Skip to content

describe_cache_report async

describe_cache_report(
    cache_report_arn: CacheReportARN,
    *,
    config_overrides: Optional[AsyncStorageGatewayClientConfig] = None,
) -> DescribeCacheReportOutput

Returns information about the specified cache report, including completion status and generation progress.

Parameters:

  • cache_report_arn (CacheReportARN) –

    The Amazon Resource Name (ARN) of the cache report you want to describe.

Raises:

  • InternalServerError –

    An internal server error has occurred during the request. For more information, see the error and message fields.

  • InvalidGatewayRequestException –

    An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

  • UnknownServiceError –

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

Source code in docs_src/capo_storage_gateway/_services/async_storage_gateway.py
async def describe_cache_report(
    self,
    cache_report_arn: "capo_storage_gateway.types.cache_report_arn.CacheReportARN",
    *,
    config_overrides: Optional[AsyncStorageGatewayClientConfig] = None,
) -> "capo_storage_gateway.types.describe_cache_report_output.DescribeCacheReportOutput":
    """<p>Returns information about the specified cache report, including completion status and generation progress.</p>

    Args:
        cache_report_arn: <p>The Amazon Resource Name (ARN) of the cache report you want to describe.</p>

    Raises:
        capo_storage_gateway.errors.internal_server_error.InternalServerError: <p>An internal server error has occurred during the request. For more information, see the error and message fields.</p>
        capo_storage_gateway.errors.invalid_gateway_request_exception.InvalidGatewayRequestException: <p>An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.</p>
        capo_storage_gateway.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_storage_gateway.types.describe_cache_report_input.DescribeCacheReportInput]",
    ) -> AsyncOperationResponse[
        "capo_storage_gateway.types.describe_cache_report_output.DescribeCacheReportOutput"
    ]:
        import capo_storage_gateway._operations.storage_gateway_20130630.describe_cache_report

        (
            output,
            http_response,
        ) = await capo_storage_gateway._operations.storage_gateway_20130630.describe_cache_report.async_describe_cache_report(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeCacheReport")
    )
    input_: capo_storage_gateway.types.describe_cache_report_input.DescribeCacheReportInput = {
        "cache_report_arn": cache_report_arn
    }

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