createTopic method

Future<CreateTopicResponse> createTopic({
  1. required String name,
  2. Map<String, String>? attributes,
  3. List<Tag>? tags,
})

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 https://aws.amazon.com/sns. 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.

May throw InvalidParameterException. May throw TopicLimitExceededException. May throw InternalErrorException. May throw AuthorizationErrorException. May throw InvalidSecurityException. May throw TagLimitExceededException. May throw StaleTagException. May throw TagPolicyException. May throw ConcurrentAccessException.

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

Parameter attributes : A map of attributes with their corresponding values.

The following lists the 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.
The following attribute applies only to server-side-encryption:
  • KmsMasterKeyId – The ID of an AWS-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 AWS Key Management Service API Reference.
The following attributes apply only to FIFO topics:
  • FifoTopic – When this is set to true, a FIFO topic is created.
  • 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 the MessageDeduplicationId parameter for the Publish action.

Parameter tags : The list of tags to add to a new topic.

Implementation

Future<CreateTopicResponse> createTopic({
  required String name,
  Map<String, String>? attributes,
  List<Tag>? tags,
}) async {
  ArgumentError.checkNotNull(name, 'name');
  final $request = <String, dynamic>{};
  $request['Name'] = name;
  attributes?.also((arg) => $request['Attributes'] = arg);
  tags?.also((arg) => $request['Tags'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'CreateTopic',
    version: '2010-03-31',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['CreateTopicInput'],
    shapes: shapes,
    resultWrapper: 'CreateTopicResult',
  );
  return CreateTopicResponse.fromXml($result);
}