get_contact_list

SESV2.Client.get_contact_list(**kwargs)

Returns contact list metadata. It does not return any information about the contacts present in the list.

See also: AWS API Documentation

Request Syntax

response = client.get_contact_list(
    ContactListName='string'
)

Parameters

ContactListName (string) --

[REQUIRED]

The name of the contact list.

Return type

dict

Returns

Response Syntax

{
    'ContactListName': 'string',
    'Topics': [
        {
            'TopicName': 'string',
            'DisplayName': 'string',
            'Description': 'string',
            'DefaultSubscriptionStatus': 'OPT_IN'|'OPT_OUT'
        },
    ],
    'Description': 'string',
    'CreatedTimestamp': datetime(2015, 1, 1),
    'LastUpdatedTimestamp': datetime(2015, 1, 1),
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

• (dict) --
  • ContactListName (string) --

    The name of the contact list.

  • Topics (list) --

    An interest group, theme, or label within a list. A contact list can have multiple topics.

    • (dict) --

      An interest group, theme, or label within a list. Lists can have multiple topics.

      • TopicName (string) --

        The name of the topic.

      • DisplayName (string) --

        The name of the topic the contact will see.

      • Description (string) --

        A description of what the topic is about, which the contact will see.

      • DefaultSubscriptionStatus (string) --

        The default subscription status to be applied to a contact if the contact has not noted their preference for subscribing to a topic.

  • Description (string) --

    A description of what the contact list is about.

  • CreatedTimestamp (datetime) --

    A timestamp noting when the contact list was created.

  • LastUpdatedTimestamp (datetime) --

    A timestamp noting the last time the contact list was updated.

  • Tags (list) --

    The tags associated with a contact list.

    • (dict) --

      An object that defines the tags that are associated with a resource. A tag is a label that you optionally define and associate with a resource. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags.

      Each tag consists of a required tag key and an associated tag value , both of which you define. A tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag value can contain as many as 256 characters. The characters can be Unicode letters, digits, white space, or one of the following symbols: _ . : / = + -. The following additional restrictions apply to tags:

      • Tag keys and values are case sensitive.
      • For each associated resource, each tag key must be unique and it can have only one value.
      • The aws: prefix is reserved for use by Amazon Web Services; you can’t use it in any tag keys or values that you define. In addition, you can't edit or remove tag keys or values that use this prefix. Tags that use this prefix don’t count against the limit of 50 tags per resource.
      • You can associate tags with public or shared resources, but the tags are available only for your Amazon Web Services account, not any other accounts that share the resource. In addition, the tags are available only for resources that are located in the specified Amazon Web Services Region for your Amazon Web Services account.
      • Key (string) --

        One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character.

      • Value (string) --

        The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don't want a resource to have a specific tag value, don't specify a value for this parameter. If you don't specify a value, Amazon SES sets the value to an empty string.

Exceptions

• SESV2.Client.exceptions.TooManyRequestsException
• SESV2.Client.exceptions.NotFoundException
• SESV2.Client.exceptions.BadRequestException