Class: Aws::SNS::Topic

Inherits:
Object
  • Object
show all
Extended by:
Deprecations
Defined in:
lib/aws-sdk-sns/topic.rb

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of Topic.

Overloads:

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

    Parameters:

    • arn (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ Topic

    Options Hash (options):

    • :arn (required, String)
    • :client (Client) 


22
23
24
25
26
27
28
 
# File '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 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:

  • (EmptyStructure) 


140
141
142
143
144
 
# File 'lib/aws-sdk-sns/topic.rb', line 140

def add_permission(options = {})
  options = options.merge(topic_arn: @arn)
  resp = @client.add_permission(options)
  resp.data
end

#arn ⇒ String

Returns:

  • (String) 


33
34
35
 
# File '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.

  • ‘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*.

^

[1]: docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html [2]: docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms [3]: docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters

Returns:

  • (Hash<String,String>) 


80
81
82
 
# File 'lib/aws-sdk-sns/topic.rb', line 80

def attributes
  data[:attributes]
end

#client ⇒ Client

Returns:



87
88
89
 
# File 'lib/aws-sdk-sns/topic.rb', line 87

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

Returns:



162
163
164
165
166
167
168
169
 
# File 'lib/aws-sdk-sns/topic.rb', line 162

def confirm_subscription(options = {})
  options = options.merge(topic_arn: @arn)
  resp = @client.confirm_subscription(options)
  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:



107
108
109
110
 
# File 'lib/aws-sdk-sns/topic.rb', line 107

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.



115
116
117
 
# File 'lib/aws-sdk-sns/topic.rb', line 115

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


topic.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure) 


176
177
178
179
180
 
# File 'lib/aws-sdk-sns/topic.rb', line 176

def delete(options = {})
  options = options.merge(topic_arn: @arn)
  resp = @client.delete_topic(options)
  resp.data
end

#identifiers ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


531
532
533
 
# File 'lib/aws-sdk-sns/topic.rb', line 531

def identifiers
  { arn: @arn }
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) 


97
98
99
100
101
 
# File 'lib/aws-sdk-sns/topic.rb', line 97

def load
  resp = @client.get_topic_attributes(topic_arn: @arn)
  @data = resp.data
  self
end

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

Examples:

Request syntax 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",
})

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 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:



317
318
319
320
321
 
# File 'lib/aws-sdk-sns/topic.rb', line 317

def publish(options = {})
  options = options.merge(topic_arn: @arn)
  resp = @client.publish(options)
  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) 


332
333
334
335
336
 
# File 'lib/aws-sdk-sns/topic.rb', line 332

def remove_permission(options = {})
  options = options.merge(topic_arn: @arn)
  resp = @client.remove_permission(options)
  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 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. Amazon SNS uses a SHA-256 hash to generate the `MessageDeduplicationId` using the body of the message (but not the attributes of the message).

    • When ‘ContentBasedDeduplication` is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.

    • If the queue has ‘ContentBasedDeduplication` set, your `MessageDeduplicationId` overrides the generated one.

    [1]: docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html [2]: docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms [3]: docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters

  • :attribute_value (String) —

    The new value for the attribute.

Returns:

  • (EmptyStructure) 


391
392
393
394
395
 
# File 'lib/aws-sdk-sns/topic.rb', line 391

def set_attributes(options = {})
  options = options.merge(topic_arn: @arn)
  resp = @client.set_topic_attributes(options)
  resp.data
end

#subscribe(options = {}) ⇒ Subscription

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 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:



495
496
497
498
499
500
501
502
 
# File 'lib/aws-sdk-sns/topic.rb', line 495

def subscribe(options = {})
  options = options.merge(topic_arn: @arn)
  resp = @client.subscribe(options)
  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:



511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
 
# File 'lib/aws-sdk-sns/topic.rb', line 511

def subscriptions(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(topic_arn: @arn)
    resp = @client.list_subscriptions_by_topic(options)
    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