UpdateEventDestination - AWS End User Messaging SMS

UpdateEventDestination

Updates an existing event destination in a configuration set. You can update the IAM role ARN for CloudWatch Logs and Firehose. You can also enable or disable the event destination.

You may want to update an event destination to change its matching event types or updating the destination resource ARN. You can't change an event destination's type between CloudWatch Logs, Firehose, and Amazon SNS.

Request Syntax

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

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

CloudWatchLogsDestination

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

Type: CloudWatchLogsDestination object

Required: No

ConfigurationSetName

The configuration set to update with the new event destination. Valid values for this can be the ConfigurationSetName or ConfigurationSetArn.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [A-Za-z0-9_:/-]+

Required: Yes

Enabled

When set to true logging is enabled.

Type: Boolean

Required: No

EventDestinationName

The name to use for the event destination.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z0-9_-]+

Required: Yes

KinesisFirehoseDestination

An object that contains information about an event destination for logging to Firehose.

Type: KinesisFirehoseDestination object

Required: No

MatchingEventTypes

An array of event types that determine which events to log.

Note

The TEXT_SENT event type is not supported.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 43 items.

Valid Values: ALL | TEXT_ALL | TEXT_SENT | TEXT_PENDING | TEXT_QUEUED | TEXT_SUCCESSFUL | TEXT_DELIVERED | TEXT_INVALID | TEXT_INVALID_MESSAGE | TEXT_UNREACHABLE | TEXT_CARRIER_UNREACHABLE | TEXT_BLOCKED | TEXT_CARRIER_BLOCKED | TEXT_SPAM | TEXT_UNKNOWN | TEXT_TTL_EXPIRED | VOICE_ALL | VOICE_INITIATED | VOICE_RINGING | VOICE_ANSWERED | VOICE_COMPLETED | VOICE_BUSY | VOICE_NO_ANSWER | VOICE_FAILED | VOICE_TTL_EXPIRED | MEDIA_ALL | MEDIA_PENDING | MEDIA_QUEUED | MEDIA_SUCCESSFUL | MEDIA_DELIVERED | MEDIA_INVALID | MEDIA_INVALID_MESSAGE | MEDIA_UNREACHABLE | MEDIA_CARRIER_UNREACHABLE | MEDIA_BLOCKED | MEDIA_CARRIER_BLOCKED | MEDIA_SPAM | MEDIA_UNKNOWN | MEDIA_TTL_EXPIRED | MEDIA_FILE_INACCESSIBLE | MEDIA_FILE_TYPE_UNSUPPORTED | MEDIA_FILE_SIZE_EXCEEDED

Required: No

SnsDestination

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

Type: SnsDestination object

Required: No

Response Syntax

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

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ConfigurationSetArn

The Amazon Resource Name (ARN) for the ConfigurationSet that was updated.

Type: String

ConfigurationSetName

The name of the configuration set.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z0-9_-]+

EventDestination

An EventDestination object containing the details of where events will be logged.

Type: EventDestination object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The request was denied because you don't have sufficient permissions to access the resource.

HTTP Status Code: 400

ConflictException

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.

HTTP Status Code: 400

InternalServerException

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.

HTTP Status Code: 500

ResourceNotFoundException

A requested resource couldn't be found.

HTTP Status Code: 400

ThrottlingException

An error that occurred because too many requests were sent during a certain amount of time.

HTTP Status Code: 400

ValidationException

A validation exception for a field.

HTTP Status Code: 400

See Also

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