describe_upload_buffer `async` ¶

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

Returns information about the upload buffer of a gateway. This operation is supported for the stored volume, cached volume, and tape gateway types.

The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space 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 upload buffer of a gateway Returns information about the upload buffer of a gateway including disk IDs and the amount of upload buffer space allocated and used.

>>> await client.describe_upload_buffer(gateway_arn='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B')
To describe upload buffer of gateway
Returns information about the upload buffer of a gateway including disk IDs and the amount of upload buffer space allocated/used.

>>> await client.describe_upload_buffer(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_upload_buffer(
    self,
    gateway_arn: "capo_storage_gateway.types.gateway_arn.GatewayARN",
    *,
    config_overrides: Optional[AsyncStorageGatewayClientConfig] = None,
) -> "capo_storage_gateway.types.describe_upload_buffer_output.DescribeUploadBufferOutput":
    """<p>Returns information about the upload buffer of a gateway. This operation is supported for the stored volume, cached volume, and tape gateway types.</p> <p>The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space 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 upload buffer of a gateway
        Returns information about the upload buffer of a gateway including disk IDs and the amount of upload buffer space allocated and used.

        >>> await client.describe_upload_buffer(gateway_arn='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B')
        To describe upload buffer of gateway
        Returns information about the upload buffer of a gateway including disk IDs and the amount of upload buffer space allocated/used.

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

    async def _handler(
        req: "AsyncOperationRequest[capo_storage_gateway.types.describe_upload_buffer_input.DescribeUploadBufferInput]",
    ) -> AsyncOperationResponse[
        "capo_storage_gateway.types.describe_upload_buffer_output.DescribeUploadBufferOutput"
    ]:
        import capo_storage_gateway._operations.storage_gateway_20130630.describe_upload_buffer

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeUploadBuffer")
    )
    input_: capo_storage_gateway.types.describe_upload_buffer_input.DescribeUploadBufferInput = {
        "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_upload_buffer async ¶

describe_upload_buffer `async` ¶