Smaws_Client_KinesisAnalyticsV2.Types
type nonrec zeppelin_monitoring_configuration_update = {
log_level_update : log_level;
Updates to the logging level for Apache Zeppelin within a Managed Service for Apache Flink Studio notebook.
*)}
Updates to the monitoring configuration for Apache Zeppelin within a Managed Service for Apache Flink Studio notebook.
type nonrec zeppelin_monitoring_configuration_description = {
log_level : log_level option;
Describes the verbosity of the CloudWatch Logs for an application.
*)}
The monitoring configuration for Apache Zeppelin within a Managed Service for Apache Flink Studio notebook.
type nonrec zeppelin_monitoring_configuration = {
log_level : log_level;
The verbosity of the CloudWatch Logs for an application.
*)}
Describes configuration parameters for Amazon CloudWatch logging for a Managed Service for Apache Flink Studio notebook. For more information about CloudWatch logging, see Monitoring.
type nonrec glue_data_catalog_configuration_update = {
database_arn_update : database_ar_n;
The updated Amazon Resource Name (ARN) of the database.
*)}
Updates to the configuration of the Glue Data Catalog that you use for SQL queries that you write in a Managed Service for Apache Flink Studio notebook.
type nonrec catalog_configuration_update = {
glue_data_catalog_configuration_update : glue_data_catalog_configuration_update;
Updates to the configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Managed Service for Apache Flink Studio notebook.
*)}
Updates to the configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Managed Service for Apache Flink Studio notebook.
type nonrec s3_content_base_location_update = {
base_path_update : base_path option;
The updated S3 bucket path.
*)bucket_arn_update : bucket_ar_n option;
The updated Amazon Resource Name (ARN) of the S3 bucket.
*)}
The information required to update the S3 base location that holds the application.
type nonrec deploy_as_application_configuration_update = {
s3_content_location_update : s3_content_base_location_update option;
Updates to the location that holds the data required to specify an Amazon Data Analytics application.
*)}
Updates to the configuration information required to deploy an Amazon Data Analytics Studio notebook as an application with durable state.
type nonrec s3_content_location = {
object_version : object_version option;
The version of the object containing the application code.
*)file_key : file_key;
The file key for the object containing the application code.
*)bucket_ar_n : bucket_ar_n;
The Amazon Resource Name (ARN) for the S3 bucket containing the application code.
*)}
For a Managed Service for Apache Flink application provides a description of an Amazon S3 object, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data.
type nonrec maven_reference = {
version : maven_version;
The version of the Maven reference.
*)artifact_id : maven_artifact_id;
The artifact ID of the Maven reference.
*)group_id : maven_group_id;
The group ID of the Maven reference.
*)}
The information required to specify a Maven reference. You can use Maven references to specify dependency JAR files.
type nonrec custom_artifact_configuration = {
maven_reference : maven_reference option;
The parameters required to fully specify a Maven reference.
*)s3_content_location : s3_content_location option;
artifact_type : artifact_type;
UDF
stands for user-defined functions. This type of artifact must be in an S3 bucket. A DEPENDENCY_JAR
can be in either Maven or an S3 bucket.
}
Specifies dependency JARs, as well as JAR files that contain user-defined functions (UDF).
type nonrec custom_artifacts_configuration_list =
custom_artifact_configuration list
type nonrec zeppelin_application_configuration_update = {
custom_artifacts_configuration_update : custom_artifacts_configuration_list
option;
Updates to the customer artifacts. Custom artifacts are dependency JAR files and user-defined functions (UDF).
*)deploy_as_application_configuration_update : deploy_as_application_configuration_update
option;
catalog_configuration_update : catalog_configuration_update option;
Updates to the configuration of the Amazon Glue Data Catalog that is associated with the Managed Service for Apache Flink Studio notebook.
*)monitoring_configuration_update : zeppelin_monitoring_configuration_update
option;
Updates to the monitoring configuration of a Managed Service for Apache Flink Studio notebook.
*)}
Updates to the configuration of Managed Service for Apache Flink Studio notebook.
type nonrec glue_data_catalog_configuration_description = {
database_ar_n : database_ar_n;
The Amazon Resource Name (ARN) of the database.
*)}
The configuration of the Glue Data Catalog that you use for Apache Flink SQL queries and table API transforms that you write in an application.
type nonrec catalog_configuration_description = {
glue_data_catalog_configuration_description : glue_data_catalog_configuration_description;
The configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Managed Service for Apache Flink Studio notebook.
*)}
The configuration parameters for the default Amazon Glue database. You use this database for Apache Flink SQL queries and table API transforms that you write in a Managed Service for Apache Flink Studio notebook.
type nonrec s3_content_base_location_description = {
base_path : base_path option;
The base path for the S3 bucket.
*)bucket_ar_n : bucket_ar_n;
The Amazon Resource Name (ARN) of the S3 bucket.
*)}
The description of the S3 base location that holds the application.
type nonrec deploy_as_application_configuration_description = {
s3_content_location_description : s3_content_base_location_description;
The location that holds the data required to specify an Amazon Data Analytics application.
*)}
The configuration information required to deploy an Amazon Data Analytics Studio notebook as an application with durable state.
type nonrec custom_artifact_configuration_description = {
maven_reference_description : maven_reference option;
The parameters that are required to specify a Maven dependency.
*)s3_content_location_description : s3_content_location option;
artifact_type : artifact_type option;
UDF
stands for user-defined functions. This type of artifact must be in an S3 bucket. A DEPENDENCY_JAR
can be in either Maven or an S3 bucket.
}
Specifies a dependency JAR or a JAR of user-defined functions.
type nonrec custom_artifacts_configuration_description_list =
custom_artifact_configuration_description list
type nonrec zeppelin_application_configuration_description = {
custom_artifacts_configuration_description : custom_artifacts_configuration_description_list
option;
Custom artifacts are dependency JARs and user-defined functions (UDF).
*)deploy_as_application_configuration_description : deploy_as_application_configuration_description
option;
The parameters required to deploy a Managed Service for Apache Flink Studio notebook as an application with durable state.
*)catalog_configuration_description : catalog_configuration_description option;
The Amazon Glue Data Catalog that is associated with the Managed Service for Apache Flink Studio notebook.
*)monitoring_configuration_description : zeppelin_monitoring_configuration_description;
The monitoring configuration of a Managed Service for Apache Flink Studio notebook.
*)}
The configuration of a Managed Service for Apache Flink Studio notebook.
type nonrec glue_data_catalog_configuration = {
database_ar_n : database_ar_n;
The Amazon Resource Name (ARN) of the database.
*)}
The configuration of the Glue Data Catalog that you use for Apache Flink SQL queries and table API transforms that you write in an application.
type nonrec catalog_configuration = {
glue_data_catalog_configuration : glue_data_catalog_configuration;
The configuration parameters for the default Amazon Glue database. You use this database for Apache Flink SQL queries and table API transforms that you write in a Managed Service for Apache Flink Studio notebook.
*)}
The configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Managed Service for Apache Flink Studio notebook.
type nonrec s3_content_base_location = {
base_path : base_path option;
The base path for the S3 bucket.
*)bucket_ar_n : bucket_ar_n;
The Amazon Resource Name (ARN) of the S3 bucket.
*)}
The S3 bucket that holds the application information.
type nonrec deploy_as_application_configuration = {
s3_content_location : s3_content_base_location;
The description of an Amazon S3 object that contains the Amazon Data Analytics application, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data.
*)}
The information required to deploy a Managed Service for Apache Flink Studio notebook as an application with durable state.
type nonrec zeppelin_application_configuration = {
custom_artifacts_configuration : custom_artifacts_configuration_list option;
Custom artifacts are dependency JARs and user-defined functions (UDF).
*)deploy_as_application_configuration : deploy_as_application_configuration
option;
The information required to deploy a Managed Service for Apache Flink Studio notebook as an application with durable state.
*)catalog_configuration : catalog_configuration option;
The Amazon Glue Data Catalog that you use in queries in a Managed Service for Apache Flink Studio notebook.
*)monitoring_configuration : zeppelin_monitoring_configuration option;
The monitoring configuration of a Managed Service for Apache Flink Studio notebook.
*)}
The configuration of a Managed Service for Apache Flink Studio notebook.
type nonrec subnet_ids = subnet_id list
type nonrec security_group_ids = security_group_id list
Describes the parameters of a VPC used by the application.
type nonrec vpc_configurations = vpc_configuration list
type nonrec vpc_configuration_update = {
security_group_id_updates : security_group_ids option;
subnet_id_updates : subnet_ids option;
vpc_configuration_id : id;
Describes an update to the ID of the VPC configuration.
*)}
Describes updates to the VPC configuration used by the application.
type nonrec vpc_configuration_updates = vpc_configuration_update list
type nonrec vpc_configuration_description = {
security_group_ids : security_group_ids;
subnet_ids : subnet_ids;
vpc_id : vpc_id;
The ID of the associated VPC.
*)vpc_configuration_id : id;
The ID of the VPC configuration.
*)}
Describes the parameters of a VPC used by the application.
type nonrec vpc_configuration_descriptions = vpc_configuration_description list
type nonrec in_app_stream_names = in_app_stream_name list
type nonrec input_lambda_processor_description = {
role_ar_n : role_ar_n option;
The ARN of the IAM role that is used to access the Amazon Lambda function.
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.
*)resource_ar_n : resource_ar_n;
The ARN of the Amazon Lambda function that is used to preprocess the records in the stream.
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: Amazon Lambda
*)}
For a SQL-based Kinesis Data Analytics application, an object that contains the Amazon Resource Name (ARN) of the Amazon Lambda function that is used to preprocess records in the stream.
type nonrec input_processing_configuration_description = {
input_lambda_processor_description : input_lambda_processor_description option;
Provides configuration information about the associated InputLambdaProcessorDescription
}
For a SQL-based Kinesis Data Analytics application, provides the configuration information about an input processor. Currently, the only input processor available is Amazon Lambda.
type nonrec kinesis_streams_input_description = {
role_ar_n : role_ar_n option;
The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
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.
*)resource_ar_n : resource_ar_n;
The Amazon Resource Name (ARN) of the Kinesis data stream.
*)}
For a SQL-based Kinesis Data Analytics application, describes the Kinesis data stream that is configured as the streaming source in the application input configuration.
type nonrec kinesis_firehose_input_description = {
role_ar_n : role_ar_n option;
The ARN of the IAM role that Kinesis Data Analytics assumes to access the stream.
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.
*)resource_ar_n : resource_ar_n;
The Amazon Resource Name (ARN) of the delivery stream.
*)}
Describes the Amazon Kinesis Data Firehose delivery stream that is configured as the streaming source in the application input configuration.
type nonrec json_mapping_parameters = {
record_row_path : record_row_path;
The path to the top-level parent that contains the records.
*)}
For a SQL-based Kinesis Data Analytics application, provides additional mapping information when JSON is the record format on the streaming source.
type nonrec csv_mapping_parameters = {
record_column_delimiter : record_column_delimiter;
The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
*)record_row_delimiter : record_row_delimiter;
The row delimiter. For example, in a CSV format, '\n' is the typical row delimiter.
*)}
For a SQL-based Kinesis Data Analytics application, provides additional mapping information when the record format uses delimiters, such as CSV. For example, the following sample records use CSV format, where the records use the '\n' as the row delimiter and a comma (",") as the column delimiter:
"name1", "address1"
"name2", "address2"
type nonrec mapping_parameters = {
csv_mapping_parameters : csv_mapping_parameters option;
Provides additional mapping information when the record format uses delimiters (for example, CSV).
*)json_mapping_parameters : json_mapping_parameters option;
Provides additional mapping information when JSON is the record format on the streaming source.
*)}
When you configure a SQL-based Kinesis Data Analytics application's 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.
type nonrec record_format = {
mapping_parameters : mapping_parameters option;
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.
*)record_format_type : record_format_type;
The type of record format.
*)}
For a SQL-based Kinesis Data Analytics application, describes the record format and relevant mapping information that should be applied to schematize the records on the stream.
type nonrec record_column = {
sql_type : record_column_sql_type;
The type of column created in the in-application input stream or reference table.
*)mapping : record_column_mapping option;
A reference to the data element in the streaming input or the reference data source.
*)name : record_column_name;
The name of the column that is created in the in-application input stream or reference table.
*)}
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.
type nonrec record_columns = record_column list
type nonrec source_schema = {
record_columns : record_columns;
A list of RecordColumn
objects.
record_encoding : record_encoding option;
Specifies the encoding of the records in the streaming source. For example, UTF-8.
*)record_format : record_format;
Specifies the format of the records on the streaming source.
*)}
For a SQL-based Kinesis Data Analytics application, 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.
type nonrec input_parallelism = {
count : input_parallelism_count option;
The number of in-application streams to create.
*)}
For a SQL-based Kinesis Data Analytics application, describes the number of in-application streams to create for a given streaming source.
type nonrec input_starting_position_configuration = {
input_starting_position : input_starting_position option;
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.}
Describes the point at which the application reads from the streaming source.
type nonrec input_description = {
input_starting_position_configuration : input_starting_position_configuration
option;
The point at which the application is configured to read from the input stream.
*)input_parallelism : input_parallelism option;
Describes the configured parallelism (number of in-application streams mapped to the streaming source).
*)input_schema : source_schema option;
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.
*)kinesis_firehose_input_description : kinesis_firehose_input_description option;
If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN.
*)kinesis_streams_input_description : kinesis_streams_input_description option;
If a Kinesis data stream is configured as a streaming source, provides the Kinesis data stream's Amazon Resource Name (ARN).
*)input_processing_configuration_description : input_processing_configuration_description
option;
The description of the preprocessor that executes on records in this input before the application's code is run.
*)in_app_stream_names : in_app_stream_names option;
Returns the in-application stream names that are mapped to the stream source.
*)name_prefix : in_app_stream_name option;
The in-application name prefix.
*)input_id : id option;
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.
*)}
Describes the application input configuration for a SQL-based Kinesis Data Analytics application.
type nonrec input_descriptions = input_description list
type nonrec kinesis_streams_output_description = {
role_ar_n : role_ar_n option;
The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
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.
*)resource_ar_n : resource_ar_n;
The Amazon Resource Name (ARN) of the Kinesis data stream.
*)}
For an SQL-based Kinesis Data Analytics application's output, describes the Kinesis data stream that is configured as its destination.
type nonrec kinesis_firehose_output_description = {
role_ar_n : role_ar_n option;
The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
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.
*)resource_ar_n : resource_ar_n;
The Amazon Resource Name (ARN) of the delivery stream.
*)}
For a SQL-based Kinesis Data Analytics application's output, describes the Kinesis Data Firehose delivery stream that is configured as its destination.
type nonrec lambda_output_description = {
role_ar_n : role_ar_n option;
The ARN of the IAM role that Kinesis Data Analytics can assume to write to the destination function.
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.
*)resource_ar_n : resource_ar_n;
The Amazon Resource Name (ARN) of the destination Lambda function.
*)}
For a SQL-based Kinesis Data Analytics application's output, describes the Amazon Lambda function that is configured as its destination.
type nonrec destination_schema = {
record_format_type : record_format_type;
Specifies the format of the records on the output stream.
*)}
Describes the data format when records are written to the destination in a SQL-based Kinesis Data Analytics application.
type nonrec output_description = {
destination_schema : destination_schema option;
The data format used for writing data to the destination.
*)lambda_output_description : lambda_output_description option;
Describes the Lambda function that is configured as the destination where output is written.
*)kinesis_firehose_output_description : kinesis_firehose_output_description
option;
Describes the Kinesis Data Firehose delivery stream that is configured as the destination where output is written.
*)kinesis_streams_output_description : kinesis_streams_output_description option;
Describes the Kinesis data stream that is configured as the destination where output is written.
*)name : in_app_stream_name option;
The name of the in-application stream that is configured as output.
*)output_id : id option;
A unique identifier for the output configuration.
*)}
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.
type nonrec output_descriptions = output_description list
type nonrec s3_reference_data_source_description = {
reference_role_ar_n : role_ar_n option;
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.
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.
*)file_key : file_key;
Amazon S3 object key name.
*)bucket_ar_n : bucket_ar_n;
The Amazon Resource Name (ARN) of the S3 bucket.
*)}
For a SQL-based Kinesis Data Analytics application, provides the bucket name and object key name that stores the reference data.
type nonrec reference_data_source_description = {
reference_schema : source_schema option;
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.
*)s3_reference_data_source_description : s3_reference_data_source_description;
Provides the Amazon S3 bucket name, the object key name that contains the reference data.
*)table_name : in_app_table_name;
The in-application table name created by the specific reference data source configuration.
*)reference_id : id;
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.
}
For a SQL-based Kinesis Data Analytics application, describes the reference data source configured for an application.
type nonrec reference_data_source_descriptions =
reference_data_source_description list
type nonrec sql_application_configuration_description = {
reference_data_source_descriptions : reference_data_source_descriptions option;
The array of ReferenceDataSourceDescription
objects describing the reference data sources used by the application.
output_descriptions : output_descriptions option;
The array of OutputDescription
objects describing the destination streams used by the application.
input_descriptions : input_descriptions option;
The array of InputDescription
objects describing the input streams used by the application.
}
Describes the inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.
type nonrec s3_application_code_location_description = {
object_version : object_version option;
The version of the object containing the application code.
*)file_key : file_key;
The file key for the object containing the application code.
*)bucket_ar_n : bucket_ar_n;
The Amazon Resource Name (ARN) for the S3 bucket containing the application code.
*)}
Describes the location of an application's code stored in an S3 bucket.
type nonrec code_content_description = {
s3_application_code_location_description : s3_application_code_location_description
option;
The S3 bucket Amazon Resource Name (ARN), file key, and object version of the application code stored in Amazon S3.
*)code_size : code_size option;
The size in bytes of the application code. Can be used to validate zip-format code.
*)code_m_d5 : code_m_d5 option;
The checksum that can be used to validate zip-format code.
*)text_content : text_content option;
The text-format code
*)}
Describes details about the code of a Managed Service for Apache Flink application.
type nonrec application_code_configuration_description = {
code_content_description : code_content_description option;
Describes details about the location and format of the application code.
*)code_content_type : code_content_type;
Specifies whether the code content is in text or zip format.
*)}
Describes code configuration for an application.
type nonrec application_restore_configuration = {
snapshot_name : snapshot_name option;
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
.
application_restore_type : application_restore_type;
Specifies how the application should be restored.
*)}
Specifies the method and snapshot to use when restarting an application using previously saved application state.
type nonrec flink_run_configuration = {
allow_non_restored_state : boolean_object option;
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.
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
.
}
Describes the starting parameters for a Managed Service for Apache Flink application.
type nonrec run_configuration_description = {
flink_run_configuration_description : flink_run_configuration option;
application_restore_configuration_description : application_restore_configuration
option;
Describes the restore behavior of a restarting application.
*)}
Describes the starting properties for a Managed Service for Apache Flink application.
type nonrec checkpoint_configuration_description = {
min_pause_between_checkpoints : min_pause_between_checkpoints option;
Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.
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.
checkpoint_interval : checkpoint_interval option;
Describes the interval in milliseconds between checkpoint operations.
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.
checkpointing_enabled : boolean_object option;
Describes whether checkpointing is enabled for a Managed Service for Apache Flink application.
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.
configuration_type : configuration_type option;
Describes whether the application uses the default checkpointing behavior in Managed Service for Apache Flink.
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:
}
Describes checkpointing parameters for a Managed Service for Apache Flink application.
type nonrec monitoring_configuration_description = {
log_level : log_level option;
Describes the verbosity of the CloudWatch Logs for an application.
*)metrics_level : metrics_level option;
Describes the granularity of the CloudWatch Logs for an application.
*)configuration_type : configuration_type option;
Describes whether to use the default CloudWatch logging configuration for an application.
*)}
Describes configuration parameters for CloudWatch logging for an application.
type nonrec parallelism_configuration_description = {
auto_scaling_enabled : boolean_object option;
Describes whether the Managed Service for Apache Flink service can increase the parallelism of the application in response to increased throughput.
*)current_parallelism : parallelism option;
Describes the current number of parallel tasks that a Managed Service for Apache Flink application can perform. If AutoScalingEnabled
is set to True, Managed Service for Apache Flink 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.
parallelism_per_kp_u : parallelism_per_kp_u option;
Describes the number of parallel tasks that a Managed Service for Apache Flink application can perform per Kinesis Processing Unit (KPU) used by the application.
*)parallelism : parallelism option;
Describes the initial number of parallel tasks that a Managed Service for Apache Flink application can perform. If AutoScalingEnabled
is set to True, then Managed Service for Apache Flink 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.
configuration_type : configuration_type option;
Describes whether the application uses the default parallelism for the Managed Service for Apache Flink service.
*)}
Describes parameters for how a Managed Service for Apache Flink application executes multiple tasks simultaneously.
type nonrec flink_application_configuration_description = {
job_plan_description : job_plan_description option;
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.
parallelism_configuration_description : parallelism_configuration_description
option;
Describes parameters for how an application executes multiple tasks simultaneously.
*)monitoring_configuration_description : monitoring_configuration_description
option;
Describes configuration parameters for Amazon CloudWatch logging for an application.
*)checkpoint_configuration_description : checkpoint_configuration_description
option;
Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance.
*)}
Describes configuration parameters for a Managed Service for Apache Flink application.
type nonrec property_map = (property_key * property_value) list
type nonrec property_group = {
property_map : property_map;
Describes the value of an application execution property key-value pair.
*)property_group_id : id;
Describes the key of an application execution property key-value pair.
*)}
Property key-value pairs passed into an application.
type nonrec property_groups = property_group list
type nonrec environment_property_descriptions = {
property_group_descriptions : property_groups option;
Describes the execution property groups.
*)}
Describes the execution properties for an Apache Flink runtime.
type nonrec application_snapshot_configuration_description = {
snapshots_enabled : boolean_object;
Describes whether snapshots are enabled for a Managed Service for Apache Flink application.
*)}
Describes whether snapshots are enabled for a Managed Service for Apache Flink application.
type nonrec application_system_rollback_configuration_description = {
rollback_enabled : boolean_object;
Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application
*)}
Describes system rollback configuration for a Managed Service for Apache Flink application
type nonrec application_configuration_description = {
zeppelin_application_configuration_description : zeppelin_application_configuration_description
option;
The configuration parameters for a Managed Service for Apache Flink Studio notebook.
*)vpc_configuration_descriptions : vpc_configuration_descriptions option;
The array of descriptions of VPC configurations available to the application.
*)application_system_rollback_configuration_description : application_system_rollback_configuration_description
option;
application_snapshot_configuration_description : application_snapshot_configuration_description
option;
Describes whether snapshots are enabled for a Managed Service for Apache Flink application.
*)environment_property_descriptions : environment_property_descriptions option;
Describes execution properties for a Managed Service for Apache Flink application.
*)flink_application_configuration_description : flink_application_configuration_description
option;
The details about a Managed Service for Apache Flink application.
*)run_configuration_description : run_configuration_description option;
The details about the starting properties for a Managed Service for Apache Flink application.
*)application_code_configuration_description : application_code_configuration_description
option;
The details about the application code for a Managed Service for Apache Flink application.
*)sql_application_configuration_description : sql_application_configuration_description
option;
The details about inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.
*)}
Describes details about the application code and starting parameters for a Managed Service for Apache Flink application.
type nonrec cloud_watch_logging_option_description = {
role_ar_n : role_ar_n option;
The IAM ARN of the role to use to send application messages.
Provided for backward compatibility. Applications created with the current API version have an application-level service execution role rather than a resource-level role.
*)log_stream_ar_n : log_stream_ar_n;
The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.
*)cloud_watch_logging_option_id : id option;
The ID of the CloudWatch logging option description.
*)}
Describes the Amazon CloudWatch logging option.
type nonrec cloud_watch_logging_option_descriptions =
cloud_watch_logging_option_description list
type nonrec application_maintenance_configuration_description = {
application_maintenance_window_end_time : application_maintenance_window_end_time;
The end time for the maintenance window.
*)application_maintenance_window_start_time : application_maintenance_window_start_time;
The start time for the maintenance window.
*)}
The details of the maintenance configuration for the application.
type nonrec application_detail = {
application_mode : application_mode option;
To create a Managed Service for Apache Flink Studio notebook, you must set the mode to INTERACTIVE
. However, for a Managed Service for Apache Flink application, the mode is optional.
application_version_rolled_back_to : application_version_id option;
The version to which you want to roll back the application.
*)conditional_token : conditional_token option;
A value you use to implement strong concurrency for application updates.
*)application_version_create_timestamp : timestamp option;
The current timestamp when the application version was created.
*)application_version_rolled_back_from : application_version_id option;
If you reverted the application using RollbackApplication
, the application version when RollbackApplication
was called.
application_version_updated_from : application_version_id option;
The previous application version before the latest application update. RollbackApplication
reverts the application to this version.
application_maintenance_configuration_description : application_maintenance_configuration_description
option;
The details of the maintenance configuration for the application.
*)cloud_watch_logging_option_descriptions : cloud_watch_logging_option_descriptions
option;
Describes the application Amazon CloudWatch logging options.
*)application_configuration_description : application_configuration_description
option;
Describes details about the application code and starting parameters for a Managed Service for Apache Flink application.
*)last_update_timestamp : timestamp option;
The current timestamp when the application was last updated.
*)create_timestamp : timestamp option;
The current timestamp when the application was created.
*)application_version_id : application_version_id;
Provides the current application version. Managed Service for Apache Flink updates the ApplicationVersionId
each time you update the application.
application_status : application_status;
The status of the application.
*)service_execution_role : role_ar_n option;
Specifies the IAM role that the application uses to access external resources.
*)runtime_environment : runtime_environment;
The runtime environment for the application.
*)application_name : application_name;
The name of the application.
*)application_description : application_description option;
The description of the application.
*)application_ar_n : resource_ar_n;
The ARN of the application.
*)}
Describes the application, including the application Amazon Resource Name (ARN), status, latest version, and input and output configurations.
type nonrec update_application_response = {
operation_id : operation_id option;
Operation ID for tracking UpdateApplication request
*)application_detail : application_detail;
Describes application updates.
*)}
type nonrec input_lambda_processor_update = {
resource_arn_update : resource_ar_n;
The Amazon Resource Name (ARN) of the new Amazon Lambda function that is used to preprocess the records in the stream.
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: Amazon Lambda
*)}
For a SQL-based Kinesis Data Analytics application, represents an update to the InputLambdaProcessor
that is used to preprocess the records in the stream.
type nonrec input_processing_configuration_update = {
input_lambda_processor_update : input_lambda_processor_update;
Provides update information for an InputLambdaProcessor
.
}
For a SQL-based Kinesis Data Analytics application, describes updates to an InputProcessingConfiguration
.
type nonrec kinesis_streams_input_update = {
resource_arn_update : resource_ar_n;
The Amazon Resource Name (ARN) of the input Kinesis data stream to read.
*)}
When you update the input configuration for a SQL-based Kinesis Data Analytics application, provides information about a Kinesis stream as the streaming source.
type nonrec kinesis_firehose_input_update = {
resource_arn_update : resource_ar_n;
The Amazon Resource Name (ARN) of the input delivery stream to read.
*)}
For a SQL-based Kinesis Data Analytics application, when updating application input configuration, provides information about a Kinesis Data Firehose delivery stream as the streaming source.
type nonrec input_schema_update = {
record_column_updates : record_columns option;
A list of RecordColumn
objects. Each object describes the mapping of the streaming source element to the corresponding column in the in-application stream.
record_encoding_update : record_encoding option;
Specifies the encoding of the records in the streaming source; for example, UTF-8.
*)record_format_update : record_format option;
Specifies the format of the records on the streaming source.
*)}
Describes updates for an SQL-based Kinesis Data Analytics application's input schema.
type nonrec input_parallelism_update = {
count_update : input_parallelism_count;
The number of in-application streams to create for the specified streaming source.
*)}
For a SQL-based Kinesis Data Analytics application, provides updates to the parallelism count.
type nonrec input_update = {
input_parallelism_update : input_parallelism_update option;
Describes the parallelism updates (the number of in-application streams Kinesis Data Analytics creates for the specific streaming source).
*)input_schema_update : input_schema_update option;
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.
*)kinesis_firehose_input_update : kinesis_firehose_input_update option;
If a Kinesis Data Firehose delivery stream is the streaming source to be updated, provides an updated stream ARN.
*)kinesis_streams_input_update : kinesis_streams_input_update option;
If a Kinesis data stream is the streaming source to be updated, provides an updated stream Amazon Resource Name (ARN).
*)input_processing_configuration_update : input_processing_configuration_update
option;
Describes updates to an InputProcessingConfiguration
.
name_prefix_update : in_app_stream_name option;
The name prefix for in-application streams that Kinesis Data Analytics creates for the specific streaming source.
*)input_id : id;
The input ID of the application input to be updated.
*)}
For a SQL-based Kinesis Data Analytics application, describes updates to a specific input configuration (identified by the InputId
of an application).
type nonrec input_updates = input_update list
type nonrec kinesis_streams_output_update = {
resource_arn_update : resource_ar_n;
The Amazon Resource Name (ARN) of the Kinesis data stream where you want to write the output.
*)}
When you update a SQL-based Kinesis Data Analytics application's output configuration using the UpdateApplication
operation, provides information about a Kinesis data stream that is configured as the destination.
type nonrec kinesis_firehose_output_update = {
resource_arn_update : resource_ar_n;
The Amazon Resource Name (ARN) of the delivery stream to write to.
*)}
For a SQL-based Kinesis Data Analytics application, when updating an output configuration using the UpdateApplication
operation, provides information about a Kinesis Data Firehose delivery stream that is configured as the destination.
type nonrec lambda_output_update = {
resource_arn_update : resource_ar_n;
The Amazon Resource Name (ARN) of the destination Amazon Lambda function.
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: Amazon Lambda
*)}
When you update an SQL-based Kinesis Data Analytics application's output configuration using the UpdateApplication
operation, provides information about an Amazon Lambda function that is configured as the destination.
type nonrec output_update = {
destination_schema_update : destination_schema option;
Describes the data format when records are written to the destination.
*)lambda_output_update : lambda_output_update option;
Describes an Amazon Lambda function as the destination for the output.
*)kinesis_firehose_output_update : kinesis_firehose_output_update option;
Describes a Kinesis Data Firehose delivery stream as the destination for the output.
*)kinesis_streams_output_update : kinesis_streams_output_update option;
Describes a Kinesis data stream as the destination for the output.
*)name_update : in_app_stream_name option;
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.
*)output_id : id;
Identifies the specific output configuration that you want to update.
*)}
For a SQL-based Kinesis Data Analytics application, describes updates to the output configuration identified by the OutputId
.
type nonrec output_updates = output_update list
type nonrec s3_reference_data_source_update = {
file_key_update : file_key option;
The object key name.
*)bucket_arn_update : bucket_ar_n option;
The Amazon Resource Name (ARN) of the S3 bucket.
*)}
For a SQL-based Kinesis Data Analytics application, describes the Amazon S3 bucket name and object key name for an in-application reference table.
type nonrec reference_data_source_update = {
reference_schema_update : source_schema option;
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.
*)s3_reference_data_source_update : s3_reference_data_source_update option;
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.
*)table_name_update : in_app_table_name option;
The in-application table name that is created by this update.
*)reference_id : id;
The ID of the reference data source that is being updated. You can use the DescribeApplication
operation to get this value.
}
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.
type nonrec reference_data_source_updates = reference_data_source_update list
type nonrec sql_application_configuration_update = {
reference_data_source_updates : reference_data_source_updates option;
The array of ReferenceDataSourceUpdate
objects describing the new reference data sources used by the application.
output_updates : output_updates option;
The array of OutputUpdate
objects describing the new destination streams used by the application.
input_updates : input_updates option;
The array of InputUpdate
objects describing the new input streams used by the application.
}
Describes updates to the input streams, destination streams, and reference data sources for a SQL-based Kinesis Data Analytics application.
type nonrec s3_content_location_update = {
object_version_update : object_version option;
The new version of the object containing the application code.
*)file_key_update : file_key option;
The new file key for the object containing the application code.
*)bucket_arn_update : bucket_ar_n option;
The new Amazon Resource Name (ARN) for the S3 bucket containing the application code.
*)}
Describes an update for the Amazon S3 code content location for an application.
type nonrec code_content_update = {
s3_content_location_update : s3_content_location_update option;
Describes an update to the location of code for an application.
*)zip_file_content_update : zip_file_content option;
Describes an update to the zipped code for an application.
*)text_content_update : text_content option;
Describes an update to the text code for an application.
*)}
Describes an update to the code of an application. Not supported for Apache Zeppelin.
type nonrec application_code_configuration_update = {
code_content_update : code_content_update option;
Describes updates to the code content of an application.
*)code_content_type_update : code_content_type option;
Describes updates to the code content type.
*)}
Describes code configuration updates for an application. This is supported for a Managed Service for Apache Flink application or a SQL-based Kinesis Data Analytics application.
type nonrec checkpoint_configuration_update = {
min_pause_between_checkpoints_update : min_pause_between_checkpoints option;
Describes updates to the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.
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.
checkpoint_interval_update : checkpoint_interval option;
Describes updates to the interval in milliseconds between checkpoint operations.
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.
checkpointing_enabled_update : boolean_object option;
Describes updates to whether checkpointing is enabled for an application.
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.
configuration_type_update : configuration_type option;
Describes updates to whether the application uses the default checkpointing behavior of Managed Service for Apache Flink. You must set this property to CUSTOM
in order to set the CheckpointingEnabled
, CheckpointInterval
, or MinPauseBetweenCheckpoints
parameters.
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:
}
Describes updates to the checkpointing parameters for a Managed Service for Apache Flink application.
type nonrec monitoring_configuration_update = {
log_level_update : log_level option;
Describes updates to the verbosity of the CloudWatch Logs for an application.
*)metrics_level_update : metrics_level option;
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.
configuration_type_update : configuration_type option;
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.
}
Describes updates to configuration parameters for Amazon CloudWatch logging for an application.
type nonrec parallelism_configuration_update = {
auto_scaling_enabled_update : boolean_object option;
Describes updates to whether the Managed Service for Apache Flink service can increase the parallelism of a Managed Service for Apache Flink application in response to increased throughput.
*)parallelism_per_kpu_update : parallelism_per_kp_u option;
Describes updates to the number of parallel tasks an application can perform per Kinesis Processing Unit (KPU) used by the application.
*)parallelism_update : parallelism option;
Describes updates to the initial number of parallel tasks an application can perform. If AutoScalingEnabled
is set to True, then Managed Service for Apache Flink 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.
configuration_type_update : configuration_type option;
Describes updates to whether the application uses the default parallelism for the Managed Service for Apache Flink 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.
}
Describes updates to parameters for how an application executes multiple tasks simultaneously.
type nonrec flink_application_configuration_update = {
parallelism_configuration_update : parallelism_configuration_update option;
Describes updates to the parameters for how an application executes multiple tasks simultaneously.
*)monitoring_configuration_update : monitoring_configuration_update option;
Describes updates to the configuration parameters for Amazon CloudWatch logging for an application.
*)checkpoint_configuration_update : checkpoint_configuration_update option;
Describes updates to an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance.
*)}
Describes updates to the configuration parameters for a Managed Service for Apache Flink application.
type nonrec environment_property_updates = {
property_groups : property_groups;
Describes updates to the execution property groups.
*)}
Describes updates to the execution property groups for a Managed Service for Apache Flink application or a Studio notebook.
type nonrec application_snapshot_configuration_update = {
snapshots_enabled_update : boolean_object;
Describes updates to whether snapshots are enabled for an application.
*)}
Describes updates to whether snapshots are enabled for a Managed Service for Apache Flink application.
type nonrec application_system_rollback_configuration_update = {
rollback_enabled_update : boolean_object;
Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application
*)}
Describes system rollback configuration for a Managed Service for Apache Flink application
type nonrec application_configuration_update = {
zeppelin_application_configuration_update : zeppelin_application_configuration_update
option;
Updates to the configuration of a Managed Service for Apache Flink Studio notebook.
*)vpc_configuration_updates : vpc_configuration_updates option;
Updates to the array of descriptions of VPC configurations available to the application.
*)application_system_rollback_configuration_update : application_system_rollback_configuration_update
option;
application_snapshot_configuration_update : application_snapshot_configuration_update
option;
Describes whether snapshots are enabled for a Managed Service for Apache Flink application.
*)environment_property_updates : environment_property_updates option;
Describes updates to the environment properties for a Managed Service for Apache Flink application.
*)flink_application_configuration_update : flink_application_configuration_update
option;
Describes updates to a Managed Service for Apache Flink application's configuration.
*)application_code_configuration_update : application_code_configuration_update
option;
Describes updates to an application's code configuration.
*)sql_application_configuration_update : sql_application_configuration_update
option;
Describes updates to a SQL-based Kinesis Data Analytics application's configuration.
*)}
Describes updates to an application's configuration.
type nonrec run_configuration_update = {
application_restore_configuration : application_restore_configuration option;
Describes updates to the restore behavior of a restarting application.
*)flink_run_configuration : flink_run_configuration option;
Describes the starting parameters for a Managed Service for Apache Flink application.
*)}
Describes the updates to the starting parameters for a Managed Service for Apache Flink application.
type nonrec cloud_watch_logging_option_update = {
log_stream_arn_update : log_stream_ar_n option;
The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.
*)cloud_watch_logging_option_id : id;
The ID of the CloudWatch logging option to update
*)}
Describes the Amazon CloudWatch logging option updates.
type nonrec cloud_watch_logging_option_updates =
cloud_watch_logging_option_update list
type nonrec update_application_request = {
runtime_environment_update : runtime_environment option;
Updates the Managed Service for Apache Flink runtime environment used to run your code. To avoid issues you must:
conditional_token : conditional_token option;
A value you use to implement strong concurrency for application updates. You must provide the CurrentApplicationVersionId
or the ConditionalToken
. You get the application's current ConditionalToken
using DescribeApplication
. For better concurrency support, use the ConditionalToken
parameter instead of CurrentApplicationVersionId
.
cloud_watch_logging_option_updates : cloud_watch_logging_option_updates option;
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
.
run_configuration_update : run_configuration_update option;
Describes updates to the application's starting parameters.
*)service_execution_role_update : role_ar_n option;
Describes updates to the service execution role.
*)application_configuration_update : application_configuration_update option;
Describes application configuration updates.
*)current_application_version_id : application_version_id option;
The current application version ID. You must provide the CurrentApplicationVersionId
or the ConditionalToken
.You can retrieve the application version ID using DescribeApplication
. For better concurrency support, use the ConditionalToken
parameter instead of CurrentApplicationVersionId
.
application_name : application_name;
The name of the application to update.
*)}
type nonrec update_application_maintenance_configuration_response = {
application_maintenance_configuration_description : application_maintenance_configuration_description
option;
The application maintenance configuration description after the update.
*)application_ar_n : resource_ar_n option;
The Amazon Resource Name (ARN) of the application.
*)}
type nonrec application_maintenance_configuration_update = {
application_maintenance_window_start_time_update : application_maintenance_window_start_time;
The updated start time for the maintenance window.
*)}
Describes the updated maintenance configuration for the application.
type nonrec update_application_maintenance_configuration_request = {
application_maintenance_configuration_update : application_maintenance_configuration_update;
Describes the application maintenance configuration update.
*)application_name : application_name;
The name of the application for which you want to update the maintenance configuration.
*)}
The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
Specified application can't be found.
The application is not available for this operation.
The specified input parameter value is not valid.
Exception thrown as a result of concurrent modifications to an application. This error can be the result of attempting to modify an application without using the current application ID.
The number of allowed resources has been exceeded.
The request JSON is not valid for the operation.
The user-provided application configuration is not valid.
The user-provided application code (query) is not valid. This can be a simple syntax error.
type nonrec tag_keys = tag_key list
type nonrec untag_resource_request = {
tag_keys : tag_keys;
A list of keys of tags to remove from the specified application.
*)resource_ar_n : kinesis_analytics_ar_n;
The ARN of the Managed Service for Apache Flink application from which to remove the tags.
*)}
Application created with too many tags, or too many tags added to an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50.
type nonrec raw_input_records = raw_input_record list
type nonrec processed_input_records = processed_input_record list
type nonrec unable_to_detect_schema_exception = {
processed_input_records : processed_input_records option;
Stream data that was modified by the processor specified in the InputProcessingConfiguration
parameter.
raw_input_records : raw_input_records option;
Raw stream data that was sampled to infer the schema.
*)message : error_message option;
}
The data format is not valid. Kinesis Data Analytics cannot detect the schema for the given streaming source.
type nonrec tag = {
value : tag_value option;
The value of the key-value tag. The value is optional.
*)key : tag_key;
The key of the key-value tag.
*)}
A key-value pair (the value is optional) that you can define and assign to Amazon 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.
type nonrec tags = tag list
type nonrec tag_resource_request = {
resource_ar_n : kinesis_analytics_ar_n;
The ARN of the application to assign the tags.
*)}
type nonrec stop_application_response = {
operation_id : operation_id option;
Operation ID for tracking StopApplication request
*)}
type nonrec stop_application_request = {
force : boolean_object option;
Set to true
to force the application to stop. If you set Force
to true
, Managed Service for Apache Flink stops the application without taking a snapshot.
Force-stopping your application may lead to data loss or duplication. To prevent data loss or duplicate processing of data during application restarts, we recommend you to take frequent snapshots of your application.
You can only force stop a Managed Service for Apache Flink application. You can't force stop a SQL-based Kinesis Data Analytics application.
The application must be in the STARTING
, UPDATING
, STOPPING
, AUTOSCALING
, or RUNNING
status.
application_name : application_name;
The name of the running application to stop.
*)}
type nonrec start_application_response = {
operation_id : operation_id option;
Operation ID for tracking StartApplication request
*)}
type nonrec sql_run_configuration = {
input_starting_position_configuration : input_starting_position_configuration;
The point at which you want the application to start processing records from the streaming source.
*)input_id : id;
The input source ID. You can get this ID by calling the DescribeApplication
operation.
}
Describes the starting parameters for a SQL-based Kinesis Data Analytics application.
type nonrec sql_run_configurations = sql_run_configuration list
type nonrec run_configuration = {
application_restore_configuration : application_restore_configuration option;
Describes the restore behavior of a restarting application.
*)sql_run_configurations : sql_run_configurations option;
Describes the starting parameters for a SQL-based Kinesis Data Analytics application application.
*)flink_run_configuration : flink_run_configuration option;
Describes the starting parameters for a Managed Service for Apache Flink application.
*)}
Describes the starting parameters for an Managed Service for Apache Flink application.
type nonrec start_application_request = {
run_configuration : run_configuration option;
Identifies the run configuration (start parameters) of a Managed Service for Apache Flink application.
*)application_name : application_name;
The name of the application.
*)}
type nonrec input_lambda_processor = {
resource_ar_n : resource_ar_n;
The ARN of the Amazon Lambda function that operates on records in the stream.
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: Amazon Lambda
*)}
An object that contains the Amazon Resource Name (ARN) of the Amazon Lambda function that is used to preprocess records in the stream in a SQL-based Kinesis Data Analytics application.
type nonrec input_processing_configuration = {
input_lambda_processor : input_lambda_processor;
The InputLambdaProcessor
that is used to preprocess the records in the stream before being processed by your application code.
}
For a SQL-based Kinesis Data Analytics application, describes a processor that is used to preprocess the records in the stream before being processed by your application code. Currently, the only input processor available is Amazon Lambda.
type nonrec kinesis_streams_input = {
resource_ar_n : resource_ar_n;
The ARN of the input Kinesis data stream to read.
*)}
Identifies a Kinesis data stream as the streaming source. You provide the stream's Amazon Resource Name (ARN).
type nonrec kinesis_firehose_input = {
resource_ar_n : resource_ar_n;
The Amazon Resource Name (ARN) of the delivery stream.
*)}
For a SQL-based Kinesis Data Analytics application, identifies a Kinesis Data Firehose delivery stream as the streaming source. You provide the delivery stream's Amazon Resource Name (ARN).
type nonrec input = {
input_schema : source_schema;
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.
*)input_parallelism : input_parallelism option;
Describes the number of in-application streams to create.
*)kinesis_firehose_input : kinesis_firehose_input option;
If the streaming source is an Amazon Kinesis Data Firehose delivery stream, identifies the delivery stream's ARN.
*)kinesis_streams_input : kinesis_streams_input option;
If the streaming source is an Amazon Kinesis data stream, identifies the stream's Amazon Resource Name (ARN).
*)input_processing_configuration : input_processing_configuration option;
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
.
name_prefix : in_app_stream_name;
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.
}
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.
type nonrec inputs = input list
type nonrec kinesis_streams_output = {
resource_ar_n : resource_ar_n;
The ARN of the destination Kinesis data stream to write to.
*)}
When you configure a SQL-based Kinesis Data Analytics application's output, identifies a Kinesis data stream as the destination. You provide the stream Amazon Resource Name (ARN).
type nonrec kinesis_firehose_output = {
resource_ar_n : resource_ar_n;
The ARN of the destination delivery stream to write to.
*)}
For a SQL-based Kinesis Data Analytics application, when configuring application output, identifies a Kinesis Data Firehose delivery stream as the destination. You provide the stream Amazon Resource Name (ARN) of the delivery stream.
type nonrec lambda_output = {
resource_ar_n : resource_ar_n;
The Amazon Resource Name (ARN) of the destination Lambda function to write to.
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: Amazon Lambda
*)}
When you configure a SQL-based Kinesis Data Analytics application's output, identifies an Amazon Lambda function as the destination. You provide the function Amazon Resource Name (ARN) of the Lambda function.
type nonrec output = {
destination_schema : destination_schema;
Describes the data format when records are written to the destination.
*)lambda_output : lambda_output option;
Identifies an Amazon Lambda function as the destination.
*)kinesis_firehose_output : kinesis_firehose_output option;
Identifies a Kinesis Data Firehose delivery stream as the destination.
*)kinesis_streams_output : kinesis_streams_output option;
Identifies a Kinesis data stream as the destination.
*)name : in_app_stream_name;
The name of the in-application stream.
*)}
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.
type nonrec outputs = output list
type nonrec s3_reference_data_source = {
file_key : file_key option;
The object key name containing the reference data.
*)bucket_ar_n : bucket_ar_n option;
The Amazon Resource Name (ARN) of the S3 bucket.
*)}
For a SQL-based Kinesis Data Analytics application, identifies the Amazon S3 bucket and object that contains the reference data.
A SQL-based 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.
type nonrec reference_data_source = {
reference_schema : source_schema;
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.
*)s3_reference_data_source : s3_reference_data_source option;
Identifies the S3 bucket and object that contains the reference data. A SQL-based 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.
table_name : in_app_table_name;
The name of the in-application table to create.
*)}
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.
type nonrec reference_data_sources = reference_data_source list
type nonrec sql_application_configuration = {
reference_data_sources : reference_data_sources option;
The array of ReferenceDataSource
objects describing the reference data sources used by the application.
outputs : outputs option;
The array of Output
objects describing the destination streams used by the application.
inputs : inputs option;
The array of Input
objects describing the input streams used by the application.
}
Describes the inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.
type nonrec snapshot_details = {
runtime_environment : runtime_environment option;
The Flink Runtime for the application snapshot.
*)snapshot_creation_timestamp : timestamp option;
The timestamp of the application snapshot.
*)application_version_id : application_version_id;
The current application version ID when the snapshot was created.
*)snapshot_status : snapshot_status;
The status of the application snapshot.
*)snapshot_name : snapshot_name;
The identifier for the application snapshot.
*)}
Provides details about a snapshot of application state.
type nonrec snapshot_summaries = snapshot_details list
The service cannot complete the request.
type nonrec s3_configuration = {
file_key : file_key;
The name of the object that contains the data.
*)bucket_ar_n : bucket_ar_n;
The ARN of the S3 bucket that contains the data.
*)}
For a SQL-based Kinesis Data Analytics application, provides a description of an Amazon S3 data source, including the Amazon Resource Name (ARN) of the S3 bucket and the name of the Amazon S3 object that contains the data.
type nonrec rollback_application_response = {
operation_id : operation_id option;
Operation ID for tracking RollbackApplication request
*)application_detail : application_detail;
}
type nonrec rollback_application_request = {
current_application_version_id : application_version_id;
The current application version ID. You can retrieve the application version ID using DescribeApplication
.
application_name : application_name;
The name of the application.
*)}
Discovery failed to get a record from the streaming source because of the Kinesis Streams ProvisionedThroughputExceededException
. For more information, see GetRecords in the Amazon Kinesis Streams API Reference.
type nonrec parsed_input_record = parsed_input_record_field list
type nonrec parsed_input_records = parsed_input_record list
type nonrec parallelism_configuration = {
auto_scaling_enabled : boolean_object option;
Describes whether the Managed Service for Apache Flink service can increase the parallelism of the application in response to increased throughput.
*)parallelism_per_kp_u : parallelism_per_kp_u option;
Describes the number of parallel tasks that a Managed Service for Apache Flink application can perform per Kinesis Processing Unit (KPU) used by the application. For more information about KPUs, see Amazon Managed Service for Apache Flink Pricing.
*)parallelism : parallelism option;
Describes the initial number of parallel tasks that a Managed Service for Apache Flink application can perform. If AutoScalingEnabled
is set to True, Managed Service for Apache Flink 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.
configuration_type : configuration_type;
Describes whether the application uses the default parallelism for the Managed Service for Apache Flink service. You must set this property to CUSTOM
in order to change your application's AutoScalingEnabled
, Parallelism
, or ParallelismPerKPU
properties.
}
Describes parameters for how a Managed Service for Apache Flink application executes multiple tasks simultaneously. For more information about parallelism, see Parallel Execution in the Apache Flink Documentation.
Status of the operation performed on an application
Provides a description of the operation failure error
type nonrec operation_failure_details = {
error_info : error_info option;
rollback_operation_id : operation_id option;
Provides the operation ID of a system-rollback operation executed due to failure in the current operation
*)}
Provides a description of the operation failure
type nonrec monitoring_configuration = {
log_level : log_level option;
Describes the verbosity of the CloudWatch Logs for an application.
*)metrics_level : metrics_level option;
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.
configuration_type : configuration_type;
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.
}
Describes configuration parameters for Amazon CloudWatch logging for an application. For more information about CloudWatch logging, see Monitoring.
type nonrec application_summary = {
application_mode : application_mode option;
For a Managed Service for Apache Flink application, the mode is STREAMING
. For a Managed Service for Apache Flink Studio notebook, it is INTERACTIVE
.
runtime_environment : runtime_environment;
The runtime environment for the application.
*)application_version_id : application_version_id;
Provides the current application version.
*)application_status : application_status;
The status of the application.
*)application_ar_n : resource_ar_n;
The ARN of the application.
*)application_name : application_name;
The name of the application.
*)}
Provides application summary information, including the application Amazon Resource Name (ARN), name, and status.
type nonrec application_summaries = application_summary list
type nonrec list_applications_response = {
next_token : application_name option;
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 Amazon Command Line Interface's Pagination Options.
application_summaries : application_summaries;
A list of ApplicationSummary
objects.
}
type nonrec list_applications_request = {
next_token : application_name option;
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 Amazon Command Line Interface's Pagination Options.
*)limit : list_applications_input_limit option;
The maximum number of applications to list.
*)}
type nonrec application_version_summary = {
application_status : application_status;
The status of the application.
*)application_version_id : application_version_id;
The ID of the application version. Managed Service for Apache Flink updates the ApplicationVersionId
each time you update the application.
}
The summary of the application version.
type nonrec application_version_summaries = application_version_summary list
type nonrec list_application_versions_response = {
next_token : next_token option;
The pagination token for the next set of results, or null
if there are no additional results. To retrieve the next set of items, pass this token into a subsequent invocation of this operation. For more information about pagination, see Using the Amazon Command Line Interface's Pagination Options.
application_version_summaries : application_version_summaries option;
A list of the application versions and the associated configuration summaries. The list includes application versions that were rolled back.
To get the complete description of a specific application version, invoke the DescribeApplicationVersion
operation.
}
type nonrec list_application_versions_request = {
next_token : next_token option;
If a previous invocation of this operation returned a pagination token, pass it into this value to retrieve the next set of results. For more information about pagination, see Using the Amazon Command Line Interface's Pagination Options.
*)limit : list_application_versions_input_limit option;
The maximum number of versions to list in this invocation of the operation.
*)application_name : application_name;
The name of the application for which you want to list all versions.
*)}
type nonrec list_application_snapshots_response = {
next_token : next_token option;
The token for the next set of results, or null
if there are no additional results.
snapshot_summaries : snapshot_summaries option;
A collection of objects containing information about the application snapshots.
*)}
type nonrec list_application_snapshots_request = {
next_token : next_token option;
Use this parameter if you receive a NextToken
response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken
response to indicate where the output should continue from.
limit : list_snapshots_input_limit option;
The maximum number of application snapshots to list.
*)application_name : application_name;
The name of an existing application.
*)}
type nonrec application_operation_info = {
operation_status : operation_status option;
end_time : timestamp option;
The timestamp at which the operation finished for the application
*)start_time : timestamp option;
The timestamp at which the operation was created
*)operation_id : operation_id option;
operation : operation option;
}
Provides a description of the operation, such as the type and status of operation
type nonrec application_operation_info_list = application_operation_info list
type nonrec list_application_operations_response = {
next_token : next_token option;
application_operation_info_list : application_operation_info_list option;
}
Response with the list of operations for an application
type nonrec list_application_operations_request = {
operation_status : operation_status option;
operation : operation option;
next_token : next_token option;
limit : list_application_operations_input_limit option;
application_name : application_name;
}
Request to list operations performed on an application
type nonrec discover_input_schema_response = {
raw_input_records : raw_input_records option;
The raw stream data that was sampled to infer the schema.
*)processed_input_records : processed_input_records option;
The stream data that was modified by the processor specified in the InputProcessingConfiguration
parameter.
parsed_input_records : parsed_input_records option;
An array of elements, where each element corresponds to a row in a stream record (a stream record can have more than one row).
*)input_schema : source_schema option;
The schema inferred from the streaming source. It identifies the format of the data in the streaming source and how each data element maps to corresponding columns in the in-application stream that you can create.
*)}
type nonrec discover_input_schema_request = {
input_processing_configuration : input_processing_configuration option;
The InputProcessingConfiguration
to use to preprocess the records before discovering the schema of the records.
s3_configuration : s3_configuration option;
Specify this parameter to discover a schema from data in an Amazon S3 object.
*)input_starting_position_configuration : input_starting_position_configuration
option;
The point at which you want Kinesis Data Analytics to start reading records from the specified streaming source for discovery purposes.
*)service_execution_role : role_ar_n;
The ARN of the role that is used to access the streaming source.
*)resource_ar_n : resource_ar_n option;
The Amazon Resource Name (ARN) of the streaming source.
*)}
type nonrec describe_application_version_response = {
application_version_detail : application_detail option;
}
type nonrec describe_application_version_request = {
application_version_id : application_version_id;
The ID of the application version for which you want to get the description.
*)application_name : application_name;
The name of the application for which you want to get the version description.
*)}
type nonrec describe_application_snapshot_response = {
snapshot_details : snapshot_details;
An object containing information about the application snapshot.
*)}
type nonrec describe_application_snapshot_request = {
snapshot_name : snapshot_name;
The identifier of an application snapshot. You can retrieve this value using .
*)application_name : application_name;
The name of an existing application.
*)}
type nonrec application_version_change_details = {
application_version_updated_to : application_version_id;
The operation execution resulted in the transition to the following version of the application
*)application_version_updated_from : application_version_id;
The operation was performed on this version of the application
*)}
Contains information about the application version changes due to an operation
type nonrec application_operation_info_details = {
operation_failure_details : operation_failure_details option;
application_version_change_details : application_version_change_details option;
operation_status : operation_status;
end_time : timestamp;
The timestamp at which the operation finished for the application
*)start_time : timestamp;
The timestamp at which the operation was created
*)operation : operation;
}
Provides a description of the operation, such as the operation-type and status
type nonrec describe_application_operation_response = {
application_operation_info_details : application_operation_info_details option;
}
Provides details of the operation corresponding to the operation-ID on a Managed Service for Apache Flink application
type nonrec describe_application_operation_request = {
operation_id : operation_id;
application_name : application_name;
}
Request for information about a specific operation performed on a Managed Service for Apache Flink application
type nonrec describe_application_response = {
application_detail : application_detail;
Provides a description of the application, such as the application's Amazon Resource Name (ARN), status, and latest version.
*)}
type nonrec describe_application_request = {
include_additional_details : boolean_object option;
Displays verbose information about a Managed Service for Apache Flink application, including the application's job plan.
*)application_name : application_name;
The name of the application.
*)}
type nonrec delete_application_vpc_configuration_response = {
operation_id : operation_id option;
Operation ID for tracking DeleteApplicationVpcConfiguration request
*)application_version_id : application_version_id option;
The updated version ID of the application.
*)application_ar_n : resource_ar_n option;
The ARN of the Managed Service for Apache Flink application.
*)}
type nonrec delete_application_vpc_configuration_request = {
conditional_token : conditional_token option;
A value you use to implement strong concurrency for application updates. You must provide the CurrentApplicationVersionId
or the ConditionalToken
. You get the application's current ConditionalToken
using DescribeApplication
. For better concurrency support, use the ConditionalToken
parameter instead of CurrentApplicationVersionId
.
vpc_configuration_id : id;
The ID of the VPC configuration to delete.
*)current_application_version_id : application_version_id option;
The current application version ID. You must provide the CurrentApplicationVersionId
or the ConditionalToken
. You can retrieve the application version ID using DescribeApplication
. For better concurrency support, use the ConditionalToken
parameter instead of CurrentApplicationVersionId
.
application_name : application_name;
The name of an existing application.
*)}
type nonrec delete_application_snapshot_request = {
snapshot_creation_timestamp : timestamp;
The creation timestamp of the application snapshot to delete. You can retrieve this value using or .
*)snapshot_name : snapshot_name;
The identifier for the snapshot delete.
*)application_name : application_name;
The name of an existing application.
*)}
type nonrec delete_application_reference_data_source_response = {
application_version_id : application_version_id option;
The updated version ID of the application.
*)application_ar_n : resource_ar_n option;
The application Amazon Resource Name (ARN).
*)}
type nonrec delete_application_reference_data_source_request = {
reference_id : id;
The ID of the reference data source. When you add a reference data source to your application using the AddApplicationReferenceDataSource
, Kinesis Data Analytics assigns an ID. You can use the DescribeApplication
operation to get the reference ID.
current_application_version_id : application_version_id;
The current application version. 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.
application_name : application_name;
The name of an existing application.
*)}
type nonrec delete_application_output_response = {
application_version_id : application_version_id option;
The current application version ID.
*)application_ar_n : resource_ar_n option;
The application Amazon Resource Name (ARN).
*)}
type nonrec delete_application_output_request = {
output_id : id;
The ID of the configuration to delete. Each output configuration that is added to the application (either when the application is created or later) using the AddApplicationOutput
operation has a unique ID. You need to provide the ID to uniquely identify the output configuration that you want to delete from the application configuration. You can use the DescribeApplication
operation to get the specific OutputId
.
current_application_version_id : application_version_id;
The application version. 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.
application_name : application_name;
The application name.
*)}
type nonrec delete_application_input_processing_configuration_response = {
application_version_id : application_version_id option;
The current application version ID.
*)application_ar_n : resource_ar_n option;
The Amazon Resource Name (ARN) of the application.
*)}
type nonrec delete_application_input_processing_configuration_request = {
input_id : id;
The ID of the input configuration from which to delete the input processing configuration. You can get a list of the input IDs for an application by using the DescribeApplication
operation.
current_application_version_id : application_version_id;
The application version. 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.
application_name : application_name;
The name of the application.
*)}
type nonrec delete_application_cloud_watch_logging_option_response = {
operation_id : operation_id option;
Operation ID for tracking DeleteApplicationCloudWatchLoggingOption request
*)cloud_watch_logging_option_descriptions : cloud_watch_logging_option_descriptions
option;
The descriptions of the remaining CloudWatch logging options for the application.
*)application_version_id : application_version_id option;
The version ID of the application. Kinesis Data Analytics updates the ApplicationVersionId
each time you change the CloudWatch logging options.
application_ar_n : resource_ar_n option;
The application's Amazon Resource Name (ARN).
*)}
type nonrec delete_application_cloud_watch_logging_option_request = {
conditional_token : conditional_token option;
A value you use to implement strong concurrency for application updates. You must provide the CurrentApplicationVersionId
or the ConditionalToken
. You get the application's current ConditionalToken
using DescribeApplication
. For better concurrency support, use the ConditionalToken
parameter instead of CurrentApplicationVersionId
.
cloud_watch_logging_option_id : id;
The CloudWatchLoggingOptionId
of the Amazon CloudWatch logging option to delete. You can get the CloudWatchLoggingOptionId
by using the DescribeApplication
operation.
current_application_version_id : application_version_id option;
The version ID of the application. You must provide the CurrentApplicationVersionId
or the ConditionalToken
. You can retrieve the application version ID using DescribeApplication
. For better concurrency support, use the ConditionalToken
parameter instead of CurrentApplicationVersionId
.
application_name : application_name;
The application name.
*)}
type nonrec delete_application_request = {
create_timestamp : timestamp;
Use the DescribeApplication
operation to get this value.
application_name : application_name;
The name of the application to delete.
*)}
type nonrec create_application_snapshot_request = {
snapshot_name : snapshot_name;
An identifier for the application snapshot.
*)application_name : application_name;
The name of an existing application
*)}
type nonrec create_application_presigned_url_request = {
session_expiration_duration_in_seconds : session_expiration_duration_in_seconds
option;
The duration in seconds for which the returned URL will be valid.
*)url_type : url_type;
The type of the extension for which to create and return a URL. Currently, the only valid extension URL type is FLINK_DASHBOARD_URL
.
application_name : application_name;
The name of the application.
*)}
type nonrec create_application_response = {
application_detail : application_detail;
In response to your CreateApplication
request, Managed Service for Apache Flink returns a response with details of the application it created.
}
type nonrec checkpoint_configuration = {
min_pause_between_checkpoints : min_pause_between_checkpoints option;
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.
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.
checkpoint_interval : checkpoint_interval option;
Describes the interval in milliseconds between checkpoint operations.
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.
checkpointing_enabled : boolean_object option;
Describes whether checkpointing is enabled for a Managed Service for Apache Flink application.
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.
configuration_type : configuration_type;
Describes whether the application uses Managed Service for Apache Flink' default checkpointing behavior. You must set this property to CUSTOM
in order to set the CheckpointingEnabled
, CheckpointInterval
, or MinPauseBetweenCheckpoints
parameters.
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:
}
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.
type nonrec flink_application_configuration = {
parallelism_configuration : parallelism_configuration option;
Describes parameters for how an application executes multiple tasks simultaneously.
*)monitoring_configuration : monitoring_configuration option;
Describes configuration parameters for Amazon CloudWatch logging for an application.
*)checkpoint_configuration : checkpoint_configuration option;
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.
*)}
Describes configuration parameters for a Managed Service for Apache Flink application or a Studio notebook.
type nonrec environment_properties = {
property_groups : property_groups;
Describes the execution property groups.
*)}
Describes execution properties for a Managed Service for Apache Flink application.
type nonrec code_content = {
s3_content_location : s3_content_location option;
Information about the Amazon S3 bucket that contains the application code.
*)zip_file_content : zip_file_content option;
The zip-format code for a Managed Service for Apache Flink application.
*)text_content : text_content option;
The text-format code for a Managed Service for Apache Flink application.
*)}
Specifies either the application code, or the location of the application code, for a Managed Service for Apache Flink application.
type nonrec application_code_configuration = {
code_content_type : code_content_type;
Specifies whether the code content is in text or zip format.
*)code_content : code_content option;
The location and type of the application code.
*)}
Describes code configuration for an application.
type nonrec application_snapshot_configuration = {
snapshots_enabled : boolean_object;
Describes whether snapshots are enabled for a Managed Service for Apache Flink application.
*)}
Describes whether snapshots are enabled for a Managed Service for Apache Flink application.
type nonrec application_system_rollback_configuration = {
rollback_enabled : boolean_object;
Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application
*)}
Describes system rollback configuration for a Managed Service for Apache Flink application
type nonrec application_configuration = {
zeppelin_application_configuration : zeppelin_application_configuration option;
The configuration parameters for a Managed Service for Apache Flink Studio notebook.
*)vpc_configurations : vpc_configurations option;
The array of descriptions of VPC configurations available to the application.
*)application_system_rollback_configuration : application_system_rollback_configuration
option;
application_snapshot_configuration : application_snapshot_configuration option;
Describes whether snapshots are enabled for a Managed Service for Apache Flink application.
*)application_code_configuration : application_code_configuration option;
The code location and type parameters for a Managed Service for Apache Flink application.
*)environment_properties : environment_properties option;
Describes execution properties for a Managed Service for Apache Flink application.
*)flink_application_configuration : flink_application_configuration option;
The creation and update parameters for a Managed Service for Apache Flink application.
*)sql_application_configuration : sql_application_configuration option;
The creation and update parameters for a SQL-based Kinesis Data Analytics application.
*)}
Specifies the creation parameters for a Managed Service for Apache Flink application.
type nonrec cloud_watch_logging_option = {
log_stream_ar_n : log_stream_ar_n;
The ARN of the CloudWatch log to receive application messages.
*)}
Provides a description of Amazon CloudWatch logging options, including the log stream Amazon Resource Name (ARN).
type nonrec cloud_watch_logging_options = cloud_watch_logging_option list
type nonrec create_application_request = {
application_mode : application_mode option;
Use the STREAMING
mode to create a Managed Service for Apache Flink application. To create a Managed Service for Apache Flink Studio notebook, use the INTERACTIVE
mode.
cloud_watch_logging_options : cloud_watch_logging_options option;
Use this parameter to configure an Amazon CloudWatch log stream to monitor application configuration errors.
*)application_configuration : application_configuration option;
Use this parameter to configure the application.
*)service_execution_role : role_ar_n;
The IAM role used by the application to access Kinesis data streams, Kinesis Data Firehose delivery streams, Amazon S3 objects, and other external resources.
*)runtime_environment : runtime_environment;
The runtime environment for the application.
*)application_description : application_description option;
A summary description of the application.
*)application_name : application_name;
The name of your application (for example, sample-app
).
}
type nonrec add_application_vpc_configuration_response = {
operation_id : operation_id option;
Operation ID for tracking AddApplicationVpcConfiguration request
*)vpc_configuration_description : vpc_configuration_description option;
The parameters of the new VPC configuration.
*)application_version_id : application_version_id option;
Provides the current application version. Managed Service for Apache Flink updates the ApplicationVersionId each time you update the application.
*)application_ar_n : resource_ar_n option;
The ARN of the application.
*)}
type nonrec add_application_vpc_configuration_request = {
conditional_token : conditional_token option;
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
. For better concurrency support, use the ConditionalToken
parameter instead of CurrentApplicationVersionId
.
vpc_configuration : vpc_configuration;
Description of the VPC to add to the application.
*)current_application_version_id : application_version_id option;
The version of the application to which you want to add the VPC configuration. You must provide the CurrentApplicationVersionId
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. For better concurrency support, use the ConditionalToken
parameter instead of CurrentApplicationVersionId
.
application_name : application_name;
The name of an existing application.
*)}
type nonrec add_application_reference_data_source_response = {
reference_data_source_descriptions : reference_data_source_descriptions option;
Describes reference data sources configured for the application.
*)application_version_id : application_version_id option;
The updated application version ID. Kinesis Data Analytics increments this ID when the application is updated.
*)application_ar_n : resource_ar_n option;
The application Amazon Resource Name (ARN).
*)}
type nonrec add_application_reference_data_source_request = {
reference_data_source : reference_data_source;
The reference data source can be an object in your Amazon S3 bucket. Kinesis Data Analytics reads the object and copies the data into the in-application table that is created. You provide an S3 bucket, object key name, and the resulting in-application table that is created.
*)current_application_version_id : application_version_id;
The version of the application for which you are adding the reference data source. 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.
application_name : application_name;
The name of an existing application.
*)}
type nonrec add_application_output_response = {
output_descriptions : output_descriptions option;
Describes the application output configuration. For more information, see Configuring Application Output.
*)application_version_id : application_version_id option;
The updated application version ID. Kinesis Data Analytics increments this ID when the application is updated.
*)application_ar_n : resource_ar_n option;
The application Amazon Resource Name (ARN).
*)}
type nonrec add_application_output_request = {
output : output;
An array of objects, each describing one output configuration. In the output configuration, you specify the name of an in-application stream, a destination (that is, a Kinesis data stream, a Kinesis Data Firehose delivery stream, or an Amazon Lambda function), and record the formation to use when writing to the destination.
*)current_application_version_id : application_version_id;
The version of the application to which you want to add the output configuration. 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.
application_name : application_name;
The name of the application to which you want to add the output configuration.
*)}
type nonrec add_application_input_processing_configuration_response = {
input_processing_configuration_description : input_processing_configuration_description
option;
The description of the preprocessor that executes on records in this input before the application's code is run.
*)input_id : id option;
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.
*)application_version_id : application_version_id option;
Provides the current application version.
*)application_ar_n : resource_ar_n option;
The Amazon Resource Name (ARN) of the application.
*)}
type nonrec add_application_input_processing_configuration_request = {
input_processing_configuration : input_processing_configuration;
The InputProcessingConfiguration
to add to the application.
input_id : id;
The ID of the input configuration to add the input processing configuration to. You can get a list of the input IDs for an application using the DescribeApplication
operation.
current_application_version_id : application_version_id;
The version of the application to which you want to add the input processing configuration. 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.
application_name : application_name;
The name of the application to which you want to add the input processing configuration.
*)}
type nonrec add_application_input_response = {
input_descriptions : input_descriptions option;
Describes the application input configuration.
*)application_version_id : application_version_id option;
Provides the current application version.
*)application_ar_n : resource_ar_n option;
The Amazon Resource Name (ARN) of the application.
*)}
type nonrec add_application_input_request = {
input : input;
The Input
to add.
current_application_version_id : application_version_id;
The current version of your application. You must provide the ApplicationVersionID
or the ConditionalToken
.You can use the DescribeApplication
operation to find the current application version.
application_name : application_name;
The name of your existing application to which you want to add the streaming source.
*)}
type nonrec add_application_cloud_watch_logging_option_response = {
operation_id : operation_id option;
Operation ID for tracking AddApplicationCloudWatchLoggingOption request
*)cloud_watch_logging_option_descriptions : cloud_watch_logging_option_descriptions
option;
The descriptions of the current CloudWatch logging options for the SQL-based Kinesis Data Analytics application.
*)application_version_id : application_version_id option;
The new version ID of the SQL-based Kinesis Data Analytics application. Kinesis Data Analytics updates the ApplicationVersionId
each time you change the CloudWatch logging options.
application_ar_n : resource_ar_n option;
The application's ARN.
*)}
type nonrec add_application_cloud_watch_logging_option_request = {
conditional_token : conditional_token option;
A value you use to implement strong concurrency for application updates. You must provide the CurrentApplicationVersionId
or the ConditionalToken
. You get the application's current ConditionalToken
using DescribeApplication
. For better concurrency support, use the ConditionalToken
parameter instead of CurrentApplicationVersionId
.
cloud_watch_logging_option : cloud_watch_logging_option;
Provides the Amazon CloudWatch log stream Amazon Resource Name (ARN).
*)current_application_version_id : application_version_id option;
The version ID of the SQL-based Kinesis Data Analytics application. You must provide the CurrentApplicationVersionId
or the ConditionalToken
.You can retrieve the application version ID using DescribeApplication
. For better concurrency support, use the ConditionalToken
parameter instead of CurrentApplicationVersionId
.
application_name : application_name;
The Kinesis Data Analytics application name.
*)}