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 show all
Defined in:
(unknown)

Instance Attribute Summary collapse

Attributes inherited from Resources::Resource

#client, #identifiers

Instance Method Summary collapse

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

#arnString (readonly)

Returns:

  • (String)

#attributesHash<String,String> (readonly)

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

    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.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

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

See Also:

#deleteStruct

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:

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

Sends a message to all of a topic's subscribed endpoints. When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it to the topic's subscribers shortly. The format of the outgoing message to each subscribed endpoint depends on the notification protocol.

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.

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

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:

See Also:

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

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

    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:

  • (Struct)

    Returns an empty response.

See Also:

#subscribe(options = {}) ⇒ Subscription

Examples:

Request syntax example with placeholder values


topic.subscribe({
  protocol: "protocol", # required
  endpoint: "endpoint",
})

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 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://%22

    • For the https protocol, the endpoint is a URL beginning with \"https://%22

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

See Also:

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

See Also: