PinpointSMSVoiceV2 / Client / delete_event_destination

delete_event_destination

PinpointSMSVoiceV2.Client.delete_event_destination(**kwargs)

Deletes an existing event destination.

An event destination is a location where you send response information about the messages that you send. For example, when a message is delivered successfully, you can send information about that event to an Amazon CloudWatch destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.

See also: AWS API Documentation

Request Syntax

response = client.delete_event_destination(
    ConfigurationSetName='string',
    EventDestinationName='string'
)

Parameters:

• ConfigurationSetName (string) –

  [REQUIRED]

  The name of the configuration set or the configuration set’s Amazon Resource Name (ARN) to remove the event destination from. The ConfigurateSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.

• EventDestinationName (string) –

  [REQUIRED]

  The name of the event destination to delete.

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) of the configuration set.

  • ConfigurationSetName (string) –

    The name of the configuration set the event destination was deleted from.

  • EventDestination (dict) –

    The event destination object that was deleted.

    • 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 Kinesis Data Firehose.

      • IamRoleArn (string) –

        The ARN of an Identity and Access Management role that is able to write event data to an Amazon Kinesis 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.InternalServerException