KinesisAnalyticsV2 / Paginator / ListSnapshots

ListSnapshots

class KinesisAnalyticsV2.Paginator.ListSnapshots

paginator = client.get_paginator('list_snapshots')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    SourceApplicationName='string',
    SnapshotInitiator='USER'|'SYSTEM',
    SnapshotInitiatorOperation='CreateSnapshot'|'ImportSnapshot'|'SystemCreateSnapshot',
    SnapshotStatus='CREATING'|'READY'|'DELETING'|'FAILED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• SourceApplicationName (string) – The name of the application.

• SnapshotInitiator (string) – Use this parameter to list only the snapshots with the specified initiator.

• SnapshotInitiatorOperation (string) – Use this parameter to list only the snapshots that were created by the specified operation.

• SnapshotStatus (string) – Use this parameter to list only the snapshots 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

{
    'SnapshotInfoList': [
        {
            'SnapshotName': 'string',
            'SnapshotArn': 'string',
            'SnapshotStatus': 'CREATING'|'READY'|'DELETING'|'FAILED',
            'SnapshotCreationTimestamp': datetime(2015, 1, 1),
            'SnapshotInitiator': 'USER'|'SYSTEM',
            'SnapshotInitiatorOperation': 'CreateSnapshot'|'ImportSnapshot'|'SystemCreateSnapshot',
            'SourceApplicationName': 'string',
            'SnapshotFormat': 'CANONICAL'
        },
    ],

}

Response Structure

• (dict) –

  • SnapshotInfoList (list) –

    A list of SnapshotInfo objects.

    • (dict) –

      Provides summary information about an enhanced snapshot.

      • SnapshotName (string) –

        The name of the enhanced snapshot.

      • SnapshotArn (string) –

        The ARN of the enhanced snapshot.

      • SnapshotStatus (string) –

        The status of the enhanced snapshot.

      • SnapshotCreationTimestamp (datetime) –

        The timestamp that indicates when the snapshot was created.

      • SnapshotInitiator (string) –

        Indicates who initiated the snapshot. USER indicates a snapshot that you created or imported. SYSTEM indicates a snapshot that Managed Service for Apache Flink created.

      • SnapshotInitiatorOperation (string) –

        The operation that created the snapshot.

      • SourceApplicationName (string) –

        The name of the application.

      • SnapshotFormat (string) –

        The format of the snapshot.