Amazonka.SNS.SetSubscriptionAttributes

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

Creating a Request

data SetSubscriptionAttributes

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.

  • FilterPolicyScope – This attribute lets you choose the filtering scope by using one of the following string value types:

    • MessageAttributes (default) – The filter is applied on the message attributes.
    • MessageBody – The filter is applied on the message body.
  • 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

ToHeaders SetSubscriptionAttributes

Defined in Amazonka.SNS.SetSubscriptionAttributes

Methods

toHeaders :: SetSubscriptionAttributes -> [Header]

ToPath SetSubscriptionAttributes

Defined in Amazonka.SNS.SetSubscriptionAttributes

Methods

toPath :: SetSubscriptionAttributes -> ByteString

ToQuery SetSubscriptionAttributes

Defined in Amazonka.SNS.SetSubscriptionAttributes

Methods

toQuery :: SetSubscriptionAttributes -> QueryString

AWSRequest SetSubscriptionAttributes

Defined in Amazonka.SNS.SetSubscriptionAttributes

Associated Types

type AWSResponse SetSubscriptionAttributes

Methods

request :: (Service -> Service) -> SetSubscriptionAttributes -> Request SetSubscriptionAttributes

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SetSubscriptionAttributes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SetSubscriptionAttributes)))

Generic SetSubscriptionAttributes

Defined in Amazonka.SNS.SetSubscriptionAttributes

Associated Types

type Rep SetSubscriptionAttributes :: Type -> Type

Methods

from :: SetSubscriptionAttributes -> Rep SetSubscriptionAttributes x

to :: Rep SetSubscriptionAttributes x -> SetSubscriptionAttributes

Read SetSubscriptionAttributes

Defined in Amazonka.SNS.SetSubscriptionAttributes

Methods

readsPrec :: Int -> ReadS SetSubscriptionAttributes

readList :: ReadS [SetSubscriptionAttributes]

readPrec :: ReadPrec SetSubscriptionAttributes

readListPrec :: ReadPrec [SetSubscriptionAttributes]

Show SetSubscriptionAttributes

Defined in Amazonka.SNS.SetSubscriptionAttributes

Methods

showsPrec :: Int -> SetSubscriptionAttributes -> ShowS

show :: SetSubscriptionAttributes -> String

showList :: [SetSubscriptionAttributes] -> ShowS

NFData SetSubscriptionAttributes

Defined in Amazonka.SNS.SetSubscriptionAttributes

Methods

rnf :: SetSubscriptionAttributes -> ()

Eq SetSubscriptionAttributes

Defined in Amazonka.SNS.SetSubscriptionAttributes

Methods

(==) :: SetSubscriptionAttributes -> SetSubscriptionAttributes -> Bool

(/=) :: SetSubscriptionAttributes -> SetSubscriptionAttributes -> Bool

Hashable SetSubscriptionAttributes

Defined in Amazonka.SNS.SetSubscriptionAttributes

Methods

hashWithSalt :: Int -> SetSubscriptionAttributes -> Int

hash :: SetSubscriptionAttributes -> Int

type AWSResponse SetSubscriptionAttributes

Defined in Amazonka.SNS.SetSubscriptionAttributes

type AWSResponse SetSubscriptionAttributes = SetSubscriptionAttributesResponse

type Rep SetSubscriptionAttributes

Defined in Amazonka.SNS.SetSubscriptionAttributes

type Rep SetSubscriptionAttributes = D1 ('MetaData "SetSubscriptionAttributes" "Amazonka.SNS.SetSubscriptionAttributes" "amazonka-sns-2.0-4k7AiJI7DyqhOUy5o4qb9" '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))))

newSetSubscriptionAttributes

Arguments

:: Text

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.

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.

• FilterPolicyScope – This attribute lets you choose the filtering scope by using one of the following string value types:

  • MessageAttributes (default) – The filter is applied on the message attributes.
  • MessageBody – The filter is applied on the message body.
• 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)

The new value for the attribute in JSON format.

setSubscriptionAttributes_subscriptionArn :: Lens' SetSubscriptionAttributes Text

The ARN of the subscription to modify.

setSubscriptionAttributes_attributeName :: Lens' SetSubscriptionAttributes 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.

• FilterPolicyScope – This attribute lets you choose the filtering scope by using one of the following string value types:

  • MessageAttributes (default) – The filter is applied on the message attributes.
  • MessageBody – The filter is applied on the message body.
• 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

See: newSetSubscriptionAttributesResponse smart constructor.

Constructors

SetSubscriptionAttributesResponse'

Instances

Generic SetSubscriptionAttributesResponse

Defined in Amazonka.SNS.SetSubscriptionAttributes

Associated Types

type Rep SetSubscriptionAttributesResponse :: Type -> Type

Methods

from :: SetSubscriptionAttributesResponse -> Rep SetSubscriptionAttributesResponse x

to :: Rep SetSubscriptionAttributesResponse x -> SetSubscriptionAttributesResponse

Read SetSubscriptionAttributesResponse

Defined in Amazonka.SNS.SetSubscriptionAttributes

Methods

readsPrec :: Int -> ReadS SetSubscriptionAttributesResponse

readList :: ReadS [SetSubscriptionAttributesResponse]

readPrec :: ReadPrec SetSubscriptionAttributesResponse

readListPrec :: ReadPrec [SetSubscriptionAttributesResponse]

Show SetSubscriptionAttributesResponse

Defined in Amazonka.SNS.SetSubscriptionAttributes

Methods

showsPrec :: Int -> SetSubscriptionAttributesResponse -> ShowS

show :: SetSubscriptionAttributesResponse -> String

showList :: [SetSubscriptionAttributesResponse] -> ShowS

NFData SetSubscriptionAttributesResponse

Defined in Amazonka.SNS.SetSubscriptionAttributes

Methods

rnf :: SetSubscriptionAttributesResponse -> ()

Eq SetSubscriptionAttributesResponse

Defined in Amazonka.SNS.SetSubscriptionAttributes

Methods

(==) :: SetSubscriptionAttributesResponse -> SetSubscriptionAttributesResponse -> Bool

(/=) :: SetSubscriptionAttributesResponse -> SetSubscriptionAttributesResponse -> Bool

type Rep SetSubscriptionAttributesResponse

Defined in Amazonka.SNS.SetSubscriptionAttributes

type Rep SetSubscriptionAttributesResponse = D1 ('MetaData "SetSubscriptionAttributesResponse" "Amazonka.SNS.SetSubscriptionAttributes" "amazonka-sns-2.0-4k7AiJI7DyqhOUy5o4qb9" 'False) (C1 ('MetaCons "SetSubscriptionAttributesResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newSetSubscriptionAttributesResponse :: SetSubscriptionAttributesResponse

Create a value of SetSubscriptionAttributesResponse with all optional fields omitted.

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