describe_multi_region_clusters ¶

def describe_multi_region_clusters(
    self,
    *,
    config_overrides: Optional[MemoryDBClientConfig] = None,
    multi_region_cluster_name: Optional["capo_memorydb.types.string.String"] = None,
    max_results: Optional[
        "capo_memorydb.types.integer_optional.IntegerOptional"
    ] = None,
    next_token: Optional["capo_memorydb.types.string.String"] = None,
    show_cluster_details: Optional[
        "capo_memorydb.types.boolean_optional.BooleanOptional"
    ] = None,
) -> "capo_memorydb.types.describe_multi_region_clusters_response.DescribeMultiRegionClustersResponse":
    """<p>Returns details about one or more multi-Region clusters.</p>

    Args:
        multi_region_cluster_name: <p>The name of a specific multi-Region cluster to describe.</p>
        max_results: <p>The maximum number of results to return.</p>
        next_token: <p>A token to specify where to start paginating.</p>
        show_cluster_details: <p>Details about the multi-Region cluster.</p>

    Raises:
        capo_memorydb.errors.cluster_not_found_fault.ClusterNotFoundFault: <p>The specified cluster does not exist.</p>
        capo_memorydb.errors.invalid_parameter_combination_exception.InvalidParameterCombinationException: <p>The specified parameter combination is not valid.</p>
        capo_memorydb.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>The specified parameter value is not valid.</p>
        capo_memorydb.errors.multi_region_cluster_not_found_fault.MultiRegionClusterNotFoundFault: <p>The specified multi-Region cluster does not exist.</p>
        capo_memorydb.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_memorydb.types.describe_multi_region_clusters_request.DescribeMultiRegionClustersRequest]",
    ) -> OperationResponse[
        "capo_memorydb.types.describe_multi_region_clusters_response.DescribeMultiRegionClustersResponse"
    ]:
        import capo_memorydb._operations.amazon_memory_db.describe_multi_region_clusters

        output, http_response = (
            capo_memorydb._operations.amazon_memory_db.describe_multi_region_clusters.describe_multi_region_clusters(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeMultiRegionClusters")
    )
    input_: capo_memorydb.types.describe_multi_region_clusters_request.DescribeMultiRegionClustersRequest = {}
    if multi_region_cluster_name is not None:
        input_["multi_region_cluster_name"] = multi_region_cluster_name
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if show_cluster_details is not None:
        input_["show_cluster_details"] = show_cluster_details

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