update-configuration-set-event-destination¶

Description¶

Updates the event destination of a configuration set. Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide.

Note

When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).

You can execute this operation no more than once per second.

Synopsis¶

  update-configuration-set-event-destination
--configuration-set-name <value>
--event-destination <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--configuration-set-name (string)

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

--event-destination (structure)

The event destination object that you want to apply to the specified configuration set.

Name -> (string)

The name of the event destination. The name must:

This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

Contain less than 64 characters.

Enabled -> (boolean)

Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to true to enable publishing to this destination; set to false to prevent publishing to this destination. The default value is false .

MatchingEventTypes -> (list)

The type of email sending events to publish to the event destination.

(string)

KinesisFirehoseDestination -> (structure)

An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.

IAMRoleARN -> (string)

The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose stream.

DeliveryStreamARN -> (string)

The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to.

CloudWatchDestination -> (structure)

An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.

DimensionConfigurations -> (list)

A list of dimensions upon which to categorize your emails when you publish email sending events to Amazon CloudWatch.

(structure)

Contains the dimension configuration to use when you publish email sending events to Amazon CloudWatch.

For information about publishing email sending events to Amazon CloudWatch, see the Amazon SES Developer Guide .

DimensionName -> (string)

The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must:

This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

Contain less than 256 characters.

DimensionValueSource -> (string)

The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon SES to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail /SendRawEmail API, choose messageTag . If you want Amazon SES to use your own email headers, choose emailHeader .

DefaultDimensionValue -> (string)

The default value of the dimension that is published to Amazon CloudWatch if you do not provide the value of the dimension when you send an email. The default value must:

This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

Contain less than 256 characters.

SNSDestination -> (structure)

An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.

TopicARN -> (string)

The ARN of the Amazon SNS topic that email sending events will be published to. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .

JSON Syntax:

{
  "Name": "string",
  "Enabled": true|false,
  "MatchingEventTypes": ["send"|"reject"|"bounce"|"complaint"|"delivery"|"open"|"click"|"renderingFailure", ...],
  "KinesisFirehoseDestination": {
    "IAMRoleARN": "string",
    "DeliveryStreamARN": "string"
  },
  "CloudWatchDestination": {
    "DimensionConfigurations": [
      {
        "DimensionName": "string",
        "DimensionValueSource": "messageTag"|"emailHeader"|"linkTag",
        "DefaultDimensionValue": "string"
      }
      ...
    ]
  },
  "SNSDestination": {
    "TopicARN": "string"
  }
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output¶

None

Table of Contents

Feedback

User Guide