[ aws . pinpoint-sms-voice-v2 ]
create-event-destination¶
Description¶
Creates a new event destination in a configuration set.
An event destination is a location where you send message events. The event options are Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS. For example, when a message is delivered successfully, you can send information about that event to an event destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.
Each configuration set can contain between 0 and 5 event destinations. Each event destination can contain a reference to a single destination, such as a CloudWatch or Kinesis Data Firehose destination.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
create-event-destination
--configuration-set-name <value>
--event-destination-name <value>
--matching-event-types <value>
[--cloud-watch-logs-destination <value>]
[--kinesis-firehose-destination <value>]
[--sns-destination <value>]
[--client-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--configuration-set-name (string)
Either the name of the configuration set or the configuration set ARN to apply event logging to. The ConfigurateSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
--event-destination-name (string)
The name that identifies the event destination.
--matching-event-types (list)
An array of event types that determine which events to log. If “ALL” is used, then Amazon Pinpoint logs every event type.
(string)
Syntax:
"string" "string" ...
Where valid values are:
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
--cloud-watch-logs-destination (structure)
An object that contains information about an event destination for logging to Amazon CloudWatch logs.
IamRoleArn -> (string)
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)
The name of the Amazon CloudWatch log group that you want to record events in.
Shorthand Syntax:
IamRoleArn=string,LogGroupArn=string
JSON Syntax:
{
"IamRoleArn": "string",
"LogGroupArn": "string"
}
--kinesis-firehose-destination (structure)
An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.
IamRoleArn -> (string)
The ARN of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon Firehose destination.
DeliveryStreamArn -> (string)
The Amazon Resource Name (ARN) of the delivery stream.
Shorthand Syntax:
IamRoleArn=string,DeliveryStreamArn=string
JSON Syntax:
{
"IamRoleArn": "string",
"DeliveryStreamArn": "string"
}
--sns-destination (structure)
An object that contains information about an event destination for logging to Amazon SNS.
TopicArn -> (string)
The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.
Shorthand Syntax:
TopicArn=string
JSON Syntax:
{
"TopicArn": "string"
}
--client-token (string)
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, a randomly generated token is used for the request to ensure idempotency.
--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¶
ConfigurationSetArn -> (string)
The ARN of the configuration set.
ConfigurationSetName -> (string)
The name of the configuration set.
EventDestination -> (structure)
The details of the destination where events are logged.
EventDestinationName -> (string)
The name of the EventDestination.
Enabled -> (boolean)
When set to true events will be logged.
MatchingEventTypes -> (list)
An array of event types that determine which events to log.
(string)
CloudWatchLogsDestination -> (structure)
An object that contains information about an event destination that sends logging events to Amazon CloudWatch logs.
IamRoleArn -> (string)
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)
The name of the Amazon CloudWatch log group that you want to record events in.
KinesisFirehoseDestination -> (structure)
An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.
IamRoleArn -> (string)
The ARN of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon Firehose destination.
DeliveryStreamArn -> (string)
The Amazon Resource Name (ARN) of the delivery stream.
SnsDestination -> (structure)
An object that contains information about an event destination that sends logging events to Amazon SNS.
TopicArn -> (string)
The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.