For new projects, we recommend that you use the new Managed Service for Apache Flink Studio over Kinesis Data Analytics for SQL Applications. Managed Service for Apache Flink Studio combines ease of use with advanced analytical capabilities, enabling you to build sophisticated stream processing applications in minutes.
ApplicationDetail
Note
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.
Provides a description of the application, including the application Amazon Resource Name (ARN), status, latest version, and input and output configuration.
Contents
- ApplicationARN
-
ARN of the application.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
arn:.*Required: Yes
- ApplicationName
-
Name of the application.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9_.-]+Required: Yes
- ApplicationStatus
-
Status of the application.
Type: String
Valid Values:
DELETING | STARTING | STOPPING | READY | RUNNING | UPDATING | AUTOSCALINGRequired: Yes
- ApplicationVersionId
-
Provides the current application version.
Type: Long
Valid Range: Minimum value of 1. Maximum value of 999999999.
Required: Yes
- ApplicationCode
-
Returns the application code that you provided to perform data analysis on any of the in-application streams in your application.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 102400.
Required: No
- ApplicationDescription
-
Description of the application.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: No
- CloudWatchLoggingOptionDescriptions
-
Describes the CloudWatch log streams that are configured to receive application messages. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Working with Amazon CloudWatch Logs.
Type: Array of CloudWatchLoggingOptionDescription objects
Required: No
- CreateTimestamp
-
Time stamp when the application version was created.
Type: Timestamp
Required: No
- InputDescriptions
-
Describes the application input configuration. For more information, see Configuring Application Input.
Type: Array of InputDescription objects
Required: No
- LastUpdateTimestamp
-
Time stamp when the application was last updated.
Type: Timestamp
Required: No
- OutputDescriptions
-
Describes the application output configuration. For more information, see Configuring Application Output.
Type: Array of OutputDescription objects
Required: No
- ReferenceDataSourceDescriptions
-
Describes reference data sources configured for the application. For more information, see Configuring Application Input.
Type: Array of ReferenceDataSourceDescription objects
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: