describe_cluster `async` ¶

describe_cluster(
    cluster_arn: __string,
    *,
    config_overrides: Optional[AsyncRoute53RecoveryControlConfigClientConfig] = None,
) -> DescribeClusterResponse

Display the details about a cluster. The response includes the cluster name, endpoints, status, and Amazon Resource Name (ARN).

Parameters:

cluster_arn (__string) –

The Amazon Resource Name (ARN) of the cluster.

Raises:

AccessDeniedException –

403 response - You do not have sufficient access to perform this action.
ConflictException –

409 response - ConflictException. You might be using a predefined variable.
InternalServerException –

500 response - InternalServiceError. Temporary service error. Retry the request.
ResourceNotFoundException –

404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
ThrottlingException –

429 response - LimitExceededException or TooManyRequestsException.
ValidationException –

400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_route53_recovery_control_config/_services/async_route53_recovery_control_config.py

async def describe_cluster(
    self,
    cluster_arn: "capo_route53_recovery_control_config.types.__string.__string",
    *,
    config_overrides: Optional[
        AsyncRoute53RecoveryControlConfigClientConfig
    ] = None,
) -> "capo_route53_recovery_control_config.types.describe_cluster_response.DescribeClusterResponse":
    """<p>Display the details about a cluster. The response includes the cluster name, endpoints, status, and Amazon Resource Name (ARN).</p>

    Args:
        cluster_arn: <p>The Amazon Resource Name (ARN) of the cluster.</p>

    Raises:
        capo_route53_recovery_control_config.errors.access_denied_exception.AccessDeniedException: <p>403 response - You do not have sufficient access to perform this action.</p>
        capo_route53_recovery_control_config.errors.conflict_exception.ConflictException: <p>409 response - ConflictException. You might be using a predefined variable.</p>
        capo_route53_recovery_control_config.errors.internal_server_exception.InternalServerException: <p>500 response - InternalServiceError. Temporary service error. Retry the request.</p>
        capo_route53_recovery_control_config.errors.resource_not_found_exception.ResourceNotFoundException: <p>404 response - MalformedQueryString. The query string contains a syntax error or resource not found.</p>
        capo_route53_recovery_control_config.errors.throttling_exception.ThrottlingException: <p>429 response - LimitExceededException or TooManyRequestsException.</p>
        capo_route53_recovery_control_config.errors.validation_exception.ValidationException: <p>400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.</p>
        capo_route53_recovery_control_config.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_route53_recovery_control_config.types.describe_cluster_request.DescribeClusterRequest]",
    ) -> AsyncOperationResponse[
        "capo_route53_recovery_control_config.types.describe_cluster_response.DescribeClusterResponse"
    ]:
        import capo_route53_recovery_control_config._operations.route53_recovery_control_config.describe_cluster

        (
            output,
            http_response,
        ) = await capo_route53_recovery_control_config._operations.route53_recovery_control_config.describe_cluster.async_describe_cluster(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeCluster")
    )
    input_: capo_route53_recovery_control_config.types.describe_cluster_request.DescribeClusterRequest = {
        "cluster_arn": cluster_arn
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

describe_cluster async ¶

describe_cluster `async` ¶