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

DescribeApplicationSnapshot

Returns information about a snapshot of application state data.

Request Syntax

{ "ApplicationName": "string", "SnapshotName": "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

SnapshotName

The identifier of an application snapshot. You can retrieve this value using ListApplicationSnapshots.

Type: String

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

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

Required: Yes

Response Syntax

{ "SnapshotDetails": { "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.

SnapshotDetails

An object containing information about the application snapshot.

Type: SnapshotDetails object

Errors

InvalidArgumentException

The specified input parameter value is not valid.

HTTP Status Code: 400

ResourceNotFoundException

Specified application can't be found.

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: