AWS Certificate Manager

{'Certificate': {'FailureReason': 'NO_AVAILABLE_CONTACTS | '
                                  'ADDITIONAL_VERIFICATION_REQUIRED | '
                                  'DOMAIN_NOT_ALLOWED | INVALID_PUBLIC_DOMAIN '
                                  '| OTHER'}}

Returns a list of the fields contained in the specified ACM Certificate. For example, this action returns the certificate status, a flag that indicates whether the certificate is associated with any other AWS service, and the date at which the certificate request was created. You specify the ACM Certificate on input by its Amazon Resource Name (ARN).

Request Syntax

client.describe_certificate(
    CertificateArn='string'
)

type CertificateArn:

string

param CertificateArn:

[REQUIRED]

String that contains an ACM Certificate ARN. The ARN must be of the form:

arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

rtype:

dict

returns:

Response Syntax

{
    'Certificate': {
        'CertificateArn': 'string',
        'DomainName': 'string',
        'SubjectAlternativeNames': [
            'string',
        ],
        'DomainValidationOptions': [
            {
                'DomainName': 'string',
                'ValidationEmails': [
                    'string',
                ],
                'ValidationDomain': 'string'
            },
        ],
        'Serial': 'string',
        'Subject': 'string',
        'Issuer': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'IssuedAt': datetime(2015, 1, 1),
        'Status': 'PENDING_VALIDATION'|'ISSUED'|'INACTIVE'|'EXPIRED'|'VALIDATION_TIMED_OUT'|'REVOKED'|'FAILED',
        'RevokedAt': datetime(2015, 1, 1),
        'RevocationReason': 'UNSPECIFIED'|'KEY_COMPROMISE'|'CA_COMPROMISE'|'AFFILIATION_CHANGED'|'SUPERCEDED'|'CESSATION_OF_OPERATION'|'CERTIFICATE_HOLD'|'REMOVE_FROM_CRL'|'PRIVILEGE_WITHDRAWN'|'A_A_COMPROMISE',
        'NotBefore': datetime(2015, 1, 1),
        'NotAfter': datetime(2015, 1, 1),
        'KeyAlgorithm': 'RSA_2048'|'EC_prime256v1',
        'SignatureAlgorithm': 'string',
        'InUseBy': [
            'string',
        ],
        'FailureReason': 'NO_AVAILABLE_CONTACTS'|'ADDITIONAL_VERIFICATION_REQUIRED'|'DOMAIN_NOT_ALLOWED'|'INVALID_PUBLIC_DOMAIN'|'OTHER'
    }
}

Response Structure

• (dict) --

  • Certificate (dict) --

    Contains a CertificateDetail structure that lists the fields of an ACM Certificate.

    • CertificateArn (string) --

      The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

    • DomainName (string) --

      The fully qualified domain name (FQDN) for the certificate, such as www.example.com or example.com.

    • SubjectAlternativeNames (list) --

      One or more domain names (subject alternative names) included in the certificate request. After the certificate is issued, this list includes the domain names bound to the public key contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website.

      • (string) --

    • DomainValidationOptions (list) --

      Contains information about the email address or addresses used for domain validation.

      • (dict) --

        Structure that contains the domain name, the base validation domain to which validation email is sent, and the email addresses used to validate the domain identity.

        • DomainName (string) --

          Fully Qualified Domain Name (FQDN) of the form www.example.com or example.com.

        • ValidationEmails (list) --

          A list of contact address for the domain registrant.

          • (string) --

        • ValidationDomain (string) --

          The base validation domain that acts as the suffix of the email addresses that are used to send the emails.

    • Serial (string) --

      The serial number of the certificate.

    • Subject (string) --

      The X.500 distinguished name of the entity associated with the public key contained in the certificate.

    • Issuer (string) --

      The X.500 distinguished name of the CA that issued and signed the certificate.

    • CreatedAt (datetime) --

      The time at which the certificate was requested.

    • IssuedAt (datetime) --

      The time at which the certificate was issued.

    • Status (string) --

      The status of the certificate.

    • RevokedAt (datetime) --

      The time at which the certificate was revoked. This value exists only when the certificate status is REVOKED.

    • RevocationReason (string) --

      The reason the certificate was revoked. This value exists only when the certificate status is REVOKED.

    • NotBefore (datetime) --

      The time before which the certificate is not valid.

    • NotAfter (datetime) --

      The time after which the certificate is not valid.

    • KeyAlgorithm (string) --

      The algorithm used to generate the key pair (the public and private key). Currently the only supported value is RSA_2048.

    • SignatureAlgorithm (string) --

      The algorithm used to generate a signature. Currently the only supported value is SHA256WITHRSA.

    • InUseBy (list) --

      A list of ARNs for the resources that are using the certificate. An ACM Certificate can be used by multiple AWS resources.

      • (string) --

    • FailureReason (string) --

      The reason the certificate request failed. This value exists only when the structure's Status is FAILED. For more information, see Certificate Request Failed in the AWS Certificate Manager User Guide.