RedshiftServerless / Client / list_custom_domain_associations

list_custom_domain_associations#

RedshiftServerless.Client.list_custom_domain_associations(**kwargs)#

Lists custom domain associations for Amazon Redshift Serverless.

See also: AWS API Documentation

Request Syntax

response = client.list_custom_domain_associations(
    customDomainCertificateArn='string',
    customDomainName='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

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

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

  • maxResults (integer) – An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

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

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) –

      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

  • RedshiftServerless.Client.exceptions.InternalServerException

  • RedshiftServerless.Client.exceptions.InvalidPaginationException

  • RedshiftServerless.Client.exceptions.ValidationException

  • RedshiftServerless.Client.exceptions.AccessDeniedException

  • RedshiftServerless.Client.exceptions.ThrottlingException