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 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 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 Amazon Pinpoint functionality into mobile apps and other types of applications. 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.
", "operations": { "AssociateOriginationIdentity": "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.
", "CreateConfigurationSet": "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 that you send.
When you send a message, you can optionally specify a single configuration set.
", "CreateEventDestination": "Creates a new event destination in a configuration set.
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 destination can contain a reference to a single destination, such as a CloudWatch or Kinesis Data Firehose destination.
", "CreateOptOutList": "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 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 opt-out keywords, see SMS opt out in the Amazon Pinpoint User Guide.
", "CreatePool": "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 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.
", "CreateRegistration": "Creates a new registration based on the RegistrationType field.
", "CreateRegistrationAssociation": "Associate the registration with an origination identity such as a phone number or sender ID.
", "CreateRegistrationAttachment": "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.
", "CreateRegistrationVersion": "Create a new version of the registration and increase the VersionNumber. The previous version of the registration becomes read-only.
", "CreateVerifiedDestinationNumber": "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.
", "DeleteConfigurationSet": "Deletes an existing configuration set.
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.
", "DeleteDefaultMessageType": "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 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 account.
", "DeleteDefaultSenderId": "Deletes an existing default sender ID on a configuration set.
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.
", "DeleteEventDestination": "Deletes an existing event destination.
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.
", "DeleteKeyword": "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 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.
", "DeleteOptOutList": "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.
", "DeleteOptedOutNumber": "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.
", "DeletePool": "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 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.
", "DeleteRegistration": "Permanently delete an existing registration from your account.
", "DeleteRegistrationAttachment": "Permanently delete the specified registration attachment.
", "DeleteRegistrationFieldValue": "Delete the value in a registration form field.
", "DeleteTextMessageSpendLimitOverride": "Deletes an account-level monthly spending limit override for sending text messages. Deleting a spend limit override will set the EnforcedLimit to equal the MaxLimit, which is controlled by Amazon Web Services. For more information on spend limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
Delete a verified destination phone number.
", "DeleteVoiceMessageSpendLimitOverride": "Deletes an account level monthly spend limit override for sending voice messages. Deleting a spend limit override sets the EnforcedLimit equal to the MaxLimit, which is controlled by Amazon Web Services. For more information on spending limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
Describes attributes of your Amazon Web Services account. The supported account attributes include account tier, which indicates whether your account is in the sandbox or production environment. When you're ready to move your account out of the sandbox, create an Amazon Web Services Support case for a service limit increase request.
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.
", "DescribeAccountLimits": "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 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 Guide.
", "DescribeConfigurationSets": "Describes the specified configuration sets or all in your account.
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.
", "DescribeKeywords": "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 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.
", "DescribeOptOutLists": "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 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.
", "DescribeOptedOutNumbers": "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 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.
", "DescribePhoneNumbers": "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 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.
", "DescribePools": "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 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 phone numbers and SenderIds that are associated with your Amazon Web Services account.
", "DescribeRegistrationAttachments": "Retrieves the specified registration attachments or all registration attachments associated with your Amazon Web Services account.
", "DescribeRegistrationFieldDefinitions": "Retrieves the specified registration type field definitions. You can use DescribeRegistrationFieldDefinitions to view the requirements for creating, filling out, and submitting each registration type.
", "DescribeRegistrationFieldValues": "Retrieves the specified registration field values.
", "DescribeRegistrationSectionDefinitions": "Retrieves the specified registration section definitions. You can use DescribeRegistrationSectionDefinitions to view the requirements for creating, filling out, and submitting each registration type.
", "DescribeRegistrationTypeDefinitions": "Retrieves the specified registration type definitions. You can use DescribeRegistrationTypeDefinitions to view the requirements for creating, filling out, and submitting each registration type.
", "DescribeRegistrationVersions": "Retrieves the specified registration version.
", "DescribeRegistrations": "Retrieves the specified registrations.
", "DescribeSenderIds": "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 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.
", "DescribeSpendLimits": "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 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 in the Amazon Pinpoint User Guide.
", "DescribeVerifiedDestinationNumbers": "Retrieves the specified verified destiona numbers.
", "DisassociateOriginationIdentity": "Removes the specified origination identity from an existing pool.
If the origination identity isn't associated with the specified pool, an error is returned.
", "DiscardRegistrationVersion": "Discard the current version of the registration.
", "ListPoolOriginationIdentities": "Lists all associated origination identities in your pool.
If you specify filters, the output includes information for only those origination identities that meet the filter criteria.
", "ListRegistrationAssociations": "Retreive all of the origination identies that are associated with a registration.
", "ListTagsForResource": "List all tags associated with a resource.
", "PutKeyword": "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 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.
", "PutOptedOutNumber": "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.
", "PutRegistrationFieldValue": "Creates or updates a field value for a registration.
", "ReleasePhoneNumber": "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.
", "ReleaseSenderId": "Releases an existing sender ID in your account.
", "RequestPhoneNumber": "Request an origination phone number for use in your account. For more information on phone number request see Requesting a number in the Amazon Pinpoint User Guide.
", "RequestSenderId": "Request a new sender ID that doesn't require registration.
", "SendDestinationNumberVerificationCode": "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.
", "SendTextMessage": "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 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 Guide.
", "SendVoiceMessage": "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.
", "SetDefaultMessageType": "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 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 account.
", "SetDefaultSenderId": "Sets default sender ID on a configuration set.
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.
", "SetTextMessageSpendLimitOverride": "Sets an account level monthly spend limit override for sending text messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services.
Sets an account level monthly spend limit override for sending voice messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services.
Submit the specified registration for review and approval.
", "TagResource": "Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS Voice, version 2 resource. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.
", "UntagResource": "Removes the association of the specified tags from an Amazon Pinpoint SMS Voice V2 resource. For more information on tags see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.
", "UpdateEventDestination": "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 updating the destination resource ARN. You can't change an event destination's type between CloudWatch Logs, Kinesis Data Firehose, and Amazon SNS.
", "UpdatePhoneNumber": "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 returned.
", "UpdatePool": "Updates the configuration of an existing pool. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, enable or disable deletion protection, and enable or disable shared routes.
Updates the configuration of an existing sender ID.
", "VerifyDestinationNumber": "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.
" }, "shapes": { "AccessDeniedException": { "base": "The request was denied because you don't have sufficient permissions to access the resource.
", "refs": { } }, "AccessDeniedExceptionReason": { "base": null, "refs": { "AccessDeniedException$Reason": "The reason for the exception.
" } }, "AccountAttribute": { "base": "Displays the attributes associated with a single Amazon Web Services account.
", "refs": { "AccountAttributeList$member": null } }, "AccountAttributeList": { "base": null, "refs": { "DescribeAccountAttributesResult$AccountAttributes": "An array of AccountAttributes objects.
" } }, "AccountAttributeName": { "base": null, "refs": { "AccountAttribute$Name": "The name of the account attribute.
" } }, "AccountLimit": { "base": "The current resource quotas associated with an Amazon Web Services account.
", "refs": { "AccountLimitList$member": null } }, "AccountLimitList": { "base": null, "refs": { "DescribeAccountLimitsResult$AccountLimits": "An array of AccountLimit objects that show the current spend limits.
" } }, "AccountLimitName": { "base": null, "refs": { "AccountLimit$Name": "The name of the attribute to apply the account limit to.
" } }, "AmazonResourceName": { "base": null, "refs": { "ListTagsForResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) of the resource to query for.
", "ListTagsForResourceResult$ResourceArn": "The ARN of the resource.
", "TagResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) of the resource.
", "UntagResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) of the resource.
" } }, "AssociateOriginationIdentityRequest": { "base": null, "refs": { } }, "AssociateOriginationIdentityResult": { "base": null, "refs": { } }, "AttachmentBody": { "base": null, "refs": { "CreateRegistrationAttachmentRequest$AttachmentBody": "The registration file to upload. The maximum file size is 1MiB and valid file extensions are PDF, JPEG and PNG.
" } }, "AttachmentStatus": { "base": null, "refs": { "CreateRegistrationAttachmentResult$AttachmentStatus": "The status of the registration attachment.
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..
The status of the registration attachment.
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..
The status of the registration attachment.
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..
The error message if the upload failed.
", "RegistrationAttachmentsInformation$AttachmentUploadErrorReason": "A description of why the upload didn't successfully complete.
" } }, "AttachmentUrl": { "base": null, "refs": { "CreateRegistrationAttachmentRequest$AttachmentUrl": "A URL to the required registration file. For example, you can provide the S3 object URL.
" } }, "Boolean": { "base": null, "refs": { "CreatePoolRequest$DeletionProtectionEnabled": "By default this is set to false. When set to true the pool can't be deleted. You can change this value using the UpdatePool action.
", "EventDestination$Enabled": "When set to true events will be logged.
", "RequestPhoneNumberRequest$DeletionProtectionEnabled": "By default this is set to false. When set to true the phone number can't be deleted.
", "RequestSenderIdRequest$DeletionProtectionEnabled": "By default this is set to false. When set to true the sender ID can't be deleted.
", "UpdateEventDestinationRequest$Enabled": "When set to true logging is enabled.
", "UpdatePhoneNumberRequest$TwoWayEnabled": "By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
", "UpdatePhoneNumberRequest$SelfManagedOptOutsEnabled": "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.
", "UpdatePhoneNumberRequest$DeletionProtectionEnabled": "By default this is set to false. When set to true the phone number can't be deleted.
", "UpdatePoolRequest$TwoWayEnabled": "By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
", "UpdatePoolRequest$SelfManagedOptOutsEnabled": "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.
", "UpdatePoolRequest$SharedRoutesEnabled": "Indicates whether shared routes are enabled for the pool.
", "UpdatePoolRequest$DeletionProtectionEnabled": "When set to true the pool can't be deleted.
", "UpdateSenderIdRequest$DeletionProtectionEnabled": "By default this is set to false. When set to true the sender ID can't be deleted.
" } }, "ClientToken": { "base": null, "refs": { "AssociateOriginationIdentityRequest$ClientToken": "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.
", "CreateConfigurationSetRequest$ClientToken": "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.
", "CreateEventDestinationRequest$ClientToken": "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.
", "CreateOptOutListRequest$ClientToken": "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.
", "CreatePoolRequest$ClientToken": "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.
", "CreateRegistrationAttachmentRequest$ClientToken": "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.
", "CreateRegistrationRequest$ClientToken": "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.
", "CreateVerifiedDestinationNumberRequest$ClientToken": "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.
", "DisassociateOriginationIdentityRequest$ClientToken": "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.
", "RequestPhoneNumberRequest$ClientToken": "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.
", "RequestSenderIdRequest$ClientToken": "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.
" } }, "CloudWatchLogsDestination": { "base": "Contains the destination configuration to use when publishing message sending events.
", "refs": { "CreateEventDestinationRequest$CloudWatchLogsDestination": "An object that contains information about an event destination for logging to Amazon CloudWatch logs.
", "EventDestination$CloudWatchLogsDestination": "An object that contains information about an event destination that sends logging events to Amazon CloudWatch logs.
", "UpdateEventDestinationRequest$CloudWatchLogsDestination": "An object that contains information about an event destination that sends data to CloudWatch Logs.
" } }, "ConfigurationSetFilter": { "base": "The information for configuration sets that meet a specified criteria.
", "refs": { "ConfigurationSetFilterList$member": null } }, "ConfigurationSetFilterList": { "base": null, "refs": { "DescribeConfigurationSetsRequest$Filters": "An array of filters to apply to the results that are returned.
" } }, "ConfigurationSetFilterName": { "base": null, "refs": { "ConfigurationSetFilter$Name": "The name of the attribute to filter on.
" } }, "ConfigurationSetInformation": { "base": "Information related to a given configuration set in your Amazon Web Services account.
", "refs": { "ConfigurationSetInformationList$member": null } }, "ConfigurationSetInformationList": { "base": null, "refs": { "DescribeConfigurationSetsResult$ConfigurationSets": "An array of ConfigurationSets objects.
" } }, "ConfigurationSetName": { "base": null, "refs": { "ConfigurationSetInformation$ConfigurationSetName": "The name of the ConfigurationSet.
", "CreateConfigurationSetRequest$ConfigurationSetName": "The name to use for the new configuration set.
", "CreateConfigurationSetResult$ConfigurationSetName": "The name of the new configuration set.
", "CreateEventDestinationResult$ConfigurationSetName": "The name of the configuration set.
", "DeleteConfigurationSetResult$ConfigurationSetName": "The name of the deleted configuration set.
", "DeleteDefaultMessageTypeResult$ConfigurationSetName": "The name of the configuration set.
", "DeleteDefaultSenderIdResult$ConfigurationSetName": "The name of the configuration set.
", "DeleteEventDestinationResult$ConfigurationSetName": "The name of the configuration set the event destination was deleted from.
", "SetDefaultMessageTypeResult$ConfigurationSetName": "The name of the configuration set that was updated.
", "SetDefaultSenderIdResult$ConfigurationSetName": "The name of the configuration set that was updated.
", "UpdateEventDestinationResult$ConfigurationSetName": "The name of the configuration set.
" } }, "ConfigurationSetNameList": { "base": null, "refs": { "DescribeConfigurationSetsRequest$ConfigurationSetNames": "An array of strings. Each element can be either a ConfigurationSetName or ConfigurationSetArn.
" } }, "ConfigurationSetNameOrArn": { "base": null, "refs": { "ConfigurationSetNameList$member": null, "CreateEventDestinationRequest$ConfigurationSetName": "Either the name of the configuration set or the configuration set ARN to apply event logging to. The ConfigurateSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
", "DeleteConfigurationSetRequest$ConfigurationSetName": "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.
", "DeleteDefaultMessageTypeRequest$ConfigurationSetName": "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.
", "DeleteDefaultSenderIdRequest$ConfigurationSetName": "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.
", "DeleteEventDestinationRequest$ConfigurationSetName": "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.
", "SendDestinationNumberVerificationCodeRequest$ConfigurationSetName": "The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
", "SendTextMessageRequest$ConfigurationSetName": "The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
", "SendVoiceMessageRequest$ConfigurationSetName": "The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
", "SetDefaultMessageTypeRequest$ConfigurationSetName": "The configuration set to update with a new default message type. This field can be the ConsigurationSetName or ConfigurationSetArn.
", "SetDefaultSenderIdRequest$ConfigurationSetName": "The configuration set to updated with a new default SenderId. This field can be the ConsigurationSetName or ConfigurationSetArn.
", "UpdateEventDestinationRequest$ConfigurationSetName": "The configuration set to update with the new event destination. Valid values for this can be the ConfigurationSetName or ConfigurationSetArn.
" } }, "ConflictException": { "base": "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.
", "refs": { } }, "ConflictExceptionReason": { "base": null, "refs": { "ConflictException$Reason": "The reason for the exception.
" } }, "ContextKey": { "base": null, "refs": { "ContextMap$key": null } }, "ContextMap": { "base": null, "refs": { "SendDestinationNumberVerificationCodeRequest$Context": "You can specify custom data in this field. If you do, that data is logged to the event destination.
", "SendTextMessageRequest$Context": "You can specify custom data in this field. If you do, that data is logged to the event destination.
", "SendVoiceMessageRequest$Context": "You can specify custom data in this field. If you do, that data is logged to the event destination.
" } }, "ContextValue": { "base": null, "refs": { "ContextMap$value": null } }, "CreateConfigurationSetRequest": { "base": null, "refs": { } }, "CreateConfigurationSetResult": { "base": null, "refs": { } }, "CreateEventDestinationRequest": { "base": null, "refs": { } }, "CreateEventDestinationResult": { "base": null, "refs": { } }, "CreateOptOutListRequest": { "base": null, "refs": { } }, "CreateOptOutListResult": { "base": null, "refs": { } }, "CreatePoolRequest": { "base": null, "refs": { } }, "CreatePoolResult": { "base": null, "refs": { } }, "CreateRegistrationAssociationRequest": { "base": null, "refs": { } }, "CreateRegistrationAssociationResult": { "base": null, "refs": { } }, "CreateRegistrationAttachmentRequest": { "base": null, "refs": { } }, "CreateRegistrationAttachmentResult": { "base": null, "refs": { } }, "CreateRegistrationRequest": { "base": null, "refs": { } }, "CreateRegistrationResult": { "base": null, "refs": { } }, "CreateRegistrationVersionRequest": { "base": null, "refs": { } }, "CreateRegistrationVersionResult": { "base": null, "refs": { } }, "CreateVerifiedDestinationNumberRequest": { "base": null, "refs": { } }, "CreateVerifiedDestinationNumberResult": { "base": null, "refs": { } }, "DeleteConfigurationSetRequest": { "base": null, "refs": { } }, "DeleteConfigurationSetResult": { "base": null, "refs": { } }, "DeleteDefaultMessageTypeRequest": { "base": null, "refs": { } }, "DeleteDefaultMessageTypeResult": { "base": null, "refs": { } }, "DeleteDefaultSenderIdRequest": { "base": null, "refs": { } }, "DeleteDefaultSenderIdResult": { "base": null, "refs": { } }, "DeleteEventDestinationRequest": { "base": null, "refs": { } }, "DeleteEventDestinationResult": { "base": null, "refs": { } }, "DeleteKeywordRequest": { "base": null, "refs": { } }, "DeleteKeywordResult": { "base": null, "refs": { } }, "DeleteOptOutListRequest": { "base": null, "refs": { } }, "DeleteOptOutListResult": { "base": null, "refs": { } }, "DeleteOptedOutNumberRequest": { "base": null, "refs": { } }, "DeleteOptedOutNumberResult": { "base": null, "refs": { } }, "DeletePoolRequest": { "base": null, "refs": { } }, "DeletePoolResult": { "base": null, "refs": { } }, "DeleteRegistrationAttachmentRequest": { "base": null, "refs": { } }, "DeleteRegistrationAttachmentResult": { "base": null, "refs": { } }, "DeleteRegistrationFieldValueRequest": { "base": null, "refs": { } }, "DeleteRegistrationFieldValueResult": { "base": null, "refs": { } }, "DeleteRegistrationRequest": { "base": null, "refs": { } }, "DeleteRegistrationResult": { "base": null, "refs": { } }, "DeleteTextMessageSpendLimitOverrideRequest": { "base": null, "refs": { } }, "DeleteTextMessageSpendLimitOverrideResult": { "base": null, "refs": { } }, "DeleteVerifiedDestinationNumberRequest": { "base": null, "refs": { } }, "DeleteVerifiedDestinationNumberResult": { "base": null, "refs": { } }, "DeleteVoiceMessageSpendLimitOverrideRequest": { "base": null, "refs": { } }, "DeleteVoiceMessageSpendLimitOverrideResult": { "base": null, "refs": { } }, "DeliveryStreamArn": { "base": null, "refs": { "KinesisFirehoseDestination$DeliveryStreamArn": "The Amazon Resource Name (ARN) of the delivery stream.
" } }, "DescribeAccountAttributesRequest": { "base": null, "refs": { } }, "DescribeAccountAttributesResult": { "base": null, "refs": { } }, "DescribeAccountLimitsRequest": { "base": null, "refs": { } }, "DescribeAccountLimitsResult": { "base": null, "refs": { } }, "DescribeConfigurationSetsRequest": { "base": null, "refs": { } }, "DescribeConfigurationSetsResult": { "base": null, "refs": { } }, "DescribeKeywordsRequest": { "base": null, "refs": { } }, "DescribeKeywordsResult": { "base": null, "refs": { } }, "DescribeOptOutListsRequest": { "base": null, "refs": { } }, "DescribeOptOutListsResult": { "base": null, "refs": { } }, "DescribeOptedOutNumbersRequest": { "base": null, "refs": { } }, "DescribeOptedOutNumbersResult": { "base": null, "refs": { } }, "DescribePhoneNumbersRequest": { "base": null, "refs": { } }, "DescribePhoneNumbersResult": { "base": null, "refs": { } }, "DescribePoolsRequest": { "base": null, "refs": { } }, "DescribePoolsResult": { "base": null, "refs": { } }, "DescribeRegistrationAttachmentsRequest": { "base": null, "refs": { } }, "DescribeRegistrationAttachmentsResult": { "base": null, "refs": { } }, "DescribeRegistrationFieldDefinitionsRequest": { "base": null, "refs": { } }, "DescribeRegistrationFieldDefinitionsResult": { "base": null, "refs": { } }, "DescribeRegistrationFieldValuesRequest": { "base": null, "refs": { } }, "DescribeRegistrationFieldValuesResult": { "base": null, "refs": { } }, "DescribeRegistrationSectionDefinitionsRequest": { "base": null, "refs": { } }, "DescribeRegistrationSectionDefinitionsResult": { "base": null, "refs": { } }, "DescribeRegistrationTypeDefinitionsRequest": { "base": null, "refs": { } }, "DescribeRegistrationTypeDefinitionsResult": { "base": null, "refs": { } }, "DescribeRegistrationVersionsRequest": { "base": null, "refs": { } }, "DescribeRegistrationVersionsResult": { "base": null, "refs": { } }, "DescribeRegistrationsRequest": { "base": null, "refs": { } }, "DescribeRegistrationsResult": { "base": null, "refs": { } }, "DescribeSenderIdsRequest": { "base": null, "refs": { } }, "DescribeSenderIdsResult": { "base": null, "refs": { } }, "DescribeSpendLimitsRequest": { "base": null, "refs": { } }, "DescribeSpendLimitsResult": { "base": null, "refs": { } }, "DescribeVerifiedDestinationNumbersRequest": { "base": null, "refs": { } }, "DescribeVerifiedDestinationNumbersResult": { "base": null, "refs": { } }, "DestinationCountryParameterKey": { "base": null, "refs": { "DestinationCountryParameters$key": null } }, "DestinationCountryParameterValue": { "base": null, "refs": { "DestinationCountryParameters$value": null } }, "DestinationCountryParameters": { "base": null, "refs": { "SendDestinationNumberVerificationCodeRequest$DestinationCountryParameters": "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.
", "SendTextMessageRequest$DestinationCountryParameters": "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.
" } }, "DestinationPhoneNumberList": { "base": null, "refs": { "DescribeVerifiedDestinationNumbersRequest$DestinationPhoneNumbers": "An array of verified destination phone number, in E.164 format.
" } }, "DisassociateOriginationIdentityRequest": { "base": null, "refs": { } }, "DisassociateOriginationIdentityResult": { "base": null, "refs": { } }, "DiscardRegistrationVersionRequest": { "base": null, "refs": { } }, "DiscardRegistrationVersionResult": { "base": null, "refs": { } }, "EventDestination": { "base": "Contains information about an event destination.
Event destinations are associated with configuration sets, which enable you to publish message sending events to CloudWatch, Kinesis Data Firehose,or Amazon SNS.
", "refs": { "CreateEventDestinationResult$EventDestination": "The details of the destination where events are logged.
", "DeleteEventDestinationResult$EventDestination": "The event destination object that was deleted.
", "EventDestinationList$member": null, "UpdateEventDestinationResult$EventDestination": "An EventDestination object containing the details of where events will be logged.
" } }, "EventDestinationList": { "base": null, "refs": { "ConfigurationSetInformation$EventDestinations": "An array of EventDestination objects that describe any events to log and where to log them.
", "DeleteConfigurationSetResult$EventDestinations": "An array of any EventDestination objects that were associated with the deleted configuration set.
" } }, "EventDestinationName": { "base": null, "refs": { "CreateEventDestinationRequest$EventDestinationName": "The name that identifies the event destination.
", "DeleteEventDestinationRequest$EventDestinationName": "The name of the event destination to delete.
", "EventDestination$EventDestinationName": "The name of the EventDestination.
", "UpdateEventDestinationRequest$EventDestinationName": "The name to use for the event destination.
" } }, "EventType": { "base": null, "refs": { "EventTypeList$member": null } }, "EventTypeList": { "base": null, "refs": { "CreateEventDestinationRequest$MatchingEventTypes": "An array of event types that determine which events to log. If \"ALL\" is used, then Amazon Pinpoint logs every event type.
The TEXT_SENT event type is not supported.
An array of event types that determine which events to log.
The TEXT_SENT event type is not supported.
An array of event types that determine which events to log.
The TEXT_SENT event type is not supported.
The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
", "DeleteRegistrationFieldValueResult$FieldPath": "The path to the registration form field.
", "FieldPathList$member": null, "PutRegistrationFieldValueRequest$FieldPath": "The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
", "PutRegistrationFieldValueResult$FieldPath": "The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
", "RegistrationFieldDefinition$FieldPath": "The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
", "RegistrationFieldValueInformation$FieldPath": "The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
" } }, "FieldPathList": { "base": null, "refs": { "DescribeRegistrationFieldDefinitionsRequest$FieldPaths": "An array of paths to the registration form field.
", "DescribeRegistrationFieldValuesRequest$FieldPaths": "An array of paths to the registration form field.
" } }, "FieldRequirement": { "base": null, "refs": { "RegistrationFieldDefinition$FieldRequirement": "Specifies if the field for the registration form is required, conditional or optional.
" } }, "FieldType": { "base": null, "refs": { "RegistrationFieldDefinition$FieldType": "The type of field.
" } }, "FilterValue": { "base": null, "refs": { "FilterValueList$member": null } }, "FilterValueList": { "base": null, "refs": { "ConfigurationSetFilter$Values": "An array values to filter for.
", "KeywordFilter$Values": "An array values to filter for.
", "OptedOutFilter$Values": "An array of values to filter for.
", "PhoneNumberFilter$Values": "An array values to filter for.
", "PoolFilter$Values": "An array values to filter for.
", "PoolOriginationIdentitiesFilter$Values": "An array values to filter for.
", "RegistrationAssociationFilter$Values": "An array of values to filter for.
", "RegistrationAttachmentFilter$Values": "An array of values to filter on.
", "RegistrationFilter$Values": "An array of values to filter on.
", "RegistrationTypeFilter$Values": "An array of values to filter on.
", "RegistrationVersionFilter$Values": "An array of values to filter on.
", "SenderIdFilter$Values": "An array of values to filter for.
", "VerifiedDestinationNumberFilter$Values": "An array of values to filter on.
" } }, "IamRoleArn": { "base": null, "refs": { "CloudWatchLogsDestination$IamRoleArn": "The Amazon Resource Name (ARN) of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon CloudWatch destination.
", "CreatePoolResult$TwoWayChannelRole": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
", "DeletePoolResult$TwoWayChannelRole": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
", "KinesisFirehoseDestination$IamRoleArn": "The ARN of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon Firehose destination.
", "PhoneNumberInformation$TwoWayChannelRole": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
", "PoolInformation$TwoWayChannelRole": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
", "ReleasePhoneNumberResult$TwoWayChannelRole": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
", "RequestPhoneNumberResult$TwoWayChannelRole": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
", "UpdatePhoneNumberRequest$TwoWayChannelRole": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
", "UpdatePhoneNumberResult$TwoWayChannelRole": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
", "UpdatePoolRequest$TwoWayChannelRole": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
", "UpdatePoolResult$TwoWayChannelRole": "An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
" } }, "Integer": { "base": null, "refs": { "SelectValidation$MinChoices": "The minimum number of choices for the select.
", "SelectValidation$MaxChoices": "The maximum number of choices for the select.
", "TextValidation$MinLength": "The minimum number of characters for the text field.
", "TextValidation$MaxLength": "The maximum number of characters for the text field.
" } }, "InternalServerException": { "base": "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.
", "refs": { } }, "IsoCountryCode": { "base": null, "refs": { "AssociateOriginationIdentityRequest$IsoCountryCode": "The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the origination identity.
", "AssociateOriginationIdentityResult$IsoCountryCode": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
", "CreatePoolRequest$IsoCountryCode": "The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the new pool.
", "CreateRegistrationAssociationResult$IsoCountryCode": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
", "DisassociateOriginationIdentityRequest$IsoCountryCode": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
", "DisassociateOriginationIdentityResult$IsoCountryCode": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
", "OriginationIdentityMetadata$IsoCountryCode": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
", "PhoneNumberInformation$IsoCountryCode": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
", "RegistrationAssociationMetadata$IsoCountryCode": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
", "ReleasePhoneNumberResult$IsoCountryCode": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
", "ReleaseSenderIdRequest$IsoCountryCode": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
", "ReleaseSenderIdResult$IsoCountryCode": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
", "RequestPhoneNumberRequest$IsoCountryCode": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
", "RequestPhoneNumberResult$IsoCountryCode": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
", "RequestSenderIdRequest$IsoCountryCode": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
", "RequestSenderIdResult$IsoCountryCode": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
", "SenderIdAndCountry$IsoCountryCode": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
", "SenderIdInformation$IsoCountryCode": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
", "SupportedAssociation$IsoCountryCode": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
", "UpdatePhoneNumberResult$IsoCountryCode": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
", "UpdateSenderIdRequest$IsoCountryCode": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
", "UpdateSenderIdResult$IsoCountryCode": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" } }, "Keyword": { "base": null, "refs": { "DeleteKeywordRequest$Keyword": "The keyword to delete.
", "DeleteKeywordResult$Keyword": "The keyword that was deleted.
", "KeywordInformation$Keyword": "The keyword as a string.
", "KeywordList$member": null, "PutKeywordRequest$Keyword": "The new keyword to add.
", "PutKeywordResult$Keyword": "The keyword that was added.
", "SendTextMessageRequest$Keyword": "When you register a short code in the US, you must specify a program name. If you don’t have a US short code, omit this attribute.
" } }, "KeywordAction": { "base": null, "refs": { "DeleteKeywordResult$KeywordAction": "The action that was associated with the deleted keyword.
", "KeywordInformation$KeywordAction": "The action to perform for the keyword.
", "PutKeywordRequest$KeywordAction": "The action to perform for the new keyword when it is received.
AUTOMATIC_RESPONSE: A message is sent to the recipient.
OPT_OUT: Keeps the recipient from receiving future messages.
OPT_IN: The recipient wants to receive future messages.
The action to perform when the keyword is used.
" } }, "KeywordFilter": { "base": "The information for keywords that meet a specified criteria.
", "refs": { "KeywordFilterList$member": null } }, "KeywordFilterList": { "base": null, "refs": { "DescribeKeywordsRequest$Filters": "An array of keyword filters to filter the results.
" } }, "KeywordFilterName": { "base": null, "refs": { "KeywordFilter$Name": "The name of the attribute to filter on.
" } }, "KeywordInformation": { "base": "The information for all keywords in a pool.
", "refs": { "KeywordInformationList$member": null } }, "KeywordInformationList": { "base": null, "refs": { "DescribeKeywordsResult$Keywords": "An array of KeywordInformation objects that contain the results.
" } }, "KeywordList": { "base": null, "refs": { "DescribeKeywordsRequest$Keywords": "An array of keywords to search for.
" } }, "KeywordMessage": { "base": null, "refs": { "DeleteKeywordResult$KeywordMessage": "The message that was associated with the deleted keyword.
", "KeywordInformation$KeywordMessage": "A custom message that can be used with the keyword.
", "PutKeywordRequest$KeywordMessage": "The message associated with the keyword.
", "PutKeywordResult$KeywordMessage": "The message associated with the keyword.
" } }, "KinesisFirehoseDestination": { "base": "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 sets, which enable you to publish message sending events.
", "refs": { "CreateEventDestinationRequest$KinesisFirehoseDestination": "An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.
", "EventDestination$KinesisFirehoseDestination": "An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.
", "UpdateEventDestinationRequest$KinesisFirehoseDestination": "An object that contains information about an event destination for logging to Kinesis Data Firehose.
" } }, "LanguageCode": { "base": null, "refs": { "SendDestinationNumberVerificationCodeRequest$LanguageCode": "Choose the language to use for the message.
" } }, "ListPoolOriginationIdentitiesRequest": { "base": null, "refs": { } }, "ListPoolOriginationIdentitiesResult": { "base": null, "refs": { } }, "ListRegistrationAssociationsRequest": { "base": null, "refs": { } }, "ListRegistrationAssociationsResult": { "base": null, "refs": { } }, "ListTagsForResourceRequest": { "base": null, "refs": { } }, "ListTagsForResourceResult": { "base": null, "refs": { } }, "LogGroupArn": { "base": null, "refs": { "CloudWatchLogsDestination$LogGroupArn": "The name of the Amazon CloudWatch log group that you want to record events in.
" } }, "MaxPrice": { "base": null, "refs": { "SendTextMessageRequest$MaxPrice": "The maximum amount that you want to spend, in US dollars, per each text message part. A text message can contain multiple parts.
", "SendVoiceMessageRequest$MaxPricePerMinute": "The maximum amount to spend per voice message, in US dollars.
" } }, "MaxResults": { "base": null, "refs": { "DescribeAccountAttributesRequest$MaxResults": "The maximum number of results to return per each request.
", "DescribeAccountLimitsRequest$MaxResults": "The maximum number of results to return per each request.
", "DescribeConfigurationSetsRequest$MaxResults": "The maximum number of results to return per each request.
", "DescribeKeywordsRequest$MaxResults": "The maximum number of results to return per each request.
", "DescribeOptOutListsRequest$MaxResults": "The maximum number of results to return per each request.
", "DescribeOptedOutNumbersRequest$MaxResults": "The maximum number of results to return per each request.
", "DescribePhoneNumbersRequest$MaxResults": "The maximum number of results to return per each request.
", "DescribePoolsRequest$MaxResults": "The maximum number of results to return per each request.
", "DescribeRegistrationAttachmentsRequest$MaxResults": "The maximum number of results to return per each request.
", "DescribeRegistrationFieldDefinitionsRequest$MaxResults": "The maximum number of results to return per each request.
", "DescribeRegistrationFieldValuesRequest$MaxResults": "The maximum number of results to return per each request.
", "DescribeRegistrationSectionDefinitionsRequest$MaxResults": "The maximum number of results to return per each request.
", "DescribeRegistrationTypeDefinitionsRequest$MaxResults": "The maximum number of results to return per each request.
", "DescribeRegistrationVersionsRequest$MaxResults": "The maximum number of results to return per each request.
", "DescribeRegistrationsRequest$MaxResults": "The maximum number of results to return per each request.
", "DescribeSenderIdsRequest$MaxResults": "The maximum number of results to return per each request.
", "DescribeSpendLimitsRequest$MaxResults": "The maximum number of results to return per each request.
", "DescribeVerifiedDestinationNumbersRequest$MaxResults": "The maximum number of results to return per each request.
", "ListPoolOriginationIdentitiesRequest$MaxResults": "The maximum number of results to return per each request.
", "ListRegistrationAssociationsRequest$MaxResults": "The maximum number of results to return per each request.
" } }, "MessageType": { "base": null, "refs": { "ConfigurationSetInformation$DefaultMessageType": "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.
", "CreatePoolRequest$MessageType": "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.
", "CreatePoolResult$MessageType": "The type of message for the pool to use.
", "DeleteConfigurationSetResult$DefaultMessageType": "The default message type of the configuration set that was deleted.
", "DeleteDefaultMessageTypeResult$MessageType": "The current message type for the configuration set.
", "DeletePoolResult$MessageType": "The message type that was associated with the deleted pool.
", "MessageTypeList$member": null, "PhoneNumberInformation$MessageType": "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.
", "PoolInformation$MessageType": "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.
", "ReleasePhoneNumberResult$MessageType": "The message type that was associated with the phone number.
", "RequestPhoneNumberRequest$MessageType": "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.
", "RequestPhoneNumberResult$MessageType": "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.
", "SendTextMessageRequest$MessageType": "The type of message. Valid values are for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
", "SetDefaultMessageTypeRequest$MessageType": "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.
", "SetDefaultMessageTypeResult$MessageType": "The new default message type of the configuration set.
", "UpdatePhoneNumberResult$MessageType": "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.
", "UpdatePoolResult$MessageType": "The type of message for the pool to use.
" } }, "MessageTypeList": { "base": null, "refs": { "ReleaseSenderIdResult$MessageTypes": "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.
", "RequestSenderIdRequest$MessageTypes": "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.
", "RequestSenderIdResult$MessageTypes": "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.
", "SenderIdInformation$MessageTypes": "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.
", "UpdateSenderIdResult$MessageTypes": "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.
" } }, "MonthlyLimit": { "base": null, "refs": { "DeleteTextMessageSpendLimitOverrideResult$MonthlyLimit": "The current monthly limit, in US dollars.
", "DeleteVoiceMessageSpendLimitOverrideResult$MonthlyLimit": "The current monthly limit, in US dollars.
", "SetTextMessageSpendLimitOverrideRequest$MonthlyLimit": "The new monthly limit to enforce on text messages.
", "SetTextMessageSpendLimitOverrideResult$MonthlyLimit": "The current monthly limit to enforce on sending text messages.
", "SetVoiceMessageSpendLimitOverrideRequest$MonthlyLimit": "The new monthly limit to enforce on voice messages.
", "SetVoiceMessageSpendLimitOverrideResult$MonthlyLimit": "The current monthly limit to enforce on sending voice messages.
" } }, "NextToken": { "base": null, "refs": { "DescribeAccountAttributesRequest$NextToken": "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.
", "DescribeAccountAttributesResult$NextToken": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
", "DescribeAccountLimitsRequest$NextToken": "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.
", "DescribeAccountLimitsResult$NextToken": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
", "DescribeConfigurationSetsRequest$NextToken": "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.
", "DescribeConfigurationSetsResult$NextToken": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
", "DescribeKeywordsRequest$NextToken": "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.
", "DescribeKeywordsResult$NextToken": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
", "DescribeOptOutListsRequest$NextToken": "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.
", "DescribeOptOutListsResult$NextToken": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
", "DescribeOptedOutNumbersRequest$NextToken": "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.
", "DescribeOptedOutNumbersResult$NextToken": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
", "DescribePhoneNumbersRequest$NextToken": "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.
", "DescribePhoneNumbersResult$NextToken": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
", "DescribePoolsRequest$NextToken": "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.
", "DescribePoolsResult$NextToken": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
", "DescribeRegistrationAttachmentsRequest$NextToken": "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.
", "DescribeRegistrationAttachmentsResult$NextToken": "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.
", "DescribeRegistrationFieldDefinitionsRequest$NextToken": "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.
", "DescribeRegistrationFieldDefinitionsResult$NextToken": "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.
", "DescribeRegistrationFieldValuesRequest$NextToken": "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.
", "DescribeRegistrationFieldValuesResult$NextToken": "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.
", "DescribeRegistrationSectionDefinitionsRequest$NextToken": "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.
", "DescribeRegistrationSectionDefinitionsResult$NextToken": "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.
", "DescribeRegistrationTypeDefinitionsRequest$NextToken": "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.
", "DescribeRegistrationTypeDefinitionsResult$NextToken": "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.
", "DescribeRegistrationVersionsRequest$NextToken": "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.
", "DescribeRegistrationVersionsResult$NextToken": "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.
", "DescribeRegistrationsRequest$NextToken": "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.
", "DescribeRegistrationsResult$NextToken": "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.
", "DescribeSenderIdsRequest$NextToken": "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.
", "DescribeSenderIdsResult$NextToken": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
", "DescribeSpendLimitsRequest$NextToken": "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.
", "DescribeSpendLimitsResult$NextToken": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
", "DescribeVerifiedDestinationNumbersRequest$NextToken": "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.
", "DescribeVerifiedDestinationNumbersResult$NextToken": "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.
", "ListPoolOriginationIdentitiesRequest$NextToken": "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.
", "ListPoolOriginationIdentitiesResult$NextToken": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
", "ListRegistrationAssociationsRequest$NextToken": "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.
", "ListRegistrationAssociationsResult$NextToken": "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.
" } }, "NonEmptyTagList": { "base": null, "refs": { "TagResourceRequest$Tags": "An array of key and value pair tags that are associated with the resource.
" } }, "NumberCapability": { "base": null, "refs": { "NumberCapabilityList$member": null } }, "NumberCapabilityList": { "base": null, "refs": { "OriginationIdentityMetadata$NumberCapabilities": "Describes if the origination identity can be used for text messages, voice calls or both.
", "PhoneNumberInformation$NumberCapabilities": "Describes if the origination identity can be used for text messages, voice calls or both.
", "ReleasePhoneNumberResult$NumberCapabilities": "Specifies if the number could be used for text messages, voice, or both.
", "RequestPhoneNumberRequest$NumberCapabilities": "Indicates if the phone number will be used for text messages, voice messages, or both.
", "RequestPhoneNumberResult$NumberCapabilities": "Indicates if the phone number will be used for text messages, voice messages or both.
", "UpdatePhoneNumberResult$NumberCapabilities": "Specifies if the number could be used for text messages, voice or both.
" } }, "NumberStatus": { "base": null, "refs": { "PhoneNumberInformation$Status": "The current status of the phone number.
", "ReleasePhoneNumberResult$Status": "The current status of the request.
", "RequestPhoneNumberResult$Status": "The current status of the request.
", "UpdatePhoneNumberResult$Status": "The current status of the request.
" } }, "NumberType": { "base": null, "refs": { "PhoneNumberInformation$NumberType": "The type of phone number.
", "ReleasePhoneNumberResult$NumberType": "The type of number that was released.
", "UpdatePhoneNumberResult$NumberType": "The type of number that was requested.
" } }, "OptOutListInformation": { "base": "The information for all OptOutList in an Amazon Web Services account.
", "refs": { "OptOutListInformationList$member": null } }, "OptOutListInformationList": { "base": null, "refs": { "DescribeOptOutListsResult$OptOutLists": "An array of OptOutListInformation objects that contain the details for the requested OptOutLists.
" } }, "OptOutListName": { "base": null, "refs": { "CreateOptOutListRequest$OptOutListName": "The name of the new OptOutList.
", "CreateOptOutListResult$OptOutListName": "The name of the new OptOutList.
", "CreatePoolResult$OptOutListName": "The name of the OptOutList associated with the pool.
", "DeleteOptOutListResult$OptOutListName": "The name of the OptOutList that was removed.
", "DeleteOptedOutNumberResult$OptOutListName": "The OptOutListName that the phone number was removed from.
", "DeletePoolResult$OptOutListName": "The name of the OptOutList that was associated with the deleted pool.
", "DescribeOptedOutNumbersResult$OptOutListName": "The name of the OptOutList.
", "OptOutListInformation$OptOutListName": "The name of the OptOutList.
", "PhoneNumberInformation$OptOutListName": "The name of the OptOutList associated with the phone number.
", "PoolInformation$OptOutListName": "The name of the OptOutList associated with the pool.
", "PutOptedOutNumberResult$OptOutListName": "The OptOutListName that the phone number was removed from.
", "ReleasePhoneNumberResult$OptOutListName": "The name of the OptOutList that was associated with the phone number.
", "RequestPhoneNumberResult$OptOutListName": "The name of the OptOutList that is associated with the requested phone number.
", "UpdatePhoneNumberResult$OptOutListName": "The name of the OptOutList associated with the phone number.
", "UpdatePoolResult$OptOutListName": "The name of the OptOutList associated with the pool.
" } }, "OptOutListNameList": { "base": null, "refs": { "DescribeOptOutListsRequest$OptOutListNames": "The OptOutLists to show the details of. This is an array of strings that can be either the OptOutListName or OptOutListArn.
" } }, "OptOutListNameOrArn": { "base": null, "refs": { "DeleteOptOutListRequest$OptOutListName": "The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.
", "DeleteOptedOutNumberRequest$OptOutListName": "The OptOutListName or OptOutListArn to remove the phone number from.
", "DescribeOptedOutNumbersRequest$OptOutListName": "The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.
", "OptOutListNameList$member": null, "PutOptedOutNumberRequest$OptOutListName": "The OptOutListName or OptOutListArn to add the phone number to.
", "RequestPhoneNumberRequest$OptOutListName": "The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.
", "UpdatePhoneNumberRequest$OptOutListName": "The OptOutList to add the phone number to. Valid values for this field can be either the OutOutListName or OutOutListArn.
", "UpdatePoolRequest$OptOutListName": "The OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn.
" } }, "OptedOutFilter": { "base": "The information for opted out numbers that meet a specified criteria.
", "refs": { "OptedOutFilterList$member": null } }, "OptedOutFilterList": { "base": null, "refs": { "DescribeOptedOutNumbersRequest$Filters": "An array of OptedOutFilter objects to filter the results on.
" } }, "OptedOutFilterName": { "base": null, "refs": { "OptedOutFilter$Name": "The name of the attribute to filter on.
" } }, "OptedOutNumberInformation": { "base": "The information for an opted out number in an Amazon Web Services account.
", "refs": { "OptedOutNumberInformationList$member": null } }, "OptedOutNumberInformationList": { "base": null, "refs": { "DescribeOptedOutNumbersResult$OptedOutNumbers": "An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers.
" } }, "OptedOutNumberList": { "base": null, "refs": { "DescribeOptedOutNumbersRequest$OptedOutNumbers": "An array of phone numbers to search for in the OptOutList.
" } }, "OriginationIdentityMetadata": { "base": "The metadata for an origination identity associated with a pool.
", "refs": { "OriginationIdentityMetadataList$member": null } }, "OriginationIdentityMetadataList": { "base": null, "refs": { "ListPoolOriginationIdentitiesResult$OriginationIdentities": "An array of any OriginationIdentityMetadata objects.
" } }, "PhoneNumber": { "base": null, "refs": { "CreateRegistrationAssociationResult$PhoneNumber": "The phone number associated with the registration in E.164 format.
", "CreateVerifiedDestinationNumberRequest$DestinationPhoneNumber": "The verified destination phone number, in E.164 format.
", "CreateVerifiedDestinationNumberResult$DestinationPhoneNumber": "The verified destination phone number, in E.164 format.
", "DeleteOptedOutNumberRequest$OptedOutNumber": "The phone number, in E.164 format, to remove from the OptOutList.
", "DeleteOptedOutNumberResult$OptedOutNumber": "The phone number that was removed from the OptOutList.
", "DeleteVerifiedDestinationNumberResult$DestinationPhoneNumber": "The verified destination phone number, in E.164 format.
", "DestinationPhoneNumberList$member": null, "OptedOutNumberInformation$OptedOutNumber": "The phone number that is opted out.
", "OptedOutNumberList$member": null, "OriginationIdentityMetadata$PhoneNumber": "The phone number in E.164 format.
", "PhoneNumberInformation$PhoneNumber": "The phone number in E.164 format.
", "PutOptedOutNumberRequest$OptedOutNumber": "The phone number to add to the OptOutList in E.164 format.
", "PutOptedOutNumberResult$OptedOutNumber": "The phone number that was added to the OptOutList.
", "RegistrationAssociationMetadata$PhoneNumber": "The phone number associated with the registration in E.164 format.
", "ReleasePhoneNumberResult$PhoneNumber": "The phone number that was released.
", "RequestPhoneNumberResult$PhoneNumber": "The new phone number that was requested.
", "SendTextMessageRequest$DestinationPhoneNumber": "The destination phone number in E.164 format.
", "SendVoiceMessageRequest$DestinationPhoneNumber": "The destination phone number in E.164 format.
", "UpdatePhoneNumberResult$PhoneNumber": "The phone number that was updated.
", "VerifiedDestinationNumberInformation$DestinationPhoneNumber": "The verified destination phone number, in E.164 format.
", "VerifyDestinationNumberResult$DestinationPhoneNumber": "The phone number in E.164 format.
" } }, "PhoneNumberFilter": { "base": "The information for a phone number that meets a specified criteria.
", "refs": { "PhoneNumberFilterList$member": null } }, "PhoneNumberFilterList": { "base": null, "refs": { "DescribePhoneNumbersRequest$Filters": "An array of PhoneNumberFilter objects to filter the results.
" } }, "PhoneNumberFilterName": { "base": null, "refs": { "PhoneNumberFilter$Name": "The name of the attribute to filter on.
" } }, "PhoneNumberIdList": { "base": null, "refs": { "DescribePhoneNumbersRequest$PhoneNumberIds": "The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.
" } }, "PhoneNumberIdOrArn": { "base": null, "refs": { "PhoneNumberIdList$member": null, "ReleasePhoneNumberRequest$PhoneNumberId": "The PhoneNumberId or PhoneNumberArn of the phone number to release. You can use DescribePhoneNumbers to get the values for PhoneNumberId and PhoneNumberArn.
", "UpdatePhoneNumberRequest$PhoneNumberId": "The unique identifier of the phone number. Valid values for this field can be either the PhoneNumberId or PhoneNumberArn.
" } }, "PhoneNumberInformation": { "base": "The information for a phone number, in E.164 format, in an Amazon Web Services account.
", "refs": { "PhoneNumberInformationList$member": null } }, "PhoneNumberInformationList": { "base": null, "refs": { "DescribePhoneNumbersResult$PhoneNumbers": "An array of PhoneNumberInformation objects that contain the details for the requested phone numbers.
" } }, "PhoneOrPoolIdOrArn": { "base": null, "refs": { "DeleteKeywordRequest$OriginationIdentity": "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.
", "DescribeKeywordsRequest$OriginationIdentity": "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.
", "PutKeywordRequest$OriginationIdentity": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers get the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
" } }, "PhoneOrSenderIdOrArn": { "base": null, "refs": { "AssociateOriginationIdentityRequest$OriginationIdentity": "The origination identity to use, such as 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.
", "CreatePoolRequest$OriginationIdentity": "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.
", "DisassociateOriginationIdentityRequest$OriginationIdentity": "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.
" } }, "PoolFilter": { "base": "The information for a pool that meets a specified criteria.
", "refs": { "PoolFilterList$member": null } }, "PoolFilterList": { "base": null, "refs": { "DescribePoolsRequest$Filters": "An array of PoolFilter objects to filter the results.
" } }, "PoolFilterName": { "base": null, "refs": { "PoolFilter$Name": "The name of the attribute to filter on.
" } }, "PoolIdList": { "base": null, "refs": { "DescribePoolsRequest$PoolIds": "The unique identifier of pools to find. This is an array of strings that can be either the PoolId or PoolArn.
" } }, "PoolIdOrArn": { "base": null, "refs": { "AssociateOriginationIdentityRequest$PoolId": "The pool to update with the new Identity. This value can be either the PoolId or PoolArn, and you can find these values using DescribePools.
", "DeletePoolRequest$PoolId": "The PoolId or PoolArn of the pool to delete. You can use DescribePools to find the values for PoolId and PoolArn .
", "DisassociateOriginationIdentityRequest$PoolId": "The unique identifier for the pool to disassociate with the origination identity. This value can be either the PoolId or PoolArn.
", "ListPoolOriginationIdentitiesRequest$PoolId": "The unique identifier for the pool. This value can be either the PoolId or PoolArn.
", "PoolIdList$member": null, "RequestPhoneNumberRequest$PoolId": "The pool to associated with the phone number. You can use the PoolId or PoolArn.
", "UpdatePoolRequest$PoolId": "The unique identifier of the pool to update. Valid values are either the PoolId or PoolArn.
" } }, "PoolInformation": { "base": "The information for a pool in an Amazon Web Services account.
", "refs": { "PoolInformationList$member": null } }, "PoolInformationList": { "base": null, "refs": { "DescribePoolsResult$Pools": "An array of PoolInformation objects that contain the details for the requested pools.
" } }, "PoolOriginationIdentitiesFilter": { "base": "Information about origination identities associated with a pool that meets a specified criteria.
", "refs": { "PoolOriginationIdentitiesFilterList$member": null } }, "PoolOriginationIdentitiesFilterList": { "base": null, "refs": { "ListPoolOriginationIdentitiesRequest$Filters": "An array of PoolOriginationIdentitiesFilter objects to filter the results..
" } }, "PoolOriginationIdentitiesFilterName": { "base": null, "refs": { "PoolOriginationIdentitiesFilter$Name": "The name of the attribute to filter on.
" } }, "PoolStatus": { "base": null, "refs": { "CreatePoolResult$Status": "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 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 current status of the pool.
", "UpdatePoolResult$Status": "The current status of the pool update request.
" } }, "PrimitiveBoolean": { "base": null, "refs": { "CreatePoolResult$TwoWayEnabled": "By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
", "CreatePoolResult$SelfManagedOptOutsEnabled": "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.
", "CreatePoolResult$SharedRoutesEnabled": "Indicates whether shared routes are enabled for the pool.
", "CreatePoolResult$DeletionProtectionEnabled": "When set to true deletion protection is enabled. By default this is set to false.
", "DeleteOptedOutNumberResult$EndUserOptedOut": "This is true if it was the end user who requested their phone number be removed.
", "DeletePoolResult$TwoWayEnabled": "By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
", "DeletePoolResult$SelfManagedOptOutsEnabled": "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.
", "DeletePoolResult$SharedRoutesEnabled": "Indicates whether shared routes are enabled for the pool.
", "OptedOutNumberInformation$EndUserOptedOut": "This is set to true if it was the end recipient that opted out.
", "PhoneNumberInformation$TwoWayEnabled": "By default this is set to false. When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
", "PhoneNumberInformation$SelfManagedOptOutsEnabled": "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
", "PhoneNumberInformation$DeletionProtectionEnabled": "When set to true the phone number can't be deleted.
", "PoolInformation$TwoWayEnabled": "When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
", "PoolInformation$SelfManagedOptOutsEnabled": "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
", "PoolInformation$SharedRoutesEnabled": "Allows you to enable shared routes on your pool.
By default, this is set to 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.
When set to true the pool can't be deleted.
", "PutOptedOutNumberResult$EndUserOptedOut": "This is true if it was the end user who requested their phone number be removed.
", "ReleasePhoneNumberResult$TwoWayEnabled": "By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
", "ReleasePhoneNumberResult$SelfManagedOptOutsEnabled": "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.
", "ReleaseSenderIdResult$Registered": "True if the sender ID is registered.
", "RequestPhoneNumberResult$TwoWayEnabled": "By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
", "RequestPhoneNumberResult$SelfManagedOptOutsEnabled": "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.
", "RequestPhoneNumberResult$DeletionProtectionEnabled": "By default this is set to false. When set to true the phone number can't be deleted.
", "RequestSenderIdResult$DeletionProtectionEnabled": "By default this is set to false. When set to true the sender ID can't be deleted.
", "RequestSenderIdResult$Registered": "True if the sender ID is registered.
", "SendTextMessageRequest$DryRun": "When set to true, the message is checked and validated, but isn't sent to the end recipient.
", "SendVoiceMessageRequest$DryRun": "When set to true, the message is checked and validated, but isn't sent to the end recipient.
", "SenderIdInformation$DeletionProtectionEnabled": "By default this is set to false. When set to true the sender ID can't be deleted.
", "SenderIdInformation$Registered": "True if the sender ID is registered.
", "SpendLimit$Overridden": "When set to 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.
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
", "UpdatePhoneNumberResult$SelfManagedOptOutsEnabled": "This is true if self managed opt-out are enabled.
", "UpdatePhoneNumberResult$DeletionProtectionEnabled": "When set to true the phone number can't be deleted.
", "UpdatePoolResult$TwoWayEnabled": "By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
", "UpdatePoolResult$SelfManagedOptOutsEnabled": "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.
", "UpdatePoolResult$SharedRoutesEnabled": "Indicates whether shared routes are enabled for the pool.
", "UpdatePoolResult$DeletionProtectionEnabled": "When set to true the pool can't be deleted.
", "UpdateSenderIdResult$DeletionProtectionEnabled": "By default this is set to false. When set to true the sender ID can't be deleted.
", "UpdateSenderIdResult$Registered": "True if the sender ID is registered..
" } }, "PrimitiveLong": { "base": null, "refs": { "AccountLimit$Used": "The current amount that has been spent, in US dollars.
", "AccountLimit$Max": "The Amazon Web Services set limit for that resource type, in US dollars.
", "SpendLimit$EnforcedLimit": "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 MaxLimit. To use this custom limit, Overridden must be set to true.
The maximum amount of money that you are able to spend to send messages each month, in US dollars.
" } }, "PutKeywordRequest": { "base": null, "refs": { } }, "PutKeywordResult": { "base": null, "refs": { } }, "PutOptedOutNumberRequest": { "base": null, "refs": { } }, "PutOptedOutNumberResult": { "base": null, "refs": { } }, "PutRegistrationFieldValueRequest": { "base": null, "refs": { } }, "PutRegistrationFieldValueResult": { "base": null, "refs": { } }, "RegistrationAssociationBehavior": { "base": null, "refs": { "SupportedAssociation$AssociationBehavior": "The association behavior.
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.
The filter definition for filtering registrations that meets a specified criteria.
", "refs": { "RegistrationAssociationFilterList$member": null } }, "RegistrationAssociationFilterList": { "base": null, "refs": { "ListRegistrationAssociationsRequest$Filters": "An array of RegistrationAssociationFilter to apply to the results that are returned.
" } }, "RegistrationAssociationFilterName": { "base": null, "refs": { "RegistrationAssociationFilter$Name": "The name of the attribute to filter on.
" } }, "RegistrationAssociationMetadata": { "base": "Metadata for the origination identity that is associated with the registration.
", "refs": { "RegistrationAssociationMetadataList$member": null } }, "RegistrationAssociationMetadataList": { "base": null, "refs": { "ListRegistrationAssociationsResult$RegistrationAssociations": "An array of RegistrationAssociationMetadata objects.
" } }, "RegistrationAttachmentFilter": { "base": "The filter definition for filtering registration attachments that meets a specified criteria.
", "refs": { "RegistrationAttachmentFilterList$member": null } }, "RegistrationAttachmentFilterList": { "base": null, "refs": { "DescribeRegistrationAttachmentsRequest$Filters": "An array of RegistrationAttachmentFilter objects to filter the results.
" } }, "RegistrationAttachmentFilterName": { "base": null, "refs": { "RegistrationAttachmentFilter$Name": "The name of the attribute to filter on.
" } }, "RegistrationAttachmentIdList": { "base": null, "refs": { "DescribeRegistrationAttachmentsRequest$RegistrationAttachmentIds": "The unique identifier of registration attachments to find. This is an array of RegistrationAttachmentId.
" } }, "RegistrationAttachmentIdOrArn": { "base": null, "refs": { "DeleteRegistrationAttachmentRequest$RegistrationAttachmentId": "The unique identifier for the registration attachment.
", "PutRegistrationFieldValueRequest$RegistrationAttachmentId": "The unique identifier for the registration attachment.
", "RegistrationFieldValueInformation$RegistrationAttachmentId": "The unique identifier for the registration attachment.
" } }, "RegistrationAttachmentsInformation": { "base": "Provides information on the specified registration attachments.
", "refs": { "RegistrationAttachmentsInformationList$member": null } }, "RegistrationAttachmentsInformationList": { "base": null, "refs": { "DescribeRegistrationAttachmentsResult$RegistrationAttachments": "An array of RegistrationAttachments objects that contain the details for the requested registration attachments.
" } }, "RegistrationDeniedReasonInformation": { "base": "Provides the reason a registration was rejected.
", "refs": { "RegistrationDeniedReasonInformationList$member": null } }, "RegistrationDeniedReasonInformationList": { "base": null, "refs": { "RegistrationVersionInformation$DeniedReasons": "An array of RegistrationDeniedReasonInformation objects.
" } }, "RegistrationDisassociationBehavior": { "base": null, "refs": { "SupportedAssociation$DisassociationBehavior": "The disassociation behavior.
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.
Provides a description of the specified field.
", "refs": { "RegistrationFieldDefinitionList$member": null } }, "RegistrationFieldDefinitionList": { "base": null, "refs": { "DescribeRegistrationFieldDefinitionsResult$RegistrationFieldDefinitions": "An array of RegistrationFieldDefinitions objects that contain the details for the requested fields.
" } }, "RegistrationFieldDisplayHints": { "base": "Provides help information on the registration field.
", "refs": { "RegistrationFieldDefinition$DisplayHints": "An array of RegistrationFieldDisplayHints objects for the field.
" } }, "RegistrationFieldValueInformation": { "base": "Provides the values of the specified field.
", "refs": { "RegistrationFieldValueInformationList$member": null } }, "RegistrationFieldValueInformationList": { "base": null, "refs": { "DescribeRegistrationFieldValuesResult$RegistrationFieldValues": "An array of RegistrationFieldValues objects that contain the values for the requested registration.
" } }, "RegistrationFilter": { "base": "The filter definition for filtering registrations that meets a specified criteria.
", "refs": { "RegistrationFilterList$member": null } }, "RegistrationFilterList": { "base": null, "refs": { "DescribeRegistrationsRequest$Filters": "An array of RegistrationFilter objects to filter the results.
" } }, "RegistrationFilterName": { "base": null, "refs": { "RegistrationFilter$Name": "The name of the attribute to filter on.
" } }, "RegistrationIdList": { "base": null, "refs": { "DescribeRegistrationsRequest$RegistrationIds": "An array of unique identifiers for each registration.
" } }, "RegistrationIdOrArn": { "base": null, "refs": { "CreateRegistrationAssociationRequest$RegistrationId": "The unique identifier for the registration.
", "CreateRegistrationVersionRequest$RegistrationId": "The unique identifier for the registration.
", "DeleteRegistrationFieldValueRequest$RegistrationId": "The unique identifier for the registration.
", "DeleteRegistrationRequest$RegistrationId": "The unique identifier for the registration.
", "DescribeRegistrationFieldValuesRequest$RegistrationId": "The unique identifier for the registration.
", "DescribeRegistrationVersionsRequest$RegistrationId": "The unique identifier for the registration.
", "DiscardRegistrationVersionRequest$RegistrationId": "The unique identifier for the registration.
", "ListRegistrationAssociationsRequest$RegistrationId": "The unique identifier for the registration.
", "PutRegistrationFieldValueRequest$RegistrationId": "The unique identifier for the registration.
", "RegistrationAttachmentIdList$member": null, "RegistrationIdList$member": null, "RequestPhoneNumberRequest$RegistrationId": "Use this field to attach your phone number for an external registration process.
", "SubmitRegistrationVersionRequest$RegistrationId": "The unique identifier for the registration.
" } }, "RegistrationInformation": { "base": "Provides information about the requested registration.
", "refs": { "RegistrationInformationList$member": null } }, "RegistrationInformationList": { "base": null, "refs": { "DescribeRegistrationsResult$Registrations": "An array of RegistrationInformation objects.
" } }, "RegistrationSectionDefinition": { "base": "Provides information on the specified section definition.
", "refs": { "RegistrationSectionDefinitionList$member": null } }, "RegistrationSectionDefinitionList": { "base": null, "refs": { "DescribeRegistrationSectionDefinitionsResult$RegistrationSectionDefinitions": "An array of RegistrationSectionDefinition objects.
" } }, "RegistrationSectionDisplayHints": { "base": "Provides help information on the registration section.
", "refs": { "RegistrationSectionDefinition$DisplayHints": "The path to the section of the registration.
" } }, "RegistrationStatus": { "base": null, "refs": { "CreateRegistrationResult$RegistrationStatus": "The status of the registration.
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.
The status of the registration.
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.
The status of the registration.
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.
The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
", "CreateRegistrationRequest$RegistrationType": "The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
", "CreateRegistrationResult$RegistrationType": "The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
", "DeleteRegistrationResult$RegistrationType": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
", "DescribeRegistrationFieldDefinitionsRequest$RegistrationType": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
", "DescribeRegistrationFieldDefinitionsResult$RegistrationType": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
", "DescribeRegistrationSectionDefinitionsRequest$RegistrationType": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
", "DescribeRegistrationSectionDefinitionsResult$RegistrationType": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
", "ListRegistrationAssociationsResult$RegistrationType": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
", "RegistrationInformation$RegistrationType": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
", "RegistrationTypeDefinition$RegistrationType": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
", "RegistrationTypeList$member": null } }, "RegistrationTypeDefinition": { "base": "Provides information on the supported registration type.
", "refs": { "RegistrationTypeDefinitionList$member": null } }, "RegistrationTypeDefinitionList": { "base": null, "refs": { "DescribeRegistrationTypeDefinitionsResult$RegistrationTypeDefinitions": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
" } }, "RegistrationTypeDisplayHints": { "base": "Provides help information on the registration type.
", "refs": { "RegistrationTypeDefinition$DisplayHints": "Provides help information on the registration.
" } }, "RegistrationTypeFilter": { "base": "The filter definition for filtering registration types that meets a specified criteria.
", "refs": { "RegistrationTypeFilterList$member": null } }, "RegistrationTypeFilterList": { "base": null, "refs": { "DescribeRegistrationTypeDefinitionsRequest$Filters": "An array of RegistrationFilter objects to filter the results.
" } }, "RegistrationTypeFilterName": { "base": null, "refs": { "RegistrationTypeFilter$Name": "The name of the attribute to filter on.
" } }, "RegistrationTypeList": { "base": null, "refs": { "DescribeRegistrationTypeDefinitionsRequest$RegistrationTypes": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
" } }, "RegistrationVersionFilter": { "base": "The filter definition for filtering registration versions that meets a specified criteria.
", "refs": { "RegistrationVersionFilterList$member": null } }, "RegistrationVersionFilterList": { "base": null, "refs": { "DescribeRegistrationVersionsRequest$Filters": "An array of RegistrationVersionFilter objects to filter the results.
" } }, "RegistrationVersionFilterName": { "base": null, "refs": { "RegistrationVersionFilter$Name": "The name of the attribute to filter on.
" } }, "RegistrationVersionInformation": { "base": "Provides information about the specified version of the registration.
", "refs": { "RegistrationVersionInformationList$member": null } }, "RegistrationVersionInformationList": { "base": null, "refs": { "DescribeRegistrationVersionsResult$RegistrationVersions": "An array of RegistrationVersions objects.
" } }, "RegistrationVersionNumber": { "base": null, "refs": { "CreateRegistrationResult$CurrentVersionNumber": "The current version number of the registration.
", "CreateRegistrationVersionResult$VersionNumber": "The new version number of the registration.
", "DeleteRegistrationFieldValueResult$VersionNumber": "The version number of the registration.
", "DeleteRegistrationResult$CurrentVersionNumber": "The current version number of the registration.
", "DeleteRegistrationResult$ApprovedVersionNumber": "The version number of the registration that was approved.
", "DeleteRegistrationResult$LatestDeniedVersionNumber": "The latest version number of the registration that was denied.
", "DescribeRegistrationFieldValuesRequest$VersionNumber": "The version number of the registration.
", "DescribeRegistrationFieldValuesResult$VersionNumber": "The current version of the registration.
", "DiscardRegistrationVersionResult$VersionNumber": "The version number of the registration.
", "PutRegistrationFieldValueResult$VersionNumber": "The version number of the registration.
", "RegistrationInformation$CurrentVersionNumber": "The current version number of the registration.
", "RegistrationInformation$ApprovedVersionNumber": "The version number of the registration that was approved.
", "RegistrationInformation$LatestDeniedVersionNumber": "The latest version number of the registration that was denied.
", "RegistrationVersionInformation$VersionNumber": "The version number of the registration.
", "RegistrationVersionNumberList$member": null, "SubmitRegistrationVersionResult$VersionNumber": "The version number of the registration.
" } }, "RegistrationVersionNumberList": { "base": null, "refs": { "DescribeRegistrationVersionsRequest$VersionNumbers": "An array of registration version numbers.
" } }, "RegistrationVersionStatus": { "base": null, "refs": { "CreateRegistrationVersionResult$RegistrationVersionStatus": "The status of the registration.
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 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 status of the registration.
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 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.
", "refs": { "CreateRegistrationVersionResult$RegistrationVersionStatusHistory": "A RegistrationVersionStatusHistory object that contains timestamps for the registration.
", "DiscardRegistrationVersionResult$RegistrationVersionStatusHistory": "The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.
", "RegistrationVersionInformation$RegistrationVersionStatusHistory": "The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.
", "SubmitRegistrationVersionResult$RegistrationVersionStatusHistory": "The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.
" } }, "ReleasePhoneNumberRequest": { "base": null, "refs": { } }, "ReleasePhoneNumberResult": { "base": null, "refs": { } }, "ReleaseSenderIdRequest": { "base": null, "refs": { } }, "ReleaseSenderIdResult": { "base": null, "refs": { } }, "RequestPhoneNumberRequest": { "base": null, "refs": { } }, "RequestPhoneNumberResult": { "base": null, "refs": { } }, "RequestSenderIdRequest": { "base": null, "refs": { } }, "RequestSenderIdResult": { "base": null, "refs": { } }, "RequestableNumberType": { "base": null, "refs": { "RequestPhoneNumberRequest$NumberType": "The type of phone number to request.
", "RequestPhoneNumberResult$NumberType": "The type of number that was released.
" } }, "ResourceIdOrArn": { "base": null, "refs": { "CreateRegistrationAssociationRequest$ResourceId": "The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.
" } }, "ResourceNotFoundException": { "base": "A requested resource couldn't be found.
", "refs": { } }, "ResourceType": { "base": null, "refs": { "ConflictException$ResourceType": "The type of resource that caused the exception.
", "ResourceNotFoundException$ResourceType": "The type of resource that caused the exception.
" } }, "SectionPath": { "base": null, "refs": { "DescribeRegistrationFieldDefinitionsRequest$SectionPath": "The path to the section of the registration.
", "DescribeRegistrationFieldValuesRequest$SectionPath": "The path to the section of the registration.
", "RegistrationFieldDefinition$SectionPath": "The section path of the field.
", "RegistrationSectionDefinition$SectionPath": "The path to the section of the registration.
", "SectionPathList$member": null } }, "SectionPathList": { "base": null, "refs": { "DescribeRegistrationSectionDefinitionsRequest$SectionPaths": "An array of paths for the registration form section.
" } }, "SelectChoice": { "base": null, "refs": { "SelectChoiceList$member": null } }, "SelectChoiceList": { "base": null, "refs": { "DeleteRegistrationFieldValueResult$SelectChoices": "An array of values for the form field.
", "PutRegistrationFieldValueRequest$SelectChoices": "An array of values for the form field.
", "PutRegistrationFieldValueResult$SelectChoices": "An array of values for the form field.
", "RegistrationFieldValueInformation$SelectChoices": "An array of values for the form field.
" } }, "SelectOptionDescription": { "base": "A description of each select option.
", "refs": { "SelectOptionDescriptionsList$member": null } }, "SelectOptionDescriptionsList": { "base": null, "refs": { "RegistrationFieldDisplayHints$SelectOptionDescriptions": "An array of SelectOptionDescription objects.
" } }, "SelectValidation": { "base": "Validation rules for a select field.
", "refs": { "RegistrationFieldDefinition$SelectValidation": "The validation rules for a select field.
" } }, "SendDestinationNumberVerificationCodeRequest": { "base": null, "refs": { } }, "SendDestinationNumberVerificationCodeResult": { "base": null, "refs": { } }, "SendTextMessageRequest": { "base": null, "refs": { } }, "SendTextMessageResult": { "base": null, "refs": { } }, "SendVoiceMessageRequest": { "base": null, "refs": { } }, "SendVoiceMessageResult": { "base": null, "refs": { } }, "SenderId": { "base": null, "refs": { "ConfigurationSetInformation$DefaultSenderId": "The default sender ID used by the ConfigurationSet.
", "DeleteConfigurationSetResult$DefaultSenderId": "The default Sender ID of the configuration set that was deleted.
", "DeleteDefaultSenderIdResult$SenderId": "The current sender ID for the configuration set.
", "ReleaseSenderIdResult$SenderId": "The sender ID that was released.
", "RequestSenderIdRequest$SenderId": "The sender ID string to request.
", "RequestSenderIdResult$SenderId": "The sender ID that was requested.
", "SenderIdInformation$SenderId": "The alphanumeric sender ID in a specific country that you'd like to describe.
", "SetDefaultSenderIdRequest$SenderId": "The current sender ID for the configuration set. When sending a text message to a destination country which supports SenderIds, the default sender ID on the configuration set specified on SendTextMessage will be used if no dedicated origination phone numbers or registered SenderIds are available in your account, instead of a generic sender ID, such as 'NOTICE'.
", "SetDefaultSenderIdResult$SenderId": "The default sender ID to set for the ConfigurationSet.
", "UpdateSenderIdResult$SenderId": "The sender ID that was updated.
" } }, "SenderIdAndCountry": { "base": "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.
", "refs": { "SenderIdList$member": null } }, "SenderIdFilter": { "base": "The information for a sender ID that meets a specified criteria.
", "refs": { "SenderIdFilterList$member": null } }, "SenderIdFilterList": { "base": null, "refs": { "DescribeSenderIdsRequest$Filters": "An array of SenderIdFilter objects to filter the results.
" } }, "SenderIdFilterName": { "base": null, "refs": { "SenderIdFilter$Name": "The name of the attribute to filter on.
" } }, "SenderIdInformation": { "base": "The information for all SenderIds in an Amazon Web Services account.
", "refs": { "SenderIdInformationList$member": null } }, "SenderIdInformationList": { "base": null, "refs": { "DescribeSenderIdsResult$SenderIds": "An array of SernderIdInformation objects that contain the details for the requested SenderIds.
" } }, "SenderIdList": { "base": null, "refs": { "DescribeSenderIdsRequest$SenderIds": "An array of SenderIdAndCountry objects to search for.
" } }, "SenderIdOrArn": { "base": null, "refs": { "ReleaseSenderIdRequest$SenderId": "The sender ID to release.
", "SenderIdAndCountry$SenderId": "The unique identifier of the sender.
", "UpdateSenderIdRequest$SenderId": "The sender ID to update.
" } }, "ServiceQuotaExceededException": { "base": "The request would cause a service quota to be exceeded.
", "refs": { } }, "ServiceQuotaExceededExceptionReason": { "base": null, "refs": { "ServiceQuotaExceededException$Reason": "The reason for the exception.
" } }, "SetDefaultMessageTypeRequest": { "base": null, "refs": { } }, "SetDefaultMessageTypeResult": { "base": null, "refs": { } }, "SetDefaultSenderIdRequest": { "base": null, "refs": { } }, "SetDefaultSenderIdResult": { "base": null, "refs": { } }, "SetTextMessageSpendLimitOverrideRequest": { "base": null, "refs": { } }, "SetTextMessageSpendLimitOverrideResult": { "base": null, "refs": { } }, "SetVoiceMessageSpendLimitOverrideRequest": { "base": null, "refs": { } }, "SetVoiceMessageSpendLimitOverrideResult": { "base": null, "refs": { } }, "SnsDestination": { "base": "An object that defines an Amazon SNS destination for events. You can use Amazon SNS to send notification when certain events occur.
", "refs": { "CreateEventDestinationRequest$SnsDestination": "An object that contains information about an event destination for logging to Amazon SNS.
", "EventDestination$SnsDestination": "An object that contains information about an event destination that sends logging events to Amazon SNS.
", "UpdateEventDestinationRequest$SnsDestination": "An object that contains information about an event destination that sends data to Amazon SNS.
" } }, "SnsTopicArn": { "base": null, "refs": { "SnsDestination$TopicArn": "The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.
" } }, "SpendLimit": { "base": "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.
", "refs": { "SpendLimitList$member": null } }, "SpendLimitList": { "base": null, "refs": { "DescribeSpendLimitsResult$SpendLimits": "An array of SpendLimit objects that contain the details for the requested spend limits.
" } }, "SpendLimitName": { "base": null, "refs": { "SpendLimit$Name": "The name for the SpendLimit.
" } }, "String": { "base": null, "refs": { "AccessDeniedException$Message": null, "AccountAttribute$Value": "The value associated with the account attribute name.
", "AssociateOriginationIdentityResult$PoolArn": "The Amazon Resource Name (ARN) of the pool that is now associated with the origination identity.
", "AssociateOriginationIdentityResult$PoolId": "The PoolId of the pool that is now associated with the origination identity.
", "AssociateOriginationIdentityResult$OriginationIdentityArn": "The PhoneNumberArn or SenderIdArn of the origination identity.
", "AssociateOriginationIdentityResult$OriginationIdentity": "The PhoneNumberId or SenderId of the origination identity.
", "ConfigurationSetInformation$ConfigurationSetArn": "The Resource Name (ARN) of the ConfigurationSet.
", "ConflictException$Message": null, "ConflictException$ResourceId": "The unique identifier of the request.
", "CreateConfigurationSetResult$ConfigurationSetArn": "The Amazon Resource Name (ARN) of the newly created configuration set.
", "CreateEventDestinationResult$ConfigurationSetArn": "The ARN of the configuration set.
", "CreateOptOutListResult$OptOutListArn": "The Amazon Resource Name (ARN) for the OptOutList.
", "CreatePoolResult$PoolArn": "The Amazon Resource Name (ARN) for the pool.
", "CreatePoolResult$PoolId": "The unique identifier for the pool.
", "CreateRegistrationAssociationResult$RegistrationArn": "The Amazon Resource Name (ARN) for the registration.
", "CreateRegistrationAssociationResult$RegistrationId": "The unique identifier for the registration.
", "CreateRegistrationAssociationResult$ResourceArn": "The Amazon Resource Name (ARN) of the origination identity that is associated with the registration.
", "CreateRegistrationAssociationResult$ResourceId": "The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.
", "CreateRegistrationAssociationResult$ResourceType": "The registration type or origination identity type.
", "CreateRegistrationAttachmentResult$RegistrationAttachmentArn": "The Amazon Resource Name (ARN) for the registration attachment.
", "CreateRegistrationAttachmentResult$RegistrationAttachmentId": "The unique identifier for the registration attachment.
", "CreateRegistrationResult$RegistrationArn": "The Amazon Resource Name (ARN) for the registration.
", "CreateRegistrationResult$RegistrationId": "The unique identifier for the registration.
", "CreateRegistrationVersionResult$RegistrationArn": "The Amazon Resource Name (ARN) for the registration.
", "CreateRegistrationVersionResult$RegistrationId": "The unique identifier for the registration.
", "CreateVerifiedDestinationNumberResult$VerifiedDestinationNumberArn": "The Amazon Resource Name (ARN) for the verified destination phone number.
", "CreateVerifiedDestinationNumberResult$VerifiedDestinationNumberId": "The unique identifier for the verified destination phone number.
", "DeleteConfigurationSetResult$ConfigurationSetArn": "The Amazon Resource Name (ARN) of the deleted configuration set.
", "DeleteDefaultMessageTypeResult$ConfigurationSetArn": "The Amazon Resource Name (ARN) of the configuration set.
", "DeleteDefaultSenderIdResult$ConfigurationSetArn": "The Amazon Resource Name (ARN) of the configuration set.
", "DeleteEventDestinationResult$ConfigurationSetArn": "The Amazon Resource Name (ARN) of the configuration set.
", "DeleteKeywordResult$OriginationIdentityArn": "The PhoneNumberArn or PoolArn that the keyword was associated with.
", "DeleteKeywordResult$OriginationIdentity": "The PhoneNumberId or PoolId that the keyword was associated with.
", "DeleteOptOutListResult$OptOutListArn": "The Amazon Resource Name (ARN) of the OptOutList that was removed.
", "DeleteOptedOutNumberResult$OptOutListArn": "The OptOutListArn that the phone number was removed from.
", "DeletePoolResult$PoolArn": "The Amazon Resource Name (ARN) of the pool that was deleted.
", "DeletePoolResult$PoolId": "The PoolId of the pool that was deleted.
", "DeleteRegistrationAttachmentResult$RegistrationAttachmentArn": "The Amazon Resource Name (ARN) for the registration attachment.
", "DeleteRegistrationAttachmentResult$RegistrationAttachmentId": "The unique identifier for the registration attachment.
", "DeleteRegistrationFieldValueResult$RegistrationArn": "The Amazon Resource Name (ARN) for the registration.
", "DeleteRegistrationFieldValueResult$RegistrationId": "The unique identifier for the registration.
", "DeleteRegistrationFieldValueResult$RegistrationAttachmentId": "The unique identifier for the registration attachment.
", "DeleteRegistrationResult$RegistrationArn": "The Amazon Resource Name (ARN) for the registration.
", "DeleteRegistrationResult$RegistrationId": "The unique identifier for the registration.
", "DeleteVerifiedDestinationNumberResult$VerifiedDestinationNumberArn": "The Amazon Resource Name (ARN) for the verified destination phone number.
", "DeleteVerifiedDestinationNumberResult$VerifiedDestinationNumberId": "The unique identifier for the verified destination phone number.
", "DescribeKeywordsResult$OriginationIdentityArn": "The PhoneNumberArn or PoolArn that is associated with the OriginationIdentity.
", "DescribeKeywordsResult$OriginationIdentity": "The PhoneNumberId or PoolId that is associated with the OriginationIdentity.
", "DescribeOptedOutNumbersResult$OptOutListArn": "The Amazon Resource Name (ARN) of the OptOutList.
", "DescribeRegistrationFieldValuesResult$RegistrationArn": "The Amazon Resource Name (ARN) for the registration.
", "DescribeRegistrationFieldValuesResult$RegistrationId": "The unique identifier for the registration.
", "DescribeRegistrationVersionsResult$RegistrationArn": "The Amazon Resource Name (ARN) for the registration.
", "DescribeRegistrationVersionsResult$RegistrationId": "The unique identifier for the registration.
", "DisassociateOriginationIdentityResult$PoolArn": "The Amazon Resource Name (ARN) of the pool.
", "DisassociateOriginationIdentityResult$PoolId": "The PoolId of the pool no longer associated with the origination identity.
", "DisassociateOriginationIdentityResult$OriginationIdentityArn": "The PhoneNumberArn or SenderIdArn of the origination identity.
", "DisassociateOriginationIdentityResult$OriginationIdentity": "The PhoneNumberId or SenderId of the origination identity.
", "DiscardRegistrationVersionResult$RegistrationArn": "The Amazon Resource Name (ARN) for the registration.
", "DiscardRegistrationVersionResult$RegistrationId": "The unique identifier for the registration.
", "InternalServerException$Message": null, "InternalServerException$RequestId": "The unique identifier of the request.
", "ListPoolOriginationIdentitiesResult$PoolArn": "The Amazon Resource Name (ARN) for the pool.
", "ListPoolOriginationIdentitiesResult$PoolId": "The unique PoolId of the pool.
", "ListRegistrationAssociationsResult$RegistrationArn": "The Amazon Resource Name (ARN) for the registration.
", "ListRegistrationAssociationsResult$RegistrationId": "The unique identifier for the registration.
", "OptOutListInformation$OptOutListArn": "The Amazon Resource Name (ARN) of the OptOutList.
", "OriginationIdentityMetadata$OriginationIdentityArn": "The Amazon Resource Name (ARN) associated with the origination identity.
", "OriginationIdentityMetadata$OriginationIdentity": "The unique identifier of the origination identity.
", "PhoneNumberInformation$PhoneNumberArn": "The Amazon Resource Name (ARN) associated with the phone number.
", "PhoneNumberInformation$PhoneNumberId": "The unique identifier for the phone number.
", "PhoneNumberInformation$MonthlyLeasingPrice": "The price, in US dollars, to lease the phone number.
", "PhoneNumberInformation$PoolId": "The unique identifier of the pool associated with the phone number.
", "PhoneNumberInformation$RegistrationId": "The unique identifier for the registration.
", "PoolInformation$PoolArn": "The Amazon Resource Name (ARN) for the pool.
", "PoolInformation$PoolId": "The unique identifier for the pool.
", "PutKeywordResult$OriginationIdentityArn": "The PhoneNumberArn or PoolArn that the keyword was associated with.
", "PutKeywordResult$OriginationIdentity": "The PhoneNumberId or PoolId that the keyword was associated with.
", "PutOptedOutNumberResult$OptOutListArn": "The OptOutListArn that the phone number was removed from.
", "PutRegistrationFieldValueResult$RegistrationArn": "The Amazon Resource Name (ARN) for the registration.
", "PutRegistrationFieldValueResult$RegistrationId": "The unique identifier for the registration.
", "PutRegistrationFieldValueResult$RegistrationAttachmentId": "The unique identifier for the registration attachment.
", "RegistrationAssociationMetadata$ResourceArn": "The Amazon Resource Name (ARN) of the origination identity that is associated with the registration.
", "RegistrationAssociationMetadata$ResourceId": "The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.
", "RegistrationAssociationMetadata$ResourceType": "The origination identity type.
", "RegistrationAttachmentsInformation$RegistrationAttachmentArn": "The Amazon Resource Name (ARN) for the registration attachment.
", "RegistrationAttachmentsInformation$RegistrationAttachmentId": "The unique identifier for the registration attachment.
", "RegistrationDeniedReasonInformation$Reason": "The reason a registration was rejected.
", "RegistrationDeniedReasonInformation$ShortDescription": "A short description of the rejection reason.
", "RegistrationDeniedReasonInformation$LongDescription": "A long description of the rejection reason.
", "RegistrationDeniedReasonInformation$DocumentationTitle": "The title of the document.
", "RegistrationDeniedReasonInformation$DocumentationLink": "The link to the document.
", "RegistrationFieldDisplayHints$Title": "The title of the display hint.
", "RegistrationFieldDisplayHints$ShortDescription": "A short description of the display hint.
", "RegistrationFieldDisplayHints$LongDescription": "A full description of the display hint.
", "RegistrationFieldDisplayHints$DocumentationTitle": "The title of the document the display hint is associated with.
", "RegistrationFieldDisplayHints$DocumentationLink": "The link to the document the display hint is associated with.
", "RegistrationFieldDisplayHints$TextValidationDescription": "The validation rules for the text field.
", "RegistrationFieldDisplayHints$ExampleTextValue": "Example text of what the value of a field should contain.
", "RegistrationFieldValueInformation$DeniedReason": "A description of why the registration was denied.
", "RegistrationInformation$RegistrationArn": "The Amazon Resource Name (ARN) for the registration.
", "RegistrationInformation$RegistrationId": "The unique identifier for the registration.
", "RegistrationSectionDisplayHints$Title": "The title of the display hint.
", "RegistrationSectionDisplayHints$ShortDescription": "A short description of the display hint.
", "RegistrationSectionDisplayHints$LongDescription": "A full description of the display hint.
", "RegistrationSectionDisplayHints$DocumentationTitle": "The title of the document the display hint is associated with.
", "RegistrationSectionDisplayHints$DocumentationLink": "The link to the document the display hint is associated with.
", "RegistrationTypeDisplayHints$Title": "The title of the display hint.
", "RegistrationTypeDisplayHints$ShortDescription": "A short description of the display hint.
", "RegistrationTypeDisplayHints$LongDescription": "A full description of the display hint.
", "RegistrationTypeDisplayHints$DocumentationTitle": "The title of the document the display hint is associated with.
", "RegistrationTypeDisplayHints$DocumentationLink": "The link to the document the display hint is associated with.
", "ReleasePhoneNumberResult$PhoneNumberArn": "The PhoneNumberArn of the phone number that was released.
", "ReleasePhoneNumberResult$PhoneNumberId": "The PhoneNumberId of the phone number that was released.
", "ReleasePhoneNumberResult$MonthlyLeasingPrice": "The monthly price of the phone number, in US dollars.
", "ReleasePhoneNumberResult$RegistrationId": "The unique identifier for the registration.
", "ReleaseSenderIdResult$SenderIdArn": "The Amazon Resource Name (ARN) associated with the SenderId.
", "ReleaseSenderIdResult$MonthlyLeasingPrice": "The monthly price, in US dollars, to lease the sender ID.
", "ReleaseSenderIdResult$RegistrationId": "The unique identifier for the registration.
", "RequestPhoneNumberResult$PhoneNumberArn": "The Amazon Resource Name (ARN) of the requested phone number.
", "RequestPhoneNumberResult$PhoneNumberId": "The unique identifier of the new phone number.
", "RequestPhoneNumberResult$MonthlyLeasingPrice": "The monthly price, in US dollars, to lease the phone number.
", "RequestPhoneNumberResult$PoolId": "The unique identifier of the pool associated with the phone number
", "RequestPhoneNumberResult$RegistrationId": "The unique identifier for the registration.
", "RequestSenderIdResult$SenderIdArn": "The Amazon Resource Name (ARN) associated with the SenderId.
", "RequestSenderIdResult$MonthlyLeasingPrice": "The monthly price, in US dollars, to lease the sender ID.
", "ResourceNotFoundException$Message": null, "ResourceNotFoundException$ResourceId": "The unique identifier of the resource.
", "SelectOptionDescription$Option": "The value of the option.
", "SelectOptionDescription$Title": "The title of the select option.
", "SelectOptionDescription$Description": "A description of the option meaning.
", "SendDestinationNumberVerificationCodeResult$MessageId": "The unique identifier for the message.
", "SendTextMessageResult$MessageId": "The unique identifier for the message.
", "SendVoiceMessageResult$MessageId": "The unique identifier for the message.
", "SenderIdInformation$SenderIdArn": "The Amazon Resource Name (ARN) associated with the SenderId.
", "SenderIdInformation$MonthlyLeasingPrice": "The monthly leasing price, in US dollars.
", "SenderIdInformation$RegistrationId": "The unique identifier for the registration.
", "ServiceQuotaExceededException$Message": null, "SetDefaultMessageTypeResult$ConfigurationSetArn": "The Amazon Resource Name (ARN) of the updated configuration set.
", "SetDefaultSenderIdResult$ConfigurationSetArn": "The Amazon Resource Name (ARN) of the updated configuration set.
", "StringList$member": null, "StringMap$key": null, "StringMap$value": null, "SubmitRegistrationVersionResult$RegistrationArn": "The Amazon Resource Name (ARN) for the registration.
", "SubmitRegistrationVersionResult$RegistrationId": "The unique identifier for the registration.
", "SupportedAssociation$ResourceType": "Defines the behavior of when an origination identity and registration can be associated with each other.
", "TextValidation$Pattern": "The regular expression used to validate the text field.
", "ThrottlingException$Message": null, "UpdateEventDestinationResult$ConfigurationSetArn": "The Amazon Resource Name (ARN) for the ConfigurationSet that was updated.
", "UpdatePhoneNumberResult$PhoneNumberArn": "The Amazon Resource Name (ARN) of the updated phone number.
", "UpdatePhoneNumberResult$PhoneNumberId": "The unique identifier of the phone number.
", "UpdatePhoneNumberResult$MonthlyLeasingPrice": "The monthly leasing price of the phone number, in US dollars.
", "UpdatePhoneNumberResult$RegistrationId": "The unique identifier for the registration.
", "UpdatePoolResult$PoolArn": "The ARN of the pool.
", "UpdatePoolResult$PoolId": "The unique identifier of the pool.
", "UpdateSenderIdResult$SenderIdArn": "The Amazon Resource Name (ARN) associated with the SenderId.
", "UpdateSenderIdResult$MonthlyLeasingPrice": "The monthly price, in US dollars, to lease the sender ID.
", "UpdateSenderIdResult$RegistrationId": "The unique identifier for the registration.
", "ValidationException$Message": null, "ValidationExceptionField$Name": "The name of the field.
", "ValidationExceptionField$Message": "The message associated with the validation exception with information to help determine its cause.
", "VerifiedDestinationNumberInformation$VerifiedDestinationNumberArn": "The Amazon Resource Name (ARN) for the verified destination phone number.
", "VerifiedDestinationNumberInformation$VerifiedDestinationNumberId": "The unique identifier for the verified destination phone number.
", "VerifyDestinationNumberResult$VerifiedDestinationNumberArn": "The Amazon Resource Name (ARN) for the verified destination phone number.
", "VerifyDestinationNumberResult$VerifiedDestinationNumberId": "The unique identifier for the verified destination phone number.
" } }, "StringList": { "base": null, "refs": { "SelectValidation$Options": "An array of strings for the possible selection options.
" } }, "StringMap": { "base": null, "refs": { "CreateRegistrationResult$AdditionalAttributes": "Metadata about a given registration which is specific to that registration type.
", "DeleteRegistrationResult$AdditionalAttributes": "Metadata about a given registration which is specific to that registration type.
", "RegistrationInformation$AdditionalAttributes": "Metadata about a given registration which is specific to that registration type.
" } }, "SubmitRegistrationVersionRequest": { "base": null, "refs": { } }, "SubmitRegistrationVersionResult": { "base": null, "refs": { } }, "SupportedAssociation": { "base": "The processing rules for when a registration can be associated with an origination identity and disassociated from an origination identity.
", "refs": { "SupportedAssociationList$member": null } }, "SupportedAssociationList": { "base": null, "refs": { "RegistrationTypeDefinition$SupportedAssociations": "The supported association behavior for the registration type.
" } }, "Tag": { "base": "The list of tags to be added to the specified topic.
", "refs": { "NonEmptyTagList$member": null, "TagList$member": null } }, "TagKey": { "base": null, "refs": { "Tag$Key": "The key identifier, or name, of the tag.
", "TagKeyList$member": null } }, "TagKeyList": { "base": null, "refs": { "UntagResourceRequest$TagKeys": "An array of tag key values to unassociate with the resource.
" } }, "TagList": { "base": null, "refs": { "CreateConfigurationSetRequest$Tags": "An array of key and value pair tags that's associated with the new configuration set.
", "CreateConfigurationSetResult$Tags": "An array of key and value pair tags that's associated with the configuration set.
", "CreateOptOutListRequest$Tags": "An array of tags (key and value pairs) to associate with the new OptOutList.
", "CreateOptOutListResult$Tags": "An array of tags (key and value pairs) associated with the new OptOutList.
", "CreatePoolRequest$Tags": "An array of tags (key and value pairs) associated with the pool.
", "CreatePoolResult$Tags": "An array of tags (key and value pairs) associated with the pool.
", "CreateRegistrationAttachmentRequest$Tags": "An array of tags (key and value pairs) to associate with the registration attachment.
", "CreateRegistrationAttachmentResult$Tags": "An array of tags (key and value pairs) to associate with the registration attachment.
", "CreateRegistrationRequest$Tags": "An array of tags (key and value pairs) to associate with the registration.
", "CreateRegistrationResult$Tags": "An array of tags (key and value pairs) to associate with the registration.
", "CreateVerifiedDestinationNumberRequest$Tags": "An array of tags (key and value pairs) to associate with the destination number.
", "CreateVerifiedDestinationNumberResult$Tags": "An array of tags (key and value pairs) to associate with the destination number.
", "ListTagsForResourceResult$Tags": "An array of key and value pair tags that are associated with the resource.
", "RequestPhoneNumberRequest$Tags": "An array of tags (key and value pairs) associate with the requested phone number.
", "RequestPhoneNumberResult$Tags": "An array of key and value pair tags that are associated with the phone number.
", "RequestSenderIdRequest$Tags": "An array of tags (key and value pairs) to associate with the sender ID.
", "RequestSenderIdResult$Tags": "An array of tags (key and value pairs) to associate with the sender ID.
" } }, "TagResourceRequest": { "base": null, "refs": { } }, "TagResourceResult": { "base": null, "refs": { } }, "TagValue": { "base": null, "refs": { "Tag$Value": "The string value associated with the key of the tag.
" } }, "TextMessageBody": { "base": null, "refs": { "SendTextMessageRequest$MessageBody": "The body of the text message.
" } }, "TextMessageOriginationIdentity": { "base": null, "refs": { "SendTextMessageRequest$OriginationIdentity": "The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
" } }, "TextValidation": { "base": "Validation rules for a text field.
", "refs": { "RegistrationFieldDefinition$TextValidation": "The validation rules for a text field.
" } }, "TextValue": { "base": null, "refs": { "DeleteRegistrationFieldValueResult$TextValue": "The text data for a free form field.
", "PutRegistrationFieldValueRequest$TextValue": "The text data for a free form field.
", "PutRegistrationFieldValueResult$TextValue": "The text data for a free form field.
", "RegistrationFieldValueInformation$TextValue": "The text data for a free form field.
" } }, "ThrottlingException": { "base": "An error that occurred because too many requests were sent during a certain amount of time.
", "refs": { } }, "TimeToLive": { "base": null, "refs": { "SendTextMessageRequest$TimeToLive": "How long the text message is valid for. By default this is 72 hours.
", "SendVoiceMessageRequest$TimeToLive": "How long the voice message is valid for. By default this is 72 hours.
" } }, "Timestamp": { "base": null, "refs": { "ConfigurationSetInformation$CreatedTimestamp": "The time when the ConfigurationSet was created, in UNIX epoch time format.
", "CreateConfigurationSetResult$CreatedTimestamp": "The time when the configuration set was created, in UNIX epoch time format.
", "CreateOptOutListResult$CreatedTimestamp": "The time when the pool was created, in UNIX epoch time format.
", "CreatePoolResult$CreatedTimestamp": "The time when the pool was created, in UNIX epoch time format.
", "CreateRegistrationAttachmentResult$CreatedTimestamp": "The time when the registration attachment was created, in UNIX epoch time format.
", "CreateRegistrationResult$CreatedTimestamp": "The time when the registration was created, in UNIX epoch time format.
", "CreateVerifiedDestinationNumberResult$CreatedTimestamp": "The time when the verified phone number was created, in UNIX epoch time format.
", "DeleteConfigurationSetResult$CreatedTimestamp": "The time that the deleted configuration set was created in UNIX epoch time format.
", "DeleteOptOutListResult$CreatedTimestamp": "The time when the OptOutList was created, in UNIX epoch time format.
", "DeleteOptedOutNumberResult$OptedOutTimestamp": "The time that the number was removed at, in UNIX epoch time format.
", "DeletePoolResult$CreatedTimestamp": "The time when the pool was created, in UNIX epoch time format.
", "DeleteRegistrationAttachmentResult$CreatedTimestamp": "The time when the registration attachment was created, in UNIX epoch time format.
", "DeleteRegistrationResult$CreatedTimestamp": "The time when the registration was created, in UNIX epoch time format.
", "DeleteVerifiedDestinationNumberResult$CreatedTimestamp": "The time when the destination phone number was created, in UNIX epoch time format.
", "OptOutListInformation$CreatedTimestamp": "The time when the OutOutList was created, in UNIX epoch time format.
", "OptedOutNumberInformation$OptedOutTimestamp": "The time that the op tout occurred, in UNIX epoch time format.
", "PhoneNumberInformation$CreatedTimestamp": "The time when the phone number was created, in UNIX epoch time format.
", "PoolInformation$CreatedTimestamp": "The time when the pool was created, in UNIX epoch time format.
", "PutOptedOutNumberResult$OptedOutTimestamp": "The time that the phone number was added to the OptOutList, in UNIX epoch time format.
", "RegistrationAttachmentsInformation$CreatedTimestamp": "The time when the registration attachment was created, in UNIX epoch time format.
", "RegistrationInformation$CreatedTimestamp": "The time when the registration was created, in UNIX epoch time format.
", "RegistrationVersionStatusHistory$DraftTimestamp": "The time when the registration was in the draft state, in UNIX epoch time format.
", "RegistrationVersionStatusHistory$SubmittedTimestamp": "The time when the registration was in the submitted state, in UNIX epoch time format.
", "RegistrationVersionStatusHistory$ReviewingTimestamp": "The time when the registration was in the reviewing state, in UNIX epoch time format.
", "RegistrationVersionStatusHistory$ApprovedTimestamp": "The time when the registration was in the approved state, in UNIX epoch time format.
", "RegistrationVersionStatusHistory$DiscardedTimestamp": "The time when the registration was in the discarded state, in UNIX epoch time format.
", "RegistrationVersionStatusHistory$DeniedTimestamp": "The time when the registration was in the denied state, in UNIX epoch time format.
", "RegistrationVersionStatusHistory$RevokedTimestamp": "The time when the registration was in the revoked state, in UNIX epoch time format.
", "RegistrationVersionStatusHistory$ArchivedTimestamp": "The time when the registration was in the archived state, in UNIX epoch time format.
", "ReleasePhoneNumberResult$CreatedTimestamp": "The time when the phone number was created, in UNIX epoch time format.
", "RequestPhoneNumberResult$CreatedTimestamp": "The time when the phone number was created, in UNIX epoch time format.
", "UpdatePhoneNumberResult$CreatedTimestamp": "The time when the phone number was created, in UNIX epoch time format.
", "UpdatePoolResult$CreatedTimestamp": "The time when the pool was created, in UNIX epoch time format.
", "VerifiedDestinationNumberInformation$CreatedTimestamp": "The time when the destination phone number was created, in UNIX epoch time format.
", "VerifyDestinationNumberResult$CreatedTimestamp": "The time when the destination phone number was created, in UNIX epoch time format.
" } }, "TwoWayChannelArn": { "base": null, "refs": { "CreatePoolResult$TwoWayChannelArn": "The Amazon Resource Name (ARN) of the two way channel.
", "DeletePoolResult$TwoWayChannelArn": "The Amazon Resource Name (ARN) of the TwoWayChannel.
", "PhoneNumberInformation$TwoWayChannelArn": "The Amazon Resource Name (ARN) of the two way channel.
", "PoolInformation$TwoWayChannelArn": "The Amazon Resource Name (ARN) of the two way channel.
", "ReleasePhoneNumberResult$TwoWayChannelArn": "The Amazon Resource Name (ARN) of the TwoWayChannel.
", "RequestPhoneNumberResult$TwoWayChannelArn": "The ARN used to identify the two way channel.
", "UpdatePhoneNumberRequest$TwoWayChannelArn": "The Amazon Resource Name (ARN) of the two way channel.
", "UpdatePhoneNumberResult$TwoWayChannelArn": "The Amazon Resource Name (ARN) of the two way channel.
", "UpdatePoolRequest$TwoWayChannelArn": "The Amazon Resource Name (ARN) of the two way channel.
", "UpdatePoolResult$TwoWayChannelArn": "The Amazon Resource Name (ARN) of the two way channel.
" } }, "UntagResourceRequest": { "base": null, "refs": { } }, "UntagResourceResult": { "base": null, "refs": { } }, "UpdateEventDestinationRequest": { "base": null, "refs": { } }, "UpdateEventDestinationResult": { "base": null, "refs": { } }, "UpdatePhoneNumberRequest": { "base": null, "refs": { } }, "UpdatePhoneNumberResult": { "base": null, "refs": { } }, "UpdatePoolRequest": { "base": null, "refs": { } }, "UpdatePoolResult": { "base": null, "refs": { } }, "UpdateSenderIdRequest": { "base": null, "refs": { } }, "UpdateSenderIdResult": { "base": null, "refs": { } }, "ValidationException": { "base": "A validation exception for a field.
", "refs": { } }, "ValidationExceptionField": { "base": "The field associated with the validation exception.
", "refs": { "ValidationExceptionFieldList$member": null } }, "ValidationExceptionFieldList": { "base": null, "refs": { "ValidationException$Fields": "The field that failed validation.
" } }, "ValidationExceptionReason": { "base": null, "refs": { "ValidationException$Reason": "The reason for the exception.
" } }, "VerificationChannel": { "base": null, "refs": { "SendDestinationNumberVerificationCodeRequest$VerificationChannel": "Choose to send the verification code as an SMS or voice message.
" } }, "VerificationCode": { "base": null, "refs": { "VerifyDestinationNumberRequest$VerificationCode": "The verification code that was received by the verified destination phone number.
" } }, "VerificationMessageOriginationIdentity": { "base": null, "refs": { "SendDestinationNumberVerificationCodeRequest$OriginationIdentity": "The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
" } }, "VerificationStatus": { "base": null, "refs": { "CreateVerifiedDestinationNumberResult$Status": "The status of the verified destination phone number.
PENDING: The phone number hasn't been verified yet.
VERIFIED: The phone number is verified and can receive messages.
The status of the verified destination phone number.
PENDING: The phone number hasn't been verified yet.
VERIFIED: The phone number is verified and can receive messages.
The status for being able to send messages to the phone number.
" } }, "VerifiedDestinationNumberFilter": { "base": "The filter definition for filtering verified destination phone numbers that meets a specified criteria.
", "refs": { "VerifiedDestinationNumberFilterList$member": null } }, "VerifiedDestinationNumberFilterList": { "base": null, "refs": { "DescribeVerifiedDestinationNumbersRequest$Filters": "An array of VerifiedDestinationNumberFilter objects to filter the results.
" } }, "VerifiedDestinationNumberFilterName": { "base": null, "refs": { "VerifiedDestinationNumberFilter$Name": "The name of the attribute to filter on.
" } }, "VerifiedDestinationNumberIdList": { "base": null, "refs": { "DescribeVerifiedDestinationNumbersRequest$VerifiedDestinationNumberIds": "An array of VerifiedDestinationNumberid to retreive.
" } }, "VerifiedDestinationNumberIdOrArn": { "base": null, "refs": { "DeleteVerifiedDestinationNumberRequest$VerifiedDestinationNumberId": "The unique identifier for the verified destination phone number.
", "SendDestinationNumberVerificationCodeRequest$VerifiedDestinationNumberId": "The unique identifier for the verified destination phone number.
", "VerifiedDestinationNumberIdList$member": null, "VerifyDestinationNumberRequest$VerifiedDestinationNumberId": "The unique identifier for the verififed destination phone number.
" } }, "VerifiedDestinationNumberInformation": { "base": "Provides information about the requested verified destintion phone number.
", "refs": { "VerifiedDestinationNumberInformationList$member": null } }, "VerifiedDestinationNumberInformationList": { "base": null, "refs": { "DescribeVerifiedDestinationNumbersResult$VerifiedDestinationNumbers": "An array of VerifiedDestinationNumberInformation objects
" } }, "VerifyDestinationNumberRequest": { "base": null, "refs": { } }, "VerifyDestinationNumberResult": { "base": null, "refs": { } }, "VoiceId": { "base": null, "refs": { "SendVoiceMessageRequest$VoiceId": "The voice for the Amazon Polly service to use. By default this is set to \"MATTHEW\".
" } }, "VoiceMessageBody": { "base": null, "refs": { "SendVoiceMessageRequest$MessageBody": "The text to convert to a voice message.
" } }, "VoiceMessageBodyTextType": { "base": null, "refs": { "SendVoiceMessageRequest$MessageBodyTextType": "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 3000.
SSML: When used the maximum character limit is 6000 including SSML tagging.
The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.
" } } } }