get_identity_verification_attributes

get_identity_verification_attributes(**kwargs)

Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity.

The verification status of an email address is "Pending" until the email address owner clicks the link within the verification email that Amazon SES sent to that address. If the email address owner clicks the link within 24 hours, the verification status of the email address changes to "Success". If the link is not clicked within 24 hours, the verification status changes to "Failed." In that case, if you still want to verify the email address, you must restart the verification process from the beginning.

For domain identities, the domain's verification status is "Pending" as Amazon SES searches for the required TXT record in the DNS settings of the domain. When Amazon SES detects the record, the domain's verification status changes to "Success". If Amazon SES is unable to detect the record within 72 hours, the domain's verification status changes to "Failed." In that case, if you still want to verify the domain, you must restart the verification process from the beginning.

This operation is throttled at one request per second and can only get verification attributes for up to 100 identities at a time.

See also: AWS API Documentation

Request Syntax

response = client.get_identity_verification_attributes(
    Identities=[
        'string',
    ]
)

Parameters

Identities (list) --

[REQUIRED]

A list of identities.

• (string) --

Return type

dict

Returns

Response Syntax

{
    'VerificationAttributes': {
        'string': {
            'VerificationStatus': 'Pending'|'Success'|'Failed'|'TemporaryFailure'|'NotStarted',
            'VerificationToken': 'string'
        }
    }
}

Response Structure

• (dict) --

  The Amazon SES verification status of a list of identities. For domain identities, this response also contains the verification token.

  • VerificationAttributes (dict) --

    A map of Identities to IdentityVerificationAttributes objects.

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

        Represents the verification attributes of a single identity.

        • VerificationStatus (string) --

          The verification status of the identity: "Pending", "Success", "Failed", or "TemporaryFailure".

        • VerificationToken (string) --

          The verification token for a domain identity. Null for email address identities.

Examples

The following example returns the verification status and the verification token for a domain identity:

response = client.get_identity_verification_attributes(
    Identities=[
        'example.com',
    ],
)

print(response)

Expected Output:

{
    'VerificationAttributes': {
        'example.com': {
            'VerificationStatus': 'Success',
            'VerificationToken': 'EXAMPLE3VYb9EDI2nTOQRi/Tf6MI/6bD6THIGiP1MVY=',
        },
    },
    'ResponseMetadata': {
        '...': '...',
    },
}