aws-sdk-sns 1.40.0 → 1.41.0

data/lib/aws-sdk-sns/errors.rb

@@ -42,6 +42,7 @@ module Aws::SNS
   # * {KMSOptInRequired}
   # * {KMSThrottlingException}
   # * {NotFoundException}
+  # * {OptedOutException}
   # * {PlatformApplicationDisabledException}
   # * {ResourceNotFoundException}
   # * {StaleTagException}
@@ -50,6 +51,9 @@ module Aws::SNS
   # * {TagPolicyException}
   # * {ThrottledException}
   # * {TopicLimitExceededException}
+  # * {UserErrorException}
+  # * {ValidationException}
+  # * {VerificationException}
   #
   # Additionally, error classes are dynamically generated for service errors based on the error code
   # if they are not defined above.
@@ -282,6 +286,21 @@ module Aws::SNS
       end
     end
 
+    class OptedOutException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SNS::Types::OptedOutException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
     class PlatformApplicationDisabledException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -402,5 +421,55 @@ module Aws::SNS
       end
     end
 
+    class UserErrorException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SNS::Types::UserErrorException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
+    class ValidationException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SNS::Types::ValidationException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
+    class VerificationException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SNS::Types::VerificationException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+
+      # @return [String]
+      def status
+        @data[:status]
+      end
+    end
+
   end
 end

data/lib/aws-sdk-sns/resource.rb

@@ -54,7 +54,7 @@ module Aws::SNS
     #   APNS (Apple Push Notification Service), APNS\_SANDBOX, and GCM
     #   (Firebase Cloud Messaging).
     # @option options [required, Hash<String,String>] :attributes
-    #   For a list of attributes, see [SetPlatformApplicationAttributes][1]
+    #   For a list of attributes, see [SetPlatformApplicationAttributes][1].
     #
     #
     #
@@ -109,9 +109,9 @@ module Aws::SNS
     #   * `Policy` – The policy that defines who can access your topic. By
     #     default, only the topic owner can publish or subscribe to the topic.
     #
-    #   The following attribute applies only to [server-side-encryption][1]\:
+    #   The following attribute applies only to [server-side encryption][1]\:
     #
-    #   * `KmsMasterKeyId` – The ID of an AWS-managed customer master key
+    #   * `KmsMasterKeyId` – The ID of an AWS managed customer master key
     #     (CMK) for Amazon SNS or a custom CMK. For more information, see [Key
     #     Terms][2]. For more examples, see [KeyId][3] in the *AWS Key
     #     Management Service API Reference*.
@@ -135,8 +135,8 @@ module Aws::SNS
     #       the body of the message (but not the attributes of the message).
     #
     #       (Optional) To override the generated value, you can specify a
-    #       value for the the `MessageDeduplicationId` parameter for the
-    #       `Publish` action.
+    #       value for the `MessageDeduplicationId` parameter for the `Publish`
+    #       action.
     #
     #
     #

data/lib/aws-sdk-sns/topic.rb

@@ -88,8 +88,8 @@ module Aws::SNS
     #     the body of the message (but not the attributes of the message).
     #
     #     (Optional) To override the generated value, you can specify a
-    #     value for the the `MessageDeduplicationId` parameter for the
-    #     `Publish` action.
+    #     value for the `MessageDeduplicationId` parameter for the `Publish`
+    #     action.
     #
     #
     #
@@ -403,8 +403,8 @@ module Aws::SNS
     #       the body of the message (but not the attributes of the message).
     #
     #       (Optional) To override the generated value, you can specify a
-    #       value for the the `MessageDeduplicationId` parameter for the
-    #       `Publish` action.
+    #       value for the `MessageDeduplicationId` parameter for the `Publish`
+    #       action.
     #
     #
     #

data/lib/aws-sdk-sns/types.rb

@@ -211,7 +211,7 @@ module Aws::SNS
     #   @return [String]
     #
     # @!attribute [rw] attributes
-    #   For a list of attributes, see [SetPlatformApplicationAttributes][1]
+    #   For a list of attributes, see [SetPlatformApplicationAttributes][1].
     #
     #
     #
@@ -295,6 +295,38 @@ module Aws::SNS
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass CreateSMSSandboxPhoneNumberInput
+    #   data as a hash:
+    #
+    #       {
+    #         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
+    #       }
+    #
+    # @!attribute [rw] phone_number
+    #   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.
+    #   @return [String]
+    #
+    # @!attribute [rw] language_code
+    #   The language to use for sending the OTP. The default value is
+    #   `en-US`.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CreateSMSSandboxPhoneNumberInput AWS API Documentation
+    #
+    class CreateSMSSandboxPhoneNumberInput < Struct.new(
+      :phone_number,
+      :language_code)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CreateSMSSandboxPhoneNumberResult AWS API Documentation
+    #
+    class CreateSMSSandboxPhoneNumberResult < Aws::EmptyStructure; end
+
     # Input for CreateTopic action.
     #
     # @note When making an API call, you may pass CreateTopicInput
@@ -342,10 +374,10 @@ module Aws::SNS
     #     default, only the topic owner can publish or subscribe to the
     #     topic.
     #
-    #   The following attribute applies only to
-    #   [server-side-encryption][1]\:
+    #   The following attribute applies only to [server-side
+    #   encryption][1]\:
     #
-    #   * `KmsMasterKeyId` – The ID of an AWS-managed customer master key
+    #   * `KmsMasterKeyId` – The ID of an AWS managed customer master key
     #     (CMK) for Amazon SNS or a custom CMK. For more information, see
     #     [Key Terms][2]. For more examples, see [KeyId][3] in the *AWS Key
     #     Management Service API Reference*.
@@ -370,7 +402,7 @@ module Aws::SNS
     #       message).
     #
     #       (Optional) To override the generated value, you can specify a
-    #       value for the the `MessageDeduplicationId` parameter for the
+    #       value for the `MessageDeduplicationId` parameter for the
     #       `Publish` action.
     #
     #
@@ -457,6 +489,29 @@ module Aws::SNS
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass DeleteSMSSandboxPhoneNumberInput
+    #   data as a hash:
+    #
+    #       {
+    #         phone_number: "PhoneNumberString", # required
+    #       }
+    #
+    # @!attribute [rw] phone_number
+    #   The destination phone number to delete.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/DeleteSMSSandboxPhoneNumberInput AWS API Documentation
+    #
+    class DeleteSMSSandboxPhoneNumberInput < Struct.new(
+      :phone_number)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/DeleteSMSSandboxPhoneNumberResult AWS API Documentation
+    #
+    class DeleteSMSSandboxPhoneNumberResult < Aws::EmptyStructure; end
+
     # @note When making an API call, you may pass DeleteTopicInput
     #   data as a hash:
     #
@@ -670,6 +725,24 @@ module Aws::SNS
       include Aws::Structure
     end
 
+    # @api private
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetSMSSandboxAccountStatusInput AWS API Documentation
+    #
+    class GetSMSSandboxAccountStatusInput < Aws::EmptyStructure; end
+
+    # @!attribute [rw] is_in_sandbox
+    #   Indicates whether the calling account is in the SMS sandbox.
+    #   @return [Boolean]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetSMSSandboxAccountStatusResult AWS API Documentation
+    #
+    class GetSMSSandboxAccountStatusResult < Struct.new(
+      :is_in_sandbox)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Input for GetSubscriptionAttributes.
     #
     # @note When making an API call, you may pass GetSubscriptionAttributesInput
@@ -843,7 +916,7 @@ module Aws::SNS
     #       message).
     #
     #       (Optional) To override the generated value, you can specify a
-    #       value for the the `MessageDeduplicationId` parameter for the
+    #       value for the `MessageDeduplicationId` parameter for the
     #       `Publish` action.
     #
     #
@@ -1064,6 +1137,51 @@ module Aws::SNS
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass ListOriginationNumbersRequest
+    #   data as a hash:
+    #
+    #       {
+    #         next_token: "nextToken",
+    #         max_results: 1,
+    #       }
+    #
+    # @!attribute [rw] next_token
+    #   Token that the previous `ListOriginationNumbers` request returns.
+    #   @return [String]
+    #
+    # @!attribute [rw] max_results
+    #   The maximum number of origination numbers to return.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListOriginationNumbersRequest AWS API Documentation
+    #
+    class ListOriginationNumbersRequest < Struct.new(
+      :next_token,
+      :max_results)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] next_token
+    #   A `NextToken` string is returned when you call the
+    #   `ListOriginationNumbers` operation if additional pages of records
+    #   are available.
+    #   @return [String]
+    #
+    # @!attribute [rw] phone_numbers
+    #   A list of the calling account's verified and pending origination
+    #   numbers.
+    #   @return [Array<Types::PhoneNumberInformation>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListOriginationNumbersResult AWS API Documentation
+    #
+    class ListOriginationNumbersResult < Struct.new(
+      :next_token,
+      :phone_numbers)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The input for the `ListPhoneNumbersOptedOut` action.
     #
     # @note When making an API call, you may pass ListPhoneNumbersOptedOutInput
@@ -1155,6 +1273,51 @@ module Aws::SNS
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass ListSMSSandboxPhoneNumbersInput
+    #   data as a hash:
+    #
+    #       {
+    #         next_token: "nextToken",
+    #         max_results: 1,
+    #       }
+    #
+    # @!attribute [rw] next_token
+    #   Token that the previous `ListSMSSandboxPhoneNumbersInput` request
+    #   returns.
+    #   @return [String]
+    #
+    # @!attribute [rw] max_results
+    #   The maximum number of phone numbers to return.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListSMSSandboxPhoneNumbersInput AWS API Documentation
+    #
+    class ListSMSSandboxPhoneNumbersInput < Struct.new(
+      :next_token,
+      :max_results)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] phone_numbers
+    #   A list of the calling account's pending and verified phone numbers.
+    #   @return [Array<Types::SMSSandboxPhoneNumber>]
+    #
+    # @!attribute [rw] next_token
+    #   A `NextToken` string is returned when you call the
+    #   `ListSMSSandboxPhoneNumbersInput` operation if additional pages of
+    #   records are available.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListSMSSandboxPhoneNumbersResult AWS API Documentation
+    #
+    class ListSMSSandboxPhoneNumbersResult < Struct.new(
+      :phone_numbers,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Input for ListSubscriptionsByTopic action.
     #
     # @note When making an API call, you may pass ListSubscriptionsByTopicInput
@@ -1414,6 +1577,61 @@ module Aws::SNS
     #
     class OptInPhoneNumberResponse < Aws::EmptyStructure; end
 
+    # Indicates that the specified phone number opted out of receiving SMS
+    # messages from your AWS account. You can't send SMS messages to phone
+    # numbers that opt out.
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/OptedOutException AWS API Documentation
+    #
+    class OptedOutException < Struct.new(
+      :message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # A list of phone numbers and their metadata.
+    #
+    # @!attribute [rw] created_at
+    #   The date and time when the phone number was created.
+    #   @return [Time]
+    #
+    # @!attribute [rw] phone_number
+    #   The phone number.
+    #   @return [String]
+    #
+    # @!attribute [rw] status
+    #   The status of the phone number.
+    #   @return [String]
+    #
+    # @!attribute [rw] iso_2_country_code
+    #   The two-character code for the country or region, in ISO 3166-1
+    #   alpha-2 format.
+    #   @return [String]
+    #
+    # @!attribute [rw] route_type
+    #   The list of supported routes.
+    #   @return [String]
+    #
+    # @!attribute [rw] number_capabilities
+    #   The capabilities of each phone number.
+    #   @return [Array<String>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/PhoneNumberInformation AWS API Documentation
+    #
+    class PhoneNumberInformation < Struct.new(
+      :created_at,
+      :phone_number,
+      :status,
+      :iso_2_country_code,
+      :route_type,
+      :number_capabilities)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Platform application object.
     #
     # @!attribute [rw] platform_application_arn
@@ -1682,7 +1900,8 @@ module Aws::SNS
       include Aws::Structure
     end
 
-    # Can't tag resource. Verify that the topic exists.
+    # Can’t perform the action on the specified resource. Make sure that the
+    # resource exists.
     #
     # @!attribute [rw] message
     #   @return [String]
@@ -1695,6 +1914,39 @@ module Aws::SNS
       include Aws::Structure
     end
 
+    # A verified or pending destination phone number in the SMS sandbox.
+    #
+    # When you start using Amazon SNS to send SMS messages, your AWS 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 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][1] in the *Amazon SNS Developer
+    # Guide*.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html
+    #
+    # @!attribute [rw] phone_number
+    #   The destination phone number.
+    #   @return [String]
+    #
+    # @!attribute [rw] status
+    #   The destination phone number's verification status.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/SMSSandboxPhoneNumber AWS API Documentation
+    #
+    class SMSSandboxPhoneNumber < Struct.new(
+      :phone_number,
+      :status)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Input for SetEndpointAttributes action.
     #
     # @note When making an API call, you may pass SetEndpointAttributesInput
@@ -2046,7 +2298,7 @@ module Aws::SNS
     #       message).
     #
     #       (Optional) To override the generated value, you can specify a
-    #       value for the the `MessageDeduplicationId` parameter for the
+    #       value for the `MessageDeduplicationId` parameter for the
     #       `Publish` action.
     #
     #
@@ -2485,5 +2737,83 @@ module Aws::SNS
     #
     class UntagResourceResponse < Aws::EmptyStructure; end
 
+    # Indicates that a request parameter does not comply with the associated
+    # constraints.
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/UserErrorException AWS API Documentation
+    #
+    class UserErrorException < Struct.new(
+      :message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Indicates that a parameter in the request is invalid.
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ValidationException AWS API Documentation
+    #
+    class ValidationException < Struct.new(
+      :message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Indicates that the one-time password (OTP) used for verification is
+    # invalid.
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    # @!attribute [rw] status
+    #   The status of the verification error.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/VerificationException AWS API Documentation
+    #
+    class VerificationException < Struct.new(
+      :message,
+      :status)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @note When making an API call, you may pass VerifySMSSandboxPhoneNumberInput
+    #   data as a hash:
+    #
+    #       {
+    #         phone_number: "PhoneNumberString", # required
+    #         one_time_password: "OTPCode", # required
+    #       }
+    #
+    # @!attribute [rw] phone_number
+    #   The destination phone number to verify.
+    #   @return [String]
+    #
+    # @!attribute [rw] one_time_password
+    #   The OTP sent to the destination number from the
+    #   `CreateSMSSandBoxPhoneNumber` call.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/VerifySMSSandboxPhoneNumberInput AWS API Documentation
+    #
+    class VerifySMSSandboxPhoneNumberInput < Struct.new(
+      :phone_number,
+      :one_time_password)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The destination phone number's verification status.
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/VerifySMSSandboxPhoneNumberResult AWS API Documentation
+    #
+    class VerifySMSSandboxPhoneNumberResult < Aws::EmptyStructure; end
+
   end
 end