Class: Aws::SNS::Topic

#initialize(arn, options = {}) ⇒ Topic
Parameters:
- arn (String)
Options Hash (options):
- :client (Client)
#initialize(options = {}) ⇒ Topic
Options Hash (options):
- :arn (required, String)
- :client (Client)

# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 22

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @arn = extract_arn(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
  @waiter_block_warned = false
end

Instance Method Details

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

Examples:

Request syntax with placeholder values


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

Parameters:

options (Hash) (defaults to: {}) —
({})

Options Hash (options):

:label (required, String) —
A unique identifier for the new policy statement.
:aws_account_id (required, Array<String>) —
The Amazon Web Services account IDs of the users (principals) who will be given access to the specified actions. The users must have Amazon Web Services account, 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:

(EmptyStructure)

# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 203

def add_permission(options = {})
  options = options.merge(topic_arn: @arn)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.add_permission(options)
  end
  resp.data
end

#arn ⇒ `String`

Returns:

(String)



33
34
35

# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 33

def arn
  @arn
end

#attributes ⇒ `Hash<String,String>`

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. For subscription confirmation and unsubscribe confirmation emails, the sender name is always "Amazon Web Services Notifications" regardless of this attribute.
EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy, taking system defaults into account.
MaximumMessageSize – The maximum size, in bytes, of a message that can be published to the topic. Amazon SNS returns this attribute only if you explicitly set it. If Amazon SNS doesn't return it, the topic uses the default of 262144 (256 KiB).
Owner – The Amazon Web Services account ID of the topic's owner.
Policy – The JSON serialization of the topic's access control policy.
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. The signature is a Base64-encoded SHA1withRSA signature.
- When you set SignatureVersion to 2. Amazon SNS uses a Base64-encoded SHA256withRSA signature.
  
  If the API response does not include the SignatureVersion attribute, it means that the SignatureVersion for the topic has value 1.
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.
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:

ArchivePolicy – The policy that sets the retention period for messages stored in the message archive of an Amazon SNS FIFO 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 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.
FifoTopic – When this is set to true, a FIFO topic is created.

Returns:

(Hash<String,String>)



140
141
142

# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 140

def attributes
  data[:attributes]
end

#client ⇒ `Client`

Returns:

(Client)



147
148
149

# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 147

def client
  @client
end

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

Examples:

Request syntax with placeholder values


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

Parameters:

options (Hash) (defaults to: {}) —
({})

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 Amazon Web Services signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires Amazon Web Services authentication.

Returns:

(Subscription)

# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 227

def confirm_subscription(options = {})
  options = options.merge(topic_arn: @arn)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.confirm_subscription(options)
  end
  Subscription.new(
    arn: resp.data.subscription_arn,
    client: @client
  )
end

#data ⇒ `Types::GetTopicAttributesResponse`

Returns the data for this Aws::SNS::Topic. Calls Client#get_topic_attributes if #data_loaded? is false.

Returns:

(Types::GetTopicAttributesResponse) —
Returns the data for this Aws::SNS::Topic. Calls Client#get_topic_attributes if #data_loaded? is false.

# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 169

def data
  load unless @data
  @data
end

#data_loaded? ⇒ `Boolean`

Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

(Boolean) —
Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



177
178
179

# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 177

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ `EmptyStructure`

Examples:

Request syntax with placeholder values


topic.delete()

Parameters:

options (Hash) (defaults to: {}) —
({})

Returns:

(EmptyStructure)

# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 243

def delete(options = {})
  options = options.merge(topic_arn: @arn)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.delete_topic(options)
  end
  resp.data
end

#load ⇒ `self` Also known as: reload

Loads, or reloads #data for the current Aws::SNS::Topic. Returns self making it possible to chain methods.

topic.reload.data

Returns:

(self)

# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 157

def load
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.get_topic_attributes(topic_arn: @arn)
  end
  @data = resp.data
  self
end

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

Examples:

Request syntax with placeholder values


topic.publish({
  target_arn: "String",
  phone_number: "PhoneNumber",
  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",
})

Parameters:

options (Hash) (defaults to: {}) —
({})

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. By default, a message can be at most 256 KiB in size (262,144 bytes, not 262,144 characters).
  
  When you publish to a topic, the maximum size is determined by the topic's MaximumMessageSize attribute, which supports values up to 1 MiB (1,048,576 bytes). Amazon SNS validates the combined size of the message body and message attributes against this value and returns an InvalidParameter error if the limit is exceeded.
  
  For more information, see Large message payloads in the Amazon SNS Developer Guide.
- 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 UTF-8 text with no line breaks or control characters, and 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 within the 5 minute minimum deduplication interval.
- The scope of deduplication depends on the FifoThroughputScope attribute, when set to Topic the message deduplication scope is across the entire topic, when set to MessageGroup the message deduplication scope is within each individual message group.
- If a message with a particular MessageDeduplicationId is sent successfully, subsequent messages within the deduplication scope and interval, with the same MessageDeduplicationId, are accepted successfully but aren't delivered.
- Every message must have a unique MessageDeduplicationId:
  - You may provide a MessageDeduplicationId explicitly.
  - If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your topic, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
  - If you don't provide a MessageDeduplicationId and the topic doesn't have ContentBasedDeduplication set, the action fails with an error.
  - If the topic has a ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
- When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication scope and interval are treated as duplicates and only one copy of the message is delivered.
- If you send one message with ContentBasedDeduplication enabled, and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates, within the deduplication scope and interval, and only one copy of the message is delivered.
:message_group_id (String) —
The MessageGroupId can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).

For FIFO topics: 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.

For standard topics: The MessageGroupId is optional and is forwarded only to Amazon SQS standard subscriptions to activate fair queues. The MessageGroupId is not used for, or sent to, any other endpoint types. When provided, the same validation rules apply as for FIFO topics.

Returns:

(Types::PublishResponse)

# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 439

def publish(options = {})
  options = options.merge(topic_arn: @arn)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.publish(options)
  end
  resp.data
end

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

Examples:

Request syntax with placeholder values


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

Parameters:

options (Hash) (defaults to: {}) —
({})

Options Hash (options):

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

Returns:

(EmptyStructure)

# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 456

def remove_permission(options = {})
  options = options.merge(topic_arn: @arn)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.remove_permission(options)
  end
  resp.data
end

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

Examples:

Request syntax with placeholder values


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

Parameters:

options (Hash) (defaults to: {}) —
({})

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, email, and email-json subscriptions. For email and email-json subscriptions, the display name is used as the sender name for regular notification messages. Subscription confirmation and unsubscribe confirmation emails always use "Amazon Web Services Notifications" as the sender name.
- MaximumMessageSize – The maximum size, in bytes, of a message that can be published to the topic. Valid values are 1024 to 1048576 (1 MiB). The default is 262144 (256 KiB).
  
  A topic with a MaximumMessageSize above 256 KiB must have 100 or fewer subscriptions, and each subscription must be an Amazon SQS, Amazon Data Firehose, or Lambda subscription.
  
  You can increase or decrease this value at any time. If the topic doesn't meet these requirements when you set a value above 256 KiB, Amazon SNS returns an InvalidParameter error. For more information, see Large message payloads in the Amazon SNS Developer Guide.
- 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 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.
- HTTP
  - HTTPSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.
  - HTTPSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an HTTP endpoint.
  - HTTPFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.
- Amazon Data Firehose
  - FirehoseSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Data Firehose endpoint.
  - FirehoseSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Data Firehose endpoint.
  - FirehoseFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Data Firehose endpoint.
- Lambda
  - LambdaSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint.
  - LambdaSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Lambda endpoint.
  - LambdaFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint.
- Platform application endpoint
  - ApplicationSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an platform application endpoint.
  - ApplicationSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an platform application endpoint.
  - ApplicationFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an platform application endpoint. In addition to being able to configure topic attributes for message delivery status of notification messages sent to Amazon SNS application endpoints, you can also configure application attributes for the delivery status of push notification messages sent to push notification services.
  For example, For more information, see Using Amazon SNS Application Attributes for Message Delivery Status.
- Amazon SQS
  - SQSSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
  - SQSSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
  - SQSFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
The <ENDPOINT>SuccessFeedbackRoleArn and <ENDPOINT>FailureFeedbackRoleArn attributes are used to give Amazon SNS write access to use CloudWatch Logs on your behalf. The <ENDPOINT>SuccessFeedbackSampleRate attribute is for specifying the sample rate percentage (0-100) of successfully delivered messages. After you configure the <ENDPOINT>FailureFeedbackRoleArn attribute, then all failed message deliveries generate CloudWatch Logs.

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. By default, SignatureVersion is set to 1.
The following attribute applies only to FIFO topics:
- ArchivePolicy – The policy that sets the retention period for messages stored in the message archive of an Amazon SNS FIFO topic.
- 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. ^
- FifoThroughputScope – Enables higher throughput for your FIFO topic by adjusting the scope of deduplication. This attribute has two possible values:
  - Topic – The scope of message deduplication is across the entire topic. This is the default value and maintains existing behavior, with a maximum throughput of 3000 messages per second or 20MB per second, whichever comes first.
  - MessageGroup – The scope of deduplication is within each individual message group, which enables higher throughput per topic subject to regional quotas. For more information on quotas or to request an increase, see Amazon SNS service quotas in the Amazon Web Services General Reference.
:attribute_value (String) —
The new value for the attribute.

Returns:

(EmptyStructure)

# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 662

def set_attributes(options = {})
  options = options.merge(topic_arn: @arn)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.set_topic_attributes(options)
  end
  resp.data
end

Examples:

Request syntax with placeholder values


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

Parameters:

options (Hash) (defaults to: {}) —
({})

Options Hash (options):

:protocol (required, String) —
The protocol that 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 Lambda function
- firehose – delivery of JSON-encoded message to an Amazon Data Firehose delivery stream.
: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 Lambda function.
- For the firehose protocol, the endpoint is the ARN of an Amazon Data Firehose delivery stream.
: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 Subscribe 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.
- FilterPolicyScope – This attribute lets you choose the filtering scope by using one of the following string value types:
  - MessageAttributes (default) – The filter is applied on the message attributes.
  - MessageBody – The filter is applied on the message body.
- 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.
The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:
- SubscriptionRoleArn – The ARN of the IAM role that has the following:
  - Permission to write to the Firehose delivery stream
  - Amazon SNS listed as a trusted entity Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to Firehose delivery streams in the Amazon SNS Developer Guide.
The following attributes apply only to FIFO topics:
- ReplayPolicy – Adds or updates an inline policy document for a subscription to replay messages stored in the specified Amazon SNS topic.
- ReplayStatus – Retrieves the status of the subscription message replay, which can be one of the following:
  - Completed – The replay has successfully redelivered all messages, and is now delivering newly published messages. If an ending point was specified in the ReplayPolicy then the subscription will no longer receive newly published messages.
  - In progress – The replay is currently replaying the selected messages.
  - Failed – The replay was unable to complete.
  - Pending – The default state while the replay initiates.
: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)

# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 816

def subscribe(options = {})
  options = options.merge(topic_arn: @arn)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.subscribe(options)
  end
  Subscription.new(
    arn: resp.data.subscription_arn,
    client: @client
  )
end

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

Examples:

Request syntax with placeholder values


topic.subscriptions()

Parameters:

options (Hash) (defaults to: {}) —
({})

Returns:

(Subscription::Collection)

# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 834

def subscriptions(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(topic_arn: @arn)
    resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      @client.list_subscriptions_by_topic(options)
    end
    resp.each_page do |page|
      batch = []
      page.data.subscriptions.each do |s|
        batch << Subscription.new(
          arn: s.subscription_arn,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  Subscription::Collection.new(batches)
end

Class: Aws::SNS::Topic

Defined Under Namespace

Read-Only Attributes collapse

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

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

Instance Method Details

#add_permission(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values

#arn ⇒ String

#attributes ⇒ Hash<String,String>

#client ⇒ Client

#confirm_subscription(options = {}) ⇒ Subscription

Examples:

Request syntax with placeholder values

#data ⇒ Types::GetTopicAttributesResponse

#data_loaded? ⇒ Boolean

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values

#load ⇒ self Also known as: reload

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

Examples:

Request syntax with placeholder values

#remove_permission(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values

#set_attributes(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values

#subscribe(options = {}) ⇒ Subscription

Examples:

Request syntax with placeholder values

#subscriptions(options = {}) ⇒ Subscription::Collection

Examples:

Request syntax with placeholder values

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

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

#arn ⇒ `String`

#attributes ⇒ `Hash<String,String>`

#client ⇒ `Client`

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

#data ⇒ `Types::GetTopicAttributesResponse`

#data_loaded? ⇒ `Boolean`

#delete(options = {}) ⇒ `EmptyStructure`

#load ⇒ `self` Also known as: reload

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

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

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

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

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