openapi: 3.0.0
info:
version: 2015-08-04
x-release: v4
title: 'Amazon Kinesis Firehose CreateSignalingChannel #X Amz Target=KinesisAnalytics 20180523.UpdateApplication API'
description:
Amazon Kinesis Data Firehose is a fully managed service that delivers real-time streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon OpenSearch Service, Amazon Redshift, Splunk, and various other supportd destinations.
x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png 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: firehose x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/firehose-2015-08-04.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://firehose.{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 Firehose multi-region endpoint - url: https://firehose.{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 Firehose multi-region endpoint - url: http://firehose.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Firehose endpoint for China (Beijing) and China (Ningxia) - url: https://firehose.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Firehose endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: '#X Amz Target=KinesisAnalytics 20180523.UpdateApplication' paths: /#X-Amz-Target=KinesisAnalytics_20180523.UpdateApplication: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: UpdateApplication description:Updates an existing Kinesis Data Analytics application. Using this operation, you can update application code, input configuration, and output configuration.
Kinesis Data Analytics updates the ApplicationVersionId each time you update your application.
You cannot update the RuntimeEnvironment of an existing application. If you need to update an application's RuntimeEnvironment, you must delete the application and create it again.
OutputId. '
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: true
CheckpointInterval: 60000
MinPauseBetweenCheckpoints: 5000
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.
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.
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.
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.
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.
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.
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. '
MavenArtifactId:
type: string
pattern: '[a-zA-Z0-9_.-]+'
minLength: 1
maxLength: 256
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.
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.
VpcId:
type: string
ConditionalToken:
type: string
pattern: '[a-zA-Z0-9-_+/=]+'
minLength: 1
maxLength: 512
CodeValidationException: {}
RecordFormatType:
type: string
enum:
- JSON
- CSV
InvalidRequestException: {}
ParallelismPerKPU:
type: integer
minimum: 1
ArtifactType:
type: string
enum:
- UDF
- DEPENDENCY_JAR
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.
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.
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.
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.
CheckpointInterval:
type: integer
minimum: 1
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.
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
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.
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.
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. '
ResourceARN:
type: string
pattern: arn:.*
minLength: 1
maxLength: 2048
TextContent:
type: string
minLength: 0
maxLength: 102400
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.
InvalidApplicationConfigurationException: {}
CustomArtifactsConfigurationDescriptionList:
type: array
items:
$ref: '#/components/schemas/CustomArtifactConfigurationDescription'
maxItems: 50
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.
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. '
ConcurrentModificationException: {}
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.
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.
SnapshotName:
type: string
pattern: '[a-zA-Z0-9_.-]+'
minLength: 1
maxLength: 256
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.
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
The starting position on the stream.
NOW - Start reading just after the most recent record in the stream, and start at the request timestamp that the customer issued.
TRIM_HORIZON - Start reading at the last untrimmed record in the stream, which is the oldest record available in the stream. This option is not available for an Amazon Kinesis Data Firehose delivery stream.
LAST_STOPPED_POINT - Resume reading from where the application last stopped reading.
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.
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.
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.
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.
ApplicationMaintenanceWindowEndTime: type: string pattern: ([01][0-9]|2[0-3]):[0-5][0-9] minLength: 5 maxLength: 5 CodeContentType: type: string enum: - PLAINTEXT - ZIPFILE 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. VpcConfigurationDescriptions: type: array items: $ref: '#/components/schemas/VpcConfigurationDescription' 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. 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:
CheckpointingEnabled: true
CheckpointInterval: 60000
MinPauseBetweenCheckpoints: 5000
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.
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.
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.
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.
ApplicationMaintenanceWindowStartTime:
type: string
pattern: ([01][0-9]|2[0-3]):[0-5][0-9]
minLength: 5
maxLength: 5
ObjectVersion:
type: string
minLength: 0
maxLength: 1024
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.
RoleARN:
type: string
pattern: arn:.*
minLength: 1
maxLength: 2048
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.
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.
ApplicationStatus:
type: string
enum:
- DELETING
- STARTING
- STOPPING
- READY
- RUNNING
- UPDATING
- AUTOSCALING
- FORCE_STOPPING
- ROLLING_BACK
- MAINTENANCE
- ROLLED_BACK
RecordColumnMapping:
type: string
minLength: 0
maxLength: 65535
InAppStreamNames:
type: array
items:
$ref: '#/components/schemas/InAppStreamName'
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.
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
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.
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.
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.
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.
CodeSize:
type: integer
minimum: 0
maximum: 52428800
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.
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). '
CloudWatchLoggingOptionDescriptions:
type: array
items:
$ref: '#/components/schemas/CloudWatchLoggingOptionDescription'
RecordColumnSqlType:
type: string
minLength: 1
maxLength: 100
CodeMD5:
type: string
minLength: 128
maxLength: 128
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.
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.
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.
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.
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.
SubnetIds:
type: array
items:
$ref: '#/components/schemas/SubnetId'
minItems: 1
maxItems: 16
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.
ApplicationRestoreType:
type: string
enum:
- SKIP_RESTORE_FROM_SNAPSHOT
- RESTORE_FROM_LATEST_SNAPSHOT
- RESTORE_FROM_CUSTOM_SNAPSHOT
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.
BucketARN:
type: string
pattern: arn:.*
minLength: 1
maxLength: 2048
MavenGroupId:
type: string
pattern: '[a-zA-Z0-9_.-]+'
minLength: 1
maxLength: 256
RecordColumnDelimiter:
type: string
minLength: 1
maxLength: 1024
MetricsLevel:
type: string
enum:
- APPLICATION
- TASK
- OPERATOR
- PARALLELISM
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.
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.
ApplicationDescription:
type: string
minLength: 0
maxLength: 1024
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.
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. '
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).
ReferenceDataSourceDescriptions:
type: array
items:
$ref: '#/components/schemas/ReferenceDataSourceDescription'
InputParallelismCount:
type: integer
minimum: 1
maximum: 64
InAppStreamName:
type: string
pattern: '[^-\s<>&]*'
minLength: 1
maxLength: 32
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.
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"