Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . ec2 . wait ]



Wait until JMESPath query Snapshots[].State returns completed for all elements when polling with describe-snapshots. It will poll every 15 seconds until a successful state has been reached. This will exit with a return code of 255 after 40 failed checks.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

snapshot-completed is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Snapshots


[--filters <value>]
[--owner-ids <value>]
[--restorable-by-user-ids <value>]
[--snapshot-ids <value>]
[--dry-run | --no-dry-run]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]


--filters (list)

The filters.

  • description - A description of the snapshot.
  • encrypted - Indicates whether the snapshot is encrypted (true | false )
  • 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.

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

    "Name": "string",
    "Values": ["string", ...]

--owner-ids (list)

Describes the snapshots owned by these owners.


"string" "string" ...

--restorable-by-user-ids (list)

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


"string" "string" ...

--snapshot-ids (list)

The snapshot IDs.

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


"string" "string" ...

--dry-run | --no-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 .

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


To wait until a snapshot is completed

The following wait snapshot-completed example pauses and resumes running only after it confirms that the specified snapshot is completed. It produces no output.

aws ec2 wait snapshot-completed \
    --snapshot-ids snap-1234567890abcdef0