ListApplicationSnapshotsCommand

Suggest an Edit

Lists information about the current application snapshots.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { KinesisAnalyticsV2Client, ListApplicationSnapshotsCommand } from "@aws-sdk/client-kinesis-analytics-v2"; // ES Modules import
// const { KinesisAnalyticsV2Client, ListApplicationSnapshotsCommand } = require("@aws-sdk/client-kinesis-analytics-v2"); // CommonJS import
const client = new KinesisAnalyticsV2Client(config);
const input = { // ListApplicationSnapshotsRequest
  ApplicationName: "STRING_VALUE", // required
  Limit: Number("int"),
  NextToken: "STRING_VALUE",
};
const command = new ListApplicationSnapshotsCommand(input);
const response = await client.send(command);
// { // ListApplicationSnapshotsResponse
//   SnapshotSummaries: [ // SnapshotSummaries
//     { // SnapshotDetails
//       SnapshotName: "STRING_VALUE", // required
//       SnapshotStatus: "CREATING" || "READY" || "DELETING" || "FAILED", // required
//       ApplicationVersionId: Number("long"), // required
//       SnapshotCreationTimestamp: new Date("TIMESTAMP"),
//       RuntimeEnvironment: "SQL-1_0" || "FLINK-1_6" || "FLINK-1_8" || "ZEPPELIN-FLINK-1_0" || "FLINK-1_11" || "FLINK-1_13" || "ZEPPELIN-FLINK-2_0" || "FLINK-1_15" || "ZEPPELIN-FLINK-3_0" || "FLINK-1_18" || "FLINK-1_19" || "FLINK-1_20",
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListApplicationSnapshotsCommand Input

See ListApplicationSnapshotsCommandInput for more details

Parameter
Type
Description
ApplicationName
Required
string | undefined

The name of an existing application.

Limit
number | undefined

The maximum number of application snapshots to list.

NextToken
string | undefined

Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

ListApplicationSnapshotsCommand Output

See ListApplicationSnapshotsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
NextToken
string | undefined

The token for the next set of results, or null if there are no additional results.

SnapshotSummaries
SnapshotDetails[] | undefined

A collection of objects containing information about the application snapshots.

Throws

Name
Fault
Details
InvalidArgumentException
client

The specified input parameter value is not valid.

UnsupportedOperationException
client

The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.

KinesisAnalyticsV2ServiceException
Base exception class for all service exceptions from KinesisAnalyticsV2 service.