libZSservicesZSamazonka-iotZSamazonka-iot
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IoT.UpdateTopicRuleDestination

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.

Synopsis

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
Eq UpdateTopicRuleDestination Source # 
Instance details

Defined in Amazonka.IoT.UpdateTopicRuleDestination

Methods

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

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

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 #

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 #

NFData UpdateTopicRuleDestination Source # 
Instance details

Defined in Amazonka.IoT.UpdateTopicRuleDestination

Methods

rnf :: UpdateTopicRuleDestination -> () #

Hashable UpdateTopicRuleDestination Source # 
Instance details

Defined in Amazonka.IoT.UpdateTopicRuleDestination

Methods

hashWithSalt :: Int -> UpdateTopicRuleDestination -> Int #

hash :: UpdateTopicRuleDestination -> Int #

ToJSON UpdateTopicRuleDestination Source # 
Instance details

Defined in Amazonka.IoT.UpdateTopicRuleDestination

Methods

toJSON :: UpdateTopicRuleDestination -> Value #

toEncoding :: UpdateTopicRuleDestination -> Encoding #

toJSONList :: [UpdateTopicRuleDestination] -> Value #

toEncodingList :: [UpdateTopicRuleDestination] -> Encoding #

AWSRequest UpdateTopicRuleDestination Source # 
Instance details

Defined in Amazonka.IoT.UpdateTopicRuleDestination

Associated Types

type AWSResponse UpdateTopicRuleDestination #

Methods

request :: UpdateTopicRuleDestination -> Request UpdateTopicRuleDestination #

response :: MonadResource m => Logger -> Service -> Proxy UpdateTopicRuleDestination -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateTopicRuleDestination))) #

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 #

type Rep UpdateTopicRuleDestination Source # 
Instance details

Defined in Amazonka.IoT.UpdateTopicRuleDestination

type Rep UpdateTopicRuleDestination = D1 ('MetaData "UpdateTopicRuleDestination" "Amazonka.IoT.UpdateTopicRuleDestination" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "UpdateTopicRuleDestination'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TopicRuleDestinationStatus)))
type AWSResponse UpdateTopicRuleDestination Source # 
Instance details

Defined in Amazonka.IoT.UpdateTopicRuleDestination

type AWSResponse UpdateTopicRuleDestination = UpdateTopicRuleDestinationResponse

newUpdateTopicRuleDestination Source #

Arguments

:: Text

$sel:arn:UpdateTopicRuleDestination'

-> TopicRuleDestinationStatus

$sel:status: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:

$sel:arn:UpdateTopicRuleDestination', updateTopicRuleDestination_arn - The ARN of the topic rule destination.

$sel:status: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

Instances

Instances details
Eq UpdateTopicRuleDestinationResponse Source # 
Instance details

Defined in Amazonka.IoT.UpdateTopicRuleDestination

Methods

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

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

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 #

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 #

NFData UpdateTopicRuleDestinationResponse Source # 
Instance details

Defined in Amazonka.IoT.UpdateTopicRuleDestination

Methods

rnf :: UpdateTopicRuleDestinationResponse -> () #

type Rep UpdateTopicRuleDestinationResponse Source # 
Instance details

Defined in Amazonka.IoT.UpdateTopicRuleDestination

type Rep UpdateTopicRuleDestinationResponse = D1 ('MetaData "UpdateTopicRuleDestinationResponse" "Amazonka.IoT.UpdateTopicRuleDestination" "libZSservicesZSamazonka-iotZSamazonka-iot" '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.