@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonPinpointSMSVoiceV2Async extends AmazonPinpointSMSVoiceV2
AsyncHandler can be used to
receive notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonPinpointSMSVoiceV2Async instead.
Welcome to the Amazon Pinpoint SMS and Voice, version 2 API Reference. This guide provides information about Amazon Pinpoint SMS and Voice, version 2 API resources, including supported HTTP methods, parameters, and schemas.
Amazon Pinpoint is an Amazon Web Services service that you can use to engage with your recipients across multiple messaging channels. The Amazon Pinpoint SMS and Voice, version 2 API provides programmatic access to options that are unique to the SMS and voice channels. Amazon Pinpoint 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 Amazon Pinpoint SMS, it's also helpful to review the Amazon Pinpoint SMS User Guide. The Amazon Pinpoint Developer Guide provides tutorials, code samples, and procedures that demonstrate how to use Amazon Pinpoint SMS features programmatically and how to integrate Amazon Pinpoint functionality into mobile apps and other types of applications. The guide also provides key information, such as Amazon Pinpoint integration with other Amazon Web Services services, and the quotas that apply to use of the service.
Regional availability
The Amazon Pinpoint SMS and Voice, version 2 API Reference is available in several Amazon Web Services Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see Amazon Web Services Service Endpoints and Amazon Pinpoint endpoints and quotas in the Amazon Web Services General Reference. To learn more about Amazon Web Services Regions, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference.
In each Region, Amazon Web Services maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see Amazon Web Services Global Infrastructure.
ENDPOINT_PREFIXassociateOriginationIdentity, 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, shutdown, submitRegistrationVersion, tagResource, untagResource, updateEventDestination, updatePhoneNumber, updatePool, updateProtectConfiguration, updateProtectConfigurationCountryRuleSet, updateSenderId, verifyDestinationNumberFuture<AssociateOriginationIdentityResult> associateOriginationIdentityAsync(AssociateOriginationIdentityRequest associateOriginationIdentityRequest)
Associates the specified origination identity with a pool.
If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.
If the origination identity configuration doesn't match the pool's configuration, an error is returned.
associateOriginationIdentityRequest - Future<AssociateOriginationIdentityResult> associateOriginationIdentityAsync(AssociateOriginationIdentityRequest associateOriginationIdentityRequest, AsyncHandler<AssociateOriginationIdentityRequest,AssociateOriginationIdentityResult> asyncHandler)
Associates the specified origination identity with a pool.
If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.
If the origination identity configuration doesn't match the pool's configuration, an error is returned.
associateOriginationIdentityRequest - asyncHandler - 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.Future<AssociateProtectConfigurationResult> associateProtectConfigurationAsync(AssociateProtectConfigurationRequest associateProtectConfigurationRequest)
Associate a protect configuration with a configuration set. This replaces the configuration sets current protect configuration. A configuration set can only be associated with one protect configuration at a time. A protect configuration can be associated with multiple configuration sets.
associateProtectConfigurationRequest - Future<AssociateProtectConfigurationResult> associateProtectConfigurationAsync(AssociateProtectConfigurationRequest associateProtectConfigurationRequest, AsyncHandler<AssociateProtectConfigurationRequest,AssociateProtectConfigurationResult> asyncHandler)
Associate a protect configuration with a configuration set. This replaces the configuration sets current protect configuration. A configuration set can only be associated with one protect configuration at a time. A protect configuration can be associated with multiple configuration sets.
associateProtectConfigurationRequest - asyncHandler - 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.Future<CreateConfigurationSetResult> createConfigurationSetAsync(CreateConfigurationSetRequest createConfigurationSetRequest)
Creates a new configuration set. After you create the configuration set, you can add one or more event destinations to it.
A configuration set is a set of rules that you apply to the SMS and voice messages that you send.
When you send a message, you can optionally specify a single configuration set.
createConfigurationSetRequest - Future<CreateConfigurationSetResult> createConfigurationSetAsync(CreateConfigurationSetRequest createConfigurationSetRequest, AsyncHandler<CreateConfigurationSetRequest,CreateConfigurationSetResult> asyncHandler)
Creates a new configuration set. After you create the configuration set, you can add one or more event destinations to it.
A configuration set is a set of rules that you apply to the SMS and voice messages that you send.
When you send a message, you can optionally specify a single configuration set.
createConfigurationSetRequest - asyncHandler - 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.Future<CreateEventDestinationResult> createEventDestinationAsync(CreateEventDestinationRequest createEventDestinationRequest)
Creates a new event destination in a configuration set.
An event destination is a location where you send message events. The event options are Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS. For example, when a message is delivered successfully, you can send information about that event to an event destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.
Each configuration set can contain between 0 and 5 event destinations. Each event destination can contain a reference to a single destination, such as a CloudWatch or Kinesis Data Firehose destination.
createEventDestinationRequest - Future<CreateEventDestinationResult> createEventDestinationAsync(CreateEventDestinationRequest createEventDestinationRequest, AsyncHandler<CreateEventDestinationRequest,CreateEventDestinationResult> asyncHandler)
Creates a new event destination in a configuration set.
An event destination is a location where you send message events. The event options are Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS. For example, when a message is delivered successfully, you can send information about that event to an event destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.
Each configuration set can contain between 0 and 5 event destinations. Each event destination can contain a reference to a single destination, such as a CloudWatch or Kinesis Data Firehose destination.
createEventDestinationRequest - asyncHandler - 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.Future<CreateOptOutListResult> createOptOutListAsync(CreateOptOutListRequest createOptOutListRequest)
Creates a new opt-out list.
If the opt-out list name already exists, an error is returned.
An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the Amazon Pinpoint User Guide.
createOptOutListRequest - Future<CreateOptOutListResult> createOptOutListAsync(CreateOptOutListRequest createOptOutListRequest, AsyncHandler<CreateOptOutListRequest,CreateOptOutListResult> asyncHandler)
Creates a new opt-out list.
If the opt-out list name already exists, an error is returned.
An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the Amazon Pinpoint User Guide.
createOptOutListRequest - asyncHandler - 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.Future<CreatePoolResult> createPoolAsync(CreatePoolRequest createPoolRequest)
Creates a new pool and associates the specified origination identity to the pool. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
The new pool inherits its configuration from the specified origination identity. This includes keywords, message type, opt-out list, two-way configuration, and self-managed opt-out configuration. Deletion protection isn't inherited from the origination identity and defaults to false.
If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.
createPoolRequest - Future<CreatePoolResult> createPoolAsync(CreatePoolRequest createPoolRequest, AsyncHandler<CreatePoolRequest,CreatePoolResult> asyncHandler)
Creates a new pool and associates the specified origination identity to the pool. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
The new pool inherits its configuration from the specified origination identity. This includes keywords, message type, opt-out list, two-way configuration, and self-managed opt-out configuration. Deletion protection isn't inherited from the origination identity and defaults to false.
If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.
createPoolRequest - asyncHandler - 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.Future<CreateProtectConfigurationResult> createProtectConfigurationAsync(CreateProtectConfigurationRequest createProtectConfigurationRequest)
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.
createProtectConfigurationRequest - Future<CreateProtectConfigurationResult> createProtectConfigurationAsync(CreateProtectConfigurationRequest createProtectConfigurationRequest, AsyncHandler<CreateProtectConfigurationRequest,CreateProtectConfigurationResult> asyncHandler)
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.
createProtectConfigurationRequest - asyncHandler - 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.Future<CreateRegistrationResult> createRegistrationAsync(CreateRegistrationRequest createRegistrationRequest)
Creates a new registration based on the RegistrationType field.
createRegistrationRequest - Future<CreateRegistrationResult> createRegistrationAsync(CreateRegistrationRequest createRegistrationRequest, AsyncHandler<CreateRegistrationRequest,CreateRegistrationResult> asyncHandler)
Creates a new registration based on the RegistrationType field.
createRegistrationRequest - asyncHandler - 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.Future<CreateRegistrationAssociationResult> createRegistrationAssociationAsync(CreateRegistrationAssociationRequest createRegistrationAssociationRequest)
Associate the registration with an origination identity such as a phone number or sender ID.
createRegistrationAssociationRequest - Future<CreateRegistrationAssociationResult> createRegistrationAssociationAsync(CreateRegistrationAssociationRequest createRegistrationAssociationRequest, AsyncHandler<CreateRegistrationAssociationRequest,CreateRegistrationAssociationResult> asyncHandler)
Associate the registration with an origination identity such as a phone number or sender ID.
createRegistrationAssociationRequest - asyncHandler - 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.Future<CreateRegistrationAttachmentResult> createRegistrationAttachmentAsync(CreateRegistrationAttachmentRequest createRegistrationAttachmentRequest)
Create a new registration attachment to use for uploading a file or a URL to a file. The maximum file size is 1MiB and valid file extensions are PDF, JPEG and PNG. For example, many sender ID registrations require a signed “letter of authorization” (LOA) to be submitted.
createRegistrationAttachmentRequest - Future<CreateRegistrationAttachmentResult> createRegistrationAttachmentAsync(CreateRegistrationAttachmentRequest createRegistrationAttachmentRequest, AsyncHandler<CreateRegistrationAttachmentRequest,CreateRegistrationAttachmentResult> asyncHandler)
Create a new registration attachment to use for uploading a file or a URL to a file. The maximum file size is 1MiB and valid file extensions are PDF, JPEG and PNG. For example, many sender ID registrations require a signed “letter of authorization” (LOA) to be submitted.
createRegistrationAttachmentRequest - asyncHandler - 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.Future<CreateRegistrationVersionResult> createRegistrationVersionAsync(CreateRegistrationVersionRequest createRegistrationVersionRequest)
Create a new version of the registration and increase the VersionNumber. The previous version of the registration becomes read-only.
createRegistrationVersionRequest - Future<CreateRegistrationVersionResult> createRegistrationVersionAsync(CreateRegistrationVersionRequest createRegistrationVersionRequest, AsyncHandler<CreateRegistrationVersionRequest,CreateRegistrationVersionResult> asyncHandler)
Create a new version of the registration and increase the VersionNumber. The previous version of the registration becomes read-only.
createRegistrationVersionRequest - asyncHandler - 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.Future<CreateVerifiedDestinationNumberResult> createVerifiedDestinationNumberAsync(CreateVerifiedDestinationNumberRequest createVerifiedDestinationNumberRequest)
You can only send messages to verified destination numbers when your account is in the sandbox. You can add up to 10 verified destination numbers.
createVerifiedDestinationNumberRequest - Future<CreateVerifiedDestinationNumberResult> createVerifiedDestinationNumberAsync(CreateVerifiedDestinationNumberRequest createVerifiedDestinationNumberRequest, AsyncHandler<CreateVerifiedDestinationNumberRequest,CreateVerifiedDestinationNumberResult> asyncHandler)
You can only send messages to verified destination numbers when your account is in the sandbox. You can add up to 10 verified destination numbers.
createVerifiedDestinationNumberRequest - asyncHandler - 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.Future<DeleteAccountDefaultProtectConfigurationResult> deleteAccountDefaultProtectConfigurationAsync(DeleteAccountDefaultProtectConfigurationRequest deleteAccountDefaultProtectConfigurationRequest)
Removes the current account default protect configuration.
deleteAccountDefaultProtectConfigurationRequest - Future<DeleteAccountDefaultProtectConfigurationResult> deleteAccountDefaultProtectConfigurationAsync(DeleteAccountDefaultProtectConfigurationRequest deleteAccountDefaultProtectConfigurationRequest, AsyncHandler<DeleteAccountDefaultProtectConfigurationRequest,DeleteAccountDefaultProtectConfigurationResult> asyncHandler)
Removes the current account default protect configuration.
deleteAccountDefaultProtectConfigurationRequest - asyncHandler - 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.Future<DeleteConfigurationSetResult> deleteConfigurationSetAsync(DeleteConfigurationSetRequest deleteConfigurationSetRequest)
Deletes an existing configuration set.
A configuration set is a set of rules that you apply to voice and SMS messages that you send. In a configuration set, you can specify a destination for specific types of events related to voice and SMS messages.
deleteConfigurationSetRequest - Future<DeleteConfigurationSetResult> deleteConfigurationSetAsync(DeleteConfigurationSetRequest deleteConfigurationSetRequest, AsyncHandler<DeleteConfigurationSetRequest,DeleteConfigurationSetResult> asyncHandler)
Deletes an existing configuration set.
A configuration set is a set of rules that you apply to voice and SMS messages that you send. In a configuration set, you can specify a destination for specific types of events related to voice and SMS messages.
deleteConfigurationSetRequest - asyncHandler - 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.Future<DeleteDefaultMessageTypeResult> deleteDefaultMessageTypeAsync(DeleteDefaultMessageTypeRequest deleteDefaultMessageTypeRequest)
Deletes an existing default message type on a configuration set.
A message type is a type of messages that you plan to send. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.
deleteDefaultMessageTypeRequest - Future<DeleteDefaultMessageTypeResult> deleteDefaultMessageTypeAsync(DeleteDefaultMessageTypeRequest deleteDefaultMessageTypeRequest, AsyncHandler<DeleteDefaultMessageTypeRequest,DeleteDefaultMessageTypeResult> asyncHandler)
Deletes an existing default message type on a configuration set.
A message type is a type of messages that you plan to send. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.
deleteDefaultMessageTypeRequest - asyncHandler - 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.Future<DeleteDefaultSenderIdResult> deleteDefaultSenderIdAsync(DeleteDefaultSenderIdRequest deleteDefaultSenderIdRequest)
Deletes an existing default sender ID on a configuration set.
A default sender ID is the identity that appears on recipients' devices when they receive SMS messages. Support for sender ID capabilities varies by country or region.
deleteDefaultSenderIdRequest - Future<DeleteDefaultSenderIdResult> deleteDefaultSenderIdAsync(DeleteDefaultSenderIdRequest deleteDefaultSenderIdRequest, AsyncHandler<DeleteDefaultSenderIdRequest,DeleteDefaultSenderIdResult> asyncHandler)
Deletes an existing default sender ID on a configuration set.
A default sender ID is the identity that appears on recipients' devices when they receive SMS messages. Support for sender ID capabilities varies by country or region.
deleteDefaultSenderIdRequest - asyncHandler - 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.Future<DeleteEventDestinationResult> deleteEventDestinationAsync(DeleteEventDestinationRequest deleteEventDestinationRequest)
Deletes an existing event destination.
An event destination is a location where you send response information about the messages that you send. For example, when a message is delivered successfully, you can send information about that event to an Amazon CloudWatch destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.
deleteEventDestinationRequest - Future<DeleteEventDestinationResult> deleteEventDestinationAsync(DeleteEventDestinationRequest deleteEventDestinationRequest, AsyncHandler<DeleteEventDestinationRequest,DeleteEventDestinationResult> asyncHandler)
Deletes an existing event destination.
An event destination is a location where you send response information about the messages that you send. For example, when a message is delivered successfully, you can send information about that event to an Amazon CloudWatch destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.
deleteEventDestinationRequest - asyncHandler - 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.Future<DeleteKeywordResult> deleteKeywordAsync(DeleteKeywordRequest deleteKeywordRequest)
Deletes an existing keyword from an origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.
Keywords "HELP" and "STOP" can't be deleted or modified.
deleteKeywordRequest - Future<DeleteKeywordResult> deleteKeywordAsync(DeleteKeywordRequest deleteKeywordRequest, AsyncHandler<DeleteKeywordRequest,DeleteKeywordResult> asyncHandler)
Deletes an existing keyword from an origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.
Keywords "HELP" and "STOP" can't be deleted or modified.
deleteKeywordRequest - asyncHandler - 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.Future<DeleteMediaMessageSpendLimitOverrideResult> deleteMediaMessageSpendLimitOverrideAsync(DeleteMediaMessageSpendLimitOverrideRequest deleteMediaMessageSpendLimitOverrideRequest)
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.
deleteMediaMessageSpendLimitOverrideRequest - Future<DeleteMediaMessageSpendLimitOverrideResult> deleteMediaMessageSpendLimitOverrideAsync(DeleteMediaMessageSpendLimitOverrideRequest deleteMediaMessageSpendLimitOverrideRequest, AsyncHandler<DeleteMediaMessageSpendLimitOverrideRequest,DeleteMediaMessageSpendLimitOverrideResult> asyncHandler)
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.
deleteMediaMessageSpendLimitOverrideRequest - asyncHandler - 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.Future<DeleteOptOutListResult> deleteOptOutListAsync(DeleteOptOutListRequest deleteOptOutListRequest)
Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are deleted.
If the specified opt-out list name doesn't exist or is in-use by an origination phone number or pool, an error is returned.
deleteOptOutListRequest - Future<DeleteOptOutListResult> deleteOptOutListAsync(DeleteOptOutListRequest deleteOptOutListRequest, AsyncHandler<DeleteOptOutListRequest,DeleteOptOutListResult> asyncHandler)
Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are deleted.
If the specified opt-out list name doesn't exist or is in-use by an origination phone number or pool, an error is returned.
deleteOptOutListRequest - asyncHandler - 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.Future<DeleteOptedOutNumberResult> deleteOptedOutNumberAsync(DeleteOptedOutNumberRequest deleteOptedOutNumberRequest)
Deletes an existing opted out destination phone number from the specified opt-out list.
Each destination phone number can only be deleted once every 30 days.
If the specified destination phone number doesn't exist or if the opt-out list doesn't exist, an error is returned.
deleteOptedOutNumberRequest - Future<DeleteOptedOutNumberResult> deleteOptedOutNumberAsync(DeleteOptedOutNumberRequest deleteOptedOutNumberRequest, AsyncHandler<DeleteOptedOutNumberRequest,DeleteOptedOutNumberResult> asyncHandler)
Deletes an existing opted out destination phone number from the specified opt-out list.
Each destination phone number can only be deleted once every 30 days.
If the specified destination phone number doesn't exist or if the opt-out list doesn't exist, an error is returned.
deleteOptedOutNumberRequest - asyncHandler - 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.Future<DeletePoolResult> deletePoolAsync(DeletePoolRequest deletePoolRequest)
Deletes an existing pool. Deleting a pool disassociates all origination identities from that pool.
If the pool status isn't active or if deletion protection is enabled, an error is returned.
A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
deletePoolRequest - Future<DeletePoolResult> deletePoolAsync(DeletePoolRequest deletePoolRequest, AsyncHandler<DeletePoolRequest,DeletePoolResult> asyncHandler)
Deletes an existing pool. Deleting a pool disassociates all origination identities from that pool.
If the pool status isn't active or if deletion protection is enabled, an error is returned.
A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
deletePoolRequest - asyncHandler - 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.Future<DeleteProtectConfigurationResult> deleteProtectConfigurationAsync(DeleteProtectConfigurationRequest deleteProtectConfigurationRequest)
Permanently delete the protect configuration. The protect configuration must have deletion protection disabled and must not be associated as the account default protect configuration or associated with a configuration set.
deleteProtectConfigurationRequest - Future<DeleteProtectConfigurationResult> deleteProtectConfigurationAsync(DeleteProtectConfigurationRequest deleteProtectConfigurationRequest, AsyncHandler<DeleteProtectConfigurationRequest,DeleteProtectConfigurationResult> asyncHandler)
Permanently delete the protect configuration. The protect configuration must have deletion protection disabled and must not be associated as the account default protect configuration or associated with a configuration set.
deleteProtectConfigurationRequest - asyncHandler - 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.Future<DeleteRegistrationResult> deleteRegistrationAsync(DeleteRegistrationRequest deleteRegistrationRequest)
Permanently delete an existing registration from your account.
deleteRegistrationRequest - Future<DeleteRegistrationResult> deleteRegistrationAsync(DeleteRegistrationRequest deleteRegistrationRequest, AsyncHandler<DeleteRegistrationRequest,DeleteRegistrationResult> asyncHandler)
Permanently delete an existing registration from your account.
deleteRegistrationRequest - asyncHandler - 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.Future<DeleteRegistrationAttachmentResult> deleteRegistrationAttachmentAsync(DeleteRegistrationAttachmentRequest deleteRegistrationAttachmentRequest)
Permanently delete the specified registration attachment.
deleteRegistrationAttachmentRequest - Future<DeleteRegistrationAttachmentResult> deleteRegistrationAttachmentAsync(DeleteRegistrationAttachmentRequest deleteRegistrationAttachmentRequest, AsyncHandler<DeleteRegistrationAttachmentRequest,DeleteRegistrationAttachmentResult> asyncHandler)
Permanently delete the specified registration attachment.
deleteRegistrationAttachmentRequest - asyncHandler - 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.Future<DeleteRegistrationFieldValueResult> deleteRegistrationFieldValueAsync(DeleteRegistrationFieldValueRequest deleteRegistrationFieldValueRequest)
Delete the value in a registration form field.
deleteRegistrationFieldValueRequest - Future<DeleteRegistrationFieldValueResult> deleteRegistrationFieldValueAsync(DeleteRegistrationFieldValueRequest deleteRegistrationFieldValueRequest, AsyncHandler<DeleteRegistrationFieldValueRequest,DeleteRegistrationFieldValueResult> asyncHandler)
Delete the value in a registration form field.
deleteRegistrationFieldValueRequest - asyncHandler - 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.Future<DeleteTextMessageSpendLimitOverrideResult> deleteTextMessageSpendLimitOverrideAsync(DeleteTextMessageSpendLimitOverrideRequest deleteTextMessageSpendLimitOverrideRequest)
Deletes an account-level monthly spending limit override for sending text messages. Deleting a spend limit
override will set the EnforcedLimit to equal the MaxLimit, which is controlled by
Amazon Web Services. For more information on spend limits (quotas) see Amazon Pinpoint quotas in the
Amazon Pinpoint Developer Guide.
deleteTextMessageSpendLimitOverrideRequest - Future<DeleteTextMessageSpendLimitOverrideResult> deleteTextMessageSpendLimitOverrideAsync(DeleteTextMessageSpendLimitOverrideRequest deleteTextMessageSpendLimitOverrideRequest, AsyncHandler<DeleteTextMessageSpendLimitOverrideRequest,DeleteTextMessageSpendLimitOverrideResult> asyncHandler)
Deletes an account-level monthly spending limit override for sending text messages. Deleting a spend limit
override will set the EnforcedLimit to equal the MaxLimit, which is controlled by
Amazon Web Services. For more information on spend limits (quotas) see Amazon Pinpoint quotas in the
Amazon Pinpoint Developer Guide.
deleteTextMessageSpendLimitOverrideRequest - asyncHandler - 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.Future<DeleteVerifiedDestinationNumberResult> deleteVerifiedDestinationNumberAsync(DeleteVerifiedDestinationNumberRequest deleteVerifiedDestinationNumberRequest)
Delete a verified destination phone number.
deleteVerifiedDestinationNumberRequest - Future<DeleteVerifiedDestinationNumberResult> deleteVerifiedDestinationNumberAsync(DeleteVerifiedDestinationNumberRequest deleteVerifiedDestinationNumberRequest, AsyncHandler<DeleteVerifiedDestinationNumberRequest,DeleteVerifiedDestinationNumberResult> asyncHandler)
Delete a verified destination phone number.
deleteVerifiedDestinationNumberRequest - asyncHandler - 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.Future<DeleteVoiceMessageSpendLimitOverrideResult> deleteVoiceMessageSpendLimitOverrideAsync(DeleteVoiceMessageSpendLimitOverrideRequest deleteVoiceMessageSpendLimitOverrideRequest)
Deletes an account level monthly spend limit override for sending voice messages. Deleting a spend limit override
sets the EnforcedLimit equal to the MaxLimit, which is controlled by Amazon Web
Services. For more information on spending limits (quotas) see Amazon Pinpoint quotas in the
Amazon Pinpoint Developer Guide.
deleteVoiceMessageSpendLimitOverrideRequest - Future<DeleteVoiceMessageSpendLimitOverrideResult> deleteVoiceMessageSpendLimitOverrideAsync(DeleteVoiceMessageSpendLimitOverrideRequest deleteVoiceMessageSpendLimitOverrideRequest, AsyncHandler<DeleteVoiceMessageSpendLimitOverrideRequest,DeleteVoiceMessageSpendLimitOverrideResult> asyncHandler)
Deletes an account level monthly spend limit override for sending voice messages. Deleting a spend limit override
sets the EnforcedLimit equal to the MaxLimit, which is controlled by Amazon Web
Services. For more information on spending limits (quotas) see Amazon Pinpoint quotas in the
Amazon Pinpoint Developer Guide.
deleteVoiceMessageSpendLimitOverrideRequest - asyncHandler - 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.Future<DescribeAccountAttributesResult> describeAccountAttributesAsync(DescribeAccountAttributesRequest describeAccountAttributesRequest)
Describes attributes of your Amazon Web Services account. The supported account attributes include account tier, which indicates whether your account is in the sandbox or production environment. When you're ready to move your account out of the sandbox, create an Amazon Web Services Support case for a service limit increase request.
New Amazon Pinpoint accounts are placed into an SMS or voice sandbox. The sandbox protects both Amazon Web Services end recipients and SMS or voice recipients from fraud and abuse.
describeAccountAttributesRequest - Future<DescribeAccountAttributesResult> describeAccountAttributesAsync(DescribeAccountAttributesRequest describeAccountAttributesRequest, AsyncHandler<DescribeAccountAttributesRequest,DescribeAccountAttributesResult> asyncHandler)
Describes attributes of your Amazon Web Services account. The supported account attributes include account tier, which indicates whether your account is in the sandbox or production environment. When you're ready to move your account out of the sandbox, create an Amazon Web Services Support case for a service limit increase request.
New Amazon Pinpoint accounts are placed into an SMS or voice sandbox. The sandbox protects both Amazon Web Services end recipients and SMS or voice recipients from fraud and abuse.
describeAccountAttributesRequest - asyncHandler - 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.Future<DescribeAccountLimitsResult> describeAccountLimitsAsync(DescribeAccountLimitsRequest describeAccountLimitsRequest)
Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your account. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.
When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of configuration sets, opt-out lists, phone numbers, and pools that you can create in a given Region. For more information see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
describeAccountLimitsRequest - Future<DescribeAccountLimitsResult> describeAccountLimitsAsync(DescribeAccountLimitsRequest describeAccountLimitsRequest, AsyncHandler<DescribeAccountLimitsRequest,DescribeAccountLimitsResult> asyncHandler)
Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your account. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.
When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of configuration sets, opt-out lists, phone numbers, and pools that you can create in a given Region. For more information see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
describeAccountLimitsRequest - asyncHandler - 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.Future<DescribeConfigurationSetsResult> describeConfigurationSetsAsync(DescribeConfigurationSetsRequest describeConfigurationSetsRequest)
Describes the specified configuration sets or all in your account.
If you specify configuration set names, the output includes information for only the specified configuration sets. If you specify filters, the output includes information for only those configuration sets that meet the filter criteria. If you don't specify configuration set names or filters, the output includes information for all configuration sets.
If you specify a configuration set name that isn't valid, an error is returned.
describeConfigurationSetsRequest - Future<DescribeConfigurationSetsResult> describeConfigurationSetsAsync(DescribeConfigurationSetsRequest describeConfigurationSetsRequest, AsyncHandler<DescribeConfigurationSetsRequest,DescribeConfigurationSetsResult> asyncHandler)
Describes the specified configuration sets or all in your account.
If you specify configuration set names, the output includes information for only the specified configuration sets. If you specify filters, the output includes information for only those configuration sets that meet the filter criteria. If you don't specify configuration set names or filters, the output includes information for all configuration sets.
If you specify a configuration set name that isn't valid, an error is returned.
describeConfigurationSetsRequest - asyncHandler - 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.Future<DescribeKeywordsResult> describeKeywordsAsync(DescribeKeywordsRequest describeKeywordsRequest)
Describes the specified keywords or all keywords on your origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.
If you specify a keyword that isn't valid, an error is returned.
describeKeywordsRequest - Future<DescribeKeywordsResult> describeKeywordsAsync(DescribeKeywordsRequest describeKeywordsRequest, AsyncHandler<DescribeKeywordsRequest,DescribeKeywordsResult> asyncHandler)
Describes the specified keywords or all keywords on your origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.
If you specify a keyword that isn't valid, an error is returned.
describeKeywordsRequest - asyncHandler - 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.Future<DescribeOptOutListsResult> describeOptOutListsAsync(DescribeOptOutListsRequest describeOptOutListsRequest)
Describes the specified opt-out list or all opt-out lists in your account.
If you specify opt-out list names, the output includes information for only the specified opt-out lists. Opt-out lists include only those that meet the filter criteria. If you don't specify opt-out list names or filters, the output includes information for all opt-out lists.
If you specify an opt-out list name that isn't valid, an error is returned.
describeOptOutListsRequest - Future<DescribeOptOutListsResult> describeOptOutListsAsync(DescribeOptOutListsRequest describeOptOutListsRequest, AsyncHandler<DescribeOptOutListsRequest,DescribeOptOutListsResult> asyncHandler)
Describes the specified opt-out list or all opt-out lists in your account.
If you specify opt-out list names, the output includes information for only the specified opt-out lists. Opt-out lists include only those that meet the filter criteria. If you don't specify opt-out list names or filters, the output includes information for all opt-out lists.
If you specify an opt-out list name that isn't valid, an error is returned.
describeOptOutListsRequest - asyncHandler - 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.Future<DescribeOptedOutNumbersResult> describeOptedOutNumbersAsync(DescribeOptedOutNumbersRequest describeOptedOutNumbersRequest)
Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list.
If you specify opted out numbers, the output includes information for only the specified opted out numbers. If you specify filters, the output includes information for only those opted out numbers that meet the filter criteria. If you don't specify opted out numbers or filters, the output includes information for all opted out destination numbers in your opt-out list.
If you specify an opted out number that isn't valid, an error is returned.
describeOptedOutNumbersRequest - Future<DescribeOptedOutNumbersResult> describeOptedOutNumbersAsync(DescribeOptedOutNumbersRequest describeOptedOutNumbersRequest, AsyncHandler<DescribeOptedOutNumbersRequest,DescribeOptedOutNumbersResult> asyncHandler)
Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list.
If you specify opted out numbers, the output includes information for only the specified opted out numbers. If you specify filters, the output includes information for only those opted out numbers that meet the filter criteria. If you don't specify opted out numbers or filters, the output includes information for all opted out destination numbers in your opt-out list.
If you specify an opted out number that isn't valid, an error is returned.
describeOptedOutNumbersRequest - asyncHandler - 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.Future<DescribePhoneNumbersResult> describePhoneNumbersAsync(DescribePhoneNumbersRequest describePhoneNumbersRequest)
Describes the specified origination phone number, or all the phone numbers in your account.
If you specify phone number IDs, the output includes information for only the specified phone numbers. If you specify filters, the output includes information for only those phone numbers that meet the filter criteria. If you don't specify phone number IDs or filters, the output includes information for all phone numbers.
If you specify a phone number ID that isn't valid, an error is returned.
describePhoneNumbersRequest - Future<DescribePhoneNumbersResult> describePhoneNumbersAsync(DescribePhoneNumbersRequest describePhoneNumbersRequest, AsyncHandler<DescribePhoneNumbersRequest,DescribePhoneNumbersResult> asyncHandler)
Describes the specified origination phone number, or all the phone numbers in your account.
If you specify phone number IDs, the output includes information for only the specified phone numbers. If you specify filters, the output includes information for only those phone numbers that meet the filter criteria. If you don't specify phone number IDs or filters, the output includes information for all phone numbers.
If you specify a phone number ID that isn't valid, an error is returned.
describePhoneNumbersRequest - asyncHandler - 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.Future<DescribePoolsResult> describePoolsAsync(DescribePoolsRequest describePoolsRequest)
Retrieves the specified pools or all pools associated with your Amazon Web Services account.
If you specify pool IDs, the output includes information for only the specified pools. If you specify filters, the output includes information for only those pools that meet the filter criteria. If you don't specify pool IDs or filters, the output includes information for all pools.
If you specify a pool ID that isn't valid, an error is returned.
A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
describePoolsRequest - Future<DescribePoolsResult> describePoolsAsync(DescribePoolsRequest describePoolsRequest, AsyncHandler<DescribePoolsRequest,DescribePoolsResult> asyncHandler)
Retrieves the specified pools or all pools associated with your Amazon Web Services account.
If you specify pool IDs, the output includes information for only the specified pools. If you specify filters, the output includes information for only those pools that meet the filter criteria. If you don't specify pool IDs or filters, the output includes information for all pools.
If you specify a pool ID that isn't valid, an error is returned.
A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
describePoolsRequest - asyncHandler - 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.Future<DescribeProtectConfigurationsResult> describeProtectConfigurationsAsync(DescribeProtectConfigurationsRequest describeProtectConfigurationsRequest)
Retrieves the protect configurations that match any of filters. If a filter isn’t provided then all protect configurations are returned.
describeProtectConfigurationsRequest - Future<DescribeProtectConfigurationsResult> describeProtectConfigurationsAsync(DescribeProtectConfigurationsRequest describeProtectConfigurationsRequest, AsyncHandler<DescribeProtectConfigurationsRequest,DescribeProtectConfigurationsResult> asyncHandler)
Retrieves the protect configurations that match any of filters. If a filter isn’t provided then all protect configurations are returned.
describeProtectConfigurationsRequest - asyncHandler - 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.Future<DescribeRegistrationAttachmentsResult> describeRegistrationAttachmentsAsync(DescribeRegistrationAttachmentsRequest describeRegistrationAttachmentsRequest)
Retrieves the specified registration attachments or all registration attachments associated with your Amazon Web Services account.
describeRegistrationAttachmentsRequest - Future<DescribeRegistrationAttachmentsResult> describeRegistrationAttachmentsAsync(DescribeRegistrationAttachmentsRequest describeRegistrationAttachmentsRequest, AsyncHandler<DescribeRegistrationAttachmentsRequest,DescribeRegistrationAttachmentsResult> asyncHandler)
Retrieves the specified registration attachments or all registration attachments associated with your Amazon Web Services account.
describeRegistrationAttachmentsRequest - asyncHandler - 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.Future<DescribeRegistrationFieldDefinitionsResult> describeRegistrationFieldDefinitionsAsync(DescribeRegistrationFieldDefinitionsRequest describeRegistrationFieldDefinitionsRequest)
Retrieves the specified registration type field definitions. You can use DescribeRegistrationFieldDefinitions to view the requirements for creating, filling out, and submitting each registration type.
describeRegistrationFieldDefinitionsRequest - Future<DescribeRegistrationFieldDefinitionsResult> describeRegistrationFieldDefinitionsAsync(DescribeRegistrationFieldDefinitionsRequest describeRegistrationFieldDefinitionsRequest, AsyncHandler<DescribeRegistrationFieldDefinitionsRequest,DescribeRegistrationFieldDefinitionsResult> asyncHandler)
Retrieves the specified registration type field definitions. You can use DescribeRegistrationFieldDefinitions to view the requirements for creating, filling out, and submitting each registration type.
describeRegistrationFieldDefinitionsRequest - asyncHandler - 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.Future<DescribeRegistrationFieldValuesResult> describeRegistrationFieldValuesAsync(DescribeRegistrationFieldValuesRequest describeRegistrationFieldValuesRequest)
Retrieves the specified registration field values.
describeRegistrationFieldValuesRequest - Future<DescribeRegistrationFieldValuesResult> describeRegistrationFieldValuesAsync(DescribeRegistrationFieldValuesRequest describeRegistrationFieldValuesRequest, AsyncHandler<DescribeRegistrationFieldValuesRequest,DescribeRegistrationFieldValuesResult> asyncHandler)
Retrieves the specified registration field values.
describeRegistrationFieldValuesRequest - asyncHandler - 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.Future<DescribeRegistrationSectionDefinitionsResult> describeRegistrationSectionDefinitionsAsync(DescribeRegistrationSectionDefinitionsRequest describeRegistrationSectionDefinitionsRequest)
Retrieves the specified registration section definitions. You can use DescribeRegistrationSectionDefinitions to view the requirements for creating, filling out, and submitting each registration type.
describeRegistrationSectionDefinitionsRequest - Future<DescribeRegistrationSectionDefinitionsResult> describeRegistrationSectionDefinitionsAsync(DescribeRegistrationSectionDefinitionsRequest describeRegistrationSectionDefinitionsRequest, AsyncHandler<DescribeRegistrationSectionDefinitionsRequest,DescribeRegistrationSectionDefinitionsResult> asyncHandler)
Retrieves the specified registration section definitions. You can use DescribeRegistrationSectionDefinitions to view the requirements for creating, filling out, and submitting each registration type.
describeRegistrationSectionDefinitionsRequest - asyncHandler - 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.Future<DescribeRegistrationTypeDefinitionsResult> describeRegistrationTypeDefinitionsAsync(DescribeRegistrationTypeDefinitionsRequest describeRegistrationTypeDefinitionsRequest)
Retrieves the specified registration type definitions. You can use DescribeRegistrationTypeDefinitions to view the requirements for creating, filling out, and submitting each registration type.
describeRegistrationTypeDefinitionsRequest - Future<DescribeRegistrationTypeDefinitionsResult> describeRegistrationTypeDefinitionsAsync(DescribeRegistrationTypeDefinitionsRequest describeRegistrationTypeDefinitionsRequest, AsyncHandler<DescribeRegistrationTypeDefinitionsRequest,DescribeRegistrationTypeDefinitionsResult> asyncHandler)
Retrieves the specified registration type definitions. You can use DescribeRegistrationTypeDefinitions to view the requirements for creating, filling out, and submitting each registration type.
describeRegistrationTypeDefinitionsRequest - asyncHandler - 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.Future<DescribeRegistrationVersionsResult> describeRegistrationVersionsAsync(DescribeRegistrationVersionsRequest describeRegistrationVersionsRequest)
Retrieves the specified registration version.
describeRegistrationVersionsRequest - Future<DescribeRegistrationVersionsResult> describeRegistrationVersionsAsync(DescribeRegistrationVersionsRequest describeRegistrationVersionsRequest, AsyncHandler<DescribeRegistrationVersionsRequest,DescribeRegistrationVersionsResult> asyncHandler)
Retrieves the specified registration version.
describeRegistrationVersionsRequest - asyncHandler - 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.Future<DescribeRegistrationsResult> describeRegistrationsAsync(DescribeRegistrationsRequest describeRegistrationsRequest)
Retrieves the specified registrations.
describeRegistrationsRequest - Future<DescribeRegistrationsResult> describeRegistrationsAsync(DescribeRegistrationsRequest describeRegistrationsRequest, AsyncHandler<DescribeRegistrationsRequest,DescribeRegistrationsResult> asyncHandler)
Retrieves the specified registrations.
describeRegistrationsRequest - asyncHandler - 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.Future<DescribeSenderIdsResult> describeSenderIdsAsync(DescribeSenderIdsRequest describeSenderIdsRequest)
Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.
If you specify SenderIds, the output includes information for only the specified SenderIds. If you specify filters, the output includes information for only those SenderIds that meet the filter criteria. If you don't specify SenderIds or filters, the output includes information for all SenderIds.
f you specify a sender ID that isn't valid, an error is returned.
describeSenderIdsRequest - Future<DescribeSenderIdsResult> describeSenderIdsAsync(DescribeSenderIdsRequest describeSenderIdsRequest, AsyncHandler<DescribeSenderIdsRequest,DescribeSenderIdsResult> asyncHandler)
Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.
If you specify SenderIds, the output includes information for only the specified SenderIds. If you specify filters, the output includes information for only those SenderIds that meet the filter criteria. If you don't specify SenderIds or filters, the output includes information for all SenderIds.
f you specify a sender ID that isn't valid, an error is returned.
describeSenderIdsRequest - asyncHandler - 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.Future<DescribeSpendLimitsResult> describeSpendLimitsAsync(DescribeSpendLimitsRequest describeSpendLimitsRequest)
Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages.
When you establish an Amazon Web Services account, the account has initial monthly spend limit in a given Region. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS spending quota for Amazon Pinpoint in the Amazon Pinpoint User Guide.
describeSpendLimitsRequest - Future<DescribeSpendLimitsResult> describeSpendLimitsAsync(DescribeSpendLimitsRequest describeSpendLimitsRequest, AsyncHandler<DescribeSpendLimitsRequest,DescribeSpendLimitsResult> asyncHandler)
Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages.
When you establish an Amazon Web Services account, the account has initial monthly spend limit in a given Region. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS spending quota for Amazon Pinpoint in the Amazon Pinpoint User Guide.
describeSpendLimitsRequest - asyncHandler - 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.Future<DescribeVerifiedDestinationNumbersResult> describeVerifiedDestinationNumbersAsync(DescribeVerifiedDestinationNumbersRequest describeVerifiedDestinationNumbersRequest)
Retrieves the specified verified destiona numbers.
describeVerifiedDestinationNumbersRequest - Future<DescribeVerifiedDestinationNumbersResult> describeVerifiedDestinationNumbersAsync(DescribeVerifiedDestinationNumbersRequest describeVerifiedDestinationNumbersRequest, AsyncHandler<DescribeVerifiedDestinationNumbersRequest,DescribeVerifiedDestinationNumbersResult> asyncHandler)
Retrieves the specified verified destiona numbers.
describeVerifiedDestinationNumbersRequest - asyncHandler - 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.Future<DisassociateOriginationIdentityResult> disassociateOriginationIdentityAsync(DisassociateOriginationIdentityRequest disassociateOriginationIdentityRequest)
Removes the specified origination identity from an existing pool.
If the origination identity isn't associated with the specified pool, an error is returned.
disassociateOriginationIdentityRequest - Future<DisassociateOriginationIdentityResult> disassociateOriginationIdentityAsync(DisassociateOriginationIdentityRequest disassociateOriginationIdentityRequest, AsyncHandler<DisassociateOriginationIdentityRequest,DisassociateOriginationIdentityResult> asyncHandler)
Removes the specified origination identity from an existing pool.
If the origination identity isn't associated with the specified pool, an error is returned.
disassociateOriginationIdentityRequest - asyncHandler - 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.Future<DisassociateProtectConfigurationResult> disassociateProtectConfigurationAsync(DisassociateProtectConfigurationRequest disassociateProtectConfigurationRequest)
Disassociate a protect configuration from a configuration set.
disassociateProtectConfigurationRequest - Future<DisassociateProtectConfigurationResult> disassociateProtectConfigurationAsync(DisassociateProtectConfigurationRequest disassociateProtectConfigurationRequest, AsyncHandler<DisassociateProtectConfigurationRequest,DisassociateProtectConfigurationResult> asyncHandler)
Disassociate a protect configuration from a configuration set.
disassociateProtectConfigurationRequest - asyncHandler - 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.Future<DiscardRegistrationVersionResult> discardRegistrationVersionAsync(DiscardRegistrationVersionRequest discardRegistrationVersionRequest)
Discard the current version of the registration.
discardRegistrationVersionRequest - Future<DiscardRegistrationVersionResult> discardRegistrationVersionAsync(DiscardRegistrationVersionRequest discardRegistrationVersionRequest, AsyncHandler<DiscardRegistrationVersionRequest,DiscardRegistrationVersionResult> asyncHandler)
Discard the current version of the registration.
discardRegistrationVersionRequest - asyncHandler - 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.Future<GetProtectConfigurationCountryRuleSetResult> getProtectConfigurationCountryRuleSetAsync(GetProtectConfigurationCountryRuleSetRequest getProtectConfigurationCountryRuleSetRequest)
Retrieve the CountryRuleSet for the specified NumberCapability from a protect configuration.
getProtectConfigurationCountryRuleSetRequest - Future<GetProtectConfigurationCountryRuleSetResult> getProtectConfigurationCountryRuleSetAsync(GetProtectConfigurationCountryRuleSetRequest getProtectConfigurationCountryRuleSetRequest, AsyncHandler<GetProtectConfigurationCountryRuleSetRequest,GetProtectConfigurationCountryRuleSetResult> asyncHandler)
Retrieve the CountryRuleSet for the specified NumberCapability from a protect configuration.
getProtectConfigurationCountryRuleSetRequest - asyncHandler - 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.Future<ListPoolOriginationIdentitiesResult> listPoolOriginationIdentitiesAsync(ListPoolOriginationIdentitiesRequest listPoolOriginationIdentitiesRequest)
Lists all associated origination identities in your pool.
If you specify filters, the output includes information for only those origination identities that meet the filter criteria.
listPoolOriginationIdentitiesRequest - Future<ListPoolOriginationIdentitiesResult> listPoolOriginationIdentitiesAsync(ListPoolOriginationIdentitiesRequest listPoolOriginationIdentitiesRequest, AsyncHandler<ListPoolOriginationIdentitiesRequest,ListPoolOriginationIdentitiesResult> asyncHandler)
Lists all associated origination identities in your pool.
If you specify filters, the output includes information for only those origination identities that meet the filter criteria.
listPoolOriginationIdentitiesRequest - asyncHandler - 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.Future<ListRegistrationAssociationsResult> listRegistrationAssociationsAsync(ListRegistrationAssociationsRequest listRegistrationAssociationsRequest)
Retreive all of the origination identies that are associated with a registration.
listRegistrationAssociationsRequest - Future<ListRegistrationAssociationsResult> listRegistrationAssociationsAsync(ListRegistrationAssociationsRequest listRegistrationAssociationsRequest, AsyncHandler<ListRegistrationAssociationsRequest,ListRegistrationAssociationsResult> asyncHandler)
Retreive all of the origination identies that are associated with a registration.
listRegistrationAssociationsRequest - asyncHandler - 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.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
List all tags associated with a resource.
listTagsForResourceRequest - Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
List all tags associated with a resource.
listTagsForResourceRequest - asyncHandler - 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.Future<PutKeywordResult> putKeywordAsync(PutKeywordRequest putKeywordRequest)
Creates or updates a keyword configuration on an origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.
If you specify a keyword that isn't valid, an error is returned.
putKeywordRequest - Future<PutKeywordResult> putKeywordAsync(PutKeywordRequest putKeywordRequest, AsyncHandler<PutKeywordRequest,PutKeywordResult> asyncHandler)
Creates or updates a keyword configuration on an origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.
If you specify a keyword that isn't valid, an error is returned.
putKeywordRequest - asyncHandler - 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.Future<PutOptedOutNumberResult> putOptedOutNumberAsync(PutOptedOutNumberRequest putOptedOutNumberRequest)
Creates an opted out destination phone number in the opt-out list.
If the destination phone number isn't valid or if the specified opt-out list doesn't exist, an error is returned.
putOptedOutNumberRequest - Future<PutOptedOutNumberResult> putOptedOutNumberAsync(PutOptedOutNumberRequest putOptedOutNumberRequest, AsyncHandler<PutOptedOutNumberRequest,PutOptedOutNumberResult> asyncHandler)
Creates an opted out destination phone number in the opt-out list.
If the destination phone number isn't valid or if the specified opt-out list doesn't exist, an error is returned.
putOptedOutNumberRequest - asyncHandler - 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.Future<PutRegistrationFieldValueResult> putRegistrationFieldValueAsync(PutRegistrationFieldValueRequest putRegistrationFieldValueRequest)
Creates or updates a field value for a registration.
putRegistrationFieldValueRequest - Future<PutRegistrationFieldValueResult> putRegistrationFieldValueAsync(PutRegistrationFieldValueRequest putRegistrationFieldValueRequest, AsyncHandler<PutRegistrationFieldValueRequest,PutRegistrationFieldValueResult> asyncHandler)
Creates or updates a field value for a registration.
putRegistrationFieldValueRequest - asyncHandler - 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.Future<ReleasePhoneNumberResult> releasePhoneNumberAsync(ReleasePhoneNumberRequest releasePhoneNumberRequest)
Releases an existing origination phone number in your account. Once released, a phone number is no longer available for sending messages.
If the origination phone number has deletion protection enabled or is associated with a pool, an error is returned.
releasePhoneNumberRequest - Future<ReleasePhoneNumberResult> releasePhoneNumberAsync(ReleasePhoneNumberRequest releasePhoneNumberRequest, AsyncHandler<ReleasePhoneNumberRequest,ReleasePhoneNumberResult> asyncHandler)
Releases an existing origination phone number in your account. Once released, a phone number is no longer available for sending messages.
If the origination phone number has deletion protection enabled or is associated with a pool, an error is returned.
releasePhoneNumberRequest - asyncHandler - 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.Future<ReleaseSenderIdResult> releaseSenderIdAsync(ReleaseSenderIdRequest releaseSenderIdRequest)
Releases an existing sender ID in your account.
releaseSenderIdRequest - Future<ReleaseSenderIdResult> releaseSenderIdAsync(ReleaseSenderIdRequest releaseSenderIdRequest, AsyncHandler<ReleaseSenderIdRequest,ReleaseSenderIdResult> asyncHandler)
Releases an existing sender ID in your account.
releaseSenderIdRequest - asyncHandler - 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.Future<RequestPhoneNumberResult> requestPhoneNumberAsync(RequestPhoneNumberRequest requestPhoneNumberRequest)
Request an origination phone number for use in your account. For more information on phone number request see Requesting a number in the Amazon Pinpoint User Guide.
requestPhoneNumberRequest - Future<RequestPhoneNumberResult> requestPhoneNumberAsync(RequestPhoneNumberRequest requestPhoneNumberRequest, AsyncHandler<RequestPhoneNumberRequest,RequestPhoneNumberResult> asyncHandler)
Request an origination phone number for use in your account. For more information on phone number request see Requesting a number in the Amazon Pinpoint User Guide.
requestPhoneNumberRequest - asyncHandler - 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.Future<RequestSenderIdResult> requestSenderIdAsync(RequestSenderIdRequest requestSenderIdRequest)
Request a new sender ID that doesn't require registration.
requestSenderIdRequest - Future<RequestSenderIdResult> requestSenderIdAsync(RequestSenderIdRequest requestSenderIdRequest, AsyncHandler<RequestSenderIdRequest,RequestSenderIdResult> asyncHandler)
Request a new sender ID that doesn't require registration.
requestSenderIdRequest - asyncHandler - 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.Future<SendDestinationNumberVerificationCodeResult> sendDestinationNumberVerificationCodeAsync(SendDestinationNumberVerificationCodeRequest sendDestinationNumberVerificationCodeRequest)
Before you can send test messages to a verified destination phone number you need to opt-in the verified destination phone number. Creates a new text message with a verification code and send it to a verified destination phone number. Once you have the verification code use VerifyDestinationNumber to opt-in the verified destination phone number to receive messages.
sendDestinationNumberVerificationCodeRequest - Future<SendDestinationNumberVerificationCodeResult> sendDestinationNumberVerificationCodeAsync(SendDestinationNumberVerificationCodeRequest sendDestinationNumberVerificationCodeRequest, AsyncHandler<SendDestinationNumberVerificationCodeRequest,SendDestinationNumberVerificationCodeResult> asyncHandler)
Before you can send test messages to a verified destination phone number you need to opt-in the verified destination phone number. Creates a new text message with a verification code and send it to a verified destination phone number. Once you have the verification code use VerifyDestinationNumber to opt-in the verified destination phone number to receive messages.
sendDestinationNumberVerificationCodeRequest - asyncHandler - 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.Future<SendMediaMessageResult> sendMediaMessageAsync(SendMediaMessageRequest sendMediaMessageRequest)
Creates a new multimedia message (MMS) and sends it to a recipient's phone number.
sendMediaMessageRequest - Future<SendMediaMessageResult> sendMediaMessageAsync(SendMediaMessageRequest sendMediaMessageRequest, AsyncHandler<SendMediaMessageRequest,SendMediaMessageResult> asyncHandler)
Creates a new multimedia message (MMS) and sends it to a recipient's phone number.
sendMediaMessageRequest - asyncHandler - 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.Future<SendTextMessageResult> sendTextMessageAsync(SendTextMessageRequest sendTextMessageRequest)
Creates a new text message and sends it to a recipient's phone number.
SMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit depends on the destination country of your messages, as well as the type of phone number (origination number) that you use to send the message. For more information, see Message Parts per Second (MPS) limits in the Amazon Pinpoint User Guide.
sendTextMessageRequest - Future<SendTextMessageResult> sendTextMessageAsync(SendTextMessageRequest sendTextMessageRequest, AsyncHandler<SendTextMessageRequest,SendTextMessageResult> asyncHandler)
Creates a new text message and sends it to a recipient's phone number.
SMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit depends on the destination country of your messages, as well as the type of phone number (origination number) that you use to send the message. For more information, see Message Parts per Second (MPS) limits in the Amazon Pinpoint User Guide.
sendTextMessageRequest - asyncHandler - 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.Future<SendVoiceMessageResult> sendVoiceMessageAsync(SendVoiceMessageRequest sendVoiceMessageRequest)
Allows you to send a request that sends a voice message through Amazon Pinpoint. This operation uses Amazon Polly to convert a text script into a voice message.
sendVoiceMessageRequest - Future<SendVoiceMessageResult> sendVoiceMessageAsync(SendVoiceMessageRequest sendVoiceMessageRequest, AsyncHandler<SendVoiceMessageRequest,SendVoiceMessageResult> asyncHandler)
Allows you to send a request that sends a voice message through Amazon Pinpoint. This operation uses Amazon Polly to convert a text script into a voice message.
sendVoiceMessageRequest - asyncHandler - 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.Future<SetAccountDefaultProtectConfigurationResult> setAccountDefaultProtectConfigurationAsync(SetAccountDefaultProtectConfigurationRequest setAccountDefaultProtectConfigurationRequest)
Set a protect configuration as your account default. You can only have one account default protect configuration at a time. The current account default protect configuration is replaced with the provided protect configuration.
setAccountDefaultProtectConfigurationRequest - Future<SetAccountDefaultProtectConfigurationResult> setAccountDefaultProtectConfigurationAsync(SetAccountDefaultProtectConfigurationRequest setAccountDefaultProtectConfigurationRequest, AsyncHandler<SetAccountDefaultProtectConfigurationRequest,SetAccountDefaultProtectConfigurationResult> asyncHandler)
Set a protect configuration as your account default. You can only have one account default protect configuration at a time. The current account default protect configuration is replaced with the provided protect configuration.
setAccountDefaultProtectConfigurationRequest - asyncHandler - 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.Future<SetDefaultMessageTypeResult> setDefaultMessageTypeAsync(SetDefaultMessageTypeRequest setDefaultMessageTypeRequest)
Sets the default message type on a configuration set.
Choose the category of SMS messages that you plan to send from this account. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.
setDefaultMessageTypeRequest - Future<SetDefaultMessageTypeResult> setDefaultMessageTypeAsync(SetDefaultMessageTypeRequest setDefaultMessageTypeRequest, AsyncHandler<SetDefaultMessageTypeRequest,SetDefaultMessageTypeResult> asyncHandler)
Sets the default message type on a configuration set.
Choose the category of SMS messages that you plan to send from this account. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.
setDefaultMessageTypeRequest - asyncHandler - 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.Future<SetDefaultSenderIdResult> setDefaultSenderIdAsync(SetDefaultSenderIdRequest setDefaultSenderIdRequest)
Sets default sender ID on a configuration set.
When sending a text message to a destination country that supports sender IDs, the default sender ID on the configuration set specified will be used if no dedicated origination phone numbers or registered sender IDs are available in your account.
setDefaultSenderIdRequest - Future<SetDefaultSenderIdResult> setDefaultSenderIdAsync(SetDefaultSenderIdRequest setDefaultSenderIdRequest, AsyncHandler<SetDefaultSenderIdRequest,SetDefaultSenderIdResult> asyncHandler)
Sets default sender ID on a configuration set.
When sending a text message to a destination country that supports sender IDs, the default sender ID on the configuration set specified will be used if no dedicated origination phone numbers or registered sender IDs are available in your account.
setDefaultSenderIdRequest - asyncHandler - 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.Future<SetMediaMessageSpendLimitOverrideResult> setMediaMessageSpendLimitOverrideAsync(SetMediaMessageSpendLimitOverrideRequest setMediaMessageSpendLimitOverrideRequest)
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.
setMediaMessageSpendLimitOverrideRequest - Future<SetMediaMessageSpendLimitOverrideResult> setMediaMessageSpendLimitOverrideAsync(SetMediaMessageSpendLimitOverrideRequest setMediaMessageSpendLimitOverrideRequest, AsyncHandler<SetMediaMessageSpendLimitOverrideRequest,SetMediaMessageSpendLimitOverrideResult> asyncHandler)
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.
setMediaMessageSpendLimitOverrideRequest - asyncHandler - 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.Future<SetTextMessageSpendLimitOverrideResult> setTextMessageSpendLimitOverrideAsync(SetTextMessageSpendLimitOverrideRequest setTextMessageSpendLimitOverrideRequest)
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.
setTextMessageSpendLimitOverrideRequest - Future<SetTextMessageSpendLimitOverrideResult> setTextMessageSpendLimitOverrideAsync(SetTextMessageSpendLimitOverrideRequest setTextMessageSpendLimitOverrideRequest, AsyncHandler<SetTextMessageSpendLimitOverrideRequest,SetTextMessageSpendLimitOverrideResult> asyncHandler)
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.
setTextMessageSpendLimitOverrideRequest - asyncHandler - 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.Future<SetVoiceMessageSpendLimitOverrideResult> setVoiceMessageSpendLimitOverrideAsync(SetVoiceMessageSpendLimitOverrideRequest setVoiceMessageSpendLimitOverrideRequest)
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.
setVoiceMessageSpendLimitOverrideRequest - Future<SetVoiceMessageSpendLimitOverrideResult> setVoiceMessageSpendLimitOverrideAsync(SetVoiceMessageSpendLimitOverrideRequest setVoiceMessageSpendLimitOverrideRequest, AsyncHandler<SetVoiceMessageSpendLimitOverrideRequest,SetVoiceMessageSpendLimitOverrideResult> asyncHandler)
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.
setVoiceMessageSpendLimitOverrideRequest - asyncHandler - 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.Future<SubmitRegistrationVersionResult> submitRegistrationVersionAsync(SubmitRegistrationVersionRequest submitRegistrationVersionRequest)
Submit the specified registration for review and approval.
submitRegistrationVersionRequest - Future<SubmitRegistrationVersionResult> submitRegistrationVersionAsync(SubmitRegistrationVersionRequest submitRegistrationVersionRequest, AsyncHandler<SubmitRegistrationVersionRequest,SubmitRegistrationVersionResult> asyncHandler)
Submit the specified registration for review and approval.
submitRegistrationVersionRequest - asyncHandler - 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.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS Voice, version 2 resource. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.
tagResourceRequest - Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS Voice, version 2 resource. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.
tagResourceRequest - asyncHandler - 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.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes the association of the specified tags from an Amazon Pinpoint SMS Voice V2 resource. For more information on tags see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.
untagResourceRequest - Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes the association of the specified tags from an Amazon Pinpoint SMS Voice V2 resource. For more information on tags see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.
untagResourceRequest - asyncHandler - 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.Future<UpdateEventDestinationResult> updateEventDestinationAsync(UpdateEventDestinationRequest updateEventDestinationRequest)
Updates an existing event destination in a configuration set. You can update the IAM role ARN for CloudWatch Logs and Kinesis Data Firehose. You can also enable or disable the event destination.
You may want to update an event destination to change its matching event types or updating the destination resource ARN. You can't change an event destination's type between CloudWatch Logs, Kinesis Data Firehose, and Amazon SNS.
updateEventDestinationRequest - Future<UpdateEventDestinationResult> updateEventDestinationAsync(UpdateEventDestinationRequest updateEventDestinationRequest, AsyncHandler<UpdateEventDestinationRequest,UpdateEventDestinationResult> asyncHandler)
Updates an existing event destination in a configuration set. You can update the IAM role ARN for CloudWatch Logs and Kinesis Data Firehose. You can also enable or disable the event destination.
You may want to update an event destination to change its matching event types or updating the destination resource ARN. You can't change an event destination's type between CloudWatch Logs, Kinesis Data Firehose, and Amazon SNS.
updateEventDestinationRequest - asyncHandler - 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.Future<UpdatePhoneNumberResult> updatePhoneNumberAsync(UpdatePhoneNumberRequest updatePhoneNumberRequest)
Updates the configuration of an existing origination phone number. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, and enable or disable deletion protection.
If the origination phone number is associated with a pool, an error is returned.
updatePhoneNumberRequest - Future<UpdatePhoneNumberResult> updatePhoneNumberAsync(UpdatePhoneNumberRequest updatePhoneNumberRequest, AsyncHandler<UpdatePhoneNumberRequest,UpdatePhoneNumberResult> asyncHandler)
Updates the configuration of an existing origination phone number. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, and enable or disable deletion protection.
If the origination phone number is associated with a pool, an error is returned.
updatePhoneNumberRequest - asyncHandler - 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.Future<UpdatePoolResult> updatePoolAsync(UpdatePoolRequest updatePoolRequest)
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.
updatePoolRequest - Future<UpdatePoolResult> updatePoolAsync(UpdatePoolRequest updatePoolRequest, AsyncHandler<UpdatePoolRequest,UpdatePoolResult> asyncHandler)
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.
updatePoolRequest - asyncHandler - 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.Future<UpdateProtectConfigurationResult> updateProtectConfigurationAsync(UpdateProtectConfigurationRequest updateProtectConfigurationRequest)
Update the setting for an existing protect configuration.
updateProtectConfigurationRequest - Future<UpdateProtectConfigurationResult> updateProtectConfigurationAsync(UpdateProtectConfigurationRequest updateProtectConfigurationRequest, AsyncHandler<UpdateProtectConfigurationRequest,UpdateProtectConfigurationResult> asyncHandler)
Update the setting for an existing protect configuration.
updateProtectConfigurationRequest - asyncHandler - 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.Future<UpdateProtectConfigurationCountryRuleSetResult> updateProtectConfigurationCountryRuleSetAsync(UpdateProtectConfigurationCountryRuleSetRequest updateProtectConfigurationCountryRuleSetRequest)
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.
updateProtectConfigurationCountryRuleSetRequest - Future<UpdateProtectConfigurationCountryRuleSetResult> updateProtectConfigurationCountryRuleSetAsync(UpdateProtectConfigurationCountryRuleSetRequest updateProtectConfigurationCountryRuleSetRequest, AsyncHandler<UpdateProtectConfigurationCountryRuleSetRequest,UpdateProtectConfigurationCountryRuleSetResult> asyncHandler)
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.
updateProtectConfigurationCountryRuleSetRequest - asyncHandler - 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.Future<UpdateSenderIdResult> updateSenderIdAsync(UpdateSenderIdRequest updateSenderIdRequest)
Updates the configuration of an existing sender ID.
updateSenderIdRequest - Future<UpdateSenderIdResult> updateSenderIdAsync(UpdateSenderIdRequest updateSenderIdRequest, AsyncHandler<UpdateSenderIdRequest,UpdateSenderIdResult> asyncHandler)
Updates the configuration of an existing sender ID.
updateSenderIdRequest - asyncHandler - 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.Future<VerifyDestinationNumberResult> verifyDestinationNumberAsync(VerifyDestinationNumberRequest verifyDestinationNumberRequest)
Use the verification code that was received by the verified destination phone number to opt-in the verified destination phone number to receive more messages.
verifyDestinationNumberRequest - Future<VerifyDestinationNumberResult> verifyDestinationNumberAsync(VerifyDestinationNumberRequest verifyDestinationNumberRequest, AsyncHandler<VerifyDestinationNumberRequest,VerifyDestinationNumberResult> asyncHandler)
Use the verification code that was received by the verified destination phone number to opt-in the verified destination phone number to receive more messages.
verifyDestinationNumberRequest - asyncHandler - 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.Copyright © 2024. All rights reserved.