Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SNS.SetSubscriptionAttributes

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Allows a subscription owner to set an attribute of the subscription to a new value.

Creating a Request

data SetSubscriptionAttributes Source #

Input for SetSubscriptionAttributes action.

See: newSetSubscriptionAttributes smart constructor.

Constructors

SetSubscriptionAttributes'

Fields

attributeValue :: Maybe Text
The new value for the attribute in JSON format.
subscriptionArn :: Text
The ARN of the subscription to modify.
attributeName :: Text
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that this action uses:
- DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
- FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.
- RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.
- RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:
- SubscriptionRoleArn – The ARN of the IAM role that has the following:
  - Permission to write to the Kinesis Data Firehose delivery stream
  - Amazon SNS listed as a trusted entity
  Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.

Instances

Instances details

Eq SetSubscriptionAttributes Source #
Instance details Defined in Amazonka.SNS.SetSubscriptionAttributes Methods (==) :: SetSubscriptionAttributes -> SetSubscriptionAttributes -> Bool # (/=) :: SetSubscriptionAttributes -> SetSubscriptionAttributes -> Bool #
Read SetSubscriptionAttributes Source #
Instance details Defined in Amazonka.SNS.SetSubscriptionAttributes Methods readsPrec :: Int -> ReadS SetSubscriptionAttributes # readList :: ReadS [SetSubscriptionAttributes] # readPrec :: ReadPrec SetSubscriptionAttributes # readListPrec :: ReadPrec [SetSubscriptionAttributes] #
Show SetSubscriptionAttributes Source #
Instance details Defined in Amazonka.SNS.SetSubscriptionAttributes Methods showsPrec :: Int -> SetSubscriptionAttributes -> ShowS # show :: SetSubscriptionAttributes -> String # showList :: [SetSubscriptionAttributes] -> ShowS #
Generic SetSubscriptionAttributes Source #
Instance details Defined in Amazonka.SNS.SetSubscriptionAttributes Associated Types type Rep SetSubscriptionAttributes :: Type -> Type # Methods from :: SetSubscriptionAttributes -> Rep SetSubscriptionAttributes x # to :: Rep SetSubscriptionAttributes x -> SetSubscriptionAttributes #
NFData SetSubscriptionAttributes Source #
Instance details Defined in Amazonka.SNS.SetSubscriptionAttributes Methods rnf :: SetSubscriptionAttributes -> () #
Hashable SetSubscriptionAttributes Source #
Instance details Defined in Amazonka.SNS.SetSubscriptionAttributes Methods hashWithSalt :: Int -> SetSubscriptionAttributes -> Int # hash :: SetSubscriptionAttributes -> Int #
AWSRequest SetSubscriptionAttributes Source #
Instance details Defined in Amazonka.SNS.SetSubscriptionAttributes Associated Types type AWSResponse SetSubscriptionAttributes # Methods request :: SetSubscriptionAttributes -> Request SetSubscriptionAttributes # response :: MonadResource m => Logger -> Service -> Proxy SetSubscriptionAttributes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SetSubscriptionAttributes))) #
ToHeaders SetSubscriptionAttributes Source #
Instance details Defined in Amazonka.SNS.SetSubscriptionAttributes Methods toHeaders :: SetSubscriptionAttributes -> [Header] #
ToPath SetSubscriptionAttributes Source #
Instance details Defined in Amazonka.SNS.SetSubscriptionAttributes Methods toPath :: SetSubscriptionAttributes -> ByteString #
ToQuery SetSubscriptionAttributes Source #
Instance details Defined in Amazonka.SNS.SetSubscriptionAttributes Methods toQuery :: SetSubscriptionAttributes -> QueryString #
type Rep SetSubscriptionAttributes Source #
Instance details Defined in Amazonka.SNS.SetSubscriptionAttributes type Rep SetSubscriptionAttributes = D1 ('MetaData "SetSubscriptionAttributes" "Amazonka.SNS.SetSubscriptionAttributes" "libZSservicesZSamazonka-snsZSamazonka-sns" 'False) (C1 ('MetaCons "SetSubscriptionAttributes'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributeValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "subscriptionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "attributeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse SetSubscriptionAttributes Source #
Instance details Defined in Amazonka.SNS.SetSubscriptionAttributes type AWSResponse SetSubscriptionAttributes = SetSubscriptionAttributesResponse

newSetSubscriptionAttributes Source #

Arguments

:: Text	`$sel:subscriptionArn:SetSubscriptionAttributes'`
-> Text	`$sel:attributeName:SetSubscriptionAttributes'`
-> SetSubscriptionAttributes

Create a value of SetSubscriptionAttributes 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:attributeValue:SetSubscriptionAttributes', setSubscriptionAttributes_attributeValue - The new value for the attribute in JSON format.

$sel:subscriptionArn:SetSubscriptionAttributes', setSubscriptionAttributes_subscriptionArn - The ARN of the subscription to modify.

$sel:attributeName:SetSubscriptionAttributes', setSubscriptionAttributes_attributeName - A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that this action uses:

DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.
RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.
RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

SubscriptionRoleArn – The ARN of the IAM role that has the following:
- Permission to write to the Kinesis Data Firehose delivery stream
- Amazon SNS listed as a trusted entity
Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.

Request Lenses

setSubscriptionAttributes_attributeValue :: Lens' SetSubscriptionAttributes (Maybe Text) Source #

The new value for the attribute in JSON format.

setSubscriptionAttributes_subscriptionArn :: Lens' SetSubscriptionAttributes Text Source #

The ARN of the subscription to modify.

setSubscriptionAttributes_attributeName :: Lens' SetSubscriptionAttributes Text Source #

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that this action uses:

DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.
RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.
RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

SubscriptionRoleArn – The ARN of the IAM role that has the following:
- Permission to write to the Kinesis Data Firehose delivery stream
- Amazon SNS listed as a trusted entity
Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.

Destructuring the Response

data SetSubscriptionAttributesResponse Source #

See: newSetSubscriptionAttributesResponse smart constructor.

Constructors

SetSubscriptionAttributesResponse'

Instances

Instances details

Eq SetSubscriptionAttributesResponse Source #
Instance details Defined in Amazonka.SNS.SetSubscriptionAttributes Methods (==) :: SetSubscriptionAttributesResponse -> SetSubscriptionAttributesResponse -> Bool # (/=) :: SetSubscriptionAttributesResponse -> SetSubscriptionAttributesResponse -> Bool #
Read SetSubscriptionAttributesResponse Source #
Instance details Defined in Amazonka.SNS.SetSubscriptionAttributes Methods readsPrec :: Int -> ReadS SetSubscriptionAttributesResponse # readList :: ReadS [SetSubscriptionAttributesResponse] # readPrec :: ReadPrec SetSubscriptionAttributesResponse # readListPrec :: ReadPrec [SetSubscriptionAttributesResponse] #
Show SetSubscriptionAttributesResponse Source #
Instance details Defined in Amazonka.SNS.SetSubscriptionAttributes Methods showsPrec :: Int -> SetSubscriptionAttributesResponse -> ShowS # show :: SetSubscriptionAttributesResponse -> String # showList :: [SetSubscriptionAttributesResponse] -> ShowS #
Generic SetSubscriptionAttributesResponse Source #
Instance details Defined in Amazonka.SNS.SetSubscriptionAttributes Associated Types type Rep SetSubscriptionAttributesResponse :: Type -> Type # Methods from :: SetSubscriptionAttributesResponse -> Rep SetSubscriptionAttributesResponse x # to :: Rep SetSubscriptionAttributesResponse x -> SetSubscriptionAttributesResponse #
NFData SetSubscriptionAttributesResponse Source #
Instance details Defined in Amazonka.SNS.SetSubscriptionAttributes Methods rnf :: SetSubscriptionAttributesResponse -> () #
type Rep SetSubscriptionAttributesResponse Source #
Instance details Defined in Amazonka.SNS.SetSubscriptionAttributes type Rep SetSubscriptionAttributesResponse = D1 ('MetaData "SetSubscriptionAttributesResponse" "Amazonka.SNS.SetSubscriptionAttributes" "libZSservicesZSamazonka-snsZSamazonka-sns" 'False) (C1 ('MetaCons "SetSubscriptionAttributesResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newSetSubscriptionAttributesResponse :: SetSubscriptionAttributesResponse Source #

Create a value of SetSubscriptionAttributesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.