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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates an API destination.

Synopsis

Creating a Request

data UpdateApiDestination Source #

See: newUpdateApiDestination smart constructor.

Constructors

UpdateApiDestination'

Fields

connectionArn :: Maybe Text
The ARN of the connection to use for the API destination.
description :: Maybe Text
The name of the API destination to update.
httpMethod :: Maybe ApiDestinationHttpMethod
The method to use for the API destination.
invocationEndpoint :: Maybe Text
The URL to the endpoint to use for the API destination.
invocationRateLimitPerSecond :: Maybe Natural
The maximum number of invocations per second to send to the API destination.
name :: Text
The name of the API destination to update.

Instances

Instances details

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

newUpdateApiDestination Source #

Arguments

:: Text	`UpdateApiDestination`
-> UpdateApiDestination

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

UpdateApiDestination, updateApiDestination_connectionArn - The ARN of the connection to use for the API destination.

UpdateApiDestination, updateApiDestination_description - The name of the API destination to update.

UpdateApiDestination, updateApiDestination_httpMethod - The method to use for the API destination.

UpdateApiDestination, updateApiDestination_invocationEndpoint - The URL to the endpoint to use for the API destination.

UpdateApiDestination, updateApiDestination_invocationRateLimitPerSecond - The maximum number of invocations per second to send to the API destination.

UpdateApiDestination, updateApiDestination_name - The name of the API destination to update.

Request Lenses

updateApiDestination_connectionArn :: Lens' UpdateApiDestination (Maybe Text) Source #

The ARN of the connection to use for the API destination.

updateApiDestination_description :: Lens' UpdateApiDestination (Maybe Text) Source #

The name of the API destination to update.

updateApiDestination_httpMethod :: Lens' UpdateApiDestination (Maybe ApiDestinationHttpMethod) Source #

The method to use for the API destination.

updateApiDestination_invocationEndpoint :: Lens' UpdateApiDestination (Maybe Text) Source #

The URL to the endpoint to use for the API destination.

updateApiDestination_invocationRateLimitPerSecond :: Lens' UpdateApiDestination (Maybe Natural) Source #

The maximum number of invocations per second to send to the API destination.

updateApiDestination_name :: Lens' UpdateApiDestination Text Source #

The name of the API destination to update.

Destructuring the Response

data UpdateApiDestinationResponse Source #

See: newUpdateApiDestinationResponse smart constructor.

Constructors

UpdateApiDestinationResponse'

Fields

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

Instances

Instances details

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

newUpdateApiDestinationResponse Source #

Arguments

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

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

UpdateApiDestinationResponse, updateApiDestinationResponse_apiDestinationArn - The ARN of the API destination that was updated.

UpdateApiDestinationResponse, updateApiDestinationResponse_apiDestinationState - The state of the API destination that was updated.

UpdateApiDestinationResponse, updateApiDestinationResponse_creationTime - A time stamp for the time that the API destination was created.

UpdateApiDestinationResponse, updateApiDestinationResponse_lastModifiedTime - A time stamp for the time that the API destination was last modified.

$sel:httpStatus:UpdateApiDestinationResponse', updateApiDestinationResponse_httpStatus - The response's http status code.

Response Lenses

updateApiDestinationResponse_apiDestinationArn :: Lens' UpdateApiDestinationResponse (Maybe Text) Source #

The ARN of the API destination that was updated.

updateApiDestinationResponse_apiDestinationState :: Lens' UpdateApiDestinationResponse (Maybe ApiDestinationState) Source #

The state of the API destination that was updated.

updateApiDestinationResponse_creationTime :: Lens' UpdateApiDestinationResponse (Maybe UTCTime) Source #

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

updateApiDestinationResponse_lastModifiedTime :: Lens' UpdateApiDestinationResponse (Maybe UTCTime) Source #

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

updateApiDestinationResponse_httpStatus :: Lens' UpdateApiDestinationResponse Int Source #

The response's http status code.