Interface PinpointSmsVoiceV2AsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may
perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API
call.
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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionassociateOriginationIdentity
(Consumer<AssociateOriginationIdentityRequest.Builder> associateOriginationIdentityRequest) Associates the specified origination identity with a pool.associateOriginationIdentity
(AssociateOriginationIdentityRequest associateOriginationIdentityRequest) Associates the specified origination identity with a pool.associateProtectConfiguration
(Consumer<AssociateProtectConfigurationRequest.Builder> associateProtectConfigurationRequest) Associate a protect configuration with a configuration set.associateProtectConfiguration
(AssociateProtectConfigurationRequest associateProtectConfigurationRequest) Associate a protect configuration with a configuration set.builder()
Create a builder that can be used to configure and create aPinpointSmsVoiceV2AsyncClient
.create()
Create aPinpointSmsVoiceV2AsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createConfigurationSet
(Consumer<CreateConfigurationSetRequest.Builder> createConfigurationSetRequest) Creates a new configuration set.createConfigurationSet
(CreateConfigurationSetRequest createConfigurationSetRequest) Creates a new configuration set.createEventDestination
(Consumer<CreateEventDestinationRequest.Builder> createEventDestinationRequest) Creates a new event destination in a configuration set.createEventDestination
(CreateEventDestinationRequest createEventDestinationRequest) Creates a new event destination in a configuration set.createOptOutList
(Consumer<CreateOptOutListRequest.Builder> createOptOutListRequest) Creates a new opt-out list.createOptOutList
(CreateOptOutListRequest createOptOutListRequest) Creates a new opt-out list.default CompletableFuture
<CreatePoolResponse> createPool
(Consumer<CreatePoolRequest.Builder> createPoolRequest) Creates a new pool and associates the specified origination identity to the pool.default CompletableFuture
<CreatePoolResponse> createPool
(CreatePoolRequest createPoolRequest) Creates a new pool and associates the specified origination identity to the pool.createProtectConfiguration
(Consumer<CreateProtectConfigurationRequest.Builder> createProtectConfigurationRequest) Create a new protect configuration.createProtectConfiguration
(CreateProtectConfigurationRequest createProtectConfigurationRequest) Create a new protect configuration.createRegistration
(Consumer<CreateRegistrationRequest.Builder> createRegistrationRequest) Creates a new registration based on the RegistrationType field.createRegistration
(CreateRegistrationRequest createRegistrationRequest) Creates a new registration based on the RegistrationType field.createRegistrationAssociation
(Consumer<CreateRegistrationAssociationRequest.Builder> createRegistrationAssociationRequest) Associate the registration with an origination identity such as a phone number or sender ID.createRegistrationAssociation
(CreateRegistrationAssociationRequest createRegistrationAssociationRequest) Associate the registration with an origination identity such as a phone number or sender ID.createRegistrationAttachment
(Consumer<CreateRegistrationAttachmentRequest.Builder> createRegistrationAttachmentRequest) Create a new registration attachment to use for uploading a file or a URL to a file.createRegistrationAttachment
(CreateRegistrationAttachmentRequest createRegistrationAttachmentRequest) Create a new registration attachment to use for uploading a file or a URL to a file.createRegistrationVersion
(Consumer<CreateRegistrationVersionRequest.Builder> createRegistrationVersionRequest) Create a new version of the registration and increase the VersionNumber.createRegistrationVersion
(CreateRegistrationVersionRequest createRegistrationVersionRequest) Create a new version of the registration and increase the VersionNumber.createVerifiedDestinationNumber
(Consumer<CreateVerifiedDestinationNumberRequest.Builder> createVerifiedDestinationNumberRequest) You can only send messages to verified destination numbers when your account is in the sandbox.createVerifiedDestinationNumber
(CreateVerifiedDestinationNumberRequest createVerifiedDestinationNumberRequest) You can only send messages to verified destination numbers when your account is in the sandbox.deleteAccountDefaultProtectConfiguration
(Consumer<DeleteAccountDefaultProtectConfigurationRequest.Builder> deleteAccountDefaultProtectConfigurationRequest) Removes the current account default protect configuration.deleteAccountDefaultProtectConfiguration
(DeleteAccountDefaultProtectConfigurationRequest deleteAccountDefaultProtectConfigurationRequest) Removes the current account default protect configuration.deleteConfigurationSet
(Consumer<DeleteConfigurationSetRequest.Builder> deleteConfigurationSetRequest) Deletes an existing configuration set.deleteConfigurationSet
(DeleteConfigurationSetRequest deleteConfigurationSetRequest) Deletes an existing configuration set.deleteDefaultMessageType
(Consumer<DeleteDefaultMessageTypeRequest.Builder> deleteDefaultMessageTypeRequest) Deletes an existing default message type on a configuration set.deleteDefaultMessageType
(DeleteDefaultMessageTypeRequest deleteDefaultMessageTypeRequest) Deletes an existing default message type on a configuration set.deleteDefaultSenderId
(Consumer<DeleteDefaultSenderIdRequest.Builder> deleteDefaultSenderIdRequest) Deletes an existing default sender ID on a configuration set.deleteDefaultSenderId
(DeleteDefaultSenderIdRequest deleteDefaultSenderIdRequest) Deletes an existing default sender ID on a configuration set.deleteEventDestination
(Consumer<DeleteEventDestinationRequest.Builder> deleteEventDestinationRequest) Deletes an existing event destination.deleteEventDestination
(DeleteEventDestinationRequest deleteEventDestinationRequest) Deletes an existing event destination.default CompletableFuture
<DeleteKeywordResponse> deleteKeyword
(Consumer<DeleteKeywordRequest.Builder> deleteKeywordRequest) Deletes an existing keyword from an origination phone number or pool.default CompletableFuture
<DeleteKeywordResponse> deleteKeyword
(DeleteKeywordRequest deleteKeywordRequest) Deletes an existing keyword from an origination phone number or pool.deleteMediaMessageSpendLimitOverride
(Consumer<DeleteMediaMessageSpendLimitOverrideRequest.Builder> deleteMediaMessageSpendLimitOverrideRequest) Deletes an account-level monthly spending limit override for sending multimedia messages (MMS).deleteMediaMessageSpendLimitOverride
(DeleteMediaMessageSpendLimitOverrideRequest deleteMediaMessageSpendLimitOverrideRequest) Deletes an account-level monthly spending limit override for sending multimedia messages (MMS).deleteOptedOutNumber
(Consumer<DeleteOptedOutNumberRequest.Builder> deleteOptedOutNumberRequest) Deletes an existing opted out destination phone number from the specified opt-out list.deleteOptedOutNumber
(DeleteOptedOutNumberRequest deleteOptedOutNumberRequest) Deletes an existing opted out destination phone number from the specified opt-out list.deleteOptOutList
(Consumer<DeleteOptOutListRequest.Builder> deleteOptOutListRequest) Deletes an existing opt-out list.deleteOptOutList
(DeleteOptOutListRequest deleteOptOutListRequest) Deletes an existing opt-out list.default CompletableFuture
<DeletePoolResponse> deletePool
(Consumer<DeletePoolRequest.Builder> deletePoolRequest) Deletes an existing pool.default CompletableFuture
<DeletePoolResponse> deletePool
(DeletePoolRequest deletePoolRequest) Deletes an existing pool.deleteProtectConfiguration
(Consumer<DeleteProtectConfigurationRequest.Builder> deleteProtectConfigurationRequest) Permanently delete the protect configuration.deleteProtectConfiguration
(DeleteProtectConfigurationRequest deleteProtectConfigurationRequest) Permanently delete the protect configuration.deleteRegistration
(Consumer<DeleteRegistrationRequest.Builder> deleteRegistrationRequest) Permanently delete an existing registration from your account.deleteRegistration
(DeleteRegistrationRequest deleteRegistrationRequest) Permanently delete an existing registration from your account.deleteRegistrationAttachment
(Consumer<DeleteRegistrationAttachmentRequest.Builder> deleteRegistrationAttachmentRequest) Permanently delete the specified registration attachment.deleteRegistrationAttachment
(DeleteRegistrationAttachmentRequest deleteRegistrationAttachmentRequest) Permanently delete the specified registration attachment.deleteRegistrationFieldValue
(Consumer<DeleteRegistrationFieldValueRequest.Builder> deleteRegistrationFieldValueRequest) Delete the value in a registration form field.deleteRegistrationFieldValue
(DeleteRegistrationFieldValueRequest deleteRegistrationFieldValueRequest) Delete the value in a registration form field.deleteTextMessageSpendLimitOverride
(Consumer<DeleteTextMessageSpendLimitOverrideRequest.Builder> deleteTextMessageSpendLimitOverrideRequest) Deletes an account-level monthly spending limit override for sending text messages.deleteTextMessageSpendLimitOverride
(DeleteTextMessageSpendLimitOverrideRequest deleteTextMessageSpendLimitOverrideRequest) Deletes an account-level monthly spending limit override for sending text messages.deleteVerifiedDestinationNumber
(Consumer<DeleteVerifiedDestinationNumberRequest.Builder> deleteVerifiedDestinationNumberRequest) Delete a verified destination phone number.deleteVerifiedDestinationNumber
(DeleteVerifiedDestinationNumberRequest deleteVerifiedDestinationNumberRequest) Delete a verified destination phone number.deleteVoiceMessageSpendLimitOverride
(Consumer<DeleteVoiceMessageSpendLimitOverrideRequest.Builder> deleteVoiceMessageSpendLimitOverrideRequest) Deletes an account level monthly spend limit override for sending voice messages.deleteVoiceMessageSpendLimitOverride
(DeleteVoiceMessageSpendLimitOverrideRequest deleteVoiceMessageSpendLimitOverrideRequest) Deletes an account level monthly spend limit override for sending voice messages.describeAccountAttributes
(Consumer<DescribeAccountAttributesRequest.Builder> describeAccountAttributesRequest) Describes attributes of your Amazon Web Services account.describeAccountAttributes
(DescribeAccountAttributesRequest describeAccountAttributesRequest) Describes attributes of your Amazon Web Services account.describeAccountAttributesPaginator
(Consumer<DescribeAccountAttributesRequest.Builder> describeAccountAttributesRequest) This is a variant ofdescribeAccountAttributes(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeAccountAttributesRequest)
operation.describeAccountAttributesPaginator
(DescribeAccountAttributesRequest describeAccountAttributesRequest) This is a variant ofdescribeAccountAttributes(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeAccountAttributesRequest)
operation.describeAccountLimits
(Consumer<DescribeAccountLimitsRequest.Builder> describeAccountLimitsRequest) Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your account.describeAccountLimits
(DescribeAccountLimitsRequest describeAccountLimitsRequest) Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your account.default DescribeAccountLimitsPublisher
describeAccountLimitsPaginator
(Consumer<DescribeAccountLimitsRequest.Builder> describeAccountLimitsRequest) This is a variant ofdescribeAccountLimits(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeAccountLimitsRequest)
operation.default DescribeAccountLimitsPublisher
describeAccountLimitsPaginator
(DescribeAccountLimitsRequest describeAccountLimitsRequest) This is a variant ofdescribeAccountLimits(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeAccountLimitsRequest)
operation.describeConfigurationSets
(Consumer<DescribeConfigurationSetsRequest.Builder> describeConfigurationSetsRequest) Describes the specified configuration sets or all in your account.describeConfigurationSets
(DescribeConfigurationSetsRequest describeConfigurationSetsRequest) Describes the specified configuration sets or all in your account.describeConfigurationSetsPaginator
(Consumer<DescribeConfigurationSetsRequest.Builder> describeConfigurationSetsRequest) This is a variant ofdescribeConfigurationSets(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeConfigurationSetsRequest)
operation.describeConfigurationSetsPaginator
(DescribeConfigurationSetsRequest describeConfigurationSetsRequest) This is a variant ofdescribeConfigurationSets(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeConfigurationSetsRequest)
operation.describeKeywords
(Consumer<DescribeKeywordsRequest.Builder> describeKeywordsRequest) Describes the specified keywords or all keywords on your origination phone number or pool.describeKeywords
(DescribeKeywordsRequest describeKeywordsRequest) Describes the specified keywords or all keywords on your origination phone number or pool.default DescribeKeywordsPublisher
describeKeywordsPaginator
(Consumer<DescribeKeywordsRequest.Builder> describeKeywordsRequest) This is a variant ofdescribeKeywords(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeKeywordsRequest)
operation.default DescribeKeywordsPublisher
describeKeywordsPaginator
(DescribeKeywordsRequest describeKeywordsRequest) This is a variant ofdescribeKeywords(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeKeywordsRequest)
operation.describeOptedOutNumbers
(Consumer<DescribeOptedOutNumbersRequest.Builder> describeOptedOutNumbersRequest) Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list.describeOptedOutNumbers
(DescribeOptedOutNumbersRequest describeOptedOutNumbersRequest) Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list.default DescribeOptedOutNumbersPublisher
describeOptedOutNumbersPaginator
(Consumer<DescribeOptedOutNumbersRequest.Builder> describeOptedOutNumbersRequest) This is a variant ofdescribeOptedOutNumbers(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeOptedOutNumbersRequest)
operation.default DescribeOptedOutNumbersPublisher
describeOptedOutNumbersPaginator
(DescribeOptedOutNumbersRequest describeOptedOutNumbersRequest) This is a variant ofdescribeOptedOutNumbers(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeOptedOutNumbersRequest)
operation.describeOptOutLists
(Consumer<DescribeOptOutListsRequest.Builder> describeOptOutListsRequest) Describes the specified opt-out list or all opt-out lists in your account.describeOptOutLists
(DescribeOptOutListsRequest describeOptOutListsRequest) Describes the specified opt-out list or all opt-out lists in your account.default DescribeOptOutListsPublisher
describeOptOutListsPaginator
(Consumer<DescribeOptOutListsRequest.Builder> describeOptOutListsRequest) This is a variant ofdescribeOptOutLists(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeOptOutListsRequest)
operation.default DescribeOptOutListsPublisher
describeOptOutListsPaginator
(DescribeOptOutListsRequest describeOptOutListsRequest) This is a variant ofdescribeOptOutLists(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeOptOutListsRequest)
operation.describePhoneNumbers
(Consumer<DescribePhoneNumbersRequest.Builder> describePhoneNumbersRequest) Describes the specified origination phone number, or all the phone numbers in your account.describePhoneNumbers
(DescribePhoneNumbersRequest describePhoneNumbersRequest) Describes the specified origination phone number, or all the phone numbers in your account.default DescribePhoneNumbersPublisher
describePhoneNumbersPaginator
(Consumer<DescribePhoneNumbersRequest.Builder> describePhoneNumbersRequest) This is a variant ofdescribePhoneNumbers(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribePhoneNumbersRequest)
operation.default DescribePhoneNumbersPublisher
describePhoneNumbersPaginator
(DescribePhoneNumbersRequest describePhoneNumbersRequest) This is a variant ofdescribePhoneNumbers(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribePhoneNumbersRequest)
operation.default CompletableFuture
<DescribePoolsResponse> describePools
(Consumer<DescribePoolsRequest.Builder> describePoolsRequest) Retrieves the specified pools or all pools associated with your Amazon Web Services account.default CompletableFuture
<DescribePoolsResponse> describePools
(DescribePoolsRequest describePoolsRequest) Retrieves the specified pools or all pools associated with your Amazon Web Services account.default DescribePoolsPublisher
describePoolsPaginator
(Consumer<DescribePoolsRequest.Builder> describePoolsRequest) This is a variant ofdescribePools(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribePoolsRequest)
operation.default DescribePoolsPublisher
describePoolsPaginator
(DescribePoolsRequest describePoolsRequest) This is a variant ofdescribePools(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribePoolsRequest)
operation.describeProtectConfigurations
(Consumer<DescribeProtectConfigurationsRequest.Builder> describeProtectConfigurationsRequest) Retrieves the protect configurations that match any of filters.describeProtectConfigurations
(DescribeProtectConfigurationsRequest describeProtectConfigurationsRequest) Retrieves the protect configurations that match any of filters.describeProtectConfigurationsPaginator
(Consumer<DescribeProtectConfigurationsRequest.Builder> describeProtectConfigurationsRequest) This is a variant ofdescribeProtectConfigurations(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeProtectConfigurationsRequest)
operation.describeProtectConfigurationsPaginator
(DescribeProtectConfigurationsRequest describeProtectConfigurationsRequest) This is a variant ofdescribeProtectConfigurations(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeProtectConfigurationsRequest)
operation.describeRegistrationAttachments
(Consumer<DescribeRegistrationAttachmentsRequest.Builder> describeRegistrationAttachmentsRequest) Retrieves the specified registration attachments or all registration attachments associated with your Amazon Web Services account.describeRegistrationAttachments
(DescribeRegistrationAttachmentsRequest describeRegistrationAttachmentsRequest) Retrieves the specified registration attachments or all registration attachments associated with your Amazon Web Services account.describeRegistrationAttachmentsPaginator
(Consumer<DescribeRegistrationAttachmentsRequest.Builder> describeRegistrationAttachmentsRequest) This is a variant ofdescribeRegistrationAttachments(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationAttachmentsRequest)
operation.describeRegistrationAttachmentsPaginator
(DescribeRegistrationAttachmentsRequest describeRegistrationAttachmentsRequest) This is a variant ofdescribeRegistrationAttachments(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationAttachmentsRequest)
operation.describeRegistrationFieldDefinitions
(Consumer<DescribeRegistrationFieldDefinitionsRequest.Builder> describeRegistrationFieldDefinitionsRequest) Retrieves the specified registration type field definitions.describeRegistrationFieldDefinitions
(DescribeRegistrationFieldDefinitionsRequest describeRegistrationFieldDefinitionsRequest) Retrieves the specified registration type field definitions.describeRegistrationFieldDefinitionsPaginator
(Consumer<DescribeRegistrationFieldDefinitionsRequest.Builder> describeRegistrationFieldDefinitionsRequest) describeRegistrationFieldDefinitionsPaginator
(DescribeRegistrationFieldDefinitionsRequest describeRegistrationFieldDefinitionsRequest) describeRegistrationFieldValues
(Consumer<DescribeRegistrationFieldValuesRequest.Builder> describeRegistrationFieldValuesRequest) Retrieves the specified registration field values.describeRegistrationFieldValues
(DescribeRegistrationFieldValuesRequest describeRegistrationFieldValuesRequest) Retrieves the specified registration field values.describeRegistrationFieldValuesPaginator
(Consumer<DescribeRegistrationFieldValuesRequest.Builder> describeRegistrationFieldValuesRequest) This is a variant ofdescribeRegistrationFieldValues(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationFieldValuesRequest)
operation.describeRegistrationFieldValuesPaginator
(DescribeRegistrationFieldValuesRequest describeRegistrationFieldValuesRequest) This is a variant ofdescribeRegistrationFieldValues(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationFieldValuesRequest)
operation.describeRegistrations
(Consumer<DescribeRegistrationsRequest.Builder> describeRegistrationsRequest) Retrieves the specified registrations.describeRegistrations
(DescribeRegistrationsRequest describeRegistrationsRequest) Retrieves the specified registrations.describeRegistrationSectionDefinitions
(Consumer<DescribeRegistrationSectionDefinitionsRequest.Builder> describeRegistrationSectionDefinitionsRequest) Retrieves the specified registration section definitions.describeRegistrationSectionDefinitions
(DescribeRegistrationSectionDefinitionsRequest describeRegistrationSectionDefinitionsRequest) Retrieves the specified registration section definitions.describeRegistrationSectionDefinitionsPaginator
(Consumer<DescribeRegistrationSectionDefinitionsRequest.Builder> describeRegistrationSectionDefinitionsRequest) describeRegistrationSectionDefinitionsPaginator
(DescribeRegistrationSectionDefinitionsRequest describeRegistrationSectionDefinitionsRequest) default DescribeRegistrationsPublisher
describeRegistrationsPaginator
(Consumer<DescribeRegistrationsRequest.Builder> describeRegistrationsRequest) This is a variant ofdescribeRegistrations(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationsRequest)
operation.default DescribeRegistrationsPublisher
describeRegistrationsPaginator
(DescribeRegistrationsRequest describeRegistrationsRequest) This is a variant ofdescribeRegistrations(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationsRequest)
operation.describeRegistrationTypeDefinitions
(Consumer<DescribeRegistrationTypeDefinitionsRequest.Builder> describeRegistrationTypeDefinitionsRequest) Retrieves the specified registration type definitions.describeRegistrationTypeDefinitions
(DescribeRegistrationTypeDefinitionsRequest describeRegistrationTypeDefinitionsRequest) Retrieves the specified registration type definitions.describeRegistrationTypeDefinitionsPaginator
(Consumer<DescribeRegistrationTypeDefinitionsRequest.Builder> describeRegistrationTypeDefinitionsRequest) describeRegistrationTypeDefinitionsPaginator
(DescribeRegistrationTypeDefinitionsRequest describeRegistrationTypeDefinitionsRequest) describeRegistrationVersions
(Consumer<DescribeRegistrationVersionsRequest.Builder> describeRegistrationVersionsRequest) Retrieves the specified registration version.describeRegistrationVersions
(DescribeRegistrationVersionsRequest describeRegistrationVersionsRequest) Retrieves the specified registration version.describeRegistrationVersionsPaginator
(Consumer<DescribeRegistrationVersionsRequest.Builder> describeRegistrationVersionsRequest) This is a variant ofdescribeRegistrationVersions(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationVersionsRequest)
operation.describeRegistrationVersionsPaginator
(DescribeRegistrationVersionsRequest describeRegistrationVersionsRequest) This is a variant ofdescribeRegistrationVersions(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationVersionsRequest)
operation.describeSenderIds
(Consumer<DescribeSenderIdsRequest.Builder> describeSenderIdsRequest) Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.describeSenderIds
(DescribeSenderIdsRequest describeSenderIdsRequest) Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.default DescribeSenderIdsPublisher
describeSenderIdsPaginator
(Consumer<DescribeSenderIdsRequest.Builder> describeSenderIdsRequest) This is a variant ofdescribeSenderIds(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeSenderIdsRequest)
operation.default DescribeSenderIdsPublisher
describeSenderIdsPaginator
(DescribeSenderIdsRequest describeSenderIdsRequest) This is a variant ofdescribeSenderIds(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeSenderIdsRequest)
operation.describeSpendLimits
(Consumer<DescribeSpendLimitsRequest.Builder> describeSpendLimitsRequest) Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages.describeSpendLimits
(DescribeSpendLimitsRequest describeSpendLimitsRequest) Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages.default DescribeSpendLimitsPublisher
describeSpendLimitsPaginator
(Consumer<DescribeSpendLimitsRequest.Builder> describeSpendLimitsRequest) This is a variant ofdescribeSpendLimits(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeSpendLimitsRequest)
operation.default DescribeSpendLimitsPublisher
describeSpendLimitsPaginator
(DescribeSpendLimitsRequest describeSpendLimitsRequest) This is a variant ofdescribeSpendLimits(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeSpendLimitsRequest)
operation.describeVerifiedDestinationNumbers
(Consumer<DescribeVerifiedDestinationNumbersRequest.Builder> describeVerifiedDestinationNumbersRequest) Retrieves the specified verified destiona numbers.describeVerifiedDestinationNumbers
(DescribeVerifiedDestinationNumbersRequest describeVerifiedDestinationNumbersRequest) Retrieves the specified verified destiona numbers.describeVerifiedDestinationNumbersPaginator
(Consumer<DescribeVerifiedDestinationNumbersRequest.Builder> describeVerifiedDestinationNumbersRequest) describeVerifiedDestinationNumbersPaginator
(DescribeVerifiedDestinationNumbersRequest describeVerifiedDestinationNumbersRequest) disassociateOriginationIdentity
(Consumer<DisassociateOriginationIdentityRequest.Builder> disassociateOriginationIdentityRequest) Removes the specified origination identity from an existing pool.disassociateOriginationIdentity
(DisassociateOriginationIdentityRequest disassociateOriginationIdentityRequest) Removes the specified origination identity from an existing pool.disassociateProtectConfiguration
(Consumer<DisassociateProtectConfigurationRequest.Builder> disassociateProtectConfigurationRequest) Disassociate a protect configuration from a configuration set.disassociateProtectConfiguration
(DisassociateProtectConfigurationRequest disassociateProtectConfigurationRequest) Disassociate a protect configuration from a configuration set.discardRegistrationVersion
(Consumer<DiscardRegistrationVersionRequest.Builder> discardRegistrationVersionRequest) Discard the current version of the registration.discardRegistrationVersion
(DiscardRegistrationVersionRequest discardRegistrationVersionRequest) Discard the current version of the registration.getProtectConfigurationCountryRuleSet
(Consumer<GetProtectConfigurationCountryRuleSetRequest.Builder> getProtectConfigurationCountryRuleSetRequest) Retrieve the CountryRuleSet for the specified NumberCapability from a protect configuration.getProtectConfigurationCountryRuleSet
(GetProtectConfigurationCountryRuleSetRequest getProtectConfigurationCountryRuleSetRequest) Retrieve the CountryRuleSet for the specified NumberCapability from a protect configuration.listPoolOriginationIdentities
(Consumer<ListPoolOriginationIdentitiesRequest.Builder> listPoolOriginationIdentitiesRequest) Lists all associated origination identities in your pool.listPoolOriginationIdentities
(ListPoolOriginationIdentitiesRequest listPoolOriginationIdentitiesRequest) Lists all associated origination identities in your pool.listPoolOriginationIdentitiesPaginator
(Consumer<ListPoolOriginationIdentitiesRequest.Builder> listPoolOriginationIdentitiesRequest) This is a variant oflistPoolOriginationIdentities(software.amazon.awssdk.services.pinpointsmsvoicev2.model.ListPoolOriginationIdentitiesRequest)
operation.listPoolOriginationIdentitiesPaginator
(ListPoolOriginationIdentitiesRequest listPoolOriginationIdentitiesRequest) This is a variant oflistPoolOriginationIdentities(software.amazon.awssdk.services.pinpointsmsvoicev2.model.ListPoolOriginationIdentitiesRequest)
operation.listRegistrationAssociations
(Consumer<ListRegistrationAssociationsRequest.Builder> listRegistrationAssociationsRequest) Retreive all of the origination identies that are associated with a registration.listRegistrationAssociations
(ListRegistrationAssociationsRequest listRegistrationAssociationsRequest) Retreive all of the origination identies that are associated with a registration.listRegistrationAssociationsPaginator
(Consumer<ListRegistrationAssociationsRequest.Builder> listRegistrationAssociationsRequest) This is a variant oflistRegistrationAssociations(software.amazon.awssdk.services.pinpointsmsvoicev2.model.ListRegistrationAssociationsRequest)
operation.listRegistrationAssociationsPaginator
(ListRegistrationAssociationsRequest listRegistrationAssociationsRequest) This is a variant oflistRegistrationAssociations(software.amazon.awssdk.services.pinpointsmsvoicev2.model.ListRegistrationAssociationsRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) List all tags associated with a resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) List all tags associated with a resource.default CompletableFuture
<PutKeywordResponse> putKeyword
(Consumer<PutKeywordRequest.Builder> putKeywordRequest) Creates or updates a keyword configuration on an origination phone number or pool.default CompletableFuture
<PutKeywordResponse> putKeyword
(PutKeywordRequest putKeywordRequest) Creates or updates a keyword configuration on an origination phone number or pool.putOptedOutNumber
(Consumer<PutOptedOutNumberRequest.Builder> putOptedOutNumberRequest) Creates an opted out destination phone number in the opt-out list.putOptedOutNumber
(PutOptedOutNumberRequest putOptedOutNumberRequest) Creates an opted out destination phone number in the opt-out list.putRegistrationFieldValue
(Consumer<PutRegistrationFieldValueRequest.Builder> putRegistrationFieldValueRequest) Creates or updates a field value for a registration.putRegistrationFieldValue
(PutRegistrationFieldValueRequest putRegistrationFieldValueRequest) Creates or updates a field value for a registration.releasePhoneNumber
(Consumer<ReleasePhoneNumberRequest.Builder> releasePhoneNumberRequest) Releases an existing origination phone number in your account.releasePhoneNumber
(ReleasePhoneNumberRequest releasePhoneNumberRequest) Releases an existing origination phone number in your account.default CompletableFuture
<ReleaseSenderIdResponse> releaseSenderId
(Consumer<ReleaseSenderIdRequest.Builder> releaseSenderIdRequest) Releases an existing sender ID in your account.default CompletableFuture
<ReleaseSenderIdResponse> releaseSenderId
(ReleaseSenderIdRequest releaseSenderIdRequest) Releases an existing sender ID in your account.requestPhoneNumber
(Consumer<RequestPhoneNumberRequest.Builder> requestPhoneNumberRequest) Request an origination phone number for use in your account.requestPhoneNumber
(RequestPhoneNumberRequest requestPhoneNumberRequest) Request an origination phone number for use in your account.default CompletableFuture
<RequestSenderIdResponse> requestSenderId
(Consumer<RequestSenderIdRequest.Builder> requestSenderIdRequest) Request a new sender ID that doesn't require registration.default CompletableFuture
<RequestSenderIdResponse> requestSenderId
(RequestSenderIdRequest requestSenderIdRequest) Request a new sender ID that doesn't require registration.sendDestinationNumberVerificationCode
(Consumer<SendDestinationNumberVerificationCodeRequest.Builder> sendDestinationNumberVerificationCodeRequest) Before you can send test messages to a verified destination phone number you need to opt-in the verified destination phone number.sendDestinationNumberVerificationCode
(SendDestinationNumberVerificationCodeRequest sendDestinationNumberVerificationCodeRequest) Before you can send test messages to a verified destination phone number you need to opt-in the verified destination phone number.sendMediaMessage
(Consumer<SendMediaMessageRequest.Builder> sendMediaMessageRequest) Creates a new multimedia message (MMS) and sends it to a recipient's phone number.sendMediaMessage
(SendMediaMessageRequest sendMediaMessageRequest) Creates a new multimedia message (MMS) and sends it to a recipient's phone number.default CompletableFuture
<SendTextMessageResponse> sendTextMessage
(Consumer<SendTextMessageRequest.Builder> sendTextMessageRequest) Creates a new text message and sends it to a recipient's phone number.default CompletableFuture
<SendTextMessageResponse> sendTextMessage
(SendTextMessageRequest sendTextMessageRequest) Creates a new text message and sends it to a recipient's phone number.sendVoiceMessage
(Consumer<SendVoiceMessageRequest.Builder> sendVoiceMessageRequest) Allows you to send a request that sends a voice message through Amazon Pinpoint.sendVoiceMessage
(SendVoiceMessageRequest sendVoiceMessageRequest) Allows you to send a request that sends a voice message through Amazon Pinpoint.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationsetAccountDefaultProtectConfiguration
(Consumer<SetAccountDefaultProtectConfigurationRequest.Builder> setAccountDefaultProtectConfigurationRequest) Set a protect configuration as your account default.setAccountDefaultProtectConfiguration
(SetAccountDefaultProtectConfigurationRequest setAccountDefaultProtectConfigurationRequest) Set a protect configuration as your account default.setDefaultMessageType
(Consumer<SetDefaultMessageTypeRequest.Builder> setDefaultMessageTypeRequest) Sets the default message type on a configuration set.setDefaultMessageType
(SetDefaultMessageTypeRequest setDefaultMessageTypeRequest) Sets the default message type on a configuration set.setDefaultSenderId
(Consumer<SetDefaultSenderIdRequest.Builder> setDefaultSenderIdRequest) Sets default sender ID on a configuration set.setDefaultSenderId
(SetDefaultSenderIdRequest setDefaultSenderIdRequest) Sets default sender ID on a configuration set.setMediaMessageSpendLimitOverride
(Consumer<SetMediaMessageSpendLimitOverrideRequest.Builder> setMediaMessageSpendLimitOverrideRequest) Sets an account level monthly spend limit override for sending MMS messages.setMediaMessageSpendLimitOverride
(SetMediaMessageSpendLimitOverrideRequest setMediaMessageSpendLimitOverrideRequest) Sets an account level monthly spend limit override for sending MMS messages.setTextMessageSpendLimitOverride
(Consumer<SetTextMessageSpendLimitOverrideRequest.Builder> setTextMessageSpendLimitOverrideRequest) Sets an account level monthly spend limit override for sending text messages.setTextMessageSpendLimitOverride
(SetTextMessageSpendLimitOverrideRequest setTextMessageSpendLimitOverrideRequest) Sets an account level monthly spend limit override for sending text messages.setVoiceMessageSpendLimitOverride
(Consumer<SetVoiceMessageSpendLimitOverrideRequest.Builder> setVoiceMessageSpendLimitOverrideRequest) Sets an account level monthly spend limit override for sending voice messages.setVoiceMessageSpendLimitOverride
(SetVoiceMessageSpendLimitOverrideRequest setVoiceMessageSpendLimitOverrideRequest) Sets an account level monthly spend limit override for sending voice messages.submitRegistrationVersion
(Consumer<SubmitRegistrationVersionRequest.Builder> submitRegistrationVersionRequest) Submit the specified registration for review and approval.submitRegistrationVersion
(SubmitRegistrationVersionRequest submitRegistrationVersionRequest) Submit the specified registration for review and approval.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS Voice, version 2 resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS Voice, version 2 resource.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the association of the specified tags from an Amazon Pinpoint SMS Voice V2 resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes the association of the specified tags from an Amazon Pinpoint SMS Voice V2 resource.updateEventDestination
(Consumer<UpdateEventDestinationRequest.Builder> updateEventDestinationRequest) Updates an existing event destination in a configuration set.updateEventDestination
(UpdateEventDestinationRequest updateEventDestinationRequest) Updates an existing event destination in a configuration set.updatePhoneNumber
(Consumer<UpdatePhoneNumberRequest.Builder> updatePhoneNumberRequest) Updates the configuration of an existing origination phone number.updatePhoneNumber
(UpdatePhoneNumberRequest updatePhoneNumberRequest) Updates the configuration of an existing origination phone number.default CompletableFuture
<UpdatePoolResponse> updatePool
(Consumer<UpdatePoolRequest.Builder> updatePoolRequest) Updates the configuration of an existing pool.default CompletableFuture
<UpdatePoolResponse> updatePool
(UpdatePoolRequest updatePoolRequest) Updates the configuration of an existing pool.updateProtectConfiguration
(Consumer<UpdateProtectConfigurationRequest.Builder> updateProtectConfigurationRequest) Update the setting for an existing protect configuration.updateProtectConfiguration
(UpdateProtectConfigurationRequest updateProtectConfigurationRequest) Update the setting for an existing protect configuration.updateProtectConfigurationCountryRuleSet
(Consumer<UpdateProtectConfigurationCountryRuleSetRequest.Builder> updateProtectConfigurationCountryRuleSetRequest) Update a country rule set toALLOW
orBLOCK
messages to be sent to the specified destination counties.updateProtectConfigurationCountryRuleSet
(UpdateProtectConfigurationCountryRuleSetRequest updateProtectConfigurationCountryRuleSetRequest) Update a country rule set toALLOW
orBLOCK
messages to be sent to the specified destination counties.default CompletableFuture
<UpdateSenderIdResponse> updateSenderId
(Consumer<UpdateSenderIdRequest.Builder> updateSenderIdRequest) Updates the configuration of an existing sender ID.default CompletableFuture
<UpdateSenderIdResponse> updateSenderId
(UpdateSenderIdRequest updateSenderIdRequest) Updates the configuration of an existing sender ID.verifyDestinationNumber
(Consumer<VerifyDestinationNumberRequest.Builder> 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.verifyDestinationNumber
(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.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
associateOriginationIdentity
default CompletableFuture<AssociateOriginationIdentityResponse> associateOriginationIdentity(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.
- Parameters:
associateOriginationIdentityRequest
-- Returns:
- A Java Future containing the result of the AssociateOriginationIdentity operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
associateOriginationIdentity
default CompletableFuture<AssociateOriginationIdentityResponse> associateOriginationIdentity(Consumer<AssociateOriginationIdentityRequest.Builder> 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.
This is a convenience which creates an instance of the
AssociateOriginationIdentityRequest.Builder
avoiding the need to create one manually viaAssociateOriginationIdentityRequest.builder()
- Parameters:
associateOriginationIdentityRequest
- AConsumer
that will call methods onAssociateOriginationIdentityRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AssociateOriginationIdentity operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
associateProtectConfiguration
default CompletableFuture<AssociateProtectConfigurationResponse> associateProtectConfiguration(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.
- Parameters:
associateProtectConfigurationRequest
-- Returns:
- A Java Future containing the result of the AssociateProtectConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
associateProtectConfiguration
default CompletableFuture<AssociateProtectConfigurationResponse> associateProtectConfiguration(Consumer<AssociateProtectConfigurationRequest.Builder> 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.
This is a convenience which creates an instance of the
AssociateProtectConfigurationRequest.Builder
avoiding the need to create one manually viaAssociateProtectConfigurationRequest.builder()
- Parameters:
associateProtectConfigurationRequest
- AConsumer
that will call methods onAssociateProtectConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AssociateProtectConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createConfigurationSet
default CompletableFuture<CreateConfigurationSetResponse> createConfigurationSet(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.
- Parameters:
createConfigurationSetRequest
-- Returns:
- A Java Future containing the result of the CreateConfigurationSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createConfigurationSet
default CompletableFuture<CreateConfigurationSetResponse> createConfigurationSet(Consumer<CreateConfigurationSetRequest.Builder> 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.
This is a convenience which creates an instance of the
CreateConfigurationSetRequest.Builder
avoiding the need to create one manually viaCreateConfigurationSetRequest.builder()
- Parameters:
createConfigurationSetRequest
- AConsumer
that will call methods onCreateConfigurationSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateConfigurationSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createEventDestination
default CompletableFuture<CreateEventDestinationResponse> createEventDestination(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.
- Parameters:
createEventDestinationRequest
-- Returns:
- A Java Future containing the result of the CreateEventDestination operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createEventDestination
default CompletableFuture<CreateEventDestinationResponse> createEventDestination(Consumer<CreateEventDestinationRequest.Builder> 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.
This is a convenience which creates an instance of the
CreateEventDestinationRequest.Builder
avoiding the need to create one manually viaCreateEventDestinationRequest.builder()
- Parameters:
createEventDestinationRequest
- AConsumer
that will call methods onCreateEventDestinationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateEventDestination operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createOptOutList
default CompletableFuture<CreateOptOutListResponse> createOptOutList(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.
- Parameters:
createOptOutListRequest
-- Returns:
- A Java Future containing the result of the CreateOptOutList operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createOptOutList
default CompletableFuture<CreateOptOutListResponse> createOptOutList(Consumer<CreateOptOutListRequest.Builder> 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.
This is a convenience which creates an instance of the
CreateOptOutListRequest.Builder
avoiding the need to create one manually viaCreateOptOutListRequest.builder()
- Parameters:
createOptOutListRequest
- AConsumer
that will call methods onCreateOptOutListRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateOptOutList operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPool
Creates a new pool and associates the specified origination identity to the pool. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
The new pool inherits its configuration from the specified origination identity. This includes keywords, message type, opt-out list, two-way configuration, and self-managed opt-out configuration. Deletion protection isn't inherited from the origination identity and defaults to false.
If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.
- Parameters:
createPoolRequest
-- Returns:
- A Java Future containing the result of the CreatePool operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPool
default CompletableFuture<CreatePoolResponse> createPool(Consumer<CreatePoolRequest.Builder> 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.
This is a convenience which creates an instance of the
CreatePoolRequest.Builder
avoiding the need to create one manually viaCreatePoolRequest.builder()
- Parameters:
createPoolRequest
- AConsumer
that will call methods onCreatePoolRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreatePool operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createProtectConfiguration
default CompletableFuture<CreateProtectConfigurationResponse> createProtectConfiguration(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 usingUpdateProtectConfigurationCountryRuleSet
. A protect configurations name is stored as a Tag with the key set toName
and value as the name of the protect configuration.- Parameters:
createProtectConfigurationRequest
-- Returns:
- A Java Future containing the result of the CreateProtectConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createProtectConfiguration
default CompletableFuture<CreateProtectConfigurationResponse> createProtectConfiguration(Consumer<CreateProtectConfigurationRequest.Builder> createProtectConfigurationRequest) Create a new protect configuration. By default all country rule sets for each capability are set to
ALLOW
. Update the country rule sets usingUpdateProtectConfigurationCountryRuleSet
. A protect configurations name is stored as a Tag with the key set toName
and value as the name of the protect configuration.
This is a convenience which creates an instance of the
CreateProtectConfigurationRequest.Builder
avoiding the need to create one manually viaCreateProtectConfigurationRequest.builder()
- Parameters:
createProtectConfigurationRequest
- AConsumer
that will call methods onCreateProtectConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateProtectConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRegistration
default CompletableFuture<CreateRegistrationResponse> createRegistration(CreateRegistrationRequest createRegistrationRequest) Creates a new registration based on the RegistrationType field.
- Parameters:
createRegistrationRequest
-- Returns:
- A Java Future containing the result of the CreateRegistration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRegistration
default CompletableFuture<CreateRegistrationResponse> createRegistration(Consumer<CreateRegistrationRequest.Builder> createRegistrationRequest) Creates a new registration based on the RegistrationType field.
This is a convenience which creates an instance of the
CreateRegistrationRequest.Builder
avoiding the need to create one manually viaCreateRegistrationRequest.builder()
- Parameters:
createRegistrationRequest
- AConsumer
that will call methods onCreateRegistrationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateRegistration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRegistrationAssociation
default CompletableFuture<CreateRegistrationAssociationResponse> createRegistrationAssociation(CreateRegistrationAssociationRequest createRegistrationAssociationRequest) Associate the registration with an origination identity such as a phone number or sender ID.
- Parameters:
createRegistrationAssociationRequest
-- Returns:
- A Java Future containing the result of the CreateRegistrationAssociation operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRegistrationAssociation
default CompletableFuture<CreateRegistrationAssociationResponse> createRegistrationAssociation(Consumer<CreateRegistrationAssociationRequest.Builder> createRegistrationAssociationRequest) Associate the registration with an origination identity such as a phone number or sender ID.
This is a convenience which creates an instance of the
CreateRegistrationAssociationRequest.Builder
avoiding the need to create one manually viaCreateRegistrationAssociationRequest.builder()
- Parameters:
createRegistrationAssociationRequest
- AConsumer
that will call methods onCreateRegistrationAssociationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateRegistrationAssociation operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRegistrationAttachment
default CompletableFuture<CreateRegistrationAttachmentResponse> createRegistrationAttachment(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.
- Parameters:
createRegistrationAttachmentRequest
-- Returns:
- A Java Future containing the result of the CreateRegistrationAttachment operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRegistrationAttachment
default CompletableFuture<CreateRegistrationAttachmentResponse> createRegistrationAttachment(Consumer<CreateRegistrationAttachmentRequest.Builder> 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.
This is a convenience which creates an instance of the
CreateRegistrationAttachmentRequest.Builder
avoiding the need to create one manually viaCreateRegistrationAttachmentRequest.builder()
- Parameters:
createRegistrationAttachmentRequest
- AConsumer
that will call methods onCreateRegistrationAttachmentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateRegistrationAttachment operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRegistrationVersion
default CompletableFuture<CreateRegistrationVersionResponse> createRegistrationVersion(CreateRegistrationVersionRequest createRegistrationVersionRequest) Create a new version of the registration and increase the VersionNumber. The previous version of the registration becomes read-only.
- Parameters:
createRegistrationVersionRequest
-- Returns:
- A Java Future containing the result of the CreateRegistrationVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRegistrationVersion
default CompletableFuture<CreateRegistrationVersionResponse> createRegistrationVersion(Consumer<CreateRegistrationVersionRequest.Builder> createRegistrationVersionRequest) Create a new version of the registration and increase the VersionNumber. The previous version of the registration becomes read-only.
This is a convenience which creates an instance of the
CreateRegistrationVersionRequest.Builder
avoiding the need to create one manually viaCreateRegistrationVersionRequest.builder()
- Parameters:
createRegistrationVersionRequest
- AConsumer
that will call methods onCreateRegistrationVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateRegistrationVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createVerifiedDestinationNumber
default CompletableFuture<CreateVerifiedDestinationNumberResponse> createVerifiedDestinationNumber(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.
- Parameters:
createVerifiedDestinationNumberRequest
-- Returns:
- A Java Future containing the result of the CreateVerifiedDestinationNumber operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createVerifiedDestinationNumber
default CompletableFuture<CreateVerifiedDestinationNumberResponse> createVerifiedDestinationNumber(Consumer<CreateVerifiedDestinationNumberRequest.Builder> 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.
This is a convenience which creates an instance of the
CreateVerifiedDestinationNumberRequest.Builder
avoiding the need to create one manually viaCreateVerifiedDestinationNumberRequest.builder()
- Parameters:
createVerifiedDestinationNumberRequest
- AConsumer
that will call methods onCreateVerifiedDestinationNumberRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateVerifiedDestinationNumber operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAccountDefaultProtectConfiguration
default CompletableFuture<DeleteAccountDefaultProtectConfigurationResponse> deleteAccountDefaultProtectConfiguration(DeleteAccountDefaultProtectConfigurationRequest deleteAccountDefaultProtectConfigurationRequest) Removes the current account default protect configuration.
- Parameters:
deleteAccountDefaultProtectConfigurationRequest
-- Returns:
- A Java Future containing the result of the DeleteAccountDefaultProtectConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAccountDefaultProtectConfiguration
default CompletableFuture<DeleteAccountDefaultProtectConfigurationResponse> deleteAccountDefaultProtectConfiguration(Consumer<DeleteAccountDefaultProtectConfigurationRequest.Builder> deleteAccountDefaultProtectConfigurationRequest) Removes the current account default protect configuration.
This is a convenience which creates an instance of the
DeleteAccountDefaultProtectConfigurationRequest.Builder
avoiding the need to create one manually viaDeleteAccountDefaultProtectConfigurationRequest.builder()
- Parameters:
deleteAccountDefaultProtectConfigurationRequest
- AConsumer
that will call methods onDeleteAccountDefaultProtectConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAccountDefaultProtectConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteConfigurationSet
default CompletableFuture<DeleteConfigurationSetResponse> deleteConfigurationSet(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.
- Parameters:
deleteConfigurationSetRequest
-- Returns:
- A Java Future containing the result of the DeleteConfigurationSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteConfigurationSet
default CompletableFuture<DeleteConfigurationSetResponse> deleteConfigurationSet(Consumer<DeleteConfigurationSetRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteConfigurationSetRequest.Builder
avoiding the need to create one manually viaDeleteConfigurationSetRequest.builder()
- Parameters:
deleteConfigurationSetRequest
- AConsumer
that will call methods onDeleteConfigurationSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteConfigurationSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDefaultMessageType
default CompletableFuture<DeleteDefaultMessageTypeResponse> deleteDefaultMessageType(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.
- Parameters:
deleteDefaultMessageTypeRequest
-- Returns:
- A Java Future containing the result of the DeleteDefaultMessageType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDefaultMessageType
default CompletableFuture<DeleteDefaultMessageTypeResponse> deleteDefaultMessageType(Consumer<DeleteDefaultMessageTypeRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteDefaultMessageTypeRequest.Builder
avoiding the need to create one manually viaDeleteDefaultMessageTypeRequest.builder()
- Parameters:
deleteDefaultMessageTypeRequest
- AConsumer
that will call methods onDeleteDefaultMessageTypeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDefaultMessageType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDefaultSenderId
default CompletableFuture<DeleteDefaultSenderIdResponse> deleteDefaultSenderId(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.
- Parameters:
deleteDefaultSenderIdRequest
-- Returns:
- A Java Future containing the result of the DeleteDefaultSenderId operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDefaultSenderId
default CompletableFuture<DeleteDefaultSenderIdResponse> deleteDefaultSenderId(Consumer<DeleteDefaultSenderIdRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteDefaultSenderIdRequest.Builder
avoiding the need to create one manually viaDeleteDefaultSenderIdRequest.builder()
- Parameters:
deleteDefaultSenderIdRequest
- AConsumer
that will call methods onDeleteDefaultSenderIdRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDefaultSenderId operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteEventDestination
default CompletableFuture<DeleteEventDestinationResponse> deleteEventDestination(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.
- Parameters:
deleteEventDestinationRequest
-- Returns:
- A Java Future containing the result of the DeleteEventDestination operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteEventDestination
default CompletableFuture<DeleteEventDestinationResponse> deleteEventDestination(Consumer<DeleteEventDestinationRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteEventDestinationRequest.Builder
avoiding the need to create one manually viaDeleteEventDestinationRequest.builder()
- Parameters:
deleteEventDestinationRequest
- AConsumer
that will call methods onDeleteEventDestinationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteEventDestination operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteKeyword
default CompletableFuture<DeleteKeywordResponse> deleteKeyword(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.
- Parameters:
deleteKeywordRequest
-- Returns:
- A Java Future containing the result of the DeleteKeyword operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteKeyword
default CompletableFuture<DeleteKeywordResponse> deleteKeyword(Consumer<DeleteKeywordRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteKeywordRequest.Builder
avoiding the need to create one manually viaDeleteKeywordRequest.builder()
- Parameters:
deleteKeywordRequest
- AConsumer
that will call methods onDeleteKeywordRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteKeyword operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteMediaMessageSpendLimitOverride
default CompletableFuture<DeleteMediaMessageSpendLimitOverrideResponse> deleteMediaMessageSpendLimitOverride(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 theMaxLimit
, 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.- Parameters:
deleteMediaMessageSpendLimitOverrideRequest
-- Returns:
- A Java Future containing the result of the DeleteMediaMessageSpendLimitOverride operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteMediaMessageSpendLimitOverride
default CompletableFuture<DeleteMediaMessageSpendLimitOverrideResponse> deleteMediaMessageSpendLimitOverride(Consumer<DeleteMediaMessageSpendLimitOverrideRequest.Builder> 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 theMaxLimit
, 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.
This is a convenience which creates an instance of the
DeleteMediaMessageSpendLimitOverrideRequest.Builder
avoiding the need to create one manually viaDeleteMediaMessageSpendLimitOverrideRequest.builder()
- Parameters:
deleteMediaMessageSpendLimitOverrideRequest
- AConsumer
that will call methods onDeleteMediaMessageSpendLimitOverrideRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteMediaMessageSpendLimitOverride operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteOptOutList
default CompletableFuture<DeleteOptOutListResponse> deleteOptOutList(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.
- Parameters:
deleteOptOutListRequest
-- Returns:
- A Java Future containing the result of the DeleteOptOutList operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteOptOutList
default CompletableFuture<DeleteOptOutListResponse> deleteOptOutList(Consumer<DeleteOptOutListRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteOptOutListRequest.Builder
avoiding the need to create one manually viaDeleteOptOutListRequest.builder()
- Parameters:
deleteOptOutListRequest
- AConsumer
that will call methods onDeleteOptOutListRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteOptOutList operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteOptedOutNumber
default CompletableFuture<DeleteOptedOutNumberResponse> deleteOptedOutNumber(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.
- Parameters:
deleteOptedOutNumberRequest
-- Returns:
- A Java Future containing the result of the DeleteOptedOutNumber operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteOptedOutNumber
default CompletableFuture<DeleteOptedOutNumberResponse> deleteOptedOutNumber(Consumer<DeleteOptedOutNumberRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteOptedOutNumberRequest.Builder
avoiding the need to create one manually viaDeleteOptedOutNumberRequest.builder()
- Parameters:
deleteOptedOutNumberRequest
- AConsumer
that will call methods onDeleteOptedOutNumberRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteOptedOutNumber operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePool
Deletes an existing pool. Deleting a pool disassociates all origination identities from that pool.
If the pool status isn't active or if deletion protection is enabled, an error is returned.
A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
- Parameters:
deletePoolRequest
-- Returns:
- A Java Future containing the result of the DeletePool operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePool
default CompletableFuture<DeletePoolResponse> deletePool(Consumer<DeletePoolRequest.Builder> 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.
This is a convenience which creates an instance of the
DeletePoolRequest.Builder
avoiding the need to create one manually viaDeletePoolRequest.builder()
- Parameters:
deletePoolRequest
- AConsumer
that will call methods onDeletePoolRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeletePool operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteProtectConfiguration
default CompletableFuture<DeleteProtectConfigurationResponse> deleteProtectConfiguration(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.
- Parameters:
deleteProtectConfigurationRequest
-- Returns:
- A Java Future containing the result of the DeleteProtectConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteProtectConfiguration
default CompletableFuture<DeleteProtectConfigurationResponse> deleteProtectConfiguration(Consumer<DeleteProtectConfigurationRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteProtectConfigurationRequest.Builder
avoiding the need to create one manually viaDeleteProtectConfigurationRequest.builder()
- Parameters:
deleteProtectConfigurationRequest
- AConsumer
that will call methods onDeleteProtectConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteProtectConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRegistration
default CompletableFuture<DeleteRegistrationResponse> deleteRegistration(DeleteRegistrationRequest deleteRegistrationRequest) Permanently delete an existing registration from your account.
- Parameters:
deleteRegistrationRequest
-- Returns:
- A Java Future containing the result of the DeleteRegistration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRegistration
default CompletableFuture<DeleteRegistrationResponse> deleteRegistration(Consumer<DeleteRegistrationRequest.Builder> deleteRegistrationRequest) Permanently delete an existing registration from your account.
This is a convenience which creates an instance of the
DeleteRegistrationRequest.Builder
avoiding the need to create one manually viaDeleteRegistrationRequest.builder()
- Parameters:
deleteRegistrationRequest
- AConsumer
that will call methods onDeleteRegistrationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteRegistration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRegistrationAttachment
default CompletableFuture<DeleteRegistrationAttachmentResponse> deleteRegistrationAttachment(DeleteRegistrationAttachmentRequest deleteRegistrationAttachmentRequest) Permanently delete the specified registration attachment.
- Parameters:
deleteRegistrationAttachmentRequest
-- Returns:
- A Java Future containing the result of the DeleteRegistrationAttachment operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRegistrationAttachment
default CompletableFuture<DeleteRegistrationAttachmentResponse> deleteRegistrationAttachment(Consumer<DeleteRegistrationAttachmentRequest.Builder> deleteRegistrationAttachmentRequest) Permanently delete the specified registration attachment.
This is a convenience which creates an instance of the
DeleteRegistrationAttachmentRequest.Builder
avoiding the need to create one manually viaDeleteRegistrationAttachmentRequest.builder()
- Parameters:
deleteRegistrationAttachmentRequest
- AConsumer
that will call methods onDeleteRegistrationAttachmentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteRegistrationAttachment operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRegistrationFieldValue
default CompletableFuture<DeleteRegistrationFieldValueResponse> deleteRegistrationFieldValue(DeleteRegistrationFieldValueRequest deleteRegistrationFieldValueRequest) Delete the value in a registration form field.
- Parameters:
deleteRegistrationFieldValueRequest
-- Returns:
- A Java Future containing the result of the DeleteRegistrationFieldValue operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRegistrationFieldValue
default CompletableFuture<DeleteRegistrationFieldValueResponse> deleteRegistrationFieldValue(Consumer<DeleteRegistrationFieldValueRequest.Builder> deleteRegistrationFieldValueRequest) Delete the value in a registration form field.
This is a convenience which creates an instance of the
DeleteRegistrationFieldValueRequest.Builder
avoiding the need to create one manually viaDeleteRegistrationFieldValueRequest.builder()
- Parameters:
deleteRegistrationFieldValueRequest
- AConsumer
that will call methods onDeleteRegistrationFieldValueRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteRegistrationFieldValue operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTextMessageSpendLimitOverride
default CompletableFuture<DeleteTextMessageSpendLimitOverrideResponse> deleteTextMessageSpendLimitOverride(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 theMaxLimit
, which is controlled by Amazon Web Services. For more information on spend limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.- Parameters:
deleteTextMessageSpendLimitOverrideRequest
-- Returns:
- A Java Future containing the result of the DeleteTextMessageSpendLimitOverride operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTextMessageSpendLimitOverride
default CompletableFuture<DeleteTextMessageSpendLimitOverrideResponse> deleteTextMessageSpendLimitOverride(Consumer<DeleteTextMessageSpendLimitOverrideRequest.Builder> deleteTextMessageSpendLimitOverrideRequest) Deletes an account-level monthly spending limit override for sending text messages. Deleting a spend limit override will set the
EnforcedLimit
to equal theMaxLimit
, which is controlled by Amazon Web Services. For more information on spend limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
This is a convenience which creates an instance of the
DeleteTextMessageSpendLimitOverrideRequest.Builder
avoiding the need to create one manually viaDeleteTextMessageSpendLimitOverrideRequest.builder()
- Parameters:
deleteTextMessageSpendLimitOverrideRequest
- AConsumer
that will call methods onDeleteTextMessageSpendLimitOverrideRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteTextMessageSpendLimitOverride operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteVerifiedDestinationNumber
default CompletableFuture<DeleteVerifiedDestinationNumberResponse> deleteVerifiedDestinationNumber(DeleteVerifiedDestinationNumberRequest deleteVerifiedDestinationNumberRequest) Delete a verified destination phone number.
- Parameters:
deleteVerifiedDestinationNumberRequest
-- Returns:
- A Java Future containing the result of the DeleteVerifiedDestinationNumber operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteVerifiedDestinationNumber
default CompletableFuture<DeleteVerifiedDestinationNumberResponse> deleteVerifiedDestinationNumber(Consumer<DeleteVerifiedDestinationNumberRequest.Builder> deleteVerifiedDestinationNumberRequest) Delete a verified destination phone number.
This is a convenience which creates an instance of the
DeleteVerifiedDestinationNumberRequest.Builder
avoiding the need to create one manually viaDeleteVerifiedDestinationNumberRequest.builder()
- Parameters:
deleteVerifiedDestinationNumberRequest
- AConsumer
that will call methods onDeleteVerifiedDestinationNumberRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteVerifiedDestinationNumber operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteVoiceMessageSpendLimitOverride
default CompletableFuture<DeleteVoiceMessageSpendLimitOverrideResponse> deleteVoiceMessageSpendLimitOverride(DeleteVoiceMessageSpendLimitOverrideRequest deleteVoiceMessageSpendLimitOverrideRequest) Deletes an account level monthly spend limit override for sending voice messages. Deleting a spend limit override sets the
EnforcedLimit
equal to theMaxLimit
, which is controlled by Amazon Web Services. For more information on spending limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.- Parameters:
deleteVoiceMessageSpendLimitOverrideRequest
-- Returns:
- A Java Future containing the result of the DeleteVoiceMessageSpendLimitOverride operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteVoiceMessageSpendLimitOverride
default CompletableFuture<DeleteVoiceMessageSpendLimitOverrideResponse> deleteVoiceMessageSpendLimitOverride(Consumer<DeleteVoiceMessageSpendLimitOverrideRequest.Builder> deleteVoiceMessageSpendLimitOverrideRequest) Deletes an account level monthly spend limit override for sending voice messages. Deleting a spend limit override sets the
EnforcedLimit
equal to theMaxLimit
, which is controlled by Amazon Web Services. For more information on spending limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
This is a convenience which creates an instance of the
DeleteVoiceMessageSpendLimitOverrideRequest.Builder
avoiding the need to create one manually viaDeleteVoiceMessageSpendLimitOverrideRequest.builder()
- Parameters:
deleteVoiceMessageSpendLimitOverrideRequest
- AConsumer
that will call methods onDeleteVoiceMessageSpendLimitOverrideRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteVoiceMessageSpendLimitOverride operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAccountAttributes
default CompletableFuture<DescribeAccountAttributesResponse> describeAccountAttributes(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.
- Parameters:
describeAccountAttributesRequest
-- Returns:
- A Java Future containing the result of the DescribeAccountAttributes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAccountAttributes
default CompletableFuture<DescribeAccountAttributesResponse> describeAccountAttributes(Consumer<DescribeAccountAttributesRequest.Builder> 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.
This is a convenience which creates an instance of the
DescribeAccountAttributesRequest.Builder
avoiding the need to create one manually viaDescribeAccountAttributesRequest.builder()
- Parameters:
describeAccountAttributesRequest
- AConsumer
that will call methods onDescribeAccountAttributesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeAccountAttributes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAccountAttributesPaginator
default DescribeAccountAttributesPublisher describeAccountAttributesPaginator(DescribeAccountAttributesRequest describeAccountAttributesRequest) This is a variant of
describeAccountAttributes(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeAccountAttributesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeAccountAttributesPublisher publisher = client.describeAccountAttributesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeAccountAttributesPublisher publisher = client.describeAccountAttributesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeAccountAttributesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeAccountAttributesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAccountAttributes(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeAccountAttributesRequest)
operation.- Parameters:
describeAccountAttributesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAccountAttributesPaginator
default DescribeAccountAttributesPublisher describeAccountAttributesPaginator(Consumer<DescribeAccountAttributesRequest.Builder> describeAccountAttributesRequest) This is a variant of
describeAccountAttributes(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeAccountAttributesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeAccountAttributesPublisher publisher = client.describeAccountAttributesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeAccountAttributesPublisher publisher = client.describeAccountAttributesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeAccountAttributesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeAccountAttributesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAccountAttributes(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeAccountAttributesRequest)
operation.
This is a convenience which creates an instance of the
DescribeAccountAttributesRequest.Builder
avoiding the need to create one manually viaDescribeAccountAttributesRequest.builder()
- Parameters:
describeAccountAttributesRequest
- AConsumer
that will call methods onDescribeAccountAttributesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAccountLimits
default CompletableFuture<DescribeAccountLimitsResponse> describeAccountLimits(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.
- Parameters:
describeAccountLimitsRequest
-- Returns:
- A Java Future containing the result of the DescribeAccountLimits operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAccountLimits
default CompletableFuture<DescribeAccountLimitsResponse> describeAccountLimits(Consumer<DescribeAccountLimitsRequest.Builder> 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.
This is a convenience which creates an instance of the
DescribeAccountLimitsRequest.Builder
avoiding the need to create one manually viaDescribeAccountLimitsRequest.builder()
- Parameters:
describeAccountLimitsRequest
- AConsumer
that will call methods onDescribeAccountLimitsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeAccountLimits operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAccountLimitsPaginator
default DescribeAccountLimitsPublisher describeAccountLimitsPaginator(DescribeAccountLimitsRequest describeAccountLimitsRequest) This is a variant of
describeAccountLimits(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeAccountLimitsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeAccountLimitsPublisher publisher = client.describeAccountLimitsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeAccountLimitsPublisher publisher = client.describeAccountLimitsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeAccountLimitsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeAccountLimitsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAccountLimits(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeAccountLimitsRequest)
operation.- Parameters:
describeAccountLimitsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAccountLimitsPaginator
default DescribeAccountLimitsPublisher describeAccountLimitsPaginator(Consumer<DescribeAccountLimitsRequest.Builder> describeAccountLimitsRequest) This is a variant of
describeAccountLimits(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeAccountLimitsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeAccountLimitsPublisher publisher = client.describeAccountLimitsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeAccountLimitsPublisher publisher = client.describeAccountLimitsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeAccountLimitsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeAccountLimitsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAccountLimits(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeAccountLimitsRequest)
operation.
This is a convenience which creates an instance of the
DescribeAccountLimitsRequest.Builder
avoiding the need to create one manually viaDescribeAccountLimitsRequest.builder()
- Parameters:
describeAccountLimitsRequest
- AConsumer
that will call methods onDescribeAccountLimitsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConfigurationSets
default CompletableFuture<DescribeConfigurationSetsResponse> describeConfigurationSets(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.
- Parameters:
describeConfigurationSetsRequest
-- Returns:
- A Java Future containing the result of the DescribeConfigurationSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConfigurationSets
default CompletableFuture<DescribeConfigurationSetsResponse> describeConfigurationSets(Consumer<DescribeConfigurationSetsRequest.Builder> 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.
This is a convenience which creates an instance of the
DescribeConfigurationSetsRequest.Builder
avoiding the need to create one manually viaDescribeConfigurationSetsRequest.builder()
- Parameters:
describeConfigurationSetsRequest
- AConsumer
that will call methods onDescribeConfigurationSetsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeConfigurationSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConfigurationSetsPaginator
default DescribeConfigurationSetsPublisher describeConfigurationSetsPaginator(DescribeConfigurationSetsRequest describeConfigurationSetsRequest) This is a variant of
describeConfigurationSets(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeConfigurationSetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeConfigurationSetsPublisher publisher = client.describeConfigurationSetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeConfigurationSetsPublisher publisher = client.describeConfigurationSetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeConfigurationSetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeConfigurationSetsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeConfigurationSets(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeConfigurationSetsRequest)
operation.- Parameters:
describeConfigurationSetsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConfigurationSetsPaginator
default DescribeConfigurationSetsPublisher describeConfigurationSetsPaginator(Consumer<DescribeConfigurationSetsRequest.Builder> describeConfigurationSetsRequest) This is a variant of
describeConfigurationSets(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeConfigurationSetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeConfigurationSetsPublisher publisher = client.describeConfigurationSetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeConfigurationSetsPublisher publisher = client.describeConfigurationSetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeConfigurationSetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeConfigurationSetsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeConfigurationSets(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeConfigurationSetsRequest)
operation.
This is a convenience which creates an instance of the
DescribeConfigurationSetsRequest.Builder
avoiding the need to create one manually viaDescribeConfigurationSetsRequest.builder()
- Parameters:
describeConfigurationSetsRequest
- AConsumer
that will call methods onDescribeConfigurationSetsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeKeywords
default CompletableFuture<DescribeKeywordsResponse> describeKeywords(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.
- Parameters:
describeKeywordsRequest
-- Returns:
- A Java Future containing the result of the DescribeKeywords operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeKeywords
default CompletableFuture<DescribeKeywordsResponse> describeKeywords(Consumer<DescribeKeywordsRequest.Builder> 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.
This is a convenience which creates an instance of the
DescribeKeywordsRequest.Builder
avoiding the need to create one manually viaDescribeKeywordsRequest.builder()
- Parameters:
describeKeywordsRequest
- AConsumer
that will call methods onDescribeKeywordsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeKeywords operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeKeywordsPaginator
default DescribeKeywordsPublisher describeKeywordsPaginator(DescribeKeywordsRequest describeKeywordsRequest) This is a variant of
describeKeywords(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeKeywordsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeKeywordsPublisher publisher = client.describeKeywordsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeKeywordsPublisher publisher = client.describeKeywordsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeKeywordsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeKeywordsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeKeywords(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeKeywordsRequest)
operation.- Parameters:
describeKeywordsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeKeywordsPaginator
default DescribeKeywordsPublisher describeKeywordsPaginator(Consumer<DescribeKeywordsRequest.Builder> describeKeywordsRequest) This is a variant of
describeKeywords(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeKeywordsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeKeywordsPublisher publisher = client.describeKeywordsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeKeywordsPublisher publisher = client.describeKeywordsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeKeywordsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeKeywordsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeKeywords(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeKeywordsRequest)
operation.
This is a convenience which creates an instance of the
DescribeKeywordsRequest.Builder
avoiding the need to create one manually viaDescribeKeywordsRequest.builder()
- Parameters:
describeKeywordsRequest
- AConsumer
that will call methods onDescribeKeywordsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOptOutLists
default CompletableFuture<DescribeOptOutListsResponse> describeOptOutLists(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.
- Parameters:
describeOptOutListsRequest
-- Returns:
- A Java Future containing the result of the DescribeOptOutLists operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOptOutLists
default CompletableFuture<DescribeOptOutListsResponse> describeOptOutLists(Consumer<DescribeOptOutListsRequest.Builder> 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.
This is a convenience which creates an instance of the
DescribeOptOutListsRequest.Builder
avoiding the need to create one manually viaDescribeOptOutListsRequest.builder()
- Parameters:
describeOptOutListsRequest
- AConsumer
that will call methods onDescribeOptOutListsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeOptOutLists operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOptOutListsPaginator
default DescribeOptOutListsPublisher describeOptOutListsPaginator(DescribeOptOutListsRequest describeOptOutListsRequest) This is a variant of
describeOptOutLists(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeOptOutListsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeOptOutListsPublisher publisher = client.describeOptOutListsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeOptOutListsPublisher publisher = client.describeOptOutListsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeOptOutListsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeOptOutListsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeOptOutLists(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeOptOutListsRequest)
operation.- Parameters:
describeOptOutListsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOptOutListsPaginator
default DescribeOptOutListsPublisher describeOptOutListsPaginator(Consumer<DescribeOptOutListsRequest.Builder> describeOptOutListsRequest) This is a variant of
describeOptOutLists(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeOptOutListsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeOptOutListsPublisher publisher = client.describeOptOutListsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeOptOutListsPublisher publisher = client.describeOptOutListsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeOptOutListsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeOptOutListsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeOptOutLists(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeOptOutListsRequest)
operation.
This is a convenience which creates an instance of the
DescribeOptOutListsRequest.Builder
avoiding the need to create one manually viaDescribeOptOutListsRequest.builder()
- Parameters:
describeOptOutListsRequest
- AConsumer
that will call methods onDescribeOptOutListsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOptedOutNumbers
default CompletableFuture<DescribeOptedOutNumbersResponse> describeOptedOutNumbers(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.
- Parameters:
describeOptedOutNumbersRequest
-- Returns:
- A Java Future containing the result of the DescribeOptedOutNumbers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOptedOutNumbers
default CompletableFuture<DescribeOptedOutNumbersResponse> describeOptedOutNumbers(Consumer<DescribeOptedOutNumbersRequest.Builder> 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.
This is a convenience which creates an instance of the
DescribeOptedOutNumbersRequest.Builder
avoiding the need to create one manually viaDescribeOptedOutNumbersRequest.builder()
- Parameters:
describeOptedOutNumbersRequest
- AConsumer
that will call methods onDescribeOptedOutNumbersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeOptedOutNumbers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOptedOutNumbersPaginator
default DescribeOptedOutNumbersPublisher describeOptedOutNumbersPaginator(DescribeOptedOutNumbersRequest describeOptedOutNumbersRequest) This is a variant of
describeOptedOutNumbers(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeOptedOutNumbersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeOptedOutNumbersPublisher publisher = client.describeOptedOutNumbersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeOptedOutNumbersPublisher publisher = client.describeOptedOutNumbersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeOptedOutNumbersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeOptedOutNumbersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeOptedOutNumbers(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeOptedOutNumbersRequest)
operation.- Parameters:
describeOptedOutNumbersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOptedOutNumbersPaginator
default DescribeOptedOutNumbersPublisher describeOptedOutNumbersPaginator(Consumer<DescribeOptedOutNumbersRequest.Builder> describeOptedOutNumbersRequest) This is a variant of
describeOptedOutNumbers(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeOptedOutNumbersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeOptedOutNumbersPublisher publisher = client.describeOptedOutNumbersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeOptedOutNumbersPublisher publisher = client.describeOptedOutNumbersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeOptedOutNumbersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeOptedOutNumbersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeOptedOutNumbers(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeOptedOutNumbersRequest)
operation.
This is a convenience which creates an instance of the
DescribeOptedOutNumbersRequest.Builder
avoiding the need to create one manually viaDescribeOptedOutNumbersRequest.builder()
- Parameters:
describeOptedOutNumbersRequest
- AConsumer
that will call methods onDescribeOptedOutNumbersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePhoneNumbers
default CompletableFuture<DescribePhoneNumbersResponse> describePhoneNumbers(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.
- Parameters:
describePhoneNumbersRequest
-- Returns:
- A Java Future containing the result of the DescribePhoneNumbers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePhoneNumbers
default CompletableFuture<DescribePhoneNumbersResponse> describePhoneNumbers(Consumer<DescribePhoneNumbersRequest.Builder> 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.
This is a convenience which creates an instance of the
DescribePhoneNumbersRequest.Builder
avoiding the need to create one manually viaDescribePhoneNumbersRequest.builder()
- Parameters:
describePhoneNumbersRequest
- AConsumer
that will call methods onDescribePhoneNumbersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribePhoneNumbers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePhoneNumbersPaginator
default DescribePhoneNumbersPublisher describePhoneNumbersPaginator(DescribePhoneNumbersRequest describePhoneNumbersRequest) This is a variant of
describePhoneNumbers(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribePhoneNumbersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribePhoneNumbersPublisher publisher = client.describePhoneNumbersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribePhoneNumbersPublisher publisher = client.describePhoneNumbersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribePhoneNumbersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribePhoneNumbersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePhoneNumbers(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribePhoneNumbersRequest)
operation.- Parameters:
describePhoneNumbersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePhoneNumbersPaginator
default DescribePhoneNumbersPublisher describePhoneNumbersPaginator(Consumer<DescribePhoneNumbersRequest.Builder> describePhoneNumbersRequest) This is a variant of
describePhoneNumbers(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribePhoneNumbersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribePhoneNumbersPublisher publisher = client.describePhoneNumbersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribePhoneNumbersPublisher publisher = client.describePhoneNumbersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribePhoneNumbersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribePhoneNumbersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePhoneNumbers(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribePhoneNumbersRequest)
operation.
This is a convenience which creates an instance of the
DescribePhoneNumbersRequest.Builder
avoiding the need to create one manually viaDescribePhoneNumbersRequest.builder()
- Parameters:
describePhoneNumbersRequest
- AConsumer
that will call methods onDescribePhoneNumbersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePools
default CompletableFuture<DescribePoolsResponse> describePools(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.
- Parameters:
describePoolsRequest
-- Returns:
- A Java Future containing the result of the DescribePools operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePools
default CompletableFuture<DescribePoolsResponse> describePools(Consumer<DescribePoolsRequest.Builder> 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.
This is a convenience which creates an instance of the
DescribePoolsRequest.Builder
avoiding the need to create one manually viaDescribePoolsRequest.builder()
- Parameters:
describePoolsRequest
- AConsumer
that will call methods onDescribePoolsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribePools operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePoolsPaginator
This is a variant of
describePools(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribePoolsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribePoolsPublisher publisher = client.describePoolsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribePoolsPublisher publisher = client.describePoolsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribePoolsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribePoolsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePools(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribePoolsRequest)
operation.- Parameters:
describePoolsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePoolsPaginator
default DescribePoolsPublisher describePoolsPaginator(Consumer<DescribePoolsRequest.Builder> describePoolsRequest) This is a variant of
describePools(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribePoolsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribePoolsPublisher publisher = client.describePoolsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribePoolsPublisher publisher = client.describePoolsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribePoolsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribePoolsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePools(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribePoolsRequest)
operation.
This is a convenience which creates an instance of the
DescribePoolsRequest.Builder
avoiding the need to create one manually viaDescribePoolsRequest.builder()
- Parameters:
describePoolsRequest
- AConsumer
that will call methods onDescribePoolsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeProtectConfigurations
default CompletableFuture<DescribeProtectConfigurationsResponse> describeProtectConfigurations(DescribeProtectConfigurationsRequest describeProtectConfigurationsRequest) Retrieves the protect configurations that match any of filters. If a filter isn’t provided then all protect configurations are returned.
- Parameters:
describeProtectConfigurationsRequest
-- Returns:
- A Java Future containing the result of the DescribeProtectConfigurations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeProtectConfigurations
default CompletableFuture<DescribeProtectConfigurationsResponse> describeProtectConfigurations(Consumer<DescribeProtectConfigurationsRequest.Builder> describeProtectConfigurationsRequest) Retrieves the protect configurations that match any of filters. If a filter isn’t provided then all protect configurations are returned.
This is a convenience which creates an instance of the
DescribeProtectConfigurationsRequest.Builder
avoiding the need to create one manually viaDescribeProtectConfigurationsRequest.builder()
- Parameters:
describeProtectConfigurationsRequest
- AConsumer
that will call methods onDescribeProtectConfigurationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeProtectConfigurations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeProtectConfigurationsPaginator
default DescribeProtectConfigurationsPublisher describeProtectConfigurationsPaginator(DescribeProtectConfigurationsRequest describeProtectConfigurationsRequest) This is a variant of
describeProtectConfigurations(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeProtectConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeProtectConfigurationsPublisher publisher = client.describeProtectConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeProtectConfigurationsPublisher publisher = client.describeProtectConfigurationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeProtectConfigurationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeProtectConfigurationsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeProtectConfigurations(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeProtectConfigurationsRequest)
operation.- Parameters:
describeProtectConfigurationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeProtectConfigurationsPaginator
default DescribeProtectConfigurationsPublisher describeProtectConfigurationsPaginator(Consumer<DescribeProtectConfigurationsRequest.Builder> describeProtectConfigurationsRequest) This is a variant of
describeProtectConfigurations(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeProtectConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeProtectConfigurationsPublisher publisher = client.describeProtectConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeProtectConfigurationsPublisher publisher = client.describeProtectConfigurationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeProtectConfigurationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeProtectConfigurationsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeProtectConfigurations(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeProtectConfigurationsRequest)
operation.
This is a convenience which creates an instance of the
DescribeProtectConfigurationsRequest.Builder
avoiding the need to create one manually viaDescribeProtectConfigurationsRequest.builder()
- Parameters:
describeProtectConfigurationsRequest
- AConsumer
that will call methods onDescribeProtectConfigurationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRegistrationAttachments
default CompletableFuture<DescribeRegistrationAttachmentsResponse> describeRegistrationAttachments(DescribeRegistrationAttachmentsRequest describeRegistrationAttachmentsRequest) Retrieves the specified registration attachments or all registration attachments associated with your Amazon Web Services account.
- Parameters:
describeRegistrationAttachmentsRequest
-- Returns:
- A Java Future containing the result of the DescribeRegistrationAttachments operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRegistrationAttachments
default CompletableFuture<DescribeRegistrationAttachmentsResponse> describeRegistrationAttachments(Consumer<DescribeRegistrationAttachmentsRequest.Builder> describeRegistrationAttachmentsRequest) Retrieves the specified registration attachments or all registration attachments associated with your Amazon Web Services account.
This is a convenience which creates an instance of the
DescribeRegistrationAttachmentsRequest.Builder
avoiding the need to create one manually viaDescribeRegistrationAttachmentsRequest.builder()
- Parameters:
describeRegistrationAttachmentsRequest
- AConsumer
that will call methods onDescribeRegistrationAttachmentsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeRegistrationAttachments operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRegistrationAttachmentsPaginator
default DescribeRegistrationAttachmentsPublisher describeRegistrationAttachmentsPaginator(DescribeRegistrationAttachmentsRequest describeRegistrationAttachmentsRequest) This is a variant of
describeRegistrationAttachments(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationAttachmentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeRegistrationAttachmentsPublisher publisher = client.describeRegistrationAttachmentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeRegistrationAttachmentsPublisher publisher = client.describeRegistrationAttachmentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationAttachmentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationAttachmentsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRegistrationAttachments(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationAttachmentsRequest)
operation.- Parameters:
describeRegistrationAttachmentsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRegistrationAttachmentsPaginator
default DescribeRegistrationAttachmentsPublisher describeRegistrationAttachmentsPaginator(Consumer<DescribeRegistrationAttachmentsRequest.Builder> describeRegistrationAttachmentsRequest) This is a variant of
describeRegistrationAttachments(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationAttachmentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeRegistrationAttachmentsPublisher publisher = client.describeRegistrationAttachmentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeRegistrationAttachmentsPublisher publisher = client.describeRegistrationAttachmentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationAttachmentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationAttachmentsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRegistrationAttachments(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationAttachmentsRequest)
operation.
This is a convenience which creates an instance of the
DescribeRegistrationAttachmentsRequest.Builder
avoiding the need to create one manually viaDescribeRegistrationAttachmentsRequest.builder()
- Parameters:
describeRegistrationAttachmentsRequest
- AConsumer
that will call methods onDescribeRegistrationAttachmentsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRegistrationFieldDefinitions
default CompletableFuture<DescribeRegistrationFieldDefinitionsResponse> describeRegistrationFieldDefinitions(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.
- Parameters:
describeRegistrationFieldDefinitionsRequest
-- Returns:
- A Java Future containing the result of the DescribeRegistrationFieldDefinitions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRegistrationFieldDefinitions
default CompletableFuture<DescribeRegistrationFieldDefinitionsResponse> describeRegistrationFieldDefinitions(Consumer<DescribeRegistrationFieldDefinitionsRequest.Builder> 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.
This is a convenience which creates an instance of the
DescribeRegistrationFieldDefinitionsRequest.Builder
avoiding the need to create one manually viaDescribeRegistrationFieldDefinitionsRequest.builder()
- Parameters:
describeRegistrationFieldDefinitionsRequest
- AConsumer
that will call methods onDescribeRegistrationFieldDefinitionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeRegistrationFieldDefinitions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRegistrationFieldDefinitionsPaginator
default DescribeRegistrationFieldDefinitionsPublisher describeRegistrationFieldDefinitionsPaginator(DescribeRegistrationFieldDefinitionsRequest describeRegistrationFieldDefinitionsRequest) This is a variant of
describeRegistrationFieldDefinitions(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationFieldDefinitionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeRegistrationFieldDefinitionsPublisher publisher = client.describeRegistrationFieldDefinitionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeRegistrationFieldDefinitionsPublisher publisher = client.describeRegistrationFieldDefinitionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationFieldDefinitionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationFieldDefinitionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRegistrationFieldDefinitions(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationFieldDefinitionsRequest)
operation.- Parameters:
describeRegistrationFieldDefinitionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRegistrationFieldDefinitionsPaginator
default DescribeRegistrationFieldDefinitionsPublisher describeRegistrationFieldDefinitionsPaginator(Consumer<DescribeRegistrationFieldDefinitionsRequest.Builder> describeRegistrationFieldDefinitionsRequest) This is a variant of
describeRegistrationFieldDefinitions(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationFieldDefinitionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeRegistrationFieldDefinitionsPublisher publisher = client.describeRegistrationFieldDefinitionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeRegistrationFieldDefinitionsPublisher publisher = client.describeRegistrationFieldDefinitionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationFieldDefinitionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationFieldDefinitionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRegistrationFieldDefinitions(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationFieldDefinitionsRequest)
operation.
This is a convenience which creates an instance of the
DescribeRegistrationFieldDefinitionsRequest.Builder
avoiding the need to create one manually viaDescribeRegistrationFieldDefinitionsRequest.builder()
- Parameters:
describeRegistrationFieldDefinitionsRequest
- AConsumer
that will call methods onDescribeRegistrationFieldDefinitionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRegistrationFieldValues
default CompletableFuture<DescribeRegistrationFieldValuesResponse> describeRegistrationFieldValues(DescribeRegistrationFieldValuesRequest describeRegistrationFieldValuesRequest) Retrieves the specified registration field values.
- Parameters:
describeRegistrationFieldValuesRequest
-- Returns:
- A Java Future containing the result of the DescribeRegistrationFieldValues operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRegistrationFieldValues
default CompletableFuture<DescribeRegistrationFieldValuesResponse> describeRegistrationFieldValues(Consumer<DescribeRegistrationFieldValuesRequest.Builder> describeRegistrationFieldValuesRequest) Retrieves the specified registration field values.
This is a convenience which creates an instance of the
DescribeRegistrationFieldValuesRequest.Builder
avoiding the need to create one manually viaDescribeRegistrationFieldValuesRequest.builder()
- Parameters:
describeRegistrationFieldValuesRequest
- AConsumer
that will call methods onDescribeRegistrationFieldValuesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeRegistrationFieldValues operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRegistrationFieldValuesPaginator
default DescribeRegistrationFieldValuesPublisher describeRegistrationFieldValuesPaginator(DescribeRegistrationFieldValuesRequest describeRegistrationFieldValuesRequest) This is a variant of
describeRegistrationFieldValues(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationFieldValuesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeRegistrationFieldValuesPublisher publisher = client.describeRegistrationFieldValuesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeRegistrationFieldValuesPublisher publisher = client.describeRegistrationFieldValuesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationFieldValuesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationFieldValuesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRegistrationFieldValues(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationFieldValuesRequest)
operation.- Parameters:
describeRegistrationFieldValuesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRegistrationFieldValuesPaginator
default DescribeRegistrationFieldValuesPublisher describeRegistrationFieldValuesPaginator(Consumer<DescribeRegistrationFieldValuesRequest.Builder> describeRegistrationFieldValuesRequest) This is a variant of
describeRegistrationFieldValues(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationFieldValuesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeRegistrationFieldValuesPublisher publisher = client.describeRegistrationFieldValuesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeRegistrationFieldValuesPublisher publisher = client.describeRegistrationFieldValuesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationFieldValuesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationFieldValuesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRegistrationFieldValues(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationFieldValuesRequest)
operation.
This is a convenience which creates an instance of the
DescribeRegistrationFieldValuesRequest.Builder
avoiding the need to create one manually viaDescribeRegistrationFieldValuesRequest.builder()
- Parameters:
describeRegistrationFieldValuesRequest
- AConsumer
that will call methods onDescribeRegistrationFieldValuesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRegistrationSectionDefinitions
default CompletableFuture<DescribeRegistrationSectionDefinitionsResponse> describeRegistrationSectionDefinitions(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.
- Parameters:
describeRegistrationSectionDefinitionsRequest
-- Returns:
- A Java Future containing the result of the DescribeRegistrationSectionDefinitions operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRegistrationSectionDefinitions
default CompletableFuture<DescribeRegistrationSectionDefinitionsResponse> describeRegistrationSectionDefinitions(Consumer<DescribeRegistrationSectionDefinitionsRequest.Builder> describeRegistrationSectionDefinitionsRequest) Retrieves the specified registration section definitions. You can use DescribeRegistrationSectionDefinitions to view the requirements for creating, filling out, and submitting each registration type.
This is a convenience which creates an instance of the
DescribeRegistrationSectionDefinitionsRequest.Builder
avoiding the need to create one manually viaDescribeRegistrationSectionDefinitionsRequest.builder()
- Parameters:
describeRegistrationSectionDefinitionsRequest
- AConsumer
that will call methods onDescribeRegistrationSectionDefinitionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeRegistrationSectionDefinitions operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRegistrationSectionDefinitionsPaginator
default DescribeRegistrationSectionDefinitionsPublisher describeRegistrationSectionDefinitionsPaginator(DescribeRegistrationSectionDefinitionsRequest describeRegistrationSectionDefinitionsRequest) This is a variant of
describeRegistrationSectionDefinitions(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationSectionDefinitionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeRegistrationSectionDefinitionsPublisher publisher = client.describeRegistrationSectionDefinitionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeRegistrationSectionDefinitionsPublisher publisher = client.describeRegistrationSectionDefinitionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationSectionDefinitionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationSectionDefinitionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRegistrationSectionDefinitions(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationSectionDefinitionsRequest)
operation.- Parameters:
describeRegistrationSectionDefinitionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRegistrationSectionDefinitionsPaginator
default DescribeRegistrationSectionDefinitionsPublisher describeRegistrationSectionDefinitionsPaginator(Consumer<DescribeRegistrationSectionDefinitionsRequest.Builder> describeRegistrationSectionDefinitionsRequest) This is a variant of
describeRegistrationSectionDefinitions(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationSectionDefinitionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeRegistrationSectionDefinitionsPublisher publisher = client.describeRegistrationSectionDefinitionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeRegistrationSectionDefinitionsPublisher publisher = client.describeRegistrationSectionDefinitionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationSectionDefinitionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationSectionDefinitionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRegistrationSectionDefinitions(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationSectionDefinitionsRequest)
operation.
This is a convenience which creates an instance of the
DescribeRegistrationSectionDefinitionsRequest.Builder
avoiding the need to create one manually viaDescribeRegistrationSectionDefinitionsRequest.builder()
- Parameters:
describeRegistrationSectionDefinitionsRequest
- AConsumer
that will call methods onDescribeRegistrationSectionDefinitionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRegistrationTypeDefinitions
default CompletableFuture<DescribeRegistrationTypeDefinitionsResponse> describeRegistrationTypeDefinitions(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.
- Parameters:
describeRegistrationTypeDefinitionsRequest
-- Returns:
- A Java Future containing the result of the DescribeRegistrationTypeDefinitions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRegistrationTypeDefinitions
default CompletableFuture<DescribeRegistrationTypeDefinitionsResponse> describeRegistrationTypeDefinitions(Consumer<DescribeRegistrationTypeDefinitionsRequest.Builder> describeRegistrationTypeDefinitionsRequest) Retrieves the specified registration type definitions. You can use DescribeRegistrationTypeDefinitions to view the requirements for creating, filling out, and submitting each registration type.
This is a convenience which creates an instance of the
DescribeRegistrationTypeDefinitionsRequest.Builder
avoiding the need to create one manually viaDescribeRegistrationTypeDefinitionsRequest.builder()
- Parameters:
describeRegistrationTypeDefinitionsRequest
- AConsumer
that will call methods onDescribeRegistrationTypeDefinitionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeRegistrationTypeDefinitions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRegistrationTypeDefinitionsPaginator
default DescribeRegistrationTypeDefinitionsPublisher describeRegistrationTypeDefinitionsPaginator(DescribeRegistrationTypeDefinitionsRequest describeRegistrationTypeDefinitionsRequest) This is a variant of
describeRegistrationTypeDefinitions(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationTypeDefinitionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeRegistrationTypeDefinitionsPublisher publisher = client.describeRegistrationTypeDefinitionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeRegistrationTypeDefinitionsPublisher publisher = client.describeRegistrationTypeDefinitionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationTypeDefinitionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationTypeDefinitionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRegistrationTypeDefinitions(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationTypeDefinitionsRequest)
operation.- Parameters:
describeRegistrationTypeDefinitionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRegistrationTypeDefinitionsPaginator
default DescribeRegistrationTypeDefinitionsPublisher describeRegistrationTypeDefinitionsPaginator(Consumer<DescribeRegistrationTypeDefinitionsRequest.Builder> describeRegistrationTypeDefinitionsRequest) This is a variant of
describeRegistrationTypeDefinitions(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationTypeDefinitionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeRegistrationTypeDefinitionsPublisher publisher = client.describeRegistrationTypeDefinitionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeRegistrationTypeDefinitionsPublisher publisher = client.describeRegistrationTypeDefinitionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationTypeDefinitionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationTypeDefinitionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRegistrationTypeDefinitions(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationTypeDefinitionsRequest)
operation.
This is a convenience which creates an instance of the
DescribeRegistrationTypeDefinitionsRequest.Builder
avoiding the need to create one manually viaDescribeRegistrationTypeDefinitionsRequest.builder()
- Parameters:
describeRegistrationTypeDefinitionsRequest
- AConsumer
that will call methods onDescribeRegistrationTypeDefinitionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRegistrationVersions
default CompletableFuture<DescribeRegistrationVersionsResponse> describeRegistrationVersions(DescribeRegistrationVersionsRequest describeRegistrationVersionsRequest) Retrieves the specified registration version.
- Parameters:
describeRegistrationVersionsRequest
-- Returns:
- A Java Future containing the result of the DescribeRegistrationVersions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRegistrationVersions
default CompletableFuture<DescribeRegistrationVersionsResponse> describeRegistrationVersions(Consumer<DescribeRegistrationVersionsRequest.Builder> describeRegistrationVersionsRequest) Retrieves the specified registration version.
This is a convenience which creates an instance of the
DescribeRegistrationVersionsRequest.Builder
avoiding the need to create one manually viaDescribeRegistrationVersionsRequest.builder()
- Parameters:
describeRegistrationVersionsRequest
- AConsumer
that will call methods onDescribeRegistrationVersionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeRegistrationVersions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRegistrationVersionsPaginator
default DescribeRegistrationVersionsPublisher describeRegistrationVersionsPaginator(DescribeRegistrationVersionsRequest describeRegistrationVersionsRequest) This is a variant of
describeRegistrationVersions(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeRegistrationVersionsPublisher publisher = client.describeRegistrationVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeRegistrationVersionsPublisher publisher = client.describeRegistrationVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationVersionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRegistrationVersions(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationVersionsRequest)
operation.- Parameters:
describeRegistrationVersionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRegistrationVersionsPaginator
default DescribeRegistrationVersionsPublisher describeRegistrationVersionsPaginator(Consumer<DescribeRegistrationVersionsRequest.Builder> describeRegistrationVersionsRequest) This is a variant of
describeRegistrationVersions(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeRegistrationVersionsPublisher publisher = client.describeRegistrationVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeRegistrationVersionsPublisher publisher = client.describeRegistrationVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationVersionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRegistrationVersions(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationVersionsRequest)
operation.
This is a convenience which creates an instance of the
DescribeRegistrationVersionsRequest.Builder
avoiding the need to create one manually viaDescribeRegistrationVersionsRequest.builder()
- Parameters:
describeRegistrationVersionsRequest
- AConsumer
that will call methods onDescribeRegistrationVersionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRegistrations
default CompletableFuture<DescribeRegistrationsResponse> describeRegistrations(DescribeRegistrationsRequest describeRegistrationsRequest) Retrieves the specified registrations.
- Parameters:
describeRegistrationsRequest
-- Returns:
- A Java Future containing the result of the DescribeRegistrations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRegistrations
default CompletableFuture<DescribeRegistrationsResponse> describeRegistrations(Consumer<DescribeRegistrationsRequest.Builder> describeRegistrationsRequest) Retrieves the specified registrations.
This is a convenience which creates an instance of the
DescribeRegistrationsRequest.Builder
avoiding the need to create one manually viaDescribeRegistrationsRequest.builder()
- Parameters:
describeRegistrationsRequest
- AConsumer
that will call methods onDescribeRegistrationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeRegistrations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRegistrationsPaginator
default DescribeRegistrationsPublisher describeRegistrationsPaginator(DescribeRegistrationsRequest describeRegistrationsRequest) This is a variant of
describeRegistrations(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeRegistrationsPublisher publisher = client.describeRegistrationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeRegistrationsPublisher publisher = client.describeRegistrationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRegistrations(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationsRequest)
operation.- Parameters:
describeRegistrationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRegistrationsPaginator
default DescribeRegistrationsPublisher describeRegistrationsPaginator(Consumer<DescribeRegistrationsRequest.Builder> describeRegistrationsRequest) This is a variant of
describeRegistrations(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeRegistrationsPublisher publisher = client.describeRegistrationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeRegistrationsPublisher publisher = client.describeRegistrationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRegistrations(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeRegistrationsRequest)
operation.
This is a convenience which creates an instance of the
DescribeRegistrationsRequest.Builder
avoiding the need to create one manually viaDescribeRegistrationsRequest.builder()
- Parameters:
describeRegistrationsRequest
- AConsumer
that will call methods onDescribeRegistrationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSenderIds
default CompletableFuture<DescribeSenderIdsResponse> describeSenderIds(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.
- Parameters:
describeSenderIdsRequest
-- Returns:
- A Java Future containing the result of the DescribeSenderIds operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSenderIds
default CompletableFuture<DescribeSenderIdsResponse> describeSenderIds(Consumer<DescribeSenderIdsRequest.Builder> 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.
This is a convenience which creates an instance of the
DescribeSenderIdsRequest.Builder
avoiding the need to create one manually viaDescribeSenderIdsRequest.builder()
- Parameters:
describeSenderIdsRequest
- AConsumer
that will call methods onDescribeSenderIdsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeSenderIds operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSenderIdsPaginator
default DescribeSenderIdsPublisher describeSenderIdsPaginator(DescribeSenderIdsRequest describeSenderIdsRequest) This is a variant of
describeSenderIds(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeSenderIdsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeSenderIdsPublisher publisher = client.describeSenderIdsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeSenderIdsPublisher publisher = client.describeSenderIdsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeSenderIdsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeSenderIdsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeSenderIds(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeSenderIdsRequest)
operation.- Parameters:
describeSenderIdsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSenderIdsPaginator
default DescribeSenderIdsPublisher describeSenderIdsPaginator(Consumer<DescribeSenderIdsRequest.Builder> describeSenderIdsRequest) This is a variant of
describeSenderIds(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeSenderIdsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeSenderIdsPublisher publisher = client.describeSenderIdsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeSenderIdsPublisher publisher = client.describeSenderIdsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeSenderIdsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeSenderIdsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeSenderIds(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeSenderIdsRequest)
operation.
This is a convenience which creates an instance of the
DescribeSenderIdsRequest.Builder
avoiding the need to create one manually viaDescribeSenderIdsRequest.builder()
- Parameters:
describeSenderIdsRequest
- AConsumer
that will call methods onDescribeSenderIdsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSpendLimits
default CompletableFuture<DescribeSpendLimitsResponse> describeSpendLimits(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.
- Parameters:
describeSpendLimitsRequest
-- Returns:
- A Java Future containing the result of the DescribeSpendLimits operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSpendLimits
default CompletableFuture<DescribeSpendLimitsResponse> describeSpendLimits(Consumer<DescribeSpendLimitsRequest.Builder> 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.
This is a convenience which creates an instance of the
DescribeSpendLimitsRequest.Builder
avoiding the need to create one manually viaDescribeSpendLimitsRequest.builder()
- Parameters:
describeSpendLimitsRequest
- AConsumer
that will call methods onDescribeSpendLimitsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeSpendLimits operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSpendLimitsPaginator
default DescribeSpendLimitsPublisher describeSpendLimitsPaginator(DescribeSpendLimitsRequest describeSpendLimitsRequest) This is a variant of
describeSpendLimits(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeSpendLimitsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeSpendLimitsPublisher publisher = client.describeSpendLimitsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeSpendLimitsPublisher publisher = client.describeSpendLimitsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeSpendLimitsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeSpendLimitsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeSpendLimits(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeSpendLimitsRequest)
operation.- Parameters:
describeSpendLimitsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSpendLimitsPaginator
default DescribeSpendLimitsPublisher describeSpendLimitsPaginator(Consumer<DescribeSpendLimitsRequest.Builder> describeSpendLimitsRequest) This is a variant of
describeSpendLimits(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeSpendLimitsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeSpendLimitsPublisher publisher = client.describeSpendLimitsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeSpendLimitsPublisher publisher = client.describeSpendLimitsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeSpendLimitsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeSpendLimitsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeSpendLimits(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeSpendLimitsRequest)
operation.
This is a convenience which creates an instance of the
DescribeSpendLimitsRequest.Builder
avoiding the need to create one manually viaDescribeSpendLimitsRequest.builder()
- Parameters:
describeSpendLimitsRequest
- AConsumer
that will call methods onDescribeSpendLimitsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeVerifiedDestinationNumbers
default CompletableFuture<DescribeVerifiedDestinationNumbersResponse> describeVerifiedDestinationNumbers(DescribeVerifiedDestinationNumbersRequest describeVerifiedDestinationNumbersRequest) Retrieves the specified verified destiona numbers.
- Parameters:
describeVerifiedDestinationNumbersRequest
-- Returns:
- A Java Future containing the result of the DescribeVerifiedDestinationNumbers operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeVerifiedDestinationNumbers
default CompletableFuture<DescribeVerifiedDestinationNumbersResponse> describeVerifiedDestinationNumbers(Consumer<DescribeVerifiedDestinationNumbersRequest.Builder> describeVerifiedDestinationNumbersRequest) Retrieves the specified verified destiona numbers.
This is a convenience which creates an instance of the
DescribeVerifiedDestinationNumbersRequest.Builder
avoiding the need to create one manually viaDescribeVerifiedDestinationNumbersRequest.builder()
- Parameters:
describeVerifiedDestinationNumbersRequest
- AConsumer
that will call methods onDescribeVerifiedDestinationNumbersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeVerifiedDestinationNumbers operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeVerifiedDestinationNumbersPaginator
default DescribeVerifiedDestinationNumbersPublisher describeVerifiedDestinationNumbersPaginator(DescribeVerifiedDestinationNumbersRequest describeVerifiedDestinationNumbersRequest) This is a variant of
describeVerifiedDestinationNumbers(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeVerifiedDestinationNumbersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeVerifiedDestinationNumbersPublisher publisher = client.describeVerifiedDestinationNumbersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeVerifiedDestinationNumbersPublisher publisher = client.describeVerifiedDestinationNumbersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeVerifiedDestinationNumbersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeVerifiedDestinationNumbersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeVerifiedDestinationNumbers(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeVerifiedDestinationNumbersRequest)
operation.- Parameters:
describeVerifiedDestinationNumbersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeVerifiedDestinationNumbersPaginator
default DescribeVerifiedDestinationNumbersPublisher describeVerifiedDestinationNumbersPaginator(Consumer<DescribeVerifiedDestinationNumbersRequest.Builder> describeVerifiedDestinationNumbersRequest) This is a variant of
describeVerifiedDestinationNumbers(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeVerifiedDestinationNumbersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeVerifiedDestinationNumbersPublisher publisher = client.describeVerifiedDestinationNumbersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeVerifiedDestinationNumbersPublisher publisher = client.describeVerifiedDestinationNumbersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeVerifiedDestinationNumbersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeVerifiedDestinationNumbersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeVerifiedDestinationNumbers(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeVerifiedDestinationNumbersRequest)
operation.
This is a convenience which creates an instance of the
DescribeVerifiedDestinationNumbersRequest.Builder
avoiding the need to create one manually viaDescribeVerifiedDestinationNumbersRequest.builder()
- Parameters:
describeVerifiedDestinationNumbersRequest
- AConsumer
that will call methods onDescribeVerifiedDestinationNumbersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateOriginationIdentity
default CompletableFuture<DisassociateOriginationIdentityResponse> disassociateOriginationIdentity(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.
- Parameters:
disassociateOriginationIdentityRequest
-- Returns:
- A Java Future containing the result of the DisassociateOriginationIdentity operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateOriginationIdentity
default CompletableFuture<DisassociateOriginationIdentityResponse> disassociateOriginationIdentity(Consumer<DisassociateOriginationIdentityRequest.Builder> 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.
This is a convenience which creates an instance of the
DisassociateOriginationIdentityRequest.Builder
avoiding the need to create one manually viaDisassociateOriginationIdentityRequest.builder()
- Parameters:
disassociateOriginationIdentityRequest
- AConsumer
that will call methods onDisassociateOriginationIdentityRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisassociateOriginationIdentity operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateProtectConfiguration
default CompletableFuture<DisassociateProtectConfigurationResponse> disassociateProtectConfiguration(DisassociateProtectConfigurationRequest disassociateProtectConfigurationRequest) Disassociate a protect configuration from a configuration set.
- Parameters:
disassociateProtectConfigurationRequest
-- Returns:
- A Java Future containing the result of the DisassociateProtectConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateProtectConfiguration
default CompletableFuture<DisassociateProtectConfigurationResponse> disassociateProtectConfiguration(Consumer<DisassociateProtectConfigurationRequest.Builder> disassociateProtectConfigurationRequest) Disassociate a protect configuration from a configuration set.
This is a convenience which creates an instance of the
DisassociateProtectConfigurationRequest.Builder
avoiding the need to create one manually viaDisassociateProtectConfigurationRequest.builder()
- Parameters:
disassociateProtectConfigurationRequest
- AConsumer
that will call methods onDisassociateProtectConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisassociateProtectConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
discardRegistrationVersion
default CompletableFuture<DiscardRegistrationVersionResponse> discardRegistrationVersion(DiscardRegistrationVersionRequest discardRegistrationVersionRequest) Discard the current version of the registration.
- Parameters:
discardRegistrationVersionRequest
-- Returns:
- A Java Future containing the result of the DiscardRegistrationVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
discardRegistrationVersion
default CompletableFuture<DiscardRegistrationVersionResponse> discardRegistrationVersion(Consumer<DiscardRegistrationVersionRequest.Builder> discardRegistrationVersionRequest) Discard the current version of the registration.
This is a convenience which creates an instance of the
DiscardRegistrationVersionRequest.Builder
avoiding the need to create one manually viaDiscardRegistrationVersionRequest.builder()
- Parameters:
discardRegistrationVersionRequest
- AConsumer
that will call methods onDiscardRegistrationVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DiscardRegistrationVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getProtectConfigurationCountryRuleSet
default CompletableFuture<GetProtectConfigurationCountryRuleSetResponse> getProtectConfigurationCountryRuleSet(GetProtectConfigurationCountryRuleSetRequest getProtectConfigurationCountryRuleSetRequest) Retrieve the CountryRuleSet for the specified NumberCapability from a protect configuration.
- Parameters:
getProtectConfigurationCountryRuleSetRequest
-- Returns:
- A Java Future containing the result of the GetProtectConfigurationCountryRuleSet operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getProtectConfigurationCountryRuleSet
default CompletableFuture<GetProtectConfigurationCountryRuleSetResponse> getProtectConfigurationCountryRuleSet(Consumer<GetProtectConfigurationCountryRuleSetRequest.Builder> getProtectConfigurationCountryRuleSetRequest) Retrieve the CountryRuleSet for the specified NumberCapability from a protect configuration.
This is a convenience which creates an instance of the
GetProtectConfigurationCountryRuleSetRequest.Builder
avoiding the need to create one manually viaGetProtectConfigurationCountryRuleSetRequest.builder()
- Parameters:
getProtectConfigurationCountryRuleSetRequest
- AConsumer
that will call methods onGetProtectConfigurationCountryRuleSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetProtectConfigurationCountryRuleSet operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPoolOriginationIdentities
default CompletableFuture<ListPoolOriginationIdentitiesResponse> listPoolOriginationIdentities(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.
- Parameters:
listPoolOriginationIdentitiesRequest
-- Returns:
- A Java Future containing the result of the ListPoolOriginationIdentities operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPoolOriginationIdentities
default CompletableFuture<ListPoolOriginationIdentitiesResponse> listPoolOriginationIdentities(Consumer<ListPoolOriginationIdentitiesRequest.Builder> 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.
This is a convenience which creates an instance of the
ListPoolOriginationIdentitiesRequest.Builder
avoiding the need to create one manually viaListPoolOriginationIdentitiesRequest.builder()
- Parameters:
listPoolOriginationIdentitiesRequest
- AConsumer
that will call methods onListPoolOriginationIdentitiesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPoolOriginationIdentities operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPoolOriginationIdentitiesPaginator
default ListPoolOriginationIdentitiesPublisher listPoolOriginationIdentitiesPaginator(ListPoolOriginationIdentitiesRequest listPoolOriginationIdentitiesRequest) This is a variant of
listPoolOriginationIdentities(software.amazon.awssdk.services.pinpointsmsvoicev2.model.ListPoolOriginationIdentitiesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.ListPoolOriginationIdentitiesPublisher publisher = client.listPoolOriginationIdentitiesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.ListPoolOriginationIdentitiesPublisher publisher = client.listPoolOriginationIdentitiesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.ListPoolOriginationIdentitiesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.ListPoolOriginationIdentitiesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPoolOriginationIdentities(software.amazon.awssdk.services.pinpointsmsvoicev2.model.ListPoolOriginationIdentitiesRequest)
operation.- Parameters:
listPoolOriginationIdentitiesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPoolOriginationIdentitiesPaginator
default ListPoolOriginationIdentitiesPublisher listPoolOriginationIdentitiesPaginator(Consumer<ListPoolOriginationIdentitiesRequest.Builder> listPoolOriginationIdentitiesRequest) This is a variant of
listPoolOriginationIdentities(software.amazon.awssdk.services.pinpointsmsvoicev2.model.ListPoolOriginationIdentitiesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.ListPoolOriginationIdentitiesPublisher publisher = client.listPoolOriginationIdentitiesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.ListPoolOriginationIdentitiesPublisher publisher = client.listPoolOriginationIdentitiesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.ListPoolOriginationIdentitiesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.ListPoolOriginationIdentitiesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPoolOriginationIdentities(software.amazon.awssdk.services.pinpointsmsvoicev2.model.ListPoolOriginationIdentitiesRequest)
operation.
This is a convenience which creates an instance of the
ListPoolOriginationIdentitiesRequest.Builder
avoiding the need to create one manually viaListPoolOriginationIdentitiesRequest.builder()
- Parameters:
listPoolOriginationIdentitiesRequest
- AConsumer
that will call methods onListPoolOriginationIdentitiesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRegistrationAssociations
default CompletableFuture<ListRegistrationAssociationsResponse> listRegistrationAssociations(ListRegistrationAssociationsRequest listRegistrationAssociationsRequest) Retreive all of the origination identies that are associated with a registration.
- Parameters:
listRegistrationAssociationsRequest
-- Returns:
- A Java Future containing the result of the ListRegistrationAssociations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRegistrationAssociations
default CompletableFuture<ListRegistrationAssociationsResponse> listRegistrationAssociations(Consumer<ListRegistrationAssociationsRequest.Builder> listRegistrationAssociationsRequest) Retreive all of the origination identies that are associated with a registration.
This is a convenience which creates an instance of the
ListRegistrationAssociationsRequest.Builder
avoiding the need to create one manually viaListRegistrationAssociationsRequest.builder()
- Parameters:
listRegistrationAssociationsRequest
- AConsumer
that will call methods onListRegistrationAssociationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListRegistrationAssociations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRegistrationAssociationsPaginator
default ListRegistrationAssociationsPublisher listRegistrationAssociationsPaginator(ListRegistrationAssociationsRequest listRegistrationAssociationsRequest) This is a variant of
listRegistrationAssociations(software.amazon.awssdk.services.pinpointsmsvoicev2.model.ListRegistrationAssociationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.ListRegistrationAssociationsPublisher publisher = client.listRegistrationAssociationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.ListRegistrationAssociationsPublisher publisher = client.listRegistrationAssociationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.ListRegistrationAssociationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.ListRegistrationAssociationsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRegistrationAssociations(software.amazon.awssdk.services.pinpointsmsvoicev2.model.ListRegistrationAssociationsRequest)
operation.- Parameters:
listRegistrationAssociationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRegistrationAssociationsPaginator
default ListRegistrationAssociationsPublisher listRegistrationAssociationsPaginator(Consumer<ListRegistrationAssociationsRequest.Builder> listRegistrationAssociationsRequest) This is a variant of
listRegistrationAssociations(software.amazon.awssdk.services.pinpointsmsvoicev2.model.ListRegistrationAssociationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.ListRegistrationAssociationsPublisher publisher = client.listRegistrationAssociationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.ListRegistrationAssociationsPublisher publisher = client.listRegistrationAssociationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointsmsvoicev2.model.ListRegistrationAssociationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointsmsvoicev2.model.ListRegistrationAssociationsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRegistrationAssociations(software.amazon.awssdk.services.pinpointsmsvoicev2.model.ListRegistrationAssociationsRequest)
operation.
This is a convenience which creates an instance of the
ListRegistrationAssociationsRequest.Builder
avoiding the need to create one manually viaListRegistrationAssociationsRequest.builder()
- Parameters:
listRegistrationAssociationsRequest
- AConsumer
that will call methods onListRegistrationAssociationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) List all tags associated with a resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) List all tags associated with a resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putKeyword
Creates or updates a keyword configuration on an origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.
If you specify a keyword that isn't valid, an error is returned.
- Parameters:
putKeywordRequest
-- Returns:
- A Java Future containing the result of the PutKeyword operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putKeyword
default CompletableFuture<PutKeywordResponse> putKeyword(Consumer<PutKeywordRequest.Builder> 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.
This is a convenience which creates an instance of the
PutKeywordRequest.Builder
avoiding the need to create one manually viaPutKeywordRequest.builder()
- Parameters:
putKeywordRequest
- AConsumer
that will call methods onPutKeywordRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutKeyword operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putOptedOutNumber
default CompletableFuture<PutOptedOutNumberResponse> putOptedOutNumber(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.
- Parameters:
putOptedOutNumberRequest
-- Returns:
- A Java Future containing the result of the PutOptedOutNumber operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putOptedOutNumber
default CompletableFuture<PutOptedOutNumberResponse> putOptedOutNumber(Consumer<PutOptedOutNumberRequest.Builder> 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.
This is a convenience which creates an instance of the
PutOptedOutNumberRequest.Builder
avoiding the need to create one manually viaPutOptedOutNumberRequest.builder()
- Parameters:
putOptedOutNumberRequest
- AConsumer
that will call methods onPutOptedOutNumberRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutOptedOutNumber operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putRegistrationFieldValue
default CompletableFuture<PutRegistrationFieldValueResponse> putRegistrationFieldValue(PutRegistrationFieldValueRequest putRegistrationFieldValueRequest) Creates or updates a field value for a registration.
- Parameters:
putRegistrationFieldValueRequest
-- Returns:
- A Java Future containing the result of the PutRegistrationFieldValue operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putRegistrationFieldValue
default CompletableFuture<PutRegistrationFieldValueResponse> putRegistrationFieldValue(Consumer<PutRegistrationFieldValueRequest.Builder> putRegistrationFieldValueRequest) Creates or updates a field value for a registration.
This is a convenience which creates an instance of the
PutRegistrationFieldValueRequest.Builder
avoiding the need to create one manually viaPutRegistrationFieldValueRequest.builder()
- Parameters:
putRegistrationFieldValueRequest
- AConsumer
that will call methods onPutRegistrationFieldValueRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutRegistrationFieldValue operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
releasePhoneNumber
default CompletableFuture<ReleasePhoneNumberResponse> releasePhoneNumber(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.
- Parameters:
releasePhoneNumberRequest
-- Returns:
- A Java Future containing the result of the ReleasePhoneNumber operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
releasePhoneNumber
default CompletableFuture<ReleasePhoneNumberResponse> releasePhoneNumber(Consumer<ReleasePhoneNumberRequest.Builder> 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.
This is a convenience which creates an instance of the
ReleasePhoneNumberRequest.Builder
avoiding the need to create one manually viaReleasePhoneNumberRequest.builder()
- Parameters:
releasePhoneNumberRequest
- AConsumer
that will call methods onReleasePhoneNumberRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ReleasePhoneNumber operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
releaseSenderId
default CompletableFuture<ReleaseSenderIdResponse> releaseSenderId(ReleaseSenderIdRequest releaseSenderIdRequest) Releases an existing sender ID in your account.
- Parameters:
releaseSenderIdRequest
-- Returns:
- A Java Future containing the result of the ReleaseSenderId operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
releaseSenderId
default CompletableFuture<ReleaseSenderIdResponse> releaseSenderId(Consumer<ReleaseSenderIdRequest.Builder> releaseSenderIdRequest) Releases an existing sender ID in your account.
This is a convenience which creates an instance of the
ReleaseSenderIdRequest.Builder
avoiding the need to create one manually viaReleaseSenderIdRequest.builder()
- Parameters:
releaseSenderIdRequest
- AConsumer
that will call methods onReleaseSenderIdRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ReleaseSenderId operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
requestPhoneNumber
default CompletableFuture<RequestPhoneNumberResponse> requestPhoneNumber(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.
- Parameters:
requestPhoneNumberRequest
-- Returns:
- A Java Future containing the result of the RequestPhoneNumber operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
requestPhoneNumber
default CompletableFuture<RequestPhoneNumberResponse> requestPhoneNumber(Consumer<RequestPhoneNumberRequest.Builder> 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.
This is a convenience which creates an instance of the
RequestPhoneNumberRequest.Builder
avoiding the need to create one manually viaRequestPhoneNumberRequest.builder()
- Parameters:
requestPhoneNumberRequest
- AConsumer
that will call methods onRequestPhoneNumberRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RequestPhoneNumber operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
requestSenderId
default CompletableFuture<RequestSenderIdResponse> requestSenderId(RequestSenderIdRequest requestSenderIdRequest) Request a new sender ID that doesn't require registration.
- Parameters:
requestSenderIdRequest
-- Returns:
- A Java Future containing the result of the RequestSenderId operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
requestSenderId
default CompletableFuture<RequestSenderIdResponse> requestSenderId(Consumer<RequestSenderIdRequest.Builder> requestSenderIdRequest) Request a new sender ID that doesn't require registration.
This is a convenience which creates an instance of the
RequestSenderIdRequest.Builder
avoiding the need to create one manually viaRequestSenderIdRequest.builder()
- Parameters:
requestSenderIdRequest
- AConsumer
that will call methods onRequestSenderIdRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RequestSenderId operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
sendDestinationNumberVerificationCode
default CompletableFuture<SendDestinationNumberVerificationCodeResponse> sendDestinationNumberVerificationCode(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.
- Parameters:
sendDestinationNumberVerificationCodeRequest
-- Returns:
- A Java Future containing the result of the SendDestinationNumberVerificationCode operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
sendDestinationNumberVerificationCode
default CompletableFuture<SendDestinationNumberVerificationCodeResponse> sendDestinationNumberVerificationCode(Consumer<SendDestinationNumberVerificationCodeRequest.Builder> 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.
This is a convenience which creates an instance of the
SendDestinationNumberVerificationCodeRequest.Builder
avoiding the need to create one manually viaSendDestinationNumberVerificationCodeRequest.builder()
- Parameters:
sendDestinationNumberVerificationCodeRequest
- AConsumer
that will call methods onSendDestinationNumberVerificationCodeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SendDestinationNumberVerificationCode operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
sendMediaMessage
default CompletableFuture<SendMediaMessageResponse> sendMediaMessage(SendMediaMessageRequest sendMediaMessageRequest) Creates a new multimedia message (MMS) and sends it to a recipient's phone number.
- Parameters:
sendMediaMessageRequest
-- Returns:
- A Java Future containing the result of the SendMediaMessage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
sendMediaMessage
default CompletableFuture<SendMediaMessageResponse> sendMediaMessage(Consumer<SendMediaMessageRequest.Builder> sendMediaMessageRequest) Creates a new multimedia message (MMS) and sends it to a recipient's phone number.
This is a convenience which creates an instance of the
SendMediaMessageRequest.Builder
avoiding the need to create one manually viaSendMediaMessageRequest.builder()
- Parameters:
sendMediaMessageRequest
- AConsumer
that will call methods onSendMediaMessageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SendMediaMessage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
sendTextMessage
default CompletableFuture<SendTextMessageResponse> sendTextMessage(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.
- Parameters:
sendTextMessageRequest
-- Returns:
- A Java Future containing the result of the SendTextMessage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
sendTextMessage
default CompletableFuture<SendTextMessageResponse> sendTextMessage(Consumer<SendTextMessageRequest.Builder> 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.
This is a convenience which creates an instance of the
SendTextMessageRequest.Builder
avoiding the need to create one manually viaSendTextMessageRequest.builder()
- Parameters:
sendTextMessageRequest
- AConsumer
that will call methods onSendTextMessageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SendTextMessage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
sendVoiceMessage
default CompletableFuture<SendVoiceMessageResponse> sendVoiceMessage(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.
- Parameters:
sendVoiceMessageRequest
-- Returns:
- A Java Future containing the result of the SendVoiceMessage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
sendVoiceMessage
default CompletableFuture<SendVoiceMessageResponse> sendVoiceMessage(Consumer<SendVoiceMessageRequest.Builder> 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.
This is a convenience which creates an instance of the
SendVoiceMessageRequest.Builder
avoiding the need to create one manually viaSendVoiceMessageRequest.builder()
- Parameters:
sendVoiceMessageRequest
- AConsumer
that will call methods onSendVoiceMessageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SendVoiceMessage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
setAccountDefaultProtectConfiguration
default CompletableFuture<SetAccountDefaultProtectConfigurationResponse> setAccountDefaultProtectConfiguration(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.
- Parameters:
setAccountDefaultProtectConfigurationRequest
-- Returns:
- A Java Future containing the result of the SetAccountDefaultProtectConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
setAccountDefaultProtectConfiguration
default CompletableFuture<SetAccountDefaultProtectConfigurationResponse> setAccountDefaultProtectConfiguration(Consumer<SetAccountDefaultProtectConfigurationRequest.Builder> 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.
This is a convenience which creates an instance of the
SetAccountDefaultProtectConfigurationRequest.Builder
avoiding the need to create one manually viaSetAccountDefaultProtectConfigurationRequest.builder()
- Parameters:
setAccountDefaultProtectConfigurationRequest
- AConsumer
that will call methods onSetAccountDefaultProtectConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SetAccountDefaultProtectConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
setDefaultMessageType
default CompletableFuture<SetDefaultMessageTypeResponse> setDefaultMessageType(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.
- Parameters:
setDefaultMessageTypeRequest
-- Returns:
- A Java Future containing the result of the SetDefaultMessageType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
setDefaultMessageType
default CompletableFuture<SetDefaultMessageTypeResponse> setDefaultMessageType(Consumer<SetDefaultMessageTypeRequest.Builder> 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.
This is a convenience which creates an instance of the
SetDefaultMessageTypeRequest.Builder
avoiding the need to create one manually viaSetDefaultMessageTypeRequest.builder()
- Parameters:
setDefaultMessageTypeRequest
- AConsumer
that will call methods onSetDefaultMessageTypeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SetDefaultMessageType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
setDefaultSenderId
default CompletableFuture<SetDefaultSenderIdResponse> setDefaultSenderId(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.
- Parameters:
setDefaultSenderIdRequest
-- Returns:
- A Java Future containing the result of the SetDefaultSenderId operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
setDefaultSenderId
default CompletableFuture<SetDefaultSenderIdResponse> setDefaultSenderId(Consumer<SetDefaultSenderIdRequest.Builder> 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.
This is a convenience which creates an instance of the
SetDefaultSenderIdRequest.Builder
avoiding the need to create one manually viaSetDefaultSenderIdRequest.builder()
- Parameters:
setDefaultSenderIdRequest
- AConsumer
that will call methods onSetDefaultSenderIdRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SetDefaultSenderId operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
setMediaMessageSpendLimitOverride
default CompletableFuture<SetMediaMessageSpendLimitOverrideResponse> setMediaMessageSpendLimitOverride(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.- Parameters:
setMediaMessageSpendLimitOverrideRequest
-- Returns:
- A Java Future containing the result of the SetMediaMessageSpendLimitOverride operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
setMediaMessageSpendLimitOverride
default CompletableFuture<SetMediaMessageSpendLimitOverrideResponse> setMediaMessageSpendLimitOverride(Consumer<SetMediaMessageSpendLimitOverrideRequest.Builder> 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.
This is a convenience which creates an instance of the
SetMediaMessageSpendLimitOverrideRequest.Builder
avoiding the need to create one manually viaSetMediaMessageSpendLimitOverrideRequest.builder()
- Parameters:
setMediaMessageSpendLimitOverrideRequest
- AConsumer
that will call methods onSetMediaMessageSpendLimitOverrideRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SetMediaMessageSpendLimitOverride operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
setTextMessageSpendLimitOverride
default CompletableFuture<SetTextMessageSpendLimitOverrideResponse> setTextMessageSpendLimitOverride(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.- Parameters:
setTextMessageSpendLimitOverrideRequest
-- Returns:
- A Java Future containing the result of the SetTextMessageSpendLimitOverride operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
setTextMessageSpendLimitOverride
default CompletableFuture<SetTextMessageSpendLimitOverrideResponse> setTextMessageSpendLimitOverride(Consumer<SetTextMessageSpendLimitOverrideRequest.Builder> 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.
This is a convenience which creates an instance of the
SetTextMessageSpendLimitOverrideRequest.Builder
avoiding the need to create one manually viaSetTextMessageSpendLimitOverrideRequest.builder()
- Parameters:
setTextMessageSpendLimitOverrideRequest
- AConsumer
that will call methods onSetTextMessageSpendLimitOverrideRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SetTextMessageSpendLimitOverride operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
setVoiceMessageSpendLimitOverride
default CompletableFuture<SetVoiceMessageSpendLimitOverrideResponse> setVoiceMessageSpendLimitOverride(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.- Parameters:
setVoiceMessageSpendLimitOverrideRequest
-- Returns:
- A Java Future containing the result of the SetVoiceMessageSpendLimitOverride operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
setVoiceMessageSpendLimitOverride
default CompletableFuture<SetVoiceMessageSpendLimitOverrideResponse> setVoiceMessageSpendLimitOverride(Consumer<SetVoiceMessageSpendLimitOverrideRequest.Builder> 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.
This is a convenience which creates an instance of the
SetVoiceMessageSpendLimitOverrideRequest.Builder
avoiding the need to create one manually viaSetVoiceMessageSpendLimitOverrideRequest.builder()
- Parameters:
setVoiceMessageSpendLimitOverrideRequest
- AConsumer
that will call methods onSetVoiceMessageSpendLimitOverrideRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SetVoiceMessageSpendLimitOverride operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
submitRegistrationVersion
default CompletableFuture<SubmitRegistrationVersionResponse> submitRegistrationVersion(SubmitRegistrationVersionRequest submitRegistrationVersionRequest) Submit the specified registration for review and approval.
- Parameters:
submitRegistrationVersionRequest
-- Returns:
- A Java Future containing the result of the SubmitRegistrationVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
submitRegistrationVersion
default CompletableFuture<SubmitRegistrationVersionResponse> submitRegistrationVersion(Consumer<SubmitRegistrationVersionRequest.Builder> submitRegistrationVersionRequest) Submit the specified registration for review and approval.
This is a convenience which creates an instance of the
SubmitRegistrationVersionRequest.Builder
avoiding the need to create one manually viaSubmitRegistrationVersionRequest.builder()
- Parameters:
submitRegistrationVersionRequest
- AConsumer
that will call methods onSubmitRegistrationVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SubmitRegistrationVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS Voice, version 2 resource. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> 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.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(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.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> 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.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateEventDestination
default CompletableFuture<UpdateEventDestinationResponse> updateEventDestination(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.
- Parameters:
updateEventDestinationRequest
-- Returns:
- A Java Future containing the result of the UpdateEventDestination operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateEventDestination
default CompletableFuture<UpdateEventDestinationResponse> updateEventDestination(Consumer<UpdateEventDestinationRequest.Builder> 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.
This is a convenience which creates an instance of the
UpdateEventDestinationRequest.Builder
avoiding the need to create one manually viaUpdateEventDestinationRequest.builder()
- Parameters:
updateEventDestinationRequest
- AConsumer
that will call methods onUpdateEventDestinationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateEventDestination operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updatePhoneNumber
default CompletableFuture<UpdatePhoneNumberResponse> updatePhoneNumber(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.
- Parameters:
updatePhoneNumberRequest
-- Returns:
- A Java Future containing the result of the UpdatePhoneNumber operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updatePhoneNumber
default CompletableFuture<UpdatePhoneNumberResponse> updatePhoneNumber(Consumer<UpdatePhoneNumberRequest.Builder> 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.
This is a convenience which creates an instance of the
UpdatePhoneNumberRequest.Builder
avoiding the need to create one manually viaUpdatePhoneNumberRequest.builder()
- Parameters:
updatePhoneNumberRequest
- AConsumer
that will call methods onUpdatePhoneNumberRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdatePhoneNumber operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updatePool
Updates the configuration of an existing pool. You can update the opt-out list, enable or disable two-way messaging, change the
TwoWayChannelArn
, enable or disable self-managed opt-outs, enable or disable deletion protection, and enable or disable shared routes.- Parameters:
updatePoolRequest
-- Returns:
- A Java Future containing the result of the UpdatePool operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updatePool
default CompletableFuture<UpdatePoolResponse> updatePool(Consumer<UpdatePoolRequest.Builder> 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.
This is a convenience which creates an instance of the
UpdatePoolRequest.Builder
avoiding the need to create one manually viaUpdatePoolRequest.builder()
- Parameters:
updatePoolRequest
- AConsumer
that will call methods onUpdatePoolRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdatePool operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateProtectConfiguration
default CompletableFuture<UpdateProtectConfigurationResponse> updateProtectConfiguration(UpdateProtectConfigurationRequest updateProtectConfigurationRequest) Update the setting for an existing protect configuration.
- Parameters:
updateProtectConfigurationRequest
-- Returns:
- A Java Future containing the result of the UpdateProtectConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateProtectConfiguration
default CompletableFuture<UpdateProtectConfigurationResponse> updateProtectConfiguration(Consumer<UpdateProtectConfigurationRequest.Builder> updateProtectConfigurationRequest) Update the setting for an existing protect configuration.
This is a convenience which creates an instance of the
UpdateProtectConfigurationRequest.Builder
avoiding the need to create one manually viaUpdateProtectConfigurationRequest.builder()
- Parameters:
updateProtectConfigurationRequest
- AConsumer
that will call methods onUpdateProtectConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateProtectConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateProtectConfigurationCountryRuleSet
default CompletableFuture<UpdateProtectConfigurationCountryRuleSetResponse> updateProtectConfigurationCountryRuleSet(UpdateProtectConfigurationCountryRuleSetRequest updateProtectConfigurationCountryRuleSetRequest) Update a country rule set to
ALLOW
orBLOCK
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.- Parameters:
updateProtectConfigurationCountryRuleSetRequest
-- Returns:
- A Java Future containing the result of the UpdateProtectConfigurationCountryRuleSet operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateProtectConfigurationCountryRuleSet
default CompletableFuture<UpdateProtectConfigurationCountryRuleSetResponse> updateProtectConfigurationCountryRuleSet(Consumer<UpdateProtectConfigurationCountryRuleSetRequest.Builder> updateProtectConfigurationCountryRuleSetRequest) Update a country rule set to
ALLOW
orBLOCK
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.
This is a convenience which creates an instance of the
UpdateProtectConfigurationCountryRuleSetRequest.Builder
avoiding the need to create one manually viaUpdateProtectConfigurationCountryRuleSetRequest.builder()
- Parameters:
updateProtectConfigurationCountryRuleSetRequest
- AConsumer
that will call methods onUpdateProtectConfigurationCountryRuleSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateProtectConfigurationCountryRuleSet operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateSenderId
default CompletableFuture<UpdateSenderIdResponse> updateSenderId(UpdateSenderIdRequest updateSenderIdRequest) Updates the configuration of an existing sender ID.
- Parameters:
updateSenderIdRequest
-- Returns:
- A Java Future containing the result of the UpdateSenderId operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateSenderId
default CompletableFuture<UpdateSenderIdResponse> updateSenderId(Consumer<UpdateSenderIdRequest.Builder> updateSenderIdRequest) Updates the configuration of an existing sender ID.
This is a convenience which creates an instance of the
UpdateSenderIdRequest.Builder
avoiding the need to create one manually viaUpdateSenderIdRequest.builder()
- Parameters:
updateSenderIdRequest
- AConsumer
that will call methods onUpdateSenderIdRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateSenderId operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
verifyDestinationNumber
default CompletableFuture<VerifyDestinationNumberResponse> verifyDestinationNumber(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.
- Parameters:
verifyDestinationNumberRequest
-- Returns:
- A Java Future containing the result of the VerifyDestinationNumber operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
verifyDestinationNumber
default CompletableFuture<VerifyDestinationNumberResponse> verifyDestinationNumber(Consumer<VerifyDestinationNumberRequest.Builder> 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.
This is a convenience which creates an instance of the
VerifyDestinationNumberRequest.Builder
avoiding the need to create one manually viaVerifyDestinationNumberRequest.builder()
- Parameters:
verifyDestinationNumberRequest
- AConsumer
that will call methods onVerifyDestinationNumberRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the VerifyDestinationNumber operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException An error that occurred because too many requests were sent during a certain amount of time.
- AccessDeniedException The request was denied because you don't have sufficient permissions to access the resource.
- ResourceNotFoundException A requested resource couldn't be found.
- ValidationException A validation exception for a field.
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
- InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointSmsVoiceV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aPinpointSmsVoiceV2AsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aPinpointSmsVoiceV2AsyncClient
.
-