PinpointSMSVoiceV2 / Client / update_event_destination

update_event_destination

PinpointSMSVoiceV2.Client.update_event_destination(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.update_event_destination(
    ConfigurationSetName='string',
    EventDestinationName='string',
    Enabled=True|False,
    MatchingEventTypes=[
        '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={
        'IamRoleArn': 'string',
        'LogGroupArn': 'string'
    },
    KinesisFirehoseDestination={
        'IamRoleArn': 'string',
        'DeliveryStreamArn': 'string'
    },
    SnsDestination={
        'TopicArn': 'string'
    }
)

Parameters:

• ConfigurationSetName (string) –

  [REQUIRED]

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

• EventDestinationName (string) –

  [REQUIRED]

  The name to use for the event destination.

• Enabled (boolean) – When set to true logging is enabled.

• MatchingEventTypes (list) –

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

  Note

  The TEXT_SENT event type is not supported.

  • (string) –

• CloudWatchLogsDestination (dict) –

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

  • IamRoleArn (string) – [REQUIRED]

    The Amazon Resource Name (ARN) of an Identity and Access Management role that is able to write event data to an Amazon CloudWatch destination.

  • LogGroupArn (string) – [REQUIRED]

    The name of the Amazon CloudWatch log group that you want to record events in.

• KinesisFirehoseDestination (dict) –

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

  • IamRoleArn (string) – [REQUIRED]

    The ARN of an Identity and Access Management role that is able to write event data to an Amazon Data Firehose destination.

  • DeliveryStreamArn (string) – [REQUIRED]

    The Amazon Resource Name (ARN) of the delivery stream.

• SnsDestination (dict) –

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

  • TopicArn (string) – [REQUIRED]

    The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.

Return type:

dict

Returns:

Response Syntax

{
    'ConfigurationSetArn': 'string',
    'ConfigurationSetName': 'string',
    'EventDestination': {
        'EventDestinationName': 'string',
        'Enabled': True|False,
        'MatchingEventTypes': [
            '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': {
            'IamRoleArn': 'string',
            'LogGroupArn': 'string'
        },
        'KinesisFirehoseDestination': {
            'IamRoleArn': 'string',
            'DeliveryStreamArn': 'string'
        },
        'SnsDestination': {
            'TopicArn': 'string'
        }
    }
}

Response Structure

• (dict) –

  • ConfigurationSetArn (string) –

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

  • ConfigurationSetName (string) –

    The name of the configuration set.

  • EventDestination (dict) –

    An EventDestination object containing the details of where events will be 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.

      Note

      The TEXT_SENT event type is not supported.

      • (string) –

    • CloudWatchLogsDestination (dict) –

      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 Identity and Access Management 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 (dict) –

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

      • IamRoleArn (string) –

        The ARN of an Identity and Access Management role that is able to write event data to an Amazon Data Firehose destination.

      • DeliveryStreamArn (string) –

        The Amazon Resource Name (ARN) of the delivery stream.

    • SnsDestination (dict) –

      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.

Exceptions

• PinpointSMSVoiceV2.Client.exceptions.ThrottlingException

• PinpointSMSVoiceV2.Client.exceptions.AccessDeniedException

• PinpointSMSVoiceV2.Client.exceptions.ResourceNotFoundException

• PinpointSMSVoiceV2.Client.exceptions.ValidationException

• PinpointSMSVoiceV2.Client.exceptions.ConflictException

• PinpointSMSVoiceV2.Client.exceptions.InternalServerException