Class: Aws::SNS::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-sns/client.rb

Overview

An API client for SNS. To construct a client, you need to configure a ‘:region` and `:credentials`.

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

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

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

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, and `:session_token` options.

    • ENV, ENV

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV to true.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    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.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

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

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :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, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

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

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::SNS::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::SNS::EndpointParameters`

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.



422
423
424
 
# File 'lib/aws-sdk-sns/client.rb', line 422

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

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. 



2984
2985
2986
 
# File 'lib/aws-sdk-sns/client.rb', line 2984

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ 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. 



2987
2988
2989
 
# File 'lib/aws-sdk-sns/client.rb', line 2987

def errors_module
  Errors
end

Instance Method Details

#add_permission(params = {}) ⇒ Struct

Adds a statement to a topic’s access control policy, granting access for the specified Amazon Web Services accounts to the specified actions.

<note markdown=“1”> To remove the ability to change topic permissions, you must deny permissions to the ‘AddPermission`, `RemovePermission`, and `SetTopicAttributes` actions in your IAM policy.

</note>

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

Parameters:

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

    ({})

Options Hash (params):

  • :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 Amazon Web Services account IDs of the users (principals) who will be given access to the specified actions. The users must have Amazon Web Services account, but do not need to be signed up for this service.

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

    The action you want to allow for the specified principal(s).

    Valid values: Any Amazon SNS action name, for example ‘Publish`.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



470
471
472
473
 
# File 'lib/aws-sdk-sns/client.rb', line 470

def add_permission(params = {}, options = {})
  req = build_request(:add_permission, params)
  req.send_request(options)
end

#build_request(operation_name, params = {}) ⇒ 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.

Parameters:

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


2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
 
# File 'lib/aws-sdk-sns/client.rb', line 2962

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config)
  context[:gem_name] = 'aws-sdk-sns'
  context[:gem_version] = '1.81.0'
  Seahorse::Client::Request.new(handlers, context)
end

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

Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your Amazon Web Services 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 #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :phone_number (required, String) —

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

Returns:

See Also:



503
504
505
506
 
# File 'lib/aws-sdk-sns/client.rb', line 503

def check_if_phone_number_is_opted_out(params = {}, options = {})
  req = build_request(:check_if_phone_number_is_opted_out, params)
  req.send_request(options)
end

#confirm_subscription(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



547
548
549
550
 
# File 'lib/aws-sdk-sns/client.rb', line 547

def confirm_subscription(params = {}, options = {})
  req = build_request(:confirm_subscription, params)
  req.send_request(options)
end

#create_platform_application(params = {}) ⇒ 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 APNS and ‘APNS_SANDBOX` using certificate credentials, `PlatformPrincipal` is `SSL certificate` and `PlatformCredential` is `private key`.

  • For APNS and ‘APNS_SANDBOX` using token credentials, `PlatformPrincipal` is `signing key ID` and `PlatformCredential` is `signing key`.

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

  • For GCM (Firebase Cloud Messaging) using key credentials, there is no ‘PlatformPrincipal`. The `PlatformCredential` is `API key`.

  • For GCM (Firebase Cloud Messaging) using token credentials, there is no ‘PlatformPrincipal`. The `PlatformCredential` is a JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in string format and special characters must be ignored. To format the file correctly, Amazon SNS recommends using the following command: “ SERVICE_JSON=`jq @json <<< cat service.json` “.

  • 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

Parameters:

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

    ({})

Options Hash (params):

  • :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` ][1].

    [1]: docs.aws.amazon.com/sns/latest/api/API_SetPlatformApplicationAttributes.html

Returns:

See Also:



634
635
636
637
 
# File 'lib/aws-sdk-sns/client.rb', line 634

def create_platform_application(params = {}, options = {})
  req = build_request(:create_platform_application, params)
  req.send_request(options)
end

#create_platform_endpoint(params = {}) ⇒ 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].

[1]: docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html [2]: docs.aws.amazon.com/sns/latest/dg/SNSMobilePushBaiduEndpoint.html

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

Parameters:

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

    ({})

Options Hash (params):

  • :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` ][1].

    [1]: docs.aws.amazon.com/sns/latest/api/API_SetEndpointAttributes.html

Returns:

See Also:



707
708
709
710
 
# File 'lib/aws-sdk-sns/client.rb', line 707

def create_platform_endpoint(params = {}, options = {})
  req = build_request(:create_platform_endpoint, params)
  req.send_request(options)
end

#create_sms_sandbox_phone_number(params = {}) ⇒ Struct

Adds a destination phone number to an Amazon Web Services account in the SMS sandbox and sends a one-time password (OTP) to that phone number.

When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the *SMS sandbox*. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see [SMS sandbox] in the *Amazon SNS Developer Guide*.

[1]: docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html

Examples:

Request syntax with placeholder values


resp = client.create_sms_sandbox_phone_number({
  phone_number: "PhoneNumberString", # required
  language_code: "en-US", # accepts en-US, en-GB, es-419, es-ES, de-DE, fr-CA, fr-FR, it-IT, ja-JP, pt-BR, kr-KR, zh-CN, zh-TW
})

Parameters:

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

    ({})

Options Hash (params):

  • :phone_number (required, String) —

    The destination phone number to verify. On verification, Amazon SNS adds this phone number to the list of verified phone numbers that you can send SMS messages to.

  • :language_code (String) —

    The language to use for sending the OTP. The default value is ‘en-US`.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



751
752
753
754
 
# File 'lib/aws-sdk-sns/client.rb', line 751

def create_sms_sandbox_phone_number(params = {}, options = {})
  req = build_request(:create_sms_sandbox_phone_number, params)
  req.send_request(options)
end

#create_topic(params = {}) ⇒ 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 [Creating an Amazon SNS topic] in the *Amazon SNS Developer Guide*. 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.

[1]: docs.aws.amazon.com/sns/latest/dg/sns-create-topic.html

Examples:

Request syntax with placeholder values


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

Response structure


resp.topic_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

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

    • ‘SignatureVersion` – The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, `SignatureVersion` is set to `1`.

    • ‘TracingConfig` – Tracing mode of an Amazon SNS topic. By default `TracingConfig` is set to `PassThrough`, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to `Active`, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.

    The following attribute applies only to [server-side encryption]:

    • ‘KmsMasterKeyId` – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see [Key Terms]. For more examples, see [KeyId] in the *Key Management Service API Reference*.

    ^

    The following attributes apply only to [FIFO topics]:

    • ‘ArchivePolicy` – Adds or updates an inline policy document to archive messages stored in the specified Amazon SNS topic.

    • ‘BeginningArchiveTime` – The earliest starting point at which a message in the topic’s archive can be replayed from. This point in time is based on the configured message retention period set by the topic’s message archiving policy.

    • ‘ContentBasedDeduplication` – Enables content-based deduplication for FIFO topics.

      • By default, ‘ContentBasedDeduplication` is set to `false`. If you create a FIFO topic and this attribute is `false`, you must specify a value for the `MessageDeduplicationId` parameter for the

        Publish][5

        action.

      • When you set ‘ContentBasedDeduplication` to `true`, Amazon SNS uses a SHA-256 hash to generate the `MessageDeduplicationId` using the body of the message (but not the attributes of the message).

        (Optional) To override the generated value, you can specify a value for the ‘MessageDeduplicationId` parameter for the `Publish` action.

    [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 [4]: docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html [5]: docs.aws.amazon.com/sns/latest/api/API_Publish.html

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

    The list of tags to add to a new topic.

    <note markdown=“1”> To be able to tag a topic on creation, you must have the ‘sns:CreateTopic` and `sns:TagResource` permissions.

    </note>
  • :data_protection_policy (String) —

    The body of the policy document you want to use for this topic.

    You can only add one policy per topic.

    The policy must be in JSON string format.

    Length Constraints: Maximum length of 30,720.

Returns:

See Also:



895
896
897
898
 
# File 'lib/aws-sdk-sns/client.rb', line 895

def create_topic(params = {}, options = {})
  req = build_request(:create_topic, params)
  req.send_request(options)
end

#delete_endpoint(params = {}) ⇒ 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.

[1]: docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :endpoint_arn (required, String) —

    ‘EndpointArn` of endpoint to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



926
927
928
929
 
# File 'lib/aws-sdk-sns/client.rb', line 926

def delete_endpoint(params = {}, options = {})
  req = build_request(:delete_endpoint, params)
  req.send_request(options)
end

#delete_platform_application(params = {}) ⇒ 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].

[1]: docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :platform_application_arn (required, String) —

    ‘PlatformApplicationArn` of platform application object to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



955
956
957
958
 
# File 'lib/aws-sdk-sns/client.rb', line 955

def delete_platform_application(params = {}, options = {})
  req = build_request(:delete_platform_application, params)
  req.send_request(options)
end

#delete_sms_sandbox_phone_number(params = {}) ⇒ Struct

Deletes an Amazon Web Services account’s verified or pending phone number from the SMS sandbox.

When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the *SMS sandbox*. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see [SMS sandbox] in the *Amazon SNS Developer Guide*.

[1]: docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html

Examples:

Request syntax with placeholder values


resp = client.delete_sms_sandbox_phone_number({
  phone_number: "PhoneNumberString", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :phone_number (required, String) —

    The destination phone number to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



992
993
994
995
 
# File 'lib/aws-sdk-sns/client.rb', line 992

def delete_sms_sandbox_phone_number(params = {}, options = {})
  req = build_request(:delete_sms_sandbox_phone_number, params)
  req.send_request(options)
end

#delete_topic(params = {}) ⇒ 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
})

Parameters:

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

    ({})

Options Hash (params):

  • :topic_arn (required, String) —

    The ARN of the topic you want to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1017
1018
1019
1020
 
# File 'lib/aws-sdk-sns/client.rb', line 1017

def delete_topic(params = {}, options = {})
  req = build_request(:delete_topic, params)
  req.send_request(options)
end

#get_data_protection_policy(params = {}) ⇒ Types::GetDataProtectionPolicyResponse

Retrieves the specified inline ‘DataProtectionPolicy` document that is stored in the specified Amazon SNS topic.

Examples:

Request syntax with placeholder values


resp = client.get_data_protection_policy({
  resource_arn: "topicARN", # required
})

Response structure


resp.data_protection_policy #=> String

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



1053
1054
1055
1056
 
# File 'lib/aws-sdk-sns/client.rb', line 1053

def get_data_protection_policy(params = {}, options = {})
  req = build_request(:get_data_protection_policy, params)
  req.send_request(options)
end

#get_endpoint_attributes(params = {}) ⇒ 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].

[1]: docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :endpoint_arn (required, String) —

    ‘EndpointArn` for `GetEndpointAttributes` input.

Returns:

See Also:



1089
1090
1091
1092
 
# File 'lib/aws-sdk-sns/client.rb', line 1089

def get_endpoint_attributes(params = {}, options = {})
  req = build_request(:get_endpoint_attributes, params)
  req.send_request(options)
end

#get_platform_application_attributes(params = {}) ⇒ 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].

[1]: docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html

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

Parameters:

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

    ({})

Options Hash (params):

  • :platform_application_arn (required, String) —

    ‘PlatformApplicationArn` for GetPlatformApplicationAttributesInput.

Returns:

See Also:



1125
1126
1127
1128
 
# File 'lib/aws-sdk-sns/client.rb', line 1125

def get_platform_application_attributes(params = {}, options = {})
  req = build_request(:get_platform_application_attributes, params)
  req.send_request(options)
end

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

Returns the settings for sending SMS messages from your Amazon Web Services 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

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



1167
1168
1169
1170
 
# File 'lib/aws-sdk-sns/client.rb', line 1167

def get_sms_attributes(params = {}, options = {})
  req = build_request(:get_sms_attributes, params)
  req.send_request(options)
end

#get_sms_sandbox_account_status(params = {}) ⇒ Types::GetSMSSandboxAccountStatusResult

Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target Amazon Web Services Region.

When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the *SMS sandbox*. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see [SMS sandbox] in the *Amazon SNS Developer Guide*.

[1]: docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html

Examples:

Response structure


resp.is_in_sandbox #=> Boolean

Parameters:

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

    ({})

Returns:

See Also:



1201
1202
1203
1204
 
# File 'lib/aws-sdk-sns/client.rb', line 1201

def (params = {}, options = {})
  req = build_request(:get_sms_sandbox_account_status, params)
  req.send_request(options)
end

#get_subscription_attributes(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :subscription_arn (required, String) —

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

Returns:

See Also:



1230
1231
1232
1233
 
# File 'lib/aws-sdk-sns/client.rb', line 1230

def get_subscription_attributes(params = {}, options = {})
  req = build_request(:get_subscription_attributes, params)
  req.send_request(options)
end

#get_topic_attributes(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :topic_arn (required, String) —

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

Returns:

See Also:



1260
1261
1262
1263
 
# File 'lib/aws-sdk-sns/client.rb', line 1260

def get_topic_attributes(params = {}, options = {})
  req = build_request(:get_topic_attributes, params)
  req.send_request(options)
end

#list_endpoints_by_platform_application(params = {}) ⇒ 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).

[1]: docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

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

    ({})

Options Hash (params):

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



1317
1318
1319
1320
 
# File 'lib/aws-sdk-sns/client.rb', line 1317

def list_endpoints_by_platform_application(params = {}, options = {})
  req = build_request(:list_endpoints_by_platform_application, params)
  req.send_request(options)
end

#list_origination_numbers(params = {}) ⇒ Types::ListOriginationNumbersResult

Lists the calling Amazon Web Services account’s dedicated origination numbers and their metadata. For more information about origination numbers, see [Origination numbers] in the *Amazon SNS Developer Guide*.

[1]: docs.aws.amazon.com/sns/latest/dg/channels-sms-originating-identities-origination-numbers.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_origination_numbers({
  next_token: "nextToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.phone_numbers #=> Array
resp.phone_numbers[0].created_at #=> Time
resp.phone_numbers[0].phone_number #=> String
resp.phone_numbers[0].status #=> String
resp.phone_numbers[0].iso_2_country_code #=> String
resp.phone_numbers[0].route_type #=> String, one of "Transactional", "Promotional", "Premium"
resp.phone_numbers[0].number_capabilities #=> Array
resp.phone_numbers[0].number_capabilities[0] #=> String, one of "SMS", "MMS", "VOICE"

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    Token that the previous ‘ListOriginationNumbers` request returns.

  • :max_results (Integer) —

    The maximum number of origination numbers to return.

Returns:

See Also:



1367
1368
1369
1370
 
# File 'lib/aws-sdk-sns/client.rb', line 1367

def list_origination_numbers(params = {}, options = {})
  req = build_request(:list_origination_numbers, params)
  req.send_request(options)
end

#list_phone_numbers_opted_out(params = {}) ⇒ 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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

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

    ({})

Options Hash (params):

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



1411
1412
1413
1414
 
# File 'lib/aws-sdk-sns/client.rb', line 1411

def list_phone_numbers_opted_out(params = {}, options = {})
  req = build_request(:list_phone_numbers_opted_out, params)
  req.send_request(options)
end

#list_platform_applications(params = {}) ⇒ 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).

[1]: docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

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

    ({})

Options Hash (params):

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



1463
1464
1465
1466
 
# File 'lib/aws-sdk-sns/client.rb', line 1463

def list_platform_applications(params = {}, options = {})
  req = build_request(:list_platform_applications, params)
  req.send_request(options)
end

#list_sms_sandbox_phone_numbers(params = {}) ⇒ Types::ListSMSSandboxPhoneNumbersResult

Lists the calling Amazon Web Services account’s current verified and pending destination phone numbers in the SMS sandbox.

When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the *SMS sandbox*. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see [SMS sandbox] in the *Amazon SNS Developer Guide*.

[1]: docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_sms_sandbox_phone_numbers({
  next_token: "nextToken",
  max_results: 1,
})

Response structure


resp.phone_numbers #=> Array
resp.phone_numbers[0].phone_number #=> String
resp.phone_numbers[0].status #=> String, one of "Pending", "Verified"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    Token that the previous ‘ListSMSSandboxPhoneNumbersInput` request returns.

  • :max_results (Integer) —

    The maximum number of phone numbers to return.

Returns:

See Also:



1517
1518
1519
1520
 
# File 'lib/aws-sdk-sns/client.rb', line 1517

def list_sms_sandbox_phone_numbers(params = {}, options = {})
  req = build_request(:list_sms_sandbox_phone_numbers, params)
  req.send_request(options)
end

#list_subscriptions(params = {}) ⇒ 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).

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    Token returned by the previous ‘ListSubscriptions` request.

Returns:

See Also:



1559
1560
1561
1562
 
# File 'lib/aws-sdk-sns/client.rb', line 1559

def list_subscriptions(params = {}, options = {})
  req = build_request(:list_subscriptions, params)
  req.send_request(options)
end

#list_subscriptions_by_topic(params = {}) ⇒ 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).

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

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

    ({})

Options Hash (params):

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



1606
1607
1608
1609
 
# File 'lib/aws-sdk-sns/client.rb', line 1606

def list_subscriptions_by_topic(params = {}, options = {})
  req = build_request(:list_subscriptions_by_topic, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ 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*.

[1]: docs.aws.amazon.com/sns/latest/dg/sns-tags.html

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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the topic for which to list tags.

Returns:

See Also:



1642
1643
1644
1645
 
# File 'lib/aws-sdk-sns/client.rb', line 1642

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#list_topics(params = {}) ⇒ 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).

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    Token returned by the previous ‘ListTopics` request.

Returns:

See Also:



1680
1681
1682
1683
 
# File 'lib/aws-sdk-sns/client.rb', line 1680

def list_topics(params = {}, options = {})
  req = build_request(:list_topics, params)
  req.send_request(options)
end

#opt_in_phone_number(params = {}) ⇒ 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
})

Parameters:

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

    ({})

Options Hash (params):

  • :phone_number (required, String) —

    The phone number to opt in. Use E.164 format.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1705
1706
1707
1708
 
# File 'lib/aws-sdk-sns/client.rb', line 1705

def opt_in_phone_number(params = {}, options = {})
  req = build_request(:opt_in_phone_number, params)
  req.send_request(options)
end

#publish(params = {}) ⇒ 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 is saved and Amazon SNS immediately delivers it to subscribers.

To use the ‘Publish` action for publishing 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 Amazon Web Services Region.

[1]: docs.aws.amazon.com/sns/latest/dg/mobile-push-send-custommessage.html

Examples:

Request syntax with placeholder values


resp = client.publish({
  topic_arn: "topicARN",
  target_arn: "String",
  phone_number: "PhoneNumber",
  message: "message", # required
  subject: "subject",
  message_structure: "messageStructure",
  message_attributes: {
    "String" => {
      data_type: "String", # required
      string_value: "String",
      binary_value: "data",
    },
  },
  message_deduplication_id: "String",
  message_group_id: "String",
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :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 UTF-8 text with no line breaks or control characters, and less than 100 characters long.

  • :message_structure (String) —

    Set ‘MessageStructure` to `json` if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set `MessageStructure` to `json`, the value of the `Message` parameter must:

    • be a syntactically valid JSON object; and

    • contain at least a top-level JSON key of “default” with a value that is a string.

    You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., “http”).

    Valid value: ‘json`

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

    Message attributes for Publish action.

  • :message_deduplication_id (String) —

    This parameter applies only to FIFO (first-in-first-out) topics. The ‘MessageDeduplicationId` can contain up to 128 alphanumeric characters `(a-z, A-Z, 0-9)` and punctuation “ (!“#$%&’()*+,-./:;<=>?@[]^_`{|}~) “.

    Every message must have a unique ‘MessageDeduplicationId`, which is a token used for deduplication of sent messages. 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:



1900
1901
1902
1903
 
# File 'lib/aws-sdk-sns/client.rb', line 1900

def publish(params = {}, options = {})
  req = build_request(:publish, params)
  req.send_request(options)
end

#publish_batch(params = {}) ⇒ Types::PublishBatchResponse

Publishes up to ten messages to the specified topic. This is a batch version of ‘Publish`. For FIFO topics, multiple messages within a single batch are published in the order they are sent, and messages are deduplicated within the batch and across batches for 5 minutes.

The result of publishing each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of ‘200`.

The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).

Some actions take lists of parameters. These lists are specified using the ‘param.n` notation. Values of `n` are integers starting from 1. For example, a parameter list with two elements looks like this:

&amp;AttributeName.1=first

&amp;AttributeName.2=second

If you send a batch message to a topic, Amazon SNS publishes the batch message to each endpoint that is subscribed to the topic. The format of the batch message depends on the notification protocol for each subscribed endpoint.

When a ‘messageId` is returned, the batch message is saved and Amazon SNS immediately delivers the message to subscribers.

Examples:

Request syntax with placeholder values


resp = client.publish_batch({
  topic_arn: "topicARN", # required
  publish_batch_request_entries: [ # required
    {
      id: "String", # required
      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.successful #=> Array
resp.successful[0].id #=> String
resp.successful[0].message_id #=> String
resp.successful[0].sequence_number #=> String
resp.failed #=> Array
resp.failed[0].id #=> String
resp.failed[0].code #=> String
resp.failed[0].message #=> String
resp.failed[0].sender_fault #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :topic_arn (required, String) —

    The Amazon resource name (ARN) of the topic you want to batch publish to.

  • :publish_batch_request_entries (required, Array<Types::PublishBatchRequestEntry>) —

    A list of ‘PublishBatch` request entries to be sent to the SNS topic.

Returns:

See Also:



1986
1987
1988
1989
 
# File 'lib/aws-sdk-sns/client.rb', line 1986

def publish_batch(params = {}, options = {})
  req = build_request(:publish_batch, params)
  req.send_request(options)
end

#put_data_protection_policy(params = {}) ⇒ Struct

Adds or updates an inline policy document that is stored in the specified Amazon SNS topic.

Examples:

Request syntax with placeholder values


resp = client.put_data_protection_policy({
  resource_arn: "topicARN", # required
  data_protection_policy: "attributeValue", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the topic whose ‘DataProtectionPolicy` you want to add or update.

    For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon Web Services General Reference.

    [1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

  • :data_protection_policy (required, String) —

    The JSON serialization of the topic’s ‘DataProtectionPolicy`.

    The ‘DataProtectionPolicy` must be in JSON string format.

    Length Constraints: Maximum length of 30,720.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2025
2026
2027
2028
 
# File 'lib/aws-sdk-sns/client.rb', line 2025

def put_data_protection_policy(params = {}, options = {})
  req = build_request(:put_data_protection_policy, params)
  req.send_request(options)
end

#remove_permission(params = {}) ⇒ Struct

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

<note markdown=“1”> To remove the ability to change topic permissions, you must deny permissions to the ‘AddPermission`, `RemovePermission`, and `SetTopicAttributes` actions in your IAM policy.

</note>

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

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



2057
2058
2059
2060
 
# File 'lib/aws-sdk-sns/client.rb', line 2057

def remove_permission(params = {}, options = {})
  req = build_request(:remove_permission, params)
  req.send_request(options)
end

#set_endpoint_attributes(params = {}) ⇒ 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].

[1]: docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

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



2107
2108
2109
2110
 
# File 'lib/aws-sdk-sns/client.rb', line 2107

def set_endpoint_attributes(params = {}, options = {})
  req = build_request(:set_endpoint_attributes, params)
  req.send_request(options)
end

#set_platform_application_attributes(params = {}) ⇒ 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].

[1]: docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html [2]: docs.aws.amazon.com/sns/latest/dg/sns-msg-status.html

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :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 ADM, ‘PlatformCredential`is client secret.

      • For Apple Services using certificate credentials, ‘PlatformCredential` is private key.

      • For Apple Services using token credentials, ‘PlatformCredential` is signing key.

      • For GCM (Firebase Cloud Messaging) using key credentials, there is no ‘PlatformPrincipal`. The `PlatformCredential` is `API key`.

      • For GCM (Firebase Cloud Messaging) using token credentials, there is no ‘PlatformPrincipal`. The `PlatformCredential` is a JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in string format and special characters must be ignored. To format the file correctly, Amazon SNS recommends using the following command: “ SERVICE_JSON=`jq @json <<< cat service.json` “.

    ^

    • ‘PlatformPrincipal` – The principal received from the notification service.

      • For ADM, ‘PlatformPrincipal`is client id.

      • For Apple Services using certificate credentials, ‘PlatformPrincipal` is SSL certificate.

      • For Apple Services using token credentials, ‘PlatformPrincipal` is signing key ID.

      • For GCM (Firebase Cloud Messaging), there is no ‘PlatformPrincipal`.

    ^

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

    The following attributes only apply to ‘APNs` token-based authentication:

    • ‘ApplePlatformTeamID` – The identifier that’s assigned to your Apple developer account team.

    • ‘ApplePlatformBundleID` – The bundle identifier that’s assigned to your iOS app.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2216
2217
2218
2219
 
# File 'lib/aws-sdk-sns/client.rb', line 2216

def set_platform_application_attributes(params = {}, options = {})
  req = build_request(:set_platform_application_attributes, params)
  req.send_request(options)
end

#set_sms_attributes(params = {}) ⇒ 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*.

<note markdown=“1”> To use this operation, you must grant the Amazon SNS service principal (‘sns.amazonaws.com`) permission to perform the `s3:ListBucket` action.

</note>

[1]: docs.aws.amazon.com/sns/latest/dg/sms_publish-to-phone.html

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

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

    The default settings for sending SMS messages from your Amazon Web Services 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 Amazon Web Services 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 principal 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*.

    [1]: console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&amp;limitType=service-code-sns [2]: docs.aws.amazon.com/sns/latest/dg/sms_stats.html

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2338
2339
2340
2341
 
# File 'lib/aws-sdk-sns/client.rb', line 2338

def set_sms_attributes(params = {}, options = {})
  req = build_request(:set_sms_attributes, params)
  req.send_request(options)
end

#set_subscription_attributes(params = {}) ⇒ 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",
})

Parameters:

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

    ({})

Options Hash (params):

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

    • ‘FilterPolicyScope` – This attribute lets you choose the filtering scope by using one of the following string value types:

      • ‘MessageAttributes` (default) – The filter is applied on the message attributes.

      • ‘MessageBody` – The filter is applied on the message body.

    • ‘RawMessageDelivery` – When set to `true`, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.

    • ‘RedrivePolicy` – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can’t be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

    The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:

    • ‘SubscriptionRoleArn` – The ARN of the IAM role that has the following:

      • Permission to write to the Firehose delivery stream

      • Amazon SNS listed as a trusted entity

      Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see [Fanout to Firehose delivery streams] in the *Amazon SNS Developer Guide*.

    [1]: docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html

  • :attribute_value (String) —

    The new value for the attribute in JSON format.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2417
2418
2419
2420
 
# File 'lib/aws-sdk-sns/client.rb', line 2417

def set_subscription_attributes(params = {}, options = {})
  req = build_request(:set_subscription_attributes, params)
  req.send_request(options)
end

#set_topic_attributes(params = {}) ⇒ Struct

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

<note markdown=“1”> To remove the ability to change topic permissions, you must deny permissions to the ‘AddPermission`, `RemovePermission`, and `SetTopicAttributes` actions in your IAM policy.

</note>

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

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

    • ‘ApplicationSuccessFeedbackRoleArn` – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to a platform application endpoint.

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

    • ‘TracingConfig` – Tracing mode of an Amazon SNS topic. By default `TracingConfig` is set to `PassThrough`, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to `Active`, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.

    • HTTP

      • ‘HTTPSuccessFeedbackRoleArn` – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.

      • ‘HTTPSuccessFeedbackSampleRate` – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an HTTP endpoint.

      • ‘HTTPFailureFeedbackRoleArn` – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.

    • Amazon Kinesis Data Firehose

      • ‘FirehoseSuccessFeedbackRoleArn` – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.

      • ‘FirehoseSuccessFeedbackSampleRate` – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.

      • ‘FirehoseFailureFeedbackRoleArn` – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.

    • Lambda

      • ‘LambdaSuccessFeedbackRoleArn` – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint.

      • ‘LambdaSuccessFeedbackSampleRate` – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Lambda endpoint.

      • ‘LambdaFailureFeedbackRoleArn` – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint.

    • Platform application endpoint

      • ‘ApplicationSuccessFeedbackRoleArn` – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.

      • ‘ApplicationSuccessFeedbackSampleRate` – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.

      • ‘ApplicationFailureFeedbackRoleArn` – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.

      <note markdown=“1”> In addition to being able to configure topic attributes for message delivery status of notification messages sent to Amazon SNS application endpoints, you can also configure application attributes for the delivery status of push notification messages sent to push notification services.

      For example, For more information, see [Using Amazon SNS Application

      Attributes for Message Delivery Status].

      </note>

    • Amazon SQS

      • ‘SQSSuccessFeedbackRoleArn` – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.

      • ‘SQSSuccessFeedbackSampleRate` – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.

      • ‘SQSFailureFeedbackRoleArn` – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.

    <note markdown=“1”> The &lt;ENDPOINT&gt;SuccessFeedbackRoleArn and &lt;ENDPOINT&gt;FailureFeedbackRoleArn attributes are used to give Amazon SNS write access to use CloudWatch Logs on your behalf. The &lt;ENDPOINT&gt;SuccessFeedbackSampleRate attribute is for specifying the sample rate percentage (0-100) of successfully delivered messages. After you configure the &lt;ENDPOINT&gt;FailureFeedbackRoleArn attribute, then all failed message deliveries generate CloudWatch Logs.

    </note>

    The following attribute applies only to [server-side-encryption]:

    • ‘KmsMasterKeyId` – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see [Key Terms]. For more examples, see [KeyId] in the *Key Management Service API Reference*.

    • ‘SignatureVersion` – The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, `SignatureVersion` is set to `1`.

    The following attribute applies only to [FIFO topics]:

    • ‘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][6

        action.

      • When you set ‘ContentBasedDeduplication` to `true`, Amazon SNS uses a SHA-256 hash to generate the `MessageDeduplicationId` using the body of the message (but not the attributes of the message).

        (Optional) To override the generated value, you can specify a value for the ‘MessageDeduplicationId` parameter for the `Publish` action.

    [1]: docs.aws.amazon.com/sns/latest/dg/sns-msg-status.html [2]: docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html [3]: docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms [4]: docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters [5]: docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html [6]: docs.aws.amazon.com/sns/latest/api/API_Publish.html

  • :attribute_value (String) —

    The new value for the attribute.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2608
2609
2610
2611
 
# File 'lib/aws-sdk-sns/client.rb', line 2608

def set_topic_attributes(params = {}, options = {})
  req = build_request(:set_topic_attributes, params)
  req.send_request(options)
end

#subscribe(params = {}) ⇒ 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 Amazon Web Services 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 two 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

Parameters:

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

    ({})

Options Hash (params):

  • :topic_arn (required, String) —

    The ARN of the topic you want to subscribe to.

  • :protocol (required, String) —

    The protocol that you want to use. Supported protocols include:

    • ‘http` – delivery of JSON-encoded message via HTTP POST

    • ‘https` – delivery of JSON-encoded message via HTTPS POST

    • ‘email` – delivery of message via SMTP

    • ‘email-json` – delivery of JSON-encoded message via SMTP

    • ‘sms` – delivery of message via SMS

    • ‘sqs` – delivery of JSON-encoded message to an Amazon SQS queue

    • ‘application` – delivery of JSON-encoded message to an EndpointArn for a mobile app and device

    • ‘lambda` – delivery of JSON-encoded message to an Lambda function

    • ‘firehose` – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.

  • :endpoint (String) —

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

    • For the ‘http` protocol, the (public) endpoint is a URL beginning with `http://`.

    • For the ‘https` protocol, the (public) endpoint is a URL beginning with `https://`.

    • For the ‘email` protocol, the endpoint is an email address.

    • For the ‘email-json` protocol, the endpoint is an email address.

    • For the ‘sms` protocol, the endpoint is a phone number of an SMS-enabled device.

    • For the ‘sqs` protocol, the endpoint is the ARN of an Amazon SQS queue.

    • For the ‘application` protocol, the endpoint is the EndpointArn of a mobile app and device.

    • For the ‘lambda` protocol, the endpoint is the ARN of an Lambda function.

    • For the ‘firehose` protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.

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

    A map of attributes with their corresponding values.

    The following lists the names, descriptions, and values of the special request parameters that the ‘Subscribe` action uses:

    • ‘DeliveryPolicy` – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

    • ‘FilterPolicy` – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.

    • ‘FilterPolicyScope` – This attribute lets you choose the filtering scope by using one of the following string value types:

      • ‘MessageAttributes` (default) – The filter is applied on the message attributes.

      • ‘MessageBody` – The filter is applied on the message body.

    • ‘RawMessageDelivery` – When set to `true`, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.

    • ‘RedrivePolicy` – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can’t be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

    The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:

    • ‘SubscriptionRoleArn` – The ARN of the IAM role that has the following:

      • Permission to write to the Firehose delivery stream

      • Amazon SNS listed as a trusted entity

      Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see [Fanout to Firehose delivery streams] in the *Amazon SNS Developer Guide*.

    The following attributes apply only to [FIFO topics]:

    • ‘ReplayPolicy` – Adds or updates an inline policy document for a subscription to replay messages stored in the specified Amazon SNS topic.

    • ‘ReplayStatus` – Retrieves the status of the subscription message replay, which can be one of the following:

      • ‘Completed` – The replay has successfully redelivered all messages, and is now delivering newly published messages. If an ending point was specified in the `ReplayPolicy` then the subscription will no longer receive newly published messages.

      • ‘In progress` – The replay is currently replaying the selected messages.

      • ‘Failed` – The replay was unable to complete.

      • ‘Pending` – The default state while the replay initiates.

    [1]: docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html [2]: docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html

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



2790
2791
2792
2793
 
# File 'lib/aws-sdk-sns/client.rb', line 2790

def subscribe(params = {}, options = {})
  req = build_request(:subscribe, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Add tags to the specified Amazon SNS topic. For an overview, see

Amazon SNS Tags][1

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 Amazon Web Services account, per Amazon Web Services Region. If your application requires a higher throughput, file a [technical support request].

[1]: docs.aws.amazon.com/sns/latest/dg/sns-tags.html [2]: console.aws.amazon.com/support/home#/case/create?issueType=technical

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

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



2844
2845
2846
2847
 
# File 'lib/aws-sdk-sns/client.rb', line 2844

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#unsubscribe(params = {}) ⇒ 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 Amazon Web Services 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.

<note markdown=“1”> Amazon SQS queue subscriptions require authentication for deletion. Only the owner of the subscription, or the owner of the topic can unsubscribe using the required Amazon Web Services signature.

</note>

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :subscription_arn (required, String) —

    The ARN of the subscription to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2880
2881
2882
2883
 
# File 'lib/aws-sdk-sns/client.rb', line 2880

def unsubscribe(params = {}, options = {})
  req = build_request(:unsubscribe, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Remove tags from the specified Amazon SNS topic. For an overview, see

Amazon SNS Tags][1

in the *Amazon SNS Developer Guide*.

[1]: docs.aws.amazon.com/sns/latest/dg/sns-tags.html

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

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



2911
2912
2913
2914
 
# File 'lib/aws-sdk-sns/client.rb', line 2911

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#verify_sms_sandbox_phone_number(params = {}) ⇒ Struct

Verifies a destination phone number with a one-time password (OTP) for the calling Amazon Web Services account.

When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the *SMS sandbox*. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see [SMS sandbox] in the *Amazon SNS Developer Guide*.

[1]: docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html

Examples:

Request syntax with placeholder values


resp = client.verify_sms_sandbox_phone_number({
  phone_number: "PhoneNumberString", # required
  one_time_password: "OTPCode", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :phone_number (required, String) —

    The destination phone number to verify.

  • :one_time_password (required, String) —

    The OTP sent to the destination number from the ‘CreateSMSSandBoxPhoneNumber` call.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2953
2954
2955
2956
 
# File 'lib/aws-sdk-sns/client.rb', line 2953

def verify_sms_sandbox_phone_number(params = {}, options = {})
  req = build_request(:verify_sms_sandbox_phone_number, params)
  req.send_request(options)
end

#waiter_names ⇒ 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. 


2977
2978
2979
 
# File 'lib/aws-sdk-sns/client.rb', line 2977

def waiter_names
  []
end