Skip to content

describe_custom_domain_associations

describe_custom_domain_associations(
    *,
    config_overrides: Optional[RedshiftClientConfig] = None,
    custom_domain_name: Optional[CustomDomainNameString] = None,
    custom_domain_certificate_arn: Optional[CustomDomainCertificateArnString] = None,
    max_records: Optional[IntegerOptional] = None,
    marker: Optional[String] = None,
) -> CustomDomainAssociationsMessage

Contains information about custom domain associations for a cluster.

Parameters:

Raises:

Source code in docs_src/capo_redshift/_services/redshift.py
def describe_custom_domain_associations(
    self,
    *,
    config_overrides: Optional[RedshiftClientConfig] = None,
    custom_domain_name: Optional[
        "capo_redshift.types.custom_domain_name_string.CustomDomainNameString"
    ] = None,
    custom_domain_certificate_arn: Optional[
        "capo_redshift.types.custom_domain_certificate_arn_string.CustomDomainCertificateArnString"
    ] = None,
    max_records: Optional[
        "capo_redshift.types.integer_optional.IntegerOptional"
    ] = None,
    marker: Optional["capo_redshift.types.string.String"] = None,
) -> "capo_redshift.types.custom_domain_associations_message.CustomDomainAssociationsMessage":
    """<p>Contains information about custom domain associations for a cluster.</p>

    Args:
        custom_domain_name: <p>The custom domain name for the custom domain association.</p>
        custom_domain_certificate_arn: <p>The certificate Amazon Resource Name (ARN) for the custom domain association.</p>
        max_records: <p>The maximum records setting for the associated custom domain.</p>
        marker: <p>The marker for the custom domain association.</p>

    Raises:
        capo_redshift.errors.custom_domain_association_not_found_fault.CustomDomainAssociationNotFoundFault: <p>An error occurred. The custom domain name couldn't be found.</p>
        capo_redshift.errors.unsupported_operation_fault.UnsupportedOperationFault: <p>The requested operation isn't supported.</p>
        capo_redshift.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_redshift.types.describe_custom_domain_associations_message.DescribeCustomDomainAssociationsMessage]",
    ) -> OperationResponse[
        "capo_redshift.types.custom_domain_associations_message.CustomDomainAssociationsMessage"
    ]:
        import capo_redshift._operations.redshift_service_version20121201.describe_custom_domain_associations

        output, http_response = (
            capo_redshift._operations.redshift_service_version20121201.describe_custom_domain_associations.describe_custom_domain_associations(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeCustomDomainAssociations")
    )
    input_: capo_redshift.types.describe_custom_domain_associations_message.DescribeCustomDomainAssociationsMessage = {}
    if custom_domain_name is not None:
        input_["custom_domain_name"] = custom_domain_name
    if custom_domain_certificate_arn is not None:
        input_["custom_domain_certificate_arn"] = custom_domain_certificate_arn
    if max_records is not None:
        input_["max_records"] = max_records
    if marker is not None:
        input_["marker"] = marker

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output