ACM / Paginator / ListAcmeDomainValidations

ListAcmeDomainValidations

class ACM.Paginator.ListAcmeDomainValidations

paginator = client.get_paginator('list_acme_domain_validations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ACM.Client.list_acme_domain_validations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AcmeEndpointArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• AcmeEndpointArn (string) –

  [REQUIRED]

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'AcmeDomainValidations': [
        {
            'AcmeDomainValidationArn': 'string',
            'AcmeEndpointArn': 'string',
            'DomainName': 'string',
            'PrevalidationType': 'DNS_PREVALIDATION',
            'PrevalidationDetails': {
                'DnsPrevalidation': {
                    'DomainScope': {
                        'ExactDomain': 'ENABLED'|'DISABLED',
                        'Subdomains': 'ENABLED'|'DISABLED',
                        'Wildcards': 'ENABLED'|'DISABLED'
                    },
                    'HostedZoneId': 'string',
                    'ResourceRecord': {
                        'Name': 'string',
                        'Type': 'CNAME',
                        'Value': 'string'
                    }
                }
            },
            'Status': 'VALIDATING'|'VALID'|'INVALID'|'DELETING',
            'FailureDetails': {
                'Reason': 'ACCESS_DENIED'|'DOMAIN_MISMATCH'|'DOMAIN_NOT_ALLOWED'|'ENDPOINT_NOT_ACTIVE'|'HOSTED_ZONE_NOT_FOUND'|'INTERNAL_FAILURE'|'INVALID_CHANGE_BATCH'|'INVALID_PUBLIC_DOMAIN'|'TIMED_OUT',
                'Message': 'string'
            },
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • AcmeDomainValidations (list) –

    The list of domain validations.

    • (dict) –

      Contains summary information about an ACME domain validation.

      • AcmeDomainValidationArn (string) –

        The Amazon Resource Name (ARN) of the ACME domain validation.

      • AcmeEndpointArn (string) –

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

      • DomainName (string) –

        The domain name being validated.

      • PrevalidationType (string) –

        The type of prevalidation used.

      • PrevalidationDetails (dict) –

        Details about the prevalidation configuration.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: DnsPrevalidation. 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'}
        

        • DnsPrevalidation (dict) –

          DNS-based prevalidation details.

          • DomainScope (dict) –

            The scope of domains covered by this prevalidation.

            • ExactDomain (string) –

              Whether validation applies to the exact domain.

            • Subdomains (string) –

              Whether validation applies to subdomains.

            • Wildcards (string) –

              Whether validation applies to wildcard domains.

          • HostedZoneId (string) –

            The Route 53 hosted zone ID for DNS validation.

          • ResourceRecord (dict) –

            The DNS resource record to create for domain validation.

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

      • Status (string) –

        The status of the domain validation.

      • FailureDetails (dict) –

        Details about the failure, if the validation failed.

        • Reason (string) –

          The reason for the failure.

        • Message (string) –

          A message describing the failure.

      • CreatedAt (datetime) –

        The time at which the domain validation was created.

      • UpdatedAt (datetime) –

        The time at which the domain validation was last updated.