describe_working_storage `async` ¶

describe_working_storage(
    gateway_arn: GatewayARN,
    *,
    config_overrides: Optional[AsyncStorageGatewayClientConfig] = None,
) -> DescribeWorkingStorageOutput

Returns information about the working storage of a gateway. This operation is only supported in the stored volumes gateway type. This operation is deprecated in cached volumes API version (20120630). Use DescribeUploadBuffer instead.

Working storage is also referred to as upload buffer. You can also use the DescribeUploadBuffer operation to add upload buffer to a stored volume gateway.

The response includes disk IDs that are configured as working storage, and it includes the amount of working storage allocated and used.

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.

Examples:

To describe the working storage of a gateway [Depreciated] This operation is supported only for the gateway-stored volume architecture. This operation is deprecated in cached-volumes API version (20120630). Use DescribeUploadBuffer instead.

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

Source code in docs_src/capo_storage_gateway/_services/async_storage_gateway.py

async def describe_working_storage(
    self,
    gateway_arn: "capo_storage_gateway.types.gateway_arn.GatewayARN",
    *,
    config_overrides: Optional[AsyncStorageGatewayClientConfig] = None,
) -> "capo_storage_gateway.types.describe_working_storage_output.DescribeWorkingStorageOutput":
    """<p>Returns information about the working storage of a gateway. This operation is only supported in the stored volumes gateway type. This operation is deprecated in cached volumes API version (20120630). Use DescribeUploadBuffer instead.</p> <note> <p>Working storage is also referred to as upload buffer. You can also use the DescribeUploadBuffer operation to add upload buffer to a stored volume gateway.</p> </note> <p>The response includes disk IDs that are configured as working storage, and it includes the amount of working storage 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 the working storage of a gateway [Depreciated]
        This operation is supported only for the gateway-stored volume architecture. This operation is deprecated in cached-volumes API version (20120630). Use DescribeUploadBuffer instead.

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

    async def _handler(
        req: "AsyncOperationRequest[capo_storage_gateway.types.describe_working_storage_input.DescribeWorkingStorageInput]",
    ) -> AsyncOperationResponse[
        "capo_storage_gateway.types.describe_working_storage_output.DescribeWorkingStorageOutput"
    ]:
        import capo_storage_gateway._operations.storage_gateway_20130630.describe_working_storage

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeWorkingStorage")
    )
    input_: capo_storage_gateway.types.describe_working_storage_input.DescribeWorkingStorageInput = {
        "gateway_arn": gateway_arn
    }

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

describe_working_storage async ¶

describe_working_storage `async` ¶