openapi: 3.2.0 info: version: '2018-05-23' x-release: v4 title: Amazon Kinesis Analytics 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: Amazon Kinesis Analytics paths: /#X-Amz-Target=KinesisAnalytics_20180523.AddApplicationCloudWatchLoggingOption: 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: AddApplicationCloudWatchLoggingOption description: Adds an Amazon CloudWatch log stream to monitor application configuration errors. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AddApplicationCloudWatchLoggingOptionResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' '482': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' '483': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' '484': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '485': description: InvalidApplicationConfigurationException content: application/json: schema: $ref: '#/components/schemas/InvalidApplicationConfigurationException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddApplicationCloudWatchLoggingOptionRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - KinesisAnalytics_20180523.AddApplicationCloudWatchLoggingOption summary: Amazon Managed Service for Apache Flink Add Application Cloud Watch Logging… tags: - Amazon Kinesis Analytics /#X-Amz-Target=KinesisAnalytics_20180523.AddApplicationInput: 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: AddApplicationInput description: 'Adds a streaming source to your SQL-based Kinesis Data Analytics application. You can add a streaming source when you create an application, or you can use this operation to add a streaming source after you create an application. For more information, see CreateApplication. Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AddApplicationInputResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' '482': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' '483': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' '484': description: CodeValidationException content: application/json: schema: $ref: '#/components/schemas/CodeValidationException' '485': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddApplicationInputRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - KinesisAnalytics_20180523.AddApplicationInput summary: Amazon Managed Service for Apache Flink Add Application Input tags: - Amazon Kinesis Analytics /#X-Amz-Target=KinesisAnalytics_20180523.AddApplicationInputProcessingConfiguration: 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: AddApplicationInputProcessingConfiguration description: Adds an InputProcessingConfiguration to a SQL-based Kinesis Data Analytics application. An input processor pre-processes records on the input stream before the application's SQL code executes. Currently, the only input processor available is Amazon Lambda. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AddApplicationInputProcessingConfigurationResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' '482': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' '483': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' '484': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddApplicationInputProcessingConfigurationRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - KinesisAnalytics_20180523.AddApplicationInputProcessingConfiguration summary: Amazon Managed Service for Apache Flink Add Application Input Processing… tags: - Amazon Kinesis Analytics /#X-Amz-Target=KinesisAnalytics_20180523.AddApplicationOutput: 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: AddApplicationOutput description: 'Adds an external destination to your SQL-based Kinesis Data Analytics application. If you want Kinesis Data Analytics to deliver data from an in-application stream within your application to an external destination (such as an Kinesis data stream, a Kinesis Data Firehose delivery stream, or an Amazon Lambda function), you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination. You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors. Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AddApplicationOutputResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' '482': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' '483': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' '484': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddApplicationOutputRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - KinesisAnalytics_20180523.AddApplicationOutput summary: Amazon Managed Service for Apache Flink Add Application Output tags: - Amazon Kinesis Analytics /#X-Amz-Target=KinesisAnalytics_20180523.AddApplicationReferenceDataSource: 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: AddApplicationReferenceDataSource description: 'Adds a reference data source to an existing SQL-based Kinesis Data Analytics application. Kinesis Data Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table within your application. In the request, you provide the source (S3 bucket name and object key name), name of the in-application table to create, and the necessary mapping information that describes how data in an Amazon S3 object maps to columns in the resulting in-application table.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AddApplicationReferenceDataSourceResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' '482': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' '483': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' '484': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddApplicationReferenceDataSourceRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - KinesisAnalytics_20180523.AddApplicationReferenceDataSource summary: Amazon Managed Service for Apache Flink Add Application Reference Data Source tags: - Amazon Kinesis Analytics /#X-Amz-Target=KinesisAnalytics_20180523.AddApplicationVpcConfiguration: 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: AddApplicationVpcConfiguration description: 'Adds a Virtual Private Cloud (VPC) configuration to the application. Applications can use VPCs to store and access resources securely. Note the following about VPC configurations for Kinesis Data Analytics applications: VPC configurations are not supported for SQL applications. When a VPC is added to a Kinesis Data Analytics application, the application can no longer be accessed from the Internet directly. To enable Internet access to the application, add an Internet gateway to your VPC.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AddApplicationVpcConfigurationResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' '482': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' '483': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' '484': description: InvalidApplicationConfigurationException content: application/json: schema: $ref: '#/components/schemas/InvalidApplicationConfigurationException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddApplicationVpcConfigurationRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - KinesisAnalytics_20180523.AddApplicationVpcConfiguration summary: Amazon Managed Service for Apache Flink Add Application Vpc Configuration tags: - Amazon Kinesis Analytics /#X-Amz-Target=KinesisAnalytics_20180523.CreateApplication: 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: CreateApplication description: Creates a Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see Creating an Application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateApplicationResponse' '480': description: CodeValidationException content: application/json: schema: $ref: '#/components/schemas/CodeValidationException' '481': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' '484': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '485': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' '486': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' '487': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateApplicationRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - KinesisAnalytics_20180523.CreateApplication summary: Amazon Managed Service for Apache Flink Create Application tags: - Amazon Kinesis Analytics /#X-Amz-Target=KinesisAnalytics_20180523.CreateApplicationPresignedUrl: 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: CreateApplicationPresignedUrl description: 'Creates and returns a URL that you can use to connect to an application''s extension. The IAM role or user used to call this API defines the permissions to access the extension. After the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request that attempts to connect to the extension. You control the amount of time that the URL will be valid using the SessionExpirationDurationInSeconds parameter. If you do not provide this parameter, the returned URL is valid for twelve hours. The URL that you get from a call to CreateApplicationPresignedUrl must be used within 3 minutes to be valid. If you first try to use the URL after the 3-minute limit expires, the service returns an HTTP 403 Forbidden error.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateApplicationPresignedUrlResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' '482': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateApplicationPresignedUrlRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - KinesisAnalytics_20180523.CreateApplicationPresignedUrl summary: Amazon Managed Service for Apache Flink Create Application Presigned Url tags: - Amazon Kinesis Analytics /#X-Amz-Target=KinesisAnalytics_20180523.CreateApplicationSnapshot: 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: CreateApplicationSnapshot description: Creates a snapshot of the application's state data. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateApplicationSnapshotResponse' '480': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' '484': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' '485': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '486': description: InvalidApplicationConfigurationException content: application/json: schema: $ref: '#/components/schemas/InvalidApplicationConfigurationException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateApplicationSnapshotRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - KinesisAnalytics_20180523.CreateApplicationSnapshot summary: Amazon Managed Service for Apache Flink Create Application Snapshot tags: - Amazon Kinesis Analytics /#X-Amz-Target=KinesisAnalytics_20180523.DeleteApplication: 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: DeleteApplication description: Deletes the specified application. Kinesis Data Analytics halts application execution and deletes the application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteApplicationResponse' '480': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' '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: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '485': description: InvalidApplicationConfigurationException content: application/json: schema: $ref: '#/components/schemas/InvalidApplicationConfigurationException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteApplicationRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - KinesisAnalytics_20180523.DeleteApplication summary: Amazon Managed Service for Apache Flink Delete Application tags: - Amazon Kinesis Analytics /#X-Amz-Target=KinesisAnalytics_20180523.DeleteApplicationCloudWatchLoggingOption: 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: DeleteApplicationCloudWatchLoggingOption description: Deletes an Amazon CloudWatch log stream from an Kinesis Data Analytics application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteApplicationCloudWatchLoggingOptionResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' '482': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' '483': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' '484': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '485': description: InvalidApplicationConfigurationException content: application/json: schema: $ref: '#/components/schemas/InvalidApplicationConfigurationException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteApplicationCloudWatchLoggingOptionRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - KinesisAnalytics_20180523.DeleteApplicationCloudWatchLoggingOption summary: Amazon Managed Service for Apache Flink Delete Application Cloud Watch Logging… tags: - Amazon Kinesis Analytics /#X-Amz-Target=KinesisAnalytics_20180523.DeleteApplicationInputProcessingConfiguration: 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: DeleteApplicationInputProcessingConfiguration description: Deletes an InputProcessingConfiguration from an input. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteApplicationInputProcessingConfigurationResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' '482': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' '483': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' '484': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteApplicationInputProcessingConfigurationRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - KinesisAnalytics_20180523.DeleteApplicationInputProcessingConfiguration summary: Amazon Managed Service for Apache Flink Delete Application Input Processing… tags: - Amazon Kinesis Analytics /#X-Amz-Target=KinesisAnalytics_20180523.DeleteApplicationOutput: 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: DeleteApplicationOutput description: Deletes the output destination configuration from your SQL-based Kinesis Data Analytics application's configuration. Kinesis Data Analytics will no longer write data from the corresponding in-application stream to the external output destination. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteApplicationOutputResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' '482': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' '483': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' '484': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteApplicationOutputRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - KinesisAnalytics_20180523.DeleteApplicationOutput summary: Amazon Managed Service for Apache Flink Delete Application Output tags: - Amazon Kinesis Analytics /#X-Amz-Target=KinesisAnalytics_20180523.DeleteApplicationReferenceDataSource: 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: DeleteApplicationReferenceDataSource description: 'Deletes a reference data source configuration from the specified SQL-based Kinesis Data Analytics application''s configuration. If the application is running, Kinesis Data Analytics immediately removes the in-application table that you created using the AddApplicationReferenceDataSource operation.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteApplicationReferenceDataSourceResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' '482': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' '483': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' '484': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteApplicationReferenceDataSourceRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - KinesisAnalytics_20180523.DeleteApplicationReferenceDataSource summary: Amazon Managed Service for Apache Flink Delete Application Reference Data Source tags: - Amazon Kinesis Analytics /#X-Amz-Target=KinesisAnalytics_20180523.DeleteApplicationSnapshot: 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: DeleteApplicationSnapshot description: Deletes a snapshot of application state. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteApplicationSnapshotResponse' '480': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' '481': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' '482': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' '483': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '484': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '485': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteApplicationSnapshotRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - KinesisAnalytics_20180523.DeleteApplicationSnapshot summary: Amazon Managed Service for Apache Flink Delete Application Snapshot tags: - Amazon Kinesis Analytics /#X-Amz-Target=KinesisAnalytics_20180523.DeleteApplicationVpcConfiguration: 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: DeleteApplicationVpcConfiguration description: Removes a VPC configuration from a Kinesis Data Analytics application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteApplicationVpcConfigurationResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' '482': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' '483': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' '484': description: InvalidApplicationConfigurationException content: application/json: schema: $ref: '#/components/schemas/InvalidApplicationConfigurationException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteApplicationVpcConfigurationRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - KinesisAnalytics_20180523.DeleteApplicationVpcConfiguration summary: Amazon Managed Service for Apache Flink Delete Application Vpc Configuration tags: - Amazon Kinesis Analytics /#X-Amz-Target=KinesisAnalytics_20180523.DescribeApplication: 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: DescribeApplication description: 'Returns information about a specific Kinesis Data Analytics application. If you want to retrieve a list of all applications in your account, use the ListApplications operation.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeApplicationResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' '482': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeApplicationRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - KinesisAnalytics_20180523.DescribeApplication summary: Amazon Managed Service for Apache Flink Describe Application tags: - Amazon Kinesis Analytics /#X-Amz-Target=KinesisAnalytics_20180523.DescribeApplicationSnapshot: 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: DescribeApplicationSnapshot description: Returns information about a snapshot of application state data. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeApplicationSnapshotResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' '482': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeApplicationSnapshotRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - KinesisAnalytics_20180523.DescribeApplicationSnapshot summary: Amazon Managed Service for Apache Flink Describe Application Snapshot tags: - Amazon Kinesis Analytics /#X-Amz-Target=KinesisAnalytics_20180523.DescribeApplicationVersion: 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: DescribeApplicationVersion description: 'Provides a detailed description of a specified version of the application. To see a list of all the versions of an application, invoke the ListApplicationVersions operation. This operation is supported only for Amazon Kinesis Data Analytics for Apache Flink.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeApplicationVersionResponse' '480': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeApplicationVersionRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - KinesisAnalytics_20180523.DescribeApplicationVersion summary: Amazon Managed Service for Apache Flink Describe Application Version tags: - Amazon Kinesis Analytics /#X-Amz-Target=KinesisAnalytics_20180523.DiscoverInputSchema: 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: DiscoverInputSchema description: 'Infers a schema for a SQL-based Kinesis Data Analytics application by evaluating sample records on the specified streaming source (Kinesis data stream or Kinesis Data Firehose delivery stream) or Amazon S3 object. In the response, the operation returns the inferred schema and also the sample records that the operation used to infer the schema. You can use the inferred schema when configuring a streaming source for your application. When you create an application using the Kinesis Data Analytics console, the console uses this operation to infer a schema and show it in the console user interface.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DiscoverInputSchemaResponse' '480': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' '481': description: UnableToDetectSchemaException content: application/json: schema: $ref: '#/components/schemas/UnableToDetectSchemaException' '482': description: ResourceProvisionedThroughputExceededException content: application/json: schema: $ref: '#/components/schemas/ResourceProvisionedThroughputExceededException' '483': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' '484': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '485': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DiscoverInputSchemaRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - KinesisAnalytics_20180523.DiscoverInputSchema summary: Amazon Managed Service for Apache Flink Discover Input Schema tags: - Amazon Kinesis Analytics /#X-Amz-Target=KinesisAnalytics_20180523.ListApplicationSnapshots: 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: ListApplicationSnapshots description: Lists information about the current application snapshots. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListApplicationSnapshotsResponse' '480': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' '481': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListApplicationSnapshotsRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - KinesisAnalytics_20180523.ListApplicationSnapshots summary: Amazon Managed Service for Apache Flink List Application Snapshots tags: - Amazon Kinesis Analytics /#X-Amz-Target=KinesisAnalytics_20180523.ListApplicationVersions: 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: ListApplicationVersions description: 'Lists all the versions for the specified application, including versions that were rolled back. The response also includes a summary of the configuration associated with each version. To get the complete description of a specific application version, invoke the DescribeApplicationVersion operation. This operation is supported only for Amazon Kinesis Data Analytics for Apache Flink.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListApplicationVersionsResponse' '480': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListApplicationVersionsRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - KinesisAnalytics_20180523.ListApplicationVersions summary: Amazon Managed Service for Apache Flink List Application Versions tags: - Amazon Kinesis Analytics /#X-Amz-Target=KinesisAnalytics_20180523.ListApplications: 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: ListApplications description: 'Returns a list of Kinesis Data Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status. If you want detailed information about a specific application, use DescribeApplication.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListApplicationsResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListApplicationsRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - KinesisAnalytics_20180523.ListApplications summary: Amazon Managed Service for Apache Flink List Applications tags: - Amazon Kinesis Analytics /#X-Amz-Target=KinesisAnalytics_20180523.ListTagsForResource: 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: ListTagsForResource description: Retrieves the list of key-value tags assigned to the application. For more information, see Using Tagging. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListTagsForResourceResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' '482': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListTagsForResourceRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - KinesisAnalytics_20180523.ListTagsForResource summary: Amazon Managed Service for Apache Flink List Tags for Resource tags: - Amazon Kinesis Analytics /#X-Amz-Target=KinesisAnalytics_20180523.RollbackApplication: 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: RollbackApplication description: 'Reverts the application to the previous running version. You can roll back an application if you suspect it is stuck in a transient status. You can roll back an application only if it is in the UPDATING or AUTOSCALING status. When you rollback an application, it loads state data from the last successful snapshot. If the application has no snapshots, Kinesis Data Analytics rejects the rollback request. This action is not supported for Kinesis Data Analytics for SQL applications.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RollbackApplicationResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' '482': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' '483': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '484': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' '485': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RollbackApplicationRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - KinesisAnalytics_20180523.RollbackApplication summary: Amazon Managed Service for Apache Flink Rollback Application tags: - Amazon Kinesis Analytics /#X-Amz-Target=KinesisAnalytics_20180523.StartApplication: 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: StartApplication description: Starts the specified Kinesis Data Analytics application. After creating an application, you must exclusively call this operation to start your application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StartApplicationResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' '482': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' '483': description: InvalidApplicationConfigurationException content: application/json: schema: $ref: '#/components/schemas/InvalidApplicationConfigurationException' '484': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StartApplicationRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - KinesisAnalytics_20180523.StartApplication summary: Amazon Managed Service for Apache Flink Start Application tags: - Amazon Kinesis Analytics /#X-Amz-Target=KinesisAnalytics_20180523.StopApplication: 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: StopApplication description: 'Stops the application from processing data. You can stop an application only if it is in the running status, unless you set the Force parameter to true. You can use the DescribeApplication operation to find the application status. Kinesis Data Analytics takes a snapshot when the application is stopped, unless Force is set to true.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StopApplicationResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' '482': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' '483': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '484': description: InvalidApplicationConfigurationException content: application/json: schema: $ref: '#/components/schemas/InvalidApplicationConfigurationException' '485': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StopApplicationRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - KinesisAnalytics_20180523.StopApplication summary: Amazon Managed Service for Apache Flink Stop Application tags: - Amazon Kinesis Analytics /#X-Amz-Target=KinesisAnalytics_20180523.TagResource: 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: TagResource description: Adds one or more key-value tags to a Kinesis Data Analytics 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. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TagResourceResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' '482': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' '483': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' '484': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TagResourceRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - KinesisAnalytics_20180523.TagResource summary: Amazon Managed Service for Apache Flink Tag Resource tags: - Amazon Kinesis Analytics /#X-Amz-Target=KinesisAnalytics_20180523.UntagResource: 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: UntagResource description: Removes one or more tags from a Kinesis Data Analytics application. For more information, see Using Tagging. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UntagResourceResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' '482': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' '483': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' '484': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UntagResourceRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - KinesisAnalytics_20180523.UntagResource summary: Amazon Managed Service for Apache Flink Untag Resource tags: - Amazon Kinesis Analytics /#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: - Amazon Kinesis Analytics /#X-Amz-Target=KinesisAnalytics_20180523.UpdateApplicationMaintenanceConfiguration: 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: UpdateApplicationMaintenanceConfiguration description: 'Updates the maintenance configuration of the Kinesis Data Analytics application. You can invoke this operation on an application that is in one of the two following states: READY or RUNNING. If you invoke it when the application is in a state other than these two states, it throws a ResourceInUseException. The service makes use of the updated configuration the next time it schedules maintenance for the application. If you invoke this operation after the service schedules maintenance, the service will apply the configuration update the next time it schedules maintenance for the application. This means that you might not see the maintenance configuration update applied to the maintenance process that follows a successful invocation of this operation, but to the following maintenance process instead. To see the current maintenance configuration of your application, invoke the DescribeApplication operation. For information about application maintenance, see Kinesis Data Analytics for Apache Flink Maintenance. This operation is supported only for Amazon Kinesis Data Analytics for Apache Flink.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateApplicationMaintenanceConfigurationResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' '482': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' '483': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' '484': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateApplicationMaintenanceConfigurationRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - KinesisAnalytics_20180523.UpdateApplicationMaintenanceConfiguration summary: Amazon Managed Service for Apache Flink Update Application Maintenance… tags: - Amazon Kinesis Analytics components: schemas: 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. ' 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. 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. AddApplicationInputProcessingConfigurationRequest: type: object required: - ApplicationName - CurrentApplicationVersionId - InputId - InputProcessingConfiguration title: AddApplicationInputProcessingConfigurationRequest properties: ApplicationName: allOf: - $ref: '#/components/schemas/ApplicationName' - description: The name of the application to which you want to add the input processing configuration. CurrentApplicationVersionId: allOf: - $ref: '#/components/schemas/ApplicationVersionId' - description: 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. InputId: allOf: - $ref: '#/components/schemas/Id' - description: 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. InputProcessingConfiguration: allOf: - $ref: '#/components/schemas/InputProcessingConfiguration' - description: The InputProcessingConfiguration to add to the application. AuthorizedUrl: type: string minLength: 1 maxLength: 2048 ApplicationMode: type: string enum: - STREAMING - INTERACTIVE CatalogConfiguration: type: object required: - GlueDataCatalogConfiguration properties: GlueDataCatalogConfiguration: allOf: - $ref: '#/components/schemas/GlueDataCatalogConfiguration' - 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. 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. DescribeApplicationRequest: type: object required: - ApplicationName title: DescribeApplicationRequest properties: ApplicationName: allOf: - $ref: '#/components/schemas/ApplicationName' - description: The name of the application. IncludeAdditionalDetails: allOf: - $ref: '#/components/schemas/BooleanObject' - description: Displays verbose information about a Kinesis Data Analytics application, including the application's job plan. LogLevel: type: string enum: - INFO - WARN - ERROR - DEBUG ResourceProvisionedThroughputExceededException: {} MavenVersion: type: string pattern: '[a-zA-Z0-9_.-]+' minLength: 1 maxLength: 256 AddApplicationReferenceDataSourceResponse: type: object properties: ApplicationARN: allOf: - $ref: '#/components/schemas/ResourceARN' - description: The application Amazon Resource Name (ARN). ApplicationVersionId: allOf: - $ref: '#/components/schemas/ApplicationVersionId' - description: The updated application version ID. Kinesis Data Analytics increments this ID when the application is updated. ReferenceDataSourceDescriptions: allOf: - $ref: '#/components/schemas/ReferenceDataSourceDescriptions' - description: 'Describes reference data sources configured for the application. ' CreateApplicationSnapshotResponse: type: object properties: {} VpcConfigurations: type: array items: $ref: '#/components/schemas/VpcConfiguration' SqlRunConfiguration: type: object required: - InputId - InputStartingPositionConfiguration properties: InputId: allOf: - $ref: '#/components/schemas/Id' - description: 'The input source ID. You can get this ID by calling the DescribeApplication operation. ' InputStartingPositionConfiguration: allOf: - $ref: '#/components/schemas/InputStartingPositionConfiguration' - description: 'The point at which you want the application to start processing records from the streaming source. ' description: Describes the starting parameters for a SQL-based Kinesis Data Analytics application. 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. InputParallelismCount: type: integer minimum: 1 maximum: 64 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. ' ConcurrentModificationException: {} UpdateApplicationMaintenanceConfigurationRequest: type: object required: - ApplicationName - ApplicationMaintenanceConfigurationUpdate title: UpdateApplicationMaintenanceConfigurationRequest properties: ApplicationName: allOf: - $ref: '#/components/schemas/ApplicationName' - description: The name of the application for which you want to update the maintenance configuration. ApplicationMaintenanceConfigurationUpdate: allOf: - $ref: '#/components/schemas/ApplicationMaintenanceConfigurationUpdate' - description: Describes the application maintenance configuration update. 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. PropertyMap: type: object minProperties: 1 maxProperties: 50 additionalProperties: $ref: '#/components/schemas/PropertyValue' ApplicationCodeConfiguration: type: object required: - CodeContentType properties: CodeContent: allOf: - $ref: '#/components/schemas/CodeContent' - description: The location and type of the application code. CodeContentType: allOf: - $ref: '#/components/schemas/CodeContentType' - description: Specifies whether the code content is in text or zip format. description: Describes code configuration for an application. DescribeApplicationVersionRequest: type: object required: - ApplicationName - ApplicationVersionId title: DescribeApplicationVersionRequest properties: ApplicationName: allOf: - $ref: '#/components/schemas/ApplicationName' - description: The name of the application for which you want to get the version description. ApplicationVersionId: allOf: - $ref: '#/components/schemas/ApplicationVersionId' - description: The ID of the application version for which you want to get the description. ZeppelinMonitoringConfiguration: type: object required: - LogLevel properties: LogLevel: allOf: - $ref: '#/components/schemas/LogLevel' - description: The verbosity of the CloudWatch Logs for an application. description: Describes configuration parameters for Amazon CloudWatch logging for a Kinesis Data Analytics Studio notebook. For more information about CloudWatch logging, see Monitoring. AddApplicationVpcConfigurationRequest: type: object required: - ApplicationName - VpcConfiguration title: AddApplicationVpcConfigurationRequest properties: ApplicationName: allOf: - $ref: '#/components/schemas/ApplicationName' - description: The name of an existing application. CurrentApplicationVersionId: allOf: - $ref: '#/components/schemas/ApplicationVersionId' - description: The version of the application to which you want to add the VPC configuration. You must provide the CurrentApplicationVersionId or the ConditionalToken. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId. VpcConfiguration: allOf: - $ref: '#/components/schemas/VpcConfiguration' - description: Description of the VPC to add to the application. ConditionalToken: allOf: - $ref: '#/components/schemas/ConditionalToken' - description: A value you use to implement strong concurrency for application updates. You must provide the ApplicationVersionID or the ConditionalToken. You get the application's current ConditionalToken using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId. TagValue: type: string minLength: 0 maxLength: 256 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. ' DeleteApplicationSnapshotResponse: type: object properties: {} ReferenceDataSources: type: array items: $ref: '#/components/schemas/ReferenceDataSource' CreateApplicationSnapshotRequest: type: object required: - ApplicationName - SnapshotName title: CreateApplicationSnapshotRequest properties: ApplicationName: allOf: - $ref: '#/components/schemas/ApplicationName' - description: The name of an existing application SnapshotName: allOf: - $ref: '#/components/schemas/SnapshotName' - description: An identifier for the application snapshot. PropertyGroups: type: array items: $ref: '#/components/schemas/PropertyGroup' maxItems: 50 CreateApplicationResponse: type: object required: - ApplicationDetail properties: ApplicationDetail: allOf: - $ref: '#/components/schemas/ApplicationDetail' - description: In response to your CreateApplication request, Kinesis Data Analytics returns a response with details of the application it created. ApplicationMaintenanceWindowEndTime: type: string pattern: ([01][0-9]|2[0-3]):[0-5][0-9] minLength: 5 maxLength: 5 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. AddApplicationReferenceDataSourceRequest: type: object required: - ApplicationName - CurrentApplicationVersionId - ReferenceDataSource title: AddApplicationReferenceDataSourceRequest properties: ApplicationName: allOf: - $ref: '#/components/schemas/ApplicationName' - description: The name of an existing application. CurrentApplicationVersionId: allOf: - $ref: '#/components/schemas/ApplicationVersionId' - description: 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. ReferenceDataSource: allOf: - $ref: '#/components/schemas/ReferenceDataSource' - description: '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. ' Tags: type: array items: $ref: '#/components/schemas/Tag' minItems: 1 maxItems: 200 ApplicationSummary: type: object required: - ApplicationName - ApplicationARN - ApplicationStatus - ApplicationVersionId - RuntimeEnvironment properties: ApplicationName: allOf: - $ref: '#/components/schemas/ApplicationName' - description: The name of the application. ApplicationARN: allOf: - $ref: '#/components/schemas/ResourceARN' - description: The ARN of the application. ApplicationStatus: allOf: - $ref: '#/components/schemas/ApplicationStatus' - description: The status of the application. ApplicationVersionId: allOf: - $ref: '#/components/schemas/ApplicationVersionId' - description: Provides the current application version. RuntimeEnvironment: allOf: - $ref: '#/components/schemas/RuntimeEnvironment' - description: The runtime environment for the application. ApplicationMode: allOf: - $ref: '#/components/schemas/ApplicationMode' - description: For a Kinesis Data Analytics for Apache Flink application, the mode is STREAMING. For a Kinesis Data Analytics Studio notebook, it is INTERACTIVE. description: Provides application summary information, including the application Amazon Resource Name (ARN), name, and status. DeleteApplicationVpcConfigurationRequest: type: object required: - ApplicationName - VpcConfigurationId title: DeleteApplicationVpcConfigurationRequest properties: ApplicationName: allOf: - $ref: '#/components/schemas/ApplicationName' - description: The name of an existing application. 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. VpcConfigurationId: allOf: - $ref: '#/components/schemas/Id' - description: The ID of the VPC configuration to delete. 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. DeleteApplicationInputProcessingConfigurationResponse: type: object properties: ApplicationARN: allOf: - $ref: '#/components/schemas/ResourceARN' - description: The Amazon Resource Name (ARN) of the application. ApplicationVersionId: allOf: - $ref: '#/components/schemas/ApplicationVersionId' - description: The current application version ID. SecurityGroupIds: type: array items: $ref: '#/components/schemas/SecurityGroupId' minItems: 1 maxItems: 5 ReferenceDataSource: type: object required: - TableName - ReferenceSchema properties: TableName: allOf: - $ref: '#/components/schemas/InAppTableName' - description: The name of the in-application table to create. S3ReferenceDataSource: allOf: - $ref: '#/components/schemas/S3ReferenceDataSource' - description: '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. ' 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 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. DeleteApplicationCloudWatchLoggingOptionResponse: type: object properties: ApplicationARN: allOf: - $ref: '#/components/schemas/ResourceARN' - description: The application's Amazon Resource Name (ARN). ApplicationVersionId: allOf: - $ref: '#/components/schemas/ApplicationVersionId' - description: The version ID of the application. Kinesis Data Analytics updates the ApplicationVersionId each time you change the CloudWatch logging options. CloudWatchLoggingOptionDescriptions: allOf: - $ref: '#/components/schemas/CloudWatchLoggingOptionDescriptions' - description: The descriptions of the remaining CloudWatch logging options for the application. ListTagsForResourceRequest: type: object required: - ResourceARN title: ListTagsForResourceRequest properties: ResourceARN: allOf: - $ref: '#/components/schemas/KinesisAnalyticsARN' - description: The ARN of the application for which to retrieve tags. 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. ' CodeValidationException: {} UrlType: type: string enum: - FLINK_DASHBOARD_URL - ZEPPELIN_UI_URL FlinkApplicationConfiguration: type: object properties: CheckpointConfiguration: allOf: - $ref: '#/components/schemas/CheckpointConfiguration' - description: 'Describes an application''s checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance in the Apache Flink Documentation. ' MonitoringConfiguration: allOf: - $ref: '#/components/schemas/MonitoringConfiguration' - description: Describes configuration parameters for Amazon CloudWatch logging for an application. ParallelismConfiguration: allOf: - $ref: '#/components/schemas/ParallelismConfiguration' - description: Describes parameters for how an application executes multiple tasks simultaneously. description: Describes configuration parameters for a Flink-based Kinesis Data Analytics application or a Studio notebook. 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. ' 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. AddApplicationOutputResponse: type: object properties: ApplicationARN: allOf: - $ref: '#/components/schemas/ResourceARN' - description: The application Amazon Resource Name (ARN). ApplicationVersionId: allOf: - $ref: '#/components/schemas/ApplicationVersionId' - description: The updated application version ID. Kinesis Data Analytics increments this ID when the application is updated. OutputDescriptions: allOf: - $ref: '#/components/schemas/OutputDescriptions' - description: 'Describes the application output configuration. For more information, see Configuring Application Output. ' 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. 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. UpdateApplicationMaintenanceConfigurationResponse: type: object properties: ApplicationARN: allOf: - $ref: '#/components/schemas/ResourceARN' - description: The Amazon Resource Name (ARN) of the application. ApplicationMaintenanceConfigurationDescription: allOf: - $ref: '#/components/schemas/ApplicationMaintenanceConfigurationDescription' - description: The application maintenance configuration description after the update. 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. BooleanObject: type: boolean ParallelismPerKPU: type: integer minimum: 1 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. InputProcessingConfiguration: type: object required: - InputLambdaProcessor properties: InputLambdaProcessor: allOf: - $ref: '#/components/schemas/InputLambdaProcessor' - description: The InputLambdaProcessor that is used to preprocess the records in the stream before being processed by your application code. description: For a SQL-based Kinesis Data Analytics application, describes a processor that is used to preprocess the records in the stream before being processed by your application code. Currently, the only input processor available is Amazon Lambda. DescribeApplicationSnapshotResponse: type: object required: - SnapshotDetails properties: SnapshotDetails: allOf: - $ref: '#/components/schemas/SnapshotDetails' - description: An object containing information about the application snapshot. TagResourceRequest: type: object required: - ResourceARN - Tags title: TagResourceRequest properties: ResourceARN: allOf: - $ref: '#/components/schemas/KinesisAnalyticsARN' - description: The ARN of the application to assign the tags. Tags: allOf: - $ref: '#/components/schemas/Tags' - description: The key-value tags to assign to the application. UnableToDetectSchemaException: {} RecordColumnSqlType: type: string minLength: 1 maxLength: 100 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. Tag: type: object required: - Key properties: Key: allOf: - $ref: '#/components/schemas/TagKey' - description: The key of the key-value tag. Value: allOf: - $ref: '#/components/schemas/TagValue' - description: The value of the key-value tag. The value is optional. description: A key-value pair (the value is optional) that you can define and assign to Amazon resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see Using Tagging. ResourceInUseException: {} RunConfiguration: type: object properties: FlinkRunConfiguration: allOf: - $ref: '#/components/schemas/FlinkRunConfiguration' - description: Describes the starting parameters for a Flink-based Kinesis Data Analytics application. SqlRunConfigurations: allOf: - $ref: '#/components/schemas/SqlRunConfigurations' - description: Describes the starting parameters for a SQL-based Kinesis Data Analytics application application. ApplicationRestoreConfiguration: allOf: - $ref: '#/components/schemas/ApplicationRestoreConfiguration' - description: Describes the restore behavior of a restarting application. description: Describes the starting parameters for an Kinesis Data Analytics application. JobPlanDescription: type: string Inputs: type: array items: $ref: '#/components/schemas/Input' RollbackApplicationResponse: type: object required: - ApplicationDetail properties: ApplicationDetail: $ref: '#/components/schemas/ApplicationDetail' ApplicationMaintenanceConfigurationUpdate: type: object required: - ApplicationMaintenanceWindowStartTimeUpdate properties: ApplicationMaintenanceWindowStartTimeUpdate: allOf: - $ref: '#/components/schemas/ApplicationMaintenanceWindowStartTime' - description: The updated start time for the maintenance window. description: Describes the updated maintenance configuration for the application. DeleteApplicationInputProcessingConfigurationRequest: type: object required: - ApplicationName - CurrentApplicationVersionId - InputId title: DeleteApplicationInputProcessingConfigurationRequest properties: ApplicationName: allOf: - $ref: '#/components/schemas/ApplicationName' - description: The name of the application. CurrentApplicationVersionId: allOf: - $ref: '#/components/schemas/ApplicationVersionId' - description: '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. ' InputId: allOf: - $ref: '#/components/schemas/Id' - description: 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. 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. 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. ' InputUpdates: type: array items: $ref: '#/components/schemas/InputUpdate' RecordColumnMapping: type: string minLength: 0 maxLength: 65535 SqlApplicationConfiguration: type: object properties: Inputs: allOf: - $ref: '#/components/schemas/Inputs' - description: The array of Input objects describing the input streams used by the application. Outputs: allOf: - $ref: '#/components/schemas/Outputs' - description: The array of Output objects describing the destination streams used by the application. ReferenceDataSources: allOf: - $ref: '#/components/schemas/ReferenceDataSources' - description: The array of ReferenceDataSource 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. ParsedInputRecordField: type: string ResourceNotFoundException: {} ParsedInputRecords: type: array items: $ref: '#/components/schemas/ParsedInputRecord' PropertyValue: type: string minLength: 1 maxLength: 2048 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. UntagResourceRequest: type: object required: - ResourceARN - TagKeys title: UntagResourceRequest properties: ResourceARN: allOf: - $ref: '#/components/schemas/KinesisAnalyticsARN' - description: The ARN of the Kinesis Data Analytics application from which to remove the tags. TagKeys: allOf: - $ref: '#/components/schemas/TagKeys' - description: A list of keys of tags to remove from the specified application. DeleteApplicationOutputRequest: type: object required: - ApplicationName - CurrentApplicationVersionId - OutputId title: DeleteApplicationOutputRequest properties: ApplicationName: allOf: - $ref: '#/components/schemas/ApplicationName' - description: The application name. CurrentApplicationVersionId: allOf: - $ref: '#/components/schemas/ApplicationVersionId' - description: '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. ' OutputId: allOf: - $ref: '#/components/schemas/Id' - description: '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. ' Input: type: object required: - NamePrefix - InputSchema properties: NamePrefix: allOf: - $ref: '#/components/schemas/InAppStreamName' - description: 'The name prefix to use when creating an in-application stream. Suppose that you specify a prefix "MyInApplicationStream." Kinesis Data Analytics then creates one or more (as per the InputParallelism count you specified) in-application streams with the names "MyInApplicationStream_001," "MyInApplicationStream_002," and so on. ' InputProcessingConfiguration: allOf: - $ref: '#/components/schemas/InputProcessingConfiguration' - description: '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. ' KinesisStreamsInput: allOf: - $ref: '#/components/schemas/KinesisStreamsInput' - description: 'If the streaming source is an Amazon Kinesis data stream, identifies the stream''s Amazon Resource Name (ARN). ' KinesisFirehoseInput: allOf: - $ref: '#/components/schemas/KinesisFirehoseInput' - description: If the streaming source is an Amazon Kinesis Data Firehose delivery stream, identifies the delivery stream's ARN. InputParallelism: allOf: - $ref: '#/components/schemas/InputParallelism' - description: 'Describes the number of in-application streams to create. ' 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.

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

description: 'When you configure the application input for a SQL-based Kinesis Data Analytics application, you specify the streaming source, the in-application stream name that is created, and the mapping between the two. ' DeleteApplicationOutputResponse: type: object properties: ApplicationARN: allOf: - $ref: '#/components/schemas/ResourceARN' - description: The application Amazon Resource Name (ARN). ApplicationVersionId: allOf: - $ref: '#/components/schemas/ApplicationVersionId' - description: The current application version ID. ListTagsForResourceResponse: type: object properties: Tags: allOf: - $ref: '#/components/schemas/Tags' - description: The key-value tags assigned to the application. VpcId: type: string 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. Outputs: type: array items: $ref: '#/components/schemas/Output' ZeppelinApplicationConfiguration: type: object properties: MonitoringConfiguration: allOf: - $ref: '#/components/schemas/ZeppelinMonitoringConfiguration' - description: The monitoring configuration of a Kinesis Data Analytics Studio notebook. CatalogConfiguration: allOf: - $ref: '#/components/schemas/CatalogConfiguration' - description: The Amazon Glue Data Catalog that you use in queries in a Kinesis Data Analytics Studio notebook. DeployAsApplicationConfiguration: allOf: - $ref: '#/components/schemas/DeployAsApplicationConfiguration' - description: The information required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state. CustomArtifactsConfiguration: allOf: - $ref: '#/components/schemas/CustomArtifactsConfigurationList' - description: Custom artifacts are dependency JARs and user-defined functions (UDF). description: The configuration of a Kinesis Data Analytics Studio notebook. 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. ProcessedInputRecord: type: string 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. ' MinPauseBetweenCheckpoints: type: integer minimum: 0 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. InAppStreamName: type: string pattern: '[^-\s<>&]*' minLength: 1 maxLength: 32 UntagResourceResponse: type: object properties: {} CloudWatchLoggingOptionUpdates: type: array items: $ref: '#/components/schemas/CloudWatchLoggingOptionUpdate' StartApplicationRequest: type: object required: - ApplicationName title: StartApplicationRequest properties: ApplicationName: allOf: - $ref: '#/components/schemas/ApplicationName' - description: The name of the application. RunConfiguration: allOf: - $ref: '#/components/schemas/RunConfiguration' - description: Identifies the run configuration (start parameters) of a Kinesis Data Analytics application. CreateApplicationPresignedUrlResponse: type: object properties: AuthorizedUrl: allOf: - $ref: '#/components/schemas/AuthorizedUrl' - description: The URL of the extension. BucketARN: type: string pattern: arn:.* minLength: 1 maxLength: 2048 ConfigurationType: type: string enum: - DEFAULT - CUSTOM LambdaOutput: type: object required: - ResourceARN properties: ResourceARN: allOf: - $ref: '#/components/schemas/ResourceARN' - description: '

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

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

' description: 'When you configure a SQL-based Kinesis Data Analytics application''s output, identifies an Amazon Lambda function as the destination. You provide the function Amazon Resource Name (ARN) of the Lambda function. ' 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. AddApplicationInputRequest: type: object required: - ApplicationName - CurrentApplicationVersionId - Input title: AddApplicationInputRequest properties: ApplicationName: allOf: - $ref: '#/components/schemas/ApplicationName' - description: The name of your existing application to which you want to add the streaming source. CurrentApplicationVersionId: allOf: - $ref: '#/components/schemas/ApplicationVersionId' - description: The current version of your application. You must provide the ApplicationVersionID or the ConditionalToken.You can use the DescribeApplication operation to find the current application version. Input: allOf: - $ref: '#/components/schemas/Input' - description: The Input to add. ListApplicationVersionsResponse: type: object properties: ApplicationVersionSummaries: allOf: - $ref: '#/components/schemas/ApplicationVersionSummaries' - description:

A list of the application versions and the associated configuration summaries. The list includes application versions that were rolled back.

To get the complete description of a specific application version, invoke the DescribeApplicationVersion operation.

NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: The pagination token for the next set of results, or null if there are no additional results. To retrieve the next set of items, pass this token into a subsequent invocation of this operation. For more information about pagination, see Using the Amazon Command Line Interface's Pagination Options. S3ContentBaseLocation: 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 S3 bucket that holds the application information. MetricsLevel: type: string enum: - APPLICATION - TASK - OPERATOR - PARALLELISM ReferenceDataSourceUpdates: type: array items: $ref: '#/components/schemas/ReferenceDataSourceUpdate' ServiceUnavailableException: {} DeployAsApplicationConfiguration: type: object required: - S3ContentLocation properties: S3ContentLocation: allOf: - $ref: '#/components/schemas/S3ContentBaseLocation' - description: 'The description of an Amazon S3 object that contains the Amazon Data Analytics application, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data. ' description: The information required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state. MavenGroupId: type: string pattern: '[a-zA-Z0-9_.-]+' minLength: 1 maxLength: 256 DiscoverInputSchemaResponse: type: object properties: InputSchema: allOf: - $ref: '#/components/schemas/SourceSchema' - description: 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. ParsedInputRecords: allOf: - $ref: '#/components/schemas/ParsedInputRecords' - description: An array of elements, where each element corresponds to a row in a stream record (a stream record can have more than one row). ProcessedInputRecords: allOf: - $ref: '#/components/schemas/ProcessedInputRecords' - description: The stream data that was modified by the processor specified in the InputProcessingConfiguration parameter. RawInputRecords: allOf: - $ref: '#/components/schemas/RawInputRecords' - description: The raw stream data that was sampled to infer the schema. ApplicationStatus: type: string enum: - DELETING - STARTING - STOPPING - READY - RUNNING - UPDATING - AUTOSCALING - FORCE_STOPPING - ROLLING_BACK - MAINTENANCE - ROLLED_BACK 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. ' 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. InAppTableName: type: string minLength: 1 maxLength: 32 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. 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. RecordColumns: type: array items: $ref: '#/components/schemas/RecordColumn' minItems: 1 maxItems: 1000 TagKeys: type: array items: $ref: '#/components/schemas/TagKey' minItems: 1 maxItems: 200 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. DeleteApplicationSnapshotRequest: type: object required: - ApplicationName - SnapshotName - SnapshotCreationTimestamp title: DeleteApplicationSnapshotRequest properties: ApplicationName: allOf: - $ref: '#/components/schemas/ApplicationName' - description: The name of an existing application. SnapshotName: allOf: - $ref: '#/components/schemas/SnapshotName' - description: The identifier for the snapshot delete. SnapshotCreationTimestamp: allOf: - $ref: '#/components/schemas/Timestamp' - description: The creation timestamp of the application snapshot to delete. You can retrieve this value using or . ListApplicationVersionsRequest: type: object required: - ApplicationName title: ListApplicationVersionsRequest properties: ApplicationName: allOf: - $ref: '#/components/schemas/ApplicationName' - description: The name of the application for which you want to list all versions. Limit: allOf: - $ref: '#/components/schemas/ListApplicationVersionsInputLimit' - description: The maximum number of versions to list in this invocation of the operation. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: If a previous invocation of this operation returned a pagination token, pass it into this value to retrieve the next set of results. For more information about pagination, see Using the Amazon Command Line Interface's Pagination Options. ApplicationSnapshotConfiguration: 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. Id: type: string pattern: '[a-zA-Z0-9_.-]+' minLength: 1 maxLength: 50 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. 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. 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. TextContent: type: string minLength: 0 maxLength: 102400 ResourceARN: type: string pattern: arn:.* minLength: 1 maxLength: 2048 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. FileKey: type: string minLength: 1 maxLength: 1024 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. InputLambdaProcessor: type: object required: - ResourceARN properties: ResourceARN: allOf: - $ref: '#/components/schemas/ResourceARN' - description: '

The ARN of the Amazon Lambda function that operates on records in the stream.

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

' description: 'An object that contains the Amazon Resource Name (ARN) of the Amazon Lambda function that is used to preprocess records in the stream in a SQL-based Kinesis Data Analytics application. ' ListApplicationsResponse: type: object required: - ApplicationSummaries properties: ApplicationSummaries: allOf: - $ref: '#/components/schemas/ApplicationSummaries' - description: A list of ApplicationSummary objects. NextToken: allOf: - $ref: '#/components/schemas/ApplicationName' - description: The pagination token for the next set of results, or null if there are no additional results. Pass this token into a subsequent command to retrieve the next set of items For more information about pagination, see Using the Amazon Command Line Interface's Pagination Options. 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. DeleteApplicationCloudWatchLoggingOptionRequest: type: object required: - ApplicationName - CloudWatchLoggingOptionId title: DeleteApplicationCloudWatchLoggingOptionRequest properties: ApplicationName: allOf: - $ref: '#/components/schemas/ApplicationName' - description: The application name. CurrentApplicationVersionId: allOf: - $ref: '#/components/schemas/ApplicationVersionId' - description: The version ID of the application. You must provide the CurrentApplicationVersionId or the ConditionalToken. You can retrieve the application version ID using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId. CloudWatchLoggingOptionId: allOf: - $ref: '#/components/schemas/Id' - description: 'The CloudWatchLoggingOptionId of the Amazon CloudWatch logging option to delete. You can get the CloudWatchLoggingOptionId by using the DescribeApplication operation. ' 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. LogStreamARN: type: string pattern: arn:.* minLength: 1 maxLength: 2048 ApplicationName: type: string pattern: '[a-zA-Z0-9_.-]+' minLength: 1 maxLength: 128 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. AddApplicationInputResponse: type: object properties: ApplicationARN: allOf: - $ref: '#/components/schemas/ResourceARN' - description: The Amazon Resource Name (ARN) of the application. ApplicationVersionId: allOf: - $ref: '#/components/schemas/ApplicationVersionId' - description: Provides the current application version. InputDescriptions: allOf: - $ref: '#/components/schemas/InputDescriptions' - description: 'Describes the application input configuration. ' ApplicationSummaries: type: array items: $ref: '#/components/schemas/ApplicationSummary' ApplicationVersionSummaries: type: array items: $ref: '#/components/schemas/ApplicationVersionSummary' 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. CloudWatchLoggingOption: type: object required: - LogStreamARN properties: LogStreamARN: allOf: - $ref: '#/components/schemas/LogStreamARN' - description: The ARN of the CloudWatch log to receive application messages. description: 'Provides a description of Amazon CloudWatch logging options, including the log stream Amazon Resource Name (ARN). ' RawInputRecords: type: array items: $ref: '#/components/schemas/RawInputRecord' EnvironmentProperties: type: object required: - PropertyGroups properties: PropertyGroups: allOf: - $ref: '#/components/schemas/PropertyGroups' - description: Describes the execution property groups. description: Describes execution properties for a Flink-based Kinesis Data Analytics application. DescribeApplicationResponse: type: object required: - ApplicationDetail properties: ApplicationDetail: allOf: - $ref: '#/components/schemas/ApplicationDetail' - description: Provides a description of the application, such as the application's Amazon Resource Name (ARN), status, and latest version. ObjectVersion: type: string minLength: 0 maxLength: 1024 CreateApplicationPresignedUrlRequest: type: object required: - ApplicationName - UrlType title: CreateApplicationPresignedUrlRequest properties: ApplicationName: allOf: - $ref: '#/components/schemas/ApplicationName' - description: The name of the application. UrlType: allOf: - $ref: '#/components/schemas/UrlType' - description: 'The type of the extension for which to create and return a URL. Currently, the only valid extension URL type is FLINK_DASHBOARD_URL. ' SessionExpirationDurationInSeconds: allOf: - $ref: '#/components/schemas/SessionExpirationDurationInSeconds' - description: The duration in seconds for which the returned URL will be valid. InvalidApplicationConfigurationException: {} 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. DiscoverInputSchemaRequest: type: object required: - ServiceExecutionRole title: DiscoverInputSchemaRequest properties: ResourceARN: allOf: - $ref: '#/components/schemas/ResourceARN' - description: The Amazon Resource Name (ARN) of the streaming source. ServiceExecutionRole: allOf: - $ref: '#/components/schemas/RoleARN' - description: The ARN of the role that is used to access the streaming source. InputStartingPositionConfiguration: allOf: - $ref: '#/components/schemas/InputStartingPositionConfiguration' - description: The point at which you want Kinesis Data Analytics to start reading records from the specified streaming source discovery purposes. S3Configuration: allOf: - $ref: '#/components/schemas/S3Configuration' - description: Specify this parameter to discover a schema from data in an Amazon S3 object. InputProcessingConfiguration: allOf: - $ref: '#/components/schemas/InputProcessingConfiguration' - description: The InputProcessingConfiguration to use to preprocess the records before discovering the schema of the records. 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. UnsupportedOperationException: {} 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. 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. AddApplicationInputProcessingConfigurationResponse: type: object properties: ApplicationARN: allOf: - $ref: '#/components/schemas/ResourceARN' - description: The Amazon Resource Name (ARN) of the application. ApplicationVersionId: allOf: - $ref: '#/components/schemas/ApplicationVersionId' - description: 'Provides the current application version. ' 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. 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. SubnetIds: type: array items: $ref: '#/components/schemas/SubnetId' minItems: 1 maxItems: 16 CodeContentType: type: string enum: - PLAINTEXT - ZIPFILE ParsedInputRecord: type: array items: $ref: '#/components/schemas/ParsedInputRecordField' 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. KinesisAnalyticsARN: type: string pattern: arn:.* minLength: 1 maxLength: 2048 ListApplicationVersionsInputLimit: type: integer minimum: 1 maximum: 50 ApplicationVersionSummary: type: object required: - ApplicationVersionId - ApplicationStatus properties: ApplicationVersionId: allOf: - $ref: '#/components/schemas/ApplicationVersionId' - description: The ID of the application version. Kinesis Data Analytics updates the ApplicationVersionId each time you update the application. ApplicationStatus: allOf: - $ref: '#/components/schemas/ApplicationStatus' - description: The status of the application. description: The summary of the application version. DescribeApplicationVersionResponse: type: object properties: ApplicationVersionDetail: $ref: '#/components/schemas/ApplicationDetail' 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. ' 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. 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. 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. 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. ' 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.

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. 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. ApplicationDescription: type: string minLength: 0 maxLength: 1024 TooManyTagsException: {} ZipFileContent: type: string minLength: 0 maxLength: 52428800 RollbackApplicationRequest: type: object required: - ApplicationName - CurrentApplicationVersionId title: RollbackApplicationRequest properties: ApplicationName: allOf: - $ref: '#/components/schemas/ApplicationName' - description: The name of the application. CurrentApplicationVersionId: allOf: - $ref: '#/components/schemas/ApplicationVersionId' - description: The current application version ID. You can retrieve the application version ID using DescribeApplication. CloudWatchLoggingOptionDescriptions: type: array items: $ref: '#/components/schemas/CloudWatchLoggingOptionDescription' 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. ApplicationConfiguration: type: object properties: SqlApplicationConfiguration: allOf: - $ref: '#/components/schemas/SqlApplicationConfiguration' - description: The creation and update parameters for a SQL-based Kinesis Data Analytics application. FlinkApplicationConfiguration: allOf: - $ref: '#/components/schemas/FlinkApplicationConfiguration' - description: The creation and update parameters for a Flink-based Kinesis Data Analytics application. EnvironmentProperties: allOf: - $ref: '#/components/schemas/EnvironmentProperties' - description: Describes execution properties for a Flink-based Kinesis Data Analytics application. ApplicationCodeConfiguration: allOf: - $ref: '#/components/schemas/ApplicationCodeConfiguration' - description: The code location and type parameters for a Flink-based Kinesis Data Analytics application. ApplicationSnapshotConfiguration: allOf: - $ref: '#/components/schemas/ApplicationSnapshotConfiguration' - description: Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application. VpcConfigurations: allOf: - $ref: '#/components/schemas/VpcConfigurations' - description: The array of descriptions of VPC configurations available to the application. ZeppelinApplicationConfiguration: allOf: - $ref: '#/components/schemas/ZeppelinApplicationConfiguration' - description: The configuration parameters for a Kinesis Data Analytics Studio notebook. description: Specifies the creation parameters for a Kinesis Data Analytics application. GlueDataCatalogConfiguration: 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. CodeMD5: type: string minLength: 128 maxLength: 128 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. 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. RecordRowPath: type: string pattern: ^(?=^\$)(?=^\S+$).*$ minLength: 1 maxLength: 65535 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. RecordEncoding: type: string pattern: UTF-8 minLength: 5 maxLength: 5 ApplicationMaintenanceWindowStartTime: type: string pattern: ([01][0-9]|2[0-3]):[0-5][0-9] minLength: 5 maxLength: 5 ProcessedInputRecords: type: array items: $ref: '#/components/schemas/ProcessedInputRecord' InvalidRequestException: {} 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. Timestamp: type: string format: date-time StopApplicationRequest: type: object required: - ApplicationName title: StopApplicationRequest properties: ApplicationName: allOf: - $ref: '#/components/schemas/ApplicationName' - description: The name of the running application to stop. Force: allOf: - $ref: '#/components/schemas/BooleanObject' - description:

Set to true to force the application to stop. If you set Force to true, Kinesis Data Analytics stops the application without taking a snapshot.

Force-stopping your application may lead to data loss or duplication. To prevent data loss or duplicate processing of data during application restarts, we recommend you to take frequent snapshots of your application.

You can only force stop a Flink-based Kinesis Data Analytics application. You can't force stop a SQL-based Kinesis Data Analytics application.

The application must be in the STARTING, UPDATING, STOPPING, AUTOSCALING, or RUNNING status.

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. S3ReferenceDataSource: type: object properties: BucketARN: allOf: - $ref: '#/components/schemas/BucketARN' - description: The Amazon Resource Name (ARN) of the S3 bucket. FileKey: allOf: - $ref: '#/components/schemas/FileKey' - description: The object key name containing the reference data. description:

For a SQL-based 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.

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. StartApplicationResponse: type: object properties: {} ListApplicationSnapshotsRequest: type: object required: - ApplicationName title: ListApplicationSnapshotsRequest properties: ApplicationName: allOf: - $ref: '#/components/schemas/ApplicationName' - description: The name of an existing application. Limit: allOf: - $ref: '#/components/schemas/ListSnapshotsInputLimit' - description: The maximum number of application snapshots to list. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: '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. ' 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. ListSnapshotsInputLimit: type: integer minimum: 1 maximum: 50 VpcConfigurationUpdates: type: array items: $ref: '#/components/schemas/VpcConfigurationUpdate' 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. NextToken: type: string minLength: 1 maxLength: 512 InvalidArgumentException: {} ListApplicationsRequest: type: object title: ListApplicationsRequest properties: Limit: allOf: - $ref: '#/components/schemas/ListApplicationsInputLimit' - description: The maximum number of applications to list. NextToken: allOf: - $ref: '#/components/schemas/ApplicationName' - description: If a previous command returned a pagination token, pass it into this value to retrieve the next set of results. For more information about pagination, see Using the Amazon Command Line Interface's Pagination Options. CodeSize: type: integer minimum: 0 maximum: 52428800 KinesisStreamsInput: type: object required: - ResourceARN properties: ResourceARN: allOf: - $ref: '#/components/schemas/ResourceARN' - description: The ARN of the input Kinesis data stream to read. description: ' Identifies a Kinesis data stream as the streaming source. You provide the stream''s Amazon Resource Name (ARN).' 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. KinesisFirehoseInput: type: object required: - ResourceARN properties: ResourceARN: allOf: - $ref: '#/components/schemas/ResourceARN' - description: The Amazon Resource Name (ARN) of the delivery stream. description: For a SQL-based Kinesis Data Analytics application, identifies a Kinesis Data Firehose delivery stream as the streaming source. You provide the delivery stream's Amazon Resource Name (ARN). BasePath: type: string pattern: '[a-zA-Z0-9/!-_.*''()]+' minLength: 1 maxLength: 1024 TagKey: type: string minLength: 1 maxLength: 128 AddApplicationCloudWatchLoggingOptionRequest: type: object required: - ApplicationName - CloudWatchLoggingOption title: AddApplicationCloudWatchLoggingOptionRequest properties: ApplicationName: allOf: - $ref: '#/components/schemas/ApplicationName' - description: The Kinesis Data Analytics application name. CurrentApplicationVersionId: allOf: - $ref: '#/components/schemas/ApplicationVersionId' - description: The version ID of the Kinesis Data Analytics application. You must provide the CurrentApplicationVersionId or the ConditionalToken.You can retrieve the application version ID using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId. CloudWatchLoggingOption: allOf: - $ref: '#/components/schemas/CloudWatchLoggingOption' - description: 'Provides the Amazon CloudWatch log stream Amazon Resource Name (ARN). ' 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. OutputUpdates: type: array items: $ref: '#/components/schemas/OutputUpdate' LimitExceededException: {} 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. 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. 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. KinesisFirehoseOutput: type: object required: - ResourceARN properties: ResourceARN: allOf: - $ref: '#/components/schemas/ResourceARN' - description: The ARN of the destination delivery stream to write to. description: 'For a SQL-based Kinesis Data Analytics application, when configuring application output, identifies a Kinesis Data Firehose delivery stream as the destination. You provide the stream Amazon Resource Name (ARN) of the delivery stream. ' ArtifactType: type: string enum: - UDF - DEPENDENCY_JAR VpcConfiguration: type: object required: - SubnetIds - SecurityGroupIds properties: 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. SessionExpirationDurationInSeconds: type: integer minimum: 1800 maximum: 43200 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. ' SnapshotSummaries: type: array items: $ref: '#/components/schemas/SnapshotDetails' Parallelism: type: integer minimum: 1 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 DeleteApplicationResponse: type: object properties: {} CreateApplicationRequest: type: object required: - ApplicationName - RuntimeEnvironment - ServiceExecutionRole title: CreateApplicationRequest properties: ApplicationName: allOf: - $ref: '#/components/schemas/ApplicationName' - description: The name of your application (for example, sample-app). ApplicationDescription: allOf: - $ref: '#/components/schemas/ApplicationDescription' - description: A summary description of the application. RuntimeEnvironment: allOf: - $ref: '#/components/schemas/RuntimeEnvironment' - description: The runtime environment for the application. ServiceExecutionRole: allOf: - $ref: '#/components/schemas/RoleARN' - description: The IAM role used by the application to access Kinesis data streams, Kinesis Data Firehose delivery streams, Amazon S3 objects, and other external resources. ApplicationConfiguration: allOf: - $ref: '#/components/schemas/ApplicationConfiguration' - description: Use this parameter to configure the application. CloudWatchLoggingOptions: allOf: - $ref: '#/components/schemas/CloudWatchLoggingOptions' - description: 'Use this parameter to configure an Amazon CloudWatch log stream to monitor application configuration errors. ' Tags: allOf: - $ref: '#/components/schemas/Tags' - description: 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. ApplicationMode: allOf: - $ref: '#/components/schemas/ApplicationMode' - description: Use the STREAMING mode to create a Kinesis Data Analytics For Flink application. To create a Kinesis Data Analytics Studio notebook, use the INTERACTIVE mode. UpdateApplicationResponse: type: object required: - ApplicationDetail properties: ApplicationDetail: allOf: - $ref: '#/components/schemas/ApplicationDetail' - description: Describes application updates. DeleteApplicationReferenceDataSourceRequest: type: object required: - ApplicationName - CurrentApplicationVersionId - ReferenceId title: DeleteApplicationReferenceDataSourceRequest properties: ApplicationName: allOf: - $ref: '#/components/schemas/ApplicationName' - description: The name of an existing application. CurrentApplicationVersionId: allOf: - $ref: '#/components/schemas/ApplicationVersionId' - description: 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. ReferenceId: allOf: - $ref: '#/components/schemas/Id' - description: '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. ' SubnetId: type: string RecordColumnDelimiter: type: string minLength: 1 maxLength: 1024 DeleteApplicationRequest: type: object required: - ApplicationName - CreateTimestamp title: DeleteApplicationRequest properties: ApplicationName: allOf: - $ref: '#/components/schemas/ApplicationName' - description: The name of the application to delete. CreateTimestamp: allOf: - $ref: '#/components/schemas/Timestamp' - description: Use the DescribeApplication operation to get this value. ApplicationVersionId: type: integer minimum: 1 maximum: 999999999 AddApplicationVpcConfigurationResponse: type: object properties: ApplicationARN: allOf: - $ref: '#/components/schemas/ResourceARN' - description: The ARN 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. VpcConfigurationDescription: allOf: - $ref: '#/components/schemas/VpcConfigurationDescription' - description: The parameters of the new VPC configuration. InAppStreamNames: type: array items: $ref: '#/components/schemas/InAppStreamName' 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. 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. SnapshotName: type: string pattern: '[a-zA-Z0-9_.-]+' minLength: 1 maxLength: 256 ReferenceDataSourceDescriptions: type: array items: $ref: '#/components/schemas/ReferenceDataSourceDescription' CheckpointConfiguration: type: object required: - ConfigurationType properties: ConfigurationType: allOf: - $ref: '#/components/schemas/ConfigurationType' - description:

Describes whether the application uses Kinesis Data Analytics' default checkpointing behavior. You must set this property to CUSTOM in order to set the CheckpointingEnabled, CheckpointInterval, or MinPauseBetweenCheckpoints parameters.

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 a checkpoint operation takes longer than the CheckpointInterval, the application otherwise performs continual checkpoint operations. For more information, see Tuning Checkpointing in the Apache Flink Documentation.

If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this API or in application code.

 description: Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance in the Apache Flink Documentation. AddApplicationCloudWatchLoggingOptionResponse: type: object properties: ApplicationARN: allOf: - $ref: '#/components/schemas/ResourceARN' - description: The application's ARN. ApplicationVersionId: allOf: - $ref: '#/components/schemas/ApplicationVersionId' - description: 'The new version ID of the Kinesis Data Analytics application. Kinesis Data Analytics updates the ApplicationVersionId each time you change the CloudWatch logging options. ' CloudWatchLoggingOptionDescriptions: allOf: - $ref: '#/components/schemas/CloudWatchLoggingOptionDescriptions' - description: The descriptions of the current CloudWatch logging options for the Kinesis Data Analytics application. 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. 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"

' MavenArtifactId: type: string pattern: '[a-zA-Z0-9_.-]+' minLength: 1 maxLength: 256 DatabaseARN: type: string pattern: arn:.* minLength: 1 maxLength: 2048 KinesisStreamsOutput: type: object required: - ResourceARN properties: ResourceARN: allOf: - $ref: '#/components/schemas/ResourceARN' - description: The ARN of the destination Kinesis data stream to write to. description: 'When you configure a SQL-based Kinesis Data Analytics application''s output, identifies a Kinesis data stream as the destination. You provide the stream Amazon Resource Name (ARN). ' CustomArtifactsConfigurationDescriptionList: type: array items: $ref: '#/components/schemas/CustomArtifactConfigurationDescription' maxItems: 50 MonitoringConfiguration: type: object required: - ConfigurationType properties: ConfigurationType: allOf: - $ref: '#/components/schemas/ConfigurationType' - description: Describes whether to use the default CloudWatch logging configuration for an application. You must set this property to CUSTOM in order to set the LogLevel or MetricsLevel parameters. MetricsLevel: allOf: - $ref: '#/components/schemas/MetricsLevel' - description: Describes the granularity of the CloudWatch Logs for an application. The Parallelism level is not recommended for applications with a Parallelism over 64 due to excessive costs. LogLevel: allOf: - $ref: '#/components/schemas/LogLevel' - description: Describes the verbosity of the CloudWatch Logs for an application. description: Describes configuration parameters for Amazon CloudWatch logging for an application. For more information about CloudWatch logging, see Monitoring. ListApplicationsInputLimit: type: integer minimum: 1 maximum: 50 CodeContent: type: object properties: TextContent: allOf: - $ref: '#/components/schemas/TextContent' - description: The text-format code for a Flink-based Kinesis Data Analytics application. ZipFileContent: allOf: - $ref: '#/components/schemas/ZipFileContent' - description: The zip-format code for a Flink-based Kinesis Data Analytics application. S3ContentLocation: allOf: - $ref: '#/components/schemas/S3ContentLocation' - description: Information about the Amazon S3 bucket that contains the application code. description: 'Specifies either the application code, or the location of the application code, for a Flink-based Kinesis Data Analytics application. ' InputStartingPosition: type: string enum: - NOW - TRIM_HORIZON - LAST_STOPPED_POINT 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. RoleARN: type: string pattern: arn:.* minLength: 1 maxLength: 2048 SnapshotDetails: type: object required: - SnapshotName - SnapshotStatus - ApplicationVersionId properties: SnapshotName: allOf: - $ref: '#/components/schemas/SnapshotName' - description: The identifier for the application snapshot. SnapshotStatus: allOf: - $ref: '#/components/schemas/SnapshotStatus' - description: The status of the application snapshot. ApplicationVersionId: allOf: - $ref: '#/components/schemas/ApplicationVersionId' - description: The current application version ID when the snapshot was created. SnapshotCreationTimestamp: allOf: - $ref: '#/components/schemas/Timestamp' - description: The timestamp of the application snapshot. description: Provides details about a snapshot of application state. 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. TagResourceResponse: type: object properties: {} 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. ' S3Configuration: type: object required: - BucketARN - FileKey properties: BucketARN: allOf: - $ref: '#/components/schemas/BucketARN' - description: The ARN of the S3 bucket that contains the data. FileKey: allOf: - $ref: '#/components/schemas/FileKey' - description: The name of the object that contains the data. description: For a SQL-based Kinesis Data Analytics application, provides a description of an Amazon S3 data source, including the Amazon Resource Name (ARN) of the S3 bucket and the name of the Amazon S3 object that contains the data. 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. SqlRunConfigurations: type: array items: $ref: '#/components/schemas/SqlRunConfiguration' Output: type: object required: - Name - DestinationSchema properties: Name: allOf: - $ref: '#/components/schemas/InAppStreamName' - description: The name of the in-application stream. KinesisStreamsOutput: allOf: - $ref: '#/components/schemas/KinesisStreamsOutput' - description: Identifies a Kinesis data stream as the destination. KinesisFirehoseOutput: allOf: - $ref: '#/components/schemas/KinesisFirehoseOutput' - description: Identifies a Kinesis Data Firehose delivery stream as the destination. LambdaOutput: allOf: - $ref: '#/components/schemas/LambdaOutput' - description: Identifies an Amazon Lambda function as the destination. DestinationSchema: allOf: - $ref: '#/components/schemas/DestinationSchema' - description: 'Describes the data format when records are written to the destination. ' description:

Describes a SQL-based Kinesis Data Analytics application's output configuration, in which you identify an in-application stream and a destination where you want the in-application stream data to be written. The destination can be a Kinesis data stream or a Kinesis Data Firehose delivery stream.

DeleteApplicationReferenceDataSourceResponse: type: object properties: ApplicationARN: allOf: - $ref: '#/components/schemas/ResourceARN' - description: The application Amazon Resource Name (ARN). ApplicationVersionId: allOf: - $ref: '#/components/schemas/ApplicationVersionId' - description: The updated version ID of the application. DescribeApplicationSnapshotRequest: type: object required: - ApplicationName - SnapshotName title: DescribeApplicationSnapshotRequest properties: ApplicationName: allOf: - $ref: '#/components/schemas/ApplicationName' - description: The name of an existing application. SnapshotName: allOf: - $ref: '#/components/schemas/SnapshotName' - description: The identifier of an application snapshot. You can retrieve this value using . RecordRowDelimiter: type: string minLength: 1 maxLength: 1024 InputDescriptions: type: array items: $ref: '#/components/schemas/InputDescription' CloudWatchLoggingOptions: type: array items: $ref: '#/components/schemas/CloudWatchLoggingOption' 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. ParallelismConfiguration: type: object required: - ConfigurationType properties: ConfigurationType: allOf: - $ref: '#/components/schemas/ConfigurationType' - description: Describes whether the application uses the default parallelism for the Kinesis Data Analytics service. You must set this property to CUSTOM in order to change your application's AutoScalingEnabled, Parallelism, or ParallelismPerKPU properties. Parallelism: 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, Kinesis Data Analytics increases the CurrentParallelism value in response to application load. The service can increase the CurrentParallelism value up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting. ParallelismPerKPU: 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. For more information about KPUs, see Amazon Kinesis Data Analytics Pricing. 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. For more information about parallelism, see Parallel Execution in the Apache Flink Documentation. 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. RecordColumnName: type: string pattern: '[^-\s<>&]*' minLength: 1 maxLength: 256 StopApplicationResponse: type: object properties: {} 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. 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). ' 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). RawInputRecord: type: string 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. ListApplicationSnapshotsResponse: type: object properties: SnapshotSummaries: allOf: - $ref: '#/components/schemas/SnapshotSummaries' - description: A collection of objects containing information about the application snapshots. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: The token for the next set of results, or null if there are no additional results. VpcConfigurationDescriptions: type: array items: $ref: '#/components/schemas/VpcConfigurationDescription' DeleteApplicationVpcConfigurationResponse: type: object properties: ApplicationARN: allOf: - $ref: '#/components/schemas/ResourceARN' - description: The ARN of the Kinesis Data Analytics application. ApplicationVersionId: allOf: - $ref: '#/components/schemas/ApplicationVersionId' - description: The updated version ID of the application. OutputDescriptions: type: array items: $ref: '#/components/schemas/OutputDescription' ApplicationRestoreType: type: string enum: - SKIP_RESTORE_FROM_SNAPSHOT - RESTORE_FROM_LATEST_SNAPSHOT - RESTORE_FROM_CUSTOM_SNAPSHOT SnapshotStatus: type: string enum: - CREATING - READY - DELETING - FAILED 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. RecordFormatType: type: string enum: - JSON - CSV CustomArtifactsConfigurationList: type: array items: $ref: '#/components/schemas/CustomArtifactConfiguration' maxItems: 50 CheckpointInterval: type: integer minimum: 1 SecurityGroupId: type: string AddApplicationOutputRequest: type: object required: - ApplicationName - CurrentApplicationVersionId - Output title: AddApplicationOutputRequest properties: ApplicationName: allOf: - $ref: '#/components/schemas/ApplicationName' - description: The name of the application to which you want to add the output configuration. CurrentApplicationVersionId: allOf: - $ref: '#/components/schemas/ApplicationVersionId' - description: '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. ' Output: allOf: - $ref: '#/components/schemas/Output' - description: An array of objects, each describing one output configuration. In the output configuration, you specify the name of an in-application stream, a destination (that is, a Kinesis data stream, a Kinesis Data Firehose delivery stream, or an Amazon Lambda function), and record the formation to use when writing to the destination. ConditionalToken: type: string pattern: '[a-zA-Z0-9-_+/=]+' minLength: 1 maxLength: 512 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. 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. 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. 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. ' parameters: X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 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