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.AddApplicationCloudWatchLoggingOption 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.AddApplicationCloudWatchLoggingOption'
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 Option
tags:
- '#X Amz Target=KinesisAnalytics 20180523.AddApplicationCloudWatchLoggingOption'
components:
schemas:
ResourceInUseException: {}
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.
ConditionalToken:
type: string
pattern: '[a-zA-Z0-9-_+/=]+'
minLength: 1
maxLength: 512
InvalidApplicationConfigurationException: {}
InvalidRequestException: {}
CloudWatchLoggingOptionDescriptions:
type: array
items:
$ref: '#/components/schemas/CloudWatchLoggingOptionDescription'
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.
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.
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