Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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
- data SetTopicAttributes = SetTopicAttributes' {
- attributeValue :: Maybe Text
- topicArn :: Text
- attributeName :: Text
- newSetTopicAttributes :: Text -> Text -> SetTopicAttributes
- setTopicAttributes_attributeValue :: Lens' SetTopicAttributes (Maybe Text)
- setTopicAttributes_topicArn :: Lens' SetTopicAttributes Text
- setTopicAttributes_attributeName :: Lens' SetTopicAttributes Text
- data SetTopicAttributesResponse = SetTopicAttributesResponse' {
- newSetTopicAttributesResponse :: SetTopicAttributesResponse
Creating a Request
data SetTopicAttributes Source #
Input for SetTopicAttributes action.
See: newSetTopicAttributes
smart constructor.
SetTopicAttributes' | |
|
Instances
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 defaultTracingConfig
is set toPassThrough
, 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 tofalse
. If you create a FIFO topic and this attribute isfalse
, you must specify a value for theMessageDeduplicationId
parameter for the Publish action. When you set
ContentBasedDeduplication
totrue
, Amazon SNS uses a SHA-256 hash to generate theMessageDeduplicationId
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 thePublish
action.
- By default,
Request Lenses
setTopicAttributes_attributeValue :: Lens' SetTopicAttributes (Maybe Text) Source #
The new value for the attribute.
setTopicAttributes_topicArn :: Lens' SetTopicAttributes Text Source #
The ARN of the topic to modify.
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 defaultTracingConfig
is set toPassThrough
, 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 tofalse
. If you create a FIFO topic and this attribute isfalse
, you must specify a value for theMessageDeduplicationId
parameter for the Publish action. When you set
ContentBasedDeduplication
totrue
, Amazon SNS uses a SHA-256 hash to generate theMessageDeduplicationId
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 thePublish
action.
- By default,
Destructuring the Response
data SetTopicAttributesResponse Source #
See: newSetTopicAttributesResponse
smart constructor.
Instances
newSetTopicAttributesResponse :: SetTopicAttributesResponse Source #
Create a value of SetTopicAttributesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.