Package software.amazon.awssdk.services.pinpointsmsvoicev2

Interface PinpointSmsVoiceV2AsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface PinpointSmsVoiceV2AsyncClient extends AwsClient
Service client for accessing Amazon Pinpoint SMS Voice V2 asynchronously. This can be created using the static builder() method.

Welcome to the Amazon Pinpoint SMS and Voice, version 2 API Reference. This guide provides information about Amazon Pinpoint SMS and Voice, version 2 API resources, including supported HTTP methods, parameters, and schemas.

Amazon Pinpoint is an Amazon Web Services service that you can use to engage with your recipients across multiple messaging channels. The Amazon Pinpoint SMS and Voice, version 2 API provides programmatic access to options that are unique to the SMS and voice channels and supplements the resources provided by the Amazon Pinpoint API.

If you're new to Amazon Pinpoint, it's also helpful to review the Amazon Pinpoint Developer Guide. The Amazon Pinpoint Developer Guide provides tutorials, code samples, and procedures that demonstrate how to use Amazon Pinpoint features programmatically and how to integrate Amazon Pinpoint functionality into mobile apps and other types of applications. The guide also provides key information, such as Amazon Pinpoint integration with other Amazon Web Services services, and the quotas that apply to use of the service.

  • Field Details

  • 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.
      • 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 via AssociateOriginationIdentityRequest.builder()

      Parameters:
      associateOriginationIdentityRequest - A Consumer that will call methods on AssociateOriginationIdentityRequest.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.
      • 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:

    • 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.
      • 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 via CreateConfigurationSetRequest.builder()

      Parameters:
      createConfigurationSetRequest - A Consumer that will call methods on CreateConfigurationSetRequest.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.
      • 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.
      • 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 via CreateEventDestinationRequest.builder()

      Parameters:
      createEventDestinationRequest - A Consumer that will call methods on CreateEventDestinationRequest.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.
      • 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.
      • 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 via CreateOptOutListRequest.builder()

      Parameters:
      createOptOutListRequest - A Consumer that will call methods on CreateOptOutListRequest.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.
      • 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

      default CompletableFuture<CreatePoolResponse> createPool(CreatePoolRequest createPoolRequest)

      Creates a new pool and associates the specified origination identity to the pool. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.

      The new pool inherits its configuration from the specified origination identity. This includes keywords, message type, opt-out list, two-way configuration, and self-managed opt-out configuration. Deletion protection isn't inherited from the origination identity and defaults to false.

      If the origination identity is a phone number and is already associated with another pool, an Error is returned. A sender ID can be associated with multiple pools.

      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.
      • 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 via CreatePoolRequest.builder()

      Parameters:
      createPoolRequest - A Consumer that will call methods on CreatePoolRequest.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.
      • 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:

    • 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.
      • ThrottlingException An error that occurred because too many requests 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 via DeleteConfigurationSetRequest.builder()

      Parameters:
      deleteConfigurationSetRequest - A Consumer that will call methods on DeleteConfigurationSetRequest.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.
      • ThrottlingException An error that occurred because too many requests 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.
      • ThrottlingException An error that occurred because too many requests 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 via DeleteDefaultMessageTypeRequest.builder()

      Parameters:
      deleteDefaultMessageTypeRequest - A Consumer that will call methods on DeleteDefaultMessageTypeRequest.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.
      • ThrottlingException An error that occurred because too many requests 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.
      • ThrottlingException An error that occurred because too many requests 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 via DeleteDefaultSenderIdRequest.builder()

      Parameters:
      deleteDefaultSenderIdRequest - A Consumer that will call methods on DeleteDefaultSenderIdRequest.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.
      • ThrottlingException An error that occurred because too many requests 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.
      • ThrottlingException An error that occurred because too many requests 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 via DeleteEventDestinationRequest.builder()

      Parameters:
      deleteEventDestinationRequest - A Consumer that will call methods on DeleteEventDestinationRequest.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.
      • ThrottlingException An error that occurred because too many requests 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.
      • ThrottlingException An error that occurred because too many requests 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 via DeleteKeywordRequest.builder()

      Parameters:
      deleteKeywordRequest - A Consumer that will call methods on DeleteKeywordRequest.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.
      • ThrottlingException An error that occurred because too many requests 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(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.
      • ThrottlingException An error that occurred because too many requests 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 via DeleteOptOutListRequest.builder()

      Parameters:
      deleteOptOutListRequest - A Consumer that will call methods on DeleteOptOutListRequest.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.
      • ThrottlingException An error that occurred because too many requests 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.
      • ThrottlingException An error that occurred because too many requests 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 via DeleteOptedOutNumberRequest.builder()

      Parameters:
      deleteOptedOutNumberRequest - A Consumer that will call methods on DeleteOptedOutNumberRequest.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.
      • ThrottlingException An error that occurred because too many requests 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(DeletePoolRequest deletePoolRequest)

      Deletes an existing pool. Deleting a pool disassociates all origination identities from that pool.

      If the pool status isn't active or if deletion protection is enabled, an Error is returned.

      A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.

      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.
      • ThrottlingException An error that occurred because too many requests 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 via DeletePoolRequest.builder()

      Parameters:
      deletePoolRequest - A Consumer that will call methods on DeletePoolRequest.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.
      • ThrottlingException An error that occurred because too many requests 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 the MaxLimit, which is controlled by Amazon Web Services. For more information on spend limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.

      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.
      • ThrottlingException An error that occurred because too many requests 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 the MaxLimit, which is controlled by Amazon Web Services. For more information on spend limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.


      This is a convenience which creates an instance of the DeleteTextMessageSpendLimitOverrideRequest.Builder avoiding the need to create one manually via DeleteTextMessageSpendLimitOverrideRequest.builder()

      Parameters:
      deleteTextMessageSpendLimitOverrideRequest - A Consumer that will call methods on DeleteTextMessageSpendLimitOverrideRequest.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.
      • ThrottlingException An error that occurred because too many requests 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(DeleteVoiceMessageSpendLimitOverrideRequest deleteVoiceMessageSpendLimitOverrideRequest)

      Deletes an account level monthly spend limit override for sending voice messages. Deleting a spend limit override sets the EnforcedLimit equal to the MaxLimit, which is controlled by Amazon Web Services. For more information on spending limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.

      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.
      • ThrottlingException An error that occurred because too many requests 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 the MaxLimit, which is controlled by Amazon Web Services. For more information on spending limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.


      This is a convenience which creates an instance of the DeleteVoiceMessageSpendLimitOverrideRequest.Builder avoiding the need to create one manually via DeleteVoiceMessageSpendLimitOverrideRequest.builder()

      Parameters:
      deleteVoiceMessageSpendLimitOverrideRequest - A Consumer that will call methods on DeleteVoiceMessageSpendLimitOverrideRequest.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.
      • ThrottlingException An error that occurred because too many requests 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.
      • ThrottlingException An error that occurred because too many requests 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 via DescribeAccountAttributesRequest.builder()

      Parameters:
      describeAccountAttributesRequest - A Consumer that will call methods on DescribeAccountAttributesRequest.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.
      • ThrottlingException An error that occurred because too many requests 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)

      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 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeAccountAttributesPublisher publisher = client.describeAccountAttributesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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.
      • ThrottlingException An error that occurred because too many requests 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)

      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 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeAccountAttributesPublisher publisher = client.describeAccountAttributesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 via DescribeAccountAttributesRequest.builder()

      Parameters:
      describeAccountAttributesRequest - A Consumer that will call methods on DescribeAccountAttributesRequest.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.
      • ThrottlingException An error that occurred because too many requests 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.
      • ThrottlingException An error that occurred because too many requests 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 via DescribeAccountLimitsRequest.builder()

      Parameters:
      describeAccountLimitsRequest - A Consumer that will call methods on DescribeAccountLimitsRequest.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.
      • ThrottlingException An error that occurred because too many requests 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)

      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 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeAccountLimitsPublisher publisher = client.describeAccountLimitsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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.
      • ThrottlingException An error that occurred because too many requests 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)

      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 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeAccountLimitsPublisher publisher = client.describeAccountLimitsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 via DescribeAccountLimitsRequest.builder()

      Parameters:
      describeAccountLimitsRequest - A Consumer that will call methods on DescribeAccountLimitsRequest.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.
      • ThrottlingException An error that occurred because too many requests 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.
      • ThrottlingException An error that occurred because too many requests 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 via DescribeConfigurationSetsRequest.builder()

      Parameters:
      describeConfigurationSetsRequest - A Consumer that will call methods on DescribeConfigurationSetsRequest.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.
      • ThrottlingException An error that occurred because too many requests 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)

      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 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeConfigurationSetsPublisher publisher = client.describeConfigurationSetsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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.
      • ThrottlingException An error that occurred because too many requests 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)

      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 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeConfigurationSetsPublisher publisher = client.describeConfigurationSetsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 via DescribeConfigurationSetsRequest.builder()

      Parameters:
      describeConfigurationSetsRequest - A Consumer that will call methods on DescribeConfigurationSetsRequest.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.
      • ThrottlingException An error that occurred because too many requests 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.
      • ThrottlingException An error that occurred because too many requests 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 via DescribeKeywordsRequest.builder()

      Parameters:
      describeKeywordsRequest - A Consumer that will call methods on DescribeKeywordsRequest.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.
      • ThrottlingException An error that occurred because too many requests 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)

      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 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeKeywordsPublisher publisher = client.describeKeywordsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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.
      • ThrottlingException An error that occurred because too many requests 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)

      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 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeKeywordsPublisher publisher = client.describeKeywordsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 via DescribeKeywordsRequest.builder()

      Parameters:
      describeKeywordsRequest - A Consumer that will call methods on DescribeKeywordsRequest.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.
      • ThrottlingException An error that occurred because too many requests 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.
      • ThrottlingException An error that occurred because too many requests 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 via DescribeOptOutListsRequest.builder()

      Parameters:
      describeOptOutListsRequest - A Consumer that will call methods on DescribeOptOutListsRequest.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.
      • ThrottlingException An error that occurred because too many requests 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)

      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 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeOptOutListsPublisher publisher = client.describeOptOutListsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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.
      • ThrottlingException An error that occurred because too many requests 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)

      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 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeOptOutListsPublisher publisher = client.describeOptOutListsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 via DescribeOptOutListsRequest.builder()

      Parameters:
      describeOptOutListsRequest - A Consumer that will call methods on DescribeOptOutListsRequest.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.
      • ThrottlingException An error that occurred because too many requests 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.
      • ThrottlingException An error that occurred because too many requests 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 via DescribeOptedOutNumbersRequest.builder()

      Parameters:
      describeOptedOutNumbersRequest - A Consumer that will call methods on DescribeOptedOutNumbersRequest.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.
      • ThrottlingException An error that occurred because too many requests 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)

      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 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeOptedOutNumbersPublisher publisher = client.describeOptedOutNumbersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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.
      • ThrottlingException An error that occurred because too many requests 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)

      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 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeOptedOutNumbersPublisher publisher = client.describeOptedOutNumbersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 via DescribeOptedOutNumbersRequest.builder()

      Parameters:
      describeOptedOutNumbersRequest - A Consumer that will call methods on DescribeOptedOutNumbersRequest.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.
      • ThrottlingException An error that occurred because too many requests 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.
      • ThrottlingException An error that occurred because too many requests 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 via DescribePhoneNumbersRequest.builder()

      Parameters:
      describePhoneNumbersRequest - A Consumer that will call methods on DescribePhoneNumbersRequest.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.
      • ThrottlingException An error that occurred because too many requests 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)

      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 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribePhoneNumbersPublisher publisher = client.describePhoneNumbersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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.
      • ThrottlingException An error that occurred because too many requests 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)

      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 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribePhoneNumbersPublisher publisher = client.describePhoneNumbersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 via DescribePhoneNumbersRequest.builder()

      Parameters:
      describePhoneNumbersRequest - A Consumer that will call methods on DescribePhoneNumbersRequest.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.
      • ThrottlingException An error that occurred because too many requests 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.
      • ThrottlingException An error that occurred because too many requests 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 via DescribePoolsRequest.builder()

      Parameters:
      describePoolsRequest - A Consumer that will call methods on DescribePoolsRequest.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.
      • ThrottlingException An error that occurred because too many requests 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(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.


      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 new Subscription 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 method 
       
 software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribePoolsPublisher publisher = client.describePoolsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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.
      • ThrottlingException An error that occurred because too many requests 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)

      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 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribePoolsPublisher publisher = client.describePoolsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 via DescribePoolsRequest.builder()

      Parameters:
      describePoolsRequest - A Consumer that will call methods on DescribePoolsRequest.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.
      • ThrottlingException An error that occurred because too many requests 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.
      • ThrottlingException An error that occurred because too many requests 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 via DescribeSenderIdsRequest.builder()

      Parameters:
      describeSenderIdsRequest - A Consumer that will call methods on DescribeSenderIdsRequest.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.
      • ThrottlingException An error that occurred because too many requests 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)

      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 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeSenderIdsPublisher publisher = client.describeSenderIdsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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.
      • ThrottlingException An error that occurred because too many requests 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)

      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 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeSenderIdsPublisher publisher = client.describeSenderIdsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 via DescribeSenderIdsRequest.builder()

      Parameters:
      describeSenderIdsRequest - A Consumer that will call methods on DescribeSenderIdsRequest.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.
      • ThrottlingException An error that occurred because too many requests 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.
      • ThrottlingException An error that occurred because too many requests 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 via DescribeSpendLimitsRequest.builder()

      Parameters:
      describeSpendLimitsRequest - A Consumer that will call methods on DescribeSpendLimitsRequest.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.
      • ThrottlingException An error that occurred because too many requests 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)

      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 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeSpendLimitsPublisher publisher = client.describeSpendLimitsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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.
      • ThrottlingException An error that occurred because too many requests 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)

      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 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeSpendLimitsPublisher publisher = client.describeSpendLimitsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 via DescribeSpendLimitsRequest.builder()

      Parameters:
      describeSpendLimitsRequest - A Consumer that will call methods on DescribeSpendLimitsRequest.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.
      • ThrottlingException An error that occurred because too many requests 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:

    • 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.
      • ThrottlingException An error that occurred because too many requests 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 via DisassociateOriginationIdentityRequest.builder()

      Parameters:
      disassociateOriginationIdentityRequest - A Consumer that will call methods on DisassociateOriginationIdentityRequest.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.
      • ThrottlingException An error that occurred because too many requests 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:

    • 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.
      • ThrottlingException An error that occurred because too many requests 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 via ListPoolOriginationIdentitiesRequest.builder()

      Parameters:
      listPoolOriginationIdentitiesRequest - A Consumer that will call methods on ListPoolOriginationIdentitiesRequest.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.
      • ThrottlingException An error that occurred because too many requests 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)

      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 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.ListPoolOriginationIdentitiesPublisher publisher = client.listPoolOriginationIdentitiesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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.
      • ThrottlingException An error that occurred because too many requests 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)

      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 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.ListPoolOriginationIdentitiesPublisher publisher = client.listPoolOriginationIdentitiesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 via ListPoolOriginationIdentitiesRequest.builder()

      Parameters:
      listPoolOriginationIdentitiesRequest - A Consumer that will call methods on ListPoolOriginationIdentitiesRequest.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.
      • ThrottlingException An error that occurred because too many requests 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.
      • ThrottlingException An error that occurred because too many requests 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 via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.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.
      • ThrottlingException An error that occurred because too many requests 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

      default CompletableFuture<PutKeywordResponse> putKeyword(PutKeywordRequest putKeywordRequest)

      Creates or updates a keyword configuration on an origination phone number or pool.

      A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.

      If you specify a keyword that isn't valid, an Error is returned.

      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.
      • 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 via PutKeywordRequest.builder()

      Parameters:
      putKeywordRequest - A Consumer that will call methods on PutKeywordRequest.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.
      • 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.
      • ThrottlingException An error that occurred because too many requests 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 via PutOptedOutNumberRequest.builder()

      Parameters:
      putOptedOutNumberRequest - A Consumer that will call methods on PutOptedOutNumberRequest.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.
      • ThrottlingException An error that occurred because too many requests 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:

    • 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.
      • ThrottlingException An error that occurred because too many requests 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 via ReleasePhoneNumberRequest.builder()

      Parameters:
      releasePhoneNumberRequest - A Consumer that will call methods on ReleasePhoneNumberRequest.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.
      • ThrottlingException An error that occurred because too many requests 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.
      • 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 via RequestPhoneNumberRequest.builder()

      Parameters:
      requestPhoneNumberRequest - A Consumer that will call methods on RequestPhoneNumberRequest.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.
      • 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.
      • 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 via SendTextMessageRequest.builder()

      Parameters:
      sendTextMessageRequest - A Consumer that will call methods on SendTextMessageRequest.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.
      • 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 text 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.
      • 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 text 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 via SendVoiceMessageRequest.builder()

      Parameters:
      sendVoiceMessageRequest - A Consumer that will call methods on SendVoiceMessageRequest.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.
      • 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:

    • 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.
      • ThrottlingException An error that occurred because too many requests 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 via SetDefaultMessageTypeRequest.builder()

      Parameters:
      setDefaultMessageTypeRequest - A Consumer that will call methods on SetDefaultMessageTypeRequest.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.
      • ThrottlingException An error that occurred because too many requests 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.
      • ThrottlingException An error that occurred because too many requests 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 via SetDefaultSenderIdRequest.builder()

      Parameters:
      setDefaultSenderIdRequest - A Consumer that will call methods on SetDefaultSenderIdRequest.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.
      • ThrottlingException An error that occurred because too many requests 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:

    • 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.
      • ThrottlingException An error that occurred because too many requests 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 via SetTextMessageSpendLimitOverrideRequest.builder()

      Parameters:
      setTextMessageSpendLimitOverrideRequest - A Consumer that will call methods on SetTextMessageSpendLimitOverrideRequest.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.
      • ThrottlingException An error that occurred because too many requests 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.
      • ThrottlingException An error that occurred because too many requests 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 via SetVoiceMessageSpendLimitOverrideRequest.builder()

      Parameters:
      setVoiceMessageSpendLimitOverrideRequest - A Consumer that will call methods on SetVoiceMessageSpendLimitOverrideRequest.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.
      • ThrottlingException An error that occurred because too many requests 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:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS Voice, version 2 resource. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.

      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.
      • 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 via TagResourceRequest.builder()

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.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.
      • 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.
      • ThrottlingException An error that occurred because too many requests 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 via UntagResourceRequest.builder()

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.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.
      • ThrottlingException An error that occurred because too many requests 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.
      • ThrottlingException An error that occurred because too many requests 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 via UpdateEventDestinationRequest.builder()

      Parameters:
      updateEventDestinationRequest - A Consumer that will call methods on UpdateEventDestinationRequest.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.
      • ThrottlingException An error that occurred because too many requests 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.
      • ThrottlingException An error that occurred because too many requests 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 via UpdatePhoneNumberRequest.builder()

      Parameters:
      updatePhoneNumberRequest - A Consumer that will call methods on UpdatePhoneNumberRequest.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.
      • ThrottlingException An error that occurred because too many requests 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(UpdatePoolRequest updatePoolRequest)

      Updates the configuration of an existing pool. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, enable or disable deletion protection, and enable or disable shared routes.

      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.
      • ThrottlingException An error that occurred because too many requests 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 via UpdatePoolRequest.builder()

      Parameters:
      updatePoolRequest - A Consumer that will call methods on UpdatePoolRequest.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.
      • ThrottlingException An error that occurred because too many requests 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

      default PinpointSmsVoiceV2ServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static PinpointSmsVoiceV2AsyncClient create()
      Create a PinpointSmsVoiceV2AsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static PinpointSmsVoiceV2AsyncClientBuilder builder()
      Create a builder that can be used to configure and create a PinpointSmsVoiceV2AsyncClient.