Struct aws_sdk_ec2::input::DescribeVolumesInput

#[non_exhaustive]
pub struct DescribeVolumesInput {
    pub filters: Option<Vec<Filter>>,
    pub volume_ids: Option<Vec<String>>,
    pub dry_run: Option<bool>,
    pub max_results: Option<i32>,
    pub next_token: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

filters: Option<Vec<Filter>>

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)

volume_ids: Option<Vec<String>>

The volume IDs.

dry_run: Option<bool>

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.

max_results: Option<i32>

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.

next_token: Option<String>

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.

Implementations

impl DescribeVolumesInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<DescribeVolumes, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<DescribeVolumes>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture DescribeVolumesInput

impl DescribeVolumesInput

pub fn filters(&self) -> Option<&[Filter]>

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) -> Option<&[String]>

The volume IDs.

pub fn dry_run(&self) -> Option<bool>

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) -> Option<i32>

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) -> Option<&str>

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 Clone for DescribeVolumesInput

fn clone(&self) -> DescribeVolumesInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeVolumesInput

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

Formats the value using the given formatter.

impl PartialEq<DescribeVolumesInput> for DescribeVolumesInput

fn eq(&self, other: &DescribeVolumesInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &DescribeVolumesInput) -> bool

This method tests for !=.

impl StructuralPartialEq for DescribeVolumesInput