com.amazonaws.services.pinpointsmsvoice

Interface AmazonPinpointSMSVoice

All Known Subinterfaces:

AmazonPinpointSMSVoiceAsync

All Known Implementing Classes:

AbstractAmazonPinpointSMSVoice, AbstractAmazonPinpointSMSVoiceAsync, AmazonPinpointSMSVoiceAsyncClient, AmazonPinpointSMSVoiceClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonPinpointSMSVoice

Interface for accessing Pinpoint SMS Voice.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonPinpointSMSVoice instead.

Pinpoint SMS and Voice Messaging public facing APIs

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateConfigurationSetResult	createConfigurationSet(CreateConfigurationSetRequest createConfigurationSetRequest) Create a new configuration set.
CreateConfigurationSetEventDestinationResult	createConfigurationSetEventDestination(CreateConfigurationSetEventDestinationRequest createConfigurationSetEventDestinationRequest) Create a new event destination in a configuration set.
DeleteConfigurationSetResult	deleteConfigurationSet(DeleteConfigurationSetRequest deleteConfigurationSetRequest) Deletes an existing configuration set.
DeleteConfigurationSetEventDestinationResult	deleteConfigurationSetEventDestination(DeleteConfigurationSetEventDestinationRequest deleteConfigurationSetEventDestinationRequest) Deletes an event destination in a configuration set.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetConfigurationSetEventDestinationsResult	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.
ListConfigurationSetsResult	listConfigurationSets(ListConfigurationSetsRequest listConfigurationSetsRequest) List all of the configuration sets associated with your Amazon Pinpoint account in the current region.
SendVoiceMessageResult	sendVoiceMessage(SendVoiceMessageRequest sendVoiceMessageRequest) Create a new voice message and send it to a recipient's phone number.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateConfigurationSetEventDestinationResult	updateConfigurationSetEventDestination(UpdateConfigurationSetEventDestinationRequest updateConfigurationSetEventDestinationRequest) Update an event destination in a configuration set.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createConfigurationSet

CreateConfigurationSetResult 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:

Result of the CreateConfigurationSet operation returned by the service.

Throws:

TooManyRequestsException - TooManyRequestsException

BadRequestException - BadRequestException

LimitExceededException - LimitExceededException

InternalServiceErrorException - InternalServiceErrorException

AlreadyExistsException - AlreadyExistsException

See Also:

AWS API Documentation

createConfigurationSetEventDestination

CreateConfigurationSetEventDestinationResult createConfigurationSetEventDestination(CreateConfigurationSetEventDestinationRequest createConfigurationSetEventDestinationRequest)

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.

Throws:

BadRequestException - BadRequestException

LimitExceededException - LimitExceededException

InternalServiceErrorException - InternalServiceErrorException

NotFoundException - NotFoundException

TooManyRequestsException - TooManyRequestsException

AlreadyExistsException - AlreadyExistsException

See Also:

AWS API Documentation

deleteConfigurationSet

DeleteConfigurationSetResult deleteConfigurationSet(DeleteConfigurationSetRequest deleteConfigurationSetRequest)

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

See Also:

AWS API Documentation

deleteConfigurationSetEventDestination

DeleteConfigurationSetEventDestinationResult deleteConfigurationSetEventDestination(DeleteConfigurationSetEventDestinationRequest deleteConfigurationSetEventDestinationRequest)

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

See Also:

AWS API Documentation

getConfigurationSetEventDestinations

GetConfigurationSetEventDestinationsResult 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:

Result of the GetConfigurationSetEventDestinations operation returned by the service.

Throws:

NotFoundException - NotFoundException

TooManyRequestsException - TooManyRequestsException

BadRequestException - BadRequestException

InternalServiceErrorException - InternalServiceErrorException

See Also:

AWS API Documentation

listConfigurationSets

ListConfigurationSetsResult listConfigurationSets(ListConfigurationSetsRequest listConfigurationSetsRequest)

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.

Throws:

TooManyRequestsException - TooManyRequestsException

BadRequestException - BadRequestException

InternalServiceErrorException - InternalServiceErrorException

See Also:

AWS API Documentation

sendVoiceMessage

SendVoiceMessageResult sendVoiceMessage(SendVoiceMessageRequest sendVoiceMessageRequest)

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

See Also:

AWS API Documentation

updateConfigurationSetEventDestination

UpdateConfigurationSetEventDestinationResult 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:

Result of the UpdateConfigurationSetEventDestination operation returned by the service.

Throws:

NotFoundException - NotFoundException

TooManyRequestsException - TooManyRequestsException

BadRequestException - BadRequestException

InternalServiceErrorException - InternalServiceErrorException

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.