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.IoT.UpdateTopicRuleDestination

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates a topic rule destination. You use this to change the status, endpoint URL, or confirmation URL of the destination.

Requires permission to access the UpdateTopicRuleDestination action.

Creating a Request

data UpdateTopicRuleDestination Source #

See: newUpdateTopicRuleDestination smart constructor.

Constructors

UpdateTopicRuleDestination'

Fields

arn :: Text
The ARN of the topic rule destination.
status :: TopicRuleDestinationStatus
The status of the topic rule destination. Valid values are:
IN_PROGRESS
A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.
ENABLED
Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination.
DISABLED
Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination.
ERROR
Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

Instances

Instances details

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

newUpdateTopicRuleDestination Source #

Arguments

:: Text	`UpdateTopicRuleDestination`
-> TopicRuleDestinationStatus	`UpdateTopicRuleDestination`
-> UpdateTopicRuleDestination

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

UpdateTopicRuleDestination, updateTopicRuleDestination_arn - The ARN of the topic rule destination.

UpdateTopicRuleDestination, updateTopicRuleDestination_status - The status of the topic rule destination. Valid values are:

IN_PROGRESS: A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.
ENABLED: Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination.
DISABLED: Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination.
ERROR: Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

Request Lenses

updateTopicRuleDestination_arn :: Lens' UpdateTopicRuleDestination Text Source #

The ARN of the topic rule destination.

updateTopicRuleDestination_status :: Lens' UpdateTopicRuleDestination TopicRuleDestinationStatus Source #

The status of the topic rule destination. Valid values are:

IN_PROGRESS: A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.
ENABLED: Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination.
DISABLED: Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination.
ERROR: Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

Destructuring the Response

data UpdateTopicRuleDestinationResponse Source #

See: newUpdateTopicRuleDestinationResponse smart constructor.

Constructors

UpdateTopicRuleDestinationResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateTopicRuleDestinationResponse Source #
Instance details Defined in Amazonka.IoT.UpdateTopicRuleDestination Associated Types type Rep UpdateTopicRuleDestinationResponse :: Type -> Type # Methods from :: UpdateTopicRuleDestinationResponse -> Rep UpdateTopicRuleDestinationResponse x # to :: Rep UpdateTopicRuleDestinationResponse x -> UpdateTopicRuleDestinationResponse #
Read UpdateTopicRuleDestinationResponse Source #
Instance details Defined in Amazonka.IoT.UpdateTopicRuleDestination Methods readsPrec :: Int -> ReadS UpdateTopicRuleDestinationResponse # readList :: ReadS [UpdateTopicRuleDestinationResponse] # readPrec :: ReadPrec UpdateTopicRuleDestinationResponse # readListPrec :: ReadPrec [UpdateTopicRuleDestinationResponse] #
Show UpdateTopicRuleDestinationResponse Source #
Instance details Defined in Amazonka.IoT.UpdateTopicRuleDestination Methods showsPrec :: Int -> UpdateTopicRuleDestinationResponse -> ShowS # show :: UpdateTopicRuleDestinationResponse -> String # showList :: [UpdateTopicRuleDestinationResponse] -> ShowS #
NFData UpdateTopicRuleDestinationResponse Source #
Instance details Defined in Amazonka.IoT.UpdateTopicRuleDestination Methods rnf :: UpdateTopicRuleDestinationResponse -> () #
Eq UpdateTopicRuleDestinationResponse Source #
Instance details Defined in Amazonka.IoT.UpdateTopicRuleDestination Methods (==) :: UpdateTopicRuleDestinationResponse -> UpdateTopicRuleDestinationResponse -> Bool # (/=) :: UpdateTopicRuleDestinationResponse -> UpdateTopicRuleDestinationResponse -> Bool #
type Rep UpdateTopicRuleDestinationResponse Source #
Instance details Defined in Amazonka.IoT.UpdateTopicRuleDestination type Rep UpdateTopicRuleDestinationResponse = D1 ('MetaData "UpdateTopicRuleDestinationResponse" "Amazonka.IoT.UpdateTopicRuleDestination" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "UpdateTopicRuleDestinationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateTopicRuleDestinationResponse Source #

Arguments

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

Create a value of UpdateTopicRuleDestinationResponse 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:httpStatus:UpdateTopicRuleDestinationResponse', updateTopicRuleDestinationResponse_httpStatus - The response's http status code.

Response Lenses

updateTopicRuleDestinationResponse_httpStatus :: Lens' UpdateTopicRuleDestinationResponse Int Source #

The response's http status code.