amazonka-comprehend-2.0: Amazon Comprehend SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Comprehend.DescribeEndpoint

Description

Gets the properties associated with a specific endpoint. Use this operation to get the status of an endpoint. For information about endpoints, see Managing endpoints.

Synopsis

Creating a Request

data DescribeEndpoint Source #

See: newDescribeEndpoint smart constructor.

Constructors

DescribeEndpoint' 

Fields

  • endpointArn :: Text

    The Amazon Resource Number (ARN) of the endpoint being described.

Instances

Instances details
ToJSON DescribeEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEndpoint

Methods

toJSON :: DescribeEndpoint -> Value #

toEncoding :: DescribeEndpoint -> Encoding #

toJSONList :: [DescribeEndpoint] -> Value #

toEncodingList :: [DescribeEndpoint] -> Encoding #

ToHeaders DescribeEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEndpoint

Methods

toHeaders :: DescribeEndpoint -> [Header] #

ToPath DescribeEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEndpoint

Methods

toPath :: DescribeEndpoint -> ByteString #

ToQuery DescribeEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEndpoint

Methods

toQuery :: DescribeEndpoint -> QueryString #

AWSRequest DescribeEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEndpoint

Associated Types

type AWSResponse DescribeEndpoint #

Methods

request :: (Service -> Service) -> DescribeEndpoint -> Request DescribeEndpoint #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeEndpoint -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeEndpoint))) #

Generic DescribeEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEndpoint

Associated Types

type Rep DescribeEndpoint :: Type -> Type #

Methods

from :: DescribeEndpoint -> Rep DescribeEndpoint x #

to :: Rep DescribeEndpoint x -> DescribeEndpoint #

Read DescribeEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEndpoint

Methods

readsPrec :: Int -> ReadS DescribeEndpoint #

readList :: ReadS [DescribeEndpoint] #

readPrec :: ReadPrec DescribeEndpoint #

readListPrec :: ReadPrec [DescribeEndpoint] #

Show DescribeEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEndpoint

Methods

showsPrec :: Int -> DescribeEndpoint -> ShowS #

show :: DescribeEndpoint -> String #

showList :: [DescribeEndpoint] -> ShowS #

NFData DescribeEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEndpoint

Methods

rnf :: DescribeEndpoint -> () #

Eq DescribeEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEndpoint

Methods

(==) :: DescribeEndpoint -> DescribeEndpoint -> Bool #

(/=) :: DescribeEndpoint -> DescribeEndpoint -> Bool #

Hashable DescribeEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEndpoint

Methods

hashWithSalt :: Int -> DescribeEndpoint -> Int #

hash :: DescribeEndpoint -> Int #

type AWSResponse DescribeEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEndpoint

type AWSResponse DescribeEndpoint = DescribeEndpointResponse
type Rep DescribeEndpoint Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEndpoint

type Rep DescribeEndpoint = D1 ('MetaData "DescribeEndpoint" "Amazonka.Comprehend.DescribeEndpoint" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "DescribeEndpoint'" 'PrefixI 'True) (S1 ('MetaSel ('Just "endpointArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeEndpoint Source #

Arguments

:: Text

DescribeEndpoint

-> DescribeEndpoint 

Create a value of DescribeEndpoint with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeEndpoint, describeEndpoint_endpointArn - The Amazon Resource Number (ARN) of the endpoint being described.

Request Lenses

describeEndpoint_endpointArn :: Lens' DescribeEndpoint Text Source #

The Amazon Resource Number (ARN) of the endpoint being described.

Destructuring the Response

data DescribeEndpointResponse Source #

See: newDescribeEndpointResponse smart constructor.

Constructors

DescribeEndpointResponse' 

Fields

Instances

Instances details
Generic DescribeEndpointResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEndpoint

Associated Types

type Rep DescribeEndpointResponse :: Type -> Type #

Methods

from :: DescribeEndpointResponse -> Rep DescribeEndpointResponse x #

to :: Rep DescribeEndpointResponse x -> DescribeEndpointResponse #

Read DescribeEndpointResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEndpoint

Methods

readsPrec :: Int -> ReadS DescribeEndpointResponse #

readList :: ReadS [DescribeEndpointResponse] #

readPrec :: ReadPrec DescribeEndpointResponse #

readListPrec :: ReadPrec [DescribeEndpointResponse] #

Show DescribeEndpointResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEndpoint

Methods

showsPrec :: Int -> DescribeEndpointResponse -> ShowS #

show :: DescribeEndpointResponse -> String #

showList :: [DescribeEndpointResponse] -> ShowS #

NFData DescribeEndpointResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEndpoint

Methods

rnf :: DescribeEndpointResponse -> () #

Eq DescribeEndpointResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEndpoint

Methods

(==) :: DescribeEndpointResponse -> DescribeEndpointResponse -> Bool #

(/=) :: DescribeEndpointResponse -> DescribeEndpointResponse -> Bool #

type Rep DescribeEndpointResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DescribeEndpoint

type Rep DescribeEndpointResponse = D1 ('MetaData "DescribeEndpointResponse" "Amazonka.Comprehend.DescribeEndpoint" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "DescribeEndpointResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "endpointProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointProperties)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeEndpointResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeEndpointResponse'

-> DescribeEndpointResponse 

Create a value of DescribeEndpointResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:endpointProperties:DescribeEndpointResponse', describeEndpointResponse_endpointProperties - Describes information associated with the specific endpoint.

$sel:httpStatus:DescribeEndpointResponse', describeEndpointResponse_httpStatus - The response's http status code.

Response Lenses

describeEndpointResponse_endpointProperties :: Lens' DescribeEndpointResponse (Maybe EndpointProperties) Source #

Describes information associated with the specific endpoint.

describeEndpointResponse_httpStatus :: Lens' DescribeEndpointResponse Int Source #

The response's http status code.