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.CreateApiDestination

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an API destination, which is an HTTP invocation endpoint configured as a target for events.

Synopsis

Creating a Request

data CreateApiDestination Source #

See: newCreateApiDestination smart constructor.

Constructors

CreateApiDestination'

Fields

description :: Maybe Text
A description for the API destination to create.
invocationRateLimitPerSecond :: Maybe Natural
The maximum number of requests per second to send to the HTTP invocation endpoint.
name :: Text
The name for the API destination to create.
connectionArn :: Text
The ARN of the connection to use for the API destination. The destination endpoint must support the authorization type specified for the connection.
invocationEndpoint :: Text
The URL to the HTTP invocation endpoint for the API destination.
httpMethod :: ApiDestinationHttpMethod
The method to use for the request to the HTTP invocation endpoint.

Instances

Instances details

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

newCreateApiDestination Source #

Arguments

:: Text	`CreateApiDestination`
-> Text	`CreateApiDestination`
-> Text	`CreateApiDestination`
-> ApiDestinationHttpMethod	`CreateApiDestination`
-> CreateApiDestination

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

CreateApiDestination, createApiDestination_description - A description for the API destination to create.

CreateApiDestination, createApiDestination_invocationRateLimitPerSecond - The maximum number of requests per second to send to the HTTP invocation endpoint.

CreateApiDestination, createApiDestination_name - The name for the API destination to create.

CreateApiDestination, createApiDestination_connectionArn - The ARN of the connection to use for the API destination. The destination endpoint must support the authorization type specified for the connection.

CreateApiDestination, createApiDestination_invocationEndpoint - The URL to the HTTP invocation endpoint for the API destination.

CreateApiDestination, createApiDestination_httpMethod - The method to use for the request to the HTTP invocation endpoint.

Request Lenses

createApiDestination_description :: Lens' CreateApiDestination (Maybe Text) Source #

A description for the API destination to create.

createApiDestination_invocationRateLimitPerSecond :: Lens' CreateApiDestination (Maybe Natural) Source #

The maximum number of requests per second to send to the HTTP invocation endpoint.

createApiDestination_name :: Lens' CreateApiDestination Text Source #

The name for the API destination to create.

createApiDestination_connectionArn :: Lens' CreateApiDestination Text Source #

The ARN of the connection to use for the API destination. The destination endpoint must support the authorization type specified for the connection.

createApiDestination_invocationEndpoint :: Lens' CreateApiDestination Text Source #

The URL to the HTTP invocation endpoint for the API destination.

createApiDestination_httpMethod :: Lens' CreateApiDestination ApiDestinationHttpMethod Source #

The method to use for the request to the HTTP invocation endpoint.

Destructuring the Response

data CreateApiDestinationResponse Source #

See: newCreateApiDestinationResponse smart constructor.

Constructors

CreateApiDestinationResponse'

Fields

apiDestinationArn :: Maybe Text
The ARN of the API destination that was created by the request.
apiDestinationState :: Maybe ApiDestinationState
The state of the API destination that was created by the request.
creationTime :: Maybe POSIX
A time stamp indicating the time that the API destination was created.
lastModifiedTime :: Maybe POSIX
A time stamp indicating the time that the API destination was last modified.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic CreateApiDestinationResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateApiDestination Associated Types type Rep CreateApiDestinationResponse :: Type -> Type # Methods from :: CreateApiDestinationResponse -> Rep CreateApiDestinationResponse x # to :: Rep CreateApiDestinationResponse x -> CreateApiDestinationResponse #
Read CreateApiDestinationResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateApiDestination Methods readsPrec :: Int -> ReadS CreateApiDestinationResponse # readList :: ReadS [CreateApiDestinationResponse] # readPrec :: ReadPrec CreateApiDestinationResponse # readListPrec :: ReadPrec [CreateApiDestinationResponse] #
Show CreateApiDestinationResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateApiDestination Methods showsPrec :: Int -> CreateApiDestinationResponse -> ShowS # show :: CreateApiDestinationResponse -> String # showList :: [CreateApiDestinationResponse] -> ShowS #
NFData CreateApiDestinationResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateApiDestination Methods rnf :: CreateApiDestinationResponse -> () #
Eq CreateApiDestinationResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateApiDestination Methods (==) :: CreateApiDestinationResponse -> CreateApiDestinationResponse -> Bool # (/=) :: CreateApiDestinationResponse -> CreateApiDestinationResponse -> Bool #
type Rep CreateApiDestinationResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateApiDestination type Rep CreateApiDestinationResponse = D1 ('MetaData "CreateApiDestinationResponse" "Amazonka.CloudWatchEvents.CreateApiDestination" "amazonka-cloudwatch-events-2.0-GJzRBos1CnlE3BT39axMc5" 'False) (C1 ('MetaCons "CreateApiDestinationResponse'" '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 "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newCreateApiDestinationResponse Source #

Arguments

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

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

CreateApiDestinationResponse, createApiDestinationResponse_apiDestinationArn - The ARN of the API destination that was created by the request.

CreateApiDestinationResponse, createApiDestinationResponse_apiDestinationState - The state of the API destination that was created by the request.

CreateApiDestinationResponse, createApiDestinationResponse_creationTime - A time stamp indicating the time that the API destination was created.

CreateApiDestinationResponse, createApiDestinationResponse_lastModifiedTime - A time stamp indicating the time that the API destination was last modified.

$sel:httpStatus:CreateApiDestinationResponse', createApiDestinationResponse_httpStatus - The response's http status code.

Response Lenses

createApiDestinationResponse_apiDestinationArn :: Lens' CreateApiDestinationResponse (Maybe Text) Source #

The ARN of the API destination that was created by the request.

createApiDestinationResponse_apiDestinationState :: Lens' CreateApiDestinationResponse (Maybe ApiDestinationState) Source #

The state of the API destination that was created by the request.

createApiDestinationResponse_creationTime :: Lens' CreateApiDestinationResponse (Maybe UTCTime) Source #

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

createApiDestinationResponse_lastModifiedTime :: Lens' CreateApiDestinationResponse (Maybe UTCTime) Source #

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

createApiDestinationResponse_httpStatus :: Lens' CreateApiDestinationResponse Int Source #

The response's http status code.