@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonPinpointSMSVoiceV2Client extends AmazonWebServiceClient implements AmazonPinpointSMSVoiceV2
Welcome to the AWS End User Messaging SMS and Voice, version 2 API Reference. This guide provides information about AWS End User Messaging 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 AWS End User Messaging SMS and Voice, version 2 API provides programmatic access to options that are unique to the SMS and voice channels. AWS End User Messaging SMS and Voice, version 2 resources such as phone numbers, sender IDs, and opt-out lists can be used by the Amazon Pinpoint API.
If you're new to AWS End User Messaging SMS and Voice, it's also helpful to review the AWS End User Messaging SMS User Guide. The AWS End User Messaging SMS User Guide provides tutorials, code samples, and procedures that demonstrate how to use AWS End User Messaging SMS and Voice features programmatically and how to integrate functionality into mobile apps and other types of applications. The guide also provides key information, such as AWS End User Messaging SMS and Voice integration with other Amazon Web Services services, and the quotas that apply to use of the service.
Regional availability
The AWS End User Messaging 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.
LOGGING_AWS_REQUEST_METRIC ENDPOINT_PREFIX addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset public static AmazonPinpointSMSVoiceV2ClientBuilder builder()
public AssociateOriginationIdentityResult associateOriginationIdentity(AssociateOriginationIdentityRequest request)
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.
associateOriginationIdentity in interface AmazonPinpointSMSVoiceV2 associateOriginationIdentityRequest - ServiceQuotaExceededException - The request would cause a service quota to be exceeded.ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.ConflictException - 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.InternalServerException - 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.public AssociateProtectConfigurationResult associateProtectConfiguration(AssociateProtectConfigurationRequest request)
Associate a protect configuration with a configuration set. This replaces the configuration sets current protect configuration. A configuration set can only be associated with one protect configuration at a time. A protect configuration can be associated with multiple configuration sets.
associateProtectConfiguration in interface AmazonPinpointSMSVoiceV2 associateProtectConfigurationRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.ConflictException - 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.InternalServerException - 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.public CreateConfigurationSetResult createConfigurationSet(CreateConfigurationSetRequest request)
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.
createConfigurationSet in interface AmazonPinpointSMSVoiceV2 createConfigurationSetRequest - ServiceQuotaExceededException - The request would cause a service quota to be exceeded.ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ValidationException - A validation exception for a field.ConflictException - 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.InternalServerException - 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.public CreateEventDestinationResult createEventDestination(CreateEventDestinationRequest request)
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 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 Firehose destination.
createEventDestination in interface AmazonPinpointSMSVoiceV2 createEventDestinationRequest - ServiceQuotaExceededException - The request would cause a service quota to be exceeded.ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.ConflictException - 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.InternalServerException - 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.public CreateOptOutListResult createOptOutList(CreateOptOutListRequest request)
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 AWS End User Messaging SMS User Guide.
createOptOutList in interface AmazonPinpointSMSVoiceV2 createOptOutListRequest - ServiceQuotaExceededException - The request would cause a service quota to be exceeded.ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ValidationException - A validation exception for a field.ConflictException - 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.InternalServerException - 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.public CreatePoolResult createPool(CreatePoolRequest request)
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.
createPool in interface AmazonPinpointSMSVoiceV2 createPoolRequest - ServiceQuotaExceededException - The request would cause a service quota to be exceeded.ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.ConflictException - 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.InternalServerException - 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.public CreateProtectConfigurationResult createProtectConfiguration(CreateProtectConfigurationRequest request)
Create a new protect configuration. By default all country rule sets for each capability are set to
ALLOW. Update the country rule sets using UpdateProtectConfigurationCountryRuleSet. A
protect configurations name is stored as a Tag with the key set to Name and value as the name of the
protect configuration.
createProtectConfiguration in interface AmazonPinpointSMSVoiceV2 createProtectConfigurationRequest - ServiceQuotaExceededException - The request would cause a service quota to be exceeded.ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ValidationException - A validation exception for a field.InternalServerException - 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.public CreateRegistrationResult createRegistration(CreateRegistrationRequest request)
Creates a new registration based on the RegistrationType field.
createRegistration in interface AmazonPinpointSMSVoiceV2 createRegistrationRequest - ServiceQuotaExceededException - The request would cause a service quota to be exceeded.ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ValidationException - A validation exception for a field.ConflictException - 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.InternalServerException - 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.public CreateRegistrationAssociationResult createRegistrationAssociation(CreateRegistrationAssociationRequest request)
Associate the registration with an origination identity such as a phone number or sender ID.
createRegistrationAssociation in interface AmazonPinpointSMSVoiceV2 createRegistrationAssociationRequest - ServiceQuotaExceededException - The request would cause a service quota to be exceeded.ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.ConflictException - 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.InternalServerException - 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.public CreateRegistrationAttachmentResult createRegistrationAttachment(CreateRegistrationAttachmentRequest request)
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.
createRegistrationAttachment in interface AmazonPinpointSMSVoiceV2 createRegistrationAttachmentRequest - ServiceQuotaExceededException - The request would cause a service quota to be exceeded.ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ValidationException - A validation exception for a field.ConflictException - 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.InternalServerException - 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.public CreateRegistrationVersionResult createRegistrationVersion(CreateRegistrationVersionRequest request)
Create a new version of the registration and increase the VersionNumber. The previous version of the registration becomes read-only.
createRegistrationVersion in interface AmazonPinpointSMSVoiceV2 createRegistrationVersionRequest - ServiceQuotaExceededException - The request would cause a service quota to be exceeded.ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.ConflictException - 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.InternalServerException - 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.public CreateVerifiedDestinationNumberResult createVerifiedDestinationNumber(CreateVerifiedDestinationNumberRequest request)
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.
createVerifiedDestinationNumber in interface AmazonPinpointSMSVoiceV2 createVerifiedDestinationNumberRequest - ServiceQuotaExceededException - The request would cause a service quota to be exceeded.ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ValidationException - A validation exception for a field.ConflictException - 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.InternalServerException - 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.public DeleteAccountDefaultProtectConfigurationResult deleteAccountDefaultProtectConfiguration(DeleteAccountDefaultProtectConfigurationRequest request)
Removes the current account default protect configuration.
deleteAccountDefaultProtectConfiguration in interface AmazonPinpointSMSVoiceV2 deleteAccountDefaultProtectConfigurationRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.InternalServerException - 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.public DeleteConfigurationSetResult deleteConfigurationSet(DeleteConfigurationSetRequest request)
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.
deleteConfigurationSet in interface AmazonPinpointSMSVoiceV2 deleteConfigurationSetRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.InternalServerException - 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.public DeleteDefaultMessageTypeResult deleteDefaultMessageType(DeleteDefaultMessageTypeRequest request)
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.
deleteDefaultMessageType in interface AmazonPinpointSMSVoiceV2 deleteDefaultMessageTypeRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.InternalServerException - 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.public DeleteDefaultSenderIdResult deleteDefaultSenderId(DeleteDefaultSenderIdRequest request)
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.
deleteDefaultSenderId in interface AmazonPinpointSMSVoiceV2 deleteDefaultSenderIdRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.InternalServerException - 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.public DeleteEventDestinationResult deleteEventDestination(DeleteEventDestinationRequest request)
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.
deleteEventDestination in interface AmazonPinpointSMSVoiceV2 deleteEventDestinationRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.InternalServerException - 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.public DeleteKeywordResult deleteKeyword(DeleteKeywordRequest request)
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, AWS End User Messaging SMS and Voice responds with a customizable message.
Keywords "HELP" and "STOP" can't be deleted or modified.
deleteKeyword in interface AmazonPinpointSMSVoiceV2 deleteKeywordRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.ConflictException - 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.InternalServerException - 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.public DeleteMediaMessageSpendLimitOverrideResult deleteMediaMessageSpendLimitOverride(DeleteMediaMessageSpendLimitOverrideRequest request)
Deletes an account-level monthly spending limit override for sending multimedia messages (MMS). 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 Quotas for Server Migration Service
in the Server Migration Service User Guide.
deleteMediaMessageSpendLimitOverride in interface AmazonPinpointSMSVoiceV2 deleteMediaMessageSpendLimitOverrideRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ValidationException - A validation exception for a field.InternalServerException - 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.public DeleteOptOutListResult deleteOptOutList(DeleteOptOutListRequest request)
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.
deleteOptOutList in interface AmazonPinpointSMSVoiceV2 deleteOptOutListRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.ConflictException - 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.InternalServerException - 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.public DeleteOptedOutNumberResult deleteOptedOutNumber(DeleteOptedOutNumberRequest request)
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.
deleteOptedOutNumber in interface AmazonPinpointSMSVoiceV2 deleteOptedOutNumberRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.ConflictException - 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.InternalServerException - 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.public DeletePoolResult deletePool(DeletePoolRequest request)
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.
deletePool in interface AmazonPinpointSMSVoiceV2 deletePoolRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.ConflictException - 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.InternalServerException - 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.public DeleteProtectConfigurationResult deleteProtectConfiguration(DeleteProtectConfigurationRequest request)
Permanently delete the protect configuration. The protect configuration must have deletion protection disabled and must not be associated as the account default protect configuration or associated with a configuration set.
deleteProtectConfiguration in interface AmazonPinpointSMSVoiceV2 deleteProtectConfigurationRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.ConflictException - 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.InternalServerException - 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.public DeleteRegistrationResult deleteRegistration(DeleteRegistrationRequest request)
Permanently delete an existing registration from your account.
deleteRegistration in interface AmazonPinpointSMSVoiceV2 deleteRegistrationRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.ConflictException - 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.InternalServerException - 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.public DeleteRegistrationAttachmentResult deleteRegistrationAttachment(DeleteRegistrationAttachmentRequest request)
Permanently delete the specified registration attachment.
deleteRegistrationAttachment in interface AmazonPinpointSMSVoiceV2 deleteRegistrationAttachmentRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.ConflictException - 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.InternalServerException - 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.public DeleteRegistrationFieldValueResult deleteRegistrationFieldValue(DeleteRegistrationFieldValueRequest request)
Delete the value in a registration form field.
deleteRegistrationFieldValue in interface AmazonPinpointSMSVoiceV2 deleteRegistrationFieldValueRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.ConflictException - 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.InternalServerException - 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.public DeleteTextMessageSpendLimitOverrideResult deleteTextMessageSpendLimitOverride(DeleteTextMessageSpendLimitOverrideRequest request)
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 Quotas in the AWS End User
Messaging SMS User Guide.
deleteTextMessageSpendLimitOverride in interface AmazonPinpointSMSVoiceV2 deleteTextMessageSpendLimitOverrideRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ValidationException - A validation exception for a field.InternalServerException - 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.public DeleteVerifiedDestinationNumberResult deleteVerifiedDestinationNumber(DeleteVerifiedDestinationNumberRequest request)
Delete a verified destination phone number.
deleteVerifiedDestinationNumber in interface AmazonPinpointSMSVoiceV2 deleteVerifiedDestinationNumberRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.ConflictException - 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.InternalServerException - 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.public DeleteVoiceMessageSpendLimitOverrideResult deleteVoiceMessageSpendLimitOverride(DeleteVoiceMessageSpendLimitOverrideRequest request)
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 Quotas in the AWS End User
Messaging SMS User Guide.
deleteVoiceMessageSpendLimitOverride in interface AmazonPinpointSMSVoiceV2 deleteVoiceMessageSpendLimitOverrideRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ValidationException - A validation exception for a field.InternalServerException - 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.public DescribeAccountAttributesResult describeAccountAttributes(DescribeAccountAttributesRequest request)
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 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.
describeAccountAttributes in interface AmazonPinpointSMSVoiceV2 describeAccountAttributesRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ValidationException - A validation exception for a field.InternalServerException - 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.public DescribeAccountLimitsResult describeAccountLimits(DescribeAccountLimitsRequest request)
Describes the current AWS End User Messaging SMS and Voice 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 Quotas in the AWS End User Messaging SMS User Guide.
describeAccountLimits in interface AmazonPinpointSMSVoiceV2 describeAccountLimitsRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ValidationException - A validation exception for a field.InternalServerException - 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.public DescribeConfigurationSetsResult describeConfigurationSets(DescribeConfigurationSetsRequest request)
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.
describeConfigurationSets in interface AmazonPinpointSMSVoiceV2 describeConfigurationSetsRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.InternalServerException - 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.public DescribeKeywordsResult describeKeywords(DescribeKeywordsRequest request)
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, AWS End User Messaging SMS and Voice responds with a customizable message.
If you specify a keyword that isn't valid, an error is returned.
describeKeywords in interface AmazonPinpointSMSVoiceV2 describeKeywordsRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.InternalServerException - 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.public DescribeOptOutListsResult describeOptOutLists(DescribeOptOutListsRequest request)
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.
describeOptOutLists in interface AmazonPinpointSMSVoiceV2 describeOptOutListsRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.InternalServerException - 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.public DescribeOptedOutNumbersResult describeOptedOutNumbers(DescribeOptedOutNumbersRequest request)
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.
describeOptedOutNumbers in interface AmazonPinpointSMSVoiceV2 describeOptedOutNumbersRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.InternalServerException - 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.public DescribePhoneNumbersResult describePhoneNumbers(DescribePhoneNumbersRequest request)
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.
describePhoneNumbers in interface AmazonPinpointSMSVoiceV2 describePhoneNumbersRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.InternalServerException - 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.public DescribePoolsResult describePools(DescribePoolsRequest request)
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.
describePools in interface AmazonPinpointSMSVoiceV2 describePoolsRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.InternalServerException - 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.public DescribeProtectConfigurationsResult describeProtectConfigurations(DescribeProtectConfigurationsRequest request)
Retrieves the protect configurations that match any of filters. If a filter isn’t provided then all protect configurations are returned.
describeProtectConfigurations in interface AmazonPinpointSMSVoiceV2 describeProtectConfigurationsRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.InternalServerException - 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.public DescribeRegistrationAttachmentsResult describeRegistrationAttachments(DescribeRegistrationAttachmentsRequest request)
Retrieves the specified registration attachments or all registration attachments associated with your Amazon Web Services account.
describeRegistrationAttachments in interface AmazonPinpointSMSVoiceV2 describeRegistrationAttachmentsRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.InternalServerException - 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.public DescribeRegistrationFieldDefinitionsResult describeRegistrationFieldDefinitions(DescribeRegistrationFieldDefinitionsRequest request)
Retrieves the specified registration type field definitions. You can use DescribeRegistrationFieldDefinitions to view the requirements for creating, filling out, and submitting each registration type.
describeRegistrationFieldDefinitions in interface AmazonPinpointSMSVoiceV2 describeRegistrationFieldDefinitionsRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ValidationException - A validation exception for a field.InternalServerException - 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.public DescribeRegistrationFieldValuesResult describeRegistrationFieldValues(DescribeRegistrationFieldValuesRequest request)
Retrieves the specified registration field values.
describeRegistrationFieldValues in interface AmazonPinpointSMSVoiceV2 describeRegistrationFieldValuesRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.InternalServerException - 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.public DescribeRegistrationSectionDefinitionsResult describeRegistrationSectionDefinitions(DescribeRegistrationSectionDefinitionsRequest request)
Retrieves the specified registration section definitions. You can use DescribeRegistrationSectionDefinitions to view the requirements for creating, filling out, and submitting each registration type.
describeRegistrationSectionDefinitions in interface AmazonPinpointSMSVoiceV2 describeRegistrationSectionDefinitionsRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ValidationException - A validation exception for a field.InternalServerException - 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.public DescribeRegistrationTypeDefinitionsResult describeRegistrationTypeDefinitions(DescribeRegistrationTypeDefinitionsRequest request)
Retrieves the specified registration type definitions. You can use DescribeRegistrationTypeDefinitions to view the requirements for creating, filling out, and submitting each registration type.
describeRegistrationTypeDefinitions in interface AmazonPinpointSMSVoiceV2 describeRegistrationTypeDefinitionsRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ValidationException - A validation exception for a field.InternalServerException - 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.public DescribeRegistrationVersionsResult describeRegistrationVersions(DescribeRegistrationVersionsRequest request)
Retrieves the specified registration version.
describeRegistrationVersions in interface AmazonPinpointSMSVoiceV2 describeRegistrationVersionsRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.InternalServerException - 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.public DescribeRegistrationsResult describeRegistrations(DescribeRegistrationsRequest request)
Retrieves the specified registrations.
describeRegistrations in interface AmazonPinpointSMSVoiceV2 describeRegistrationsRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.InternalServerException - 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.public DescribeSenderIdsResult describeSenderIds(DescribeSenderIdsRequest request)
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.
describeSenderIds in interface AmazonPinpointSMSVoiceV2 describeSenderIdsRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.InternalServerException - 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.public DescribeSpendLimitsResult describeSpendLimits(DescribeSpendLimitsRequest request)
Describes the current 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, MMS, or Voice spending quota in the AWS End User Messaging SMS User Guide.
describeSpendLimits in interface AmazonPinpointSMSVoiceV2 describeSpendLimitsRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ValidationException - A validation exception for a field.InternalServerException - 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.public DescribeVerifiedDestinationNumbersResult describeVerifiedDestinationNumbers(DescribeVerifiedDestinationNumbersRequest request)
Retrieves the specified verified destiona numbers.
describeVerifiedDestinationNumbers in interface AmazonPinpointSMSVoiceV2 describeVerifiedDestinationNumbersRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.InternalServerException - 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.public DisassociateOriginationIdentityResult disassociateOriginationIdentity(DisassociateOriginationIdentityRequest request)
Removes the specified origination identity from an existing pool.
If the origination identity isn't associated with the specified pool, an error is returned.
disassociateOriginationIdentity in interface AmazonPinpointSMSVoiceV2 disassociateOriginationIdentityRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.ConflictException - 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.InternalServerException - 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.public DisassociateProtectConfigurationResult disassociateProtectConfiguration(DisassociateProtectConfigurationRequest request)
Disassociate a protect configuration from a configuration set.
disassociateProtectConfiguration in interface AmazonPinpointSMSVoiceV2 disassociateProtectConfigurationRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.ConflictException - 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.InternalServerException - 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.public DiscardRegistrationVersionResult discardRegistrationVersion(DiscardRegistrationVersionRequest request)
Discard the current version of the registration.
discardRegistrationVersion in interface AmazonPinpointSMSVoiceV2 discardRegistrationVersionRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.ConflictException - 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.InternalServerException - 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.public GetProtectConfigurationCountryRuleSetResult getProtectConfigurationCountryRuleSet(GetProtectConfigurationCountryRuleSetRequest request)
Retrieve the CountryRuleSet for the specified NumberCapability from a protect configuration.
getProtectConfigurationCountryRuleSet in interface AmazonPinpointSMSVoiceV2 getProtectConfigurationCountryRuleSetRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.InternalServerException - 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.public ListPoolOriginationIdentitiesResult listPoolOriginationIdentities(ListPoolOriginationIdentitiesRequest request)
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.
listPoolOriginationIdentities in interface AmazonPinpointSMSVoiceV2 listPoolOriginationIdentitiesRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.InternalServerException - 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.public ListRegistrationAssociationsResult listRegistrationAssociations(ListRegistrationAssociationsRequest request)
Retreive all of the origination identies that are associated with a registration.
listRegistrationAssociations in interface AmazonPinpointSMSVoiceV2 listRegistrationAssociationsRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.InternalServerException - 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.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
List all tags associated with a resource.
listTagsForResource in interface AmazonPinpointSMSVoiceV2 listTagsForResourceRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.InternalServerException - 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.public PutKeywordResult putKeyword(PutKeywordRequest request)
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, AWS End User Messaging SMS and Voice responds with a customizable message.
If you specify a keyword that isn't valid, an error is returned.
putKeyword in interface AmazonPinpointSMSVoiceV2 putKeywordRequest - ServiceQuotaExceededException - The request would cause a service quota to be exceeded.ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.ConflictException - 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.InternalServerException - 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.public PutOptedOutNumberResult putOptedOutNumber(PutOptedOutNumberRequest request)
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.
putOptedOutNumber in interface AmazonPinpointSMSVoiceV2 putOptedOutNumberRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.InternalServerException - 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.public PutRegistrationFieldValueResult putRegistrationFieldValue(PutRegistrationFieldValueRequest request)
Creates or updates a field value for a registration.
putRegistrationFieldValue in interface AmazonPinpointSMSVoiceV2 putRegistrationFieldValueRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.ConflictException - 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.InternalServerException - 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.public ReleasePhoneNumberResult releasePhoneNumber(ReleasePhoneNumberRequest request)
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.
releasePhoneNumber in interface AmazonPinpointSMSVoiceV2 releasePhoneNumberRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.ConflictException - 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.InternalServerException - 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.public ReleaseSenderIdResult releaseSenderId(ReleaseSenderIdRequest request)
Releases an existing sender ID in your account.
releaseSenderId in interface AmazonPinpointSMSVoiceV2 releaseSenderIdRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.ConflictException - 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.InternalServerException - 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.public RequestPhoneNumberResult requestPhoneNumber(RequestPhoneNumberRequest request)
Request an origination phone number for use in your account. For more information on phone number request see Request a phone number in the AWS End User Messaging SMS User Guide.
requestPhoneNumber in interface AmazonPinpointSMSVoiceV2 requestPhoneNumberRequest - ServiceQuotaExceededException - The request would cause a service quota to be exceeded.ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.ConflictException - 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.InternalServerException - 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.public RequestSenderIdResult requestSenderId(RequestSenderIdRequest request)
Request a new sender ID that doesn't require registration.
requestSenderId in interface AmazonPinpointSMSVoiceV2 requestSenderIdRequest - ServiceQuotaExceededException - The request would cause a service quota to be exceeded.ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ValidationException - A validation exception for a field.ConflictException - 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.InternalServerException - 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.public SendDestinationNumberVerificationCodeResult sendDestinationNumberVerificationCode(SendDestinationNumberVerificationCodeRequest request)
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.
sendDestinationNumberVerificationCode in interface AmazonPinpointSMSVoiceV2 sendDestinationNumberVerificationCodeRequest - ServiceQuotaExceededException - The request would cause a service quota to be exceeded.ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.ConflictException - 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.InternalServerException - 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.public SendMediaMessageResult sendMediaMessage(SendMediaMessageRequest request)
Creates a new multimedia message (MMS) and sends it to a recipient's phone number.
sendMediaMessage in interface AmazonPinpointSMSVoiceV2 sendMediaMessageRequest - ServiceQuotaExceededException - The request would cause a service quota to be exceeded.ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.ConflictException - 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.InternalServerException - 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.public SendTextMessageResult sendTextMessage(SendTextMessageRequest request)
Creates a new text message and sends it to a recipient's phone number. SendTextMessage only sends an SMS message to one recipient each time it is invoked.
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 about MPS, see Message Parts per Second (MPS) limits in the AWS End User Messaging SMS User Guide.
sendTextMessage in interface AmazonPinpointSMSVoiceV2 sendTextMessageRequest - ServiceQuotaExceededException - The request would cause a service quota to be exceeded.ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.ConflictException - 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.InternalServerException - 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.public SendVoiceMessageResult sendVoiceMessage(SendVoiceMessageRequest request)
Allows you to send a request that sends a voice message. This operation uses Amazon Polly to convert a text script into a voice message.
sendVoiceMessage in interface AmazonPinpointSMSVoiceV2 sendVoiceMessageRequest - ServiceQuotaExceededException - The request would cause a service quota to be exceeded.ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.ConflictException - 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.InternalServerException - 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.public SetAccountDefaultProtectConfigurationResult setAccountDefaultProtectConfiguration(SetAccountDefaultProtectConfigurationRequest request)
Set a protect configuration as your account default. You can only have one account default protect configuration at a time. The current account default protect configuration is replaced with the provided protect configuration.
setAccountDefaultProtectConfiguration in interface AmazonPinpointSMSVoiceV2 setAccountDefaultProtectConfigurationRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.InternalServerException - 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.public SetDefaultMessageTypeResult setDefaultMessageType(SetDefaultMessageTypeRequest request)
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.
setDefaultMessageType in interface AmazonPinpointSMSVoiceV2 setDefaultMessageTypeRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.InternalServerException - 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.public SetDefaultSenderIdResult setDefaultSenderId(SetDefaultSenderIdRequest request)
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.
setDefaultSenderId in interface AmazonPinpointSMSVoiceV2 setDefaultSenderIdRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.InternalServerException - 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.public SetMediaMessageSpendLimitOverrideResult setMediaMessageSpendLimitOverride(SetMediaMessageSpendLimitOverrideRequest request)
Sets an account level monthly spend limit override for sending MMS messages. The requested spend limit must be
less than or equal to the MaxLimit, which is set by Amazon Web Services.
setMediaMessageSpendLimitOverride in interface AmazonPinpointSMSVoiceV2 setMediaMessageSpendLimitOverrideRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ValidationException - A validation exception for a field.InternalServerException - 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.public SetTextMessageSpendLimitOverrideResult setTextMessageSpendLimitOverride(SetTextMessageSpendLimitOverrideRequest request)
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.
setTextMessageSpendLimitOverride in interface AmazonPinpointSMSVoiceV2 setTextMessageSpendLimitOverrideRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ValidationException - A validation exception for a field.InternalServerException - 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.public SetVoiceMessageSpendLimitOverrideResult setVoiceMessageSpendLimitOverride(SetVoiceMessageSpendLimitOverrideRequest request)
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.
setVoiceMessageSpendLimitOverride in interface AmazonPinpointSMSVoiceV2 setVoiceMessageSpendLimitOverrideRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ValidationException - A validation exception for a field.InternalServerException - 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.public SubmitRegistrationVersionResult submitRegistrationVersion(SubmitRegistrationVersionRequest request)
Submit the specified registration for review and approval.
submitRegistrationVersion in interface AmazonPinpointSMSVoiceV2 submitRegistrationVersionRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.ConflictException - 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.InternalServerException - 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.public TagResourceResult tagResource(TagResourceRequest request)
Adds or overwrites only the specified tags for the specified 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 Tags in the AWS End User Messaging SMS User Guide.
tagResource in interface AmazonPinpointSMSVoiceV2 tagResourceRequest - ServiceQuotaExceededException - The request would cause a service quota to be exceeded.ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.InternalServerException - 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.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes the association of the specified tags from a resource. For more information on tags see Tags in the AWS End User Messaging SMS User Guide.
untagResource in interface AmazonPinpointSMSVoiceV2 untagResourceRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.InternalServerException - 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.public UpdateEventDestinationResult updateEventDestination(UpdateEventDestinationRequest request)
Updates an existing event destination in a configuration set. You can update the IAM role ARN for CloudWatch Logs and 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, Firehose, and Amazon SNS.
updateEventDestination in interface AmazonPinpointSMSVoiceV2 updateEventDestinationRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.ConflictException - 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.InternalServerException - 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.public UpdatePhoneNumberResult updatePhoneNumber(UpdatePhoneNumberRequest request)
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.
updatePhoneNumber in interface AmazonPinpointSMSVoiceV2 updatePhoneNumberRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.ConflictException - 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.InternalServerException - 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.public UpdatePoolResult updatePool(UpdatePoolRequest request)
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.
updatePool in interface AmazonPinpointSMSVoiceV2 updatePoolRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.ConflictException - 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.InternalServerException - 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.public UpdateProtectConfigurationResult updateProtectConfiguration(UpdateProtectConfigurationRequest request)
Update the setting for an existing protect configuration.
updateProtectConfiguration in interface AmazonPinpointSMSVoiceV2 updateProtectConfigurationRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.InternalServerException - 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.public UpdateProtectConfigurationCountryRuleSetResult updateProtectConfigurationCountryRuleSet(UpdateProtectConfigurationCountryRuleSetRequest request)
Update a country rule set to ALLOW or BLOCK messages to be sent to the specified
destination counties. You can update one or multiple countries at a time. The updates are only applied to the
specified NumberCapability type.
updateProtectConfigurationCountryRuleSet in interface AmazonPinpointSMSVoiceV2 updateProtectConfigurationCountryRuleSetRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.InternalServerException - 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.public UpdateSenderIdResult updateSenderId(UpdateSenderIdRequest request)
Updates the configuration of an existing sender ID.
updateSenderId in interface AmazonPinpointSMSVoiceV2 updateSenderIdRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.InternalServerException - 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.public VerifyDestinationNumberResult verifyDestinationNumber(VerifyDestinationNumberRequest request)
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.
verifyDestinationNumber in interface AmazonPinpointSMSVoiceV2 verifyDestinationNumberRequest - ThrottlingException - An error that occurred because too many requests were sent during a certain amount of time.AccessDeniedException - The request was denied because you don't have sufficient permissions to access the resource.ResourceNotFoundException - A requested resource couldn't be found.ValidationException - A validation exception for a field.ConflictException - 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.InternalServerException - 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.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata in interface AmazonPinpointSMSVoiceV2 request - The originally executed requestpublic void shutdown()
AmazonWebServiceClient shutdown in interface AmazonPinpointSMSVoiceV2 shutdown in class AmazonWebServiceClient