Update Event Destination

pinpointsmsvoicev2_update_event_destination

R Documentation

Updates an existing event destination in a configuration set

Description

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.

Usage

pinpointsmsvoicev2_update_event_destination(ConfigurationSetName,
  EventDestinationName, Enabled, MatchingEventTypes,
  CloudWatchLogsDestination, KinesisFirehoseDestination, SnsDestination)

Arguments

ConfigurationSetName

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

EventDestinationName

[required] The name to use for the event destination.

Enabled

When set to true logging is enabled.

MatchingEventTypes

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

The TEXT_SENT event type is not supported.

CloudWatchLogsDestination

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

KinesisFirehoseDestination

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

SnsDestination

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

Value

A list with the following syntax:

list(
  ConfigurationSetArn = "string",
  ConfigurationSetName = "string",
  EventDestination = list(
    EventDestinationName = "string",
    Enabled = TRUE|FALSE,
    MatchingEventTypes = list(
      "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"
    ),
    CloudWatchLogsDestination = list(
      IamRoleArn = "string",
      LogGroupArn = "string"
    ),
    KinesisFirehoseDestination = list(
      IamRoleArn = "string",
      DeliveryStreamArn = "string"
    ),
    SnsDestination = list(
      TopicArn = "string"
    )
  )
)

Request syntax

svc$update_event_destination(
  ConfigurationSetName = "string",
  EventDestinationName = "string",
  Enabled = TRUE|FALSE,
  MatchingEventTypes = list(
    "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"
  ),
  CloudWatchLogsDestination = list(
    IamRoleArn = "string",
    LogGroupArn = "string"
  ),
  KinesisFirehoseDestination = list(
    IamRoleArn = "string",
    DeliveryStreamArn = "string"
  ),
  SnsDestination = list(
    TopicArn = "string"
  )
)