KinesisAnalyticsV2 / Paginator / ListSnapshotOperations

ListSnapshotOperations

class KinesisAnalyticsV2.Paginator.ListSnapshotOperations

paginator = client.get_paginator('list_snapshot_operations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from KinesisAnalyticsV2.Client.list_snapshot_operations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    SnapshotName='string',
    SnapshotOperation='CreateSnapshot'|'DeleteSnapshot'|'ImportSnapshot'|'ExportSnapshot'|'SystemCreateSnapshot',
    SnapshotOperationStatus='IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'CANCELLED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• SnapshotName (string) –

  [REQUIRED]

  The name of the enhanced snapshot.

• SnapshotOperation (string) – Use this parameter to list only the operations of the specified type.

• SnapshotOperationStatus (string) – Use this parameter to list only the operations with the specified status.

• 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

{
    'SnapshotOperationInfoList': [
        {
            'SnapshotOperationId': 'string',
            'SnapshotOperation': 'CreateSnapshot'|'DeleteSnapshot'|'ImportSnapshot'|'ExportSnapshot'|'SystemCreateSnapshot',
            'SnapshotOperationStatus': 'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'CANCELLED',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • SnapshotOperationInfoList (list) –

    A list of SnapshotOperationInfo objects.

    • (dict) –

      Provides summary information about an operation that was performed on an enhanced snapshot.

      • SnapshotOperationId (string) –

        The ID of the snapshot operation.

      • SnapshotOperation (string) –

        The type of operation that was performed on the snapshot.

      • SnapshotOperationStatus (string) –

        The status of the snapshot operation.

      • StartTime (datetime) –

        The timestamp that indicates when the operation was created.

      • EndTime (datetime) –

        The timestamp that indicates when the operation finished. This field is present only after the operation completes.