Class: Aws::SNS::Client

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

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

  • :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::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

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

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

    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 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentails` to enable retries and extended timeouts.

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

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

  • :disable_host_prefix_injection (Boolean) — default: false —

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

  • :endpoint (String) —

    The client endpoint is normally constructed from the ‘:region` option. You should only configure an `:endpoint` when connecting to test endpoints. This should be avalid HTTP(S) URI.

  • :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. Defaults to `false`.

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

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

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

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function.

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

    @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 and auth errors from expired credentials.

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

  • :secret_access_key (String)
  • :session_token (String)
  • :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.

  • :validate_params (Boolean) — default: true —

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



202
203
204
 
# File 'lib/aws-sdk-sns/client.rb', line 202

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. 



1785
1786
1787
 
# File 'lib/aws-sdk-sns/client.rb', line 1785

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. 



1788
1789
1790
 
# File 'lib/aws-sdk-sns/client.rb', line 1788

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 AWS accounts to the specified actions.

Examples:

Request syntax with placeholder values


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

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

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

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

    Valid values: any Amazon SNS action name.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



242
243
244
245
 
# File 'lib/aws-sdk-sns/client.rb', line 242

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


1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
 
# File 'lib/aws-sdk-sns/client.rb', line 1763

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



275
276
277
278
 
# File 'lib/aws-sdk-sns/client.rb', line 275

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

Returns:

See Also:



319
320
321
322
 
# File 'lib/aws-sdk-sns/client.rb', line 319

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, to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the ‘CreatePlatformApplication` action. The PlatformPrincipal is received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is “SSL certificate”. For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is “client id”. The PlatformCredential is also received from the notification service. For WNS, PlatformPrincipal is “Package Security Identifier”. For MPNS, PlatformPrincipal is “TLS certificate”. For Baidu, PlatformPrincipal is “API key”.

For APNS/APNS_SANDBOX, PlatformCredential is “private key”. For GCM, PlatformCredential is “API key”. For ADM, PlatformCredential is “client secret”. For WNS, PlatformCredential is “secret key”. For MPNS, PlatformCredential is “private key”. For Baidu, PlatformCredential is “secret key”. The PlatformApplicationArn that is returned when using ‘CreatePlatformApplication` is then used as an attribute for the `CreatePlatformEndpoint` action. For more information, see [Using Amazon SNS Mobile Push Notifications]. For more information about obtaining the PlatformPrincipal and PlatformCredential for each of the supported push notification services, see [Getting Started with Apple Push Notification Service], [Getting Started with Amazon Device Messaging], [Getting Started with Baidu Cloud Push], [Getting Started with Google Cloud Messaging for Android], [Getting Started with MPNS], or [Getting Started with WNS].

[1]: docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html [2]: docs.aws.amazon.com/sns/latest/dg/mobile-push-apns.html [3]: docs.aws.amazon.com/sns/latest/dg/mobile-push-adm.html [4]: docs.aws.amazon.com/sns/latest/dg/mobile-push-baidu.html [5]: docs.aws.amazon.com/sns/latest/dg/mobile-push-gcm.html [6]: docs.aws.amazon.com/sns/latest/dg/mobile-push-mpns.html [7]: docs.aws.amazon.com/sns/latest/dg/mobile-push-wns.html

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 (Google Cloud Messaging).

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

    For a list of attributes, see [SetPlatformApplicationAttributes]

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

Returns:

See Also:



402
403
404
405
 
# File 'lib/aws-sdk-sns/client.rb', line 402

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 and APNS. ‘CreatePlatformEndpoint` requires the PlatformApplicationArn that is returned from `CreatePlatformApplication`. The EndpointArn that is returned when using `CreatePlatformEndpoint` can then be used by the `Publish` action 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 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]: docs.aws.amazon.com/sns/latest/api/API_SetEndpointAttributes.html

Returns:

See Also:



475
476
477
478
 
# File 'lib/aws-sdk-sns/client.rb', line 475

def create_platform_endpoint(params = {}, options = {})
  req = build_request(:create_platform_endpoint, 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 topics. For more information, see [aws.amazon.com/sns][1]. 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]: aws.amazon.com/sns/

Examples:

Request syntax with placeholder values


resp = client.create_topic({
  name: "topicName", # required
  attributes: {
    "attributeName" => "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.

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

    A map of attributes with their corresponding values.

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

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

    • ‘DisplayName` – The display name to use for a topic with SMS subscriptions.

    • ‘Policy` – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.

Returns:

See Also:



533
534
535
536
 
# File 'lib/aws-sdk-sns/client.rb', line 533

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:



564
565
566
567
 
# File 'lib/aws-sdk-sns/client.rb', line 564

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



592
593
594
595
 
# File 'lib/aws-sdk-sns/client.rb', line 592

def delete_platform_application(params = {}, options = {})
  req = build_request(:delete_platform_application, 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:



617
618
619
620
 
# File 'lib/aws-sdk-sns/client.rb', line 617

def delete_topic(params = {}, options = {})
  req = build_request(:delete_topic, 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 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:



652
653
654
655
 
# File 'lib/aws-sdk-sns/client.rb', line 652

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



687
688
689
690
 
# File 'lib/aws-sdk-sns/client.rb', line 687

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



728
729
730
731
 
# File 'lib/aws-sdk-sns/client.rb', line 728

def get_sms_attributes(params = {}, options = {})
  req = build_request(:get_sms_attributes, 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:



757
758
759
760
 
# File 'lib/aws-sdk-sns/client.rb', line 757

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:



787
788
789
790
 
# File 'lib/aws-sdk-sns/client.rb', line 787

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

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:



842
843
844
845
 
# File 'lib/aws-sdk-sns/client.rb', line 842

def list_endpoints_by_platform_application(params = {}, options = {})
  req = build_request(:list_endpoints_by_platform_application, 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.

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:



884
885
886
887
 
# File 'lib/aws-sdk-sns/client.rb', line 884

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

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:



933
934
935
936
 
# File 'lib/aws-sdk-sns/client.rb', line 933

def list_platform_applications(params = {}, options = {})
  req = build_request(:list_platform_applications, 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).

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:



973
974
975
976
 
# File 'lib/aws-sdk-sns/client.rb', line 973

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

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:



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

def list_subscriptions_by_topic(params = {}, options = {})
  req = build_request(:list_subscriptions_by_topic, 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).

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:



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

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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1079
1080
1081
1082
 
# File 'lib/aws-sdk-sns/client.rb', line 1079

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 or sends a text message (SMS message) directly to a phone number.

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

When a ‘messageId` is returned, the message has been saved and Amazon SNS will attempt to deliver it shortly.

To use the ‘Publish` action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for the TargetArn parameter. The EndpointArn is returned when making a call with the `CreatePlatformEndpoint` action.

For more information about formatting messages, see [Send Custom Platform-Specific Payloads in Messages to Mobile Devices].

[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: "String",
  message: "message", # required
  subject: "subject",
  message_structure: "messageStructure",
  message_attributes: {
    "String" => {
      data_type: "String", # required
      string_value: "String",
      binary_value: "data",
    },
  },
})

Response structure


resp.message_id #=> 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) —

    Either TopicArn or EndpointArn, but not both.

    If you don’t specify a value for the ‘TargetArn` parameter, you must specify a value for the `PhoneNumber` or `TopicArn` parameters.

  • :phone_number (String) —

    The phone number to which you want to deliver an SMS message. Use E.164 format.

    If you don’t specify a value for the ‘PhoneNumber` parameter, you must specify a value for the `TargetArn` or `TopicArn` parameters.

  • :message (required, String) —

    The message you want to send.

    The ‘Message` parameter is always a string. If you set `MessageStructure` to `json`, you must string-encode the `Message` parameter.

    If you are publishing to a topic and you want to send the same message to all transport protocols, include the text of the message as a String value. If you want to send different messages for each transport protocol, set the value of the ‘MessageStructure` parameter to `json` and use a JSON object for the `Message` parameter.

    Constraints:

    • With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).

    • For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters.

      If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren’t truncated mid-word but are cut off at whole-word boundaries.

      The total size limit for a single SMS ‘Publish` action is 1,600 characters.

    JSON-specific constraints:

    • Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.

    • The values will be parsed (unescaped) before they are used in outgoing messages.

    • Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).

    • Values have a minimum length of 0 (the empty string, “”, is allowed).

    • Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).

    • Non-string values will cause the key to be ignored.

    • Keys that do not correspond to supported transport protocols are ignored.

    • Duplicate keys are not allowed.

    • Failure to parse or validate any key or value in the message will cause the ‘Publish` call to return an error (no partial delivery).

  • :subject (String) —

    Optional parameter to be used as the “Subject” line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.

    Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.

  • :message_structure (String) —

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

    • be a syntactically valid JSON object; and

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

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

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

    Valid value: ‘json`

    [1]: docs.aws.amazon.com/sns/latest/gsg/Publish.html#sns-message-formatting-by-protocol

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

    Message attributes for Publish action.

Returns:

See Also:



1255
1256
1257
1258
 
# File 'lib/aws-sdk-sns/client.rb', line 1255

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

#remove_permission(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

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:



1281
1282
1283
1284
 
# File 'lib/aws-sdk-sns/client.rb', line 1281

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



1330
1331
1332
1333
 
# File 'lib/aws-sdk-sns/client.rb', line 1330

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. 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 APNS/APNS_SANDBOX, PlatformCredential is private key. For GCM, PlatformCredential is “API key”. For ADM, PlatformCredential is “client secret”.

    • ‘PlatformPrincipal` – The principal received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is SSL certificate. For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is “client id”.

    • ‘EventEndpointCreated` – Topic ARN to which EndpointCreated event notifications should be sent.

    • ‘EventEndpointDeleted` – Topic ARN to which EndpointDeleted event notifications should be sent.

    • ‘EventEndpointUpdated` – Topic ARN to which EndpointUpdate event notifications should be sent.

    • ‘EventDeliveryFailure` – Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application’s endpoints.

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

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

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1401
1402
1403
1404
 
# File 'lib/aws-sdk-sns/client.rb', line 1401

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 [Sending an SMS Message] in the *Amazon SNS Developer Guide*.

[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 account. You can set values for the following attribute names:

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

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

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

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

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

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

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

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

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

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

    • Time that the message was published (in UTC)

    • Message ID

    • Destination phone number

    • Message type

    • Delivery status

    • Message price (in USD)

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

    • Total number of parts

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

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

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



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

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 the ‘SetTopicAttributes` action uses:

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

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

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

  • :attribute_value (String) —

    The new value for the attribute in JSON format.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1562
1563
1564
1565
 
# File 'lib/aws-sdk-sns/client.rb', line 1562

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.

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:

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

  • :attribute_value (String) —

    The new value for the attribute.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

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

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

Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the ‘ConfirmSubscription` action with the token from the confirmation message. Confirmation tokens are valid for three days.

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.subscription_arn #=> String

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 you want to use. Supported protocols include:

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

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

    • ‘email` – delivery of message via SMTP

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

    • ‘sms` – delivery of message via SMS

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

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

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

  • :endpoint (String) —

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

    • For the ‘http` protocol, the endpoint is an URL beginning with “http://”

    • For the ‘https` protocol, the endpoint is a URL beginning with “https://”

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

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

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

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

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

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

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

    A map of attributes with their corresponding values.

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

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

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

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

  • :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 ‘false`, the response includes the ARN for confirmed subscriptions, but it includes an ARN value of “pending subscription” for subscriptions that are not yet confirmed. A subscription becomes confirmed when the subscriber calls the `ConfirmSubscription` action with a confirmation token.

    If you set this parameter to ‘true`, the response includes the ARN in all cases, even if the subscription is not yet confirmed.

    The default value is ‘false`.

Returns:

See Also:



1724
1725
1726
1727
 
# File 'lib/aws-sdk-sns/client.rb', line 1724

def subscribe(params = {}, options = {})
  req = build_request(:subscribe, 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 AWS signature is required. If the ‘Unsubscribe` call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the `Unsubscribe` request was unintended.

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

Examples:

Request syntax with placeholder values


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

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:



1754
1755
1756
1757
 
# File 'lib/aws-sdk-sns/client.rb', line 1754

def unsubscribe(params = {}, options = {})
  req = build_request(:unsubscribe, 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. 


1778
1779
1780
 
# File 'lib/aws-sdk-sns/client.rb', line 1778

def waiter_names
  []
end