SSM / Paginator / ListDocumentVersions

ListDocumentVersions

class SSM.Paginator.ListDocumentVersions

paginator = client.get_paginator('list_document_versions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SSM.Client.list_document_versions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Name='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• Name (string) –

  [REQUIRED]

  The name of the document. You can specify an Amazon Resource Name (ARN).

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

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

Return type:

dict

Returns:

Response Syntax

{
    'DocumentVersions': [
        {
            'Name': 'string',
            'DisplayName': 'string',
            'DocumentVersion': 'string',
            'VersionName': 'string',
            'CreatedDate': datetime(2015, 1, 1),
            'IsDefaultVersion': True|False,
            'DocumentFormat': 'YAML'|'JSON'|'TEXT',
            'Status': 'Creating'|'Active'|'Updating'|'Deleting'|'Failed',
            'StatusInformation': 'string',
            'ReviewStatus': 'APPROVED'|'NOT_REVIEWED'|'PENDING'|'REJECTED'
        },
    ],

}

Response Structure

• (dict) –

  • DocumentVersions (list) –

    The document versions.

    • (dict) –

      Version information about the document.

      • Name (string) –

        The document name.

      • DisplayName (string) –

        The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.

      • DocumentVersion (string) –

        The document version.

      • VersionName (string) –

        The version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can’t be changed.

      • CreatedDate (datetime) –

        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 SSM document, such as Creating, Active, Failed, and Deleting.

      • StatusInformation (string) –

        A message returned by Amazon Web Services Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, “The specified S3 bucket doesn’t exist. Verify that the URL of the S3 bucket is correct.”

      • ReviewStatus (string) –

        The current status of the approval review for the latest version of the document.