Skip to content

list_custom_domain_associations 

list_custom_domain_associations(
    *,
    config_overrides: Optional[RedshiftServerlessClientConfig] = None,
    next_token: Optional[PaginationToken] = None,
    max_results: Optional[int] = None,
    custom_domain_name: Optional[CustomDomainName] = None,
    custom_domain_certificate_arn: Optional[CustomDomainCertificateArnString] = None,
) -> ListCustomDomainAssociationsResponse

Lists custom domain associations for Amazon Redshift Serverless.

Parameters:

  • next_token (Optional[PaginationToken], default: None ) –

    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.

  • max_results (Optional[int], default: None ) –

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

  • custom_domain_name (Optional[CustomDomainName], default: None ) –

    The custom domain name associated with the workgroup.

  • custom_domain_certificate_arn (Optional[CustomDomainCertificateArnString], default: None ) –

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

Raises:

Source code in docs_src/capo_redshift_serverless/_services/redshift_serverless.py 
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
def list_custom_domain_associations(
    self,
    *,
    config_overrides: Optional[RedshiftServerlessClientConfig] = None,
    next_token: Optional[
        "capo_redshift_serverless.types.pagination_token.PaginationToken"
    ] = None,
    max_results: Optional[int] = None,
    custom_domain_name: Optional[
        "capo_redshift_serverless.types.custom_domain_name.CustomDomainName"
    ] = None,
    custom_domain_certificate_arn: Optional[
        "capo_redshift_serverless.types.custom_domain_certificate_arn_string.CustomDomainCertificateArnString"
    ] = None,
) -> "capo_redshift_serverless.types.list_custom_domain_associations_response.ListCustomDomainAssociationsResponse":
    """<p> Lists custom domain associations for Amazon Redshift Serverless.</p>

    Args:
        next_token: <p>When <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.</p>
        max_results: <p>An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to display the next page of results.</p>
        custom_domain_name: <p>The custom domain name associated with the workgroup.</p>
        custom_domain_certificate_arn: <p>The custom domain name’s certificate Amazon resource name (ARN).</p>

    Raises:
        capo_redshift_serverless.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_redshift_serverless.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_redshift_serverless.errors.invalid_pagination_exception.InvalidPaginationException: <p>The provided pagination token is invalid.</p>
        capo_redshift_serverless.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_redshift_serverless.errors.validation_exception.ValidationException: <p>The input failed to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_redshift_serverless.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_redshift_serverless.types.list_custom_domain_associations_request.ListCustomDomainAssociationsRequest]",
    ) -> OperationResponse[
        "capo_redshift_serverless.types.list_custom_domain_associations_response.ListCustomDomainAssociationsResponse"
    ]:
        import capo_redshift_serverless._operations.redshift_serverless.list_custom_domain_associations

        output, http_response = (
            capo_redshift_serverless._operations.redshift_serverless.list_custom_domain_associations.list_custom_domain_associations(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListCustomDomainAssociations")
    )
    input_: capo_redshift_serverless.types.list_custom_domain_associations_request.ListCustomDomainAssociationsRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    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

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