AWS Certificate Manager

{'Certificate': {'DomainValidationOptions': {'ValidationStatus': 'PENDING_VALIDATION '
                                                                 '| SUCCESS | '
                                                                 'FAILED'},
                 'RenewalSummary': {'DomainValidationOptions': [{'DomainName': 'string',
                                                                 'ValidationDomain': 'string',
                                                                 'ValidationEmails': ['string'],
                                                                 'ValidationStatus': 'PENDING_VALIDATION '
                                                                                     '| '
                                                                                     'SUCCESS '
                                                                                     '| '
                                                                                     'FAILED'}],
                                    'RenewalStatus': 'PENDING_AUTO_RENEWAL | '
                                                     'PENDING_VALIDATION | '
                                                     'SUCCESS | FAILED'}}}

Returns detailed metadata about the specified ACM Certificate.

See also: AWS API Documentation

Request Syntax

client.describe_certificate(
    CertificateArn='string'
)

type CertificateArn:

string

param CertificateArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the ACM Certificate. The ARN must have the following 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',
                'ValidationStatus': 'PENDING_VALIDATION'|'SUCCESS'|'FAILED'
            },
        ],
        'Serial': 'string',
        'Subject': 'string',
        'Issuer': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'IssuedAt': datetime(2015, 1, 1),
        'ImportedAt': 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'|'RSA_1024'|'EC_prime256v1',
        'SignatureAlgorithm': 'string',
        'InUseBy': [
            'string',
        ],
        'FailureReason': 'NO_AVAILABLE_CONTACTS'|'ADDITIONAL_VERIFICATION_REQUIRED'|'DOMAIN_NOT_ALLOWED'|'INVALID_PUBLIC_DOMAIN'|'OTHER',
        'Type': 'IMPORTED'|'AMAZON_ISSUED',
        'RenewalSummary': {
            'RenewalStatus': 'PENDING_AUTO_RENEWAL'|'PENDING_VALIDATION'|'SUCCESS'|'FAILED',
            'DomainValidationOptions': [
                {
                    'DomainName': 'string',
                    'ValidationEmails': [
                        'string',
                    ],
                    'ValidationDomain': 'string',
                    'ValidationStatus': 'PENDING_VALIDATION'|'SUCCESS'|'FAILED'
                },
            ]
        }
    }
}

Response Structure

• (dict) --

  • Certificate (dict) --

    Metadata about 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 in the AWS General Reference.

    • DomainName (string) --

      The fully qualified domain name 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. This list contains the domain names that are bound to the public key that is 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 initial validation of each domain name that occurs as a result of the RequestCertificate request. This field exists only when the certificate type is AMAZON_ISSUED.

      • (dict) --

        Contains information about the validation of each domain name in the certificate.

        • DomainName (string) --

          A fully qualified domain name (FQDN) in the certificate. For example, www.example.com or example.com.

        • ValidationEmails (list) --

          A list of email addresses that ACM used to send domain validation emails.

          • (string) --

        • ValidationDomain (string) --

          The domain name that ACM used to send domain validation emails.

        • ValidationStatus (string) --

          The validation status of the domain name.

    • Serial (string) --

      The serial number of the certificate.

    • Subject (string) --

      The name of the entity that is associated with the public key contained in the certificate.

    • Issuer (string) --

      The name of the certificate authority that issued and signed the certificate.

    • CreatedAt (datetime) --

      The time at which the certificate was requested. This value exists only when the certificate type is AMAZON_ISSUED.

    • IssuedAt (datetime) --

      The time at which the certificate was issued. This value exists only when the certificate type is AMAZON_ISSUED.

    • ImportedAt (datetime) --

      The date and time at which the certificate was imported. This value exists only when the certificate type is IMPORTED.

    • 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 that was used to generate the key pair (the public and private key).

    • SignatureAlgorithm (string) --

      The algorithm that was used to sign the certificate.

    • InUseBy (list) --

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

      • (string) --

    • FailureReason (string) --

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

    • Type (string) --

      The source of the certificate. For certificates provided by ACM, this value is AMAZON_ISSUED. For certificates that you imported with ImportCertificate, this value is IMPORTED. ACM does not provide managed renewal for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see Importing Certificates in the AWS Certificate Manager User Guide.

    • RenewalSummary (dict) --

      Contains information about the status of ACM's managed renewal for the certificate. This field exists only when the certificate type is AMAZON_ISSUED.

      • RenewalStatus (string) --

        The status of ACM's managed renewal of the certificate.

      • DomainValidationOptions (list) --

        Contains information about the validation of each domain name in the certificate, as it pertains to ACM's managed renewal. This is different from the initial validation that occurs as a result of the RequestCertificate request. This field exists only when the certificate type is AMAZON_ISSUED.

        • (dict) --

          Contains information about the validation of each domain name in the certificate.

          • DomainName (string) --

            A fully qualified domain name (FQDN) in the certificate. For example, www.example.com or example.com.

          • ValidationEmails (list) --

            A list of email addresses that ACM used to send domain validation emails.

            • (string) --

          • ValidationDomain (string) --

            The domain name that ACM used to send domain validation emails.

          • ValidationStatus (string) --

            The validation status of the domain name.