Amazon Kinesis Analytics
kinesisanalytics (API Version 2018-05-23)

ListApplicationSnapshots

Lists information about the current application snapshots.

Request Syntax

{ "ApplicationName": "string", "Limit": number, "NextToken": "string" }

Request Parameters

The request accepts the following data in JSON format.

ApplicationName

The name of an existing application.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9_.-]+

Required: Yes

Limit

The maximum number of application snapshots to list.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No

NextToken

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Required: No

Response Syntax

{ "NextToken": "string", "SnapshotSummaries": [ { "ApplicationVersionId": number, "SnapshotCreationTimestamp": number, "SnapshotName": "string", "SnapshotStatus": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

SnapshotSummaries

A collection of objects containing information about the application snapshots.

Type: Array of SnapshotDetails objects

Errors

InvalidArgumentException

The specified input parameter value is not valid.

HTTP Status Code: 400

UnsupportedOperationException

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

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: