Struct aws_sdk_ec2::client::fluent_builders::DescribeVolumes

pub struct DescribeVolumes<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Fluent builder constructing a request to DescribeVolumes.

Describes the specified EBS volumes or all of your EBS volumes.

If you are describing a long list of volumes, we recommend that you paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeVolumes request to retrieve the remaining results.

For more information about EBS volumes, see Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide.

Implementations

impl<C, M, R> DescribeVolumes<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<DescribeVolumesOutput, SdkError<DescribeVolumesError>> where
    R::Policy: SmithyRetryPolicy<DescribeVolumesInputOperationOutputAlias, DescribeVolumesOutput, DescribeVolumesError, DescribeVolumesInputOperationRetryAlias>, 

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) -> DescribeVolumesPaginator<C, M, R>

Create a paginator for this request

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

pub fn filters(self, input: Filter) -> Self

Appends an item to Filters.

To override the contents of this collection use set_filters.

The filters.

• attachment.attach-time - The time stamp when the attachment initiated.

• attachment.delete-on-termination - Whether the volume is deleted on instance termination.

• attachment.device - The device name specified in the block device mapping (for example, /dev/sda1).

• attachment.instance-id - The ID of the instance the volume is attached to.

• attachment.status - The attachment state (attaching | attached | detaching).

• availability-zone - The Availability Zone in which the volume was created.

• create-time - The time stamp when the volume was created.

• encrypted - Indicates whether the volume is encrypted (true | false)

• multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach (true | false)

• fast-restored - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore (true | false).

• size - The size of the volume, in GiB.

• snapshot-id - The snapshot from which the volume was created.

• status - The state of the volume (creating | available | in-use | deleting | deleted | error).

• tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

• volume-id - The volume ID.

• volume-type - The Amazon EBS volume type (gp2 | gp3 | io1 | io2 | st1 | sc1| standard)

pub fn set_filters(self, input: Option<Vec<Filter>>) -> Self

The filters.

• attachment.attach-time - The time stamp when the attachment initiated.

• attachment.delete-on-termination - Whether the volume is deleted on instance termination.

• attachment.device - The device name specified in the block device mapping (for example, /dev/sda1).

• attachment.instance-id - The ID of the instance the volume is attached to.

• attachment.status - The attachment state (attaching | attached | detaching).

• availability-zone - The Availability Zone in which the volume was created.

• create-time - The time stamp when the volume was created.

• encrypted - Indicates whether the volume is encrypted (true | false)

• multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach (true | false)

• fast-restored - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore (true | false).

• size - The size of the volume, in GiB.

• snapshot-id - The snapshot from which the volume was created.

• status - The state of the volume (creating | available | in-use | deleting | deleted | error).

• tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

• volume-id - The volume ID.

• volume-type - The Amazon EBS volume type (gp2 | gp3 | io1 | io2 | st1 | sc1| standard)

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

Appends an item to VolumeIds.

To override the contents of this collection use set_volume_ids.

The volume IDs.

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

The volume IDs.

pub fn dry_run(self, input: bool) -> Self

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

pub fn set_dry_run(self, input: Option<bool>) -> Self

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

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

The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes request with the returned NextToken value. This value can be between 5 and 500; if MaxResults is given a value larger than 500, only 500 results are returned. If this parameter is not used, then DescribeVolumes returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

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

The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes request with the returned NextToken value. This value can be between 5 and 500; if MaxResults is given a value larger than 500, only 500 results are returned. If this parameter is not used, then DescribeVolumes returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

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

The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

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

The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for DescribeVolumes<C, M, R>

fn clone(&self) -> DescribeVolumes<C, M, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for DescribeVolumes<C, M, R>

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

Formats the value using the given formatter.