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.CreateApplication' paths: /#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 tags: - '#X Amz Target=KinesisAnalytics 20180523.CreateApplication' components: schemas: 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.
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: 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 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.
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.
MavenArtifactId:
type: string
pattern: '[a-zA-Z0-9_.-]+'
minLength: 1
maxLength: 256
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.
VpcId:
type: string
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. '
ConditionalToken:
type: string
pattern: '[a-zA-Z0-9-_+/=]+'
minLength: 1
maxLength: 512
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).'
CodeValidationException: {}
RecordFormatType:
type: string
enum:
- JSON
- CSV
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.
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.
InvalidRequestException: {}
ArtifactType:
type: string
enum:
- UDF
- DEPENDENCY_JAR
ParallelismPerKPU:
type: integer
minimum: 1
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
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.
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. '
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.
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.
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.
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.
CustomArtifactsConfigurationDescriptionList:
type: array
items:
$ref: '#/components/schemas/CustomArtifactConfigurationDescription'
maxItems: 50
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
Outputs:
type: array
items:
$ref: '#/components/schemas/Output'
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.
InputStartingPositionConfiguration:
type: object
properties:
InputStartingPosition:
allOf:
- $ref: '#/components/schemas/InputStartingPosition'
- description: 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.
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. ' FileKey: type: string minLength: 1 maxLength: 1024 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. 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.
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.
Timestamp:
type: string
format: date-time
TagValue:
type: string
minLength: 0
maxLength: 256
ApplicationMaintenanceWindowEndTime:
type: string
pattern: ([01][0-9]|2[0-3]):[0-5][0-9]
minLength: 5
maxLength: 5
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.
TagKey: type: string minLength: 1 maxLength: 128 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. 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' 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. 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. 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 toCUSTOM 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.
SubnetId:
type: string
DatabaseARN:
type: string
pattern: arn:.*
minLength: 1
maxLength: 2048
SecurityGroupId:
type: string
PropertyValue:
type: string
minLength: 1
maxLength: 2048
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.
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.
UnsupportedOperationException: {}
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
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.
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.
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.
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.
LogStreamARN:
type: string
pattern: arn:.*
minLength: 1
maxLength: 2048
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.
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. '
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.
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
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.
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).
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.
SubnetIds:
type: array
items:
$ref: '#/components/schemas/SubnetId'
minItems: 1
maxItems: 16
ApplicationRestoreType:
type: string
enum:
- SKIP_RESTORE_FROM_SNAPSHOT
- RESTORE_FROM_LATEST_SNAPSHOT
- RESTORE_FROM_CUSTOM_SNAPSHOT
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.
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
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
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.
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.
BooleanObject: type: boolean CustomArtifactsConfigurationList: type: array items: $ref: '#/components/schemas/CustomArtifactConfiguration' maxItems: 50 VpcConfigurations: type: array items: $ref: '#/components/schemas/VpcConfiguration' 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. LimitExceededException: {} 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.
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. 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. 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. ' 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 ofRecordColumn 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'
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.
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
minItems: 1
maxItems: 200
InputParallelismCount:
type: integer
minimum: 1
maximum: 64
TooManyTagsException: {}
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"