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

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

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

description: Describes the starting parameters for a Flink-based Kinesis Data Analytics application. 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. SqlRunConfigurations: type: array items: $ref: '#/components/schemas/SqlRunConfiguration' StartApplicationResponse: type: object properties: {} 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. ApplicationRestoreType: type: string enum: - SKIP_RESTORE_FROM_SNAPSHOT - RESTORE_FROM_LATEST_SNAPSHOT - RESTORE_FROM_CUSTOM_SNAPSHOT SnapshotName: type: string pattern: '[a-zA-Z0-9_.-]+' minLength: 1 maxLength: 256 InvalidArgumentException: {} InputStartingPosition: type: string enum: - NOW - TRIM_HORIZON - LAST_STOPPED_POINT ApplicationName: type: string pattern: '[a-zA-Z0-9_.-]+' minLength: 1 maxLength: 128 ResourceNotFoundException: {} parameters: X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders 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