# WARNING ABOUT GENERATED CODE # # This file is generated. See the contributing guide for more information: # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md # # WARNING ABOUT GENERATED CODE module Aws::KinesisAnalyticsV2 module Types # @note When making an API call, you may pass AddApplicationCloudWatchLoggingOptionRequest # data as a hash: # # { # application_name: "ApplicationName", # required # current_application_version_id: 1, # required # cloud_watch_logging_option: { # required # log_stream_arn: "LogStreamARN", # required # }, # } # # @!attribute [rw] application_name # The Kinesis Data Analytics application name. # @return [String] # # @!attribute [rw] current_application_version_id # The version ID of the Kinesis Data Analytics application. You can # retrieve the application version ID using DescribeApplication. # @return [Integer] # # @!attribute [rw] cloud_watch_logging_option # Provides the Amazon CloudWatch log stream Amazon Resource Name # (ARN). # @return [Types::CloudWatchLoggingOption] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/AddApplicationCloudWatchLoggingOptionRequest AWS API Documentation # class AddApplicationCloudWatchLoggingOptionRequest < Struct.new( :application_name, :current_application_version_id, :cloud_watch_logging_option) include Aws::Structure end # @!attribute [rw] application_arn # The application's ARN. # @return [String] # # @!attribute [rw] application_version_id # The new version ID of the Kinesis Data Analytics application. # Kinesis Data Analytics updates the `ApplicationVersionId` each time # you change the CloudWatch logging options. # @return [Integer] # # @!attribute [rw] cloud_watch_logging_option_descriptions # The descriptions of the current CloudWatch logging options for the # Kinesis Data Analytics application. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/AddApplicationCloudWatchLoggingOptionResponse AWS API Documentation # class AddApplicationCloudWatchLoggingOptionResponse < Struct.new( :application_arn, :application_version_id, :cloud_watch_logging_option_descriptions) include Aws::Structure end # @note When making an API call, you may pass AddApplicationInputProcessingConfigurationRequest # data as a hash: # # { # application_name: "ApplicationName", # required # current_application_version_id: 1, # required # input_id: "Id", # required # input_processing_configuration: { # required # input_lambda_processor: { # required # resource_arn: "ResourceARN", # required # }, # }, # } # # @!attribute [rw] application_name # The name of the application to which you want to add the input # processing configuration. # @return [String] # # @!attribute [rw] current_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. # @return [Integer] # # @!attribute [rw] input_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. # @return [String] # # @!attribute [rw] input_processing_configuration # The InputProcessingConfiguration to add to the application. # @return [Types::InputProcessingConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/AddApplicationInputProcessingConfigurationRequest AWS API Documentation # class AddApplicationInputProcessingConfigurationRequest < Struct.new( :application_name, :current_application_version_id, :input_id, :input_processing_configuration) include Aws::Structure end # @!attribute [rw] application_arn # The Amazon Resource Name (ARN) of the application. # @return [String] # # @!attribute [rw] application_version_id # Provides the current application version. # @return [Integer] # # @!attribute [rw] input_id # The input ID that is associated with the application input. This is # the ID that Amazon Kinesis Data Analytics assigns to each input # configuration that you add to your application. # @return [String] # # @!attribute [rw] input_processing_configuration_description # The description of the preprocessor that executes on records in this # input before the application's code is run. # @return [Types::InputProcessingConfigurationDescription] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/AddApplicationInputProcessingConfigurationResponse AWS API Documentation # class AddApplicationInputProcessingConfigurationResponse < Struct.new( :application_arn, :application_version_id, :input_id, :input_processing_configuration_description) include Aws::Structure end # @note When making an API call, you may pass AddApplicationInputRequest # data as a hash: # # { # application_name: "ApplicationName", # required # current_application_version_id: 1, # required # input: { # required # name_prefix: "InAppStreamName", # required # input_processing_configuration: { # input_lambda_processor: { # required # resource_arn: "ResourceARN", # required # }, # }, # kinesis_streams_input: { # resource_arn: "ResourceARN", # required # }, # kinesis_firehose_input: { # resource_arn: "ResourceARN", # required # }, # input_parallelism: { # count: 1, # }, # input_schema: { # required # record_format: { # required # record_format_type: "JSON", # required, accepts JSON, CSV # mapping_parameters: { # json_mapping_parameters: { # record_row_path: "RecordRowPath", # required # }, # csv_mapping_parameters: { # record_row_delimiter: "RecordRowDelimiter", # required # record_column_delimiter: "RecordColumnDelimiter", # required # }, # }, # }, # record_encoding: "RecordEncoding", # record_columns: [ # required # { # name: "RecordColumnName", # required # mapping: "RecordColumnMapping", # sql_type: "RecordColumnSqlType", # required # }, # ], # }, # }, # } # # @!attribute [rw] application_name # The name of your existing application to which you want to add the # streaming source. # @return [String] # # @!attribute [rw] current_application_version_id # The current version of your application. You can use the # DescribeApplication operation to find the current application # version. # @return [Integer] # # @!attribute [rw] input # The Input to add. # @return [Types::Input] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/AddApplicationInputRequest AWS API Documentation # class AddApplicationInputRequest < Struct.new( :application_name, :current_application_version_id, :input) include Aws::Structure end # @!attribute [rw] application_arn # The Amazon Resource Name (ARN) of the application. # @return [String] # # @!attribute [rw] application_version_id # Provides the current application version. # @return [Integer] # # @!attribute [rw] input_descriptions # Describes the application input configuration. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/AddApplicationInputResponse AWS API Documentation # class AddApplicationInputResponse < Struct.new( :application_arn, :application_version_id, :input_descriptions) include Aws::Structure end # @note When making an API call, you may pass AddApplicationOutputRequest # data as a hash: # # { # application_name: "ApplicationName", # required # current_application_version_id: 1, # required # output: { # required # name: "InAppStreamName", # required # kinesis_streams_output: { # resource_arn: "ResourceARN", # required # }, # kinesis_firehose_output: { # resource_arn: "ResourceARN", # required # }, # lambda_output: { # resource_arn: "ResourceARN", # required # }, # destination_schema: { # required # record_format_type: "JSON", # required, accepts JSON, CSV # }, # }, # } # # @!attribute [rw] application_name # The name of the application to which you want to add the output # configuration. # @return [String] # # @!attribute [rw] current_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. # @return [Integer] # # @!attribute [rw] 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 AWS Lambda function), and # record the formation to use when writing to the destination. # @return [Types::Output] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/AddApplicationOutputRequest AWS API Documentation # class AddApplicationOutputRequest < Struct.new( :application_name, :current_application_version_id, :output) include Aws::Structure end # @!attribute [rw] application_arn # The application Amazon Resource Name (ARN). # @return [String] # # @!attribute [rw] application_version_id # The updated application version ID. Kinesis Data Analytics # increments this ID when the application is updated. # @return [Integer] # # @!attribute [rw] output_descriptions # Describes the application output configuration. For more # information, see [Configuring Application Output][1]. # # # # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/AddApplicationOutputResponse AWS API Documentation # class AddApplicationOutputResponse < Struct.new( :application_arn, :application_version_id, :output_descriptions) include Aws::Structure end # @note When making an API call, you may pass AddApplicationReferenceDataSourceRequest # data as a hash: # # { # application_name: "ApplicationName", # required # current_application_version_id: 1, # required # reference_data_source: { # required # table_name: "InAppTableName", # required # s3_reference_data_source: { # bucket_arn: "BucketARN", # file_key: "FileKey", # }, # reference_schema: { # required # record_format: { # required # record_format_type: "JSON", # required, accepts JSON, CSV # mapping_parameters: { # json_mapping_parameters: { # record_row_path: "RecordRowPath", # required # }, # csv_mapping_parameters: { # record_row_delimiter: "RecordRowDelimiter", # required # record_column_delimiter: "RecordColumnDelimiter", # required # }, # }, # }, # record_encoding: "RecordEncoding", # record_columns: [ # required # { # name: "RecordColumnName", # required # mapping: "RecordColumnMapping", # sql_type: "RecordColumnSqlType", # required # }, # ], # }, # }, # } # # @!attribute [rw] application_name # The name of an existing application. # @return [String] # # @!attribute [rw] current_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. # @return [Integer] # # @!attribute [rw] 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. # @return [Types::ReferenceDataSource] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/AddApplicationReferenceDataSourceRequest AWS API Documentation # class AddApplicationReferenceDataSourceRequest < Struct.new( :application_name, :current_application_version_id, :reference_data_source) include Aws::Structure end # @!attribute [rw] application_arn # The application Amazon Resource Name (ARN). # @return [String] # # @!attribute [rw] application_version_id # The updated application version ID. Amazon Kinesis Data Analytics # increments this ID when the application is updated. # @return [Integer] # # @!attribute [rw] reference_data_source_descriptions # Describes reference data sources configured for the application. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/AddApplicationReferenceDataSourceResponse AWS API Documentation # class AddApplicationReferenceDataSourceResponse < Struct.new( :application_arn, :application_version_id, :reference_data_source_descriptions) include Aws::Structure end # @note When making an API call, you may pass AddApplicationVpcConfigurationRequest # data as a hash: # # { # application_name: "ApplicationName", # required # current_application_version_id: 1, # required # vpc_configuration: { # required # subnet_ids: ["SubnetId"], # required # security_group_ids: ["SecurityGroupId"], # required # }, # } # # @!attribute [rw] application_name # The name of an existing application. # @return [String] # # @!attribute [rw] current_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. # @return [Integer] # # @!attribute [rw] vpc_configuration # Description of the VPC to add to the application. # @return [Types::VpcConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/AddApplicationVpcConfigurationRequest AWS API Documentation # class AddApplicationVpcConfigurationRequest < Struct.new( :application_name, :current_application_version_id, :vpc_configuration) include Aws::Structure end # @!attribute [rw] application_arn # The ARN of the application. # @return [String] # # @!attribute [rw] application_version_id # Provides the current application version. Kinesis Data Analytics # updates the ApplicationVersionId each time you update the # application. # @return [Integer] # # @!attribute [rw] vpc_configuration_description # The parameters of the new VPC configuration. # @return [Types::VpcConfigurationDescription] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/AddApplicationVpcConfigurationResponse AWS API Documentation # class AddApplicationVpcConfigurationResponse < Struct.new( :application_arn, :application_version_id, :vpc_configuration_description) include Aws::Structure end # Describes code configuration for a Java-based Kinesis Data Analytics # application. # # @note When making an API call, you may pass ApplicationCodeConfiguration # data as a hash: # # { # code_content: { # text_content: "TextContent", # zip_file_content: "data", # s3_content_location: { # bucket_arn: "BucketARN", # required # file_key: "FileKey", # required # object_version: "ObjectVersion", # }, # }, # code_content_type: "PLAINTEXT", # required, accepts PLAINTEXT, ZIPFILE # } # # @!attribute [rw] code_content # The location and type of the application code. # @return [Types::CodeContent] # # @!attribute [rw] code_content_type # Specifies whether the code content is in text or zip format. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/ApplicationCodeConfiguration AWS API Documentation # class ApplicationCodeConfiguration < Struct.new( :code_content, :code_content_type) include Aws::Structure end # Describes code configuration for a Java-based Kinesis Data Analytics # application. # # @!attribute [rw] code_content_type # Specifies whether the code content is in text or zip format. # @return [String] # # @!attribute [rw] code_content_description # Describes details about the location and format of the application # code. # @return [Types::CodeContentDescription] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/ApplicationCodeConfigurationDescription AWS API Documentation # class ApplicationCodeConfigurationDescription < Struct.new( :code_content_type, :code_content_description) include Aws::Structure end # Describes updates to a Java-based Amazon Kinesis Data Analytics # application. # # @note When making an API call, you may pass ApplicationCodeConfigurationUpdate # data as a hash: # # { # code_content_type_update: "PLAINTEXT", # accepts PLAINTEXT, ZIPFILE # code_content_update: { # text_content_update: "TextContent", # zip_file_content_update: "data", # s3_content_location_update: { # bucket_arn_update: "BucketARN", # file_key_update: "FileKey", # object_version_update: "ObjectVersion", # }, # }, # } # # @!attribute [rw] code_content_type_update # Describes updates to the code content type. # @return [String] # # @!attribute [rw] code_content_update # Describes updates to the code content of an application. # @return [Types::CodeContentUpdate] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/ApplicationCodeConfigurationUpdate AWS API Documentation # class ApplicationCodeConfigurationUpdate < Struct.new( :code_content_type_update, :code_content_update) include Aws::Structure end # Specifies the creation parameters for an Amazon Kinesis Data Analytics # application. # # @note When making an API call, you may pass ApplicationConfiguration # data as a hash: # # { # sql_application_configuration: { # inputs: [ # { # name_prefix: "InAppStreamName", # required # input_processing_configuration: { # input_lambda_processor: { # required # resource_arn: "ResourceARN", # required # }, # }, # kinesis_streams_input: { # resource_arn: "ResourceARN", # required # }, # kinesis_firehose_input: { # resource_arn: "ResourceARN", # required # }, # input_parallelism: { # count: 1, # }, # input_schema: { # required # record_format: { # required # record_format_type: "JSON", # required, accepts JSON, CSV # mapping_parameters: { # json_mapping_parameters: { # record_row_path: "RecordRowPath", # required # }, # csv_mapping_parameters: { # record_row_delimiter: "RecordRowDelimiter", # required # record_column_delimiter: "RecordColumnDelimiter", # required # }, # }, # }, # record_encoding: "RecordEncoding", # record_columns: [ # required # { # name: "RecordColumnName", # required # mapping: "RecordColumnMapping", # sql_type: "RecordColumnSqlType", # required # }, # ], # }, # }, # ], # outputs: [ # { # name: "InAppStreamName", # required # kinesis_streams_output: { # resource_arn: "ResourceARN", # required # }, # kinesis_firehose_output: { # resource_arn: "ResourceARN", # required # }, # lambda_output: { # resource_arn: "ResourceARN", # required # }, # destination_schema: { # required # record_format_type: "JSON", # required, accepts JSON, CSV # }, # }, # ], # reference_data_sources: [ # { # table_name: "InAppTableName", # required # s3_reference_data_source: { # bucket_arn: "BucketARN", # file_key: "FileKey", # }, # reference_schema: { # required # record_format: { # required # record_format_type: "JSON", # required, accepts JSON, CSV # mapping_parameters: { # json_mapping_parameters: { # record_row_path: "RecordRowPath", # required # }, # csv_mapping_parameters: { # record_row_delimiter: "RecordRowDelimiter", # required # record_column_delimiter: "RecordColumnDelimiter", # required # }, # }, # }, # record_encoding: "RecordEncoding", # record_columns: [ # required # { # name: "RecordColumnName", # required # mapping: "RecordColumnMapping", # sql_type: "RecordColumnSqlType", # required # }, # ], # }, # }, # ], # }, # flink_application_configuration: { # checkpoint_configuration: { # configuration_type: "DEFAULT", # required, accepts DEFAULT, CUSTOM # checkpointing_enabled: false, # checkpoint_interval: 1, # min_pause_between_checkpoints: 1, # }, # monitoring_configuration: { # configuration_type: "DEFAULT", # required, accepts DEFAULT, CUSTOM # metrics_level: "APPLICATION", # accepts APPLICATION, TASK, OPERATOR, PARALLELISM # log_level: "INFO", # accepts INFO, WARN, ERROR, DEBUG # }, # parallelism_configuration: { # configuration_type: "DEFAULT", # required, accepts DEFAULT, CUSTOM # parallelism: 1, # parallelism_per_kpu: 1, # auto_scaling_enabled: false, # }, # }, # environment_properties: { # property_groups: [ # required # { # property_group_id: "Id", # required # property_map: { # required # "PropertyKey" => "PropertyValue", # }, # }, # ], # }, # application_code_configuration: { # required # code_content: { # text_content: "TextContent", # zip_file_content: "data", # s3_content_location: { # bucket_arn: "BucketARN", # required # file_key: "FileKey", # required # object_version: "ObjectVersion", # }, # }, # code_content_type: "PLAINTEXT", # required, accepts PLAINTEXT, ZIPFILE # }, # application_snapshot_configuration: { # snapshots_enabled: false, # required # }, # vpc_configurations: [ # { # subnet_ids: ["SubnetId"], # required # security_group_ids: ["SecurityGroupId"], # required # }, # ], # } # # @!attribute [rw] sql_application_configuration # The creation and update parameters for an SQL-based Kinesis Data # Analytics application. # @return [Types::SqlApplicationConfiguration] # # @!attribute [rw] flink_application_configuration # The creation and update parameters for a Java-based Kinesis Data # Analytics application. # @return [Types::FlinkApplicationConfiguration] # # @!attribute [rw] environment_properties # Describes execution properties for a Java-based Kinesis Data # Analytics application. # @return [Types::EnvironmentProperties] # # @!attribute [rw] application_code_configuration # The code location and type parameters for a Java-based Kinesis Data # Analytics application. # @return [Types::ApplicationCodeConfiguration] # # @!attribute [rw] application_snapshot_configuration # Describes whether snapshots are enabled for a Java-based Kinesis # Data Analytics application. # @return [Types::ApplicationSnapshotConfiguration] # # @!attribute [rw] vpc_configurations # The array of descriptions of VPC configurations available to the # application. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/ApplicationConfiguration AWS API Documentation # class ApplicationConfiguration < Struct.new( :sql_application_configuration, :flink_application_configuration, :environment_properties, :application_code_configuration, :application_snapshot_configuration, :vpc_configurations) include Aws::Structure end # Describes details about the application code and starting parameters # for an Amazon Kinesis Data Analytics application. # # @!attribute [rw] sql_application_configuration_description # The details about inputs, outputs, and reference data sources for an # SQL-based Kinesis Data Analytics application. # @return [Types::SqlApplicationConfigurationDescription] # # @!attribute [rw] application_code_configuration_description # The details about the application code for a Java-based Kinesis Data # Analytics application. # @return [Types::ApplicationCodeConfigurationDescription] # # @!attribute [rw] run_configuration_description # The details about the starting properties for a Kinesis Data # Analytics application. # @return [Types::RunConfigurationDescription] # # @!attribute [rw] flink_application_configuration_description # The details about a Java-based Kinesis Data Analytics application. # @return [Types::FlinkApplicationConfigurationDescription] # # @!attribute [rw] environment_property_descriptions # Describes execution properties for a Java-based Kinesis Data # Analytics application. # @return [Types::EnvironmentPropertyDescriptions] # # @!attribute [rw] application_snapshot_configuration_description # Describes whether snapshots are enabled for a Java-based Kinesis # Data Analytics application. # @return [Types::ApplicationSnapshotConfigurationDescription] # # @!attribute [rw] vpc_configuration_descriptions # The array of descriptions of VPC configurations available to the # application. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/ApplicationConfigurationDescription AWS API Documentation # class ApplicationConfigurationDescription < Struct.new( :sql_application_configuration_description, :application_code_configuration_description, :run_configuration_description, :flink_application_configuration_description, :environment_property_descriptions, :application_snapshot_configuration_description, :vpc_configuration_descriptions) include Aws::Structure end # Describes updates to an application's configuration. # # @note When making an API call, you may pass ApplicationConfigurationUpdate # data as a hash: # # { # sql_application_configuration_update: { # input_updates: [ # { # input_id: "Id", # required # name_prefix_update: "InAppStreamName", # input_processing_configuration_update: { # input_lambda_processor_update: { # required # resource_arn_update: "ResourceARN", # required # }, # }, # kinesis_streams_input_update: { # resource_arn_update: "ResourceARN", # required # }, # kinesis_firehose_input_update: { # resource_arn_update: "ResourceARN", # required # }, # input_schema_update: { # record_format_update: { # record_format_type: "JSON", # required, accepts JSON, CSV # mapping_parameters: { # json_mapping_parameters: { # record_row_path: "RecordRowPath", # required # }, # csv_mapping_parameters: { # record_row_delimiter: "RecordRowDelimiter", # required # record_column_delimiter: "RecordColumnDelimiter", # required # }, # }, # }, # record_encoding_update: "RecordEncoding", # record_column_updates: [ # { # name: "RecordColumnName", # required # mapping: "RecordColumnMapping", # sql_type: "RecordColumnSqlType", # required # }, # ], # }, # input_parallelism_update: { # count_update: 1, # required # }, # }, # ], # output_updates: [ # { # output_id: "Id", # required # name_update: "InAppStreamName", # kinesis_streams_output_update: { # resource_arn_update: "ResourceARN", # required # }, # kinesis_firehose_output_update: { # resource_arn_update: "ResourceARN", # required # }, # lambda_output_update: { # resource_arn_update: "ResourceARN", # required # }, # destination_schema_update: { # record_format_type: "JSON", # required, accepts JSON, CSV # }, # }, # ], # reference_data_source_updates: [ # { # reference_id: "Id", # required # table_name_update: "InAppTableName", # s3_reference_data_source_update: { # bucket_arn_update: "BucketARN", # file_key_update: "FileKey", # }, # reference_schema_update: { # record_format: { # required # record_format_type: "JSON", # required, accepts JSON, CSV # mapping_parameters: { # json_mapping_parameters: { # record_row_path: "RecordRowPath", # required # }, # csv_mapping_parameters: { # record_row_delimiter: "RecordRowDelimiter", # required # record_column_delimiter: "RecordColumnDelimiter", # required # }, # }, # }, # record_encoding: "RecordEncoding", # record_columns: [ # required # { # name: "RecordColumnName", # required # mapping: "RecordColumnMapping", # sql_type: "RecordColumnSqlType", # required # }, # ], # }, # }, # ], # }, # application_code_configuration_update: { # code_content_type_update: "PLAINTEXT", # accepts PLAINTEXT, ZIPFILE # code_content_update: { # text_content_update: "TextContent", # zip_file_content_update: "data", # s3_content_location_update: { # bucket_arn_update: "BucketARN", # file_key_update: "FileKey", # object_version_update: "ObjectVersion", # }, # }, # }, # flink_application_configuration_update: { # checkpoint_configuration_update: { # configuration_type_update: "DEFAULT", # accepts DEFAULT, CUSTOM # checkpointing_enabled_update: false, # checkpoint_interval_update: 1, # min_pause_between_checkpoints_update: 1, # }, # monitoring_configuration_update: { # configuration_type_update: "DEFAULT", # accepts DEFAULT, CUSTOM # metrics_level_update: "APPLICATION", # accepts APPLICATION, TASK, OPERATOR, PARALLELISM # log_level_update: "INFO", # accepts INFO, WARN, ERROR, DEBUG # }, # parallelism_configuration_update: { # configuration_type_update: "DEFAULT", # accepts DEFAULT, CUSTOM # parallelism_update: 1, # parallelism_per_kpu_update: 1, # auto_scaling_enabled_update: false, # }, # }, # environment_property_updates: { # property_groups: [ # required # { # property_group_id: "Id", # required # property_map: { # required # "PropertyKey" => "PropertyValue", # }, # }, # ], # }, # application_snapshot_configuration_update: { # snapshots_enabled_update: false, # required # }, # vpc_configuration_updates: [ # { # vpc_configuration_id: "Id", # required # subnet_id_updates: ["SubnetId"], # security_group_id_updates: ["SecurityGroupId"], # }, # ], # } # # @!attribute [rw] sql_application_configuration_update # Describes updates to an SQL-based Kinesis Data Analytics # application's configuration. # @return [Types::SqlApplicationConfigurationUpdate] # # @!attribute [rw] application_code_configuration_update # Describes updates to a Java-based Kinesis Data Analytics # application's code configuration. # @return [Types::ApplicationCodeConfigurationUpdate] # # @!attribute [rw] flink_application_configuration_update # Describes updates to a Java-based Kinesis Data Analytics # application's configuration. # @return [Types::FlinkApplicationConfigurationUpdate] # # @!attribute [rw] environment_property_updates # Describes updates to the environment properties for a Java-based # Kinesis Data Analytics application. # @return [Types::EnvironmentPropertyUpdates] # # @!attribute [rw] application_snapshot_configuration_update # Describes whether snapshots are enabled for a Java-based Kinesis # Data Analytics application. # @return [Types::ApplicationSnapshotConfigurationUpdate] # # @!attribute [rw] vpc_configuration_updates # Updates to the array of descriptions of VPC configurations available # to the application. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/ApplicationConfigurationUpdate AWS API Documentation # class ApplicationConfigurationUpdate < Struct.new( :sql_application_configuration_update, :application_code_configuration_update, :flink_application_configuration_update, :environment_property_updates, :application_snapshot_configuration_update, :vpc_configuration_updates) include Aws::Structure end # Describes the application, including the application Amazon Resource # Name (ARN), status, latest version, and input and output # configurations. # # @!attribute [rw] application_arn # The ARN of the application. # @return [String] # # @!attribute [rw] application_description # The description of the application. # @return [String] # # @!attribute [rw] application_name # The name of the application. # @return [String] # # @!attribute [rw] runtime_environment # The runtime environment for the application (`SQL-1.0` or # `FLINK-1_6`). # @return [String] # # @!attribute [rw] service_execution_role # Specifies the IAM role that the application uses to access external # resources. # @return [String] # # @!attribute [rw] application_status # The status of the application. # @return [String] # # @!attribute [rw] application_version_id # Provides the current application version. Kinesis Data Analytics # updates the `ApplicationVersionId` each time you update the # application. # @return [Integer] # # @!attribute [rw] create_timestamp # The current timestamp when the application was created. # @return [Time] # # @!attribute [rw] last_update_timestamp # The current timestamp when the application was last updated. # @return [Time] # # @!attribute [rw] application_configuration_description # Provides details about the application's SQL or Java code and # starting parameters. # @return [Types::ApplicationConfigurationDescription] # # @!attribute [rw] cloud_watch_logging_option_descriptions # Describes the application Amazon CloudWatch logging options. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/ApplicationDetail AWS API Documentation # class ApplicationDetail < Struct.new( :application_arn, :application_description, :application_name, :runtime_environment, :service_execution_role, :application_status, :application_version_id, :create_timestamp, :last_update_timestamp, :application_configuration_description, :cloud_watch_logging_option_descriptions) include Aws::Structure end # Specifies the method and snapshot to use when restarting an # application using previously saved application state. # # @note When making an API call, you may pass ApplicationRestoreConfiguration # data as a hash: # # { # application_restore_type: "SKIP_RESTORE_FROM_SNAPSHOT", # required, accepts SKIP_RESTORE_FROM_SNAPSHOT, RESTORE_FROM_LATEST_SNAPSHOT, RESTORE_FROM_CUSTOM_SNAPSHOT # snapshot_name: "SnapshotName", # } # # @!attribute [rw] application_restore_type # Specifies how the application should be restored. # @return [String] # # @!attribute [rw] snapshot_name # 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`. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/ApplicationRestoreConfiguration AWS API Documentation # class ApplicationRestoreConfiguration < Struct.new( :application_restore_type, :snapshot_name) include Aws::Structure end # Describes whether snapshots are enabled for a Java-based Kinesis Data # Analytics application. # # @note When making an API call, you may pass ApplicationSnapshotConfiguration # data as a hash: # # { # snapshots_enabled: false, # required # } # # @!attribute [rw] snapshots_enabled # Describes whether snapshots are enabled for a Java-based Kinesis # Data Analytics application. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/ApplicationSnapshotConfiguration AWS API Documentation # class ApplicationSnapshotConfiguration < Struct.new( :snapshots_enabled) include Aws::Structure end # Describes whether snapshots are enabled for a Java-based Kinesis Data # Analytics application. # # @!attribute [rw] snapshots_enabled # Describes whether snapshots are enabled for a Java-based Kinesis # Data Analytics application. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/ApplicationSnapshotConfigurationDescription AWS API Documentation # class ApplicationSnapshotConfigurationDescription < Struct.new( :snapshots_enabled) include Aws::Structure end # Describes updates to whether snapshots are enabled for a Java-based # Kinesis Data Analytics application. # # @note When making an API call, you may pass ApplicationSnapshotConfigurationUpdate # data as a hash: # # { # snapshots_enabled_update: false, # required # } # # @!attribute [rw] snapshots_enabled_update # Describes updates to whether snapshots are enabled for a Java-based # Kinesis Data Analytics application. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/ApplicationSnapshotConfigurationUpdate AWS API Documentation # class ApplicationSnapshotConfigurationUpdate < Struct.new( :snapshots_enabled_update) include Aws::Structure end # Provides application summary information, including the application # Amazon Resource Name (ARN), name, and status. # # @!attribute [rw] application_name # The name of the application. # @return [String] # # @!attribute [rw] application_arn # The ARN of the application. # @return [String] # # @!attribute [rw] application_status # The status of the application. # @return [String] # # @!attribute [rw] application_version_id # Provides the current application version. # @return [Integer] # # @!attribute [rw] runtime_environment # The runtime environment for the application (`SQL-1.0` or # `FLINK-1_6`). # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/ApplicationSummary AWS API Documentation # class ApplicationSummary < Struct.new( :application_name, :application_arn, :application_status, :application_version_id, :runtime_environment) include Aws::Structure end # For an SQL-based 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"` # # @note When making an API call, you may pass CSVMappingParameters # data as a hash: # # { # record_row_delimiter: "RecordRowDelimiter", # required # record_column_delimiter: "RecordColumnDelimiter", # required # } # # @!attribute [rw] record_row_delimiter # The row delimiter. For example, in a CSV format, *'\\n'* is the # typical row delimiter. # @return [String] # # @!attribute [rw] record_column_delimiter # The column delimiter. For example, in a CSV format, a comma (",") # is the typical column delimiter. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/CSVMappingParameters AWS API Documentation # class CSVMappingParameters < Struct.new( :record_row_delimiter, :record_column_delimiter) include Aws::Structure end # 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][1] in the # [Apache Flink Documentation][2]. # # # # [1]: https://ci.apache.org/projects/flink/flink-docs-release-1.6/concepts/programming-model.html#checkpoints-for-fault-tolerance # [2]: https://ci.apache.org/projects/flink/flink-docs-release-1.6/ # # @note When making an API call, you may pass CheckpointConfiguration # data as a hash: # # { # configuration_type: "DEFAULT", # required, accepts DEFAULT, CUSTOM # checkpointing_enabled: false, # checkpoint_interval: 1, # min_pause_between_checkpoints: 1, # } # # @!attribute [rw] configuration_type # Describes whether the application uses Amazon Kinesis Data # Analytics' 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: # # * **CheckpointingEnabled:** true # # * **CheckpointInterval:** 60000 # # * **MinPauseBetweenCheckpoints:** 5000 # # # @return [String] # # @!attribute [rw] checkpointing_enabled # Describes whether checkpointing is enabled for a Java-based Kinesis # Data Analytics 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. # # # @return [Boolean] # # @!attribute [rw] checkpoint_interval # Describes the interval in milliseconds between checkpoint # operations. # # If `CheckpointConfiguration.ConfigurationType` is `DEFAULT`, the # application will use a `CheckpointInterval` vaue of 60000, even if # this value is set to another value using this API or in application # code. # # # @return [Integer] # # @!attribute [rw] min_pause_between_checkpoints # 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][1] in the [Apache # Flink Documentation][2]. # # 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. # # # # # # [1]: https://ci.apache.org/projects/flink/flink-docs-stable/ops/state/large_state_tuning.html#tuning-checkpointing # [2]: https://ci.apache.org/projects/flink/flink-docs-release-1.6/ # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/CheckpointConfiguration AWS API Documentation # class CheckpointConfiguration < Struct.new( :configuration_type, :checkpointing_enabled, :checkpoint_interval, :min_pause_between_checkpoints) include Aws::Structure end # Describes checkpointing parameters for a Java-based Amazon Kinesis # Data Analytics application. # # @!attribute [rw] configuration_type # Describes whether the application uses the default checkpointing # behavior in Kinesis Data Analytics. # # If this value is set to `DEFAULT`, the application will use the # following values, even if they are set to other values using APIs or # application code: # # * **CheckpointingEnabled:** true # # * **CheckpointInterval:** 60000 # # * **MinPauseBetweenCheckpoints:** 5000 # # # @return [String] # # @!attribute [rw] checkpointing_enabled # Describes whether checkpointing is enabled for a Java-based Kinesis # Data Analytics 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. # # # @return [Boolean] # # @!attribute [rw] checkpoint_interval # Describes the interval in milliseconds between checkpoint # operations. # # If `CheckpointConfiguration.ConfigurationType` is `DEFAULT`, the # application will use a `CheckpointInterval` vaue of 60000, even if # this value is set to another value using this API or in application # code. # # # @return [Integer] # # @!attribute [rw] min_pause_between_checkpoints # 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. # # # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/CheckpointConfigurationDescription AWS API Documentation # class CheckpointConfigurationDescription < Struct.new( :configuration_type, :checkpointing_enabled, :checkpoint_interval, :min_pause_between_checkpoints) include Aws::Structure end # Describes updates to the checkpointing parameters for a Java-based # Amazon Kinesis Data Analytics application. # # @note When making an API call, you may pass CheckpointConfigurationUpdate # data as a hash: # # { # configuration_type_update: "DEFAULT", # accepts DEFAULT, CUSTOM # checkpointing_enabled_update: false, # checkpoint_interval_update: 1, # min_pause_between_checkpoints_update: 1, # } # # @!attribute [rw] configuration_type_update # Describes updates to whether the application uses the default # checkpointing behavior of Kinesis Data Analytics. You must set this # property to `CUSTOM` in order to set the `CheckpointingEnabled`, # `CheckpointInterval`, or `MinPauseBetweenCheckpoints` parameters. # # If this value is set to `DEFAULT`, the application will use the # following values, even if they are set to other values using APIs or # application code: # # * **CheckpointingEnabled:** true # # * **CheckpointInterval:** 60000 # # * **MinPauseBetweenCheckpoints:** 5000 # # # @return [String] # # @!attribute [rw] checkpointing_enabled_update # 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. # # # @return [Boolean] # # @!attribute [rw] checkpoint_interval_update # Describes updates to the interval in milliseconds between checkpoint # operations. # # If `CheckpointConfiguration.ConfigurationType` is `DEFAULT`, the # application will use a `CheckpointInterval` vaue of 60000, even if # this value is set to another value using this API or in application # code. # # # @return [Integer] # # @!attribute [rw] min_pause_between_checkpoints_update # 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. # # # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/CheckpointConfigurationUpdate AWS API Documentation # class CheckpointConfigurationUpdate < Struct.new( :configuration_type_update, :checkpointing_enabled_update, :checkpoint_interval_update, :min_pause_between_checkpoints_update) include Aws::Structure end # Provides a description of Amazon CloudWatch logging options, including # the log stream Amazon Resource Name (ARN). # # @note When making an API call, you may pass CloudWatchLoggingOption # data as a hash: # # { # log_stream_arn: "LogStreamARN", # required # } # # @!attribute [rw] log_stream_arn # The ARN of the CloudWatch log to receive application messages. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/CloudWatchLoggingOption AWS API Documentation # class CloudWatchLoggingOption < Struct.new( :log_stream_arn) include Aws::Structure end # Describes the Amazon CloudWatch logging option. # # @!attribute [rw] cloud_watch_logging_option_id # The ID of the CloudWatch logging option description. # @return [String] # # @!attribute [rw] log_stream_arn # The Amazon Resource Name (ARN) of the CloudWatch log to receive # application messages. # @return [String] # # @!attribute [rw] role_arn # 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. # # # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/CloudWatchLoggingOptionDescription AWS API Documentation # class CloudWatchLoggingOptionDescription < Struct.new( :cloud_watch_logging_option_id, :log_stream_arn, :role_arn) include Aws::Structure end # Describes the Amazon CloudWatch logging option updates. # # @note When making an API call, you may pass CloudWatchLoggingOptionUpdate # data as a hash: # # { # cloud_watch_logging_option_id: "Id", # required # log_stream_arn_update: "LogStreamARN", # } # # @!attribute [rw] cloud_watch_logging_option_id # The ID of the CloudWatch logging option to update # @return [String] # # @!attribute [rw] log_stream_arn_update # The Amazon Resource Name (ARN) of the CloudWatch log to receive # application messages. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/CloudWatchLoggingOptionUpdate AWS API Documentation # class CloudWatchLoggingOptionUpdate < Struct.new( :cloud_watch_logging_option_id, :log_stream_arn_update) include Aws::Structure end # Specifies either the application code, or the location of the # application code, for a Java-based Amazon Kinesis Data Analytics # application. # # @note When making an API call, you may pass CodeContent # data as a hash: # # { # text_content: "TextContent", # zip_file_content: "data", # s3_content_location: { # bucket_arn: "BucketARN", # required # file_key: "FileKey", # required # object_version: "ObjectVersion", # }, # } # # @!attribute [rw] text_content # The text-format code for a Java-based Kinesis Data Analytics # application. # @return [String] # # @!attribute [rw] zip_file_content # The zip-format code for a Java-based Kinesis Data Analytics # application. # @return [String] # # @!attribute [rw] s3_content_location # Information about the Amazon S3 bucket containing the application # code. # @return [Types::S3ContentLocation] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/CodeContent AWS API Documentation # class CodeContent < Struct.new( :text_content, :zip_file_content, :s3_content_location) include Aws::Structure end # Describes details about the application code for a Java-based Kinesis # Data Analytics application. # # @!attribute [rw] text_content # The text-format code # @return [String] # # @!attribute [rw] code_md5 # The checksum that can be used to validate zip-format code. # @return [String] # # @!attribute [rw] code_size # The size in bytes of the application code. Can be used to validate # zip-format code. # @return [Integer] # # @!attribute [rw] s3_application_code_location_description # The S3 bucket Amazon Resource Name (ARN), file key, and object # version of the application code stored in Amazon S3. # @return [Types::S3ApplicationCodeLocationDescription] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/CodeContentDescription AWS API Documentation # class CodeContentDescription < Struct.new( :text_content, :code_md5, :code_size, :s3_application_code_location_description) include Aws::Structure end # Describes an update to the code of a Java-based Kinesis Data Analytics # application. # # @note When making an API call, you may pass CodeContentUpdate # data as a hash: # # { # text_content_update: "TextContent", # zip_file_content_update: "data", # s3_content_location_update: { # bucket_arn_update: "BucketARN", # file_key_update: "FileKey", # object_version_update: "ObjectVersion", # }, # } # # @!attribute [rw] text_content_update # Describes an update to the text code for an application. # @return [String] # # @!attribute [rw] zip_file_content_update # Describes an update to the zipped code for an application. # @return [String] # # @!attribute [rw] s3_content_location_update # Describes an update to the location of code for an application. # @return [Types::S3ContentLocationUpdate] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/CodeContentUpdate AWS API Documentation # class CodeContentUpdate < Struct.new( :text_content_update, :zip_file_content_update, :s3_content_location_update) include Aws::Structure end # The user-provided application code (query) is not valid. This can be a # simple syntax error. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/CodeValidationException AWS API Documentation # class CodeValidationException < Struct.new( :message) include Aws::Structure end # 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. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/ConcurrentModificationException AWS API Documentation # class ConcurrentModificationException < Struct.new( :message) include Aws::Structure end # @note When making an API call, you may pass CreateApplicationRequest # data as a hash: # # { # application_name: "ApplicationName", # required # application_description: "ApplicationDescription", # runtime_environment: "SQL-1_0", # required, accepts SQL-1_0, FLINK-1_6, FLINK-1_8 # service_execution_role: "RoleARN", # required # application_configuration: { # sql_application_configuration: { # inputs: [ # { # name_prefix: "InAppStreamName", # required # input_processing_configuration: { # input_lambda_processor: { # required # resource_arn: "ResourceARN", # required # }, # }, # kinesis_streams_input: { # resource_arn: "ResourceARN", # required # }, # kinesis_firehose_input: { # resource_arn: "ResourceARN", # required # }, # input_parallelism: { # count: 1, # }, # input_schema: { # required # record_format: { # required # record_format_type: "JSON", # required, accepts JSON, CSV # mapping_parameters: { # json_mapping_parameters: { # record_row_path: "RecordRowPath", # required # }, # csv_mapping_parameters: { # record_row_delimiter: "RecordRowDelimiter", # required # record_column_delimiter: "RecordColumnDelimiter", # required # }, # }, # }, # record_encoding: "RecordEncoding", # record_columns: [ # required # { # name: "RecordColumnName", # required # mapping: "RecordColumnMapping", # sql_type: "RecordColumnSqlType", # required # }, # ], # }, # }, # ], # outputs: [ # { # name: "InAppStreamName", # required # kinesis_streams_output: { # resource_arn: "ResourceARN", # required # }, # kinesis_firehose_output: { # resource_arn: "ResourceARN", # required # }, # lambda_output: { # resource_arn: "ResourceARN", # required # }, # destination_schema: { # required # record_format_type: "JSON", # required, accepts JSON, CSV # }, # }, # ], # reference_data_sources: [ # { # table_name: "InAppTableName", # required # s3_reference_data_source: { # bucket_arn: "BucketARN", # file_key: "FileKey", # }, # reference_schema: { # required # record_format: { # required # record_format_type: "JSON", # required, accepts JSON, CSV # mapping_parameters: { # json_mapping_parameters: { # record_row_path: "RecordRowPath", # required # }, # csv_mapping_parameters: { # record_row_delimiter: "RecordRowDelimiter", # required # record_column_delimiter: "RecordColumnDelimiter", # required # }, # }, # }, # record_encoding: "RecordEncoding", # record_columns: [ # required # { # name: "RecordColumnName", # required # mapping: "RecordColumnMapping", # sql_type: "RecordColumnSqlType", # required # }, # ], # }, # }, # ], # }, # flink_application_configuration: { # checkpoint_configuration: { # configuration_type: "DEFAULT", # required, accepts DEFAULT, CUSTOM # checkpointing_enabled: false, # checkpoint_interval: 1, # min_pause_between_checkpoints: 1, # }, # monitoring_configuration: { # configuration_type: "DEFAULT", # required, accepts DEFAULT, CUSTOM # metrics_level: "APPLICATION", # accepts APPLICATION, TASK, OPERATOR, PARALLELISM # log_level: "INFO", # accepts INFO, WARN, ERROR, DEBUG # }, # parallelism_configuration: { # configuration_type: "DEFAULT", # required, accepts DEFAULT, CUSTOM # parallelism: 1, # parallelism_per_kpu: 1, # auto_scaling_enabled: false, # }, # }, # environment_properties: { # property_groups: [ # required # { # property_group_id: "Id", # required # property_map: { # required # "PropertyKey" => "PropertyValue", # }, # }, # ], # }, # application_code_configuration: { # required # code_content: { # text_content: "TextContent", # zip_file_content: "data", # s3_content_location: { # bucket_arn: "BucketARN", # required # file_key: "FileKey", # required # object_version: "ObjectVersion", # }, # }, # code_content_type: "PLAINTEXT", # required, accepts PLAINTEXT, ZIPFILE # }, # application_snapshot_configuration: { # snapshots_enabled: false, # required # }, # vpc_configurations: [ # { # subnet_ids: ["SubnetId"], # required # security_group_ids: ["SecurityGroupId"], # required # }, # ], # }, # cloud_watch_logging_options: [ # { # log_stream_arn: "LogStreamARN", # required # }, # ], # tags: [ # { # key: "TagKey", # required # value: "TagValue", # }, # ], # } # # @!attribute [rw] application_name # The name of your application (for example, `sample-app`). # @return [String] # # @!attribute [rw] application_description # A summary description of the application. # @return [String] # # @!attribute [rw] runtime_environment # The runtime environment for the application (`SQL-1.0` or # `FLINK-1_6`). # @return [String] # # @!attribute [rw] service_execution_role # The IAM role used by the application to access Kinesis data streams, # Kinesis Data Firehose delivery streams, Amazon S3 objects, and other # external resources. # @return [String] # # @!attribute [rw] application_configuration # Use this parameter to configure the application. # @return [Types::ApplicationConfiguration] # # @!attribute [rw] cloud_watch_logging_options # Use this parameter to configure an Amazon CloudWatch log stream to # monitor application configuration errors. # @return [Array] # # @!attribute [rw] tags # A list of one or more tags to assign to the application. A tag is a # key-value pair that identifies an application. Note that the maximum # number of application tags includes system tags. The maximum number # of user-defined application tags is 50. For more information, see # [Using Tagging][1]. # # # # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/java/how-tagging.html # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/CreateApplicationRequest AWS API Documentation # class CreateApplicationRequest < Struct.new( :application_name, :application_description, :runtime_environment, :service_execution_role, :application_configuration, :cloud_watch_logging_options, :tags) include Aws::Structure end # @!attribute [rw] application_detail # In response to your `CreateApplication` request, Kinesis Data # Analytics returns a response with details of the application it # created. # @return [Types::ApplicationDetail] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/CreateApplicationResponse AWS API Documentation # class CreateApplicationResponse < Struct.new( :application_detail) include Aws::Structure end # @note When making an API call, you may pass CreateApplicationSnapshotRequest # data as a hash: # # { # application_name: "ApplicationName", # required # snapshot_name: "SnapshotName", # required # } # # @!attribute [rw] application_name # The name of an existing application # @return [String] # # @!attribute [rw] snapshot_name # An identifier for the application snapshot. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/CreateApplicationSnapshotRequest AWS API Documentation # class CreateApplicationSnapshotRequest < Struct.new( :application_name, :snapshot_name) include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/CreateApplicationSnapshotResponse AWS API Documentation # class CreateApplicationSnapshotResponse < Aws::EmptyStructure; end # @note When making an API call, you may pass DeleteApplicationCloudWatchLoggingOptionRequest # data as a hash: # # { # application_name: "ApplicationName", # required # current_application_version_id: 1, # required # cloud_watch_logging_option_id: "Id", # required # } # # @!attribute [rw] application_name # The application name. # @return [String] # # @!attribute [rw] current_application_version_id # The version ID of the application. You can retrieve the application # version ID using DescribeApplication. # @return [Integer] # # @!attribute [rw] cloud_watch_logging_option_id # The `CloudWatchLoggingOptionId` of the Amazon CloudWatch logging # option to delete. You can get the `CloudWatchLoggingOptionId` by # using the DescribeApplication operation. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/DeleteApplicationCloudWatchLoggingOptionRequest AWS API Documentation # class DeleteApplicationCloudWatchLoggingOptionRequest < Struct.new( :application_name, :current_application_version_id, :cloud_watch_logging_option_id) include Aws::Structure end # @!attribute [rw] application_arn # The application's Amazon Resource Name (ARN). # @return [String] # # @!attribute [rw] application_version_id # The version ID of the application. Kinesis Data Analytics updates # the `ApplicationVersionId` each time you change the CloudWatch # logging options. # @return [Integer] # # @!attribute [rw] cloud_watch_logging_option_descriptions # The descriptions of the remaining CloudWatch logging options for the # application. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/DeleteApplicationCloudWatchLoggingOptionResponse AWS API Documentation # class DeleteApplicationCloudWatchLoggingOptionResponse < Struct.new( :application_arn, :application_version_id, :cloud_watch_logging_option_descriptions) include Aws::Structure end # @note When making an API call, you may pass DeleteApplicationInputProcessingConfigurationRequest # data as a hash: # # { # application_name: "ApplicationName", # required # current_application_version_id: 1, # required # input_id: "Id", # required # } # # @!attribute [rw] application_name # The name of the application. # @return [String] # # @!attribute [rw] current_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. # @return [Integer] # # @!attribute [rw] input_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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/DeleteApplicationInputProcessingConfigurationRequest AWS API Documentation # class DeleteApplicationInputProcessingConfigurationRequest < Struct.new( :application_name, :current_application_version_id, :input_id) include Aws::Structure end # @!attribute [rw] application_arn # The Amazon Resource Name (ARN) of the application. # @return [String] # # @!attribute [rw] application_version_id # The current application version ID. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/DeleteApplicationInputProcessingConfigurationResponse AWS API Documentation # class DeleteApplicationInputProcessingConfigurationResponse < Struct.new( :application_arn, :application_version_id) include Aws::Structure end # @note When making an API call, you may pass DeleteApplicationOutputRequest # data as a hash: # # { # application_name: "ApplicationName", # required # current_application_version_id: 1, # required # output_id: "Id", # required # } # # @!attribute [rw] application_name # The application name. # @return [String] # # @!attribute [rw] current_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. # @return [Integer] # # @!attribute [rw] output_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`. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/DeleteApplicationOutputRequest AWS API Documentation # class DeleteApplicationOutputRequest < Struct.new( :application_name, :current_application_version_id, :output_id) include Aws::Structure end # @!attribute [rw] application_arn # The application Amazon Resource Name (ARN). # @return [String] # # @!attribute [rw] application_version_id # The current application version ID. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/DeleteApplicationOutputResponse AWS API Documentation # class DeleteApplicationOutputResponse < Struct.new( :application_arn, :application_version_id) include Aws::Structure end # @note When making an API call, you may pass DeleteApplicationReferenceDataSourceRequest # data as a hash: # # { # application_name: "ApplicationName", # required # current_application_version_id: 1, # required # reference_id: "Id", # required # } # # @!attribute [rw] application_name # The name of an existing application. # @return [String] # # @!attribute [rw] current_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. # @return [Integer] # # @!attribute [rw] reference_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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/DeleteApplicationReferenceDataSourceRequest AWS API Documentation # class DeleteApplicationReferenceDataSourceRequest < Struct.new( :application_name, :current_application_version_id, :reference_id) include Aws::Structure end # @!attribute [rw] application_arn # The application Amazon Resource Name (ARN). # @return [String] # # @!attribute [rw] application_version_id # The updated version ID of the application. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/DeleteApplicationReferenceDataSourceResponse AWS API Documentation # class DeleteApplicationReferenceDataSourceResponse < Struct.new( :application_arn, :application_version_id) include Aws::Structure end # @note When making an API call, you may pass DeleteApplicationRequest # data as a hash: # # { # application_name: "ApplicationName", # required # create_timestamp: Time.now, # required # } # # @!attribute [rw] application_name # The name of the application to delete. # @return [String] # # @!attribute [rw] create_timestamp # Use the `DescribeApplication` operation to get this value. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/DeleteApplicationRequest AWS API Documentation # class DeleteApplicationRequest < Struct.new( :application_name, :create_timestamp) include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/DeleteApplicationResponse AWS API Documentation # class DeleteApplicationResponse < Aws::EmptyStructure; end # @note When making an API call, you may pass DeleteApplicationSnapshotRequest # data as a hash: # # { # application_name: "ApplicationName", # required # snapshot_name: "SnapshotName", # required # snapshot_creation_timestamp: Time.now, # required # } # # @!attribute [rw] application_name # The name of an existing application. # @return [String] # # @!attribute [rw] snapshot_name # The identifier for the snapshot delete. # @return [String] # # @!attribute [rw] snapshot_creation_timestamp # The creation timestamp of the application snapshot to delete. You # can retrieve this value using or . # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/DeleteApplicationSnapshotRequest AWS API Documentation # class DeleteApplicationSnapshotRequest < Struct.new( :application_name, :snapshot_name, :snapshot_creation_timestamp) include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/DeleteApplicationSnapshotResponse AWS API Documentation # class DeleteApplicationSnapshotResponse < Aws::EmptyStructure; end # @note When making an API call, you may pass DeleteApplicationVpcConfigurationRequest # data as a hash: # # { # application_name: "ApplicationName", # required # current_application_version_id: 1, # required # vpc_configuration_id: "Id", # required # } # # @!attribute [rw] application_name # The name of an existing application. # @return [String] # # @!attribute [rw] current_application_version_id # The current application version ID. You can retrieve the application # version ID using DescribeApplication. # @return [Integer] # # @!attribute [rw] vpc_configuration_id # The ID of the VPC configuration to delete. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/DeleteApplicationVpcConfigurationRequest AWS API Documentation # class DeleteApplicationVpcConfigurationRequest < Struct.new( :application_name, :current_application_version_id, :vpc_configuration_id) include Aws::Structure end # @!attribute [rw] application_arn # The ARN of the Kinesis Data Analytics application. # @return [String] # # @!attribute [rw] application_version_id # The updated version ID of the application. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/DeleteApplicationVpcConfigurationResponse AWS API Documentation # class DeleteApplicationVpcConfigurationResponse < Struct.new( :application_arn, :application_version_id) include Aws::Structure end # @note When making an API call, you may pass DescribeApplicationRequest # data as a hash: # # { # application_name: "ApplicationName", # required # include_additional_details: false, # } # # @!attribute [rw] application_name # The name of the application. # @return [String] # # @!attribute [rw] include_additional_details # Displays verbose information about a Kinesis Data Analytics # application, including the application's job plan. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/DescribeApplicationRequest AWS API Documentation # class DescribeApplicationRequest < Struct.new( :application_name, :include_additional_details) include Aws::Structure end # @!attribute [rw] application_detail # Provides a description of the application, such as the # application's Amazon Resource Name (ARN), status, and latest # version. # @return [Types::ApplicationDetail] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/DescribeApplicationResponse AWS API Documentation # class DescribeApplicationResponse < Struct.new( :application_detail) include Aws::Structure end # @note When making an API call, you may pass DescribeApplicationSnapshotRequest # data as a hash: # # { # application_name: "ApplicationName", # required # snapshot_name: "SnapshotName", # required # } # # @!attribute [rw] application_name # The name of an existing application. # @return [String] # # @!attribute [rw] snapshot_name # The identifier of an application snapshot. You can retrieve this # value using . # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/DescribeApplicationSnapshotRequest AWS API Documentation # class DescribeApplicationSnapshotRequest < Struct.new( :application_name, :snapshot_name) include Aws::Structure end # @!attribute [rw] snapshot_details # An object containing information about the application snapshot. # @return [Types::SnapshotDetails] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/DescribeApplicationSnapshotResponse AWS API Documentation # class DescribeApplicationSnapshotResponse < Struct.new( :snapshot_details) include Aws::Structure end # Describes the data format when records are written to the destination # in an SQL-based Amazon Kinesis Data Analytics application. # # @note When making an API call, you may pass DestinationSchema # data as a hash: # # { # record_format_type: "JSON", # required, accepts JSON, CSV # } # # @!attribute [rw] record_format_type # Specifies the format of the records on the output stream. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/DestinationSchema AWS API Documentation # class DestinationSchema < Struct.new( :record_format_type) include Aws::Structure end # @note When making an API call, you may pass DiscoverInputSchemaRequest # data as a hash: # # { # resource_arn: "ResourceARN", # service_execution_role: "RoleARN", # required # input_starting_position_configuration: { # input_starting_position: "NOW", # accepts NOW, TRIM_HORIZON, LAST_STOPPED_POINT # }, # s3_configuration: { # bucket_arn: "BucketARN", # required # file_key: "FileKey", # required # }, # input_processing_configuration: { # input_lambda_processor: { # required # resource_arn: "ResourceARN", # required # }, # }, # } # # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the streaming source. # @return [String] # # @!attribute [rw] service_execution_role # The ARN of the role that is used to access the streaming source. # @return [String] # # @!attribute [rw] input_starting_position_configuration # The point at which you want Kinesis Data Analytics to start reading # records from the specified streaming source discovery purposes. # @return [Types::InputStartingPositionConfiguration] # # @!attribute [rw] s3_configuration # Specify this parameter to discover a schema from data in an Amazon # S3 object. # @return [Types::S3Configuration] # # @!attribute [rw] input_processing_configuration # The InputProcessingConfiguration to use to preprocess the records # before discovering the schema of the records. # @return [Types::InputProcessingConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/DiscoverInputSchemaRequest AWS API Documentation # class DiscoverInputSchemaRequest < Struct.new( :resource_arn, :service_execution_role, :input_starting_position_configuration, :s3_configuration, :input_processing_configuration) include Aws::Structure end # @!attribute [rw] input_schema # 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. # @return [Types::SourceSchema] # # @!attribute [rw] parsed_input_records # An array of elements, where each element corresponds to a row in a # stream record (a stream record can have more than one row). # @return [Array>] # # @!attribute [rw] processed_input_records # The stream data that was modified by the processor specified in the # `InputProcessingConfiguration` parameter. # @return [Array] # # @!attribute [rw] raw_input_records # The raw stream data that was sampled to infer the schema. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/DiscoverInputSchemaResponse AWS API Documentation # class DiscoverInputSchemaResponse < Struct.new( :input_schema, :parsed_input_records, :processed_input_records, :raw_input_records) include Aws::Structure end # Describes execution properties for a Java-based Kinesis Data Analytics # application. # # @note When making an API call, you may pass EnvironmentProperties # data as a hash: # # { # property_groups: [ # required # { # property_group_id: "Id", # required # property_map: { # required # "PropertyKey" => "PropertyValue", # }, # }, # ], # } # # @!attribute [rw] property_groups # Describes the execution property groups. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/EnvironmentProperties AWS API Documentation # class EnvironmentProperties < Struct.new( :property_groups) include Aws::Structure end # Describes the execution properties for a Java-based Amazon Kinesis # Data Analytics application. # # @!attribute [rw] property_group_descriptions # Describes the execution property groups. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/EnvironmentPropertyDescriptions AWS API Documentation # class EnvironmentPropertyDescriptions < Struct.new( :property_group_descriptions) include Aws::Structure end # Describes updates to the execution property groups for a Java-based # Amazon Kinesis Data Analytics application. # # @note When making an API call, you may pass EnvironmentPropertyUpdates # data as a hash: # # { # property_groups: [ # required # { # property_group_id: "Id", # required # property_map: { # required # "PropertyKey" => "PropertyValue", # }, # }, # ], # } # # @!attribute [rw] property_groups # Describes updates to the execution property groups. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/EnvironmentPropertyUpdates AWS API Documentation # class EnvironmentPropertyUpdates < Struct.new( :property_groups) include Aws::Structure end # Describes configuration parameters for a Java-based Amazon Kinesis # Data Analytics application. # # @note When making an API call, you may pass FlinkApplicationConfiguration # data as a hash: # # { # checkpoint_configuration: { # configuration_type: "DEFAULT", # required, accepts DEFAULT, CUSTOM # checkpointing_enabled: false, # checkpoint_interval: 1, # min_pause_between_checkpoints: 1, # }, # monitoring_configuration: { # configuration_type: "DEFAULT", # required, accepts DEFAULT, CUSTOM # metrics_level: "APPLICATION", # accepts APPLICATION, TASK, OPERATOR, PARALLELISM # log_level: "INFO", # accepts INFO, WARN, ERROR, DEBUG # }, # parallelism_configuration: { # configuration_type: "DEFAULT", # required, accepts DEFAULT, CUSTOM # parallelism: 1, # parallelism_per_kpu: 1, # auto_scaling_enabled: false, # }, # } # # @!attribute [rw] checkpoint_configuration # 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][1] in the [Apache Flink Documentation][2]. # # # # [1]: https://ci.apache.org/projects/flink/flink-docs-release-1.6/concepts/programming-model.html#checkpoints-for-fault-tolerance # [2]: https://ci.apache.org/projects/flink/flink-docs-release-1.6/ # @return [Types::CheckpointConfiguration] # # @!attribute [rw] monitoring_configuration # Describes configuration parameters for Amazon CloudWatch logging for # an application. # @return [Types::MonitoringConfiguration] # # @!attribute [rw] parallelism_configuration # Describes parameters for how an application executes multiple tasks # simultaneously. # @return [Types::ParallelismConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/FlinkApplicationConfiguration AWS API Documentation # class FlinkApplicationConfiguration < Struct.new( :checkpoint_configuration, :monitoring_configuration, :parallelism_configuration) include Aws::Structure end # Describes configuration parameters for a Java-based Amazon Kinesis # Data Analytics application. # # @!attribute [rw] checkpoint_configuration_description # Describes an application's checkpointing configuration. # Checkpointing is the process of persisting application state for # fault tolerance. # @return [Types::CheckpointConfigurationDescription] # # @!attribute [rw] monitoring_configuration_description # Describes configuration parameters for Amazon CloudWatch logging for # an application. # @return [Types::MonitoringConfigurationDescription] # # @!attribute [rw] parallelism_configuration_description # Describes parameters for how an application executes multiple tasks # simultaneously. # @return [Types::ParallelismConfigurationDescription] # # @!attribute [rw] job_plan_description # The job plan for an application. For more information about the job # plan, see [Jobs and Scheduling][1] in the [Apache Flink # Documentation][2]. To retrieve the job plan for the application, use # the DescribeApplicationRequest$IncludeAdditionalDetails parameter of # the DescribeApplication operation. # # # # [1]: https://ci.apache.org/projects/flink/flink-docs-stable/internals/job_scheduling.html # [2]: https://ci.apache.org/projects/flink/flink-docs-release-1.6/ # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/FlinkApplicationConfigurationDescription AWS API Documentation # class FlinkApplicationConfigurationDescription < Struct.new( :checkpoint_configuration_description, :monitoring_configuration_description, :parallelism_configuration_description, :job_plan_description) include Aws::Structure end # Describes updates to the configuration parameters for a Java-based # Amazon Kinesis Data Analytics application. # # @note When making an API call, you may pass FlinkApplicationConfigurationUpdate # data as a hash: # # { # checkpoint_configuration_update: { # configuration_type_update: "DEFAULT", # accepts DEFAULT, CUSTOM # checkpointing_enabled_update: false, # checkpoint_interval_update: 1, # min_pause_between_checkpoints_update: 1, # }, # monitoring_configuration_update: { # configuration_type_update: "DEFAULT", # accepts DEFAULT, CUSTOM # metrics_level_update: "APPLICATION", # accepts APPLICATION, TASK, OPERATOR, PARALLELISM # log_level_update: "INFO", # accepts INFO, WARN, ERROR, DEBUG # }, # parallelism_configuration_update: { # configuration_type_update: "DEFAULT", # accepts DEFAULT, CUSTOM # parallelism_update: 1, # parallelism_per_kpu_update: 1, # auto_scaling_enabled_update: false, # }, # } # # @!attribute [rw] checkpoint_configuration_update # Describes updates to an application's checkpointing configuration. # Checkpointing is the process of persisting application state for # fault tolerance. # @return [Types::CheckpointConfigurationUpdate] # # @!attribute [rw] monitoring_configuration_update # Describes updates to the configuration parameters for Amazon # CloudWatch logging for an application. # @return [Types::MonitoringConfigurationUpdate] # # @!attribute [rw] parallelism_configuration_update # Describes updates to the parameters for how an application executes # multiple tasks simultaneously. # @return [Types::ParallelismConfigurationUpdate] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/FlinkApplicationConfigurationUpdate AWS API Documentation # class FlinkApplicationConfigurationUpdate < Struct.new( :checkpoint_configuration_update, :monitoring_configuration_update, :parallelism_configuration_update) include Aws::Structure end # Describes the starting parameters for an Apache Flink-based Kinesis # Data Analytics application. # # @note When making an API call, you may pass FlinkRunConfiguration # data as a hash: # # { # allow_non_restored_state: false, # } # # @!attribute [rw] allow_non_restored_state # When restoring from a savepoint, 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 savepoints to # remove stateful parameters, and state data in the savepoint no # longer corresponds to valid application data. For more information, # see [ Allowing Non-Restored State][1] in the [Apache Flink # documentation][2]. # # # # [1]: https://ci.apache.org/projects/flink/flink-docs-release-1.8/ops/state/savepoints.html#allowing-non-restored-state # [2]: https://ci.apache.org/projects/flink/flink-docs-release-1.8/ # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/FlinkRunConfiguration AWS API Documentation # class FlinkRunConfiguration < Struct.new( :allow_non_restored_state) include Aws::Structure end # When you configure the application input for an SQL-based Amazon # Kinesis Data Analytics application, you specify the streaming source, # the in-application stream name that is created, and the mapping # between the two. # # @note When making an API call, you may pass Input # data as a hash: # # { # name_prefix: "InAppStreamName", # required # input_processing_configuration: { # input_lambda_processor: { # required # resource_arn: "ResourceARN", # required # }, # }, # kinesis_streams_input: { # resource_arn: "ResourceARN", # required # }, # kinesis_firehose_input: { # resource_arn: "ResourceARN", # required # }, # input_parallelism: { # count: 1, # }, # input_schema: { # required # record_format: { # required # record_format_type: "JSON", # required, accepts JSON, CSV # mapping_parameters: { # json_mapping_parameters: { # record_row_path: "RecordRowPath", # required # }, # csv_mapping_parameters: { # record_row_delimiter: "RecordRowDelimiter", # required # record_column_delimiter: "RecordColumnDelimiter", # required # }, # }, # }, # record_encoding: "RecordEncoding", # record_columns: [ # required # { # name: "RecordColumnName", # required # mapping: "RecordColumnMapping", # sql_type: "RecordColumnSqlType", # required # }, # ], # }, # } # # @!attribute [rw] name_prefix # 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. # @return [String] # # @!attribute [rw] input_processing_configuration # 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. # @return [Types::InputProcessingConfiguration] # # @!attribute [rw] kinesis_streams_input # If the streaming source is an Amazon Kinesis data stream, identifies # the stream's Amazon Resource Name (ARN). # @return [Types::KinesisStreamsInput] # # @!attribute [rw] kinesis_firehose_input # If the streaming source is an Amazon Kinesis Data Firehose delivery # stream, identifies the delivery stream's ARN. # @return [Types::KinesisFirehoseInput] # # @!attribute [rw] input_parallelism # Describes the number of in-application streams to create. # @return [Types::InputParallelism] # # @!attribute [rw] input_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. # @return [Types::SourceSchema] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/Input AWS API Documentation # class Input < Struct.new( :name_prefix, :input_processing_configuration, :kinesis_streams_input, :kinesis_firehose_input, :input_parallelism, :input_schema) include Aws::Structure end # Describes the application input configuration for an SQL-based Amazon # Kinesis Data Analytics application. # # @!attribute [rw] input_id # 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. # @return [String] # # @!attribute [rw] name_prefix # The in-application name prefix. # @return [String] # # @!attribute [rw] in_app_stream_names # Returns the in-application stream names that are mapped to the # stream source. # @return [Array] # # @!attribute [rw] input_processing_configuration_description # The description of the preprocessor that executes on records in this # input before the application's code is run. # @return [Types::InputProcessingConfigurationDescription] # # @!attribute [rw] kinesis_streams_input_description # If a Kinesis data stream is configured as a streaming source, # provides the Kinesis data stream's Amazon Resource Name (ARN). # @return [Types::KinesisStreamsInputDescription] # # @!attribute [rw] kinesis_firehose_input_description # If a Kinesis Data Firehose delivery stream is configured as a # streaming source, provides the delivery stream's ARN. # @return [Types::KinesisFirehoseInputDescription] # # @!attribute [rw] input_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. # @return [Types::SourceSchema] # # @!attribute [rw] input_parallelism # Describes the configured parallelism (number of in-application # streams mapped to the streaming source). # @return [Types::InputParallelism] # # @!attribute [rw] input_starting_position_configuration # The point at which the application is configured to read from the # input stream. # @return [Types::InputStartingPositionConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/InputDescription AWS API Documentation # class InputDescription < Struct.new( :input_id, :name_prefix, :in_app_stream_names, :input_processing_configuration_description, :kinesis_streams_input_description, :kinesis_firehose_input_description, :input_schema, :input_parallelism, :input_starting_position_configuration) include Aws::Structure end # An object that contains the Amazon Resource Name (ARN) of the AWS # Lambda function that is used to preprocess records in the stream in an # SQL-based Amazon Kinesis Data Analytics application. # # @note When making an API call, you may pass InputLambdaProcessor # data as a hash: # # { # resource_arn: "ResourceARN", # required # } # # @!attribute [rw] resource_arn # The ARN of the AWS 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: AWS # Lambda](/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda) # # # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/InputLambdaProcessor AWS API Documentation # class InputLambdaProcessor < Struct.new( :resource_arn) include Aws::Structure end # For an SQL-based Amazon Kinesis Data Analytics application, an object # that contains the Amazon Resource Name (ARN) of the AWS Lambda # function that is used to preprocess records in the stream. # # @!attribute [rw] resource_arn # The ARN of the AWS 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: AWS # Lambda](/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda) # # # @return [String] # # @!attribute [rw] role_arn # The ARN of the IAM role that is used to access the AWS 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. # # # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/InputLambdaProcessorDescription AWS API Documentation # class InputLambdaProcessorDescription < Struct.new( :resource_arn, :role_arn) include Aws::Structure end # For an SQL-based Amazon Kinesis Data Analytics application, represents # an update to the InputLambdaProcessor that is used to preprocess the # records in the stream. # # @note When making an API call, you may pass InputLambdaProcessorUpdate # data as a hash: # # { # resource_arn_update: "ResourceARN", # required # } # # @!attribute [rw] resource_arn_update # The Amazon Resource Name (ARN) of the new AWS 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: AWS # Lambda](/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda) # # # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/InputLambdaProcessorUpdate AWS API Documentation # class InputLambdaProcessorUpdate < Struct.new( :resource_arn_update) include Aws::Structure end # For an SQL-based Amazon Kinesis Data Analytics application, describes # the number of in-application streams to create for a given streaming # source. # # @note When making an API call, you may pass InputParallelism # data as a hash: # # { # count: 1, # } # # @!attribute [rw] count # The number of in-application streams to create. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/InputParallelism AWS API Documentation # class InputParallelism < Struct.new( :count) include Aws::Structure end # For an SQL-based Amazon Kinesis Data Analytics application, provides # updates to the parallelism count. # # @note When making an API call, you may pass InputParallelismUpdate # data as a hash: # # { # count_update: 1, # required # } # # @!attribute [rw] count_update # The number of in-application streams to create for the specified # streaming source. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/InputParallelismUpdate AWS API Documentation # class InputParallelismUpdate < Struct.new( :count_update) include Aws::Structure end # For an SQL-based Amazon 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 [AWS Lambda][1]. # # # # [1]: https://aws.amazon.com/documentation/lambda/ # # @note When making an API call, you may pass InputProcessingConfiguration # data as a hash: # # { # input_lambda_processor: { # required # resource_arn: "ResourceARN", # required # }, # } # # @!attribute [rw] input_lambda_processor # The InputLambdaProcessor that is used to preprocess the records in # the stream before being processed by your application code. # @return [Types::InputLambdaProcessor] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/InputProcessingConfiguration AWS API Documentation # class InputProcessingConfiguration < Struct.new( :input_lambda_processor) include Aws::Structure end # For an SQL-based Amazon Kinesis Data Analytics application, provides # the configuration information about an input processor. Currently, the # only input processor available is [AWS Lambda][1]. # # # # [1]: https://aws.amazon.com/documentation/lambda/ # # @!attribute [rw] input_lambda_processor_description # Provides configuration information about the associated # InputLambdaProcessorDescription # @return [Types::InputLambdaProcessorDescription] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/InputProcessingConfigurationDescription AWS API Documentation # class InputProcessingConfigurationDescription < Struct.new( :input_lambda_processor_description) include Aws::Structure end # For an SQL-based Amazon Kinesis Data Analytics application, describes # updates to an InputProcessingConfiguration. # # @note When making an API call, you may pass InputProcessingConfigurationUpdate # data as a hash: # # { # input_lambda_processor_update: { # required # resource_arn_update: "ResourceARN", # required # }, # } # # @!attribute [rw] input_lambda_processor_update # Provides update information for an InputLambdaProcessor. # @return [Types::InputLambdaProcessorUpdate] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/InputProcessingConfigurationUpdate AWS API Documentation # class InputProcessingConfigurationUpdate < Struct.new( :input_lambda_processor_update) include Aws::Structure end # Describes updates for an SQL-based Amazon Kinesis Data Analytics # application's input schema. # # @note When making an API call, you may pass InputSchemaUpdate # data as a hash: # # { # record_format_update: { # record_format_type: "JSON", # required, accepts JSON, CSV # mapping_parameters: { # json_mapping_parameters: { # record_row_path: "RecordRowPath", # required # }, # csv_mapping_parameters: { # record_row_delimiter: "RecordRowDelimiter", # required # record_column_delimiter: "RecordColumnDelimiter", # required # }, # }, # }, # record_encoding_update: "RecordEncoding", # record_column_updates: [ # { # name: "RecordColumnName", # required # mapping: "RecordColumnMapping", # sql_type: "RecordColumnSqlType", # required # }, # ], # } # # @!attribute [rw] record_format_update # Specifies the format of the records on the streaming source. # @return [Types::RecordFormat] # # @!attribute [rw] record_encoding_update # Specifies the encoding of the records in the streaming source; for # example, UTF-8. # @return [String] # # @!attribute [rw] record_column_updates # A list of `RecordColumn` objects. Each object describes the mapping # of the streaming source element to the corresponding column in the # in-application stream. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/InputSchemaUpdate AWS API Documentation # class InputSchemaUpdate < Struct.new( :record_format_update, :record_encoding_update, :record_column_updates) include Aws::Structure end # Describes the point at which the application reads from the streaming # source. # # @note When making an API call, you may pass InputStartingPositionConfiguration # data as a hash: # # { # input_starting_position: "NOW", # accepts NOW, TRIM_HORIZON, LAST_STOPPED_POINT # } # # @!attribute [rw] input_starting_position # 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/InputStartingPositionConfiguration AWS API Documentation # class InputStartingPositionConfiguration < Struct.new( :input_starting_position) include Aws::Structure end # For an SQL-based Amazon Kinesis Data Analytics application, describes # updates to a specific input configuration (identified by the `InputId` # of an application). # # @note When making an API call, you may pass InputUpdate # data as a hash: # # { # input_id: "Id", # required # name_prefix_update: "InAppStreamName", # input_processing_configuration_update: { # input_lambda_processor_update: { # required # resource_arn_update: "ResourceARN", # required # }, # }, # kinesis_streams_input_update: { # resource_arn_update: "ResourceARN", # required # }, # kinesis_firehose_input_update: { # resource_arn_update: "ResourceARN", # required # }, # input_schema_update: { # record_format_update: { # record_format_type: "JSON", # required, accepts JSON, CSV # mapping_parameters: { # json_mapping_parameters: { # record_row_path: "RecordRowPath", # required # }, # csv_mapping_parameters: { # record_row_delimiter: "RecordRowDelimiter", # required # record_column_delimiter: "RecordColumnDelimiter", # required # }, # }, # }, # record_encoding_update: "RecordEncoding", # record_column_updates: [ # { # name: "RecordColumnName", # required # mapping: "RecordColumnMapping", # sql_type: "RecordColumnSqlType", # required # }, # ], # }, # input_parallelism_update: { # count_update: 1, # required # }, # } # # @!attribute [rw] input_id # The input ID of the application input to be updated. # @return [String] # # @!attribute [rw] name_prefix_update # The name prefix for in-application streams that Kinesis Data # Analytics creates for the specific streaming source. # @return [String] # # @!attribute [rw] input_processing_configuration_update # Describes updates to an InputProcessingConfiguration. # @return [Types::InputProcessingConfigurationUpdate] # # @!attribute [rw] kinesis_streams_input_update # If a Kinesis data stream is the streaming source to be updated, # provides an updated stream Amazon Resource Name (ARN). # @return [Types::KinesisStreamsInputUpdate] # # @!attribute [rw] kinesis_firehose_input_update # If a Kinesis Data Firehose delivery stream is the streaming source # to be updated, provides an updated stream ARN. # @return [Types::KinesisFirehoseInputUpdate] # # @!attribute [rw] input_schema_update # 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. # @return [Types::InputSchemaUpdate] # # @!attribute [rw] input_parallelism_update # Describes the parallelism updates (the number of in-application # streams Kinesis Data Analytics creates for the specific streaming # source). # @return [Types::InputParallelismUpdate] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/InputUpdate AWS API Documentation # class InputUpdate < Struct.new( :input_id, :name_prefix_update, :input_processing_configuration_update, :kinesis_streams_input_update, :kinesis_firehose_input_update, :input_schema_update, :input_parallelism_update) include Aws::Structure end # The user-provided application configuration is not valid. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/InvalidApplicationConfigurationException AWS API Documentation # class InvalidApplicationConfigurationException < Struct.new( :message) include Aws::Structure end # The specified input parameter value is not valid. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/InvalidArgumentException AWS API Documentation # class InvalidArgumentException < Struct.new( :message) include Aws::Structure end # The request JSON is not valid for the operation. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/InvalidRequestException AWS API Documentation # class InvalidRequestException < Struct.new( :message) include Aws::Structure end # For an SQL-based Amazon Kinesis Data Analytics application, provides # additional mapping information when JSON is the record format on the # streaming source. # # @note When making an API call, you may pass JSONMappingParameters # data as a hash: # # { # record_row_path: "RecordRowPath", # required # } # # @!attribute [rw] record_row_path # The path to the top-level parent that contains the records. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/JSONMappingParameters AWS API Documentation # class JSONMappingParameters < Struct.new( :record_row_path) include Aws::Structure end # For an SQL-based Amazon 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). # # @note When making an API call, you may pass KinesisFirehoseInput # data as a hash: # # { # resource_arn: "ResourceARN", # required # } # # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the delivery stream. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/KinesisFirehoseInput AWS API Documentation # class KinesisFirehoseInput < Struct.new( :resource_arn) include Aws::Structure end # Describes the Amazon Kinesis Data Firehose delivery stream that is # configured as the streaming source in the application input # configuration. # # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the delivery stream. # @return [String] # # @!attribute [rw] role_arn # 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. # # # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/KinesisFirehoseInputDescription AWS API Documentation # class KinesisFirehoseInputDescription < Struct.new( :resource_arn, :role_arn) include Aws::Structure end # For an SQL-based Amazon Kinesis Data Analytics application, when # updating application input configuration, provides information about a # Kinesis Data Firehose delivery stream as the streaming source. # # @note When making an API call, you may pass KinesisFirehoseInputUpdate # data as a hash: # # { # resource_arn_update: "ResourceARN", # required # } # # @!attribute [rw] resource_arn_update # The Amazon Resource Name (ARN) of the input delivery stream to read. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/KinesisFirehoseInputUpdate AWS API Documentation # class KinesisFirehoseInputUpdate < Struct.new( :resource_arn_update) include Aws::Structure end # For an SQL-based Amazon 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. # # @note When making an API call, you may pass KinesisFirehoseOutput # data as a hash: # # { # resource_arn: "ResourceARN", # required # } # # @!attribute [rw] resource_arn # The ARN of the destination delivery stream to write to. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/KinesisFirehoseOutput AWS API Documentation # class KinesisFirehoseOutput < Struct.new( :resource_arn) include Aws::Structure end # For an SQL-based Amazon Kinesis Data Analytics application's output, # describes the Kinesis Data Firehose delivery stream that is configured # as its destination. # # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the delivery stream. # @return [String] # # @!attribute [rw] role_arn # 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. # # # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/KinesisFirehoseOutputDescription AWS API Documentation # class KinesisFirehoseOutputDescription < Struct.new( :resource_arn, :role_arn) include Aws::Structure end # For an SQL-based Amazon 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. # # @note When making an API call, you may pass KinesisFirehoseOutputUpdate # data as a hash: # # { # resource_arn_update: "ResourceARN", # required # } # # @!attribute [rw] resource_arn_update # The Amazon Resource Name (ARN) of the delivery stream to write to. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/KinesisFirehoseOutputUpdate AWS API Documentation # class KinesisFirehoseOutputUpdate < Struct.new( :resource_arn_update) include Aws::Structure end # Identifies an Amazon Kinesis data stream as the streaming source. You # provide the stream's Amazon Resource Name (ARN). # # @note When making an API call, you may pass KinesisStreamsInput # data as a hash: # # { # resource_arn: "ResourceARN", # required # } # # @!attribute [rw] resource_arn # The ARN of the input Kinesis data stream to read. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/KinesisStreamsInput AWS API Documentation # class KinesisStreamsInput < Struct.new( :resource_arn) include Aws::Structure end # For an SQL-based Amazon Kinesis Data Analytics application, describes # the Kinesis data stream that is configured as the streaming source in # the application input configuration. # # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the Kinesis data stream. # @return [String] # # @!attribute [rw] role_arn # 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. # # # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/KinesisStreamsInputDescription AWS API Documentation # class KinesisStreamsInputDescription < Struct.new( :resource_arn, :role_arn) include Aws::Structure end # When you update the input configuration for an SQL-based Amazon # Kinesis Data Analytics application, provides information about an # Amazon Kinesis stream as the streaming source. # # @note When making an API call, you may pass KinesisStreamsInputUpdate # data as a hash: # # { # resource_arn_update: "ResourceARN", # required # } # # @!attribute [rw] resource_arn_update # The Amazon Resource Name (ARN) of the input Kinesis data stream to # read. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/KinesisStreamsInputUpdate AWS API Documentation # class KinesisStreamsInputUpdate < Struct.new( :resource_arn_update) include Aws::Structure end # When you configure an SQL-based Amazon Kinesis Data Analytics # application's output, identifies a Kinesis data stream as the # destination. You provide the stream Amazon Resource Name (ARN). # # @note When making an API call, you may pass KinesisStreamsOutput # data as a hash: # # { # resource_arn: "ResourceARN", # required # } # # @!attribute [rw] resource_arn # The ARN of the destination Kinesis data stream to write to. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/KinesisStreamsOutput AWS API Documentation # class KinesisStreamsOutput < Struct.new( :resource_arn) include Aws::Structure end # For an SQL-based Amazon Kinesis Data Analytics application's output, # describes the Kinesis data stream that is configured as its # destination. # # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the Kinesis data stream. # @return [String] # # @!attribute [rw] role_arn # 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. # # # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/KinesisStreamsOutputDescription AWS API Documentation # class KinesisStreamsOutputDescription < Struct.new( :resource_arn, :role_arn) include Aws::Structure end # When you update an SQL-based Amazon Kinesis Data Analytics # application's output configuration using the UpdateApplication # operation, provides information about a Kinesis data stream that is # configured as the destination. # # @note When making an API call, you may pass KinesisStreamsOutputUpdate # data as a hash: # # { # resource_arn_update: "ResourceARN", # required # } # # @!attribute [rw] resource_arn_update # The Amazon Resource Name (ARN) of the Kinesis data stream where you # want to write the output. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/KinesisStreamsOutputUpdate AWS API Documentation # class KinesisStreamsOutputUpdate < Struct.new( :resource_arn_update) include Aws::Structure end # When you configure an SQL-based Amazon Kinesis Data Analytics # application's output, identifies an AWS Lambda function as the # destination. You provide the function Amazon Resource Name (ARN) of # the Lambda function. # # @note When making an API call, you may pass LambdaOutput # data as a hash: # # { # resource_arn: "ResourceARN", # required # } # # @!attribute [rw] resource_arn # 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: AWS # Lambda](/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda) # # # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/LambdaOutput AWS API Documentation # class LambdaOutput < Struct.new( :resource_arn) include Aws::Structure end # For an SQL-based Amazon Kinesis Data Analytics application output, # describes the AWS Lambda function that is configured as its # destination. # # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the destination Lambda function. # @return [String] # # @!attribute [rw] role_arn # 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. # # # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/LambdaOutputDescription AWS API Documentation # class LambdaOutputDescription < Struct.new( :resource_arn, :role_arn) include Aws::Structure end # When you update an SQL-based Amazon Kinesis Data Analytics # application's output configuration using the UpdateApplication # operation, provides information about an AWS Lambda function that is # configured as the destination. # # @note When making an API call, you may pass LambdaOutputUpdate # data as a hash: # # { # resource_arn_update: "ResourceARN", # required # } # # @!attribute [rw] resource_arn_update # The Amazon Resource Name (ARN) of the destination AWS 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: AWS # Lambda](/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda) # # # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/LambdaOutputUpdate AWS API Documentation # class LambdaOutputUpdate < Struct.new( :resource_arn_update) include Aws::Structure end # The number of allowed resources has been exceeded. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/LimitExceededException AWS API Documentation # class LimitExceededException < Struct.new( :message) include Aws::Structure end # @note When making an API call, you may pass ListApplicationSnapshotsRequest # data as a hash: # # { # application_name: "ApplicationName", # required # limit: 1, # next_token: "NextToken", # } # # @!attribute [rw] application_name # The name of an existing application. # @return [String] # # @!attribute [rw] limit # The maximum number of application snapshots to list. # @return [Integer] # # @!attribute [rw] next_token # 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/ListApplicationSnapshotsRequest AWS API Documentation # class ListApplicationSnapshotsRequest < Struct.new( :application_name, :limit, :next_token) include Aws::Structure end # @!attribute [rw] snapshot_summaries # A collection of objects containing information about the application # snapshots. # @return [Array] # # @!attribute [rw] next_token # The token for the next set of results, or `null` if there are no # additional results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/ListApplicationSnapshotsResponse AWS API Documentation # class ListApplicationSnapshotsResponse < Struct.new( :snapshot_summaries, :next_token) include Aws::Structure end # @note When making an API call, you may pass ListApplicationsRequest # data as a hash: # # { # limit: 1, # next_token: "ApplicationName", # } # # @!attribute [rw] limit # The maximum number of applications to list. # @return [Integer] # # @!attribute [rw] next_token # If a previous command returned a pagination token, pass it into this # value to retrieve the next set of results. For more information # about pagination, see [Using the AWS Command Line Interface's # Pagination Options][1]. # # # # [1]: https://docs.aws.amazon.com/cli/latest/userguide/pagination.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/ListApplicationsRequest AWS API Documentation # class ListApplicationsRequest < Struct.new( :limit, :next_token) include Aws::Structure end # @!attribute [rw] application_summaries # A list of `ApplicationSummary` objects. # @return [Array] # # @!attribute [rw] next_token # The pagination token for the next set of results, or `null` if there # are no additional results. Pass this token into a subsequent command # to retrieve the next set of items For more information about # pagination, see [Using the AWS Command Line Interface's Pagination # Options][1]. # # # # [1]: https://docs.aws.amazon.com/cli/latest/userguide/pagination.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/ListApplicationsResponse AWS API Documentation # class ListApplicationsResponse < Struct.new( :application_summaries, :next_token) include Aws::Structure end # @note When making an API call, you may pass ListTagsForResourceRequest # data as a hash: # # { # resource_arn: "KinesisAnalyticsARN", # required # } # # @!attribute [rw] resource_arn # The ARN of the application for which to retrieve tags. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/ListTagsForResourceRequest AWS API Documentation # class ListTagsForResourceRequest < Struct.new( :resource_arn) include Aws::Structure end # @!attribute [rw] tags # The key-value tags assigned to the application. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/ListTagsForResourceResponse AWS API Documentation # class ListTagsForResourceResponse < Struct.new( :tags) include Aws::Structure end # When you configure an SQL-based Amazon 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. # # @note When making an API call, you may pass MappingParameters # data as a hash: # # { # json_mapping_parameters: { # record_row_path: "RecordRowPath", # required # }, # csv_mapping_parameters: { # record_row_delimiter: "RecordRowDelimiter", # required # record_column_delimiter: "RecordColumnDelimiter", # required # }, # } # # @!attribute [rw] json_mapping_parameters # Provides additional mapping information when JSON is the record # format on the streaming source. # @return [Types::JSONMappingParameters] # # @!attribute [rw] csv_mapping_parameters # Provides additional mapping information when the record format uses # delimiters (for example, CSV). # @return [Types::CSVMappingParameters] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/MappingParameters AWS API Documentation # class MappingParameters < Struct.new( :json_mapping_parameters, :csv_mapping_parameters) include Aws::Structure end # Describes configuration parameters for Amazon CloudWatch logging for a # Java-based Kinesis Data Analytics application. For more information # about CloudWatch logging, see [Monitoring][1]. # # # # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/java/monitoring-overview.html # # @note When making an API call, you may pass MonitoringConfiguration # data as a hash: # # { # configuration_type: "DEFAULT", # required, accepts DEFAULT, CUSTOM # metrics_level: "APPLICATION", # accepts APPLICATION, TASK, OPERATOR, PARALLELISM # log_level: "INFO", # accepts INFO, WARN, ERROR, DEBUG # } # # @!attribute [rw] 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. # @return [String] # # @!attribute [rw] metrics_level # Describes the granularity of the CloudWatch Logs for an application. # @return [String] # # @!attribute [rw] log_level # Describes the verbosity of the CloudWatch Logs for an application. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/MonitoringConfiguration AWS API Documentation # class MonitoringConfiguration < Struct.new( :configuration_type, :metrics_level, :log_level) include Aws::Structure end # Describes configuration parameters for CloudWatch logging for a # Java-based Kinesis Data Analytics application. # # @!attribute [rw] configuration_type # Describes whether to use the default CloudWatch logging # configuration for an application. # @return [String] # # @!attribute [rw] metrics_level # Describes the granularity of the CloudWatch Logs for an application. # @return [String] # # @!attribute [rw] log_level # Describes the verbosity of the CloudWatch Logs for an application. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/MonitoringConfigurationDescription AWS API Documentation # class MonitoringConfigurationDescription < Struct.new( :configuration_type, :metrics_level, :log_level) include Aws::Structure end # Describes updates to configuration parameters for Amazon CloudWatch # logging for a Java-based Kinesis Data Analytics application. # # @note When making an API call, you may pass MonitoringConfigurationUpdate # data as a hash: # # { # configuration_type_update: "DEFAULT", # accepts DEFAULT, CUSTOM # metrics_level_update: "APPLICATION", # accepts APPLICATION, TASK, OPERATOR, PARALLELISM # log_level_update: "INFO", # accepts INFO, WARN, ERROR, DEBUG # } # # @!attribute [rw] configuration_type_update # 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. # @return [String] # # @!attribute [rw] metrics_level_update # Describes updates to the granularity of the CloudWatch Logs for an # application. # @return [String] # # @!attribute [rw] log_level_update # Describes updates to the verbosity of the CloudWatch Logs for an # application. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/MonitoringConfigurationUpdate AWS API Documentation # class MonitoringConfigurationUpdate < Struct.new( :configuration_type_update, :metrics_level_update, :log_level_update) include Aws::Structure end # Describes an SQL-based Amazon 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. # # @note When making an API call, you may pass Output # data as a hash: # # { # name: "InAppStreamName", # required # kinesis_streams_output: { # resource_arn: "ResourceARN", # required # }, # kinesis_firehose_output: { # resource_arn: "ResourceARN", # required # }, # lambda_output: { # resource_arn: "ResourceARN", # required # }, # destination_schema: { # required # record_format_type: "JSON", # required, accepts JSON, CSV # }, # } # # @!attribute [rw] name # The name of the in-application stream. # @return [String] # # @!attribute [rw] kinesis_streams_output # Identifies an Amazon Kinesis data stream as the destination. # @return [Types::KinesisStreamsOutput] # # @!attribute [rw] kinesis_firehose_output # Identifies an Amazon Kinesis Data Firehose delivery stream as the # destination. # @return [Types::KinesisFirehoseOutput] # # @!attribute [rw] lambda_output # Identifies an AWS Lambda function as the destination. # @return [Types::LambdaOutput] # # @!attribute [rw] destination_schema # Describes the data format when records are written to the # destination. # @return [Types::DestinationSchema] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/Output AWS API Documentation # class Output < Struct.new( :name, :kinesis_streams_output, :kinesis_firehose_output, :lambda_output, :destination_schema) include Aws::Structure end # For an SQL-based Amazon 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. # # @!attribute [rw] output_id # A unique identifier for the output configuration. # @return [String] # # @!attribute [rw] name # The name of the in-application stream that is configured as output. # @return [String] # # @!attribute [rw] kinesis_streams_output_description # Describes the Kinesis data stream that is configured as the # destination where output is written. # @return [Types::KinesisStreamsOutputDescription] # # @!attribute [rw] kinesis_firehose_output_description # Describes the Kinesis Data Firehose delivery stream that is # configured as the destination where output is written. # @return [Types::KinesisFirehoseOutputDescription] # # @!attribute [rw] lambda_output_description # Describes the Lambda function that is configured as the destination # where output is written. # @return [Types::LambdaOutputDescription] # # @!attribute [rw] destination_schema # The data format used for writing data to the destination. # @return [Types::DestinationSchema] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/OutputDescription AWS API Documentation # class OutputDescription < Struct.new( :output_id, :name, :kinesis_streams_output_description, :kinesis_firehose_output_description, :lambda_output_description, :destination_schema) include Aws::Structure end # For an SQL-based Amazon Kinesis Data Analytics application, describes # updates to the output configuration identified by the `OutputId`. # # @note When making an API call, you may pass OutputUpdate # data as a hash: # # { # output_id: "Id", # required # name_update: "InAppStreamName", # kinesis_streams_output_update: { # resource_arn_update: "ResourceARN", # required # }, # kinesis_firehose_output_update: { # resource_arn_update: "ResourceARN", # required # }, # lambda_output_update: { # resource_arn_update: "ResourceARN", # required # }, # destination_schema_update: { # record_format_type: "JSON", # required, accepts JSON, CSV # }, # } # # @!attribute [rw] output_id # Identifies the specific output configuration that you want to # update. # @return [String] # # @!attribute [rw] name_update # 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. # @return [String] # # @!attribute [rw] kinesis_streams_output_update # Describes a Kinesis data stream as the destination for the output. # @return [Types::KinesisStreamsOutputUpdate] # # @!attribute [rw] kinesis_firehose_output_update # Describes a Kinesis Data Firehose delivery stream as the destination # for the output. # @return [Types::KinesisFirehoseOutputUpdate] # # @!attribute [rw] lambda_output_update # Describes an AWS Lambda function as the destination for the output. # @return [Types::LambdaOutputUpdate] # # @!attribute [rw] destination_schema_update # Describes the data format when records are written to the # destination. # @return [Types::DestinationSchema] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/OutputUpdate AWS API Documentation # class OutputUpdate < Struct.new( :output_id, :name_update, :kinesis_streams_output_update, :kinesis_firehose_output_update, :lambda_output_update, :destination_schema_update) include Aws::Structure end # Describes parameters for how a Java-based Amazon Kinesis Data # Analytics application executes multiple tasks simultaneously. For more # information about parallelism, see [Parallel Execution][1] in the # [Apache Flink Documentation][2]. # # # # [1]: https://ci.apache.org/projects/flink/flink-docs-stable/dev/parallel.html # [2]: https://ci.apache.org/projects/flink/flink-docs-release-1.6/ # # @note When making an API call, you may pass ParallelismConfiguration # data as a hash: # # { # configuration_type: "DEFAULT", # required, accepts DEFAULT, CUSTOM # parallelism: 1, # parallelism_per_kpu: 1, # auto_scaling_enabled: false, # } # # @!attribute [rw] configuration_type # Describes whether the application uses the default parallelism for # the Kinesis Data Analytics service. You must set this property to # `CUSTOM` in order to change your application's # `AutoScalingEnabled`, `Parallelism`, or `ParallelismPerKPU` # properties. # @return [String] # # @!attribute [rw] parallelism # Describes the initial number of parallel tasks that a Java-based # Kinesis Data Analytics application can perform. If # `AutoScalingEnabled` is set to True, Kinesis Data Analytics # increases the `CurrentParallelism` value in response to application # load. The service can increase the `CurrentParallelism` value up to # the maximum parallelism, which is `ParalellismPerKPU` times the # maximum KPUs for the application. The maximum KPUs for an # application is 32 by default, and can be increased by requesting a # limit increase. If application load is reduced, the service can # reduce the `CurrentParallelism` value down to the `Parallelism` # setting. # @return [Integer] # # @!attribute [rw] parallelism_per_kpu # Describes the number of parallel tasks that a Java-based Kinesis # Data Analytics application can perform per Kinesis Processing Unit # (KPU) used by the application. For more information about KPUs, see # [Amazon Kinesis Data Analytics Pricing][1]. # # # # [1]: http://aws.amazon.com/kinesis/data-analytics/pricing/ # @return [Integer] # # @!attribute [rw] auto_scaling_enabled # Describes whether the Kinesis Data Analytics service can increase # the parallelism of the application in response to increased # throughput. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/ParallelismConfiguration AWS API Documentation # class ParallelismConfiguration < Struct.new( :configuration_type, :parallelism, :parallelism_per_kpu, :auto_scaling_enabled) include Aws::Structure end # Describes parameters for how a Java-based Kinesis Data Analytics # application executes multiple tasks simultaneously. # # @!attribute [rw] configuration_type # Describes whether the application uses the default parallelism for # the Kinesis Data Analytics service. # @return [String] # # @!attribute [rw] parallelism # Describes the initial number of parallel tasks that a Java-based # Kinesis Data Analytics application can perform. If # `AutoScalingEnabled` is set to True, then Kinesis Data Analytics can # increase the `CurrentParallelism` value in response to application # load. The service can increase `CurrentParallelism` up to the # maximum parallelism, which is `ParalellismPerKPU` times the maximum # KPUs for the application. The maximum KPUs for an application is 32 # by default, and can be increased by requesting a limit increase. If # application load is reduced, the service can reduce the # `CurrentParallelism` value down to the `Parallelism` setting. # @return [Integer] # # @!attribute [rw] parallelism_per_kpu # Describes the number of parallel tasks that a Java-based Kinesis # Data Analytics application can perform per Kinesis Processing Unit # (KPU) used by the application. # @return [Integer] # # @!attribute [rw] current_parallelism # Describes the current number of parallel tasks that a Java-based # Kinesis Data Analytics application can perform. If # `AutoScalingEnabled` is set to True, Kinesis Data Analytics can # increase this value in response to application load. The service can # increase this value up to the maximum parallelism, which is # `ParalellismPerKPU` times the maximum KPUs for the application. The # maximum KPUs for an application is 32 by default, and can be # increased by requesting a limit increase. If application load is # reduced, the service can reduce the `CurrentParallelism` value down # to the `Parallelism` setting. # @return [Integer] # # @!attribute [rw] auto_scaling_enabled # Describes whether the Kinesis Data Analytics service can increase # the parallelism of the application in response to increased # throughput. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/ParallelismConfigurationDescription AWS API Documentation # class ParallelismConfigurationDescription < Struct.new( :configuration_type, :parallelism, :parallelism_per_kpu, :current_parallelism, :auto_scaling_enabled) include Aws::Structure end # Describes updates to parameters for how a Java-based Kinesis Data # Analytics application executes multiple tasks simultaneously. # # @note When making an API call, you may pass ParallelismConfigurationUpdate # data as a hash: # # { # configuration_type_update: "DEFAULT", # accepts DEFAULT, CUSTOM # parallelism_update: 1, # parallelism_per_kpu_update: 1, # auto_scaling_enabled_update: false, # } # # @!attribute [rw] configuration_type_update # Describes updates to whether the application uses the default # parallelism for the Kinesis Data Analytics service, or if a custom # parallelism is used. You must set this property to `CUSTOM` in order # to change your application's `AutoScalingEnabled`, `Parallelism`, # or `ParallelismPerKPU` properties. # @return [String] # # @!attribute [rw] parallelism_update # Describes updates to the initial number of parallel tasks an # application can perform. If `AutoScalingEnabled` is set to True, # then Kinesis Data Analytics can increase the `CurrentParallelism` # value in response to application load. The service can increase # `CurrentParallelism` up to the maximum parallelism, which is # `ParalellismPerKPU` times the maximum KPUs for the application. The # maximum KPUs for an application is 32 by default, and can be # increased by requesting a limit increase. If application load is # reduced, the service will reduce `CurrentParallelism` down to the # `Parallelism` setting. # @return [Integer] # # @!attribute [rw] parallelism_per_kpu_update # Describes updates to the number of parallel tasks an application can # perform per Kinesis Processing Unit (KPU) used by the application. # @return [Integer] # # @!attribute [rw] auto_scaling_enabled_update # Describes updates to whether the Kinesis Data Analytics service can # increase the parallelism of the application in response to increased # throughput. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/ParallelismConfigurationUpdate AWS API Documentation # class ParallelismConfigurationUpdate < Struct.new( :configuration_type_update, :parallelism_update, :parallelism_per_kpu_update, :auto_scaling_enabled_update) include Aws::Structure end # Property key-value pairs passed into a Java-based Kinesis Data # Analytics application. # # @note When making an API call, you may pass PropertyGroup # data as a hash: # # { # property_group_id: "Id", # required # property_map: { # required # "PropertyKey" => "PropertyValue", # }, # } # # @!attribute [rw] property_group_id # Describes the key of an application execution property key-value # pair. # @return [String] # # @!attribute [rw] property_map # Describes the value of an application execution property key-value # pair. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/PropertyGroup AWS API Documentation # class PropertyGroup < Struct.new( :property_group_id, :property_map) include Aws::Structure end # For an SQL-based Amazon 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. # # @note When making an API call, you may pass RecordColumn # data as a hash: # # { # name: "RecordColumnName", # required # mapping: "RecordColumnMapping", # sql_type: "RecordColumnSqlType", # required # } # # @!attribute [rw] name # The name of the column that is created in the in-application input # stream or reference table. # @return [String] # # @!attribute [rw] mapping # A reference to the data element in the streaming input or the # reference data source. # @return [String] # # @!attribute [rw] sql_type # The type of column created in the in-application input stream or # reference table. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/RecordColumn AWS API Documentation # class RecordColumn < Struct.new( :name, :mapping, :sql_type) include Aws::Structure end # For an SQL-based Amazon Kinesis Data Analytics application, describes # the record format and relevant mapping information that should be # applied to schematize the records on the stream. # # @note When making an API call, you may pass RecordFormat # data as a hash: # # { # record_format_type: "JSON", # required, accepts JSON, CSV # mapping_parameters: { # json_mapping_parameters: { # record_row_path: "RecordRowPath", # required # }, # csv_mapping_parameters: { # record_row_delimiter: "RecordRowDelimiter", # required # record_column_delimiter: "RecordColumnDelimiter", # required # }, # }, # } # # @!attribute [rw] record_format_type # The type of record format. # @return [String] # # @!attribute [rw] mapping_parameters # 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. # @return [Types::MappingParameters] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/RecordFormat AWS API Documentation # class RecordFormat < Struct.new( :record_format_type, :mapping_parameters) include Aws::Structure end # For an SQL-based Amazon 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. # # @note When making an API call, you may pass ReferenceDataSource # data as a hash: # # { # table_name: "InAppTableName", # required # s3_reference_data_source: { # bucket_arn: "BucketARN", # file_key: "FileKey", # }, # reference_schema: { # required # record_format: { # required # record_format_type: "JSON", # required, accepts JSON, CSV # mapping_parameters: { # json_mapping_parameters: { # record_row_path: "RecordRowPath", # required # }, # csv_mapping_parameters: { # record_row_delimiter: "RecordRowDelimiter", # required # record_column_delimiter: "RecordColumnDelimiter", # required # }, # }, # }, # record_encoding: "RecordEncoding", # record_columns: [ # required # { # name: "RecordColumnName", # required # mapping: "RecordColumnMapping", # sql_type: "RecordColumnSqlType", # required # }, # ], # }, # } # # @!attribute [rw] table_name # The name of the in-application table to create. # @return [String] # # @!attribute [rw] s3_reference_data_source # Identifies the S3 bucket and object that contains the reference # data. A Kinesis Data Analytics application loads reference data only # once. If the data changes, you call the UpdateApplication operation # to trigger reloading of data into your application. # @return [Types::S3ReferenceDataSource] # # @!attribute [rw] reference_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. # @return [Types::SourceSchema] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/ReferenceDataSource AWS API Documentation # class ReferenceDataSource < Struct.new( :table_name, :s3_reference_data_source, :reference_schema) include Aws::Structure end # For an SQL-based Amazon Kinesis Data Analytics application, describes # the reference data source configured for an application. # # @!attribute [rw] reference_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. # @return [String] # # @!attribute [rw] table_name # The in-application table name created by the specific reference data # source configuration. # @return [String] # # @!attribute [rw] s3_reference_data_source_description # Provides the Amazon S3 bucket name, the object key name that # contains the reference data. # @return [Types::S3ReferenceDataSourceDescription] # # @!attribute [rw] reference_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. # @return [Types::SourceSchema] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/ReferenceDataSourceDescription AWS API Documentation # class ReferenceDataSourceDescription < Struct.new( :reference_id, :table_name, :s3_reference_data_source_description, :reference_schema) include Aws::Structure end # When you update a reference data source configuration for a SQL-based # Amazon 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. # # @note When making an API call, you may pass ReferenceDataSourceUpdate # data as a hash: # # { # reference_id: "Id", # required # table_name_update: "InAppTableName", # s3_reference_data_source_update: { # bucket_arn_update: "BucketARN", # file_key_update: "FileKey", # }, # reference_schema_update: { # record_format: { # required # record_format_type: "JSON", # required, accepts JSON, CSV # mapping_parameters: { # json_mapping_parameters: { # record_row_path: "RecordRowPath", # required # }, # csv_mapping_parameters: { # record_row_delimiter: "RecordRowDelimiter", # required # record_column_delimiter: "RecordColumnDelimiter", # required # }, # }, # }, # record_encoding: "RecordEncoding", # record_columns: [ # required # { # name: "RecordColumnName", # required # mapping: "RecordColumnMapping", # sql_type: "RecordColumnSqlType", # required # }, # ], # }, # } # # @!attribute [rw] reference_id # The ID of the reference data source that is being updated. You can # use the DescribeApplication operation to get this value. # @return [String] # # @!attribute [rw] table_name_update # The in-application table name that is created by this update. # @return [String] # # @!attribute [rw] s3_reference_data_source_update # 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. # @return [Types::S3ReferenceDataSourceUpdate] # # @!attribute [rw] reference_schema_update # 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. # @return [Types::SourceSchema] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/ReferenceDataSourceUpdate AWS API Documentation # class ReferenceDataSourceUpdate < Struct.new( :reference_id, :table_name_update, :s3_reference_data_source_update, :reference_schema_update) include Aws::Structure end # The application is not available for this operation. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/ResourceInUseException AWS API Documentation # class ResourceInUseException < Struct.new( :message) include Aws::Structure end # Specified application can't be found. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/ResourceNotFoundException AWS API Documentation # class ResourceNotFoundException < Struct.new( :message) include Aws::Structure end # Discovery failed to get a record from the streaming source because of # the Amazon Kinesis Streams `ProvisionedThroughputExceededException`. # For more information, see [GetRecords][1] in the Amazon Kinesis # Streams API Reference. # # # # [1]: http://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetRecords.html # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/ResourceProvisionedThroughputExceededException AWS API Documentation # class ResourceProvisionedThroughputExceededException < Struct.new( :message) include Aws::Structure end # Describes the starting parameters for an Amazon Kinesis Data Analytics # application. # # @note When making an API call, you may pass RunConfiguration # data as a hash: # # { # flink_run_configuration: { # allow_non_restored_state: false, # }, # sql_run_configurations: [ # { # input_id: "Id", # required # input_starting_position_configuration: { # required # input_starting_position: "NOW", # accepts NOW, TRIM_HORIZON, LAST_STOPPED_POINT # }, # }, # ], # application_restore_configuration: { # application_restore_type: "SKIP_RESTORE_FROM_SNAPSHOT", # required, accepts SKIP_RESTORE_FROM_SNAPSHOT, RESTORE_FROM_LATEST_SNAPSHOT, RESTORE_FROM_CUSTOM_SNAPSHOT # snapshot_name: "SnapshotName", # }, # } # # @!attribute [rw] flink_run_configuration # Describes the starting parameters for an Apache Flink-based Kinesis # Data Analytics application. # @return [Types::FlinkRunConfiguration] # # @!attribute [rw] sql_run_configurations # Describes the starting parameters for an SQL-based Kinesis Data # Analytics application. # @return [Array] # # @!attribute [rw] application_restore_configuration # Describes the restore behavior of a restarting application. # @return [Types::ApplicationRestoreConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/RunConfiguration AWS API Documentation # class RunConfiguration < Struct.new( :flink_run_configuration, :sql_run_configurations, :application_restore_configuration) include Aws::Structure end # Describes the starting properties for a Kinesis Data Analytics # application. # # @!attribute [rw] application_restore_configuration_description # Describes the restore behavior of a restarting application. # @return [Types::ApplicationRestoreConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/RunConfigurationDescription AWS API Documentation # class RunConfigurationDescription < Struct.new( :application_restore_configuration_description) include Aws::Structure end # Describes the updates to the starting parameters for a Kinesis Data # Analytics application. # # @note When making an API call, you may pass RunConfigurationUpdate # data as a hash: # # { # flink_run_configuration: { # allow_non_restored_state: false, # }, # application_restore_configuration: { # application_restore_type: "SKIP_RESTORE_FROM_SNAPSHOT", # required, accepts SKIP_RESTORE_FROM_SNAPSHOT, RESTORE_FROM_LATEST_SNAPSHOT, RESTORE_FROM_CUSTOM_SNAPSHOT # snapshot_name: "SnapshotName", # }, # } # # @!attribute [rw] flink_run_configuration # Describes the starting parameters for an Apache Flink-based Kinesis # Data Analytics application. # @return [Types::FlinkRunConfiguration] # # @!attribute [rw] application_restore_configuration # Describes updates to the restore behavior of a restarting # application. # @return [Types::ApplicationRestoreConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/RunConfigurationUpdate AWS API Documentation # class RunConfigurationUpdate < Struct.new( :flink_run_configuration, :application_restore_configuration) include Aws::Structure end # Describes the location of a Java-based Amazon Kinesis Data Analytics # application's code stored in an S3 bucket. # # @!attribute [rw] bucket_arn # The Amazon Resource Name (ARN) for the S3 bucket containing the # application code. # @return [String] # # @!attribute [rw] file_key # The file key for the object containing the application code. # @return [String] # # @!attribute [rw] object_version # The version of the object containing the application code. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/S3ApplicationCodeLocationDescription AWS API Documentation # class S3ApplicationCodeLocationDescription < Struct.new( :bucket_arn, :file_key, :object_version) include Aws::Structure end # For an SQL-based Amazon 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. # # @note When making an API call, you may pass S3Configuration # data as a hash: # # { # bucket_arn: "BucketARN", # required # file_key: "FileKey", # required # } # # @!attribute [rw] bucket_arn # The ARN of the S3 bucket that contains the data. # @return [String] # # @!attribute [rw] file_key # The name of the object that contains the data. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/S3Configuration AWS API Documentation # class S3Configuration < Struct.new( :bucket_arn, :file_key) include Aws::Structure end # For a Java-based Amazon Kinesis Data Analytics 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. # # @note When making an API call, you may pass S3ContentLocation # data as a hash: # # { # bucket_arn: "BucketARN", # required # file_key: "FileKey", # required # object_version: "ObjectVersion", # } # # @!attribute [rw] bucket_arn # The Amazon Resource Name (ARN) for the S3 bucket containing the # application code. # @return [String] # # @!attribute [rw] file_key # The file key for the object containing the application code. # @return [String] # # @!attribute [rw] object_version # The version of the object containing the application code. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/S3ContentLocation AWS API Documentation # class S3ContentLocation < Struct.new( :bucket_arn, :file_key, :object_version) include Aws::Structure end # Describes an update for the Amazon S3 code content location for a # Java-based Amazon Kinesis Data Analytics application. # # @note When making an API call, you may pass S3ContentLocationUpdate # data as a hash: # # { # bucket_arn_update: "BucketARN", # file_key_update: "FileKey", # object_version_update: "ObjectVersion", # } # # @!attribute [rw] bucket_arn_update # The new Amazon Resource Name (ARN) for the S3 bucket containing the # application code. # @return [String] # # @!attribute [rw] file_key_update # The new file key for the object containing the application code. # @return [String] # # @!attribute [rw] object_version_update # The new version of the object containing the application code. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/S3ContentLocationUpdate AWS API Documentation # class S3ContentLocationUpdate < Struct.new( :bucket_arn_update, :file_key_update, :object_version_update) include Aws::Structure end # For an SQL-based Amazon Kinesis Data Analytics application, identifies # the Amazon S3 bucket and object that contains the reference data. # # A Kinesis Data Analytics application loads reference data only once. # If the data changes, you call the UpdateApplication operation to # trigger reloading of data into your application. # # @note When making an API call, you may pass S3ReferenceDataSource # data as a hash: # # { # bucket_arn: "BucketARN", # file_key: "FileKey", # } # # @!attribute [rw] bucket_arn # The Amazon Resource Name (ARN) of the S3 bucket. # @return [String] # # @!attribute [rw] file_key # The object key name containing the reference data. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/S3ReferenceDataSource AWS API Documentation # class S3ReferenceDataSource < Struct.new( :bucket_arn, :file_key) include Aws::Structure end # For an SQL-based Amazon Kinesis Data Analytics application, provides # the bucket name and object key name that stores the reference data. # # @!attribute [rw] bucket_arn # The Amazon Resource Name (ARN) of the S3 bucket. # @return [String] # # @!attribute [rw] file_key # Amazon S3 object key name. # @return [String] # # @!attribute [rw] reference_role_arn # 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. # # # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/S3ReferenceDataSourceDescription AWS API Documentation # class S3ReferenceDataSourceDescription < Struct.new( :bucket_arn, :file_key, :reference_role_arn) include Aws::Structure end # For an SQL-based Amazon Kinesis Data Analytics application, describes # the Amazon S3 bucket name and object key name for an in-application # reference table. # # @note When making an API call, you may pass S3ReferenceDataSourceUpdate # data as a hash: # # { # bucket_arn_update: "BucketARN", # file_key_update: "FileKey", # } # # @!attribute [rw] bucket_arn_update # The Amazon Resource Name (ARN) of the S3 bucket. # @return [String] # # @!attribute [rw] file_key_update # The object key name. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/S3ReferenceDataSourceUpdate AWS API Documentation # class S3ReferenceDataSourceUpdate < Struct.new( :bucket_arn_update, :file_key_update) include Aws::Structure end # The service cannot complete the request. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/ServiceUnavailableException AWS API Documentation # class ServiceUnavailableException < Struct.new( :message) include Aws::Structure end # Provides details about a snapshot of application state. # # @!attribute [rw] snapshot_name # The identifier for the application snapshot. # @return [String] # # @!attribute [rw] snapshot_status # The status of the application snapshot. # @return [String] # # @!attribute [rw] application_version_id # The current application version ID when the snapshot was created. # @return [Integer] # # @!attribute [rw] snapshot_creation_timestamp # The timestamp of the application snapshot. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/SnapshotDetails AWS API Documentation # class SnapshotDetails < Struct.new( :snapshot_name, :snapshot_status, :application_version_id, :snapshot_creation_timestamp) include Aws::Structure end # For an SQL-based Amazon 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. # # @note When making an API call, you may pass SourceSchema # data as a hash: # # { # record_format: { # required # record_format_type: "JSON", # required, accepts JSON, CSV # mapping_parameters: { # json_mapping_parameters: { # record_row_path: "RecordRowPath", # required # }, # csv_mapping_parameters: { # record_row_delimiter: "RecordRowDelimiter", # required # record_column_delimiter: "RecordColumnDelimiter", # required # }, # }, # }, # record_encoding: "RecordEncoding", # record_columns: [ # required # { # name: "RecordColumnName", # required # mapping: "RecordColumnMapping", # sql_type: "RecordColumnSqlType", # required # }, # ], # } # # @!attribute [rw] record_format # Specifies the format of the records on the streaming source. # @return [Types::RecordFormat] # # @!attribute [rw] record_encoding # Specifies the encoding of the records in the streaming source. For # example, UTF-8. # @return [String] # # @!attribute [rw] record_columns # A list of `RecordColumn` objects. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/SourceSchema AWS API Documentation # class SourceSchema < Struct.new( :record_format, :record_encoding, :record_columns) include Aws::Structure end # Describes the inputs, outputs, and reference data sources for an # SQL-based Kinesis Data Analytics application. # # @note When making an API call, you may pass SqlApplicationConfiguration # data as a hash: # # { # inputs: [ # { # name_prefix: "InAppStreamName", # required # input_processing_configuration: { # input_lambda_processor: { # required # resource_arn: "ResourceARN", # required # }, # }, # kinesis_streams_input: { # resource_arn: "ResourceARN", # required # }, # kinesis_firehose_input: { # resource_arn: "ResourceARN", # required # }, # input_parallelism: { # count: 1, # }, # input_schema: { # required # record_format: { # required # record_format_type: "JSON", # required, accepts JSON, CSV # mapping_parameters: { # json_mapping_parameters: { # record_row_path: "RecordRowPath", # required # }, # csv_mapping_parameters: { # record_row_delimiter: "RecordRowDelimiter", # required # record_column_delimiter: "RecordColumnDelimiter", # required # }, # }, # }, # record_encoding: "RecordEncoding", # record_columns: [ # required # { # name: "RecordColumnName", # required # mapping: "RecordColumnMapping", # sql_type: "RecordColumnSqlType", # required # }, # ], # }, # }, # ], # outputs: [ # { # name: "InAppStreamName", # required # kinesis_streams_output: { # resource_arn: "ResourceARN", # required # }, # kinesis_firehose_output: { # resource_arn: "ResourceARN", # required # }, # lambda_output: { # resource_arn: "ResourceARN", # required # }, # destination_schema: { # required # record_format_type: "JSON", # required, accepts JSON, CSV # }, # }, # ], # reference_data_sources: [ # { # table_name: "InAppTableName", # required # s3_reference_data_source: { # bucket_arn: "BucketARN", # file_key: "FileKey", # }, # reference_schema: { # required # record_format: { # required # record_format_type: "JSON", # required, accepts JSON, CSV # mapping_parameters: { # json_mapping_parameters: { # record_row_path: "RecordRowPath", # required # }, # csv_mapping_parameters: { # record_row_delimiter: "RecordRowDelimiter", # required # record_column_delimiter: "RecordColumnDelimiter", # required # }, # }, # }, # record_encoding: "RecordEncoding", # record_columns: [ # required # { # name: "RecordColumnName", # required # mapping: "RecordColumnMapping", # sql_type: "RecordColumnSqlType", # required # }, # ], # }, # }, # ], # } # # @!attribute [rw] inputs # The array of Input objects describing the input streams used by the # application. # @return [Array] # # @!attribute [rw] outputs # The array of Output objects describing the destination streams used # by the application. # @return [Array] # # @!attribute [rw] reference_data_sources # The array of ReferenceDataSource objects describing the reference # data sources used by the application. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/SqlApplicationConfiguration AWS API Documentation # class SqlApplicationConfiguration < Struct.new( :inputs, :outputs, :reference_data_sources) include Aws::Structure end # Describes the inputs, outputs, and reference data sources for an # SQL-based Kinesis Data Analytics application. # # @!attribute [rw] input_descriptions # The array of InputDescription objects describing the input streams # used by the application. # @return [Array] # # @!attribute [rw] output_descriptions # The array of OutputDescription objects describing the destination # streams used by the application. # @return [Array] # # @!attribute [rw] reference_data_source_descriptions # The array of ReferenceDataSourceDescription objects describing the # reference data sources used by the application. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/SqlApplicationConfigurationDescription AWS API Documentation # class SqlApplicationConfigurationDescription < Struct.new( :input_descriptions, :output_descriptions, :reference_data_source_descriptions) include Aws::Structure end # Describes updates to the input streams, destination streams, and # reference data sources for an SQL-based Kinesis Data Analytics # application. # # @note When making an API call, you may pass SqlApplicationConfigurationUpdate # data as a hash: # # { # input_updates: [ # { # input_id: "Id", # required # name_prefix_update: "InAppStreamName", # input_processing_configuration_update: { # input_lambda_processor_update: { # required # resource_arn_update: "ResourceARN", # required # }, # }, # kinesis_streams_input_update: { # resource_arn_update: "ResourceARN", # required # }, # kinesis_firehose_input_update: { # resource_arn_update: "ResourceARN", # required # }, # input_schema_update: { # record_format_update: { # record_format_type: "JSON", # required, accepts JSON, CSV # mapping_parameters: { # json_mapping_parameters: { # record_row_path: "RecordRowPath", # required # }, # csv_mapping_parameters: { # record_row_delimiter: "RecordRowDelimiter", # required # record_column_delimiter: "RecordColumnDelimiter", # required # }, # }, # }, # record_encoding_update: "RecordEncoding", # record_column_updates: [ # { # name: "RecordColumnName", # required # mapping: "RecordColumnMapping", # sql_type: "RecordColumnSqlType", # required # }, # ], # }, # input_parallelism_update: { # count_update: 1, # required # }, # }, # ], # output_updates: [ # { # output_id: "Id", # required # name_update: "InAppStreamName", # kinesis_streams_output_update: { # resource_arn_update: "ResourceARN", # required # }, # kinesis_firehose_output_update: { # resource_arn_update: "ResourceARN", # required # }, # lambda_output_update: { # resource_arn_update: "ResourceARN", # required # }, # destination_schema_update: { # record_format_type: "JSON", # required, accepts JSON, CSV # }, # }, # ], # reference_data_source_updates: [ # { # reference_id: "Id", # required # table_name_update: "InAppTableName", # s3_reference_data_source_update: { # bucket_arn_update: "BucketARN", # file_key_update: "FileKey", # }, # reference_schema_update: { # record_format: { # required # record_format_type: "JSON", # required, accepts JSON, CSV # mapping_parameters: { # json_mapping_parameters: { # record_row_path: "RecordRowPath", # required # }, # csv_mapping_parameters: { # record_row_delimiter: "RecordRowDelimiter", # required # record_column_delimiter: "RecordColumnDelimiter", # required # }, # }, # }, # record_encoding: "RecordEncoding", # record_columns: [ # required # { # name: "RecordColumnName", # required # mapping: "RecordColumnMapping", # sql_type: "RecordColumnSqlType", # required # }, # ], # }, # }, # ], # } # # @!attribute [rw] input_updates # The array of InputUpdate objects describing the new input streams # used by the application. # @return [Array] # # @!attribute [rw] output_updates # The array of OutputUpdate objects describing the new destination # streams used by the application. # @return [Array] # # @!attribute [rw] reference_data_source_updates # The array of ReferenceDataSourceUpdate objects describing the new # reference data sources used by the application. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/SqlApplicationConfigurationUpdate AWS API Documentation # class SqlApplicationConfigurationUpdate < Struct.new( :input_updates, :output_updates, :reference_data_source_updates) include Aws::Structure end # Describes the starting parameters for an SQL-based Kinesis Data # Analytics application. # # @note When making an API call, you may pass SqlRunConfiguration # data as a hash: # # { # input_id: "Id", # required # input_starting_position_configuration: { # required # input_starting_position: "NOW", # accepts NOW, TRIM_HORIZON, LAST_STOPPED_POINT # }, # } # # @!attribute [rw] input_id # The input source ID. You can get this ID by calling the # DescribeApplication operation. # @return [String] # # @!attribute [rw] input_starting_position_configuration # The point at which you want the application to start processing # records from the streaming source. # @return [Types::InputStartingPositionConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/SqlRunConfiguration AWS API Documentation # class SqlRunConfiguration < Struct.new( :input_id, :input_starting_position_configuration) include Aws::Structure end # @note When making an API call, you may pass StartApplicationRequest # data as a hash: # # { # application_name: "ApplicationName", # required # run_configuration: { # required # flink_run_configuration: { # allow_non_restored_state: false, # }, # sql_run_configurations: [ # { # input_id: "Id", # required # input_starting_position_configuration: { # required # input_starting_position: "NOW", # accepts NOW, TRIM_HORIZON, LAST_STOPPED_POINT # }, # }, # ], # application_restore_configuration: { # application_restore_type: "SKIP_RESTORE_FROM_SNAPSHOT", # required, accepts SKIP_RESTORE_FROM_SNAPSHOT, RESTORE_FROM_LATEST_SNAPSHOT, RESTORE_FROM_CUSTOM_SNAPSHOT # snapshot_name: "SnapshotName", # }, # }, # } # # @!attribute [rw] application_name # The name of the application. # @return [String] # # @!attribute [rw] run_configuration # Identifies the run configuration (start parameters) of a Kinesis # Data Analytics application. # @return [Types::RunConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/StartApplicationRequest AWS API Documentation # class StartApplicationRequest < Struct.new( :application_name, :run_configuration) include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/StartApplicationResponse AWS API Documentation # class StartApplicationResponse < Aws::EmptyStructure; end # @note When making an API call, you may pass StopApplicationRequest # data as a hash: # # { # application_name: "ApplicationName", # required # } # # @!attribute [rw] application_name # The name of the running application to stop. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/StopApplicationRequest AWS API Documentation # class StopApplicationRequest < Struct.new( :application_name) include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/StopApplicationResponse AWS API Documentation # class StopApplicationResponse < Aws::EmptyStructure; end # A key-value pair (the value is optional) that you can define and # assign to AWS resources. If you specify a tag that already exists, the # tag value is replaced with the value that you specify in the request. # Note that the maximum number of application tags includes system tags. # The maximum number of user-defined application tags is 50. For more # information, see [Using Tagging][1]. # # # # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/java/how-tagging.html # # @note When making an API call, you may pass Tag # data as a hash: # # { # key: "TagKey", # required # value: "TagValue", # } # # @!attribute [rw] key # The key of the key-value tag. # @return [String] # # @!attribute [rw] value # The value of the key-value tag. The value is optional. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/Tag AWS API Documentation # class Tag < Struct.new( :key, :value) include Aws::Structure end # @note When making an API call, you may pass TagResourceRequest # data as a hash: # # { # resource_arn: "KinesisAnalyticsARN", # required # tags: [ # required # { # key: "TagKey", # required # value: "TagValue", # }, # ], # } # # @!attribute [rw] resource_arn # The ARN of the application to assign the tags. # @return [String] # # @!attribute [rw] tags # The key-value tags to assign to the application. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/TagResourceRequest AWS API Documentation # class TagResourceRequest < Struct.new( :resource_arn, :tags) include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/TagResourceResponse AWS API Documentation # class TagResourceResponse < Aws::EmptyStructure; end # 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. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/TooManyTagsException AWS API Documentation # class TooManyTagsException < Struct.new( :message) include Aws::Structure end # The data format is not valid. Amazon Kinesis Data Analytics cannot # detect the schema for the given streaming source. # # @!attribute [rw] message # @return [String] # # @!attribute [rw] raw_input_records # Raw stream data that was sampled to infer the schema. # @return [Array] # # @!attribute [rw] processed_input_records # Stream data that was modified by the processor specified in the # `InputProcessingConfiguration` parameter. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/UnableToDetectSchemaException AWS API Documentation # class UnableToDetectSchemaException < Struct.new( :message, :raw_input_records, :processed_input_records) include Aws::Structure end # The request was rejected because a specified parameter is not # supported or a specified resource is not valid for this operation. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/UnsupportedOperationException AWS API Documentation # class UnsupportedOperationException < Struct.new( :message) include Aws::Structure end # @note When making an API call, you may pass UntagResourceRequest # data as a hash: # # { # resource_arn: "KinesisAnalyticsARN", # required # tag_keys: ["TagKey"], # required # } # # @!attribute [rw] resource_arn # The ARN of the Kinesis Analytics application from which to remove # the tags. # @return [String] # # @!attribute [rw] tag_keys # A list of keys of tags to remove from the specified application. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/UntagResourceRequest AWS API Documentation # class UntagResourceRequest < Struct.new( :resource_arn, :tag_keys) include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/UntagResourceResponse AWS API Documentation # class UntagResourceResponse < Aws::EmptyStructure; end # @note When making an API call, you may pass UpdateApplicationRequest # data as a hash: # # { # application_name: "ApplicationName", # required # current_application_version_id: 1, # required # application_configuration_update: { # sql_application_configuration_update: { # input_updates: [ # { # input_id: "Id", # required # name_prefix_update: "InAppStreamName", # input_processing_configuration_update: { # input_lambda_processor_update: { # required # resource_arn_update: "ResourceARN", # required # }, # }, # kinesis_streams_input_update: { # resource_arn_update: "ResourceARN", # required # }, # kinesis_firehose_input_update: { # resource_arn_update: "ResourceARN", # required # }, # input_schema_update: { # record_format_update: { # record_format_type: "JSON", # required, accepts JSON, CSV # mapping_parameters: { # json_mapping_parameters: { # record_row_path: "RecordRowPath", # required # }, # csv_mapping_parameters: { # record_row_delimiter: "RecordRowDelimiter", # required # record_column_delimiter: "RecordColumnDelimiter", # required # }, # }, # }, # record_encoding_update: "RecordEncoding", # record_column_updates: [ # { # name: "RecordColumnName", # required # mapping: "RecordColumnMapping", # sql_type: "RecordColumnSqlType", # required # }, # ], # }, # input_parallelism_update: { # count_update: 1, # required # }, # }, # ], # output_updates: [ # { # output_id: "Id", # required # name_update: "InAppStreamName", # kinesis_streams_output_update: { # resource_arn_update: "ResourceARN", # required # }, # kinesis_firehose_output_update: { # resource_arn_update: "ResourceARN", # required # }, # lambda_output_update: { # resource_arn_update: "ResourceARN", # required # }, # destination_schema_update: { # record_format_type: "JSON", # required, accepts JSON, CSV # }, # }, # ], # reference_data_source_updates: [ # { # reference_id: "Id", # required # table_name_update: "InAppTableName", # s3_reference_data_source_update: { # bucket_arn_update: "BucketARN", # file_key_update: "FileKey", # }, # reference_schema_update: { # record_format: { # required # record_format_type: "JSON", # required, accepts JSON, CSV # mapping_parameters: { # json_mapping_parameters: { # record_row_path: "RecordRowPath", # required # }, # csv_mapping_parameters: { # record_row_delimiter: "RecordRowDelimiter", # required # record_column_delimiter: "RecordColumnDelimiter", # required # }, # }, # }, # record_encoding: "RecordEncoding", # record_columns: [ # required # { # name: "RecordColumnName", # required # mapping: "RecordColumnMapping", # sql_type: "RecordColumnSqlType", # required # }, # ], # }, # }, # ], # }, # application_code_configuration_update: { # code_content_type_update: "PLAINTEXT", # accepts PLAINTEXT, ZIPFILE # code_content_update: { # text_content_update: "TextContent", # zip_file_content_update: "data", # s3_content_location_update: { # bucket_arn_update: "BucketARN", # file_key_update: "FileKey", # object_version_update: "ObjectVersion", # }, # }, # }, # flink_application_configuration_update: { # checkpoint_configuration_update: { # configuration_type_update: "DEFAULT", # accepts DEFAULT, CUSTOM # checkpointing_enabled_update: false, # checkpoint_interval_update: 1, # min_pause_between_checkpoints_update: 1, # }, # monitoring_configuration_update: { # configuration_type_update: "DEFAULT", # accepts DEFAULT, CUSTOM # metrics_level_update: "APPLICATION", # accepts APPLICATION, TASK, OPERATOR, PARALLELISM # log_level_update: "INFO", # accepts INFO, WARN, ERROR, DEBUG # }, # parallelism_configuration_update: { # configuration_type_update: "DEFAULT", # accepts DEFAULT, CUSTOM # parallelism_update: 1, # parallelism_per_kpu_update: 1, # auto_scaling_enabled_update: false, # }, # }, # environment_property_updates: { # property_groups: [ # required # { # property_group_id: "Id", # required # property_map: { # required # "PropertyKey" => "PropertyValue", # }, # }, # ], # }, # application_snapshot_configuration_update: { # snapshots_enabled_update: false, # required # }, # vpc_configuration_updates: [ # { # vpc_configuration_id: "Id", # required # subnet_id_updates: ["SubnetId"], # security_group_id_updates: ["SecurityGroupId"], # }, # ], # }, # service_execution_role_update: "RoleARN", # run_configuration_update: { # flink_run_configuration: { # allow_non_restored_state: false, # }, # application_restore_configuration: { # application_restore_type: "SKIP_RESTORE_FROM_SNAPSHOT", # required, accepts SKIP_RESTORE_FROM_SNAPSHOT, RESTORE_FROM_LATEST_SNAPSHOT, RESTORE_FROM_CUSTOM_SNAPSHOT # snapshot_name: "SnapshotName", # }, # }, # cloud_watch_logging_option_updates: [ # { # cloud_watch_logging_option_id: "Id", # required # log_stream_arn_update: "LogStreamARN", # }, # ], # } # # @!attribute [rw] application_name # The name of the application to update. # @return [String] # # @!attribute [rw] current_application_version_id # The current application version ID. You can retrieve the application # version ID using DescribeApplication. # @return [Integer] # # @!attribute [rw] application_configuration_update # Describes application configuration updates. # @return [Types::ApplicationConfigurationUpdate] # # @!attribute [rw] service_execution_role_update # Describes updates to the service execution role. # @return [String] # # @!attribute [rw] run_configuration_update # Describes updates to the application's starting parameters. # @return [Types::RunConfigurationUpdate] # # @!attribute [rw] cloud_watch_logging_option_updates # 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. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/UpdateApplicationRequest AWS API Documentation # class UpdateApplicationRequest < Struct.new( :application_name, :current_application_version_id, :application_configuration_update, :service_execution_role_update, :run_configuration_update, :cloud_watch_logging_option_updates) include Aws::Structure end # @!attribute [rw] application_detail # Describes application updates. # @return [Types::ApplicationDetail] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/UpdateApplicationResponse AWS API Documentation # class UpdateApplicationResponse < Struct.new( :application_detail) include Aws::Structure end # Describes the parameters of a VPC used by the application. # # @note When making an API call, you may pass VpcConfiguration # data as a hash: # # { # subnet_ids: ["SubnetId"], # required # security_group_ids: ["SecurityGroupId"], # required # } # # @!attribute [rw] subnet_ids # The array of [Subnet][1] IDs used by the VPC configuration. # # # # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Subnet.html # @return [Array] # # @!attribute [rw] security_group_ids # The array of [SecurityGroup][1] IDs used by the VPC configuration. # # # # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SecurityGroup.html # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/VpcConfiguration AWS API Documentation # class VpcConfiguration < Struct.new( :subnet_ids, :security_group_ids) include Aws::Structure end # Describes the parameters of a VPC used by the application. # # @!attribute [rw] vpc_configuration_id # The ID of the VPC configuration. # @return [String] # # @!attribute [rw] vpc_id # The ID of the associated VPC. # @return [String] # # @!attribute [rw] subnet_ids # The array of [Subnet][1] IDs used by the VPC configuration. # # # # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Subnet.html # @return [Array] # # @!attribute [rw] security_group_ids # The array of [SecurityGroup][1] IDs used by the VPC configuration. # # # # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SecurityGroup.html # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/VpcConfigurationDescription AWS API Documentation # class VpcConfigurationDescription < Struct.new( :vpc_configuration_id, :vpc_id, :subnet_ids, :security_group_ids) include Aws::Structure end # Describes updates to the VPC configuration used by the application. # # @note When making an API call, you may pass VpcConfigurationUpdate # data as a hash: # # { # vpc_configuration_id: "Id", # required # subnet_id_updates: ["SubnetId"], # security_group_id_updates: ["SecurityGroupId"], # } # # @!attribute [rw] vpc_configuration_id # Describes an update to the ID of the VPC configuration. # @return [String] # # @!attribute [rw] subnet_id_updates # Describes updates to the array of [Subnet][1] IDs used by the VPC # configuration. # # # # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Subnet.html # @return [Array] # # @!attribute [rw] security_group_id_updates # Describes updates to the array of [SecurityGroup][1] IDs used by the # VPC configuration. # # # # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SecurityGroup.html # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/VpcConfigurationUpdate AWS API Documentation # class VpcConfigurationUpdate < Struct.new( :vpc_configuration_id, :subnet_id_updates, :security_group_id_updates) include Aws::Structure end end end