KinesisAnalyticsV2 / Client / create_snapshot

create_snapshot

KinesisAnalyticsV2.Client.create_snapshot(**kwargs)

Creates an enhanced snapshot of the state data of a running Managed Service for Apache Flink application. The application must be in the RUNNING status, use Apache Flink version 1.20 or later, and use the ENHANCED_SNAPSHOTS snapshot mode.

This operation is asynchronous. The response returns the snapshot ARN with the CREATING status. To check the status of the snapshot, use DescribeSnapshot. To track the progress of the operation, use DescribeSnapshotOperation.

An application can have only one CreateSnapshot operation in progress at a time. For information about limits, see Managed Service for Apache Flink Quotas. For more information about snapshots, see Enhanced Snapshots.

See also: AWS API Documentation

Request Syntax

response = client.create_snapshot(
    ApplicationName='string',
    SnapshotName='string',
    SnapshotDescription='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • ApplicationName (string) –

    [REQUIRED]

    The name of the application.

  • SnapshotName (string) –

    [REQUIRED]

    The name of the enhanced snapshot. The name must be unique among the snapshots in your account and Region. You can’t reuse the name of an existing snapshot, including a snapshot in the FAILED status, until you delete that snapshot. Names that begin with SYSTEMSNAPSHOT are reserved.

  • SnapshotDescription (string) – A summary description of the snapshot.

  • Tags (list) –

    A list of one or more tags to assign to the snapshot. A tag is a key-value pair that identifies a snapshot. For more information, see Using Tagging.

    • (dict) –

      A key-value pair (the value is optional) that you can define and assign to Amazon resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see Using Tagging.

      • Key (string) – [REQUIRED]

        The key of the key-value tag.

      • Value (string) –

        The value of the key-value tag. The value is optional.

Return type:

dict

Returns:

Response Syntax

{
    'SnapshotArn': 'string',
    'SnapshotStatus': 'CREATING'|'READY'|'DELETING'|'FAILED',
    'SnapshotOperationId': 'string',
    'SnapshotOperationStatus': 'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'CANCELLED'
}

Response Structure

  • (dict) –

    • SnapshotArn (string) –

      The ARN of the enhanced snapshot.

    • SnapshotStatus (string) –

      The status of the snapshot. When Managed Service for Apache Flink accepts the request, the status is CREATING.

    • SnapshotOperationId (string) –

      The ID of the snapshot operation. You can use this value with DescribeSnapshotOperation to track the progress of the operation.

    • SnapshotOperationStatus (string) –

      The status of the snapshot operation.

Exceptions