:doc:`RedshiftServerless <../../redshift-serverless>` / Client / list_custom_domain_associations

*******************************
list_custom_domain_associations
*******************************



.. py:method:: RedshiftServerless.Client.list_custom_domain_associations(**kwargs)

  

  Lists custom domain associations for Amazon Redshift Serverless.

  

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


  **Request Syntax**
  ::

    response = client.list_custom_domain_associations(
        customDomainCertificateArn='string',
        customDomainName='string',
        maxResults=123,
        nextToken='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 maxResults: integer
  :param maxResults: 

    An optional parameter that specifies the maximum number of results to return. You can use ``nextToken`` to display the next page of results.

    

  
  :type nextToken: string
  :param nextToken: 

    When ``nextToken`` is returned, there are more results available. The value of ``nextToken`` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

    

  
  
  :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) --* 

        When ``nextToken`` is returned, there are more results available. The value of ``nextToken`` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

        
  
  **Exceptions**
  
  *   :py:class:`RedshiftServerless.Client.exceptions.InternalServerException`

  
  *   :py:class:`RedshiftServerless.Client.exceptions.InvalidPaginationException`

  
  *   :py:class:`RedshiftServerless.Client.exceptions.ValidationException`

  
  *   :py:class:`RedshiftServerless.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`RedshiftServerless.Client.exceptions.ThrottlingException`

  