ec2_describe_snapshots {aws.ecx}

Describe Snapshots

Description

Describe Snapshots

Usage

ec2_describe_snapshots(
  Filter = NULL,
  MaxResults = NULL,
  NextToken = NULL,
  Owner = NULL,
  RestorableBy = NULL,
  SnapshotId = NULL,
  DryRun = NULL,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

Arguments

Filter

Named list where the name is the filter name and the value is the filter's value. The value can be a vector or a list object (see below)[optional]

MaxResults

Integer. The maximum number of snapshot results returned by DescribeSnapshots in paginated output.[optional]

NextToken

Characters. The token for the next page of results[optional]

Owner

List. Scopes the results to snapshots with the specified owners.[optional]

RestorableBy

List. The IDs of the AWS accounts that can create volumes from the snapshot.[optional]

SnapshotId

List. The snapshot IDs.[optional]

DryRun

Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional]

simplify

Logical. Whether to simplify the result and handle nextToken in the response[optional]

others

Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]

print_on_error

Logical. Whether to show an error message when a network error occurs.

retry_time

Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent retry_time times but still not be able to get the response, an error will be thrown.

network_timeout

Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.

region

Character. The region of the AWS service.

Value

A list object or a character vector

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 AWS account alias set using the IAM console. We recommend that you use the related parameter instead of this filter.

• owner-id - The AWS 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.

MaxResults

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.

Owner

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

RestorableBy

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

SnapshotId

The snapshot IDs.

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

DryRun

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.