amazonka-sns-2.0: Amazon Simple Notification Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SNS.SetSubscriptionAttributes

Description

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

Synopsis

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

Instances details
ToHeaders SetSubscriptionAttributes Source # 
Instance details

Defined in Amazonka.SNS.SetSubscriptionAttributes

ToPath SetSubscriptionAttributes Source # 
Instance details

Defined in Amazonka.SNS.SetSubscriptionAttributes

ToQuery SetSubscriptionAttributes Source # 
Instance details

Defined in Amazonka.SNS.SetSubscriptionAttributes

AWSRequest SetSubscriptionAttributes Source # 
Instance details

Defined in Amazonka.SNS.SetSubscriptionAttributes

Generic SetSubscriptionAttributes Source # 
Instance details

Defined in Amazonka.SNS.SetSubscriptionAttributes

Associated Types

type Rep SetSubscriptionAttributes :: Type -> Type #

Read SetSubscriptionAttributes Source # 
Instance details

Defined in Amazonka.SNS.SetSubscriptionAttributes

Show SetSubscriptionAttributes Source # 
Instance details

Defined in Amazonka.SNS.SetSubscriptionAttributes

NFData SetSubscriptionAttributes Source # 
Instance details

Defined in Amazonka.SNS.SetSubscriptionAttributes

Eq SetSubscriptionAttributes Source # 
Instance details

Defined in Amazonka.SNS.SetSubscriptionAttributes

Hashable SetSubscriptionAttributes Source # 
Instance details

Defined in Amazonka.SNS.SetSubscriptionAttributes

type AWSResponse SetSubscriptionAttributes Source # 
Instance details

Defined in Amazonka.SNS.SetSubscriptionAttributes

type Rep SetSubscriptionAttributes Source # 
Instance details

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 Source #

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) Source #

The new value for the attribute in JSON format.

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.
  • 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 Source #

See: newSetSubscriptionAttributesResponse smart constructor.

Instances

Instances details
Generic SetSubscriptionAttributesResponse Source # 
Instance details

Defined in Amazonka.SNS.SetSubscriptionAttributes

Associated Types

type Rep SetSubscriptionAttributesResponse :: Type -> Type #

Read SetSubscriptionAttributesResponse Source # 
Instance details

Defined in Amazonka.SNS.SetSubscriptionAttributes

Show SetSubscriptionAttributesResponse Source # 
Instance details

Defined in Amazonka.SNS.SetSubscriptionAttributes

NFData SetSubscriptionAttributesResponse Source # 
Instance details

Defined in Amazonka.SNS.SetSubscriptionAttributes

Eq SetSubscriptionAttributesResponse Source # 
Instance details

Defined in Amazonka.SNS.SetSubscriptionAttributes

type Rep SetSubscriptionAttributesResponse Source # 
Instance details

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 Source #

Create a value of SetSubscriptionAttributesResponse with all optional fields omitted.

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