@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonPinpointSMSVoiceV2AsyncClient extends AmazonPinpointSMSVoiceV2Client implements AmazonPinpointSMSVoiceV2Async
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
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_METRICENDPOINT_PREFIXassociateOriginationIdentity, associateProtectConfiguration, builder, createConfigurationSet, createEventDestination, createOptOutList, createPool, createProtectConfiguration, createRegistration, createRegistrationAssociation, createRegistrationAttachment, createRegistrationVersion, createVerifiedDestinationNumber, deleteAccountDefaultProtectConfiguration, deleteConfigurationSet, deleteDefaultMessageType, deleteDefaultSenderId, deleteEventDestination, deleteKeyword, deleteMediaMessageSpendLimitOverride, deleteOptedOutNumber, deleteOptOutList, deletePool, deleteProtectConfiguration, deleteRegistration, deleteRegistrationAttachment, deleteRegistrationFieldValue, deleteTextMessageSpendLimitOverride, deleteVerifiedDestinationNumber, deleteVoiceMessageSpendLimitOverride, describeAccountAttributes, describeAccountLimits, describeConfigurationSets, describeKeywords, describeOptedOutNumbers, describeOptOutLists, describePhoneNumbers, describePools, describeProtectConfigurations, describeRegistrationAttachments, describeRegistrationFieldDefinitions, describeRegistrationFieldValues, describeRegistrations, describeRegistrationSectionDefinitions, describeRegistrationTypeDefinitions, describeRegistrationVersions, describeSenderIds, describeSpendLimits, describeVerifiedDestinationNumbers, disassociateOriginationIdentity, disassociateProtectConfiguration, discardRegistrationVersion, getCachedResponseMetadata, getProtectConfigurationCountryRuleSet, listPoolOriginationIdentities, listRegistrationAssociations, listTagsForResource, putKeyword, putOptedOutNumber, putRegistrationFieldValue, releasePhoneNumber, releaseSenderId, requestPhoneNumber, requestSenderId, sendDestinationNumberVerificationCode, sendMediaMessage, sendTextMessage, sendVoiceMessage, setAccountDefaultProtectConfiguration, setDefaultMessageType, setDefaultSenderId, setMediaMessageSpendLimitOverride, setTextMessageSpendLimitOverride, setVoiceMessageSpendLimitOverride, submitRegistrationVersion, tagResource, untagResource, updateEventDestination, updatePhoneNumber, updatePool, updateProtectConfiguration, updateProtectConfigurationCountryRuleSet, updateSenderId, verifyDestinationNumberaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitassociateOriginationIdentity, associateProtectConfiguration, createConfigurationSet, createEventDestination, createOptOutList, createPool, createProtectConfiguration, createRegistration, createRegistrationAssociation, createRegistrationAttachment, createRegistrationVersion, createVerifiedDestinationNumber, deleteAccountDefaultProtectConfiguration, deleteConfigurationSet, deleteDefaultMessageType, deleteDefaultSenderId, deleteEventDestination, deleteKeyword, deleteMediaMessageSpendLimitOverride, deleteOptedOutNumber, deleteOptOutList, deletePool, deleteProtectConfiguration, deleteRegistration, deleteRegistrationAttachment, deleteRegistrationFieldValue, deleteTextMessageSpendLimitOverride, deleteVerifiedDestinationNumber, deleteVoiceMessageSpendLimitOverride, describeAccountAttributes, describeAccountLimits, describeConfigurationSets, describeKeywords, describeOptedOutNumbers, describeOptOutLists, describePhoneNumbers, describePools, describeProtectConfigurations, describeRegistrationAttachments, describeRegistrationFieldDefinitions, describeRegistrationFieldValues, describeRegistrations, describeRegistrationSectionDefinitions, describeRegistrationTypeDefinitions, describeRegistrationVersions, describeSenderIds, describeSpendLimits, describeVerifiedDestinationNumbers, disassociateOriginationIdentity, disassociateProtectConfiguration, discardRegistrationVersion, getCachedResponseMetadata, getProtectConfigurationCountryRuleSet, listPoolOriginationIdentities, listRegistrationAssociations, listTagsForResource, putKeyword, putOptedOutNumber, putRegistrationFieldValue, releasePhoneNumber, releaseSenderId, requestPhoneNumber, requestSenderId, sendDestinationNumberVerificationCode, sendMediaMessage, sendTextMessage, sendVoiceMessage, setAccountDefaultProtectConfiguration, setDefaultMessageType, setDefaultSenderId, setMediaMessageSpendLimitOverride, setTextMessageSpendLimitOverride, setVoiceMessageSpendLimitOverride, submitRegistrationVersion, tagResource, untagResource, updateEventDestination, updatePhoneNumber, updatePool, updateProtectConfiguration, updateProtectConfigurationCountryRuleSet, updateSenderId, verifyDestinationNumberpublic static AmazonPinpointSMSVoiceV2AsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<AssociateOriginationIdentityResult> associateOriginationIdentityAsync(AssociateOriginationIdentityRequest request)
AmazonPinpointSMSVoiceV2AsyncAssociates 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.
associateOriginationIdentityAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<AssociateOriginationIdentityResult> associateOriginationIdentityAsync(AssociateOriginationIdentityRequest request, AsyncHandler<AssociateOriginationIdentityRequest,AssociateOriginationIdentityResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncAssociates 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.
associateOriginationIdentityAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AssociateProtectConfigurationResult> associateProtectConfigurationAsync(AssociateProtectConfigurationRequest request)
AmazonPinpointSMSVoiceV2AsyncAssociate 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.
associateProtectConfigurationAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<AssociateProtectConfigurationResult> associateProtectConfigurationAsync(AssociateProtectConfigurationRequest request, AsyncHandler<AssociateProtectConfigurationRequest,AssociateProtectConfigurationResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncAssociate 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.
associateProtectConfigurationAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateConfigurationSetResult> createConfigurationSetAsync(CreateConfigurationSetRequest request)
AmazonPinpointSMSVoiceV2AsyncCreates 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.
createConfigurationSetAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<CreateConfigurationSetResult> createConfigurationSetAsync(CreateConfigurationSetRequest request, AsyncHandler<CreateConfigurationSetRequest,CreateConfigurationSetResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncCreates 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.
createConfigurationSetAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateEventDestinationResult> createEventDestinationAsync(CreateEventDestinationRequest request)
AmazonPinpointSMSVoiceV2AsyncCreates 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.
createEventDestinationAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<CreateEventDestinationResult> createEventDestinationAsync(CreateEventDestinationRequest request, AsyncHandler<CreateEventDestinationRequest,CreateEventDestinationResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncCreates 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.
createEventDestinationAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateOptOutListResult> createOptOutListAsync(CreateOptOutListRequest request)
AmazonPinpointSMSVoiceV2AsyncCreates 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.
createOptOutListAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<CreateOptOutListResult> createOptOutListAsync(CreateOptOutListRequest request, AsyncHandler<CreateOptOutListRequest,CreateOptOutListResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncCreates 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.
createOptOutListAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreatePoolResult> createPoolAsync(CreatePoolRequest request)
AmazonPinpointSMSVoiceV2AsyncCreates 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.
createPoolAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<CreatePoolResult> createPoolAsync(CreatePoolRequest request, AsyncHandler<CreatePoolRequest,CreatePoolResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncCreates 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.
createPoolAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateProtectConfigurationResult> createProtectConfigurationAsync(CreateProtectConfigurationRequest request)
AmazonPinpointSMSVoiceV2Async
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.
createProtectConfigurationAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<CreateProtectConfigurationResult> createProtectConfigurationAsync(CreateProtectConfigurationRequest request, AsyncHandler<CreateProtectConfigurationRequest,CreateProtectConfigurationResult> asyncHandler)
AmazonPinpointSMSVoiceV2Async
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.
createProtectConfigurationAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateRegistrationResult> createRegistrationAsync(CreateRegistrationRequest request)
AmazonPinpointSMSVoiceV2AsyncCreates a new registration based on the RegistrationType field.
createRegistrationAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<CreateRegistrationResult> createRegistrationAsync(CreateRegistrationRequest request, AsyncHandler<CreateRegistrationRequest,CreateRegistrationResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncCreates a new registration based on the RegistrationType field.
createRegistrationAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateRegistrationAssociationResult> createRegistrationAssociationAsync(CreateRegistrationAssociationRequest request)
AmazonPinpointSMSVoiceV2AsyncAssociate the registration with an origination identity such as a phone number or sender ID.
createRegistrationAssociationAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<CreateRegistrationAssociationResult> createRegistrationAssociationAsync(CreateRegistrationAssociationRequest request, AsyncHandler<CreateRegistrationAssociationRequest,CreateRegistrationAssociationResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncAssociate the registration with an origination identity such as a phone number or sender ID.
createRegistrationAssociationAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateRegistrationAttachmentResult> createRegistrationAttachmentAsync(CreateRegistrationAttachmentRequest request)
AmazonPinpointSMSVoiceV2AsyncCreate 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.
createRegistrationAttachmentAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<CreateRegistrationAttachmentResult> createRegistrationAttachmentAsync(CreateRegistrationAttachmentRequest request, AsyncHandler<CreateRegistrationAttachmentRequest,CreateRegistrationAttachmentResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncCreate 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.
createRegistrationAttachmentAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateRegistrationVersionResult> createRegistrationVersionAsync(CreateRegistrationVersionRequest request)
AmazonPinpointSMSVoiceV2AsyncCreate a new version of the registration and increase the VersionNumber. The previous version of the registration becomes read-only.
createRegistrationVersionAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<CreateRegistrationVersionResult> createRegistrationVersionAsync(CreateRegistrationVersionRequest request, AsyncHandler<CreateRegistrationVersionRequest,CreateRegistrationVersionResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncCreate a new version of the registration and increase the VersionNumber. The previous version of the registration becomes read-only.
createRegistrationVersionAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateVerifiedDestinationNumberResult> createVerifiedDestinationNumberAsync(CreateVerifiedDestinationNumberRequest request)
AmazonPinpointSMSVoiceV2AsyncYou can only send messages to verified destination numbers when your account is in the sandbox. You can add up to 10 verified destination numbers.
createVerifiedDestinationNumberAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<CreateVerifiedDestinationNumberResult> createVerifiedDestinationNumberAsync(CreateVerifiedDestinationNumberRequest request, AsyncHandler<CreateVerifiedDestinationNumberRequest,CreateVerifiedDestinationNumberResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncYou can only send messages to verified destination numbers when your account is in the sandbox. You can add up to 10 verified destination numbers.
createVerifiedDestinationNumberAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteAccountDefaultProtectConfigurationResult> deleteAccountDefaultProtectConfigurationAsync(DeleteAccountDefaultProtectConfigurationRequest request)
AmazonPinpointSMSVoiceV2AsyncRemoves the current account default protect configuration.
deleteAccountDefaultProtectConfigurationAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DeleteAccountDefaultProtectConfigurationResult> deleteAccountDefaultProtectConfigurationAsync(DeleteAccountDefaultProtectConfigurationRequest request, AsyncHandler<DeleteAccountDefaultProtectConfigurationRequest,DeleteAccountDefaultProtectConfigurationResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncRemoves the current account default protect configuration.
deleteAccountDefaultProtectConfigurationAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteConfigurationSetResult> deleteConfigurationSetAsync(DeleteConfigurationSetRequest request)
AmazonPinpointSMSVoiceV2AsyncDeletes 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.
deleteConfigurationSetAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DeleteConfigurationSetResult> deleteConfigurationSetAsync(DeleteConfigurationSetRequest request, AsyncHandler<DeleteConfigurationSetRequest,DeleteConfigurationSetResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncDeletes 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.
deleteConfigurationSetAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteDefaultMessageTypeResult> deleteDefaultMessageTypeAsync(DeleteDefaultMessageTypeRequest request)
AmazonPinpointSMSVoiceV2AsyncDeletes 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.
deleteDefaultMessageTypeAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DeleteDefaultMessageTypeResult> deleteDefaultMessageTypeAsync(DeleteDefaultMessageTypeRequest request, AsyncHandler<DeleteDefaultMessageTypeRequest,DeleteDefaultMessageTypeResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncDeletes 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.
deleteDefaultMessageTypeAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteDefaultSenderIdResult> deleteDefaultSenderIdAsync(DeleteDefaultSenderIdRequest request)
AmazonPinpointSMSVoiceV2AsyncDeletes 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.
deleteDefaultSenderIdAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DeleteDefaultSenderIdResult> deleteDefaultSenderIdAsync(DeleteDefaultSenderIdRequest request, AsyncHandler<DeleteDefaultSenderIdRequest,DeleteDefaultSenderIdResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncDeletes 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.
deleteDefaultSenderIdAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteEventDestinationResult> deleteEventDestinationAsync(DeleteEventDestinationRequest request)
AmazonPinpointSMSVoiceV2AsyncDeletes 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.
deleteEventDestinationAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DeleteEventDestinationResult> deleteEventDestinationAsync(DeleteEventDestinationRequest request, AsyncHandler<DeleteEventDestinationRequest,DeleteEventDestinationResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncDeletes 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.
deleteEventDestinationAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteKeywordResult> deleteKeywordAsync(DeleteKeywordRequest request)
AmazonPinpointSMSVoiceV2AsyncDeletes 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.
deleteKeywordAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DeleteKeywordResult> deleteKeywordAsync(DeleteKeywordRequest request, AsyncHandler<DeleteKeywordRequest,DeleteKeywordResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncDeletes 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.
deleteKeywordAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteMediaMessageSpendLimitOverrideResult> deleteMediaMessageSpendLimitOverrideAsync(DeleteMediaMessageSpendLimitOverrideRequest request)
AmazonPinpointSMSVoiceV2Async
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.
deleteMediaMessageSpendLimitOverrideAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DeleteMediaMessageSpendLimitOverrideResult> deleteMediaMessageSpendLimitOverrideAsync(DeleteMediaMessageSpendLimitOverrideRequest request, AsyncHandler<DeleteMediaMessageSpendLimitOverrideRequest,DeleteMediaMessageSpendLimitOverrideResult> asyncHandler)
AmazonPinpointSMSVoiceV2Async
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.
deleteMediaMessageSpendLimitOverrideAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteOptOutListResult> deleteOptOutListAsync(DeleteOptOutListRequest request)
AmazonPinpointSMSVoiceV2AsyncDeletes 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.
deleteOptOutListAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DeleteOptOutListResult> deleteOptOutListAsync(DeleteOptOutListRequest request, AsyncHandler<DeleteOptOutListRequest,DeleteOptOutListResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncDeletes 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.
deleteOptOutListAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteOptedOutNumberResult> deleteOptedOutNumberAsync(DeleteOptedOutNumberRequest request)
AmazonPinpointSMSVoiceV2AsyncDeletes 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.
deleteOptedOutNumberAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DeleteOptedOutNumberResult> deleteOptedOutNumberAsync(DeleteOptedOutNumberRequest request, AsyncHandler<DeleteOptedOutNumberRequest,DeleteOptedOutNumberResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncDeletes 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.
deleteOptedOutNumberAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeletePoolResult> deletePoolAsync(DeletePoolRequest request)
AmazonPinpointSMSVoiceV2AsyncDeletes 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.
deletePoolAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DeletePoolResult> deletePoolAsync(DeletePoolRequest request, AsyncHandler<DeletePoolRequest,DeletePoolResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncDeletes 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.
deletePoolAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteProtectConfigurationResult> deleteProtectConfigurationAsync(DeleteProtectConfigurationRequest request)
AmazonPinpointSMSVoiceV2AsyncPermanently 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.
deleteProtectConfigurationAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DeleteProtectConfigurationResult> deleteProtectConfigurationAsync(DeleteProtectConfigurationRequest request, AsyncHandler<DeleteProtectConfigurationRequest,DeleteProtectConfigurationResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncPermanently 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.
deleteProtectConfigurationAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteRegistrationResult> deleteRegistrationAsync(DeleteRegistrationRequest request)
AmazonPinpointSMSVoiceV2AsyncPermanently delete an existing registration from your account.
deleteRegistrationAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DeleteRegistrationResult> deleteRegistrationAsync(DeleteRegistrationRequest request, AsyncHandler<DeleteRegistrationRequest,DeleteRegistrationResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncPermanently delete an existing registration from your account.
deleteRegistrationAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteRegistrationAttachmentResult> deleteRegistrationAttachmentAsync(DeleteRegistrationAttachmentRequest request)
AmazonPinpointSMSVoiceV2AsyncPermanently delete the specified registration attachment.
deleteRegistrationAttachmentAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DeleteRegistrationAttachmentResult> deleteRegistrationAttachmentAsync(DeleteRegistrationAttachmentRequest request, AsyncHandler<DeleteRegistrationAttachmentRequest,DeleteRegistrationAttachmentResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncPermanently delete the specified registration attachment.
deleteRegistrationAttachmentAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteRegistrationFieldValueResult> deleteRegistrationFieldValueAsync(DeleteRegistrationFieldValueRequest request)
AmazonPinpointSMSVoiceV2AsyncDelete the value in a registration form field.
deleteRegistrationFieldValueAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DeleteRegistrationFieldValueResult> deleteRegistrationFieldValueAsync(DeleteRegistrationFieldValueRequest request, AsyncHandler<DeleteRegistrationFieldValueRequest,DeleteRegistrationFieldValueResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncDelete the value in a registration form field.
deleteRegistrationFieldValueAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteTextMessageSpendLimitOverrideResult> deleteTextMessageSpendLimitOverrideAsync(DeleteTextMessageSpendLimitOverrideRequest request)
AmazonPinpointSMSVoiceV2Async
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.
deleteTextMessageSpendLimitOverrideAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DeleteTextMessageSpendLimitOverrideResult> deleteTextMessageSpendLimitOverrideAsync(DeleteTextMessageSpendLimitOverrideRequest request, AsyncHandler<DeleteTextMessageSpendLimitOverrideRequest,DeleteTextMessageSpendLimitOverrideResult> asyncHandler)
AmazonPinpointSMSVoiceV2Async
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.
deleteTextMessageSpendLimitOverrideAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteVerifiedDestinationNumberResult> deleteVerifiedDestinationNumberAsync(DeleteVerifiedDestinationNumberRequest request)
AmazonPinpointSMSVoiceV2AsyncDelete a verified destination phone number.
deleteVerifiedDestinationNumberAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DeleteVerifiedDestinationNumberResult> deleteVerifiedDestinationNumberAsync(DeleteVerifiedDestinationNumberRequest request, AsyncHandler<DeleteVerifiedDestinationNumberRequest,DeleteVerifiedDestinationNumberResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncDelete a verified destination phone number.
deleteVerifiedDestinationNumberAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteVoiceMessageSpendLimitOverrideResult> deleteVoiceMessageSpendLimitOverrideAsync(DeleteVoiceMessageSpendLimitOverrideRequest request)
AmazonPinpointSMSVoiceV2Async
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.
deleteVoiceMessageSpendLimitOverrideAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DeleteVoiceMessageSpendLimitOverrideResult> deleteVoiceMessageSpendLimitOverrideAsync(DeleteVoiceMessageSpendLimitOverrideRequest request, AsyncHandler<DeleteVoiceMessageSpendLimitOverrideRequest,DeleteVoiceMessageSpendLimitOverrideResult> asyncHandler)
AmazonPinpointSMSVoiceV2Async
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.
deleteVoiceMessageSpendLimitOverrideAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeAccountAttributesResult> describeAccountAttributesAsync(DescribeAccountAttributesRequest request)
AmazonPinpointSMSVoiceV2AsyncDescribes 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.
describeAccountAttributesAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DescribeAccountAttributesResult> describeAccountAttributesAsync(DescribeAccountAttributesRequest request, AsyncHandler<DescribeAccountAttributesRequest,DescribeAccountAttributesResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncDescribes 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.
describeAccountAttributesAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeAccountLimitsResult> describeAccountLimitsAsync(DescribeAccountLimitsRequest request)
AmazonPinpointSMSVoiceV2AsyncDescribes 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.
describeAccountLimitsAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DescribeAccountLimitsResult> describeAccountLimitsAsync(DescribeAccountLimitsRequest request, AsyncHandler<DescribeAccountLimitsRequest,DescribeAccountLimitsResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncDescribes 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.
describeAccountLimitsAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeConfigurationSetsResult> describeConfigurationSetsAsync(DescribeConfigurationSetsRequest request)
AmazonPinpointSMSVoiceV2AsyncDescribes 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.
describeConfigurationSetsAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DescribeConfigurationSetsResult> describeConfigurationSetsAsync(DescribeConfigurationSetsRequest request, AsyncHandler<DescribeConfigurationSetsRequest,DescribeConfigurationSetsResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncDescribes 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.
describeConfigurationSetsAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeKeywordsResult> describeKeywordsAsync(DescribeKeywordsRequest request)
AmazonPinpointSMSVoiceV2AsyncDescribes 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.
describeKeywordsAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DescribeKeywordsResult> describeKeywordsAsync(DescribeKeywordsRequest request, AsyncHandler<DescribeKeywordsRequest,DescribeKeywordsResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncDescribes 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.
describeKeywordsAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeOptOutListsResult> describeOptOutListsAsync(DescribeOptOutListsRequest request)
AmazonPinpointSMSVoiceV2AsyncDescribes 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.
describeOptOutListsAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DescribeOptOutListsResult> describeOptOutListsAsync(DescribeOptOutListsRequest request, AsyncHandler<DescribeOptOutListsRequest,DescribeOptOutListsResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncDescribes 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.
describeOptOutListsAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeOptedOutNumbersResult> describeOptedOutNumbersAsync(DescribeOptedOutNumbersRequest request)
AmazonPinpointSMSVoiceV2AsyncDescribes 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.
describeOptedOutNumbersAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DescribeOptedOutNumbersResult> describeOptedOutNumbersAsync(DescribeOptedOutNumbersRequest request, AsyncHandler<DescribeOptedOutNumbersRequest,DescribeOptedOutNumbersResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncDescribes 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.
describeOptedOutNumbersAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribePhoneNumbersResult> describePhoneNumbersAsync(DescribePhoneNumbersRequest request)
AmazonPinpointSMSVoiceV2AsyncDescribes 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.
describePhoneNumbersAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DescribePhoneNumbersResult> describePhoneNumbersAsync(DescribePhoneNumbersRequest request, AsyncHandler<DescribePhoneNumbersRequest,DescribePhoneNumbersResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncDescribes 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.
describePhoneNumbersAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribePoolsResult> describePoolsAsync(DescribePoolsRequest request)
AmazonPinpointSMSVoiceV2AsyncRetrieves 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.
describePoolsAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DescribePoolsResult> describePoolsAsync(DescribePoolsRequest request, AsyncHandler<DescribePoolsRequest,DescribePoolsResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncRetrieves 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.
describePoolsAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeProtectConfigurationsResult> describeProtectConfigurationsAsync(DescribeProtectConfigurationsRequest request)
AmazonPinpointSMSVoiceV2AsyncRetrieves the protect configurations that match any of filters. If a filter isn’t provided then all protect configurations are returned.
describeProtectConfigurationsAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DescribeProtectConfigurationsResult> describeProtectConfigurationsAsync(DescribeProtectConfigurationsRequest request, AsyncHandler<DescribeProtectConfigurationsRequest,DescribeProtectConfigurationsResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncRetrieves the protect configurations that match any of filters. If a filter isn’t provided then all protect configurations are returned.
describeProtectConfigurationsAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeRegistrationAttachmentsResult> describeRegistrationAttachmentsAsync(DescribeRegistrationAttachmentsRequest request)
AmazonPinpointSMSVoiceV2AsyncRetrieves the specified registration attachments or all registration attachments associated with your Amazon Web Services account.
describeRegistrationAttachmentsAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DescribeRegistrationAttachmentsResult> describeRegistrationAttachmentsAsync(DescribeRegistrationAttachmentsRequest request, AsyncHandler<DescribeRegistrationAttachmentsRequest,DescribeRegistrationAttachmentsResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncRetrieves the specified registration attachments or all registration attachments associated with your Amazon Web Services account.
describeRegistrationAttachmentsAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeRegistrationFieldDefinitionsResult> describeRegistrationFieldDefinitionsAsync(DescribeRegistrationFieldDefinitionsRequest request)
AmazonPinpointSMSVoiceV2AsyncRetrieves the specified registration type field definitions. You can use DescribeRegistrationFieldDefinitions to view the requirements for creating, filling out, and submitting each registration type.
describeRegistrationFieldDefinitionsAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DescribeRegistrationFieldDefinitionsResult> describeRegistrationFieldDefinitionsAsync(DescribeRegistrationFieldDefinitionsRequest request, AsyncHandler<DescribeRegistrationFieldDefinitionsRequest,DescribeRegistrationFieldDefinitionsResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncRetrieves the specified registration type field definitions. You can use DescribeRegistrationFieldDefinitions to view the requirements for creating, filling out, and submitting each registration type.
describeRegistrationFieldDefinitionsAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeRegistrationFieldValuesResult> describeRegistrationFieldValuesAsync(DescribeRegistrationFieldValuesRequest request)
AmazonPinpointSMSVoiceV2AsyncRetrieves the specified registration field values.
describeRegistrationFieldValuesAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DescribeRegistrationFieldValuesResult> describeRegistrationFieldValuesAsync(DescribeRegistrationFieldValuesRequest request, AsyncHandler<DescribeRegistrationFieldValuesRequest,DescribeRegistrationFieldValuesResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncRetrieves the specified registration field values.
describeRegistrationFieldValuesAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeRegistrationSectionDefinitionsResult> describeRegistrationSectionDefinitionsAsync(DescribeRegistrationSectionDefinitionsRequest request)
AmazonPinpointSMSVoiceV2AsyncRetrieves the specified registration section definitions. You can use DescribeRegistrationSectionDefinitions to view the requirements for creating, filling out, and submitting each registration type.
describeRegistrationSectionDefinitionsAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DescribeRegistrationSectionDefinitionsResult> describeRegistrationSectionDefinitionsAsync(DescribeRegistrationSectionDefinitionsRequest request, AsyncHandler<DescribeRegistrationSectionDefinitionsRequest,DescribeRegistrationSectionDefinitionsResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncRetrieves the specified registration section definitions. You can use DescribeRegistrationSectionDefinitions to view the requirements for creating, filling out, and submitting each registration type.
describeRegistrationSectionDefinitionsAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeRegistrationTypeDefinitionsResult> describeRegistrationTypeDefinitionsAsync(DescribeRegistrationTypeDefinitionsRequest request)
AmazonPinpointSMSVoiceV2AsyncRetrieves the specified registration type definitions. You can use DescribeRegistrationTypeDefinitions to view the requirements for creating, filling out, and submitting each registration type.
describeRegistrationTypeDefinitionsAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DescribeRegistrationTypeDefinitionsResult> describeRegistrationTypeDefinitionsAsync(DescribeRegistrationTypeDefinitionsRequest request, AsyncHandler<DescribeRegistrationTypeDefinitionsRequest,DescribeRegistrationTypeDefinitionsResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncRetrieves the specified registration type definitions. You can use DescribeRegistrationTypeDefinitions to view the requirements for creating, filling out, and submitting each registration type.
describeRegistrationTypeDefinitionsAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeRegistrationVersionsResult> describeRegistrationVersionsAsync(DescribeRegistrationVersionsRequest request)
AmazonPinpointSMSVoiceV2AsyncRetrieves the specified registration version.
describeRegistrationVersionsAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DescribeRegistrationVersionsResult> describeRegistrationVersionsAsync(DescribeRegistrationVersionsRequest request, AsyncHandler<DescribeRegistrationVersionsRequest,DescribeRegistrationVersionsResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncRetrieves the specified registration version.
describeRegistrationVersionsAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeRegistrationsResult> describeRegistrationsAsync(DescribeRegistrationsRequest request)
AmazonPinpointSMSVoiceV2AsyncRetrieves the specified registrations.
describeRegistrationsAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DescribeRegistrationsResult> describeRegistrationsAsync(DescribeRegistrationsRequest request, AsyncHandler<DescribeRegistrationsRequest,DescribeRegistrationsResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncRetrieves the specified registrations.
describeRegistrationsAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeSenderIdsResult> describeSenderIdsAsync(DescribeSenderIdsRequest request)
AmazonPinpointSMSVoiceV2AsyncDescribes 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.
describeSenderIdsAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DescribeSenderIdsResult> describeSenderIdsAsync(DescribeSenderIdsRequest request, AsyncHandler<DescribeSenderIdsRequest,DescribeSenderIdsResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncDescribes 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.
describeSenderIdsAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeSpendLimitsResult> describeSpendLimitsAsync(DescribeSpendLimitsRequest request)
AmazonPinpointSMSVoiceV2AsyncDescribes 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.
describeSpendLimitsAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DescribeSpendLimitsResult> describeSpendLimitsAsync(DescribeSpendLimitsRequest request, AsyncHandler<DescribeSpendLimitsRequest,DescribeSpendLimitsResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncDescribes 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.
describeSpendLimitsAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeVerifiedDestinationNumbersResult> describeVerifiedDestinationNumbersAsync(DescribeVerifiedDestinationNumbersRequest request)
AmazonPinpointSMSVoiceV2AsyncRetrieves the specified verified destiona numbers.
describeVerifiedDestinationNumbersAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DescribeVerifiedDestinationNumbersResult> describeVerifiedDestinationNumbersAsync(DescribeVerifiedDestinationNumbersRequest request, AsyncHandler<DescribeVerifiedDestinationNumbersRequest,DescribeVerifiedDestinationNumbersResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncRetrieves the specified verified destiona numbers.
describeVerifiedDestinationNumbersAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DisassociateOriginationIdentityResult> disassociateOriginationIdentityAsync(DisassociateOriginationIdentityRequest request)
AmazonPinpointSMSVoiceV2AsyncRemoves the specified origination identity from an existing pool.
If the origination identity isn't associated with the specified pool, an error is returned.
disassociateOriginationIdentityAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DisassociateOriginationIdentityResult> disassociateOriginationIdentityAsync(DisassociateOriginationIdentityRequest request, AsyncHandler<DisassociateOriginationIdentityRequest,DisassociateOriginationIdentityResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncRemoves the specified origination identity from an existing pool.
If the origination identity isn't associated with the specified pool, an error is returned.
disassociateOriginationIdentityAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DisassociateProtectConfigurationResult> disassociateProtectConfigurationAsync(DisassociateProtectConfigurationRequest request)
AmazonPinpointSMSVoiceV2AsyncDisassociate a protect configuration from a configuration set.
disassociateProtectConfigurationAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DisassociateProtectConfigurationResult> disassociateProtectConfigurationAsync(DisassociateProtectConfigurationRequest request, AsyncHandler<DisassociateProtectConfigurationRequest,DisassociateProtectConfigurationResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncDisassociate a protect configuration from a configuration set.
disassociateProtectConfigurationAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DiscardRegistrationVersionResult> discardRegistrationVersionAsync(DiscardRegistrationVersionRequest request)
AmazonPinpointSMSVoiceV2AsyncDiscard the current version of the registration.
discardRegistrationVersionAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<DiscardRegistrationVersionResult> discardRegistrationVersionAsync(DiscardRegistrationVersionRequest request, AsyncHandler<DiscardRegistrationVersionRequest,DiscardRegistrationVersionResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncDiscard the current version of the registration.
discardRegistrationVersionAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetProtectConfigurationCountryRuleSetResult> getProtectConfigurationCountryRuleSetAsync(GetProtectConfigurationCountryRuleSetRequest request)
AmazonPinpointSMSVoiceV2AsyncRetrieve the CountryRuleSet for the specified NumberCapability from a protect configuration.
getProtectConfigurationCountryRuleSetAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<GetProtectConfigurationCountryRuleSetResult> getProtectConfigurationCountryRuleSetAsync(GetProtectConfigurationCountryRuleSetRequest request, AsyncHandler<GetProtectConfigurationCountryRuleSetRequest,GetProtectConfigurationCountryRuleSetResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncRetrieve the CountryRuleSet for the specified NumberCapability from a protect configuration.
getProtectConfigurationCountryRuleSetAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListPoolOriginationIdentitiesResult> listPoolOriginationIdentitiesAsync(ListPoolOriginationIdentitiesRequest request)
AmazonPinpointSMSVoiceV2AsyncLists 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.
listPoolOriginationIdentitiesAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<ListPoolOriginationIdentitiesResult> listPoolOriginationIdentitiesAsync(ListPoolOriginationIdentitiesRequest request, AsyncHandler<ListPoolOriginationIdentitiesRequest,ListPoolOriginationIdentitiesResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncLists 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.
listPoolOriginationIdentitiesAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListRegistrationAssociationsResult> listRegistrationAssociationsAsync(ListRegistrationAssociationsRequest request)
AmazonPinpointSMSVoiceV2AsyncRetreive all of the origination identies that are associated with a registration.
listRegistrationAssociationsAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<ListRegistrationAssociationsResult> listRegistrationAssociationsAsync(ListRegistrationAssociationsRequest request, AsyncHandler<ListRegistrationAssociationsRequest,ListRegistrationAssociationsResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncRetreive all of the origination identies that are associated with a registration.
listRegistrationAssociationsAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AmazonPinpointSMSVoiceV2AsyncList all tags associated with a resource.
listTagsForResourceAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncList all tags associated with a resource.
listTagsForResourceAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutKeywordResult> putKeywordAsync(PutKeywordRequest request)
AmazonPinpointSMSVoiceV2AsyncCreates 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.
putKeywordAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<PutKeywordResult> putKeywordAsync(PutKeywordRequest request, AsyncHandler<PutKeywordRequest,PutKeywordResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncCreates 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.
putKeywordAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutOptedOutNumberResult> putOptedOutNumberAsync(PutOptedOutNumberRequest request)
AmazonPinpointSMSVoiceV2AsyncCreates 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.
putOptedOutNumberAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<PutOptedOutNumberResult> putOptedOutNumberAsync(PutOptedOutNumberRequest request, AsyncHandler<PutOptedOutNumberRequest,PutOptedOutNumberResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncCreates 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.
putOptedOutNumberAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutRegistrationFieldValueResult> putRegistrationFieldValueAsync(PutRegistrationFieldValueRequest request)
AmazonPinpointSMSVoiceV2AsyncCreates or updates a field value for a registration.
putRegistrationFieldValueAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<PutRegistrationFieldValueResult> putRegistrationFieldValueAsync(PutRegistrationFieldValueRequest request, AsyncHandler<PutRegistrationFieldValueRequest,PutRegistrationFieldValueResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncCreates or updates a field value for a registration.
putRegistrationFieldValueAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ReleasePhoneNumberResult> releasePhoneNumberAsync(ReleasePhoneNumberRequest request)
AmazonPinpointSMSVoiceV2AsyncReleases 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.
releasePhoneNumberAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<ReleasePhoneNumberResult> releasePhoneNumberAsync(ReleasePhoneNumberRequest request, AsyncHandler<ReleasePhoneNumberRequest,ReleasePhoneNumberResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncReleases 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.
releasePhoneNumberAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ReleaseSenderIdResult> releaseSenderIdAsync(ReleaseSenderIdRequest request)
AmazonPinpointSMSVoiceV2AsyncReleases an existing sender ID in your account.
releaseSenderIdAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<ReleaseSenderIdResult> releaseSenderIdAsync(ReleaseSenderIdRequest request, AsyncHandler<ReleaseSenderIdRequest,ReleaseSenderIdResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncReleases an existing sender ID in your account.
releaseSenderIdAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<RequestPhoneNumberResult> requestPhoneNumberAsync(RequestPhoneNumberRequest request)
AmazonPinpointSMSVoiceV2AsyncRequest 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.
requestPhoneNumberAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<RequestPhoneNumberResult> requestPhoneNumberAsync(RequestPhoneNumberRequest request, AsyncHandler<RequestPhoneNumberRequest,RequestPhoneNumberResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncRequest 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.
requestPhoneNumberAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<RequestSenderIdResult> requestSenderIdAsync(RequestSenderIdRequest request)
AmazonPinpointSMSVoiceV2AsyncRequest a new sender ID that doesn't require registration.
requestSenderIdAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<RequestSenderIdResult> requestSenderIdAsync(RequestSenderIdRequest request, AsyncHandler<RequestSenderIdRequest,RequestSenderIdResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncRequest a new sender ID that doesn't require registration.
requestSenderIdAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SendDestinationNumberVerificationCodeResult> sendDestinationNumberVerificationCodeAsync(SendDestinationNumberVerificationCodeRequest request)
AmazonPinpointSMSVoiceV2AsyncBefore 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.
sendDestinationNumberVerificationCodeAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<SendDestinationNumberVerificationCodeResult> sendDestinationNumberVerificationCodeAsync(SendDestinationNumberVerificationCodeRequest request, AsyncHandler<SendDestinationNumberVerificationCodeRequest,SendDestinationNumberVerificationCodeResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncBefore 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.
sendDestinationNumberVerificationCodeAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SendMediaMessageResult> sendMediaMessageAsync(SendMediaMessageRequest request)
AmazonPinpointSMSVoiceV2AsyncCreates a new multimedia message (MMS) and sends it to a recipient's phone number.
sendMediaMessageAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<SendMediaMessageResult> sendMediaMessageAsync(SendMediaMessageRequest request, AsyncHandler<SendMediaMessageRequest,SendMediaMessageResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncCreates a new multimedia message (MMS) and sends it to a recipient's phone number.
sendMediaMessageAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SendTextMessageResult> sendTextMessageAsync(SendTextMessageRequest request)
AmazonPinpointSMSVoiceV2AsyncCreates 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.
sendTextMessageAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<SendTextMessageResult> sendTextMessageAsync(SendTextMessageRequest request, AsyncHandler<SendTextMessageRequest,SendTextMessageResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncCreates 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.
sendTextMessageAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SendVoiceMessageResult> sendVoiceMessageAsync(SendVoiceMessageRequest request)
AmazonPinpointSMSVoiceV2AsyncAllows you to send a request that sends a voice message. This operation uses Amazon Polly to convert a text script into a voice message.
sendVoiceMessageAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<SendVoiceMessageResult> sendVoiceMessageAsync(SendVoiceMessageRequest request, AsyncHandler<SendVoiceMessageRequest,SendVoiceMessageResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncAllows you to send a request that sends a voice message. This operation uses Amazon Polly to convert a text script into a voice message.
sendVoiceMessageAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SetAccountDefaultProtectConfigurationResult> setAccountDefaultProtectConfigurationAsync(SetAccountDefaultProtectConfigurationRequest request)
AmazonPinpointSMSVoiceV2AsyncSet 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.
setAccountDefaultProtectConfigurationAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<SetAccountDefaultProtectConfigurationResult> setAccountDefaultProtectConfigurationAsync(SetAccountDefaultProtectConfigurationRequest request, AsyncHandler<SetAccountDefaultProtectConfigurationRequest,SetAccountDefaultProtectConfigurationResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncSet 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.
setAccountDefaultProtectConfigurationAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SetDefaultMessageTypeResult> setDefaultMessageTypeAsync(SetDefaultMessageTypeRequest request)
AmazonPinpointSMSVoiceV2AsyncSets 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.
setDefaultMessageTypeAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<SetDefaultMessageTypeResult> setDefaultMessageTypeAsync(SetDefaultMessageTypeRequest request, AsyncHandler<SetDefaultMessageTypeRequest,SetDefaultMessageTypeResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncSets 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.
setDefaultMessageTypeAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SetDefaultSenderIdResult> setDefaultSenderIdAsync(SetDefaultSenderIdRequest request)
AmazonPinpointSMSVoiceV2AsyncSets 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.
setDefaultSenderIdAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<SetDefaultSenderIdResult> setDefaultSenderIdAsync(SetDefaultSenderIdRequest request, AsyncHandler<SetDefaultSenderIdRequest,SetDefaultSenderIdResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncSets 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.
setDefaultSenderIdAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SetMediaMessageSpendLimitOverrideResult> setMediaMessageSpendLimitOverrideAsync(SetMediaMessageSpendLimitOverrideRequest request)
AmazonPinpointSMSVoiceV2Async
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.
setMediaMessageSpendLimitOverrideAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<SetMediaMessageSpendLimitOverrideResult> setMediaMessageSpendLimitOverrideAsync(SetMediaMessageSpendLimitOverrideRequest request, AsyncHandler<SetMediaMessageSpendLimitOverrideRequest,SetMediaMessageSpendLimitOverrideResult> asyncHandler)
AmazonPinpointSMSVoiceV2Async
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.
setMediaMessageSpendLimitOverrideAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SetTextMessageSpendLimitOverrideResult> setTextMessageSpendLimitOverrideAsync(SetTextMessageSpendLimitOverrideRequest request)
AmazonPinpointSMSVoiceV2Async
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.
setTextMessageSpendLimitOverrideAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<SetTextMessageSpendLimitOverrideResult> setTextMessageSpendLimitOverrideAsync(SetTextMessageSpendLimitOverrideRequest request, AsyncHandler<SetTextMessageSpendLimitOverrideRequest,SetTextMessageSpendLimitOverrideResult> asyncHandler)
AmazonPinpointSMSVoiceV2Async
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.
setTextMessageSpendLimitOverrideAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SetVoiceMessageSpendLimitOverrideResult> setVoiceMessageSpendLimitOverrideAsync(SetVoiceMessageSpendLimitOverrideRequest request)
AmazonPinpointSMSVoiceV2Async
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.
setVoiceMessageSpendLimitOverrideAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<SetVoiceMessageSpendLimitOverrideResult> setVoiceMessageSpendLimitOverrideAsync(SetVoiceMessageSpendLimitOverrideRequest request, AsyncHandler<SetVoiceMessageSpendLimitOverrideRequest,SetVoiceMessageSpendLimitOverrideResult> asyncHandler)
AmazonPinpointSMSVoiceV2Async
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.
setVoiceMessageSpendLimitOverrideAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SubmitRegistrationVersionResult> submitRegistrationVersionAsync(SubmitRegistrationVersionRequest request)
AmazonPinpointSMSVoiceV2AsyncSubmit the specified registration for review and approval.
submitRegistrationVersionAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<SubmitRegistrationVersionResult> submitRegistrationVersionAsync(SubmitRegistrationVersionRequest request, AsyncHandler<SubmitRegistrationVersionRequest,SubmitRegistrationVersionResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncSubmit the specified registration for review and approval.
submitRegistrationVersionAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AmazonPinpointSMSVoiceV2AsyncAdds 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.
tagResourceAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncAdds 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.
tagResourceAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AmazonPinpointSMSVoiceV2AsyncRemoves 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.
untagResourceAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncRemoves 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.
untagResourceAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateEventDestinationResult> updateEventDestinationAsync(UpdateEventDestinationRequest request)
AmazonPinpointSMSVoiceV2AsyncUpdates 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.
updateEventDestinationAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<UpdateEventDestinationResult> updateEventDestinationAsync(UpdateEventDestinationRequest request, AsyncHandler<UpdateEventDestinationRequest,UpdateEventDestinationResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncUpdates 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.
updateEventDestinationAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdatePhoneNumberResult> updatePhoneNumberAsync(UpdatePhoneNumberRequest request)
AmazonPinpointSMSVoiceV2AsyncUpdates 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.
updatePhoneNumberAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<UpdatePhoneNumberResult> updatePhoneNumberAsync(UpdatePhoneNumberRequest request, AsyncHandler<UpdatePhoneNumberRequest,UpdatePhoneNumberResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncUpdates 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.
updatePhoneNumberAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdatePoolResult> updatePoolAsync(UpdatePoolRequest request)
AmazonPinpointSMSVoiceV2Async
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.
updatePoolAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<UpdatePoolResult> updatePoolAsync(UpdatePoolRequest request, AsyncHandler<UpdatePoolRequest,UpdatePoolResult> asyncHandler)
AmazonPinpointSMSVoiceV2Async
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.
updatePoolAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateProtectConfigurationResult> updateProtectConfigurationAsync(UpdateProtectConfigurationRequest request)
AmazonPinpointSMSVoiceV2AsyncUpdate the setting for an existing protect configuration.
updateProtectConfigurationAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<UpdateProtectConfigurationResult> updateProtectConfigurationAsync(UpdateProtectConfigurationRequest request, AsyncHandler<UpdateProtectConfigurationRequest,UpdateProtectConfigurationResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncUpdate the setting for an existing protect configuration.
updateProtectConfigurationAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateProtectConfigurationCountryRuleSetResult> updateProtectConfigurationCountryRuleSetAsync(UpdateProtectConfigurationCountryRuleSetRequest request)
AmazonPinpointSMSVoiceV2Async
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.
updateProtectConfigurationCountryRuleSetAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<UpdateProtectConfigurationCountryRuleSetResult> updateProtectConfigurationCountryRuleSetAsync(UpdateProtectConfigurationCountryRuleSetRequest request, AsyncHandler<UpdateProtectConfigurationCountryRuleSetRequest,UpdateProtectConfigurationCountryRuleSetResult> asyncHandler)
AmazonPinpointSMSVoiceV2Async
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.
updateProtectConfigurationCountryRuleSetAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateSenderIdResult> updateSenderIdAsync(UpdateSenderIdRequest request)
AmazonPinpointSMSVoiceV2AsyncUpdates the configuration of an existing sender ID.
updateSenderIdAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<UpdateSenderIdResult> updateSenderIdAsync(UpdateSenderIdRequest request, AsyncHandler<UpdateSenderIdRequest,UpdateSenderIdResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncUpdates the configuration of an existing sender ID.
updateSenderIdAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<VerifyDestinationNumberResult> verifyDestinationNumberAsync(VerifyDestinationNumberRequest request)
AmazonPinpointSMSVoiceV2AsyncUse the verification code that was received by the verified destination phone number to opt-in the verified destination phone number to receive more messages.
verifyDestinationNumberAsync in interface AmazonPinpointSMSVoiceV2Asyncpublic Future<VerifyDestinationNumberResult> verifyDestinationNumberAsync(VerifyDestinationNumberRequest request, AsyncHandler<VerifyDestinationNumberRequest,VerifyDestinationNumberResult> asyncHandler)
AmazonPinpointSMSVoiceV2AsyncUse the verification code that was received by the verified destination phone number to opt-in the verified destination phone number to receive more messages.
verifyDestinationNumberAsync in interface AmazonPinpointSMSVoiceV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AmazonPinpointSMSVoiceV2shutdown in class AmazonPinpointSMSVoiceV2Client