KinesisAnalyticsV2 / Client / list_snapshots

list_snapshots

KinesisAnalyticsV2.Client.list_snapshots(**kwargs)

Lists the enhanced snapshots in your account. Snapshots are not scoped to an application. To list the snapshots that were created from a specific application, use the SourceApplicationName parameter.

You can specify only one of the following filters in a request: SourceApplicationName, SnapshotInitiator, SnapshotInitiatorOperation, or SnapshotStatus. If you specify more than one filter, InvalidArgumentException is returned.

The results are sorted in descending order of snapshot creation timestamp. To get detailed information about a specific snapshot, use DescribeSnapshot.

See also: AWS API Documentation

Request Syntax

response = client.list_snapshots(
    SourceApplicationName='string',
    SnapshotInitiator='USER'|'SYSTEM',
    SnapshotInitiatorOperation='CreateSnapshot'|'ImportSnapshot'|'SystemCreateSnapshot',
    SnapshotStatus='CREATING'|'READY'|'DELETING'|'FAILED',
    Limit=123,
    NextToken='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.

  • Limit (integer) – The maximum number of snapshots to list.

  • NextToken (string) – A pagination token that can be used in a subsequent request.

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'
        },
    ],
    'NextToken': 'string'
}

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.

    • NextToken (string) –

      A pagination token that can be used in a subsequent request.

Exceptions