{-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE DuplicateRecordFields #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE StrictData #-} {-# LANGUAGE TypeFamilies #-} {-# LANGUAGE NoImplicitPrelude #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Amazonka.Comprehend.DescribeEndpoint -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Gets the properties associated with a specific endpoint. Use this -- operation to get the status of an endpoint. For information about -- endpoints, see -- . module Amazonka.Comprehend.DescribeEndpoint ( -- * Creating a Request DescribeEndpoint (..), newDescribeEndpoint, -- * Request Lenses describeEndpoint_endpointArn, -- * Destructuring the Response DescribeEndpointResponse (..), newDescribeEndpointResponse, -- * Response Lenses describeEndpointResponse_endpointProperties, describeEndpointResponse_httpStatus, ) where import Amazonka.Comprehend.Types import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import qualified Amazonka.Prelude as Prelude import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response -- | /See:/ 'newDescribeEndpoint' smart constructor. data DescribeEndpoint = DescribeEndpoint' { -- | The Amazon Resource Number (ARN) of the endpoint being described. endpointArn :: Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'DescribeEndpoint' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'endpointArn', 'describeEndpoint_endpointArn' - The Amazon Resource Number (ARN) of the endpoint being described. newDescribeEndpoint :: -- | 'endpointArn' Prelude.Text -> DescribeEndpoint newDescribeEndpoint pEndpointArn_ = DescribeEndpoint' {endpointArn = pEndpointArn_} -- | The Amazon Resource Number (ARN) of the endpoint being described. describeEndpoint_endpointArn :: Lens.Lens' DescribeEndpoint Prelude.Text describeEndpoint_endpointArn = Lens.lens (\DescribeEndpoint' {endpointArn} -> endpointArn) (\s@DescribeEndpoint' {} a -> s {endpointArn = a} :: DescribeEndpoint) instance Core.AWSRequest DescribeEndpoint where type AWSResponse DescribeEndpoint = DescribeEndpointResponse request overrides = Request.postJSON (overrides defaultService) response = Response.receiveJSON ( \s h x -> DescribeEndpointResponse' Prelude.<$> (x Data..?> "EndpointProperties") Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) ) instance Prelude.Hashable DescribeEndpoint where hashWithSalt _salt DescribeEndpoint' {..} = _salt `Prelude.hashWithSalt` endpointArn instance Prelude.NFData DescribeEndpoint where rnf DescribeEndpoint' {..} = Prelude.rnf endpointArn instance Data.ToHeaders DescribeEndpoint where toHeaders = Prelude.const ( Prelude.mconcat [ "X-Amz-Target" Data.=# ( "Comprehend_20171127.DescribeEndpoint" :: Prelude.ByteString ), "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToJSON DescribeEndpoint where toJSON DescribeEndpoint' {..} = Data.object ( Prelude.catMaybes [Prelude.Just ("EndpointArn" Data..= endpointArn)] ) instance Data.ToPath DescribeEndpoint where toPath = Prelude.const "/" instance Data.ToQuery DescribeEndpoint where toQuery = Prelude.const Prelude.mempty -- | /See:/ 'newDescribeEndpointResponse' smart constructor. data DescribeEndpointResponse = DescribeEndpointResponse' { -- | Describes information associated with the specific endpoint. endpointProperties :: Prelude.Maybe EndpointProperties, -- | The response's http status code. httpStatus :: Prelude.Int } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'DescribeEndpointResponse' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'endpointProperties', 'describeEndpointResponse_endpointProperties' - Describes information associated with the specific endpoint. -- -- 'httpStatus', 'describeEndpointResponse_httpStatus' - The response's http status code. newDescribeEndpointResponse :: -- | 'httpStatus' Prelude.Int -> DescribeEndpointResponse newDescribeEndpointResponse pHttpStatus_ = DescribeEndpointResponse' { endpointProperties = Prelude.Nothing, httpStatus = pHttpStatus_ } -- | Describes information associated with the specific endpoint. describeEndpointResponse_endpointProperties :: Lens.Lens' DescribeEndpointResponse (Prelude.Maybe EndpointProperties) describeEndpointResponse_endpointProperties = Lens.lens (\DescribeEndpointResponse' {endpointProperties} -> endpointProperties) (\s@DescribeEndpointResponse' {} a -> s {endpointProperties = a} :: DescribeEndpointResponse) -- | The response's http status code. describeEndpointResponse_httpStatus :: Lens.Lens' DescribeEndpointResponse Prelude.Int describeEndpointResponse_httpStatus = Lens.lens (\DescribeEndpointResponse' {httpStatus} -> httpStatus) (\s@DescribeEndpointResponse' {} a -> s {httpStatus = a} :: DescribeEndpointResponse) instance Prelude.NFData DescribeEndpointResponse where rnf DescribeEndpointResponse' {..} = Prelude.rnf endpointProperties `Prelude.seq` Prelude.rnf httpStatus