SESV2 / Client / list_email_identity_certificates

list_email_identity_certificates

SESV2.Client.list_email_identity_certificates(**kwargs)

Lists the S/MIME certificates that are associated with the specified email identity. The results include certificates in all states, such as PROVISIONING, ACTIVE, INACTIVE, DEPROVISIONING, and FAILED.

If a certificate has passed its expiration time, it’s returned with a status of FAILED.

We recommend using pagination to ensure that the operation returns quickly and successfully. When there are more results than fit in a single response, the response includes a NextToken value that you use in a subsequent call to retrieve the next set of results.

See also: AWS API Documentation

Request Syntax

response = client.list_email_identity_certificates(
    EmailIdentity='string',
    NextToken='string',
    PageSize=123
)
Parameters:

  • EmailIdentity (string) –

    [REQUIRED]

    The email identity whose certificate associations you want to list.

  • NextToken (string) – A token returned from a previous call to ListEmailIdentityCertificates to indicate the position in the list of certificates.

  • PageSize (integer) – The number of results to show in a single call to ListEmailIdentityCertificates. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

Return type:

dict

Returns:

Response Syntax

{
    'Certificates': [
        {
            'FromAddress': 'string',
            'Status': 'PROVISIONING'|'INACTIVE'|'DEPROVISIONING'|'ACTIVE'|'FAILED',
            'CertificateArn': 'string',
            'CertificateExpiryTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    Information about the S/MIME certificates that are associated with an email identity.

    • Certificates (list) –

      An array that contains the certificate associations for the email identity. Each entry includes the from address, the certificate’s status, its Amazon Resource Name (ARN), and its expiry time.

      • (dict) –

        An object that contains information about an S/MIME certificate that’s associated with an email identity.

        • FromAddress (string) –

          The email address that the certificate applies to.

        • Status (string) –

          The status of the certificate association. A status of ACTIVE indicates that the certificate is ready to use for signing.

        • CertificateArn (string) –

          The Amazon Resource Name (ARN) of the Certificate Manager (ACM) certificate that’s associated with the email identity.

        • CertificateExpiryTime (datetime) –

          The timestamp after which the certificate is no longer valid.

    • NextToken (string) –

      A token that indicates that there are additional certificates to list. To view additional certificates, issue another request to ListEmailIdentityCertificates, and pass this token in the NextToken parameter.

Exceptions

  • SESV2.Client.exceptions.NotFoundException

  • SESV2.Client.exceptions.TooManyRequestsException

  • SESV2.Client.exceptions.BadRequestException