Redshift / Client / describe_custom_domain_associations

describe_custom_domain_associations#

Redshift.Client.describe_custom_domain_associations(**kwargs)#

Contains information about custom domain associations for a cluster.

See also: AWS API Documentation

Request Syntax

response = client.describe_custom_domain_associations(
    CustomDomainName='string',
    CustomDomainCertificateArn='string',
    MaxRecords=123,
    Marker='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.

  • MaxRecords (integer) – The maximum records setting for the associated custom domain.

  • Marker (string) – The marker for the custom domain association.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • Marker (string) –

      The marker for the custom domain association.

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

Exceptions

  • Redshift.Client.exceptions.CustomDomainAssociationNotFoundFault

  • Redshift.Client.exceptions.UnsupportedOperationFault