Amazon Pinpoint SMS and Voice
API Reference

Event Destination Name

A configuration set is a set of rules that you apply to the voice messages that you send. In a configuration set, you can specify a destination for specific types of events related to voice messages. For example, when a message is successfully delivered, you can log that event to an Amazon CloudWatch destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.

Each configuration set can contain between 0 and 10 event destinations. Each event destination can contain a reference to one (and only one) destination, such as an CloudWatch Logs or Amazon Kinesis Data Firehose destination.

URI

/v1/sms-voice/configuration-sets/ConfigurationSetName/event-destinations/EventDestinationName

HTTP Methods

PUT

Operation ID: UpdateConfigurationSetEventDestination

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

Path Parameters

Name Type Required Description
EventDestinationName String True

The name of the event destination that you want to update.

ConfigurationSetName String True

The name of the configuration set that contains the event destination that you want to update.

Responses

Status Code Response Model Description
200 UpdateConfigurationSetEventDestinationResponse

An empty object that indicates that the event destination was updated successfully.

400 BadRequestException

The request contained syntax that the API couldn't interpret. Modify the request and try again.

404 NotFoundException

The requested resource wasn't found.

429 TooManyRequestsException

You've made too many PUT requests in one second. Requests are limited to 1 per second.

500 InternalServiceErrorException

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DELETE

Operation ID: DeleteConfigurationSetEventDestination

Deletes an event destination in a configuration set.

Path Parameters

Name Type Required Description
EventDestinationName String True

The name of the event destination that you want to delete.

ConfigurationSetName String True

The name of the configuration set that you want to delete.

Responses

Status Code Response Model Description
200 DeleteConfigurationSetEventDestinationResponse

An empty object that indicates that the event destination was deleted successfully.

400 BadRequestException

The request contained syntax that the API couldn't interpret. Modify the request and try again.

404 NotFoundException

The requested resource wasn't found.

429 TooManyRequestsException

You've made too many DELETE requests in one second. Requests are limited to 1 per second.

500 InternalServiceErrorException

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

OPTIONS

Responses

Status Code Response Model Description
200 None

200 response

Schemas

Request Bodies

Example PUT

{ "EventDestination": { "SnsDestination": { "TopicArn": "string" }, "Enabled": boolean, "MatchingEventTypes": [ enum ], "CloudWatchLogsDestination": { "IamRoleArn": "string", "LogGroupArn": "string" }, "KinesisFirehoseDestination": { "DeliveryStreamArn": "string", "IamRoleArn": "string" } } }

Response Bodies

Example UpdateConfigurationSetEventDestinationResponse

{ }

Example DeleteConfigurationSetEventDestinationResponse

{ }

Example BadRequestException

{ "Message": "string" }

Example NotFoundException

{ "Message": "string" }

Example TooManyRequestsException

{ "Message": "string" }

Example InternalServiceErrorException

{ "Message": "string" }

Properties

BadRequestException

The input that you provided to the API is invalid.

Property Type Required Description
Message

string

False

A description of the error that the API encountered.

CloudWatchLogsDestination

An object that contains information about an event destination that sends data to Amazon CloudWatch Logs.

Property Type Required Description
IamRoleArn

string

True

The Amazon Resource Name (ARN) of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon CloudWatch destination.

LogGroupArn

string

True

The name of the Amazon CloudWatch Log Group that you want to record events in.

DeleteConfigurationSetEventDestinationResponse

An empty object that indicates that the event destination was deleted successfully.

EventDestinationDefinition

An object that defines a single event destination.

Property Type Required Description
SnsDestination

SnsDestination

False

An object that contains information about an event destination that sends data to Amazon SNS.

Enabled

boolean

False

Indicates whether or not the event destination is enabled. If the event destination is enabled, then Amazon Pinpoint sends response data to the specified event destination.

MatchingEventTypes

Array of type EventType

True

The types of events that you want to send to the event destination. Possible values:

  • INITIATED_CALL – The service has started trying to deliver the message to the recipient.

  • RINGING – The service has initiated the phone call, and the recipient's phone is ringing.

  • ANSWERED – The recipient answered the phone call.

  • COMPLETED_CALL – The message was successfully delivered to the recipient.

  • BUSY – Amazon Pinpoint attempted to deliver the voice message, but received a busy signal.

  • FAILED – The message wasn't delivered.

  • NO_ANSWER – Amazon Pinpoint attempted to deliver the message, but the recipient didn't answer.

CloudWatchLogsDestination

CloudWatchLogsDestination

False

An object that contains information about an event destination that sends data to Amazon CloudWatch Logs.

KinesisFirehoseDestination

KinesisFirehoseDestination

False

An object that contains information about an event destination that sends data to Amazon Kinesis Data Firehose.

EventType

The types of events that are sent to the event destination. Possible values are:

  • INITIATED_CALL

  • RINGING

  • ANSWERED

  • COMPLETED_CALL

  • BUSY

  • FAILED

  • NO_ANSWER

InternalServiceErrorException

This error occurs when an there is an unexpected issue with the Amazon Pinpoint SMS and Voice API service.

Property Type Required Description
Message

string

False

A description of the error that the API encountered.

KinesisFirehoseDestination

An object that contains information about an event destination that sends data to Amazon Kinesis Data Firehose.

Property Type Required Description
DeliveryStreamArn

string

True

The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose destination that you want to use in the event destination.

IamRoleArn

string

True

The Amazon Resource Name (ARN) of an IAM role that can write data to an Amazon Kinesis Data Firehose stream.

NotFoundException

The resource you attempted to access doesn't exist.

Property Type Required Description
Message

string

False

A description of the error that the API encountered.

SnsDestination

An object that contains information about an event destination that sends data to Amazon SNS.

Property Type Required Description
TopicArn

string

True

The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.

TooManyRequestsException

This error occurs when an there is an unexpected issue with the Amazon Pinpoint SMS and Voice API service.

Property Type Required Description
Message

string

False

A description of the error that the API encountered.

UpdateConfigurationSetEventDestinationRequest

An object that defines a request to update an existing event destination.

Property Type Required Description
EventDestination

EventDestinationDefinition

True

An object that defines a single event destination.

UpdateConfigurationSetEventDestinationResponse

An empty object that indicates that the event destination was updated successfully.

Note

The following table was intentionally left blank.

See Also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

UpdateConfigurationSetEventDestination

DeleteConfigurationSetEventDestination