URI HTTP methods Schemas Properties See also

Event Destination

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 an event destination for specific types of events related to voice messages. An event destination is a location that you publish information about your voice calls to. 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 Amazon CloudWatch log 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.

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 from 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


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

Response bodies

{
}

{
}


{
  "Message": "string"
}


{
  "Message": "string"
}


{
  "Message": "string"
}


{
  "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
`CloudWatchLogsDestination`	CloudWatchLogsDestination	False	An object that contains information about an event destination that sends data to Amazon CloudWatch Logs.
`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.
`KinesisFirehoseDestination`	KinesisFirehoseDestination	False	An object that contains information about an event destination that sends data to Amazon Kinesis Data Firehose.
`MatchingEventTypes`	Array of type EventType	True	The types of events that you want to send to the event destination. Possible values: `INITIATED_CALL` - Amazon Pinpoint started trying to deliver the message to the recipient. `RINGING` - Amazon Pinpoint initiated the phone call, and the recipient's phone is ringing. `ANSWERED` - Amazon Pinpoint established a connection with the recipient. Note This status doesn't necessarily mean that Amazon Pinpoint made a connection with a human recipient. For example, it could indicate that Amazon Pinpoint established a connection with a voicemail system. `COMPLETED_CALL` - Amazon Pinpoint played the audio message to the recipient. Note This status doesn't necessarily mean that the message was delivered to a human recipient. For example, it could indicate that the audio message was delivered to a voicemail system. `BUSY` - Amazon Pinpoint attempted to deliver the voice message, but received a busy signal. `FAILED` - Amazon Pinpoint wasn't able to deliver the message. `NO_ANSWER` - Amazon Pinpoint attempted to deliver the message, but the recipient didn't answer.
`SnsDestination`	SnsDestination	False	An object that contains information about an event destination that sends data to Amazon SNS.

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