openapi: 3.0.0 info: version: '2018-05-23' x-release: v4 title: 'Amazon Kinesis Analytics #X Amz Target=KinesisAnalytics 20180523.AddApplicationCloudWatchLoggingOption #X Amz Target=KinesisAnalytics 20180523.AddApplicationCloudWatchLoggingOption #X Amz Target=KinesisAnalytics 20180523.UpdateApplication API' description: Amazon Kinesis Data Analytics is a fully managed service that you can use to process and analyze streaming data using Java, SQL, or Scala. The service enables you to quickly author and run Java, SQL, or Scala code against streaming sources to perform time series analytics, feed real-time dashboards, and create real-time metrics. x-logo: url: https://twitter.com/awscloud/profile_image?size=original backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: kinesisanalyticsv2 x-aws-signingName: kinesisanalytics x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/kinesisanalyticsv2-2018-05-23.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://kinesisanalytics.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Kinesis Analytics V2 multi-region endpoint - url: https://kinesisanalytics.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Kinesis Analytics V2 multi-region endpoint - url: http://kinesisanalytics.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Kinesis Analytics V2 endpoint for China (Beijing) and China (Ningxia) - url: https://kinesisanalytics.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Kinesis Analytics V2 endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: '#X Amz Target=KinesisAnalytics 20180523.UpdateApplication' paths: /#X-Amz-Target=KinesisAnalytics_20180523.UpdateApplication: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: UpdateApplication description:

Updates an existing Kinesis Data Analytics application. Using this operation, you can update application code, input configuration, and output configuration.

Kinesis Data Analytics updates the ApplicationVersionId each time you update your application.

You cannot update the RuntimeEnvironment of an existing application. If you need to update an application's RuntimeEnvironment, you must delete the application and create it again.

 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateApplicationResponse' '480': description: CodeValidationException content: application/json: schema: $ref: '#/components/schemas/CodeValidationException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' '483': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' '484': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' '485': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '486': description: InvalidApplicationConfigurationException content: application/json: schema: $ref: '#/components/schemas/InvalidApplicationConfigurationException' '487': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateApplicationRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - KinesisAnalytics_20180523.UpdateApplication summary: Amazon Managed Service for Apache Flink Update Application tags: - '#X Amz Target=KinesisAnalytics 20180523.UpdateApplication' components: schemas: InputProcessingConfigurationUpdate: type: object required: - InputLambdaProcessorUpdate properties: InputLambdaProcessorUpdate: allOf: - $ref: '#/components/schemas/InputLambdaProcessorUpdate' - description: Provides update information for an InputLambdaProcessor. description: For a SQL-based Kinesis Data Analytics application, describes updates to an InputProcessingConfiguration. ResourceInUseException: {} S3ContentBaseLocationDescription: type: object required: - BucketARN properties: BucketARN: allOf: - $ref: '#/components/schemas/BucketARN' - description: The Amazon Resource Name (ARN) of the S3 bucket. BasePath: allOf: - $ref: '#/components/schemas/BasePath' - description: The base path for the S3 bucket. description: The description of the S3 base location that holds the application. VpcConfigurationUpdates: type: array items: $ref: '#/components/schemas/VpcConfigurationUpdate' ReferenceDataSourceDescriptions: type: array items: $ref: '#/components/schemas/ReferenceDataSourceDescription' InputParallelismUpdate: type: object required: - CountUpdate properties: CountUpdate: allOf: - $ref: '#/components/schemas/InputParallelismCount' - description: The number of in-application streams to create for the specified streaming source. description: For a SQL-based Kinesis Data Analytics application, provides updates to the parallelism count. RunConfigurationDescription: type: object properties: ApplicationRestoreConfigurationDescription: allOf: - $ref: '#/components/schemas/ApplicationRestoreConfiguration' - description: Describes the restore behavior of a restarting application. FlinkRunConfigurationDescription: $ref: '#/components/schemas/FlinkRunConfiguration' description: Describes the starting properties for a Kinesis Data Analytics application. InputDescription: type: object properties: InputId: allOf: - $ref: '#/components/schemas/Id' - description: 'The input ID that is associated with the application input. This is the ID that Kinesis Data Analytics assigns to each input configuration that you add to your application. ' NamePrefix: allOf: - $ref: '#/components/schemas/InAppStreamName' - description: The in-application name prefix. InAppStreamNames: allOf: - $ref: '#/components/schemas/InAppStreamNames' - description: 'Returns the in-application stream names that are mapped to the stream source. ' InputProcessingConfigurationDescription: allOf: - $ref: '#/components/schemas/InputProcessingConfigurationDescription' - description: 'The description of the preprocessor that executes on records in this input before the application''s code is run. ' KinesisStreamsInputDescription: allOf: - $ref: '#/components/schemas/KinesisStreamsInputDescription' - description: 'If a Kinesis data stream is configured as a streaming source, provides the Kinesis data stream''s Amazon Resource Name (ARN). ' KinesisFirehoseInputDescription: allOf: - $ref: '#/components/schemas/KinesisFirehoseInputDescription' - description: 'If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream''s ARN. ' InputSchema: allOf: - $ref: '#/components/schemas/SourceSchema' - description: '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. ' InputParallelism: allOf: - $ref: '#/components/schemas/InputParallelism' - description: 'Describes the configured parallelism (number of in-application streams mapped to the streaming source). ' InputStartingPositionConfiguration: allOf: - $ref: '#/components/schemas/InputStartingPositionConfiguration' - description: The point at which the application is configured to read from the input stream. description: 'Describes the application input configuration for a SQL-based Kinesis Data Analytics application. ' KinesisFirehoseOutputDescription: type: object required: - ResourceARN properties: ResourceARN: allOf: - $ref: '#/components/schemas/ResourceARN' - description: The Amazon Resource Name (ARN) of the delivery stream. RoleARN: allOf: - $ref: '#/components/schemas/RoleARN' - description:

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.

 description: For a SQL-based Kinesis Data Analytics application's output, describes the Kinesis Data Firehose delivery stream that is configured as its destination. CustomArtifactConfigurationDescription: type: object properties: ArtifactType: allOf: - $ref: '#/components/schemas/ArtifactType' - description: ' UDF stands for user-defined functions. This type of artifact must be in an S3 bucket. A DEPENDENCY_JAR can be in either Maven or an S3 bucket.' S3ContentLocationDescription: $ref: '#/components/schemas/S3ContentLocation' MavenReferenceDescription: allOf: - $ref: '#/components/schemas/MavenReference' - description: The parameters that are required to specify a Maven dependency. description: Specifies a dependency JAR or a JAR of user-defined functions. KinesisFirehoseOutputUpdate: type: object required: - ResourceARNUpdate properties: ResourceARNUpdate: allOf: - $ref: '#/components/schemas/ResourceARN' - description: 'The Amazon Resource Name (ARN) of the delivery stream to write to. ' description: For a SQL-based Kinesis Data Analytics application, when updating an output configuration using the UpdateApplication operation, provides information about a Kinesis Data Firehose delivery stream that is configured as the destination. MavenArtifactId: type: string pattern: '[a-zA-Z0-9_.-]+' minLength: 1 maxLength: 256 CodeContentType: type: string enum: - PLAINTEXT - ZIPFILE Parallelism: type: integer minimum: 1 MonitoringConfigurationUpdate: type: object properties: ConfigurationTypeUpdate: allOf: - $ref: '#/components/schemas/ConfigurationType' - description: Describes updates to whether to use the default CloudWatch logging configuration for an application. You must set this property to CUSTOM in order to set the LogLevel or MetricsLevel parameters. MetricsLevelUpdate: allOf: - $ref: '#/components/schemas/MetricsLevel' - description: Describes updates to the granularity of the CloudWatch Logs for an application. The Parallelism level is not recommended for applications with a Parallelism over 64 due to excessive costs. LogLevelUpdate: allOf: - $ref: '#/components/schemas/LogLevel' - description: Describes updates to the verbosity of the CloudWatch Logs for an application. description: Describes updates to configuration parameters for Amazon CloudWatch logging for an application. RunConfigurationUpdate: type: object properties: FlinkRunConfiguration: allOf: - $ref: '#/components/schemas/FlinkRunConfiguration' - description: Describes the starting parameters for a Flink-based Kinesis Data Analytics application. ApplicationRestoreConfiguration: allOf: - $ref: '#/components/schemas/ApplicationRestoreConfiguration' - description: Describes updates to the restore behavior of a restarting application. description: Describes the updates to the starting parameters for a Kinesis Data Analytics application. SubnetId: type: string LambdaOutputUpdate: type: object required: - ResourceARNUpdate properties: ResourceARNUpdate: allOf: - $ref: '#/components/schemas/ResourceARN' - description: '

The Amazon Resource Name (ARN) of the destination Amazon Lambda function.

To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: Amazon Lambda

' description: When you update an SQL-based Kinesis Data Analytics application's output configuration using the UpdateApplication operation, provides information about an Amazon Lambda function that is configured as the destination. RecordColumns: type: array items: $ref: '#/components/schemas/RecordColumn' minItems: 1 maxItems: 1000 ApplicationConfigurationDescription: type: object properties: SqlApplicationConfigurationDescription: allOf: - $ref: '#/components/schemas/SqlApplicationConfigurationDescription' - description: The details about inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application. ApplicationCodeConfigurationDescription: allOf: - $ref: '#/components/schemas/ApplicationCodeConfigurationDescription' - description: The details about the application code for a Flink-based Kinesis Data Analytics application. RunConfigurationDescription: allOf: - $ref: '#/components/schemas/RunConfigurationDescription' - description: The details about the starting properties for a Kinesis Data Analytics application. FlinkApplicationConfigurationDescription: allOf: - $ref: '#/components/schemas/FlinkApplicationConfigurationDescription' - description: The details about a Flink-based Kinesis Data Analytics application. EnvironmentPropertyDescriptions: allOf: - $ref: '#/components/schemas/EnvironmentPropertyDescriptions' - description: Describes execution properties for a Flink-based Kinesis Data Analytics application. ApplicationSnapshotConfigurationDescription: allOf: - $ref: '#/components/schemas/ApplicationSnapshotConfigurationDescription' - description: Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application. VpcConfigurationDescriptions: allOf: - $ref: '#/components/schemas/VpcConfigurationDescriptions' - description: The array of descriptions of VPC configurations available to the application. ZeppelinApplicationConfigurationDescription: allOf: - $ref: '#/components/schemas/ZeppelinApplicationConfigurationDescription' - description: The configuration parameters for a Kinesis Data Analytics Studio notebook. description: Describes details about the application code and starting parameters for a Kinesis Data Analytics application. S3ApplicationCodeLocationDescription: type: object required: - BucketARN - FileKey properties: BucketARN: allOf: - $ref: '#/components/schemas/BucketARN' - description: The Amazon Resource Name (ARN) for the S3 bucket containing the application code. FileKey: allOf: - $ref: '#/components/schemas/FileKey' - description: The file key for the object containing the application code. ObjectVersion: allOf: - $ref: '#/components/schemas/ObjectVersion' - description: The version of the object containing the application code. description: Describes the location of an application's code stored in an S3 bucket. LimitExceededException: {} DestinationSchema: type: object required: - RecordFormatType properties: RecordFormatType: allOf: - $ref: '#/components/schemas/RecordFormatType' - description: Specifies the format of the records on the output stream. description: 'Describes the data format when records are written to the destination in a SQL-based Kinesis Data Analytics application. ' S3ContentLocationUpdate: type: object properties: BucketARNUpdate: allOf: - $ref: '#/components/schemas/BucketARN' - description: The new Amazon Resource Name (ARN) for the S3 bucket containing the application code. FileKeyUpdate: allOf: - $ref: '#/components/schemas/FileKey' - description: The new file key for the object containing the application code. ObjectVersionUpdate: allOf: - $ref: '#/components/schemas/ObjectVersion' - description: The new version of the object containing the application code. description: Describes an update for the Amazon S3 code content location for an application. MinPauseBetweenCheckpoints: type: integer minimum: 0 ParallelismConfigurationUpdate: type: object properties: ConfigurationTypeUpdate: allOf: - $ref: '#/components/schemas/ConfigurationType' - description: Describes updates to whether the application uses the default parallelism for the Kinesis Data Analytics service, or if a custom parallelism is used. You must set this property to CUSTOM in order to change your application's AutoScalingEnabled, Parallelism, or ParallelismPerKPU properties. ParallelismUpdate: allOf: - $ref: '#/components/schemas/Parallelism' - description: Describes updates to the initial number of parallel tasks an application can perform. If AutoScalingEnabled is set to True, then Kinesis Data Analytics can increase the CurrentParallelism value in response to application load. The service can increase CurrentParallelism up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service will reduce CurrentParallelism down to the Parallelism setting. ParallelismPerKPUUpdate: allOf: - $ref: '#/components/schemas/ParallelismPerKPU' - description: Describes updates to the number of parallel tasks an application can perform per Kinesis Processing Unit (KPU) used by the application. AutoScalingEnabledUpdate: allOf: - $ref: '#/components/schemas/BooleanObject' - description: Describes updates to whether the Kinesis Data Analytics service can increase the parallelism of a Flink-based Kinesis Data Analytics application in response to increased throughput. description: Describes updates to parameters for how an application executes multiple tasks simultaneously. EnvironmentPropertyDescriptions: type: object properties: PropertyGroupDescriptions: allOf: - $ref: '#/components/schemas/PropertyGroups' - description: Describes the execution property groups. description: Describes the execution properties for an Apache Flink runtime. InputDescriptions: type: array items: $ref: '#/components/schemas/InputDescription' DeployAsApplicationConfigurationUpdate: type: object properties: S3ContentLocationUpdate: allOf: - $ref: '#/components/schemas/S3ContentBaseLocationUpdate' - description: Updates to the location that holds the data required to specify an Amazon Data Analytics application. description: Updates to the configuration information required to deploy an Amazon Data Analytics Studio notebook as an application with durable state. ApplicationMaintenanceWindowStartTime: type: string pattern: ([01][0-9]|2[0-3]):[0-5][0-9] minLength: 5 maxLength: 5 CodeSize: type: integer minimum: 0 maximum: 52428800 CatalogConfigurationDescription: type: object required: - GlueDataCatalogConfigurationDescription properties: GlueDataCatalogConfigurationDescription: allOf: - $ref: '#/components/schemas/GlueDataCatalogConfigurationDescription' - description: The configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Kinesis Data Analytics Studio notebook. description: The configuration parameters for the default Amazon Glue database. You use this database for Apache Flink SQL queries and table API transforms that you write in a Kinesis Data Analytics Studio notebook. SnapshotName: type: string pattern: '[a-zA-Z0-9_.-]+' minLength: 1 maxLength: 256 S3ContentBaseLocationUpdate: type: object properties: BucketARNUpdate: allOf: - $ref: '#/components/schemas/BucketARN' - description: The updated Amazon Resource Name (ARN) of the S3 bucket. BasePathUpdate: allOf: - $ref: '#/components/schemas/BasePath' - description: The updated S3 bucket path. description: The information required to update the S3 base location that holds the application. RecordFormat: type: object required: - RecordFormatType properties: RecordFormatType: allOf: - $ref: '#/components/schemas/RecordFormatType' - description: The type of record format. MappingParameters: allOf: - $ref: '#/components/schemas/MappingParameters' - description: 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. description: ' For a SQL-based Kinesis Data Analytics application, describes the record format and relevant mapping information that should be applied to schematize the records on the stream. ' CustomArtifactsConfigurationDescriptionList: type: array items: $ref: '#/components/schemas/CustomArtifactConfigurationDescription' maxItems: 50 OutputDescription: type: object properties: OutputId: allOf: - $ref: '#/components/schemas/Id' - description: A unique identifier for the output configuration. Name: allOf: - $ref: '#/components/schemas/InAppStreamName' - description: The name of the in-application stream that is configured as output. KinesisStreamsOutputDescription: allOf: - $ref: '#/components/schemas/KinesisStreamsOutputDescription' - description: Describes the Kinesis data stream that is configured as the destination where output is written. KinesisFirehoseOutputDescription: allOf: - $ref: '#/components/schemas/KinesisFirehoseOutputDescription' - description: Describes the Kinesis Data Firehose delivery stream that is configured as the destination where output is written. LambdaOutputDescription: allOf: - $ref: '#/components/schemas/LambdaOutputDescription' - description: Describes the Lambda function that is configured as the destination where output is written. DestinationSchema: allOf: - $ref: '#/components/schemas/DestinationSchema' - description: The data format used for writing data to the destination. description: 'For a SQL-based Kinesis Data Analytics application, describes the application output configuration, which includes the in-application stream name and the destination where the stream data is written. The destination can be a Kinesis data stream or a Kinesis Data Firehose delivery stream. ' ApplicationName: type: string pattern: '[a-zA-Z0-9_.-]+' minLength: 1 maxLength: 128 CodeValidationException: {} CloudWatchLoggingOptionUpdate: type: object required: - CloudWatchLoggingOptionId properties: CloudWatchLoggingOptionId: allOf: - $ref: '#/components/schemas/Id' - description: The ID of the CloudWatch logging option to update LogStreamARNUpdate: allOf: - $ref: '#/components/schemas/LogStreamARN' - description: The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages. description: Describes the Amazon CloudWatch logging option updates. RecordColumnName: type: string pattern: '[^-\s<>&]*' minLength: 1 maxLength: 256 RecordColumnDelimiter: type: string minLength: 1 maxLength: 1024 FlinkApplicationConfigurationDescription: type: object properties: CheckpointConfigurationDescription: allOf: - $ref: '#/components/schemas/CheckpointConfigurationDescription' - description: Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. MonitoringConfigurationDescription: allOf: - $ref: '#/components/schemas/MonitoringConfigurationDescription' - description: Describes configuration parameters for Amazon CloudWatch logging for an application. ParallelismConfigurationDescription: allOf: - $ref: '#/components/schemas/ParallelismConfigurationDescription' - description: Describes parameters for how an application executes multiple tasks simultaneously. JobPlanDescription: allOf: - $ref: '#/components/schemas/JobPlanDescription' - description: The job plan for an application. For more information about the job plan, see Jobs and Scheduling in the Apache Flink Documentation. To retrieve the job plan for the application, use the DescribeApplicationRequest$IncludeAdditionalDetails parameter of the DescribeApplication operation. description: Describes configuration parameters for a Flink-based Kinesis Data Analytics application. ApplicationDescription: type: string minLength: 0 maxLength: 1024 KinesisStreamsInputDescription: type: object required: - ResourceARN properties: ResourceARN: allOf: - $ref: '#/components/schemas/ResourceARN' - description: The Amazon Resource Name (ARN) of the Kinesis data stream. RoleARN: allOf: - $ref: '#/components/schemas/RoleARN' - description:

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.

 description: 'For a SQL-based Kinesis Data Analytics application, describes the Kinesis data stream that is configured as the streaming source in the application input configuration. ' InAppStreamName: type: string pattern: '[^-\s<>&]*' minLength: 1 maxLength: 32 UpdateApplicationResponse: type: object required: - ApplicationDetail properties: ApplicationDetail: allOf: - $ref: '#/components/schemas/ApplicationDetail' - description: Describes application updates. ZeppelinMonitoringConfigurationUpdate: type: object required: - LogLevelUpdate properties: LogLevelUpdate: allOf: - $ref: '#/components/schemas/LogLevel' - description: Updates to the logging level for Apache Zeppelin within a Kinesis Data Analytics Studio notebook. description: Updates to the monitoring configuration for Apache Zeppelin within a Kinesis Data Analytics Studio notebook. KinesisStreamsOutputDescription: type: object required: - ResourceARN properties: ResourceARN: allOf: - $ref: '#/components/schemas/ResourceARN' - description: The Amazon Resource Name (ARN) of the Kinesis data stream. RoleARN: allOf: - $ref: '#/components/schemas/RoleARN' - description:

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.

 description: 'For an SQL-based Kinesis Data Analytics application''s output, describes the Kinesis data stream that is configured as its destination. ' LambdaOutputDescription: type: object required: - ResourceARN properties: ResourceARN: allOf: - $ref: '#/components/schemas/ResourceARN' - description: The Amazon Resource Name (ARN) of the destination Lambda function. RoleARN: allOf: - $ref: '#/components/schemas/RoleARN' - description:

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.

 description: 'For a SQL-based Kinesis Data Analytics application''s output, describes the Amazon Lambda function that is configured as its destination. ' InputStartingPositionConfiguration: type: object properties: InputStartingPosition: allOf: - $ref: '#/components/schemas/InputStartingPosition' - description:

The starting position on the stream.

description: Describes the point at which the application reads from the streaming source. GlueDataCatalogConfigurationUpdate: type: object required: - DatabaseARNUpdate properties: DatabaseARNUpdate: allOf: - $ref: '#/components/schemas/DatabaseARN' - description: The updated Amazon Resource Name (ARN) of the database. description: Updates to the configuration of the Glue Data Catalog that you use for SQL queries that you write in a Kinesis Data Analytics Studio notebook. ApplicationSnapshotConfigurationDescription: type: object required: - SnapshotsEnabled properties: SnapshotsEnabled: allOf: - $ref: '#/components/schemas/BooleanObject' - description: Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application. description: Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application. MavenVersion: type: string pattern: '[a-zA-Z0-9_.-]+' minLength: 1 maxLength: 256 InvalidApplicationConfigurationException: {} JobPlanDescription: type: string ZipFileContent: type: string minLength: 0 maxLength: 52428800 CloudWatchLoggingOptionDescription: type: object required: - LogStreamARN properties: CloudWatchLoggingOptionId: allOf: - $ref: '#/components/schemas/Id' - description: The ID of the CloudWatch logging option description. LogStreamARN: allOf: - $ref: '#/components/schemas/LogStreamARN' - description: The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages. RoleARN: allOf: - $ref: '#/components/schemas/RoleARN' - description:

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.

 description: Describes the Amazon CloudWatch logging option. InputUpdates: type: array items: $ref: '#/components/schemas/InputUpdate' KinesisFirehoseInputDescription: type: object required: - ResourceARN properties: ResourceARN: allOf: - $ref: '#/components/schemas/ResourceARN' - description: The Amazon Resource Name (ARN) of the delivery stream. RoleARN: allOf: - $ref: '#/components/schemas/RoleARN' - description:

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.

 description: 'Describes the Amazon Kinesis Data Firehose delivery stream that is configured as the streaming source in the application input configuration. ' InputUpdate: type: object required: - InputId properties: InputId: allOf: - $ref: '#/components/schemas/Id' - description: The input ID of the application input to be updated. NamePrefixUpdate: allOf: - $ref: '#/components/schemas/InAppStreamName' - description: The name prefix for in-application streams that Kinesis Data Analytics creates for the specific streaming source. InputProcessingConfigurationUpdate: allOf: - $ref: '#/components/schemas/InputProcessingConfigurationUpdate' - description: Describes updates to an InputProcessingConfiguration. KinesisStreamsInputUpdate: allOf: - $ref: '#/components/schemas/KinesisStreamsInputUpdate' - description: If a Kinesis data stream is the streaming source to be updated, provides an updated stream Amazon Resource Name (ARN). KinesisFirehoseInputUpdate: allOf: - $ref: '#/components/schemas/KinesisFirehoseInputUpdate' - description: If a Kinesis Data Firehose delivery stream is the streaming source to be updated, provides an updated stream ARN. InputSchemaUpdate: allOf: - $ref: '#/components/schemas/InputSchemaUpdate' - description: 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. InputParallelismUpdate: allOf: - $ref: '#/components/schemas/InputParallelismUpdate' - description: Describes the parallelism updates (the number of in-application streams Kinesis Data Analytics creates for the specific streaming source). description: 'For a SQL-based Kinesis Data Analytics application, describes updates to a specific input configuration (identified by the InputId of an application). ' VpcId: type: string OutputUpdates: type: array items: $ref: '#/components/schemas/OutputUpdate' RoleARN: type: string pattern: arn:.* minLength: 1 maxLength: 2048 BasePath: type: string pattern: '[a-zA-Z0-9/!-_.*''()]+' minLength: 1 maxLength: 1024 CSVMappingParameters: type: object required: - RecordRowDelimiter - RecordColumnDelimiter properties: RecordRowDelimiter: allOf: - $ref: '#/components/schemas/RecordRowDelimiter' - description: The row delimiter. For example, in a CSV format, '\n' is the typical row delimiter. RecordColumnDelimiter: allOf: - $ref: '#/components/schemas/RecordColumnDelimiter' - description: The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter. description: '

For a SQL-based Kinesis Data Analytics application, provides additional mapping information when the record format uses delimiters, such as CSV. For example, the following sample records use CSV format, where the records use the ''\n'' as the row delimiter and a comma (",") as the column delimiter:

"name1", "address1"

"name2", "address2"

' ConcurrentModificationException: {} UpdateApplicationRequest: type: object required: - ApplicationName title: UpdateApplicationRequest properties: ApplicationName: allOf: - $ref: '#/components/schemas/ApplicationName' - description: The name of the application to update. CurrentApplicationVersionId: allOf: - $ref: '#/components/schemas/ApplicationVersionId' - description: The current application version ID. You must provide the CurrentApplicationVersionId or the ConditionalToken.You can retrieve the application version ID using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId. ApplicationConfigurationUpdate: allOf: - $ref: '#/components/schemas/ApplicationConfigurationUpdate' - description: Describes application configuration updates. ServiceExecutionRoleUpdate: allOf: - $ref: '#/components/schemas/RoleARN' - description: Describes updates to the service execution role. RunConfigurationUpdate: allOf: - $ref: '#/components/schemas/RunConfigurationUpdate' - description: Describes updates to the application's starting parameters. CloudWatchLoggingOptionUpdates: allOf: - $ref: '#/components/schemas/CloudWatchLoggingOptionUpdates' - description: 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. ConditionalToken: allOf: - $ref: '#/components/schemas/ConditionalToken' - description: A value you use to implement strong concurrency for application updates. You must provide the CurrentApplicationVersionId or the ConditionalToken. You get the application's current ConditionalToken using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId. ApplicationMode: type: string enum: - STREAMING - INTERACTIVE PropertyValue: type: string minLength: 1 maxLength: 2048 ResourceARN: type: string pattern: arn:.* minLength: 1 maxLength: 2048 ParallelismConfigurationDescription: type: object properties: ConfigurationType: allOf: - $ref: '#/components/schemas/ConfigurationType' - description: 'Describes whether the application uses the default parallelism for the Kinesis Data Analytics service. ' Parallelism: allOf: - $ref: '#/components/schemas/Parallelism' - description: Describes the initial number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, then Kinesis Data Analytics can increase the CurrentParallelism value in response to application load. The service can increase CurrentParallelism up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting. ParallelismPerKPU: allOf: - $ref: '#/components/schemas/ParallelismPerKPU' - description: Describes the number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application. CurrentParallelism: allOf: - $ref: '#/components/schemas/Parallelism' - description: Describes the current number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, Kinesis Data Analytics can increase this value in response to application load. The service can increase this value up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting. AutoScalingEnabled: allOf: - $ref: '#/components/schemas/BooleanObject' - description: Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput. description: Describes parameters for how a Flink-based Kinesis Data Analytics application executes multiple tasks simultaneously. DatabaseARN: type: string pattern: arn:.* minLength: 1 maxLength: 2048 KinesisStreamsInputUpdate: type: object required: - ResourceARNUpdate properties: ResourceARNUpdate: allOf: - $ref: '#/components/schemas/ResourceARN' - description: The Amazon Resource Name (ARN) of the input Kinesis data stream to read. description: When you update the input configuration for a SQL-based Kinesis Data Analytics application, provides information about a Kinesis stream as the streaming source. KinesisFirehoseInputUpdate: type: object required: - ResourceARNUpdate properties: ResourceARNUpdate: allOf: - $ref: '#/components/schemas/ResourceARN' - description: The Amazon Resource Name (ARN) of the input delivery stream to read. description: For a SQL-based Kinesis Data Analytics application, when updating application input configuration, provides information about a Kinesis Data Firehose delivery stream as the streaming source. DeployAsApplicationConfigurationDescription: type: object required: - S3ContentLocationDescription properties: S3ContentLocationDescription: allOf: - $ref: '#/components/schemas/S3ContentBaseLocationDescription' - description: The location that holds the data required to specify an Amazon Data Analytics application. description: The configuration information required to deploy an Amazon Data Analytics Studio notebook as an application with durable state. MavenGroupId: type: string pattern: '[a-zA-Z0-9_.-]+' minLength: 1 maxLength: 256 ConfigurationType: type: string enum: - DEFAULT - CUSTOM CustomArtifactsConfigurationList: type: array items: $ref: '#/components/schemas/CustomArtifactConfiguration' maxItems: 50 InputSchemaUpdate: type: object properties: RecordFormatUpdate: allOf: - $ref: '#/components/schemas/RecordFormat' - description: Specifies the format of the records on the streaming source. RecordEncodingUpdate: allOf: - $ref: '#/components/schemas/RecordEncoding' - description: Specifies the encoding of the records in the streaming source; for example, UTF-8. RecordColumnUpdates: allOf: - $ref: '#/components/schemas/RecordColumns' - description: A list of RecordColumn objects. Each object describes the mapping of the streaming source element to the corresponding column in the in-application stream. description: Describes updates for an SQL-based Kinesis Data Analytics application's input schema. CodeContentUpdate: type: object properties: TextContentUpdate: allOf: - $ref: '#/components/schemas/TextContent' - description: Describes an update to the text code for an application. ZipFileContentUpdate: allOf: - $ref: '#/components/schemas/ZipFileContent' - description: Describes an update to the zipped code for an application. S3ContentLocationUpdate: allOf: - $ref: '#/components/schemas/S3ContentLocationUpdate' - description: Describes an update to the location of code for an application. description: Describes an update to the code of an application. Not supported for Apache Zeppelin. KinesisStreamsOutputUpdate: type: object required: - ResourceARNUpdate properties: ResourceARNUpdate: allOf: - $ref: '#/components/schemas/ResourceARN' - description: The Amazon Resource Name (ARN) of the Kinesis data stream where you want to write the output. description: When you update a SQL-based Kinesis Data Analytics application's output configuration using the UpdateApplication operation, provides information about a Kinesis data stream that is configured as the destination. ReferenceDataSourceUpdate: type: object required: - ReferenceId properties: ReferenceId: allOf: - $ref: '#/components/schemas/Id' - description: The ID of the reference data source that is being updated. You can use the DescribeApplication operation to get this value. TableNameUpdate: allOf: - $ref: '#/components/schemas/InAppTableName' - description: The in-application table name that is created by this update. S3ReferenceDataSourceUpdate: allOf: - $ref: '#/components/schemas/S3ReferenceDataSourceUpdate' - description: 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. ReferenceSchemaUpdate: allOf: - $ref: '#/components/schemas/SourceSchema' - description: '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. ' description: When you update a reference data source configuration for a SQL-based Kinesis Data Analytics application, this object provides all the updated values (such as the source bucket name and object key name), the in-application table name that is created, and updated mapping information that maps the data in the Amazon S3 object to the in-application reference table that is created. MonitoringConfigurationDescription: type: object properties: ConfigurationType: allOf: - $ref: '#/components/schemas/ConfigurationType' - description: Describes whether to use the default CloudWatch logging configuration for an application. MetricsLevel: allOf: - $ref: '#/components/schemas/MetricsLevel' - description: Describes the granularity of the CloudWatch Logs for an application. LogLevel: allOf: - $ref: '#/components/schemas/LogLevel' - description: Describes the verbosity of the CloudWatch Logs for an application. description: Describes configuration parameters for CloudWatch logging for an application. RecordColumn: type: object required: - Name - SqlType properties: Name: allOf: - $ref: '#/components/schemas/RecordColumnName' - description: The name of the column that is created in the in-application input stream or reference table. Mapping: allOf: - $ref: '#/components/schemas/RecordColumnMapping' - description: A reference to the data element in the streaming input or the reference data source. SqlType: allOf: - $ref: '#/components/schemas/RecordColumnSqlType' - description: The type of column created in the in-application input stream or reference table. description:

For a SQL-based Kinesis Data Analytics application, describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream.

Also used to describe the format of the reference data source.

Timestamp: type: string format: date-time CloudWatchLoggingOptionUpdates: type: array items: $ref: '#/components/schemas/CloudWatchLoggingOptionUpdate' SecurityGroupId: type: string ReferenceDataSourceDescription: type: object required: - ReferenceId - TableName - S3ReferenceDataSourceDescription properties: ReferenceId: allOf: - $ref: '#/components/schemas/Id' - description: The ID of the reference data source. This is the ID that Kinesis Data Analytics assigns when you add the reference data source to your application using the CreateApplication or UpdateApplication operation. TableName: allOf: - $ref: '#/components/schemas/InAppTableName' - description: The in-application table name created by the specific reference data source configuration. S3ReferenceDataSourceDescription: allOf: - $ref: '#/components/schemas/S3ReferenceDataSourceDescription' - description: 'Provides the Amazon S3 bucket name, the object key name that contains the reference data. ' ReferenceSchema: allOf: - $ref: '#/components/schemas/SourceSchema' - description: 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. description: For a SQL-based Kinesis Data Analytics application, describes the reference data source configured for an application. FileKey: type: string minLength: 1 maxLength: 1024 InvalidRequestException: {} ZeppelinMonitoringConfigurationDescription: type: object properties: LogLevel: allOf: - $ref: '#/components/schemas/LogLevel' - description: Describes the verbosity of the CloudWatch Logs for an application. description: The monitoring configuration for Apache Zeppelin within a Kinesis Data Analytics Studio notebook. SubnetIds: type: array items: $ref: '#/components/schemas/SubnetId' minItems: 1 maxItems: 16 Id: type: string pattern: '[a-zA-Z0-9_.-]+' minLength: 1 maxLength: 50 FlinkRunConfiguration: type: object properties: AllowNonRestoredState: allOf: - $ref: '#/components/schemas/BooleanObject' - description:

When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program. This will happen if the program is updated between snapshots to remove stateful parameters, and state data in the snapshot no longer corresponds to valid application data. For more information, see Allowing Non-Restored State in the Apache Flink documentation.

This value defaults to false. If you update your application without specifying this parameter, AllowNonRestoredState will be set to false, even if it was previously set to true.

 description: Describes the starting parameters for a Flink-based Kinesis Data Analytics application. ParallelismPerKPU: type: integer minimum: 1 InAppStreamNames: type: array items: $ref: '#/components/schemas/InAppStreamName' ApplicationDetail: type: object required: - ApplicationARN - ApplicationName - RuntimeEnvironment - ApplicationStatus - ApplicationVersionId properties: ApplicationARN: allOf: - $ref: '#/components/schemas/ResourceARN' - description: The ARN of the application. ApplicationDescription: allOf: - $ref: '#/components/schemas/ApplicationDescription' - description: The description of the application. ApplicationName: allOf: - $ref: '#/components/schemas/ApplicationName' - description: The name of the application. RuntimeEnvironment: allOf: - $ref: '#/components/schemas/RuntimeEnvironment' - description: The runtime environment for the application. ServiceExecutionRole: allOf: - $ref: '#/components/schemas/RoleARN' - description: Specifies the IAM role that the application uses to access external resources. ApplicationStatus: allOf: - $ref: '#/components/schemas/ApplicationStatus' - description: The status of the application. ApplicationVersionId: allOf: - $ref: '#/components/schemas/ApplicationVersionId' - description: Provides the current application version. Kinesis Data Analytics updates the ApplicationVersionId each time you update the application. CreateTimestamp: allOf: - $ref: '#/components/schemas/Timestamp' - description: The current timestamp when the application was created. LastUpdateTimestamp: allOf: - $ref: '#/components/schemas/Timestamp' - description: The current timestamp when the application was last updated. ApplicationConfigurationDescription: allOf: - $ref: '#/components/schemas/ApplicationConfigurationDescription' - description: Describes details about the application code and starting parameters for a Kinesis Data Analytics application. CloudWatchLoggingOptionDescriptions: allOf: - $ref: '#/components/schemas/CloudWatchLoggingOptionDescriptions' - description: Describes the application Amazon CloudWatch logging options. ApplicationMaintenanceConfigurationDescription: allOf: - $ref: '#/components/schemas/ApplicationMaintenanceConfigurationDescription' - description: The details of the maintenance configuration for the application. ApplicationVersionUpdatedFrom: allOf: - $ref: '#/components/schemas/ApplicationVersionId' - description: The previous application version before the latest application update. RollbackApplication reverts the application to this version. ApplicationVersionRolledBackFrom: allOf: - $ref: '#/components/schemas/ApplicationVersionId' - description: If you reverted the application using RollbackApplication, the application version when RollbackApplication was called. ConditionalToken: allOf: - $ref: '#/components/schemas/ConditionalToken' - description: A value you use to implement strong concurrency for application updates. ApplicationVersionRolledBackTo: allOf: - $ref: '#/components/schemas/ApplicationVersionId' - description: The version to which you want to roll back the application. ApplicationMode: allOf: - $ref: '#/components/schemas/ApplicationMode' - description: To create a Kinesis Data Analytics Studio notebook, you must set the mode to INTERACTIVE. However, for a Kinesis Data Analytics for Apache Flink application, the mode is optional. description: Describes the application, including the application Amazon Resource Name (ARN), status, latest version, and input and output configurations. MetricsLevel: type: string enum: - APPLICATION - TASK - OPERATOR - PARALLELISM ApplicationSnapshotConfigurationUpdate: type: object required: - SnapshotsEnabledUpdate properties: SnapshotsEnabledUpdate: allOf: - $ref: '#/components/schemas/BooleanObject' - description: Describes updates to whether snapshots are enabled for an application. description: Describes updates to whether snapshots are enabled for a Flink-based Kinesis Data Analytics application. ApplicationConfigurationUpdate: type: object properties: SqlApplicationConfigurationUpdate: allOf: - $ref: '#/components/schemas/SqlApplicationConfigurationUpdate' - description: Describes updates to a SQL-based Kinesis Data Analytics application's configuration. ApplicationCodeConfigurationUpdate: allOf: - $ref: '#/components/schemas/ApplicationCodeConfigurationUpdate' - description: Describes updates to an application's code configuration. FlinkApplicationConfigurationUpdate: allOf: - $ref: '#/components/schemas/FlinkApplicationConfigurationUpdate' - description: Describes updates to a Flink-based Kinesis Data Analytics application's configuration. EnvironmentPropertyUpdates: allOf: - $ref: '#/components/schemas/EnvironmentPropertyUpdates' - description: Describes updates to the environment properties for a Flink-based Kinesis Data Analytics application. ApplicationSnapshotConfigurationUpdate: allOf: - $ref: '#/components/schemas/ApplicationSnapshotConfigurationUpdate' - description: Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application. VpcConfigurationUpdates: allOf: - $ref: '#/components/schemas/VpcConfigurationUpdates' - description: Updates to the array of descriptions of VPC configurations available to the application. ZeppelinApplicationConfigurationUpdate: allOf: - $ref: '#/components/schemas/ZeppelinApplicationConfigurationUpdate' - description: Updates to the configuration of a Kinesis Data Analytics Studio notebook. description: Describes updates to an application's configuration. LogStreamARN: type: string pattern: arn:.* minLength: 1 maxLength: 2048 ApplicationRestoreType: type: string enum: - SKIP_RESTORE_FROM_SNAPSHOT - RESTORE_FROM_LATEST_SNAPSHOT - RESTORE_FROM_CUSTOM_SNAPSHOT S3ReferenceDataSourceUpdate: type: object properties: BucketARNUpdate: allOf: - $ref: '#/components/schemas/BucketARN' - description: The Amazon Resource Name (ARN) of the S3 bucket. FileKeyUpdate: allOf: - $ref: '#/components/schemas/FileKey' - description: The object key name. description: 'For a SQL-based Kinesis Data Analytics application, describes the Amazon S3 bucket name and object key name for an in-application reference table. ' CheckpointConfigurationUpdate: type: object properties: ConfigurationTypeUpdate: allOf: - $ref: '#/components/schemas/ConfigurationType' - description:

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:

 CheckpointingEnabledUpdate: allOf: - $ref: '#/components/schemas/BooleanObject' - description:

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.

 CheckpointIntervalUpdate: allOf: - $ref: '#/components/schemas/CheckpointInterval' - description:

Describes updates to the interval in milliseconds between checkpoint operations.

If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointInterval value of 60000, even if this value is set to another value using this API or in application code.

 MinPauseBetweenCheckpointsUpdate: allOf: - $ref: '#/components/schemas/MinPauseBetweenCheckpoints' - description:

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.

 description: Describes updates to the checkpointing parameters for a Flink-based Kinesis Data Analytics application. RecordColumnMapping: type: string minLength: 0 maxLength: 65535 ApplicationMaintenanceConfigurationDescription: type: object required: - ApplicationMaintenanceWindowStartTime - ApplicationMaintenanceWindowEndTime properties: ApplicationMaintenanceWindowStartTime: allOf: - $ref: '#/components/schemas/ApplicationMaintenanceWindowStartTime' - description: The start time for the maintenance window. ApplicationMaintenanceWindowEndTime: allOf: - $ref: '#/components/schemas/ApplicationMaintenanceWindowEndTime' - description: The end time for the maintenance window. description: The details of the maintenance configuration for the application. JSONMappingParameters: type: object required: - RecordRowPath properties: RecordRowPath: allOf: - $ref: '#/components/schemas/RecordRowPath' - description: The path to the top-level parent that contains the records. description: For a SQL-based Kinesis Data Analytics application, provides additional mapping information when JSON is the record format on the streaming source. MavenReference: type: object required: - GroupId - ArtifactId - Version properties: GroupId: allOf: - $ref: '#/components/schemas/MavenGroupId' - description: The group ID of the Maven reference. ArtifactId: allOf: - $ref: '#/components/schemas/MavenArtifactId' - description: The artifact ID of the Maven reference. Version: allOf: - $ref: '#/components/schemas/MavenVersion' - description: The version of the Maven reference. description: The information required to specify a Maven reference. You can use Maven references to specify dependency JAR files. PropertyGroups: type: array items: $ref: '#/components/schemas/PropertyGroup' maxItems: 50 S3ContentLocation: type: object required: - BucketARN - FileKey properties: BucketARN: allOf: - $ref: '#/components/schemas/BucketARN' - description: The Amazon Resource Name (ARN) for the S3 bucket containing the application code. FileKey: allOf: - $ref: '#/components/schemas/FileKey' - description: The file key for the object containing the application code. ObjectVersion: allOf: - $ref: '#/components/schemas/ObjectVersion' - description: The version of the object containing the application code. description: 'For a 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. ' RecordRowDelimiter: type: string minLength: 1 maxLength: 1024 ApplicationVersionId: type: integer minimum: 1 maximum: 999999999 VpcConfigurationUpdate: type: object required: - VpcConfigurationId properties: VpcConfigurationId: allOf: - $ref: '#/components/schemas/Id' - description: Describes an update to the ID of the VPC configuration. SubnetIdUpdates: allOf: - $ref: '#/components/schemas/SubnetIds' - description: Describes updates to the array of Subnet IDs used by the VPC configuration. SecurityGroupIdUpdates: allOf: - $ref: '#/components/schemas/SecurityGroupIds' - description: Describes updates to the array of SecurityGroup IDs used by the VPC configuration. description: Describes updates to the VPC configuration used by the application. GlueDataCatalogConfigurationDescription: type: object required: - DatabaseARN properties: DatabaseARN: allOf: - $ref: '#/components/schemas/DatabaseARN' - description: The Amazon Resource Name (ARN) of the database. description: The configuration of the Glue Data Catalog that you use for Apache Flink SQL queries and table API transforms that you write in an application. ApplicationCodeConfigurationDescription: type: object required: - CodeContentType properties: CodeContentType: allOf: - $ref: '#/components/schemas/CodeContentType' - description: Specifies whether the code content is in text or zip format. CodeContentDescription: allOf: - $ref: '#/components/schemas/CodeContentDescription' - description: Describes details about the location and format of the application code. description: Describes code configuration for an application. RuntimeEnvironment: type: string enum: - SQL-1_0 - FLINK-1_6 - FLINK-1_8 - ZEPPELIN-FLINK-1_0 - FLINK-1_11 - FLINK-1_13 - ZEPPELIN-FLINK-2_0 - FLINK-1_15 - ZEPPELIN-FLINK-3_0 ResourceNotFoundException: {} EnvironmentPropertyUpdates: type: object required: - PropertyGroups properties: PropertyGroups: allOf: - $ref: '#/components/schemas/PropertyGroups' - description: Describes updates to the execution property groups. description: Describes updates to the execution property groups for a Flink-based Kinesis Data Analytics application or a Studio notebook. SourceSchema: type: object required: - RecordFormat - RecordColumns properties: RecordFormat: allOf: - $ref: '#/components/schemas/RecordFormat' - description: Specifies the format of the records on the streaming source. RecordEncoding: allOf: - $ref: '#/components/schemas/RecordEncoding' - description: Specifies the encoding of the records in the streaming source. For example, UTF-8. RecordColumns: allOf: - $ref: '#/components/schemas/RecordColumns' - description: 'A list of RecordColumn objects. ' description: 'For a SQL-based Kinesis Data Analytics application, describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream. ' CodeMD5: type: string minLength: 128 maxLength: 128 ApplicationRestoreConfiguration: type: object required: - ApplicationRestoreType properties: ApplicationRestoreType: allOf: - $ref: '#/components/schemas/ApplicationRestoreType' - description: Specifies how the application should be restored. SnapshotName: allOf: - $ref: '#/components/schemas/SnapshotName' - description: 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. description: Specifies the method and snapshot to use when restarting an application using previously saved application state. ReferenceDataSourceUpdates: type: array items: $ref: '#/components/schemas/ReferenceDataSourceUpdate' TextContent: type: string minLength: 0 maxLength: 102400 BooleanObject: type: boolean InputParallelismCount: type: integer minimum: 1 maximum: 64 InAppTableName: type: string minLength: 1 maxLength: 32 ZeppelinApplicationConfigurationUpdate: type: object properties: MonitoringConfigurationUpdate: allOf: - $ref: '#/components/schemas/ZeppelinMonitoringConfigurationUpdate' - description: Updates to the monitoring configuration of a Kinesis Data Analytics Studio notebook. CatalogConfigurationUpdate: allOf: - $ref: '#/components/schemas/CatalogConfigurationUpdate' - description: Updates to the configuration of the Amazon Glue Data Catalog that is associated with the Kinesis Data Analytics Studio notebook. DeployAsApplicationConfigurationUpdate: $ref: '#/components/schemas/DeployAsApplicationConfigurationUpdate' CustomArtifactsConfigurationUpdate: allOf: - $ref: '#/components/schemas/CustomArtifactsConfigurationList' - description: Updates to the customer artifacts. Custom artifacts are dependency JAR files and user-defined functions (UDF). description: Updates to the configuration of Kinesis Data Analytics Studio notebook. SqlApplicationConfigurationUpdate: type: object properties: InputUpdates: allOf: - $ref: '#/components/schemas/InputUpdates' - description: The array of InputUpdate objects describing the new input streams used by the application. OutputUpdates: allOf: - $ref: '#/components/schemas/OutputUpdates' - description: The array of OutputUpdate objects describing the new destination streams used by the application. ReferenceDataSourceUpdates: allOf: - $ref: '#/components/schemas/ReferenceDataSourceUpdates' - description: The array of ReferenceDataSourceUpdate objects describing the new reference data sources used by the application. description: Describes updates to the input streams, destination streams, and reference data sources for a SQL-based Kinesis Data Analytics application. CatalogConfigurationUpdate: type: object required: - GlueDataCatalogConfigurationUpdate properties: GlueDataCatalogConfigurationUpdate: allOf: - $ref: '#/components/schemas/GlueDataCatalogConfigurationUpdate' - description: Updates to the configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Kinesis Data Analytics Studio notebook. description: Updates to the configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Kinesis Data Analytics Studio notebook. VpcConfigurationDescription: type: object required: - VpcConfigurationId - VpcId - SubnetIds - SecurityGroupIds properties: VpcConfigurationId: allOf: - $ref: '#/components/schemas/Id' - description: The ID of the VPC configuration. VpcId: allOf: - $ref: '#/components/schemas/VpcId' - description: The ID of the associated VPC. SubnetIds: allOf: - $ref: '#/components/schemas/SubnetIds' - description: The array of Subnet IDs used by the VPC configuration. SecurityGroupIds: allOf: - $ref: '#/components/schemas/SecurityGroupIds' - description: The array of SecurityGroup IDs used by the VPC configuration. description: Describes the parameters of a VPC used by the application. LogLevel: type: string enum: - INFO - WARN - ERROR - DEBUG CheckpointConfigurationDescription: type: object properties: ConfigurationType: allOf: - $ref: '#/components/schemas/ConfigurationType' - description:

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: allOf: - $ref: '#/components/schemas/BooleanObject' - description:

Describes whether checkpointing is enabled for a Flink-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.

 CheckpointInterval: allOf: - $ref: '#/components/schemas/CheckpointInterval' - description:

Describes the interval in milliseconds between checkpoint operations.

If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointInterval value of 60000, even if this value is set to another value using this API or in application code.

 MinPauseBetweenCheckpoints: allOf: - $ref: '#/components/schemas/MinPauseBetweenCheckpoints' - description:

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.

 description: Describes checkpointing parameters for a Flink-based Kinesis Data Analytics application. RecordFormatType: type: string enum: - JSON - CSV ConditionalToken: type: string pattern: '[a-zA-Z0-9-_+/=]+' minLength: 1 maxLength: 512 RecordColumnSqlType: type: string minLength: 1 maxLength: 100 ArtifactType: type: string enum: - UDF - DEPENDENCY_JAR BucketARN: type: string pattern: arn:.* minLength: 1 maxLength: 2048 InputParallelism: type: object properties: Count: allOf: - $ref: '#/components/schemas/InputParallelismCount' - description: The number of in-application streams to create. description: 'For a SQL-based Kinesis Data Analytics application, describes the number of in-application streams to create for a given streaming source. ' CloudWatchLoggingOptionDescriptions: type: array items: $ref: '#/components/schemas/CloudWatchLoggingOptionDescription' OutputUpdate: type: object required: - OutputId properties: OutputId: allOf: - $ref: '#/components/schemas/Id' - description: Identifies the specific output configuration that you want to update. NameUpdate: allOf: - $ref: '#/components/schemas/InAppStreamName' - description: If you want to specify a different in-application stream for this output configuration, use this field to specify the new in-application stream name. KinesisStreamsOutputUpdate: allOf: - $ref: '#/components/schemas/KinesisStreamsOutputUpdate' - description: Describes a Kinesis data stream as the destination for the output. KinesisFirehoseOutputUpdate: allOf: - $ref: '#/components/schemas/KinesisFirehoseOutputUpdate' - description: Describes a Kinesis Data Firehose delivery stream as the destination for the output. LambdaOutputUpdate: allOf: - $ref: '#/components/schemas/LambdaOutputUpdate' - description: Describes an Amazon Lambda function as the destination for the output. DestinationSchemaUpdate: allOf: - $ref: '#/components/schemas/DestinationSchema' - description: 'Describes the data format when records are written to the destination. ' description: ' For a SQL-based Kinesis Data Analytics application, describes updates to the output configuration identified by the OutputId. ' CustomArtifactConfiguration: type: object required: - ArtifactType properties: ArtifactType: allOf: - $ref: '#/components/schemas/ArtifactType' - description: ' UDF stands for user-defined functions. This type of artifact must be in an S3 bucket. A DEPENDENCY_JAR can be in either Maven or an S3 bucket.' S3ContentLocation: $ref: '#/components/schemas/S3ContentLocation' MavenReference: allOf: - $ref: '#/components/schemas/MavenReference' - description: The parameters required to fully specify a Maven reference. description: Specifies dependency JARs, as well as JAR files that contain user-defined functions (UDF). OutputDescriptions: type: array items: $ref: '#/components/schemas/OutputDescription' RecordRowPath: type: string pattern: ^(?=^\$)(?=^\S+$).*$ minLength: 1 maxLength: 65535 MappingParameters: type: object properties: JSONMappingParameters: allOf: - $ref: '#/components/schemas/JSONMappingParameters' - description: Provides additional mapping information when JSON is the record format on the streaming source. CSVMappingParameters: allOf: - $ref: '#/components/schemas/CSVMappingParameters' - description: Provides additional mapping information when the record format uses delimiters (for example, CSV). description: When you configure a SQL-based Kinesis Data Analytics application's input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source. CheckpointInterval: type: integer minimum: 1 VpcConfigurationDescriptions: type: array items: $ref: '#/components/schemas/VpcConfigurationDescription' ApplicationMaintenanceWindowEndTime: type: string pattern: ([01][0-9]|2[0-3]):[0-5][0-9] minLength: 5 maxLength: 5 ApplicationStatus: type: string enum: - DELETING - STARTING - STOPPING - READY - RUNNING - UPDATING - AUTOSCALING - FORCE_STOPPING - ROLLING_BACK - MAINTENANCE - ROLLED_BACK InputLambdaProcessorUpdate: type: object required: - ResourceARNUpdate properties: ResourceARNUpdate: allOf: - $ref: '#/components/schemas/ResourceARN' - description: '

The Amazon Resource Name (ARN) of the new Amazon Lambda function that is used to preprocess the records in the stream.

To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: Amazon Lambda

' description: For a SQL-based Kinesis Data Analytics application, represents an update to the InputLambdaProcessor that is used to preprocess the records in the stream. RecordEncoding: type: string pattern: UTF-8 minLength: 5 maxLength: 5 ZeppelinApplicationConfigurationDescription: type: object required: - MonitoringConfigurationDescription properties: MonitoringConfigurationDescription: allOf: - $ref: '#/components/schemas/ZeppelinMonitoringConfigurationDescription' - description: The monitoring configuration of a Kinesis Data Analytics Studio notebook. CatalogConfigurationDescription: allOf: - $ref: '#/components/schemas/CatalogConfigurationDescription' - description: The Amazon Glue Data Catalog that is associated with the Kinesis Data Analytics Studio notebook. DeployAsApplicationConfigurationDescription: allOf: - $ref: '#/components/schemas/DeployAsApplicationConfigurationDescription' - description: The parameters required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state. CustomArtifactsConfigurationDescription: allOf: - $ref: '#/components/schemas/CustomArtifactsConfigurationDescriptionList' - description: Custom artifacts are dependency JARs and user-defined functions (UDF). description: The configuration of a Kinesis Data Analytics Studio notebook. FlinkApplicationConfigurationUpdate: type: object properties: CheckpointConfigurationUpdate: allOf: - $ref: '#/components/schemas/CheckpointConfigurationUpdate' - description: Describes updates to an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. MonitoringConfigurationUpdate: allOf: - $ref: '#/components/schemas/MonitoringConfigurationUpdate' - description: Describes updates to the configuration parameters for Amazon CloudWatch logging for an application. ParallelismConfigurationUpdate: allOf: - $ref: '#/components/schemas/ParallelismConfigurationUpdate' - description: Describes updates to the parameters for how an application executes multiple tasks simultaneously. description: Describes updates to the configuration parameters for a Flink-based Kinesis Data Analytics application. InputLambdaProcessorDescription: type: object required: - ResourceARN properties: ResourceARN: allOf: - $ref: '#/components/schemas/ResourceARN' - description: '

The ARN of the Amazon Lambda function that is used to preprocess the records in the stream.

To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: Amazon Lambda

' RoleARN: allOf: - $ref: '#/components/schemas/RoleARN' - description:

The ARN of the IAM role that is used to access the Amazon Lambda function.

Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.

 description: For a SQL-based Kinesis Data Analytics application, an object that contains the Amazon Resource Name (ARN) of the Amazon Lambda function that is used to preprocess records in the stream. PropertyMap: type: object minProperties: 1 maxProperties: 50 additionalProperties: $ref: '#/components/schemas/PropertyValue' SqlApplicationConfigurationDescription: type: object properties: InputDescriptions: allOf: - $ref: '#/components/schemas/InputDescriptions' - description: The array of InputDescription objects describing the input streams used by the application. OutputDescriptions: allOf: - $ref: '#/components/schemas/OutputDescriptions' - description: The array of OutputDescription objects describing the destination streams used by the application. ReferenceDataSourceDescriptions: allOf: - $ref: '#/components/schemas/ReferenceDataSourceDescriptions' - description: The array of ReferenceDataSourceDescription objects describing the reference data sources used by the application. description: Describes the inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application. InvalidArgumentException: {} InputProcessingConfigurationDescription: type: object properties: InputLambdaProcessorDescription: allOf: - $ref: '#/components/schemas/InputLambdaProcessorDescription' - description: 'Provides configuration information about the associated InputLambdaProcessorDescription ' description: For a SQL-based Kinesis Data Analytics application, provides the configuration information about an input processor. Currently, the only input processor available is Amazon Lambda. PropertyGroup: type: object required: - PropertyGroupId - PropertyMap properties: PropertyGroupId: allOf: - $ref: '#/components/schemas/Id' - description: Describes the key of an application execution property key-value pair. PropertyMap: allOf: - $ref: '#/components/schemas/PropertyMap' - description: Describes the value of an application execution property key-value pair. description: Property key-value pairs passed into an application. ObjectVersion: type: string minLength: 0 maxLength: 1024 S3ReferenceDataSourceDescription: type: object required: - BucketARN - FileKey properties: BucketARN: allOf: - $ref: '#/components/schemas/BucketARN' - description: The Amazon Resource Name (ARN) of the S3 bucket. FileKey: allOf: - $ref: '#/components/schemas/FileKey' - description: Amazon S3 object key name. ReferenceRoleARN: allOf: - $ref: '#/components/schemas/RoleARN' - description:

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.

 description: For a SQL-based Kinesis Data Analytics application, provides the bucket name and object key name that stores the reference data. InputStartingPosition: type: string enum: - NOW - TRIM_HORIZON - LAST_STOPPED_POINT ApplicationCodeConfigurationUpdate: type: object properties: CodeContentTypeUpdate: allOf: - $ref: '#/components/schemas/CodeContentType' - description: Describes updates to the code content type. CodeContentUpdate: allOf: - $ref: '#/components/schemas/CodeContentUpdate' - description: Describes updates to the code content of an application. description: Describes code configuration updates for an application. This is supported for a Flink-based Kinesis Data Analytics application or a SQL-based Kinesis Data Analytics application. SecurityGroupIds: type: array items: $ref: '#/components/schemas/SecurityGroupId' minItems: 1 maxItems: 5 CodeContentDescription: type: object properties: TextContent: allOf: - $ref: '#/components/schemas/TextContent' - description: The text-format code CodeMD5: allOf: - $ref: '#/components/schemas/CodeMD5' - description: The checksum that can be used to validate zip-format code. CodeSize: allOf: - $ref: '#/components/schemas/CodeSize' - description: The size in bytes of the application code. Can be used to validate zip-format code. S3ApplicationCodeLocationDescription: allOf: - $ref: '#/components/schemas/S3ApplicationCodeLocationDescription' - description: The S3 bucket Amazon Resource Name (ARN), file key, and object version of the application code stored in Amazon S3. description: Describes details about the code of a Kinesis Data Analytics application. parameters: X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/kinesisanalytics/ x-hasEquivalentPaths: true