applications

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

Overview

Name	applications
Type	Resource
Id	aws.kinesisanalyticsv2.applications

Fields

The following fields are returned by SELECT queries:

describe_application

Name	Datatype	Description
application_arn	string	The ARN of the application. (pattern: <code>arn:.*</code>)
application_configuration_description	object	Describes details about the application code and starting parameters for a Managed Service for Apache Flink application.
application_description	string	The description of the application.
application_maintenance_configuration_description	object	The details of the maintenance configuration for the application.
application_mode	string	To create a Managed Service for Apache Flink Studio notebook, you must set the mode to INTERACTIVE. However, for a Managed Service for Apache Flink application, the mode is optional. (STREAMING, INTERACTIVE)
application_name	string	The name of the application. (pattern: <code>[a-zA-Z0-9_.-]+</code>)
application_status	string	The status of the application. (DELETING, STARTING, STOPPING, READY, RUNNING, UPDATING, AUTOSCALING, FORCE_STOPPING, ROLLING_BACK, MAINTENANCE, ROLLED_BACK)
application_version_create_timestamp	string (date-time)	The timestamp that indicates when the application version was created.
application_version_id	integer (int64)	Provides the current application version. Managed Service for Apache Flink updates the ApplicationVersionId each time you update the application.
application_version_rolled_back_from	integer (int64)	If you reverted the application using RollbackApplication, the application version when RollbackApplication was called.
application_version_rolled_back_to	integer (int64)	The version to which you want to roll back the application.
application_version_updated_from	integer (int64)	The previous application version before the latest application update. RollbackApplication reverts the application to this version.
cloud_watch_logging_option_descriptions	array	Describes the application Amazon CloudWatch logging options.
conditional_token	string	A value you use to implement strong concurrency for application updates. (pattern: <code>[a-zA-Z0-9-_+/=]+</code>)
create_timestamp	string (date-time)	The current timestamp when the application was created.
last_update_timestamp	string (date-time)	The current timestamp when the application was last updated.
runtime_environment	string	The runtime environment for the application. (SQL-1_0, FLINK-1_6, FLINK-1_8, ZEPPELIN-FLINK-1_0, FLINK-1_11, FLINK-1_13, ZEPPELIN-FLINK-2_0, FLINK-1_15, ZEPPELIN-FLINK-3_0, FLINK-1_18, FLINK-1_19, FLINK-1_20, FLINK-2_2, FLINK-2_3)
service_execution_role	string	Specifies the IAM role that the application uses to access external resources. (pattern: <code>arn:.*</code>)

list_applications

Name	Datatype	Description
application_arn	string	The ARN of the application. (pattern: <code>arn:.*</code>)
application_mode	string	For a Managed Service for Apache Flink application, the mode is STREAMING. For a Managed Service for Apache Flink Studio notebook, it is INTERACTIVE. (STREAMING, INTERACTIVE)
application_name	string	The name of the application. (pattern: <code>[a-zA-Z0-9_.-]+</code>)
application_status	string	The status of the application. (DELETING, STARTING, STOPPING, READY, RUNNING, UPDATING, AUTOSCALING, FORCE_STOPPING, ROLLING_BACK, MAINTENANCE, ROLLED_BACK)
application_version_id	integer (int64)	Provides the current application version.
runtime_environment	string	The runtime environment for the application. (SQL-1_0, FLINK-1_6, FLINK-1_8, ZEPPELIN-FLINK-1_0, FLINK-1_11, FLINK-1_13, ZEPPELIN-FLINK-2_0, FLINK-1_15, ZEPPELIN-FLINK-3_0, FLINK-1_18, FLINK-1_19, FLINK-1_20, FLINK-2_2, FLINK-2_3)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_application	select	region		Returns information about a specific Managed Service for Apache Flink application. If you want to retrieve a list of all applications in your account, use the ListApplications operation.
list_applications	select	region		Returns a list of Managed Service for Apache Flink applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status. If you want detailed information about a specific application, use DescribeApplication.
create_application	insert	region, ApplicationName, RuntimeEnvironment, ServiceExecutionRole		Creates a Managed Service for Apache Flink application. For information about creating a Managed Service for Apache Flink application, see Creating an Application.
create_application_presigned_url	insert	region, ApplicationName, UrlType		Creates and returns a URL that you can use to connect to an application's extension. The IAM role or user used to call this API defines the permissions to access the extension. After the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request that attempts to connect to the extension. You control the amount of time that the URL will be valid using the SessionExpirationDurationInSeconds parameter. If you do not provide this parameter, the returned URL is valid for twelve hours. The URL that you get from a call to CreateApplicationPresignedUrl must be used within 3 minutes to be valid. If you first try to use the URL after the 3-minute limit expires, the service returns an HTTP 403 Forbidden error.
add_application_input_processing_configuration	update	region, ApplicationName, CurrentApplicationVersionId, InputId, InputProcessingConfiguration		Adds an InputProcessingConfiguration to a SQL-based Kinesis Data Analytics application. An input processor pre-processes records on the input stream before the application's SQL code executes. Currently, the only input processor available is Amazon Lambda.
add_application_input	update	region, ApplicationName, CurrentApplicationVersionId, Input		Adds a streaming source to your SQL-based Kinesis Data Analytics application. You can add a streaming source 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.
add_application_output	update	region, ApplicationName, CurrentApplicationVersionId, Output		Adds an external destination to your SQL-based Kinesis Data Analytics application. If you want Kinesis Data Analytics to deliver data from an in-application stream within your application to an external destination (such as an Kinesis data stream, a Kinesis Data Firehose delivery stream, or an Amazon 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. 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.
add_application_reference_data_source	update	region, ApplicationName, CurrentApplicationVersionId, ReferenceDataSource		Adds a reference data source to an existing SQL-based Kinesis Data Analytics application. Kinesis Data 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 an Amazon S3 object maps to columns in the resulting in-application table.
add_application_cloud_watch_logging_option	update	region, ApplicationName, CloudWatchLoggingOption		Adds an Amazon CloudWatch log stream to monitor application configuration errors.
add_application_vpc_configuration	update	region, ApplicationName, VpcConfiguration		Adds a Virtual Private Cloud (VPC) configuration to the application. Applications can use VPCs to store and access resources securely. Note the following about VPC configurations for Managed Service for Apache Flink applications: VPC configurations are not supported for SQL applications. When a VPC is added to a Managed Service for Apache Flink application, the application can no longer be accessed from the Internet directly. To enable Internet access to the application, add an Internet gateway to your VPC.
update_application_maintenance_configuration	update	region, ApplicationName, ApplicationMaintenanceConfigurationUpdate		Updates the maintenance configuration of the Managed Service for Apache Flink application. You can invoke this operation on an application that is in one of the two following states: READY or RUNNING. If you invoke it when the application is in a state other than these two states, it throws a ResourceInUseException. The service makes use of the updated configuration the next time it schedules maintenance for the application. If you invoke this operation after the service schedules maintenance, the service will apply the configuration update the next time it schedules maintenance for the application. This means that you might not see the maintenance configuration update applied to the maintenance process that follows a successful invocation of this operation, but to the following maintenance process instead. To see the current maintenance configuration of your application, invoke the DescribeApplication operation. For information about application maintenance, see Managed Service for Apache Flink for Apache Flink Maintenance. This operation is supported only for Managed Service for Apache Flink.
update_application	update	region, ApplicationName		Updates an existing Managed Service for Apache Flink application. Using this operation, you can update application code, input configuration, and output configuration. Managed Service for Apache Flink updates the ApplicationVersionId each time you update your application.
delete_application_input_processing_configuration	delete	region		Deletes an InputProcessingConfiguration from an input.
delete_application_output	delete	region		Deletes the output destination configuration from your SQL-based Kinesis Data Analytics application's configuration. Kinesis Data Analytics will no longer write data from the corresponding in-application stream to the external output destination.
delete_application_reference_data_source	delete	region		Deletes a reference data source configuration from the specified SQL-based Kinesis Data Analytics application's configuration. If the application is running, Kinesis Data Analytics immediately removes the in-application table that you created using the AddApplicationReferenceDataSource operation.
delete_application	delete	region		Deletes the specified application. Managed Service for Apache Flink halts application execution and deletes the application.
delete_application_cloud_watch_logging_option	delete	region		Deletes an Amazon CloudWatch log stream from an SQL-based Kinesis Data Analytics application.
delete_application_vpc_configuration	delete	region		Removes a VPC configuration from a Managed Service for Apache Flink application.
rollback_application	exec	region, ApplicationName, CurrentApplicationVersionId		Reverts the application to the previous running version. You can roll back an application if you suspect it is stuck in a transient status or in the running status. You can roll back an application only if it is in the UPDATING, AUTOSCALING, or RUNNING statuses. When you rollback an application, it loads state data from the last successful snapshot. If the application has no snapshots, Managed Service for Apache Flink rejects the rollback request.
start_application	exec	region, ApplicationName		Starts the specified Managed Service for Apache Flink application. After creating an application, you must exclusively call this operation to start your application.
stop_application	exec	region, ApplicationName		Stops the application from processing data. You can stop an application only if it is in the running status, unless you set the Force parameter to true. You can use the DescribeApplication operation to find the application status. Managed Service for Apache Flink takes a snapshot when the application is stopped, unless Force is set to true.

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

Returns information about a specific Managed Service for Apache Flink application. If you want to retrieve a list of all applications in your account, use the ListApplications operation.

SELECT
application_arn,
application_configuration_description,
application_description,
application_maintenance_configuration_description,
application_mode,
application_name,
application_status,
application_version_create_timestamp,
application_version_id,
application_version_rolled_back_from,
application_version_rolled_back_to,
application_version_updated_from,
cloud_watch_logging_option_descriptions,
conditional_token,
create_timestamp,
last_update_timestamp,
runtime_environment,
service_execution_role
FROM aws.kinesisanalyticsv2.applications
WHERE region = '{{ region }}' -- required
;

list_applications

Returns a list of Managed Service for Apache Flink applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status. If you want detailed information about a specific application, use DescribeApplication.

SELECT
application_arn,
application_mode,
application_name,
application_status,
application_version_id,
runtime_environment
FROM aws.kinesisanalyticsv2.applications
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_application

Creates a Managed Service for Apache Flink application. For information about creating a Managed Service for Apache Flink application, see Creating an Application.

INSERT INTO aws.kinesisanalyticsv2.applications (
ApplicationName,
ApplicationDescription,
RuntimeEnvironment,
ServiceExecutionRole,
ApplicationConfiguration,
CloudWatchLoggingOptions,
Tags,
ApplicationMode,
region
)
SELECT 
'{{ ApplicationName }}' /* required */,
'{{ ApplicationDescription }}',
'{{ RuntimeEnvironment }}' /* required */,
'{{ ServiceExecutionRole }}' /* required */,
'{{ ApplicationConfiguration }}',
'{{ CloudWatchLoggingOptions }}',
'{{ Tags }}',
'{{ ApplicationMode }}',
'{{ region }}'
RETURNING
application_detail
;

create_application_presigned_url

Creates and returns a URL that you can use to connect to an application's extension. The IAM role or user used to call this API defines the permissions to access the extension. After the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request that attempts to connect to the extension. You control the amount of time that the URL will be valid using the SessionExpirationDurationInSeconds parameter. If you do not provide this parameter, the returned URL is valid for twelve hours. The URL that you get from a call to CreateApplicationPresignedUrl must be used within 3 minutes to be valid. If you first try to use the URL after the 3-minute limit expires, the service returns an HTTP 403 Forbidden error.

INSERT INTO aws.kinesisanalyticsv2.applications (
ApplicationName,
UrlType,
SessionExpirationDurationInSeconds,
region
)
SELECT 
'{{ ApplicationName }}' /* required */,
'{{ UrlType }}' /* required */,
{{ SessionExpirationDurationInSeconds }},
'{{ region }}'
RETURNING
authorized_url
;

Manifest

# 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: |
      The name of the application.
  - name: ApplicationDescription
    value: "{{ ApplicationDescription }}"
    description: |
      A summary description of the application.
  - name: RuntimeEnvironment
    value: "{{ RuntimeEnvironment }}"
    description: |
      The runtime environment for the application.
    valid_values: ['SQL-1_0', 'FLINK-1_6', 'FLINK-1_8', 'ZEPPELIN-FLINK-1_0', 'FLINK-1_11', 'FLINK-1_13', 'ZEPPELIN-FLINK-2_0', 'FLINK-1_15', 'ZEPPELIN-FLINK-3_0', 'FLINK-1_18', 'FLINK-1_19', 'FLINK-1_20', 'FLINK-2_2', 'FLINK-2_3']
  - name: ServiceExecutionRole
    value: "{{ ServiceExecutionRole }}"
    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.
  - name: ApplicationConfiguration
    description: |
      Use this parameter to configure the application.
    value:
      SqlApplicationConfiguration:
        Inputs:
          - NamePrefix: "{{ NamePrefix }}"
            InputProcessingConfiguration:
              InputLambdaProcessor:
                ResourceARN: "{{ ResourceARN }}"
            KinesisStreamsInput:
              ResourceARN: "{{ ResourceARN }}"
            KinesisFirehoseInput:
              ResourceARN: "{{ ResourceARN }}"
            InputParallelism:
              Count: {{ Count }}
            InputSchema:
              RecordFormat:
                RecordFormatType: "{{ RecordFormatType }}"
                MappingParameters: "{{ MappingParameters }}"
              RecordEncoding: "{{ RecordEncoding }}"
              RecordColumns:
                - Name: "{{ Name }}"
                  Mapping: "{{ Mapping }}"
                  SqlType: "{{ SqlType }}"
        Outputs:
          - Name: "{{ Name }}"
            KinesisStreamsOutput:
              ResourceARN: "{{ ResourceARN }}"
            KinesisFirehoseOutput:
              ResourceARN: "{{ ResourceARN }}"
            LambdaOutput:
              ResourceARN: "{{ ResourceARN }}"
            DestinationSchema:
              RecordFormatType: "{{ RecordFormatType }}"
        ReferenceDataSources:
          - TableName: "{{ TableName }}"
            S3ReferenceDataSource:
              BucketARN: "{{ BucketARN }}"
              FileKey: "{{ FileKey }}"
            ReferenceSchema:
              RecordFormat:
                RecordFormatType: "{{ RecordFormatType }}"
                MappingParameters: "{{ MappingParameters }}"
              RecordEncoding: "{{ RecordEncoding }}"
              RecordColumns:
                - Name: "{{ Name }}"
                  Mapping: "{{ Mapping }}"
                  SqlType: "{{ SqlType }}"
      FlinkApplicationConfiguration:
        CheckpointConfiguration:
          ConfigurationType: "{{ ConfigurationType }}"
          CheckpointingEnabled: {{ CheckpointingEnabled }}
          CheckpointInterval: {{ CheckpointInterval }}
          MinPauseBetweenCheckpoints: {{ MinPauseBetweenCheckpoints }}
        MonitoringConfiguration:
          ConfigurationType: "{{ ConfigurationType }}"
          MetricsLevel: "{{ MetricsLevel }}"
          LogLevel: "{{ LogLevel }}"
        ParallelismConfiguration:
          ConfigurationType: "{{ ConfigurationType }}"
          Parallelism: {{ Parallelism }}
          ParallelismPerKPU: {{ ParallelismPerKPU }}
          AutoScalingEnabled: {{ AutoScalingEnabled }}
      EnvironmentProperties:
        PropertyGroups:
          - PropertyGroupId: "{{ PropertyGroupId }}"
            PropertyMap: "{{ PropertyMap }}"
      ApplicationCodeConfiguration:
        CodeContent:
          TextContent: "{{ TextContent }}"
          ZipFileContent: "{{ ZipFileContent }}"
          S3ContentLocation:
            BucketARN: "{{ BucketARN }}"
            FileKey: "{{ FileKey }}"
            ObjectVersion: "{{ ObjectVersion }}"
        CodeContentType: "{{ CodeContentType }}"
      ApplicationSnapshotConfiguration:
        SnapshotsEnabled: {{ SnapshotsEnabled }}
      ApplicationSystemRollbackConfiguration:
        RollbackEnabled: {{ RollbackEnabled }}
      VpcConfigurations:
        - SubnetIds: "{{ SubnetIds }}"
          SecurityGroupIds: "{{ SecurityGroupIds }}"
      ZeppelinApplicationConfiguration:
        MonitoringConfiguration:
          LogLevel: "{{ LogLevel }}"
        CatalogConfiguration:
          GlueDataCatalogConfiguration:
            DatabaseARN: "{{ DatabaseARN }}"
        DeployAsApplicationConfiguration:
          S3ContentLocation:
            BucketARN: "{{ BucketARN }}"
            BasePath: "{{ BasePath }}"
        CustomArtifactsConfiguration:
          - ArtifactType: "{{ ArtifactType }}"
            S3ContentLocation:
              BucketARN: "{{ BucketARN }}"
              FileKey: "{{ FileKey }}"
              ObjectVersion: "{{ ObjectVersion }}"
            MavenReference:
              GroupId: "{{ GroupId }}"
              ArtifactId: "{{ ArtifactId }}"
              Version: "{{ Version }}"
      ApplicationEncryptionConfiguration:
        KeyId: "{{ KeyId }}"
        KeyType: "{{ KeyType }}"
  - name: CloudWatchLoggingOptions
    description: |
      Use this parameter to configure an Amazon CloudWatch log stream to monitor application configuration errors.
    value:
      - LogStreamARN: "{{ LogStreamARN }}"
  - 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 }}"
  - name: ApplicationMode
    value: "{{ ApplicationMode }}"
    description: |
      Use the STREAMING mode to create a Managed Service for Apache Flink application. To create a Managed Service for Apache Flink Studio notebook, use the INTERACTIVE mode.
    valid_values: ['STREAMING', 'INTERACTIVE']
  - name: UrlType
    value: "{{ UrlType }}"
    description: |
      The type of the extension for which to create and return a URL. Currently, the only valid extension URL type is FLINK_DASHBOARD_URL.
    valid_values: ['FLINK_DASHBOARD_URL', 'ZEPPELIN_UI_URL']
  - name: SessionExpirationDurationInSeconds
    value: {{ SessionExpirationDurationInSeconds }}
    description: |
      The duration in seconds for which the returned URL will be valid.

UPDATE examples

add_application_input_processing_configuration

Adds an InputProcessingConfiguration to a SQL-based Kinesis Data Analytics application. An input processor pre-processes records on the input stream before the application's SQL code executes. Currently, the only input processor available is Amazon Lambda.

UPDATE aws.kinesisanalyticsv2.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
RETURNING
application_arn,
application_version_id,
input_id,
input_processing_configuration_description;

add_application_input

Adds a streaming source to your SQL-based Kinesis Data Analytics application. You can add a streaming source 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.

UPDATE aws.kinesisanalyticsv2.applications
SET 
ApplicationName = '{{ ApplicationName }}',
CurrentApplicationVersionId = {{ CurrentApplicationVersionId }},
Input = '{{ Input }}'
WHERE 
region = '{{ region }}' --required
AND ApplicationName = '{{ ApplicationName }}' --required
AND CurrentApplicationVersionId = '{{ CurrentApplicationVersionId }}' --required
AND Input = '{{ Input }}' --required
RETURNING
application_arn,
application_version_id,
input_descriptions;

add_application_output

Adds an external destination to your SQL-based Kinesis Data Analytics application. If you want Kinesis Data Analytics to deliver data from an in-application stream within your application to an external destination (such as an Kinesis data stream, a Kinesis Data Firehose delivery stream, or an Amazon 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. 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.

UPDATE aws.kinesisanalyticsv2.applications
SET 
ApplicationName = '{{ ApplicationName }}',
CurrentApplicationVersionId = {{ CurrentApplicationVersionId }},
Output = '{{ Output }}'
WHERE 
region = '{{ region }}' --required
AND ApplicationName = '{{ ApplicationName }}' --required
AND CurrentApplicationVersionId = '{{ CurrentApplicationVersionId }}' --required
AND Output = '{{ Output }}' --required
RETURNING
application_arn,
application_version_id,
output_descriptions;

add_application_reference_data_source

Adds a reference data source to an existing SQL-based Kinesis Data Analytics application. Kinesis Data 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 an Amazon S3 object maps to columns in the resulting in-application table.

UPDATE aws.kinesisanalyticsv2.applications
SET 
ApplicationName = '{{ ApplicationName }}',
CurrentApplicationVersionId = {{ CurrentApplicationVersionId }},
ReferenceDataSource = '{{ ReferenceDataSource }}'
WHERE 
region = '{{ region }}' --required
AND ApplicationName = '{{ ApplicationName }}' --required
AND CurrentApplicationVersionId = '{{ CurrentApplicationVersionId }}' --required
AND ReferenceDataSource = '{{ ReferenceDataSource }}' --required
RETURNING
application_arn,
application_version_id,
reference_data_source_descriptions;

add_application_cloud_watch_logging_option

Adds an Amazon CloudWatch log stream to monitor application configuration errors.

UPDATE aws.kinesisanalyticsv2.applications
SET 
ApplicationName = '{{ ApplicationName }}',
CurrentApplicationVersionId = {{ CurrentApplicationVersionId }},
CloudWatchLoggingOption = '{{ CloudWatchLoggingOption }}',
ConditionalToken = '{{ ConditionalToken }}'
WHERE 
region = '{{ region }}' --required
AND ApplicationName = '{{ ApplicationName }}' --required
AND CloudWatchLoggingOption = '{{ CloudWatchLoggingOption }}' --required
RETURNING
application_arn,
application_version_id,
cloud_watch_logging_option_descriptions,
operation_id;

add_application_vpc_configuration

Adds a Virtual Private Cloud (VPC) configuration to the application. Applications can use VPCs to store and access resources securely. Note the following about VPC configurations for Managed Service for Apache Flink applications: VPC configurations are not supported for SQL applications. When a VPC is added to a Managed Service for Apache Flink application, the application can no longer be accessed from the Internet directly. To enable Internet access to the application, add an Internet gateway to your VPC.

UPDATE aws.kinesisanalyticsv2.applications
SET 
ApplicationName = '{{ ApplicationName }}',
CurrentApplicationVersionId = {{ CurrentApplicationVersionId }},
VpcConfiguration = '{{ VpcConfiguration }}',
ConditionalToken = '{{ ConditionalToken }}'
WHERE 
region = '{{ region }}' --required
AND ApplicationName = '{{ ApplicationName }}' --required
AND VpcConfiguration = '{{ VpcConfiguration }}' --required
RETURNING
application_arn,
application_version_id,
operation_id,
vpc_configuration_description;

update_application_maintenance_configuration

Updates the maintenance configuration of the Managed Service for Apache Flink application. You can invoke this operation on an application that is in one of the two following states: READY or RUNNING. If you invoke it when the application is in a state other than these two states, it throws a ResourceInUseException. The service makes use of the updated configuration the next time it schedules maintenance for the application. If you invoke this operation after the service schedules maintenance, the service will apply the configuration update the next time it schedules maintenance for the application. This means that you might not see the maintenance configuration update applied to the maintenance process that follows a successful invocation of this operation, but to the following maintenance process instead. To see the current maintenance configuration of your application, invoke the DescribeApplication operation. For information about application maintenance, see Managed Service for Apache Flink for Apache Flink Maintenance. This operation is supported only for Managed Service for Apache Flink.

UPDATE aws.kinesisanalyticsv2.applications
SET 
ApplicationName = '{{ ApplicationName }}',
ApplicationMaintenanceConfigurationUpdate = '{{ ApplicationMaintenanceConfigurationUpdate }}'
WHERE 
region = '{{ region }}' --required
AND ApplicationName = '{{ ApplicationName }}' --required
AND ApplicationMaintenanceConfigurationUpdate = '{{ ApplicationMaintenanceConfigurationUpdate }}' --required
RETURNING
application_arn,
application_maintenance_configuration_description;

update_application

Updates an existing Managed Service for Apache Flink application. Using this operation, you can update application code, input configuration, and output configuration. Managed Service for Apache Flink updates the ApplicationVersionId each time you update your application.

UPDATE aws.kinesisanalyticsv2.applications
SET 
ApplicationName = '{{ ApplicationName }}',
CurrentApplicationVersionId = {{ CurrentApplicationVersionId }},
ApplicationConfigurationUpdate = '{{ ApplicationConfigurationUpdate }}',
ServiceExecutionRoleUpdate = '{{ ServiceExecutionRoleUpdate }}',
RunConfigurationUpdate = '{{ RunConfigurationUpdate }}',
CloudWatchLoggingOptionUpdates = '{{ CloudWatchLoggingOptionUpdates }}',
ConditionalToken = '{{ ConditionalToken }}',
RuntimeEnvironmentUpdate = '{{ RuntimeEnvironmentUpdate }}'
WHERE 
region = '{{ region }}' --required
AND ApplicationName = '{{ ApplicationName }}' --required
RETURNING
application_detail,
operation_id;

DELETE examples

delete_application_input_processing_configuration

Deletes an InputProcessingConfiguration from an input.

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

delete_application_output

Deletes the output destination configuration from your SQL-based Kinesis Data Analytics application's configuration. Kinesis Data Analytics will no longer write data from the corresponding in-application stream to the external output destination.

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

delete_application_reference_data_source

Deletes a reference data source configuration from the specified SQL-based Kinesis Data Analytics application's configuration. If the application is running, Kinesis Data Analytics immediately removes the in-application table that you created using the AddApplicationReferenceDataSource operation.

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

delete_application

Deletes the specified application. Managed Service for Apache Flink halts application execution and deletes the application.

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

delete_application_cloud_watch_logging_option

Deletes an Amazon CloudWatch log stream from an SQL-based Kinesis Data Analytics application.

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

delete_application_vpc_configuration

Removes a VPC configuration from a Managed Service for Apache Flink application.

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

Lifecycle Methods

rollback_application

Reverts the application to the previous running version. You can roll back an application if you suspect it is stuck in a transient status or in the running status. You can roll back an application only if it is in the UPDATING, AUTOSCALING, or RUNNING statuses. When you rollback an application, it loads state data from the last successful snapshot. If the application has no snapshots, Managed Service for Apache Flink rejects the rollback request.

EXEC aws.kinesisanalyticsv2.applications.rollback_application 
@region='{{ region }}' --required 
@@json=
'{
"ApplicationName": "{{ ApplicationName }}", 
"CurrentApplicationVersionId": {{ CurrentApplicationVersionId }}
}'
;

start_application

Starts the specified Managed Service for Apache Flink application. After creating an application, you must exclusively call this operation to start your application.

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

stop_application

Stops the application from processing data. You can stop an application only if it is in the running status, unless you set the Force parameter to true. You can use the DescribeApplication operation to find the application status. Managed Service for Apache Flink takes a snapshot when the application is stopped, unless Force is set to true.

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