ACM / Client / describe_acme_endpoint

describe_acme_endpoint

ACM.Client.describe_acme_endpoint(**kwargs)

Returns detailed metadata about the specified ACME endpoint, including its status, URL, authorization behavior, and certificate authority configuration.

See also: AWS API Documentation

Request Syntax

response = client.describe_acme_endpoint(
    AcmeEndpointArn='string'
)

Parameters:

AcmeEndpointArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the ACME endpoint.

Return type:

dict

Returns:

Response Syntax

{
    'AcmeEndpoint': {
        'AcmeEndpointArn': 'string',
        'EndpointUrl': 'string',
        'Status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED',
        'FailureReason': 'string',
        'AuthorizationBehavior': 'PRE_APPROVED',
        'Contact': 'REQUIRED'|'NOT_REQUIRED',
        'CertificateAuthority': {
            'PublicCertificateAuthority': {
                'AllowedKeyAlgorithms': [
                    'RSA_2048'|'EC_prime256v1'|'EC_secp384r1',
                ]
            }
        },
        'CertificateTags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'CreatedAt': datetime(2015, 1, 1),
        'UpdatedAt': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) –

  • AcmeEndpoint (dict) –

    The ACME endpoint details.

    • AcmeEndpointArn (string) –

      The Amazon Resource Name (ARN) of the ACME endpoint.

    • EndpointUrl (string) –

      The URL of the ACME endpoint.

    • Status (string) –

      The status of the ACME endpoint.

    • FailureReason (string) –

      The reason the ACME endpoint failed, if applicable.

    • AuthorizationBehavior (string) –

      The authorization behavior of the ACME endpoint.

    • Contact (string) –

      Whether ACME clients must provide contact information during account registration.

    • CertificateAuthority (dict) –

      The certificate authority configuration for the ACME endpoint.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: PublicCertificateAuthority. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      

      • PublicCertificateAuthority (dict) –

        Configuration for using a public certificate authority.

        • AllowedKeyAlgorithms (list) –

          The key algorithms allowed for certificates issued by this certificate authority.

          • (string) –

    • CertificateTags (list) –

      Tags applied to certificates issued through this ACME endpoint.

      • (dict) –

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

        • Key (string) –

          The key of the tag.

        • Value (string) –

          The value of the tag.

    • CreatedAt (datetime) –

      The time at which the ACME endpoint was created.

    • UpdatedAt (datetime) –

      The time at which the ACME endpoint was last updated.

Exceptions

• ACM.Client.exceptions.InternalServerException

• ACM.Client.exceptions.AccessDeniedException

• ACM.Client.exceptions.ValidationException

• ACM.Client.exceptions.ResourceNotFoundException

• ACM.Client.exceptions.ThrottlingException