AWS Certificate Manager

2026/11/19 - AWS Certificate Manager - 4 updated api methods

Changes  AWS Certificate Manager now supports the ability to issue certificates from the Amazon N2 certificate authorities (CAs), an Amazon-operated CA hierarchy.

DescribeCertificate (updated) Link ¶
Changes (response)
{'Certificate': {'CertificateUsage': 'CLIENT_AND_SERVER_AUTH | '
                                     'CLIENT_AUTH_ONLY',
                 'RootHierarchyType': 'N2_AMAZON_MANAGED | '
                                      'N2_SFG2_AMAZON_MANAGED'}}

Returns detailed metadata about the specified ACM certificate.

If you have just created a certificate using the RequestCertificate action, there is a delay of several seconds before you can retrieve information about it.

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).

rtype:

dict

returns:

Response Syntax

{
    'Certificate': {
        'CertificateArn': 'string',
        'DomainName': 'string',
        'SubjectAlternativeNames': [
            'string',
        ],
        'ManagedBy': 'CLOUDFRONT',
        'DomainValidationOptions': [
            {
                'DomainName': 'string',
                'ValidationEmails': [
                    'string',
                ],
                'ValidationDomain': 'string',
                'ValidationStatus': 'PENDING_VALIDATION'|'SUCCESS'|'FAILED',
                'ResourceRecord': {
                    'Name': 'string',
                    'Type': 'CNAME',
                    'Value': 'string'
                },
                'HttpRedirect': {
                    'RedirectFrom': 'string',
                    'RedirectTo': 'string'
                },
                'ValidationMethod': 'EMAIL'|'DNS'|'HTTP'
            },
        ],
        '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'|'SUPERSEDED'|'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_1024'|'RSA_2048'|'RSA_3072'|'RSA_4096'|'EC_prime256v1'|'EC_secp384r1'|'EC_secp521r1',
        'SignatureAlgorithm': 'string',
        'InUseBy': [
            'string',
        ],
        'FailureReason': 'NO_AVAILABLE_CONTACTS'|'ADDITIONAL_VERIFICATION_REQUIRED'|'DOMAIN_NOT_ALLOWED'|'INVALID_PUBLIC_DOMAIN'|'DOMAIN_VALIDATION_DENIED'|'CAA_ERROR'|'PCA_LIMIT_EXCEEDED'|'PCA_INVALID_ARN'|'PCA_INVALID_STATE'|'PCA_REQUEST_FAILED'|'PCA_NAME_CONSTRAINTS_VALIDATION'|'PCA_RESOURCE_NOT_FOUND'|'PCA_INVALID_ARGS'|'PCA_INVALID_DURATION'|'PCA_ACCESS_DENIED'|'SLR_NOT_FOUND'|'OTHER',
        'Type': 'IMPORTED'|'AMAZON_ISSUED'|'PRIVATE',
        'RenewalSummary': {
            'RenewalStatus': 'PENDING_AUTO_RENEWAL'|'PENDING_VALIDATION'|'SUCCESS'|'FAILED',
            'DomainValidationOptions': [
                {
                    'DomainName': 'string',
                    'ValidationEmails': [
                        'string',
                    ],
                    'ValidationDomain': 'string',
                    'ValidationStatus': 'PENDING_VALIDATION'|'SUCCESS'|'FAILED',
                    'ResourceRecord': {
                        'Name': 'string',
                        'Type': 'CNAME',
                        'Value': 'string'
                    },
                    'HttpRedirect': {
                        'RedirectFrom': 'string',
                        'RedirectTo': 'string'
                    },
                    'ValidationMethod': 'EMAIL'|'DNS'|'HTTP'
                },
            ],
            'RenewalStatusReason': 'NO_AVAILABLE_CONTACTS'|'ADDITIONAL_VERIFICATION_REQUIRED'|'DOMAIN_NOT_ALLOWED'|'INVALID_PUBLIC_DOMAIN'|'DOMAIN_VALIDATION_DENIED'|'CAA_ERROR'|'PCA_LIMIT_EXCEEDED'|'PCA_INVALID_ARN'|'PCA_INVALID_STATE'|'PCA_REQUEST_FAILED'|'PCA_NAME_CONSTRAINTS_VALIDATION'|'PCA_RESOURCE_NOT_FOUND'|'PCA_INVALID_ARGS'|'PCA_INVALID_DURATION'|'PCA_ACCESS_DENIED'|'SLR_NOT_FOUND'|'OTHER',
            'UpdatedAt': datetime(2015, 1, 1)
        },
        'KeyUsages': [
            {
                'Name': 'DIGITAL_SIGNATURE'|'NON_REPUDIATION'|'KEY_ENCIPHERMENT'|'DATA_ENCIPHERMENT'|'KEY_AGREEMENT'|'CERTIFICATE_SIGNING'|'CRL_SIGNING'|'ENCIPHER_ONLY'|'DECIPHER_ONLY'|'ANY'|'CUSTOM'
            },
        ],
        'ExtendedKeyUsages': [
            {
                'Name': 'TLS_WEB_SERVER_AUTHENTICATION'|'TLS_WEB_CLIENT_AUTHENTICATION'|'CODE_SIGNING'|'EMAIL_PROTECTION'|'TIME_STAMPING'|'OCSP_SIGNING'|'IPSEC_END_SYSTEM'|'IPSEC_TUNNEL'|'IPSEC_USER'|'ANY'|'NONE'|'CUSTOM',
                'OID': 'string'
            },
        ],
        'CertificateAuthorityArn': 'string',
        'RenewalEligibility': 'ELIGIBLE'|'INELIGIBLE',
        'Options': {
            'CertificateTransparencyLoggingPreference': 'ENABLED'|'DISABLED',
            'Export': 'ENABLED'|'DISABLED',
            'ValidationMethod': 'EMAIL'|'DNS'|'HTTP'
        },
        'UpdateSummary': {
            'Status': 'PENDING_DOMAIN_VALIDATION'|'SUCCESS'|'FAILED',
            'Type': 'DOMAIN_VALIDATION_METHOD',
            'DomainValidationMethodUpdateSummary': {
                'From': 'EMAIL'|'DNS'|'HTTP',
                'To': 'EMAIL'|'DNS'|'HTTP'
            },
            'RequestedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1)
        },
        'CertificateKeyPairOrigin': 'AWS_MANAGED'|'ACME'|'CUSTOMER_PROVIDED',
        'AcmeEndpointArn': 'string',
        'AcmeAccountId': 'string',
        'CertificateUsage': 'CLIENT_AND_SERVER_AUTH'|'CLIENT_AUTH_ONLY',
        'RootHierarchyType': 'N2_AMAZON_MANAGED'|'N2_SFG2_AMAZON_MANAGED'
    }
}

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) in the Amazon Web Services 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) --

      • ManagedBy (string) --

        Identifies the Amazon Web Services service that manages the certificate issued by ACM.

      • 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. This can be one of the following values:

            • PENDING_VALIDATION

            • SUCCESS

            • FAILED

          • ResourceRecord (dict) --

            Contains the CNAME record that you add to your DNS database for domain validation. For more information, see Use DNS to Validate Domain Ownership.

            • Name (string) --

              The name of the DNS record to create in your domain. This is supplied by ACM.

            • Type (string) --

              The type of DNS record. Currently this can be CNAME.

            • Value (string) --

              The value of the CNAME record to add to your DNS database. This is supplied by ACM.

          • HttpRedirect (dict) --

            Contains information for HTTP-based domain validation of certificates requested through Amazon CloudFront and issued by ACM. This field exists only when the certificate type is AMAZON_ISSUED and the validation method is HTTP.

            • RedirectFrom (string) --

              The URL including the domain to be validated. The certificate authority sends GET requests here during validation.

            • RedirectTo (string) --

              The URL hosting the validation token. RedirectFrom must return this content or redirect here.

          • ValidationMethod (string) --

            Specifies the domain validation method.

      • 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.

      • 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 when the certificate was imported. This value exists only when the certificate type is IMPORTED.

      • Status (string) --

        The status of the certificate.

        A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for any of the reasons given in the troubleshooting topic Certificate request fails. ACM makes repeated attempts to validate a certificate for 72 hours and then times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with DNS validation or Email validation, and try again. If validation succeeds, the certificate enters status ISSUED.

      • 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 public-private key pair.

      • SignatureAlgorithm (string) --

        The algorithm that was used to sign the certificate.

      • InUseBy (list) --

        A list of ARNs for the Amazon Web Services resources that are using the certificate. A certificate can be used by multiple Amazon Web Services 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 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 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. This can be one of the following values:

              • PENDING_VALIDATION

              • SUCCESS

              • FAILED

            • ResourceRecord (dict) --

              Contains the CNAME record that you add to your DNS database for domain validation. For more information, see Use DNS to Validate Domain Ownership.

              • Name (string) --

                The name of the DNS record to create in your domain. This is supplied by ACM.

              • Type (string) --

                The type of DNS record. Currently this can be CNAME.

              • Value (string) --

                The value of the CNAME record to add to your DNS database. This is supplied by ACM.

            • HttpRedirect (dict) --

              Contains information for HTTP-based domain validation of certificates requested through Amazon CloudFront and issued by ACM. This field exists only when the certificate type is AMAZON_ISSUED and the validation method is HTTP.

              • RedirectFrom (string) --

                The URL including the domain to be validated. The certificate authority sends GET requests here during validation.

              • RedirectTo (string) --

                The URL hosting the validation token. RedirectFrom must return this content or redirect here.

            • ValidationMethod (string) --

              Specifies the domain validation method.

        • RenewalStatusReason (string) --

          The reason that a renewal request was unsuccessful.

        • UpdatedAt (datetime) --

          The time at which the renewal summary was last updated.

      • KeyUsages (list) --

        A list of Key Usage X.509 v3 extension objects. Each object is a string value that identifies the purpose of the public key contained in the certificate. Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.

        • (dict) --

          The Key Usage X.509 v3 extension defines the purpose of the public key contained in the certificate.

          • Name (string) --

            A string value that contains a Key Usage extension name.

      • ExtendedKeyUsages (list) --

        Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID).

        • (dict) --

          The Extended Key Usage X.509 v3 extension defines one or more purposes for which the public key can be used. This is in addition to or in place of the basic purposes specified by the Key Usage extension.

          • Name (string) --

            The name of an Extended Key Usage value.

          • OID (string) --

            An object identifier (OID) for the extension value. OIDs are strings of numbers separated by periods. The following OIDs are defined in RFC 3280 and RFC 5280.

            • 1.3.6.1.5.5.7.3.1 (TLS_WEB_SERVER_AUTHENTICATION)

            • 1.3.6.1.5.5.7.3.2 (TLS_WEB_CLIENT_AUTHENTICATION)

            • 1.3.6.1.5.5.7.3.3 (CODE_SIGNING)

            • 1.3.6.1.5.5.7.3.4 (EMAIL_PROTECTION)

            • 1.3.6.1.5.5.7.3.8 (TIME_STAMPING)

            • 1.3.6.1.5.5.7.3.9 (OCSP_SIGNING)

            • 1.3.6.1.5.5.7.3.5 (IPSEC_END_SYSTEM)

            • 1.3.6.1.5.5.7.3.6 (IPSEC_TUNNEL)

            • 1.3.6.1.5.5.7.3.7 (IPSEC_USER)

      • CertificateAuthorityArn (string) --

        The Amazon Resource Name (ARN) of the private certificate authority (CA) that issued the certificate. This has the following format:

        arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

      • RenewalEligibility (string) --

        Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.

      • Options (dict) --

        Contains the certificate options. Certificate transparency logging opt-out is no longer available. ACM records all public certificates other than Amazon N2 certificates in a certificate transparency log.

        • CertificateTransparencyLoggingPreference (string) --

          This parameter has been deprecated. Certificate transparency logging opt-out is no longer available. ACM records all public certificates other than Amazon N2 certificates in a certificate transparency log.

        • Export (string) --

          You can opt in to allow the export of your certificates by specifying ENABLED. You cannot update the value of Export after the the certificate is created.

        • ValidationMethod (string) --

          The domain validation method for the certificate. To migrate from email to DNS validation, specify DNS.

      • UpdateSummary (dict) --

        Contains information about the most recent update to the certificate. This field exists only when the certificate type is AMAZON_ISSUED and a certificate update has been requested.

        • Status (string) --

          The status of the certificate update. The following are valid values:

          • PENDING_DOMAIN_VALIDATION – The certificate update is waiting for domain ownership validation to complete.

          • SUCCESS – The certificate was updated successfully.

          • FAILED – The certificate update failed.

        • Type (string) --

          The type of update that was requested for the certificate. The following are valid values:

          • DOMAIN_VALIDATION_METHOD – The update changes the domain validation method for the certificate.

        • DomainValidationMethodUpdateSummary (dict) --

          Contains information about a domain validation method migration, including the previous and target validation methods.

          • From (string) --

            The validation method that the certificate was using before the update.

          • To (string) --

            The target validation method for the update.

        • RequestedAt (datetime) --

          The time at which the certificate update was requested.

        • UpdatedAt (datetime) --

          The time at which the certificate update status was last changed.

      • CertificateKeyPairOrigin (string) --

        The origin of the certificate's key pair.

      • AcmeEndpointArn (string) --

        The ARN of the ACME endpoint used to issue the certificate.

      • AcmeAccountId (string) --

        The ACME account identifier associated with the certificate.

      • CertificateUsage (string) --

        The Extended Key Usage profile of the certificate. This value exists only for Amazon N2 certificates. If CertificateUsage was omitted from the request, this value is CLIENT_AND_SERVER_AUTH.

      • RootHierarchyType (string) --

        The root hierarchy from which the certificate was issued. This value exists only for Amazon N2 certificates, which have a Type of AMAZON_ISSUED.

ListCertificates (updated) Link ¶
Changes (request, response)
Request
{'RootHierarchyTypes': ['N2_AMAZON_MANAGED | N2_SFG2_AMAZON_MANAGED']}
Response
{'CertificateSummaryList': {'CertificateUsage': 'CLIENT_AND_SERVER_AUTH | '
                                                'CLIENT_AUTH_ONLY',
                            'RootHierarchyType': 'N2_AMAZON_MANAGED | '
                                                 'N2_SFG2_AMAZON_MANAGED'}}

Retrieves a list of certificate ARNs and domain names. You can request that only certificates that match a specific status be listed. You can also filter by specific attributes of the certificate. Default filtering returns only RSA_2048 certificates. For more information, see Filters.

See also: AWS API Documentation

Request Syntax

client.list_certificates(
    CertificateStatuses=[
        'PENDING_VALIDATION'|'ISSUED'|'INACTIVE'|'EXPIRED'|'VALIDATION_TIMED_OUT'|'REVOKED'|'FAILED',
    ],
    CertificateKeyPairOrigins=[
        'AWS_MANAGED'|'ACME'|'CUSTOMER_PROVIDED',
    ],
    RootHierarchyTypes=[
        'N2_AMAZON_MANAGED'|'N2_SFG2_AMAZON_MANAGED',
    ],
    Includes={
        'extendedKeyUsage': [
            'TLS_WEB_SERVER_AUTHENTICATION'|'TLS_WEB_CLIENT_AUTHENTICATION'|'CODE_SIGNING'|'EMAIL_PROTECTION'|'TIME_STAMPING'|'OCSP_SIGNING'|'IPSEC_END_SYSTEM'|'IPSEC_TUNNEL'|'IPSEC_USER'|'ANY'|'NONE'|'CUSTOM',
        ],
        'keyUsage': [
            'DIGITAL_SIGNATURE'|'NON_REPUDIATION'|'KEY_ENCIPHERMENT'|'DATA_ENCIPHERMENT'|'KEY_AGREEMENT'|'CERTIFICATE_SIGNING'|'CRL_SIGNING'|'ENCIPHER_ONLY'|'DECIPHER_ONLY'|'ANY'|'CUSTOM',
        ],
        'keyTypes': [
            'RSA_1024'|'RSA_2048'|'RSA_3072'|'RSA_4096'|'EC_prime256v1'|'EC_secp384r1'|'EC_secp521r1',
        ],
        'exportOption': 'ENABLED'|'DISABLED',
        'managedBy': 'CLOUDFRONT'
    },
    NextToken='string',
    MaxItems=123,
    SortBy='CREATED_AT',
    SortOrder='ASCENDING'|'DESCENDING'
)
type CertificateStatuses:

list

param CertificateStatuses:

Filter the certificate list by status value.

  • (string) --

type CertificateKeyPairOrigins:

list

param CertificateKeyPairOrigins:

Filter the certificate list by certificate key pair origin. Specify one or more CertificateKeyPairOrigin values. Default filtering returns only certificates with key pair origin of AWS_MANAGED and CUSTOMER_PROVIDED.

  • (string) --

    The origin of the certificate's key pair.

type RootHierarchyTypes:

list

param RootHierarchyTypes:

Filter the certificate list by root hierarchy type. Specify one or more RootHierarchyType values. By default, this action does not return certificates with a RootHierarchyType of N2_AMAZON_MANAGED or N2_SFG2_AMAZON_MANAGED. To list only Amazon N2 certificates, specify one or both of these values in the RootHierarchyTypes filter.

  • (string) --

    The root hierarchy from which a certificate is issued. Valid values:

    • N2_AMAZON_MANAGED – An Amazon N2 certificate that chains to an Amazon N2 root.

    • N2_SFG2_AMAZON_MANAGED – An Amazon N2 certificate that chains to an Amazon N2 root cross-signed by Starfield G2.

type Includes:

dict

param Includes:

Filter the certificate list. For more information, see the Filters structure.

  • extendedKeyUsage (list) --

    Specify one or more ExtendedKeyUsage extension values.

    • (string) --

  • keyUsage (list) --

    Specify one or more KeyUsage extension values.

    • (string) --

  • keyTypes (list) --

    Specify one or more algorithms that can be used to generate key pairs.

    Default filtering returns only RSA_1024 and RSA_2048 certificates that have at least one domain. To return other certificate types, provide the desired type signatures in a comma-separated list. For example, "keyTypes": ["RSA_2048","RSA_4096"] returns both RSA_2048 and RSA_4096 certificates.

    • (string) --

  • exportOption (string) --

    Specify ENABLED or DISABLED to identify certificates that can be exported.

  • managedBy (string) --

    Identifies the Amazon Web Services service that manages the certificate issued by ACM.

type NextToken:

string

param NextToken:

Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the response you just received.

type MaxItems:

integer

param MaxItems:

Use this parameter when paginating results to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.

type SortBy:

string

param SortBy:

Specifies the field to sort results by. If you specify SortBy, you must also specify SortOrder.

type SortOrder:

string

param SortOrder:

Specifies the order of sorted results. If you specify SortOrder, you must also specify SortBy.

rtype:

dict

returns:

Response Syntax

{
    'NextToken': 'string',
    'CertificateSummaryList': [
        {
            'CertificateArn': 'string',
            'DomainName': 'string',
            'SubjectAlternativeNameSummaries': [
                'string',
            ],
            'HasAdditionalSubjectAlternativeNames': True|False,
            'Status': 'PENDING_VALIDATION'|'ISSUED'|'INACTIVE'|'EXPIRED'|'VALIDATION_TIMED_OUT'|'REVOKED'|'FAILED',
            'Type': 'IMPORTED'|'AMAZON_ISSUED'|'PRIVATE',
            'KeyAlgorithm': 'RSA_1024'|'RSA_2048'|'RSA_3072'|'RSA_4096'|'EC_prime256v1'|'EC_secp384r1'|'EC_secp521r1',
            'KeyUsages': [
                'DIGITAL_SIGNATURE'|'NON_REPUDIATION'|'KEY_ENCIPHERMENT'|'DATA_ENCIPHERMENT'|'KEY_AGREEMENT'|'CERTIFICATE_SIGNING'|'CRL_SIGNING'|'ENCIPHER_ONLY'|'DECIPHER_ONLY'|'ANY'|'CUSTOM',
            ],
            'ExtendedKeyUsages': [
                'TLS_WEB_SERVER_AUTHENTICATION'|'TLS_WEB_CLIENT_AUTHENTICATION'|'CODE_SIGNING'|'EMAIL_PROTECTION'|'TIME_STAMPING'|'OCSP_SIGNING'|'IPSEC_END_SYSTEM'|'IPSEC_TUNNEL'|'IPSEC_USER'|'ANY'|'NONE'|'CUSTOM',
            ],
            'ExportOption': 'ENABLED'|'DISABLED',
            'InUse': True|False,
            'Exported': True|False,
            'RenewalEligibility': 'ELIGIBLE'|'INELIGIBLE',
            'NotBefore': datetime(2015, 1, 1),
            'NotAfter': datetime(2015, 1, 1),
            'CreatedAt': datetime(2015, 1, 1),
            'IssuedAt': datetime(2015, 1, 1),
            'ImportedAt': datetime(2015, 1, 1),
            'RevokedAt': datetime(2015, 1, 1),
            'ManagedBy': 'CLOUDFRONT',
            'CertificateKeyPairOrigin': 'AWS_MANAGED'|'ACME'|'CUSTOMER_PROVIDED',
            'CertificateUsage': 'CLIENT_AND_SERVER_AUTH'|'CLIENT_AUTH_ONLY',
            'RootHierarchyType': 'N2_AMAZON_MANAGED'|'N2_SFG2_AMAZON_MANAGED'
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      When the list is truncated, this value is present and contains the value to use for the NextToken parameter in a subsequent pagination request.

    • CertificateSummaryList (list) --

      A list of ACM certificates.

      • (dict) --

        This structure is returned in the response object of ListCertificates action.

        • CertificateArn (string) --

          Amazon Resource Name (ARN) of the certificate. This is of the form:

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

          For more information about ARNs, see Amazon Resource Names (ARNs).

        • DomainName (string) --

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

        • SubjectAlternativeNameSummaries (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.

          When called by ListCertificates, this parameter will only return the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.

          • (string) --

        • HasAdditionalSubjectAlternativeNames (boolean) --

          When called by ListCertificates, indicates whether the full list of subject alternative names has been included in the response. If false, the response includes all of the subject alternative names included in the certificate. If true, the response only includes the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.

        • Status (string) --

          The status of the certificate.

          A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for any of the reasons given in the troubleshooting topic Certificate request fails. ACM makes repeated attempts to validate a certificate for 72 hours and then times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with DNS validation or Email validation, and try again. If validation succeeds, the certificate enters status ISSUED.

        • 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 Certificate Manager User Guide.

        • KeyAlgorithm (string) --

          The algorithm that was used to generate the public-private key pair.

        • KeyUsages (list) --

          A list of Key Usage X.509 v3 extension objects. Each object is a string value that identifies the purpose of the public key contained in the certificate. Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.

          • (string) --

        • ExtendedKeyUsages (list) --

          Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID).

          • (string) --

        • ExportOption (string) --

          Indicates if export is enabled for the certificate.

        • InUse (boolean) --

          Indicates whether the certificate is currently in use by any Amazon Web Services resources.

        • Exported (boolean) --

          Indicates whether the certificate has been exported.

        • RenewalEligibility (string) --

          Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.

        • NotBefore (datetime) --

          The time before which the certificate is not valid.

        • NotAfter (datetime) --

          The time after which the certificate is not valid.

        • CreatedAt (datetime) --

          The time at which the certificate was requested.

        • 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 when the certificate was imported. This value exists only when the certificate type is IMPORTED.

        • RevokedAt (datetime) --

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

        • ManagedBy (string) --

          Identifies the Amazon Web Services service that manages the certificate issued by ACM.

        • CertificateKeyPairOrigin (string) --

          The origin of the certificate's key pair.

        • CertificateUsage (string) --

          The Extended Key Usage profile of the certificate. This value exists only for Amazon N2 certificates. If CertificateUsage was omitted from the request, this value is CLIENT_AND_SERVER_AUTH.

        • RootHierarchyType (string) --

          The root hierarchy from which the certificate was issued. This value exists only for Amazon N2 certificates, which have a Type of AMAZON_ISSUED.

RequestCertificate (updated) Link ¶
Changes (request)
{'CertificateUsage': 'CLIENT_AND_SERVER_AUTH | CLIENT_AUTH_ONLY',
 'RootHierarchyType': 'N2_AMAZON_MANAGED | N2_SFG2_AMAZON_MANAGED'}

Requests an ACM certificate for use with other Amazon Web Services services. To request an ACM certificate, you must specify a fully qualified domain name (FQDN) in the DomainName parameter. You can also specify additional FQDNs in the SubjectAlternativeNames parameter.

If you are requesting a private certificate, domain validation is not required. If you are requesting a public certificate, each domain name that you specify must be validated to verify that you own or control the domain. You can use DNS validation or email validation. We recommend that you use DNS validation.

After successful completion of the RequestCertificate action, there is a delay of several seconds before you can retrieve information about the new certificate.

See also: AWS API Documentation

Request Syntax

client.request_certificate(
    DomainName='string',
    ValidationMethod='EMAIL'|'DNS'|'HTTP',
    SubjectAlternativeNames=[
        'string',
    ],
    IdempotencyToken='string',
    DomainValidationOptions=[
        {
            'DomainName': 'string',
            'ValidationDomain': 'string'
        },
    ],
    Options={
        'CertificateTransparencyLoggingPreference': 'ENABLED'|'DISABLED',
        'Export': 'ENABLED'|'DISABLED',
        'ValidationMethod': 'EMAIL'|'DNS'|'HTTP'
    },
    CertificateAuthorityArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    KeyAlgorithm='RSA_1024'|'RSA_2048'|'RSA_3072'|'RSA_4096'|'EC_prime256v1'|'EC_secp384r1'|'EC_secp521r1',
    ManagedBy='CLOUDFRONT',
    CertificateUsage='CLIENT_AND_SERVER_AUTH'|'CLIENT_AUTH_ONLY',
    RootHierarchyType='N2_AMAZON_MANAGED'|'N2_SFG2_AMAZON_MANAGED'
)
type DomainName:

string

param DomainName:

[REQUIRED]

Fully qualified domain name (FQDN), such as www.example.com, that you want to secure with an ACM certificate. Use an asterisk (*) to create a wildcard certificate that protects several sites in the same domain. For example, *.example.com protects www.example.com, site.example.com, and images.example.com.

In compliance with RFC 5280, the length of the domain name (technically, the Common Name) that you provide cannot exceed 64 octets (characters), including periods. To add a longer domain name, specify it in the Subject Alternative Name field, which supports names up to 253 octets in length.

type ValidationMethod:

string

param ValidationMethod:

The method you want to use if you are requesting a public certificate to validate that you own or control domain. You can validate with DNS or validate with email. We recommend that you use DNS validation.

type SubjectAlternativeNames:

list

param SubjectAlternativeNames:

Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate. For example, add the name www.example.net to a certificate for which the DomainName field is www.example.com if users can reach your site by using either name. The maximum number of domain names that you can add to an ACM certificate is 100. However, the initial quota is 10 domain names. If you need more than 10 names, you must request a quota increase. For more information, see Quotas.

The maximum length of a SAN DNS name is 253 octets. The name is made up of multiple labels separated by periods. No label can be longer than 63 octets. Consider the following examples:

  • (63 octets).(63 octets).(63 octets).(61 octets) is legal because the total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets.

  • (64 octets).(63 octets).(63 octets).(61 octets) is not legal because the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds 63 octets.

  • (63 octets).(63 octets).(63 octets).(62 octets) is not legal because the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets.

  • (string) --

type IdempotencyToken:

string

param IdempotencyToken:

Customer chosen string that can be used to distinguish between calls to RequestCertificate. Idempotency tokens time out after one hour. Therefore, if you call RequestCertificate multiple times with the same idempotency token within one hour, ACM recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, ACM recognizes that you are requesting multiple certificates.

type DomainValidationOptions:

list

param DomainValidationOptions:

The domain name that you want ACM to use to send you emails so that you can validate domain ownership.

  • (dict) --

    Contains information about the domain names that you want ACM to use to send you emails that enable you to validate domain ownership.

    • DomainName (string) -- [REQUIRED]

      A fully qualified domain name (FQDN) in the certificate request.

    • ValidationDomain (string) -- [REQUIRED]

      The domain name that you want ACM to use to send you validation emails. This domain name is the suffix of the email addresses that you want ACM to use. This must be the same as the DomainName value or a superdomain of the DomainName value. For example, if you request a certificate for testing.example.com, you can specify example.com for this value. In that case, ACM sends domain validation emails to the following five addresses:

type Options:

dict

param Options:

You can use this parameter to specify whether to export your certificate.

Certificate transparency logging opt-out is no longer available. ACM records all public certificates other than Amazon N2 certificates in a certificate transparency log. For more information, see Certificate Transparency Logging.

You can export public ACM certificates to use with Amazon Web Services services as well as outside the Amazon Web Services Cloud. For more information, see Certificate Manager exportable public certificate.

  • CertificateTransparencyLoggingPreference (string) --

    This parameter has been deprecated. Certificate transparency logging opt-out is no longer available. ACM records all public certificates other than Amazon N2 certificates in a certificate transparency log.

  • Export (string) --

    You can opt in to allow the export of your certificates by specifying ENABLED. You cannot update the value of Export after the the certificate is created.

  • ValidationMethod (string) --

    The domain validation method for the certificate. To migrate from email to DNS validation, specify DNS.

type CertificateAuthorityArn:

string

param CertificateAuthorityArn:

The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate. If you do not provide an ARN and you are trying to request a private certificate, ACM will attempt to issue a public certificate. For more information about private CAs, see the Amazon Web Services Private Certificate Authority user guide. The ARN must have the following form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

type Tags:

list

param Tags:

One or more resource tags to associate with the certificate.

  • (dict) --

    A key-value pair that identifies or specifies metadata about an ACM resource.

    • Key (string) -- [REQUIRED]

      The key of the tag.

    • Value (string) --

      The value of the tag.

type KeyAlgorithm:

string

param KeyAlgorithm:

Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data. RSA is the default key algorithm for ACM certificates. Elliptic Curve Digital Signature Algorithm (ECDSA) keys are smaller, offering security comparable to RSA keys but with greater computing efficiency. However, ECDSA is not supported by all network clients. Some Amazon Web Services services may require RSA keys, or only support ECDSA keys of a particular size, while others allow the use of either RSA and ECDSA keys to ensure that compatibility is not broken. Check the requirements for the Amazon Web Services service where you plan to deploy your certificate. For more information about selecting an algorithm, see Key algorithms.

Default: RSA_2048

type ManagedBy:

string

param ManagedBy:

Identifies the Amazon Web Services service that manages the certificate issued by ACM.

type CertificateUsage:

string

param CertificateUsage:

The Extended Key Usage profile of the certificate. You can specify this parameter only when RootHierarchyType is N2_AMAZON_MANAGED or N2_SFG2_AMAZON_MANAGED. If you specify CertificateUsage with any other root hierarchy type, or without RootHierarchyType, the request fails with a ValidationException.

  • CLIENT_AND_SERVER_AUTH authenticates both the client and the server. Valid for both N2 root hierarchy types.

  • CLIENT_AUTH_ONLY authenticates only the client. Valid only for N2_AMAZON_MANAGED.

Default: CLIENT_AND_SERVER_AUTH

type RootHierarchyType:

string

param RootHierarchyType:

The root hierarchy from which ACM issues the certificate. Specify one of the following values to request an Amazon N2 certificate:

  • N2_AMAZON_MANAGED – An Amazon N2 certificate that chains to an Amazon N2 root. The maximum validity period, which is also the default, is 395 days.

  • N2_SFG2_AMAZON_MANAGED – An Amazon N2 certificate that chains to an Amazon N2 root cross-signed by Starfield G2. The maximum validity period, which is also the default, is 98 days.

You cannot specify RootHierarchyType together with CertificateAuthorityArn.

If you omit this parameter, ACM issues a standard public certificate. A request that specifies any value other than N2_AMAZON_MANAGED or N2_SFG2_AMAZON_MANAGED fails with a ValidationException.

An Amazon N2 certificate request must specify a ValidationMethod of DNS. Amazon N2 certificates are not recorded in a certificate transparency log.

A request for a validity period longer than the maximum fails with a ValidationException.

rtype:

dict

returns:

Response Syntax

{
    'CertificateArn': 'string'
}

Response Structure

  • (dict) --

    • CertificateArn (string) --

      String that contains the ARN of the issued certificate. This must be of the form:

      arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012

SearchCertificates (updated) Link ¶
Changes (request, response)
Request
{'FilterStatement': {'Filter': {'AcmCertificateMetadataFilter': {'RootHierarchyType': 'N2_AMAZON_MANAGED '
                                                                                      '| '
                                                                                      'N2_SFG2_AMAZON_MANAGED'}}}}
Response
{'Results': {'CertificateMetadata': {'AcmCertificateMetadata': {'CertificateUsage': 'CLIENT_AND_SERVER_AUTH '
                                                                                    '| '
                                                                                    'CLIENT_AUTH_ONLY',
                                                                'RootHierarchyType': 'N2_AMAZON_MANAGED '
                                                                                     '| '
                                                                                     'N2_SFG2_AMAZON_MANAGED'}}}}

Retrieves a list of certificates matching search criteria. You can filter certificates by X.509 attributes and ACM specific properties like certificate status, type and renewal eligibility. This operation provides more flexible filtering than ListCertificates by supporting complex filter statements.

See also: AWS API Documentation

Request Syntax

client.search_certificates(
    FilterStatement={
        'And': [
            {'... recursive ...'},
        ],
        'Or': [
            {'... recursive ...'},
        ],
        'Not': {'... recursive ...'},
        'Filter': {
            'CertificateArn': 'string',
            'X509AttributeFilter': {
                'Subject': {
                    'CommonName': {
                        'Value': 'string',
                        'ComparisonOperator': 'CONTAINS'|'EQUALS'
                    }
                },
                'SubjectAlternativeName': {
                    'DnsName': {
                        'Value': 'string',
                        'ComparisonOperator': 'CONTAINS'|'EQUALS'
                    }
                },
                'ExtendedKeyUsage': 'TLS_WEB_SERVER_AUTHENTICATION'|'TLS_WEB_CLIENT_AUTHENTICATION'|'CODE_SIGNING'|'EMAIL_PROTECTION'|'TIME_STAMPING'|'OCSP_SIGNING'|'IPSEC_END_SYSTEM'|'IPSEC_TUNNEL'|'IPSEC_USER'|'ANY'|'NONE'|'CUSTOM',
                'KeyUsage': 'DIGITAL_SIGNATURE'|'NON_REPUDIATION'|'KEY_ENCIPHERMENT'|'DATA_ENCIPHERMENT'|'KEY_AGREEMENT'|'CERTIFICATE_SIGNING'|'CRL_SIGNING'|'ENCIPHER_ONLY'|'DECIPHER_ONLY'|'ANY'|'CUSTOM',
                'KeyAlgorithm': 'RSA_1024'|'RSA_2048'|'RSA_3072'|'RSA_4096'|'EC_prime256v1'|'EC_secp384r1'|'EC_secp521r1',
                'SerialNumber': 'string',
                'NotAfter': {
                    'Start': datetime(2015, 1, 1),
                    'End': datetime(2015, 1, 1)
                },
                'NotBefore': {
                    'Start': datetime(2015, 1, 1),
                    'End': datetime(2015, 1, 1)
                }
            },
            'AcmCertificateMetadataFilter': {
                'Status': 'PENDING_VALIDATION'|'ISSUED'|'INACTIVE'|'EXPIRED'|'VALIDATION_TIMED_OUT'|'REVOKED'|'FAILED',
                'RenewalStatus': 'PENDING_AUTO_RENEWAL'|'PENDING_VALIDATION'|'SUCCESS'|'FAILED',
                'Type': 'IMPORTED'|'AMAZON_ISSUED'|'PRIVATE',
                'InUse': True|False,
                'Exported': True|False,
                'ExportOption': 'ENABLED'|'DISABLED',
                'ManagedBy': 'CLOUDFRONT',
                'ValidationMethod': 'EMAIL'|'DNS'|'HTTP',
                'CertificateKeyPairOrigin': 'AWS_MANAGED'|'ACME'|'CUSTOMER_PROVIDED',
                'AcmeEndpointArn': 'string',
                'AcmeAccountId': 'string',
                'RootHierarchyType': 'N2_AMAZON_MANAGED'|'N2_SFG2_AMAZON_MANAGED'
            }
        }
    },
    MaxResults=123,
    NextToken='string',
    SortBy='CREATED_AT'|'NOT_AFTER'|'STATUS'|'RENEWAL_STATUS'|'EXPORTED'|'IN_USE'|'NOT_BEFORE'|'KEY_ALGORITHM'|'TYPE'|'CERTIFICATE_ARN'|'COMMON_NAME'|'REVOKED_AT'|'RENEWAL_ELIGIBILITY'|'ISSUED_AT'|'MANAGED_BY'|'EXPORT_OPTION'|'VALIDATION_METHOD'|'IMPORTED_AT'|'ACME_ENDPOINT_ARN'|'ACME_ACCOUNT_ID'|'CERTIFICATE_KEY_PAIR_ORIGIN',
    SortOrder='ASCENDING'|'DESCENDING'
)
type FilterStatement:

dict

param FilterStatement:

A filter statement that defines the search criteria. You can combine multiple filters using AND, OR, and NOT logical operators to create complex queries.

  • And (list) --

    A list of filter statements that must all be true.

    • (dict) --

      A filter statement used to search for certificates. Can contain AND, OR, NOT logical operators or a single filter.

  • Or (list) --

    A list of filter statements where at least one must be true.

    • (dict) --

      A filter statement used to search for certificates. Can contain AND, OR, NOT logical operators or a single filter.

  • Not (dict) --

    A filter statement that must not be true.

  • Filter (dict) --

    A single certificate filter.

    • CertificateArn (string) --

      Filter by certificate ARN.

    • X509AttributeFilter (dict) --

      Filter by X.509 certificate attributes.

      • Subject (dict) --

        Filter by certificate subject.

        • CommonName (dict) --

          Filter by common name in the subject.

          • Value (string) -- [REQUIRED]

            The value to match against.

          • ComparisonOperator (string) -- [REQUIRED]

            The comparison operator to use.

      • SubjectAlternativeName (dict) --

        Filter by subject alternative names.

        • DnsName (dict) --

          Filter by DNS name in subject alternative names.

          • Value (string) -- [REQUIRED]

            The DNS name value to match against.

          • ComparisonOperator (string) -- [REQUIRED]

            The comparison operator to use.

      • ExtendedKeyUsage (string) --

        Filter by extended key usage.

      • KeyUsage (string) --

        Filter by key usage.

      • KeyAlgorithm (string) --

        Filter by key algorithm.

      • SerialNumber (string) --

        Filter by serial number.

      • NotAfter (dict) --

        Filter by certificate expiration date. The start date is inclusive.

        • Start (datetime) --

          The start of the time range. This value is inclusive.

        • End (datetime) --

          The end of the time range. This value is inclusive.

      • NotBefore (dict) --

        Filter by certificate validity start date. The start date is inclusive.

        • Start (datetime) --

          The start of the time range. This value is inclusive.

        • End (datetime) --

          The end of the time range. This value is inclusive.

    • AcmCertificateMetadataFilter (dict) --

      Filter by ACM certificate metadata.

      • Status (string) --

        Filter by certificate status.

      • RenewalStatus (string) --

        Filter by certificate renewal status.

      • Type (string) --

        Filter by certificate type.

      • InUse (boolean) --

        Filter by whether the certificate is in use.

      • Exported (boolean) --

        Filter by whether the certificate has been exported.

      • ExportOption (string) --

        Filter by certificate export option.

      • ManagedBy (string) --

        Filter by the entity that manages the certificate.

      • ValidationMethod (string) --

        Filter by validation method.

      • CertificateKeyPairOrigin (string) --

        Filter by certificate key pair origin.

      • AcmeEndpointArn (string) --

        Filter by ACME endpoint ARN.

      • AcmeAccountId (string) --

        Filter by ACME account identifier.

      • RootHierarchyType (string) --

        Filter by root hierarchy type. Specify N2_AMAZON_MANAGED or N2_SFG2_AMAZON_MANAGED to return Amazon N2 certificates.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return in the response. Default is 100.

type NextToken:

string

param NextToken:

Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the response you just received.

type SortBy:

string

param SortBy:

Specifies the field to sort results by. Valid values are CREATED_AT, NOT_AFTER, STATUS, RENEWAL_STATUS, EXPORTED, IN_USE, NOT_BEFORE, KEY_ALGORITHM, TYPE, CERTIFICATE_ARN, COMMON_NAME, REVOKED_AT, RENEWAL_ELIGIBILITY, ISSUED_AT, MANAGED_BY, EXPORT_OPTION, VALIDATION_METHOD, and IMPORTED_AT.

type SortOrder:

string

param SortOrder:

Specifies the order of sorted results. Valid values are ASCENDING or DESCENDING.

rtype:

dict

returns:

Response Syntax

{
    'Results': [
        {
            'CertificateArn': 'string',
            'X509Attributes': {
                'Issuer': {
                    'CommonName': 'string',
                    'DomainComponents': [
                        'string',
                    ],
                    'Country': 'string',
                    'CustomAttributes': [
                        {
                            'ObjectIdentifier': 'string',
                            'Value': 'string'
                        },
                    ],
                    'DistinguishedNameQualifier': 'string',
                    'GenerationQualifier': 'string',
                    'GivenName': 'string',
                    'Initials': 'string',
                    'Locality': 'string',
                    'Organization': 'string',
                    'OrganizationalUnit': 'string',
                    'Pseudonym': 'string',
                    'SerialNumber': 'string',
                    'State': 'string',
                    'Surname': 'string',
                    'Title': 'string'
                },
                'Subject': {
                    'CommonName': 'string',
                    'DomainComponents': [
                        'string',
                    ],
                    'Country': 'string',
                    'CustomAttributes': [
                        {
                            'ObjectIdentifier': 'string',
                            'Value': 'string'
                        },
                    ],
                    'DistinguishedNameQualifier': 'string',
                    'GenerationQualifier': 'string',
                    'GivenName': 'string',
                    'Initials': 'string',
                    'Locality': 'string',
                    'Organization': 'string',
                    'OrganizationalUnit': 'string',
                    'Pseudonym': 'string',
                    'SerialNumber': 'string',
                    'State': 'string',
                    'Surname': 'string',
                    'Title': 'string'
                },
                'SubjectAlternativeNames': [
                    {
                        'DirectoryName': {
                            'CommonName': 'string',
                            'DomainComponents': [
                                'string',
                            ],
                            'Country': 'string',
                            'CustomAttributes': [
                                {
                                    'ObjectIdentifier': 'string',
                                    'Value': 'string'
                                },
                            ],
                            'DistinguishedNameQualifier': 'string',
                            'GenerationQualifier': 'string',
                            'GivenName': 'string',
                            'Initials': 'string',
                            'Locality': 'string',
                            'Organization': 'string',
                            'OrganizationalUnit': 'string',
                            'Pseudonym': 'string',
                            'SerialNumber': 'string',
                            'State': 'string',
                            'Surname': 'string',
                            'Title': 'string'
                        },
                        'DnsName': 'string',
                        'IpAddress': 'string',
                        'OtherName': {
                            'ObjectIdentifier': 'string',
                            'Value': 'string'
                        },
                        'RegisteredId': 'string',
                        'Rfc822Name': 'string',
                        'UniformResourceIdentifier': 'string'
                    },
                ],
                'ExtendedKeyUsages': [
                    'TLS_WEB_SERVER_AUTHENTICATION'|'TLS_WEB_CLIENT_AUTHENTICATION'|'CODE_SIGNING'|'EMAIL_PROTECTION'|'TIME_STAMPING'|'OCSP_SIGNING'|'IPSEC_END_SYSTEM'|'IPSEC_TUNNEL'|'IPSEC_USER'|'ANY'|'NONE'|'CUSTOM',
                ],
                'KeyAlgorithm': 'RSA_1024'|'RSA_2048'|'RSA_3072'|'RSA_4096'|'EC_prime256v1'|'EC_secp384r1'|'EC_secp521r1',
                'KeyUsages': [
                    'DIGITAL_SIGNATURE'|'NON_REPUDIATION'|'KEY_ENCIPHERMENT'|'DATA_ENCIPHERMENT'|'KEY_AGREEMENT'|'CERTIFICATE_SIGNING'|'CRL_SIGNING'|'ENCIPHER_ONLY'|'DECIPHER_ONLY'|'ANY'|'CUSTOM',
                ],
                'SerialNumber': 'string',
                'NotAfter': datetime(2015, 1, 1),
                'NotBefore': datetime(2015, 1, 1)
            },
            'CertificateMetadata': {
                'AcmCertificateMetadata': {
                    'CreatedAt': datetime(2015, 1, 1),
                    'Exported': True|False,
                    'ImportedAt': datetime(2015, 1, 1),
                    'InUse': True|False,
                    'IssuedAt': datetime(2015, 1, 1),
                    'RenewalEligibility': 'ELIGIBLE'|'INELIGIBLE',
                    'RevokedAt': datetime(2015, 1, 1),
                    'Status': 'PENDING_VALIDATION'|'ISSUED'|'INACTIVE'|'EXPIRED'|'VALIDATION_TIMED_OUT'|'REVOKED'|'FAILED',
                    'RenewalStatus': 'PENDING_AUTO_RENEWAL'|'PENDING_VALIDATION'|'SUCCESS'|'FAILED',
                    'Type': 'IMPORTED'|'AMAZON_ISSUED'|'PRIVATE',
                    'ExportOption': 'ENABLED'|'DISABLED',
                    'ManagedBy': 'CLOUDFRONT',
                    'ValidationMethod': 'EMAIL'|'DNS'|'HTTP',
                    'CertificateKeyPairOrigin': 'AWS_MANAGED'|'ACME'|'CUSTOMER_PROVIDED',
                    'AcmeEndpointArn': 'string',
                    'AcmeAccountId': 'string',
                    'CertificateUsage': 'CLIENT_AND_SERVER_AUTH'|'CLIENT_AUTH_ONLY',
                    'RootHierarchyType': 'N2_AMAZON_MANAGED'|'N2_SFG2_AMAZON_MANAGED'
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Results (list) --

      A list of certificate search results containing certificate ARNs, X.509 attributes, and ACM metadata.

      • (dict) --

        Contains information about a certificate returned by the SearchCertificates action. This structure includes the certificate ARN, X.509 attributes, and ACM metadata.

        • CertificateArn (string) --

          The Amazon Resource Name (ARN) of the certificate.

        • X509Attributes (dict) --

          X.509 certificate attributes such as subject, issuer, and validity period.

          • Issuer (dict) --

            The distinguished name of the certificate issuer.

            • CommonName (string) --

              The common name (CN) attribute.

            • DomainComponents (list) --

              The domain component attributes.

              • (string) --

            • Country (string) --

              The country (C) attribute.

            • CustomAttributes (list) --

              A list of custom attributes in the distinguished name. Each custom attribute contains an object identifier (OID) and its corresponding value.

              • (dict) --

                Defines the X.500 relative distinguished name (RDN).

                • ObjectIdentifier (string) --

                  Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN).

                • Value (string) --

                  Specifies the attribute value of relative distinguished name (RDN).

            • DistinguishedNameQualifier (string) --

              The distinguished name qualifier attribute.

            • GenerationQualifier (string) --

              The generation qualifier attribute.

            • GivenName (string) --

              The given name attribute.

            • Initials (string) --

              The initials attribute.

            • Locality (string) --

              The locality (L) attribute.

            • Organization (string) --

              The organization (O) attribute.

            • OrganizationalUnit (string) --

              The organizational unit (OU) attribute.

            • Pseudonym (string) --

              The pseudonym attribute.

            • SerialNumber (string) --

              The serial number attribute.

            • State (string) --

              The state or province (ST) attribute.

            • Surname (string) --

              The surname attribute.

            • Title (string) --

              The title attribute.

          • Subject (dict) --

            The distinguished name of the certificate subject.

            • CommonName (string) --

              The common name (CN) attribute.

            • DomainComponents (list) --

              The domain component attributes.

              • (string) --

            • Country (string) --

              The country (C) attribute.

            • CustomAttributes (list) --

              A list of custom attributes in the distinguished name. Each custom attribute contains an object identifier (OID) and its corresponding value.

              • (dict) --

                Defines the X.500 relative distinguished name (RDN).

                • ObjectIdentifier (string) --

                  Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN).

                • Value (string) --

                  Specifies the attribute value of relative distinguished name (RDN).

            • DistinguishedNameQualifier (string) --

              The distinguished name qualifier attribute.

            • GenerationQualifier (string) --

              The generation qualifier attribute.

            • GivenName (string) --

              The given name attribute.

            • Initials (string) --

              The initials attribute.

            • Locality (string) --

              The locality (L) attribute.

            • Organization (string) --

              The organization (O) attribute.

            • OrganizationalUnit (string) --

              The organizational unit (OU) attribute.

            • Pseudonym (string) --

              The pseudonym attribute.

            • SerialNumber (string) --

              The serial number attribute.

            • State (string) --

              The state or province (ST) attribute.

            • Surname (string) --

              The surname attribute.

            • Title (string) --

              The title attribute.

          • 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.

            • (dict) --

              Describes an ASN.1 X.400 GeneralName as defined in RFC 5280. Only one of the following naming options should be provided.

              • DirectoryName (dict) --

                Contains information about the certificate subject. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate.

                • CommonName (string) --

                  The common name (CN) attribute.

                • DomainComponents (list) --

                  The domain component attributes.

                  • (string) --

                • Country (string) --

                  The country (C) attribute.

                • CustomAttributes (list) --

                  A list of custom attributes in the distinguished name. Each custom attribute contains an object identifier (OID) and its corresponding value.

                  • (dict) --

                    Defines the X.500 relative distinguished name (RDN).

                    • ObjectIdentifier (string) --

                      Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN).

                    • Value (string) --

                      Specifies the attribute value of relative distinguished name (RDN).

                • DistinguishedNameQualifier (string) --

                  The distinguished name qualifier attribute.

                • GenerationQualifier (string) --

                  The generation qualifier attribute.

                • GivenName (string) --

                  The given name attribute.

                • Initials (string) --

                  The initials attribute.

                • Locality (string) --

                  The locality (L) attribute.

                • Organization (string) --

                  The organization (O) attribute.

                • OrganizationalUnit (string) --

                  The organizational unit (OU) attribute.

                • Pseudonym (string) --

                  The pseudonym attribute.

                • SerialNumber (string) --

                  The serial number attribute.

                • State (string) --

                  The state or province (ST) attribute.

                • Surname (string) --

                  The surname attribute.

                • Title (string) --

                  The title attribute.

              • DnsName (string) --

                Represents GeneralName as a DNS name.

              • IpAddress (string) --

                Represents GeneralName as an IPv4 or IPv6 address.

              • OtherName (dict) --

                Represents GeneralName using an OtherName object.

                • ObjectIdentifier (string) --

                  Specifies an OID.

                • Value (string) --

                  Specifies an OID value.

              • RegisteredId (string) --

                Represents GeneralName as an object identifier (OID).

              • Rfc822Name (string) --

                Represents GeneralName as an RFC 822 email address.

              • UniformResourceIdentifier (string) --

                Represents GeneralName as a URI.

          • ExtendedKeyUsages (list) --

            Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID).

            • (string) --

          • KeyAlgorithm (string) --

            The algorithm that was used to generate the public-private key pair.

          • KeyUsages (list) --

            A list of Key Usage X.509 v3 extension objects. Each object is a string value that identifies the purpose of the public key contained in the certificate. Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.

            • (string) --

          • SerialNumber (string) --

            The serial number assigned by the certificate authority.

          • NotAfter (datetime) --

            The time after which the certificate is not valid.

          • NotBefore (datetime) --

            The time before which the certificate is not valid.

        • CertificateMetadata (dict) --

          ACM-specific metadata about the certificate.

          • AcmCertificateMetadata (dict) --

            Metadata for an ACM certificate.

            • CreatedAt (datetime) --

              The time at which the certificate was requested.

            • Exported (boolean) --

              Indicates whether the certificate has been exported.

            • ImportedAt (datetime) --

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

            • InUse (boolean) --

              Indicates whether the certificate is currently in use by an Amazon Web Services service.

            • IssuedAt (datetime) --

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

            • RenewalEligibility (string) --

              Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.

            • RevokedAt (datetime) --

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

            • Status (string) --

              The status of the certificate.

              A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for any of the reasons given in the troubleshooting topic Certificate request fails. ACM makes repeated attempts to validate a certificate for 72 hours and then times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with DNS validation or Email validation, and try again. If validation succeeds, the certificate enters status ISSUED.

            • RenewalStatus (string) --

              The renewal status of the certificate.

            • 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 Certificate Manager User Guide.

            • ExportOption (string) --

              Indicates whether the certificate can be exported.

            • ManagedBy (string) --

              Identifies the Amazon Web Services service that manages the certificate issued by ACM.

            • ValidationMethod (string) --

              Specifies the domain validation method.

            • CertificateKeyPairOrigin (string) --

              The origin of the certificate's key pair.

            • AcmeEndpointArn (string) --

              The ARN of the ACME endpoint used to issue the certificate.

            • AcmeAccountId (string) --

              The ACME account identifier associated with the certificate.

            • CertificateUsage (string) --

              The Extended Key Usage profile of the certificate. This value exists only for Amazon N2 certificates. If CertificateUsage was omitted from the request, this value is CLIENT_AND_SERVER_AUTH.

            • RootHierarchyType (string) --

              The root hierarchy from which the certificate was issued. This value exists only for Amazon N2 certificates, which have a Type of AMAZON_ISSUED.

    • NextToken (string) --

      When the list is truncated, this value is present and contains the value to use for the NextToken parameter in a subsequent pagination request.