Struct aws_sdk_storagegateway::client::fluent_builders::ListVolumes

pub struct ListVolumes { /* private fields */ }

Fluent builder constructing a request to ListVolumes.

Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the volume ARNs. If you want additional volume information, use the DescribeStorediSCSIVolumes or the DescribeCachediSCSIVolumes API.

The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can optionally specify the Limit field in the body to limit the number of volumes in the response. If the number of volumes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of volumes. This operation is only supported in the cached volume and stored volume gateway types.

Implementations

impl ListVolumes

pub async fn send(self) -> Result<ListVolumesOutput, SdkError<ListVolumesError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn into_paginator(self) -> ListVolumesPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

pub fn gateway_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

pub fn set_gateway_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

pub fn marker(self, input: impl Into<String>) -> Self

A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the response of a previous List iSCSI Volumes request.

pub fn set_marker(self, input: Option<String>) -> Self

A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the response of a previous List iSCSI Volumes request.

pub fn limit(self, input: i32) -> Self

Specifies that the list of volumes returned be limited to the specified number of items.

pub fn set_limit(self, input: Option<i32>) -> Self

Specifies that the list of volumes returned be limited to the specified number of items.

Trait Implementations

impl Clone for ListVolumes

fn clone(&self) -> ListVolumes

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListVolumes

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.