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

Class: Aws::SNS::Topic

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

Defined Under Namespace

Classes: Collection

Actions collapse

Associations collapse

Read-Only Attributes 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)


19
20
21
22
23
24
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 19

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

Returns:

  • (EmptyStructure)


121
122
123
124
125
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 121

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

#arnString

Returns:

  • (String)


29
30
31
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 29

def arn
  @arn
end

#attributesHash<String,String>

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

  • TopicArn -- the topic's ARN

  • Owner -- the AWS account ID of the topic's owner

  • Policy -- the JSON serialization of the topic's access control policy

  • DisplayName -- the human-readable name used in the "From" field for notifications to email and email-json endpoints

  • SubscriptionsPending -- the number of subscriptions pending confirmation on this topic

  • SubscriptionsConfirmed -- the number of confirmed subscriptions on this topic

  • SubscriptionsDeleted -- the number of deleted subscriptions on this topic

  • DeliveryPolicy -- the JSON serialization of the topic's delivery policy

  • EffectiveDeliveryPolicy -- the JSON serialization of the effective delivery policy that takes into account system defaults

Returns:

  • (Hash<String,String>)


61
62
63
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 61

def attributes
  data[:attributes]
end

#clientClient

Returns:



68
69
70
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 68

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:



143
144
145
146
147
148
149
150
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 143

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

#dataTypes::GetTopicAttributesResponse

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

Returns:



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

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.



96
97
98
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 96

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


topic.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure)


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

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

#loadself 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)


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

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

Parameters:

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

    ({})

Options Hash (options):

  • :target_arn (String)

    Either TopicArn or EndpointArn, but not both.

    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 to the topic.

    If 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: Messages must be UTF-8 encoded strings at most 256 KB in size (262144 bytes, not 262144 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").

    For information about sending different messages for each protocol using the AWS Management Console, go to Create Different Messages for Each Protocol in the Amazon Simple Notification Service Getting Started Guide.

    Valid value: json

  • :message_attributes (Hash<String,Types::MessageAttributeValue>)

    Message attributes for Publish action.

Returns:



266
267
268
269
270
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 266

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)


281
282
283
284
285
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 281

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)

    The name of the attribute you want to set. Only a subset of the topic's attributes are mutable.

    Valid values: Policy | DisplayName | DeliveryPolicy

  • :attribute_value (String)

    The new value for the attribute.

Returns:

  • (EmptyStructure)


302
303
304
305
306
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 302

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

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 AWS Lambda function.

  • :endpoint (String)

    The endpoint that you want to receive notifications. Endpoints vary by protocol:

    • For the http protocol, the endpoint is an URL beginning with "http://"

    • For the https protocol, the 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 AWS Lambda function.

Returns:



361
362
363
364
365
366
367
368
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 361

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:



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
# File 'gems/aws-sdk-sns/lib/aws-sdk-sns/topic.rb', line 377

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