Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CloudWatchEvents.DescribeApiDestination

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves details about an API destination.

Synopsis

Creating a Request

data DescribeApiDestination Source #

See: newDescribeApiDestination smart constructor.

Constructors

DescribeApiDestination'
Fields name :: Text The name of the API destination to retrieve.

Instances

Instances details

ToJSON DescribeApiDestination Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeApiDestination Methods toJSON :: DescribeApiDestination -> Value # toEncoding :: DescribeApiDestination -> Encoding # toJSONList :: [DescribeApiDestination] -> Value # toEncodingList :: [DescribeApiDestination] -> Encoding #
ToHeaders DescribeApiDestination Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeApiDestination Methods toHeaders :: DescribeApiDestination -> [Header] #
ToPath DescribeApiDestination Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeApiDestination Methods toPath :: DescribeApiDestination -> ByteString #
ToQuery DescribeApiDestination Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeApiDestination Methods toQuery :: DescribeApiDestination -> QueryString #
AWSRequest DescribeApiDestination Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeApiDestination Associated Types type AWSResponse DescribeApiDestination # Methods request :: (Service -> Service) -> DescribeApiDestination -> Request DescribeApiDestination # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeApiDestination -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeApiDestination))) #
Generic DescribeApiDestination Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeApiDestination Associated Types type Rep DescribeApiDestination :: Type -> Type # Methods from :: DescribeApiDestination -> Rep DescribeApiDestination x # to :: Rep DescribeApiDestination x -> DescribeApiDestination #
Read DescribeApiDestination Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeApiDestination Methods readsPrec :: Int -> ReadS DescribeApiDestination # readList :: ReadS [DescribeApiDestination] # readPrec :: ReadPrec DescribeApiDestination # readListPrec :: ReadPrec [DescribeApiDestination] #
Show DescribeApiDestination Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeApiDestination Methods showsPrec :: Int -> DescribeApiDestination -> ShowS # show :: DescribeApiDestination -> String # showList :: [DescribeApiDestination] -> ShowS #
NFData DescribeApiDestination Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeApiDestination Methods rnf :: DescribeApiDestination -> () #
Eq DescribeApiDestination Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeApiDestination Methods (==) :: DescribeApiDestination -> DescribeApiDestination -> Bool # (/=) :: DescribeApiDestination -> DescribeApiDestination -> Bool #
Hashable DescribeApiDestination Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeApiDestination Methods hashWithSalt :: Int -> DescribeApiDestination -> Int # hash :: DescribeApiDestination -> Int #
type AWSResponse DescribeApiDestination Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeApiDestination type AWSResponse DescribeApiDestination = DescribeApiDestinationResponse
type Rep DescribeApiDestination Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeApiDestination type Rep DescribeApiDestination = D1 ('MetaData "DescribeApiDestination" "Amazonka.CloudWatchEvents.DescribeApiDestination" "amazonka-cloudwatch-events-2.0-GJzRBos1CnlE3BT39axMc5" 'False) (C1 ('MetaCons "DescribeApiDestination'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeApiDestination Source #

Arguments

:: Text	`DescribeApiDestination`
-> DescribeApiDestination

Create a value of DescribeApiDestination 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:

DescribeApiDestination, describeApiDestination_name - The name of the API destination to retrieve.

Request Lenses

describeApiDestination_name :: Lens' DescribeApiDestination Text Source #

The name of the API destination to retrieve.

Destructuring the Response

data DescribeApiDestinationResponse Source #

See: newDescribeApiDestinationResponse smart constructor.

Constructors

DescribeApiDestinationResponse'

Fields

apiDestinationArn :: Maybe Text
The ARN of the API destination retrieved.
apiDestinationState :: Maybe ApiDestinationState
The state of the API destination retrieved.
connectionArn :: Maybe Text
The ARN of the connection specified for the API destination retrieved.
creationTime :: Maybe POSIX
A time stamp for the time that the API destination was created.
description :: Maybe Text
The description for the API destination retrieved.
httpMethod :: Maybe ApiDestinationHttpMethod
The method to use to connect to the HTTP endpoint.
invocationEndpoint :: Maybe Text
The URL to use to connect to the HTTP endpoint.
invocationRateLimitPerSecond :: Maybe Natural
The maximum number of invocations per second to specified for the API destination. Note that if you set the invocation rate maximum to a value lower the rate necessary to send all events received on to the destination HTTP endpoint, some events may not be delivered within the 24-hour retry window. If you plan to set the rate lower than the rate necessary to deliver all events, consider using a dead-letter queue to catch events that are not delivered within 24 hours.
lastModifiedTime :: Maybe POSIX
A time stamp for the time that the API destination was last modified.
name :: Maybe Text
The name of the API destination retrieved.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeApiDestinationResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeApiDestination Associated Types type Rep DescribeApiDestinationResponse :: Type -> Type # Methods from :: DescribeApiDestinationResponse -> Rep DescribeApiDestinationResponse x # to :: Rep DescribeApiDestinationResponse x -> DescribeApiDestinationResponse #
Read DescribeApiDestinationResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeApiDestination Methods readsPrec :: Int -> ReadS DescribeApiDestinationResponse # readList :: ReadS [DescribeApiDestinationResponse] # readPrec :: ReadPrec DescribeApiDestinationResponse # readListPrec :: ReadPrec [DescribeApiDestinationResponse] #
Show DescribeApiDestinationResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeApiDestination Methods showsPrec :: Int -> DescribeApiDestinationResponse -> ShowS # show :: DescribeApiDestinationResponse -> String # showList :: [DescribeApiDestinationResponse] -> ShowS #
NFData DescribeApiDestinationResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeApiDestination Methods rnf :: DescribeApiDestinationResponse -> () #
Eq DescribeApiDestinationResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeApiDestination Methods (==) :: DescribeApiDestinationResponse -> DescribeApiDestinationResponse -> Bool # (/=) :: DescribeApiDestinationResponse -> DescribeApiDestinationResponse -> Bool #
type Rep DescribeApiDestinationResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeApiDestination type Rep DescribeApiDestinationResponse = D1 ('MetaData "DescribeApiDestinationResponse" "Amazonka.CloudWatchEvents.DescribeApiDestination" "amazonka-cloudwatch-events-2.0-GJzRBos1CnlE3BT39axMc5" 'False) (C1 ('MetaCons "DescribeApiDestinationResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "apiDestinationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "apiDestinationState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ApiDestinationState))) :: (S1 ('MetaSel ('Just "connectionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "httpMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ApiDestinationHttpMethod)) :: (S1 ('MetaSel ('Just "invocationEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "invocationRateLimitPerSecond") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :: (S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeApiDestinationResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeApiDestinationResponse'`
-> DescribeApiDestinationResponse

Create a value of DescribeApiDestinationResponse 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:

DescribeApiDestinationResponse, describeApiDestinationResponse_apiDestinationArn - The ARN of the API destination retrieved.

DescribeApiDestinationResponse, describeApiDestinationResponse_apiDestinationState - The state of the API destination retrieved.

DescribeApiDestinationResponse, describeApiDestinationResponse_connectionArn - The ARN of the connection specified for the API destination retrieved.

DescribeApiDestinationResponse, describeApiDestinationResponse_creationTime - A time stamp for the time that the API destination was created.

DescribeApiDestinationResponse, describeApiDestinationResponse_description - The description for the API destination retrieved.

DescribeApiDestinationResponse, describeApiDestinationResponse_httpMethod - The method to use to connect to the HTTP endpoint.

DescribeApiDestinationResponse, describeApiDestinationResponse_invocationEndpoint - The URL to use to connect to the HTTP endpoint.

DescribeApiDestinationResponse, describeApiDestinationResponse_invocationRateLimitPerSecond - The maximum number of invocations per second to specified for the API destination. Note that if you set the invocation rate maximum to a value lower the rate necessary to send all events received on to the destination HTTP endpoint, some events may not be delivered within the 24-hour retry window. If you plan to set the rate lower than the rate necessary to deliver all events, consider using a dead-letter queue to catch events that are not delivered within 24 hours.

DescribeApiDestinationResponse, describeApiDestinationResponse_lastModifiedTime - A time stamp for the time that the API destination was last modified.

DescribeApiDestination, describeApiDestinationResponse_name - The name of the API destination retrieved.

$sel:httpStatus:DescribeApiDestinationResponse', describeApiDestinationResponse_httpStatus - The response's http status code.

Response Lenses

describeApiDestinationResponse_apiDestinationArn :: Lens' DescribeApiDestinationResponse (Maybe Text) Source #

The ARN of the API destination retrieved.

describeApiDestinationResponse_apiDestinationState :: Lens' DescribeApiDestinationResponse (Maybe ApiDestinationState) Source #

The state of the API destination retrieved.

describeApiDestinationResponse_connectionArn :: Lens' DescribeApiDestinationResponse (Maybe Text) Source #

The ARN of the connection specified for the API destination retrieved.

describeApiDestinationResponse_creationTime :: Lens' DescribeApiDestinationResponse (Maybe UTCTime) Source #

A time stamp for the time that the API destination was created.

describeApiDestinationResponse_description :: Lens' DescribeApiDestinationResponse (Maybe Text) Source #

The description for the API destination retrieved.

describeApiDestinationResponse_httpMethod :: Lens' DescribeApiDestinationResponse (Maybe ApiDestinationHttpMethod) Source #

The method to use to connect to the HTTP endpoint.

describeApiDestinationResponse_invocationEndpoint :: Lens' DescribeApiDestinationResponse (Maybe Text) Source #

The URL to use to connect to the HTTP endpoint.

describeApiDestinationResponse_invocationRateLimitPerSecond :: Lens' DescribeApiDestinationResponse (Maybe Natural) Source #

The maximum number of invocations per second to specified for the API destination. Note that if you set the invocation rate maximum to a value lower the rate necessary to send all events received on to the destination HTTP endpoint, some events may not be delivered within the 24-hour retry window. If you plan to set the rate lower than the rate necessary to deliver all events, consider using a dead-letter queue to catch events that are not delivered within 24 hours.

describeApiDestinationResponse_lastModifiedTime :: Lens' DescribeApiDestinationResponse (Maybe UTCTime) Source #

A time stamp for the time that the API destination was last modified.

describeApiDestinationResponse_name :: Lens' DescribeApiDestinationResponse (Maybe Text) Source #

The name of the API destination retrieved.

describeApiDestinationResponse_httpStatus :: Lens' DescribeApiDestinationResponse Int Source #

The response's http status code.