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.
Adds a destination phone number to an AWS 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 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 in the Amazon SNS Developer Guide.
" + }, "CreateTopic":{ "name":"CreateTopic", "http":{ @@ -156,6 +177,27 @@ ], "documentation":"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.
" }, + "DeleteSMSSandboxPhoneNumber":{ + "name":"DeleteSMSSandboxPhoneNumber", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSMSSandboxPhoneNumberInput"}, + "output":{ + "shape":"DeleteSMSSandboxPhoneNumberResult", + "resultWrapper":"DeleteSMSSandboxPhoneNumberResult" + }, + "errors":[ + {"shape":"AuthorizationErrorException"}, + {"shape":"InternalErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"UserErrorException"}, + {"shape":"ThrottledException"} + ], + "documentation":"Deletes an AWS account's verified or pending phone number from 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 in the Amazon SNS Developer Guide.
" + }, "DeleteTopic":{ "name":"DeleteTopic", "http":{ @@ -231,6 +273,24 @@ ], "documentation":"Returns the settings for sending SMS messages from your account.
These settings are set with the SetSMSAttributes action.
Retrieves the SMS sandbox status for the calling AWS account in the target AWS Region.
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 in the Amazon SNS Developer Guide.
" + }, "GetSubscriptionAttributes":{ "name":"GetSubscriptionAttributes", "http":{ @@ -289,6 +349,26 @@ ], "documentation":"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).
" }, + "ListOriginationNumbers":{ + "name":"ListOriginationNumbers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListOriginationNumbersRequest"}, + "output":{ + "shape":"ListOriginationNumbersResult", + "resultWrapper":"ListOriginationNumbersResult" + }, + "errors":[ + {"shape":"InternalErrorException"}, + {"shape":"AuthorizationErrorException"}, + {"shape":"ThrottledException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ValidationException"} + ], + "documentation":"Lists the calling AWS account's dedicated origination numbers and their metadata. For more information about origination numbers, see Origination numbers in the Amazon SNS Developer Guide.
" + }, "ListPhoneNumbersOptedOut":{ "name":"ListPhoneNumbersOptedOut", "http":{ @@ -326,6 +406,26 @@ ], "documentation":"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).
" }, + "ListSMSSandboxPhoneNumbers":{ + "name":"ListSMSSandboxPhoneNumbers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSMSSandboxPhoneNumbersInput"}, + "output":{ + "shape":"ListSMSSandboxPhoneNumbersResult", + "resultWrapper":"ListSMSSandboxPhoneNumbersResult" + }, + "errors":[ + {"shape":"AuthorizationErrorException"}, + {"shape":"InternalErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottledException"} + ], + "documentation":"Lists the calling AWS account's current verified and pending destination phone numbers 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 in the Amazon SNS Developer Guide.
" + }, "ListSubscriptions":{ "name":"ListSubscriptions", "http":{ @@ -626,6 +726,27 @@ {"shape":"ConcurrentAccessException"} ], "documentation":"Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.
" + }, + "VerifySMSSandboxPhoneNumber":{ + "name":"VerifySMSSandboxPhoneNumber", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"VerifySMSSandboxPhoneNumberInput"}, + "output":{ + "shape":"VerifySMSSandboxPhoneNumberResult", + "resultWrapper":"VerifySMSSandboxPhoneNumberResult" + }, + "errors":[ + {"shape":"AuthorizationErrorException"}, + {"shape":"InternalErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"VerificationException"}, + {"shape":"ThrottledException"} + ], + "documentation":"Verifies a destination phone number with a one-time password (OTP) for the calling AWS account.
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 in the Amazon SNS Developer Guide.
" } }, "shapes":{ @@ -773,7 +894,7 @@ }, "Attributes":{ "shape":"MapStringToString", - "documentation":"For a list of attributes, see SetPlatformApplicationAttributes
" + "documentation":"For a list of attributes, see SetPlatformApplicationAttributes.
" } }, "documentation":"Input for CreatePlatformApplication action.
" @@ -814,6 +935,25 @@ }, "documentation":"Input for CreatePlatformEndpoint action.
" }, + "CreateSMSSandboxPhoneNumberInput":{ + "type":"structure", + "required":["PhoneNumber"], + "members":{ + "PhoneNumber":{ + "shape":"PhoneNumberString", + "documentation":"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.
" + }, + "LanguageCode":{ + "shape":"LanguageCodeString", + "documentation":"The language to use for sending the OTP. The default value is en-US.
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the CreateTopic action uses:
DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
DisplayName – The display name to use for a topic with SMS subscriptions.
FifoTopic – Set to true to create a FIFO topic.
Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
The following attribute applies only to server-side-encryption:
KmsMasterKeyId – The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.
The following attributes apply only to FIFO topics:
FifoTopic – When this is set to true, a FIFO topic is created.
ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.
When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
(Optional) To override the generated value, you can specify a value for the the MessageDeduplicationId parameter for the Publish action.
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the CreateTopic action uses:
DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
DisplayName – The display name to use for a topic with SMS subscriptions.
FifoTopic – Set to true to create a FIFO topic.
Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
The following attribute applies only to server-side encryption:
KmsMasterKeyId – The ID of an AWS managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.
The following attributes apply only to FIFO topics:
FifoTopic – When this is set to true, a FIFO topic is created.
ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.
When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
(Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.
Input for DeletePlatformApplication action.
" }, + "DeleteSMSSandboxPhoneNumberInput":{ + "type":"structure", + "required":["PhoneNumber"], + "members":{ + "PhoneNumber":{ + "shape":"PhoneNumberString", + "documentation":"The destination phone number to delete.
" + } + } + }, + "DeleteSMSSandboxPhoneNumberResult":{ + "type":"structure", + "members":{ + } + }, "DeleteTopicInput":{ "type":"structure", "required":["TopicArn"], @@ -984,6 +1139,21 @@ }, "documentation":"The response from the GetSMSAttributes request.
Indicates whether the calling account is in the SMS sandbox.
" + } + } + }, "GetSubscriptionAttributesInput":{ "type":"structure", "required":["SubscriptionArn"], @@ -1021,7 +1191,7 @@ "members":{ "Attributes":{ "shape":"TopicAttributesMap", - "documentation":"A map of the topic's attributes. Attributes in this map include the following:
DeliveryPolicy – The JSON serialization of the topic's delivery policy.
DisplayName – The human-readable name used in the From field for notifications to email and email-json endpoints.
Owner – The AWS account ID of the topic's owner.
Policy – The JSON serialization of the topic's access control policy.
SubscriptionsConfirmed – The number of confirmed subscriptions for the topic.
SubscriptionsDeleted – The number of deleted subscriptions for the topic.
SubscriptionsPending – The number of subscriptions pending confirmation for the topic.
TopicArn – The topic's ARN.
EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy, taking system defaults into account.
The following attribute applies only to server-side-encryption:
KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.
The following attributes apply only to FIFO topics:
FifoTopic – When this is set to true, a FIFO topic is created.
ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.
When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
(Optional) To override the generated value, you can specify a value for the the MessageDeduplicationId parameter for the Publish action.
A map of the topic's attributes. Attributes in this map include the following:
DeliveryPolicy – The JSON serialization of the topic's delivery policy.
DisplayName – The human-readable name used in the From field for notifications to email and email-json endpoints.
Owner – The AWS account ID of the topic's owner.
Policy – The JSON serialization of the topic's access control policy.
SubscriptionsConfirmed – The number of confirmed subscriptions for the topic.
SubscriptionsDeleted – The number of deleted subscriptions for the topic.
SubscriptionsPending – The number of subscriptions pending confirmation for the topic.
TopicArn – The topic's ARN.
EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy, taking system defaults into account.
The following attribute applies only to server-side-encryption:
KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.
The following attributes apply only to FIFO topics:
FifoTopic – When this is set to true, a FIFO topic is created.
ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.
When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
(Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.
Response for GetTopicAttributes action.
" @@ -1081,6 +1251,12 @@ }, "exception":true }, + "Iso2CountryCode":{ + "type":"string", + "documentation":"The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. For example, GB or US.", + "max":2, + "pattern":"^[A-Za-z]{2}$" + }, "KMSAccessDeniedException":{ "type":"structure", "members":{ @@ -1159,6 +1335,25 @@ }, "exception":true }, + "LanguageCodeString":{ + "type":"string", + "documentation":"Supported language code for sending OTP message", + "enum":[ + "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" + ] + }, "ListEndpointsByPlatformApplicationInput":{ "type":"structure", "required":["PlatformApplicationArn"], @@ -1196,6 +1391,32 @@ "type":"list", "member":{"shape":"PlatformApplication"} }, + "ListOriginationNumbersRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"nextToken", + "documentation":"Token that the previous ListOriginationNumbers request returns.
The maximum number of origination numbers to return.
" + } + } + }, + "ListOriginationNumbersResult":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"nextToken", + "documentation":"A NextToken string is returned when you call the ListOriginationNumbers operation if additional pages of records are available.
A list of the calling account's verified and pending origination numbers.
" + } + } + }, "ListPhoneNumbersOptedOutInput":{ "type":"structure", "members":{ @@ -1244,6 +1465,33 @@ }, "documentation":"Response for ListPlatformApplications action.
" }, + "ListSMSSandboxPhoneNumbersInput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"nextToken", + "documentation":"Token that the previous ListSMSSandboxPhoneNumbersInput request returns.
The maximum number of phone numbers to return.
" + } + } + }, + "ListSMSSandboxPhoneNumbersResult":{ + "type":"structure", + "required":["PhoneNumbers"], + "members":{ + "PhoneNumbers":{ + "shape":"SMSSandboxPhoneNumberList", + "documentation":"A list of the calling account's pending and verified phone numbers.
" + }, + "NextToken":{ + "shape":"string", + "documentation":"A NextToken string is returned when you call the ListSMSSandboxPhoneNumbersInput operation if additional pages of records are available.
The response for the OptInPhoneNumber action.
" }, + "OptedOutException":{ + "type":"structure", + "members":{ + "message":{"shape":"string"} + }, + "documentation":"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.
", + "error":{ + "code":"OptedOut", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, "PhoneNumber":{"type":"string"}, + "PhoneNumberInformation":{ + "type":"structure", + "members":{ + "CreatedAt":{ + "shape":"Timestamp", + "documentation":"The date and time when the phone number was created.
" + }, + "PhoneNumber":{ + "shape":"String", + "documentation":"The phone number.
" + }, + "Status":{ + "shape":"String", + "documentation":"The status of the phone number.
" + }, + "Iso2CountryCode":{ + "shape":"Iso2CountryCode", + "documentation":"The two-character code for the country or region, in ISO 3166-1 alpha-2 format.
" + }, + "RouteType":{ + "shape":"RouteType", + "documentation":"The list of supported routes.
" + }, + "NumberCapabilities":{ + "shape":"NumberCapabilityList", + "documentation":"The capabilities of each phone number.
" + } + }, + "documentation":"A list of phone numbers and their metadata.
" + }, + "PhoneNumberInformationList":{ + "type":"list", + "member":{"shape":"PhoneNumberInformation"}, + "documentation":"List of customer owned phone numbers." + }, "PhoneNumberList":{ "type":"list", "member":{"shape":"PhoneNumber"} }, + "PhoneNumberString":{ + "type":"string", + "max":20, + "pattern":"^(\\+[0-9]{8,}|[0-9]{0,9})$" + }, "PlatformApplication":{ "type":"structure", "members":{ @@ -1523,7 +1855,7 @@ "members":{ "message":{"shape":"string"} }, - "documentation":"Can't tag resource. Verify that the topic exists.
", + "documentation":"Can’t perform the action on the specified resource. Make sure that the resource exists.
", "error":{ "code":"ResourceNotFound", "httpStatusCode":404, @@ -1531,6 +1863,41 @@ }, "exception":true }, + "RouteType":{ + "type":"string", + "documentation":"Enum listing out all supported route types. The following enum values are supported. 1. Transactional : Non-marketing traffic 2. Promotional : Marketing 3. Premium : Premium routes for OTP delivery to the carriers", + "enum":[ + "Transactional", + "Promotional", + "Premium" + ] + }, + "SMSSandboxPhoneNumber":{ + "type":"structure", + "members":{ + "PhoneNumber":{ + "shape":"PhoneNumberString", + "documentation":"The destination phone number.
" + }, + "Status":{ + "shape":"SMSSandboxPhoneNumberVerificationStatus", + "documentation":"The destination phone number's verification status.
" + } + }, + "documentation":"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 in the Amazon SNS Developer Guide.
" + }, + "SMSSandboxPhoneNumberList":{ + "type":"list", + "member":{"shape":"SMSSandboxPhoneNumber"} + }, + "SMSSandboxPhoneNumberVerificationStatus":{ + "type":"string", + "documentation":"Enum listing out all supported destination phone number verification statuses. The following enum values are supported. 1. PENDING : The destination phone number is pending verification. 2. VERIFIED : The destination phone number is verified.", + "enum":[ + "Pending", + "Verified" + ] + }, "SetEndpointAttributesInput":{ "type":"structure", "required":[ @@ -1619,7 +1986,7 @@ }, "AttributeName":{ "shape":"attributeName", - "documentation":"A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:
DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
DisplayName – The display name to use for a topic with SMS subscriptions.
Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
The following attribute applies only to server-side-encryption:
KmsMasterKeyId – The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.
The following attribute applies only to FIFO topics:
ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.
When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
(Optional) To override the generated value, you can specify a value for the the MessageDeduplicationId parameter for the Publish action.
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:
DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
DisplayName – The display name to use for a topic with SMS subscriptions.
Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
The following attribute applies only to server-side-encryption:
KmsMasterKeyId – The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.
The following attribute applies only to FIFO topics:
ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.
When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
(Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.
Indicates that a request parameter does not comply with the associated constraints.
", + "error":{ + "code":"UserError", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ValidationException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Indicates that a parameter in the request is invalid.
", + "error":{ + "code":"ValidationException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "VerificationException":{ + "type":"structure", + "required":[ + "Message", + "Status" + ], + "members":{ + "Message":{"shape":"string"}, + "Status":{ + "shape":"string", + "documentation":"The status of the verification error.
" + } + }, + "documentation":"Indicates that the one-time password (OTP) used for verification is invalid.
", + "exception":true + }, + "VerifySMSSandboxPhoneNumberInput":{ + "type":"structure", + "required":[ + "PhoneNumber", + "OneTimePassword" + ], + "members":{ + "PhoneNumber":{ + "shape":"PhoneNumberString", + "documentation":"The destination phone number to verify.
" + }, + "OneTimePassword":{ + "shape":"OTPCode", + "documentation":"The OTP sent to the destination number from the CreateSMSSandBoxPhoneNumber call.
The destination phone number's verification status.
" + }, "account":{"type":"string"}, "action":{"type":"string"}, "attributeName":{"type":"string"},