applications

Creates, updates, deletes, gets or lists an applications resource.

Overview

Name	`applications`
Type	Resource
Id	`aws.kinesisanalytics.applications`

Fields

The following fields are returned by SELECT queries:

describe_application
list_applications

Name	Datatype	Description
`application_arn`	`string`	ARN of the application. (pattern: <code>arn:.*</code>)
`application_code`	`string`	Returns the application code that you provided to perform data analysis on any of the in-application streams in your application.
`application_description`	`string`	Description of the application.
`application_name`	`string`	Name of the application. (pattern: <code>[a-zA-Z0-9_.-]+</code>)
`application_status`	`string`	Status of the application. (DELETING, STARTING, STOPPING, READY, RUNNING, UPDATING)
`application_version_id`	`integer (int64)`	Provides the current application version.
`cloud_watch_logging_option_descriptions`	`array`	Describes the CloudWatch log streams that are configured to receive application messages. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Working with Amazon CloudWatch Logs.
`create_timestamp`	`string (date-time)`	Time stamp when the application version was created.
`input_descriptions`	`array`	Describes the application input configuration. For more information, see Configuring Application Input.
`last_update_timestamp`	`string (date-time)`	Time stamp when the application was last updated.
`output_descriptions`	`array`	Describes the application output configuration. For more information, see Configuring Application Output.
`reference_data_source_descriptions`	`array`	Describes reference data sources configured for the application. For more information, see Configuring Application Input.

Name	Datatype	Description
`application_summaries`	`array`	List of ApplicationSummary objects.
`has_more_applications`	`boolean`	Returns true if there are more applications to retrieve.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Description
`describe_application`	`select`	`region`	This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. Returns information about a specific Amazon Kinesis Analytics application. If you want to retrieve a list of all applications in your account, use the ListApplications operation. This operation requires permissions to perform the kinesisanalytics:DescribeApplication action. You can use DescribeApplication to get the current application versionId, which you need to call other operations such as Update.
`list_applications`	`select`	`region`	This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. Returns a list of Amazon Kinesis Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status. If the response returns the HasMoreApplications value as true, you can send another request by adding the ExclusiveStartApplicationName in the request body, and set the value of this to the last application name from the previous response. If you want detailed information about a specific application, use DescribeApplication. This operation requires permissions to perform the kinesisanalytics:ListApplications action.
`create_application`	`insert`	`region`, `ApplicationName`	This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. Creates an Amazon Kinesis Analytics application. You can configure each application with one streaming source as input, application code to process the input, and up to three destinations where you want Amazon Kinesis Analytics to write the output data from your application. For an overview, see How it Works. In the input configuration, you map the streaming source to an in-application stream, which you can think of as a constantly updating table. In the mapping, you must provide a schema for the in-application stream and map each data column in the in-application stream to a data element in the streaming source. Your application code is one or more SQL statements that read input data, transform it, and generate output. Your application code can create one or more SQL artifacts like SQL streams or pumps. In the output configuration, you can configure the application to write data from in-application streams created in your applications to up to three destinations. To read data from your source stream or write data to destination streams, Amazon Kinesis Analytics needs your permissions. You grant these permissions by creating IAM roles. This operation requires permissions to perform the kinesisanalytics:CreateApplication action. For introductory exercises to create an Amazon Kinesis Analytics application, see Getting Started.
`add_application_input_processing_configuration`	`update`	`region`, `ApplicationName`, `CurrentApplicationVersionId`, `InputId`, `InputProcessingConfiguration`	This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. Adds an InputProcessingConfiguration to an application. An input processor preprocesses records on the input stream before the application's SQL code executes. Currently, the only input processor available is AWS Lambda.
`add_application_cloud_watch_logging_option`	`update`	`region`, `ApplicationName`, `CurrentApplicationVersionId`, `CloudWatchLoggingOption`	This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. Adds a CloudWatch log stream to monitor application configuration errors. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Working with Amazon CloudWatch Logs.
`add_application_input`	`update`	`region`, `ApplicationName`, `CurrentApplicationVersionId`, `Input`	This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. Adds a streaming source to your Amazon Kinesis application. For conceptual information, see Configuring Application Input. You can add a streaming source either when you create an application or you can use this operation to add a streaming source after you create an application. For more information, see CreateApplication. Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version. This operation requires permissions to perform the kinesisanalytics:AddApplicationInput action.
`add_application_output`	`update`	`region`, `ApplicationName`, `CurrentApplicationVersionId`, `Output`	This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. Adds an external destination to your Amazon Kinesis Analytics application. If you want Amazon Kinesis Analytics to deliver data from an in-application stream within your application to an external destination (such as an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an AWS Lambda function), you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination. You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors. For more information, see Understanding Application Output (Destination). Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version. For the limits on the number of application inputs and outputs you can configure, see Limits. This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action.
`add_application_reference_data_source`	`update`	`region`, `ApplicationName`, `CurrentApplicationVersionId`, `ReferenceDataSource`	This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. Adds a reference data source to an existing application. Amazon Kinesis Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table within your application. In the request, you provide the source (S3 bucket name and object key name), name of the in-application table to create, and the necessary mapping information that describes how data in Amazon S3 object maps to columns in the resulting in-application table. For conceptual information, see Configuring Application Input. For the limits on data sources you can add to your application, see Limits. This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action.
`update_application`	`update`	`region`, `ApplicationName`, `CurrentApplicationVersionId`, `ApplicationUpdate`	This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. Updates an existing Amazon Kinesis Analytics application. Using this API, you can update application code, input configuration, and output configuration. Note that Amazon Kinesis Analytics updates the CurrentApplicationVersionId each time you update your application. This operation requires permission for the kinesisanalytics:UpdateApplication action.
`delete_application_cloud_watch_logging_option`	`delete`	`region`	This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. Deletes a CloudWatch log stream from an application. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Working with Amazon CloudWatch Logs.
`delete_application_input_processing_configuration`	`delete`	`region`	This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. Deletes an InputProcessingConfiguration from an input.
`delete_application_output`	`delete`	`region`	This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. Deletes output destination configuration from your application configuration. Amazon Kinesis Analytics will no longer write data from the corresponding in-application stream to the external output destination. This operation requires permissions to perform the kinesisanalytics:DeleteApplicationOutput action.
`delete_application_reference_data_source`	`delete`	`region`	This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. Deletes a reference data source configuration from the specified application configuration. If the application is running, Amazon Kinesis Analytics immediately removes the in-application table that you created using the AddApplicationReferenceDataSource operation. This operation requires permissions to perform the kinesisanalytics.DeleteApplicationReferenceDataSource action.
`delete_application`	`delete`	`region`	This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. Deletes the specified application. Amazon Kinesis Analytics halts application execution and deletes the application, including any application artifacts (such as in-application streams, reference table, and application code). This operation requires permissions to perform the kinesisanalytics:DeleteApplication action.
`start_application`	`exec`	`region`, `ApplicationName`, `InputConfigurations`	This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. Starts the specified Amazon Kinesis Analytics application. After creating an application, you must exclusively call this operation to start your application. After the application starts, it begins consuming the input data, processes it, and writes the output to the configured destination. The application status must be READY for you to start an application. You can get the application status in the console or using the DescribeApplication operation. After you start the application, you can stop the application from processing the input by calling the StopApplication operation. This operation requires permissions to perform the kinesisanalytics:StartApplication action.
`stop_application`	`exec`	`region`, `ApplicationName`	This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. Stops the application from processing input data. You can stop an application only if it is in the running state. You can use the DescribeApplication operation to find the application state. After the application is stopped, Amazon Kinesis Analytics stops reading data from the input, the application stops processing data, and there is no output written to the destination. This operation requires permissions to perform the kinesisanalytics:StopApplication action.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`region`	`string`	AWS region (default: us-east-1)

`SELECT` examples

describe_application
list_applications

SELECT
application_arn,
application_code,
application_description,
application_name,
application_status,
application_version_id,
cloud_watch_logging_option_descriptions,
create_timestamp,
input_descriptions,
last_update_timestamp,
output_descriptions,
reference_data_source_descriptions
FROM aws.kinesisanalytics.applications
WHERE region = '{{ region }}' -- required
;

SELECT
application_summaries,
has_more_applications
FROM aws.kinesisanalytics.applications
WHERE region = '{{ region }}' -- required
;

`INSERT` examples

create_application
Manifest

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. Creates an Amazon Kinesis Analytics application. You can configure each application with one streaming source as input, application code to process the input, and up to three destinations where you want Amazon Kinesis Analytics to write the output data from your application. For an overview, see How it Works. In the input configuration, you map the streaming source to an in-application stream, which you can think of as a constantly updating table. In the mapping, you must provide a schema for the in-application stream and map each data column in the in-application stream to a data element in the streaming source. Your application code is one or more SQL statements that read input data, transform it, and generate output. Your application code can create one or more SQL artifacts like SQL streams or pumps. In the output configuration, you can configure the application to write data from in-application streams created in your applications to up to three destinations. To read data from your source stream or write data to destination streams, Amazon Kinesis Analytics needs your permissions. You grant these permissions by creating IAM roles. This operation requires permissions to perform the kinesisanalytics:CreateApplication action. For introductory exercises to create an Amazon Kinesis Analytics application, see Getting Started.

INSERT INTO aws.kinesisanalytics.applications (
ApplicationName,
ApplicationDescription,
Inputs,
Outputs,
CloudWatchLoggingOptions,
ApplicationCode,
Tags,
region
)
SELECT 
'{{ ApplicationName }}' /* required */,
'{{ ApplicationDescription }}',
'{{ Inputs }}',
'{{ Outputs }}',
'{{ CloudWatchLoggingOptions }}',
'{{ ApplicationCode }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
application_summary
;

# Description fields are for documentation purposes
- name: applications
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the applications resource.
  - name: ApplicationName
    value: "{{ ApplicationName }}"
    description: |
      Name of your Amazon Kinesis Analytics application (for example, sample-app).
  - name: ApplicationDescription
    value: "{{ ApplicationDescription }}"
    description: |
      Summary description of the application.
  - name: Inputs
    description: |
      Use this parameter to configure the application input. You can configure your application to receive input from a single streaming source. In this configuration, you map this streaming source to an in-application stream that is created. Your application code can then query the in-application stream like a table (you can think of it as a constantly updating table). For the streaming source, you provide its Amazon Resource Name (ARN) and format of data on the stream (for example, JSON, CSV, etc.). You also must provide an IAM role that Amazon Kinesis Analytics can assume to read this stream on your behalf. To create the in-application stream, you need to specify a schema to transform your data into a schematized version used in SQL. In the schema, you provide the necessary mapping of the data elements in the streaming source to record columns in the in-app stream.
    value:
      - NamePrefix: "{{ NamePrefix }}"
        InputProcessingConfiguration:
          InputLambdaProcessor:
            ResourceARN: "{{ ResourceARN }}"
            RoleARN: "{{ RoleARN }}"
        KinesisStreamsInput:
          ResourceARN: "{{ ResourceARN }}"
          RoleARN: "{{ RoleARN }}"
        KinesisFirehoseInput:
          ResourceARN: "{{ ResourceARN }}"
          RoleARN: "{{ RoleARN }}"
        InputParallelism:
          Count: {{ Count }}
        InputSchema:
          RecordFormat:
            RecordFormatType: "{{ RecordFormatType }}"
            MappingParameters:
              JSONMappingParameters:
                RecordRowPath: "{{ RecordRowPath }}"
              CSVMappingParameters:
                RecordRowDelimiter: "{{ RecordRowDelimiter }}"
                RecordColumnDelimiter: "{{ RecordColumnDelimiter }}"
          RecordEncoding: "{{ RecordEncoding }}"
          RecordColumns:
            - Name: "{{ Name }}"
              Mapping: "{{ Mapping }}"
              SqlType: "{{ SqlType }}"
  - name: Outputs
    description: |
      You can configure application output to write data from any of the in-application streams to up to three destinations. These destinations can be Amazon Kinesis streams, Amazon Kinesis Firehose delivery streams, AWS Lambda destinations, or any combination of the three. In the configuration, you specify the in-application stream name, the destination stream or Lambda function Amazon Resource Name (ARN), and the format to use when writing data. You must also provide an IAM role that Amazon Kinesis Analytics can assume to write to the destination stream or Lambda function on your behalf. In the output configuration, you also provide the output stream or Lambda function ARN. For stream destinations, you provide the format of data in the stream (for example, JSON, CSV). You also must provide an IAM role that Amazon Kinesis Analytics can assume to write to the stream or Lambda function on your behalf.
    value:
      - Name: "{{ Name }}"
        KinesisStreamsOutput:
          ResourceARN: "{{ ResourceARN }}"
          RoleARN: "{{ RoleARN }}"
        KinesisFirehoseOutput:
          ResourceARN: "{{ ResourceARN }}"
          RoleARN: "{{ RoleARN }}"
        LambdaOutput:
          ResourceARN: "{{ ResourceARN }}"
          RoleARN: "{{ RoleARN }}"
        DestinationSchema:
          RecordFormatType: "{{ RecordFormatType }}"
  - name: CloudWatchLoggingOptions
    description: |
      Use this parameter to configure a CloudWatch log stream to monitor application configuration errors. For more information, see Working with Amazon CloudWatch Logs.
    value:
      - LogStreamARN: "{{ LogStreamARN }}"
        RoleARN: "{{ RoleARN }}"
  - name: ApplicationCode
    value: "{{ ApplicationCode }}"
    description: |
      One or more SQL statements that read input data, transform it, and generate output. For example, you can write a SQL statement that reads data from one in-application stream, generates a running average of the number of advertisement clicks by vendor, and insert resulting rows in another in-application stream using pumps. For more information about the typical pattern, see Application Code. You can provide such series of SQL statements, where output of one statement can be used as the input for the next statement. You store intermediate results by creating in-application streams and pumps. Note that the application code must create the streams with names specified in the Outputs. For example, if your Outputs defines output streams named ExampleOutputStream1 and ExampleOutputStream2, then your application code must create these streams.
  - name: 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.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

`UPDATE` examples

add_application_input_processing_configuration
add_application_cloud_watch_logging_option
add_application_input
add_application_output
add_application_reference_data_source
update_application

UPDATE aws.kinesisanalytics.applications
SET 
ApplicationName = '{{ ApplicationName }}',
CurrentApplicationVersionId = {{ CurrentApplicationVersionId }},
InputId = '{{ InputId }}',
InputProcessingConfiguration = '{{ InputProcessingConfiguration }}'
WHERE 
region = '{{ region }}' --required
AND ApplicationName = '{{ ApplicationName }}' --required
AND CurrentApplicationVersionId = '{{ CurrentApplicationVersionId }}' --required
AND InputId = '{{ InputId }}' --required
AND InputProcessingConfiguration = '{{ InputProcessingConfiguration }}' --required;

UPDATE aws.kinesisanalytics.applications
SET 
ApplicationName = '{{ ApplicationName }}',
CurrentApplicationVersionId = {{ CurrentApplicationVersionId }},
CloudWatchLoggingOption = '{{ CloudWatchLoggingOption }}'
WHERE 
region = '{{ region }}' --required
AND ApplicationName = '{{ ApplicationName }}' --required
AND CurrentApplicationVersionId = '{{ CurrentApplicationVersionId }}' --required
AND CloudWatchLoggingOption = '{{ CloudWatchLoggingOption }}' --required;

UPDATE aws.kinesisanalytics.applications
SET 
ApplicationName = '{{ ApplicationName }}',
CurrentApplicationVersionId = {{ CurrentApplicationVersionId }},
Input = '{{ Input }}'
WHERE 
region = '{{ region }}' --required
AND ApplicationName = '{{ ApplicationName }}' --required
AND CurrentApplicationVersionId = '{{ CurrentApplicationVersionId }}' --required
AND Input = '{{ Input }}' --required;

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. Adds an external destination to your Amazon Kinesis Analytics application. If you want Amazon Kinesis Analytics to deliver data from an in-application stream within your application to an external destination (such as an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an AWS Lambda function), you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination. You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors. For more information, see Understanding Application Output (Destination). Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version. For the limits on the number of application inputs and outputs you can configure, see Limits. This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action.

UPDATE aws.kinesisanalytics.applications
SET 
ApplicationName = '{{ ApplicationName }}',
CurrentApplicationVersionId = {{ CurrentApplicationVersionId }},
Output = '{{ Output }}'
WHERE 
region = '{{ region }}' --required
AND ApplicationName = '{{ ApplicationName }}' --required
AND CurrentApplicationVersionId = '{{ CurrentApplicationVersionId }}' --required
AND Output = '{{ Output }}' --required;

UPDATE aws.kinesisanalytics.applications
SET 
ApplicationName = '{{ ApplicationName }}',
CurrentApplicationVersionId = {{ CurrentApplicationVersionId }},
ReferenceDataSource = '{{ ReferenceDataSource }}'
WHERE 
region = '{{ region }}' --required
AND ApplicationName = '{{ ApplicationName }}' --required
AND CurrentApplicationVersionId = '{{ CurrentApplicationVersionId }}' --required
AND ReferenceDataSource = '{{ ReferenceDataSource }}' --required;

UPDATE aws.kinesisanalytics.applications
SET 
ApplicationName = '{{ ApplicationName }}',
CurrentApplicationVersionId = {{ CurrentApplicationVersionId }},
ApplicationUpdate = '{{ ApplicationUpdate }}'
WHERE 
region = '{{ region }}' --required
AND ApplicationName = '{{ ApplicationName }}' --required
AND CurrentApplicationVersionId = '{{ CurrentApplicationVersionId }}' --required
AND ApplicationUpdate = '{{ ApplicationUpdate }}' --required;

`DELETE` examples

delete_application_cloud_watch_logging_option
delete_application_input_processing_configuration
delete_application_output
delete_application_reference_data_source
delete_application

DELETE FROM aws.kinesisanalytics.applications
WHERE region = '{{ region }}' --required
;

DELETE FROM aws.kinesisanalytics.applications
WHERE region = '{{ region }}' --required
;

DELETE FROM aws.kinesisanalytics.applications
WHERE region = '{{ region }}' --required
;

DELETE FROM aws.kinesisanalytics.applications
WHERE region = '{{ region }}' --required
;

DELETE FROM aws.kinesisanalytics.applications
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

start_application
stop_application

EXEC aws.kinesisanalytics.applications.start_application 
@region='{{ region }}' --required 
@@json=
'{
"ApplicationName": "{{ ApplicationName }}", 
"InputConfigurations": "{{ InputConfigurations }}"
}'
;

EXEC aws.kinesisanalytics.applications.stop_application 
@region='{{ region }}' --required 
@@json=
'{
"ApplicationName": "{{ ApplicationName }}"
}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​

Lifecycle Methods​