create-application¶

Description¶

Creates a Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see Creating an Application .

Synopsis¶

  create-application
--application-name <value>
[--application-description <value>]
--runtime-environment <value>
--service-execution-role <value>
[--application-configuration <value>]
[--cloud-watch-logging-options <value>]
[--tags <value>]
[--application-mode <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--application-name (string)

The name of your application (for example, sample-app ).

--application-description (string)

A summary description of the application.

--runtime-environment (string)

The runtime environment for the application (SQL-1_0 , FLINK-1_6 , FLINK-1_8 , or FLINK-1_11 ).

Possible values:

SQL-1_0

FLINK-1_6

FLINK-1_8

ZEPPELIN-FLINK-1_0

FLINK-1_11

FLINK-1_13

ZEPPELIN-FLINK-2_0

--service-execution-role (string)

The IAM role used by the application to access Kinesis data streams, Kinesis Data Firehose delivery streams, Amazon S3 objects, and other external resources.

--application-configuration (structure)

Use this parameter to configure the application.

SqlApplicationConfiguration -> (structure)

The creation and update parameters for a SQL-based Kinesis Data Analytics application.

Inputs -> (list)

The array of Input objects describing the input streams used by the application.

(structure)

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.

NamePrefix -> (string)

The name prefix to use when creating an in-application stream. Suppose that you specify a prefix “MyInApplicationStream .” Kinesis Data Analytics then creates one or more (as per the InputParallelism count you specified) in-application streams with the names “MyInApplicationStream_001 ,” “MyInApplicationStream_002 ,” and so on.

InputProcessingConfiguration -> (structure)

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 .

InputLambdaProcessor -> (structure)

The InputLambdaProcessor that is used to preprocess the records in the stream before being processed by your application code.

ResourceARN -> (string)

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

Note

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

KinesisStreamsInput -> (structure)

If the streaming source is an Amazon Kinesis data stream, identifies the stream’s Amazon Resource Name (ARN).

ResourceARN -> (string)

The ARN of the input Kinesis data stream to read.

KinesisFirehoseInput -> (structure)

If the streaming source is an Amazon Kinesis Data Firehose delivery stream, identifies the delivery stream’s ARN.

ResourceARN -> (string)

The Amazon Resource Name (ARN) of the delivery stream.

InputParallelism -> (structure)

Describes the number of in-application streams to create.

Count -> (integer)

The number of in-application streams to create.

InputSchema -> (structure)

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.

RecordFormat -> (structure)

Specifies the format of the records on the streaming source.

RecordFormatType -> (string)

The type of record format.

MappingParameters -> (structure)

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.

JSONMappingParameters -> (structure)

Provides additional mapping information when JSON is the record format on the streaming source.

RecordRowPath -> (string)

The path to the top-level parent that contains the records.

CSVMappingParameters -> (structure)

Provides additional mapping information when the record format uses delimiters (for example, CSV).

RecordRowDelimiter -> (string)

The row delimiter. For example, in a CSV format, ‘n’ is the typical row delimiter.

RecordColumnDelimiter -> (string)

The column delimiter. For example, in a CSV format, a comma (“,”) is the typical column delimiter.

RecordEncoding -> (string)

Specifies the encoding of the records in the streaming source. For example, UTF-8.

RecordColumns -> (list)

A list of RecordColumn objects.

(structure)

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.

Name -> (string)

The name of the column that is created in the in-application input stream or reference table.

Mapping -> (string)

A reference to the data element in the streaming input or the reference data source.

SqlType -> (string)

The type of column created in the in-application input stream or reference table.

Outputs -> (list)

The array of Output objects describing the destination streams used by the application.

(structure)

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.

Name -> (string)

The name of the in-application stream.

KinesisStreamsOutput -> (structure)

Identifies a Kinesis data stream as the destination.

ResourceARN -> (string)

The ARN of the destination Kinesis data stream to write to.

KinesisFirehoseOutput -> (structure)

Identifies a Kinesis Data Firehose delivery stream as the destination.

ResourceARN -> (string)

The ARN of the destination delivery stream to write to.

LambdaOutput -> (structure)

Identifies an Amazon Lambda function as the destination.

ResourceARN -> (string)

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

Note

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

DestinationSchema -> (structure)

Describes the data format when records are written to the destination.

RecordFormatType -> (string)

Specifies the format of the records on the output stream.

ReferenceDataSources -> (list)

The array of ReferenceDataSource objects describing the reference data sources used by the application.

(structure)

For a SQL-based Kinesis Data Analytics application, describes the reference data source by providing the source information (Amazon S3 bucket name and object key name), the resulting in-application table name that is created, and the necessary schema to map the data elements in the Amazon S3 object to the in-application table.

TableName -> (string)

The name of the in-application table to create.

S3ReferenceDataSource -> (structure)

Identifies the S3 bucket and object that contains the reference data. A Kinesis Data Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application.

BucketARN -> (string)

The Amazon Resource Name (ARN) of the S3 bucket.

FileKey -> (string)

The object key name containing the reference data.

ReferenceSchema -> (structure)

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.

RecordFormat -> (structure)

Specifies the format of the records on the streaming source.

RecordFormatType -> (string)

The type of record format.

MappingParameters -> (structure)

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.

JSONMappingParameters -> (structure)

Provides additional mapping information when JSON is the record format on the streaming source.

RecordRowPath -> (string)

The path to the top-level parent that contains the records.

CSVMappingParameters -> (structure)

Provides additional mapping information when the record format uses delimiters (for example, CSV).

RecordRowDelimiter -> (string)

The row delimiter. For example, in a CSV format, ‘n’ is the typical row delimiter.

RecordColumnDelimiter -> (string)

The column delimiter. For example, in a CSV format, a comma (“,”) is the typical column delimiter.

RecordEncoding -> (string)

Specifies the encoding of the records in the streaming source. For example, UTF-8.

RecordColumns -> (list)

A list of RecordColumn objects.

(structure)

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.

Name -> (string)

The name of the column that is created in the in-application input stream or reference table.

Mapping -> (string)

A reference to the data element in the streaming input or the reference data source.

SqlType -> (string)

The type of column created in the in-application input stream or reference table.

FlinkApplicationConfiguration -> (structure)

The creation and update parameters for a Flink-based Kinesis Data Analytics application.

CheckpointConfiguration -> (structure)

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 .

ConfigurationType -> (string)

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.

Note

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

CheckpointingEnabled -> (boolean)

Describes whether checkpointing is enabled for a Flink-based Kinesis Data Analytics application.

Note

If CheckpointConfiguration.ConfigurationType is DEFAULT , the application will use a CheckpointingEnabled value of true , even if this value is set to another value using this API or in application code.

CheckpointInterval -> (long)

Describes the interval in milliseconds between checkpoint operations.

Note

If CheckpointConfiguration.ConfigurationType is DEFAULT , the application will use a CheckpointInterval value of 60000, even if this value is set to another value using this API or in application code.

MinPauseBetweenCheckpoints -> (long)

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 .

Note

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.

MonitoringConfiguration -> (structure)

Describes configuration parameters for Amazon CloudWatch logging for an application.

ConfigurationType -> (string)

Describes whether to use the default CloudWatch logging configuration for an application. You must set this property to CUSTOM in order to set the LogLevel or MetricsLevel parameters.

MetricsLevel -> (string)

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 -> (string)

Describes the verbosity of the CloudWatch Logs for an application.

ParallelismConfiguration -> (structure)

Describes parameters for how an application executes multiple tasks simultaneously.

ConfigurationType -> (string)

Describes whether the application uses the default parallelism for the Kinesis Data Analytics service. You must set this property to CUSTOM in order to change your application’s AutoScalingEnabled , Parallelism , or ParallelismPerKPU properties.

Parallelism -> (integer)

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 -> (integer)

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 -> (boolean)

Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.

EnvironmentProperties -> (structure)

Describes execution properties for a Flink-based Kinesis Data Analytics application.

PropertyGroups -> (list)

Describes the execution property groups.

(structure)

Property key-value pairs passed into an application.

PropertyGroupId -> (string)

Describes the key of an application execution property key-value pair.

PropertyMap -> (map)

Describes the value of an application execution property key-value pair.

key -> (string)

value -> (string)

ApplicationCodeConfiguration -> (structure)

The code location and type parameters for a Flink-based Kinesis Data Analytics application.

CodeContent -> (structure)

The location and type of the application code.

TextContent -> (string)

The text-format code for a Flink-based Kinesis Data Analytics application.

ZipFileContent -> (blob)

The zip-format code for a Flink-based Kinesis Data Analytics application.

S3ContentLocation -> (structure)

Information about the Amazon S3 bucket that contains the application code.

BucketARN -> (string)

The Amazon Resource Name (ARN) for the S3 bucket containing the application code.

FileKey -> (string)

The file key for the object containing the application code.

ObjectVersion -> (string)

The version of the object containing the application code.

CodeContentType -> (string)

Specifies whether the code content is in text or zip format.

ApplicationSnapshotConfiguration -> (structure)

Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

SnapshotsEnabled -> (boolean)

Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

VpcConfigurations -> (list)

The array of descriptions of VPC configurations available to the application.

(structure)

Describes the parameters of a VPC used by the application.

SubnetIds -> (list)

The array of Subnet IDs used by the VPC configuration.

(string)

SecurityGroupIds -> (list)

The array of SecurityGroup IDs used by the VPC configuration.

(string)

ZeppelinApplicationConfiguration -> (structure)

The configuration parameters for a Kinesis Data Analytics Studio notebook.

MonitoringConfiguration -> (structure)

The monitoring configuration of a Kinesis Data Analytics Studio notebook.

LogLevel -> (string)

The verbosity of the CloudWatch Logs for an application.

CatalogConfiguration -> (structure)

The Amazon Glue Data Catalog that you use in queries in a Kinesis Data Analytics Studio notebook.

GlueDataCatalogConfiguration -> (structure)

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.

DatabaseARN -> (string)

The Amazon Resource Name (ARN) of the database.

DeployAsApplicationConfiguration -> (structure)

The information required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state.

S3ContentLocation -> (structure)

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.

BucketARN -> (string)

The Amazon Resource Name (ARN) of the S3 bucket.

BasePath -> (string)

The base path for the S3 bucket.

CustomArtifactsConfiguration -> (list)

Custom artifacts are dependency JARs and user-defined functions (UDF).

(structure)

Specifies dependency JARs, as well as JAR files that contain user-defined functions (UDF).

ArtifactType -> (string)

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 -> (structure)

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.

BucketARN -> (string)

The Amazon Resource Name (ARN) for the S3 bucket containing the application code.

FileKey -> (string)

The file key for the object containing the application code.

ObjectVersion -> (string)

The version of the object containing the application code.

MavenReference -> (structure)

The parameters required to fully specify a Maven reference.

GroupId -> (string)

The group ID of the Maven reference.

ArtifactId -> (string)

The artifact ID of the Maven reference.

Version -> (string)

The version of the Maven reference.

JSON Syntax:

{
  "SqlApplicationConfiguration": {
    "Inputs": [
      {
        "NamePrefix": "string",
        "InputProcessingConfiguration": {
          "InputLambdaProcessor": {
            "ResourceARN": "string"
          }
        },
        "KinesisStreamsInput": {
          "ResourceARN": "string"
        },
        "KinesisFirehoseInput": {
          "ResourceARN": "string"
        },
        "InputParallelism": {
          "Count": integer
        },
        "InputSchema": {
          "RecordFormat": {
            "RecordFormatType": "JSON"|"CSV",
            "MappingParameters": {
              "JSONMappingParameters": {
                "RecordRowPath": "string"
              },
              "CSVMappingParameters": {
                "RecordRowDelimiter": "string",
                "RecordColumnDelimiter": "string"
              }
            }
          },
          "RecordEncoding": "string",
          "RecordColumns": [
            {
              "Name": "string",
              "Mapping": "string",
              "SqlType": "string"
            }
            ...
          ]
        }
      }
      ...
    ],
    "Outputs": [
      {
        "Name": "string",
        "KinesisStreamsOutput": {
          "ResourceARN": "string"
        },
        "KinesisFirehoseOutput": {
          "ResourceARN": "string"
        },
        "LambdaOutput": {
          "ResourceARN": "string"
        },
        "DestinationSchema": {
          "RecordFormatType": "JSON"|"CSV"
        }
      }
      ...
    ],
    "ReferenceDataSources": [
      {
        "TableName": "string",
        "S3ReferenceDataSource": {
          "BucketARN": "string",
          "FileKey": "string"
        },
        "ReferenceSchema": {
          "RecordFormat": {
            "RecordFormatType": "JSON"|"CSV",
            "MappingParameters": {
              "JSONMappingParameters": {
                "RecordRowPath": "string"
              },
              "CSVMappingParameters": {
                "RecordRowDelimiter": "string",
                "RecordColumnDelimiter": "string"
              }
            }
          },
          "RecordEncoding": "string",
          "RecordColumns": [
            {
              "Name": "string",
              "Mapping": "string",
              "SqlType": "string"
            }
            ...
          ]
        }
      }
      ...
    ]
  },
  "FlinkApplicationConfiguration": {
    "CheckpointConfiguration": {
      "ConfigurationType": "DEFAULT"|"CUSTOM",
      "CheckpointingEnabled": true|false,
      "CheckpointInterval": long,
      "MinPauseBetweenCheckpoints": long
    },
    "MonitoringConfiguration": {
      "ConfigurationType": "DEFAULT"|"CUSTOM",
      "MetricsLevel": "APPLICATION"|"TASK"|"OPERATOR"|"PARALLELISM",
      "LogLevel": "INFO"|"WARN"|"ERROR"|"DEBUG"
    },
    "ParallelismConfiguration": {
      "ConfigurationType": "DEFAULT"|"CUSTOM",
      "Parallelism": integer,
      "ParallelismPerKPU": integer,
      "AutoScalingEnabled": true|false
    }
  },
  "EnvironmentProperties": {
    "PropertyGroups": [
      {
        "PropertyGroupId": "string",
        "PropertyMap": {"string": "string"
          ...}
      }
      ...
    ]
  },
  "ApplicationCodeConfiguration": {
    "CodeContent": {
      "TextContent": "string",
      "ZipFileContent": blob,
      "S3ContentLocation": {
        "BucketARN": "string",
        "FileKey": "string",
        "ObjectVersion": "string"
      }
    },
    "CodeContentType": "PLAINTEXT"|"ZIPFILE"
  },
  "ApplicationSnapshotConfiguration": {
    "SnapshotsEnabled": true|false
  },
  "VpcConfigurations": [
    {
      "SubnetIds": ["string", ...],
      "SecurityGroupIds": ["string", ...]
    }
    ...
  ],
  "ZeppelinApplicationConfiguration": {
    "MonitoringConfiguration": {
      "LogLevel": "INFO"|"WARN"|"ERROR"|"DEBUG"
    },
    "CatalogConfiguration": {
      "GlueDataCatalogConfiguration": {
        "DatabaseARN": "string"
      }
    },
    "DeployAsApplicationConfiguration": {
      "S3ContentLocation": {
        "BucketARN": "string",
        "BasePath": "string"
      }
    },
    "CustomArtifactsConfiguration": [
      {
        "ArtifactType": "UDF"|"DEPENDENCY_JAR",
        "S3ContentLocation": {
          "BucketARN": "string",
          "FileKey": "string",
          "ObjectVersion": "string"
        },
        "MavenReference": {
          "GroupId": "string",
          "ArtifactId": "string",
          "Version": "string"
        }
      }
      ...
    ]
  }
}

--cloud-watch-logging-options (list)

Use this parameter to configure an Amazon CloudWatch log stream to monitor application configuration errors.

(structure)

Provides a description of Amazon CloudWatch logging options, including the log stream Amazon Resource Name (ARN).

LogStreamARN -> (string)

The ARN of the CloudWatch log to receive application messages.

Shorthand Syntax:

LogStreamARN=string ...

JSON Syntax:

[
  {
    "LogStreamARN": "string"
  }
  ...
]

--tags (list)

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 .

(structure)

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 .

Key -> (string)

The key of the key-value tag.

Value -> (string)

The value of the key-value tag. The value is optional.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--application-mode (string)

Use the STREAMING mode to create a Kinesis Data Analytics Studio notebook. To create a Kinesis Data Analytics Studio notebook, use the INTERACTIVE mode.

Possible values:

STREAMING

INTERACTIVE

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output¶

ApplicationDetail -> (structure)

In response to your CreateApplication request, Kinesis Data Analytics returns a response with details of the application it created.

ApplicationARN -> (string)

The ARN of the application.

ApplicationDescription -> (string)

The description of the application.

ApplicationName -> (string)

The name of the application.

RuntimeEnvironment -> (string)

The runtime environment for the application (SQL-1_0 , FLINK-1_6 , FLINK-1_8 , or FLINK-1_11 ).

ServiceExecutionRole -> (string)

Specifies the IAM role that the application uses to access external resources.

ApplicationStatus -> (string)

The status of the application.

ApplicationVersionId -> (long)

Provides the current application version. Kinesis Data Analytics updates the ApplicationVersionId each time you update the application.

CreateTimestamp -> (timestamp)

The current timestamp when the application was created.

LastUpdateTimestamp -> (timestamp)

The current timestamp when the application was last updated.

ApplicationConfigurationDescription -> (structure)

Describes details about the application code and starting parameters for a Kinesis Data Analytics application.

SqlApplicationConfigurationDescription -> (structure)

The details about inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.

InputDescriptions -> (list)

The array of InputDescription objects describing the input streams used by the application.

(structure)

Describes the application input configuration for a SQL-based Kinesis Data Analytics application.

InputId -> (string)

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 -> (string)

The in-application name prefix.

InAppStreamNames -> (list)

Returns the in-application stream names that are mapped to the stream source.

(string)

InputProcessingConfigurationDescription -> (structure)

The description of the preprocessor that executes on records in this input before the application’s code is run.

InputLambdaProcessorDescription -> (structure)

Provides configuration information about the associated InputLambdaProcessorDescription

ResourceARN -> (string)

The ARN of the Amazon Lambda function that is used to preprocess the records in the stream.

Note

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

RoleARN -> (string)

The ARN of the IAM role that is used to access the Amazon Lambda function.

Note

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.

KinesisStreamsInputDescription -> (structure)

If a Kinesis data stream is configured as a streaming source, provides the Kinesis data stream’s Amazon Resource Name (ARN).

ResourceARN -> (string)

The Amazon Resource Name (ARN) of the Kinesis data stream.

RoleARN -> (string)

The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.

Note

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.

KinesisFirehoseInputDescription -> (structure)

If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream’s ARN.

ResourceARN -> (string)

The Amazon Resource Name (ARN) of the delivery stream.

RoleARN -> (string)

The ARN of the IAM role that Kinesis Data Analytics assumes to access the stream.

Note

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.

InputSchema -> (structure)

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.

RecordFormat -> (structure)

Specifies the format of the records on the streaming source.

RecordFormatType -> (string)

The type of record format.

MappingParameters -> (structure)

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.

JSONMappingParameters -> (structure)

Provides additional mapping information when JSON is the record format on the streaming source.

RecordRowPath -> (string)

The path to the top-level parent that contains the records.

CSVMappingParameters -> (structure)

Provides additional mapping information when the record format uses delimiters (for example, CSV).

RecordRowDelimiter -> (string)

The row delimiter. For example, in a CSV format, ‘n’ is the typical row delimiter.

RecordColumnDelimiter -> (string)

The column delimiter. For example, in a CSV format, a comma (“,”) is the typical column delimiter.

RecordEncoding -> (string)

Specifies the encoding of the records in the streaming source. For example, UTF-8.

RecordColumns -> (list)

A list of RecordColumn objects.

(structure)

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.

Name -> (string)

The name of the column that is created in the in-application input stream or reference table.

Mapping -> (string)

A reference to the data element in the streaming input or the reference data source.

SqlType -> (string)

The type of column created in the in-application input stream or reference table.

InputParallelism -> (structure)

Describes the configured parallelism (number of in-application streams mapped to the streaming source).

Count -> (integer)

The number of in-application streams to create.

InputStartingPositionConfiguration -> (structure)

The point at which the application is configured to read from the input stream.

InputStartingPosition -> (string)

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.

OutputDescriptions -> (list)

The array of OutputDescription objects describing the destination streams used by the application.

(structure)

For a SQL-based Kinesis Data Analytics application, describes the application output configuration, which includes the in-application stream name and the destination where the stream data is written. The destination can be a Kinesis data stream or a Kinesis Data Firehose delivery stream.

OutputId -> (string)

A unique identifier for the output configuration.

Name -> (string)

The name of the in-application stream that is configured as output.

KinesisStreamsOutputDescription -> (structure)

Describes the Kinesis data stream that is configured as the destination where output is written.

ResourceARN -> (string)

The Amazon Resource Name (ARN) of the Kinesis data stream.

RoleARN -> (string)

The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.

Note

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.

KinesisFirehoseOutputDescription -> (structure)

Describes the Kinesis Data Firehose delivery stream that is configured as the destination where output is written.

ResourceARN -> (string)

The Amazon Resource Name (ARN) of the delivery stream.

RoleARN -> (string)

The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.

Note

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.

LambdaOutputDescription -> (structure)

Describes the Lambda function that is configured as the destination where output is written.

ResourceARN -> (string)

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

RoleARN -> (string)

The ARN of the IAM role that Kinesis Data Analytics can assume to write to the destination function.

Note

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.

DestinationSchema -> (structure)

The data format used for writing data to the destination.

RecordFormatType -> (string)

Specifies the format of the records on the output stream.

ReferenceDataSourceDescriptions -> (list)

The array of ReferenceDataSourceDescription objects describing the reference data sources used by the application.

(structure)

For a SQL-based Kinesis Data Analytics application, describes the reference data source configured for an application.

ReferenceId -> (string)

The ID of the reference data source. This is the ID that Kinesis Data Analytics assigns when you add the reference data source to your application using the CreateApplication or UpdateApplication operation.

TableName -> (string)

The in-application table name created by the specific reference data source configuration.

S3ReferenceDataSourceDescription -> (structure)

Provides the Amazon S3 bucket name, the object key name that contains the reference data.

BucketARN -> (string)

The Amazon Resource Name (ARN) of the S3 bucket.

FileKey -> (string)

Amazon S3 object key name.

ReferenceRoleARN -> (string)

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.

Note

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.

ReferenceSchema -> (structure)

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.

RecordFormat -> (structure)

Specifies the format of the records on the streaming source.

RecordFormatType -> (string)

The type of record format.

MappingParameters -> (structure)

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.

JSONMappingParameters -> (structure)

Provides additional mapping information when JSON is the record format on the streaming source.

RecordRowPath -> (string)

The path to the top-level parent that contains the records.

CSVMappingParameters -> (structure)

Provides additional mapping information when the record format uses delimiters (for example, CSV).

RecordRowDelimiter -> (string)

The row delimiter. For example, in a CSV format, ‘n’ is the typical row delimiter.

RecordColumnDelimiter -> (string)

The column delimiter. For example, in a CSV format, a comma (“,”) is the typical column delimiter.

RecordEncoding -> (string)

Specifies the encoding of the records in the streaming source. For example, UTF-8.

RecordColumns -> (list)

A list of RecordColumn objects.

(structure)

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.

Name -> (string)

The name of the column that is created in the in-application input stream or reference table.

Mapping -> (string)

A reference to the data element in the streaming input or the reference data source.

SqlType -> (string)

The type of column created in the in-application input stream or reference table.

ApplicationCodeConfigurationDescription -> (structure)

The details about the application code for a Flink-based Kinesis Data Analytics application.

CodeContentType -> (string)

Specifies whether the code content is in text or zip format.

CodeContentDescription -> (structure)

Describes details about the location and format of the application code.

TextContent -> (string)

The text-format code

CodeMD5 -> (string)

The checksum that can be used to validate zip-format code.

CodeSize -> (long)

The size in bytes of the application code. Can be used to validate zip-format code.

S3ApplicationCodeLocationDescription -> (structure)

The S3 bucket Amazon Resource Name (ARN), file key, and object version of the application code stored in Amazon S3.

BucketARN -> (string)

The Amazon Resource Name (ARN) for the S3 bucket containing the application code.

FileKey -> (string)

The file key for the object containing the application code.

ObjectVersion -> (string)

The version of the object containing the application code.

RunConfigurationDescription -> (structure)

The details about the starting properties for a Kinesis Data Analytics application.

ApplicationRestoreConfigurationDescription -> (structure)

Describes the restore behavior of a restarting application.

ApplicationRestoreType -> (string)

Specifies how the application should be restored.

SnapshotName -> (string)

The identifier of an existing snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType .

FlinkRunConfigurationDescription -> (structure)

Describes the starting parameters for a Flink-based Kinesis Data Analytics application.

AllowNonRestoredState -> (boolean)

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 .

Note

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 .

FlinkApplicationConfigurationDescription -> (structure)

The details about a Flink-based Kinesis Data Analytics application.

CheckpointConfigurationDescription -> (structure)

Describes an application’s checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance.

ConfigurationType -> (string)

Describes whether the application uses the default checkpointing behavior in Kinesis Data Analytics.

Note

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

CheckpointingEnabled -> (boolean)

Describes whether checkpointing is enabled for a Flink-based Kinesis Data Analytics application.

Note

If CheckpointConfiguration.ConfigurationType is DEFAULT , the application will use a CheckpointingEnabled value of true , even if this value is set to another value using this API or in application code.

CheckpointInterval -> (long)

Describes the interval in milliseconds between checkpoint operations.

Note

If CheckpointConfiguration.ConfigurationType is DEFAULT , the application will use a CheckpointInterval value of 60000, even if this value is set to another value using this API or in application code.

MinPauseBetweenCheckpoints -> (long)

Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.

Note

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.

MonitoringConfigurationDescription -> (structure)

Describes configuration parameters for Amazon CloudWatch logging for an application.

ConfigurationType -> (string)

Describes whether to use the default CloudWatch logging configuration for an application.

MetricsLevel -> (string)

Describes the granularity of the CloudWatch Logs for an application.

LogLevel -> (string)

Describes the verbosity of the CloudWatch Logs for an application.

ParallelismConfigurationDescription -> (structure)

Describes parameters for how an application executes multiple tasks simultaneously.

ConfigurationType -> (string)

Describes whether the application uses the default parallelism for the Kinesis Data Analytics service.

Parallelism -> (integer)

Describes the initial number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, then Kinesis Data Analytics can increase the CurrentParallelism value in response to application load. The service can increase CurrentParallelism up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.

ParallelismPerKPU -> (integer)

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 -> (integer)

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 -> (boolean)

Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.

JobPlanDescription -> (string)

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.

EnvironmentPropertyDescriptions -> (structure)

Describes execution properties for a Flink-based Kinesis Data Analytics application.

PropertyGroupDescriptions -> (list)

Describes the execution property groups.

(structure)

Property key-value pairs passed into an application.

PropertyGroupId -> (string)

Describes the key of an application execution property key-value pair.

PropertyMap -> (map)

Describes the value of an application execution property key-value pair.

key -> (string)

value -> (string)

ApplicationSnapshotConfigurationDescription -> (structure)

Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

SnapshotsEnabled -> (boolean)

Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

VpcConfigurationDescriptions -> (list)

The array of descriptions of VPC configurations available to the application.

(structure)

Describes the parameters of a VPC used by the application.

VpcConfigurationId -> (string)

The ID of the VPC configuration.

VpcId -> (string)

The ID of the associated VPC.

SubnetIds -> (list)

The array of Subnet IDs used by the VPC configuration.

(string)

SecurityGroupIds -> (list)

The array of SecurityGroup IDs used by the VPC configuration.

(string)

ZeppelinApplicationConfigurationDescription -> (structure)

The configuration parameters for a Kinesis Data Analytics Studio notebook.

MonitoringConfigurationDescription -> (structure)

The monitoring configuration of a Kinesis Data Analytics Studio notebook.

LogLevel -> (string)

Describes the verbosity of the CloudWatch Logs for an application.

CatalogConfigurationDescription -> (structure)

The Amazon Glue Data Catalog that is associated with the Kinesis Data Analytics Studio notebook.

GlueDataCatalogConfigurationDescription -> (structure)

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.

DatabaseARN -> (string)

The Amazon Resource Name (ARN) of the database.

DeployAsApplicationConfigurationDescription -> (structure)

The parameters required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state.

S3ContentLocationDescription -> (structure)

The location that holds the data required to specify an Amazon Data Analytics application.

BucketARN -> (string)

The Amazon Resource Name (ARN) of the S3 bucket.

BasePath -> (string)

The base path for the S3 bucket.

CustomArtifactsConfigurationDescription -> (list)

Custom artifacts are dependency JARs and user-defined functions (UDF).

(structure)

Specifies a dependency JAR or a JAR of user-defined functions.

ArtifactType -> (string)

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 -> (structure)

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.

BucketARN -> (string)

The Amazon Resource Name (ARN) for the S3 bucket containing the application code.

FileKey -> (string)

The file key for the object containing the application code.

ObjectVersion -> (string)

The version of the object containing the application code.

MavenReferenceDescription -> (structure)

The parameters that are required to specify a Maven dependency.

GroupId -> (string)

The group ID of the Maven reference.

ArtifactId -> (string)

The artifact ID of the Maven reference.

Version -> (string)

The version of the Maven reference.

CloudWatchLoggingOptionDescriptions -> (list)

Describes the application Amazon CloudWatch logging options.

(structure)

Describes the Amazon CloudWatch logging option.

CloudWatchLoggingOptionId -> (string)

The ID of the CloudWatch logging option description.

LogStreamARN -> (string)

The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.

RoleARN -> (string)

The IAM ARN of the role to use to send application messages.

Note

Provided for backward compatibility. Applications created with the current API version have an application-level service execution role rather than a resource-level role.

ApplicationMaintenanceConfigurationDescription -> (structure)

The details of the maintenance configuration for the application.

ApplicationMaintenanceWindowStartTime -> (string)

The start time for the maintenance window.

ApplicationMaintenanceWindowEndTime -> (string)

The end time for the maintenance window.

ApplicationVersionUpdatedFrom -> (long)

The previous application version before the latest application update. RollbackApplication reverts the application to this version.

ApplicationVersionRolledBackFrom -> (long)

If you reverted the application using RollbackApplication , the application version when RollbackApplication was called.

ConditionalToken -> (string)

A value you use to implement strong concurrency for application updates.

ApplicationVersionRolledBackTo -> (long)

The version to which you want to roll back the application.

ApplicationMode -> (string)

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.

Table of Contents

Feedback

User Guide

create-application¶

Description¶

Synopsis¶

Options¶

Output¶