Table Of Contents

Feedback

User Guide

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

[ aws . ssm ]

list-document-versions

Description

List all versions for a document.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

list-document-versions 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: DocumentVersions

Synopsis

  list-document-versions
--name <value>
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--name (string)

The name of the document about which you want version information.

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

Examples

To view details about existing document versions

This example lists all the versions for a document.

Command:

aws ssm list-document-versions --name "patchWindowsAmi"

Output:

{
      "DocumentVersions": [
              {
                      "IsDefaultVersion": false,
                      "Name": "patchWindowsAmi",
                      "DocumentVersion": "2",
                      "CreatedDate": 1475799950.484
              },
              {
                      "IsDefaultVersion": false,
                      "Name": "patchWindowsAmi",
                      "DocumentVersion": "1",
                      "CreatedDate": 1475799931.064
              }
      ]
}

Output

DocumentVersions -> (list)

The document versions.

(structure)

Version information about the document.

Name -> (string)

The document name.

DocumentVersion -> (string)

The document version.

VersionName -> (string)

The version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.

CreatedDate -> (timestamp)

The date the document was created.

IsDefaultVersion -> (boolean)

An identifier for the default version of the document.

DocumentFormat -> (string)

The document format, either JSON or YAML.

Status -> (string)

The status of the Systems Manager document, such as Creating , Active , Failed , and Deleting .

StatusInformation -> (string)

A message returned by AWS Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket does not exist. Verify that the URL of the S3 bucket is correct."

NextToken -> (string)

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.