CreateTopic
Creates a topic to which notifications can be published. Users can create at most 100,000 standard topics (at most 1,000 FIFO topics). For more information, see Creating an Amazon SNS topic in the Amazon SNS Developer Guide. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- Attributes
- Attributes.entry.N.key (key)
- Attributes.entry.N.value (value)
-
A map of attributes with their corresponding values.
The following lists names, descriptions, and values of the special request parameters that the
CreateTopic
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. -
FifoTopic
– Set to true to create a FIFO topic. -
Policy
– The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic. -
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. By default,SignatureVersion
is set to1
. -
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 toActive
, 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:
The following attributes apply only to FIFO topics:
-
ArchivePolicy
– Adds or updates an inline policy document to archive messages stored in the specified Amazon SNS topic. -
BeginningArchiveTime
– The earliest starting point at which a message in the topic’s archive can be replayed from. This point in time is based on the configured message retention period set by the topic’s message archiving policy. -
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.
-
Type: String to string map
Required: No
-
- DataProtectionPolicy
-
The body of the policy document you want to use for this topic.
You can only add one policy per topic.
The policy must be in JSON string format.
Length Constraints: Maximum length of 30,720.
Type: String
Required: No
- Name
-
The name of the topic you want to create.
Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.
For a FIFO (first-in-first-out) topic, the name must end with the
.fifo
suffix.Type: String
Required: Yes
- Tags.member.N
-
The list of tags to add to a new topic.
Note
To be able to tag a topic on creation, you must have the
sns:CreateTopic
andsns:TagResource
permissions.Type: Array of Tag objects
Required: No
Response Elements
The following element is returned by the service.
- TopicArn
-
The Amazon Resource Name (ARN) assigned to the created topic.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AuthorizationError
-
Indicates that the user has been denied access to the requested resource.
HTTP Status Code: 403
- ConcurrentAccess
-
Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially.
HTTP Status Code: 400
- InternalError
-
Indicates an internal service error.
HTTP Status Code: 500
- InvalidParameter
-
Indicates that a request parameter does not comply with the associated constraints.
HTTP Status Code: 400
- InvalidSecurity
-
The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4.
HTTP Status Code: 403
- StaleTag
-
A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation.
HTTP Status Code: 400
- TagLimitExceeded
-
Can't add more than 50 tags to a topic.
HTTP Status Code: 400
- TagPolicy
-
The request doesn't comply with the IAM tag policy. Correct your request and then retry it.
HTTP Status Code: 400
- TopicLimitExceeded
-
Indicates that the customer already owns the maximum allowed number of topics.
HTTP Status Code: 403
Examples
The structure of AUTHPARAMS
depends on the signature of the API request.
For more information, see Examples
of the complete Signature Version 4 signing process (Python) in the
AWS General Reference.
Example
This example illustrates one usage of CreateTopic.
Sample Request
https://sns.us-east-2.amazonaws.com/?Action=CreateTopic
&Name=My-Topic
&Version=2010-03-31
&AUTHPARAMS
Sample Response
<CreateTopicResponse xmlns="https://sns.amazonaws.com/doc/2010-03-31/">
<CreateTopicResult>
<TopicArn>arn:aws:sns:us-east-2:123456789012:My-Topic</TopicArn>
</CreateTopicResult>
<ResponseMetadata>
<RequestId>a8dec8b3-33a4-11df-8963-01868b7c937a</RequestId>
</ResponseMetadata>
</CreateTopicResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: