KinesisAnalyticsV2 / Client / list_snapshot_operations

list_snapshot_operations

KinesisAnalyticsV2.Client.list_snapshot_operations(**kwargs)

Lists the operations that were performed on the specified enhanced snapshot, such as CreateSnapshot, ImportSnapshot, and ExportSnapshot. The response includes a summary of each operation.

You can specify only one of the SnapshotOperation or SnapshotOperationStatus filters in a request. If you specify both, InvalidArgumentException is returned.

To get the complete description of a specific operation, use DescribeSnapshotOperation. Snapshot operations are available for 90 days after they are created.

See also: AWS API Documentation

Request Syntax

response = client.list_snapshot_operations(
    SnapshotName='string',
    SnapshotOperation='CreateSnapshot'|'DeleteSnapshot'|'ImportSnapshot'|'ExportSnapshot'|'SystemCreateSnapshot',
    SnapshotOperationStatus='IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'CANCELLED',
    Limit=123,
    NextToken='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.

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

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

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

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.

    • NextToken (string) –

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

Exceptions