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

Class: AWS::SNS::Client::V20100331

Inherits:

AWS::SNS::Client

• Object
• Core::Client
• Core::QueryClient
• AWS::SNS::Client
• AWS::SNS::Client::V20100331

Defined in:

lib/aws/sns/client.rb

Constant Summary

Constant Summary

Constants inherited from AWS::SNS::Client

API_VERSION

Instance Attribute Summary

Attributes inherited from Core::Client

#config

Instance Method Summary

• #add_permission(options = {}) ⇒ Core::Response

  Calls the AddPermission API operation.

• #confirm_subscription(options = {}) ⇒ Core::Response

  Calls the ConfirmSubscription API operation.

• #create_platform_application(options = {}) ⇒ Core::Response

  Calls the CreatePlatformApplication API operation.

• #create_platform_endpoint(options = {}) ⇒ Core::Response

  Calls the CreatePlatformEndpoint API operation.

• #create_topic(options = {}) ⇒ Core::Response

  Calls the CreateTopic API operation.

• #delete_endpoint(options = {}) ⇒ Core::Response

  Calls the DeleteEndpoint API operation.

• #delete_platform_application(options = {}) ⇒ Core::Response

  Calls the DeletePlatformApplication API operation.

• #delete_topic(options = {}) ⇒ Core::Response

  Calls the DeleteTopic API operation.

• #get_endpoint_attributes(options = {}) ⇒ Core::Response

  Calls the GetEndpointAttributes API operation.

• #get_platform_application_attributes(options = {}) ⇒ Core::Response

  Calls the GetPlatformApplicationAttributes API operation.

• #get_subscription_attributes(options = {}) ⇒ Core::Response

  Calls the GetSubscriptionAttributes API operation.

• #get_topic_attributes(options = {}) ⇒ Core::Response

  Calls the GetTopicAttributes API operation.

• #list_endpoints_by_platform_application(options = {}) ⇒ Core::Response

  Calls the ListEndpointsByPlatformApplication API operation.

• #list_platform_applications(options = {}) ⇒ Core::Response

  Calls the ListPlatformApplications API operation.

• #list_subscriptions(options = {}) ⇒ Core::Response

  Calls the ListSubscriptions API operation.

• #list_subscriptions_by_topic(options = {}) ⇒ Core::Response

  Calls the ListSubscriptionsByTopic API operation.

• #list_topics(options = {}) ⇒ Core::Response

  Calls the ListTopics API operation.

• #publish(options = {}) ⇒ Core::Response

  Calls the Publish API operation.

• #remove_permission(options = {}) ⇒ Core::Response

  Calls the RemovePermission API operation.

• #set_endpoint_attributes(options = {}) ⇒ Core::Response

  Calls the SetEndpointAttributes API operation.

• #set_platform_application_attributes(options = {}) ⇒ Core::Response

  Calls the SetPlatformApplicationAttributes API operation.

• #set_subscription_attributes(options = {}) ⇒ Core::Response

  Calls the SetSubscriptionAttributes API operation.

• #set_topic_attributes(options = {}) ⇒ Core::Response

  Calls the SetTopicAttributes API operation.

• #subscribe(options = {}) ⇒ Core::Response

  Calls the Subscribe API operation.

• #unsubscribe(options = {}) ⇒ Core::Response

  Calls the Unsubscribe API operation.

Methods inherited from Core::Client

#initialize, #log_warning, #operations, #with_http_handler, #with_options

Constructor Details

This class inherits a constructor from AWS::Core::Client

Instance Method Details

#add_permission(options = {}) ⇒ Core::Response

Calls the AddPermission API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :topic_arn - required - (String)
  • :label - required - (String)
  • :aws_account_id - required - (Array<)
  • :action_name - required - (Array<)

Returns:

• (Core::Response)

#confirm_subscription(options = {}) ⇒ Core::Response

Calls the ConfirmSubscription API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :topic_arn - required - (String)
  • :token - required - (String)
  • :authenticate_on_unsubscribe - (String)

Returns:

• (Core::Response) —

  The #data method of the response object returns a hash with the following structure:

  • :subscription_arn - (String)

#create_platform_application(options = {}) ⇒ Core::Response

Calls the CreatePlatformApplication API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :name - required - (String)
  • :platform - required - (String)
  • :attributes - required - (Hash<<String,String>)

Returns:

• (Core::Response) —

  The #data method of the response object returns a hash with the following structure:

  • :platform_application_arn - (String)

#create_platform_endpoint(options = {}) ⇒ Core::Response

Calls the CreatePlatformEndpoint API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :platform_application_arn - required - (String)
  • :token - required - (String)
  • :custom_user_data - (String)
  • :attributes - (Hash<<String,String>)

Returns:

• (Core::Response) —

  The #data method of the response object returns a hash with the following structure:

  • :endpoint_arn - (String)

#create_topic(options = {}) ⇒ Core::Response

Calls the CreateTopic API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :name - required - (String)

Returns:

• (Core::Response) —

  The #data method of the response object returns a hash with the following structure:

  • :topic_arn - (String)

#delete_endpoint(options = {}) ⇒ Core::Response

Calls the DeleteEndpoint API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :endpoint_arn - required - (String)

Returns:

• (Core::Response)

#delete_platform_application(options = {}) ⇒ Core::Response

Calls the DeletePlatformApplication API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :platform_application_arn - required - (String)

Returns:

• (Core::Response)

#delete_topic(options = {}) ⇒ Core::Response

Calls the DeleteTopic API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :topic_arn - required - (String)

Returns:

• (Core::Response)

#get_endpoint_attributes(options = {}) ⇒ Core::Response

Calls the GetEndpointAttributes API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :endpoint_arn - required - (String)

Returns:

• (Core::Response) —

  The #data method of the response object returns a hash with the following structure:

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

#get_platform_application_attributes(options = {}) ⇒ Core::Response

Calls the GetPlatformApplicationAttributes API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :platform_application_arn - required - (String)

Returns:

• (Core::Response) —

  The #data method of the response object returns a hash with the following structure:

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

#get_subscription_attributes(options = {}) ⇒ Core::Response

Calls the GetSubscriptionAttributes API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :subscription_arn - required - (String)

Returns:

• (Core::Response) —

  The #data method of the response object returns a hash with the following structure:

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

#get_topic_attributes(options = {}) ⇒ Core::Response

Calls the GetTopicAttributes API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :topic_arn - required - (String)

Returns:

• (Core::Response) —

  The #data method of the response object returns a hash with the following structure:

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

#list_endpoints_by_platform_application(options = {}) ⇒ Core::Response

Calls the ListEndpointsByPlatformApplication API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :platform_application_arn - required - (String)
  • :next_token - (String)

Returns:

• (Core::Response) —

  The #data method of the response object returns a hash with the following structure:

  • :endpoints - (Array)
    • :endpoint_arn - (String)
    • :attributes - (Hash<String,String>)
  • :next_token - (String)

#list_platform_applications(options = {}) ⇒ Core::Response

Calls the ListPlatformApplications API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :next_token - (String)

Returns:

• (Core::Response) —

  The #data method of the response object returns a hash with the following structure:

  • :platform_applications - (Array)
    • :platform_application_arn - (String)
    • :attributes - (Hash<String,String>)
  • :next_token - (String)

#list_subscriptions(options = {}) ⇒ Core::Response

Calls the ListSubscriptions API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :next_token - (String)

Returns:

• (Core::Response) —

  The #data method of the response object returns a hash with the following structure:

  • :subscriptions - (Array)
    • :subscription_arn - (String)
    • :owner - (String)
    • :protocol - (String)
    • :endpoint - (String)
    • :topic_arn - (String)
  • :next_token - (String)

#list_subscriptions_by_topic(options = {}) ⇒ Core::Response

Calls the ListSubscriptionsByTopic API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :topic_arn - required - (String)
  • :next_token - (String)

Returns:

• (Core::Response) —

  The #data method of the response object returns a hash with the following structure:

  • :subscriptions - (Array)
    • :subscription_arn - (String)
    • :owner - (String)
    • :protocol - (String)
    • :endpoint - (String)
    • :topic_arn - (String)
  • :next_token - (String)

#list_topics(options = {}) ⇒ Core::Response

Calls the ListTopics API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :next_token - (String)

Returns:

• (Core::Response) —

  The #data method of the response object returns a hash with the following structure:

  • :topics - (Array)
    • :topic_arn - (String)
  • :next_token - (String)

#publish(options = {}) ⇒ Core::Response

Calls the Publish API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :topic_arn - (String)
  • :target_arn - (String)
  • :message - required - (String)
  • :subject - (String)
  • :message_structure - (String)
  • :message_attributes - (Hash<<String,Hash>)
    • :data_type - required - (String)
    • :string_value - (String)
    • :binary_value - (String)

Returns:

• (Core::Response) —

  The #data method of the response object returns a hash with the following structure:

  • :message_id - (String)

#remove_permission(options = {}) ⇒ Core::Response

Calls the RemovePermission API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :topic_arn - required - (String)
  • :label - required - (String)

Returns:

• (Core::Response)

#set_endpoint_attributes(options = {}) ⇒ Core::Response

Calls the SetEndpointAttributes API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :endpoint_arn - required - (String)
  • :attributes - required - (Hash<<String,String>)

Returns:

• (Core::Response)

#set_platform_application_attributes(options = {}) ⇒ Core::Response

Calls the SetPlatformApplicationAttributes API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :platform_application_arn - required - (String)
  • :attributes - required - (Hash<<String,String>)

Returns:

• (Core::Response)

#set_subscription_attributes(options = {}) ⇒ Core::Response

Calls the SetSubscriptionAttributes API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :subscription_arn - required - (String)
  • :attribute_name - required - (String)
  • :attribute_value - (String)

Returns:

• (Core::Response)

#set_topic_attributes(options = {}) ⇒ Core::Response

Calls the SetTopicAttributes API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :topic_arn - required - (String)
  • :attribute_name - required - (String)
  • :attribute_value - (String)

Returns:

• (Core::Response)

#subscribe(options = {}) ⇒ Core::Response

Calls the Subscribe API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :topic_arn - required - (String)
  • :protocol - required - (String)
  • :endpoint - (String)

Returns:

• (Core::Response) —

  The #data method of the response object returns a hash with the following structure:

  • :subscription_arn - (String)

#unsubscribe(options = {}) ⇒ Core::Response

Calls the Unsubscribe API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :subscription_arn - required - (String)

Returns:

• (Core::Response)