SES / Client / describe_configuration_set

describe_configuration_set#

SES.Client.describe_configuration_set(**kwargs)#

Returns the details of the specified configuration set. For information about using configuration sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Request Syntax

response = client.describe_configuration_set(
    ConfigurationSetName='string',
    ConfigurationSetAttributeNames=[
        'eventDestinations'|'trackingOptions'|'deliveryOptions'|'reputationOptions',
    ]
)

Parameters:

ConfigurationSetName (string) –
[REQUIRED]

The name of the configuration set to describe.
ConfigurationSetAttributeNames (list) –
A list of configuration set attributes to return.
- (string) –

Return type:

dict

Returns:

Response Syntax

{
    'ConfigurationSet': {
        'Name': 'string'
    },
    'EventDestinations': [
        {
            'Name': 'string',
            'Enabled': True|False,
            'MatchingEventTypes': [
                'send'|'reject'|'bounce'|'complaint'|'delivery'|'open'|'click'|'renderingFailure',
            ],
            'KinesisFirehoseDestination': {
                'IAMRoleARN': 'string',
                'DeliveryStreamARN': 'string'
            },
            'CloudWatchDestination': {
                'DimensionConfigurations': [
                    {
                        'DimensionName': 'string',
                        'DimensionValueSource': 'messageTag'|'emailHeader'|'linkTag',
                        'DefaultDimensionValue': 'string'
                    },
                ]
            },
            'SNSDestination': {
                'TopicARN': 'string'
            }
        },
    ],
    'TrackingOptions': {
        'CustomRedirectDomain': 'string'
    },
    'DeliveryOptions': {
        'TlsPolicy': 'Require'|'Optional'
    },
    'ReputationOptions': {
        'SendingEnabled': True|False,
        'ReputationMetricsEnabled': True|False,
        'LastFreshStart': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) –

Represents the details of a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
- ConfigurationSet (dict) –
  
  The configuration set object associated with the specified configuration set.
  - Name (string) –
    
    The name of the configuration set. The name must meet the following requirements:
    - Contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
    - Contain 64 characters or fewer.
- EventDestinations (list) –
  
  A list of event destinations associated with the configuration set.
  - (dict) –
    
    Contains information about an event destination.
    
    Note
    When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose or Amazon Simple Notification Service (Amazon SNS).
    
    Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see the Amazon SES Developer Guide.
    - Name (string) –
      
      The name of the event destination. The name must meet the following requirements:
      - Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
      - Contain 64 characters or fewer.
    - Enabled (boolean) –
      
      Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to true to enable publishing to this destination; set to false to prevent publishing to this destination. The default value is false.
    - MatchingEventTypes (list) –
      
      The type of email sending events to publish to the event destination.
      - send - The call was successful and Amazon SES is attempting to deliver the email.
      - reject - Amazon SES determined that the email contained a virus and rejected it.
      - bounce - The recipient’s mail server permanently rejected the email. This corresponds to a hard bounce.
      - complaint - The recipient marked the email as spam.
      - delivery - Amazon SES successfully delivered the email to the recipient’s mail server.
      - open - The recipient received the email and opened it in their email client.
      - click - The recipient clicked one or more links in the email.
      - renderingFailure - Amazon SES did not send the email because of a template rendering issue.
      - (string) –
    - KinesisFirehoseDestination (dict) –
      
      An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.
      - IAMRoleARN (string) –
        
        The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose stream.
      - DeliveryStreamARN (string) –
        
        The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to.
    - CloudWatchDestination (dict) –
      
      An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.
      - DimensionConfigurations (list) –
        
        A list of dimensions upon which to categorize your emails when you publish email sending events to Amazon CloudWatch.
        
        (dict) –
        
        Contains the dimension configuration to use when you publish email sending events to Amazon CloudWatch.
        
        For information about publishing email sending events to Amazon CloudWatch, see the Amazon SES Developer Guide.
        
        DimensionName (string) –
        
        The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must meet the following requirements:
        
        Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), or colons (:).
        
        Contain 256 characters or fewer.
        
        DimensionValueSource (string) –
        
        The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. To use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/ SendRawEmail API, specify messageTag. To use your own email headers, specify emailHeader. To put a custom tag on any link included in your email, specify linkTag.
        
        DefaultDimensionValue (string) –
        
        The default value of the dimension that is published to Amazon CloudWatch if you do not provide the value of the dimension when you send an email. The default value must meet the following requirements:
        
        Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), at signs (@), or periods (.).
        
        Contain 256 characters or fewer.
    - SNSDestination (dict) –
      
      An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.
      - TopicARN (string) –
        
        The ARN of the Amazon SNS topic for email sending events. You can find the ARN of a topic by using the ListTopics Amazon SNS operation.
        
        For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
- TrackingOptions (dict) –
  
  The name of the custom open and click tracking domain associated with the configuration set.
  - CustomRedirectDomain (string) –
    
    The custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain.
- DeliveryOptions (dict) –
  
  Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).
  - TlsPolicy (string) –
    
    Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require, messages are only delivered if a TLS connection can be established. If the value is Optional, messages can be delivered in plain text if a TLS connection can’t be established.
- ReputationOptions (dict) –
  
  An object that represents the reputation settings for the configuration set.
  - SendingEnabled (boolean) –
    
    Describes whether email sending is enabled or disabled for the configuration set. If the value is true, then Amazon SES sends emails that use the configuration set. If the value is false, Amazon SES does not send emails that use the configuration set. The default value is true. You can change this setting using UpdateConfigurationSetSendingEnabled.
  - ReputationMetricsEnabled (boolean) –
    
    Describes whether or not Amazon SES publishes reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch.
    
    If the value is true, reputation metrics are published. If the value is false, reputation metrics are not published. The default value is false.
  - LastFreshStart (datetime) –
    
    The date and time at which the reputation metrics for the configuration set were last reset. Resetting these metrics is known as a fresh start.
    
    When you disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled and later re-enable it, the reputation metrics for the configuration set (but not for the entire Amazon SES account) are reset.
    
    If email sending for the configuration set has never been disabled and later re-enabled, the value of this attribute is null.

Exceptions

SES.Client.exceptions.ConfigurationSetDoesNotExistException