software.amazon.awssdk.services.pinpointsmsvoice

Interface PinpointSmsVoiceAsyncClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
 @ThreadSafe
public interface PinpointSmsVoiceAsyncClient
extends SdkClient

Service client for accessing Pinpoint SMS Voice asynchronously. This can be created using the static builder() method. Pinpoint SMS and Voice Messaging public facing APIs

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_METADATA_ID Value for looking up the service's metadata from the ServiceMetadataProvider.
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
static PinpointSmsVoiceAsyncClientBuilder	builder() Create a builder that can be used to configure and create a PinpointSmsVoiceAsyncClient.
static PinpointSmsVoiceAsyncClient	create() Create a PinpointSmsVoiceAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<CreateConfigurationSetResponse>	createConfigurationSet(Consumer<CreateConfigurationSetRequest.Builder> createConfigurationSetRequest) Create a new configuration set.
default CompletableFuture<CreateConfigurationSetResponse>	createConfigurationSet(CreateConfigurationSetRequest createConfigurationSetRequest) Create a new configuration set.
default CompletableFuture<CreateConfigurationSetEventDestinationResponse>	createConfigurationSetEventDestination(Consumer<CreateConfigurationSetEventDestinationRequest.Builder> createConfigurationSetEventDestinationRequest) Create a new event destination in a configuration set.
default CompletableFuture<CreateConfigurationSetEventDestinationResponse>	createConfigurationSetEventDestination(CreateConfigurationSetEventDestinationRequest createConfigurationSetEventDestinationRequest) Create a new event destination in a configuration set.
default CompletableFuture<DeleteConfigurationSetResponse>	deleteConfigurationSet(Consumer<DeleteConfigurationSetRequest.Builder> deleteConfigurationSetRequest) Deletes an existing configuration set.
default CompletableFuture<DeleteConfigurationSetResponse>	deleteConfigurationSet(DeleteConfigurationSetRequest deleteConfigurationSetRequest) Deletes an existing configuration set.
default CompletableFuture<DeleteConfigurationSetEventDestinationResponse>	deleteConfigurationSetEventDestination(Consumer<DeleteConfigurationSetEventDestinationRequest.Builder> deleteConfigurationSetEventDestinationRequest) Deletes an event destination in a configuration set.
default CompletableFuture<DeleteConfigurationSetEventDestinationResponse>	deleteConfigurationSetEventDestination(DeleteConfigurationSetEventDestinationRequest deleteConfigurationSetEventDestinationRequest) Deletes an event destination in a configuration set.
default CompletableFuture<GetConfigurationSetEventDestinationsResponse>	getConfigurationSetEventDestinations(Consumer<GetConfigurationSetEventDestinationsRequest.Builder> getConfigurationSetEventDestinationsRequest) Obtain information about an event destination, including the types of events it reports, the Amazon Resource Name (ARN) of the destination, and the name of the event destination.
default CompletableFuture<GetConfigurationSetEventDestinationsResponse>	getConfigurationSetEventDestinations(GetConfigurationSetEventDestinationsRequest getConfigurationSetEventDestinationsRequest) Obtain information about an event destination, including the types of events it reports, the Amazon Resource Name (ARN) of the destination, and the name of the event destination.
default CompletableFuture<ListConfigurationSetsResponse>	listConfigurationSets(Consumer<ListConfigurationSetsRequest.Builder> listConfigurationSetsRequest) List all of the configuration sets associated with your Amazon Pinpoint account in the current region.
default CompletableFuture<ListConfigurationSetsResponse>	listConfigurationSets(ListConfigurationSetsRequest listConfigurationSetsRequest) List all of the configuration sets associated with your Amazon Pinpoint account in the current region.
default CompletableFuture<SendVoiceMessageResponse>	sendVoiceMessage(Consumer<SendVoiceMessageRequest.Builder> sendVoiceMessageRequest) Create a new voice message and send it to a recipient's phone number.
default CompletableFuture<SendVoiceMessageResponse>	sendVoiceMessage(SendVoiceMessageRequest sendVoiceMessageRequest) Create a new voice message and send it to a recipient's phone number.
default CompletableFuture<UpdateConfigurationSetEventDestinationResponse>	updateConfigurationSetEventDestination(Consumer<UpdateConfigurationSetEventDestinationRequest.Builder> updateConfigurationSetEventDestinationRequest) Update an event destination in a configuration set.
default CompletableFuture<UpdateConfigurationSetEventDestinationResponse>	updateConfigurationSetEventDestination(UpdateConfigurationSetEventDestinationRequest updateConfigurationSetEventDestinationRequest) Update an event destination in a configuration set.

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

Constant Field Values

Method Detail

create

static PinpointSmsVoiceAsyncClient create()

Create a PinpointSmsVoiceAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static PinpointSmsVoiceAsyncClientBuilder builder()

Create a builder that can be used to configure and create a PinpointSmsVoiceAsyncClient.

createConfigurationSet

default CompletableFuture<CreateConfigurationSetResponse> createConfigurationSet(CreateConfigurationSetRequest createConfigurationSetRequest)

Create a new configuration set. After you create the configuration set, you can add one or more event destinations to it.

Parameters:

createConfigurationSetRequest - A request to create a new configuration set.

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.

• TooManyRequestsException TooManyRequestsException
• BadRequestException BadRequestException
• LimitExceededException LimitExceededException
• InternalServiceErrorException InternalServiceErrorException
• AlreadyExistsException AlreadyExistsException
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• PinpointSmsVoiceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

createConfigurationSet

default CompletableFuture<CreateConfigurationSetResponse> createConfigurationSet(Consumer<CreateConfigurationSetRequest.Builder> createConfigurationSetRequest)

Create a new configuration set. After you create the configuration set, you can add one or more event destinations to it.

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. A request to create a new configuration set.

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.

• TooManyRequestsException TooManyRequestsException
• BadRequestException BadRequestException
• LimitExceededException LimitExceededException
• InternalServiceErrorException InternalServiceErrorException
• AlreadyExistsException AlreadyExistsException
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• PinpointSmsVoiceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

createConfigurationSetEventDestination

default CompletableFuture<CreateConfigurationSetEventDestinationResponse> createConfigurationSetEventDestination(CreateConfigurationSetEventDestinationRequest createConfigurationSetEventDestinationRequest)

Create a new event destination in a configuration set.

Parameters:

createConfigurationSetEventDestinationRequest - Create a new event destination in a configuration set.

Returns:

A Java Future containing the result of the CreateConfigurationSetEventDestination operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException BadRequestException
• LimitExceededException LimitExceededException
• InternalServiceErrorException InternalServiceErrorException
• NotFoundException NotFoundException
• TooManyRequestsException TooManyRequestsException
• AlreadyExistsException AlreadyExistsException
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• PinpointSmsVoiceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

createConfigurationSetEventDestination

default CompletableFuture<CreateConfigurationSetEventDestinationResponse> createConfigurationSetEventDestination(Consumer<CreateConfigurationSetEventDestinationRequest.Builder> createConfigurationSetEventDestinationRequest)

Create a new event destination in a configuration set.

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

Parameters:

createConfigurationSetEventDestinationRequest - A Consumer that will call methods on CreateConfigurationSetEventDestinationRequest.Builder to create a request. Create a new event destination in a configuration set.

Returns:

A Java Future containing the result of the CreateConfigurationSetEventDestination operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException BadRequestException
• LimitExceededException LimitExceededException
• InternalServiceErrorException InternalServiceErrorException
• NotFoundException NotFoundException
• TooManyRequestsException TooManyRequestsException
• AlreadyExistsException AlreadyExistsException
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• PinpointSmsVoiceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

deleteConfigurationSet

default CompletableFuture<DeleteConfigurationSetResponse> deleteConfigurationSet(DeleteConfigurationSetRequest deleteConfigurationSetRequest)

Deletes an existing configuration set.

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.

• NotFoundException NotFoundException
• TooManyRequestsException TooManyRequestsException
• BadRequestException BadRequestException
• InternalServiceErrorException InternalServiceErrorException
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• PinpointSmsVoiceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

deleteConfigurationSet

default CompletableFuture<DeleteConfigurationSetResponse> deleteConfigurationSet(Consumer<DeleteConfigurationSetRequest.Builder> deleteConfigurationSetRequest)

Deletes an existing configuration set.

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.

• NotFoundException NotFoundException
• TooManyRequestsException TooManyRequestsException
• BadRequestException BadRequestException
• InternalServiceErrorException InternalServiceErrorException
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• PinpointSmsVoiceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

deleteConfigurationSetEventDestination

default CompletableFuture<DeleteConfigurationSetEventDestinationResponse> deleteConfigurationSetEventDestination(DeleteConfigurationSetEventDestinationRequest deleteConfigurationSetEventDestinationRequest)

Deletes an event destination in a configuration set.

Parameters:

deleteConfigurationSetEventDestinationRequest -

Returns:

A Java Future containing the result of the DeleteConfigurationSetEventDestination operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotFoundException NotFoundException
• TooManyRequestsException TooManyRequestsException
• BadRequestException BadRequestException
• InternalServiceErrorException InternalServiceErrorException
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• PinpointSmsVoiceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

deleteConfigurationSetEventDestination

default CompletableFuture<DeleteConfigurationSetEventDestinationResponse> deleteConfigurationSetEventDestination(Consumer<DeleteConfigurationSetEventDestinationRequest.Builder> deleteConfigurationSetEventDestinationRequest)

Deletes an event destination in a configuration set.

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

Parameters:

deleteConfigurationSetEventDestinationRequest - A Consumer that will call methods on DeleteConfigurationSetEventDestinationRequest.Builder to create a request.

Returns:

A Java Future containing the result of the DeleteConfigurationSetEventDestination operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotFoundException NotFoundException
• TooManyRequestsException TooManyRequestsException
• BadRequestException BadRequestException
• InternalServiceErrorException InternalServiceErrorException
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• PinpointSmsVoiceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getConfigurationSetEventDestinations

default CompletableFuture<GetConfigurationSetEventDestinationsResponse> getConfigurationSetEventDestinations(GetConfigurationSetEventDestinationsRequest getConfigurationSetEventDestinationsRequest)

Obtain information about an event destination, including the types of events it reports, the Amazon Resource Name (ARN) of the destination, and the name of the event destination.

Parameters:

getConfigurationSetEventDestinationsRequest -

Returns:

A Java Future containing the result of the GetConfigurationSetEventDestinations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotFoundException NotFoundException
• TooManyRequestsException TooManyRequestsException
• BadRequestException BadRequestException
• InternalServiceErrorException InternalServiceErrorException
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• PinpointSmsVoiceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getConfigurationSetEventDestinations

default CompletableFuture<GetConfigurationSetEventDestinationsResponse> getConfigurationSetEventDestinations(Consumer<GetConfigurationSetEventDestinationsRequest.Builder> getConfigurationSetEventDestinationsRequest)

Obtain information about an event destination, including the types of events it reports, the Amazon Resource Name (ARN) of the destination, and the name of the event destination.

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

Parameters:

getConfigurationSetEventDestinationsRequest - A Consumer that will call methods on GetConfigurationSetEventDestinationsRequest.Builder to create a request.

Returns:

A Java Future containing the result of the GetConfigurationSetEventDestinations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotFoundException NotFoundException
• TooManyRequestsException TooManyRequestsException
• BadRequestException BadRequestException
• InternalServiceErrorException InternalServiceErrorException
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• PinpointSmsVoiceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listConfigurationSets

default CompletableFuture<ListConfigurationSetsResponse> listConfigurationSets(ListConfigurationSetsRequest listConfigurationSetsRequest)

List all of the configuration sets associated with your Amazon Pinpoint account in the current region.

Parameters:

listConfigurationSetsRequest -

Returns:

A Java Future containing the result of the ListConfigurationSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• TooManyRequestsException TooManyRequestsException
• BadRequestException BadRequestException
• InternalServiceErrorException InternalServiceErrorException
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• PinpointSmsVoiceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listConfigurationSets

default CompletableFuture<ListConfigurationSetsResponse> listConfigurationSets(Consumer<ListConfigurationSetsRequest.Builder> listConfigurationSetsRequest)

List all of the configuration sets associated with your Amazon Pinpoint account in the current region.

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

Parameters:

listConfigurationSetsRequest - A Consumer that will call methods on ListConfigurationSetsRequest.Builder to create a request.

Returns:

A Java Future containing the result of the ListConfigurationSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• TooManyRequestsException TooManyRequestsException
• BadRequestException BadRequestException
• InternalServiceErrorException InternalServiceErrorException
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• PinpointSmsVoiceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

sendVoiceMessage

default CompletableFuture<SendVoiceMessageResponse> sendVoiceMessage(SendVoiceMessageRequest sendVoiceMessageRequest)

Create a new voice message and send it to a recipient's phone number.

Parameters:

sendVoiceMessageRequest - 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.

• TooManyRequestsException TooManyRequestsException
• BadRequestException BadRequestException
• InternalServiceErrorException InternalServiceErrorException
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• PinpointSmsVoiceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

sendVoiceMessage

default CompletableFuture<SendVoiceMessageResponse> sendVoiceMessage(Consumer<SendVoiceMessageRequest.Builder> sendVoiceMessageRequest)

Create a new voice message and send it to a recipient's phone number.

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. 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.

• TooManyRequestsException TooManyRequestsException
• BadRequestException BadRequestException
• InternalServiceErrorException InternalServiceErrorException
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• PinpointSmsVoiceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

updateConfigurationSetEventDestination

default CompletableFuture<UpdateConfigurationSetEventDestinationResponse> updateConfigurationSetEventDestination(UpdateConfigurationSetEventDestinationRequest updateConfigurationSetEventDestinationRequest)

Update an event destination in a configuration set. An event destination is a location that you publish information about your voice calls to. For example, you can log an event to an Amazon CloudWatch destination when a call fails.

Parameters:

updateConfigurationSetEventDestinationRequest - UpdateConfigurationSetEventDestinationRequest

Returns:

A Java Future containing the result of the UpdateConfigurationSetEventDestination operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotFoundException NotFoundException
• TooManyRequestsException TooManyRequestsException
• BadRequestException BadRequestException
• InternalServiceErrorException InternalServiceErrorException
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• PinpointSmsVoiceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

updateConfigurationSetEventDestination

default CompletableFuture<UpdateConfigurationSetEventDestinationResponse> updateConfigurationSetEventDestination(Consumer<UpdateConfigurationSetEventDestinationRequest.Builder> updateConfigurationSetEventDestinationRequest)

Update an event destination in a configuration set. An event destination is a location that you publish information about your voice calls to. For example, you can log an event to an Amazon CloudWatch destination when a call fails.

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

Parameters:

updateConfigurationSetEventDestinationRequest - A Consumer that will call methods on UpdateConfigurationSetEventDestinationRequest.Builder to create a request. UpdateConfigurationSetEventDestinationRequest

Returns:

A Java Future containing the result of the UpdateConfigurationSetEventDestination operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotFoundException NotFoundException
• TooManyRequestsException TooManyRequestsException
• BadRequestException BadRequestException
• InternalServiceErrorException InternalServiceErrorException
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• PinpointSmsVoiceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation