2021/05/05 - Amazon Kinesis Analytics - 1 new 8 updated api methods
Changes Amazon Kinesis Analytics now supports RollbackApplication for Apache Flink applications to revert the application to the previous running version
Reverts the application to the previous running version. You can roll back an application if you suspect it is stuck in a transient status.
You can roll back an application only if it is in the UPDATING or AUTOSCALING status.
When you rollback an application, it loads state data from the last successful snapshot. If the application has no snapshots, Kinesis Data Analytics rejects the rollback request.
This action is not supported for Kinesis Data Analytics for SQL applications.
See also: AWS API Documentation
Request Syntax
client.rollback_application(
ApplicationName='string',
CurrentApplicationVersionId=123
)
string
[REQUIRED]
The name of the application.
integer
[REQUIRED]
The current application version ID. You can retrieve the application version ID using DescribeApplication .
dict
Response Syntax
{
'ApplicationDetail': {
'ApplicationARN': 'string',
'ApplicationDescription': 'string',
'ApplicationName': 'string',
'RuntimeEnvironment': 'SQL-1_0'|'FLINK-1_6'|'FLINK-1_8'|'FLINK-1_11',
'ServiceExecutionRole': 'string',
'ApplicationStatus': 'DELETING'|'STARTING'|'STOPPING'|'READY'|'RUNNING'|'UPDATING'|'AUTOSCALING'|'FORCE_STOPPING'|'MAINTENANCE'|'ROLLING_BACK',
'ApplicationVersionId': 123,
'CreateTimestamp': datetime(2015, 1, 1),
'LastUpdateTimestamp': datetime(2015, 1, 1),
'ApplicationConfigurationDescription': {
'SqlApplicationConfigurationDescription': {
'InputDescriptions': [
{
'InputId': 'string',
'NamePrefix': 'string',
'InAppStreamNames': [
'string',
],
'InputProcessingConfigurationDescription': {
'InputLambdaProcessorDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
}
},
'KinesisStreamsInputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'KinesisFirehoseInputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'InputSchema': {
'RecordFormat': {
'RecordFormatType': 'JSON'|'CSV',
'MappingParameters': {
'JSONMappingParameters': {
'RecordRowPath': 'string'
},
'CSVMappingParameters': {
'RecordRowDelimiter': 'string',
'RecordColumnDelimiter': 'string'
}
}
},
'RecordEncoding': 'string',
'RecordColumns': [
{
'Name': 'string',
'Mapping': 'string',
'SqlType': 'string'
},
]
},
'InputParallelism': {
'Count': 123
},
'InputStartingPositionConfiguration': {
'InputStartingPosition': 'NOW'|'TRIM_HORIZON'|'LAST_STOPPED_POINT'
}
},
],
'OutputDescriptions': [
{
'OutputId': 'string',
'Name': 'string',
'KinesisStreamsOutputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'KinesisFirehoseOutputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'LambdaOutputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'DestinationSchema': {
'RecordFormatType': 'JSON'|'CSV'
}
},
],
'ReferenceDataSourceDescriptions': [
{
'ReferenceId': 'string',
'TableName': 'string',
'S3ReferenceDataSourceDescription': {
'BucketARN': 'string',
'FileKey': 'string',
'ReferenceRoleARN': 'string'
},
'ReferenceSchema': {
'RecordFormat': {
'RecordFormatType': 'JSON'|'CSV',
'MappingParameters': {
'JSONMappingParameters': {
'RecordRowPath': 'string'
},
'CSVMappingParameters': {
'RecordRowDelimiter': 'string',
'RecordColumnDelimiter': 'string'
}
}
},
'RecordEncoding': 'string',
'RecordColumns': [
{
'Name': 'string',
'Mapping': 'string',
'SqlType': 'string'
},
]
}
},
]
},
'ApplicationCodeConfigurationDescription': {
'CodeContentType': 'PLAINTEXT'|'ZIPFILE',
'CodeContentDescription': {
'TextContent': 'string',
'CodeMD5': 'string',
'CodeSize': 123,
'S3ApplicationCodeLocationDescription': {
'BucketARN': 'string',
'FileKey': 'string',
'ObjectVersion': 'string'
}
}
},
'RunConfigurationDescription': {
'ApplicationRestoreConfigurationDescription': {
'ApplicationRestoreType': 'SKIP_RESTORE_FROM_SNAPSHOT'|'RESTORE_FROM_LATEST_SNAPSHOT'|'RESTORE_FROM_CUSTOM_SNAPSHOT',
'SnapshotName': 'string'
},
'FlinkRunConfigurationDescription': {
'AllowNonRestoredState': True|False
}
},
'FlinkApplicationConfigurationDescription': {
'CheckpointConfigurationDescription': {
'ConfigurationType': 'DEFAULT'|'CUSTOM',
'CheckpointingEnabled': True|False,
'CheckpointInterval': 123,
'MinPauseBetweenCheckpoints': 123
},
'MonitoringConfigurationDescription': {
'ConfigurationType': 'DEFAULT'|'CUSTOM',
'MetricsLevel': 'APPLICATION'|'TASK'|'OPERATOR'|'PARALLELISM',
'LogLevel': 'INFO'|'WARN'|'ERROR'|'DEBUG'
},
'ParallelismConfigurationDescription': {
'ConfigurationType': 'DEFAULT'|'CUSTOM',
'Parallelism': 123,
'ParallelismPerKPU': 123,
'CurrentParallelism': 123,
'AutoScalingEnabled': True|False
},
'JobPlanDescription': 'string'
},
'EnvironmentPropertyDescriptions': {
'PropertyGroupDescriptions': [
{
'PropertyGroupId': 'string',
'PropertyMap': {
'string': 'string'
}
},
]
},
'ApplicationSnapshotConfigurationDescription': {
'SnapshotsEnabled': True|False
},
'VpcConfigurationDescriptions': [
{
'VpcConfigurationId': 'string',
'VpcId': 'string',
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
]
},
'CloudWatchLoggingOptionDescriptions': [
{
'CloudWatchLoggingOptionId': 'string',
'LogStreamARN': 'string',
'RoleARN': 'string'
},
],
'ApplicationMaintenanceConfigurationDescription': {
'ApplicationMaintenanceWindowStartTime': 'string',
'ApplicationMaintenanceWindowEndTime': 'string'
},
'ApplicationVersionUpdatedFrom': 123,
'ApplicationVersionRolledBackFrom': 123,
'ConditionalToken': 'string'
}
}
Response Structure
(dict) --
ApplicationDetail (dict) --
Describes the application, including the application Amazon Resource Name (ARN), status, latest version, and input and output configurations.
ApplicationARN (string) --
The ARN of the application.
ApplicationDescription (string) --
The description of the application.
ApplicationName (string) --
The name of the application.
RuntimeEnvironment (string) --
The runtime environment for the application (SQL-1_0 , FLINK-1_6 , FLINK-1_8 , or FLINK-1_11 ).
ServiceExecutionRole (string) --
Specifies the IAM role that the application uses to access external resources.
ApplicationStatus (string) --
The status of the application.
ApplicationVersionId (integer) --
Provides the current application version. Kinesis Data Analytics updates the ApplicationVersionId each time you update the application.
CreateTimestamp (datetime) --
The current timestamp when the application was created.
LastUpdateTimestamp (datetime) --
The current timestamp when the application was last updated.
ApplicationConfigurationDescription (dict) --
Provides details about the application's Java, SQL, or Scala code and starting parameters.
SqlApplicationConfigurationDescription (dict) --
The details about inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.
InputDescriptions (list) --
The array of InputDescription objects describing the input streams used by the application.
(dict) --
Describes the application input configuration for a SQL-based Kinesis Data Analytics application.
InputId (string) --
The input ID that is associated with the application input. This is the ID that Kinesis Data Analytics assigns to each input configuration that you add to your application.
NamePrefix (string) --
The in-application name prefix.
InAppStreamNames (list) --
Returns the in-application stream names that are mapped to the stream source.
(string) --
InputProcessingConfigurationDescription (dict) --
The description of the preprocessor that executes on records in this input before the application's code is run.
InputLambdaProcessorDescription (dict) --
Provides configuration information about the associated InputLambdaProcessorDescription
ResourceARN (string) --
The ARN of the AWS Lambda function that is used to preprocess the records in the stream.
Note
To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda
RoleARN (string) --
The ARN of the IAM role that is used to access the AWS Lambda function.
Note
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
KinesisStreamsInputDescription (dict) --
If a Kinesis data stream is configured as a streaming source, provides the Kinesis data stream's Amazon Resource Name (ARN).
ResourceARN (string) --
The Amazon Resource Name (ARN) of the Kinesis data stream.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
Note
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
KinesisFirehoseInputDescription (dict) --
If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN.
ResourceARN (string) --
The Amazon Resource Name (ARN) of the delivery stream.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics assumes to access the stream.
Note
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
InputSchema (dict) --
Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.
RecordFormat (dict) --
Specifies the format of the records on the streaming source.
RecordFormatType (string) --
The type of record format.
MappingParameters (dict) --
When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.
JSONMappingParameters (dict) --
Provides additional mapping information when JSON is the record format on the streaming source.
RecordRowPath (string) --
The path to the top-level parent that contains the records.
CSVMappingParameters (dict) --
Provides additional mapping information when the record format uses delimiters (for example, CSV).
RecordRowDelimiter (string) --
The row delimiter. For example, in a CSV format, 'n' is the typical row delimiter.
RecordColumnDelimiter (string) --
The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
RecordEncoding (string) --
Specifies the encoding of the records in the streaming source. For example, UTF-8.
RecordColumns (list) --
A list of RecordColumn objects.
(dict) --
For a SQL-based Kinesis Data Analytics application, describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream.
Also used to describe the format of the reference data source.
Name (string) --
The name of the column that is created in the in-application input stream or reference table.
Mapping (string) --
A reference to the data element in the streaming input or the reference data source.
SqlType (string) --
The type of column created in the in-application input stream or reference table.
InputParallelism (dict) --
Describes the configured parallelism (number of in-application streams mapped to the streaming source).
Count (integer) --
The number of in-application streams to create.
InputStartingPositionConfiguration (dict) --
The point at which the application is configured to read from the input stream.
InputStartingPosition (string) --
The starting position on the stream.
NOW - Start reading just after the most recent record in the stream, and start at the request timestamp that the customer issued.
TRIM_HORIZON - Start reading at the last untrimmed record in the stream, which is the oldest record available in the stream. This option is not available for an Amazon Kinesis Data Firehose delivery stream.
LAST_STOPPED_POINT - Resume reading from where the application last stopped reading.
OutputDescriptions (list) --
The array of OutputDescription objects describing the destination streams used by the application.
(dict) --
For a SQL-based Kinesis Data Analytics application, describes the application output configuration, which includes the in-application stream name and the destination where the stream data is written. The destination can be a Kinesis data stream or a Kinesis Data Firehose delivery stream.
OutputId (string) --
A unique identifier for the output configuration.
Name (string) --
The name of the in-application stream that is configured as output.
KinesisStreamsOutputDescription (dict) --
Describes the Kinesis data stream that is configured as the destination where output is written.
ResourceARN (string) --
The Amazon Resource Name (ARN) of the Kinesis data stream.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
Note
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
KinesisFirehoseOutputDescription (dict) --
Describes the Kinesis Data Firehose delivery stream that is configured as the destination where output is written.
ResourceARN (string) --
The Amazon Resource Name (ARN) of the delivery stream.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
Note
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
LambdaOutputDescription (dict) --
Describes the Lambda function that is configured as the destination where output is written.
ResourceARN (string) --
The Amazon Resource Name (ARN) of the destination Lambda function.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to write to the destination function.
Note
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
DestinationSchema (dict) --
The data format used for writing data to the destination.
RecordFormatType (string) --
Specifies the format of the records on the output stream.
ReferenceDataSourceDescriptions (list) --
The array of ReferenceDataSourceDescription objects describing the reference data sources used by the application.
(dict) --
For a SQL-based Kinesis Data Analytics application, describes the reference data source configured for an application.
ReferenceId (string) --
The ID of the reference data source. This is the ID that Kinesis Data Analytics assigns when you add the reference data source to your application using the CreateApplication or UpdateApplication operation.
TableName (string) --
The in-application table name created by the specific reference data source configuration.
S3ReferenceDataSourceDescription (dict) --
Provides the Amazon S3 bucket name, the object key name that contains the reference data.
BucketARN (string) --
The Amazon Resource Name (ARN) of the S3 bucket.
FileKey (string) --
Amazon S3 object key name.
ReferenceRoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf to populate the in-application reference table.
Note
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
ReferenceSchema (dict) --
Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.
RecordFormat (dict) --
Specifies the format of the records on the streaming source.
RecordFormatType (string) --
The type of record format.
MappingParameters (dict) --
When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.
JSONMappingParameters (dict) --
Provides additional mapping information when JSON is the record format on the streaming source.
RecordRowPath (string) --
The path to the top-level parent that contains the records.
CSVMappingParameters (dict) --
Provides additional mapping information when the record format uses delimiters (for example, CSV).
RecordRowDelimiter (string) --
The row delimiter. For example, in a CSV format, 'n' is the typical row delimiter.
RecordColumnDelimiter (string) --
The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
RecordEncoding (string) --
Specifies the encoding of the records in the streaming source. For example, UTF-8.
RecordColumns (list) --
A list of RecordColumn objects.
(dict) --
For a SQL-based Kinesis Data Analytics application, describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream.
Also used to describe the format of the reference data source.
Name (string) --
The name of the column that is created in the in-application input stream or reference table.
Mapping (string) --
A reference to the data element in the streaming input or the reference data source.
SqlType (string) --
The type of column created in the in-application input stream or reference table.
ApplicationCodeConfigurationDescription (dict) --
The details about the application code for a Flink-based Kinesis Data Analytics application.
CodeContentType (string) --
Specifies whether the code content is in text or zip format.
CodeContentDescription (dict) --
Describes details about the location and format of the application code.
TextContent (string) --
The text-format code
CodeMD5 (string) --
The checksum that can be used to validate zip-format code.
CodeSize (integer) --
The size in bytes of the application code. Can be used to validate zip-format code.
S3ApplicationCodeLocationDescription (dict) --
The S3 bucket Amazon Resource Name (ARN), file key, and object version of the application code stored in Amazon S3.
BucketARN (string) --
The Amazon Resource Name (ARN) for the S3 bucket containing the application code.
FileKey (string) --
The file key for the object containing the application code.
ObjectVersion (string) --
The version of the object containing the application code.
RunConfigurationDescription (dict) --
The details about the starting properties for a Kinesis Data Analytics application.
ApplicationRestoreConfigurationDescription (dict) --
Describes the restore behavior of a restarting application.
ApplicationRestoreType (string) --
Specifies how the application should be restored.
SnapshotName (string) --
The identifier of an existing snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType .
FlinkRunConfigurationDescription (dict) --
Describes the starting parameters for a Flink-based Kinesis Data Analytics application.
AllowNonRestoredState (boolean) --
When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program. This will happen if the program is updated between snapshots to remove stateful parameters, and state data in the snapshot no longer corresponds to valid application data. For more information, see Allowing Non-Restored State in the Apache Flink documentation .
Note
This value defaults to false . If you update your application without specifying this parameter, AllowNonRestoredState will be set to false , even if it was previously set to true .
FlinkApplicationConfigurationDescription (dict) --
The details about a Flink-based Kinesis Data Analytics application.
CheckpointConfigurationDescription (dict) --
Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance.
ConfigurationType (string) --
Describes whether the application uses the default checkpointing behavior in Kinesis Data Analytics.
Note
If this value is set to DEFAULT , the application will use the following values, even if they are set to other values using APIs or application code:
CheckpointingEnabled: true
CheckpointInterval: 60000
MinPauseBetweenCheckpoints: 5000
CheckpointingEnabled (boolean) --
Describes whether checkpointing is enabled for a Flink-based Kinesis Data Analytics application.
Note
If CheckpointConfiguration.ConfigurationType is DEFAULT , the application will use a CheckpointingEnabled value of true , even if this value is set to another value using this API or in application code.
CheckpointInterval (integer) --
Describes the interval in milliseconds between checkpoint operations.
Note
If CheckpointConfiguration.ConfigurationType is DEFAULT , the application will use a CheckpointInterval value of 60000, even if this value is set to another value using this API or in application code.
MinPauseBetweenCheckpoints (integer) --
Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.
Note
If CheckpointConfiguration.ConfigurationType is DEFAULT , the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this API or in application code.
MonitoringConfigurationDescription (dict) --
Describes configuration parameters for Amazon CloudWatch logging for an application.
ConfigurationType (string) --
Describes whether to use the default CloudWatch logging configuration for an application.
MetricsLevel (string) --
Describes the granularity of the CloudWatch Logs for an application.
LogLevel (string) --
Describes the verbosity of the CloudWatch Logs for an application.
ParallelismConfigurationDescription (dict) --
Describes parameters for how an application executes multiple tasks simultaneously.
ConfigurationType (string) --
Describes whether the application uses the default parallelism for the Kinesis Data Analytics service.
Parallelism (integer) --
Describes the initial number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, then Kinesis Data Analytics can increase the CurrentParallelism value in response to application load. The service can increase CurrentParallelism up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.
ParallelismPerKPU (integer) --
Describes the number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application.
CurrentParallelism (integer) --
Describes the current number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, Kinesis Data Analytics can increase this value in response to application load. The service can increase this value up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.
AutoScalingEnabled (boolean) --
Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.
JobPlanDescription (string) --
The job plan for an application. For more information about the job plan, see Jobs and Scheduling in the Apache Flink Documentation . To retrieve the job plan for the application, use the DescribeApplicationRequest$IncludeAdditionalDetails parameter of the DescribeApplication operation.
EnvironmentPropertyDescriptions (dict) --
Describes execution properties for a Flink-based Kinesis Data Analytics application.
PropertyGroupDescriptions (list) --
Describes the execution property groups.
(dict) --
Property key-value pairs passed into a Flink-based Kinesis Data Analytics application.
PropertyGroupId (string) --
Describes the key of an application execution property key-value pair.
PropertyMap (dict) --
Describes the value of an application execution property key-value pair.
(string) --
(string) --
ApplicationSnapshotConfigurationDescription (dict) --
Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.
SnapshotsEnabled (boolean) --
Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.
VpcConfigurationDescriptions (list) --
The array of descriptions of VPC configurations available to the application.
(dict) --
Describes the parameters of a VPC used by the application.
VpcConfigurationId (string) --
The ID of the VPC configuration.
VpcId (string) --
The ID of the associated VPC.
SubnetIds (list) --
The array of Subnet IDs used by the VPC configuration.
(string) --
SecurityGroupIds (list) --
The array of SecurityGroup IDs used by the VPC configuration.
(string) --
CloudWatchLoggingOptionDescriptions (list) --
Describes the application Amazon CloudWatch logging options.
(dict) --
Describes the Amazon CloudWatch logging option.
CloudWatchLoggingOptionId (string) --
The ID of the CloudWatch logging option description.
LogStreamARN (string) --
The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.
RoleARN (string) --
The IAM ARN of the role to use to send application messages.
Note
Provided for backward compatibility. Applications created with the current API version have an application-level service execution role rather than a resource-level role.
ApplicationMaintenanceConfigurationDescription (dict) --
Describes the time window for automatic application maintenance.
ApplicationMaintenanceWindowStartTime (string) --
The start time for the automatic maintenance window.
ApplicationMaintenanceWindowEndTime (string) --
The end time for the automatic maintenance window.
ApplicationVersionUpdatedFrom (integer) --
The previous application version before the latest application update. RollbackApplication reverts the application to this version.
ApplicationVersionRolledBackFrom (integer) --
If you reverted the application using RollbackApplication , the application version when RollbackApplication was called.
ConditionalToken (string) --
A value you use to implement strong concurrency for application updates.
{'ConditionalToken': 'string'}
Adds an Amazon CloudWatch log stream to monitor application configuration errors.
See also: AWS API Documentation
Request Syntax
client.add_application_cloud_watch_logging_option(
ApplicationName='string',
CurrentApplicationVersionId=123,
CloudWatchLoggingOption={
'LogStreamARN': 'string'
},
ConditionalToken='string'
)
string
[REQUIRED]
The Kinesis Data Analytics application name.
integer
The version ID of the Kinesis Data Analytics application. You must provide the ApplicationVersionID or the ConditionalToken .You can retrieve the application version ID using DescribeApplication .
dict
[REQUIRED]
Provides the Amazon CloudWatch log stream Amazon Resource Name (ARN).
LogStreamARN (string) -- [REQUIRED]
The ARN of the CloudWatch log to receive application messages.
string
A value you use to implement strong concurrency for application updates. You must provide the ApplicationVersionID or the ConditionalToken . You get the application's current ConditionalToken using DescribeApplication .
dict
Response Syntax
{
'ApplicationARN': 'string',
'ApplicationVersionId': 123,
'CloudWatchLoggingOptionDescriptions': [
{
'CloudWatchLoggingOptionId': 'string',
'LogStreamARN': 'string',
'RoleARN': 'string'
},
]
}
Response Structure
(dict) --
ApplicationARN (string) --
The application's ARN.
ApplicationVersionId (integer) --
The new version ID of the Kinesis Data Analytics application. Kinesis Data Analytics updates the ApplicationVersionId each time you change the CloudWatch logging options.
CloudWatchLoggingOptionDescriptions (list) --
The descriptions of the current CloudWatch logging options for the Kinesis Data Analytics application.
(dict) --
Describes the Amazon CloudWatch logging option.
CloudWatchLoggingOptionId (string) --
The ID of the CloudWatch logging option description.
LogStreamARN (string) --
The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.
RoleARN (string) --
The IAM ARN of the role to use to send application messages.
Note
Provided for backward compatibility. Applications created with the current API version have an application-level service execution role rather than a resource-level role.
{'ConditionalToken': 'string'}
Adds a Virtual Private Cloud (VPC) configuration to the application. Applications can use VPCs to store and access resources securely.
Note the following about VPC configurations for Kinesis Data Analytics applications:
VPC configurations are not supported for SQL applications.
When a VPC is added to a Kinesis Data Analytics application, the application can no longer be accessed from the Internet directly. To enable Internet access to the application, add an Internet gateway to your VPC.
See also: AWS API Documentation
Request Syntax
client.add_application_vpc_configuration(
ApplicationName='string',
CurrentApplicationVersionId=123,
VpcConfiguration={
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
ConditionalToken='string'
)
string
[REQUIRED]
The name of an existing application.
integer
The version of the application to which you want to add the VPC configuration. You must provide the ApplicationVersionID or the ConditionalToken . You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.
dict
[REQUIRED]
Description of the VPC to add to the application.
SubnetIds (list) -- [REQUIRED]
The array of Subnet IDs used by the VPC configuration.
(string) --
SecurityGroupIds (list) -- [REQUIRED]
The array of SecurityGroup IDs used by the VPC configuration.
(string) --
string
A value you use to implement strong concurrency for application updates. You must provide the ApplicationVersionID or the ConditionalToken . You get the application's current ConditionalToken using DescribeApplication .
dict
Response Syntax
{
'ApplicationARN': 'string',
'ApplicationVersionId': 123,
'VpcConfigurationDescription': {
'VpcConfigurationId': 'string',
'VpcId': 'string',
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
}
}
Response Structure
(dict) --
ApplicationARN (string) --
The ARN of the application.
ApplicationVersionId (integer) --
Provides the current application version. Kinesis Data Analytics updates the ApplicationVersionId each time you update the application.
VpcConfigurationDescription (dict) --
The parameters of the new VPC configuration.
VpcConfigurationId (string) --
The ID of the VPC configuration.
VpcId (string) --
The ID of the associated VPC.
SubnetIds (list) --
The array of Subnet IDs used by the VPC configuration.
(string) --
SecurityGroupIds (list) --
The array of SecurityGroup IDs used by the VPC configuration.
(string) --
{'ApplicationDetail': {'ApplicationStatus': {'ROLLING_BACK'},
'ApplicationVersionRolledBackFrom': 'long',
'ApplicationVersionUpdatedFrom': 'long',
'ConditionalToken': 'string'}}
Creates a Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see Creating an Application .
See also: AWS API Documentation
Request Syntax
client.create_application(
ApplicationName='string',
ApplicationDescription='string',
RuntimeEnvironment='SQL-1_0'|'FLINK-1_6'|'FLINK-1_8'|'FLINK-1_11',
ServiceExecutionRole='string',
ApplicationConfiguration={
'SqlApplicationConfiguration': {
'Inputs': [
{
'NamePrefix': 'string',
'InputProcessingConfiguration': {
'InputLambdaProcessor': {
'ResourceARN': 'string'
}
},
'KinesisStreamsInput': {
'ResourceARN': 'string'
},
'KinesisFirehoseInput': {
'ResourceARN': 'string'
},
'InputParallelism': {
'Count': 123
},
'InputSchema': {
'RecordFormat': {
'RecordFormatType': 'JSON'|'CSV',
'MappingParameters': {
'JSONMappingParameters': {
'RecordRowPath': 'string'
},
'CSVMappingParameters': {
'RecordRowDelimiter': 'string',
'RecordColumnDelimiter': 'string'
}
}
},
'RecordEncoding': 'string',
'RecordColumns': [
{
'Name': 'string',
'Mapping': 'string',
'SqlType': 'string'
},
]
}
},
],
'Outputs': [
{
'Name': 'string',
'KinesisStreamsOutput': {
'ResourceARN': 'string'
},
'KinesisFirehoseOutput': {
'ResourceARN': 'string'
},
'LambdaOutput': {
'ResourceARN': 'string'
},
'DestinationSchema': {
'RecordFormatType': 'JSON'|'CSV'
}
},
],
'ReferenceDataSources': [
{
'TableName': 'string',
'S3ReferenceDataSource': {
'BucketARN': 'string',
'FileKey': 'string'
},
'ReferenceSchema': {
'RecordFormat': {
'RecordFormatType': 'JSON'|'CSV',
'MappingParameters': {
'JSONMappingParameters': {
'RecordRowPath': 'string'
},
'CSVMappingParameters': {
'RecordRowDelimiter': 'string',
'RecordColumnDelimiter': 'string'
}
}
},
'RecordEncoding': 'string',
'RecordColumns': [
{
'Name': 'string',
'Mapping': 'string',
'SqlType': 'string'
},
]
}
},
]
},
'FlinkApplicationConfiguration': {
'CheckpointConfiguration': {
'ConfigurationType': 'DEFAULT'|'CUSTOM',
'CheckpointingEnabled': True|False,
'CheckpointInterval': 123,
'MinPauseBetweenCheckpoints': 123
},
'MonitoringConfiguration': {
'ConfigurationType': 'DEFAULT'|'CUSTOM',
'MetricsLevel': 'APPLICATION'|'TASK'|'OPERATOR'|'PARALLELISM',
'LogLevel': 'INFO'|'WARN'|'ERROR'|'DEBUG'
},
'ParallelismConfiguration': {
'ConfigurationType': 'DEFAULT'|'CUSTOM',
'Parallelism': 123,
'ParallelismPerKPU': 123,
'AutoScalingEnabled': True|False
}
},
'EnvironmentProperties': {
'PropertyGroups': [
{
'PropertyGroupId': 'string',
'PropertyMap': {
'string': 'string'
}
},
]
},
'ApplicationCodeConfiguration': {
'CodeContent': {
'TextContent': 'string',
'ZipFileContent': b'bytes',
'S3ContentLocation': {
'BucketARN': 'string',
'FileKey': 'string',
'ObjectVersion': 'string'
}
},
'CodeContentType': 'PLAINTEXT'|'ZIPFILE'
},
'ApplicationSnapshotConfiguration': {
'SnapshotsEnabled': True|False
},
'VpcConfigurations': [
{
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
]
},
CloudWatchLoggingOptions=[
{
'LogStreamARN': 'string'
},
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The name of your application (for example, sample-app ).
string
A summary description of the application.
string
[REQUIRED]
The runtime environment for the application (SQL-1_0 , FLINK-1_6 , FLINK-1_8 , or FLINK-1_11 ).
string
[REQUIRED]
The IAM role used by the application to access Kinesis data streams, Kinesis Data Firehose delivery streams, Amazon S3 objects, and other external resources.
dict
Use this parameter to configure the application.
SqlApplicationConfiguration (dict) --
The creation and update parameters for a SQL-based Kinesis Data Analytics application.
Inputs (list) --
The array of Input objects describing the input streams used by the application.
(dict) --
When you configure the application input for a SQL-based Kinesis Data Analytics application, you specify the streaming source, the in-application stream name that is created, and the mapping between the two.
NamePrefix (string) -- [REQUIRED]
The name prefix to use when creating an in-application stream. Suppose that you specify a prefix "MyInApplicationStream ." Kinesis Data Analytics then creates one or more (as per the InputParallelism count you specified) in-application streams with the names "MyInApplicationStream_001 ," "MyInApplicationStream_002 ," and so on.
InputProcessingConfiguration (dict) --
The InputProcessingConfiguration for the input. An input processor transforms records as they are received from the stream, before the application's SQL code executes. Currently, the only input processing configuration available is InputLambdaProcessor .
InputLambdaProcessor (dict) -- [REQUIRED]
The InputLambdaProcessor that is used to preprocess the records in the stream before being processed by your application code.
ResourceARN (string) -- [REQUIRED]
The ARN of the AWS Lambda function that operates on records in the stream.
Note
To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda
KinesisStreamsInput (dict) --
If the streaming source is an Amazon Kinesis data stream, identifies the stream's Amazon Resource Name (ARN).
ResourceARN (string) -- [REQUIRED]
The ARN of the input Kinesis data stream to read.
KinesisFirehoseInput (dict) --
If the streaming source is an Amazon Kinesis Data Firehose delivery stream, identifies the delivery stream's ARN.
ResourceARN (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the delivery stream.
InputParallelism (dict) --
Describes the number of in-application streams to create.
Count (integer) --
The number of in-application streams to create.
InputSchema (dict) -- [REQUIRED]
Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.
Also used to describe the format of the reference data source.
RecordFormat (dict) -- [REQUIRED]
Specifies the format of the records on the streaming source.
RecordFormatType (string) -- [REQUIRED]
The type of record format.
MappingParameters (dict) --
When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.
JSONMappingParameters (dict) --
Provides additional mapping information when JSON is the record format on the streaming source.
RecordRowPath (string) -- [REQUIRED]
The path to the top-level parent that contains the records.
CSVMappingParameters (dict) --
Provides additional mapping information when the record format uses delimiters (for example, CSV).
RecordRowDelimiter (string) -- [REQUIRED]
The row delimiter. For example, in a CSV format, 'n' is the typical row delimiter.
RecordColumnDelimiter (string) -- [REQUIRED]
The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
RecordEncoding (string) --
Specifies the encoding of the records in the streaming source. For example, UTF-8.
RecordColumns (list) -- [REQUIRED]
A list of RecordColumn objects.
(dict) --
For a SQL-based Kinesis Data Analytics application, describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream.
Also used to describe the format of the reference data source.
Name (string) -- [REQUIRED]
The name of the column that is created in the in-application input stream or reference table.
Mapping (string) --
A reference to the data element in the streaming input or the reference data source.
SqlType (string) -- [REQUIRED]
The type of column created in the in-application input stream or reference table.
Outputs (list) --
The array of Output objects describing the destination streams used by the application.
(dict) --
Describes a SQL-based Kinesis Data Analytics application's output configuration, in which you identify an in-application stream and a destination where you want the in-application stream data to be written. The destination can be a Kinesis data stream or a Kinesis Data Firehose delivery stream.
Name (string) -- [REQUIRED]
The name of the in-application stream.
KinesisStreamsOutput (dict) --
Identifies a Kinesis data stream as the destination.
ResourceARN (string) -- [REQUIRED]
The ARN of the destination Kinesis data stream to write to.
KinesisFirehoseOutput (dict) --
Identifies a Kinesis Data Firehose delivery stream as the destination.
ResourceARN (string) -- [REQUIRED]
The ARN of the destination delivery stream to write to.
LambdaOutput (dict) --
Identifies an AWS Lambda function as the destination.
ResourceARN (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the destination Lambda function to write to.
Note
To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda
DestinationSchema (dict) -- [REQUIRED]
Describes the data format when records are written to the destination.
RecordFormatType (string) -- [REQUIRED]
Specifies the format of the records on the output stream.
ReferenceDataSources (list) --
The array of ReferenceDataSource objects describing the reference data sources used by the application.
(dict) --
For a SQL-based Kinesis Data Analytics application, describes the reference data source by providing the source information (Amazon S3 bucket name and object key name), the resulting in-application table name that is created, and the necessary schema to map the data elements in the Amazon S3 object to the in-application table.
TableName (string) -- [REQUIRED]
The name of the in-application table to create.
S3ReferenceDataSource (dict) --
Identifies the S3 bucket and object that contains the reference data. A Kinesis Data Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application.
BucketARN (string) --
The Amazon Resource Name (ARN) of the S3 bucket.
FileKey (string) --
The object key name containing the reference data.
ReferenceSchema (dict) -- [REQUIRED]
Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.
RecordFormat (dict) -- [REQUIRED]
Specifies the format of the records on the streaming source.
RecordFormatType (string) -- [REQUIRED]
The type of record format.
MappingParameters (dict) --
When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.
JSONMappingParameters (dict) --
Provides additional mapping information when JSON is the record format on the streaming source.
RecordRowPath (string) -- [REQUIRED]
The path to the top-level parent that contains the records.
CSVMappingParameters (dict) --
Provides additional mapping information when the record format uses delimiters (for example, CSV).
RecordRowDelimiter (string) -- [REQUIRED]
The row delimiter. For example, in a CSV format, 'n' is the typical row delimiter.
RecordColumnDelimiter (string) -- [REQUIRED]
The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
RecordEncoding (string) --
Specifies the encoding of the records in the streaming source. For example, UTF-8.
RecordColumns (list) -- [REQUIRED]
A list of RecordColumn objects.
(dict) --
For a SQL-based Kinesis Data Analytics application, describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream.
Also used to describe the format of the reference data source.
Name (string) -- [REQUIRED]
The name of the column that is created in the in-application input stream or reference table.
Mapping (string) --
A reference to the data element in the streaming input or the reference data source.
SqlType (string) -- [REQUIRED]
The type of column created in the in-application input stream or reference table.
FlinkApplicationConfiguration (dict) --
The creation and update parameters for a Flink-based Kinesis Data Analytics application.
CheckpointConfiguration (dict) --
Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance in the Apache Flink Documentation .
ConfigurationType (string) -- [REQUIRED]
Describes whether the application uses Kinesis Data Analytics' default checkpointing behavior. You must set this property to CUSTOM in order to set the CheckpointingEnabled , CheckpointInterval , or MinPauseBetweenCheckpoints parameters.
Note
If this value is set to DEFAULT , the application will use the following values, even if they are set to other values using APIs or application code:
CheckpointingEnabled: true
CheckpointInterval: 60000
MinPauseBetweenCheckpoints: 5000
CheckpointingEnabled (boolean) --
Describes whether checkpointing is enabled for a Flink-based Kinesis Data Analytics application.
Note
If CheckpointConfiguration.ConfigurationType is DEFAULT , the application will use a CheckpointingEnabled value of true , even if this value is set to another value using this API or in application code.
CheckpointInterval (integer) --
Describes the interval in milliseconds between checkpoint operations.
Note
If CheckpointConfiguration.ConfigurationType is DEFAULT , the application will use a CheckpointInterval value of 60000, even if this value is set to another value using this API or in application code.
MinPauseBetweenCheckpoints (integer) --
Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. If a checkpoint operation takes longer than the CheckpointInterval , the application otherwise performs continual checkpoint operations. For more information, see Tuning Checkpointing in the Apache Flink Documentation .
Note
If CheckpointConfiguration.ConfigurationType is DEFAULT , the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this API or in application code.
MonitoringConfiguration (dict) --
Describes configuration parameters for Amazon CloudWatch logging for an application.
ConfigurationType (string) -- [REQUIRED]
Describes whether to use the default CloudWatch logging configuration for an application. You must set this property to CUSTOM in order to set the LogLevel or MetricsLevel parameters.
MetricsLevel (string) --
Describes the granularity of the CloudWatch Logs for an application. The Parallelism level is not recommended for applications with a Parallelism over 64 due to excessive costs.
LogLevel (string) --
Describes the verbosity of the CloudWatch Logs for an application.
ParallelismConfiguration (dict) --
Describes parameters for how an application executes multiple tasks simultaneously.
ConfigurationType (string) -- [REQUIRED]
Describes whether the application uses the default parallelism for the Kinesis Data Analytics service. You must set this property to CUSTOM in order to change your application's AutoScalingEnabled , Parallelism , or ParallelismPerKPU properties.
Parallelism (integer) --
Describes the initial number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, Kinesis Data Analytics increases the CurrentParallelism value in response to application load. The service can increase the CurrentParallelism value up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.
ParallelismPerKPU (integer) --
Describes the number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application. For more information about KPUs, see Amazon Kinesis Data Analytics Pricing .
AutoScalingEnabled (boolean) --
Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.
EnvironmentProperties (dict) --
Describes execution properties for a Flink-based Kinesis Data Analytics application.
PropertyGroups (list) -- [REQUIRED]
Describes the execution property groups.
(dict) --
Property key-value pairs passed into a Flink-based Kinesis Data Analytics application.
PropertyGroupId (string) -- [REQUIRED]
Describes the key of an application execution property key-value pair.
PropertyMap (dict) -- [REQUIRED]
Describes the value of an application execution property key-value pair.
(string) --
(string) --
ApplicationCodeConfiguration (dict) -- [REQUIRED]
The code location and type parameters for a Flink-based Kinesis Data Analytics application.
CodeContent (dict) --
The location and type of the application code.
TextContent (string) --
The text-format code for a Flink-based Kinesis Data Analytics application.
ZipFileContent (bytes) --
The zip-format code for a Flink-based Kinesis Data Analytics application.
S3ContentLocation (dict) --
Information about the Amazon S3 bucket containing the application code.
BucketARN (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the S3 bucket containing the application code.
FileKey (string) -- [REQUIRED]
The file key for the object containing the application code.
ObjectVersion (string) --
The version of the object containing the application code.
CodeContentType (string) -- [REQUIRED]
Specifies whether the code content is in text or zip format.
ApplicationSnapshotConfiguration (dict) --
Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.
SnapshotsEnabled (boolean) -- [REQUIRED]
Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.
VpcConfigurations (list) --
The array of descriptions of VPC configurations available to the application.
(dict) --
Describes the parameters of a VPC used by the application.
SubnetIds (list) -- [REQUIRED]
The array of Subnet IDs used by the VPC configuration.
(string) --
SecurityGroupIds (list) -- [REQUIRED]
The array of SecurityGroup IDs used by the VPC configuration.
(string) --
list
Use this parameter to configure an Amazon CloudWatch log stream to monitor application configuration errors.
(dict) --
Provides a description of Amazon CloudWatch logging options, including the log stream Amazon Resource Name (ARN).
LogStreamARN (string) -- [REQUIRED]
The ARN of the CloudWatch log to receive application messages.
list
A list of one or more tags to assign to the application. A tag is a key-value pair that identifies an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see Using Tagging .
(dict) --
A key-value pair (the value is optional) that you can define and assign to AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see Using Tagging .
Key (string) -- [REQUIRED]
The key of the key-value tag.
Value (string) --
The value of the key-value tag. The value is optional.
dict
Response Syntax
{
'ApplicationDetail': {
'ApplicationARN': 'string',
'ApplicationDescription': 'string',
'ApplicationName': 'string',
'RuntimeEnvironment': 'SQL-1_0'|'FLINK-1_6'|'FLINK-1_8'|'FLINK-1_11',
'ServiceExecutionRole': 'string',
'ApplicationStatus': 'DELETING'|'STARTING'|'STOPPING'|'READY'|'RUNNING'|'UPDATING'|'AUTOSCALING'|'FORCE_STOPPING'|'MAINTENANCE'|'ROLLING_BACK',
'ApplicationVersionId': 123,
'CreateTimestamp': datetime(2015, 1, 1),
'LastUpdateTimestamp': datetime(2015, 1, 1),
'ApplicationConfigurationDescription': {
'SqlApplicationConfigurationDescription': {
'InputDescriptions': [
{
'InputId': 'string',
'NamePrefix': 'string',
'InAppStreamNames': [
'string',
],
'InputProcessingConfigurationDescription': {
'InputLambdaProcessorDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
}
},
'KinesisStreamsInputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'KinesisFirehoseInputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'InputSchema': {
'RecordFormat': {
'RecordFormatType': 'JSON'|'CSV',
'MappingParameters': {
'JSONMappingParameters': {
'RecordRowPath': 'string'
},
'CSVMappingParameters': {
'RecordRowDelimiter': 'string',
'RecordColumnDelimiter': 'string'
}
}
},
'RecordEncoding': 'string',
'RecordColumns': [
{
'Name': 'string',
'Mapping': 'string',
'SqlType': 'string'
},
]
},
'InputParallelism': {
'Count': 123
},
'InputStartingPositionConfiguration': {
'InputStartingPosition': 'NOW'|'TRIM_HORIZON'|'LAST_STOPPED_POINT'
}
},
],
'OutputDescriptions': [
{
'OutputId': 'string',
'Name': 'string',
'KinesisStreamsOutputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'KinesisFirehoseOutputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'LambdaOutputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'DestinationSchema': {
'RecordFormatType': 'JSON'|'CSV'
}
},
],
'ReferenceDataSourceDescriptions': [
{
'ReferenceId': 'string',
'TableName': 'string',
'S3ReferenceDataSourceDescription': {
'BucketARN': 'string',
'FileKey': 'string',
'ReferenceRoleARN': 'string'
},
'ReferenceSchema': {
'RecordFormat': {
'RecordFormatType': 'JSON'|'CSV',
'MappingParameters': {
'JSONMappingParameters': {
'RecordRowPath': 'string'
},
'CSVMappingParameters': {
'RecordRowDelimiter': 'string',
'RecordColumnDelimiter': 'string'
}
}
},
'RecordEncoding': 'string',
'RecordColumns': [
{
'Name': 'string',
'Mapping': 'string',
'SqlType': 'string'
},
]
}
},
]
},
'ApplicationCodeConfigurationDescription': {
'CodeContentType': 'PLAINTEXT'|'ZIPFILE',
'CodeContentDescription': {
'TextContent': 'string',
'CodeMD5': 'string',
'CodeSize': 123,
'S3ApplicationCodeLocationDescription': {
'BucketARN': 'string',
'FileKey': 'string',
'ObjectVersion': 'string'
}
}
},
'RunConfigurationDescription': {
'ApplicationRestoreConfigurationDescription': {
'ApplicationRestoreType': 'SKIP_RESTORE_FROM_SNAPSHOT'|'RESTORE_FROM_LATEST_SNAPSHOT'|'RESTORE_FROM_CUSTOM_SNAPSHOT',
'SnapshotName': 'string'
},
'FlinkRunConfigurationDescription': {
'AllowNonRestoredState': True|False
}
},
'FlinkApplicationConfigurationDescription': {
'CheckpointConfigurationDescription': {
'ConfigurationType': 'DEFAULT'|'CUSTOM',
'CheckpointingEnabled': True|False,
'CheckpointInterval': 123,
'MinPauseBetweenCheckpoints': 123
},
'MonitoringConfigurationDescription': {
'ConfigurationType': 'DEFAULT'|'CUSTOM',
'MetricsLevel': 'APPLICATION'|'TASK'|'OPERATOR'|'PARALLELISM',
'LogLevel': 'INFO'|'WARN'|'ERROR'|'DEBUG'
},
'ParallelismConfigurationDescription': {
'ConfigurationType': 'DEFAULT'|'CUSTOM',
'Parallelism': 123,
'ParallelismPerKPU': 123,
'CurrentParallelism': 123,
'AutoScalingEnabled': True|False
},
'JobPlanDescription': 'string'
},
'EnvironmentPropertyDescriptions': {
'PropertyGroupDescriptions': [
{
'PropertyGroupId': 'string',
'PropertyMap': {
'string': 'string'
}
},
]
},
'ApplicationSnapshotConfigurationDescription': {
'SnapshotsEnabled': True|False
},
'VpcConfigurationDescriptions': [
{
'VpcConfigurationId': 'string',
'VpcId': 'string',
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
]
},
'CloudWatchLoggingOptionDescriptions': [
{
'CloudWatchLoggingOptionId': 'string',
'LogStreamARN': 'string',
'RoleARN': 'string'
},
],
'ApplicationMaintenanceConfigurationDescription': {
'ApplicationMaintenanceWindowStartTime': 'string',
'ApplicationMaintenanceWindowEndTime': 'string'
},
'ApplicationVersionUpdatedFrom': 123,
'ApplicationVersionRolledBackFrom': 123,
'ConditionalToken': 'string'
}
}
Response Structure
(dict) --
ApplicationDetail (dict) --
In response to your CreateApplication request, Kinesis Data Analytics returns a response with details of the application it created.
ApplicationARN (string) --
The ARN of the application.
ApplicationDescription (string) --
The description of the application.
ApplicationName (string) --
The name of the application.
RuntimeEnvironment (string) --
The runtime environment for the application (SQL-1_0 , FLINK-1_6 , FLINK-1_8 , or FLINK-1_11 ).
ServiceExecutionRole (string) --
Specifies the IAM role that the application uses to access external resources.
ApplicationStatus (string) --
The status of the application.
ApplicationVersionId (integer) --
Provides the current application version. Kinesis Data Analytics updates the ApplicationVersionId each time you update the application.
CreateTimestamp (datetime) --
The current timestamp when the application was created.
LastUpdateTimestamp (datetime) --
The current timestamp when the application was last updated.
ApplicationConfigurationDescription (dict) --
Provides details about the application's Java, SQL, or Scala code and starting parameters.
SqlApplicationConfigurationDescription (dict) --
The details about inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.
InputDescriptions (list) --
The array of InputDescription objects describing the input streams used by the application.
(dict) --
Describes the application input configuration for a SQL-based Kinesis Data Analytics application.
InputId (string) --
The input ID that is associated with the application input. This is the ID that Kinesis Data Analytics assigns to each input configuration that you add to your application.
NamePrefix (string) --
The in-application name prefix.
InAppStreamNames (list) --
Returns the in-application stream names that are mapped to the stream source.
(string) --
InputProcessingConfigurationDescription (dict) --
The description of the preprocessor that executes on records in this input before the application's code is run.
InputLambdaProcessorDescription (dict) --
Provides configuration information about the associated InputLambdaProcessorDescription
ResourceARN (string) --
The ARN of the AWS Lambda function that is used to preprocess the records in the stream.
Note
To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda
RoleARN (string) --
The ARN of the IAM role that is used to access the AWS Lambda function.
Note
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
KinesisStreamsInputDescription (dict) --
If a Kinesis data stream is configured as a streaming source, provides the Kinesis data stream's Amazon Resource Name (ARN).
ResourceARN (string) --
The Amazon Resource Name (ARN) of the Kinesis data stream.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
Note
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
KinesisFirehoseInputDescription (dict) --
If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN.
ResourceARN (string) --
The Amazon Resource Name (ARN) of the delivery stream.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics assumes to access the stream.
Note
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
InputSchema (dict) --
Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.
RecordFormat (dict) --
Specifies the format of the records on the streaming source.
RecordFormatType (string) --
The type of record format.
MappingParameters (dict) --
When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.
JSONMappingParameters (dict) --
Provides additional mapping information when JSON is the record format on the streaming source.
RecordRowPath (string) --
The path to the top-level parent that contains the records.
CSVMappingParameters (dict) --
Provides additional mapping information when the record format uses delimiters (for example, CSV).
RecordRowDelimiter (string) --
The row delimiter. For example, in a CSV format, 'n' is the typical row delimiter.
RecordColumnDelimiter (string) --
The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
RecordEncoding (string) --
Specifies the encoding of the records in the streaming source. For example, UTF-8.
RecordColumns (list) --
A list of RecordColumn objects.
(dict) --
For a SQL-based Kinesis Data Analytics application, describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream.
Also used to describe the format of the reference data source.
Name (string) --
The name of the column that is created in the in-application input stream or reference table.
Mapping (string) --
A reference to the data element in the streaming input or the reference data source.
SqlType (string) --
The type of column created in the in-application input stream or reference table.
InputParallelism (dict) --
Describes the configured parallelism (number of in-application streams mapped to the streaming source).
Count (integer) --
The number of in-application streams to create.
InputStartingPositionConfiguration (dict) --
The point at which the application is configured to read from the input stream.
InputStartingPosition (string) --
The starting position on the stream.
NOW - Start reading just after the most recent record in the stream, and start at the request timestamp that the customer issued.
TRIM_HORIZON - Start reading at the last untrimmed record in the stream, which is the oldest record available in the stream. This option is not available for an Amazon Kinesis Data Firehose delivery stream.
LAST_STOPPED_POINT - Resume reading from where the application last stopped reading.
OutputDescriptions (list) --
The array of OutputDescription objects describing the destination streams used by the application.
(dict) --
For a SQL-based Kinesis Data Analytics application, describes the application output configuration, which includes the in-application stream name and the destination where the stream data is written. The destination can be a Kinesis data stream or a Kinesis Data Firehose delivery stream.
OutputId (string) --
A unique identifier for the output configuration.
Name (string) --
The name of the in-application stream that is configured as output.
KinesisStreamsOutputDescription (dict) --
Describes the Kinesis data stream that is configured as the destination where output is written.
ResourceARN (string) --
The Amazon Resource Name (ARN) of the Kinesis data stream.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
Note
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
KinesisFirehoseOutputDescription (dict) --
Describes the Kinesis Data Firehose delivery stream that is configured as the destination where output is written.
ResourceARN (string) --
The Amazon Resource Name (ARN) of the delivery stream.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
Note
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
LambdaOutputDescription (dict) --
Describes the Lambda function that is configured as the destination where output is written.
ResourceARN (string) --
The Amazon Resource Name (ARN) of the destination Lambda function.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to write to the destination function.
Note
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
DestinationSchema (dict) --
The data format used for writing data to the destination.
RecordFormatType (string) --
Specifies the format of the records on the output stream.
ReferenceDataSourceDescriptions (list) --
The array of ReferenceDataSourceDescription objects describing the reference data sources used by the application.
(dict) --
For a SQL-based Kinesis Data Analytics application, describes the reference data source configured for an application.
ReferenceId (string) --
The ID of the reference data source. This is the ID that Kinesis Data Analytics assigns when you add the reference data source to your application using the CreateApplication or UpdateApplication operation.
TableName (string) --
The in-application table name created by the specific reference data source configuration.
S3ReferenceDataSourceDescription (dict) --
Provides the Amazon S3 bucket name, the object key name that contains the reference data.
BucketARN (string) --
The Amazon Resource Name (ARN) of the S3 bucket.
FileKey (string) --
Amazon S3 object key name.
ReferenceRoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf to populate the in-application reference table.
Note
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
ReferenceSchema (dict) --
Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.
RecordFormat (dict) --
Specifies the format of the records on the streaming source.
RecordFormatType (string) --
The type of record format.
MappingParameters (dict) --
When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.
JSONMappingParameters (dict) --
Provides additional mapping information when JSON is the record format on the streaming source.
RecordRowPath (string) --
The path to the top-level parent that contains the records.
CSVMappingParameters (dict) --
Provides additional mapping information when the record format uses delimiters (for example, CSV).
RecordRowDelimiter (string) --
The row delimiter. For example, in a CSV format, 'n' is the typical row delimiter.
RecordColumnDelimiter (string) --
The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
RecordEncoding (string) --
Specifies the encoding of the records in the streaming source. For example, UTF-8.
RecordColumns (list) --
A list of RecordColumn objects.
(dict) --
For a SQL-based Kinesis Data Analytics application, describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream.
Also used to describe the format of the reference data source.
Name (string) --
The name of the column that is created in the in-application input stream or reference table.
Mapping (string) --
A reference to the data element in the streaming input or the reference data source.
SqlType (string) --
The type of column created in the in-application input stream or reference table.
ApplicationCodeConfigurationDescription (dict) --
The details about the application code for a Flink-based Kinesis Data Analytics application.
CodeContentType (string) --
Specifies whether the code content is in text or zip format.
CodeContentDescription (dict) --
Describes details about the location and format of the application code.
TextContent (string) --
The text-format code
CodeMD5 (string) --
The checksum that can be used to validate zip-format code.
CodeSize (integer) --
The size in bytes of the application code. Can be used to validate zip-format code.
S3ApplicationCodeLocationDescription (dict) --
The S3 bucket Amazon Resource Name (ARN), file key, and object version of the application code stored in Amazon S3.
BucketARN (string) --
The Amazon Resource Name (ARN) for the S3 bucket containing the application code.
FileKey (string) --
The file key for the object containing the application code.
ObjectVersion (string) --
The version of the object containing the application code.
RunConfigurationDescription (dict) --
The details about the starting properties for a Kinesis Data Analytics application.
ApplicationRestoreConfigurationDescription (dict) --
Describes the restore behavior of a restarting application.
ApplicationRestoreType (string) --
Specifies how the application should be restored.
SnapshotName (string) --
The identifier of an existing snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType .
FlinkRunConfigurationDescription (dict) --
Describes the starting parameters for a Flink-based Kinesis Data Analytics application.
AllowNonRestoredState (boolean) --
When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program. This will happen if the program is updated between snapshots to remove stateful parameters, and state data in the snapshot no longer corresponds to valid application data. For more information, see Allowing Non-Restored State in the Apache Flink documentation .
Note
This value defaults to false . If you update your application without specifying this parameter, AllowNonRestoredState will be set to false , even if it was previously set to true .
FlinkApplicationConfigurationDescription (dict) --
The details about a Flink-based Kinesis Data Analytics application.
CheckpointConfigurationDescription (dict) --
Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance.
ConfigurationType (string) --
Describes whether the application uses the default checkpointing behavior in Kinesis Data Analytics.
Note
If this value is set to DEFAULT , the application will use the following values, even if they are set to other values using APIs or application code:
CheckpointingEnabled: true
CheckpointInterval: 60000
MinPauseBetweenCheckpoints: 5000
CheckpointingEnabled (boolean) --
Describes whether checkpointing is enabled for a Flink-based Kinesis Data Analytics application.
Note
If CheckpointConfiguration.ConfigurationType is DEFAULT , the application will use a CheckpointingEnabled value of true , even if this value is set to another value using this API or in application code.
CheckpointInterval (integer) --
Describes the interval in milliseconds between checkpoint operations.
Note
If CheckpointConfiguration.ConfigurationType is DEFAULT , the application will use a CheckpointInterval value of 60000, even if this value is set to another value using this API or in application code.
MinPauseBetweenCheckpoints (integer) --
Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.
Note
If CheckpointConfiguration.ConfigurationType is DEFAULT , the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this API or in application code.
MonitoringConfigurationDescription (dict) --
Describes configuration parameters for Amazon CloudWatch logging for an application.
ConfigurationType (string) --
Describes whether to use the default CloudWatch logging configuration for an application.
MetricsLevel (string) --
Describes the granularity of the CloudWatch Logs for an application.
LogLevel (string) --
Describes the verbosity of the CloudWatch Logs for an application.
ParallelismConfigurationDescription (dict) --
Describes parameters for how an application executes multiple tasks simultaneously.
ConfigurationType (string) --
Describes whether the application uses the default parallelism for the Kinesis Data Analytics service.
Parallelism (integer) --
Describes the initial number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, then Kinesis Data Analytics can increase the CurrentParallelism value in response to application load. The service can increase CurrentParallelism up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.
ParallelismPerKPU (integer) --
Describes the number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application.
CurrentParallelism (integer) --
Describes the current number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, Kinesis Data Analytics can increase this value in response to application load. The service can increase this value up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.
AutoScalingEnabled (boolean) --
Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.
JobPlanDescription (string) --
The job plan for an application. For more information about the job plan, see Jobs and Scheduling in the Apache Flink Documentation . To retrieve the job plan for the application, use the DescribeApplicationRequest$IncludeAdditionalDetails parameter of the DescribeApplication operation.
EnvironmentPropertyDescriptions (dict) --
Describes execution properties for a Flink-based Kinesis Data Analytics application.
PropertyGroupDescriptions (list) --
Describes the execution property groups.
(dict) --
Property key-value pairs passed into a Flink-based Kinesis Data Analytics application.
PropertyGroupId (string) --
Describes the key of an application execution property key-value pair.
PropertyMap (dict) --
Describes the value of an application execution property key-value pair.
(string) --
(string) --
ApplicationSnapshotConfigurationDescription (dict) --
Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.
SnapshotsEnabled (boolean) --
Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.
VpcConfigurationDescriptions (list) --
The array of descriptions of VPC configurations available to the application.
(dict) --
Describes the parameters of a VPC used by the application.
VpcConfigurationId (string) --
The ID of the VPC configuration.
VpcId (string) --
The ID of the associated VPC.
SubnetIds (list) --
The array of Subnet IDs used by the VPC configuration.
(string) --
SecurityGroupIds (list) --
The array of SecurityGroup IDs used by the VPC configuration.
(string) --
CloudWatchLoggingOptionDescriptions (list) --
Describes the application Amazon CloudWatch logging options.
(dict) --
Describes the Amazon CloudWatch logging option.
CloudWatchLoggingOptionId (string) --
The ID of the CloudWatch logging option description.
LogStreamARN (string) --
The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.
RoleARN (string) --
The IAM ARN of the role to use to send application messages.
Note
Provided for backward compatibility. Applications created with the current API version have an application-level service execution role rather than a resource-level role.
ApplicationMaintenanceConfigurationDescription (dict) --
Describes the time window for automatic application maintenance.
ApplicationMaintenanceWindowStartTime (string) --
The start time for the automatic maintenance window.
ApplicationMaintenanceWindowEndTime (string) --
The end time for the automatic maintenance window.
ApplicationVersionUpdatedFrom (integer) --
The previous application version before the latest application update. RollbackApplication reverts the application to this version.
ApplicationVersionRolledBackFrom (integer) --
If you reverted the application using RollbackApplication , the application version when RollbackApplication was called.
ConditionalToken (string) --
A value you use to implement strong concurrency for application updates.
{'ConditionalToken': 'string'}
Deletes an Amazon CloudWatch log stream from an Kinesis Data Analytics application.
See also: AWS API Documentation
Request Syntax
client.delete_application_cloud_watch_logging_option(
ApplicationName='string',
CurrentApplicationVersionId=123,
CloudWatchLoggingOptionId='string',
ConditionalToken='string'
)
string
[REQUIRED]
The application name.
integer
The version ID of the application. You must provide the ApplicationVersionID or the ConditionalToken . You can retrieve the application version ID using DescribeApplication .
string
[REQUIRED]
The CloudWatchLoggingOptionId of the Amazon CloudWatch logging option to delete. You can get the CloudWatchLoggingOptionId by using the DescribeApplication operation.
string
A value you use to implement strong concurrency for application updates. You must provide the ApplicationVersionID or the ConditionalToken . You get the application's current ConditionalToken using DescribeApplication .
dict
Response Syntax
{
'ApplicationARN': 'string',
'ApplicationVersionId': 123,
'CloudWatchLoggingOptionDescriptions': [
{
'CloudWatchLoggingOptionId': 'string',
'LogStreamARN': 'string',
'RoleARN': 'string'
},
]
}
Response Structure
(dict) --
ApplicationARN (string) --
The application's Amazon Resource Name (ARN).
ApplicationVersionId (integer) --
The version ID of the application. Kinesis Data Analytics updates the ApplicationVersionId each time you change the CloudWatch logging options.
CloudWatchLoggingOptionDescriptions (list) --
The descriptions of the remaining CloudWatch logging options for the application.
(dict) --
Describes the Amazon CloudWatch logging option.
CloudWatchLoggingOptionId (string) --
The ID of the CloudWatch logging option description.
LogStreamARN (string) --
The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.
RoleARN (string) --
The IAM ARN of the role to use to send application messages.
Note
Provided for backward compatibility. Applications created with the current API version have an application-level service execution role rather than a resource-level role.
{'ConditionalToken': 'string'}
Removes a VPC configuration from a Kinesis Data Analytics application.
See also: AWS API Documentation
Request Syntax
client.delete_application_vpc_configuration(
ApplicationName='string',
CurrentApplicationVersionId=123,
VpcConfigurationId='string',
ConditionalToken='string'
)
string
[REQUIRED]
The name of an existing application.
integer
The current application version ID. You must provide the ApplicationVersionID or the ConditionalToken .You can retrieve the application version ID using DescribeApplication .
string
[REQUIRED]
The ID of the VPC configuration to delete.
string
A value you use to implement strong concurrency for application updates. You must provide the ApplicationVersionID or the ConditionalToken . You get the application's current ConditionalToken using DescribeApplication .
dict
Response Syntax
{
'ApplicationARN': 'string',
'ApplicationVersionId': 123
}
Response Structure
(dict) --
ApplicationARN (string) --
The ARN of the Kinesis Data Analytics application.
ApplicationVersionId (integer) --
The updated version ID of the application.
{'ApplicationDetail': {'ApplicationStatus': {'ROLLING_BACK'},
'ApplicationVersionRolledBackFrom': 'long',
'ApplicationVersionUpdatedFrom': 'long',
'ConditionalToken': 'string'}}
Returns information about a specific Kinesis Data Analytics application.
If you want to retrieve a list of all applications in your account, use the ListApplications operation.
See also: AWS API Documentation
Request Syntax
client.describe_application(
ApplicationName='string',
IncludeAdditionalDetails=True|False
)
string
[REQUIRED]
The name of the application.
boolean
Displays verbose information about a Kinesis Data Analytics application, including the application's job plan.
dict
Response Syntax
{
'ApplicationDetail': {
'ApplicationARN': 'string',
'ApplicationDescription': 'string',
'ApplicationName': 'string',
'RuntimeEnvironment': 'SQL-1_0'|'FLINK-1_6'|'FLINK-1_8'|'FLINK-1_11',
'ServiceExecutionRole': 'string',
'ApplicationStatus': 'DELETING'|'STARTING'|'STOPPING'|'READY'|'RUNNING'|'UPDATING'|'AUTOSCALING'|'FORCE_STOPPING'|'MAINTENANCE'|'ROLLING_BACK',
'ApplicationVersionId': 123,
'CreateTimestamp': datetime(2015, 1, 1),
'LastUpdateTimestamp': datetime(2015, 1, 1),
'ApplicationConfigurationDescription': {
'SqlApplicationConfigurationDescription': {
'InputDescriptions': [
{
'InputId': 'string',
'NamePrefix': 'string',
'InAppStreamNames': [
'string',
],
'InputProcessingConfigurationDescription': {
'InputLambdaProcessorDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
}
},
'KinesisStreamsInputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'KinesisFirehoseInputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'InputSchema': {
'RecordFormat': {
'RecordFormatType': 'JSON'|'CSV',
'MappingParameters': {
'JSONMappingParameters': {
'RecordRowPath': 'string'
},
'CSVMappingParameters': {
'RecordRowDelimiter': 'string',
'RecordColumnDelimiter': 'string'
}
}
},
'RecordEncoding': 'string',
'RecordColumns': [
{
'Name': 'string',
'Mapping': 'string',
'SqlType': 'string'
},
]
},
'InputParallelism': {
'Count': 123
},
'InputStartingPositionConfiguration': {
'InputStartingPosition': 'NOW'|'TRIM_HORIZON'|'LAST_STOPPED_POINT'
}
},
],
'OutputDescriptions': [
{
'OutputId': 'string',
'Name': 'string',
'KinesisStreamsOutputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'KinesisFirehoseOutputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'LambdaOutputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'DestinationSchema': {
'RecordFormatType': 'JSON'|'CSV'
}
},
],
'ReferenceDataSourceDescriptions': [
{
'ReferenceId': 'string',
'TableName': 'string',
'S3ReferenceDataSourceDescription': {
'BucketARN': 'string',
'FileKey': 'string',
'ReferenceRoleARN': 'string'
},
'ReferenceSchema': {
'RecordFormat': {
'RecordFormatType': 'JSON'|'CSV',
'MappingParameters': {
'JSONMappingParameters': {
'RecordRowPath': 'string'
},
'CSVMappingParameters': {
'RecordRowDelimiter': 'string',
'RecordColumnDelimiter': 'string'
}
}
},
'RecordEncoding': 'string',
'RecordColumns': [
{
'Name': 'string',
'Mapping': 'string',
'SqlType': 'string'
},
]
}
},
]
},
'ApplicationCodeConfigurationDescription': {
'CodeContentType': 'PLAINTEXT'|'ZIPFILE',
'CodeContentDescription': {
'TextContent': 'string',
'CodeMD5': 'string',
'CodeSize': 123,
'S3ApplicationCodeLocationDescription': {
'BucketARN': 'string',
'FileKey': 'string',
'ObjectVersion': 'string'
}
}
},
'RunConfigurationDescription': {
'ApplicationRestoreConfigurationDescription': {
'ApplicationRestoreType': 'SKIP_RESTORE_FROM_SNAPSHOT'|'RESTORE_FROM_LATEST_SNAPSHOT'|'RESTORE_FROM_CUSTOM_SNAPSHOT',
'SnapshotName': 'string'
},
'FlinkRunConfigurationDescription': {
'AllowNonRestoredState': True|False
}
},
'FlinkApplicationConfigurationDescription': {
'CheckpointConfigurationDescription': {
'ConfigurationType': 'DEFAULT'|'CUSTOM',
'CheckpointingEnabled': True|False,
'CheckpointInterval': 123,
'MinPauseBetweenCheckpoints': 123
},
'MonitoringConfigurationDescription': {
'ConfigurationType': 'DEFAULT'|'CUSTOM',
'MetricsLevel': 'APPLICATION'|'TASK'|'OPERATOR'|'PARALLELISM',
'LogLevel': 'INFO'|'WARN'|'ERROR'|'DEBUG'
},
'ParallelismConfigurationDescription': {
'ConfigurationType': 'DEFAULT'|'CUSTOM',
'Parallelism': 123,
'ParallelismPerKPU': 123,
'CurrentParallelism': 123,
'AutoScalingEnabled': True|False
},
'JobPlanDescription': 'string'
},
'EnvironmentPropertyDescriptions': {
'PropertyGroupDescriptions': [
{
'PropertyGroupId': 'string',
'PropertyMap': {
'string': 'string'
}
},
]
},
'ApplicationSnapshotConfigurationDescription': {
'SnapshotsEnabled': True|False
},
'VpcConfigurationDescriptions': [
{
'VpcConfigurationId': 'string',
'VpcId': 'string',
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
]
},
'CloudWatchLoggingOptionDescriptions': [
{
'CloudWatchLoggingOptionId': 'string',
'LogStreamARN': 'string',
'RoleARN': 'string'
},
],
'ApplicationMaintenanceConfigurationDescription': {
'ApplicationMaintenanceWindowStartTime': 'string',
'ApplicationMaintenanceWindowEndTime': 'string'
},
'ApplicationVersionUpdatedFrom': 123,
'ApplicationVersionRolledBackFrom': 123,
'ConditionalToken': 'string'
}
}
Response Structure
(dict) --
ApplicationDetail (dict) --
Provides a description of the application, such as the application's Amazon Resource Name (ARN), status, and latest version.
ApplicationARN (string) --
The ARN of the application.
ApplicationDescription (string) --
The description of the application.
ApplicationName (string) --
The name of the application.
RuntimeEnvironment (string) --
The runtime environment for the application (SQL-1_0 , FLINK-1_6 , FLINK-1_8 , or FLINK-1_11 ).
ServiceExecutionRole (string) --
Specifies the IAM role that the application uses to access external resources.
ApplicationStatus (string) --
The status of the application.
ApplicationVersionId (integer) --
Provides the current application version. Kinesis Data Analytics updates the ApplicationVersionId each time you update the application.
CreateTimestamp (datetime) --
The current timestamp when the application was created.
LastUpdateTimestamp (datetime) --
The current timestamp when the application was last updated.
ApplicationConfigurationDescription (dict) --
Provides details about the application's Java, SQL, or Scala code and starting parameters.
SqlApplicationConfigurationDescription (dict) --
The details about inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.
InputDescriptions (list) --
The array of InputDescription objects describing the input streams used by the application.
(dict) --
Describes the application input configuration for a SQL-based Kinesis Data Analytics application.
InputId (string) --
The input ID that is associated with the application input. This is the ID that Kinesis Data Analytics assigns to each input configuration that you add to your application.
NamePrefix (string) --
The in-application name prefix.
InAppStreamNames (list) --
Returns the in-application stream names that are mapped to the stream source.
(string) --
InputProcessingConfigurationDescription (dict) --
The description of the preprocessor that executes on records in this input before the application's code is run.
InputLambdaProcessorDescription (dict) --
Provides configuration information about the associated InputLambdaProcessorDescription
ResourceARN (string) --
The ARN of the AWS Lambda function that is used to preprocess the records in the stream.
Note
To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda
RoleARN (string) --
The ARN of the IAM role that is used to access the AWS Lambda function.
Note
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
KinesisStreamsInputDescription (dict) --
If a Kinesis data stream is configured as a streaming source, provides the Kinesis data stream's Amazon Resource Name (ARN).
ResourceARN (string) --
The Amazon Resource Name (ARN) of the Kinesis data stream.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
Note
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
KinesisFirehoseInputDescription (dict) --
If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN.
ResourceARN (string) --
The Amazon Resource Name (ARN) of the delivery stream.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics assumes to access the stream.
Note
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
InputSchema (dict) --
Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.
RecordFormat (dict) --
Specifies the format of the records on the streaming source.
RecordFormatType (string) --
The type of record format.
MappingParameters (dict) --
When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.
JSONMappingParameters (dict) --
Provides additional mapping information when JSON is the record format on the streaming source.
RecordRowPath (string) --
The path to the top-level parent that contains the records.
CSVMappingParameters (dict) --
Provides additional mapping information when the record format uses delimiters (for example, CSV).
RecordRowDelimiter (string) --
The row delimiter. For example, in a CSV format, 'n' is the typical row delimiter.
RecordColumnDelimiter (string) --
The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
RecordEncoding (string) --
Specifies the encoding of the records in the streaming source. For example, UTF-8.
RecordColumns (list) --
A list of RecordColumn objects.
(dict) --
For a SQL-based Kinesis Data Analytics application, describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream.
Also used to describe the format of the reference data source.
Name (string) --
The name of the column that is created in the in-application input stream or reference table.
Mapping (string) --
A reference to the data element in the streaming input or the reference data source.
SqlType (string) --
The type of column created in the in-application input stream or reference table.
InputParallelism (dict) --
Describes the configured parallelism (number of in-application streams mapped to the streaming source).
Count (integer) --
The number of in-application streams to create.
InputStartingPositionConfiguration (dict) --
The point at which the application is configured to read from the input stream.
InputStartingPosition (string) --
The starting position on the stream.
NOW - Start reading just after the most recent record in the stream, and start at the request timestamp that the customer issued.
TRIM_HORIZON - Start reading at the last untrimmed record in the stream, which is the oldest record available in the stream. This option is not available for an Amazon Kinesis Data Firehose delivery stream.
LAST_STOPPED_POINT - Resume reading from where the application last stopped reading.
OutputDescriptions (list) --
The array of OutputDescription objects describing the destination streams used by the application.
(dict) --
For a SQL-based Kinesis Data Analytics application, describes the application output configuration, which includes the in-application stream name and the destination where the stream data is written. The destination can be a Kinesis data stream or a Kinesis Data Firehose delivery stream.
OutputId (string) --
A unique identifier for the output configuration.
Name (string) --
The name of the in-application stream that is configured as output.
KinesisStreamsOutputDescription (dict) --
Describes the Kinesis data stream that is configured as the destination where output is written.
ResourceARN (string) --
The Amazon Resource Name (ARN) of the Kinesis data stream.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
Note
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
KinesisFirehoseOutputDescription (dict) --
Describes the Kinesis Data Firehose delivery stream that is configured as the destination where output is written.
ResourceARN (string) --
The Amazon Resource Name (ARN) of the delivery stream.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
Note
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
LambdaOutputDescription (dict) --
Describes the Lambda function that is configured as the destination where output is written.
ResourceARN (string) --
The Amazon Resource Name (ARN) of the destination Lambda function.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to write to the destination function.
Note
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
DestinationSchema (dict) --
The data format used for writing data to the destination.
RecordFormatType (string) --
Specifies the format of the records on the output stream.
ReferenceDataSourceDescriptions (list) --
The array of ReferenceDataSourceDescription objects describing the reference data sources used by the application.
(dict) --
For a SQL-based Kinesis Data Analytics application, describes the reference data source configured for an application.
ReferenceId (string) --
The ID of the reference data source. This is the ID that Kinesis Data Analytics assigns when you add the reference data source to your application using the CreateApplication or UpdateApplication operation.
TableName (string) --
The in-application table name created by the specific reference data source configuration.
S3ReferenceDataSourceDescription (dict) --
Provides the Amazon S3 bucket name, the object key name that contains the reference data.
BucketARN (string) --
The Amazon Resource Name (ARN) of the S3 bucket.
FileKey (string) --
Amazon S3 object key name.
ReferenceRoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf to populate the in-application reference table.
Note
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
ReferenceSchema (dict) --
Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.
RecordFormat (dict) --
Specifies the format of the records on the streaming source.
RecordFormatType (string) --
The type of record format.
MappingParameters (dict) --
When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.
JSONMappingParameters (dict) --
Provides additional mapping information when JSON is the record format on the streaming source.
RecordRowPath (string) --
The path to the top-level parent that contains the records.
CSVMappingParameters (dict) --
Provides additional mapping information when the record format uses delimiters (for example, CSV).
RecordRowDelimiter (string) --
The row delimiter. For example, in a CSV format, 'n' is the typical row delimiter.
RecordColumnDelimiter (string) --
The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
RecordEncoding (string) --
Specifies the encoding of the records in the streaming source. For example, UTF-8.
RecordColumns (list) --
A list of RecordColumn objects.
(dict) --
For a SQL-based Kinesis Data Analytics application, describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream.
Also used to describe the format of the reference data source.
Name (string) --
The name of the column that is created in the in-application input stream or reference table.
Mapping (string) --
A reference to the data element in the streaming input or the reference data source.
SqlType (string) --
The type of column created in the in-application input stream or reference table.
ApplicationCodeConfigurationDescription (dict) --
The details about the application code for a Flink-based Kinesis Data Analytics application.
CodeContentType (string) --
Specifies whether the code content is in text or zip format.
CodeContentDescription (dict) --
Describes details about the location and format of the application code.
TextContent (string) --
The text-format code
CodeMD5 (string) --
The checksum that can be used to validate zip-format code.
CodeSize (integer) --
The size in bytes of the application code. Can be used to validate zip-format code.
S3ApplicationCodeLocationDescription (dict) --
The S3 bucket Amazon Resource Name (ARN), file key, and object version of the application code stored in Amazon S3.
BucketARN (string) --
The Amazon Resource Name (ARN) for the S3 bucket containing the application code.
FileKey (string) --
The file key for the object containing the application code.
ObjectVersion (string) --
The version of the object containing the application code.
RunConfigurationDescription (dict) --
The details about the starting properties for a Kinesis Data Analytics application.
ApplicationRestoreConfigurationDescription (dict) --
Describes the restore behavior of a restarting application.
ApplicationRestoreType (string) --
Specifies how the application should be restored.
SnapshotName (string) --
The identifier of an existing snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType .
FlinkRunConfigurationDescription (dict) --
Describes the starting parameters for a Flink-based Kinesis Data Analytics application.
AllowNonRestoredState (boolean) --
When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program. This will happen if the program is updated between snapshots to remove stateful parameters, and state data in the snapshot no longer corresponds to valid application data. For more information, see Allowing Non-Restored State in the Apache Flink documentation .
Note
This value defaults to false . If you update your application without specifying this parameter, AllowNonRestoredState will be set to false , even if it was previously set to true .
FlinkApplicationConfigurationDescription (dict) --
The details about a Flink-based Kinesis Data Analytics application.
CheckpointConfigurationDescription (dict) --
Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance.
ConfigurationType (string) --
Describes whether the application uses the default checkpointing behavior in Kinesis Data Analytics.
Note
If this value is set to DEFAULT , the application will use the following values, even if they are set to other values using APIs or application code:
CheckpointingEnabled: true
CheckpointInterval: 60000
MinPauseBetweenCheckpoints: 5000
CheckpointingEnabled (boolean) --
Describes whether checkpointing is enabled for a Flink-based Kinesis Data Analytics application.
Note
If CheckpointConfiguration.ConfigurationType is DEFAULT , the application will use a CheckpointingEnabled value of true , even if this value is set to another value using this API or in application code.
CheckpointInterval (integer) --
Describes the interval in milliseconds between checkpoint operations.
Note
If CheckpointConfiguration.ConfigurationType is DEFAULT , the application will use a CheckpointInterval value of 60000, even if this value is set to another value using this API or in application code.
MinPauseBetweenCheckpoints (integer) --
Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.
Note
If CheckpointConfiguration.ConfigurationType is DEFAULT , the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this API or in application code.
MonitoringConfigurationDescription (dict) --
Describes configuration parameters for Amazon CloudWatch logging for an application.
ConfigurationType (string) --
Describes whether to use the default CloudWatch logging configuration for an application.
MetricsLevel (string) --
Describes the granularity of the CloudWatch Logs for an application.
LogLevel (string) --
Describes the verbosity of the CloudWatch Logs for an application.
ParallelismConfigurationDescription (dict) --
Describes parameters for how an application executes multiple tasks simultaneously.
ConfigurationType (string) --
Describes whether the application uses the default parallelism for the Kinesis Data Analytics service.
Parallelism (integer) --
Describes the initial number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, then Kinesis Data Analytics can increase the CurrentParallelism value in response to application load. The service can increase CurrentParallelism up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.
ParallelismPerKPU (integer) --
Describes the number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application.
CurrentParallelism (integer) --
Describes the current number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, Kinesis Data Analytics can increase this value in response to application load. The service can increase this value up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.
AutoScalingEnabled (boolean) --
Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.
JobPlanDescription (string) --
The job plan for an application. For more information about the job plan, see Jobs and Scheduling in the Apache Flink Documentation . To retrieve the job plan for the application, use the DescribeApplicationRequest$IncludeAdditionalDetails parameter of the DescribeApplication operation.
EnvironmentPropertyDescriptions (dict) --
Describes execution properties for a Flink-based Kinesis Data Analytics application.
PropertyGroupDescriptions (list) --
Describes the execution property groups.
(dict) --
Property key-value pairs passed into a Flink-based Kinesis Data Analytics application.
PropertyGroupId (string) --
Describes the key of an application execution property key-value pair.
PropertyMap (dict) --
Describes the value of an application execution property key-value pair.
(string) --
(string) --
ApplicationSnapshotConfigurationDescription (dict) --
Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.
SnapshotsEnabled (boolean) --
Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.
VpcConfigurationDescriptions (list) --
The array of descriptions of VPC configurations available to the application.
(dict) --
Describes the parameters of a VPC used by the application.
VpcConfigurationId (string) --
The ID of the VPC configuration.
VpcId (string) --
The ID of the associated VPC.
SubnetIds (list) --
The array of Subnet IDs used by the VPC configuration.
(string) --
SecurityGroupIds (list) --
The array of SecurityGroup IDs used by the VPC configuration.
(string) --
CloudWatchLoggingOptionDescriptions (list) --
Describes the application Amazon CloudWatch logging options.
(dict) --
Describes the Amazon CloudWatch logging option.
CloudWatchLoggingOptionId (string) --
The ID of the CloudWatch logging option description.
LogStreamARN (string) --
The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.
RoleARN (string) --
The IAM ARN of the role to use to send application messages.
Note
Provided for backward compatibility. Applications created with the current API version have an application-level service execution role rather than a resource-level role.
ApplicationMaintenanceConfigurationDescription (dict) --
Describes the time window for automatic application maintenance.
ApplicationMaintenanceWindowStartTime (string) --
The start time for the automatic maintenance window.
ApplicationMaintenanceWindowEndTime (string) --
The end time for the automatic maintenance window.
ApplicationVersionUpdatedFrom (integer) --
The previous application version before the latest application update. RollbackApplication reverts the application to this version.
ApplicationVersionRolledBackFrom (integer) --
If you reverted the application using RollbackApplication , the application version when RollbackApplication was called.
ConditionalToken (string) --
A value you use to implement strong concurrency for application updates.
{'ApplicationSummaries': {'ApplicationStatus': {'ROLLING_BACK'}}}
Returns a list of Kinesis Data Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status.
If you want detailed information about a specific application, use DescribeApplication .
See also: AWS API Documentation
Request Syntax
client.list_applications(
Limit=123,
NextToken='string'
)
integer
The maximum number of applications to list.
string
If a previous command returned a pagination token, pass it into this value to retrieve the next set of results. For more information about pagination, see Using the AWS Command Line Interface's Pagination Options .
dict
Response Syntax
{
'ApplicationSummaries': [
{
'ApplicationName': 'string',
'ApplicationARN': 'string',
'ApplicationStatus': 'DELETING'|'STARTING'|'STOPPING'|'READY'|'RUNNING'|'UPDATING'|'AUTOSCALING'|'FORCE_STOPPING'|'MAINTENANCE'|'ROLLING_BACK',
'ApplicationVersionId': 123,
'RuntimeEnvironment': 'SQL-1_0'|'FLINK-1_6'|'FLINK-1_8'|'FLINK-1_11'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ApplicationSummaries (list) --
A list of ApplicationSummary objects.
(dict) --
Provides application summary information, including the application Amazon Resource Name (ARN), name, and status.
ApplicationName (string) --
The name of the application.
ApplicationARN (string) --
The ARN of the application.
ApplicationStatus (string) --
The status of the application.
ApplicationVersionId (integer) --
Provides the current application version.
RuntimeEnvironment (string) --
The runtime environment for the application (SQL-1_0 , FLINK-1_6 , FLINK-1_8 , or FLINK-1_11 ).
NextToken (string) --
The pagination token for the next set of results, or null if there are no additional results. Pass this token into a subsequent command to retrieve the next set of items For more information about pagination, see Using the AWS Command Line Interface's Pagination Options .
{'ConditionalToken': 'string'}
Response {'ApplicationDetail': {'ApplicationStatus': {'ROLLING_BACK'},
'ApplicationVersionRolledBackFrom': 'long',
'ApplicationVersionUpdatedFrom': 'long',
'ConditionalToken': 'string'}}
Updates an existing Kinesis Data Analytics application. Using this operation, you can update application code, input configuration, and output configuration.
Kinesis Data Analytics updates the ApplicationVersionId each time you update your application.
Note
You cannot update the RuntimeEnvironment of an existing application. If you need to update an application's RuntimeEnvironment , you must delete the application and create it again.
See also: AWS API Documentation
Request Syntax
client.update_application(
ApplicationName='string',
CurrentApplicationVersionId=123,
ApplicationConfigurationUpdate={
'SqlApplicationConfigurationUpdate': {
'InputUpdates': [
{
'InputId': 'string',
'NamePrefixUpdate': 'string',
'InputProcessingConfigurationUpdate': {
'InputLambdaProcessorUpdate': {
'ResourceARNUpdate': 'string'
}
},
'KinesisStreamsInputUpdate': {
'ResourceARNUpdate': 'string'
},
'KinesisFirehoseInputUpdate': {
'ResourceARNUpdate': 'string'
},
'InputSchemaUpdate': {
'RecordFormatUpdate': {
'RecordFormatType': 'JSON'|'CSV',
'MappingParameters': {
'JSONMappingParameters': {
'RecordRowPath': 'string'
},
'CSVMappingParameters': {
'RecordRowDelimiter': 'string',
'RecordColumnDelimiter': 'string'
}
}
},
'RecordEncodingUpdate': 'string',
'RecordColumnUpdates': [
{
'Name': 'string',
'Mapping': 'string',
'SqlType': 'string'
},
]
},
'InputParallelismUpdate': {
'CountUpdate': 123
}
},
],
'OutputUpdates': [
{
'OutputId': 'string',
'NameUpdate': 'string',
'KinesisStreamsOutputUpdate': {
'ResourceARNUpdate': 'string'
},
'KinesisFirehoseOutputUpdate': {
'ResourceARNUpdate': 'string'
},
'LambdaOutputUpdate': {
'ResourceARNUpdate': 'string'
},
'DestinationSchemaUpdate': {
'RecordFormatType': 'JSON'|'CSV'
}
},
],
'ReferenceDataSourceUpdates': [
{
'ReferenceId': 'string',
'TableNameUpdate': 'string',
'S3ReferenceDataSourceUpdate': {
'BucketARNUpdate': 'string',
'FileKeyUpdate': 'string'
},
'ReferenceSchemaUpdate': {
'RecordFormat': {
'RecordFormatType': 'JSON'|'CSV',
'MappingParameters': {
'JSONMappingParameters': {
'RecordRowPath': 'string'
},
'CSVMappingParameters': {
'RecordRowDelimiter': 'string',
'RecordColumnDelimiter': 'string'
}
}
},
'RecordEncoding': 'string',
'RecordColumns': [
{
'Name': 'string',
'Mapping': 'string',
'SqlType': 'string'
},
]
}
},
]
},
'ApplicationCodeConfigurationUpdate': {
'CodeContentTypeUpdate': 'PLAINTEXT'|'ZIPFILE',
'CodeContentUpdate': {
'TextContentUpdate': 'string',
'ZipFileContentUpdate': b'bytes',
'S3ContentLocationUpdate': {
'BucketARNUpdate': 'string',
'FileKeyUpdate': 'string',
'ObjectVersionUpdate': 'string'
}
}
},
'FlinkApplicationConfigurationUpdate': {
'CheckpointConfigurationUpdate': {
'ConfigurationTypeUpdate': 'DEFAULT'|'CUSTOM',
'CheckpointingEnabledUpdate': True|False,
'CheckpointIntervalUpdate': 123,
'MinPauseBetweenCheckpointsUpdate': 123
},
'MonitoringConfigurationUpdate': {
'ConfigurationTypeUpdate': 'DEFAULT'|'CUSTOM',
'MetricsLevelUpdate': 'APPLICATION'|'TASK'|'OPERATOR'|'PARALLELISM',
'LogLevelUpdate': 'INFO'|'WARN'|'ERROR'|'DEBUG'
},
'ParallelismConfigurationUpdate': {
'ConfigurationTypeUpdate': 'DEFAULT'|'CUSTOM',
'ParallelismUpdate': 123,
'ParallelismPerKPUUpdate': 123,
'AutoScalingEnabledUpdate': True|False
}
},
'EnvironmentPropertyUpdates': {
'PropertyGroups': [
{
'PropertyGroupId': 'string',
'PropertyMap': {
'string': 'string'
}
},
]
},
'ApplicationSnapshotConfigurationUpdate': {
'SnapshotsEnabledUpdate': True|False
},
'VpcConfigurationUpdates': [
{
'VpcConfigurationId': 'string',
'SubnetIdUpdates': [
'string',
],
'SecurityGroupIdUpdates': [
'string',
]
},
]
},
ServiceExecutionRoleUpdate='string',
RunConfigurationUpdate={
'FlinkRunConfiguration': {
'AllowNonRestoredState': True|False
},
'ApplicationRestoreConfiguration': {
'ApplicationRestoreType': 'SKIP_RESTORE_FROM_SNAPSHOT'|'RESTORE_FROM_LATEST_SNAPSHOT'|'RESTORE_FROM_CUSTOM_SNAPSHOT',
'SnapshotName': 'string'
}
},
CloudWatchLoggingOptionUpdates=[
{
'CloudWatchLoggingOptionId': 'string',
'LogStreamARNUpdate': 'string'
},
],
ConditionalToken='string'
)
string
[REQUIRED]
The name of the application to update.
integer
The current application version ID. You must provide the ApplicationVersionID or the ConditionalToken .You can retrieve the application version ID using DescribeApplication .
dict
Describes application configuration updates.
SqlApplicationConfigurationUpdate (dict) --
Describes updates to a SQL-based Kinesis Data Analytics application's configuration.
InputUpdates (list) --
The array of InputUpdate objects describing the new input streams used by the application.
(dict) --
For a SQL-based Kinesis Data Analytics application, describes updates to a specific input configuration (identified by the InputId of an application).
InputId (string) -- [REQUIRED]
The input ID of the application input to be updated.
NamePrefixUpdate (string) --
The name prefix for in-application streams that Kinesis Data Analytics creates for the specific streaming source.
InputProcessingConfigurationUpdate (dict) --
Describes updates to an InputProcessingConfiguration .
InputLambdaProcessorUpdate (dict) -- [REQUIRED]
Provides update information for an InputLambdaProcessor .
ResourceARNUpdate (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the new AWS Lambda function that is used to preprocess the records in the stream.
Note
To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda
KinesisStreamsInputUpdate (dict) --
If a Kinesis data stream is the streaming source to be updated, provides an updated stream Amazon Resource Name (ARN).
ResourceARNUpdate (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the input Kinesis data stream to read.
KinesisFirehoseInputUpdate (dict) --
If a Kinesis Data Firehose delivery stream is the streaming source to be updated, provides an updated stream ARN.
ResourceARNUpdate (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the input delivery stream to read.
InputSchemaUpdate (dict) --
Describes the data format on the streaming source, and how record elements on the streaming source map to columns of the in-application stream that is created.
RecordFormatUpdate (dict) --
Specifies the format of the records on the streaming source.
RecordFormatType (string) -- [REQUIRED]
The type of record format.
MappingParameters (dict) --
When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.
JSONMappingParameters (dict) --
Provides additional mapping information when JSON is the record format on the streaming source.
RecordRowPath (string) -- [REQUIRED]
The path to the top-level parent that contains the records.
CSVMappingParameters (dict) --
Provides additional mapping information when the record format uses delimiters (for example, CSV).
RecordRowDelimiter (string) -- [REQUIRED]
The row delimiter. For example, in a CSV format, 'n' is the typical row delimiter.
RecordColumnDelimiter (string) -- [REQUIRED]
The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
RecordEncodingUpdate (string) --
Specifies the encoding of the records in the streaming source; for example, UTF-8.
RecordColumnUpdates (list) --
A list of RecordColumn objects. Each object describes the mapping of the streaming source element to the corresponding column in the in-application stream.
(dict) --
For a SQL-based Kinesis Data Analytics application, describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream.
Also used to describe the format of the reference data source.
Name (string) -- [REQUIRED]
The name of the column that is created in the in-application input stream or reference table.
Mapping (string) --
A reference to the data element in the streaming input or the reference data source.
SqlType (string) -- [REQUIRED]
The type of column created in the in-application input stream or reference table.
InputParallelismUpdate (dict) --
Describes the parallelism updates (the number of in-application streams Kinesis Data Analytics creates for the specific streaming source).
CountUpdate (integer) -- [REQUIRED]
The number of in-application streams to create for the specified streaming source.
OutputUpdates (list) --
The array of OutputUpdate objects describing the new destination streams used by the application.
(dict) --
For a SQL-based Kinesis Data Analytics application, describes updates to the output configuration identified by the OutputId .
OutputId (string) -- [REQUIRED]
Identifies the specific output configuration that you want to update.
NameUpdate (string) --
If you want to specify a different in-application stream for this output configuration, use this field to specify the new in-application stream name.
KinesisStreamsOutputUpdate (dict) --
Describes a Kinesis data stream as the destination for the output.
ResourceARNUpdate (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Kinesis data stream where you want to write the output.
KinesisFirehoseOutputUpdate (dict) --
Describes a Kinesis Data Firehose delivery stream as the destination for the output.
ResourceARNUpdate (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the delivery stream to write to.
LambdaOutputUpdate (dict) --
Describes an AWS Lambda function as the destination for the output.
ResourceARNUpdate (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the destination AWS Lambda function.
Note
To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda
DestinationSchemaUpdate (dict) --
Describes the data format when records are written to the destination.
RecordFormatType (string) -- [REQUIRED]
Specifies the format of the records on the output stream.
ReferenceDataSourceUpdates (list) --
The array of ReferenceDataSourceUpdate objects describing the new reference data sources used by the application.
(dict) --
When you update a reference data source configuration for a SQL-based Kinesis Data Analytics application, this object provides all the updated values (such as the source bucket name and object key name), the in-application table name that is created, and updated mapping information that maps the data in the Amazon S3 object to the in-application reference table that is created.
ReferenceId (string) -- [REQUIRED]
The ID of the reference data source that is being updated. You can use the DescribeApplication operation to get this value.
TableNameUpdate (string) --
The in-application table name that is created by this update.
S3ReferenceDataSourceUpdate (dict) --
Describes the S3 bucket name, object key name, and IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf and populate the in-application reference table.
BucketARNUpdate (string) --
The Amazon Resource Name (ARN) of the S3 bucket.
FileKeyUpdate (string) --
The object key name.
ReferenceSchemaUpdate (dict) --
Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.
RecordFormat (dict) -- [REQUIRED]
Specifies the format of the records on the streaming source.
RecordFormatType (string) -- [REQUIRED]
The type of record format.
MappingParameters (dict) --
When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.
JSONMappingParameters (dict) --
Provides additional mapping information when JSON is the record format on the streaming source.
RecordRowPath (string) -- [REQUIRED]
The path to the top-level parent that contains the records.
CSVMappingParameters (dict) --
Provides additional mapping information when the record format uses delimiters (for example, CSV).
RecordRowDelimiter (string) -- [REQUIRED]
The row delimiter. For example, in a CSV format, 'n' is the typical row delimiter.
RecordColumnDelimiter (string) -- [REQUIRED]
The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
RecordEncoding (string) --
Specifies the encoding of the records in the streaming source. For example, UTF-8.
RecordColumns (list) -- [REQUIRED]
A list of RecordColumn objects.
(dict) --
For a SQL-based Kinesis Data Analytics application, describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream.
Also used to describe the format of the reference data source.
Name (string) -- [REQUIRED]
The name of the column that is created in the in-application input stream or reference table.
Mapping (string) --
A reference to the data element in the streaming input or the reference data source.
SqlType (string) -- [REQUIRED]
The type of column created in the in-application input stream or reference table.
ApplicationCodeConfigurationUpdate (dict) --
Describes updates to a Flink-based Kinesis Data Analytics application's code configuration.
CodeContentTypeUpdate (string) --
Describes updates to the code content type.
CodeContentUpdate (dict) --
Describes updates to the code content of an application.
TextContentUpdate (string) --
Describes an update to the text code for an application.
ZipFileContentUpdate (bytes) --
Describes an update to the zipped code for an application.
S3ContentLocationUpdate (dict) --
Describes an update to the location of code for an application.
BucketARNUpdate (string) --
The new Amazon Resource Name (ARN) for the S3 bucket containing the application code.
FileKeyUpdate (string) --
The new file key for the object containing the application code.
ObjectVersionUpdate (string) --
The new version of the object containing the application code.
FlinkApplicationConfigurationUpdate (dict) --
Describes updates to a Flink-based Kinesis Data Analytics application's configuration.
CheckpointConfigurationUpdate (dict) --
Describes updates to an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance.
ConfigurationTypeUpdate (string) --
Describes updates to whether the application uses the default checkpointing behavior of Kinesis Data Analytics. You must set this property to CUSTOM in order to set the CheckpointingEnabled , CheckpointInterval , or MinPauseBetweenCheckpoints parameters.
Note
If this value is set to DEFAULT , the application will use the following values, even if they are set to other values using APIs or application code:
CheckpointingEnabled: true
CheckpointInterval: 60000
MinPauseBetweenCheckpoints: 5000
CheckpointingEnabledUpdate (boolean) --
Describes updates to whether checkpointing is enabled for an application.
Note
If CheckpointConfiguration.ConfigurationType is DEFAULT , the application will use a CheckpointingEnabled value of true , even if this value is set to another value using this API or in application code.
CheckpointIntervalUpdate (integer) --
Describes updates to the interval in milliseconds between checkpoint operations.
Note
If CheckpointConfiguration.ConfigurationType is DEFAULT , the application will use a CheckpointInterval value of 60000, even if this value is set to another value using this API or in application code.
MinPauseBetweenCheckpointsUpdate (integer) --
Describes updates to the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.
Note
If CheckpointConfiguration.ConfigurationType is DEFAULT , the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this API or in application code.
MonitoringConfigurationUpdate (dict) --
Describes updates to the configuration parameters for Amazon CloudWatch logging for an application.
ConfigurationTypeUpdate (string) --
Describes updates to whether to use the default CloudWatch logging configuration for an application. You must set this property to CUSTOM in order to set the LogLevel or MetricsLevel parameters.
MetricsLevelUpdate (string) --
Describes updates to the granularity of the CloudWatch Logs for an application. The Parallelism level is not recommended for applications with a Parallelism over 64 due to excessive costs.
LogLevelUpdate (string) --
Describes updates to the verbosity of the CloudWatch Logs for an application.
ParallelismConfigurationUpdate (dict) --
Describes updates to the parameters for how an application executes multiple tasks simultaneously.
ConfigurationTypeUpdate (string) --
Describes updates to whether the application uses the default parallelism for the Kinesis Data Analytics service, or if a custom parallelism is used. You must set this property to CUSTOM in order to change your application's AutoScalingEnabled , Parallelism , or ParallelismPerKPU properties.
ParallelismUpdate (integer) --
Describes updates to the initial number of parallel tasks an application can perform. If AutoScalingEnabled is set to True, then Kinesis Data Analytics can increase the CurrentParallelism value in response to application load. The service can increase CurrentParallelism up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service will reduce CurrentParallelism down to the Parallelism setting.
ParallelismPerKPUUpdate (integer) --
Describes updates to the number of parallel tasks an application can perform per Kinesis Processing Unit (KPU) used by the application.
AutoScalingEnabledUpdate (boolean) --
Describes updates to whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.
EnvironmentPropertyUpdates (dict) --
Describes updates to the environment properties for a Flink-based Kinesis Data Analytics application.
PropertyGroups (list) -- [REQUIRED]
Describes updates to the execution property groups.
(dict) --
Property key-value pairs passed into a Flink-based Kinesis Data Analytics application.
PropertyGroupId (string) -- [REQUIRED]
Describes the key of an application execution property key-value pair.
PropertyMap (dict) -- [REQUIRED]
Describes the value of an application execution property key-value pair.
(string) --
(string) --
ApplicationSnapshotConfigurationUpdate (dict) --
Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.
SnapshotsEnabledUpdate (boolean) -- [REQUIRED]
Describes updates to whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.
VpcConfigurationUpdates (list) --
Updates to the array of descriptions of VPC configurations available to the application.
(dict) --
Describes updates to the VPC configuration used by the application.
VpcConfigurationId (string) -- [REQUIRED]
Describes an update to the ID of the VPC configuration.
SubnetIdUpdates (list) --
Describes updates to the array of Subnet IDs used by the VPC configuration.
(string) --
SecurityGroupIdUpdates (list) --
Describes updates to the array of SecurityGroup IDs used by the VPC configuration.
(string) --
string
Describes updates to the service execution role.
dict
Describes updates to the application's starting parameters.
FlinkRunConfiguration (dict) --
Describes the starting parameters for a Flink-based Kinesis Data Analytics application.
AllowNonRestoredState (boolean) --
When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program. This will happen if the program is updated between snapshots to remove stateful parameters, and state data in the snapshot no longer corresponds to valid application data. For more information, see Allowing Non-Restored State in the Apache Flink documentation .
Note
This value defaults to false . If you update your application without specifying this parameter, AllowNonRestoredState will be set to false , even if it was previously set to true .
ApplicationRestoreConfiguration (dict) --
Describes updates to the restore behavior of a restarting application.
ApplicationRestoreType (string) -- [REQUIRED]
Specifies how the application should be restored.
SnapshotName (string) --
The identifier of an existing snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType .
list
Describes application Amazon CloudWatch logging option updates. You can only update existing CloudWatch logging options with this action. To add a new CloudWatch logging option, use AddApplicationCloudWatchLoggingOption .
(dict) --
Describes the Amazon CloudWatch logging option updates.
CloudWatchLoggingOptionId (string) -- [REQUIRED]
The ID of the CloudWatch logging option to update
LogStreamARNUpdate (string) --
The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.
string
A value you use to implement strong concurrency for application updates. You must provide the ApplicationVersionID or the ConditionalToken . You get the application's current ConditionalToken using DescribeApplication .
dict
Response Syntax
{
'ApplicationDetail': {
'ApplicationARN': 'string',
'ApplicationDescription': 'string',
'ApplicationName': 'string',
'RuntimeEnvironment': 'SQL-1_0'|'FLINK-1_6'|'FLINK-1_8'|'FLINK-1_11',
'ServiceExecutionRole': 'string',
'ApplicationStatus': 'DELETING'|'STARTING'|'STOPPING'|'READY'|'RUNNING'|'UPDATING'|'AUTOSCALING'|'FORCE_STOPPING'|'MAINTENANCE'|'ROLLING_BACK',
'ApplicationVersionId': 123,
'CreateTimestamp': datetime(2015, 1, 1),
'LastUpdateTimestamp': datetime(2015, 1, 1),
'ApplicationConfigurationDescription': {
'SqlApplicationConfigurationDescription': {
'InputDescriptions': [
{
'InputId': 'string',
'NamePrefix': 'string',
'InAppStreamNames': [
'string',
],
'InputProcessingConfigurationDescription': {
'InputLambdaProcessorDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
}
},
'KinesisStreamsInputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'KinesisFirehoseInputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'InputSchema': {
'RecordFormat': {
'RecordFormatType': 'JSON'|'CSV',
'MappingParameters': {
'JSONMappingParameters': {
'RecordRowPath': 'string'
},
'CSVMappingParameters': {
'RecordRowDelimiter': 'string',
'RecordColumnDelimiter': 'string'
}
}
},
'RecordEncoding': 'string',
'RecordColumns': [
{
'Name': 'string',
'Mapping': 'string',
'SqlType': 'string'
},
]
},
'InputParallelism': {
'Count': 123
},
'InputStartingPositionConfiguration': {
'InputStartingPosition': 'NOW'|'TRIM_HORIZON'|'LAST_STOPPED_POINT'
}
},
],
'OutputDescriptions': [
{
'OutputId': 'string',
'Name': 'string',
'KinesisStreamsOutputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'KinesisFirehoseOutputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'LambdaOutputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'DestinationSchema': {
'RecordFormatType': 'JSON'|'CSV'
}
},
],
'ReferenceDataSourceDescriptions': [
{
'ReferenceId': 'string',
'TableName': 'string',
'S3ReferenceDataSourceDescription': {
'BucketARN': 'string',
'FileKey': 'string',
'ReferenceRoleARN': 'string'
},
'ReferenceSchema': {
'RecordFormat': {
'RecordFormatType': 'JSON'|'CSV',
'MappingParameters': {
'JSONMappingParameters': {
'RecordRowPath': 'string'
},
'CSVMappingParameters': {
'RecordRowDelimiter': 'string',
'RecordColumnDelimiter': 'string'
}
}
},
'RecordEncoding': 'string',
'RecordColumns': [
{
'Name': 'string',
'Mapping': 'string',
'SqlType': 'string'
},
]
}
},
]
},
'ApplicationCodeConfigurationDescription': {
'CodeContentType': 'PLAINTEXT'|'ZIPFILE',
'CodeContentDescription': {
'TextContent': 'string',
'CodeMD5': 'string',
'CodeSize': 123,
'S3ApplicationCodeLocationDescription': {
'BucketARN': 'string',
'FileKey': 'string',
'ObjectVersion': 'string'
}
}
},
'RunConfigurationDescription': {
'ApplicationRestoreConfigurationDescription': {
'ApplicationRestoreType': 'SKIP_RESTORE_FROM_SNAPSHOT'|'RESTORE_FROM_LATEST_SNAPSHOT'|'RESTORE_FROM_CUSTOM_SNAPSHOT',
'SnapshotName': 'string'
},
'FlinkRunConfigurationDescription': {
'AllowNonRestoredState': True|False
}
},
'FlinkApplicationConfigurationDescription': {
'CheckpointConfigurationDescription': {
'ConfigurationType': 'DEFAULT'|'CUSTOM',
'CheckpointingEnabled': True|False,
'CheckpointInterval': 123,
'MinPauseBetweenCheckpoints': 123
},
'MonitoringConfigurationDescription': {
'ConfigurationType': 'DEFAULT'|'CUSTOM',
'MetricsLevel': 'APPLICATION'|'TASK'|'OPERATOR'|'PARALLELISM',
'LogLevel': 'INFO'|'WARN'|'ERROR'|'DEBUG'
},
'ParallelismConfigurationDescription': {
'ConfigurationType': 'DEFAULT'|'CUSTOM',
'Parallelism': 123,
'ParallelismPerKPU': 123,
'CurrentParallelism': 123,
'AutoScalingEnabled': True|False
},
'JobPlanDescription': 'string'
},
'EnvironmentPropertyDescriptions': {
'PropertyGroupDescriptions': [
{
'PropertyGroupId': 'string',
'PropertyMap': {
'string': 'string'
}
},
]
},
'ApplicationSnapshotConfigurationDescription': {
'SnapshotsEnabled': True|False
},
'VpcConfigurationDescriptions': [
{
'VpcConfigurationId': 'string',
'VpcId': 'string',
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
]
},
'CloudWatchLoggingOptionDescriptions': [
{
'CloudWatchLoggingOptionId': 'string',
'LogStreamARN': 'string',
'RoleARN': 'string'
},
],
'ApplicationMaintenanceConfigurationDescription': {
'ApplicationMaintenanceWindowStartTime': 'string',
'ApplicationMaintenanceWindowEndTime': 'string'
},
'ApplicationVersionUpdatedFrom': 123,
'ApplicationVersionRolledBackFrom': 123,
'ConditionalToken': 'string'
}
}
Response Structure
(dict) --
ApplicationDetail (dict) --
Describes application updates.
ApplicationARN (string) --
The ARN of the application.
ApplicationDescription (string) --
The description of the application.
ApplicationName (string) --
The name of the application.
RuntimeEnvironment (string) --
The runtime environment for the application (SQL-1_0 , FLINK-1_6 , FLINK-1_8 , or FLINK-1_11 ).
ServiceExecutionRole (string) --
Specifies the IAM role that the application uses to access external resources.
ApplicationStatus (string) --
The status of the application.
ApplicationVersionId (integer) --
Provides the current application version. Kinesis Data Analytics updates the ApplicationVersionId each time you update the application.
CreateTimestamp (datetime) --
The current timestamp when the application was created.
LastUpdateTimestamp (datetime) --
The current timestamp when the application was last updated.
ApplicationConfigurationDescription (dict) --
Provides details about the application's Java, SQL, or Scala code and starting parameters.
SqlApplicationConfigurationDescription (dict) --
The details about inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.
InputDescriptions (list) --
The array of InputDescription objects describing the input streams used by the application.
(dict) --
Describes the application input configuration for a SQL-based Kinesis Data Analytics application.
InputId (string) --
The input ID that is associated with the application input. This is the ID that Kinesis Data Analytics assigns to each input configuration that you add to your application.
NamePrefix (string) --
The in-application name prefix.
InAppStreamNames (list) --
Returns the in-application stream names that are mapped to the stream source.
(string) --
InputProcessingConfigurationDescription (dict) --
The description of the preprocessor that executes on records in this input before the application's code is run.
InputLambdaProcessorDescription (dict) --
Provides configuration information about the associated InputLambdaProcessorDescription
ResourceARN (string) --
The ARN of the AWS Lambda function that is used to preprocess the records in the stream.
Note
To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda
RoleARN (string) --
The ARN of the IAM role that is used to access the AWS Lambda function.
Note
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
KinesisStreamsInputDescription (dict) --
If a Kinesis data stream is configured as a streaming source, provides the Kinesis data stream's Amazon Resource Name (ARN).
ResourceARN (string) --
The Amazon Resource Name (ARN) of the Kinesis data stream.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
Note
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
KinesisFirehoseInputDescription (dict) --
If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN.
ResourceARN (string) --
The Amazon Resource Name (ARN) of the delivery stream.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics assumes to access the stream.
Note
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
InputSchema (dict) --
Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.
RecordFormat (dict) --
Specifies the format of the records on the streaming source.
RecordFormatType (string) --
The type of record format.
MappingParameters (dict) --
When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.
JSONMappingParameters (dict) --
Provides additional mapping information when JSON is the record format on the streaming source.
RecordRowPath (string) --
The path to the top-level parent that contains the records.
CSVMappingParameters (dict) --
Provides additional mapping information when the record format uses delimiters (for example, CSV).
RecordRowDelimiter (string) --
The row delimiter. For example, in a CSV format, 'n' is the typical row delimiter.
RecordColumnDelimiter (string) --
The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
RecordEncoding (string) --
Specifies the encoding of the records in the streaming source. For example, UTF-8.
RecordColumns (list) --
A list of RecordColumn objects.
(dict) --
For a SQL-based Kinesis Data Analytics application, describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream.
Also used to describe the format of the reference data source.
Name (string) --
The name of the column that is created in the in-application input stream or reference table.
Mapping (string) --
A reference to the data element in the streaming input or the reference data source.
SqlType (string) --
The type of column created in the in-application input stream or reference table.
InputParallelism (dict) --
Describes the configured parallelism (number of in-application streams mapped to the streaming source).
Count (integer) --
The number of in-application streams to create.
InputStartingPositionConfiguration (dict) --
The point at which the application is configured to read from the input stream.
InputStartingPosition (string) --
The starting position on the stream.
NOW - Start reading just after the most recent record in the stream, and start at the request timestamp that the customer issued.
TRIM_HORIZON - Start reading at the last untrimmed record in the stream, which is the oldest record available in the stream. This option is not available for an Amazon Kinesis Data Firehose delivery stream.
LAST_STOPPED_POINT - Resume reading from where the application last stopped reading.
OutputDescriptions (list) --
The array of OutputDescription objects describing the destination streams used by the application.
(dict) --
For a SQL-based Kinesis Data Analytics application, describes the application output configuration, which includes the in-application stream name and the destination where the stream data is written. The destination can be a Kinesis data stream or a Kinesis Data Firehose delivery stream.
OutputId (string) --
A unique identifier for the output configuration.
Name (string) --
The name of the in-application stream that is configured as output.
KinesisStreamsOutputDescription (dict) --
Describes the Kinesis data stream that is configured as the destination where output is written.
ResourceARN (string) --
The Amazon Resource Name (ARN) of the Kinesis data stream.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
Note
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
KinesisFirehoseOutputDescription (dict) --
Describes the Kinesis Data Firehose delivery stream that is configured as the destination where output is written.
ResourceARN (string) --
The Amazon Resource Name (ARN) of the delivery stream.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
Note
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
LambdaOutputDescription (dict) --
Describes the Lambda function that is configured as the destination where output is written.
ResourceARN (string) --
The Amazon Resource Name (ARN) of the destination Lambda function.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to write to the destination function.
Note
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
DestinationSchema (dict) --
The data format used for writing data to the destination.
RecordFormatType (string) --
Specifies the format of the records on the output stream.
ReferenceDataSourceDescriptions (list) --
The array of ReferenceDataSourceDescription objects describing the reference data sources used by the application.
(dict) --
For a SQL-based Kinesis Data Analytics application, describes the reference data source configured for an application.
ReferenceId (string) --
The ID of the reference data source. This is the ID that Kinesis Data Analytics assigns when you add the reference data source to your application using the CreateApplication or UpdateApplication operation.
TableName (string) --
The in-application table name created by the specific reference data source configuration.
S3ReferenceDataSourceDescription (dict) --
Provides the Amazon S3 bucket name, the object key name that contains the reference data.
BucketARN (string) --
The Amazon Resource Name (ARN) of the S3 bucket.
FileKey (string) --
Amazon S3 object key name.
ReferenceRoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf to populate the in-application reference table.
Note
Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
ReferenceSchema (dict) --
Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.
RecordFormat (dict) --
Specifies the format of the records on the streaming source.
RecordFormatType (string) --
The type of record format.
MappingParameters (dict) --
When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.
JSONMappingParameters (dict) --
Provides additional mapping information when JSON is the record format on the streaming source.
RecordRowPath (string) --
The path to the top-level parent that contains the records.
CSVMappingParameters (dict) --
Provides additional mapping information when the record format uses delimiters (for example, CSV).
RecordRowDelimiter (string) --
The row delimiter. For example, in a CSV format, 'n' is the typical row delimiter.
RecordColumnDelimiter (string) --
The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
RecordEncoding (string) --
Specifies the encoding of the records in the streaming source. For example, UTF-8.
RecordColumns (list) --
A list of RecordColumn objects.
(dict) --
For a SQL-based Kinesis Data Analytics application, describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream.
Also used to describe the format of the reference data source.
Name (string) --
The name of the column that is created in the in-application input stream or reference table.
Mapping (string) --
A reference to the data element in the streaming input or the reference data source.
SqlType (string) --
The type of column created in the in-application input stream or reference table.
ApplicationCodeConfigurationDescription (dict) --
The details about the application code for a Flink-based Kinesis Data Analytics application.
CodeContentType (string) --
Specifies whether the code content is in text or zip format.
CodeContentDescription (dict) --
Describes details about the location and format of the application code.
TextContent (string) --
The text-format code
CodeMD5 (string) --
The checksum that can be used to validate zip-format code.
CodeSize (integer) --
The size in bytes of the application code. Can be used to validate zip-format code.
S3ApplicationCodeLocationDescription (dict) --
The S3 bucket Amazon Resource Name (ARN), file key, and object version of the application code stored in Amazon S3.
BucketARN (string) --
The Amazon Resource Name (ARN) for the S3 bucket containing the application code.
FileKey (string) --
The file key for the object containing the application code.
ObjectVersion (string) --
The version of the object containing the application code.
RunConfigurationDescription (dict) --
The details about the starting properties for a Kinesis Data Analytics application.
ApplicationRestoreConfigurationDescription (dict) --
Describes the restore behavior of a restarting application.
ApplicationRestoreType (string) --
Specifies how the application should be restored.
SnapshotName (string) --
The identifier of an existing snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType .
FlinkRunConfigurationDescription (dict) --
Describes the starting parameters for a Flink-based Kinesis Data Analytics application.
AllowNonRestoredState (boolean) --
When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program. This will happen if the program is updated between snapshots to remove stateful parameters, and state data in the snapshot no longer corresponds to valid application data. For more information, see Allowing Non-Restored State in the Apache Flink documentation .
Note
This value defaults to false . If you update your application without specifying this parameter, AllowNonRestoredState will be set to false , even if it was previously set to true .
FlinkApplicationConfigurationDescription (dict) --
The details about a Flink-based Kinesis Data Analytics application.
CheckpointConfigurationDescription (dict) --
Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance.
ConfigurationType (string) --
Describes whether the application uses the default checkpointing behavior in Kinesis Data Analytics.
Note
If this value is set to DEFAULT , the application will use the following values, even if they are set to other values using APIs or application code:
CheckpointingEnabled: true
CheckpointInterval: 60000
MinPauseBetweenCheckpoints: 5000
CheckpointingEnabled (boolean) --
Describes whether checkpointing is enabled for a Flink-based Kinesis Data Analytics application.
Note
If CheckpointConfiguration.ConfigurationType is DEFAULT , the application will use a CheckpointingEnabled value of true , even if this value is set to another value using this API or in application code.
CheckpointInterval (integer) --
Describes the interval in milliseconds between checkpoint operations.
Note
If CheckpointConfiguration.ConfigurationType is DEFAULT , the application will use a CheckpointInterval value of 60000, even if this value is set to another value using this API or in application code.
MinPauseBetweenCheckpoints (integer) --
Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.
Note
If CheckpointConfiguration.ConfigurationType is DEFAULT , the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this API or in application code.
MonitoringConfigurationDescription (dict) --
Describes configuration parameters for Amazon CloudWatch logging for an application.
ConfigurationType (string) --
Describes whether to use the default CloudWatch logging configuration for an application.
MetricsLevel (string) --
Describes the granularity of the CloudWatch Logs for an application.
LogLevel (string) --
Describes the verbosity of the CloudWatch Logs for an application.
ParallelismConfigurationDescription (dict) --
Describes parameters for how an application executes multiple tasks simultaneously.
ConfigurationType (string) --
Describes whether the application uses the default parallelism for the Kinesis Data Analytics service.
Parallelism (integer) --
Describes the initial number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, then Kinesis Data Analytics can increase the CurrentParallelism value in response to application load. The service can increase CurrentParallelism up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.
ParallelismPerKPU (integer) --
Describes the number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application.
CurrentParallelism (integer) --
Describes the current number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, Kinesis Data Analytics can increase this value in response to application load. The service can increase this value up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.
AutoScalingEnabled (boolean) --
Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.
JobPlanDescription (string) --
The job plan for an application. For more information about the job plan, see Jobs and Scheduling in the Apache Flink Documentation . To retrieve the job plan for the application, use the DescribeApplicationRequest$IncludeAdditionalDetails parameter of the DescribeApplication operation.
EnvironmentPropertyDescriptions (dict) --
Describes execution properties for a Flink-based Kinesis Data Analytics application.
PropertyGroupDescriptions (list) --
Describes the execution property groups.
(dict) --
Property key-value pairs passed into a Flink-based Kinesis Data Analytics application.
PropertyGroupId (string) --
Describes the key of an application execution property key-value pair.
PropertyMap (dict) --
Describes the value of an application execution property key-value pair.
(string) --
(string) --
ApplicationSnapshotConfigurationDescription (dict) --
Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.
SnapshotsEnabled (boolean) --
Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.
VpcConfigurationDescriptions (list) --
The array of descriptions of VPC configurations available to the application.
(dict) --
Describes the parameters of a VPC used by the application.
VpcConfigurationId (string) --
The ID of the VPC configuration.
VpcId (string) --
The ID of the associated VPC.
SubnetIds (list) --
The array of Subnet IDs used by the VPC configuration.
(string) --
SecurityGroupIds (list) --
The array of SecurityGroup IDs used by the VPC configuration.
(string) --
CloudWatchLoggingOptionDescriptions (list) --
Describes the application Amazon CloudWatch logging options.
(dict) --
Describes the Amazon CloudWatch logging option.
CloudWatchLoggingOptionId (string) --
The ID of the CloudWatch logging option description.
LogStreamARN (string) --
The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.
RoleARN (string) --
The IAM ARN of the role to use to send application messages.
Note
Provided for backward compatibility. Applications created with the current API version have an application-level service execution role rather than a resource-level role.
ApplicationMaintenanceConfigurationDescription (dict) --
Describes the time window for automatic application maintenance.
ApplicationMaintenanceWindowStartTime (string) --
The start time for the automatic maintenance window.
ApplicationMaintenanceWindowEndTime (string) --
The end time for the automatic maintenance window.
ApplicationVersionUpdatedFrom (integer) --
The previous application version before the latest application update. RollbackApplication reverts the application to this version.
ApplicationVersionRolledBackFrom (integer) --
If you reverted the application using RollbackApplication , the application version when RollbackApplication was called.
ConditionalToken (string) --
A value you use to implement strong concurrency for application updates.