AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . pinpoint-email ]

update-configuration-set-event-destination

Description

Update the configuration of an event destination for a configuration set.

In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

See also: AWS API Documentation

Synopsis

  update-configuration-set-event-destination
--configuration-set-name <value>
--event-destination-name <value>
--event-destination <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--configuration-set-name (string)

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

--event-destination-name (string)

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

--event-destination (structure)

An object that defines the event destination.

Enabled -> (boolean)

If true , the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this EventDestinationDefinition .

If false , the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.

MatchingEventTypes -> (list)

An array that specifies which events Amazon Pinpoint should send to the destinations in this EventDestinationDefinition .

(string)

An email sending event type. For example, email sends, opens, and bounces are all email events.

KinesisFirehoseDestination -> (structure)

An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.

IamRoleArn -> (string)

The Amazon Resource Name (ARN) of the IAM role that Amazon Pinpoint uses when sending email events to the Amazon Kinesis Data Firehose stream.

DeliveryStreamArn -> (string)

The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that Amazon Pinpoint sends email events to.

CloudWatchDestination -> (structure)

An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.

DimensionConfigurations -> (list)

An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.

(structure)

An object that defines the dimension configuration to use when you send Amazon Pinpoint email events to Amazon CloudWatch.

DimensionName -> (string)

The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:

  • It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
  • It can contain no more than 256 characters.

DimensionValueSource -> (string)

The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon Pinpoint 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 Pinpoint to use your own email headers, choose emailHeader . If you want Amazon Pinpoint to use link tags, choose linkTags .

DefaultDimensionValue -> (string)

The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria:

  • It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
  • It can contain no more than 256 characters.

SnsDestination -> (structure)

An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.

TopicArn -> (string)

The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish email events to. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .

PinpointDestination -> (structure)

An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.

ApplicationArn -> (string)

The Amazon Resource Name (ARN) of the Amazon Pinpoint project that you want to send email events to.

JSON Syntax:

{
  "Enabled": true|false,
  "MatchingEventTypes": ["SEND"|"REJECT"|"BOUNCE"|"COMPLAINT"|"DELIVERY"|"OPEN"|"CLICK"|"RENDERING_FAILURE", ...],
  "KinesisFirehoseDestination": {
    "IamRoleArn": "string",
    "DeliveryStreamArn": "string"
  },
  "CloudWatchDestination": {
    "DimensionConfigurations": [
      {
        "DimensionName": "string",
        "DimensionValueSource": "MESSAGE_TAG"|"EMAIL_HEADER"|"LINK_TAG",
        "DefaultDimensionValue": "string"
      }
      ...
    ]
  },
  "SnsDestination": {
    "TopicArn": "string"
  },
  "PinpointDestination": {
    "ApplicationArn": "string"
  }
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

None