:doc:`RedshiftServerless <../../redshift-serverless>` / Paginator / ListCustomDomainAssociations

****************************
ListCustomDomainAssociations
****************************



.. py:class:: RedshiftServerless.Paginator.ListCustomDomainAssociations

  ::

    
    paginator = client.get_paginator('list_custom_domain_associations')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`RedshiftServerless.Client.list_custom_domain_associations`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/ListCustomDomainAssociations>`_    


    **Request Syntax**
    ::

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

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

      

    
    :type customDomainName: string
    :param customDomainName: 

      The custom domain name associated with the workgroup.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: 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.

          
    