Interface PinpointSmsVoiceAsyncClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface PinpointSmsVoiceAsyncClient extends AwsClient
Service client for accessing Pinpoint SMS Voice asynchronously. This can be created using the staticbuilder()method. Pinpoint SMS and Voice Messaging public facing APIs
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
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 theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
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.Builderavoiding the need to create one manually viaCreateConfigurationSetRequest.builder()- Parameters:
createConfigurationSetRequest- AConsumerthat will call methods onCreateConfigurationSetRequest.Builderto 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.Builderavoiding the need to create one manually viaCreateConfigurationSetEventDestinationRequest.builder()- Parameters:
createConfigurationSetEventDestinationRequest- AConsumerthat will call methods onCreateConfigurationSetEventDestinationRequest.Builderto 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.Builderavoiding the need to create one manually viaDeleteConfigurationSetRequest.builder()- Parameters:
deleteConfigurationSetRequest- AConsumerthat will call methods onDeleteConfigurationSetRequest.Builderto 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.Builderavoiding the need to create one manually viaDeleteConfigurationSetEventDestinationRequest.builder()- Parameters:
deleteConfigurationSetEventDestinationRequest- AConsumerthat will call methods onDeleteConfigurationSetEventDestinationRequest.Builderto 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.Builderavoiding the need to create one manually viaGetConfigurationSetEventDestinationsRequest.builder()- Parameters:
getConfigurationSetEventDestinationsRequest- AConsumerthat will call methods onGetConfigurationSetEventDestinationsRequest.Builderto 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.Builderavoiding the need to create one manually viaListConfigurationSetsRequest.builder()- Parameters:
listConfigurationSetsRequest- AConsumerthat will call methods onListConfigurationSetsRequest.Builderto 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.Builderavoiding the need to create one manually viaSendVoiceMessageRequest.builder()- Parameters:
sendVoiceMessageRequest- AConsumerthat will call methods onSendVoiceMessageRequest.Builderto 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.Builderavoiding the need to create one manually viaUpdateConfigurationSetEventDestinationRequest.builder()- Parameters:
updateConfigurationSetEventDestinationRequest- AConsumerthat will call methods onUpdateConfigurationSetEventDestinationRequest.Builderto 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
-
serviceClientConfiguration
default PinpointSmsVoiceServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
create
static PinpointSmsVoiceAsyncClient create()
Create aPinpointSmsVoiceAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static PinpointSmsVoiceAsyncClientBuilder builder()
Create a builder that can be used to configure and create aPinpointSmsVoiceAsyncClient.
-
-