Interface PinpointSmsVoiceClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
Pinpoint SMS and Voice Messaging public facing APIs-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aPinpointSmsVoiceClient
.static PinpointSmsVoiceClient
create()
Create aPinpointSmsVoiceClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateConfigurationSetResponse
createConfigurationSet
(Consumer<CreateConfigurationSetRequest.Builder> createConfigurationSetRequest) Create a new configuration set.default CreateConfigurationSetResponse
createConfigurationSet
(CreateConfigurationSetRequest createConfigurationSetRequest) Create a new configuration set.createConfigurationSetEventDestination
(Consumer<CreateConfigurationSetEventDestinationRequest.Builder> createConfigurationSetEventDestinationRequest) Create a new event destination in a configuration set.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.deleteConfigurationSetEventDestination
(Consumer<DeleteConfigurationSetEventDestinationRequest.Builder> deleteConfigurationSetEventDestinationRequest) Deletes an event destination in a configuration set.deleteConfigurationSetEventDestination
(DeleteConfigurationSetEventDestinationRequest deleteConfigurationSetEventDestinationRequest) Deletes an event destination in a configuration set.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.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 ListConfigurationSetsResponse
listConfigurationSets
(Consumer<ListConfigurationSetsRequest.Builder> listConfigurationSetsRequest) List all of the configuration sets associated with your Amazon Pinpoint account in the current region.default ListConfigurationSetsResponse
listConfigurationSets
(ListConfigurationSetsRequest listConfigurationSetsRequest) List all of the configuration sets associated with your Amazon Pinpoint account in the current region.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.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
updateConfigurationSetEventDestination
(Consumer<UpdateConfigurationSetEventDestinationRequest.Builder> updateConfigurationSetEventDestinationRequest) Update an event destination in a configuration set.updateConfigurationSetEventDestination
(UpdateConfigurationSetEventDestinationRequest updateConfigurationSetEventDestinationRequest) Update an event destination in a configuration set.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
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
- A request to create a new configuration set.- Returns:
- Result of the CreateConfigurationSet operation returned by the service.
- See Also:
-
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 viaCreateConfigurationSetRequest.builder()
- Parameters:
createConfigurationSetRequest
- AConsumer
that will call methods onCreateConfigurationSetRequest.Builder
to create a request. A request to create a new configuration set.- Returns:
- Result of the CreateConfigurationSet operation returned by the service.
- See Also:
-
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
- Create a new event destination in a configuration set.- Returns:
- Result of the CreateConfigurationSetEventDestination operation returned by the service.
- See Also:
-
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 viaCreateConfigurationSetEventDestinationRequest.builder()
- Parameters:
createConfigurationSetEventDestinationRequest
- AConsumer
that will call methods onCreateConfigurationSetEventDestinationRequest.Builder
to create a request. Create a new event destination in a configuration set.- Returns:
- Result of the CreateConfigurationSetEventDestination operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDeleteConfigurationSetRequest.builder()
- Parameters:
deleteConfigurationSetRequest
- AConsumer
that will call methods onDeleteConfigurationSetRequest.Builder
to create a request.- Returns:
- Result of the DeleteConfigurationSet operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaDeleteConfigurationSetEventDestinationRequest.builder()
- Parameters:
deleteConfigurationSetEventDestinationRequest
- AConsumer
that will call methods onDeleteConfigurationSetEventDestinationRequest.Builder
to create a request.- Returns:
- Result of the DeleteConfigurationSetEventDestination operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaGetConfigurationSetEventDestinationsRequest.builder()
- Parameters:
getConfigurationSetEventDestinationsRequest
- AConsumer
that will call methods onGetConfigurationSetEventDestinationsRequest.Builder
to create a request.- Returns:
- Result of the GetConfigurationSetEventDestinations operation returned by the service.
- See Also:
-
listConfigurationSets
default ListConfigurationSetsResponse listConfigurationSets(ListConfigurationSetsRequest listConfigurationSetsRequest) throws TooManyRequestsException, BadRequestException, InternalServiceErrorException, AwsServiceException, SdkClientException, PinpointSmsVoiceException List all of the configuration sets associated with your Amazon Pinpoint account in the current region.- Parameters:
listConfigurationSetsRequest
-- Returns:
- Result of the ListConfigurationSets operation returned by the service.
- See Also:
-
listConfigurationSets
default ListConfigurationSetsResponse listConfigurationSets(Consumer<ListConfigurationSetsRequest.Builder> listConfigurationSetsRequest) throws TooManyRequestsException, BadRequestException, InternalServiceErrorException, AwsServiceException, SdkClientException, PinpointSmsVoiceException 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 viaListConfigurationSetsRequest.builder()
- Parameters:
listConfigurationSetsRequest
- AConsumer
that will call methods onListConfigurationSetsRequest.Builder
to create a request.- Returns:
- Result of the ListConfigurationSets operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaSendVoiceMessageRequest.builder()
- Parameters:
sendVoiceMessageRequest
- AConsumer
that will call methods onSendVoiceMessageRequest.Builder
to create a request. SendVoiceMessageRequest- Returns:
- Result of the SendVoiceMessage operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaUpdateConfigurationSetEventDestinationRequest.builder()
- Parameters:
updateConfigurationSetEventDestinationRequest
- AConsumer
that will call methods onUpdateConfigurationSetEventDestinationRequest.Builder
to create a request. UpdateConfigurationSetEventDestinationRequest- Returns:
- Result of the UpdateConfigurationSetEventDestination operation returned by the service.
- See Also:
-
create
Create aPinpointSmsVoiceClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aPinpointSmsVoiceClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-