software.amazon.awssdk.services.pinpointsmsvoice

Interface PinpointSmsVoiceClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

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

Service client for accessing Pinpoint SMS Voice. 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_NAME

Method Summary

Modifier and Type	Method and Description
static PinpointSmsVoiceClientBuilder	builder() Create a builder that can be used to configure and create a PinpointSmsVoiceClient.
static PinpointSmsVoiceClient	create() Create a PinpointSmsVoiceClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateConfigurationSetResponse	createConfigurationSet(Consumer<CreateConfigurationSetRequest.Builder> createConfigurationSetRequest) Create a new configuration set.
default CreateConfigurationSetResponse	createConfigurationSet(CreateConfigurationSetRequest createConfigurationSetRequest) Create a new configuration set.
default CreateConfigurationSetEventDestinationResponse	createConfigurationSetEventDestination(Consumer<CreateConfigurationSetEventDestinationRequest.Builder> createConfigurationSetEventDestinationRequest) Create a new event destination in a configuration set.
default CreateConfigurationSetEventDestinationResponse	createConfigurationSetEventDestination(CreateConfigurationSetEventDestinationRequest createConfigurationSetEventDestinationRequest) Create a new event destination in a configuration set.
default DeleteConfigurationSetResponse	deleteConfigurationSet(Consumer<DeleteConfigurationSetRequest.Builder> deleteConfigurationSetRequest) Deletes an existing configuration set.
default DeleteConfigurationSetResponse	deleteConfigurationSet(DeleteConfigurationSetRequest deleteConfigurationSetRequest) Deletes an existing configuration set.
default DeleteConfigurationSetEventDestinationResponse	deleteConfigurationSetEventDestination(Consumer<DeleteConfigurationSetEventDestinationRequest.Builder> deleteConfigurationSetEventDestinationRequest) Deletes an event destination in a configuration set.
default DeleteConfigurationSetEventDestinationResponse	deleteConfigurationSetEventDestination(DeleteConfigurationSetEventDestinationRequest deleteConfigurationSetEventDestinationRequest) Deletes an event destination in a configuration set.
default 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 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 SendVoiceMessageResponse	sendVoiceMessage(Consumer<SendVoiceMessageRequest.Builder> sendVoiceMessageRequest) Create a new voice message and send it to a recipient's phone number.
default SendVoiceMessageResponse	sendVoiceMessage(SendVoiceMessageRequest sendVoiceMessageRequest) Create a new voice message and send it to a recipient's phone number.
static ServiceMetadata	serviceMetadata()
default UpdateConfigurationSetEventDestinationResponse	updateConfigurationSetEventDestination(Consumer<UpdateConfigurationSetEventDestinationRequest.Builder> updateConfigurationSetEventDestinationRequest) Update an event destination in a configuration set.
default 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

Method Detail

create

static PinpointSmsVoiceClient create()

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

builder

static PinpointSmsVoiceClientBuilder builder()

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

createConfigurationSet

default CreateConfigurationSetResponse createConfigurationSet(CreateConfigurationSetRequest createConfigurationSetRequest)
                                                       throws TooManyRequestsException,
                                                              BadRequestException,
                                                              LimitExceededException,
                                                              InternalServiceErrorException,
                                                              AlreadyExistsException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              PinpointSmsVoiceException

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

Parameters:

createConfigurationSetRequest - CreateConfigurationSetRequest

Returns:

Result of the CreateConfigurationSet operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

createConfigurationSet

default CreateConfigurationSetResponse createConfigurationSet(Consumer<CreateConfigurationSetRequest.Builder> createConfigurationSetRequest)
                                                       throws TooManyRequestsException,
                                                              BadRequestException,
                                                              LimitExceededException,
                                                              InternalServiceErrorException,
                                                              AlreadyExistsException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              PinpointSmsVoiceException

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

Returns:

Result of the CreateConfigurationSet operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

createConfigurationSetEventDestination

default CreateConfigurationSetEventDestinationResponse createConfigurationSetEventDestination(CreateConfigurationSetEventDestinationRequest createConfigurationSetEventDestinationRequest)
                                                                                       throws BadRequestException,
                                                                                              LimitExceededException,
                                                                                              InternalServiceErrorException,
                                                                                              NotFoundException,
                                                                                              TooManyRequestsException,
                                                                                              AlreadyExistsException,
                                                                                              AwsServiceException,
                                                                                              SdkClientException,
                                                                                              PinpointSmsVoiceException

Create a new event destination in a configuration set.

Parameters:

createConfigurationSetEventDestinationRequest - CreateConfigurationSetEventDestinationRequest

Returns:

Result of the CreateConfigurationSetEventDestination operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

createConfigurationSetEventDestination

default CreateConfigurationSetEventDestinationResponse createConfigurationSetEventDestination(Consumer<CreateConfigurationSetEventDestinationRequest.Builder> createConfigurationSetEventDestinationRequest)
                                                                                       throws BadRequestException,
                                                                                              LimitExceededException,
                                                                                              InternalServiceErrorException,
                                                                                              NotFoundException,
                                                                                              TooManyRequestsException,
                                                                                              AlreadyExistsException,
                                                                                              AwsServiceException,
                                                                                              SdkClientException,
                                                                                              PinpointSmsVoiceException

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

Returns:

Result of the CreateConfigurationSetEventDestination operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

deleteConfigurationSet

default DeleteConfigurationSetResponse deleteConfigurationSet(DeleteConfigurationSetRequest deleteConfigurationSetRequest)
                                                       throws NotFoundException,
                                                              TooManyRequestsException,
                                                              BadRequestException,
                                                              InternalServiceErrorException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              PinpointSmsVoiceException

Deletes an existing configuration set.

Parameters:

deleteConfigurationSetRequest -

Returns:

Result of the DeleteConfigurationSet operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

deleteConfigurationSet

default DeleteConfigurationSetResponse deleteConfigurationSet(Consumer<DeleteConfigurationSetRequest.Builder> deleteConfigurationSetRequest)
                                                       throws NotFoundException,
                                                              TooManyRequestsException,
                                                              BadRequestException,
                                                              InternalServiceErrorException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              PinpointSmsVoiceException

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:

Result of the DeleteConfigurationSet operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

deleteConfigurationSetEventDestination

default DeleteConfigurationSetEventDestinationResponse deleteConfigurationSetEventDestination(DeleteConfigurationSetEventDestinationRequest deleteConfigurationSetEventDestinationRequest)
                                                                                       throws NotFoundException,
                                                                                              TooManyRequestsException,
                                                                                              BadRequestException,
                                                                                              InternalServiceErrorException,
                                                                                              AwsServiceException,
                                                                                              SdkClientException,
                                                                                              PinpointSmsVoiceException

Deletes an event destination in a configuration set.

Parameters:

deleteConfigurationSetEventDestinationRequest -

Returns:

Result of the DeleteConfigurationSetEventDestination operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

deleteConfigurationSetEventDestination

default DeleteConfigurationSetEventDestinationResponse deleteConfigurationSetEventDestination(Consumer<DeleteConfigurationSetEventDestinationRequest.Builder> deleteConfigurationSetEventDestinationRequest)
                                                                                       throws NotFoundException,
                                                                                              TooManyRequestsException,
                                                                                              BadRequestException,
                                                                                              InternalServiceErrorException,
                                                                                              AwsServiceException,
                                                                                              SdkClientException,
                                                                                              PinpointSmsVoiceException

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:

Result of the DeleteConfigurationSetEventDestination operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

getConfigurationSetEventDestinations

default GetConfigurationSetEventDestinationsResponse getConfigurationSetEventDestinations(GetConfigurationSetEventDestinationsRequest getConfigurationSetEventDestinationsRequest)
                                                                                   throws NotFoundException,
                                                                                          TooManyRequestsException,
                                                                                          BadRequestException,
                                                                                          InternalServiceErrorException,
                                                                                          AwsServiceException,
                                                                                          SdkClientException,
                                                                                          PinpointSmsVoiceException

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:

Result of the GetConfigurationSetEventDestinations operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

getConfigurationSetEventDestinations

default GetConfigurationSetEventDestinationsResponse getConfigurationSetEventDestinations(Consumer<GetConfigurationSetEventDestinationsRequest.Builder> getConfigurationSetEventDestinationsRequest)
                                                                                   throws NotFoundException,
                                                                                          TooManyRequestsException,
                                                                                          BadRequestException,
                                                                                          InternalServiceErrorException,
                                                                                          AwsServiceException,
                                                                                          SdkClientException,
                                                                                          PinpointSmsVoiceException

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:

Result of the GetConfigurationSetEventDestinations operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

sendVoiceMessage

default SendVoiceMessageResponse sendVoiceMessage(SendVoiceMessageRequest sendVoiceMessageRequest)
                                           throws TooManyRequestsException,
                                                  BadRequestException,
                                                  InternalServiceErrorException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  PinpointSmsVoiceException

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

Parameters:

sendVoiceMessageRequest - SendVoiceMessageRequest

Returns:

Result of the SendVoiceMessage operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

sendVoiceMessage

default SendVoiceMessageResponse sendVoiceMessage(Consumer<SendVoiceMessageRequest.Builder> sendVoiceMessageRequest)
                                           throws TooManyRequestsException,
                                                  BadRequestException,
                                                  InternalServiceErrorException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  PinpointSmsVoiceException

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:

Result of the SendVoiceMessage operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

updateConfigurationSetEventDestination

default UpdateConfigurationSetEventDestinationResponse updateConfigurationSetEventDestination(UpdateConfigurationSetEventDestinationRequest updateConfigurationSetEventDestinationRequest)
                                                                                       throws NotFoundException,
                                                                                              TooManyRequestsException,
                                                                                              BadRequestException,
                                                                                              InternalServiceErrorException,
                                                                                              AwsServiceException,
                                                                                              SdkClientException,
                                                                                              PinpointSmsVoiceException

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:

Result of the UpdateConfigurationSetEventDestination operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

updateConfigurationSetEventDestination

default UpdateConfigurationSetEventDestinationResponse updateConfigurationSetEventDestination(Consumer<UpdateConfigurationSetEventDestinationRequest.Builder> updateConfigurationSetEventDestinationRequest)
                                                                                       throws NotFoundException,
                                                                                              TooManyRequestsException,
                                                                                              BadRequestException,
                                                                                              InternalServiceErrorException,
                                                                                              AwsServiceException,
                                                                                              SdkClientException,
                                                                                              PinpointSmsVoiceException

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:

Result of the UpdateConfigurationSetEventDestination operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()