describe_cluster `async` ¶

describe_cluster(
    cluster_id: ClusterId,
    *,
    config_overrides: Optional[AsyncSnowballClientConfig] = None,
) -> DescribeClusterResult

Returns information about a specific cluster including shipping information, cluster status, and other important metadata.

Parameters:

cluster_id (ClusterId) –

The automatically generated ID for a cluster.

Raises:

InvalidResourceException –

The specified resource can't be found. Check the information you provided in your last request, and try again.
UnknownServiceError –

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

Source code in docs_src/capo_snowball/_services/async_snowball.py

async def describe_cluster(
    self,
    cluster_id: "capo_snowball.types.cluster_id.ClusterId",
    *,
    config_overrides: Optional[AsyncSnowballClientConfig] = None,
) -> "capo_snowball.types.describe_cluster_result.DescribeClusterResult":
    """<p>Returns information about a specific cluster including shipping information, cluster status, and other important metadata.</p>

    Args:
        cluster_id: <p>The automatically generated ID for a cluster.</p>

    Raises:
        capo_snowball.errors.invalid_resource_exception.InvalidResourceException: <p>The specified resource can't be found. Check the information you provided in your last request, and try again.</p>
        capo_snowball.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_snowball.types.describe_cluster_request.DescribeClusterRequest]",
    ) -> AsyncOperationResponse[
        "capo_snowball.types.describe_cluster_result.DescribeClusterResult"
    ]:
        import capo_snowball._operations.awsie_snowball_job_management_service.describe_cluster

        (
            output,
            http_response,
        ) = await capo_snowball._operations.awsie_snowball_job_management_service.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_snowball.types.describe_cluster_request.DescribeClusterRequest = {
        "cluster_id": cluster_id
    }

    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` ¶