You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/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,
}

Instance Attribute Summary collapse

Instance Attribute Details

#dry_runBoolean

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)


14790
14791
14792
14793
14794
14795
14796
14797
14798
14799
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 14790

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

#filtersArray<Types::Filter>

The filters.

  • description - A description of the snapshot.

  • owner-alias - Value from an Amazon-maintained list (amazon | self | all | 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:<key> - 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:



14790
14791
14792
14793
14794
14795
14796
14797
14798
14799
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 14790

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

#max_resultsInteger

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)


14790
14791
14792
14793
14794
14795
14796
14797
14798
14799
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 14790

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

#next_tokenString

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)


14790
14791
14792
14793
14794
14795
14796
14797
14798
14799
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 14790

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

#owner_idsArray<String>

Describes the snapshots owned by these owners.

Returns:

  • (Array<String>)


14790
14791
14792
14793
14794
14795
14796
14797
14798
14799
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 14790

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_idsArray<String>

The IDs of the AWS accounts that can create volumes from the snapshot.

Returns:

  • (Array<String>)


14790
14791
14792
14793
14794
14795
14796
14797
14798
14799
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 14790

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

#snapshot_idsArray<String>

The snapshot IDs.

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

Returns:

  • (Array<String>)


14790
14791
14792
14793
14794
14795
14796
14797
14798
14799
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 14790

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