You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SNS::Topic

Inherits:

Resources::Resource

Object
Resources::Resource
Aws::SNS::Topic

show all

Defined in:: (unknown)

Instance Attribute Summary collapse

#arn ⇒ String readonly
#attributes ⇒ Hash<String,String> readonly
A map of the topic\'s attributes.

Attributes inherited from Resources::Resource

#client, #identifiers

Instance Method Summary collapse

#add_permission(options = {}) ⇒ Struct
Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.

.
#confirm_subscription(options = {}) ⇒ Subscription
#delete ⇒ Struct
Deletes a topic and all its subscriptions.
#initialize ⇒ Object constructor
#publish(options = {}) ⇒ Types::PublishResponse
Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone number, or a message to a mobile platform endpoint (when you specify the TargetArn).

If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic.
#remove_permission(options = {}) ⇒ Struct
Removes a statement from a topic's access control policy.

.
#set_attributes(options = {}) ⇒ Struct
Allows a topic owner to set an attribute of the topic to a new value.

.
#subscribe(options = {}) ⇒ Subscription
#subscriptions(options = {}) ⇒ Collection<Subscription>
Returns a Collection of Subscription resources.

Methods inherited from Resources::Resource

add_data_attribute, add_identifier, #data, data_attributes, #data_loaded?, identifiers, #load, #wait_until

Methods included from Resources::OperationMethods

#add_batch_operation, #add_operation, #batch_operation, #batch_operation_names, #batch_operations, #operation, #operation_names, #operations

Constructor Details

#initialize(arn, options = {}) ⇒ `Object` #initialize(options = {}) ⇒ `Object`

Overloads:

#initialize(arn, options = {}) ⇒ Object
Parameters:
- arn (String)
Options Hash (options):
- :client (Client) —
  When `:client is not given, the options hash is used to construct a new Client object.
#initialize(options = {}) ⇒ Object
Options Hash (options):
- :arn (required, String)
- :client (Client) —
  When `:client is not given, the options hash is used to construct a new Client object.

Instance Attribute Details

#arn ⇒ `String` (readonly)

Returns:

(String)

#attributes ⇒ `Hash<String,String>` (readonly)

A map of the topic\'s attributes. Attributes in this map include the following:

DeliveryPolicy – The JSON serialization of the topic\'s delivery policy.
DisplayName – The human-readable name used in the From field for notifications to email and email-json endpoints.
Owner – The AWS account ID of the topic\'s owner.
Policy – The JSON serialization of the topic\'s access control policy.
SubscriptionsConfirmed – The number of confirmed subscriptions for the topic.
SubscriptionsDeleted – The number of deleted subscriptions for the topic.
SubscriptionsPending – The number of subscriptions pending confirmation for the topic.
TopicArn – The topic\'s ARN.
EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy, taking system defaults into account.

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.

Returns:

(Hash<String,String>) —
A map of the topic\'s attributes.

Instance Method Details

#add_permission(options = {}) ⇒ `Struct`

Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.

Examples:

Request syntax example with placeholder values


topic.add_permission({
  label: "label", # required
  aws_account_id: ["delegate"], # required
  action_name: ["action"], # required
})

Options Hash (options):

:label (required, String) —
A unique identifier for the new policy statement.
:aws_account_id (required, Array<String>) —
The AWS account IDs of the users (principals) who will be given access to the specified actions. The users must have AWS accounts, but do not need to be signed up for this service.
:action_name (required, Array<String>) —
The action you want to allow for the specified principal(s).

Valid values: Any Amazon SNS action name, for example Publish.

Returns:

(Struct) —
Returns an empty response.

See Also:

Client#add_permission

#confirm_subscription(options = {}) ⇒ `Subscription`

Examples:

Request syntax example with placeholder values


topic.confirm_subscription({
  token: "token", # required
  authenticate_on_unsubscribe: "authenticateOnUnsubscribe",
})

Basic usage

subscription = topic.confirm_subscription(options)
subscription.arn
#=> "subscription-arn"

Options Hash (options):

:token (required, String) —
Short-lived token sent to an endpoint during the Subscribe action.
:authenticate_on_unsubscribe (String) —
Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.

Returns:

(Subscription)

See Also:

#delete ⇒ `Struct`

Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error.

Examples:

Request syntax example with placeholder values


topic.delete()

Returns:

(Struct) —
Returns an empty response.

See Also:

Client#delete_topic

#publish(options = {}) ⇒ `Types::PublishResponse`

Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone number, or a message to a mobile platform endpoint (when you specify the TargetArn).

If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic. The format of the message depends on the notification protocol for each subscribed endpoint.

When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it shortly.

To use the Publish action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for the TargetArn parameter. The EndpointArn is returned when making a call with the CreatePlatformEndpoint action.

For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices.

You can publish messages only to topics and endpoints in the same AWS Region.

Examples:

Request syntax example with placeholder values


topic.publish({
  target_arn: "String",
  phone_number: "String",
  message: "message", # required
  subject: "subject",
  message_structure: "messageStructure",
  message_attributes: {
    "String" => {
      data_type: "String", # required
      string_value: "String",
      binary_value: "data",
    },
  },
  message_deduplication_id: "String",
  message_group_id: "String",
})

Options Hash (options):

:target_arn (String) —
If you don\'t specify a value for the TargetArn parameter, you must specify a value for the PhoneNumber or TopicArn parameters.
:phone_number (String) —
The phone number to which you want to deliver an SMS message. Use E.164 format.

If you don\'t specify a value for the PhoneNumber parameter, you must specify a value for the TargetArn or TopicArn parameters.
:message (required, String) —
The message you want to send.

If you are publishing to a topic and you want to send the same message to all transport protocols, include the text of the message as a String value. If you want to send different messages for each transport protocol, set the value of the MessageStructure parameter to json and use a JSON object for the Message parameter.

Constraints:
- With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).
- For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters.
  
  If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren\'t truncated mid-word but are cut off at whole-word boundaries.
  
  The total size limit for a single SMS Publish action is 1,600 characters.
JSON-specific constraints:
- Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
- The values will be parsed (unescaped) before they are used in outgoing messages.
- Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
- Values have a minimum length of 0 (the empty string, \"\", is allowed).
- Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
- Non-string values will cause the key to be ignored.
- Keys that do not correspond to supported transport protocols are ignored.
- Duplicate keys are not allowed.
- Failure to parse or validate any key or value in the message will cause the Publish call to return an error (no partial delivery).
:subject (String) —
Optional parameter to be used as the \"Subject\" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.

Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
:message_structure (String) —
Set MessageStructure to json if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set MessageStructure to json, the value of the Message parameter must:
- be a syntactically valid JSON object; and
- contain at least a top-level JSON key of \"default\" with a value that is a string.
You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., \"http\").

Valid value: json
:message_attributes (Hash<String,Types::MessageAttributeValue>) —
Message attributes for Publish action.
:message_deduplication_id (String) —
This parameter applies only to FIFO (first-in-first-out) topics. The MessageDeduplicationId can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_``{|}`~).

Every message must have a unique MessageDeduplicationId, which is a token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any message sent with the same MessageDeduplicationId during the 5-minute deduplication interval is treated as a duplicate.

If the topic has ContentBasedDeduplication set, the system generates a MessageDeduplicationId based on the contents of the message. Your MessageDeduplicationId overrides the generated one.
:message_group_id (String) —
This parameter applies only to FIFO (first-in-first-out) topics. The MessageGroupId can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_``{|}`~).

The MessageGroupId is a tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). Every message must include a MessageGroupId.

Returns:

(Types::PublishResponse) —
Returns a response object which responds to the following methods:
- #message_id => String
- #sequence_number => String

See Also:

Client#publish

#remove_permission(options = {}) ⇒ `Struct`

Removes a statement from a topic's access control policy.

Examples:

Request syntax example with placeholder values


topic.remove_permission({
  label: "label", # required
})

Options Hash (options):

:label (required, String) —
The unique label of the statement you want to remove.

Returns:

(Struct) —
Returns an empty response.

See Also:

Client#remove_permission

#set_attributes(options = {}) ⇒ `Struct`

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

Examples:

Request syntax example with placeholder values


topic.set_attributes({
  attribute_name: "attributeName", # required
  attribute_value: "attributeValue",
})

Options Hash (options):

:attribute_name (required, String) —
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.
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 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 the MessageDeduplicationId parameter for the Publish action.
:attribute_value (String) —
The new value for the attribute.

Returns:

(Struct) —
Returns an empty response.

See Also:

Client#set_topic_attributes

Examples:

Request syntax example with placeholder values


topic.subscribe({
  protocol: "protocol", # required
  endpoint: "endpoint",
  attributes: {
    "attributeName" => "attributeValue",
  },
  return_subscription_arn: false,
})

Basic usage

subscription = topic.subscribe(options)
subscription.arn
#=> "subscription-arn"

Options Hash (options):

:protocol (required, String) —
The protocol you want to use. Supported protocols include:
- http – delivery of JSON-encoded message via HTTP POST
- https – delivery of JSON-encoded message via HTTPS POST
- email – delivery of message via SMTP
- email-json – delivery of JSON-encoded message via SMTP
- sms – delivery of message via SMS
- sqs – delivery of JSON-encoded message to an Amazon SQS queue
- application – delivery of JSON-encoded message to an EndpointArn for a mobile app and device.
- lambda – delivery of JSON-encoded message to an Amazon Lambda function.
:endpoint (String) —
The endpoint that you want to receive notifications. Endpoints vary by protocol:
- For the http protocol, the (public) endpoint is a URL beginning with http://
- For the https protocol, the (public) endpoint is a URL beginning with https://
- For the email protocol, the endpoint is an email address
- For the email-json protocol, the endpoint is an email address
- For the sms protocol, the endpoint is a phone number of an SMS-enabled device
- For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue
- For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
- For the lambda protocol, the endpoint is the ARN of an Amazon Lambda function.
:attributes (Hash<String,String>) —
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.
- FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.
- RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.
- RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can\'t be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
:return_subscription_arn (Boolean) —
Sets whether the response from the Subscribe request includes the subscription ARN, even if the subscription is not yet confirmed.

If you set this parameter to true, the response includes the ARN in all cases, even if the subscription is not yet confirmed. In addition to the ARN for confirmed subscriptions, the response also includes the pending subscription ARN value for subscriptions that aren\'t yet confirmed. A subscription becomes confirmed when the subscriber calls the ConfirmSubscription action with a confirmation token.

The default value is false.

Returns:

(Subscription)

See Also:

#confirm_subscription
#subscriptions
Client#subscribe

#subscriptions(options = {}) ⇒ `Collection<Subscription>`

Returns a Collection of Subscription resources. No API requests are made until you call an enumerable method on the collection. Client#list_subscriptions_by_topic will be called multiple times until every Subscription has been yielded.

Examples:

Request syntax example with placeholder values


topic.subscriptions({
  next_token: "nextToken",
})

Enumerating Subscription resources.

topic.subscriptions.each do |subscription|
  # yields each subscription
end

Enumerating Subscription resources with a limit.

topic.subscriptions.limit(10).each do |subscription|
  # yields at most 10 subscriptions
end

Options Hash (options):

:next_token (String) —
Token returned by the previous ListSubscriptionsByTopic request.

Returns:

(Collection<Subscription>)

See Also:

Class: Aws::SNS::Topic

Instance Attribute Summary collapse

Attributes inherited from Resources::Resource

Instance Method Summary collapse

Methods inherited from Resources::Resource

Methods included from Resources::OperationMethods

Constructor Details

#initialize(arn, options = {}) ⇒ Object #initialize(options = {}) ⇒ Object

Instance Attribute Details

#arn ⇒ String (readonly)

#attributes ⇒ Hash<String,String> (readonly)

Instance Method Details

#add_permission(options = {}) ⇒ Struct

#confirm_subscription(options = {}) ⇒ Subscription

#delete ⇒ Struct

#publish(options = {}) ⇒ Types::PublishResponse

#remove_permission(options = {}) ⇒ Struct

#set_attributes(options = {}) ⇒ Struct

#subscribe(options = {}) ⇒ Subscription

#subscriptions(options = {}) ⇒ Collection<Subscription>

#initialize(arn, options = {}) ⇒ `Object` #initialize(options = {}) ⇒ `Object`

#arn ⇒ `String` (readonly)

#attributes ⇒ `Hash<String,String>` (readonly)

#add_permission(options = {}) ⇒ `Struct`

#confirm_subscription(options = {}) ⇒ `Subscription`

#delete ⇒ `Struct`

#publish(options = {}) ⇒ `Types::PublishResponse`

#remove_permission(options = {}) ⇒ `Struct`

#set_attributes(options = {}) ⇒ `Struct`

#subscribe(options = {}) ⇒ `Subscription`

#subscriptions(options = {}) ⇒ `Collection<Subscription>`