com.amazonaws.services.pinpointsmsvoice

Class AmazonPinpointSMSVoiceClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.pinpointsmsvoice.AmazonPinpointSMSVoiceClient

All Implemented Interfaces:

AmazonPinpointSMSVoice

Direct Known Subclasses:

AmazonPinpointSMSVoiceAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonPinpointSMSVoiceClient
extends AmazonWebServiceClient
implements AmazonPinpointSMSVoice

Client for accessing Pinpoint SMS Voice. All service calls made using this client are blocking, and will not return until the service call completes.

Pinpoint SMS and Voice Messaging public facing APIs

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.pinpointsmsvoice.AmazonPinpointSMSVoice

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonPinpointSMSVoiceClientBuilder	builder()
CreateConfigurationSetResult	createConfigurationSet(CreateConfigurationSetRequest request) Create a new configuration set.
CreateConfigurationSetEventDestinationResult	createConfigurationSetEventDestination(CreateConfigurationSetEventDestinationRequest request) Create a new event destination in a configuration set.
DeleteConfigurationSetResult	deleteConfigurationSet(DeleteConfigurationSetRequest request) Deletes an existing configuration set.
DeleteConfigurationSetEventDestinationResult	deleteConfigurationSetEventDestination(DeleteConfigurationSetEventDestinationRequest request) 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 request) 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 request) List all of the configuration sets associated with your Amazon Pinpoint account in the current region.
SendVoiceMessageResult	sendVoiceMessage(SendVoiceMessageRequest request) 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 request) Update an event destination in a configuration set.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AmazonPinpointSMSVoiceClientBuilder builder()

createConfigurationSet

public CreateConfigurationSetResult createConfigurationSet(CreateConfigurationSetRequest request)

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

Specified by:

createConfigurationSet in interface AmazonPinpointSMSVoice

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

public CreateConfigurationSetEventDestinationResult createConfigurationSetEventDestination(CreateConfigurationSetEventDestinationRequest request)

Create a new event destination in a configuration set.

Specified by:

createConfigurationSetEventDestination in interface AmazonPinpointSMSVoice

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

public DeleteConfigurationSetResult deleteConfigurationSet(DeleteConfigurationSetRequest request)

Deletes an existing configuration set.

Specified by:

deleteConfigurationSet in interface AmazonPinpointSMSVoice

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

public DeleteConfigurationSetEventDestinationResult deleteConfigurationSetEventDestination(DeleteConfigurationSetEventDestinationRequest request)

Deletes an event destination in a configuration set.

Specified by:

deleteConfigurationSetEventDestination in interface AmazonPinpointSMSVoice

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

public GetConfigurationSetEventDestinationsResult getConfigurationSetEventDestinations(GetConfigurationSetEventDestinationsRequest request)

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.

Specified by:

getConfigurationSetEventDestinations in interface AmazonPinpointSMSVoice

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

public ListConfigurationSetsResult listConfigurationSets(ListConfigurationSetsRequest request)

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

Specified by:

listConfigurationSets in interface AmazonPinpointSMSVoice

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

public SendVoiceMessageResult sendVoiceMessage(SendVoiceMessageRequest request)

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

Specified by:

sendVoiceMessage in interface AmazonPinpointSMSVoice

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

public UpdateConfigurationSetEventDestinationResult updateConfigurationSetEventDestination(UpdateConfigurationSetEventDestinationRequest request)

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.

Specified by:

updateConfigurationSetEventDestination in interface AmazonPinpointSMSVoice

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AmazonPinpointSMSVoice

Parameters:

request - The originally executed request

Returns:

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

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonPinpointSMSVoice

Overrides:

shutdown in class AmazonWebServiceClient