Class: Aws::EC2::Types::DescribeSnapshotsRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass DescribeSnapshotsRequest data as a hash:

{
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  owner_ids: ["String"],
  restorable_by_user_ids: ["String"],
  snapshot_ids: ["String"],
  dry_run: false,
}

Contains the parameters for DescribeSnapshots.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#dry_run ⇒ Boolean

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`.

Returns:

  • (Boolean) 


14698
14699
14700
14701
14702
14703
14704
14705
14706
14707
 
# File 'lib/aws-sdk-ec2/types.rb', line 14698

class DescribeSnapshotsRequest < Struct.new(
  :filters,
  :max_results,
  :next_token,
  :owner_ids,
  :restorable_by_user_ids,
  :snapshot_ids,
  :dry_run)
  include Aws::Structure
end

#filters ⇒ Array<Types::Filter>

One or more filters.

  • ‘description` - A description of the snapshot.

  • ‘owner-alias` - Value from an Amazon-maintained list (`amazon` | `aws-marketplace` | `microsoft`) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console.

  • ‘owner-id` - The ID of the AWS account that owns the snapshot.

  • ‘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`:&lt;key&gt; - 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.

Returns:



14698
14699
14700
14701
14702
14703
14704
14705
14706
14707
 
# File 'lib/aws-sdk-ec2/types.rb', line 14698

class DescribeSnapshotsRequest < Struct.new(
  :filters,
  :max_results,
  :next_token,
  :owner_ids,
  :restorable_by_user_ids,
  :snapshot_ids,
  :dry_run)
  include Aws::Structure
end

#max_results ⇒ Integer

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 1000; if `MaxResults` is given a value larger than 1000, only 1000 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.

Returns:

  • (Integer) 


14698
14699
14700
14701
14702
14703
14704
14705
14706
14707
 
# File 'lib/aws-sdk-ec2/types.rb', line 14698

class DescribeSnapshotsRequest < Struct.new(
  :filters,
  :max_results,
  :next_token,
  :owner_ids,
  :restorable_by_user_ids,
  :snapshot_ids,
  :dry_run)
  include Aws::Structure
end

#next_token ⇒ 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.

Returns:

  • (String) 


14698
14699
14700
14701
14702
14703
14704
14705
14706
14707
 
# File 'lib/aws-sdk-ec2/types.rb', line 14698

class DescribeSnapshotsRequest < Struct.new(
  :filters,
  :max_results,
  :next_token,
  :owner_ids,
  :restorable_by_user_ids,
  :snapshot_ids,
  :dry_run)
  include Aws::Structure
end

#owner_ids ⇒ Array<String>

Returns the snapshots owned by the specified owner. Multiple owners can be specified.

Returns:

  • (Array<String>) 


14698
14699
14700
14701
14702
14703
14704
14705
14706
14707
 
# File 'lib/aws-sdk-ec2/types.rb', line 14698

class DescribeSnapshotsRequest < Struct.new(
  :filters,
  :max_results,
  :next_token,
  :owner_ids,
  :restorable_by_user_ids,
  :snapshot_ids,
  :dry_run)
  include Aws::Structure
end

#restorable_by_user_ids ⇒ Array<String>

One or more AWS accounts IDs that can create volumes from the snapshot.

Returns:

  • (Array<String>) 


14698
14699
14700
14701
14702
14703
14704
14705
14706
14707
 
# File 'lib/aws-sdk-ec2/types.rb', line 14698

class DescribeSnapshotsRequest < Struct.new(
  :filters,
  :max_results,
  :next_token,
  :owner_ids,
  :restorable_by_user_ids,
  :snapshot_ids,
  :dry_run)
  include Aws::Structure
end

#snapshot_ids ⇒ Array<String>

One or more snapshot IDs.

Default: Describes snapshots for which you have launch permissions.

Returns:

  • (Array<String>) 


14698
14699
14700
14701
14702
14703
14704
14705
14706
14707
 
# File 'lib/aws-sdk-ec2/types.rb', line 14698

class DescribeSnapshotsRequest < Struct.new(
  :filters,
  :max_results,
  :next_token,
  :owner_ids,
  :restorable_by_user_ids,
  :snapshot_ids,
  :dry_run)
  include Aws::Structure
end