Redshift / Paginator / DescribeCustomDomainAssociations

DescribeCustomDomainAssociations

class Redshift.Paginator.DescribeCustomDomainAssociations

paginator = client.get_paginator('describe_custom_domain_associations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Redshift.Client.describe_custom_domain_associations().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• CustomDomainName (string) – The custom domain name for the custom domain association.

• CustomDomainCertificateArn (string) – The certificate Amazon Resource Name (ARN) for the custom domain association.

• 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

{
    'Associations': [
        {
            'CustomDomainCertificateArn': 'string',
            'CustomDomainCertificateExpiryDate': datetime(2015, 1, 1),
            'CertificateAssociations': [
                {
                    'CustomDomainName': 'string',
                    'ClusterIdentifier': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • Associations (list) –

    The associations for the custom domain.

    • (dict) –

      Contains information about the custom domain name association.

      • CustomDomainCertificateArn (string) –

        The Amazon Resource Name (ARN) for the certificate associated with the custom domain.

      • CustomDomainCertificateExpiryDate (datetime) –

        The expiration date for the certificate.

      • CertificateAssociations (list) –

        A list of all associated clusters and domain names tied to a specific certificate.

        • (dict) –

          A cluster ID and custom domain name tied to a specific certificate. These are typically returned in a list.

          • CustomDomainName (string) –

            The custom domain name for the certificate association.

          • ClusterIdentifier (string) –

            The cluster identifier for the certificate association.

  • NextToken (string) –

    A token to resume pagination.