Struct aws_sdk_ec2::input::DescribeSnapshotsInput

#[non_exhaustive]
pub struct DescribeSnapshotsInput {
    pub filters: Option<Vec<Filter>>,
    pub max_results: Option<i32>,
    pub next_token: Option<String>,
    pub owner_ids: Option<Vec<String>>,
    pub restorable_by_user_ids: Option<Vec<String>>,
    pub snapshot_ids: Option<Vec<String>>,
    pub dry_run: Option<bool>,
}

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.

• description - A description of the snapshot.

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

• owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is not the user-configured Amazon Web Services account alias set using the IAM console. We recommend that you use the related parameter instead of this filter.

• owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the related parameter instead of this filter.

• progress - The progress of the snapshot, as a percentage (for example, 80%).

• snapshot-id - The snapshot ID.

• start-time - The time stamp when the snapshot was initiated.

• status - The status of the snapshot (pending | completed | 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 ID of the volume the snapshot is for.

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

max_results: Option<i32>

The maximum number of snapshot results returned by DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots 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 DescribeSnapshots request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned. If this parameter is not used, then DescribeSnapshots returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.

next_token: Option<String>

The NextToken value returned from a previous paginated DescribeSnapshots 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.

owner_ids: Option<Vec<String>>

Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services account IDs, self, and amazon.

restorable_by_user_ids: Option<Vec<String>>

The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.

snapshot_ids: Option<Vec<String>>

The snapshot IDs.

Default: Describes the snapshots for which you have create volume permissions.

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.

Implementations

impl DescribeSnapshotsInput

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

Consumes the builder and constructs an Operation<DescribeSnapshots>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture DescribeSnapshotsInput

impl DescribeSnapshotsInput

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

The filters.

• description - A description of the snapshot.

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

• owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is not the user-configured Amazon Web Services account alias set using the IAM console. We recommend that you use the related parameter instead of this filter.

• owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the related parameter instead of this filter.

• progress - The progress of the snapshot, as a percentage (for example, 80%).

• snapshot-id - The snapshot ID.

• start-time - The time stamp when the snapshot was initiated.

• status - The status of the snapshot (pending | completed | 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 ID of the volume the snapshot is for.

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

pub fn max_results(&self) -> Option<i32>

The maximum number of snapshot results returned by DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots 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 DescribeSnapshots request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned. If this parameter is not used, then DescribeSnapshots returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.

pub fn next_token(&self) -> Option<&str>

The NextToken value returned from a previous paginated DescribeSnapshots 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 owner_ids(&self) -> Option<&[String]>

Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services account IDs, self, and amazon.

pub fn restorable_by_user_ids(&self) -> Option<&[String]>

The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.

pub fn snapshot_ids(&self) -> Option<&[String]>

The snapshot IDs.

Default: Describes the snapshots for which you have create volume permissions.

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.

Trait Implementations

impl Clone for DescribeSnapshotsInput

fn clone(&self) -> DescribeSnapshotsInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeSnapshotsInput

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

Formats the value using the given formatter.

impl PartialEq<DescribeSnapshotsInput> for DescribeSnapshotsInput

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

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

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

This method tests for !=.

impl StructuralPartialEq for DescribeSnapshotsInput