aws_sdk_storagegateway/client/
describe_upload_buffer.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`DescribeUploadBuffer`](crate::operation::describe_upload_buffer::builders::DescribeUploadBufferFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`gateway_arn(impl Into<String>)`](crate::operation::describe_upload_buffer::builders::DescribeUploadBufferFluentBuilder::gateway_arn) / [`set_gateway_arn(Option<String>)`](crate::operation::describe_upload_buffer::builders::DescribeUploadBufferFluentBuilder::set_gateway_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the gateway. Use the <code>ListGateways</code> operation to return a list of gateways for your account and Amazon Web Services Region.</p><br>
7    /// - On success, responds with [`DescribeUploadBufferOutput`](crate::operation::describe_upload_buffer::DescribeUploadBufferOutput) with field(s):
8    ///   - [`gateway_arn(Option<String>)`](crate::operation::describe_upload_buffer::DescribeUploadBufferOutput::gateway_arn): <p>The Amazon Resource Name (ARN) of the gateway. Use the <code>ListGateways</code> operation to return a list of gateways for your account and Amazon Web Services Region.</p>
9    ///   - [`disk_ids(Option<Vec::<String>>)`](crate::operation::describe_upload_buffer::DescribeUploadBufferOutput::disk_ids): <p>An array of the gateway's local disk IDs that are configured as working storage. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as working storage, then the DiskIds array is empty.</p>
10    ///   - [`upload_buffer_used_in_bytes(i64)`](crate::operation::describe_upload_buffer::DescribeUploadBufferOutput::upload_buffer_used_in_bytes): <p>The total number of bytes being used in the gateway's upload buffer.</p>
11    ///   - [`upload_buffer_allocated_in_bytes(i64)`](crate::operation::describe_upload_buffer::DescribeUploadBufferOutput::upload_buffer_allocated_in_bytes): <p>The total number of bytes allocated in the gateway's as upload buffer.</p>
12    /// - On failure, responds with [`SdkError<DescribeUploadBufferError>`](crate::operation::describe_upload_buffer::DescribeUploadBufferError)
13    pub fn describe_upload_buffer(&self) -> crate::operation::describe_upload_buffer::builders::DescribeUploadBufferFluentBuilder {
14        crate::operation::describe_upload_buffer::builders::DescribeUploadBufferFluentBuilder::new(self.handle.clone())
15    }
16}
aws_sdk_storagegateway/client/describe_upload_buffer.rs

aws_sdk_storagegateway/client/
describe_upload_buffer.rs
