+Regional availability +
+The Amazon Pinpoint SMS and Voice, version 2 API Reference is +available in several Amazon Web Services Regions and it provides an endpoint for each of +these Regions. For a list of all the Regions and endpoints where the API is currently +available, see Amazon Web Services Service Endpoints and Amazon Pinpoint +endpoints and quotas in the Amazon Web Services General Reference. To +learn more about Amazon Web Services Regions, see Managing +Amazon Web Services Regions in the Amazon Web Services General +Reference.
+In each Region, Amazon Web Services maintains multiple Availability Zones. These +Availability Zones are physically isolated from each other, but are united by private, +low-latency, high-throughput, and highly redundant network connections. These +Availability Zones enable us to provide very high levels of availability and redundancy, +while also minimizing latency. To learn more about the number of Availability Zones that +are available in each Region, see Amazon Web Services +Global Infrastructure. +
## Installing @@ -257,6 +276,46 @@ CreatePool [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-pinpoint-sms-voice-v2/classes/createpoolcommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-pinpoint-sms-voice-v2/interfaces/createpoolcommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-pinpoint-sms-voice-v2/interfaces/createpoolcommandoutput.html) + +Welcome to the Amazon Pinpoint SMS and Voice, version 2 API Reference. * This guide provides information about Amazon Pinpoint SMS and Voice, version 2 API * resources, including supported HTTP methods, parameters, and schemas.
- *Amazon Pinpoint is an Amazon Web Services service that you can use to engage with + *
Amazon Pinpoint is an Amazon Web Services service that you can use to engage with * your recipients across multiple messaging channels. The Amazon Pinpoint SMS and * Voice, version 2 API provides programmatic access to options that are unique to the SMS * and voice channels and supplements the resources provided by the Amazon Pinpoint * API.
- *If you're new to Amazon Pinpoint, it's also helpful to review the
+ * If you're new to Amazon Pinpoint, it's also helpful to review the
* Amazon Pinpoint Developer Guide. The Amazon Pinpoint
* Developer Guide provides tutorials, code samples, and procedures that
* demonstrate how to use Amazon Pinpoint features programmatically and how to integrate
@@ -945,6 +1534,25 @@ export interface PinpointSMSVoiceV2 {
* The guide also provides key information, such as Amazon Pinpoint integration with
* other Amazon Web Services services, and the quotas that apply to use of the
* service.
+ * Regional availability
+ * The Amazon Pinpoint SMS and Voice, version 2 API Reference is
+ * available in several Amazon Web Services Regions and it provides an endpoint for each of
+ * these Regions. For a list of all the Regions and endpoints where the API is currently
+ * available, see Amazon Web Services Service Endpoints and Amazon Pinpoint
+ * endpoints and quotas in the Amazon Web Services General Reference. To
+ * learn more about Amazon Web Services Regions, see Managing
+ * Amazon Web Services Regions in the Amazon Web Services General
+ * Reference. In each Region, Amazon Web Services maintains multiple Availability Zones. These
+ * Availability Zones are physically isolated from each other, but are united by private,
+ * low-latency, high-throughput, and highly redundant network connections. These
+ * Availability Zones enable us to provide very high levels of availability and redundancy,
+ * while also minimizing latency. To learn more about the number of Availability Zones that
+ * are available in each Region, see Amazon Web Services
+ * Global Infrastructure.
+ * Welcome to the Amazon Pinpoint SMS and Voice, version 2 API Reference.
* This guide provides information about Amazon Pinpoint SMS and Voice, version 2 API
* resources, including supported HTTP methods, parameters, and schemas. Amazon Pinpoint is an Amazon Web Services service that you can use to engage with
+ * Amazon Pinpoint is an Amazon Web Services service that you can use to engage with
* your recipients across multiple messaging channels. The Amazon Pinpoint SMS and
* Voice, version 2 API provides programmatic access to options that are unique to the SMS
* and voice channels and supplements the resources provided by the Amazon Pinpoint
* API. If you're new to Amazon Pinpoint, it's also helpful to review the
+ * If you're new to Amazon Pinpoint, it's also helpful to review the
* Amazon Pinpoint Developer Guide. The Amazon Pinpoint
* Developer Guide provides tutorials, code samples, and procedures that
* demonstrate how to use Amazon Pinpoint features programmatically and how to integrate
@@ -460,6 +601,25 @@ export interface PinpointSMSVoiceV2ClientResolvedConfig extends PinpointSMSVoice
* The guide also provides key information, such as Amazon Pinpoint integration with
* other Amazon Web Services services, and the quotas that apply to use of the
* service.
+ * Regional availability
+ * The Amazon Pinpoint SMS and Voice, version 2 API Reference is
+ * available in several Amazon Web Services Regions and it provides an endpoint for each of
+ * these Regions. For a list of all the Regions and endpoints where the API is currently
+ * available, see Amazon Web Services Service Endpoints and Amazon Pinpoint
+ * endpoints and quotas in the Amazon Web Services General Reference. To
+ * learn more about Amazon Web Services Regions, see Managing
+ * Amazon Web Services Regions in the Amazon Web Services General
+ * Reference. In each Region, Amazon Web Services maintains multiple Availability Zones. These
+ * Availability Zones are physically isolated from each other, but are united by private,
+ * low-latency, high-throughput, and highly redundant network connections. These
+ * Availability Zones enable us to provide very high levels of availability and redundancy,
+ * while also minimizing latency. To learn more about the number of Availability Zones that
+ * are available in each Region, see Amazon Web Services
+ * Global Infrastructure.
+ * Associates the specified origination identity with a pool. If the origination identity is a phone number and is already associated with another
- * pool, an Error is returned. A sender ID can be associated with multiple pools. If the origination identity configuration doesn't match the pool's configuration, an
- * Error is returned. If the origination identity is a phone number and is already associated with another
+ * pool, an error is returned. A sender ID can be associated with multiple pools. If the origination identity configuration doesn't match the pool's configuration, an
+ * error is returned. Creates a new configuration set. After you create the configuration set, you can add
* one or more event destinations to it. A configuration set is a set of rules that you apply to the SMS and voice messages
+ * A configuration set is a set of rules that you apply to the SMS and voice messages
* that you send. When you send a message, you can optionally specify a single configuration set. When you send a message, you can optionally specify a single configuration set. Creates a new event destination in a configuration set. An event destination is a location where you send message events. The event options
+ * An event destination is a location where you send message events. The event options
* are Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS. For example,
* when a message is delivered successfully, you can send information about that event to
* an event destination, or send notifications to endpoints that are subscribed to an
* Amazon SNS topic. Each configuration set can contain between 0 and 5 event destinations. Each event
+ * Each configuration set can contain between 0 and 5 event destinations. Each event
* destination can contain a reference to a single destination, such as a CloudWatch
* or Kinesis Data Firehose destination. Creates a new opt-out list. If the opt-out list name already exists, an Error is returned. An opt-out list is a list of phone numbers that are opted out, meaning you can't send
+ * If the opt-out list name already exists, an error is returned. An opt-out list is a list of phone numbers that are opted out, meaning you can't send
* SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for
* the phone number is added to the opt-out list. In addition to STOP, your recipients can
* use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported
diff --git a/clients/client-pinpoint-sms-voice-v2/src/commands/CreatePoolCommand.ts b/clients/client-pinpoint-sms-voice-v2/src/commands/CreatePoolCommand.ts
index e0ca61f7cbe39..71e9e20d50cd3 100644
--- a/clients/client-pinpoint-sms-voice-v2/src/commands/CreatePoolCommand.ts
+++ b/clients/client-pinpoint-sms-voice-v2/src/commands/CreatePoolCommand.ts
@@ -44,12 +44,12 @@ export interface CreatePoolCommandOutput extends CreatePoolResult, __MetadataBea
* Creates a new pool and associates the specified origination identity to the pool. A
* pool can include one or more phone numbers and SenderIds that are associated with your
* Amazon Web Services account. The new pool inherits its configuration from the specified origination identity. This
+ * The new pool inherits its configuration from the specified origination identity. This
* includes keywords, message type, opt-out list, two-way configuration, and self-managed
* opt-out configuration. Deletion protection isn't inherited from the origination identity
* and defaults to false. If the origination identity is a phone number and is already associated with another
- * pool, an Error is returned. A sender ID can be associated with multiple pools. If the origination identity is a phone number and is already associated with another
+ * pool, an error is returned. A sender ID can be associated with multiple pools. Associate the registration with an origination identity such as a phone number or sender ID. The request was denied because you don't have sufficient permissions to access the
+ * resource. Your request has conflicting operations. This can occur if you're trying to perform
+ * more than one operation on the same resource at the same time or it could be that the
+ * requested action isn't valid for the current state or configuration of the
+ * resource. The API encountered an unexpected error and couldn't complete the request. You might
+ * be able to successfully issue the request again in the future. A requested resource couldn't be found. The request would cause a service quota to be exceeded. An error that occurred because too many requests were sent during a certain amount of
+ * time. A validation exception for a field. Base exception class for all service exceptions from PinpointSMSVoiceV2 service. Create a new registration attachment to use for uploading a file or a URL to a file. The maximum file size is 1MiB and valid file extensions are PDF, JPEG and PNG. For example, many sender ID registrations require a signed “letter of authorization” (LOA) to be submitted. The request was denied because you don't have sufficient permissions to access the
+ * resource. Your request has conflicting operations. This can occur if you're trying to perform
+ * more than one operation on the same resource at the same time or it could be that the
+ * requested action isn't valid for the current state or configuration of the
+ * resource. The API encountered an unexpected error and couldn't complete the request. You might
+ * be able to successfully issue the request again in the future. The request would cause a service quota to be exceeded. An error that occurred because too many requests were sent during a certain amount of
+ * time. A validation exception for a field. Base exception class for all service exceptions from PinpointSMSVoiceV2 service. Creates a new registration based on the RegistrationType field. The request was denied because you don't have sufficient permissions to access the
+ * resource. Your request has conflicting operations. This can occur if you're trying to perform
+ * more than one operation on the same resource at the same time or it could be that the
+ * requested action isn't valid for the current state or configuration of the
+ * resource. The API encountered an unexpected error and couldn't complete the request. You might
+ * be able to successfully issue the request again in the future. The request would cause a service quota to be exceeded. An error that occurred because too many requests were sent during a certain amount of
+ * time. A validation exception for a field. Base exception class for all service exceptions from PinpointSMSVoiceV2 service. Create a new version of the registration and increase the VersionNumber. The previous version of the registration becomes read-only. The request was denied because you don't have sufficient permissions to access the
+ * resource. Your request has conflicting operations. This can occur if you're trying to perform
+ * more than one operation on the same resource at the same time or it could be that the
+ * requested action isn't valid for the current state or configuration of the
+ * resource. The API encountered an unexpected error and couldn't complete the request. You might
+ * be able to successfully issue the request again in the future. A requested resource couldn't be found. The request would cause a service quota to be exceeded. An error that occurred because too many requests were sent during a certain amount of
+ * time. A validation exception for a field. Base exception class for all service exceptions from PinpointSMSVoiceV2 service. You can only send messages to verified destination numbers when your account is in the sandbox. You can add up to 10 verified destination
+ * numbers. The request was denied because you don't have sufficient permissions to access the
+ * resource. Your request has conflicting operations. This can occur if you're trying to perform
+ * more than one operation on the same resource at the same time or it could be that the
+ * requested action isn't valid for the current state or configuration of the
+ * resource. The API encountered an unexpected error and couldn't complete the request. You might
+ * be able to successfully issue the request again in the future. The request would cause a service quota to be exceeded. An error that occurred because too many requests were sent during a certain amount of
+ * time. A validation exception for a field. Base exception class for all service exceptions from PinpointSMSVoiceV2 service. Deletes an existing configuration set. A configuration set is a set of rules that you apply to voice and SMS messages that
+ * A configuration set is a set of rules that you apply to voice and SMS messages that
* you send. In a configuration set, you can specify a destination for specific types of
* events related to voice and SMS messages. Deletes an existing default message type on a configuration set. A message type is a type of messages that you plan to send. If you send
+ * A message type is a type of messages that you plan to send. If you send
* account-related messages or time-sensitive messages such as one-time passcodes, choose
* Transactional. If you plan to send messages that
* contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services
diff --git a/clients/client-pinpoint-sms-voice-v2/src/commands/DeleteDefaultSenderIdCommand.ts b/clients/client-pinpoint-sms-voice-v2/src/commands/DeleteDefaultSenderIdCommand.ts
index 181dd4e5a2bd7..f1c36f863b667 100644
--- a/clients/client-pinpoint-sms-voice-v2/src/commands/DeleteDefaultSenderIdCommand.ts
+++ b/clients/client-pinpoint-sms-voice-v2/src/commands/DeleteDefaultSenderIdCommand.ts
@@ -42,7 +42,7 @@ export interface DeleteDefaultSenderIdCommandOutput extends DeleteDefaultSenderI
/**
* @public
* Deletes an existing default sender ID on a configuration set. A default sender ID is the identity that appears on recipients' devices when they
+ * A default sender ID is the identity that appears on recipients' devices when they
* receive SMS messages. Support for sender ID capabilities varies by country or
* region. Deletes an existing event destination. An event destination is a location where you send response information about the
+ * An event destination is a location where you send response information about the
* messages that you send. For example, when a message is delivered successfully, you can
* send information about that event to an Amazon CloudWatch destination, or send
* notifications to endpoints that are subscribed to an Amazon SNS topic. Deletes an existing keyword from an origination phone number or pool. A keyword is a word that you can search for on a particular phone number or pool. It
+ * A keyword is a word that you can search for on a particular phone number or pool. It
* is also a specific word or phrase that an end user can send to your number to elicit a
* response, such as an informational message or a special offer. When your number receives
* a message that begins with a keyword, Amazon Pinpoint responds with a customizable
* message. Keywords "HELP" and "STOP" can't be deleted or modified. Keywords "HELP" and "STOP" can't be deleted or modified. Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are
* deleted. If the specified opt-out list name doesn't exist or is in-use by an origination phone
- * number or pool, an Error is returned. If the specified opt-out list name doesn't exist or is in-use by an origination phone
+ * number or pool, an error is returned. Deletes an existing opted out destination phone number from the specified opt-out
* list. Each destination phone number can only be deleted once every 30 days. If the specified destination phone number doesn't exist or if the opt-out list doesn't
- * exist, an Error is returned. Each destination phone number can only be deleted once every 30 days. If the specified destination phone number doesn't exist or if the opt-out list doesn't
+ * exist, an error is returned. Deletes an existing pool. Deleting a pool disassociates all origination identities
* from that pool. If the pool status isn't active or if deletion protection is enabled, an Error is
+ * If the pool status isn't active or if deletion protection is enabled, an error is
* returned. A pool is a collection of phone numbers and SenderIds. A pool can include one or more
+ * A pool is a collection of phone numbers and SenderIds. A pool can include one or more
* phone numbers and SenderIds that are associated with your Amazon Web Services
* account. Permanently delete the specified registration attachment. The request was denied because you don't have sufficient permissions to access the
+ * resource. Your request has conflicting operations. This can occur if you're trying to perform
+ * more than one operation on the same resource at the same time or it could be that the
+ * requested action isn't valid for the current state or configuration of the
+ * resource. The API encountered an unexpected error and couldn't complete the request. You might
+ * be able to successfully issue the request again in the future. A requested resource couldn't be found. An error that occurred because too many requests were sent during a certain amount of
+ * time. A validation exception for a field. Base exception class for all service exceptions from PinpointSMSVoiceV2 service. Permanently delete an existing registration from your account. The request was denied because you don't have sufficient permissions to access the
+ * resource. Your request has conflicting operations. This can occur if you're trying to perform
+ * more than one operation on the same resource at the same time or it could be that the
+ * requested action isn't valid for the current state or configuration of the
+ * resource. The API encountered an unexpected error and couldn't complete the request. You might
+ * be able to successfully issue the request again in the future. A requested resource couldn't be found. An error that occurred because too many requests were sent during a certain amount of
+ * time. A validation exception for a field. Base exception class for all service exceptions from PinpointSMSVoiceV2 service. Delete the value in a registration form field. The request was denied because you don't have sufficient permissions to access the
+ * resource. Your request has conflicting operations. This can occur if you're trying to perform
+ * more than one operation on the same resource at the same time or it could be that the
+ * requested action isn't valid for the current state or configuration of the
+ * resource. The API encountered an unexpected error and couldn't complete the request. You might
+ * be able to successfully issue the request again in the future. A requested resource couldn't be found. An error that occurred because too many requests were sent during a certain amount of
+ * time. A validation exception for a field. Base exception class for all service exceptions from PinpointSMSVoiceV2 service. Delete a verified destination phone number. The request was denied because you don't have sufficient permissions to access the
+ * resource. Your request has conflicting operations. This can occur if you're trying to perform
+ * more than one operation on the same resource at the same time or it could be that the
+ * requested action isn't valid for the current state or configuration of the
+ * resource. The API encountered an unexpected error and couldn't complete the request. You might
+ * be able to successfully issue the request again in the future. A requested resource couldn't be found. An error that occurred because too many requests were sent during a certain amount of
+ * time. A validation exception for a field. Base exception class for all service exceptions from PinpointSMSVoiceV2 service. New Amazon Pinpoint accounts are placed into an SMS or voice sandbox. The sandbox
+ * New Amazon Pinpoint accounts are placed into an SMS or voice sandbox. The sandbox
* protects both Amazon Web Services end recipients and SMS or voice recipients from fraud
* and abuse. Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your
* account. The description for a quota includes the quota name, current usage toward that
* quota, and the quota's maximum value. When you establish an Amazon Web Services account, the account has initial quotas on
+ * When you establish an Amazon Web Services account, the account has initial quotas on
* the maximum number of configuration sets, opt-out lists, phone numbers, and pools that
* you can create in a given Region. For more information see
* Amazon Pinpoint quotas in the Amazon Pinpoint Developer
diff --git a/clients/client-pinpoint-sms-voice-v2/src/commands/DescribeConfigurationSetsCommand.ts b/clients/client-pinpoint-sms-voice-v2/src/commands/DescribeConfigurationSetsCommand.ts
index 6bdbd87d6df67..483dfb3b5ec2d 100644
--- a/clients/client-pinpoint-sms-voice-v2/src/commands/DescribeConfigurationSetsCommand.ts
+++ b/clients/client-pinpoint-sms-voice-v2/src/commands/DescribeConfigurationSetsCommand.ts
@@ -42,12 +42,12 @@ export interface DescribeConfigurationSetsCommandOutput extends DescribeConfigur
/**
* @public
* Describes the specified configuration sets or all in your account. If you specify configuration set names, the output includes information for only the
+ * If you specify configuration set names, the output includes information for only the
* specified configuration sets. If you specify filters, the output includes information
* for only those configuration sets that meet the filter criteria. If you don't specify
* configuration set names or filters, the output includes information for all
* configuration sets. If you specify a configuration set name that isn't valid, an error is returned. If you specify a configuration set name that isn't valid, an error is returned. Describes the specified keywords or all keywords on your origination phone number or
* pool. A keyword is a word that you can search for on a particular phone number or pool. It
+ * A keyword is a word that you can search for on a particular phone number or pool. It
* is also a specific word or phrase that an end user can send to your number to elicit a
* response, such as an informational message or a special offer. When your number receives
* a message that begins with a keyword, Amazon Pinpoint responds with a customizable
* message. If you specify a keyword that isn't valid, an Error is returned. If you specify a keyword that isn't valid, an error is returned. Describes the specified opt-out list or all opt-out lists in your account. If you specify opt-out list names, the output includes information for only the
+ * If you specify opt-out list names, the output includes information for only the
* specified opt-out lists. Opt-out lists include only those that meet the filter criteria.
* If you don't specify opt-out list names or filters, the output includes information for
* all opt-out lists. If you specify an opt-out list name that isn't valid, an Error is returned. If you specify an opt-out list name that isn't valid, an error is returned. Describes the specified opted out destination numbers or all opted out destination
* numbers in an opt-out list. If you specify opted out numbers, the output includes information for only the
+ * If you specify opted out numbers, the output includes information for only the
* specified opted out numbers. If you specify filters, the output includes information for
* only those opted out numbers that meet the filter criteria. If you don't specify opted
* out numbers or filters, the output includes information for all opted out destination
* numbers in your opt-out list. If you specify an opted out number that isn't valid, an Error is returned. If you specify an opted out number that isn't valid, an error is returned. Describes the specified origination phone number, or all the phone numbers in your
* account. If you specify phone number IDs, the output includes information for only the
+ * If you specify phone number IDs, the output includes information for only the
* specified phone numbers. If you specify filters, the output includes information for
* only those phone numbers that meet the filter criteria. If you don't specify phone
* number IDs or filters, the output includes information for all phone numbers. If you specify a phone number ID that isn't valid, an Error is returned. If you specify a phone number ID that isn't valid, an error is returned. Retrieves the specified pools or all pools associated with your Amazon Web Services
* account. If you specify pool IDs, the output includes information for only the specified pools.
+ * If you specify pool IDs, the output includes information for only the specified pools.
* If you specify filters, the output includes information for only those pools that meet
* the filter criteria. If you don't specify pool IDs or filters, the output includes
* information for all pools. If you specify a pool ID that isn't valid, an Error is returned. A pool is a collection of phone numbers and SenderIds. A pool can include one or more
+ * If you specify a pool ID that isn't valid, an error is returned. A pool is a collection of phone numbers and SenderIds. A pool can include one or more
* phone numbers and SenderIds that are associated with your Amazon Web Services
* account. Retrieves the specified registration attachments or all registration attachments associated with your Amazon Web Services account. The request was denied because you don't have sufficient permissions to access the
+ * resource. The API encountered an unexpected error and couldn't complete the request. You might
+ * be able to successfully issue the request again in the future. A requested resource couldn't be found. An error that occurred because too many requests were sent during a certain amount of
+ * time. A validation exception for a field. Base exception class for all service exceptions from PinpointSMSVoiceV2 service. Retrieves the specified registration type field definitions. You can use DescribeRegistrationFieldDefinitions to view the requirements for creating, filling out, and submitting each registration type. The request was denied because you don't have sufficient permissions to access the
+ * resource. The API encountered an unexpected error and couldn't complete the request. You might
+ * be able to successfully issue the request again in the future. An error that occurred because too many requests were sent during a certain amount of
+ * time. A validation exception for a field. Base exception class for all service exceptions from PinpointSMSVoiceV2 service. Retrieves the specified registration field values. The request was denied because you don't have sufficient permissions to access the
+ * resource. The API encountered an unexpected error and couldn't complete the request. You might
+ * be able to successfully issue the request again in the future. A requested resource couldn't be found. An error that occurred because too many requests were sent during a certain amount of
+ * time. A validation exception for a field. Base exception class for all service exceptions from PinpointSMSVoiceV2 service. Retrieves the specified registration section definitions. You can use DescribeRegistrationSectionDefinitions to view the requirements for creating, filling out, and submitting each registration type. The request was denied because you don't have sufficient permissions to access the
+ * resource. The API encountered an unexpected error and couldn't complete the request. You might
+ * be able to successfully issue the request again in the future. An error that occurred because too many requests were sent during a certain amount of
+ * time. A validation exception for a field. Base exception class for all service exceptions from PinpointSMSVoiceV2 service. Retrieves the specified registration type definitions. You can use DescribeRegistrationTypeDefinitions to view the requirements for creating, filling out, and submitting each registration type. The request was denied because you don't have sufficient permissions to access the
+ * resource. The API encountered an unexpected error and couldn't complete the request. You might
+ * be able to successfully issue the request again in the future. An error that occurred because too many requests were sent during a certain amount of
+ * time. A validation exception for a field. Base exception class for all service exceptions from PinpointSMSVoiceV2 service. Retrieves the specified registration version. The request was denied because you don't have sufficient permissions to access the
+ * resource. The API encountered an unexpected error and couldn't complete the request. You might
+ * be able to successfully issue the request again in the future. A requested resource couldn't be found. An error that occurred because too many requests were sent during a certain amount of
+ * time. A validation exception for a field. Base exception class for all service exceptions from PinpointSMSVoiceV2 service. Retrieves the specified registrations. The request was denied because you don't have sufficient permissions to access the
+ * resource. The API encountered an unexpected error and couldn't complete the request. You might
+ * be able to successfully issue the request again in the future. A requested resource couldn't be found. An error that occurred because too many requests were sent during a certain amount of
+ * time. A validation exception for a field. Base exception class for all service exceptions from PinpointSMSVoiceV2 service. Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account. If you specify SenderIds, the output includes information for only the specified
+ * If you specify SenderIds, the output includes information for only the specified
* SenderIds. If you specify filters, the output includes information for only those
* SenderIds that meet the filter criteria. If you don't specify SenderIds or filters, the
* output includes information for all SenderIds. f you specify a sender ID that isn't valid, an Error is returned. f you specify a sender ID that isn't valid, an error is returned. Describes the current Amazon Pinpoint monthly spend limits for sending voice and
* text messages. When you establish an Amazon Web Services account, the account has initial monthly
+ * When you establish an Amazon Web Services account, the account has initial monthly
* spend limit in a given Region. For more information on increasing your monthly spend
* limit, see
* Requesting increases to your monthly SMS spending quota for Amazon Pinpoint
diff --git a/clients/client-pinpoint-sms-voice-v2/src/commands/DescribeVerifiedDestinationNumbersCommand.ts b/clients/client-pinpoint-sms-voice-v2/src/commands/DescribeVerifiedDestinationNumbersCommand.ts
new file mode 100644
index 0000000000000..47c8db13bbd9d
--- /dev/null
+++ b/clients/client-pinpoint-sms-voice-v2/src/commands/DescribeVerifiedDestinationNumbersCommand.ts
@@ -0,0 +1,199 @@
+// smithy-typescript generated code
+import { EndpointParameterInstructions, getEndpointPlugin } from "@smithy/middleware-endpoint";
+import { getSerdePlugin } from "@smithy/middleware-serde";
+import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
+import { Command as $Command } from "@smithy/smithy-client";
+import {
+ FinalizeHandlerArguments,
+ Handler,
+ HandlerExecutionContext,
+ HttpHandlerOptions as __HttpHandlerOptions,
+ MetadataBearer as __MetadataBearer,
+ MiddlewareStack,
+ SerdeContext as __SerdeContext,
+ SMITHY_CONTEXT_KEY,
+} from "@smithy/types";
+
+import {
+ DescribeVerifiedDestinationNumbersRequest,
+ DescribeVerifiedDestinationNumbersResult,
+} from "../models/models_0";
+import {
+ PinpointSMSVoiceV2ClientResolvedConfig,
+ ServiceInputTypes,
+ ServiceOutputTypes,
+} from "../PinpointSMSVoiceV2Client";
+import {
+ de_DescribeVerifiedDestinationNumbersCommand,
+ se_DescribeVerifiedDestinationNumbersCommand,
+} from "../protocols/Aws_json1_0";
+
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link DescribeVerifiedDestinationNumbersCommand}.
+ */
+export interface DescribeVerifiedDestinationNumbersCommandInput extends DescribeVerifiedDestinationNumbersRequest {}
+/**
+ * @public
+ *
+ * The output of {@link DescribeVerifiedDestinationNumbersCommand}.
+ */
+export interface DescribeVerifiedDestinationNumbersCommandOutput
+ extends DescribeVerifiedDestinationNumbersResult,
+ __MetadataBearer {}
+
+/**
+ * @public
+ * Retrieves the specified verified destiona numbers. The request was denied because you don't have sufficient permissions to access the
+ * resource. The API encountered an unexpected error and couldn't complete the request. You might
+ * be able to successfully issue the request again in the future. A requested resource couldn't be found. An error that occurred because too many requests were sent during a certain amount of
+ * time. A validation exception for a field. Base exception class for all service exceptions from PinpointSMSVoiceV2 service. Removes the specified origination identity from an existing pool. If the origination identity isn't associated with the specified pool, an Error is
+ * If the origination identity isn't associated with the specified pool, an error is
* returned. Discard the current version of the registration. The request was denied because you don't have sufficient permissions to access the
+ * resource. Your request has conflicting operations. This can occur if you're trying to perform
+ * more than one operation on the same resource at the same time or it could be that the
+ * requested action isn't valid for the current state or configuration of the
+ * resource. The API encountered an unexpected error and couldn't complete the request. You might
+ * be able to successfully issue the request again in the future. A requested resource couldn't be found. An error that occurred because too many requests were sent during a certain amount of
+ * time. A validation exception for a field. Base exception class for all service exceptions from PinpointSMSVoiceV2 service. Lists all associated origination identities in your pool. If you specify filters, the output includes information for only those origination
+ * If you specify filters, the output includes information for only those origination
* identities that meet the filter criteria. Retreive all of the origination identies that are associated with a registration. The request was denied because you don't have sufficient permissions to access the
+ * resource. The API encountered an unexpected error and couldn't complete the request. You might
+ * be able to successfully issue the request again in the future. A requested resource couldn't be found. An error that occurred because too many requests were sent during a certain amount of
+ * time. A validation exception for a field. Base exception class for all service exceptions from PinpointSMSVoiceV2 service. Creates or updates a keyword configuration on an origination phone number or
* pool. A keyword is a word that you can search for on a particular phone number or pool. It
+ * A keyword is a word that you can search for on a particular phone number or pool. It
* is also a specific word or phrase that an end user can send to your number to elicit a
* response, such as an informational message or a special offer. When your number receives
* a message that begins with a keyword, Amazon Pinpoint responds with a customizable
* message. If you specify a keyword that isn't valid, an Error is returned. If you specify a keyword that isn't valid, an error is returned. Creates an opted out destination phone number in the opt-out list. If the destination phone number isn't valid or if the specified opt-out list doesn't
- * exist, an Error is returned. If the destination phone number isn't valid or if the specified opt-out list doesn't
+ * exist, an error is returned. Creates or updates a field value for a registration. The request was denied because you don't have sufficient permissions to access the
+ * resource. Your request has conflicting operations. This can occur if you're trying to perform
+ * more than one operation on the same resource at the same time or it could be that the
+ * requested action isn't valid for the current state or configuration of the
+ * resource. The API encountered an unexpected error and couldn't complete the request. You might
+ * be able to successfully issue the request again in the future. A requested resource couldn't be found. An error that occurred because too many requests were sent during a certain amount of
+ * time. A validation exception for a field. Base exception class for all service exceptions from PinpointSMSVoiceV2 service. Releases an existing origination phone number in your account. Once released, a phone
* number is no longer available for sending messages. If the origination phone number has deletion protection enabled or is associated with
- * a pool, an Error is returned. If the origination phone number has deletion protection enabled or is associated with
+ * a pool, an error is returned. Releases an existing sender ID in your account. The request was denied because you don't have sufficient permissions to access the
+ * resource. Your request has conflicting operations. This can occur if you're trying to perform
+ * more than one operation on the same resource at the same time or it could be that the
+ * requested action isn't valid for the current state or configuration of the
+ * resource. The API encountered an unexpected error and couldn't complete the request. You might
+ * be able to successfully issue the request again in the future. A requested resource couldn't be found. An error that occurred because too many requests were sent during a certain amount of
+ * time. A validation exception for a field. Base exception class for all service exceptions from PinpointSMSVoiceV2 service. Request a new sender ID that doesn't require registration. The request was denied because you don't have sufficient permissions to access the
+ * resource. Your request has conflicting operations. This can occur if you're trying to perform
+ * more than one operation on the same resource at the same time or it could be that the
+ * requested action isn't valid for the current state or configuration of the
+ * resource. The API encountered an unexpected error and couldn't complete the request. You might
+ * be able to successfully issue the request again in the future. The request would cause a service quota to be exceeded. An error that occurred because too many requests were sent during a certain amount of
+ * time. A validation exception for a field. Base exception class for all service exceptions from PinpointSMSVoiceV2 service. Before you can send test messages to a verified destination phone number you need to
+ * opt-in the verified destination phone number. Creates a new text message with a
+ * verification code and send it to a verified destination phone number. Once you have the verification code use VerifyDestinationNumber to opt-in the verified destination phone number to receive messages. The request was denied because you don't have sufficient permissions to access the
+ * resource. Your request has conflicting operations. This can occur if you're trying to perform
+ * more than one operation on the same resource at the same time or it could be that the
+ * requested action isn't valid for the current state or configuration of the
+ * resource. The API encountered an unexpected error and couldn't complete the request. You might
+ * be able to successfully issue the request again in the future. A requested resource couldn't be found. The request would cause a service quota to be exceeded. An error that occurred because too many requests were sent during a certain amount of
+ * time. A validation exception for a field. Base exception class for all service exceptions from PinpointSMSVoiceV2 service. Creates a new text message and sends it to a recipient's phone number. SMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit
+ * SMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit
* depends on the destination country of your messages, as well as the type of phone number
* (origination number) that you use to send the message. For more information, see Message Parts per
* Second (MPS) limits in the Amazon Pinpoint User
diff --git a/clients/client-pinpoint-sms-voice-v2/src/commands/SendVoiceMessageCommand.ts b/clients/client-pinpoint-sms-voice-v2/src/commands/SendVoiceMessageCommand.ts
index 0322a5ddd9a41..d77db53c99dbd 100644
--- a/clients/client-pinpoint-sms-voice-v2/src/commands/SendVoiceMessageCommand.ts
+++ b/clients/client-pinpoint-sms-voice-v2/src/commands/SendVoiceMessageCommand.ts
@@ -41,7 +41,7 @@ export interface SendVoiceMessageCommandOutput extends SendVoiceMessageResult, _
/**
* @public
- * Allows you to send a request that sends a text message through Amazon Pinpoint.
+ * Allows you to send a request that sends a voice message through Amazon Pinpoint.
* This operation uses Amazon Polly to
* convert a text script into a voice message. Sets the default message type on a configuration set. Choose the category of SMS messages that you plan to send from this account. If you
+ * Choose the category of SMS messages that you plan to send from this account. If you
* send account-related messages or time-sensitive messages such as one-time passcodes,
* choose Transactional. If you plan to send messages that
* contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services
diff --git a/clients/client-pinpoint-sms-voice-v2/src/commands/SetDefaultSenderIdCommand.ts b/clients/client-pinpoint-sms-voice-v2/src/commands/SetDefaultSenderIdCommand.ts
index dc46ee2598761..ffab3e4846a06 100644
--- a/clients/client-pinpoint-sms-voice-v2/src/commands/SetDefaultSenderIdCommand.ts
+++ b/clients/client-pinpoint-sms-voice-v2/src/commands/SetDefaultSenderIdCommand.ts
@@ -42,7 +42,7 @@ export interface SetDefaultSenderIdCommandOutput extends SetDefaultSenderIdResul
/**
* @public
* Sets default sender ID on a configuration set. When sending a text message to a destination country that supports sender IDs, the
+ * When sending a text message to a destination country that supports sender IDs, the
* default sender ID on the configuration set specified will be used if no dedicated
* origination phone numbers or registered sender IDs are available in your account. Submit the specified registration for review and approval. The request was denied because you don't have sufficient permissions to access the
+ * resource. Your request has conflicting operations. This can occur if you're trying to perform
+ * more than one operation on the same resource at the same time or it could be that the
+ * requested action isn't valid for the current state or configuration of the
+ * resource. The API encountered an unexpected error and couldn't complete the request. You might
+ * be able to successfully issue the request again in the future. A requested resource couldn't be found. An error that occurred because too many requests were sent during a certain amount of
+ * time. A validation exception for a field. Base exception class for all service exceptions from PinpointSMSVoiceV2 service. Updates an existing event destination in a configuration set. You can update the
* IAM role ARN for CloudWatch Logs and Kinesis Data Firehose. You can
* also enable or disable the event destination. You may want to update an event destination to change its matching event types or
+ * You may want to update an event destination to change its matching event types or
* updating the destination resource ARN. You can't change an event destination's type
* between CloudWatch Logs, Kinesis Data Firehose, and Amazon SNS. Updates the configuration of an existing origination phone number. You can update the
* opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable
* or disable self-managed opt-outs, and enable or disable deletion protection. If the origination phone number is associated with a pool, an Error is
+ * If the origination phone number is associated with a pool, an error is
* returned. Updates the configuration of an existing sender ID. The request was denied because you don't have sufficient permissions to access the
+ * resource. The API encountered an unexpected error and couldn't complete the request. You might
+ * be able to successfully issue the request again in the future. A requested resource couldn't be found. An error that occurred because too many requests were sent during a certain amount of
+ * time. A validation exception for a field. Base exception class for all service exceptions from PinpointSMSVoiceV2 service. Use the verification code that was received by the verified destination phone number to opt-in the verified destination phone number to receive more messages. The request was denied because you don't have sufficient permissions to access the
+ * resource. Your request has conflicting operations. This can occur if you're trying to perform
+ * more than one operation on the same resource at the same time or it could be that the
+ * requested action isn't valid for the current state or configuration of the
+ * resource. The API encountered an unexpected error and couldn't complete the request. You might
+ * be able to successfully issue the request again in the future. A requested resource couldn't be found. An error that occurred because too many requests were sent during a certain amount of
+ * time. A validation exception for a field. Base exception class for all service exceptions from PinpointSMSVoiceV2 service. Welcome to the Amazon Pinpoint SMS and Voice, version 2 API Reference.
* This guide provides information about Amazon Pinpoint SMS and Voice, version 2 API
* resources, including supported HTTP methods, parameters, and schemas. Amazon Pinpoint is an Amazon Web Services service that you can use to engage with
+ * Amazon Pinpoint is an Amazon Web Services service that you can use to engage with
* your recipients across multiple messaging channels. The Amazon Pinpoint SMS and
* Voice, version 2 API provides programmatic access to options that are unique to the SMS
* and voice channels and supplements the resources provided by the Amazon Pinpoint
* API. If you're new to Amazon Pinpoint, it's also helpful to review the
+ * If you're new to Amazon Pinpoint, it's also helpful to review the
* Amazon Pinpoint Developer Guide. The Amazon Pinpoint
* Developer Guide provides tutorials, code samples, and procedures that
* demonstrate how to use Amazon Pinpoint features programmatically and how to integrate
@@ -17,6 +17,25 @@
* The guide also provides key information, such as Amazon Pinpoint integration with
* other Amazon Web Services services, and the quotas that apply to use of the
* service.
+ * Regional availability
+ * The Amazon Pinpoint SMS and Voice, version 2 API Reference is
+ * available in several Amazon Web Services Regions and it provides an endpoint for each of
+ * these Regions. For a list of all the Regions and endpoints where the API is currently
+ * available, see Amazon Web Services Service Endpoints and Amazon Pinpoint
+ * endpoints and quotas in the Amazon Web Services General Reference. To
+ * learn more about Amazon Web Services Regions, see Managing
+ * Amazon Web Services Regions in the Amazon Web Services General
+ * Reference. In each Region, Amazon Web Services maintains multiple Availability Zones. These
+ * Availability Zones are physically isolated from each other, but are united by private,
+ * low-latency, high-throughput, and highly redundant network connections. These
+ * Availability Zones enable us to provide very high levels of availability and redundancy,
+ * while also minimizing latency. To learn more about the number of Availability Zones that
+ * are available in each Region, see Amazon Web Services
+ * Global Infrastructure.
+ * Contains the destination configuration to use when publishing message sending events.
@@ -596,7 +666,7 @@ export type MessageType = (typeof MessageType)[keyof typeof MessageType];
* @public
* Contains the delivery stream Amazon Resource Name (ARN), and the ARN of the Identity and Access Management (IAM) role associated with an Kinesis Data Firehose event
* destination. Event destinations, such as Kinesis Data Firehose, are associated with configuration
+ * Event destinations, such as Kinesis Data Firehose, are associated with configuration
* sets, which enable you to publish message sending events. Contains information about an event destination. Event destinations are associated with configuration sets, which enable you to publish
- * message sending events to
- * Amazon
- * CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS. Event destinations are associated with configuration sets, which enable you to publish
+ * message sending events to CloudWatch, Kinesis Data Firehose,or Amazon SNS. An array of event types that determine which events to log. The An array of event types that determine which events to log. If "ALL" is used, then
* Amazon Pinpoint logs every event type. The The current status of the pool. CREATING: The pool is currently being created and isn't yet available for
+ * CREATING: The pool is currently being created and isn't yet available for
* use. ACTIVE: The pool is active and available for use. ACTIVE: The pool is active and available for use. DELETING: The pool is being deleted. DELETING: The pool is being deleted. An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages. By default this is set to false. When an end recipient sends a message that begins
@@ -1126,869 +1206,1064 @@ export interface CreatePoolResult {
/**
* @public
*/
-export interface DeleteConfigurationSetRequest {
+export interface CreateRegistrationRequest {
/**
* @public
- * The name of the configuration set or the configuration set ARN that you want to
- * delete. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action. The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions
+ * action. An array of tags (key and value pairs) to associate with the registration. Unique, case-sensitive identifier that you provide to ensure the idempotency of the
+ * request. If you don't specify a client token, a randomly generated token is used for the
+ * request to ensure idempotency. The Amazon Resource Name (ARN) of the deleted configuration set. The Amazon Resource Name (ARN) for the registration. The name of the deleted configuration set. The unique identifier for the registration. An array of any EventDestination objects that were associated with the deleted
- * configuration set. The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions
+ * action. The default message type of the configuration set that was deleted. The status of the registration.
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ * The default Sender ID of the configuration set that was deleted. The current version number of the registration. The time that the deleted configuration set was created in UNIX epoch time format. Metadata about a given registration which is specific to that registration type. An array of tags (key and value pairs) to associate with the registration. The time when the registration was created, in UNIX epoch time format. The name of the configuration set or the configuration set Amazon Resource Name (ARN)
- * to delete the default message type from. The ConfigurationSetName and
- * ConfigurationSetArn can be found using the DescribeConfigurationSets
- * action. The unique identifier for the registration. The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId. The Amazon Resource Name (ARN) of the configuration set. The Amazon Resource Name (ARN) for the registration. The name of the configuration set. The unique identifier for the registration. The current message type for the configuration set. The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions
+ * action. The name of the configuration set or the configuration set Amazon Resource Name (ARN)
- * to delete the default sender ID from. The ConfigurationSetName and ConfigurationSetArn
- * can be found using the DescribeConfigurationSets action. The Amazon Resource Name (ARN) of the origination identity that is associated with the registration. The Amazon Resource Name (ARN) of the configuration set. The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId. The name of the configuration set. The registration type or origination identity type. The current sender ID for the configuration set. The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. The phone number associated with the registration in E.164 format. The name of the configuration set or the configuration set's Amazon Resource Name
- * (ARN) to remove the event destination from. The ConfigurateSetName and
- * ConfigurationSetArn can be found using the DescribeConfigurationSets
- * action. The registration file to upload. The maximum file size is 1MiB and valid file extensions are PDF, JPEG and PNG. The name of the event destination to delete. A URL to the required registration file. For example, you can provide the S3 object URL. An array of tags (key and value pairs) to associate with the registration attachment. Unique, case-sensitive identifier that you provide to ensure the idempotency of the
+ * request. If you don't specify a client token, a randomly generated token is used for the
+ * request to ensure idempotency. The Amazon Resource Name (ARN) of the configuration set. The Amazon Resource Name (ARN) for the registration attachment. The name of the configuration set the event destination was deleted from. The unique identifier for the registration attachment. The event destination object that was deleted. The status of the registration attachment.
+ *
+ *
+ *
+ * The origination identity to use such as a PhoneNumberId, PhoneNumberArn, PoolId or
- * PoolArn. You can use DescribePhoneNumbers to find the values for
- * PhoneNumberId and PhoneNumberArn and DescribePools to find the values
- * of PoolId and PoolArn. An array of tags (key and value pairs) to associate with the registration attachment. The keyword to delete. The time when the registration attachment was created, in UNIX epoch time format. The unique identifier for the registration. The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes. The PhoneNumberArn or PoolArn that the keyword was associated with. The time when the registration was in the draft state, in UNIX epoch time format. The PhoneNumberId or PoolId that the keyword was associated with. The time when the registration was in the submitted state, in UNIX epoch time format. The keyword that was deleted. The time when the registration was in the reviewing state, in UNIX epoch time format. The message that was associated with the deleted keyword. The time when the registration was in the approved state, in UNIX epoch time format. The action that was associated with the deleted keyword. The time when the registration was in the discarded state, in UNIX epoch time format. The OptOutListName or OptOutListArn to remove the phone number from. The time when the registration was in the denied state, in UNIX epoch time format. The phone number, in E.164 format, to remove from the OptOutList. The time when the registration was in the revoked state, in UNIX epoch time format. The time when the registration was in the archived state, in UNIX epoch time format. The OptOutListArn that the phone number was removed from. The Amazon Resource Name (ARN) for the registration. The OptOutListName that the phone number was removed from. The unique identifier for the registration. The phone number that was removed from the OptOutList. The new version number of the registration. The time that the number was removed at, in UNIX epoch time format. The status of the registration.
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ * This is true if it was the end user who requested their phone number be removed.
- * The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and
- * OptOutListArn. A RegistrationVersionStatusHistory object that contains timestamps for the registration. The Amazon Resource Name (ARN) of the OptOutList that was removed. The verified destination phone number, in E.164 format. The name of the OptOutList that was removed. An array of tags (key and value pairs) to associate with the destination number. The time when the OptOutList was created, in UNIX epoch time format. Unique, case-sensitive identifier that you provide to ensure the idempotency of the
+ * request. If you don't specify a client token, a randomly generated token is used for the
+ * request to ensure idempotency. The PoolId or PoolArn of the pool to delete. You can use DescribePools to find the values for PoolId and PoolArn . The Amazon Resource Name (ARN) of the pool that was deleted. The Amazon Resource Name (ARN) for the verified destination phone number. The PoolId of the pool that was deleted. The unique identifier for the verified destination phone number. The current status of the pool. CREATING: The pool is currently being created and isn't yet available for
- * use. The verified destination phone number, in E.164 format. The status of the verified destination phone number. ACTIVE: The pool is active and available for use.
+ * DELETING: The pool is being deleted.
+ * The message type that was associated with the deleted pool. An array of tags (key and value pairs) to associate with the destination number. By default this is set to false. When set to true you can receive incoming text
- * messages from your end recipients. The time when the verified phone number was created, in UNIX epoch time format. The Amazon Resource Name (ARN) of the TwoWayChannel. The name of the configuration set or the configuration set ARN that you want to
+ * delete. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action. By default this is set to false. When an end recipient sends a message that begins
- * with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically
- * replies with a customizable message and adds the end recipient to the OptOutList. When
- * set to true you're responsible for responding to HELP and STOP requests. You're also
- * responsible for tracking and honoring opt-out requests. The Amazon Resource Name (ARN) of the deleted configuration set. The name of the OptOutList that was associated with the deleted pool. The name of the deleted configuration set. Indicates whether shared routes are enabled for the pool. An array of any EventDestination objects that were associated with the deleted
+ * configuration set. The time when the pool was created, in UNIX epoch time format. The default message type of the configuration set that was deleted. The default Sender ID of the configuration set that was deleted. The current monthly limit, in US dollars. The time that the deleted configuration set was created in UNIX epoch time format. The current monthly limit, in US dollars. The name of the configuration set or the configuration set Amazon Resource Name (ARN)
+ * to delete the default message type from. The ConfigurationSetName and
+ * ConfigurationSetArn can be found using the DescribeConfigurationSets
+ * action. The token to be used for the next set of paginated results. You don't need to supply a
- * value for this field in the initial request. The Amazon Resource Name (ARN) of the configuration set. The maximum number of results to return per each request. The name of the configuration set. An array of AccountAttributes objects. The current message type for the configuration set. The token to be used for the next set of paginated results. If this field is empty
- * then there are no more results. The name of the configuration set or the configuration set Amazon Resource Name (ARN)
+ * to delete the default sender ID from. The ConfigurationSetName and ConfigurationSetArn
+ * can be found using the DescribeConfigurationSets action. The token to be used for the next set of paginated results. You don't need to supply a
- * value for this field in the initial request. The Amazon Resource Name (ARN) of the configuration set. The maximum number of results to return per each request. The name of the configuration set. The current sender ID for the configuration set. An array of AccountLimit objects that show the current spend limits. The name of the configuration set or the configuration set's Amazon Resource Name
+ * (ARN) to remove the event destination from. The ConfigurateSetName and
+ * ConfigurationSetArn can be found using the DescribeConfigurationSets
+ * action. The token to be used for the next set of paginated results. If this field is empty
- * then there are no more results. The name of the event destination to delete. An array of strings. Each element can be either a ConfigurationSetName or
- * ConfigurationSetArn. An array of filters to apply to the results that are returned. The Amazon Resource Name (ARN) of the configuration set. The token to be used for the next set of paginated results. You don't need to supply a
- * value for this field in the initial request. The name of the configuration set the event destination was deleted from. The maximum number of results to return per each request. The event destination object that was deleted. An array of ConfigurationSets objects. The origination identity to use such as a PhoneNumberId, PhoneNumberArn, PoolId or
+ * PoolArn. You can use DescribePhoneNumbers to find the values for
+ * PhoneNumberId and PhoneNumberArn and DescribePools to find the values
+ * of PoolId and PoolArn. The token to be used for the next set of paginated results. If this field is empty
- * then there are no more results. The keyword to delete. The information for keywords that meet a specified criteria. The name of the attribute to filter on. The PhoneNumberArn or PoolArn that the keyword was associated with. An array values to filter for. The PhoneNumberId or PoolId that the keyword was associated with. The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or
- * SenderIdArn. You can use DescribePhoneNumbers to find the values for
- * PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used
- * to get the values for SenderId and SenderIdArn. The keyword that was deleted. An array of keywords to search for. The message that was associated with the deleted keyword. An array of keyword filters to filter the results. The action that was associated with the deleted keyword. The token to be used for the next set of paginated results. You don't need to supply a
- * value for this field in the initial request. The OptOutListName or OptOutListArn to remove the phone number from. The maximum number of results to return per each request. The phone number, in E.164 format, to remove from the OptOutList. The information for all keywords in a pool. The keyword as a string. The OptOutListArn that the phone number was removed from. A custom message that can be used with the keyword. The OptOutListName that the phone number was removed from. The action to perform for the keyword. The phone number that was removed from the OptOutList. The time that the number was removed at, in UNIX epoch time format. This is true if it was the end user who requested their phone number be removed.
+ * The PhoneNumberArn or PoolArn that is associated with the OriginationIdentity. The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and
+ * OptOutListArn. The PhoneNumberId or PoolId that is associated with the OriginationIdentity. The Amazon Resource Name (ARN) of the OptOutList that was removed. An array of KeywordInformation objects that contain the results. The name of the OptOutList that was removed. The token to be used for the next set of paginated results. If this field is empty
- * then there are no more results. The time when the OptOutList was created, in UNIX epoch time format. The PoolId or PoolArn of the pool to delete. You can use DescribePools to find the values for PoolId and PoolArn . The Amazon Resource Name (ARN) of the pool that was deleted. The information for opted out numbers that meet a specified criteria. The name of the attribute to filter on. The PoolId of the pool that was deleted. An array of values to filter for. The current status of the pool. CREATING: The pool is currently being created and isn't yet available for
+ * use. ACTIVE: The pool is active and available for use. DELETING: The pool is being deleted. The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and
- * OptOutListArn. The message type that was associated with the deleted pool. An array of phone numbers to search for in the OptOutList. By default this is set to false. When set to true you can receive incoming text
+ * messages from your end recipients. An array of OptedOutFilter objects to filter the results on. The Amazon Resource Name (ARN) of the TwoWayChannel. The token to be used for the next set of paginated results. You don't need to supply a
- * value for this field in the initial request. An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages. The maximum number of results to return per each request. By default this is set to false. When an end recipient sends a message that begins
+ * with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically
+ * replies with a customizable message and adds the end recipient to the OptOutList. When
+ * set to true you're responsible for responding to HELP and STOP requests. You're also
+ * responsible for tracking and honoring opt-out requests. The information for an opted out number in an Amazon Web Services account. The phone number that is opted out. The name of the OptOutList that was associated with the deleted pool. The time that the op tout occurred, in UNIX epoch time format. Indicates whether shared routes are enabled for the pool. This is set to true if it was the end recipient that opted out. The time when the pool was created, in UNIX epoch time format. The Amazon Resource Name (ARN) of the OptOutList. The unique identifier for the registration. The name of the OptOutList. The Amazon Resource Name (ARN) for the registration. An array of OptedOutNumbersInformation objects that provide information about the
- * requested OptedOutNumbers. The unique identifier for the registration. The token to be used for the next set of paginated results. If this field is empty
- * then there are no more results. The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions
+ * action. The OptOutLists to show the details of. This is an array of strings that can be either
- * the OptOutListName or OptOutListArn. The status of the registration.
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ * The token to be used for the next set of paginated results. You don't need to supply a
- * value for this field in the initial request. The current version number of the registration. The maximum number of results to return per each request. The version number of the registration that was approved. The information for all OptOutList in an Amazon Web Services account. The Amazon Resource Name (ARN) of the OptOutList. The latest version number of the registration that was denied. The name of the OptOutList. Metadata about a given registration which is specific to that registration type. The time when the OutOutList was created, in UNIX epoch time format. The time when the registration was created, in UNIX epoch time format. An array of OptOutListInformation objects that contain the details for the requested
- * OptOutLists. The token to be used for the next set of paginated results. If this field is empty
- * then there are no more results. The unique identifier for the registration attachment. The Amazon Resource Name (ARN) for the registration attachment. The unique identifier for the registration attachment. The status of the registration attachment.
+ *
+ *
+ *
+ * The error message if the upload failed. The time when the registration attachment was created, in UNIX epoch time format. The unique identifier for the registration. The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths. The Amazon Resource Name (ARN) for the registration. The unique identifier for the registration. The version number of the registration. The path to the registration form field. An array of values for the form field. The text data for a free form field. The unique identifier for the registration attachment. The current monthly limit, in US dollars. The unique identifier for the verified destination phone number. The Amazon Resource Name (ARN) for the verified destination phone number. The unique identifier for the verified destination phone number. The verified destination phone number, in E.164 format. The time when the destination phone number was created, in UNIX epoch time format. The current monthly limit, in US dollars. The token to be used for the next set of paginated results. You don't need to supply a
+ * value for this field in the initial request. The maximum number of results to return per each request. An array of AccountAttributes objects. The token to be used for the next set of paginated results. If this field is empty
+ * then there are no more results. The token to be used for the next set of paginated results. You don't need to supply a
+ * value for this field in the initial request. The maximum number of results to return per each request. An array of AccountLimit objects that show the current spend limits. The token to be used for the next set of paginated results. If this field is empty
+ * then there are no more results. An array of strings. Each element can be either a ConfigurationSetName or
+ * ConfigurationSetArn. An array of filters to apply to the results that are returned. The token to be used for the next set of paginated results. You don't need to supply a
+ * value for this field in the initial request. The maximum number of results to return per each request. An array of ConfigurationSets objects. The token to be used for the next set of paginated results. If this field is empty
+ * then there are no more results. The information for keywords that meet a specified criteria. The name of the attribute to filter on. An array values to filter for. The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or
+ * SenderIdArn. You can use DescribePhoneNumbers to find the values for
+ * PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used
+ * to get the values for SenderId and SenderIdArn. An array of keywords to search for. An array of keyword filters to filter the results. The token to be used for the next set of paginated results. You don't need to supply a
+ * value for this field in the initial request. The maximum number of results to return per each request. The information for all keywords in a pool. The keyword as a string. A custom message that can be used with the keyword. The action to perform for the keyword. The PhoneNumberArn or PoolArn that is associated with the OriginationIdentity. The PhoneNumberId or PoolId that is associated with the OriginationIdentity. An array of KeywordInformation objects that contain the results. The token to be used for the next set of paginated results. If this field is empty
+ * then there are no more results. The information for opted out numbers that meet a specified criteria. The name of the attribute to filter on. An array of values to filter for. The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and
+ * OptOutListArn. An array of phone numbers to search for in the OptOutList. An array of OptedOutFilter objects to filter the results on. The token to be used for the next set of paginated results. You don't need to supply a
+ * value for this field in the initial request. The maximum number of results to return per each request. The information for an opted out number in an Amazon Web Services account. The phone number that is opted out. The time that the op tout occurred, in UNIX epoch time format. This is set to true if it was the end recipient that opted out. The Amazon Resource Name (ARN) of the OptOutList. The name of the OptOutList. An array of OptedOutNumbersInformation objects that provide information about the
+ * requested OptedOutNumbers. The token to be used for the next set of paginated results. If this field is empty
+ * then there are no more results. The OptOutLists to show the details of. This is an array of strings that can be either
+ * the OptOutListName or OptOutListArn. The token to be used for the next set of paginated results. You don't need to supply a
+ * value for this field in the initial request. The maximum number of results to return per each request. The information for all OptOutList in an Amazon Web Services account. The Amazon Resource Name (ARN) of the OptOutList. The name of the OptOutList. The time when the OutOutList was created, in UNIX epoch time format. An array of OptOutListInformation objects that contain the details for the requested
+ * OptOutLists. The token to be used for the next set of paginated results. If this field is empty
+ * then there are no more results. The information for a phone number that meets a specified criteria. The name of the attribute to filter on. An array values to filter for. The unique identifier of phone numbers to find information about. This is an array of
+ * strings that can be either the PhoneNumberId or PhoneNumberArn. An array of PhoneNumberFilter objects to filter the results. The token to be used for the next set of paginated results. You don't need to supply a
+ * value for this field in the initial request. The maximum number of results to return per each request. The information for a phone number, in E.164 format, in an Amazon Web Services account. The Amazon Resource Name (ARN) associated with the phone number. The unique identifier for the phone number. The phone number in E.164 format. The current status of the phone number. The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
+ * The type of message. Valid values are TRANSACTIONAL for messages that are critical or
+ * time-sensitive and PROMOTIONAL for messages that aren't critical or
+ * time-sensitive. Describes if the origination identity can be used for text messages, voice calls or
+ * both. The type of phone number. The price, in US dollars, to lease the phone number. By default this is set to false. When set to true you can receive incoming text
+ * messages from your end recipients using the TwoWayChannelArn. The Amazon Resource Name (ARN) of the two way channel. An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages. When set to false an end recipient sends a message that begins with HELP or STOP to
+ * one of your dedicated numbers, Amazon Pinpoint automatically replies with a
+ * customizable message and adds the end recipient to the OptOutList. When set to true
+ * you're responsible for responding to HELP and STOP requests. You're also responsible for
+ * tracking and honoring opt-out request. For more information see Self-managed opt-outs
+ * The name of the OptOutList associated with the phone number. When set to true the phone number can't be deleted. The unique identifier of the pool associated with the phone number. The unique identifier for the registration. The time when the phone number was created, in UNIX epoch time format. An array of PhoneNumberInformation objects that contain the details for the requested
+ * phone numbers. The token to be used for the next set of paginated results. If this field is empty
+ * then there are no more results. The information for a pool that meets a specified criteria. The name of the attribute to filter on. An array values to filter for. The unique identifier of pools to find. This is an array of strings that can be either
+ * the PoolId or PoolArn. An array of PoolFilter objects to filter the results. The token to be used for the next set of paginated results. You don't need to supply a
+ * value for this field in the initial request. The maximum number of results to return per each request. The information for a pool in an Amazon Web Services account. The Amazon Resource Name (ARN) for the pool. The unique identifier for the pool. The current status of the pool. The type of message. Valid values are TRANSACTIONAL for messages that are critical or
+ * time-sensitive and PROMOTIONAL for messages that aren't critical or
+ * time-sensitive. When set to true you can receive incoming text messages from your end recipients using
+ * the TwoWayChannelArn. The Amazon Resource Name (ARN) of the two way channel. An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages. When set to false, an end recipient sends a message that begins with HELP or STOP to
+ * one of your dedicated numbers, Amazon Pinpoint automatically replies with a
+ * customizable message and adds the end recipient to the OptOutList. When set to true
+ * you're responsible for responding to HELP and STOP requests. You're also responsible for
+ * tracking and honoring opt-out requests. For more information see Self-managed opt-outs
+ * The name of the OptOutList associated with the pool. Allows you to enable shared routes on your pool. By default, this is set to When set to true the pool can't be deleted. The time when the pool was created, in UNIX epoch time format. An array of PoolInformation objects that contain the details for the requested pools. The token to be used for the next set of paginated results. If this field is empty
+ * then there are no more results. The filter definition for filtering registration attachments that meets a specified criteria. The name of the attribute to filter on. An array of values to filter on. The unique identifier of registration attachments to find. This is an array of RegistrationAttachmentId. An array of RegistrationAttachmentFilter objects to filter the results. The token to be used for the next set of paginated results. You don't need to supply a
+ * value for this field in the initial request. The maximum number of results to return per each request. Provides information on the specified registration attachments. The Amazon Resource Name (ARN) for the registration attachment. The unique identifier for the registration attachment. The status of the registration attachment.
+ *
+ *
+ *
+ * A description of why the upload didn't successfully complete. The time when the registration attachment was created, in UNIX epoch time format. An array of RegistrationAttachments objects that contain the details for the requested registration attachments. The token to be used for the next set of paginated results. You don't need to supply a
+ * value for this field in the initial request. The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions
+ * action. The path to the section of the registration. An array of paths to the registration form field. The token to be used for the next set of paginated results. You don't need to supply a
+ * value for this field in the initial request. The maximum number of results to return per each request. A description of each select option. The value of the option. The title of the select option. A description of the option meaning. Provides help information on the registration field. The title of the display hint. A short description of the display hint. A full description of the display hint. The title of the document the display hint is associated with. The link to the document the display hint is associated with. An array of SelectOptionDescription objects. The validation rules for the text field. Example text of what the value of a field should contain. Validation rules for a select field. The minimum number of choices for the select. The maximum number of choices for the select. An array of strings for the possible selection options. Validation rules for a text field. The minimum number of characters for the text field. The maximum number of characters for the text field. The regular expression used to validate the text field. Provides a description of the specified field. The section path of the field. The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths. The type of field. Specifies if the field for the registration form is required, conditional or optional. The validation rules for a select field. The validation rules for a text field. An array of RegistrationFieldDisplayHints objects for the field. The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions
+ * action. An array of RegistrationFieldDefinitions objects that contain the details for the requested fields. The token to be used for the next set of paginated results. You don't need to supply a
+ * value for this field in the initial request. The unique identifier for the registration. The version number of the registration. The path to the section of the registration. An array of paths to the registration form field. The token to be used for the next set of paginated results. You don't need to supply a
+ * value for this field in the initial request. The maximum number of results to return per each request. Provides the values of the specified field. The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths. An array of values for the form field. The text data for a free form field. The unique identifier for the registration attachment. A description of why the registration was denied. The Amazon Resource Name (ARN) for the registration. The unique identifier for the registration. The current version of the registration. An array of RegistrationFieldValues objects that contain the values for the requested registration. The token to be used for the next set of paginated results. You don't need to supply a
+ * value for this field in the initial request. The filter definition for filtering registrations that meets a specified criteria. The name of the attribute to filter on. An array of values to filter on. An array of unique identifiers for each registration. An array of RegistrationFilter objects to filter the results. The token to be used for the next set of paginated results. You don't need to supply a
+ * value for this field in the initial request. The maximum number of results to return per each request. Provides information about the requested registration. The Amazon Resource Name (ARN) for the registration. The unique identifier for the registration. The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions
+ * action. The status of the registration.
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ * The current version number of the registration. The version number of the registration that was approved. The latest version number of the registration that was denied. Metadata about a given registration which is specific to that registration type. The time when the registration was created, in UNIX epoch time format. An array of RegistrationInformation objects. The token to be used for the next set of paginated results. You don't need to supply a
+ * value for this field in the initial request. The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions
+ * action. An array of paths for the registration form section. The token to be used for the next set of paginated results. You don't need to supply a
+ * value for this field in the initial request. The maximum number of results to return per each request. Provides help information on the registration section. The title of the display hint. A short description of the display hint. A full description of the display hint. The title of the document the display hint is associated with. The link to the document the display hint is associated with. Provides information on the specified section definition. The path to the section of the registration. The path to the section of the registration. The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions
+ * action. An array of RegistrationSectionDefinition objects. The token to be used for the next set of paginated results. You don't need to supply a
+ * value for this field in the initial request. The filter definition for filtering registration types that meets a specified criteria. The name of the attribute to filter on. An array of values to filter on. The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions
+ * action. An array of RegistrationFilter objects to filter the results. The token to be used for the next set of paginated results. You don't need to supply a
+ * value for this field in the initial request. The maximum number of results to return per each request. Provides help information on the registration type. The title of the display hint. A short description of the display hint. A full description of the display hint. The title of the document the display hint is associated with. The link to the document the display hint is associated with. The processing rules for when a registration can be associated with an origination identity and disassociated from an origination identity. Defines the behavior of when an origination identity and registration can be associated with each other. The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. The association behavior.
+ *
+ *
+ * The disassociation behavior.
+ *
+ *
+ * Provides information on the supported registration type. The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions
+ * action. The supported association behavior for the registration type. Provides help information on the registration. The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions
+ * action. The token to be used for the next set of paginated results. You don't need to supply a
+ * value for this field in the initial request. The filter definition for filtering registration versions that meets a specified criteria. The name of the attribute to filter on. An array of values to filter on. The unique identifier for the registration. An array of registration version numbers. An array of RegistrationVersionFilter objects to filter the results. The token to be used for the next set of paginated results. You don't need to supply a
+ * value for this field in the initial request. The maximum number of results to return per each request. The information for a phone number that meets a specified criteria. Provides the reason a registration was rejected. The name of the attribute to filter on. The reason a registration was rejected. An array values to filter for. A short description of the rejection reason. A long description of the rejection reason. The title of the document. The link to the document. Provides information about the specified version of the registration. The unique identifier of phone numbers to find information about. This is an array of
- * strings that can be either the PhoneNumberId or PhoneNumberArn. The version number of the registration. An array of PhoneNumberFilter objects to filter the results. The status of the registration.
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ * The token to be used for the next set of paginated results. You don't need to supply a
- * value for this field in the initial request. The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes. The maximum number of results to return per each request. An array of RegistrationDeniedReasonInformation objects. The Amazon Resource Name (ARN) for the registration. The unique identifier for the registration. An array of RegistrationVersions objects. The token to be used for the next set of paginated results. You don't need to supply a
+ * value for this field in the initial request. The information for a sender ID that meets a specified criteria. The name of the attribute to filter on. An array of values to filter for. The alphanumeric sender ID in a specific country that you want to describe. For more
+ * information on sender IDs see Requesting
+ * sender IDs for SMS messaging with Amazon Pinpoint
+ * in the Amazon Pinpoint User Guide. The unique identifier of the sender. The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
+ * The information for a phone number in an Amazon Web Services account. The Amazon Resource Name (ARN) associated with the phone number. An array of SenderIdAndCountry objects to search for. The unique identifier for the phone number. An array of SenderIdFilter objects to filter the results. The phone number in E.164 format. The token to be used for the next set of paginated results. You don't need to supply a
+ * value for this field in the initial request. The current status of the phone number. The maximum number of results to return per each request. The information for all SenderIds in an Amazon Web Services account. The Amazon Resource Name (ARN) associated with the SenderId. The alphanumeric sender ID in a specific country that you'd like to describe. Describes if the origination identity can be used for text messages, voice calls or
- * both. The monthly leasing price, in US dollars. The type of phone number. By default this is set to false. When set to true the sender ID can't be deleted. The price, in US dollars, to lease the phone number. True if the sender ID is registered. By default this is set to false. When set to true you can receive incoming text
- * messages from your end recipients using the TwoWayChannelArn. The unique identifier for the registration. The Amazon Resource Name (ARN) of the two way channel. An array of SernderIdInformation objects that contain the details for the requested
+ * SenderIds. When set to false an end recipient sends a message that begins with HELP or STOP to
- * one of your dedicated numbers, Amazon Pinpoint automatically replies with a
- * customizable message and adds the end recipient to the OptOutList. When set to true
- * you're responsible for responding to HELP and STOP requests. You're also responsible for
- * tracking and honoring opt-out request. For more information see Self-managed opt-outs
- * The token to be used for the next set of paginated results. If this field is empty
+ * then there are no more results. The name of the OptOutList associated with the phone number. The token to be used for the next set of paginated results. You don't need to supply a
+ * value for this field in the initial request. When set to true the phone number can't be deleted. The maximum number of results to return per each request. Describes the current Amazon Pinpoint monthly spend limits for sending voice and
+ * text messages. For more information on increasing your monthly spend limit, see
+ * Requesting increases to your monthly SMS spending quota for Amazon Pinpoint
+ * in the Amazon Pinpoint User Guide. The unique identifier of the pool associated with the phone number. The name for the SpendLimit. The maximum amount of money, in US dollars, that you want to be able to spend sending
+ * messages each month. This value has to be less than or equal to the amount in
+ * The maximum amount of money that you are able to spend to send messages each month,
+ * in US dollars. The time when the phone number was created, in UNIX epoch time format. When set to An array of PhoneNumberInformation objects that contain the details for the requested
- * phone numbers. An array of SpendLimit objects that contain the details for the requested spend
+ * limits. The information for a pool that meets a specified criteria. The filter definition for filtering verified destination phone numbers that meets a specified criteria. The name of the attribute to filter on. An array values to filter for. An array of values to filter on. The unique identifier of pools to find. This is an array of strings that can be either
- * the PoolId or PoolArn. An array of VerifiedDestinationNumberid to retreive. An array of PoolFilter objects to filter the results. An array of verified destination phone number, in E.164 format. An array of VerifiedDestinationNumberFilter objects to filter the results. The information for a pool in an Amazon Web Services account. Provides information about the requested verified destintion phone number. The Amazon Resource Name (ARN) for the pool. The unique identifier for the pool. The current status of the pool. The type of message. Valid values are TRANSACTIONAL for messages that are critical or
- * time-sensitive and PROMOTIONAL for messages that aren't critical or
- * time-sensitive. When set to true you can receive incoming text messages from your end recipients using
- * the TwoWayChannelArn. The Amazon Resource Name (ARN) of the two way channel. When set to false, an end recipient sends a message that begins with HELP or STOP to
- * one of your dedicated numbers, Amazon Pinpoint automatically replies with a
- * customizable message and adds the end recipient to the OptOutList. When set to true
- * you're responsible for responding to HELP and STOP requests. You're also responsible for
- * tracking and honoring opt-out requests. For more information see Self-managed opt-outs
- * The Amazon Resource Name (ARN) for the verified destination phone number. The name of the OptOutList associated with the pool. The unique identifier for the verified destination phone number. Allows you to enable shared routes on your pool. By default, this is set to The verified destination phone number, in E.164 format. When set to true the pool can't be deleted. The status of the verified destination phone number.
+ *
+ * The time when the pool was created, in UNIX epoch time format. The time when the destination phone number was created, in UNIX epoch time format. An array of PoolInformation objects that contain the details for the requested pools. An array of VerifiedDestinationNumberInformation objects The token to be used for the next set of paginated results. If this field is empty
- * then there are no more results. The token to be used for the next set of paginated results. You don't need to supply a
+ * value for this field in the initial request. The information for a sender ID that meets a specified criteria. The name of the attribute to filter on. The unique identifier for the pool to disassociate with the origination identity. This
+ * value can be either the PoolId or PoolArn. An array of values to filter for. The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or
+ * SenderIdArn. You can use DescribePhoneNumbers find the values for
+ * PhoneNumberId and PhoneNumberArn, or use DescribeSenderIds to get the
+ * values for SenderId and SenderIdArn. The alphanumeric sender ID in a specific country that you want to describe. For more
- * information on sender IDs see Requesting
- * sender IDs for SMS messaging with Amazon Pinpoint
- * in the Amazon Pinpoint User Guide. The unique identifier of the sender. The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
+ * The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- * Unique, case-sensitive identifier you provide to ensure the idempotency of the
+ * request. If you don't specify a client token, a randomly generated token is used for the
+ * request to ensure idempotency. An array of SenderIdAndCountry objects to search for. The Amazon Resource Name (ARN) of the pool. An array of SenderIdFilter objects to filter the results. The PoolId of the pool no longer associated with the origination identity. The token to be used for the next set of paginated results. You don't need to supply a
- * value for this field in the initial request. The PhoneNumberArn or SenderIdArn of the origination identity. The maximum number of results to return per each request. The PhoneNumberId or SenderId of the origination identity. The information for all SenderIds in an Amazon Web Services account. The Amazon Resource Name (ARN) associated with the SenderId. The two-character code, in ISO 3166-1 alpha-2 format, for the country or
+ * region. The alphanumeric sender ID in a specific country that you'd like to describe. The unique identifier for the registration. The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- * The Amazon Resource Name (ARN) for the registration. The type of message. Valid values are TRANSACTIONAL for messages that are critical or
- * time-sensitive and PROMOTIONAL for messages that aren't critical or
- * time-sensitive. The unique identifier for the registration. The monthly leasing price, in US dollars. The version number of the registration. An array of SernderIdInformation objects that contain the details for the requested
- * SenderIds. The status of the registration version.
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ * The token to be used for the next set of paginated results. If this field is empty
- * then there are no more results. The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes. The token to be used for the next set of paginated results. You don't need to supply a
- * value for this field in the initial request. The maximum number of results to return per each request. Describes the current Amazon Pinpoint monthly spend limits for sending voice and
- * text messages. For more information on increasing your monthly spend limit, see
- * Requesting increases to your monthly SMS spending quota for Amazon Pinpoint
- * in the Amazon Pinpoint User Guide. Information about origination identities associated with a pool that meets a specified
+ * criteria. The name for the SpendLimit. The name of the attribute to filter on. The maximum amount of money, in US dollars, that you want to be able to spend sending
- * messages each month. This value has to be less than or equal to the amount in
- * An array values to filter for. The maximum amount of money that you are able to spend to send messages each month,
- * in US dollars. The unique identifier for the pool. This value can be either the PoolId or
+ * PoolArn. When set to An array of PoolOriginationIdentitiesFilter objects to filter the results.. An array of SpendLimit objects that contain the details for the requested spend
- * limits. The token to be used for the next set of paginated results. You don't need to supply a
+ * value for this field in the initial request. The token to be used for the next set of paginated results. If this field is empty
- * then there are no more results. The maximum number of results to return per each request. The metadata for an origination identity associated with a pool. The unique identifier for the pool to disassociate with the origination identity. This
- * value can be either the PoolId or PoolArn. The Amazon Resource Name (ARN) associated with the origination identity. The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or
- * SenderIdArn. You can use DescribePhoneNumbers find the values for
- * PhoneNumberId and PhoneNumberArn, or use DescribeSenderIds to get the
- * values for SenderId and SenderIdArn. The unique identifier of the origination identity. Unique, case-sensitive identifier you provide to ensure the idempotency of the
- * request. If you don't specify a client token, a randomly generated token is used for the
- * request to ensure idempotency. Describes if the origination identity can be used for text messages, voice calls or
+ * both. The phone number in E.164 format. The Amazon Resource Name (ARN) of the pool. The Amazon Resource Name (ARN) for the pool. The PoolId of the pool no longer associated with the origination identity. The unique PoolId of the pool. The PhoneNumberArn or SenderIdArn of the origination identity. The PhoneNumberId or SenderId of the origination identity. An array of any OriginationIdentityMetadata objects. The two-character code, in ISO 3166-1 alpha-2 format, for the country or
- * region. The token to be used for the next set of paginated results. If this field is empty
+ * then there are no more results. Information about origination identities associated with a pool that meets a specified
- * criteria. The filter definition for filtering registrations that meets a specified criteria. The name of the attribute to filter on. An array values to filter for. An array of values to filter for. The unique identifier for the pool. This value can be either the PoolId or
- * PoolArn. The unique identifier for the registration. An array of PoolOriginationIdentitiesFilter objects to filter the results.. An array of RegistrationAssociationFilter to apply to the results that are returned. The metadata for an origination identity associated with a pool. Metadata for the origination identity that is associated with the registration. The Amazon Resource Name (ARN) associated with the origination identity. The Amazon Resource Name (ARN) of the origination identity that is associated with the registration. The unique identifier of the origination identity. The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId. The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- * The origination identity type. Describes if the origination identity can be used for text messages, voice calls or
- * both. The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. The phone number associated with the registration in E.164 format. The Amazon Resource Name (ARN) for the pool. The Amazon Resource Name (ARN) for the registration. The unique PoolId of the pool. The unique identifier for the registration. An array of any OriginationIdentityMetadata objects. The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions
+ * action. The token to be used for the next set of paginated results. If this field is empty
- * then there are no more results. An array of RegistrationAssociationMetadata objects. The token to be used for the next set of paginated results. You don't need to supply a
+ * value for this field in the initial request. The message associated with the keyword. The action to perform for the new keyword when it is received. AUTOMATIC_RESPONSE: A message is sent to the recipient. AUTOMATIC_RESPONSE: A message is sent to the recipient. OPT_OUT: Keeps the recipient from receiving future messages. OPT_OUT: Keeps the recipient from receiving future messages. OPT_IN: The recipient wants to receive future messages. OPT_IN: The recipient wants to receive future messages. The PhoneNumberArn or PoolArn that the keyword was associated with. The PhoneNumberId or PoolId that the keyword was associated with. The keyword that was added. The message associated with the keyword. The action to perform when the keyword is used. The OptOutListName or OptOutListArn to add the phone number to. The phone number to add to the OptOutList in E.164 format. The OptOutListArn that the phone number was removed from. The OptOutListName that the phone number was removed from. The phone number that was added to the OptOutList. The time that the phone number was added to the OptOutList, in UNIX epoch time format. The action to perform for the new keyword when it is received. This is true if it was the end user who requested their phone number be removed.
+ * The PhoneNumberArn or PoolArn that the keyword was associated with. The unique identifier for the registration. The PhoneNumberId or PoolId that the keyword was associated with. The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths. The keyword that was added. An array of values for the form field. The message associated with the keyword. The text data for a free form field. The action to perform when the keyword is used. The unique identifier for the registration attachment. The OptOutListName or OptOutListArn to add the phone number to. The Amazon Resource Name (ARN) for the registration. The phone number to add to the OptOutList in E.164 format. The unique identifier for the registration. The OptOutListArn that the phone number was removed from. The version number of the registration. The OptOutListName that the phone number was removed from. The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths. The phone number that was added to the OptOutList. An array of values for the form field. The time that the phone number was added to the OptOutList, in UNIX epoch time format. The text data for a free form field. This is true if it was the end user who requested their phone number be removed.
- * The unique identifier for the registration attachment. An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages. By default this is set to false. When an end recipient sends a message that begins
@@ -3137,6 +5767,12 @@ export interface ReleasePhoneNumberResult {
*/
OptOutListName?: string;
+ /**
+ * @public
+ * The unique identifier for the registration. The time when the phone number was created, in UNIX epoch time format. The sender ID to release. The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. The Amazon Resource Name (ARN) associated with the SenderId. The sender ID that was released. The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. The type of message. Valid values are TRANSACTIONAL for messages that are critical or
+ * time-sensitive and PROMOTIONAL for messages that aren't critical or
+ * time-sensitive. The monthly price, in US dollars, to lease the sender ID. True if the sender ID is registered. The unique identifier for the registration. The name of the OptOutList to associate with the phone number. You can use the
- * OutOutListName or OptPutListArn. The current status of the request. The current status of the request. The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
+ * The type of message. Valid values are TRANSACTIONAL for messages that are critical or
+ * time-sensitive and PROMOTIONAL for messages that aren't critical or
+ * time-sensitive. Indicates if the phone number will be used for text messages, voice messages or both.
+ * The type of number that was released. The monthly price, in US dollars, to lease the phone number. By default this is set to false. When set to true you can receive incoming text
+ * messages from your end recipients. The ARN used to identify the two way channel. An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages. By default this is set to false. When an end recipient sends a message that begins
+ * with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically
+ * replies with a customizable message and adds the end recipient to the OptOutList. When
+ * set to true you're responsible for responding to HELP and STOP requests. You're also
+ * responsible for tracking and honoring opt-out requests. The name of the OptOutList that is associated with the requested phone number. By default this is set to false. When set to true the phone number can't be deleted.
+ * The unique identifier of the pool associated with the phone number The unique identifier for the registration. An array of key and value pair tags that are associated with the phone number. The time when the phone number was created, in UNIX epoch time format. The sender ID string to request. The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. The type of message. Valid values are TRANSACTIONAL for messages that are critical or
+ * time-sensitive and PROMOTIONAL for messages that aren't critical or
+ * time-sensitive. By default this is set to false. When set to true the sender ID can't be deleted. An array of tags (key and value pairs) to associate with the sender ID. Unique, case-sensitive identifier that you provide to ensure the idempotency of the
+ * request. If you don't specify a client token, a randomly generated token is used for the
+ * request to ensure idempotency. The Amazon Resource Name (ARN) associated with the SenderId. The sender ID that was requested. The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- * The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.TEXT_SENT event type is not supported.TEXT_SENT event type is not supported.
+ *
*
*/
@@ -1081,6 +1155,12 @@ export interface CreatePoolResult {
*/
TwoWayChannelArn?: string;
+ /**
+ * @public
+ *
+ *
*/
- DefaultMessageType?: MessageType;
+ RegistrationStatus: RegistrationStatus | undefined;
/**
* @public
- * CREATED: Your registration is created but not submitted.SUBMITTED: Your registration has been submitted and is awaiting review.REVIEWING: Your registration has been accepted and is being reviewed.PROVISIONING: Your registration has been approved and your origination identity is being created.COMPLETE: Your registration has been approved and and your origination identity has been created.REQUIRES_UPDATES: You must fix your registration and resubmit it.CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number.DELETED: The registration has been deleted.
+ *
*/
- EventDestination?: EventDestination;
-}
+ AttachmentStatus: AttachmentStatus | undefined;
-/**
- * @public
- */
-export interface DeleteKeywordRequest {
/**
* @public
- * UPLOAD_IN_PROGRESS The attachment is being uploaded.UPLOAD_COMPLETE The attachment has been uploaded.UPLOAD_FAILED The attachment failed to uploaded.DELETED The attachment has been deleted..
+ *
*/
- OptedOutTimestamp?: Date;
+ RegistrationVersionStatus: RegistrationVersionStatus | undefined;
/**
* @public
- * DRAFT: The initial status of a registration version after it’s created.SUBMITTED: Your registration has been submitted.REVIEWING: Your registration has been accepted and is being reviewed.APPROVED: Your registration has been approved.DISCARDED: You've abandon this version of their registration to start over with a new version. DENIED: You must fix your registration and resubmit it.REVOKED: Your previously approved registration has been revoked.ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.
- *
*
*/
- Status?: PoolStatus;
+ Status: VerificationStatus | undefined;
/**
* @public
- * PENDING: The phone number hasn't been verified yet.VERIFIED: The phone number is verified and can receive messages.
+ *
*/
- Values: string[] | undefined;
-}
+ Status?: PoolStatus;
-/**
- * @public
- */
-export interface DescribeOptedOutNumbersRequest {
/**
* @public
- *
+ *
*/
- OptOutListNames?: string[];
+ RegistrationStatus: RegistrationStatus | undefined;
/**
* @public
- * CREATED: Your registration is created but not submitted.SUBMITTED: Your registration has been submitted and is awaiting review.REVIEWING: Your registration has been accepted and is being reviewed.PROVISIONING: Your registration has been approved and your origination identity is being created.COMPLETE: Your registration has been approved and and your origination identity has been created.REQUIRES_UPDATES: You must fix your registration and resubmit it.CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number.DELETED: The registration has been deleted.
+ *
+ */
+ AttachmentStatus: AttachmentStatus | undefined;
+
+ /**
+ * @public
+ * UPLOAD_IN_PROGRESS The attachment is being uploaded.UPLOAD_COMPLETE The attachment has been uploaded.UPLOAD_FAILED The attachment failed to uploaded.DELETED The attachment has been deleted..False. If you set this value to
+ * True, your messages are sent using phone numbers or sender IDs
+ * (depending on the country) that are shared with other Amazon Pinpoint users. In some
+ * countries, such as the United States, senders aren't allowed to use shared routes and
+ * must use a dedicated phone number or short code.
+ *
+ */
+ AttachmentStatus: AttachmentStatus | undefined;
+
+ /**
+ * @public
+ * UPLOAD_IN_PROGRESS The attachment is being uploaded.UPLOAD_COMPLETE The attachment has been uploaded.UPLOAD_FAILED The attachment failed to uploaded.DELETED The attachment has been deleted..
+ *
+ */
+ RegistrationStatus: RegistrationStatus | undefined;
+
+ /**
+ * @public
+ * CREATED: Your registration is created but not submitted.SUBMITTED: Your registration has been submitted and is awaiting review.REVIEWING: Your registration has been accepted and is being reviewed.PROVISIONING: Your registration has been approved and your origination identity is being created.COMPLETE: Your registration has been approved and and your origination identity has been created.REQUIRES_UPDATES: You must fix your registration and resubmit it.CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number.DELETED: The registration has been deleted.
+ *
+ */
+ AssociationBehavior: RegistrationAssociationBehavior | undefined;
+
+ /**
+ * @public
+ * ASSOCIATE_BEFORE_SUBMIT The origination identity has to be supplied when creating a registration.ASSOCIATE_ON_APPROVAL This applies to all short code registrations. The short code will be automatically provisioned once the registration is approved.ASSOCIATE_AFTER_COMPLETE This applies to phone number registrations when you must complete a registration first, then associate one or more phone numbers later. For example 10DLC campaigns and long codes.
+ *
+ */
+ DisassociationBehavior: RegistrationDisassociationBehavior | undefined;
+}
+
+/**
+ * @public
+ * DISASSOCIATE_ALL_CLOSES_REGISTRATION All origination identities must be disassociated from the registration before the registration can be closed.DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION All origination identities must be disassociated from the registration before the registration can be deleted.DELETE_REGISTRATION_DISASSOCIATES The registration can be deleted and all origination identities will be disasscoiated.
+ *
*/
- Filters?: PhoneNumberFilter[];
+ RegistrationVersionStatus: RegistrationVersionStatus | undefined;
/**
* @public
- * DRAFT: The initial status of a registration version after it’s created.SUBMITTED: Your registration has been submitted.REVIEWING: Your registration has been accepted and is being reviewed.APPROVED: Your registration has been approved.DISCARDED: You've abandon this version of their registration to start over with a new version. DENIED: You must fix your registration and resubmit it.REVOKED: Your previously approved registration has been revoked.ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.MaxLimit. To use this custom limit, Overridden must be set
+ * to true.True, the value that has been specified in the
+ * EnforcedLimit is used to determine the maximum amount in US dollars
+ * that can be spent to send messages each month, in US dollars.False. If you set this value to
- * True, your messages are sent using phone numbers or sender IDs
- * (depending on the country) that are shared with other Amazon Pinpoint users. In some
- * countries, such as the United States, senders aren't allowed to use shared routes and
- * must use a dedicated phone number or short code.
+ *
*/
- DeletionProtectionEnabled: boolean | undefined;
+ Status: VerificationStatus | undefined;
/**
* @public
- * PENDING: The phone number hasn't been verified yet.VERIFIED: The phone number is verified and can receive messages.
+ *
*/
- SenderIds?: SenderIdInformation[];
+ RegistrationVersionStatus: RegistrationVersionStatus | undefined;
/**
* @public
- * DRAFT: The initial status of a registration version after it’s created.SUBMITTED: Your registration has been submitted.REVIEWING: Your registration has been accepted and is being reviewed.APPROVED: Your registration has been approved.DISCARDED: You've abandon this version of their registration to start over with a new version. DENIED: You must fix your registration and resubmit it.REVOKED: Your previously approved registration has been revoked.ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.MaxLimit. To use this custom limit, Overridden must be set
- * to true.True, the value that has been specified in the
- * EnforcedLimit is used to determine the maximum amount in US dollars
- * that can be spent to send messages each month, in US dollars.
+ */
+ KeywordMessage: string | undefined;
+
+ /**
+ * @public
+ *
*
*/
- KeywordMessage: string | undefined;
+ KeywordAction?: KeywordAction;
+}
+
+/**
+ * @public
+ */
+export interface PutKeywordResult {
+ /**
+ * @public
+ *
Indicates if the phone number will be used for text messages, voice messages or both. - *
+ *The monthly price, in US dollars, to lease the sender ID.
*/ - NumberCapabilities?: NumberCapability[]; + MonthlyLeasingPrice: string | undefined; /** * @public - *The type of number that was released.
+ *By default this is set to false. When set to true the sender ID can't be deleted.
*/ - NumberType?: RequestableNumberType; + DeletionProtectionEnabled: boolean | undefined; /** * @public - *The monthly price, in US dollars, to lease the phone number.
+ *True if the sender ID is registered.
*/ - MonthlyLeasingPrice?: string; + Registered: boolean | undefined; /** * @public - *By default this is set to false. When set to true you can receive incoming text - * messages from your end recipients.
+ *An array of tags (key and value pairs) to associate with the sender ID.
*/ - TwoWayEnabled?: boolean; + Tags?: Tag[]; +} + +/** + * @public + * @enum + */ +export const VerificationChannel = { + TEXT: "TEXT", + VOICE: "VOICE", +} as const; +/** + * @public + */ +export type VerificationChannel = (typeof VerificationChannel)[keyof typeof VerificationChannel]; + +/** + * @public + */ +export interface SendDestinationNumberVerificationCodeRequest { /** * @public - *The ARN used to identify the two way channel.
+ *The unique identifier for the verified destination phone number.
*/ - TwoWayChannelArn?: string; + VerifiedDestinationNumberId: string | undefined; /** * @public - *By default this is set to false. When an end recipient sends a message that begins - * with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically - * replies with a customizable message and adds the end recipient to the OptOutList. When - * set to true you're responsible for responding to HELP and STOP requests. You're also - * responsible for tracking and honoring opt-out requests.
+ *Choose to send the verification code as an SMS or voice message.
*/ - SelfManagedOptOutsEnabled?: boolean; + VerificationChannel: VerificationChannel | undefined; /** * @public - *The name of the OptOutList that is associated with the requested phone number.
+ *Choose the language to use for the message.
*/ - OptOutListName?: string; + LanguageCode?: LanguageCode; /** * @public - *By default this is set to false. When set to true the phone number can't be deleted. - *
+ *The origination identity of the message. This can be either the PhoneNumber, + * PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
*/ - DeletionProtectionEnabled?: boolean; + OriginationIdentity?: string; /** * @public - *The unique identifier of the pool associated with the phone number
+ *The name of the configuration set to use. This can be either the ConfigurationSetName + * or ConfigurationSetArn.
*/ - PoolId?: string; + ConfigurationSetName?: string; /** * @public - *An array of key and value pair tags that are associated with the phone number.
+ *You can specify custom data in this field. If you do, that data is logged to the event + * destination.
*/ - Tags?: Tag[]; + Context?: RecordThe time when the phone number was created, in UNIX epoch time format.
+ *This field is used for any country-specific registration requirements. Currently, this + * setting is only used when you send messages to recipients in India using a sender ID. + * For more information see Special requirements for sending SMS messages to recipients in India. + *
*/ - CreatedTimestamp?: Date; + DestinationCountryParameters?: PartialThe unique identifier for the message.
+ */ + MessageId: string | undefined; } /** @@ -3376,7 +6269,6 @@ export interface SendTextMessageRequest { /** * @public *The type of message. Valid values are - * TRANSACTIONAL * for messages that are critical or time-sensitive and PROMOTIONAL for messages that * aren't critical or time-sensitive.
*/ @@ -3556,13 +6448,13 @@ export interface SendVoiceMessageRequest { * @public *Specifies if the MessageBody field contains text or speech synthesis * markup language (SSML).
- *TEXT: This is the default value. When used the maximum character limit is + *
TEXT: This is the default value. When used the maximum character limit is * 3000.
*SSML: When used the maximum character limit is 6000 including SSML + *
SSML: When used the maximum character limit is 6000 including SSML * tagging.
*The unique identifier for the registration.
+ */ + RegistrationId: string | undefined; +} + +/** + * @public + */ +export interface SubmitRegistrationVersionResult { + /** + * @public + *The Amazon Resource Name (ARN) for the registration.
+ */ + RegistrationArn: string | undefined; + + /** + * @public + *The unique identifier for the registration.
+ */ + RegistrationId: string | undefined; + + /** + * @public + *The version number of the registration.
+ */ + VersionNumber: number | undefined; + + /** + * @public + *The status of the registration version.
+ *
+ * DRAFT: The initial status of a registration version after it’s created.
+ * SUBMITTED: Your registration has been submitted.
+ * REVIEWING: Your registration has been accepted and is being reviewed.
+ * APPROVED: Your registration has been approved.
+ * DISCARDED: You've abandon this version of their registration to start over with a new version.
+ * DENIED: You must fix your registration and resubmit it.
+ * REVOKED: Your previously approved registration has been revoked.
+ * ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.
The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.
+ */ + RegistrationVersionStatusHistory: RegistrationVersionStatusHistory | undefined; +} + /** * @public */ @@ -3823,6 +6795,9 @@ export interface UpdateEventDestinationRequest { /** * @public *An array of event types that determine which events to log.
+ *The TEXT_SENT event type is not supported.
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
+ */ + TwoWayChannelRole?: string; + /** * @public *By default this is set to false. When an end recipient sends a message that begins @@ -3994,6 +6975,12 @@ export interface UpdatePhoneNumberResult { */ TwoWayChannelArn?: string; + /** + * @public + *
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
+ */ + TwoWayChannelRole?: string; + /** * @public *This is true if self managed opt-out are enabled.
@@ -4012,6 +6999,12 @@ export interface UpdatePhoneNumberResult { */ DeletionProtectionEnabled?: boolean; + /** + * @public + *The unique identifier for the registration.
+ */ + RegistrationId?: string; + /** * @public *The time when the phone number was created, in UNIX epoch time format.
@@ -4043,6 +7036,12 @@ export interface UpdatePoolRequest { */ TwoWayChannelArn?: string; + /** + * @public + *An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
+ */ + TwoWayChannelRole?: string; + /** * @public *By default this is set to false. When an end recipient sends a message that begins @@ -4114,6 +7113,12 @@ export interface UpdatePoolResult { */ TwoWayChannelArn?: string; + /** + * @public + *
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
+ */ + TwoWayChannelRole?: string; + /** * @public *When an end recipient sends a message that begins with HELP or STOP to one of your @@ -4148,3 +7153,133 @@ export interface UpdatePoolResult { */ CreatedTimestamp?: Date; } + +/** + * @public + */ +export interface UpdateSenderIdRequest { + /** + * @public + *
The sender ID to update.
+ */ + SenderId: string | undefined; + + /** + * @public + *The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
+ */ + IsoCountryCode: string | undefined; + + /** + * @public + *By default this is set to false. When set to true the sender ID can't be deleted.
+ */ + DeletionProtectionEnabled?: boolean; +} + +/** + * @public + */ +export interface UpdateSenderIdResult { + /** + * @public + *The Amazon Resource Name (ARN) associated with the SenderId.
+ */ + SenderIdArn: string | undefined; + + /** + * @public + *The sender ID that was updated.
+ */ + SenderId: string | undefined; + + /** + * @public + *The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
+ */ + IsoCountryCode: string | undefined; + + /** + * @public + *The type of message. Valid values are TRANSACTIONAL for messages that are critical or + * time-sensitive and PROMOTIONAL for messages that aren't critical or + * time-sensitive.
+ */ + MessageTypes: MessageType[] | undefined; + + /** + * @public + *The monthly price, in US dollars, to lease the sender ID.
+ */ + MonthlyLeasingPrice: string | undefined; + + /** + * @public + *By default this is set to false. When set to true the sender ID can't be deleted.
+ */ + DeletionProtectionEnabled: boolean | undefined; + + /** + * @public + *True if the sender ID is registered..
+ */ + Registered: boolean | undefined; + + /** + * @public + *The unique identifier for the registration.
+ */ + RegistrationId?: string; +} + +/** + * @public + */ +export interface VerifyDestinationNumberRequest { + /** + * @public + *The unique identifier for the verififed destination phone number.
+ */ + VerifiedDestinationNumberId: string | undefined; + + /** + * @public + *The verification code that was received by the verified destination phone number.
+ */ + VerificationCode: string | undefined; +} + +/** + * @public + */ +export interface VerifyDestinationNumberResult { + /** + * @public + *The Amazon Resource Name (ARN) for the verified destination phone number.
+ */ + VerifiedDestinationNumberArn: string | undefined; + + /** + * @public + *The unique identifier for the verified destination phone number.
+ */ + VerifiedDestinationNumberId: string | undefined; + + /** + * @public + *The phone number in E.164 format.
+ */ + DestinationPhoneNumber: string | undefined; + + /** + * @public + *The status for being able to send messages to the phone number.
+ */ + Status: VerificationStatus | undefined; + + /** + * @public + *The time when the destination phone number was created, in UNIX epoch time format.
+ */ + CreatedTimestamp: Date | undefined; +} diff --git a/clients/client-pinpoint-sms-voice-v2/src/pagination/DescribeRegistrationAttachmentsPaginator.ts b/clients/client-pinpoint-sms-voice-v2/src/pagination/DescribeRegistrationAttachmentsPaginator.ts new file mode 100644 index 0000000000000..a78d72df1c1a2 --- /dev/null +++ b/clients/client-pinpoint-sms-voice-v2/src/pagination/DescribeRegistrationAttachmentsPaginator.ts @@ -0,0 +1,50 @@ +// smithy-typescript generated code +import { Paginator } from "@smithy/types"; + +import { + DescribeRegistrationAttachmentsCommand, + DescribeRegistrationAttachmentsCommandInput, + DescribeRegistrationAttachmentsCommandOutput, +} from "../commands/DescribeRegistrationAttachmentsCommand"; +import { PinpointSMSVoiceV2Client } from "../PinpointSMSVoiceV2Client"; +import { PinpointSMSVoiceV2PaginationConfiguration } from "./Interfaces"; + +/** + * @internal + */ +const makePagedClientRequest = async ( + client: PinpointSMSVoiceV2Client, + input: DescribeRegistrationAttachmentsCommandInput, + ...args: any +): PromiseAssociates the specified origination identity with a pool.
\nIf the origination identity is a phone number and is already associated with another\n pool, an Error is returned. A sender ID can be associated with multiple pools.
\nIf the origination identity configuration doesn't match the pool's configuration, an\n Error is returned.
" + "smithy.api#documentation": "Associates the specified origination identity with a pool.
\nIf the origination identity is a phone number and is already associated with another\n pool, an error is returned. A sender ID can be associated with multiple pools.
\nIf the origination identity configuration doesn't match the pool's configuration, an\n error is returned.
" } }, "com.amazonaws.pinpointsmsvoicev2#AssociateOriginationIdentityRequest": { @@ -209,6 +225,9 @@ "smithy.api#idempotencyToken": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.pinpointsmsvoicev2#AssociateOriginationIdentityResult": { @@ -244,6 +263,62 @@ "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
" } } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#AttachmentBody": { + "type": "blob", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1572864 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#AttachmentStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "UPLOAD_IN_PROGRESS", + "name": "UPLOAD_IN_PROGRESS" + }, + { + "value": "UPLOAD_COMPLETE", + "name": "UPLOAD_COMPLETE" + }, + { + "value": "UPLOAD_FAILED", + "name": "UPLOAD_FAILED" + }, + { + "value": "DELETED", + "name": "DELETED" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#AttachmentUploadErrorReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "INTERNAL_ERROR", + "name": "INTERNAL_ERROR" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#AttachmentUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^\\S+$" } }, "com.amazonaws.pinpointsmsvoicev2#ClientToken": { @@ -453,6 +528,10 @@ "type": "string", "traits": { "smithy.api#enum": [ + { + "value": "CREATE_REGISTRATION_VERSION_NOT_ALLOWED", + "name": "CREATE_REGISTRATION_VERSION_NOT_ALLOWED" + }, { "value": "DELETION_PROTECTION_ENABLED", "name": "DELETION_PROTECTION_ENABLED" @@ -465,6 +544,18 @@ "value": "DESTINATION_PHONE_NUMBER_OPTED_OUT", "name": "DESTINATION_PHONE_NUMBER_OPTED_OUT" }, + { + "value": "DISASSOCIATE_REGISTRATION_NOT_ALLOWED", + "name": "DISASSOCIATE_REGISTRATION_NOT_ALLOWED" + }, + { + "value": "DISCARD_REGISTRATION_VERSION_NOT_ALLOWED", + "name": "DISCARD_REGISTRATION_VERSION_NOT_ALLOWED" + }, + { + "value": "EDIT_REGISTRATION_FIELD_VALUES_NOT_ALLOWED", + "name": "EDIT_REGISTRATION_FIELD_VALUES_NOT_ALLOWED" + }, { "value": "EVENT_DESTINATION_MISMATCH", "name": "EVENT_DESTINATION_MISMATCH" @@ -478,8 +569,8 @@ "name": "LAST_PHONE_NUMBER" }, { - "value": "SELF_MANAGED_OPT_OUTS_MISMATCH", - "name": "SELF_MANAGED_OPT_OUTS_MISMATCH" + "value": "NUMBER_CAPABILITIES_MISMATCH", + "name": "NUMBER_CAPABILITIES_MISMATCH" }, { "value": "MESSAGE_TYPE_MISMATCH", @@ -497,6 +588,10 @@ "value": "PHONE_NUMBER_ASSOCIATED_TO_POOL", "name": "PHONE_NUMBER_ASSOCIATED_TO_POOL" }, + { + "value": "PHONE_NUMBER_ASSOCIATED_TO_REGISTRATION", + "name": "PHONE_NUMBER_ASSOCIATED_TO_REGISTRATION" + }, { "value": "PHONE_NUMBER_NOT_ASSOCIATED_TO_POOL", "name": "PHONE_NUMBER_NOT_ASSOCIATED_TO_POOL" @@ -505,6 +600,18 @@ "value": "PHONE_NUMBER_NOT_IN_REGISTRATION_REGION", "name": "PHONE_NUMBER_NOT_IN_REGISTRATION_REGION" }, + { + "value": "REGISTRATION_ALREADY_SUBMITTED", + "name": "REGISTRATION_ALREADY_SUBMITTED" + }, + { + "value": "REGISTRATION_NOT_COMPLETE", + "name": "REGISTRATION_NOT_COMPLETE" + }, + { + "value": "SENDER_ID_ASSOCIATED_TO_POOL", + "name": "SENDER_ID_ASSOCIATED_TO_POOL" + }, { "value": "RESOURCE_ALREADY_EXISTS", "name": "RESOURCE_ALREADY_EXISTS" @@ -525,9 +632,25 @@ "value": "RESOURCE_NOT_EMPTY", "name": "RESOURCE_NOT_EMPTY" }, + { + "value": "SELF_MANAGED_OPT_OUTS_MISMATCH", + "name": "SELF_MANAGED_OPT_OUTS_MISMATCH" + }, + { + "value": "SUBMIT_REGISTRATION_VERSION_NOT_ALLOWED", + "name": "SUBMIT_REGISTRATION_VERSION_NOT_ALLOWED" + }, { "value": "TWO_WAY_CONFIG_MISMATCH", "name": "TWO_WAY_CONFIG_MISMATCH" + }, + { + "value": "VERIFICATION_CODE_EXPIRED", + "name": "VERIFICATION_CODE_EXPIRED" + }, + { + "value": "VERIFICATION_ALREADY_COMPLETE", + "name": "VERIFICATION_ALREADY_COMPLETE" } ] } @@ -563,7 +686,7 @@ "min": 1, "max": 800 }, - "smithy.api#pattern": "^\\S+$" + "smithy.api#pattern": "^(?!\\s)^[\\s\\S]+(?Creates a new configuration set. After you create the configuration set, you can add\n one or more event destinations to it.\nA configuration set is a set of rules that you apply to the SMS and voice messages\n that you send.
\nWhen you send a message, you can optionally specify a single configuration set.
" + "smithy.api#documentation": "Creates a new configuration set. After you create the configuration set, you can add\n one or more event destinations to it.
\nA configuration set is a set of rules that you apply to the SMS and voice messages\n that you send.
\nWhen you send a message, you can optionally specify a single configuration set.
" } }, "com.amazonaws.pinpointsmsvoicev2#CreateConfigurationSetRequest": { @@ -621,6 +744,9 @@ "smithy.api#idempotencyToken": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.pinpointsmsvoicev2#CreateConfigurationSetResult": { @@ -650,6 +776,9 @@ "smithy.api#documentation": "The time when the configuration set was created, in UNIX epoch time format.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.pinpointsmsvoicev2#CreateEventDestination": { @@ -684,7 +813,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new event destination in a configuration set.
\nAn event destination is a location where you send message events. The event options\n are Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS. For example,\n when a message is delivered successfully, you can send information about that event to\n an event destination, or send notifications to endpoints that are subscribed to an\n Amazon SNS topic.
\nEach configuration set can contain between 0 and 5 event destinations. Each event\n destination can contain a reference to a single destination, such as a CloudWatch\n or Kinesis Data Firehose destination.
" + "smithy.api#documentation": "Creates a new event destination in a configuration set.
\nAn event destination is a location where you send message events. The event options\n are Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS. For example,\n when a message is delivered successfully, you can send information about that event to\n an event destination, or send notifications to endpoints that are subscribed to an\n Amazon SNS topic.
\nEach configuration set can contain between 0 and 5 event destinations. Each event\n destination can contain a reference to a single destination, such as a CloudWatch\n or Kinesis Data Firehose destination.
" } }, "com.amazonaws.pinpointsmsvoicev2#CreateEventDestinationRequest": { @@ -707,7 +836,7 @@ "MatchingEventTypes": { "target": "com.amazonaws.pinpointsmsvoicev2#EventTypeList", "traits": { - "smithy.api#documentation": "An array of event types that determine which events to log. If \"ALL\" is used, then\n Amazon Pinpoint logs every event type.
", + "smithy.api#documentation": "An array of event types that determine which events to log. If \"ALL\" is used, then\n Amazon Pinpoint logs every event type.
\nThe TEXT_SENT event type is not supported.
The details of the destination where events are logged.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.pinpointsmsvoicev2#CreateOptOutList": { @@ -790,7 +925,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new opt-out list.
\nIf the opt-out list name already exists, an Error is returned.
\nAn opt-out list is a list of phone numbers that are opted out, meaning you can't send\n SMS or voice messages to them. If end user replies with the keyword \"STOP,\" an entry for\n the phone number is added to the opt-out list. In addition to STOP, your recipients can\n use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported\n opt-out keywords, see \n SMS opt out in the Amazon Pinpoint User\n Guide.
" + "smithy.api#documentation": "Creates a new opt-out list.
\nIf the opt-out list name already exists, an error is returned.
\nAn opt-out list is a list of phone numbers that are opted out, meaning you can't send\n SMS or voice messages to them. If end user replies with the keyword \"STOP,\" an entry for\n the phone number is added to the opt-out list. In addition to STOP, your recipients can\n use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported\n opt-out keywords, see \n SMS opt out in the Amazon Pinpoint User\n Guide.
" } }, "com.amazonaws.pinpointsmsvoicev2#CreateOptOutListRequest": { @@ -816,6 +951,9 @@ "smithy.api#idempotencyToken": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.pinpointsmsvoicev2#CreateOptOutListResult": { @@ -845,6 +983,9 @@ "smithy.api#documentation": "The time when the pool was created, in UNIX epoch time format.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.pinpointsmsvoicev2#CreatePool": { @@ -879,7 +1020,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new pool and associates the specified origination identity to the pool. A\n pool can include one or more phone numbers and SenderIds that are associated with your\n Amazon Web Services account.
\nThe new pool inherits its configuration from the specified origination identity. This\n includes keywords, message type, opt-out list, two-way configuration, and self-managed\n opt-out configuration. Deletion protection isn't inherited from the origination identity\n and defaults to false.
\nIf the origination identity is a phone number and is already associated with another\n pool, an Error is returned. A sender ID can be associated with multiple pools.
" + "smithy.api#documentation": "Creates a new pool and associates the specified origination identity to the pool. A\n pool can include one or more phone numbers and SenderIds that are associated with your\n Amazon Web Services account.
\nThe new pool inherits its configuration from the specified origination identity. This\n includes keywords, message type, opt-out list, two-way configuration, and self-managed\n opt-out configuration. Deletion protection isn't inherited from the origination identity\n and defaults to false.
\nIf the origination identity is a phone number and is already associated with another\n pool, an error is returned. A sender ID can be associated with multiple pools.
" } }, "com.amazonaws.pinpointsmsvoicev2#CreatePoolRequest": { @@ -925,6 +1066,9 @@ "smithy.api#idempotencyToken": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.pinpointsmsvoicev2#CreatePoolResult": { @@ -945,7 +1089,7 @@ "Status": { "target": "com.amazonaws.pinpointsmsvoicev2#PoolStatus", "traits": { - "smithy.api#documentation": "The current status of the pool.
\nCREATING: The pool is currently being created and isn't yet available for\n use.
\nACTIVE: The pool is active and available for use.
\nDELETING: The pool is being deleted.
\nThe current status of the pool.
\nCREATING: The pool is currently being created and isn't yet available for\n use.
\nACTIVE: The pool is active and available for use.
\nDELETING: The pool is being deleted.
\nThe Amazon Resource Name (ARN) of the two way channel.
" } }, + "TwoWayChannelRole": { + "target": "com.amazonaws.pinpointsmsvoicev2#IamRoleArn", + "traits": { + "smithy.api#documentation": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + } + }, "SelfManagedOptOutsEnabled": { "target": "smithy.api#PrimitiveBoolean", "traits": { @@ -1006,25 +1156,31 @@ "smithy.api#documentation": "The time when the pool was created, in UNIX epoch time format.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteConfigurationSet": { + "com.amazonaws.pinpointsmsvoicev2#CreateRegistration": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteConfigurationSetRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteConfigurationSetResult" + "target": "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationResult" }, "errors": [ { "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException" }, { "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" @@ -1034,80 +1190,33 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an existing configuration set.
\nA configuration set is a set of rules that you apply to voice and SMS messages that\n you send. In a configuration set, you can specify a destination for specific types of\n events related to voice and SMS messages.
" - } - }, - "com.amazonaws.pinpointsmsvoicev2#DeleteConfigurationSetRequest": { - "type": "structure", - "members": { - "ConfigurationSetName": { - "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", - "traits": { - "smithy.api#documentation": "The name of the configuration set or the configuration set ARN that you want to\n delete. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#DeleteConfigurationSetResult": { - "type": "structure", - "members": { - "ConfigurationSetArn": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the deleted configuration set.
" - } - }, - "ConfigurationSetName": { - "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetName", - "traits": { - "smithy.api#documentation": "The name of the deleted configuration set.
" - } - }, - "EventDestinations": { - "target": "com.amazonaws.pinpointsmsvoicev2#EventDestinationList", - "traits": { - "smithy.api#documentation": "An array of any EventDestination objects that were associated with the deleted\n configuration set.
" - } - }, - "DefaultMessageType": { - "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", - "traits": { - "smithy.api#documentation": "The default message type of the configuration set that was deleted.
" - } - }, - "DefaultSenderId": { - "target": "com.amazonaws.pinpointsmsvoicev2#SenderId", - "traits": { - "smithy.api#documentation": "The default Sender ID of the configuration set that was deleted.
" - } - }, - "CreatedTimestamp": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "The time that the deleted configuration set was created in UNIX epoch time format.
" - } - } + "smithy.api#documentation": "Creates a new registration based on the RegistrationType field.
" } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultMessageType": { + "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationAssociation": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultMessageTypeRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationAssociationRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultMessageTypeResult" + "target": "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationAssociationResult" }, "errors": [ { "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, { "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" }, @@ -1116,61 +1225,113 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an existing default message type on a configuration set.
\nA message type is a type of messages that you plan to send. If you send\n account-related messages or time-sensitive messages such as one-time passcodes, choose\n Transactional. If you plan to send messages that\n contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services\n account.
" + "smithy.api#documentation": "Associate the registration with an origination identity such as a phone number or sender ID.
" } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultMessageTypeRequest": { + "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationAssociationRequest": { "type": "structure", "members": { - "ConfigurationSetName": { - "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", + "RegistrationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationIdOrArn", "traits": { - "smithy.api#documentation": "The name of the configuration set or the configuration set Amazon Resource Name (ARN)\n to delete the default message type from. The ConfigurationSetName and\n ConfigurationSetArn can be found using the DescribeConfigurationSets\n action.
", + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceIdOrArn", + "traits": { + "smithy.api#documentation": "The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultMessageTypeResult": { + "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationAssociationResult": { "type": "structure", "members": { - "ConfigurationSetArn": { + "RegistrationArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configuration set.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the registration.
", + "smithy.api#required": {} } }, - "ConfigurationSetName": { - "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetName", + "RegistrationId": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The name of the configuration set.
" + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} } }, - "MessageType": { - "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", + "RegistrationType": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationType", "traits": { - "smithy.api#documentation": "The current message type for the configuration set.
" + "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
", + "smithy.api#required": {} + } + }, + "ResourceArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the origination identity that is associated with the registration.
", + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.
", + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The registration type or origination identity type.
", + "smithy.api#required": {} + } + }, + "IsoCountryCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", + "traits": { + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" + } + }, + "PhoneNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "traits": { + "smithy.api#documentation": "The phone number associated with the registration in E.164 format.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultSenderId": { + "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationAttachment": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultSenderIdRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationAttachmentRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultSenderIdResult" + "target": "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationAttachmentResult" }, "errors": [ { "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException" }, { "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" @@ -1180,208 +1341,181 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an existing default sender ID on a configuration set.
\nA default sender ID is the identity that appears on recipients' devices when they\n receive SMS messages. Support for sender ID capabilities varies by country or\n region.
" + "smithy.api#documentation": "Create a new registration attachment to use for uploading a file or a URL to a file. The maximum file size is 1MiB and valid file extensions are PDF, JPEG and PNG. For example, many sender ID registrations require a signed “letter of authorization” (LOA) to be submitted.
" } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultSenderIdRequest": { + "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationAttachmentRequest": { "type": "structure", "members": { - "ConfigurationSetName": { - "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", + "AttachmentBody": { + "target": "com.amazonaws.pinpointsmsvoicev2#AttachmentBody", "traits": { - "smithy.api#documentation": "The name of the configuration set or the configuration set Amazon Resource Name (ARN)\n to delete the default sender ID from. The ConfigurationSetName and ConfigurationSetArn\n can be found using the DescribeConfigurationSets action.
", - "smithy.api#required": {} + "smithy.api#documentation": "The registration file to upload. The maximum file size is 1MiB and valid file extensions are PDF, JPEG and PNG.
" } - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultSenderIdResult": { - "type": "structure", - "members": { - "ConfigurationSetArn": { - "target": "smithy.api#String", + }, + "AttachmentUrl": { + "target": "com.amazonaws.pinpointsmsvoicev2#AttachmentUrl", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configuration set.
" + "smithy.api#documentation": "A URL to the required registration file. For example, you can provide the S3 object URL.
" } }, - "ConfigurationSetName": { - "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetName", + "Tags": { + "target": "com.amazonaws.pinpointsmsvoicev2#TagList", "traits": { - "smithy.api#documentation": "The name of the configuration set.
" + "smithy.api#documentation": "An array of tags (key and value pairs) to associate with the registration attachment.
" } }, - "SenderId": { - "target": "com.amazonaws.pinpointsmsvoicev2#SenderId", + "ClientToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#ClientToken", "traits": { - "smithy.api#documentation": "The current sender ID for the configuration set.
" + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don't specify a client token, a randomly generated token is used for the\n request to ensure idempotency.
", + "smithy.api#idempotencyToken": {} } } - } - }, - "com.amazonaws.pinpointsmsvoicev2#DeleteEventDestination": { - "type": "operation", - "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteEventDestinationRequest" - }, - "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteEventDestinationResult" }, - "errors": [ - { - "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" - } - ], "traits": { - "smithy.api#documentation": "Deletes an existing event destination.
\nAn event destination is a location where you send response information about the\n messages that you send. For example, when a message is delivered successfully, you can\n send information about that event to an Amazon CloudWatch destination, or send\n notifications to endpoints that are subscribed to an Amazon SNS topic.
" + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteEventDestinationRequest": { + "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationAttachmentResult": { "type": "structure", "members": { - "ConfigurationSetName": { - "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", + "RegistrationAttachmentArn": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The name of the configuration set or the configuration set's Amazon Resource Name\n (ARN) to remove the event destination from. The ConfigurateSetName and\n ConfigurationSetArn can be found using the DescribeConfigurationSets\n action.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the registration attachment.
", "smithy.api#required": {} } }, - "EventDestinationName": { - "target": "com.amazonaws.pinpointsmsvoicev2#EventDestinationName", + "RegistrationAttachmentId": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The name of the event destination to delete.
", + "smithy.api#documentation": "The unique identifier for the registration attachment.
", "smithy.api#required": {} } - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#DeleteEventDestinationResult": { - "type": "structure", - "members": { - "ConfigurationSetArn": { - "target": "smithy.api#String", + }, + "AttachmentStatus": { + "target": "com.amazonaws.pinpointsmsvoicev2#AttachmentStatus", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configuration set.
" + "smithy.api#documentation": "The status of the registration attachment.
\n\n UPLOAD_IN_PROGRESS The attachment is being uploaded.
\n UPLOAD_COMPLETE The attachment has been uploaded.
\n UPLOAD_FAILED The attachment failed to uploaded.
\n DELETED The attachment has been deleted..
The name of the configuration set the event destination was deleted from.
" + "smithy.api#documentation": "An array of tags (key and value pairs) to associate with the registration attachment.
" } }, - "EventDestination": { - "target": "com.amazonaws.pinpointsmsvoicev2#EventDestination", + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The event destination object that was deleted.
" + "smithy.api#documentation": "The time when the registration attachment was created, in UNIX epoch time format.
", + "smithy.api#required": {} } } - } - }, - "com.amazonaws.pinpointsmsvoicev2#DeleteKeyword": { - "type": "operation", - "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteKeywordRequest" }, - "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteKeywordResult" - }, - "errors": [ - { - "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" - } - ], "traits": { - "smithy.api#documentation": "Deletes an existing keyword from an origination phone number or pool.
\nA keyword is a word that you can search for on a particular phone number or pool. It\n is also a specific word or phrase that an end user can send to your number to elicit a\n response, such as an informational message or a special offer. When your number receives\n a message that begins with a keyword, Amazon Pinpoint responds with a customizable\n message.
\nKeywords \"HELP\" and \"STOP\" can't be deleted or modified.
" + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteKeywordRequest": { + "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationRequest": { "type": "structure", "members": { - "OriginationIdentity": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneOrPoolIdOrArn", + "RegistrationType": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationType", "traits": { - "smithy.api#documentation": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, PoolId or\n PoolArn. You can use DescribePhoneNumbers to find the values for\n PhoneNumberId and PhoneNumberArn and DescribePools to find the values\n of PoolId and PoolArn.
", + "smithy.api#documentation": "The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
", "smithy.api#required": {} } }, - "Keyword": { - "target": "com.amazonaws.pinpointsmsvoicev2#Keyword", + "Tags": { + "target": "com.amazonaws.pinpointsmsvoicev2#TagList", "traits": { - "smithy.api#documentation": "The keyword to delete.
", - "smithy.api#required": {} + "smithy.api#documentation": "An array of tags (key and value pairs) to associate with the registration.
" + } + }, + "ClientToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#ClientToken", + "traits": { + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don't specify a client token, a randomly generated token is used for the\n request to ensure idempotency.
", + "smithy.api#idempotencyToken": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteKeywordResult": { + "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationResult": { "type": "structure", "members": { - "OriginationIdentityArn": { + "RegistrationArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The PhoneNumberArn or PoolArn that the keyword was associated with.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the registration.
", + "smithy.api#required": {} } }, - "OriginationIdentity": { + "RegistrationId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The PhoneNumberId or PoolId that the keyword was associated with.
" + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} } }, - "Keyword": { - "target": "com.amazonaws.pinpointsmsvoicev2#Keyword", + "RegistrationType": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationType", "traits": { - "smithy.api#documentation": "The keyword that was deleted.
" + "smithy.api#documentation": "The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
", + "smithy.api#required": {} } }, - "KeywordMessage": { - "target": "com.amazonaws.pinpointsmsvoicev2#KeywordMessage", + "RegistrationStatus": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationStatus", "traits": { - "smithy.api#documentation": "The message that was associated with the deleted keyword.
" + "smithy.api#documentation": "The status of the registration.
\n\n CREATED: Your registration is created but not submitted.
\n SUBMITTED: Your registration has been submitted and is awaiting review.
\n REVIEWING: Your registration has been accepted and is being reviewed.
\n PROVISIONING: Your registration has been approved and your origination identity is being created.
\n COMPLETE: Your registration has been approved and and your origination identity has been created.
\n REQUIRES_UPDATES: You must fix your registration and resubmit it.
\n CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number.
\n DELETED: The registration has been deleted.
The action that was associated with the deleted keyword.
" + "smithy.api#documentation": "The current version number of the registration.
", + "smithy.api#required": {} + } + }, + "AdditionalAttributes": { + "target": "com.amazonaws.pinpointsmsvoicev2#StringMap", + "traits": { + "smithy.api#documentation": "Metadata about a given registration which is specific to that registration type.
" + } + }, + "Tags": { + "target": "com.amazonaws.pinpointsmsvoicev2#TagList", + "traits": { + "smithy.api#documentation": "An array of tags (key and value pairs) to associate with the registration.
" + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the registration was created, in UNIX epoch time format.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutList": { + "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationVersion": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutListRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationVersionRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutListResult" + "target": "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationVersionResult" }, "errors": [ { @@ -1396,6 +1530,9 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" }, @@ -1404,51 +1541,74 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are\n deleted.
\nIf the specified opt-out list name doesn't exist or is in-use by an origination phone\n number or pool, an Error is returned.
" + "smithy.api#documentation": "Create a new version of the registration and increase the VersionNumber. The previous version of the registration becomes read-only.
" } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutListRequest": { + "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationVersionRequest": { "type": "structure", "members": { - "OptOutListName": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", + "RegistrationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationIdOrArn", "traits": { - "smithy.api#documentation": "The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and\n OptOutListArn.
", + "smithy.api#documentation": "The unique identifier for the registration.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutListResult": { + "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationVersionResult": { "type": "structure", "members": { - "OptOutListArn": { + "RegistrationArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the OptOutList that was removed.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the registration.
", + "smithy.api#required": {} } }, - "OptOutListName": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", + "RegistrationId": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The name of the OptOutList that was removed.
" + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} } }, - "CreatedTimestamp": { - "target": "smithy.api#Timestamp", + "VersionNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionNumber", "traits": { - "smithy.api#documentation": "The time when the OptOutList was created, in UNIX epoch time format.
" + "smithy.api#documentation": "The new version number of the registration.
", + "smithy.api#required": {} + } + }, + "RegistrationVersionStatus": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionStatus", + "traits": { + "smithy.api#documentation": "The status of the registration.
\n\n DRAFT: The initial status of a registration version after it’s created.
\n SUBMITTED: Your registration has been submitted.
\n REVIEWING: Your registration has been accepted and is being reviewed.
\n APPROVED: Your registration has been approved.
\n DISCARDED: You've abandon this version of their registration to start over with a new version.
\n DENIED: You must fix your registration and resubmit it.
\n REVOKED: Your previously approved registration has been revoked.
\n ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.
A RegistrationVersionStatusHistory object that contains timestamps for the registration.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteOptedOutNumber": { + "com.amazonaws.pinpointsmsvoicev2#CreateVerifiedDestinationNumber": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteOptedOutNumberRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#CreateVerifiedDestinationNumberRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteOptedOutNumberResult" + "target": "com.amazonaws.pinpointsmsvoicev2#CreateVerifiedDestinationNumberResult" }, "errors": [ { @@ -1461,7 +1621,7 @@ "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException" }, { "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" @@ -1471,79 +1631,98 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an existing opted out destination phone number from the specified opt-out\n list.
\nEach destination phone number can only be deleted once every 30 days.
\nIf the specified destination phone number doesn't exist or if the opt-out list doesn't\n exist, an Error is returned.
" + "smithy.api#documentation": "You can only send messages to verified destination numbers when your account is in the sandbox. You can add up to 10 verified destination\n numbers.
" } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteOptedOutNumberRequest": { + "com.amazonaws.pinpointsmsvoicev2#CreateVerifiedDestinationNumberRequest": { "type": "structure", "members": { - "OptOutListName": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", + "DestinationPhoneNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", "traits": { - "smithy.api#documentation": "The OptOutListName or OptOutListArn to remove the phone number from.
", + "smithy.api#documentation": "The verified destination phone number, in E.164 format.
", "smithy.api#required": {} } }, - "OptedOutNumber": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "Tags": { + "target": "com.amazonaws.pinpointsmsvoicev2#TagList", "traits": { - "smithy.api#documentation": "The phone number, in E.164 format, to remove from the OptOutList.
", - "smithy.api#required": {} + "smithy.api#documentation": "An array of tags (key and value pairs) to associate with the destination number.
" + } + }, + "ClientToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#ClientToken", + "traits": { + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don't specify a client token, a randomly generated token is used for the\n request to ensure idempotency.
", + "smithy.api#idempotencyToken": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteOptedOutNumberResult": { + "com.amazonaws.pinpointsmsvoicev2#CreateVerifiedDestinationNumberResult": { "type": "structure", "members": { - "OptOutListArn": { + "VerifiedDestinationNumberArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The OptOutListArn that the phone number was removed from.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the verified destination phone number.
", + "smithy.api#required": {} } }, - "OptOutListName": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", + "VerifiedDestinationNumberId": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The OptOutListName that the phone number was removed from.
" + "smithy.api#documentation": "The unique identifier for the verified destination phone number.
", + "smithy.api#required": {} } }, - "OptedOutNumber": { + "DestinationPhoneNumber": { "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", "traits": { - "smithy.api#documentation": "The phone number that was removed from the OptOutList.
" + "smithy.api#documentation": "The verified destination phone number, in E.164 format.
", + "smithy.api#required": {} } }, - "OptedOutTimestamp": { - "target": "smithy.api#Timestamp", + "Status": { + "target": "com.amazonaws.pinpointsmsvoicev2#VerificationStatus", "traits": { - "smithy.api#documentation": "The time that the number was removed at, in UNIX epoch time format.
" + "smithy.api#documentation": "The status of the verified destination phone number.
\n\n PENDING: The phone number hasn't been verified yet.
\n VERIFIED: The phone number is verified and can receive messages.
This is true if it was the end user who requested their phone number be removed.\n
" + "smithy.api#documentation": "An array of tags (key and value pairs) to associate with the destination number.
" + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the verified phone number was created, in UNIX epoch time format.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DeletePool": { + "com.amazonaws.pinpointsmsvoicev2#DeleteConfigurationSet": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeletePoolRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteConfigurationSetRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeletePoolResult" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteConfigurationSetResult" }, "errors": [ { "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" - }, { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, @@ -1558,96 +1737,75 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an existing pool. Deleting a pool disassociates all origination identities\n from that pool.
\nIf the pool status isn't active or if deletion protection is enabled, an Error is\n returned.
\nA pool is a collection of phone numbers and SenderIds. A pool can include one or more\n phone numbers and SenderIds that are associated with your Amazon Web Services\n account.
" + "smithy.api#documentation": "Deletes an existing configuration set.
\nA configuration set is a set of rules that you apply to voice and SMS messages that\n you send. In a configuration set, you can specify a destination for specific types of\n events related to voice and SMS messages.
" } }, - "com.amazonaws.pinpointsmsvoicev2#DeletePoolRequest": { + "com.amazonaws.pinpointsmsvoicev2#DeleteConfigurationSetRequest": { "type": "structure", "members": { - "PoolId": { - "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn", + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", "traits": { - "smithy.api#documentation": "The PoolId or PoolArn of the pool to delete. You can use DescribePools to find the values for PoolId and PoolArn .
", + "smithy.api#documentation": "The name of the configuration set or the configuration set ARN that you want to\n delete. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DeletePoolResult": { + "com.amazonaws.pinpointsmsvoicev2#DeleteConfigurationSetResult": { "type": "structure", "members": { - "PoolArn": { + "ConfigurationSetArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pool that was deleted.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the deleted configuration set.
" } }, - "PoolId": { - "target": "smithy.api#String", + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetName", "traits": { - "smithy.api#documentation": "The PoolId of the pool that was deleted.
" + "smithy.api#documentation": "The name of the deleted configuration set.
" } }, - "Status": { - "target": "com.amazonaws.pinpointsmsvoicev2#PoolStatus", + "EventDestinations": { + "target": "com.amazonaws.pinpointsmsvoicev2#EventDestinationList", "traits": { - "smithy.api#documentation": "The current status of the pool.
\nCREATING: The pool is currently being created and isn't yet available for\n use.
\nACTIVE: The pool is active and available for use.
\nDELETING: The pool is being deleted.
\nAn array of any EventDestination objects that were associated with the deleted\n configuration set.
" } }, - "MessageType": { + "DefaultMessageType": { "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", "traits": { - "smithy.api#documentation": "The message type that was associated with the deleted pool.
" - } - }, - "TwoWayEnabled": { - "target": "smithy.api#PrimitiveBoolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients.
" - } - }, - "TwoWayChannelArn": { - "target": "com.amazonaws.pinpointsmsvoicev2#TwoWayChannelArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the TwoWayChannel.
" - } - }, - "SelfManagedOptOutsEnabled": { - "target": "smithy.api#PrimitiveBoolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins\n with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically\n replies with a customizable message and adds the end recipient to the OptOutList. When\n set to true you're responsible for responding to HELP and STOP requests. You're also\n responsible for tracking and honoring opt-out requests.
" - } - }, - "OptOutListName": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", - "traits": { - "smithy.api#documentation": "The name of the OptOutList that was associated with the deleted pool.
" + "smithy.api#documentation": "The default message type of the configuration set that was deleted.
" } }, - "SharedRoutesEnabled": { - "target": "smithy.api#PrimitiveBoolean", + "DefaultSenderId": { + "target": "com.amazonaws.pinpointsmsvoicev2#SenderId", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Indicates whether shared routes are enabled for the pool.
" + "smithy.api#documentation": "The default Sender ID of the configuration set that was deleted.
" } }, "CreatedTimestamp": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time when the pool was created, in UNIX epoch time format.
" + "smithy.api#documentation": "The time that the deleted configuration set was created in UNIX epoch time format.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteTextMessageSpendLimitOverride": { + "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultMessageType": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteTextMessageSpendLimitOverrideRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultMessageTypeRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteTextMessageSpendLimitOverrideResult" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultMessageTypeResult" }, "errors": [ { @@ -1656,6 +1814,9 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" }, @@ -1664,82 +1825,57 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an account-level monthly spending limit override for sending text messages.\n Deleting a spend limit override will set the EnforcedLimit to equal the\n MaxLimit, which is controlled by Amazon Web Services. For more\n information on spend limits (quotas) see Amazon Pinpoint quotas \n in the Amazon Pinpoint Developer Guide.
Deletes an existing default message type on a configuration set.
\nA message type is a type of messages that you plan to send. If you send\n account-related messages or time-sensitive messages such as one-time passcodes, choose\n Transactional. If you plan to send messages that\n contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services\n account.
" } }, - "com.amazonaws.pinpointsmsvoicev2#DeleteTextMessageSpendLimitOverrideRequest": { - "type": "structure", - "members": {} - }, - "com.amazonaws.pinpointsmsvoicev2#DeleteTextMessageSpendLimitOverrideResult": { + "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultMessageTypeRequest": { "type": "structure", "members": { - "MonthlyLimit": { - "target": "com.amazonaws.pinpointsmsvoicev2#MonthlyLimit", + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", "traits": { - "smithy.api#documentation": "The current monthly limit, in US dollars.
" + "smithy.api#documentation": "The name of the configuration set or the configuration set Amazon Resource Name (ARN)\n to delete the default message type from. The ConfigurationSetName and\n ConfigurationSetArn can be found using the DescribeConfigurationSets\n action.
", + "smithy.api#required": {} } } - } - }, - "com.amazonaws.pinpointsmsvoicev2#DeleteVoiceMessageSpendLimitOverride": { - "type": "operation", - "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteVoiceMessageSpendLimitOverrideRequest" - }, - "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteVoiceMessageSpendLimitOverrideResult" }, - "errors": [ - { - "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" - } - ], "traits": { - "smithy.api#documentation": "Deletes an account level monthly spend limit override for sending voice messages.\n Deleting a spend limit override sets the EnforcedLimit equal to the\n MaxLimit, which is controlled by Amazon Web Services. For more\n information on spending limits (quotas) see Amazon Pinpoint quotas\n in the Amazon Pinpoint Developer Guide.
The current monthly limit, in US dollars.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configuration set.
" + } + }, + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetName", + "traits": { + "smithy.api#documentation": "The name of the configuration set.
" + } + }, + "MessageType": { + "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", + "traits": { + "smithy.api#documentation": "The current message type for the configuration set.
" } } - } - }, - "com.amazonaws.pinpointsmsvoicev2#DeliveryStreamArn": { - "type": "string", + }, "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:\\S+$" + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeAccountAttributes": { + "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultSenderId": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeAccountAttributesRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultSenderIdRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeAccountAttributesResult" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultSenderIdResult" }, "errors": [ { @@ -1748,6 +1884,9 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" }, @@ -1756,53 +1895,57 @@ } ], "traits": { - "smithy.api#documentation": "Describes attributes of your Amazon Web Services account. The supported account\n attributes include account tier, which indicates whether your account is in the sandbox\n or production environment. When you're ready to move your account out of the sandbox,\n create an Amazon Web Services Support case for a service limit increase request.
\nNew Amazon Pinpoint accounts are placed into an SMS or voice sandbox. The sandbox\n protects both Amazon Web Services end recipients and SMS or voice recipients from fraud\n and abuse.
", - "smithy.api#paginated": { - "items": "AccountAttributes" - } + "smithy.api#documentation": "Deletes an existing default sender ID on a configuration set.
\nA default sender ID is the identity that appears on recipients' devices when they\n receive SMS messages. Support for sender ID capabilities varies by country or\n region.
" } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeAccountAttributesRequest": { + "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultSenderIdRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", - "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", "traits": { - "smithy.api#documentation": "The maximum number of results to return per each request.
" + "smithy.api#documentation": "The name of the configuration set or the configuration set Amazon Resource Name (ARN)\n to delete the default sender ID from. The ConfigurationSetName and ConfigurationSetArn\n can be found using the DescribeConfigurationSets action.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeAccountAttributesResult": { + "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultSenderIdResult": { "type": "structure", "members": { - "AccountAttributes": { - "target": "com.amazonaws.pinpointsmsvoicev2#AccountAttributeList", + "ConfigurationSetArn": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "An array of AccountAttributes objects.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configuration set.
" } }, - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetName", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" + "smithy.api#documentation": "The name of the configuration set.
" + } + }, + "SenderId": { + "target": "com.amazonaws.pinpointsmsvoicev2#SenderId", + "traits": { + "smithy.api#documentation": "The current sender ID for the configuration set.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeAccountLimits": { + "com.amazonaws.pinpointsmsvoicev2#DeleteEventDestination": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeAccountLimitsRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteEventDestinationRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeAccountLimitsResult" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteEventDestinationResult" }, "errors": [ { @@ -1811,6 +1954,9 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" }, @@ -1819,58 +1965,72 @@ } ], "traits": { - "smithy.api#documentation": "Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your\n account. The description for a quota includes the quota name, current usage toward that\n quota, and the quota's maximum value.
\nWhen you establish an Amazon Web Services account, the account has initial quotas on\n the maximum number of configuration sets, opt-out lists, phone numbers, and pools that\n you can create in a given Region. For more information see \n Amazon Pinpoint quotas in the Amazon Pinpoint Developer\n Guide.
", - "smithy.api#paginated": { - "items": "AccountLimits" - } + "smithy.api#documentation": "Deletes an existing event destination.
\nAn event destination is a location where you send response information about the\n messages that you send. For example, when a message is delivered successfully, you can\n send information about that event to an Amazon CloudWatch destination, or send\n notifications to endpoints that are subscribed to an Amazon SNS topic.
" } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeAccountLimitsRequest": { + "com.amazonaws.pinpointsmsvoicev2#DeleteEventDestinationRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The name of the configuration set or the configuration set's Amazon Resource Name\n (ARN) to remove the event destination from. The ConfigurateSetName and\n ConfigurationSetArn can be found using the DescribeConfigurationSets\n action.
", + "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "EventDestinationName": { + "target": "com.amazonaws.pinpointsmsvoicev2#EventDestinationName", "traits": { - "smithy.api#documentation": "The maximum number of results to return per each request.
" + "smithy.api#documentation": "The name of the event destination to delete.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeAccountLimitsResult": { + "com.amazonaws.pinpointsmsvoicev2#DeleteEventDestinationResult": { "type": "structure", "members": { - "AccountLimits": { - "target": "com.amazonaws.pinpointsmsvoicev2#AccountLimitList", + "ConfigurationSetArn": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "An array of AccountLimit objects that show the current spend limits.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configuration set.
" } }, - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetName", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" + "smithy.api#documentation": "The name of the configuration set the event destination was deleted from.
" + } + }, + "EventDestination": { + "target": "com.amazonaws.pinpointsmsvoicev2#EventDestination", + "traits": { + "smithy.api#documentation": "The event destination object that was deleted.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeConfigurationSets": { + "com.amazonaws.pinpointsmsvoicev2#DeleteKeyword": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeConfigurationSetsRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteKeywordRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeConfigurationSetsResult" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteKeywordResult" }, "errors": [ { "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, @@ -1885,70 +2045,84 @@ } ], "traits": { - "smithy.api#documentation": "Describes the specified configuration sets or all in your account.
\nIf you specify configuration set names, the output includes information for only the\n specified configuration sets. If you specify filters, the output includes information\n for only those configuration sets that meet the filter criteria. If you don't specify\n configuration set names or filters, the output includes information for all\n configuration sets.
\nIf you specify a configuration set name that isn't valid, an error is returned.
", - "smithy.api#paginated": { - "items": "ConfigurationSets" - } + "smithy.api#documentation": "Deletes an existing keyword from an origination phone number or pool.
\nA keyword is a word that you can search for on a particular phone number or pool. It\n is also a specific word or phrase that an end user can send to your number to elicit a\n response, such as an informational message or a special offer. When your number receives\n a message that begins with a keyword, Amazon Pinpoint responds with a customizable\n message.
\nKeywords \"HELP\" and \"STOP\" can't be deleted or modified.
" } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeConfigurationSetsRequest": { + "com.amazonaws.pinpointsmsvoicev2#DeleteKeywordRequest": { "type": "structure", "members": { - "ConfigurationSetNames": { - "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameList", + "OriginationIdentity": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneOrPoolIdOrArn", "traits": { - "smithy.api#documentation": "An array of strings. Each element can be either a ConfigurationSetName or\n ConfigurationSetArn.
" + "smithy.api#documentation": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, PoolId or\n PoolArn. You can use DescribePhoneNumbers to find the values for\n PhoneNumberId and PhoneNumberArn and DescribePools to find the values\n of PoolId and PoolArn.
", + "smithy.api#required": {} } }, - "Filters": { - "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetFilterList", + "Keyword": { + "target": "com.amazonaws.pinpointsmsvoicev2#Keyword", "traits": { - "smithy.api#documentation": "An array of filters to apply to the results that are returned.
" + "smithy.api#documentation": "The keyword to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DeleteKeywordResult": { + "type": "structure", + "members": { + "OriginationIdentityArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The PhoneNumberArn or PoolArn that the keyword was associated with.
" } }, - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "OriginationIdentity": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The PhoneNumberId or PoolId that the keyword was associated with.
" } }, - "MaxResults": { - "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "Keyword": { + "target": "com.amazonaws.pinpointsmsvoicev2#Keyword", "traits": { - "smithy.api#documentation": "The maximum number of results to return per each request.
" + "smithy.api#documentation": "The keyword that was deleted.
" } - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#DescribeConfigurationSetsResult": { - "type": "structure", - "members": { - "ConfigurationSets": { - "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetInformationList", + }, + "KeywordMessage": { + "target": "com.amazonaws.pinpointsmsvoicev2#KeywordMessage", "traits": { - "smithy.api#documentation": "An array of ConfigurationSets objects.
" + "smithy.api#documentation": "The message that was associated with the deleted keyword.
" } }, - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "KeywordAction": { + "target": "com.amazonaws.pinpointsmsvoicev2#KeywordAction", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" + "smithy.api#documentation": "The action that was associated with the deleted keyword.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeKeywords": { + "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutList": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeKeywordsRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutListRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeKeywordsResult" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutListResult" }, "errors": [ { "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, @@ -1963,89 +2137,65 @@ } ], "traits": { - "smithy.api#documentation": "Describes the specified keywords or all keywords on your origination phone number or\n pool.
\nA keyword is a word that you can search for on a particular phone number or pool. It\n is also a specific word or phrase that an end user can send to your number to elicit a\n response, such as an informational message or a special offer. When your number receives\n a message that begins with a keyword, Amazon Pinpoint responds with a customizable\n message.
\nIf you specify a keyword that isn't valid, an Error is returned.
", - "smithy.api#paginated": { - "items": "Keywords" - } + "smithy.api#documentation": "Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are\n deleted.
\nIf the specified opt-out list name doesn't exist or is in-use by an origination phone\n number or pool, an error is returned.
" } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeKeywordsRequest": { + "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutListRequest": { "type": "structure", "members": { - "OriginationIdentity": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneOrPoolIdOrArn", + "OptOutListName": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", "traits": { - "smithy.api#documentation": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers to find the values for\n PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used\n to get the values for SenderId and SenderIdArn.
", + "smithy.api#documentation": "The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and\n OptOutListArn.
", "smithy.api#required": {} } - }, - "Keywords": { - "target": "com.amazonaws.pinpointsmsvoicev2#KeywordList", - "traits": { - "smithy.api#documentation": "An array of keywords to search for.
" - } - }, - "Filters": { - "target": "com.amazonaws.pinpointsmsvoicev2#KeywordFilterList", - "traits": { - "smithy.api#documentation": "An array of keyword filters to filter the results.
" - } - }, - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", - "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results to return per each request.
" - } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeKeywordsResult": { + "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutListResult": { "type": "structure", "members": { - "OriginationIdentityArn": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The PhoneNumberArn or PoolArn that is associated with the OriginationIdentity.
" - } - }, - "OriginationIdentity": { + "OptOutListArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The PhoneNumberId or PoolId that is associated with the OriginationIdentity.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the OptOutList that was removed.
" } }, - "Keywords": { - "target": "com.amazonaws.pinpointsmsvoicev2#KeywordInformationList", + "OptOutListName": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", "traits": { - "smithy.api#documentation": "An array of KeywordInformation objects that contain the results.
" + "smithy.api#documentation": "The name of the OptOutList that was removed.
" } }, - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" + "smithy.api#documentation": "The time when the OptOutList was created, in UNIX epoch time format.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeOptOutLists": { + "com.amazonaws.pinpointsmsvoicev2#DeleteOptedOutNumber": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeOptOutListsRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteOptedOutNumberRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeOptOutListsResult" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteOptedOutNumberResult" }, "errors": [ { "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, @@ -2060,64 +2210,85 @@ } ], "traits": { - "smithy.api#documentation": "Describes the specified opt-out list or all opt-out lists in your account.
\nIf you specify opt-out list names, the output includes information for only the\n specified opt-out lists. Opt-out lists include only those that meet the filter criteria.\n If you don't specify opt-out list names or filters, the output includes information for\n all opt-out lists.
\nIf you specify an opt-out list name that isn't valid, an Error is returned.
", - "smithy.api#paginated": { - "items": "OptOutLists" - } + "smithy.api#documentation": "Deletes an existing opted out destination phone number from the specified opt-out\n list.
\nEach destination phone number can only be deleted once every 30 days.
\nIf the specified destination phone number doesn't exist or if the opt-out list doesn't\n exist, an error is returned.
" } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeOptOutListsRequest": { + "com.amazonaws.pinpointsmsvoicev2#DeleteOptedOutNumberRequest": { "type": "structure", "members": { - "OptOutListNames": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameList", - "traits": { - "smithy.api#documentation": "The OptOutLists to show the details of. This is an array of strings that can be either\n the OptOutListName or OptOutListArn.
" - } - }, - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "OptOutListName": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The OptOutListName or OptOutListArn to remove the phone number from.
", + "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "OptedOutNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", "traits": { - "smithy.api#documentation": "The maximum number of results to return per each request.
" + "smithy.api#documentation": "The phone number, in E.164 format, to remove from the OptOutList.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeOptOutListsResult": { + "com.amazonaws.pinpointsmsvoicev2#DeleteOptedOutNumberResult": { "type": "structure", "members": { - "OptOutLists": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListInformationList", + "OptOutListArn": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "An array of OptOutListInformation objects that contain the details for the requested\n OptOutLists.
" + "smithy.api#documentation": "The OptOutListArn that the phone number was removed from.
" } }, - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "OptOutListName": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" + "smithy.api#documentation": "The OptOutListName that the phone number was removed from.
" + } + }, + "OptedOutNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "traits": { + "smithy.api#documentation": "The phone number that was removed from the OptOutList.
" + } + }, + "OptedOutTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the number was removed at, in UNIX epoch time format.
" + } + }, + "EndUserOptedOut": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "This is true if it was the end user who requested their phone number be removed.\n
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeOptedOutNumbers": { + "com.amazonaws.pinpointsmsvoicev2#DeletePool": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeOptedOutNumbersRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#DeletePoolRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeOptedOutNumbersResult" + "target": "com.amazonaws.pinpointsmsvoicev2#DeletePoolResult" }, "errors": [ { "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, @@ -2132,89 +2303,116 @@ } ], "traits": { - "smithy.api#documentation": "Describes the specified opted out destination numbers or all opted out destination\n numbers in an opt-out list.
\nIf you specify opted out numbers, the output includes information for only the\n specified opted out numbers. If you specify filters, the output includes information for\n only those opted out numbers that meet the filter criteria. If you don't specify opted\n out numbers or filters, the output includes information for all opted out destination\n numbers in your opt-out list.
\nIf you specify an opted out number that isn't valid, an Error is returned.
", - "smithy.api#paginated": { - "items": "OptedOutNumbers" - } + "smithy.api#documentation": "Deletes an existing pool. Deleting a pool disassociates all origination identities\n from that pool.
\nIf the pool status isn't active or if deletion protection is enabled, an error is\n returned.
\nA pool is a collection of phone numbers and SenderIds. A pool can include one or more\n phone numbers and SenderIds that are associated with your Amazon Web Services\n account.
" } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeOptedOutNumbersRequest": { + "com.amazonaws.pinpointsmsvoicev2#DeletePoolRequest": { "type": "structure", "members": { - "OptOutListName": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", + "PoolId": { + "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn", "traits": { - "smithy.api#documentation": "The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and\n OptOutListArn.
", + "smithy.api#documentation": "The PoolId or PoolArn of the pool to delete. You can use DescribePools to find the values for PoolId and PoolArn .
", "smithy.api#required": {} } - }, - "OptedOutNumbers": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptedOutNumberList", + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DeletePoolResult": { + "type": "structure", + "members": { + "PoolArn": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "An array of phone numbers to search for in the OptOutList.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pool that was deleted.
" } }, - "Filters": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptedOutFilterList", + "PoolId": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "An array of OptedOutFilter objects to filter the results on.
" + "smithy.api#documentation": "The PoolId of the pool that was deleted.
" } }, - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "Status": { + "target": "com.amazonaws.pinpointsmsvoicev2#PoolStatus", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The current status of the pool.
\nCREATING: The pool is currently being created and isn't yet available for\n use.
\nACTIVE: The pool is active and available for use.
\nDELETING: The pool is being deleted.
\nThe maximum number of results to return per each request.
" + "smithy.api#documentation": "The message type that was associated with the deleted pool.
" } - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#DescribeOptedOutNumbersResult": { - "type": "structure", - "members": { - "OptOutListArn": { - "target": "smithy.api#String", + }, + "TwoWayEnabled": { + "target": "smithy.api#PrimitiveBoolean", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the OptOutList.
" + "smithy.api#default": false, + "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients.
" + } + }, + "TwoWayChannelArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#TwoWayChannelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the TwoWayChannel.
" + } + }, + "TwoWayChannelRole": { + "target": "com.amazonaws.pinpointsmsvoicev2#IamRoleArn", + "traits": { + "smithy.api#documentation": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + } + }, + "SelfManagedOptOutsEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins\n with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically\n replies with a customizable message and adds the end recipient to the OptOutList. When\n set to true you're responsible for responding to HELP and STOP requests. You're also\n responsible for tracking and honoring opt-out requests.
" } }, "OptOutListName": { "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", "traits": { - "smithy.api#documentation": "The name of the OptOutList.
" + "smithy.api#documentation": "The name of the OptOutList that was associated with the deleted pool.
" } }, - "OptedOutNumbers": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptedOutNumberInformationList", + "SharedRoutesEnabled": { + "target": "smithy.api#PrimitiveBoolean", "traits": { - "smithy.api#documentation": "An array of OptedOutNumbersInformation objects that provide information about the\n requested OptedOutNumbers.
" + "smithy.api#default": false, + "smithy.api#documentation": "Indicates whether shared routes are enabled for the pool.
" } }, - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" + "smithy.api#documentation": "The time when the pool was created, in UNIX epoch time format.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DescribePhoneNumbers": { + "com.amazonaws.pinpointsmsvoicev2#DeleteRegistration": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribePhoneNumbersRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteRegistrationRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribePhoneNumbersResult" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteRegistrationResult" }, "errors": [ { "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, @@ -2229,70 +2427,24 @@ } ], "traits": { - "smithy.api#documentation": "Describes the specified origination phone number, or all the phone numbers in your\n account.
\nIf you specify phone number IDs, the output includes information for only the\n specified phone numbers. If you specify filters, the output includes information for\n only those phone numbers that meet the filter criteria. If you don't specify phone\n number IDs or filters, the output includes information for all phone numbers.
\nIf you specify a phone number ID that isn't valid, an Error is returned.
", - "smithy.api#paginated": { - "items": "PhoneNumbers" - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#DescribePhoneNumbersRequest": { - "type": "structure", - "members": { - "PhoneNumberIds": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberIdList", - "traits": { - "smithy.api#documentation": "The unique identifier of phone numbers to find information about. This is an array of\n strings that can be either the PhoneNumberId or PhoneNumberArn.
" - } - }, - "Filters": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberFilterList", - "traits": { - "smithy.api#documentation": "An array of PhoneNumberFilter objects to filter the results.
" - } - }, - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", - "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results to return per each request.
" - } - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#DescribePhoneNumbersResult": { - "type": "structure", - "members": { - "PhoneNumbers": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberInformationList", - "traits": { - "smithy.api#documentation": "An array of PhoneNumberInformation objects that contain the details for the requested\n phone numbers.
" - } - }, - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", - "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" - } - } + "smithy.api#documentation": "Permanently delete an existing registration from your account.
" } }, - "com.amazonaws.pinpointsmsvoicev2#DescribePools": { + "com.amazonaws.pinpointsmsvoicev2#DeleteRegistrationAttachment": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribePoolsRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteRegistrationAttachmentRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribePoolsResult" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteRegistrationAttachmentResult" }, "errors": [ { "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, @@ -2307,70 +2459,81 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the specified pools or all pools associated with your Amazon Web Services\n account.
\nIf you specify pool IDs, the output includes information for only the specified pools.\n If you specify filters, the output includes information for only those pools that meet\n the filter criteria. If you don't specify pool IDs or filters, the output includes\n information for all pools.
\nIf you specify a pool ID that isn't valid, an Error is returned.
\nA pool is a collection of phone numbers and SenderIds. A pool can include one or more\n phone numbers and SenderIds that are associated with your Amazon Web Services\n account.
", - "smithy.api#paginated": { - "items": "Pools" - } + "smithy.api#documentation": "Permanently delete the specified registration attachment.
" } }, - "com.amazonaws.pinpointsmsvoicev2#DescribePoolsRequest": { + "com.amazonaws.pinpointsmsvoicev2#DeleteRegistrationAttachmentRequest": { "type": "structure", "members": { - "PoolIds": { - "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdList", + "RegistrationAttachmentId": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationAttachmentIdOrArn", "traits": { - "smithy.api#documentation": "The unique identifier of pools to find. This is an array of strings that can be either\n the PoolId or PoolArn.
" + "smithy.api#documentation": "The unique identifier for the registration attachment.
", + "smithy.api#required": {} } - }, - "Filters": { - "target": "com.amazonaws.pinpointsmsvoicev2#PoolFilterList", + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DeleteRegistrationAttachmentResult": { + "type": "structure", + "members": { + "RegistrationAttachmentArn": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "An array of PoolFilter objects to filter the results.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the registration attachment.
", + "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "RegistrationAttachmentId": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The unique identifier for the registration attachment.
", + "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "AttachmentStatus": { + "target": "com.amazonaws.pinpointsmsvoicev2#AttachmentStatus", "traits": { - "smithy.api#documentation": "The maximum number of results to return per each request.
" + "smithy.api#documentation": "The status of the registration attachment.
\n\n UPLOAD_IN_PROGRESS The attachment is being uploaded.
\n UPLOAD_COMPLETE The attachment has been uploaded.
\n UPLOAD_FAILED The attachment failed to uploaded.
\n DELETED The attachment has been deleted..
An array of PoolInformation objects that contain the details for the requested pools.
" + "smithy.api#documentation": "The error message if the upload failed.
" } }, - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" + "smithy.api#documentation": "The time when the registration attachment was created, in UNIX epoch time format.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeSenderIds": { + "com.amazonaws.pinpointsmsvoicev2#DeleteRegistrationFieldValue": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeSenderIdsRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteRegistrationFieldValueRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeSenderIdsResult" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteRegistrationFieldValueResult" }, "errors": [ { "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, @@ -2385,167 +2548,222 @@ } ], "traits": { - "smithy.api#documentation": "Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.
\nIf you specify SenderIds, the output includes information for only the specified\n SenderIds. If you specify filters, the output includes information for only those\n SenderIds that meet the filter criteria. If you don't specify SenderIds or filters, the\n output includes information for all SenderIds.
\nf you specify a sender ID that isn't valid, an Error is returned.
", - "smithy.api#paginated": { - "items": "SenderIds" - } + "smithy.api#documentation": "Delete the value in a registration form field.
" } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeSenderIdsRequest": { + "com.amazonaws.pinpointsmsvoicev2#DeleteRegistrationFieldValueRequest": { "type": "structure", "members": { - "SenderIds": { - "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdList", - "traits": { - "smithy.api#documentation": "An array of SenderIdAndCountry objects to search for.
" - } - }, - "Filters": { - "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdFilterList", - "traits": { - "smithy.api#documentation": "An array of SenderIdFilter objects to filter the results.
" - } - }, - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "RegistrationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationIdOrArn", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "FieldPath": { + "target": "com.amazonaws.pinpointsmsvoicev2#FieldPath", "traits": { - "smithy.api#documentation": "The maximum number of results to return per each request.
" + "smithy.api#documentation": "The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeSenderIdsResult": { + "com.amazonaws.pinpointsmsvoicev2#DeleteRegistrationFieldValueResult": { "type": "structure", "members": { - "SenderIds": { - "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdInformationList", + "RegistrationArn": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "An array of SernderIdInformation objects that contain the details for the requested\n SenderIds.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the registration.
", + "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "RegistrationId": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} } - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#DescribeSpendLimits": { - "type": "operation", - "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeSpendLimitsRequest" - }, - "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeSpendLimitsResult" - }, - "errors": [ - { - "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + "VersionNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionNumber", + "traits": { + "smithy.api#documentation": "The version number of the registration.
", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + "FieldPath": { + "target": "com.amazonaws.pinpointsmsvoicev2#FieldPath", + "traits": { + "smithy.api#documentation": "The path to the registration form field.
", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Describes the current Amazon Pinpoint monthly spend limits for sending voice and\n text messages.
\nWhen you establish an Amazon Web Services account, the account has initial monthly\n spend limit in a given Region. For more information on increasing your monthly spend\n limit, see \n Requesting increases to your monthly SMS spending quota for Amazon Pinpoint\n in the Amazon Pinpoint User Guide.
", - "smithy.api#paginated": { - "items": "SpendLimits" - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#DescribeSpendLimitsRequest": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "SelectChoices": { + "target": "com.amazonaws.pinpointsmsvoicev2#SelectChoiceList", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "An array of values for the form field.
" } }, - "MaxResults": { - "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "TextValue": { + "target": "com.amazonaws.pinpointsmsvoicev2#TextValue", "traits": { - "smithy.api#documentation": "The maximum number of results to return per each request.
" + "smithy.api#documentation": "The text data for a free form field.
" + } + }, + "RegistrationAttachmentId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration attachment.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DescribeSpendLimitsResult": { + "com.amazonaws.pinpointsmsvoicev2#DeleteRegistrationRequest": { "type": "structure", "members": { - "SpendLimits": { - "target": "com.amazonaws.pinpointsmsvoicev2#SpendLimitList", + "RegistrationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationIdOrArn", "traits": { - "smithy.api#documentation": "An array of SpendLimit objects that contain the details for the requested spend\n limits.
" + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DeleteRegistrationResult": { + "type": "structure", + "members": { + "RegistrationArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the registration.
", + "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "RegistrationId": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} + } + }, + "RegistrationType": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationType", + "traits": { + "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
", + "smithy.api#required": {} + } + }, + "RegistrationStatus": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationStatus", + "traits": { + "smithy.api#documentation": "The status of the registration.
\n\n CREATED: Your registration is created but not submitted.
\n SUBMITTED: Your registration has been submitted and is awaiting review.
\n REVIEWING: Your registration has been accepted and is being reviewed.
\n PROVISIONING: Your registration has been approved and your origination identity is being created.
\n COMPLETE: Your registration has been approved and and your origination identity has been created.
\n REQUIRES_UPDATES: You must fix your registration and resubmit it.
\n CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number.
\n DELETED: The registration has been deleted.
The current version number of the registration.
", + "smithy.api#required": {} + } + }, + "ApprovedVersionNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionNumber", + "traits": { + "smithy.api#documentation": "The version number of the registration that was approved.
" + } + }, + "LatestDeniedVersionNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionNumber", + "traits": { + "smithy.api#documentation": "The latest version number of the registration that was denied.
" + } + }, + "AdditionalAttributes": { + "target": "com.amazonaws.pinpointsmsvoicev2#StringMap", + "traits": { + "smithy.api#documentation": "Metadata about a given registration which is specific to that registration type.
" + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the registration was created, in UNIX epoch time format.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DestinationCountryParameterKey": { - "type": "string", + "com.amazonaws.pinpointsmsvoicev2#DeleteTextMessageSpendLimitOverride": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteTextMessageSpendLimitOverrideRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteTextMessageSpendLimitOverrideResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], "traits": { - "smithy.api#enum": [ - { - "value": "IN_TEMPLATE_ID", - "name": "IN_TEMPLATE_ID" - }, - { - "value": "IN_ENTITY_ID", - "name": "IN_ENTITY_ID" - } - ] + "smithy.api#documentation": "Deletes an account-level monthly spending limit override for sending text messages.\n Deleting a spend limit override will set the EnforcedLimit to equal the\n MaxLimit, which is controlled by Amazon Web Services. For more\n information on spend limits (quotas) see Amazon Pinpoint quotas \n in the Amazon Pinpoint Developer Guide.
The current monthly limit, in US dollars.
" + } + } }, "traits": { - "smithy.api#length": { - "max": 10 - } + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DisassociateOriginationIdentity": { + "com.amazonaws.pinpointsmsvoicev2#DeleteVerifiedDestinationNumber": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#DisassociateOriginationIdentityRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteVerifiedDestinationNumberRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#DisassociateOriginationIdentityResult" + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteVerifiedDestinationNumberResult" }, "errors": [ { @@ -2568,478 +2786,346 @@ } ], "traits": { - "smithy.api#documentation": "Removes the specified origination identity from an existing pool.
\nIf the origination identity isn't associated with the specified pool, an Error is\n returned.
" + "smithy.api#documentation": "Delete a verified destination phone number.
" } }, - "com.amazonaws.pinpointsmsvoicev2#DisassociateOriginationIdentityRequest": { + "com.amazonaws.pinpointsmsvoicev2#DeleteVerifiedDestinationNumberRequest": { "type": "structure", "members": { - "PoolId": { - "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn", - "traits": { - "smithy.api#documentation": "The unique identifier for the pool to disassociate with the origination identity. This\n value can be either the PoolId or PoolArn.
", - "smithy.api#required": {} - } - }, - "OriginationIdentity": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneOrSenderIdOrArn", - "traits": { - "smithy.api#documentation": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers find the values for\n PhoneNumberId and PhoneNumberArn, or use DescribeSenderIds to get the\n values for SenderId and SenderIdArn.
", - "smithy.api#required": {} - } - }, - "IsoCountryCode": { - "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", + "VerifiedDestinationNumberId": { + "target": "com.amazonaws.pinpointsmsvoicev2#VerifiedDestinationNumberIdOrArn", "traits": { - "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
", + "smithy.api#documentation": "The unique identifier for the verified destination phone number.
", "smithy.api#required": {} } - }, - "ClientToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#ClientToken", - "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. If you don't specify a client token, a randomly generated token is used for the\n request to ensure idempotency.
", - "smithy.api#idempotencyToken": {} - } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#DisassociateOriginationIdentityResult": { + "com.amazonaws.pinpointsmsvoicev2#DeleteVerifiedDestinationNumberResult": { "type": "structure", "members": { - "PoolArn": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pool.
" - } - }, - "PoolId": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The PoolId of the pool no longer associated with the origination identity.
" - } - }, - "OriginationIdentityArn": { + "VerifiedDestinationNumberArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The PhoneNumberArn or SenderIdArn of the origination identity.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the verified destination phone number.
", + "smithy.api#required": {} } }, - "OriginationIdentity": { + "VerifiedDestinationNumberId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The PhoneNumberId or SenderId of the origination identity.
" - } - }, - "IsoCountryCode": { - "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", - "traits": { - "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or\n region.
" - } - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#EventDestination": { - "type": "structure", - "members": { - "EventDestinationName": { - "target": "com.amazonaws.pinpointsmsvoicev2#EventDestinationName", - "traits": { - "smithy.api#documentation": "The name of the EventDestination.
", + "smithy.api#documentation": "The unique identifier for the verified destination phone number.
", "smithy.api#required": {} } }, - "Enabled": { - "target": "smithy.api#Boolean", + "DestinationPhoneNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", "traits": { - "smithy.api#documentation": "When set to true events will be logged.
", + "smithy.api#documentation": "The verified destination phone number, in E.164 format.
", "smithy.api#required": {} } }, - "MatchingEventTypes": { - "target": "com.amazonaws.pinpointsmsvoicev2#EventTypeList", + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "An array of event types that determine which events to log.
", + "smithy.api#documentation": "The time when the destination phone number was created, in UNIX epoch time format.
", "smithy.api#required": {} } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DeleteVoiceMessageSpendLimitOverride": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteVoiceMessageSpendLimitOverrideRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteVoiceMessageSpendLimitOverrideResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, - "CloudWatchLogsDestination": { - "target": "com.amazonaws.pinpointsmsvoicev2#CloudWatchLogsDestination", - "traits": { - "smithy.api#documentation": "An object that contains information about an event destination that sends logging\n events to Amazon CloudWatch logs.
" - } + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, - "KinesisFirehoseDestination": { - "target": "com.amazonaws.pinpointsmsvoicev2#KinesisFirehoseDestination", - "traits": { - "smithy.api#documentation": "An object that contains information about an event destination for logging to Amazon\n Kinesis Data Firehose.
" - } + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" }, - "SnsDestination": { - "target": "com.amazonaws.pinpointsmsvoicev2#SnsDestination", + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an account level monthly spend limit override for sending voice messages.\n Deleting a spend limit override sets the EnforcedLimit equal to the\n MaxLimit, which is controlled by Amazon Web Services. For more\n information on spending limits (quotas) see Amazon Pinpoint quotas\n in the Amazon Pinpoint Developer Guide.
An object that contains information about an event destination that sends logging\n events to Amazon SNS.
" + "smithy.api#documentation": "The current monthly limit, in US dollars.
" } } }, "traits": { - "smithy.api#documentation": "Contains information about an event destination.
\nEvent destinations are associated with configuration sets, which enable you to publish\n message sending events to\n Amazon\n CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS.
" - } - }, - "com.amazonaws.pinpointsmsvoicev2#EventDestinationList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#EventDestination" + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#EventDestinationName": { + "com.amazonaws.pinpointsmsvoicev2#DeliveryStreamArn": { "type": "string", "traits": { "smithy.api#length": { - "min": 1, - "max": 64 + "min": 20, + "max": 2048 }, - "smithy.api#pattern": "^[A-Za-z0-9_-]+$" + "smithy.api#pattern": "^arn:\\S+$" } }, - "com.amazonaws.pinpointsmsvoicev2#EventType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ALL", - "name": "ALL" - }, - { - "value": "TEXT_ALL", - "name": "TEXT_ALL" - }, - { - "value": "TEXT_SENT", - "name": "TEXT_SENT" - }, - { - "value": "TEXT_PENDING", - "name": "TEXT_PENDING" - }, - { - "value": "TEXT_QUEUED", - "name": "TEXT_QUEUED" - }, - { - "value": "TEXT_SUCCESSFUL", - "name": "TEXT_SUCCESSFUL" - }, - { - "value": "TEXT_DELIVERED", - "name": "TEXT_DELIVERED" - }, - { - "value": "TEXT_INVALID", - "name": "TEXT_INVALID" - }, - { - "value": "TEXT_INVALID_MESSAGE", - "name": "TEXT_INVALID_MESSAGE" - }, - { - "value": "TEXT_UNREACHABLE", - "name": "TEXT_UNREACHABLE" - }, - { - "value": "TEXT_CARRIER_UNREACHABLE", - "name": "TEXT_CARRIER_UNREACHABLE" - }, - { - "value": "TEXT_BLOCKED", - "name": "TEXT_BLOCKED" - }, - { - "value": "TEXT_CARRIER_BLOCKED", - "name": "TEXT_CARRIER_BLOCKED" - }, - { - "value": "TEXT_SPAM", - "name": "TEXT_SPAM" - }, - { - "value": "TEXT_UNKNOWN", - "name": "TEXT_UNKNOWN" - }, - { - "value": "TEXT_TTL_EXPIRED", - "name": "TEXT_TTL_EXPIRED" - }, - { - "value": "VOICE_ALL", - "name": "VOICE_ALL" - }, - { - "value": "VOICE_INITIATED", - "name": "VOICE_INITIATED" - }, - { - "value": "VOICE_RINGING", - "name": "VOICE_RINGING" - }, - { - "value": "VOICE_ANSWERED", - "name": "VOICE_ANSWERED" - }, - { - "value": "VOICE_COMPLETED", - "name": "VOICE_COMPLETED" - }, - { - "value": "VOICE_BUSY", - "name": "VOICE_BUSY" - }, - { - "value": "VOICE_NO_ANSWER", - "name": "VOICE_NO_ANSWER" - }, - { - "value": "VOICE_FAILED", - "name": "VOICE_FAILED" - }, - { - "value": "VOICE_TTL_EXPIRED", - "name": "VOICE_TTL_EXPIRED" - } - ] - } - }, - "com.amazonaws.pinpointsmsvoicev2#EventTypeList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#EventType" + "com.amazonaws.pinpointsmsvoicev2#DescribeAccountAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeAccountAttributesRequest" }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 25 - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#FilterValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#pattern": "^[A-Za-z0-9_-]+$" - } - }, - "com.amazonaws.pinpointsmsvoicev2#FilterValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#FilterValue" + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeAccountAttributesResult" }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 20 + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" } - } - }, - "com.amazonaws.pinpointsmsvoicev2#IamRoleArn": { - "type": "string", + ], "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:\\S+$" + "smithy.api#documentation": "Describes attributes of your Amazon Web Services account. The supported account\n attributes include account tier, which indicates whether your account is in the sandbox\n or production environment. When you're ready to move your account out of the sandbox,\n create an Amazon Web Services Support case for a service limit increase request.
\nNew Amazon Pinpoint accounts are placed into an SMS or voice sandbox. The sandbox\n protects both Amazon Web Services end recipients and SMS or voice recipients from fraud\n and abuse.
", + "smithy.api#paginated": { + "items": "AccountAttributes" + } } }, - "com.amazonaws.pinpointsmsvoicev2#InternalServerException": { + "com.amazonaws.pinpointsmsvoicev2#DescribeAccountAttributesRequest": { "type": "structure", "members": { - "Message": { - "target": "smithy.api#String" + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } }, - "RequestId": { - "target": "smithy.api#String", + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", "traits": { - "smithy.api#documentation": "The unique identifier of the request.
" + "smithy.api#documentation": "The maximum number of results to return per each request.
" } } }, "traits": { - "smithy.api#documentation": "The API encountered an unexpected error and couldn't complete the request. You might\n be able to successfully issue the request again in the future.
", - "smithy.api#error": "server", - "smithy.api#retryable": {} - } - }, - "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 2, - "max": 2 - }, - "smithy.api#pattern": "^[A-Z]{2}$" - } - }, - "com.amazonaws.pinpointsmsvoicev2#Keyword": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 30 - }, - "smithy.api#pattern": "^[ \\S]+$" - } - }, - "com.amazonaws.pinpointsmsvoicev2#KeywordAction": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AUTOMATIC_RESPONSE", - "name": "AUTOMATIC_RESPONSE" - }, - { - "value": "OPT_OUT", - "name": "OPT_OUT" - }, - { - "value": "OPT_IN", - "name": "OPT_IN" - } - ] + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#KeywordFilter": { + "com.amazonaws.pinpointsmsvoicev2#DescribeAccountAttributesResult": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.pinpointsmsvoicev2#KeywordFilterName", + "AccountAttributes": { + "target": "com.amazonaws.pinpointsmsvoicev2#AccountAttributeList", "traits": { - "smithy.api#documentation": "The name of the attribute to filter on.
", - "smithy.api#required": {} + "smithy.api#documentation": "An array of AccountAttributes objects.
" } }, - "Values": { - "target": "com.amazonaws.pinpointsmsvoicev2#FilterValueList", + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "An array values to filter for.
", - "smithy.api#required": {} + "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" } } }, "traits": { - "smithy.api#documentation": "The information for keywords that meet a specified criteria.
" + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#KeywordFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#KeywordFilter" + "com.amazonaws.pinpointsmsvoicev2#DescribeAccountLimits": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeAccountLimitsRequest" }, - "traits": { - "smithy.api#length": { - "max": 20 - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#KeywordFilterName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "keyword-action", - "name": "KEYWORD_ACTION" - } - ] + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeAccountLimitsResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your\n account. The description for a quota includes the quota name, current usage toward that\n quota, and the quota's maximum value.
\nWhen you establish an Amazon Web Services account, the account has initial quotas on\n the maximum number of configuration sets, opt-out lists, phone numbers, and pools that\n you can create in a given Region. For more information see \n Amazon Pinpoint quotas in the Amazon Pinpoint Developer\n Guide.
", + "smithy.api#paginated": { + "items": "AccountLimits" + } } }, - "com.amazonaws.pinpointsmsvoicev2#KeywordInformation": { + "com.amazonaws.pinpointsmsvoicev2#DescribeAccountLimitsRequest": { "type": "structure", "members": { - "Keyword": { - "target": "com.amazonaws.pinpointsmsvoicev2#Keyword", + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The keyword as a string.
", - "smithy.api#required": {} + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" } }, - "KeywordMessage": { - "target": "com.amazonaws.pinpointsmsvoicev2#KeywordMessage", + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", "traits": { - "smithy.api#documentation": "A custom message that can be used with the keyword.
", - "smithy.api#required": {} + "smithy.api#documentation": "The maximum number of results to return per each request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeAccountLimitsResult": { + "type": "structure", + "members": { + "AccountLimits": { + "target": "com.amazonaws.pinpointsmsvoicev2#AccountLimitList", + "traits": { + "smithy.api#documentation": "An array of AccountLimit objects that show the current spend limits.
" } }, - "KeywordAction": { - "target": "com.amazonaws.pinpointsmsvoicev2#KeywordAction", + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The action to perform for the keyword.
", - "smithy.api#required": {} + "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" } } }, "traits": { - "smithy.api#documentation": "The information for all keywords in a pool.
" - } - }, - "com.amazonaws.pinpointsmsvoicev2#KeywordInformationList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#KeywordInformation" + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#KeywordList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#Keyword" + "com.amazonaws.pinpointsmsvoicev2#DescribeConfigurationSets": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeConfigurationSetsRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeConfigurationSetsResult" }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], "traits": { - "smithy.api#length": { - "max": 5 + "smithy.api#documentation": "Describes the specified configuration sets or all in your account.
\nIf you specify configuration set names, the output includes information for only the\n specified configuration sets. If you specify filters, the output includes information\n for only those configuration sets that meet the filter criteria. If you don't specify\n configuration set names or filters, the output includes information for all\n configuration sets.
\nIf you specify a configuration set name that isn't valid, an error is returned.
", + "smithy.api#paginated": { + "items": "ConfigurationSets" } } }, - "com.amazonaws.pinpointsmsvoicev2#KeywordMessage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1600 + "com.amazonaws.pinpointsmsvoicev2#DescribeConfigurationSetsRequest": { + "type": "structure", + "members": { + "ConfigurationSetNames": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameList", + "traits": { + "smithy.api#documentation": "An array of strings. Each element can be either a ConfigurationSetName or\n ConfigurationSetArn.
" + } }, - "smithy.api#pattern": "^(?!\\s*$)[\\s\\S]+$" + "Filters": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetFilterList", + "traits": { + "smithy.api#documentation": "An array of filters to apply to the results that are returned.
" + } + }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per each request.
" + } + } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#KinesisFirehoseDestination": { + "com.amazonaws.pinpointsmsvoicev2#DescribeConfigurationSetsResult": { "type": "structure", "members": { - "IamRoleArn": { - "target": "com.amazonaws.pinpointsmsvoicev2#IamRoleArn", + "ConfigurationSets": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetInformationList", "traits": { - "smithy.api#documentation": "The ARN of an Amazon Identity and Access Management (IAM) role that is able to write\n event data to an Amazon Firehose destination.
", - "smithy.api#required": {} + "smithy.api#documentation": "An array of ConfigurationSets objects.
" } }, - "DeliveryStreamArn": { - "target": "com.amazonaws.pinpointsmsvoicev2#DeliveryStreamArn", + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the delivery stream.
", - "smithy.api#required": {} + "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" } } }, "traits": { - "smithy.api#documentation": "Contains the delivery stream Amazon Resource Name (ARN), and the ARN of the Identity and Access Management (IAM) role associated with an Kinesis Data Firehose event\n destination.
\nEvent destinations, such as Kinesis Data Firehose, are associated with configuration\n sets, which enable you to publish message sending events.
" + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#ListPoolOriginationIdentities": { + "com.amazonaws.pinpointsmsvoicev2#DescribeKeywords": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#ListPoolOriginationIdentitiesRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeKeywordsRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#ListPoolOriginationIdentitiesResult" + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeKeywordsResult" }, "errors": [ { @@ -3059,26 +3145,32 @@ } ], "traits": { - "smithy.api#documentation": "Lists all associated origination identities in your pool.
\nIf you specify filters, the output includes information for only those origination\n identities that meet the filter criteria.
", + "smithy.api#documentation": "Describes the specified keywords or all keywords on your origination phone number or\n pool.
\nA keyword is a word that you can search for on a particular phone number or pool. It\n is also a specific word or phrase that an end user can send to your number to elicit a\n response, such as an informational message or a special offer. When your number receives\n a message that begins with a keyword, Amazon Pinpoint responds with a customizable\n message.
\nIf you specify a keyword that isn't valid, an error is returned.
", "smithy.api#paginated": { - "items": "OriginationIdentities" + "items": "Keywords" } } }, - "com.amazonaws.pinpointsmsvoicev2#ListPoolOriginationIdentitiesRequest": { + "com.amazonaws.pinpointsmsvoicev2#DescribeKeywordsRequest": { "type": "structure", "members": { - "PoolId": { - "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn", + "OriginationIdentity": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneOrPoolIdOrArn", "traits": { - "smithy.api#documentation": "The unique identifier for the pool. This value can be either the PoolId or\n PoolArn.
", + "smithy.api#documentation": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers to find the values for\n PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used\n to get the values for SenderId and SenderIdArn.
", "smithy.api#required": {} } }, + "Keywords": { + "target": "com.amazonaws.pinpointsmsvoicev2#KeywordList", + "traits": { + "smithy.api#documentation": "An array of keywords to search for.
" + } + }, "Filters": { - "target": "com.amazonaws.pinpointsmsvoicev2#PoolOriginationIdentitiesFilterList", + "target": "com.amazonaws.pinpointsmsvoicev2#KeywordFilterList", "traits": { - "smithy.api#documentation": "An array of PoolOriginationIdentitiesFilter objects to filter the results..
" + "smithy.api#documentation": "An array of keyword filters to filter the results.
" } }, "NextToken": { @@ -3093,27 +3185,30 @@ "smithy.api#documentation": "The maximum number of results to return per each request.
" } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#ListPoolOriginationIdentitiesResult": { + "com.amazonaws.pinpointsmsvoicev2#DescribeKeywordsResult": { "type": "structure", "members": { - "PoolArn": { + "OriginationIdentityArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the pool.
" + "smithy.api#documentation": "The PhoneNumberArn or PoolArn that is associated with the OriginationIdentity.
" } }, - "PoolId": { + "OriginationIdentity": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The unique PoolId of the pool.
" + "smithy.api#documentation": "The PhoneNumberId or PoolId that is associated with the OriginationIdentity.
" } }, - "OriginationIdentities": { - "target": "com.amazonaws.pinpointsmsvoicev2#OriginationIdentityMetadataList", + "Keywords": { + "target": "com.amazonaws.pinpointsmsvoicev2#KeywordInformationList", "traits": { - "smithy.api#documentation": "An array of any OriginationIdentityMetadata objects.
" + "smithy.api#documentation": "An array of KeywordInformation objects that contain the results.
" } }, "NextToken": { @@ -3122,15 +3217,18 @@ "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#ListTagsForResource": { + "com.amazonaws.pinpointsmsvoicev2#DescribeOptOutLists": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#ListTagsForResourceRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeOptOutListsRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#ListTagsForResourceResult" + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeOptOutListsResult" }, "errors": [ { @@ -3150,849 +3248,3182 @@ } ], "traits": { - "smithy.api#documentation": "List all tags associated with a resource.
" + "smithy.api#documentation": "Describes the specified opt-out list or all opt-out lists in your account.
\nIf you specify opt-out list names, the output includes information for only the\n specified opt-out lists. Opt-out lists include only those that meet the filter criteria.\n If you don't specify opt-out list names or filters, the output includes information for\n all opt-out lists.
\nIf you specify an opt-out list name that isn't valid, an error is returned.
", + "smithy.api#paginated": { + "items": "OptOutLists" + } } }, - "com.amazonaws.pinpointsmsvoicev2#ListTagsForResourceRequest": { + "com.amazonaws.pinpointsmsvoicev2#DescribeOptOutListsRequest": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.pinpointsmsvoicev2#AmazonResourceName", + "OptOutListNames": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameList", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to query for.
", - "smithy.api#required": {} + "smithy.api#documentation": "The OptOutLists to show the details of. This is an array of strings that can be either\n the OptOutListName or OptOutListArn.
" + } + }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per each request.
" } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#ListTagsForResourceResult": { + "com.amazonaws.pinpointsmsvoicev2#DescribeOptOutListsResult": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.pinpointsmsvoicev2#AmazonResourceName", + "OptOutLists": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListInformationList", "traits": { - "smithy.api#documentation": "The ARN of the resource.
" + "smithy.api#documentation": "An array of OptOutListInformation objects that contain the details for the requested\n OptOutLists.
" } }, - "Tags": { - "target": "com.amazonaws.pinpointsmsvoicev2#TagList", + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "An array of key and value pair tags that are associated with the resource.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" } } - } - }, - "com.amazonaws.pinpointsmsvoicev2#LogGroupArn": { - "type": "string", + }, "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:\\S+$" + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#MaxPrice": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 2, - "max": 8 + "com.amazonaws.pinpointsmsvoicev2#DescribeOptedOutNumbers": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeOptedOutNumbersRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeOptedOutNumbersResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, - "smithy.api#pattern": "^[0-9]{0,2}\\.[0-9]{1,5}$" - } - }, - "com.amazonaws.pinpointsmsvoicev2#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" } - } - }, - "com.amazonaws.pinpointsmsvoicev2#MessageType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "TRANSACTIONAL", - "name": "TRANSACTIONAL" - }, - { - "value": "PROMOTIONAL", - "name": "PROMOTIONAL" - } - ] - } - }, - "com.amazonaws.pinpointsmsvoicev2#MessageTypeList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#MessageType" - } - }, - "com.amazonaws.pinpointsmsvoicev2#MonthlyLimit": { - "type": "long", + ], "traits": { - "smithy.api#range": { - "min": 0, - "max": 1000000000 + "smithy.api#documentation": "Describes the specified opted out destination numbers or all opted out destination\n numbers in an opt-out list.
\nIf you specify opted out numbers, the output includes information for only the\n specified opted out numbers. If you specify filters, the output includes information for\n only those opted out numbers that meet the filter criteria. If you don't specify opted\n out numbers or filters, the output includes information for all opted out destination\n numbers in your opt-out list.
\nIf you specify an opted out number that isn't valid, an error is returned.
", + "smithy.api#paginated": { + "items": "OptedOutNumbers" } } }, - "com.amazonaws.pinpointsmsvoicev2#NextToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 + "com.amazonaws.pinpointsmsvoicev2#DescribeOptedOutNumbersRequest": { + "type": "structure", + "members": { + "OptOutListName": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", + "traits": { + "smithy.api#documentation": "The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and\n OptOutListArn.
", + "smithy.api#required": {} + } }, - "smithy.api#pattern": "^.+$" - } - }, - "com.amazonaws.pinpointsmsvoicev2#NonEmptyTagList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#Tag" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#NumberCapability": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SMS", - "name": "SMS" - }, - { - "value": "VOICE", - "name": "VOICE" + "OptedOutNumbers": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptedOutNumberList", + "traits": { + "smithy.api#documentation": "An array of phone numbers to search for in the OptOutList.
" } - ] - } - }, - "com.amazonaws.pinpointsmsvoicev2#NumberCapabilityList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#NumberCapability" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2 - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#NumberStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "PENDING" - }, - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "ASSOCIATING", - "name": "ASSOCIATING" - }, - { - "value": "DISASSOCIATING", - "name": "DISASSOCIATING" - }, - { - "value": "DELETED", - "name": "DELETED" + }, + "Filters": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptedOutFilterList", + "traits": { + "smithy.api#documentation": "An array of OptedOutFilter objects to filter the results on.
" } - ] - } - }, - "com.amazonaws.pinpointsmsvoicev2#NumberType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SHORT_CODE", - "name": "SHORT_CODE" - }, - { - "value": "LONG_CODE", - "name": "LONG_CODE" - }, - { - "value": "TOLL_FREE", - "name": "TOLL_FREE" - }, - { - "value": "TEN_DLC", - "name": "TEN_DLC" + }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" } - ] + }, + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per each request.
" + } + } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#OptOutListInformation": { + "com.amazonaws.pinpointsmsvoicev2#DescribeOptedOutNumbersResult": { "type": "structure", "members": { "OptOutListArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the OptOutList.
", - "smithy.api#required": {} + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the OptOutList.
" } }, "OptOutListName": { "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", "traits": { - "smithy.api#documentation": "The name of the OptOutList.
", - "smithy.api#required": {} + "smithy.api#documentation": "The name of the OptOutList.
" } }, - "CreatedTimestamp": { - "target": "smithy.api#Timestamp", + "OptedOutNumbers": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptedOutNumberInformationList", "traits": { - "smithy.api#documentation": "The time when the OutOutList was created, in UNIX epoch time format.
", - "smithy.api#required": {} + "smithy.api#documentation": "An array of OptedOutNumbersInformation objects that provide information about the\n requested OptedOutNumbers.
" + } + }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" } } }, "traits": { - "smithy.api#documentation": "The information for all OptOutList in an Amazon Web Services account.
" - } - }, - "com.amazonaws.pinpointsmsvoicev2#OptOutListInformationList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListInformation" + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#OptOutListName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 + "com.amazonaws.pinpointsmsvoicev2#DescribePhoneNumbers": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribePhoneNumbersRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribePhoneNumbersResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, - "smithy.api#pattern": "^[A-Za-z0-9_-]+$" + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Describes the specified origination phone number, or all the phone numbers in your\n account.
\nIf you specify phone number IDs, the output includes information for only the\n specified phone numbers. If you specify filters, the output includes information for\n only those phone numbers that meet the filter criteria. If you don't specify phone\n number IDs or filters, the output includes information for all phone numbers.
\nIf you specify a phone number ID that isn't valid, an error is returned.
", + "smithy.api#paginated": { + "items": "PhoneNumbers" + } } }, - "com.amazonaws.pinpointsmsvoicev2#OptOutListNameList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn" - }, - "traits": { - "smithy.api#length": { - "max": 5 + "com.amazonaws.pinpointsmsvoicev2#DescribePhoneNumbersRequest": { + "type": "structure", + "members": { + "PhoneNumberIds": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberIdList", + "traits": { + "smithy.api#documentation": "The unique identifier of phone numbers to find information about. This is an array of\n strings that can be either the PhoneNumberId or PhoneNumberArn.
" + } + }, + "Filters": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberFilterList", + "traits": { + "smithy.api#documentation": "An array of PhoneNumberFilter objects to filter the results.
" + } + }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per each request.
" + } } - } - }, - "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn": { - "type": "string", + }, "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#OptedOutFilter": { + "com.amazonaws.pinpointsmsvoicev2#DescribePhoneNumbersResult": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptedOutFilterName", + "PhoneNumbers": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberInformationList", "traits": { - "smithy.api#documentation": "The name of the attribute to filter on.
", - "smithy.api#required": {} + "smithy.api#documentation": "An array of PhoneNumberInformation objects that contain the details for the requested\n phone numbers.
" } }, - "Values": { - "target": "com.amazonaws.pinpointsmsvoicev2#FilterValueList", + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "An array of values to filter for.
", - "smithy.api#required": {} + "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" } } }, "traits": { - "smithy.api#documentation": "The information for opted out numbers that meet a specified criteria.
" + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#OptedOutFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptedOutFilter" + "com.amazonaws.pinpointsmsvoicev2#DescribePools": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribePoolsRequest" }, - "traits": { - "smithy.api#length": { - "max": 20 + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribePoolsResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" } - } - }, - "com.amazonaws.pinpointsmsvoicev2#OptedOutFilterName": { - "type": "string", + ], "traits": { - "smithy.api#enum": [ - { - "value": "end-user-opted-out", - "name": "END_USER_OPTED_OUT" - } - ] + "smithy.api#documentation": "Retrieves the specified pools or all pools associated with your Amazon Web Services\n account.
\nIf you specify pool IDs, the output includes information for only the specified pools.\n If you specify filters, the output includes information for only those pools that meet\n the filter criteria. If you don't specify pool IDs or filters, the output includes\n information for all pools.
\nIf you specify a pool ID that isn't valid, an error is returned.
\nA pool is a collection of phone numbers and SenderIds. A pool can include one or more\n phone numbers and SenderIds that are associated with your Amazon Web Services\n account.
", + "smithy.api#paginated": { + "items": "Pools" + } } }, - "com.amazonaws.pinpointsmsvoicev2#OptedOutNumberInformation": { + "com.amazonaws.pinpointsmsvoicev2#DescribePoolsRequest": { "type": "structure", "members": { - "OptedOutNumber": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "PoolIds": { + "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdList", "traits": { - "smithy.api#documentation": "The phone number that is opted out.
", - "smithy.api#required": {} + "smithy.api#documentation": "The unique identifier of pools to find. This is an array of strings that can be either\n the PoolId or PoolArn.
" } }, - "OptedOutTimestamp": { - "target": "smithy.api#Timestamp", + "Filters": { + "target": "com.amazonaws.pinpointsmsvoicev2#PoolFilterList", "traits": { - "smithy.api#documentation": "The time that the op tout occurred, in UNIX epoch time format.
", - "smithy.api#required": {} + "smithy.api#documentation": "An array of PoolFilter objects to filter the results.
" } }, - "EndUserOptedOut": { - "target": "smithy.api#PrimitiveBoolean", + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "This is set to true if it was the end recipient that opted out.
", - "smithy.api#required": {} + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per each request.
" } } }, "traits": { - "smithy.api#documentation": "The information for an opted out number in an Amazon Web Services account.
" + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#OptedOutNumberInformationList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptedOutNumberInformation" + "com.amazonaws.pinpointsmsvoicev2#DescribePoolsResult": { + "type": "structure", + "members": { + "Pools": { + "target": "com.amazonaws.pinpointsmsvoicev2#PoolInformationList", + "traits": { + "smithy.api#documentation": "An array of PoolInformation objects that contain the details for the requested pools.
" + } + }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" + } + } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#OptedOutNumberList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber" + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationAttachments": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationAttachmentsRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationAttachmentsResult" }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], "traits": { - "smithy.api#length": { - "max": 5 + "smithy.api#documentation": "Retrieves the specified registration attachments or all registration attachments associated with your Amazon Web Services account.
", + "smithy.api#paginated": { + "items": "RegistrationAttachments" } } }, - "com.amazonaws.pinpointsmsvoicev2#OriginationIdentityMetadata": { + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationAttachmentsRequest": { "type": "structure", "members": { - "OriginationIdentityArn": { - "target": "smithy.api#String", + "RegistrationAttachmentIds": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationAttachmentIdList", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the origination identity.
", - "smithy.api#required": {} + "smithy.api#documentation": "The unique identifier of registration attachments to find. This is an array of RegistrationAttachmentId.
" } }, - "OriginationIdentity": { - "target": "smithy.api#String", + "Filters": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationAttachmentFilterList", "traits": { - "smithy.api#documentation": "The unique identifier of the origination identity.
", - "smithy.api#required": {} + "smithy.api#documentation": "An array of RegistrationAttachmentFilter objects to filter the results.
" } }, - "IsoCountryCode": { - "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
", - "smithy.api#required": {} + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" } }, - "NumberCapabilities": { - "target": "com.amazonaws.pinpointsmsvoicev2#NumberCapabilityList", + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", "traits": { - "smithy.api#documentation": "Describes if the origination identity can be used for text messages, voice calls or\n both.
", - "smithy.api#required": {} + "smithy.api#documentation": "The maximum number of results to return per each request.
" } } }, "traits": { - "smithy.api#documentation": "The metadata for an origination identity associated with a pool.
" - } - }, - "com.amazonaws.pinpointsmsvoicev2#OriginationIdentityMetadataList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#OriginationIdentityMetadata" - } - }, - "com.amazonaws.pinpointsmsvoicev2#PhoneNumber": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 20 - }, - "smithy.api#pattern": "^\\+?[1-9][0-9]{1,18}$" + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#PhoneNumberFilter": { + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationAttachmentsResult": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberFilterName", + "RegistrationAttachments": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationAttachmentsInformationList", "traits": { - "smithy.api#documentation": "The name of the attribute to filter on.
", + "smithy.api#documentation": "An array of RegistrationAttachments objects that contain the details for the requested registration attachments.
", "smithy.api#required": {} } }, - "Values": { - "target": "com.amazonaws.pinpointsmsvoicev2#FilterValueList", + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "An array values to filter for.
", - "smithy.api#required": {} + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" } } }, "traits": { - "smithy.api#documentation": "The information for a phone number that meets a specified criteria.
" + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#PhoneNumberFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberFilter" + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationFieldDefinitions": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationFieldDefinitionsRequest" }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationFieldDefinitionsResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], "traits": { - "smithy.api#length": { - "max": 20 + "smithy.api#documentation": "Retrieves the specified registration type field definitions. You can use DescribeRegistrationFieldDefinitions to view the requirements for creating, filling out, and submitting each registration type.
", + "smithy.api#paginated": { + "items": "RegistrationFieldDefinitions" } } }, - "com.amazonaws.pinpointsmsvoicev2#PhoneNumberFilterName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "status", - "name": "STATUS" - }, - { - "value": "iso-country-code", - "name": "ISO_COUNTRY_CODE" - }, - { - "value": "message-type", - "name": "MESSAGE_TYPE" - }, - { - "value": "number-capability", - "name": "NUMBER_CAPABILITY" - }, - { - "value": "number-type", - "name": "NUMBER_TYPE" - }, - { - "value": "two-way-enabled", - "name": "TWO_WAY_ENABLED" - }, - { - "value": "self-managed-opt-outs-enabled", - "name": "SELF_MANAGED_OPT_OUTS_ENABLED" - }, - { - "value": "opt-out-list-name", - "name": "OPT_OUT_LIST_NAME" - }, - { - "value": "deletion-protection-enabled", - "name": "DELETION_PROTECTION_ENABLED" + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationFieldDefinitionsRequest": { + "type": "structure", + "members": { + "RegistrationType": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationType", + "traits": { + "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
", + "smithy.api#required": {} } - ] + }, + "SectionPath": { + "target": "com.amazonaws.pinpointsmsvoicev2#SectionPath", + "traits": { + "smithy.api#documentation": "The path to the section of the registration.
" + } + }, + "FieldPaths": { + "target": "com.amazonaws.pinpointsmsvoicev2#FieldPathList", + "traits": { + "smithy.api#documentation": "An array of paths to the registration form field.
" + } + }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per each request.
" + } + } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#PhoneNumberIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberIdOrArn" + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationFieldDefinitionsResult": { + "type": "structure", + "members": { + "RegistrationType": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationType", + "traits": { + "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
", + "smithy.api#required": {} + } + }, + "RegistrationFieldDefinitions": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationFieldDefinitionList", + "traits": { + "smithy.api#documentation": "An array of RegistrationFieldDefinitions objects that contain the details for the requested fields.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } + } }, "traits": { - "smithy.api#length": { - "max": 5 - } + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#PhoneNumberIdOrArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationFieldValues": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationFieldValuesRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationFieldValuesResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, - "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the specified registration field values.
", + "smithy.api#paginated": { + "items": "RegistrationFieldValues" + } } }, - "com.amazonaws.pinpointsmsvoicev2#PhoneNumberInformation": { + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationFieldValuesRequest": { "type": "structure", "members": { - "PhoneNumberArn": { - "target": "smithy.api#String", + "RegistrationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationIdOrArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the phone number.
", + "smithy.api#documentation": "The unique identifier for the registration.
", "smithy.api#required": {} } }, - "PhoneNumberId": { - "target": "smithy.api#String", + "VersionNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionNumber", "traits": { - "smithy.api#documentation": "The unique identifier for the phone number.
" + "smithy.api#documentation": "The version number of the registration.
" } }, - "PhoneNumber": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "SectionPath": { + "target": "com.amazonaws.pinpointsmsvoicev2#SectionPath", "traits": { - "smithy.api#documentation": "The phone number in E.164 format.
", - "smithy.api#required": {} + "smithy.api#documentation": "The path to the section of the registration.
" } }, - "Status": { - "target": "com.amazonaws.pinpointsmsvoicev2#NumberStatus", + "FieldPaths": { + "target": "com.amazonaws.pinpointsmsvoicev2#FieldPathList", "traits": { - "smithy.api#documentation": "The current status of the phone number.
", - "smithy.api#required": {} + "smithy.api#documentation": "An array of paths to the registration form field.
" } }, - "IsoCountryCode": { - "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
", - "smithy.api#required": {} + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" } }, - "MessageType": { - "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", "traits": { - "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
", - "smithy.api#required": {} + "smithy.api#documentation": "The maximum number of results to return per each request.
" } - }, - "NumberCapabilities": { - "target": "com.amazonaws.pinpointsmsvoicev2#NumberCapabilityList", + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationFieldValuesResult": { + "type": "structure", + "members": { + "RegistrationArn": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Describes if the origination identity can be used for text messages, voice calls or\n both.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the registration.
", "smithy.api#required": {} } }, - "NumberType": { - "target": "com.amazonaws.pinpointsmsvoicev2#NumberType", + "RegistrationId": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The type of phone number.
", + "smithy.api#documentation": "The unique identifier for the registration.
", "smithy.api#required": {} } }, - "MonthlyLeasingPrice": { - "target": "smithy.api#String", + "VersionNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionNumber", "traits": { - "smithy.api#documentation": "The price, in US dollars, to lease the phone number.
", + "smithy.api#documentation": "The current version of the registration.
", "smithy.api#required": {} } }, - "TwoWayEnabled": { - "target": "smithy.api#PrimitiveBoolean", + "RegistrationFieldValues": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationFieldValueInformationList", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients using the TwoWayChannelArn.
", + "smithy.api#documentation": "An array of RegistrationFieldValues objects that contain the values for the requested registration.
", "smithy.api#required": {} } }, - "TwoWayChannelArn": { - "target": "com.amazonaws.pinpointsmsvoicev2#TwoWayChannelArn", + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the two way channel.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationSectionDefinitions": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationSectionDefinitionsRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationSectionDefinitionsResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, - "SelfManagedOptOutsEnabled": { - "target": "smithy.api#PrimitiveBoolean", + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the specified registration section definitions. You can use DescribeRegistrationSectionDefinitions to view the requirements for creating, filling out, and submitting each registration type.
", + "smithy.api#paginated": { + "items": "RegistrationSectionDefinitions" + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationSectionDefinitionsRequest": { + "type": "structure", + "members": { + "RegistrationType": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationType", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "When set to false an end recipient sends a message that begins with HELP or STOP to\n one of your dedicated numbers, Amazon Pinpoint automatically replies with a\n customizable message and adds the end recipient to the OptOutList. When set to true\n you're responsible for responding to HELP and STOP requests. You're also responsible for\n tracking and honoring opt-out request. For more information see Self-managed opt-outs\n
", + "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
", "smithy.api#required": {} } }, - "OptOutListName": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", + "SectionPaths": { + "target": "com.amazonaws.pinpointsmsvoicev2#SectionPathList", "traits": { - "smithy.api#documentation": "The name of the OptOutList associated with the phone number.
", - "smithy.api#required": {} + "smithy.api#documentation": "An array of paths for the registration form section.
" } }, - "DeletionProtectionEnabled": { - "target": "smithy.api#PrimitiveBoolean", + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "When set to true the phone number can't be deleted.
", - "smithy.api#required": {} + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" } }, - "PoolId": { - "target": "smithy.api#String", + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", "traits": { - "smithy.api#documentation": "The unique identifier of the pool associated with the phone number.
" + "smithy.api#documentation": "The maximum number of results to return per each request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationSectionDefinitionsResult": { + "type": "structure", + "members": { + "RegistrationType": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationType", + "traits": { + "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
", + "smithy.api#required": {} } }, - "CreatedTimestamp": { - "target": "smithy.api#Timestamp", + "RegistrationSectionDefinitions": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationSectionDefinitionList", "traits": { - "smithy.api#documentation": "The time when the phone number was created, in UNIX epoch time format.
", + "smithy.api#documentation": "An array of RegistrationSectionDefinition objects.
", "smithy.api#required": {} } + }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } } }, "traits": { - "smithy.api#documentation": "The information for a phone number in an Amazon Web Services account.
" + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#PhoneNumberInformationList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberInformation" - } - }, - "com.amazonaws.pinpointsmsvoicev2#PhoneOrPoolIdOrArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" - } - }, - "com.amazonaws.pinpointsmsvoicev2#PhoneOrSenderIdOrArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" - } - }, - "com.amazonaws.pinpointsmsvoicev2#PinpointSMSVoiceV2": { - "type": "service", - "version": "2022-03-31", - "operations": [ + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationTypeDefinitions": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationTypeDefinitionsRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationTypeDefinitionsResult" + }, + "errors": [ { - "target": "com.amazonaws.pinpointsmsvoicev2#AssociateOriginationIdentity" + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#CreateConfigurationSet" + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#CreateEventDestination" + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#CreateOptOutList" + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the specified registration type definitions. You can use DescribeRegistrationTypeDefinitions to view the requirements for creating, filling out, and submitting each registration type.
", + "smithy.api#paginated": { + "items": "RegistrationTypeDefinitions" + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationTypeDefinitionsRequest": { + "type": "structure", + "members": { + "RegistrationTypes": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationTypeList", + "traits": { + "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
" + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#CreatePool" + "Filters": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationTypeFilterList", + "traits": { + "smithy.api#documentation": "An array of RegistrationFilter objects to filter the results.
" + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteConfigurationSet" + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultMessageType" + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per each request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationTypeDefinitionsResult": { + "type": "structure", + "members": { + "RegistrationTypeDefinitions": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationTypeDefinitionList", + "traits": { + "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
", + "smithy.api#required": {} + } }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationVersionsRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationVersionsResult" + }, + "errors": [ { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultSenderId" + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteEventDestination" + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteKeyword" + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteOptedOutNumber" + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutList" + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the specified registration version.
", + "smithy.api#paginated": { + "items": "RegistrationVersions" + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationVersionsRequest": { + "type": "structure", + "members": { + "RegistrationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationIdOrArn", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#DeletePool" + "VersionNumbers": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionNumberList", + "traits": { + "smithy.api#documentation": "An array of registration version numbers.
" + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteTextMessageSpendLimitOverride" + "Filters": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionFilterList", + "traits": { + "smithy.api#documentation": "An array of RegistrationVersionFilter objects to filter the results.
" + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#DeleteVoiceMessageSpendLimitOverride" + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeAccountAttributes" + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per each request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationVersionsResult": { + "type": "structure", + "members": { + "RegistrationArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the registration.
", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeAccountLimits" + "RegistrationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeConfigurationSets" + "RegistrationVersions": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionInformationList", + "traits": { + "smithy.api#documentation": "An array of RegistrationVersions objects.
", + "smithy.api#required": {} + } }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrations": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationsRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationsResult" + }, + "errors": [ { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeKeywords" + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeOptedOutNumbers" + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeOptOutLists" + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribePhoneNumbers" + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribePools" + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the specified registrations.
", + "smithy.api#paginated": { + "items": "Registrations" + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationsRequest": { + "type": "structure", + "members": { + "RegistrationIds": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationIdList", + "traits": { + "smithy.api#documentation": "An array of unique identifiers for each registration.
" + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeSenderIds" + "Filters": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationFilterList", + "traits": { + "smithy.api#documentation": "An array of RegistrationFilter objects to filter the results.
" + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#DescribeSpendLimits" + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per each request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationsResult": { + "type": "structure", + "members": { + "Registrations": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationInformationList", + "traits": { + "smithy.api#documentation": "An array of RegistrationInformation objects.
", + "smithy.api#required": {} + } }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeSenderIds": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeSenderIdsRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeSenderIdsResult" + }, + "errors": [ { - "target": "com.amazonaws.pinpointsmsvoicev2#DisassociateOriginationIdentity" + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#ListPoolOriginationIdentities" + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#ListTagsForResource" + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#PutKeyword" + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#PutOptedOutNumber" + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.
\nIf you specify SenderIds, the output includes information for only the specified\n SenderIds. If you specify filters, the output includes information for only those\n SenderIds that meet the filter criteria. If you don't specify SenderIds or filters, the\n output includes information for all SenderIds.
\nf you specify a sender ID that isn't valid, an error is returned.
", + "smithy.api#paginated": { + "items": "SenderIds" + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeSenderIdsRequest": { + "type": "structure", + "members": { + "SenderIds": { + "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdList", + "traits": { + "smithy.api#documentation": "An array of SenderIdAndCountry objects to search for.
" + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ReleasePhoneNumber" + "Filters": { + "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdFilterList", + "traits": { + "smithy.api#documentation": "An array of SenderIdFilter objects to filter the results.
" + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#RequestPhoneNumber" + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#SendTextMessage" + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per each request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeSenderIdsResult": { + "type": "structure", + "members": { + "SenderIds": { + "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdInformationList", + "traits": { + "smithy.api#documentation": "An array of SernderIdInformation objects that contain the details for the requested\n SenderIds.
" + } }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeSpendLimits": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeSpendLimitsRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeSpendLimitsResult" + }, + "errors": [ { - "target": "com.amazonaws.pinpointsmsvoicev2#SendVoiceMessage" + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#SetDefaultMessageType" + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#SetDefaultSenderId" + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#SetTextMessageSpendLimitOverride" + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Describes the current Amazon Pinpoint monthly spend limits for sending voice and\n text messages.
\nWhen you establish an Amazon Web Services account, the account has initial monthly\n spend limit in a given Region. For more information on increasing your monthly spend\n limit, see \n Requesting increases to your monthly SMS spending quota for Amazon Pinpoint\n in the Amazon Pinpoint User Guide.
", + "smithy.api#paginated": { + "items": "SpendLimits" + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeSpendLimitsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#SetVoiceMessageSpendLimitOverride" + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per each request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeSpendLimitsResult": { + "type": "structure", + "members": { + "SpendLimits": { + "target": "com.amazonaws.pinpointsmsvoicev2#SpendLimitList", + "traits": { + "smithy.api#documentation": "An array of SpendLimit objects that contain the details for the requested spend\n limits.
" + } }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeVerifiedDestinationNumbers": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeVerifiedDestinationNumbersRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeVerifiedDestinationNumbersResult" + }, + "errors": [ { - "target": "com.amazonaws.pinpointsmsvoicev2#TagResource" + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#UntagResource" + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#UpdateEventDestination" + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#UpdatePhoneNumber" + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" }, { - "target": "com.amazonaws.pinpointsmsvoicev2#UpdatePool" + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" } ], "traits": { - "aws.api#service": { - "sdkId": "Pinpoint SMS Voice V2", - "endpointPrefix": "sms-voice", - "arnNamespace": "sms-voice" + "smithy.api#documentation": "Retrieves the specified verified destiona numbers.
", + "smithy.api#paginated": { + "items": "VerifiedDestinationNumbers" + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeVerifiedDestinationNumbersRequest": { + "type": "structure", + "members": { + "VerifiedDestinationNumberIds": { + "target": "com.amazonaws.pinpointsmsvoicev2#VerifiedDestinationNumberIdList", + "traits": { + "smithy.api#documentation": "An array of VerifiedDestinationNumberid to retreive.
" + } }, - "aws.auth#sigv4": { - "name": "sms-voice" + "DestinationPhoneNumbers": { + "target": "com.amazonaws.pinpointsmsvoicev2#DestinationPhoneNumberList", + "traits": { + "smithy.api#documentation": "An array of verified destination phone number, in E.164 format.
" + } }, - "aws.protocols#awsJson1_0": {}, - "smithy.api#documentation": "Welcome to the Amazon Pinpoint SMS and Voice, version 2 API Reference.\n This guide provides information about Amazon Pinpoint SMS and Voice, version 2 API\n resources, including supported HTTP methods, parameters, and schemas.
\nAmazon Pinpoint is an Amazon Web Services service that you can use to engage with\n your recipients across multiple messaging channels. The Amazon Pinpoint SMS and\n Voice, version 2 API provides programmatic access to options that are unique to the SMS\n and voice channels and supplements the resources provided by the Amazon Pinpoint\n API.
\nIf you're new to Amazon Pinpoint, it's also helpful to review the \n Amazon Pinpoint Developer Guide. The Amazon Pinpoint\n Developer Guide provides tutorials, code samples, and procedures that\n demonstrate how to use Amazon Pinpoint features programmatically and how to integrate\n Amazon Pinpoint functionality into mobile apps and other types of applications.\n The guide also provides key information, such as Amazon Pinpoint integration with\n other Amazon Web Services services, and the quotas that apply to use of the\n service.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" + "Filters": { + "target": "com.amazonaws.pinpointsmsvoicev2#VerifiedDestinationNumberFilterList", + "traits": { + "smithy.api#documentation": "An array of VerifiedDestinationNumberFilter objects to filter the results.
" + } }, - "smithy.api#title": "Amazon Pinpoint SMS Voice V2", - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per each request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DescribeVerifiedDestinationNumbersResult": { + "type": "structure", + "members": { + "VerifiedDestinationNumbers": { + "target": "com.amazonaws.pinpointsmsvoicev2#VerifiedDestinationNumberInformationList", + "traits": { + "smithy.api#documentation": "An array of VerifiedDestinationNumberInformation objects
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DestinationCountryParameterKey": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "IN_TEMPLATE_ID", + "name": "IN_TEMPLATE_ID" }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" + { + "value": "IN_ENTITY_ID", + "name": "IN_ENTITY_ID" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#DestinationCountryParameterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^\\S+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#DestinationCountryParameters": { + "type": "map", + "key": { + "target": "com.amazonaws.pinpointsmsvoicev2#DestinationCountryParameterKey" + }, + "value": { + "target": "com.amazonaws.pinpointsmsvoicev2#DestinationCountryParameterValue" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#DestinationPhoneNumberList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#DisassociateOriginationIdentity": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DisassociateOriginationIdentityRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DisassociateOriginationIdentityResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Removes the specified origination identity from an existing pool.
\nIf the origination identity isn't associated with the specified pool, an error is\n returned.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#DisassociateOriginationIdentityRequest": { + "type": "structure", + "members": { + "PoolId": { + "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn", + "traits": { + "smithy.api#documentation": "The unique identifier for the pool to disassociate with the origination identity. This\n value can be either the PoolId or PoolArn.
", + "smithy.api#required": {} + } + }, + "OriginationIdentity": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneOrSenderIdOrArn", + "traits": { + "smithy.api#documentation": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers find the values for\n PhoneNumberId and PhoneNumberArn, or use DescribeSenderIds to get the\n values for SenderId and SenderIdArn.
", + "smithy.api#required": {} + } + }, + "IsoCountryCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", + "traits": { + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#ClientToken", + "traits": { + "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. If you don't specify a client token, a randomly generated token is used for the\n request to ensure idempotency.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DisassociateOriginationIdentityResult": { + "type": "structure", + "members": { + "PoolArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pool.
" + } + }, + "PoolId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The PoolId of the pool no longer associated with the origination identity.
" + } + }, + "OriginationIdentityArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The PhoneNumberArn or SenderIdArn of the origination identity.
" + } + }, + "OriginationIdentity": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The PhoneNumberId or SenderId of the origination identity.
" + } + }, + "IsoCountryCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", + "traits": { + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or\n region.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DiscardRegistrationVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DiscardRegistrationVersionRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DiscardRegistrationVersionResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Discard the current version of the registration.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#DiscardRegistrationVersionRequest": { + "type": "structure", + "members": { + "RegistrationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationIdOrArn", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DiscardRegistrationVersionResult": { + "type": "structure", + "members": { + "RegistrationArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the registration.
", + "smithy.api#required": {} + } + }, + "RegistrationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} + } + }, + "VersionNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionNumber", + "traits": { + "smithy.api#documentation": "The version number of the registration.
", + "smithy.api#required": {} + } + }, + "RegistrationVersionStatus": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionStatus", + "traits": { + "smithy.api#documentation": "The status of the registration version.
\n\n DRAFT: The initial status of a registration version after it’s created.
\n SUBMITTED: Your registration has been submitted.
\n REVIEWING: Your registration has been accepted and is being reviewed.
\n APPROVED: Your registration has been approved.
\n DISCARDED: You've abandon this version of their registration to start over with a new version.
\n DENIED: You must fix your registration and resubmit it.
\n REVOKED: Your previously approved registration has been revoked.
\n ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.
The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#EventDestination": { + "type": "structure", + "members": { + "EventDestinationName": { + "target": "com.amazonaws.pinpointsmsvoicev2#EventDestinationName", + "traits": { + "smithy.api#documentation": "The name of the EventDestination.
", + "smithy.api#required": {} + } + }, + "Enabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "When set to true events will be logged.
", + "smithy.api#required": {} + } + }, + "MatchingEventTypes": { + "target": "com.amazonaws.pinpointsmsvoicev2#EventTypeList", + "traits": { + "smithy.api#documentation": "An array of event types that determine which events to log.
\nThe TEXT_SENT event type is not supported.
An object that contains information about an event destination that sends logging\n events to Amazon CloudWatch logs.
" + } + }, + "KinesisFirehoseDestination": { + "target": "com.amazonaws.pinpointsmsvoicev2#KinesisFirehoseDestination", + "traits": { + "smithy.api#documentation": "An object that contains information about an event destination for logging to Amazon\n Kinesis Data Firehose.
" + } + }, + "SnsDestination": { + "target": "com.amazonaws.pinpointsmsvoicev2#SnsDestination", + "traits": { + "smithy.api#documentation": "An object that contains information about an event destination that sends logging\n events to Amazon SNS.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about an event destination.
\nEvent destinations are associated with configuration sets, which enable you to publish\n message sending events to CloudWatch, Kinesis Data Firehose,or Amazon SNS.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#EventDestinationList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#EventDestination" + } + }, + "com.amazonaws.pinpointsmsvoicev2#EventDestinationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z0-9_-]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#EventType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ALL", + "name": "ALL" + }, + { + "value": "TEXT_ALL", + "name": "TEXT_ALL" + }, + { + "value": "TEXT_SENT", + "name": "TEXT_SENT" + }, + { + "value": "TEXT_PENDING", + "name": "TEXT_PENDING" + }, + { + "value": "TEXT_QUEUED", + "name": "TEXT_QUEUED" + }, + { + "value": "TEXT_SUCCESSFUL", + "name": "TEXT_SUCCESSFUL" + }, + { + "value": "TEXT_DELIVERED", + "name": "TEXT_DELIVERED" + }, + { + "value": "TEXT_INVALID", + "name": "TEXT_INVALID" + }, + { + "value": "TEXT_INVALID_MESSAGE", + "name": "TEXT_INVALID_MESSAGE" + }, + { + "value": "TEXT_UNREACHABLE", + "name": "TEXT_UNREACHABLE" + }, + { + "value": "TEXT_CARRIER_UNREACHABLE", + "name": "TEXT_CARRIER_UNREACHABLE" + }, + { + "value": "TEXT_BLOCKED", + "name": "TEXT_BLOCKED" + }, + { + "value": "TEXT_CARRIER_BLOCKED", + "name": "TEXT_CARRIER_BLOCKED" + }, + { + "value": "TEXT_SPAM", + "name": "TEXT_SPAM" + }, + { + "value": "TEXT_UNKNOWN", + "name": "TEXT_UNKNOWN" + }, + { + "value": "TEXT_TTL_EXPIRED", + "name": "TEXT_TTL_EXPIRED" + }, + { + "value": "VOICE_ALL", + "name": "VOICE_ALL" + }, + { + "value": "VOICE_INITIATED", + "name": "VOICE_INITIATED" + }, + { + "value": "VOICE_RINGING", + "name": "VOICE_RINGING" + }, + { + "value": "VOICE_ANSWERED", + "name": "VOICE_ANSWERED" + }, + { + "value": "VOICE_COMPLETED", + "name": "VOICE_COMPLETED" + }, + { + "value": "VOICE_BUSY", + "name": "VOICE_BUSY" + }, + { + "value": "VOICE_NO_ANSWER", + "name": "VOICE_NO_ANSWER" + }, + { + "value": "VOICE_FAILED", + "name": "VOICE_FAILED" + }, + { + "value": "VOICE_TTL_EXPIRED", + "name": "VOICE_TTL_EXPIRED" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#EventTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#EventType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#FieldPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[A-Za-z0-9_\\.]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#FieldPathList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#FieldPath" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#FieldRequirement": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "REQUIRED", + "name": "REQUIRED" + }, + { + "value": "CONDITIONAL", + "name": "CONDITIONAL" + }, + { + "value": "OPTIONAL", + "name": "OPTIONAL" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#FieldType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SELECT", + "name": "SELECT" + }, + { + "value": "TEXT", + "name": "TEXT" + }, + { + "value": "ATTACHMENT", + "name": "ATTACHMENT" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#FilterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[\\.:A-Za-z0-9_-]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#FilterValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#FilterValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#IamRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:\\S+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + }, + "RequestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the request.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The API encountered an unexpected error and couldn't complete the request. You might\n be able to successfully issue the request again in the future.
", + "smithy.api#error": "server", + "smithy.api#retryable": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + }, + "smithy.api#pattern": "^[A-Z]{2}$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#Keyword": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + }, + "smithy.api#pattern": "^[ \\S]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#KeywordAction": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AUTOMATIC_RESPONSE", + "name": "AUTOMATIC_RESPONSE" + }, + { + "value": "OPT_OUT", + "name": "OPT_OUT" + }, + { + "value": "OPT_IN", + "name": "OPT_IN" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#KeywordFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.pinpointsmsvoicev2#KeywordFilterName", + "traits": { + "smithy.api#documentation": "The name of the attribute to filter on.
", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.pinpointsmsvoicev2#FilterValueList", + "traits": { + "smithy.api#documentation": "An array values to filter for.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The information for keywords that meet a specified criteria.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#KeywordFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#KeywordFilter" + }, + "traits": { + "smithy.api#length": { + "max": 20 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#KeywordFilterName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "keyword-action", + "name": "KEYWORD_ACTION" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#KeywordInformation": { + "type": "structure", + "members": { + "Keyword": { + "target": "com.amazonaws.pinpointsmsvoicev2#Keyword", + "traits": { + "smithy.api#documentation": "The keyword as a string.
", + "smithy.api#required": {} + } + }, + "KeywordMessage": { + "target": "com.amazonaws.pinpointsmsvoicev2#KeywordMessage", + "traits": { + "smithy.api#documentation": "A custom message that can be used with the keyword.
", + "smithy.api#required": {} + } + }, + "KeywordAction": { + "target": "com.amazonaws.pinpointsmsvoicev2#KeywordAction", + "traits": { + "smithy.api#documentation": "The action to perform for the keyword.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The information for all keywords in a pool.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#KeywordInformationList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#KeywordInformation" + } + }, + "com.amazonaws.pinpointsmsvoicev2#KeywordList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#Keyword" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#KeywordMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + }, + "smithy.api#pattern": "^(?!\\s*$)[\\s\\S]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#KinesisFirehoseDestination": { + "type": "structure", + "members": { + "IamRoleArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#IamRoleArn", + "traits": { + "smithy.api#documentation": "The ARN of an Amazon Identity and Access Management (IAM) role that is able to write\n event data to an Amazon Firehose destination.
", + "smithy.api#required": {} + } + }, + "DeliveryStreamArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#DeliveryStreamArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the delivery stream.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the delivery stream Amazon Resource Name (ARN), and the ARN of the Identity and Access Management (IAM) role associated with an Kinesis Data Firehose event\n destination.
\nEvent destinations, such as Kinesis Data Firehose, are associated with configuration\n sets, which enable you to publish message sending events.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#LanguageCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DE_DE", + "name": "DE_DE" + }, + { + "value": "EN_GB", + "name": "EN_GB" + }, + { + "value": "EN_US", + "name": "EN_US" + }, + { + "value": "ES_419", + "name": "ES_419" + }, + { + "value": "ES_ES", + "name": "ES_ES" + }, + { + "value": "FR_CA", + "name": "FR_CA" + }, + { + "value": "FR_FR", + "name": "FR_FR" + }, + { + "value": "IT_IT", + "name": "IT_IT" + }, + { + "value": "JA_JP", + "name": "JA_JP" + }, + { + "value": "KO_KR", + "name": "KO_KR" + }, + { + "value": "PT_BR", + "name": "PT_BR" + }, + { + "value": "ZH_CN", + "name": "ZH_CN" + }, + { + "value": "ZH_TW", + "name": "ZH_TW" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#ListPoolOriginationIdentities": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#ListPoolOriginationIdentitiesRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#ListPoolOriginationIdentitiesResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all associated origination identities in your pool.
\nIf you specify filters, the output includes information for only those origination\n identities that meet the filter criteria.
", + "smithy.api#paginated": { + "items": "OriginationIdentities" + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#ListPoolOriginationIdentitiesRequest": { + "type": "structure", + "members": { + "PoolId": { + "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn", + "traits": { + "smithy.api#documentation": "The unique identifier for the pool. This value can be either the PoolId or\n PoolArn.
", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.pinpointsmsvoicev2#PoolOriginationIdentitiesFilterList", + "traits": { + "smithy.api#documentation": "An array of PoolOriginationIdentitiesFilter objects to filter the results..
" + } + }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per each request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#ListPoolOriginationIdentitiesResult": { + "type": "structure", + "members": { + "PoolArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the pool.
" + } + }, + "PoolId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique PoolId of the pool.
" + } + }, + "OriginationIdentities": { + "target": "com.amazonaws.pinpointsmsvoicev2#OriginationIdentityMetadataList", + "traits": { + "smithy.api#documentation": "An array of any OriginationIdentityMetadata objects.
" + } + }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#ListRegistrationAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#ListRegistrationAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#ListRegistrationAssociationsResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retreive all of the origination identies that are associated with a registration.
", + "smithy.api#paginated": { + "items": "RegistrationAssociations" + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#ListRegistrationAssociationsRequest": { + "type": "structure", + "members": { + "RegistrationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationIdOrArn", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationAssociationFilterList", + "traits": { + "smithy.api#documentation": "An array of RegistrationAssociationFilter to apply to the results that are returned.
" + } + }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per each request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#ListRegistrationAssociationsResult": { + "type": "structure", + "members": { + "RegistrationArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the registration.
", + "smithy.api#required": {} + } + }, + "RegistrationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} + } + }, + "RegistrationType": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationType", + "traits": { + "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
", + "smithy.api#required": {} + } + }, + "RegistrationAssociations": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationAssociationMetadataList", + "traits": { + "smithy.api#documentation": "An array of RegistrationAssociationMetadata objects.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", + "traits": { + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#ListTagsForResourceResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List all tags associated with a resource.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#AmazonResourceName", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to query for.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#ListTagsForResourceResult": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#AmazonResourceName", + "traits": { + "smithy.api#documentation": "The ARN of the resource.
" + } + }, + "Tags": { + "target": "com.amazonaws.pinpointsmsvoicev2#TagList", + "traits": { + "smithy.api#documentation": "An array of key and value pair tags that are associated with the resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#LogGroupArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:\\S+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#MaxPrice": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 8 + }, + "smithy.api#pattern": "^[0-9]{0,2}\\.[0-9]{1,5}$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#MessageType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "TRANSACTIONAL", + "name": "TRANSACTIONAL" + }, + { + "value": "PROMOTIONAL", + "name": "PROMOTIONAL" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#MessageTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#MessageType" + }, + "traits": { + "smithy.api#length": { + "max": 2 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#MonthlyLimit": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 1000000000 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#NonEmptyTagList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#NumberCapability": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SMS", + "name": "SMS" + }, + { + "value": "VOICE", + "name": "VOICE" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#NumberCapabilityList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#NumberCapability" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#NumberStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "ASSOCIATING", + "name": "ASSOCIATING" + }, + { + "value": "DISASSOCIATING", + "name": "DISASSOCIATING" + }, + { + "value": "DELETED", + "name": "DELETED" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#NumberType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SHORT_CODE", + "name": "SHORT_CODE" + }, + { + "value": "LONG_CODE", + "name": "LONG_CODE" + }, + { + "value": "TOLL_FREE", + "name": "TOLL_FREE" + }, + { + "value": "TEN_DLC", + "name": "TEN_DLC" + }, + { + "value": "SIMULATOR", + "name": "SIMULATOR" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#OptOutListInformation": { + "type": "structure", + "members": { + "OptOutListArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the OptOutList.
", + "smithy.api#required": {} + } + }, + "OptOutListName": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", + "traits": { + "smithy.api#documentation": "The name of the OptOutList.
", + "smithy.api#required": {} + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the OutOutList was created, in UNIX epoch time format.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The information for all OptOutList in an Amazon Web Services account.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#OptOutListInformationList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListInformation" + } + }, + "com.amazonaws.pinpointsmsvoicev2#OptOutListName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z0-9_-]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#OptOutListNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#OptedOutFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptedOutFilterName", + "traits": { + "smithy.api#documentation": "The name of the attribute to filter on.
", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.pinpointsmsvoicev2#FilterValueList", + "traits": { + "smithy.api#documentation": "An array of values to filter for.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The information for opted out numbers that meet a specified criteria.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#OptedOutFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptedOutFilter" + }, + "traits": { + "smithy.api#length": { + "max": 20 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#OptedOutFilterName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "end-user-opted-out", + "name": "END_USER_OPTED_OUT" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#OptedOutNumberInformation": { + "type": "structure", + "members": { + "OptedOutNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "traits": { + "smithy.api#documentation": "The phone number that is opted out.
", + "smithy.api#required": {} + } + }, + "OptedOutTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the op tout occurred, in UNIX epoch time format.
", + "smithy.api#required": {} + } + }, + "EndUserOptedOut": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "This is set to true if it was the end recipient that opted out.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The information for an opted out number in an Amazon Web Services account.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#OptedOutNumberInformationList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptedOutNumberInformation" + } + }, + "com.amazonaws.pinpointsmsvoicev2#OptedOutNumberList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#OriginationIdentityMetadata": { + "type": "structure", + "members": { + "OriginationIdentityArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the origination identity.
", + "smithy.api#required": {} + } + }, + "OriginationIdentity": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the origination identity.
", + "smithy.api#required": {} + } + }, + "IsoCountryCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", + "traits": { + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
", + "smithy.api#required": {} + } + }, + "NumberCapabilities": { + "target": "com.amazonaws.pinpointsmsvoicev2#NumberCapabilityList", + "traits": { + "smithy.api#documentation": "Describes if the origination identity can be used for text messages, voice calls or\n both.
", + "smithy.api#required": {} + } + }, + "PhoneNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "traits": { + "smithy.api#documentation": "The phone number in E.164 format.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The metadata for an origination identity associated with a pool.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#OriginationIdentityMetadataList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#OriginationIdentityMetadata" + } + }, + "com.amazonaws.pinpointsmsvoicev2#PhoneNumber": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + }, + "smithy.api#pattern": "^\\+?[1-9][0-9]{1,18}$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#PhoneNumberFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberFilterName", + "traits": { + "smithy.api#documentation": "The name of the attribute to filter on.
", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.pinpointsmsvoicev2#FilterValueList", + "traits": { + "smithy.api#documentation": "An array values to filter for.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The information for a phone number that meets a specified criteria.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#PhoneNumberFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberFilter" + }, + "traits": { + "smithy.api#length": { + "max": 20 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#PhoneNumberFilterName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "status", + "name": "STATUS" + }, + { + "value": "iso-country-code", + "name": "ISO_COUNTRY_CODE" + }, + { + "value": "message-type", + "name": "MESSAGE_TYPE" + }, + { + "value": "number-capability", + "name": "NUMBER_CAPABILITY" + }, + { + "value": "number-type", + "name": "NUMBER_TYPE" + }, + { + "value": "two-way-enabled", + "name": "TWO_WAY_ENABLED" + }, + { + "value": "self-managed-opt-outs-enabled", + "name": "SELF_MANAGED_OPT_OUTS_ENABLED" + }, + { + "value": "opt-out-list-name", + "name": "OPT_OUT_LIST_NAME" + }, + { + "value": "deletion-protection-enabled", + "name": "DELETION_PROTECTION_ENABLED" + }, + { + "value": "two-way-channel-arn", + "name": "TWO_WAY_CHANNEL_ARN" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#PhoneNumberIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberIdOrArn" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#PhoneNumberIdOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#PhoneNumberInformation": { + "type": "structure", + "members": { + "PhoneNumberArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the phone number.
", + "smithy.api#required": {} + } + }, + "PhoneNumberId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the phone number.
" + } + }, + "PhoneNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "traits": { + "smithy.api#documentation": "The phone number in E.164 format.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.pinpointsmsvoicev2#NumberStatus", + "traits": { + "smithy.api#documentation": "The current status of the phone number.
", + "smithy.api#required": {} + } + }, + "IsoCountryCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", + "traits": { + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
", + "smithy.api#required": {} + } + }, + "MessageType": { + "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", + "traits": { + "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
", + "smithy.api#required": {} + } + }, + "NumberCapabilities": { + "target": "com.amazonaws.pinpointsmsvoicev2#NumberCapabilityList", + "traits": { + "smithy.api#documentation": "Describes if the origination identity can be used for text messages, voice calls or\n both.
", + "smithy.api#required": {} + } + }, + "NumberType": { + "target": "com.amazonaws.pinpointsmsvoicev2#NumberType", + "traits": { + "smithy.api#documentation": "The type of phone number.
", + "smithy.api#required": {} + } + }, + "MonthlyLeasingPrice": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The price, in US dollars, to lease the phone number.
", + "smithy.api#required": {} + } + }, + "TwoWayEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients using the TwoWayChannelArn.
", + "smithy.api#required": {} + } + }, + "TwoWayChannelArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#TwoWayChannelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the two way channel.
" + } + }, + "TwoWayChannelRole": { + "target": "com.amazonaws.pinpointsmsvoicev2#IamRoleArn", + "traits": { + "smithy.api#documentation": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + } + }, + "SelfManagedOptOutsEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "When set to false an end recipient sends a message that begins with HELP or STOP to\n one of your dedicated numbers, Amazon Pinpoint automatically replies with a\n customizable message and adds the end recipient to the OptOutList. When set to true\n you're responsible for responding to HELP and STOP requests. You're also responsible for\n tracking and honoring opt-out request. For more information see Self-managed opt-outs\n
", + "smithy.api#required": {} + } + }, + "OptOutListName": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", + "traits": { + "smithy.api#documentation": "The name of the OptOutList associated with the phone number.
", + "smithy.api#required": {} + } + }, + "DeletionProtectionEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "When set to true the phone number can't be deleted.
", + "smithy.api#required": {} + } + }, + "PoolId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the pool associated with the phone number.
" + } + }, + "RegistrationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration.
" + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the phone number was created, in UNIX epoch time format.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The information for a phone number, in E.164 format, in an Amazon Web Services account.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#PhoneNumberInformationList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberInformation" + } + }, + "com.amazonaws.pinpointsmsvoicev2#PhoneOrPoolIdOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#PhoneOrSenderIdOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#PinpointSMSVoiceV2": { + "type": "service", + "version": "2022-03-31", + "operations": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AssociateOriginationIdentity" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#CreateConfigurationSet" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#CreateEventDestination" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#CreateOptOutList" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#CreatePool" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#CreateRegistration" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationAssociation" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationAttachment" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationVersion" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#CreateVerifiedDestinationNumber" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteConfigurationSet" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultMessageType" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultSenderId" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteEventDestination" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteKeyword" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteOptedOutNumber" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutList" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DeletePool" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteRegistration" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteRegistrationAttachment" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteRegistrationFieldValue" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteTextMessageSpendLimitOverride" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteVerifiedDestinationNumber" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteVoiceMessageSpendLimitOverride" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeAccountAttributes" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeAccountLimits" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeConfigurationSets" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeKeywords" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeOptedOutNumbers" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeOptOutLists" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribePhoneNumbers" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribePools" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationAttachments" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationFieldDefinitions" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationFieldValues" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrations" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationSectionDefinitions" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationTypeDefinitions" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeRegistrationVersions" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeSenderIds" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeSpendLimits" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DescribeVerifiedDestinationNumbers" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DisassociateOriginationIdentity" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DiscardRegistrationVersion" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ListPoolOriginationIdentities" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ListRegistrationAssociations" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ListTagsForResource" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#PutKeyword" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#PutOptedOutNumber" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#PutRegistrationFieldValue" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ReleasePhoneNumber" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ReleaseSenderId" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#RequestPhoneNumber" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#RequestSenderId" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#SendDestinationNumberVerificationCode" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#SendTextMessage" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#SendVoiceMessage" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#SetDefaultMessageType" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#SetDefaultSenderId" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#SetTextMessageSpendLimitOverride" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#SetVoiceMessageSpendLimitOverride" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#SubmitRegistrationVersion" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#TagResource" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#UntagResource" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#UpdateEventDestination" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#UpdatePhoneNumber" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#UpdatePool" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#UpdateSenderId" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#VerifyDestinationNumber" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Pinpoint SMS Voice V2", + "endpointPrefix": "sms-voice", + "arnNamespace": "sms-voice" + }, + "aws.auth#sigv4": { + "name": "sms-voice" + }, + "aws.protocols#awsJson1_0": {}, + "smithy.api#documentation": "Welcome to the Amazon Pinpoint SMS and Voice, version 2 API Reference.\n This guide provides information about Amazon Pinpoint SMS and Voice, version 2 API\n resources, including supported HTTP methods, parameters, and schemas.
\nAmazon Pinpoint is an Amazon Web Services service that you can use to engage with\n your recipients across multiple messaging channels. The Amazon Pinpoint SMS and\n Voice, version 2 API provides programmatic access to options that are unique to the SMS\n and voice channels and supplements the resources provided by the Amazon Pinpoint\n API.
\nIf you're new to Amazon Pinpoint, it's also helpful to review the \n Amazon Pinpoint Developer Guide. The Amazon Pinpoint\n Developer Guide provides tutorials, code samples, and procedures that\n demonstrate how to use Amazon Pinpoint features programmatically and how to integrate\n Amazon Pinpoint functionality into mobile apps and other types of applications.\n The guide also provides key information, such as Amazon Pinpoint integration with\n other Amazon Web Services services, and the quotas that apply to use of the\n service.
\n\n Regional availability\n
\nThe Amazon Pinpoint SMS and Voice, version 2 API Reference is\n available in several Amazon Web Services Regions and it provides an endpoint for each of\n these Regions. For a list of all the Regions and endpoints where the API is currently\n available, see Amazon Web Services Service Endpoints and Amazon Pinpoint\n endpoints and quotas in the Amazon Web Services General Reference. To\n learn more about Amazon Web Services Regions, see Managing\n Amazon Web Services Regions in the Amazon Web Services General\n Reference.
\nIn each Region, Amazon Web Services maintains multiple Availability Zones. These\n Availability Zones are physically isolated from each other, but are united by private,\n low-latency, high-throughput, and highly redundant network connections. These\n Availability Zones enable us to provide very high levels of availability and redundancy,\n while also minimizing latency. To learn more about the number of Availability Zones that\n are available in each Region, see Amazon Web Services\n Global Infrastructure.\n
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + }, + "smithy.api#title": "Amazon Pinpoint SMS Voice V2", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" }, true ] @@ -4703,11 +7134,2879 @@ } } }, - "com.amazonaws.pinpointsmsvoicev2#PoolFilter": { + "com.amazonaws.pinpointsmsvoicev2#PoolFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.pinpointsmsvoicev2#PoolFilterName", + "traits": { + "smithy.api#documentation": "The name of the attribute to filter on.
", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.pinpointsmsvoicev2#FilterValueList", + "traits": { + "smithy.api#documentation": "An array values to filter for.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The information for a pool that meets a specified criteria.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#PoolFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#PoolFilter" + }, + "traits": { + "smithy.api#length": { + "max": 20 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#PoolFilterName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "status", + "name": "STATUS" + }, + { + "value": "message-type", + "name": "MESSAGE_TYPE" + }, + { + "value": "two-way-enabled", + "name": "TWO_WAY_ENABLED" + }, + { + "value": "self-managed-opt-outs-enabled", + "name": "SELF_MANAGED_OPT_OUTS_ENABLED" + }, + { + "value": "opt-out-list-name", + "name": "OPT_OUT_LIST_NAME" + }, + { + "value": "shared-routes-enabled", + "name": "SHARED_ROUTES_ENABLED" + }, + { + "value": "deletion-protection-enabled", + "name": "DELETION_PROTECTION_ENABLED" + }, + { + "value": "two-way-channel-arn", + "name": "TWO_WAY_CHANNEL_ARN" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#PoolIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#PoolInformation": { + "type": "structure", + "members": { + "PoolArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the pool.
", + "smithy.api#required": {} + } + }, + "PoolId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the pool.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.pinpointsmsvoicev2#PoolStatus", + "traits": { + "smithy.api#documentation": "The current status of the pool.
", + "smithy.api#required": {} + } + }, + "MessageType": { + "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", + "traits": { + "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
", + "smithy.api#required": {} + } + }, + "TwoWayEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "When set to true you can receive incoming text messages from your end recipients using\n the TwoWayChannelArn.
", + "smithy.api#required": {} + } + }, + "TwoWayChannelArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#TwoWayChannelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the two way channel.
" + } + }, + "TwoWayChannelRole": { + "target": "com.amazonaws.pinpointsmsvoicev2#IamRoleArn", + "traits": { + "smithy.api#documentation": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + } + }, + "SelfManagedOptOutsEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "When set to false, an end recipient sends a message that begins with HELP or STOP to\n one of your dedicated numbers, Amazon Pinpoint automatically replies with a\n customizable message and adds the end recipient to the OptOutList. When set to true\n you're responsible for responding to HELP and STOP requests. You're also responsible for\n tracking and honoring opt-out requests. For more information see Self-managed opt-outs\n
", + "smithy.api#required": {} + } + }, + "OptOutListName": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", + "traits": { + "smithy.api#documentation": "The name of the OptOutList associated with the pool.
", + "smithy.api#required": {} + } + }, + "SharedRoutesEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Allows you to enable shared routes on your pool.
\nBy default, this is set to False. If you set this value to\n True, your messages are sent using phone numbers or sender IDs\n (depending on the country) that are shared with other Amazon Pinpoint users. In some\n countries, such as the United States, senders aren't allowed to use shared routes and\n must use a dedicated phone number or short code.
When set to true the pool can't be deleted.
", + "smithy.api#required": {} + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the pool was created, in UNIX epoch time format.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The information for a pool in an Amazon Web Services account.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#PoolInformationList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#PoolInformation" + } + }, + "com.amazonaws.pinpointsmsvoicev2#PoolOriginationIdentitiesFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.pinpointsmsvoicev2#PoolOriginationIdentitiesFilterName", + "traits": { + "smithy.api#documentation": "The name of the attribute to filter on.
", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.pinpointsmsvoicev2#FilterValueList", + "traits": { + "smithy.api#documentation": "An array values to filter for.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Information about origination identities associated with a pool that meets a specified\n criteria.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#PoolOriginationIdentitiesFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#PoolOriginationIdentitiesFilter" + }, + "traits": { + "smithy.api#length": { + "max": 20 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#PoolOriginationIdentitiesFilterName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "iso-country-code", + "name": "ISO_COUNTRY_CODE" + }, + { + "value": "number-capability", + "name": "NUMBER_CAPABILITY" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#PoolStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATING", + "name": "CREATING" + }, + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "DELETING", + "name": "DELETING" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#PutKeyword": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#PutKeywordRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#PutKeywordResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates or updates a keyword configuration on an origination phone number or\n pool.
\nA keyword is a word that you can search for on a particular phone number or pool. It\n is also a specific word or phrase that an end user can send to your number to elicit a\n response, such as an informational message or a special offer. When your number receives\n a message that begins with a keyword, Amazon Pinpoint responds with a customizable\n message.
\nIf you specify a keyword that isn't valid, an error is returned.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#PutKeywordRequest": { + "type": "structure", + "members": { + "OriginationIdentity": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneOrPoolIdOrArn", + "traits": { + "smithy.api#documentation": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers get the values for\n PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used\n to get the values for SenderId and SenderIdArn.
", + "smithy.api#required": {} + } + }, + "Keyword": { + "target": "com.amazonaws.pinpointsmsvoicev2#Keyword", + "traits": { + "smithy.api#documentation": "The new keyword to add.
", + "smithy.api#required": {} + } + }, + "KeywordMessage": { + "target": "com.amazonaws.pinpointsmsvoicev2#KeywordMessage", + "traits": { + "smithy.api#documentation": "The message associated with the keyword.
", + "smithy.api#required": {} + } + }, + "KeywordAction": { + "target": "com.amazonaws.pinpointsmsvoicev2#KeywordAction", + "traits": { + "smithy.api#documentation": "The action to perform for the new keyword when it is received.
\nAUTOMATIC_RESPONSE: A message is sent to the recipient.
\nOPT_OUT: Keeps the recipient from receiving future messages.
\nOPT_IN: The recipient wants to receive future messages.
\nThe PhoneNumberArn or PoolArn that the keyword was associated with.
" + } + }, + "OriginationIdentity": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The PhoneNumberId or PoolId that the keyword was associated with.
" + } + }, + "Keyword": { + "target": "com.amazonaws.pinpointsmsvoicev2#Keyword", + "traits": { + "smithy.api#documentation": "The keyword that was added.
" + } + }, + "KeywordMessage": { + "target": "com.amazonaws.pinpointsmsvoicev2#KeywordMessage", + "traits": { + "smithy.api#documentation": "The message associated with the keyword.
" + } + }, + "KeywordAction": { + "target": "com.amazonaws.pinpointsmsvoicev2#KeywordAction", + "traits": { + "smithy.api#documentation": "The action to perform when the keyword is used.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#PutOptedOutNumber": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#PutOptedOutNumberRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#PutOptedOutNumberResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an opted out destination phone number in the opt-out list.
\nIf the destination phone number isn't valid or if the specified opt-out list doesn't\n exist, an error is returned.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#PutOptedOutNumberRequest": { + "type": "structure", + "members": { + "OptOutListName": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", + "traits": { + "smithy.api#documentation": "The OptOutListName or OptOutListArn to add the phone number to.
", + "smithy.api#required": {} + } + }, + "OptedOutNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "traits": { + "smithy.api#documentation": "The phone number to add to the OptOutList in E.164 format.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#PutOptedOutNumberResult": { + "type": "structure", + "members": { + "OptOutListArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The OptOutListArn that the phone number was removed from.
" + } + }, + "OptOutListName": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", + "traits": { + "smithy.api#documentation": "The OptOutListName that the phone number was removed from.
" + } + }, + "OptedOutNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "traits": { + "smithy.api#documentation": "The phone number that was added to the OptOutList.
" + } + }, + "OptedOutTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the phone number was added to the OptOutList, in UNIX epoch time format.
" + } + }, + "EndUserOptedOut": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "This is true if it was the end user who requested their phone number be removed.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#PutRegistrationFieldValue": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#PutRegistrationFieldValueRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#PutRegistrationFieldValueResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates or updates a field value for a registration.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#PutRegistrationFieldValueRequest": { + "type": "structure", + "members": { + "RegistrationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationIdOrArn", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} + } + }, + "FieldPath": { + "target": "com.amazonaws.pinpointsmsvoicev2#FieldPath", + "traits": { + "smithy.api#documentation": "The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
", + "smithy.api#required": {} + } + }, + "SelectChoices": { + "target": "com.amazonaws.pinpointsmsvoicev2#SelectChoiceList", + "traits": { + "smithy.api#documentation": "An array of values for the form field.
" + } + }, + "TextValue": { + "target": "com.amazonaws.pinpointsmsvoicev2#TextValue", + "traits": { + "smithy.api#documentation": "The text data for a free form field.
" + } + }, + "RegistrationAttachmentId": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationAttachmentIdOrArn", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration attachment.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#PutRegistrationFieldValueResult": { + "type": "structure", + "members": { + "RegistrationArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the registration.
", + "smithy.api#required": {} + } + }, + "RegistrationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} + } + }, + "VersionNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionNumber", + "traits": { + "smithy.api#documentation": "The version number of the registration.
", + "smithy.api#required": {} + } + }, + "FieldPath": { + "target": "com.amazonaws.pinpointsmsvoicev2#FieldPath", + "traits": { + "smithy.api#documentation": "The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
", + "smithy.api#required": {} + } + }, + "SelectChoices": { + "target": "com.amazonaws.pinpointsmsvoicev2#SelectChoiceList", + "traits": { + "smithy.api#documentation": "An array of values for the form field.
" + } + }, + "TextValue": { + "target": "com.amazonaws.pinpointsmsvoicev2#TextValue", + "traits": { + "smithy.api#documentation": "The text data for a free form field.
" + } + }, + "RegistrationAttachmentId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration attachment.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationAssociationBehavior": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ASSOCIATE_BEFORE_SUBMIT", + "name": "ASSOCIATE_BEFORE_SUBMIT" + }, + { + "value": "ASSOCIATE_ON_APPROVAL", + "name": "ASSOCIATE_ON_APPROVAL" + }, + { + "value": "ASSOCIATE_AFTER_COMPLETE", + "name": "ASSOCIATE_AFTER_COMPLETE" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationAssociationFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationAssociationFilterName", + "traits": { + "smithy.api#documentation": "The name of the attribute to filter on.
", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.pinpointsmsvoicev2#FilterValueList", + "traits": { + "smithy.api#documentation": "An array of values to filter for.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The filter definition for filtering registrations that meets a specified criteria.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationAssociationFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationAssociationFilter" + }, + "traits": { + "smithy.api#length": { + "max": 20 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationAssociationFilterName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "resource-type", + "name": "RESOURCE_TYPE" + }, + { + "value": "iso-country-code", + "name": "ISO_COUNTRY_CODE" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationAssociationMetadata": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the origination identity that is associated with the registration.
", + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.
", + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The origination identity type.
", + "smithy.api#required": {} + } + }, + "IsoCountryCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", + "traits": { + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" + } + }, + "PhoneNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "traits": { + "smithy.api#documentation": "The phone number associated with the registration in E.164 format.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata for the origination identity that is associated with the registration.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationAssociationMetadataList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationAssociationMetadata" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationAttachmentFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationAttachmentFilterName", + "traits": { + "smithy.api#documentation": "The name of the attribute to filter on.
", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.pinpointsmsvoicev2#FilterValueList", + "traits": { + "smithy.api#documentation": "An array of values to filter on.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The filter definition for filtering registration attachments that meets a specified criteria.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationAttachmentFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationAttachmentFilter" + }, + "traits": { + "smithy.api#length": { + "max": 20 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationAttachmentFilterName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "attachment-status", + "name": "ATTACHMENT_STATUS" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationAttachmentIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationIdOrArn" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationAttachmentIdOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationAttachmentsInformation": { + "type": "structure", + "members": { + "RegistrationAttachmentArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the registration attachment.
", + "smithy.api#required": {} + } + }, + "RegistrationAttachmentId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration attachment.
", + "smithy.api#required": {} + } + }, + "AttachmentStatus": { + "target": "com.amazonaws.pinpointsmsvoicev2#AttachmentStatus", + "traits": { + "smithy.api#documentation": "The status of the registration attachment.
\n\n UPLOAD_IN_PROGRESS The attachment is being uploaded.
\n UPLOAD_COMPLETE The attachment has been uploaded.
\n UPLOAD_FAILED The attachment failed to uploaded.
\n DELETED The attachment has been deleted..
A description of why the upload didn't successfully complete.
" + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the registration attachment was created, in UNIX epoch time format.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information on the specified registration attachments.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationAttachmentsInformationList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationAttachmentsInformation" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationDeniedReasonInformation": { + "type": "structure", + "members": { + "Reason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The reason a registration was rejected.
", + "smithy.api#required": {} + } + }, + "ShortDescription": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A short description of the rejection reason.
", + "smithy.api#required": {} + } + }, + "LongDescription": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A long description of the rejection reason.
" + } + }, + "DocumentationTitle": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The title of the document.
" + } + }, + "DocumentationLink": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The link to the document.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides the reason a registration was rejected.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationDeniedReasonInformationList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationDeniedReasonInformation" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationDisassociationBehavior": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DISASSOCIATE_ALL_CLOSES_REGISTRATION", + "name": "DISASSOCIATE_ALL_CLOSES_REGISTRATION" + }, + { + "value": "DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION", + "name": "DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION" + }, + { + "value": "DELETE_REGISTRATION_DISASSOCIATES", + "name": "DELETE_REGISTRATION_DISASSOCIATES" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationFieldDefinition": { + "type": "structure", + "members": { + "SectionPath": { + "target": "com.amazonaws.pinpointsmsvoicev2#SectionPath", + "traits": { + "smithy.api#documentation": "The section path of the field.
", + "smithy.api#required": {} + } + }, + "FieldPath": { + "target": "com.amazonaws.pinpointsmsvoicev2#FieldPath", + "traits": { + "smithy.api#documentation": "The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
", + "smithy.api#required": {} + } + }, + "FieldType": { + "target": "com.amazonaws.pinpointsmsvoicev2#FieldType", + "traits": { + "smithy.api#documentation": "The type of field.
", + "smithy.api#required": {} + } + }, + "FieldRequirement": { + "target": "com.amazonaws.pinpointsmsvoicev2#FieldRequirement", + "traits": { + "smithy.api#documentation": "Specifies if the field for the registration form is required, conditional or optional.
", + "smithy.api#required": {} + } + }, + "SelectValidation": { + "target": "com.amazonaws.pinpointsmsvoicev2#SelectValidation", + "traits": { + "smithy.api#documentation": "The validation rules for a select field.
" + } + }, + "TextValidation": { + "target": "com.amazonaws.pinpointsmsvoicev2#TextValidation", + "traits": { + "smithy.api#documentation": "The validation rules for a text field.
" + } + }, + "DisplayHints": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationFieldDisplayHints", + "traits": { + "smithy.api#documentation": "An array of RegistrationFieldDisplayHints objects for the field.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Provides a description of the specified field.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationFieldDefinitionList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationFieldDefinition" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationFieldDisplayHints": { + "type": "structure", + "members": { + "Title": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The title of the display hint.
", + "smithy.api#required": {} + } + }, + "ShortDescription": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A short description of the display hint.
", + "smithy.api#required": {} + } + }, + "LongDescription": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A full description of the display hint.
" + } + }, + "DocumentationTitle": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The title of the document the display hint is associated with.
" + } + }, + "DocumentationLink": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The link to the document the display hint is associated with.
" + } + }, + "SelectOptionDescriptions": { + "target": "com.amazonaws.pinpointsmsvoicev2#SelectOptionDescriptionsList", + "traits": { + "smithy.api#documentation": "An array of SelectOptionDescription objects.
" + } + }, + "TextValidationDescription": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The validation rules for the text field.
" + } + }, + "ExampleTextValue": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Example text of what the value of a field should contain.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides help information on the registration field.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationFieldValueInformation": { + "type": "structure", + "members": { + "FieldPath": { + "target": "com.amazonaws.pinpointsmsvoicev2#FieldPath", + "traits": { + "smithy.api#documentation": "The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
", + "smithy.api#required": {} + } + }, + "SelectChoices": { + "target": "com.amazonaws.pinpointsmsvoicev2#SelectChoiceList", + "traits": { + "smithy.api#documentation": "An array of values for the form field.
" + } + }, + "TextValue": { + "target": "com.amazonaws.pinpointsmsvoicev2#TextValue", + "traits": { + "smithy.api#documentation": "The text data for a free form field.
" + } + }, + "RegistrationAttachmentId": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationAttachmentIdOrArn", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration attachment.
" + } + }, + "DeniedReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A description of why the registration was denied.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides the values of the specified field.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationFieldValueInformationList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationFieldValueInformation" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationFilterName", + "traits": { + "smithy.api#documentation": "The name of the attribute to filter on.
", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.pinpointsmsvoicev2#FilterValueList", + "traits": { + "smithy.api#documentation": "An array of values to filter on.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The filter definition for filtering registrations that meets a specified criteria.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationFilter" + }, + "traits": { + "smithy.api#length": { + "max": 20 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationFilterName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "registration-type", + "name": "REGISTRATION_TYPE" + }, + { + "value": "registration-status", + "name": "REGISTRATION_STATUS" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationIdOrArn" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationIdOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationInformation": { + "type": "structure", + "members": { + "RegistrationArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the registration.
", + "smithy.api#required": {} + } + }, + "RegistrationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} + } + }, + "RegistrationType": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationType", + "traits": { + "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
", + "smithy.api#required": {} + } + }, + "RegistrationStatus": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationStatus", + "traits": { + "smithy.api#documentation": "The status of the registration.
\n\n CREATED: Your registration is created but not submitted.
\n SUBMITTED: Your registration has been submitted and is awaiting review.
\n REVIEWING: Your registration has been accepted and is being reviewed.
\n PROVISIONING: Your registration has been approved and your origination identity is being created.
\n COMPLETE: Your registration has been approved and and your origination identity has been created.
\n REQUIRES_UPDATES: You must fix your registration and resubmit it.
\n CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number.
\n DELETED: The registration has been deleted.
The current version number of the registration.
", + "smithy.api#required": {} + } + }, + "ApprovedVersionNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionNumber", + "traits": { + "smithy.api#documentation": "The version number of the registration that was approved.
" + } + }, + "LatestDeniedVersionNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionNumber", + "traits": { + "smithy.api#documentation": "The latest version number of the registration that was denied.
" + } + }, + "AdditionalAttributes": { + "target": "com.amazonaws.pinpointsmsvoicev2#StringMap", + "traits": { + "smithy.api#documentation": "Metadata about a given registration which is specific to that registration type.
" + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the registration was created, in UNIX epoch time format.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information about the requested registration.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationInformationList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationInformation" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationSectionDefinition": { + "type": "structure", + "members": { + "SectionPath": { + "target": "com.amazonaws.pinpointsmsvoicev2#SectionPath", + "traits": { + "smithy.api#documentation": "The path to the section of the registration.
", + "smithy.api#required": {} + } + }, + "DisplayHints": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationSectionDisplayHints", + "traits": { + "smithy.api#documentation": "The path to the section of the registration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information on the specified section definition.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationSectionDefinitionList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationSectionDefinition" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationSectionDisplayHints": { + "type": "structure", + "members": { + "Title": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The title of the display hint.
", + "smithy.api#required": {} + } + }, + "ShortDescription": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A short description of the display hint.
", + "smithy.api#required": {} + } + }, + "LongDescription": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A full description of the display hint.
" + } + }, + "DocumentationTitle": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The title of the document the display hint is associated with.
" + } + }, + "DocumentationLink": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The link to the document the display hint is associated with.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides help information on the registration section.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATED", + "name": "CREATED" + }, + { + "value": "SUBMITTED", + "name": "SUBMITTED" + }, + { + "value": "REVIEWING", + "name": "REVIEWING" + }, + { + "value": "PROVISIONING", + "name": "PROVISIONING" + }, + { + "value": "COMPLETE", + "name": "COMPLETE" + }, + { + "value": "REQUIRES_UPDATES", + "name": "REQUIRES_UPDATES" + }, + { + "value": "CLOSED", + "name": "CLOSED" + }, + { + "value": "DELETED", + "name": "DELETED" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z0-9_]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationTypeDefinition": { + "type": "structure", + "members": { + "RegistrationType": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationType", + "traits": { + "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
", + "smithy.api#required": {} + } + }, + "SupportedAssociations": { + "target": "com.amazonaws.pinpointsmsvoicev2#SupportedAssociationList", + "traits": { + "smithy.api#documentation": "The supported association behavior for the registration type.
" + } + }, + "DisplayHints": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationTypeDisplayHints", + "traits": { + "smithy.api#documentation": "Provides help information on the registration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information on the supported registration type.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationTypeDefinitionList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationTypeDefinition" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationTypeDisplayHints": { + "type": "structure", + "members": { + "Title": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The title of the display hint.
", + "smithy.api#required": {} + } + }, + "ShortDescription": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A short description of the display hint.
" + } + }, + "LongDescription": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A full description of the display hint.
" + } + }, + "DocumentationTitle": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The title of the document the display hint is associated with.
" + } + }, + "DocumentationLink": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The link to the document the display hint is associated with.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides help information on the registration type.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationTypeFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationTypeFilterName", + "traits": { + "smithy.api#documentation": "The name of the attribute to filter on.
", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.pinpointsmsvoicev2#FilterValueList", + "traits": { + "smithy.api#documentation": "An array of values to filter on.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The filter definition for filtering registration types that meets a specified criteria.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationTypeFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationTypeFilter" + }, + "traits": { + "smithy.api#length": { + "max": 20 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationTypeFilterName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "supported-association-resource-type", + "name": "SUPPORTED_ASSOCIATION_RESOURCE_TYPE" + }, + { + "value": "supported-association-iso-country-code", + "name": "SUPPORTED_ASSOCIATION_ISO_COUNTRY_CODE" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationType" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionFilterName", + "traits": { + "smithy.api#documentation": "The name of the attribute to filter on.
", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.pinpointsmsvoicev2#FilterValueList", + "traits": { + "smithy.api#documentation": "An array of values to filter on.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The filter definition for filtering registration versions that meets a specified criteria.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionFilter" + }, + "traits": { + "smithy.api#length": { + "max": 20 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionFilterName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "registration-version-status", + "name": "REGISTRATION_VERSION_STATUS" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionInformation": { + "type": "structure", + "members": { + "VersionNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionNumber", + "traits": { + "smithy.api#documentation": "The version number of the registration.
", + "smithy.api#required": {} + } + }, + "RegistrationVersionStatus": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionStatus", + "traits": { + "smithy.api#documentation": "The status of the registration.
\n\n DRAFT: The initial status of a registration version after it’s created.
\n SUBMITTED: Your registration has been submitted.
\n REVIEWING: Your registration has been accepted and is being reviewed.
\n APPROVED: Your registration has been approved.
\n DISCARDED: You've abandon this version of their registration to start over with a new version.
\n DENIED: You must fix your registration and resubmit it.
\n REVOKED: Your previously approved registration has been revoked.
\n ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.
The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.
", + "smithy.api#required": {} + } + }, + "DeniedReasons": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationDeniedReasonInformationList", + "traits": { + "smithy.api#documentation": "An array of RegistrationDeniedReasonInformation objects.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information about the specified version of the registration.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionInformationList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionInformation" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionNumber": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100000 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionNumberList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionNumber" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DRAFT", + "name": "DRAFT" + }, + { + "value": "SUBMITTED", + "name": "SUBMITTED" + }, + { + "value": "REVIEWING", + "name": "REVIEWING" + }, + { + "value": "APPROVED", + "name": "APPROVED" + }, + { + "value": "DISCARDED", + "name": "DISCARDED" + }, + { + "value": "DENIED", + "name": "DENIED" + }, + { + "value": "REVOKED", + "name": "REVOKED" + }, + { + "value": "ARCHIVED", + "name": "ARCHIVED" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionStatusHistory": { + "type": "structure", + "members": { + "DraftTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the registration was in the draft state, in UNIX epoch time format.
", + "smithy.api#required": {} + } + }, + "SubmittedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the registration was in the submitted state, in UNIX epoch time format.
" + } + }, + "ReviewingTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the registration was in the reviewing state, in UNIX epoch time format.
" + } + }, + "ApprovedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the registration was in the approved state, in UNIX epoch time format.
" + } + }, + "DiscardedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the registration was in the discarded state, in UNIX epoch time format.
" + } + }, + "DeniedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the registration was in the denied state, in UNIX epoch time format.
" + } + }, + "RevokedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the registration was in the revoked state, in UNIX epoch time format.
" + } + }, + "ArchivedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the registration was in the archived state, in UNIX epoch time format.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#ReleasePhoneNumber": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#ReleasePhoneNumberRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#ReleasePhoneNumberResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Releases an existing origination phone number in your account. Once released, a phone\n number is no longer available for sending messages.
\nIf the origination phone number has deletion protection enabled or is associated with\n a pool, an error is returned.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#ReleasePhoneNumberRequest": { + "type": "structure", + "members": { + "PhoneNumberId": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberIdOrArn", + "traits": { + "smithy.api#documentation": "The PhoneNumberId or PhoneNumberArn of the phone number to release. You can use DescribePhoneNumbers to get the values for PhoneNumberId and\n PhoneNumberArn.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#ReleasePhoneNumberResult": { + "type": "structure", + "members": { + "PhoneNumberArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The PhoneNumberArn of the phone number that was released.
" + } + }, + "PhoneNumberId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The PhoneNumberId of the phone number that was released.
" + } + }, + "PhoneNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "traits": { + "smithy.api#documentation": "The phone number that was released.
" + } + }, + "Status": { + "target": "com.amazonaws.pinpointsmsvoicev2#NumberStatus", + "traits": { + "smithy.api#documentation": "The current status of the request.
" + } + }, + "IsoCountryCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", + "traits": { + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or\n region.
" + } + }, + "MessageType": { + "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", + "traits": { + "smithy.api#documentation": "The message type that was associated with the phone number.
" + } + }, + "NumberCapabilities": { + "target": "com.amazonaws.pinpointsmsvoicev2#NumberCapabilityList", + "traits": { + "smithy.api#documentation": "Specifies if the number could be used for text messages, voice, or both.
" + } + }, + "NumberType": { + "target": "com.amazonaws.pinpointsmsvoicev2#NumberType", + "traits": { + "smithy.api#documentation": "The type of number that was released.
" + } + }, + "MonthlyLeasingPrice": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The monthly price of the phone number, in US dollars.
" + } + }, + "TwoWayEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients.
" + } + }, + "TwoWayChannelArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#TwoWayChannelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the TwoWayChannel.
" + } + }, + "TwoWayChannelRole": { + "target": "com.amazonaws.pinpointsmsvoicev2#IamRoleArn", + "traits": { + "smithy.api#documentation": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + } + }, + "SelfManagedOptOutsEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins\n with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically\n replies with a customizable message and adds the end recipient to the OptOutList. When\n set to true you're responsible for responding to HELP and STOP requests. You're also\n responsible for tracking and honoring opt-out requests.
" + } + }, + "OptOutListName": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", + "traits": { + "smithy.api#documentation": "The name of the OptOutList that was associated with the phone number.
" + } + }, + "RegistrationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration.
" + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the phone number was created, in UNIX epoch time format.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#ReleaseSenderId": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#ReleaseSenderIdRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#ReleaseSenderIdResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Releases an existing sender ID in your account.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#ReleaseSenderIdRequest": { + "type": "structure", + "members": { + "SenderId": { + "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdOrArn", + "traits": { + "smithy.api#documentation": "The sender ID to release.
", + "smithy.api#required": {} + } + }, + "IsoCountryCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", + "traits": { + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#ReleaseSenderIdResult": { + "type": "structure", + "members": { + "SenderIdArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the SenderId.
", + "smithy.api#required": {} + } + }, + "SenderId": { + "target": "com.amazonaws.pinpointsmsvoicev2#SenderId", + "traits": { + "smithy.api#documentation": "The sender ID that was released.
", + "smithy.api#required": {} + } + }, + "IsoCountryCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", + "traits": { + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
", + "smithy.api#required": {} + } + }, + "MessageTypes": { + "target": "com.amazonaws.pinpointsmsvoicev2#MessageTypeList", + "traits": { + "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
", + "smithy.api#required": {} + } + }, + "MonthlyLeasingPrice": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The monthly price, in US dollars, to lease the sender ID.
", + "smithy.api#required": {} + } + }, + "Registered": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "True if the sender ID is registered.
", + "smithy.api#required": {} + } + }, + "RegistrationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#RequestPhoneNumber": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#RequestPhoneNumberRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#RequestPhoneNumberResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Request an origination phone number for use in your account. For more information on\n phone number request see Requesting a\n number in the Amazon Pinpoint User Guide.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RequestPhoneNumberRequest": { + "type": "structure", + "members": { + "IsoCountryCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", + "traits": { + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
", + "smithy.api#required": {} + } + }, + "MessageType": { + "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", + "traits": { + "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
", + "smithy.api#required": {} + } + }, + "NumberCapabilities": { + "target": "com.amazonaws.pinpointsmsvoicev2#NumberCapabilityList", + "traits": { + "smithy.api#documentation": "Indicates if the phone number will be used for text messages, voice messages, or both.
", + "smithy.api#required": {} + } + }, + "NumberType": { + "target": "com.amazonaws.pinpointsmsvoicev2#RequestableNumberType", + "traits": { + "smithy.api#documentation": "The type of phone number to request.
", + "smithy.api#required": {} + } + }, + "OptOutListName": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", + "traits": { + "smithy.api#documentation": "The name of the OptOutList to associate with the phone number. You can use the\n OptOutListName or OptOutListArn.
" + } + }, + "PoolId": { + "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn", + "traits": { + "smithy.api#documentation": "The pool to associated with the phone number. You can use the PoolId or PoolArn.
" + } + }, + "RegistrationId": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationIdOrArn", + "traits": { + "smithy.api#documentation": "Use this field to attach your phone number for an external registration\n process.
" + } + }, + "DeletionProtectionEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "By default this is set to false. When set to true the phone number can't be\n deleted.
" + } + }, + "Tags": { + "target": "com.amazonaws.pinpointsmsvoicev2#TagList", + "traits": { + "smithy.api#documentation": "An array of tags (key and value pairs) associate with the requested phone number.\n
" + } + }, + "ClientToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#ClientToken", + "traits": { + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don't specify a client token, a randomly generated token is used for the\n request to ensure idempotency.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#RequestPhoneNumberResult": { + "type": "structure", + "members": { + "PhoneNumberArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the requested phone number.
" + } + }, + "PhoneNumberId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the new phone number.
" + } + }, + "PhoneNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "traits": { + "smithy.api#documentation": "The new phone number that was requested.
" + } + }, + "Status": { + "target": "com.amazonaws.pinpointsmsvoicev2#NumberStatus", + "traits": { + "smithy.api#documentation": "The current status of the request.
" + } + }, + "IsoCountryCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", + "traits": { + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
" + } + }, + "MessageType": { + "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", + "traits": { + "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
" + } + }, + "NumberCapabilities": { + "target": "com.amazonaws.pinpointsmsvoicev2#NumberCapabilityList", + "traits": { + "smithy.api#documentation": "Indicates if the phone number will be used for text messages, voice messages or both.\n
" + } + }, + "NumberType": { + "target": "com.amazonaws.pinpointsmsvoicev2#RequestableNumberType", + "traits": { + "smithy.api#documentation": "The type of number that was released.
" + } + }, + "MonthlyLeasingPrice": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The monthly price, in US dollars, to lease the phone number.
" + } + }, + "TwoWayEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients.
" + } + }, + "TwoWayChannelArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#TwoWayChannelArn", + "traits": { + "smithy.api#documentation": "The ARN used to identify the two way channel.
" + } + }, + "TwoWayChannelRole": { + "target": "com.amazonaws.pinpointsmsvoicev2#IamRoleArn", + "traits": { + "smithy.api#documentation": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + } + }, + "SelfManagedOptOutsEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins\n with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically\n replies with a customizable message and adds the end recipient to the OptOutList. When\n set to true you're responsible for responding to HELP and STOP requests. You're also\n responsible for tracking and honoring opt-out requests.
" + } + }, + "OptOutListName": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", + "traits": { + "smithy.api#documentation": "The name of the OptOutList that is associated with the requested phone number.
" + } + }, + "DeletionProtectionEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "By default this is set to false. When set to true the phone number can't be deleted.\n
" + } + }, + "PoolId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the pool associated with the phone number
" + } + }, + "RegistrationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration.
" + } + }, + "Tags": { + "target": "com.amazonaws.pinpointsmsvoicev2#TagList", + "traits": { + "smithy.api#documentation": "An array of key and value pair tags that are associated with the phone number.
" + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the phone number was created, in UNIX epoch time format.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#RequestSenderId": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#RequestSenderIdRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#RequestSenderIdResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Request a new sender ID that doesn't require registration.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#RequestSenderIdRequest": { + "type": "structure", + "members": { + "SenderId": { + "target": "com.amazonaws.pinpointsmsvoicev2#SenderId", + "traits": { + "smithy.api#documentation": "The sender ID string to request.
", + "smithy.api#required": {} + } + }, + "IsoCountryCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", + "traits": { + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
", + "smithy.api#required": {} + } + }, + "MessageTypes": { + "target": "com.amazonaws.pinpointsmsvoicev2#MessageTypeList", + "traits": { + "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
" + } + }, + "DeletionProtectionEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "By default this is set to false. When set to true the sender ID can't be deleted.
" + } + }, + "Tags": { + "target": "com.amazonaws.pinpointsmsvoicev2#TagList", + "traits": { + "smithy.api#documentation": "An array of tags (key and value pairs) to associate with the sender ID.
" + } + }, + "ClientToken": { + "target": "com.amazonaws.pinpointsmsvoicev2#ClientToken", + "traits": { + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don't specify a client token, a randomly generated token is used for the\n request to ensure idempotency.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#RequestSenderIdResult": { + "type": "structure", + "members": { + "SenderIdArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the SenderId.
", + "smithy.api#required": {} + } + }, + "SenderId": { + "target": "com.amazonaws.pinpointsmsvoicev2#SenderId", + "traits": { + "smithy.api#documentation": "The sender ID that was requested.
", + "smithy.api#required": {} + } + }, + "IsoCountryCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", + "traits": { + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
", + "smithy.api#required": {} + } + }, + "MessageTypes": { + "target": "com.amazonaws.pinpointsmsvoicev2#MessageTypeList", + "traits": { + "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
", + "smithy.api#required": {} + } + }, + "MonthlyLeasingPrice": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The monthly price, in US dollars, to lease the sender ID.
", + "smithy.api#required": {} + } + }, + "DeletionProtectionEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "By default this is set to false. When set to true the sender ID can't be deleted.
", + "smithy.api#required": {} + } + }, + "Registered": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "True if the sender ID is registered.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.pinpointsmsvoicev2#TagList", + "traits": { + "smithy.api#documentation": "An array of tags (key and value pairs) to associate with the sender ID.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#RequestableNumberType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "LONG_CODE", + "name": "LONG_CODE" + }, + { + "value": "TOLL_FREE", + "name": "TOLL_FREE" + }, + { + "value": "TEN_DLC", + "name": "TEN_DLC" + }, + { + "value": "SIMULATOR", + "name": "SIMULATOR" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#ResourceIdOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + }, + "ResourceType": { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceType", + "traits": { + "smithy.api#documentation": "The type of resource that caused the exception.
" + } + }, + "ResourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A requested resource couldn't be found.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.pinpointsmsvoicev2#ResourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "account", + "name": "ACCOUNT" + }, + { + "value": "phone-number", + "name": "PHONE_NUMBER" + }, + { + "value": "sender-id", + "name": "SENDER_ID" + }, + { + "value": "pool", + "name": "POOL" + }, + { + "value": "configuration-set", + "name": "CONFIGURATION_SET" + }, + { + "value": "opt-out-list", + "name": "OPT_OUT_LIST" + }, + { + "value": "event-destination", + "name": "EVENT_DESTINATION" + }, + { + "value": "keyword", + "name": "KEYWORD" + }, + { + "value": "opted-out-number", + "name": "OPTED_OUT_NUMBER" + }, + { + "value": "registration", + "name": "REGISTRATION" + }, + { + "value": "registration-attachment", + "name": "REGISTRATION_ATTACHMENT" + }, + { + "value": "verified-destination-number", + "name": "VERIFIED_DESTINATION_NUMBER" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#SectionPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[A-Za-z0-9_]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#SectionPathList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#SectionPath" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#SelectChoice": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#SelectChoiceList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#SelectChoice" + }, + "traits": { + "smithy.api#length": { + "max": 100 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#SelectOptionDescription": { + "type": "structure", + "members": { + "Option": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The value of the option.
", + "smithy.api#required": {} + } + }, + "Title": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The title of the select option.
" + } + }, + "Description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A description of the option meaning.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A description of each select option.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#SelectOptionDescriptionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#SelectOptionDescription" + } + }, + "com.amazonaws.pinpointsmsvoicev2#SelectValidation": { + "type": "structure", + "members": { + "MinChoices": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The minimum number of choices for the select.
", + "smithy.api#required": {} + } + }, + "MaxChoices": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of choices for the select.
", + "smithy.api#required": {} + } + }, + "Options": { + "target": "com.amazonaws.pinpointsmsvoicev2#StringList", + "traits": { + "smithy.api#documentation": "An array of strings for the possible selection options.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Validation rules for a select field.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#SendDestinationNumberVerificationCode": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#SendDestinationNumberVerificationCodeRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#SendDestinationNumberVerificationCodeResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Before you can send test messages to a verified destination phone number you need to\n opt-in the verified destination phone number. Creates a new text message with a\n verification code and send it to a verified destination phone number. Once you have the verification code use VerifyDestinationNumber to opt-in the verified destination phone number to receive messages.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#SendDestinationNumberVerificationCodeRequest": { + "type": "structure", + "members": { + "VerifiedDestinationNumberId": { + "target": "com.amazonaws.pinpointsmsvoicev2#VerifiedDestinationNumberIdOrArn", + "traits": { + "smithy.api#documentation": "The unique identifier for the verified destination phone number.
", + "smithy.api#required": {} + } + }, + "VerificationChannel": { + "target": "com.amazonaws.pinpointsmsvoicev2#VerificationChannel", + "traits": { + "smithy.api#documentation": "Choose to send the verification code as an SMS or voice message.
", + "smithy.api#required": {} + } + }, + "LanguageCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#LanguageCode", + "traits": { + "smithy.api#documentation": "Choose the language to use for the message.
" + } + }, + "OriginationIdentity": { + "target": "com.amazonaws.pinpointsmsvoicev2#VerificationMessageOriginationIdentity", + "traits": { + "smithy.api#documentation": "The origination identity of the message. This can be either the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
" + } + }, + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", + "traits": { + "smithy.api#documentation": "The name of the configuration set to use. This can be either the ConfigurationSetName\n or ConfigurationSetArn.
" + } + }, + "Context": { + "target": "com.amazonaws.pinpointsmsvoicev2#ContextMap", + "traits": { + "smithy.api#documentation": "You can specify custom data in this field. If you do, that data is logged to the event\n destination.
" + } + }, + "DestinationCountryParameters": { + "target": "com.amazonaws.pinpointsmsvoicev2#DestinationCountryParameters", + "traits": { + "smithy.api#documentation": "This field is used for any country-specific registration requirements. Currently, this\n setting is only used when you send messages to recipients in India using a sender ID.\n For more information see Special requirements for sending SMS messages to recipients in India.\n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#SendDestinationNumberVerificationCodeResult": { + "type": "structure", + "members": { + "MessageId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the message.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#SendTextMessage": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#SendTextMessageRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#SendTextMessageResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new text message and sends it to a recipient's phone number.
\nSMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit\n depends on the destination country of your messages, as well as the type of phone number\n (origination number) that you use to send the message. For more information, see Message Parts per\n Second (MPS) limits in the Amazon Pinpoint User\n Guide.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#SendTextMessageRequest": { + "type": "structure", + "members": { + "DestinationPhoneNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "traits": { + "smithy.api#documentation": "The destination phone number in E.164 format.
", + "smithy.api#required": {} + } + }, + "OriginationIdentity": { + "target": "com.amazonaws.pinpointsmsvoicev2#TextMessageOriginationIdentity", + "traits": { + "smithy.api#documentation": "The origination identity of the message. This can be either the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
" + } + }, + "MessageBody": { + "target": "com.amazonaws.pinpointsmsvoicev2#TextMessageBody", + "traits": { + "smithy.api#documentation": "The body of the text message.
" + } + }, + "MessageType": { + "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", + "traits": { + "smithy.api#documentation": "The type of message. Valid values are \n for messages that are critical or time-sensitive and PROMOTIONAL for messages that\n aren't critical or time-sensitive.
" + } + }, + "Keyword": { + "target": "com.amazonaws.pinpointsmsvoicev2#Keyword", + "traits": { + "smithy.api#documentation": "When you register a short code in the US, you must specify a program name. If you\n don’t have a US short code, omit this attribute.
" + } + }, + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", + "traits": { + "smithy.api#documentation": "The name of the configuration set to use. This can be either the ConfigurationSetName\n or ConfigurationSetArn.
" + } + }, + "MaxPrice": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxPrice", + "traits": { + "smithy.api#documentation": "The maximum amount that you want to spend, in US dollars, per each text message part.\n A text message can contain multiple parts.
" + } + }, + "TimeToLive": { + "target": "com.amazonaws.pinpointsmsvoicev2#TimeToLive", + "traits": { + "smithy.api#documentation": "How long the text message is valid for. By default this is 72 hours.
" + } + }, + "Context": { + "target": "com.amazonaws.pinpointsmsvoicev2#ContextMap", + "traits": { + "smithy.api#documentation": "You can specify custom data in this field. If you do, that data is logged to the event\n destination.
" + } + }, + "DestinationCountryParameters": { + "target": "com.amazonaws.pinpointsmsvoicev2#DestinationCountryParameters", + "traits": { + "smithy.api#documentation": "This field is used for any country-specific registration requirements. Currently, this\n setting is only used when you send messages to recipients in India using a sender ID.\n For more information see Special requirements for sending SMS messages to recipients in India.\n
" + } + }, + "DryRun": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "When set to true, the message is checked and validated, but isn't sent to the end\n recipient.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#SendTextMessageResult": { + "type": "structure", + "members": { + "MessageId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the message.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#SendVoiceMessage": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#SendVoiceMessageRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#SendVoiceMessageResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Allows you to send a request that sends a voice message through Amazon Pinpoint.\n This operation uses Amazon Polly to\n convert a text script into a voice message.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#SendVoiceMessageRequest": { + "type": "structure", + "members": { + "DestinationPhoneNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "traits": { + "smithy.api#documentation": "The destination phone number in E.164 format.
", + "smithy.api#required": {} + } + }, + "OriginationIdentity": { + "target": "com.amazonaws.pinpointsmsvoicev2#VoiceMessageOriginationIdentity", + "traits": { + "smithy.api#documentation": "The origination identity to use for the voice call. This can be the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.
", + "smithy.api#required": {} + } + }, + "MessageBody": { + "target": "com.amazonaws.pinpointsmsvoicev2#VoiceMessageBody", + "traits": { + "smithy.api#documentation": "The text to convert to a voice message.
" + } + }, + "MessageBodyTextType": { + "target": "com.amazonaws.pinpointsmsvoicev2#VoiceMessageBodyTextType", + "traits": { + "smithy.api#documentation": "Specifies if the MessageBody field contains text or speech synthesis\n markup language (SSML).
\nTEXT: This is the default value. When used the maximum character limit is\n 3000.
\nSSML: When used the maximum character limit is 6000 including SSML\n tagging.
\nThe voice for the Amazon Polly\n service to use. By default this is set to \"MATTHEW\".
" + } + }, + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", + "traits": { + "smithy.api#documentation": "The name of the configuration set to use. This can be either the ConfigurationSetName\n or ConfigurationSetArn.
" + } + }, + "MaxPricePerMinute": { + "target": "com.amazonaws.pinpointsmsvoicev2#MaxPrice", + "traits": { + "smithy.api#documentation": "The maximum amount to spend per voice message, in US dollars.
" + } + }, + "TimeToLive": { + "target": "com.amazonaws.pinpointsmsvoicev2#TimeToLive", + "traits": { + "smithy.api#documentation": "How long the voice message is valid for. By default this is 72 hours.
" + } + }, + "Context": { + "target": "com.amazonaws.pinpointsmsvoicev2#ContextMap", + "traits": { + "smithy.api#documentation": "You can specify custom data in this field. If you do, that data is logged to the event\n destination.
" + } + }, + "DryRun": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "When set to true, the message is checked and validated, but isn't sent to the end\n recipient.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#SendVoiceMessageResult": { + "type": "structure", + "members": { + "MessageId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the message.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#SenderId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 11 + }, + "smithy.api#pattern": "^[A-Za-z0-9_-]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#SenderIdAndCountry": { + "type": "structure", + "members": { + "SenderId": { + "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdOrArn", + "traits": { + "smithy.api#documentation": "The unique identifier of the sender.
", + "smithy.api#required": {} + } + }, + "IsoCountryCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", + "traits": { + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The alphanumeric sender ID in a specific country that you want to describe. For more\n information on sender IDs see Requesting\n sender IDs for SMS messaging with Amazon Pinpoint\n in the Amazon Pinpoint User Guide.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#SenderIdFilter": { "type": "structure", "members": { "Name": { - "target": "com.amazonaws.pinpointsmsvoicev2#PoolFilterName", + "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdFilterName", "traits": { "smithy.api#documentation": "The name of the attribute to filter on.
", "smithy.api#required": {} @@ -4716,19 +10015,19 @@ "Values": { "target": "com.amazonaws.pinpointsmsvoicev2#FilterValueList", "traits": { - "smithy.api#documentation": "An array values to filter for.
", + "smithy.api#documentation": "An array of values to filter for.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The information for a pool that meets a specified criteria.
" + "smithy.api#documentation": "The information for a sender ID that meets a specified criteria.
" } }, - "com.amazonaws.pinpointsmsvoicev2#PoolFilterList": { + "com.amazonaws.pinpointsmsvoicev2#SenderIdFilterList": { "type": "list", "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#PoolFilter" + "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdFilter" }, "traits": { "smithy.api#length": { @@ -4736,247 +10035,252 @@ } } }, - "com.amazonaws.pinpointsmsvoicev2#PoolFilterName": { + "com.amazonaws.pinpointsmsvoicev2#SenderIdFilterName": { "type": "string", "traits": { "smithy.api#enum": [ { - "value": "status", - "name": "STATUS" - }, - { - "value": "message-type", - "name": "MESSAGE_TYPE" - }, - { - "value": "two-way-enabled", - "name": "TWO_WAY_ENABLED" - }, - { - "value": "self-managed-opt-outs-enabled", - "name": "SELF_MANAGED_OPT_OUTS_ENABLED" + "value": "sender-id", + "name": "SENDER_ID" }, { - "value": "opt-out-list-name", - "name": "OPT_OUT_LIST_NAME" + "value": "iso-country-code", + "name": "ISO_COUNTRY_CODE" }, { - "value": "shared-routes-enabled", - "name": "SHARED_ROUTES_ENABLED" + "value": "message-type", + "name": "MESSAGE_TYPE" }, { "value": "deletion-protection-enabled", "name": "DELETION_PROTECTION_ENABLED" + }, + { + "value": "registered", + "name": "REGISTERED" } ] } }, - "com.amazonaws.pinpointsmsvoicev2#PoolIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn" - }, - "traits": { - "smithy.api#length": { - "max": 5 - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" - } - }, - "com.amazonaws.pinpointsmsvoicev2#PoolInformation": { + "com.amazonaws.pinpointsmsvoicev2#SenderIdInformation": { "type": "structure", "members": { - "PoolArn": { + "SenderIdArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the pool.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the SenderId.
", "smithy.api#required": {} } }, - "PoolId": { - "target": "smithy.api#String", + "SenderId": { + "target": "com.amazonaws.pinpointsmsvoicev2#SenderId", "traits": { - "smithy.api#documentation": "The unique identifier for the pool.
", + "smithy.api#documentation": "The alphanumeric sender ID in a specific country that you'd like to describe.
", "smithy.api#required": {} } }, - "Status": { - "target": "com.amazonaws.pinpointsmsvoicev2#PoolStatus", + "IsoCountryCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", "traits": { - "smithy.api#documentation": "The current status of the pool.
", + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
", "smithy.api#required": {} } }, - "MessageType": { - "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", + "MessageTypes": { + "target": "com.amazonaws.pinpointsmsvoicev2#MessageTypeList", "traits": { "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
", "smithy.api#required": {} } }, - "TwoWayEnabled": { - "target": "smithy.api#PrimitiveBoolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "When set to true you can receive incoming text messages from your end recipients using\n the TwoWayChannelArn.
", - "smithy.api#required": {} - } - }, - "TwoWayChannelArn": { - "target": "com.amazonaws.pinpointsmsvoicev2#TwoWayChannelArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the two way channel.
" - } - }, - "SelfManagedOptOutsEnabled": { - "target": "smithy.api#PrimitiveBoolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "When set to false, an end recipient sends a message that begins with HELP or STOP to\n one of your dedicated numbers, Amazon Pinpoint automatically replies with a\n customizable message and adds the end recipient to the OptOutList. When set to true\n you're responsible for responding to HELP and STOP requests. You're also responsible for\n tracking and honoring opt-out requests. For more information see Self-managed opt-outs\n
", - "smithy.api#required": {} - } - }, - "OptOutListName": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", + "MonthlyLeasingPrice": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The name of the OptOutList associated with the pool.
", + "smithy.api#documentation": "The monthly leasing price, in US dollars.
", "smithy.api#required": {} } }, - "SharedRoutesEnabled": { + "DeletionProtectionEnabled": { "target": "smithy.api#PrimitiveBoolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Allows you to enable shared routes on your pool.
\nBy default, this is set to False. If you set this value to\n True, your messages are sent using phone numbers or sender IDs\n (depending on the country) that are shared with other Amazon Pinpoint users. In some\n countries, such as the United States, senders aren't allowed to use shared routes and\n must use a dedicated phone number or short code.
By default this is set to false. When set to true the sender ID can't be deleted.
", "smithy.api#required": {} } }, - "DeletionProtectionEnabled": { + "Registered": { "target": "smithy.api#PrimitiveBoolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "When set to true the pool can't be deleted.
", + "smithy.api#documentation": "True if the sender ID is registered.
", "smithy.api#required": {} } }, - "CreatedTimestamp": { - "target": "smithy.api#Timestamp", + "RegistrationId": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The time when the pool was created, in UNIX epoch time format.
", - "smithy.api#required": {} + "smithy.api#documentation": "The unique identifier for the registration.
" } } }, "traits": { - "smithy.api#documentation": "The information for a pool in an Amazon Web Services account.
" + "smithy.api#documentation": "The information for all SenderIds in an Amazon Web Services account.
" } }, - "com.amazonaws.pinpointsmsvoicev2#PoolInformationList": { + "com.amazonaws.pinpointsmsvoicev2#SenderIdInformationList": { "type": "list", "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#PoolInformation" + "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdInformation" } }, - "com.amazonaws.pinpointsmsvoicev2#PoolOriginationIdentitiesFilter": { + "com.amazonaws.pinpointsmsvoicev2#SenderIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdAndCountry" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#SenderIdOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.pinpointsmsvoicev2#PoolOriginationIdentitiesFilterName", - "traits": { - "smithy.api#documentation": "The name of the attribute to filter on.
", - "smithy.api#required": {} - } + "Message": { + "target": "smithy.api#String" }, - "Values": { - "target": "com.amazonaws.pinpointsmsvoicev2#FilterValueList", + "Reason": { + "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededExceptionReason", "traits": { - "smithy.api#documentation": "An array values to filter for.
", - "smithy.api#required": {} + "smithy.api#documentation": "The reason for the exception.
" } } }, "traits": { - "smithy.api#documentation": "Information about origination identities associated with a pool that meets a specified\n criteria.
" - } - }, - "com.amazonaws.pinpointsmsvoicev2#PoolOriginationIdentitiesFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#PoolOriginationIdentitiesFilter" - }, - "traits": { - "smithy.api#length": { - "max": 20 - } + "smithy.api#documentation": "The request would cause a service quota to be exceeded.
", + "smithy.api#error": "client" } }, - "com.amazonaws.pinpointsmsvoicev2#PoolOriginationIdentitiesFilterName": { + "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededExceptionReason": { "type": "string", "traits": { "smithy.api#enum": [ { - "value": "iso-country-code", - "name": "ISO_COUNTRY_CODE" + "value": "ASSOCIATIONS_PER_REGISTRATION", + "name": "ASSOCIATIONS_PER_REGISTRATION" + }, + { + "value": "CONFIGURATION_SETS_PER_ACCOUNT", + "name": "CONFIGURATION_SETS_PER_ACCOUNT" + }, + { + "value": "DAILY_DESTINATION_CALL_LIMIT", + "name": "DAILY_DESTINATION_CALL_LIMIT" + }, + { + "value": "EVENT_DESTINATIONS_PER_CONFIGURATION_SET", + "name": "EVENT_DESTINATIONS_PER_CONFIGURATION_SET" + }, + { + "value": "KEYWORDS_PER_PHONE_NUMBER", + "name": "KEYWORDS_PER_PHONE_NUMBER" + }, + { + "value": "KEYWORDS_PER_POOL", + "name": "KEYWORDS_PER_POOL" + }, + { + "value": "MONTHLY_SPEND_LIMIT_REACHED_FOR_TEXT", + "name": "MONTHLY_SPEND_LIMIT_REACHED_FOR_TEXT" + }, + { + "value": "MONTHLY_SPEND_LIMIT_REACHED_FOR_VOICE", + "name": "MONTHLY_SPEND_LIMIT_REACHED_FOR_VOICE" + }, + { + "value": "OPT_OUT_LISTS_PER_ACCOUNT", + "name": "OPT_OUT_LISTS_PER_ACCOUNT" + }, + { + "value": "ORIGINATION_IDENTITIES_PER_POOL", + "name": "ORIGINATION_IDENTITIES_PER_POOL" + }, + { + "value": "PHONE_NUMBERS_PER_ACCOUNT", + "name": "PHONE_NUMBERS_PER_ACCOUNT" }, { - "value": "number-capability", - "name": "NUMBER_CAPABILITY" - } - ] - } - }, - "com.amazonaws.pinpointsmsvoicev2#PoolStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ + "value": "PHONE_NUMBERS_PER_REGISTRATION", + "name": "PHONE_NUMBERS_PER_REGISTRATION" + }, { - "value": "CREATING", - "name": "CREATING" + "value": "POOLS_PER_ACCOUNT", + "name": "POOLS_PER_ACCOUNT" }, { - "value": "ACTIVE", - "name": "ACTIVE" + "value": "REGISTRATION_ATTACHMENTS_CREATED_PER_DAY", + "name": "REGISTRATION_ATTACHMENTS_CREATED_PER_DAY" }, { - "value": "DELETING", - "name": "DELETING" + "value": "REGISTRATION_ATTACHMENTS_PER_ACCOUNT", + "name": "REGISTRATION_ATTACHMENTS_PER_ACCOUNT" + }, + { + "value": "REGISTRATION_VERSIONS_CREATED_PER_DAY", + "name": "REGISTRATION_VERSIONS_CREATED_PER_DAY" + }, + { + "value": "REGISTRATIONS_PER_ACCOUNT", + "name": "REGISTRATIONS_PER_ACCOUNT" + }, + { + "value": "SENDER_IDS_PER_ACCOUNT", + "name": "SENDER_IDS_PER_ACCOUNT" + }, + { + "value": "TAGS_PER_RESOURCE", + "name": "TAGS_PER_RESOURCE" + }, + { + "value": "VERIFIED_DESTINATION_NUMBERS_PER_ACCOUNT", + "name": "VERIFIED_DESTINATION_NUMBERS_PER_ACCOUNT" + }, + { + "value": "VERIFICATION_ATTEMPTS_PER_DAY", + "name": "VERIFICATION_ATTEMPTS_PER_DAY" } ] } }, - "com.amazonaws.pinpointsmsvoicev2#PutKeyword": { + "com.amazonaws.pinpointsmsvoicev2#SetDefaultMessageType": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#PutKeywordRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#SetDefaultMessageTypeRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#PutKeywordResult" + "target": "com.amazonaws.pinpointsmsvoicev2#SetDefaultMessageTypeResult" }, "errors": [ { "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" - }, { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, { "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException" - }, { "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" }, @@ -4985,83 +10289,64 @@ } ], "traits": { - "smithy.api#documentation": "Creates or updates a keyword configuration on an origination phone number or\n pool.
\nA keyword is a word that you can search for on a particular phone number or pool. It\n is also a specific word or phrase that an end user can send to your number to elicit a\n response, such as an informational message or a special offer. When your number receives\n a message that begins with a keyword, Amazon Pinpoint responds with a customizable\n message.
\nIf you specify a keyword that isn't valid, an Error is returned.
" + "smithy.api#documentation": "Sets the default message type on a configuration set.
\nChoose the category of SMS messages that you plan to send from this account. If you\n send account-related messages or time-sensitive messages such as one-time passcodes,\n choose Transactional. If you plan to send messages that\n contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services\n account.
" } }, - "com.amazonaws.pinpointsmsvoicev2#PutKeywordRequest": { + "com.amazonaws.pinpointsmsvoicev2#SetDefaultMessageTypeRequest": { "type": "structure", "members": { - "OriginationIdentity": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneOrPoolIdOrArn", - "traits": { - "smithy.api#documentation": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers get the values for\n PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used\n to get the values for SenderId and SenderIdArn.
", - "smithy.api#required": {} - } - }, - "Keyword": { - "target": "com.amazonaws.pinpointsmsvoicev2#Keyword", + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", "traits": { - "smithy.api#documentation": "The new keyword to add.
", + "smithy.api#documentation": "The configuration set to update with a new default message type. This field can be the\n ConsigurationSetName or ConfigurationSetArn.
", "smithy.api#required": {} } }, - "KeywordMessage": { - "target": "com.amazonaws.pinpointsmsvoicev2#KeywordMessage", + "MessageType": { + "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", "traits": { - "smithy.api#documentation": "The message associated with the keyword.
\nAUTOMATIC_RESPONSE: A message is sent to the recipient.
\nOPT_OUT: Keeps the recipient from receiving future messages.
\nOPT_IN: The recipient wants to receive future messages.
\nThe type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
", "smithy.api#required": {} } - }, - "KeywordAction": { - "target": "com.amazonaws.pinpointsmsvoicev2#KeywordAction", - "traits": { - "smithy.api#documentation": "The action to perform for the new keyword when it is received.
" - } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#PutKeywordResult": { + "com.amazonaws.pinpointsmsvoicev2#SetDefaultMessageTypeResult": { "type": "structure", "members": { - "OriginationIdentityArn": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The PhoneNumberArn or PoolArn that the keyword was associated with.
" - } - }, - "OriginationIdentity": { + "ConfigurationSetArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The PhoneNumberId or PoolId that the keyword was associated with.
" - } - }, - "Keyword": { - "target": "com.amazonaws.pinpointsmsvoicev2#Keyword", - "traits": { - "smithy.api#documentation": "The keyword that was added.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated configuration set.
" } }, - "KeywordMessage": { - "target": "com.amazonaws.pinpointsmsvoicev2#KeywordMessage", + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetName", "traits": { - "smithy.api#documentation": "The message associated with the keyword.
" + "smithy.api#documentation": "The name of the configuration set that was updated.
" } }, - "KeywordAction": { - "target": "com.amazonaws.pinpointsmsvoicev2#KeywordAction", + "MessageType": { + "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", "traits": { - "smithy.api#documentation": "The action to perform when the keyword is used.
" + "smithy.api#documentation": "The new default message type of the configuration set.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#PutOptedOutNumber": { + "com.amazonaws.pinpointsmsvoicev2#SetDefaultSenderId": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#PutOptedOutNumberRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#SetDefaultSenderIdRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#PutOptedOutNumberResult" + "target": "com.amazonaws.pinpointsmsvoicev2#SetDefaultSenderIdResult" }, "errors": [ { @@ -5081,95 +10366,127 @@ } ], "traits": { - "smithy.api#documentation": "Creates an opted out destination phone number in the opt-out list.
\nIf the destination phone number isn't valid or if the specified opt-out list doesn't\n exist, an Error is returned.
" + "smithy.api#documentation": "Sets default sender ID on a configuration set.
\nWhen sending a text message to a destination country that supports sender IDs, the\n default sender ID on the configuration set specified will be used if no dedicated\n origination phone numbers or registered sender IDs are available in your account.
" } }, - "com.amazonaws.pinpointsmsvoicev2#PutOptedOutNumberRequest": { + "com.amazonaws.pinpointsmsvoicev2#SetDefaultSenderIdRequest": { "type": "structure", "members": { - "OptOutListName": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", "traits": { - "smithy.api#documentation": "The OptOutListName or OptOutListArn to add the phone number to.
", + "smithy.api#documentation": "The configuration set to updated with a new default SenderId. This field can be the\n ConsigurationSetName or ConfigurationSetArn.
", "smithy.api#required": {} } }, - "OptedOutNumber": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "SenderId": { + "target": "com.amazonaws.pinpointsmsvoicev2#SenderId", "traits": { - "smithy.api#documentation": "The phone number to add to the OptOutList in E.164 format.
", + "smithy.api#documentation": "The current sender ID for the configuration set. When sending a text message to a\n destination country which supports SenderIds, the default sender ID on the configuration\n set specified on SendTextMessage will be used if no dedicated\n origination phone numbers or registered SenderIds are available in your account, instead\n of a generic sender ID, such as 'NOTICE'.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#PutOptedOutNumberResult": { + "com.amazonaws.pinpointsmsvoicev2#SetDefaultSenderIdResult": { "type": "structure", "members": { - "OptOutListArn": { + "ConfigurationSetArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The OptOutListArn that the phone number was removed from.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated configuration set.
" } }, - "OptOutListName": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetName", "traits": { - "smithy.api#documentation": "The OptOutListName that the phone number was removed from.
" + "smithy.api#documentation": "The name of the configuration set that was updated.
" } }, - "OptedOutNumber": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "SenderId": { + "target": "com.amazonaws.pinpointsmsvoicev2#SenderId", "traits": { - "smithy.api#documentation": "The phone number that was added to the OptOutList.
" + "smithy.api#documentation": "The default sender ID to set for the ConfigurationSet.
" } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#SetTextMessageSpendLimitOverride": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#SetTextMessageSpendLimitOverrideRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#SetTextMessageSpendLimitOverrideResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, - "OptedOutTimestamp": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "The time that the phone number was added to the OptOutList, in UNIX epoch time format.
" - } + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, - "EndUserOptedOut": { - "target": "smithy.api#PrimitiveBoolean", + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Sets an account level monthly spend limit override for sending text messages. The\n requested spend limit must be less than or equal to the MaxLimit, which is\n set by Amazon Web Services.
This is true if it was the end user who requested their phone number be removed.\n
" + "smithy.api#documentation": "The new monthly limit to enforce on text messages.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#RegistrationId": { - "type": "string", + "com.amazonaws.pinpointsmsvoicev2#SetTextMessageSpendLimitOverrideResult": { + "type": "structure", + "members": { + "MonthlyLimit": { + "target": "com.amazonaws.pinpointsmsvoicev2#MonthlyLimit", + "traits": { + "smithy.api#documentation": "The current monthly limit to enforce on sending text messages.
" + } + } + }, "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^\\S+$" + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#ReleasePhoneNumber": { + "com.amazonaws.pinpointsmsvoicev2#SetVoiceMessageSpendLimitOverride": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#ReleasePhoneNumberRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#SetVoiceMessageSpendLimitOverrideRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#ReleasePhoneNumberResult" + "target": "com.amazonaws.pinpointsmsvoicev2#SetVoiceMessageSpendLimitOverrideResult" }, "errors": [ { "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" - }, { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" - }, { "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" }, @@ -5178,119 +10495,145 @@ } ], "traits": { - "smithy.api#documentation": "Releases an existing origination phone number in your account. Once released, a phone\n number is no longer available for sending messages.
\nIf the origination phone number has deletion protection enabled or is associated with\n a pool, an Error is returned.
" + "smithy.api#documentation": "Sets an account level monthly spend limit override for sending voice messages. The\n requested spend limit must be less than or equal to the MaxLimit, which is\n set by Amazon Web Services.
The new monthly limit to enforce on voice messages.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#SetVoiceMessageSpendLimitOverrideResult": { + "type": "structure", + "members": { + "MonthlyLimit": { + "target": "com.amazonaws.pinpointsmsvoicev2#MonthlyLimit", + "traits": { + "smithy.api#documentation": "The current monthly limit to enforce on sending voice messages.
" + } + } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#ReleasePhoneNumberRequest": { + "com.amazonaws.pinpointsmsvoicev2#SnsDestination": { "type": "structure", "members": { - "PhoneNumberId": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberIdOrArn", + "TopicArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#SnsTopicArn", "traits": { - "smithy.api#documentation": "The PhoneNumberId or PhoneNumberArn of the phone number to release. You can use DescribePhoneNumbers to get the values for PhoneNumberId and\n PhoneNumberArn.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to\n publish events to.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "An object that defines an Amazon SNS destination for events. You can use\n Amazon SNS to send notification when certain events occur.
" } }, - "com.amazonaws.pinpointsmsvoicev2#ReleasePhoneNumberResult": { + "com.amazonaws.pinpointsmsvoicev2#SnsTopicArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:\\S+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#SpendLimit": { "type": "structure", "members": { - "PhoneNumberArn": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The PhoneNumberArn of the phone number that was released.
" - } - }, - "PhoneNumberId": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The PhoneNumberId of the phone number that was released.
" - } - }, - "PhoneNumber": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", - "traits": { - "smithy.api#documentation": "The phone number that was released.
" - } - }, - "Status": { - "target": "com.amazonaws.pinpointsmsvoicev2#NumberStatus", - "traits": { - "smithy.api#documentation": "The current status of the request.
" - } - }, - "IsoCountryCode": { - "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", - "traits": { - "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or\n region.
" - } - }, - "MessageType": { - "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", - "traits": { - "smithy.api#documentation": "The message type that was associated with the phone number.
" - } - }, - "NumberCapabilities": { - "target": "com.amazonaws.pinpointsmsvoicev2#NumberCapabilityList", - "traits": { - "smithy.api#documentation": "Specifies if the number could be used for text messages, voice, or both.
" - } - }, - "NumberType": { - "target": "com.amazonaws.pinpointsmsvoicev2#NumberType", - "traits": { - "smithy.api#documentation": "The type of number that was released.
" - } - }, - "MonthlyLeasingPrice": { - "target": "smithy.api#String", + "Name": { + "target": "com.amazonaws.pinpointsmsvoicev2#SpendLimitName", "traits": { - "smithy.api#documentation": "The monthly price of the phone number, in US dollars.
" + "smithy.api#documentation": "The name for the SpendLimit.
", + "smithy.api#required": {} } }, - "TwoWayEnabled": { - "target": "smithy.api#PrimitiveBoolean", + "EnforcedLimit": { + "target": "smithy.api#PrimitiveLong", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients.
" + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum amount of money, in US dollars, that you want to be able to spend sending\n messages each month. This value has to be less than or equal to the amount in\n MaxLimit. To use this custom limit, Overridden must be set\n to true.
The Amazon Resource Name (ARN) of the TwoWayChannel.
" + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum amount of money that you are able to spend to send messages each month,\n in US dollars.
", + "smithy.api#required": {} } }, - "SelfManagedOptOutsEnabled": { + "Overridden": { "target": "smithy.api#PrimitiveBoolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins\n with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically\n replies with a customizable message and adds the end recipient to the OptOutList. When\n set to true you're responsible for responding to HELP and STOP requests. You're also\n responsible for tracking and honoring opt-out requests.
" - } - }, - "OptOutListName": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", - "traits": { - "smithy.api#documentation": "The name of the OptOutList that was associated with the phone number.
" - } - }, - "CreatedTimestamp": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "The time when the phone number was created, in UNIX epoch time format.
" + "smithy.api#documentation": "When set to True, the value that has been specified in the\n EnforcedLimit is used to determine the maximum amount in US dollars\n that can be spent to send messages each month, in US dollars.
Describes the current Amazon Pinpoint monthly spend limits for sending voice and\n text messages. For more information on increasing your monthly spend limit, see \n Requesting increases to your monthly SMS spending quota for Amazon Pinpoint\n in the Amazon Pinpoint User Guide.
" } }, - "com.amazonaws.pinpointsmsvoicev2#RequestPhoneNumber": { + "com.amazonaws.pinpointsmsvoicev2#SpendLimitList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#SpendLimit" + } + }, + "com.amazonaws.pinpointsmsvoicev2#SpendLimitName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "TEXT_MESSAGE_MONTHLY_SPEND_LIMIT", + "name": "TEXT_MESSAGE_MONTHLY_SPEND_LIMIT" + }, + { + "value": "VOICE_MESSAGE_MONTHLY_SPEND_LIMIT", + "name": "VOICE_MESSAGE_MONTHLY_SPEND_LIMIT" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#StringList": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.pinpointsmsvoicev2#StringMap": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.pinpointsmsvoicev2#SubmitRegistrationVersion": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#RequestPhoneNumberRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#SubmitRegistrationVersionRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#RequestPhoneNumberResult" + "target": "com.amazonaws.pinpointsmsvoicev2#SubmitRegistrationVersionResult" }, "errors": [ { @@ -5305,9 +10648,6 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException" - }, { "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" }, @@ -5316,303 +10656,343 @@ } ], "traits": { - "smithy.api#documentation": "Request an origination phone number for use in your account. For more information on\n phone number request see Requesting a\n number in the Amazon Pinpoint User Guide.
" + "smithy.api#documentation": "Submit the specified registration for review and approval.
" } }, - "com.amazonaws.pinpointsmsvoicev2#RequestPhoneNumberRequest": { + "com.amazonaws.pinpointsmsvoicev2#SubmitRegistrationVersionRequest": { "type": "structure", "members": { - "IsoCountryCode": { - "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", - "traits": { - "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
", - "smithy.api#required": {} - } - }, - "MessageType": { - "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", - "traits": { - "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
", - "smithy.api#required": {} - } - }, - "NumberCapabilities": { - "target": "com.amazonaws.pinpointsmsvoicev2#NumberCapabilityList", - "traits": { - "smithy.api#documentation": "Indicates if the phone number will be used for text messages, voice messages, or both.
", - "smithy.api#required": {} - } - }, - "NumberType": { - "target": "com.amazonaws.pinpointsmsvoicev2#RequestableNumberType", - "traits": { - "smithy.api#documentation": "The type of phone number to request.
", - "smithy.api#required": {} - } - }, - "OptOutListName": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", - "traits": { - "smithy.api#documentation": "The name of the OptOutList to associate with the phone number. You can use the\n OutOutListName or OptPutListArn.
" - } - }, - "PoolId": { - "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn", - "traits": { - "smithy.api#documentation": "The pool to associated with the phone number. You can use the PoolId or PoolArn.
" - } - }, "RegistrationId": { - "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationId", - "traits": { - "smithy.api#documentation": "Use this field to attach your phone number for an external registration\n process.
" - } - }, - "DeletionProtectionEnabled": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "By default this is set to false. When set to true the phone number can't be\n deleted.
" - } - }, - "Tags": { - "target": "com.amazonaws.pinpointsmsvoicev2#TagList", - "traits": { - "smithy.api#documentation": "An array of tags (key and value pairs) associate with the requested phone number.\n
" - } - }, - "ClientToken": { - "target": "com.amazonaws.pinpointsmsvoicev2#ClientToken", + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationIdOrArn", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don't specify a client token, a randomly generated token is used for the\n request to ensure idempotency.
", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#RequestPhoneNumberResult": { + "com.amazonaws.pinpointsmsvoicev2#SubmitRegistrationVersionResult": { "type": "structure", "members": { - "PhoneNumberArn": { + "RegistrationArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the requested phone number.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the registration.
", + "smithy.api#required": {} } }, - "PhoneNumberId": { + "RegistrationId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The unique identifier of the new phone number.
" - } - }, - "PhoneNumber": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", - "traits": { - "smithy.api#documentation": "The new phone number that was requested.
" - } - }, - "Status": { - "target": "com.amazonaws.pinpointsmsvoicev2#NumberStatus", - "traits": { - "smithy.api#documentation": "The current status of the request.
" - } - }, - "IsoCountryCode": { - "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", - "traits": { - "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
" - } - }, - "MessageType": { - "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", - "traits": { - "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
" + "smithy.api#documentation": "The unique identifier for the registration.
", + "smithy.api#required": {} } }, - "NumberCapabilities": { - "target": "com.amazonaws.pinpointsmsvoicev2#NumberCapabilityList", + "VersionNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionNumber", "traits": { - "smithy.api#documentation": "Indicates if the phone number will be used for text messages, voice messages or both.\n
" + "smithy.api#documentation": "The version number of the registration.
", + "smithy.api#required": {} } }, - "NumberType": { - "target": "com.amazonaws.pinpointsmsvoicev2#RequestableNumberType", + "RegistrationVersionStatus": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionStatus", "traits": { - "smithy.api#documentation": "The type of number that was released.
" + "smithy.api#documentation": "The status of the registration version.
\n\n DRAFT: The initial status of a registration version after it’s created.
\n SUBMITTED: Your registration has been submitted.
\n REVIEWING: Your registration has been accepted and is being reviewed.
\n APPROVED: Your registration has been approved.
\n DISCARDED: You've abandon this version of their registration to start over with a new version.
\n DENIED: You must fix your registration and resubmit it.
\n REVOKED: Your previously approved registration has been revoked.
\n ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.
The monthly price, in US dollars, to lease the phone number.
" + "smithy.api#documentation": "The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.
", + "smithy.api#required": {} } - }, - "TwoWayEnabled": { - "target": "smithy.api#PrimitiveBoolean", + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#SupportedAssociation": { + "type": "structure", + "members": { + "ResourceType": { + "target": "smithy.api#String", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients.
" + "smithy.api#documentation": "Defines the behavior of when an origination identity and registration can be associated with each other.
", + "smithy.api#required": {} } }, - "TwoWayChannelArn": { - "target": "com.amazonaws.pinpointsmsvoicev2#TwoWayChannelArn", + "IsoCountryCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", "traits": { - "smithy.api#documentation": "The ARN used to identify the two way channel.
" + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" } }, - "SelfManagedOptOutsEnabled": { - "target": "smithy.api#PrimitiveBoolean", + "AssociationBehavior": { + "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationAssociationBehavior", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins\n with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically\n replies with a customizable message and adds the end recipient to the OptOutList. When\n set to true you're responsible for responding to HELP and STOP requests. You're also\n responsible for tracking and honoring opt-out requests.
" + "smithy.api#documentation": "The association behavior.
\n\n ASSOCIATE_BEFORE_SUBMIT The origination identity has to be supplied when creating a registration.
\n ASSOCIATE_ON_APPROVAL This applies to all short code registrations. The short code will be automatically provisioned once the registration is approved.
\n ASSOCIATE_AFTER_COMPLETE This applies to phone number registrations when you must complete a registration first, then associate one or more phone numbers later. For example 10DLC campaigns and long codes.
The name of the OptOutList that is associated with the requested phone number.
" + "smithy.api#documentation": "The disassociation behavior.
\n\n DISASSOCIATE_ALL_CLOSES_REGISTRATION All origination identities must be disassociated from the registration before the registration can be closed.
\n DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION All origination identities must be disassociated from the registration before the registration can be deleted.
\n DELETE_REGISTRATION_DISASSOCIATES The registration can be deleted and all origination identities will be disasscoiated.
The processing rules for when a registration can be associated with an origination identity and disassociated from an origination identity.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#SupportedAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#SupportedAssociation" + } + }, + "com.amazonaws.pinpointsmsvoicev2#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.pinpointsmsvoicev2#TagKey", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "By default this is set to false. When set to true the phone number can't be deleted.\n
" + "smithy.api#documentation": "The key identifier, or name, of the tag.
", + "smithy.api#required": {} } }, - "PoolId": { - "target": "smithy.api#String", + "Value": { + "target": "com.amazonaws.pinpointsmsvoicev2#TagValue", "traits": { - "smithy.api#documentation": "The unique identifier of the pool associated with the phone number
" + "smithy.api#documentation": "The string value associated with the key of the tag.
", + "smithy.api#required": {} } + } + }, + "traits": { + "smithy.api#documentation": "The list of tags to be added to the specified topic.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 }, - "Tags": { - "target": "com.amazonaws.pinpointsmsvoicev2#TagList", + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#Tag" + }, + "traits": { + "smithy.api#length": { + "max": 200 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#TagResourceResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS\n Voice, version 2 resource. When you specify an existing tag key, the value is\n overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag\n consists of a key and an optional value. Tag keys must be unique per resource. For more\n information about tags, see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer\n Guide.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#AmazonResourceName", "traits": { - "smithy.api#documentation": "An array of key and value pair tags that are associated with the phone number.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", + "smithy.api#required": {} } }, - "CreatedTimestamp": { - "target": "smithy.api#Timestamp", + "Tags": { + "target": "com.amazonaws.pinpointsmsvoicev2#NonEmptyTagList", "traits": { - "smithy.api#documentation": "The time when the phone number was created, in UNIX epoch time format.
" + "smithy.api#documentation": "An array of key and value pair tags that are associated with the resource.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#RequestableNumberType": { + "com.amazonaws.pinpointsmsvoicev2#TagResourceResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#TagValue": { "type": "string", "traits": { - "smithy.api#enum": [ - { - "value": "LONG_CODE", - "name": "LONG_CODE" - }, - { - "value": "TOLL_FREE", - "name": "TOLL_FREE" - }, - { - "value": "TEN_DLC", - "name": "TEN_DLC" - } - ] + "smithy.api#length": { + "max": 256 + }, + "smithy.api#pattern": "^.*$" } }, - "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException": { + "com.amazonaws.pinpointsmsvoicev2#TextMessageBody": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + }, + "smithy.api#pattern": "^(?!\\s*$)[\\s\\S]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#TextMessageOriginationIdentity": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9_:/\\+-]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#TextValidation": { "type": "structure", "members": { - "Message": { - "target": "smithy.api#String" + "MinLength": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The minimum number of characters for the text field.
", + "smithy.api#required": {} + } }, - "ResourceType": { - "target": "com.amazonaws.pinpointsmsvoicev2#ResourceType", + "MaxLength": { + "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "The type of resource that caused the exception.
" + "smithy.api#documentation": "The maximum number of characters for the text field.
", + "smithy.api#required": {} } }, - "ResourceId": { + "Pattern": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The unique identifier of the resource.
" + "smithy.api#documentation": "The regular expression used to validate the text field.
", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A requested resource couldn't be found.
", - "smithy.api#error": "client" + "smithy.api#documentation": "Validation rules for a text field.
" } }, - "com.amazonaws.pinpointsmsvoicev2#ResourceType": { + "com.amazonaws.pinpointsmsvoicev2#TextValue": { "type": "string", "traits": { - "smithy.api#enum": [ - { - "value": "account", - "name": "ACCOUNT" - }, - { - "value": "phone-number", - "name": "PHONE_NUMBER" - }, - { - "value": "sender-id", - "name": "SENDER_ID" - }, - { - "value": "pool", - "name": "POOL" - }, - { - "value": "configuration-set", - "name": "CONFIGURATION_SET" - }, - { - "value": "opt-out-list", - "name": "OPT_OUT_LIST" - }, - { - "value": "event-destination", - "name": "EVENT_DESTINATION" - }, - { - "value": "keyword", - "name": "KEYWORD" - }, - { - "value": "opted-out-number", - "name": "OPTED_OUT_NUMBER" - }, - { - "value": "registration", - "name": "REGISTRATION" - } - ] + "smithy.api#length": { + "min": 1, + "max": 2048 + } } }, - "com.amazonaws.pinpointsmsvoicev2#SendTextMessage": { + "com.amazonaws.pinpointsmsvoicev2#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "An error that occurred because too many requests were sent during a certain amount of\n time.
", + "smithy.api#error": "client", + "smithy.api#retryable": { + "throttling": true + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#TimeToLive": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 259200 + } + } + }, + "com.amazonaws.pinpointsmsvoicev2#TwoWayChannelArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^\\S+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#UntagResource": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#SendTextMessageRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#UntagResourceRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#SendTextMessageResult" + "target": "com.amazonaws.pinpointsmsvoicev2#UntagResourceResult" }, "errors": [ { "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" - }, { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, { "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException" - }, { "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" }, @@ -5621,100 +11001,45 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new text message and sends it to a recipient's phone number.
\nSMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit\n depends on the destination country of your messages, as well as the type of phone number\n (origination number) that you use to send the message. For more information, see Message Parts per\n Second (MPS) limits in the Amazon Pinpoint User\n Guide.
" + "smithy.api#documentation": "Removes the association of the specified tags from an Amazon Pinpoint SMS Voice V2\n resource. For more information on tags see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer\n Guide.
" } }, - "com.amazonaws.pinpointsmsvoicev2#SendTextMessageRequest": { + "com.amazonaws.pinpointsmsvoicev2#UntagResourceRequest": { "type": "structure", "members": { - "DestinationPhoneNumber": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "ResourceArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#AmazonResourceName", "traits": { - "smithy.api#documentation": "The destination phone number in E.164 format.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", "smithy.api#required": {} } }, - "OriginationIdentity": { - "target": "com.amazonaws.pinpointsmsvoicev2#TextMessageOriginationIdentity", - "traits": { - "smithy.api#documentation": "The origination identity of the message. This can be either the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
" - } - }, - "MessageBody": { - "target": "com.amazonaws.pinpointsmsvoicev2#TextMessageBody", - "traits": { - "smithy.api#documentation": "The body of the text message.
" - } - }, - "MessageType": { - "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", - "traits": { - "smithy.api#documentation": "The type of message. Valid values are\n TRANSACTIONAL\n for messages that are critical or time-sensitive and PROMOTIONAL for messages that\n aren't critical or time-sensitive.
" - } - }, - "Keyword": { - "target": "com.amazonaws.pinpointsmsvoicev2#Keyword", - "traits": { - "smithy.api#documentation": "When you register a short code in the US, you must specify a program name. If you\n don’t have a US short code, omit this attribute.
" - } - }, - "ConfigurationSetName": { - "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", - "traits": { - "smithy.api#documentation": "The name of the configuration set to use. This can be either the ConfigurationSetName\n or ConfigurationSetArn.
" - } - }, - "MaxPrice": { - "target": "com.amazonaws.pinpointsmsvoicev2#MaxPrice", - "traits": { - "smithy.api#documentation": "The maximum amount that you want to spend, in US dollars, per each text message part.\n A text message can contain multiple parts.
" - } - }, - "TimeToLive": { - "target": "com.amazonaws.pinpointsmsvoicev2#TimeToLive", - "traits": { - "smithy.api#documentation": "How long the text message is valid for. By default this is 72 hours.
" - } - }, - "Context": { - "target": "com.amazonaws.pinpointsmsvoicev2#ContextMap", - "traits": { - "smithy.api#documentation": "You can specify custom data in this field. If you do, that data is logged to the event\n destination.
" - } - }, - "DestinationCountryParameters": { - "target": "com.amazonaws.pinpointsmsvoicev2#DestinationCountryParameters", - "traits": { - "smithy.api#documentation": "This field is used for any country-specific registration requirements. Currently, this\n setting is only used when you send messages to recipients in India using a sender ID.\n For more information see Special requirements for sending SMS messages to recipients in India.\n
" - } - }, - "DryRun": { - "target": "smithy.api#PrimitiveBoolean", + "TagKeys": { + "target": "com.amazonaws.pinpointsmsvoicev2#TagKeyList", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "When set to true, the message is checked and validated, but isn't sent to the end\n recipient.
" + "smithy.api#documentation": "An array of tag key values to unassociate with the resource.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#SendTextMessageResult": { + "com.amazonaws.pinpointsmsvoicev2#UntagResourceResult": { "type": "structure", - "members": { - "MessageId": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The unique identifier for the message.
" - } - } + "members": {}, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#SendVoiceMessage": { + "com.amazonaws.pinpointsmsvoicev2#UpdateEventDestination": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#SendVoiceMessageRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#UpdateEventDestinationRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#SendVoiceMessageResult" + "target": "com.amazonaws.pinpointsmsvoicev2#UpdateEventDestinationResult" }, "errors": [ { @@ -5729,9 +11054,6 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException" - }, { "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" }, @@ -5740,331 +11062,298 @@ } ], "traits": { - "smithy.api#documentation": "Allows you to send a request that sends a text message through Amazon Pinpoint.\n This operation uses Amazon Polly to\n convert a text script into a voice message.
" + "smithy.api#documentation": "Updates an existing event destination in a configuration set. You can update the\n IAM role ARN for CloudWatch Logs and Kinesis Data Firehose. You can\n also enable or disable the event destination.
\nYou may want to update an event destination to change its matching event types or\n updating the destination resource ARN. You can't change an event destination's type\n between CloudWatch Logs, Kinesis Data Firehose, and Amazon SNS.
" } }, - "com.amazonaws.pinpointsmsvoicev2#SendVoiceMessageRequest": { + "com.amazonaws.pinpointsmsvoicev2#UpdateEventDestinationRequest": { "type": "structure", "members": { - "DestinationPhoneNumber": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", "traits": { - "smithy.api#documentation": "The destination phone number in E.164 format.
", + "smithy.api#documentation": "The configuration set to update with the new event destination. Valid values for this\n can be the ConfigurationSetName or ConfigurationSetArn.
", "smithy.api#required": {} } }, - "OriginationIdentity": { - "target": "com.amazonaws.pinpointsmsvoicev2#VoiceMessageOriginationIdentity", + "EventDestinationName": { + "target": "com.amazonaws.pinpointsmsvoicev2#EventDestinationName", "traits": { - "smithy.api#documentation": "The origination identity to use for the voice call. This can be the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.
", + "smithy.api#documentation": "The name to use for the event destination.
", "smithy.api#required": {} } }, - "MessageBody": { - "target": "com.amazonaws.pinpointsmsvoicev2#VoiceMessageBody", + "Enabled": { + "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "The text to convert to a voice message.
" + "smithy.api#documentation": "When set to true logging is enabled.
" } }, - "MessageBodyTextType": { - "target": "com.amazonaws.pinpointsmsvoicev2#VoiceMessageBodyTextType", + "MatchingEventTypes": { + "target": "com.amazonaws.pinpointsmsvoicev2#EventTypeList", "traits": { - "smithy.api#documentation": "Specifies if the MessageBody field contains text or speech synthesis\n markup language (SSML).
\nTEXT: This is the default value. When used the maximum character limit is\n 3000.
\nSSML: When used the maximum character limit is 6000 including SSML\n tagging.
\nAn array of event types that determine which events to log.
\nThe TEXT_SENT event type is not supported.
The voice for the Amazon Polly\n service to use. By default this is set to \"MATTHEW\".
" + "smithy.api#documentation": "An object that contains information about an event destination that sends data to\n CloudWatch Logs.
" } }, - "ConfigurationSetName": { - "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", + "KinesisFirehoseDestination": { + "target": "com.amazonaws.pinpointsmsvoicev2#KinesisFirehoseDestination", "traits": { - "smithy.api#documentation": "The name of the configuration set to use. This can be either the ConfigurationSetName\n or ConfigurationSetArn.
" + "smithy.api#documentation": "An object that contains information about an event destination for logging to Kinesis Data Firehose.
" } }, - "MaxPricePerMinute": { - "target": "com.amazonaws.pinpointsmsvoicev2#MaxPrice", + "SnsDestination": { + "target": "com.amazonaws.pinpointsmsvoicev2#SnsDestination", "traits": { - "smithy.api#documentation": "The maximum amount to spend per voice message, in US dollars.
" + "smithy.api#documentation": "An object that contains information about an event destination that sends data to\n Amazon SNS.
" } - }, - "TimeToLive": { - "target": "com.amazonaws.pinpointsmsvoicev2#TimeToLive", + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#UpdateEventDestinationResult": { + "type": "structure", + "members": { + "ConfigurationSetArn": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "How long the voice message is valid for. By default this is 72 hours.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the ConfigurationSet that was updated.
" } }, - "Context": { - "target": "com.amazonaws.pinpointsmsvoicev2#ContextMap", + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetName", "traits": { - "smithy.api#documentation": "You can specify custom data in this field. If you do, that data is logged to the event\n destination.
" + "smithy.api#documentation": "The name of the configuration set.
" } }, - "DryRun": { - "target": "smithy.api#PrimitiveBoolean", + "EventDestination": { + "target": "com.amazonaws.pinpointsmsvoicev2#EventDestination", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "When set to true, the message is checked and validated, but isn't sent to the end\n recipient.
" + "smithy.api#documentation": "An EventDestination object containing the details of where events will be logged.\n
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#SendVoiceMessageResult": { - "type": "structure", - "members": { - "MessageId": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The unique identifier for the message.
" - } + "com.amazonaws.pinpointsmsvoicev2#UpdatePhoneNumber": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#UpdatePhoneNumberRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#UpdatePhoneNumberResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" } - } - }, - "com.amazonaws.pinpointsmsvoicev2#SenderId": { - "type": "string", + ], "traits": { - "smithy.api#length": { - "min": 1, - "max": 11 - }, - "smithy.api#pattern": "^[A-Za-z0-9_-]+$" + "smithy.api#documentation": "Updates the configuration of an existing origination phone number. You can update the\n opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable\n or disable self-managed opt-outs, and enable or disable deletion protection.
\nIf the origination phone number is associated with a pool, an error is\n returned.
" } }, - "com.amazonaws.pinpointsmsvoicev2#SenderIdAndCountry": { + "com.amazonaws.pinpointsmsvoicev2#UpdatePhoneNumberRequest": { "type": "structure", "members": { - "SenderId": { - "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdOrArn", + "PhoneNumberId": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberIdOrArn", "traits": { - "smithy.api#documentation": "The unique identifier of the sender.
", + "smithy.api#documentation": "The unique identifier of the phone number. Valid values for this field can be either\n the PhoneNumberId or PhoneNumberArn.
", "smithy.api#required": {} } }, - "IsoCountryCode": { - "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", + "TwoWayEnabled": { + "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
", - "smithy.api#required": {} + "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients.
" } - } - }, - "traits": { - "smithy.api#documentation": "The alphanumeric sender ID in a specific country that you want to describe. For more\n information on sender IDs see Requesting\n sender IDs for SMS messaging with Amazon Pinpoint\n in the Amazon Pinpoint User Guide.
" - } - }, - "com.amazonaws.pinpointsmsvoicev2#SenderIdFilter": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdFilterName", + }, + "TwoWayChannelArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#TwoWayChannelArn", "traits": { - "smithy.api#documentation": "The name of the attribute to filter on.
", - "smithy.api#required": {} + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the two way channel.
" } }, - "Values": { - "target": "com.amazonaws.pinpointsmsvoicev2#FilterValueList", + "TwoWayChannelRole": { + "target": "com.amazonaws.pinpointsmsvoicev2#IamRoleArn", "traits": { - "smithy.api#documentation": "An array of values to filter for.
", - "smithy.api#required": {} + "smithy.api#documentation": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + } + }, + "SelfManagedOptOutsEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins\n with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically\n replies with a customizable message and adds the end recipient to the OptOutList. When\n set to true you're responsible for responding to HELP and STOP requests. You're also\n responsible for tracking and honoring opt-out requests.
" + } + }, + "OptOutListName": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", + "traits": { + "smithy.api#documentation": "The OptOutList to add the phone number to. Valid values for this field can be either\n the OutOutListName or OutOutListArn.
" + } + }, + "DeletionProtectionEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "By default this is set to false. When set to true the phone number can't be deleted.\n
" } } }, "traits": { - "smithy.api#documentation": "The information for a sender ID that meets a specified criteria.
" - } - }, - "com.amazonaws.pinpointsmsvoicev2#SenderIdFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdFilter" - }, - "traits": { - "smithy.api#length": { - "max": 20 - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#SenderIdFilterName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "sender-id", - "name": "SENDER_ID" - }, - { - "value": "iso-country-code", - "name": "ISO_COUNTRY_CODE" - }, - { - "value": "message-type", - "name": "MESSAGE_TYPE" - } - ] + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#SenderIdInformation": { + "com.amazonaws.pinpointsmsvoicev2#UpdatePhoneNumberResult": { "type": "structure", "members": { - "SenderIdArn": { + "PhoneNumberArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the SenderId.
", - "smithy.api#required": {} + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated phone number.
" } }, - "SenderId": { - "target": "com.amazonaws.pinpointsmsvoicev2#SenderId", + "PhoneNumberId": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The alphanumeric sender ID in a specific country that you'd like to describe.
", - "smithy.api#required": {} + "smithy.api#documentation": "The unique identifier of the phone number.
" + } + }, + "PhoneNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", + "traits": { + "smithy.api#documentation": "The phone number that was updated.
" + } + }, + "Status": { + "target": "com.amazonaws.pinpointsmsvoicev2#NumberStatus", + "traits": { + "smithy.api#documentation": "The current status of the request.
" } }, "IsoCountryCode": { "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", "traits": { - "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
", - "smithy.api#required": {} + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
" } }, - "MessageTypes": { - "target": "com.amazonaws.pinpointsmsvoicev2#MessageTypeList", + "MessageType": { + "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", "traits": { - "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
", - "smithy.api#required": {} + "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
" + } + }, + "NumberCapabilities": { + "target": "com.amazonaws.pinpointsmsvoicev2#NumberCapabilityList", + "traits": { + "smithy.api#documentation": "Specifies if the number could be used for text messages, voice or both.
" + } + }, + "NumberType": { + "target": "com.amazonaws.pinpointsmsvoicev2#NumberType", + "traits": { + "smithy.api#documentation": "The type of number that was requested.
" } }, "MonthlyLeasingPrice": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The monthly leasing price, in US dollars.
", - "smithy.api#required": {} + "smithy.api#documentation": "The monthly leasing price of the phone number, in US dollars.
" } - } - }, - "traits": { - "smithy.api#documentation": "The information for all SenderIds in an Amazon Web Services account.
" - } - }, - "com.amazonaws.pinpointsmsvoicev2#SenderIdInformationList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdInformation" - } - }, - "com.amazonaws.pinpointsmsvoicev2#SenderIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdAndCountry" - }, - "traits": { - "smithy.api#length": { - "max": 5 - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#SenderIdOrArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 }, - "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" - } - }, - "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException": { - "type": "structure", - "members": { - "Message": { - "target": "smithy.api#String" + "TwoWayEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients.
" + } }, - "Reason": { - "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededExceptionReason", + "TwoWayChannelArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#TwoWayChannelArn", "traits": { - "smithy.api#documentation": "The reason for the exception.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the two way channel.
" } - } - }, - "traits": { - "smithy.api#documentation": "The request would cause a service quota to be exceeded.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededExceptionReason": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CONFIGURATION_SETS_PER_ACCOUNT", - "name": "CONFIGURATION_SETS_PER_ACCOUNT" - }, - { - "value": "DAILY_DESTINATION_CALL_LIMIT", - "name": "DAILY_DESTINATION_CALL_LIMIT" - }, - { - "value": "EVENT_DESTINATIONS_PER_CONFIGURATION_SET", - "name": "EVENT_DESTINATIONS_PER_CONFIGURATION_SET" - }, - { - "value": "KEYWORDS_PER_PHONE_NUMBER", - "name": "KEYWORDS_PER_PHONE_NUMBER" - }, - { - "value": "KEYWORDS_PER_POOL", - "name": "KEYWORDS_PER_POOL" - }, - { - "value": "MONTHLY_SPEND_LIMIT_REACHED_FOR_TEXT", - "name": "MONTHLY_SPEND_LIMIT_REACHED_FOR_TEXT" - }, - { - "value": "MONTHLY_SPEND_LIMIT_REACHED_FOR_VOICE", - "name": "MONTHLY_SPEND_LIMIT_REACHED_FOR_VOICE" - }, - { - "value": "OPT_OUT_LISTS_PER_ACCOUNT", - "name": "OPT_OUT_LISTS_PER_ACCOUNT" - }, - { - "value": "ORIGINATION_IDENTITIES_PER_POOL", - "name": "ORIGINATION_IDENTITIES_PER_POOL" - }, - { - "value": "PHONE_NUMBERS_PER_ACCOUNT", - "name": "PHONE_NUMBERS_PER_ACCOUNT" - }, - { - "value": "PHONE_NUMBERS_PER_REGISTRATION", - "name": "PHONE_NUMBERS_PER_REGISTRATION" - }, - { - "value": "POOLS_PER_ACCOUNT", - "name": "POOLS_PER_ACCOUNT" - }, - { - "value": "TAGS_PER_RESOURCE", - "name": "TAGS_PER_RESOURCE" + }, + "TwoWayChannelRole": { + "target": "com.amazonaws.pinpointsmsvoicev2#IamRoleArn", + "traits": { + "smithy.api#documentation": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + } + }, + "SelfManagedOptOutsEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "This is true if self managed opt-out are enabled.
" } - ] + }, + "OptOutListName": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", + "traits": { + "smithy.api#documentation": "The name of the OptOutList associated with the phone number.
" + } + }, + "DeletionProtectionEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "When set to true the phone number can't be deleted.
" + } + }, + "RegistrationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration.
" + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the phone number was created, in UNIX epoch time format.
" + } + } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#SetDefaultMessageType": { + "com.amazonaws.pinpointsmsvoicev2#UpdatePool": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#SetDefaultMessageTypeRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#UpdatePoolRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#SetDefaultMessageTypeResult" + "target": "com.amazonaws.pinpointsmsvoicev2#UpdatePoolResult" }, "errors": [ { "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, @@ -6079,129 +11368,157 @@ } ], "traits": { - "smithy.api#documentation": "Sets the default message type on a configuration set.
\nChoose the category of SMS messages that you plan to send from this account. If you\n send account-related messages or time-sensitive messages such as one-time passcodes,\n choose Transactional. If you plan to send messages that\n contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services\n account.
" + "smithy.api#documentation": "Updates the configuration of an existing pool. You can update the opt-out list, enable\n or disable two-way messaging, change the TwoWayChannelArn, enable or\n disable self-managed opt-outs, enable or disable deletion protection, and enable or\n disable shared routes.
The configuration set to update with a new default message type. This field can be the\n ConsigurationSetName or ConfigurationSetArn.
", + "smithy.api#documentation": "The unique identifier of the pool to update. Valid values are either the PoolId or\n PoolArn.
", "smithy.api#required": {} } }, - "MessageType": { - "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", + "TwoWayEnabled": { + "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
", - "smithy.api#required": {} + "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients.
" + } + }, + "TwoWayChannelArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#TwoWayChannelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the two way channel.
" + } + }, + "TwoWayChannelRole": { + "target": "com.amazonaws.pinpointsmsvoicev2#IamRoleArn", + "traits": { + "smithy.api#documentation": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + } + }, + "SelfManagedOptOutsEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins\n with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically\n replies with a customizable message and adds the end recipient to the OptOutList. When\n set to true you're responsible for responding to HELP and STOP requests. You're also\n responsible for tracking and honoring opt-out requests.
" + } + }, + "OptOutListName": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", + "traits": { + "smithy.api#documentation": "The OptOutList to associate with the pool. Valid values are either OptOutListName or\n OptOutListArn.
" + } + }, + "SharedRoutesEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether shared routes are enabled for the pool.
" + } + }, + "DeletionProtectionEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "When set to true the pool can't be deleted.
" } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#SetDefaultMessageTypeResult": { + "com.amazonaws.pinpointsmsvoicev2#UpdatePoolResult": { "type": "structure", "members": { - "ConfigurationSetArn": { + "PoolArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated configuration set.
" + "smithy.api#documentation": "The ARN of the pool.
" } }, - "ConfigurationSetName": { - "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetName", + "PoolId": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The name of the configuration set that was updated.
" + "smithy.api#documentation": "The unique identifier of the pool.
" + } + }, + "Status": { + "target": "com.amazonaws.pinpointsmsvoicev2#PoolStatus", + "traits": { + "smithy.api#documentation": "The current status of the pool update request.
" } }, "MessageType": { "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", "traits": { - "smithy.api#documentation": "The new default message type of the configuration set.
" + "smithy.api#documentation": "The type of message for the pool to use.
" } - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#SetDefaultSenderId": { - "type": "operation", - "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#SetDefaultSenderIdRequest" - }, - "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#SetDefaultSenderIdResult" - }, - "errors": [ - { - "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + "TwoWayEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients.
" + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + "TwoWayChannelArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#TwoWayChannelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the two way channel.
" + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + "TwoWayChannelRole": { + "target": "com.amazonaws.pinpointsmsvoicev2#IamRoleArn", + "traits": { + "smithy.api#documentation": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" + } }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Sets default sender ID on a configuration set.
\nWhen sending a text message to a destination country that supports sender IDs, the\n default sender ID on the configuration set specified will be used if no dedicated\n origination phone numbers or registered sender IDs are available in your account.
" - } - }, - "com.amazonaws.pinpointsmsvoicev2#SetDefaultSenderIdRequest": { - "type": "structure", - "members": { - "ConfigurationSetName": { - "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", + "SelfManagedOptOutsEnabled": { + "target": "smithy.api#PrimitiveBoolean", "traits": { - "smithy.api#documentation": "The configuration set to updated with a new default SenderId. This field can be the\n ConsigurationSetName or ConfigurationSetArn.
", - "smithy.api#required": {} + "smithy.api#default": false, + "smithy.api#documentation": "When an end recipient sends a message that begins with HELP or STOP to one of your\n dedicated numbers, Amazon Pinpoint automatically replies with a customizable message\n and adds the end recipient to the OptOutList. When set to true you're responsible for\n responding to HELP and STOP requests. You're also responsible for tracking and honoring\n opt-out requests.
" } }, - "SenderId": { - "target": "com.amazonaws.pinpointsmsvoicev2#SenderId", + "OptOutListName": { + "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", "traits": { - "smithy.api#documentation": "The current sender ID for the configuration set. When sending a text message to a\n destination country which supports SenderIds, the default sender ID on the configuration\n set specified on SendTextMessage will be used if no dedicated\n origination phone numbers or registered SenderIds are available in your account, instead\n of a generic sender ID, such as 'NOTICE'.
", - "smithy.api#required": {} + "smithy.api#documentation": "The name of the OptOutList associated with the pool.
" } - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#SetDefaultSenderIdResult": { - "type": "structure", - "members": { - "ConfigurationSetArn": { - "target": "smithy.api#String", + }, + "SharedRoutesEnabled": { + "target": "smithy.api#PrimitiveBoolean", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated configuration set.
" + "smithy.api#default": false, + "smithy.api#documentation": "Indicates whether shared routes are enabled for the pool.
" } }, - "ConfigurationSetName": { - "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetName", + "DeletionProtectionEnabled": { + "target": "smithy.api#PrimitiveBoolean", "traits": { - "smithy.api#documentation": "The name of the configuration set that was updated.
" + "smithy.api#default": false, + "smithy.api#documentation": "When set to true the pool can't be deleted.
" } }, - "SenderId": { - "target": "com.amazonaws.pinpointsmsvoicev2#SenderId", + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The default sender ID to set for the ConfigurationSet.
" + "smithy.api#documentation": "The time when the pool was created, in UNIX epoch time format.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#SetTextMessageSpendLimitOverride": { + "com.amazonaws.pinpointsmsvoicev2#UpdateSenderId": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#SetTextMessageSpendLimitOverrideRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#UpdateSenderIdRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#SetTextMessageSpendLimitOverrideResult" + "target": "com.amazonaws.pinpointsmsvoicev2#UpdateSenderIdResult" }, "errors": [ { @@ -6210,6 +11527,9 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" }, @@ -6218,674 +11538,484 @@ } ], "traits": { - "smithy.api#documentation": "Sets an account level monthly spend limit override for sending text messages. The\n requested spend limit must be less than or equal to the MaxLimit, which is\n set by Amazon Web Services.
Updates the configuration of an existing sender ID.
" } }, - "com.amazonaws.pinpointsmsvoicev2#SetTextMessageSpendLimitOverrideRequest": { + "com.amazonaws.pinpointsmsvoicev2#UpdateSenderIdRequest": { "type": "structure", "members": { - "MonthlyLimit": { - "target": "com.amazonaws.pinpointsmsvoicev2#MonthlyLimit", + "SenderId": { + "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdOrArn", "traits": { - "smithy.api#documentation": "The new monthly limit to enforce on text messages.
", + "smithy.api#documentation": "The sender ID to update.
", "smithy.api#required": {} } - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#SetTextMessageSpendLimitOverrideResult": { - "type": "structure", - "members": { - "MonthlyLimit": { - "target": "com.amazonaws.pinpointsmsvoicev2#MonthlyLimit", + }, + "IsoCountryCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", "traits": { - "smithy.api#documentation": "The current monthly limit to enforce on sending text messages.
" + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
", + "smithy.api#required": {} } - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#SetVoiceMessageSpendLimitOverride": { - "type": "operation", - "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#SetVoiceMessageSpendLimitOverrideRequest" - }, - "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#SetVoiceMessageSpendLimitOverrideResult" - }, - "errors": [ - { - "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Sets an account level monthly spend limit override for sending voice messages. The\n requested spend limit must be less than or equal to the MaxLimit, which is\n set by Amazon Web Services.
The new monthly limit to enforce on voice messages.
", - "smithy.api#required": {} + "smithy.api#documentation": "By default this is set to false. When set to true the sender ID can't be deleted.
" } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#SetVoiceMessageSpendLimitOverrideResult": { + "com.amazonaws.pinpointsmsvoicev2#UpdateSenderIdResult": { "type": "structure", "members": { - "MonthlyLimit": { - "target": "com.amazonaws.pinpointsmsvoicev2#MonthlyLimit", + "SenderIdArn": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The current monthly limit to enforce on sending voice messages.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the SenderId.
", + "smithy.api#required": {} + } + }, + "SenderId": { + "target": "com.amazonaws.pinpointsmsvoicev2#SenderId", + "traits": { + "smithy.api#documentation": "The sender ID that was updated.
", + "smithy.api#required": {} + } + }, + "IsoCountryCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", + "traits": { + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
", + "smithy.api#required": {} + } + }, + "MessageTypes": { + "target": "com.amazonaws.pinpointsmsvoicev2#MessageTypeList", + "traits": { + "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
", + "smithy.api#required": {} + } + }, + "MonthlyLeasingPrice": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The monthly price, in US dollars, to lease the sender ID.
", + "smithy.api#required": {} + } + }, + "DeletionProtectionEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "By default this is set to false. When set to true the sender ID can't be deleted.
", + "smithy.api#required": {} + } + }, + "Registered": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "True if the sender ID is registered..
", + "smithy.api#required": {} + } + }, + "RegistrationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the registration.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.pinpointsmsvoicev2#SnsDestination": { + "com.amazonaws.pinpointsmsvoicev2#ValidationException": { "type": "structure", "members": { - "TopicArn": { - "target": "com.amazonaws.pinpointsmsvoicev2#SnsTopicArn", + "Message": { + "target": "smithy.api#String" + }, + "Reason": { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationExceptionReason", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to\n publish events to.
", - "smithy.api#required": {} + "smithy.api#documentation": "The reason for the exception.
" + } + }, + "Fields": { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "The field that failed validation.
" } } }, "traits": { - "smithy.api#documentation": "An object that defines an Amazon SNS destination for events. You can use\n Amazon SNS to send notification when certain events occur.
" - } - }, - "com.amazonaws.pinpointsmsvoicev2#SnsTopicArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:\\S+$" + "smithy.api#documentation": "A validation exception for a field.
", + "smithy.api#error": "client" } }, - "com.amazonaws.pinpointsmsvoicev2#SpendLimit": { + "com.amazonaws.pinpointsmsvoicev2#ValidationExceptionField": { "type": "structure", "members": { "Name": { - "target": "com.amazonaws.pinpointsmsvoicev2#SpendLimitName", - "traits": { - "smithy.api#documentation": "The name for the SpendLimit.
", - "smithy.api#required": {} - } - }, - "EnforcedLimit": { - "target": "smithy.api#PrimitiveLong", + "target": "smithy.api#String", "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum amount of money, in US dollars, that you want to be able to spend sending\n messages each month. This value has to be less than or equal to the amount in\n MaxLimit. To use this custom limit, Overridden must be set\n to true.
The name of the field.
", "smithy.api#required": {} } }, - "MaxLimit": { - "target": "smithy.api#PrimitiveLong", + "Message": { + "target": "smithy.api#String", "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum amount of money that you are able to spend to send messages each month,\n in US dollars.
", + "smithy.api#documentation": "The message associated with the validation exception with information to help\n determine its cause.
", "smithy.api#required": {} } - }, - "Overridden": { - "target": "smithy.api#PrimitiveBoolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "When set to True, the value that has been specified in the\n EnforcedLimit is used to determine the maximum amount in US dollars\n that can be spent to send messages each month, in US dollars.
The field associated with the validation exception.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationExceptionField" + } + }, + "com.amazonaws.pinpointsmsvoicev2#ValidationExceptionReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CANNOT_ADD_OPTED_OUT_NUMBER", + "name": "CANNOT_ADD_OPTED_OUT_NUMBER" + }, + { + "value": "CANNOT_PARSE", + "name": "CANNOT_PARSE" + }, + { + "value": "COUNTRY_CODE_MISMATCH", + "name": "COUNTRY_CODE_MISMATCH" + }, + { + "value": "DESTINATION_COUNTRY_BLOCKED", + "name": "DESTINATION_COUNTRY_BLOCKED" + }, + { + "value": "FIELD_VALIDATION_FAILED", + "name": "FIELD_VALIDATION_FAILED" + }, + { + "value": "ATTACHMENT_TYPE_NOT_SUPPORTED", + "name": "ATTACHMENT_TYPE_NOT_SUPPORTED" + }, + { + "value": "INVALID_ARN", + "name": "INVALID_ARN" + }, + { + "value": "INVALID_FILTER_VALUES", + "name": "INVALID_FILTER_VALUES" + }, + { + "value": "INVALID_IDENTITY_FOR_DESTINATION_COUNTRY", + "name": "INVALID_IDENTITY_FOR_DESTINATION_COUNTRY" + }, + { + "value": "INVALID_NEXT_TOKEN", + "name": "INVALID_NEXT_TOKEN" + }, + { + "value": "INVALID_PARAMETER", + "name": "INVALID_PARAMETER" + }, + { + "value": "INVALID_REQUEST", + "name": "INVALID_REQUEST" + }, + { + "value": "INVALID_REGISTRATION_ASSOCIATION", + "name": "INVALID_REGISTRATION_ASSOCIATION" + }, + { + "value": "MAXIMUM_SIZE_EXCEEDED", + "name": "MAXIMUM_SIZE_EXCEEDED" + }, + { + "value": "MISSING_PARAMETER", + "name": "MISSING_PARAMETER" + }, + { + "value": "PARAMETERS_CANNOT_BE_USED_TOGETHER", + "name": "PARAMETERS_CANNOT_BE_USED_TOGETHER" + }, + { + "value": "PHONE_NUMBER_CANNOT_BE_OPTED_IN", + "name": "PHONE_NUMBER_CANNOT_BE_OPTED_IN" + }, + { + "value": "PHONE_NUMBER_CANNOT_BE_RELEASED", + "name": "PHONE_NUMBER_CANNOT_BE_RELEASED" + }, + { + "value": "PRICE_OVER_THRESHOLD", + "name": "PRICE_OVER_THRESHOLD" + }, + { + "value": "RESOURCE_NOT_ACCESSIBLE", + "name": "RESOURCE_NOT_ACCESSIBLE" + }, + { + "value": "REQUESTED_SPEND_LIMIT_HIGHER_THAN_SERVICE_LIMIT", + "name": "REQUESTED_SPEND_LIMIT_HIGHER_THAN_SERVICE_LIMIT" + }, + { + "value": "SENDER_ID_NOT_REGISTERED", + "name": "SENDER_ID_NOT_REGISTERED" + }, + { + "value": "SENDER_ID_NOT_SUPPORTED", + "name": "SENDER_ID_NOT_SUPPORTED" + }, + { + "value": "SENDER_ID_REQUIRES_REGISTRATION", + "name": "SENDER_ID_REQUIRES_REGISTRATION" + }, + { + "value": "TWO_WAY_TOPIC_NOT_PRESENT", + "name": "TWO_WAY_TOPIC_NOT_PRESENT" + }, + { + "value": "TWO_WAY_NOT_ENABLED", + "name": "TWO_WAY_NOT_ENABLED" + }, + { + "value": "TWO_WAY_NOT_SUPPORTED_IN_COUNTRY", + "name": "TWO_WAY_NOT_SUPPORTED_IN_COUNTRY" + }, + { + "value": "TWO_WAY_NOT_SUPPORTED_IN_REGION", + "name": "TWO_WAY_NOT_SUPPORTED_IN_REGION" + }, + { + "value": "TWO_WAY_CHANNEL_NOT_PRESENT", + "name": "TWO_WAY_CHANNEL_NOT_PRESENT" + }, + { + "value": "UNKNOWN_REGISTRATION_FIELD", + "name": "UNKNOWN_REGISTRATION_FIELD" + }, + { + "value": "UNKNOWN_REGISTRATION_SECTION", + "name": "UNKNOWN_REGISTRATION_SECTION" + }, + { + "value": "UNKNOWN_REGISTRATION_TYPE", + "name": "UNKNOWN_REGISTRATION_TYPE" + }, + { + "value": "UNKNOWN_REGISTRATION_VERSION", + "name": "UNKNOWN_REGISTRATION_VERSION" + }, + { + "value": "UNKNOWN_OPERATION", + "name": "UNKNOWN_OPERATION" + }, + { + "value": "REGISTRATION_FIELD_CANNOT_BE_DELETED", + "name": "REGISTRATION_FIELD_CANNOT_BE_DELETED" + }, + { + "value": "VERIFICATION_CODE_MISMATCH", + "name": "VERIFICATION_CODE_MISMATCH" + }, + { + "value": "VOICE_CAPABILITY_NOT_AVAILABLE", + "name": "VOICE_CAPABILITY_NOT_AVAILABLE" + }, + { + "value": "OTHER", + "name": "OTHER" } - } - }, - "traits": { - "smithy.api#documentation": "Describes the current Amazon Pinpoint monthly spend limits for sending voice and\n text messages. For more information on increasing your monthly spend limit, see \n Requesting increases to your monthly SMS spending quota for Amazon Pinpoint\n in the Amazon Pinpoint User Guide.
" - } - }, - "com.amazonaws.pinpointsmsvoicev2#SpendLimitList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#SpendLimit" + ] } }, - "com.amazonaws.pinpointsmsvoicev2#SpendLimitName": { + "com.amazonaws.pinpointsmsvoicev2#VerificationChannel": { "type": "string", "traits": { "smithy.api#enum": [ { - "value": "TEXT_MESSAGE_MONTHLY_SPEND_LIMIT", - "name": "TEXT_MESSAGE_MONTHLY_SPEND_LIMIT" + "value": "TEXT", + "name": "TEXT" }, { - "value": "VOICE_MESSAGE_MONTHLY_SPEND_LIMIT", - "name": "VOICE_MESSAGE_MONTHLY_SPEND_LIMIT" + "value": "VOICE", + "name": "VOICE" } ] } }, - "com.amazonaws.pinpointsmsvoicev2#Tag": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.pinpointsmsvoicev2#TagKey", - "traits": { - "smithy.api#documentation": "The key identifier, or name, of the tag.
", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.pinpointsmsvoicev2#TagValue", - "traits": { - "smithy.api#documentation": "The string value associated with the key of the tag.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The list of tags to be added to the specified topic.
" - } - }, - "com.amazonaws.pinpointsmsvoicev2#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^.+$" - } - }, - "com.amazonaws.pinpointsmsvoicev2#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#TagList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#Tag" - }, - "traits": { - "smithy.api#length": { - "max": 200 - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#TagResourceRequest" - }, - "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#TagResourceResult" - }, - "errors": [ - { - "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS\n Voice, version 2 resource. When you specify an existing tag key, the value is\n overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag\n consists of a key and an optional value. Tag keys must be unique per resource. For more\n information about tags, see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer\n Guide.
" - } - }, - "com.amazonaws.pinpointsmsvoicev2#TagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.pinpointsmsvoicev2#AmazonResourceName", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.pinpointsmsvoicev2#NonEmptyTagList", - "traits": { - "smithy.api#documentation": "An array of key and value pair tags that are associated with the resource.
", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#TagResourceResult": { - "type": "structure", - "members": {} - }, - "com.amazonaws.pinpointsmsvoicev2#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 256 - }, - "smithy.api#pattern": "^.*$" - } - }, - "com.amazonaws.pinpointsmsvoicev2#TextMessageBody": { + "com.amazonaws.pinpointsmsvoicev2#VerificationCode": { "type": "string", "traits": { "smithy.api#length": { "min": 1, - "max": 1600 + "max": 20 }, - "smithy.api#pattern": "^(?!\\s*$)[\\s\\S]+$" + "smithy.api#pattern": "^[A-Za-z0-9]+$" } }, - "com.amazonaws.pinpointsmsvoicev2#TextMessageOriginationIdentity": { + "com.amazonaws.pinpointsmsvoicev2#VerificationMessageOriginationIdentity": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, - "smithy.api#pattern": "^[A-Za-z0-9_:/\\+-]+$" - } - }, - "com.amazonaws.pinpointsmsvoicev2#ThrottlingException": { - "type": "structure", - "members": { - "Message": { - "target": "smithy.api#String" - } - }, - "traits": { - "smithy.api#documentation": "An error that occurred because too many requests were sent during a certain amount of\n time.
", - "smithy.api#error": "client", - "smithy.api#retryable": { - "throttling": true - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#TimeToLive": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 5, - "max": 259200 - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#TwoWayChannelArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:\\S+$" - } - }, - "com.amazonaws.pinpointsmsvoicev2#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#UntagResourceResult" - }, - "errors": [ - { - "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Removes the association of the specified tags from an Amazon Pinpoint SMS Voice V2\n resource. For more information on tags see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer\n Guide.
" - } - }, - "com.amazonaws.pinpointsmsvoicev2#UntagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.pinpointsmsvoicev2#AmazonResourceName", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", - "smithy.api#required": {} - } - }, - "TagKeys": { - "target": "com.amazonaws.pinpointsmsvoicev2#TagKeyList", - "traits": { - "smithy.api#documentation": "An array of tag key values to unassociate with the resource.
", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#UntagResourceResult": { - "type": "structure", - "members": {} - }, - "com.amazonaws.pinpointsmsvoicev2#UpdateEventDestination": { - "type": "operation", - "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#UpdateEventDestinationRequest" - }, - "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#UpdateEventDestinationResult" - }, - "errors": [ - { - "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" - } - ], + "smithy.api#pattern": "^[A-Za-z0-9_:/\\+-]+$" + } + }, + "com.amazonaws.pinpointsmsvoicev2#VerificationStatus": { + "type": "string", "traits": { - "smithy.api#documentation": "Updates an existing event destination in a configuration set. You can update the\n IAM role ARN for CloudWatch Logs and Kinesis Data Firehose. You can\n also enable or disable the event destination.
\nYou may want to update an event destination to change its matching event types or\n updating the destination resource ARN. You can't change an event destination's type\n between CloudWatch Logs, Kinesis Data Firehose, and Amazon SNS.
" + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "VERIFIED", + "name": "VERIFIED" + } + ] } }, - "com.amazonaws.pinpointsmsvoicev2#UpdateEventDestinationRequest": { + "com.amazonaws.pinpointsmsvoicev2#VerifiedDestinationNumberFilter": { "type": "structure", "members": { - "ConfigurationSetName": { - "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", + "Name": { + "target": "com.amazonaws.pinpointsmsvoicev2#VerifiedDestinationNumberFilterName", "traits": { - "smithy.api#documentation": "The configuration set to update with the new event destination. Valid values for this\n can be the ConfigurationSetName or ConfigurationSetArn.
", + "smithy.api#documentation": "The name of the attribute to filter on.
", "smithy.api#required": {} } }, - "EventDestinationName": { - "target": "com.amazonaws.pinpointsmsvoicev2#EventDestinationName", + "Values": { + "target": "com.amazonaws.pinpointsmsvoicev2#FilterValueList", "traits": { - "smithy.api#documentation": "The name to use for the event destination.
", + "smithy.api#documentation": "An array of values to filter on.
", "smithy.api#required": {} } - }, - "Enabled": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "When set to true logging is enabled.
" - } - }, - "MatchingEventTypes": { - "target": "com.amazonaws.pinpointsmsvoicev2#EventTypeList", - "traits": { - "smithy.api#documentation": "An array of event types that determine which events to log.
" - } - }, - "CloudWatchLogsDestination": { - "target": "com.amazonaws.pinpointsmsvoicev2#CloudWatchLogsDestination", - "traits": { - "smithy.api#documentation": "An object that contains information about an event destination that sends data to\n CloudWatch Logs.
" - } - }, - "KinesisFirehoseDestination": { - "target": "com.amazonaws.pinpointsmsvoicev2#KinesisFirehoseDestination", - "traits": { - "smithy.api#documentation": "An object that contains information about an event destination for logging to Kinesis Data Firehose.
" - } - }, - "SnsDestination": { - "target": "com.amazonaws.pinpointsmsvoicev2#SnsDestination", - "traits": { - "smithy.api#documentation": "An object that contains information about an event destination that sends data to\n Amazon SNS.
" - } } + }, + "traits": { + "smithy.api#documentation": "The filter definition for filtering verified destination phone numbers that meets a specified criteria.
" } }, - "com.amazonaws.pinpointsmsvoicev2#UpdateEventDestinationResult": { - "type": "structure", - "members": { - "ConfigurationSetArn": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the ConfigurationSet that was updated.
" - } - }, - "ConfigurationSetName": { - "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetName", - "traits": { - "smithy.api#documentation": "The name of the configuration set.
" - } - }, - "EventDestination": { - "target": "com.amazonaws.pinpointsmsvoicev2#EventDestination", - "traits": { - "smithy.api#documentation": "An EventDestination object containing the details of where events will be logged.\n
" - } + "com.amazonaws.pinpointsmsvoicev2#VerifiedDestinationNumberFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#VerifiedDestinationNumberFilter" + }, + "traits": { + "smithy.api#length": { + "max": 20 } } }, - "com.amazonaws.pinpointsmsvoicev2#UpdatePhoneNumber": { - "type": "operation", - "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#UpdatePhoneNumberRequest" - }, - "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#UpdatePhoneNumberResult" + "com.amazonaws.pinpointsmsvoicev2#VerifiedDestinationNumberFilterName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "status", + "name": "STATUS" + } + ] + } + }, + "com.amazonaws.pinpointsmsvoicev2#VerifiedDestinationNumberIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#VerifiedDestinationNumberIdOrArn" }, - "errors": [ - { - "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" - }, - { - "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" - } - ], "traits": { - "smithy.api#documentation": "Updates the configuration of an existing origination phone number. You can update the\n opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable\n or disable self-managed opt-outs, and enable or disable deletion protection.
\nIf the origination phone number is associated with a pool, an Error is\n returned.
" + "smithy.api#length": { + "max": 5 + } } }, - "com.amazonaws.pinpointsmsvoicev2#UpdatePhoneNumberRequest": { - "type": "structure", - "members": { - "PhoneNumberId": { - "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberIdOrArn", - "traits": { - "smithy.api#documentation": "The unique identifier of the phone number. Valid values for this field can be either\n the PhoneNumberId or PhoneNumberArn.
", - "smithy.api#required": {} - } - }, - "TwoWayEnabled": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients.
" - } - }, - "TwoWayChannelArn": { - "target": "com.amazonaws.pinpointsmsvoicev2#TwoWayChannelArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the two way channel.
" - } - }, - "SelfManagedOptOutsEnabled": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins\n with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically\n replies with a customizable message and adds the end recipient to the OptOutList. When\n set to true you're responsible for responding to HELP and STOP requests. You're also\n responsible for tracking and honoring opt-out requests.
" - } - }, - "OptOutListName": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", - "traits": { - "smithy.api#documentation": "The OptOutList to add the phone number to. Valid values for this field can be either\n the OutOutListName or OutOutListArn.
" - } + "com.amazonaws.pinpointsmsvoicev2#VerifiedDestinationNumberIdOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 }, - "DeletionProtectionEnabled": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "By default this is set to false. When set to true the phone number can't be deleted.\n
" - } - } + "smithy.api#pattern": "^[A-Za-z0-9_:/-]+$" } }, - "com.amazonaws.pinpointsmsvoicev2#UpdatePhoneNumberResult": { + "com.amazonaws.pinpointsmsvoicev2#VerifiedDestinationNumberInformation": { "type": "structure", "members": { - "PhoneNumberArn": { + "VerifiedDestinationNumberArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated phone number.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the verified destination phone number.
", + "smithy.api#required": {} } }, - "PhoneNumberId": { + "VerifiedDestinationNumberId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The unique identifier of the phone number.
" + "smithy.api#documentation": "The unique identifier for the verified destination phone number.
", + "smithy.api#required": {} } }, - "PhoneNumber": { + "DestinationPhoneNumber": { "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", "traits": { - "smithy.api#documentation": "The phone number that was updated.
" + "smithy.api#documentation": "The verified destination phone number, in E.164 format.
", + "smithy.api#required": {} } }, "Status": { - "target": "com.amazonaws.pinpointsmsvoicev2#NumberStatus", - "traits": { - "smithy.api#documentation": "The current status of the request.
" - } - }, - "IsoCountryCode": { - "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", - "traits": { - "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
" - } - }, - "MessageType": { - "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", - "traits": { - "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
" - } - }, - "NumberCapabilities": { - "target": "com.amazonaws.pinpointsmsvoicev2#NumberCapabilityList", - "traits": { - "smithy.api#documentation": "Specifies if the number could be used for text messages, voice or both.
" - } - }, - "NumberType": { - "target": "com.amazonaws.pinpointsmsvoicev2#NumberType", - "traits": { - "smithy.api#documentation": "The type of number that was requested.
" - } - }, - "MonthlyLeasingPrice": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The monthly leasing price of the phone number, in US dollars.
" - } - }, - "TwoWayEnabled": { - "target": "smithy.api#PrimitiveBoolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients.
" - } - }, - "TwoWayChannelArn": { - "target": "com.amazonaws.pinpointsmsvoicev2#TwoWayChannelArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the two way channel.
" - } - }, - "SelfManagedOptOutsEnabled": { - "target": "smithy.api#PrimitiveBoolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "This is true if self managed opt-out are enabled.
" - } - }, - "OptOutListName": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", - "traits": { - "smithy.api#documentation": "The name of the OptOutList associated with the phone number.
" - } - }, - "DeletionProtectionEnabled": { - "target": "smithy.api#PrimitiveBoolean", + "target": "com.amazonaws.pinpointsmsvoicev2#VerificationStatus", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "When set to true the phone number can't be deleted.
" + "smithy.api#documentation": "The status of the verified destination phone number.
\n\n PENDING: The phone number hasn't been verified yet.
\n VERIFIED: The phone number is verified and can receive messages.
The time when the phone number was created, in UNIX epoch time format.
" + "smithy.api#documentation": "The time when the destination phone number was created, in UNIX epoch time format.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "Provides information about the requested verified destintion phone number.
" + } + }, + "com.amazonaws.pinpointsmsvoicev2#VerifiedDestinationNumberInformationList": { + "type": "list", + "member": { + "target": "com.amazonaws.pinpointsmsvoicev2#VerifiedDestinationNumberInformation" } }, - "com.amazonaws.pinpointsmsvoicev2#UpdatePool": { + "com.amazonaws.pinpointsmsvoicev2#VerifyDestinationNumber": { "type": "operation", "input": { - "target": "com.amazonaws.pinpointsmsvoicev2#UpdatePoolRequest" + "target": "com.amazonaws.pinpointsmsvoicev2#VerifyDestinationNumberRequest" }, "output": { - "target": "com.amazonaws.pinpointsmsvoicev2#UpdatePoolResult" + "target": "com.amazonaws.pinpointsmsvoicev2#VerifyDestinationNumberResult" }, "errors": [ { @@ -6908,285 +12038,72 @@ } ], "traits": { - "smithy.api#documentation": "Updates the configuration of an existing pool. You can update the opt-out list, enable\n or disable two-way messaging, change the TwoWayChannelArn, enable or\n disable self-managed opt-outs, enable or disable deletion protection, and enable or\n disable shared routes.
Use the verification code that was received by the verified destination phone number to opt-in the verified destination phone number to receive more messages.
" } }, - "com.amazonaws.pinpointsmsvoicev2#UpdatePoolRequest": { + "com.amazonaws.pinpointsmsvoicev2#VerifyDestinationNumberRequest": { "type": "structure", "members": { - "PoolId": { - "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn", + "VerifiedDestinationNumberId": { + "target": "com.amazonaws.pinpointsmsvoicev2#VerifiedDestinationNumberIdOrArn", "traits": { - "smithy.api#documentation": "The unique identifier of the pool to update. Valid values are either the PoolId or\n PoolArn.
", + "smithy.api#documentation": "The unique identifier for the verififed destination phone number.
", "smithy.api#required": {} } }, - "TwoWayEnabled": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients.
" - } - }, - "TwoWayChannelArn": { - "target": "com.amazonaws.pinpointsmsvoicev2#TwoWayChannelArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the two way channel.
" - } - }, - "SelfManagedOptOutsEnabled": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins\n with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically\n replies with a customizable message and adds the end recipient to the OptOutList. When\n set to true you're responsible for responding to HELP and STOP requests. You're also\n responsible for tracking and honoring opt-out requests.
" - } - }, - "OptOutListName": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", - "traits": { - "smithy.api#documentation": "The OptOutList to associate with the pool. Valid values are either OptOutListName or\n OptOutListArn.
" - } - }, - "SharedRoutesEnabled": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "Indicates whether shared routes are enabled for the pool.
" - } - }, - "DeletionProtectionEnabled": { - "target": "smithy.api#Boolean", + "VerificationCode": { + "target": "com.amazonaws.pinpointsmsvoicev2#VerificationCode", "traits": { - "smithy.api#documentation": "When set to true the pool can't be deleted.
" + "smithy.api#documentation": "The verification code that was received by the verified destination phone number.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.pinpointsmsvoicev2#UpdatePoolResult": { + "com.amazonaws.pinpointsmsvoicev2#VerifyDestinationNumberResult": { "type": "structure", "members": { - "PoolArn": { + "VerifiedDestinationNumberArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The ARN of the pool.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the verified destination phone number.
", + "smithy.api#required": {} } }, - "PoolId": { + "VerifiedDestinationNumberId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The unique identifier of the pool.
" - } - }, - "Status": { - "target": "com.amazonaws.pinpointsmsvoicev2#PoolStatus", - "traits": { - "smithy.api#documentation": "The current status of the pool update request.
" - } - }, - "MessageType": { - "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", - "traits": { - "smithy.api#documentation": "The type of message for the pool to use.
" - } - }, - "TwoWayEnabled": { - "target": "smithy.api#PrimitiveBoolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients.
" - } - }, - "TwoWayChannelArn": { - "target": "com.amazonaws.pinpointsmsvoicev2#TwoWayChannelArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the two way channel.
" - } - }, - "SelfManagedOptOutsEnabled": { - "target": "smithy.api#PrimitiveBoolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "When an end recipient sends a message that begins with HELP or STOP to one of your\n dedicated numbers, Amazon Pinpoint automatically replies with a customizable message\n and adds the end recipient to the OptOutList. When set to true you're responsible for\n responding to HELP and STOP requests. You're also responsible for tracking and honoring\n opt-out requests.
" - } - }, - "OptOutListName": { - "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListName", - "traits": { - "smithy.api#documentation": "The name of the OptOutList associated with the pool.
" + "smithy.api#documentation": "The unique identifier for the verified destination phone number.
", + "smithy.api#required": {} } }, - "SharedRoutesEnabled": { - "target": "smithy.api#PrimitiveBoolean", + "DestinationPhoneNumber": { + "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumber", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Indicates whether shared routes are enabled for the pool.
" + "smithy.api#documentation": "The phone number in E.164 format.
", + "smithy.api#required": {} } }, - "DeletionProtectionEnabled": { - "target": "smithy.api#PrimitiveBoolean", + "Status": { + "target": "com.amazonaws.pinpointsmsvoicev2#VerificationStatus", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "When set to true the pool can't be deleted.
" + "smithy.api#documentation": "The status for being able to send messages to the phone number.
", + "smithy.api#required": {} } }, "CreatedTimestamp": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time when the pool was created, in UNIX epoch time format.
" - } - } - } - }, - "com.amazonaws.pinpointsmsvoicev2#ValidationException": { - "type": "structure", - "members": { - "Message": { - "target": "smithy.api#String" - }, - "Reason": { - "target": "com.amazonaws.pinpointsmsvoicev2#ValidationExceptionReason", - "traits": { - "smithy.api#documentation": "The reason for the exception.
" - } - }, - "Fields": { - "target": "com.amazonaws.pinpointsmsvoicev2#ValidationExceptionFieldList", - "traits": { - "smithy.api#documentation": "The field that failed validation.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A validation exception for a field.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.pinpointsmsvoicev2#ValidationExceptionField": { - "type": "structure", - "members": { - "Name": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The name of the field.
", - "smithy.api#required": {} - } - }, - "Message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The message associated with the validation exception with information to help\n determine its cause.
", + "smithy.api#documentation": "The time when the destination phone number was created, in UNIX epoch time format.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The field associated with the validation exception.
" - } - }, - "com.amazonaws.pinpointsmsvoicev2#ValidationExceptionFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.pinpointsmsvoicev2#ValidationExceptionField" - } - }, - "com.amazonaws.pinpointsmsvoicev2#ValidationExceptionReason": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "UNKNOWN_OPERATION", - "name": "UNKNOWN_OPERATION" - }, - { - "value": "CANNOT_PARSE", - "name": "CANNOT_PARSE" - }, - { - "value": "FIELD_VALIDATION_FAILED", - "name": "FIELD_VALIDATION_FAILED" - }, - { - "value": "OTHER", - "name": "OTHER" - }, - { - "value": "INVALID_PARAMETER", - "name": "INVALID_PARAMETER" - }, - { - "value": "INVALID_ARN", - "name": "INVALID_ARN" - }, - { - "value": "INVALID_IDENTITY_FOR_DESTINATION_COUNTRY", - "name": "INVALID_IDENTITY_FOR_DESTINATION_COUNTRY" - }, - { - "value": "DESTINATION_COUNTRY_BLOCKED", - "name": "DESTINATION_COUNTRY_BLOCKED" - }, - { - "value": "CANNOT_ADD_OPTED_OUT_NUMBER", - "name": "CANNOT_ADD_OPTED_OUT_NUMBER" - }, - { - "value": "COUNTRY_CODE_MISMATCH", - "name": "COUNTRY_CODE_MISMATCH" - }, - { - "value": "INVALID_FILTER_VALUES", - "name": "INVALID_FILTER_VALUES" - }, - { - "value": "INVALID_NEXT_TOKEN", - "name": "INVALID_NEXT_TOKEN" - }, - { - "value": "MISSING_PARAMETER", - "name": "MISSING_PARAMETER" - }, - { - "value": "PARAMETERS_CANNOT_BE_USED_TOGETHER", - "name": "PARAMETERS_CANNOT_BE_USED_TOGETHER" - }, - { - "value": "PHONE_NUMBER_CANNOT_BE_OPTED_IN", - "name": "PHONE_NUMBER_CANNOT_BE_OPTED_IN" - }, - { - "value": "PHONE_NUMBER_CANNOT_BE_RELEASED", - "name": "PHONE_NUMBER_CANNOT_BE_RELEASED" - }, - { - "value": "PRICE_OVER_THRESHOLD", - "name": "PRICE_OVER_THRESHOLD" - }, - { - "value": "REQUESTED_SPEND_LIMIT_HIGHER_THAN_SERVICE_LIMIT", - "name": "REQUESTED_SPEND_LIMIT_HIGHER_THAN_SERVICE_LIMIT" - }, - { - "value": "SENDER_ID_NOT_REGISTERED", - "name": "SENDER_ID_NOT_REGISTERED" - }, - { - "value": "SENDER_ID_NOT_SUPPORTED", - "name": "SENDER_ID_NOT_SUPPORTED" - }, - { - "value": "TWO_WAY_NOT_ENABLED", - "name": "TWO_WAY_NOT_ENABLED" - }, - { - "value": "TWO_WAY_NOT_SUPPORTED_IN_COUNTRY", - "name": "TWO_WAY_NOT_SUPPORTED_IN_COUNTRY" - }, - { - "value": "TWO_WAY_NOT_SUPPORTED_IN_REGION", - "name": "TWO_WAY_NOT_SUPPORTED_IN_REGION" - }, - { - "value": "TWO_WAY_TOPIC_NOT_PRESENT", - "name": "TWO_WAY_TOPIC_NOT_PRESENT" - } - ] + "smithy.api#output": {} } }, "com.amazonaws.pinpointsmsvoicev2#VoiceId": {