describe_clusters ¶

def describe_clusters(
    self,
    *,
    config_overrides: Optional[DAXClientConfig] = None,
    cluster_names: Optional[
        "capo_dax.types.cluster_name_list.ClusterNameList"
    ] = None,
    max_results: Optional["capo_dax.types.integer_optional.IntegerOptional"] = None,
    next_token: Optional["capo_dax.types.string.String"] = None,
) -> "capo_dax.types.describe_clusters_response.DescribeClustersResponse":
    """<p>Returns information about all provisioned DAX clusters if no cluster identifier is specified, or about a specific DAX cluster if a cluster identifier is supplied.</p> <p>If the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes are successfully provisioned.</p> <p>If the cluster is in the DELETING state, only cluster level information will be displayed.</p> <p>If nodes are currently being added to the DAX cluster, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. When the DAX cluster state is <i>available</i>, the cluster is ready for use.</p> <p>If nodes are currently being removed from the DAX cluster, no endpoint information for the removed nodes is displayed.</p>

    Args:
        cluster_names: <p>The names of the DAX clusters being described.</p>
        max_results: <p>The maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved.</p> <p>The value for <code>MaxResults</code> must be between 20 and 100.</p>
        next_token: <p>An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by <code>MaxResults</code>.</p>

    Raises:
        capo_dax.errors.cluster_not_found_fault.ClusterNotFoundFault: <p>The requested cluster ID does not refer to an existing DAX cluster.</p>
        capo_dax.errors.invalid_parameter_combination_exception.InvalidParameterCombinationException: <p>Two or more incompatible parameters were specified.</p>
        capo_dax.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>The value for a parameter is invalid.</p>
        capo_dax.errors.service_linked_role_not_found_fault.ServiceLinkedRoleNotFoundFault: <p>The specified service linked role (SLR) was not found.</p>
        capo_dax.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_dax.types.describe_clusters_request.DescribeClustersRequest]",
    ) -> OperationResponse[
        "capo_dax.types.describe_clusters_response.DescribeClustersResponse"
    ]:
        import capo_dax._operations.amazon_daxv3.describe_clusters

        output, http_response = (
            capo_dax._operations.amazon_daxv3.describe_clusters.describe_clusters(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeClusters")
    )
    input_: capo_dax.types.describe_clusters_request.DescribeClustersRequest = {}
    if cluster_names is not None:
        input_["cluster_names"] = cluster_names
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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