RedshiftServerless / Paginator / ListCustomDomainAssociations

ListCustomDomainAssociations

class RedshiftServerless.Paginator.ListCustomDomainAssociations

paginator = client.get_paginator('list_custom_domain_associations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from RedshiftServerless.Client.list_custom_domain_associations().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• customDomainCertificateArn (string) – The custom domain name’s certificate Amazon resource name (ARN).

• customDomainName (string) – The custom domain name associated with the workgroup.

• 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',
            'customDomainCertificateExpiryTime': datetime(2015, 1, 1),
            'customDomainName': 'string',
            'workgroupName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • associations (list) –

    A list of Association objects.

    • (dict) –

      An object that represents the custom domain name association.

      • customDomainCertificateArn (string) –

        The custom domain name’s certificate Amazon resource name (ARN).

      • customDomainCertificateExpiryTime (datetime) –

        The expiration time for the certificate.

      • customDomainName (string) –

        The custom domain name associated with the workgroup.

      • workgroupName (string) –

        The name of the workgroup associated with the database.

  • NextToken (string) –

    A token to resume pagination.