ApplicationDetail - Kinesis Data Analytics
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

ApplicationDetail

Describes the application, including the application Amazon Resource Name (ARN), status, latest version, and input and output configurations.

Contents

ApplicationARN

The ARN of the application.

Type: String

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

Pattern: arn:.*

Required: Yes

ApplicationConfigurationDescription

Describes details about the application code and starting parameters for a Kinesis Data Analytics application.

Type: ApplicationConfigurationDescription object

Required: No

ApplicationDescription

The description of the application.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No

ApplicationMaintenanceConfigurationDescription

The details of the maintenance configuration for the application.

Type: ApplicationMaintenanceConfigurationDescription object

Required: No

ApplicationMode

To create a Kinesis Data Analytics Studio notebook, you must set the mode to INTERACTIVE. However, for a Kinesis Data Analytics for Apache Flink application, the mode is optional.

Type: String

Valid Values: STREAMING | INTERACTIVE

Required: No

ApplicationName

The name of the application.

Type: String

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

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

Required: Yes

ApplicationStatus

The status of the application.

Type: String

Valid Values: DELETING | STARTING | STOPPING | READY | RUNNING | UPDATING | AUTOSCALING | FORCE_STOPPING | ROLLING_BACK | MAINTENANCE | ROLLED_BACK

Required: Yes

ApplicationVersionId

Provides the current application version. Kinesis Data Analytics updates the ApplicationVersionId each time you update the application.

Type: Long

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

Required: Yes

ApplicationVersionRolledBackFrom

If you reverted the application using RollbackApplication, the application version when RollbackApplication was called.

Type: Long

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

Required: No

ApplicationVersionRolledBackTo

The version to which you want to roll back the application.

Type: Long

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

Required: No

ApplicationVersionUpdatedFrom

The previous application version before the latest application update. RollbackApplication reverts the application to this version.

Type: Long

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

Required: No

CloudWatchLoggingOptionDescriptions

Describes the application Amazon CloudWatch logging options.

Type: Array of CloudWatchLoggingOptionDescription objects

Required: No

ConditionalToken

A value you use to implement strong concurrency for application updates.

Type: String

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

Pattern: [a-zA-Z0-9-_+/=]+

Required: No

CreateTimestamp

The current timestamp when the application was created.

Type: Timestamp

Required: No

LastUpdateTimestamp

The current timestamp when the application was last updated.

Type: Timestamp

Required: No

RuntimeEnvironment

The runtime environment for the application.

Type: String

Valid Values: SQL-1_0 | FLINK-1_6 | FLINK-1_8 | ZEPPELIN-FLINK-1_0 | FLINK-1_11 | FLINK-1_13 | ZEPPELIN-FLINK-2_0

Required: Yes

ServiceExecutionRole

Specifies the IAM role that the application uses to access external resources.

Type: String

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

Pattern: arn:.*

Required: No

See Also

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