describe_cache ¶

def describe_cache(
    self,
    gateway_arn: "capo_storage_gateway.types.gateway_arn.GatewayARN",
    *,
    config_overrides: Optional[StorageGatewayClientConfig] = None,
) -> "capo_storage_gateway.types.describe_cache_output.DescribeCacheOutput":
    """<p>Returns information about the cache of a gateway. This operation is only supported in the cached volume, tape, and file gateway types.</p> <p>The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used.</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.

    Examples:
        To describe cache information
        Returns information about the cache of a gateway.

        >>> client.describe_cache(gateway_arn='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B')
    """

    def _handler(
        req: "OperationRequest[capo_storage_gateway.types.describe_cache_input.DescribeCacheInput]",
    ) -> OperationResponse[
        "capo_storage_gateway.types.describe_cache_output.DescribeCacheOutput"
    ]:
        import capo_storage_gateway._operations.storage_gateway_20130630.describe_cache

        output, http_response = (
            capo_storage_gateway._operations.storage_gateway_20130630.describe_cache.describe_cache(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeCache")
    )
    input_: capo_storage_gateway.types.describe_cache_input.DescribeCacheInput = {
        "gateway_arn": gateway_arn
    }

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