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

Description

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

To remove the ability to change topic permissions, you must deny permissions to the AddPermission, RemovePermission, and SetTopicAttributes actions in your IAM policy.

Synopsis

Creating a Request

data SetTopicAttributes Source #

Input for SetTopicAttributes action.

See: newSetTopicAttributes smart constructor.

Constructors

SetTopicAttributes' 

Fields

  • attributeValue :: Maybe Text

    The new value for the attribute.

  • topicArn :: Text

    The ARN of the topic 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 the SetTopicAttributes action uses:

    • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
    • DisplayName – The display name to use for a topic with SMS subscriptions.
    • Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
    • TracingConfig – Tracing mode of an Amazon SNS topic. By default TracingConfig is set to PassThrough, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.

    The following attribute applies only to server-side-encryption:

    • KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.
    • SignatureVersion – The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS.

    The following attribute applies only to FIFO topics:

    • ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.

      • By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.
      • When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

        (Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.

Instances

Instances details
ToHeaders SetTopicAttributes Source # 
Instance details

Defined in Amazonka.SNS.SetTopicAttributes

ToPath SetTopicAttributes Source # 
Instance details

Defined in Amazonka.SNS.SetTopicAttributes

ToQuery SetTopicAttributes Source # 
Instance details

Defined in Amazonka.SNS.SetTopicAttributes

AWSRequest SetTopicAttributes Source # 
Instance details

Defined in Amazonka.SNS.SetTopicAttributes

Associated Types

type AWSResponse SetTopicAttributes #

Generic SetTopicAttributes Source # 
Instance details

Defined in Amazonka.SNS.SetTopicAttributes

Associated Types

type Rep SetTopicAttributes :: Type -> Type #

Read SetTopicAttributes Source # 
Instance details

Defined in Amazonka.SNS.SetTopicAttributes

Show SetTopicAttributes Source # 
Instance details

Defined in Amazonka.SNS.SetTopicAttributes

NFData SetTopicAttributes Source # 
Instance details

Defined in Amazonka.SNS.SetTopicAttributes

Methods

rnf :: SetTopicAttributes -> () #

Eq SetTopicAttributes Source # 
Instance details

Defined in Amazonka.SNS.SetTopicAttributes

Hashable SetTopicAttributes Source # 
Instance details

Defined in Amazonka.SNS.SetTopicAttributes

type AWSResponse SetTopicAttributes Source # 
Instance details

Defined in Amazonka.SNS.SetTopicAttributes

type Rep SetTopicAttributes Source # 
Instance details

Defined in Amazonka.SNS.SetTopicAttributes

type Rep SetTopicAttributes = D1 ('MetaData "SetTopicAttributes" "Amazonka.SNS.SetTopicAttributes" "amazonka-sns-2.0-4k7AiJI7DyqhOUy5o4qb9" 'False) (C1 ('MetaCons "SetTopicAttributes'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributeValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "topicArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "attributeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newSetTopicAttributes Source #

Create a value of SetTopicAttributes 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:SetTopicAttributes', setTopicAttributes_attributeValue - The new value for the attribute.

SetTopicAttributes, setTopicAttributes_topicArn - The ARN of the topic to modify.

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

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

  • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
  • DisplayName – The display name to use for a topic with SMS subscriptions.
  • Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
  • TracingConfig – Tracing mode of an Amazon SNS topic. By default TracingConfig is set to PassThrough, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.

The following attribute applies only to server-side-encryption:

  • KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.
  • SignatureVersion – The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS.

The following attribute applies only to FIFO topics:

  • ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.

    • By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.
    • When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

      (Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.

Request Lenses

setTopicAttributes_attributeName :: Lens' SetTopicAttributes Text Source #

A map of attributes with their corresponding values.

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

  • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
  • DisplayName – The display name to use for a topic with SMS subscriptions.
  • Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
  • TracingConfig – Tracing mode of an Amazon SNS topic. By default TracingConfig is set to PassThrough, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.

The following attribute applies only to server-side-encryption:

  • KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.
  • SignatureVersion – The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS.

The following attribute applies only to FIFO topics:

  • ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.

    • By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.
    • When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

      (Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.

Destructuring the Response

data SetTopicAttributesResponse Source #

See: newSetTopicAttributesResponse smart constructor.

Instances

Instances details
Generic SetTopicAttributesResponse Source # 
Instance details

Defined in Amazonka.SNS.SetTopicAttributes

Associated Types

type Rep SetTopicAttributesResponse :: Type -> Type #

Read SetTopicAttributesResponse Source # 
Instance details

Defined in Amazonka.SNS.SetTopicAttributes

Show SetTopicAttributesResponse Source # 
Instance details

Defined in Amazonka.SNS.SetTopicAttributes

NFData SetTopicAttributesResponse Source # 
Instance details

Defined in Amazonka.SNS.SetTopicAttributes

Eq SetTopicAttributesResponse Source # 
Instance details

Defined in Amazonka.SNS.SetTopicAttributes

type Rep SetTopicAttributesResponse Source # 
Instance details

Defined in Amazonka.SNS.SetTopicAttributes

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

newSetTopicAttributesResponse :: SetTopicAttributesResponse Source #

Create a value of SetTopicAttributesResponse with all optional fields omitted.

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