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

Description

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.

Synopsis

Creating a Request

data CreateTopic Source #

Input for CreateTopic action.

See: newCreateTopic smart constructor.

Constructors

CreateTopic' 

Fields

  • attributes :: Maybe (HashMap Text Text)

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

    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 MessageDeduplicationId parameter for the Publish action.

  • dataProtectionPolicy :: Maybe Text

    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.

  • tags :: Maybe [Tag]

    The list of tags to add to a new topic.

    To be able to tag a topic on creation, you must have the sns:CreateTopic and sns:TagResource permissions.

  • name :: Text

    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.

Instances

Instances details
ToHeaders CreateTopic Source # 
Instance details

Defined in Amazonka.SNS.CreateTopic

Methods

toHeaders :: CreateTopic -> [Header] #

ToPath CreateTopic Source # 
Instance details

Defined in Amazonka.SNS.CreateTopic

ToQuery CreateTopic Source # 
Instance details

Defined in Amazonka.SNS.CreateTopic

AWSRequest CreateTopic Source # 
Instance details

Defined in Amazonka.SNS.CreateTopic

Associated Types

type AWSResponse CreateTopic #

Generic CreateTopic Source # 
Instance details

Defined in Amazonka.SNS.CreateTopic

Associated Types

type Rep CreateTopic :: Type -> Type #

Read CreateTopic Source # 
Instance details

Defined in Amazonka.SNS.CreateTopic

Show CreateTopic Source # 
Instance details

Defined in Amazonka.SNS.CreateTopic

NFData CreateTopic Source # 
Instance details

Defined in Amazonka.SNS.CreateTopic

Methods

rnf :: CreateTopic -> () #

Eq CreateTopic Source # 
Instance details

Defined in Amazonka.SNS.CreateTopic

Hashable CreateTopic Source # 
Instance details

Defined in Amazonka.SNS.CreateTopic

type AWSResponse CreateTopic Source # 
Instance details

Defined in Amazonka.SNS.CreateTopic

type Rep CreateTopic Source # 
Instance details

Defined in Amazonka.SNS.CreateTopic

type Rep CreateTopic = D1 ('MetaData "CreateTopic" "Amazonka.SNS.CreateTopic" "amazonka-sns-2.0-4k7AiJI7DyqhOUy5o4qb9" 'False) (C1 ('MetaCons "CreateTopic'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "dataProtectionPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateTopic Source #

Create a value of CreateTopic 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:

CreateTopic, createTopic_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.
  • 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 to 1.
  • 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.

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 MessageDeduplicationId parameter for the Publish action.

$sel:dataProtectionPolicy:CreateTopic', createTopic_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.

$sel:tags:CreateTopic', createTopic_tags - The list of tags to add to a new topic.

To be able to tag a topic on creation, you must have the sns:CreateTopic and sns:TagResource permissions.

$sel:name:CreateTopic', createTopic_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.

Request Lenses

createTopic_attributes :: Lens' CreateTopic (Maybe (HashMap Text 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 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 to 1.
  • 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.

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 MessageDeduplicationId parameter for the Publish action.

createTopic_dataProtectionPolicy :: Lens' CreateTopic (Maybe Text) Source #

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.

createTopic_tags :: Lens' CreateTopic (Maybe [Tag]) Source #

The list of tags to add to a new topic.

To be able to tag a topic on creation, you must have the sns:CreateTopic and sns:TagResource permissions.

createTopic_name :: Lens' CreateTopic Text Source #

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.

Destructuring the Response

data CreateTopicResponse Source #

Response from CreateTopic action.

See: newCreateTopicResponse smart constructor.

Constructors

CreateTopicResponse' 

Fields

Instances

Instances details
Generic CreateTopicResponse Source # 
Instance details

Defined in Amazonka.SNS.CreateTopic

Associated Types

type Rep CreateTopicResponse :: Type -> Type #

Read CreateTopicResponse Source # 
Instance details

Defined in Amazonka.SNS.CreateTopic

Show CreateTopicResponse Source # 
Instance details

Defined in Amazonka.SNS.CreateTopic

NFData CreateTopicResponse Source # 
Instance details

Defined in Amazonka.SNS.CreateTopic

Methods

rnf :: CreateTopicResponse -> () #

Eq CreateTopicResponse Source # 
Instance details

Defined in Amazonka.SNS.CreateTopic

type Rep CreateTopicResponse Source # 
Instance details

Defined in Amazonka.SNS.CreateTopic

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

newCreateTopicResponse Source #

Create a value of CreateTopicResponse 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:

CreateTopicResponse, createTopicResponse_topicArn - The Amazon Resource Name (ARN) assigned to the created topic.

$sel:httpStatus:CreateTopicResponse', createTopicResponse_httpStatus - The response's http status code.

Response Lenses

createTopicResponse_topicArn :: Lens' CreateTopicResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) assigned to the created topic.