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

Class: Aws::SNS::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

An API client for Amazon Simple Notification Service. To construct a client, you need to configure a :region and :credentials.

sns = Aws::SNS::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

  • ENV['AWS_REGION']
  • Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

  • ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
  • Aws.config[:credentials]
  • The shared credentials ini file at ~/.aws/credentials (more information)
  • From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::SNS::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ Aws::SNS::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String) —

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :active_endpoint_cache (Boolean) —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.

  • :credentials (required, Credentials) —

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Plugins::RequestSigner for more details.
  • :disable_host_prefix_injection (Boolean) —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.

  • :endpoint (String) —

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.

  • :endpoint_cache_max_entries (Integer) —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_max_threads (Integer) —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_poll_interval (Integer) —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec. See Plugins::EndpointDiscovery for more details.

  • :endpoint_discovery (Boolean) —

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :http_continue_timeout (Float) — default: 1 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the logger at. See Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter) —

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.

  • :logger (Logger) — default: nil —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.

  • :profile (String) —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String) —

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials. See Plugins::RetryErrors for more details.

  • :secret_access_key (String) —

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :session_token (String) —

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :ssl_ca_bundle (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled. See Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

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 with placeholder values


resp = client.add_permission({
  topic_arn: "topicARN", # required
  label: "label", # required
  aws_account_id: ["delegate"], # required
  action_name: ["action"], # required
})

Options Hash (options):

  • :topic_arn (required, String) —

    The ARN of the topic whose access control policy you wish to modify.

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

#check_if_phone_number_is_opted_out(options = {}) ⇒ Types::CheckIfPhoneNumberIsOptedOutResponse

Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your account. You cannot send SMS messages to a number that is opted out.

To resume sending messages, you can opt in the number by using the OptInPhoneNumber action.

Examples:

Request syntax with placeholder values


resp = client.check_if_phone_number_is_opted_out({
  phone_number: "PhoneNumber", # required
})

Response structure


resp.is_opted_out #=> true/false

Options Hash (options):

  • :phone_number (required, String) —

    The phone number for which you want to check the opt out status.

Returns:

See Also:

#confirm_subscription(options = {}) ⇒ Types::ConfirmSubscriptionResponse

Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier Subscribe action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the AuthenticateOnUnsubscribe flag is set to "true".

Examples:

Request syntax with placeholder values


resp = client.confirm_subscription({
  topic_arn: "topicARN", # required
  token: "token", # required
  authenticate_on_unsubscribe: "authenticateOnUnsubscribe",
})

Response structure


resp.subscription_arn #=> String

Options Hash (options):

  • :topic_arn (required, String) —

    The ARN of the topic for which you wish to confirm a subscription.

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

#create_platform_application(options = {}) ⇒ Types::CreatePlatformApplicationResponse

Creates a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action.

PlatformPrincipal and PlatformCredential are received from the notification service.

  • For ADM, PlatformPrincipal is client id and PlatformCredential is client secret.

  • For Baidu, PlatformPrincipal is API key and PlatformCredential is secret key.

  • For APNS and APNS_SANDBOX, PlatformPrincipal is SSL certificate and PlatformCredential is private key.

  • For GCM (Firebase Cloud Messaging), there is no PlatformPrincipal and the PlatformCredential is API key.

  • For MPNS, PlatformPrincipal is TLS certificate and PlatformCredential is private key.

  • For WNS, PlatformPrincipal is Package Security Identifier and PlatformCredential is secret key.

You can use the returned PlatformApplicationArn as an attribute for the CreatePlatformEndpoint action.

Examples:

Request syntax with placeholder values


resp = client.create_platform_application({
  name: "String", # required
  platform: "String", # required
  attributes: { # required
    "String" => "String",
  },
})

Response structure


resp.platform_application_arn #=> String

Options Hash (options):

  • :name (required, String) —

    Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.

  • :platform (required, String) —

    The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud Messaging).

  • :attributes (required, Hash<String,String>) —

    For a list of attributes, see SetPlatformApplicationAttributes

Returns:

See Also:

#create_platform_endpoint(options = {}) ⇒ Types::CreateEndpointResponse

Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication. You can use the returned EndpointArn to send a message to a mobile app or by the Subscribe action for subscription to a topic. The CreatePlatformEndpoint action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more information, see Using Amazon SNS Mobile Push Notifications.

When using CreatePlatformEndpoint with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see Creating an Amazon SNS Endpoint for Baidu.

Examples:

Request syntax with placeholder values


resp = client.create_platform_endpoint({
  platform_application_arn: "String", # required
  token: "String", # required
  custom_user_data: "String",
  attributes: {
    "String" => "String",
  },
})

Response structure


resp.endpoint_arn #=> String

Options Hash (options):

  • :platform_application_arn (required, String) —

    PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.

  • :token (required, String) —

    Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM (Firebase Cloud Messaging) or ADM, the device token equivalent is called the registration ID.

  • :custom_user_data (String) —

    Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

  • :attributes (Hash<String,String>) —

    For a list of attributes, see SetEndpointAttributes.

Returns:

See Also:

#create_topic(options = {}) ⇒ Types::CreateTopicResponse

Creates a topic to which notifications can be published. Users can create at most 100,000 standard topics (at most 1,000 FIFO topics). For more information, see https://aws.amazon.com/sns. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.

Examples:

Request syntax with placeholder values


resp = client.create_topic({
  name: "topicName", # required
  attributes: {
    "attributeName" => "attributeValue",
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.topic_arn #=> String

Options Hash (options):

  • :name (required, String) —

    The name of the topic you want to create.

    Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.

    For a FIFO (first-in-first-out) topic, the name must end with the .fifo suffix.

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

    • FifoTopic – Set to true to create a FIFO topic.

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

  • :tags (Array<Types::Tag>) —

    The list of tags to add to a new topic.

    To be able to tag a topic on creation, you must have the sns:CreateTopic and sns:TagResource permissions.

Returns:

See Also:

#delete_endpoint(options = {}) ⇒ Struct

Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications.

When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the topic.

Examples:

Request syntax with placeholder values


resp = client.delete_endpoint({
  endpoint_arn: "String", # required
})

Options Hash (options):

  • :endpoint_arn (required, String) —

    EndpointArn of endpoint to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#delete_platform_application(options = {}) ⇒ Struct

Deletes a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications.

Examples:

Request syntax with placeholder values


resp = client.delete_platform_application({
  platform_application_arn: "String", # required
})

Options Hash (options):

  • :platform_application_arn (required, String) —

    PlatformApplicationArn of platform application object to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#delete_topic(options = {}) ⇒ 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 with placeholder values


resp = client.delete_topic({
  topic_arn: "topicARN", # required
})

Options Hash (options):

  • :topic_arn (required, String) —

    The ARN of the topic you want to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#get_endpoint_attributes(options = {}) ⇒ Types::GetEndpointAttributesResponse

Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.

Examples:

Request syntax with placeholder values


resp = client.get_endpoint_attributes({
  endpoint_arn: "String", # required
})

Response structure


resp.attributes #=> Hash
resp.attributes["String"] #=> String

Options Hash (options):

  • :endpoint_arn (required, String) —

    EndpointArn for GetEndpointAttributes input.

Returns:

See Also:

#get_platform_application_attributes(options = {}) ⇒ Types::GetPlatformApplicationAttributesResponse

Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications.

Examples:

Request syntax with placeholder values


resp = client.get_platform_application_attributes({
  platform_application_arn: "String", # required
})

Response structure


resp.attributes #=> Hash
resp.attributes["String"] #=> String

Options Hash (options):

  • :platform_application_arn (required, String) —

    PlatformApplicationArn for GetPlatformApplicationAttributesInput.

Returns:

See Also:

#get_sms_attributes(options = {}) ⇒ Types::GetSMSAttributesResponse

Returns the settings for sending SMS messages from your account.

These settings are set with the SetSMSAttributes action.

Examples:

Request syntax with placeholder values


resp = client.get_sms_attributes({
  attributes: ["String"],
})

Response structure


resp.attributes #=> Hash
resp.attributes["String"] #=> String

Options Hash (options):

  • :attributes (Array<String>) —

    A list of the individual attribute names, such as MonthlySpendLimit, for which you want values.

    For all attribute names, see SetSMSAttributes.

    If you don\'t use this parameter, Amazon SNS returns all SMS attributes.

Returns:

See Also:

#get_subscription_attributes(options = {}) ⇒ Types::GetSubscriptionAttributesResponse

Returns all of the properties of a subscription.

Examples:

Request syntax with placeholder values


resp = client.get_subscription_attributes({
  subscription_arn: "subscriptionARN", # required
})

Response structure


resp.attributes #=> Hash
resp.attributes["attributeName"] #=> String

Options Hash (options):

  • :subscription_arn (required, String) —

    The ARN of the subscription whose properties you want to get.

Returns:

See Also:

#get_topic_attributes(options = {}) ⇒ Types::GetTopicAttributesResponse

Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.

Examples:

Request syntax with placeholder values


resp = client.get_topic_attributes({
  topic_arn: "topicARN", # required
})

Response structure


resp.attributes #=> Hash
resp.attributes["attributeName"] #=> String

Options Hash (options):

  • :topic_arn (required, String) —

    The ARN of the topic whose properties you want to get.

Returns:

See Also:

#list_endpoints_by_platform_application(options = {}) ⇒ Types::ListEndpointsByPlatformApplicationResponse

Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM (Firebase Cloud Messaging) and APNS. The results for ListEndpointsByPlatformApplication are paginated and return a limited list of endpoints, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListEndpointsByPlatformApplication again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications.

This action is throttled at 30 transactions per second (TPS).

Examples:

Request syntax with placeholder values


resp = client.list_endpoints_by_platform_application({
  platform_application_arn: "String", # required
  next_token: "String",
})

Response structure


resp.endpoints #=> Array
resp.endpoints[0].endpoint_arn #=> String
resp.endpoints[0].attributes #=> Hash
resp.endpoints[0].attributes["String"] #=> String
resp.next_token #=> String

Options Hash (options):

  • :platform_application_arn (required, String) —

    PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.

  • :next_token (String) —

    NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results.

Returns:

See Also:

#list_phone_numbers_opted_out(options = {}) ⇒ Types::ListPhoneNumbersOptedOutResponse

Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.

The results for ListPhoneNumbersOptedOut are paginated, and each page returns up to 100 phone numbers. If additional phone numbers are available after the first page of results, then a NextToken string will be returned. To receive the next page, you call ListPhoneNumbersOptedOut again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null.

Examples:

Request syntax with placeholder values


resp = client.list_phone_numbers_opted_out({
  next_token: "string",
})

Response structure


resp.phone_numbers #=> Array
resp.phone_numbers[0] #=> String
resp.next_token #=> String

Options Hash (options):

  • :next_token (String) —

    A NextToken string is used when you call the ListPhoneNumbersOptedOut action to retrieve additional records that are available after the first page of results.

Returns:

See Also:

#list_platform_applications(options = {}) ⇒ Types::ListPlatformApplicationsResponse

Lists the platform application objects for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). The results for ListPlatformApplications are paginated and return a limited list of applications, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListPlatformApplications using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications.

This action is throttled at 15 transactions per second (TPS).

Examples:

Request syntax with placeholder values


resp = client.list_platform_applications({
  next_token: "String",
})

Response structure


resp.platform_applications #=> Array
resp.platform_applications[0].platform_application_arn #=> String
resp.platform_applications[0].attributes #=> Hash
resp.platform_applications[0].attributes["String"] #=> String
resp.next_token #=> String

Options Hash (options):

  • :next_token (String) —

    NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results.

Returns:

See Also:

#list_subscriptions(options = {}) ⇒ Types::ListSubscriptionsResponse

Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptions call to get further results.

This action is throttled at 30 transactions per second (TPS).

Examples:

Request syntax with placeholder values


resp = client.list_subscriptions({
  next_token: "nextToken",
})

Response structure


resp.subscriptions #=> Array
resp.subscriptions[0].subscription_arn #=> String
resp.subscriptions[0].owner #=> String
resp.subscriptions[0].protocol #=> String
resp.subscriptions[0].endpoint #=> String
resp.subscriptions[0].topic_arn #=> String
resp.next_token #=> String

Options Hash (options):

  • :next_token (String) —

    Token returned by the previous ListSubscriptions request.

Returns:

See Also:

#list_subscriptions_by_topic(options = {}) ⇒ Types::ListSubscriptionsByTopicResponse

Returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptionsByTopic call to get further results.

This action is throttled at 30 transactions per second (TPS).

Examples:

Request syntax with placeholder values


resp = client.list_subscriptions_by_topic({
  topic_arn: "topicARN", # required
  next_token: "nextToken",
})

Response structure


resp.subscriptions #=> Array
resp.subscriptions[0].subscription_arn #=> String
resp.subscriptions[0].owner #=> String
resp.subscriptions[0].protocol #=> String
resp.subscriptions[0].endpoint #=> String
resp.subscriptions[0].topic_arn #=> String
resp.next_token #=> String

Options Hash (options):

  • :topic_arn (required, String) —

    The ARN of the topic for which you wish to find subscriptions.

  • :next_token (String) —

    Token returned by the previous ListSubscriptionsByTopic request.

Returns:

See Also:

#list_tags_for_resource(options = {}) ⇒ Types::ListTagsForResourceResponse

List all tags added to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon Simple Notification Service Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "AmazonResourceName", # required
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Options Hash (options):

  • :resource_arn (required, String) —

    The ARN of the topic for which to list tags.

Returns:

See Also:

#list_topics(options = {}) ⇒ Types::ListTopicsResponse

Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are more topics, a NextToken is also returned. Use the NextToken parameter in a new ListTopics call to get further results.

This action is throttled at 30 transactions per second (TPS).

Examples:

Request syntax with placeholder values


resp = client.list_topics({
  next_token: "nextToken",
})

Response structure


resp.topics #=> Array
resp.topics[0].topic_arn #=> String
resp.next_token #=> String

Options Hash (options):

  • :next_token (String) —

    Token returned by the previous ListTopics request.

Returns:

See Also:

#opt_in_phone_number(options = {}) ⇒ Struct

Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number.

You can opt in a phone number only once every 30 days.

Examples:

Request syntax with placeholder values


resp = client.opt_in_phone_number({
  phone_number: "PhoneNumber", # required
})

Options Hash (options):

  • :phone_number (required, String) —

    The phone number to opt in.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#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 with placeholder values


resp = client.publish({
  topic_arn: "topicARN",
  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",
})

Response structure


resp.message_id #=> String
resp.sequence_number #=> String

Options Hash (options):

  • :topic_arn (String) —

    The topic you want to publish to.

    If you don\'t specify a value for the TopicArn parameter, you must specify a value for the PhoneNumber or TargetArn parameters.

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

See Also:

#remove_permission(options = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.remove_permission({
  topic_arn: "topicARN", # required
  label: "label", # required
})

Options Hash (options):

  • :topic_arn (required, String) —

    The ARN of the topic whose access control policy you wish to modify.

  • :label (required, String) —

    The unique label of the statement you want to remove.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#set_endpoint_attributes(options = {}) ⇒ Struct

Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.

Examples:

Request syntax with placeholder values


resp = client.set_endpoint_attributes({
  endpoint_arn: "String", # required
  attributes: { # required
    "String" => "String",
  },
})

Options Hash (options):

  • :endpoint_arn (required, String) —

    EndpointArn used for SetEndpointAttributes action.

  • :attributes (required, Hash<String,String>) —

    A map of the endpoint attributes. Attributes in this map include the following:

    • CustomUserData – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

    • Enabled – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.

    • Token – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#set_platform_application_attributes(options = {}) ⇒ Struct

Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications. For information on configuring attributes for message delivery status, see Using Amazon SNS Application Attributes for Message Delivery Status.

Examples:

Request syntax with placeholder values


resp = client.set_platform_application_attributes({
  platform_application_arn: "String", # required
  attributes: { # required
    "String" => "String",
  },
})

Options Hash (options):

  • :platform_application_arn (required, String) —

    PlatformApplicationArn for SetPlatformApplicationAttributes action.

  • :attributes (required, Hash<String,String>) —

    A map of the platform application attributes. Attributes in this map include the following:

    • PlatformCredential – The credential received from the notification service. For APNS and APNS_SANDBOX, PlatformCredential is private key. For GCM (Firebase Cloud Messaging), PlatformCredential is API key. For ADM, PlatformCredential is client secret.

    • PlatformPrincipal – The principal received from the notification service. For APNS and APNS_SANDBOX, PlatformPrincipal is SSL certificate. For GCM (Firebase Cloud Messaging), there is no PlatformPrincipal. For ADM, PlatformPrincipal is client id.

    • EventEndpointCreated – Topic ARN to which EndpointCreated event notifications are sent.

    • EventEndpointDeleted – Topic ARN to which EndpointDeleted event notifications are sent.

    • EventEndpointUpdated – Topic ARN to which EndpointUpdate event notifications are sent.

    • EventDeliveryFailure – Topic ARN to which DeliveryFailure event notifications are sent upon Direct Publish delivery failure (permanent) to one of the application\'s endpoints.

    • SuccessFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.

    • FailureFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.

    • SuccessFeedbackSampleRate – Sample rate percentage (0-100) of successfully delivered messages.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#set_sms_attributes(options = {}) ⇒ Struct

Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.

You can override some of these settings for a single message when you use the Publish action with the MessageAttributes.entry.N parameter. For more information, see Publishing to a mobile phone in the Amazon SNS Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.set_sms_attributes({
  attributes: { # required
    "String" => "String",
  },
})

Options Hash (options):

  • :attributes (required, Hash<String,String>) —

    The default settings for sending SMS messages from your account. You can set values for the following attribute names:

    MonthlySpendLimit – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes.

    Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.

    By default, the spend limit is set to the maximum allowed by Amazon SNS. If you want to raise the limit, submit an SNS Limit Increase case. For New limit value, enter your desired monthly spend limit. In the Use Case Description field, explain that you are requesting an SMS monthly spend limit increase.

    DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information.

    DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to 0. To write logs for 10% of your successful deliveries, set it to 10.

    DefaultSenderID – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter.

    DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values:

    • Promotional – (Default) Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.

    • Transactional – Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.

    UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your account:

    • Time that the message was published (in UTC)

    • Message ID

    • Destination phone number

    • Message type

    • Delivery status

    • Message price (in USD)

    • Part number (a message is split into multiple parts if it is too long for a single message)

    • Total number of parts

    To receive the report, the bucket must have a policy that allows the Amazon SNS service principle to perform the s3:PutObject and s3:GetBucketLocation actions.

    For an example bucket policy and usage report, see Monitoring SMS Activity in the Amazon SNS Developer Guide.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#set_subscription_attributes(options = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.set_subscription_attributes({
  subscription_arn: "subscriptionARN", # required
  attribute_name: "attributeName", # required
  attribute_value: "attributeValue",
})

Options Hash (options):

  • :subscription_arn (required, String) —

    The ARN of the subscription to modify.

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

  • :attribute_value (String) —

    The new value for the attribute in JSON format.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#set_topic_attributes(options = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.set_topic_attributes({
  topic_arn: "topicARN", # required
  attribute_name: "attributeName", # required
  attribute_value: "attributeValue",
})

Options Hash (options):

  • :topic_arn (required, String) —

    The ARN of the topic to modify.

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

#subscribe(options = {}) ⇒ Types::SubscribeResponse

Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S or email, or if the endpoint and the topic are not in the same AWS account, the endpoint owner must run the ConfirmSubscription action to confirm the subscription.

You call the ConfirmSubscription action with the token from the subscription response. Confirmation tokens are valid for three days.

This action is throttled at 100 transactions per second (TPS).

Examples:

Request syntax with placeholder values


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

Response structure


resp.subscription_arn #=> String

Options Hash (options):

  • :topic_arn (required, String) —

    The ARN of the topic you want to subscribe to.

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

See Also:

#tag_resource(options = {}) ⇒ Struct

Add tags to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.

When you use topic tags, keep the following guidelines in mind:

  • Adding more than 50 tags to a topic isn't recommended.

  • Tags don't have any semantic meaning. Amazon SNS interprets tags as character strings.

  • Tags are case-sensitive.

  • A new tag with a key identical to that of an existing tag overwrites the existing tag.

  • Tagging actions are limited to 10 TPS per AWS account, per AWS region. If your application requires a higher throughput, file a technical support request.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "AmazonResourceName", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Options Hash (options):

  • :resource_arn (required, String) —

    The ARN of the topic to which to add tags.

  • :tags (required, Array<Types::Tag>) —

    The tags to be added to the specified topic. A tag consists of a required key and an optional value.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#unsubscribe(options = {}) ⇒ Struct

Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic's owner can unsubscribe, and an AWS signature is required. If the Unsubscribe call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the Unsubscribe request was unintended.

This action is throttled at 100 transactions per second (TPS).

Examples:

Request syntax with placeholder values


resp = client.unsubscribe({
  subscription_arn: "subscriptionARN", # required
})

Options Hash (options):

  • :subscription_arn (required, String) —

    The ARN of the subscription to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#untag_resource(options = {}) ⇒ Struct

Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "AmazonResourceName", # required
  tag_keys: ["TagKey"], # required
})

Options Hash (options):

  • :resource_arn (required, String) —

    The ARN of the topic from which to remove tags.

  • :tag_keys (required, Array<String>) —

    The list of tag keys to remove from the specified topic.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

  • waiter_name (Symbol) —

    The name of the waiter. See #waiter_names for a full list of supported waiters.

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

    Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

Returns:

  • (Boolean) —

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError) —

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError) —

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError) —

    Raised when you request to wait for an unknown state.

#waiter_names ⇒ Array<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter NameClient MethodDefault Delay:Default Max Attempts:

Returns:

  • (Array<Symbol>) —

    the list of supported waiters.