DirectoryService / Paginator / DescribeSnapshots

DescribeSnapshots

class DirectoryService.Paginator.DescribeSnapshots

paginator = client.get_paginator('describe_snapshots')

paginate(**kwargs)

Creates an iterator that will paginate through responses from DirectoryService.Client.describe_snapshots().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DirectoryId='string',
    SnapshotIds=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• DirectoryId (string) – The identifier of the directory for which to retrieve snapshot information.

• SnapshotIds (list) –

  A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the Limit and NextToken members.

  • (string) –

• 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

{
    'Snapshots': [
        {
            'DirectoryId': 'string',
            'SnapshotId': 'string',
            'Type': 'Auto'|'Manual',
            'Name': 'string',
            'Status': 'Creating'|'Completed'|'Failed',
            'StartTime': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  Contains the results of the DescribeSnapshots operation.

  • Snapshots (list) –

    The list of Snapshot objects that were retrieved.

    It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.

    • (dict) –

      Describes a directory snapshot.

      • DirectoryId (string) –

        The directory identifier.

      • SnapshotId (string) –

        The snapshot identifier.

      • Type (string) –

        The snapshot type.

      • Name (string) –

        The descriptive name of the snapshot.

      • Status (string) –

        The snapshot status.

      • StartTime (datetime) –

        The date and time that the snapshot was taken.