Skip to content

aws.kinesisanalyticsv2.describe_application

Example SQL Queries

SELECT * FROM
aws.kinesisanalyticsv2.describe_application
WHERE
"application_name" = 'VALUE';

Description

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.

Table Definition

Column NameColumn Data Type
application_name Required Input Column

The name of the application.

VARCHAR
include_additional_details Input Column

Displays verbose information about a Managed Service for Apache Flink application, including the application's job plan.

BOOLEAN
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

application_detail

Provides a description of the application, such as the application's Amazon Resource Name (ARN), status, and latest version.

STRUCT(
"application_arn" VARCHAR,
"application_description" VARCHAR,
"application_name" VARCHAR,
"runtime_environment" VARCHAR,
"service_execution_role" VARCHAR,
"application_status" VARCHAR,
"application_version_id" BIGINT,
"create_timestamp" TIMESTAMP_S,
"last_update_timestamp" TIMESTAMP_S,
"application_configuration_description" STRUCT(
"sql_application_configuration_description" STRUCT(
"input_descriptions" STRUCT(
"input_id" VARCHAR,
"name_prefix" VARCHAR,
"in_app_stream_names" VARCHAR[],
"input_processing_configuration_description" STRUCT(
"input_lambda_processor_description" STRUCT(
"resource_arn" VARCHAR,
"role_arn" VARCHAR
)
),
"kinesis_streams_input_description" STRUCT(
"resource_arn" VARCHAR,
"role_arn" VARCHAR
),
"kinesis_firehose_input_description" STRUCT(
"resource_arn" VARCHAR,
"role_arn" VARCHAR
),
"input_schema" STRUCT(
"record_format" STRUCT(
"record_format_type" VARCHAR,
"mapping_parameters" STRUCT(
"json_mapping_parameters" STRUCT(
"record_row_path" VARCHAR
),
"csv_mapping_parameters" STRUCT(
"record_row_delimiter" VARCHAR,
"record_column_delimiter" VARCHAR
)
)
),
"record_encoding" VARCHAR,
"record_columns" STRUCT(
"name" VARCHAR,
"mapping" VARCHAR,
"sql_type" VARCHAR
)[]
),
"input_parallelism" STRUCT(
"count" BIGINT
),
"input_starting_position_configuration" STRUCT(
"input_starting_position" VARCHAR
)
)[],
"output_descriptions" STRUCT(
"output_id" VARCHAR,
"name" VARCHAR,
"kinesis_streams_output_description" STRUCT(
"resource_arn" VARCHAR,
"role_arn" VARCHAR
),
"kinesis_firehose_output_description" STRUCT(
"resource_arn" VARCHAR,
"role_arn" VARCHAR
),
"lambda_output_description" STRUCT(
"resource_arn" VARCHAR,
"role_arn" VARCHAR
),
"destination_schema" STRUCT(
"record_format_type" VARCHAR
)
)[],
"reference_data_source_descriptions" STRUCT(
"reference_id" VARCHAR,
"table_name" VARCHAR,
"s3_reference_data_source_description" STRUCT(
"bucket_arn" VARCHAR,
"file_key" VARCHAR,
"reference_role_arn" VARCHAR
),
"reference_schema" STRUCT(
"record_format" STRUCT(
"record_format_type" VARCHAR,
"mapping_parameters" STRUCT(
"json_mapping_parameters" STRUCT(
"record_row_path" VARCHAR
),
"csv_mapping_parameters" STRUCT(
"record_row_delimiter" VARCHAR,
"record_column_delimiter" VARCHAR
)
)
),
"record_encoding" VARCHAR,
"record_columns" STRUCT(
"name" VARCHAR,
"mapping" VARCHAR,
"sql_type" VARCHAR
)[]
)
)[]
),
"application_code_configuration_description" STRUCT(
"code_content_type" VARCHAR,
"code_content_description" STRUCT(
"text_content" VARCHAR,
"code_md5" VARCHAR,
"code_size" BIGINT,
"s3_application_code_location_description" STRUCT(
"bucket_arn" VARCHAR,
"file_key" VARCHAR,
"object_version" VARCHAR
)
)
),
"run_configuration_description" STRUCT(
"application_restore_configuration_description" STRUCT(
"application_restore_type" VARCHAR,
"snapshot_name" VARCHAR
),
"flink_run_configuration_description" STRUCT(
"allow_non_restored_state" BOOLEAN
)
),
"flink_application_configuration_description" STRUCT(
"checkpoint_configuration_description" STRUCT(
"configuration_type" VARCHAR,
"checkpointing_enabled" BOOLEAN,
"checkpoint_interval" BIGINT,
"min_pause_between_checkpoints" BIGINT
),
"monitoring_configuration_description" STRUCT(
"configuration_type" VARCHAR,
"metrics_level" VARCHAR,
"log_level" VARCHAR
),
"parallelism_configuration_description" STRUCT(
"configuration_type" VARCHAR,
"parallelism" BIGINT,
"parallelism_per_kpu" BIGINT,
"current_parallelism" BIGINT,
"auto_scaling_enabled" BOOLEAN
),
"job_plan_description" VARCHAR
),
"environment_property_descriptions" STRUCT(
"property_group_descriptions" STRUCT(
"property_group_id" VARCHAR,
"property_map" MAP(VARCHAR, VARCHAR)
)[]
),
"application_snapshot_configuration_description" STRUCT(
"snapshots_enabled" BOOLEAN
),
"application_system_rollback_configuration_description" STRUCT(
"rollback_enabled" BOOLEAN
),
"vpc_configuration_descriptions" STRUCT(
"vpc_configuration_id" VARCHAR,
"vpc_id" VARCHAR,
"subnet_ids" VARCHAR[],
"security_group_ids" VARCHAR[]
)[],
"zeppelin_application_configuration_description" STRUCT(
"monitoring_configuration_description" STRUCT(
"log_level" VARCHAR
),
"catalog_configuration_description" STRUCT(
"glue_data_catalog_configuration_description" STRUCT(
"database_arn" VARCHAR
)
),
"deploy_as_application_configuration_description" STRUCT(
"s3_content_location_description" STRUCT(
"bucket_arn" VARCHAR,
"base_path" VARCHAR
)
),
"custom_artifacts_configuration_description" STRUCT(
"artifact_type" VARCHAR,
"s3_content_location_description" STRUCT(
"bucket_arn" VARCHAR,
"file_key" VARCHAR,
"object_version" VARCHAR
),
"maven_reference_description" STRUCT(
"group_id" VARCHAR,
"artifact_id" VARCHAR,
"version" VARCHAR
)
)[]
)
),
"cloud_watch_logging_option_descriptions" STRUCT(
"cloud_watch_logging_option_id" VARCHAR,
"log_stream_arn" VARCHAR,
"role_arn" VARCHAR
)[],
"application_maintenance_configuration_description" STRUCT(
"application_maintenance_window_start_time" VARCHAR,
"application_maintenance_window_end_time" VARCHAR
),
"application_version_updated_from" BIGINT,
"application_version_rolled_back_from" BIGINT,
"application_version_create_timestamp" TIMESTAMP_S,
"conditional_token" VARCHAR,
"application_version_rolled_back_to" BIGINT,
"application_mode" VARCHAR
)
Show child fields
application_detail.application_arn

The ARN of the application.

application_detail.application_configuration_description

Describes details about the application code and starting parameters for a Managed Service for Apache Flink application.

Show child fields
application_detail.application_configuration_description.application_code_configuration_description

The details about the application code for a Managed Service for Apache Flink application.

Show child fields
application_detail.application_configuration_description.application_code_configuration_description.code_content_description

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

Show child fields
application_detail.application_configuration_description.application_code_configuration_description.code_content_description.code_md5

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

application_detail.application_configuration_description.application_code_configuration_description.code_content_description.code_size

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

application_detail.application_configuration_description.application_code_configuration_description.code_content_description.s3_application_code_location_description

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

Show child fields
application_detail.application_configuration_description.application_code_configuration_description.code_content_description.s3_application_code_location_description.bucket_arn

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

application_detail.application_configuration_description.application_code_configuration_description.code_content_description.s3_application_code_location_description.file_key

The file key for the object containing the application code.

application_detail.application_configuration_description.application_code_configuration_description.code_content_description.s3_application_code_location_description.object_version

The version of the object containing the application code.

application_detail.application_configuration_description.application_code_configuration_description.code_content_description.text_content

The text-format code

application_detail.application_configuration_description.application_code_configuration_description.code_content_type

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

application_detail.application_configuration_description.application_snapshot_configuration_description

Describes whether snapshots are enabled for a Managed Service for Apache Flink application.

Show child fields
application_detail.application_configuration_description.application_snapshot_configuration_description.snapshots_enabled

Describes whether snapshots are enabled for a Managed Service for Apache Flink application.

application_detail.application_configuration_description.application_system_rollback_configuration_description

Describes system rollback configuration for a Managed Service for Apache Flink application

Show child fields
application_detail.application_configuration_description.application_system_rollback_configuration_description.rollback_enabled

Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application

application_detail.application_configuration_description.environment_property_descriptions

Describes execution properties for a Managed Service for Apache Flink application.

Show child fields
application_detail.application_configuration_description.environment_property_descriptions.property_group_descriptions[]
Show child fields
application_detail.application_configuration_description.environment_property_descriptions.property_group_descriptions[].property_group_id

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

application_detail.application_configuration_description.environment_property_descriptions.property_group_descriptions[].property_map

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

application_detail.application_configuration_description.flink_application_configuration_description

The details about a Managed Service for Apache Flink application.

Show child fields
application_detail.application_configuration_description.flink_application_configuration_description.checkpoint_configuration_description

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

Show child fields
application_detail.application_configuration_description.flink_application_configuration_description.checkpoint_configuration_description.checkpoint_interval

Describes the interval in milliseconds between checkpoint operations.

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

application_detail.application_configuration_description.flink_application_configuration_description.checkpoint_configuration_description.checkpointing_enabled

Describes whether checkpointing is enabled for a Managed Service for Apache Flink application.

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

application_detail.application_configuration_description.flink_application_configuration_description.checkpoint_configuration_description.configuration_type

Describes whether the application uses the default checkpointing behavior in Managed Service for Apache Flink.

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

application_detail.application_configuration_description.flink_application_configuration_description.checkpoint_configuration_description.min_pause_between_checkpoints

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

If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this API or in application code.

application_detail.application_configuration_description.flink_application_configuration_description.job_plan_description

The job plan for an application. For more information about the job plan, see Jobs and Scheduling in the Apache Flink Documentation. To retrieve the job plan for the application, use the DescribeApplicationRequest$IncludeAdditionalDetails parameter of the DescribeApplication operation.

application_detail.application_configuration_description.flink_application_configuration_description.monitoring_configuration_description

Describes configuration parameters for Amazon CloudWatch logging for an application.

Show child fields
application_detail.application_configuration_description.flink_application_configuration_description.monitoring_configuration_description.configuration_type

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

application_detail.application_configuration_description.flink_application_configuration_description.monitoring_configuration_description.log_level

Describes the verbosity of the CloudWatch Logs for an application.

application_detail.application_configuration_description.flink_application_configuration_description.monitoring_configuration_description.metrics_level

Describes the granularity of the CloudWatch Logs for an application.

application_detail.application_configuration_description.flink_application_configuration_description.parallelism_configuration_description

Describes parameters for how an application executes multiple tasks simultaneously.

Show child fields
application_detail.application_configuration_description.flink_application_configuration_description.parallelism_configuration_description.auto_scaling_enabled

Describes whether the Managed Service for Apache Flink service can increase the parallelism of the application in response to increased throughput.

application_detail.application_configuration_description.flink_application_configuration_description.parallelism_configuration_description.configuration_type

Describes whether the application uses the default parallelism for the Managed Service for Apache Flink service.

application_detail.application_configuration_description.flink_application_configuration_description.parallelism_configuration_description.current_parallelism

Describes the current number of parallel tasks that a Managed Service for Apache Flink application can perform. If AutoScalingEnabled is set to True, Managed Service for Apache Flink 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.

application_detail.application_configuration_description.flink_application_configuration_description.parallelism_configuration_description.parallelism

Describes the initial number of parallel tasks that a Managed Service for Apache Flink application can perform. If AutoScalingEnabled is set to True, then Managed Service for Apache Flink 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.

application_detail.application_configuration_description.flink_application_configuration_description.parallelism_configuration_description.parallelism_per_kpu

Describes the number of parallel tasks that a Managed Service for Apache Flink application can perform per Kinesis Processing Unit (KPU) used by the application.

application_detail.application_configuration_description.run_configuration_description

The details about the starting properties for a Managed Service for Apache Flink application.

Show child fields
application_detail.application_configuration_description.run_configuration_description.application_restore_configuration_description

Describes the restore behavior of a restarting application.

Show child fields
application_detail.application_configuration_description.run_configuration_description.application_restore_configuration_description.application_restore_type

Specifies how the application should be restored.

application_detail.application_configuration_description.run_configuration_description.application_restore_configuration_description.snapshot_name

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.

application_detail.application_configuration_description.run_configuration_description.flink_run_configuration_description

Describes the starting parameters for a Managed Service for Apache Flink application.

Show child fields
application_detail.application_configuration_description.run_configuration_description.flink_run_configuration_description.allow_non_restored_state

When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program. This will happen if the program is updated between snapshots to remove stateful parameters, and state data in the snapshot no longer corresponds to valid application data. For more information, see Allowing Non-Restored State in the Apache Flink documentation.

This value defaults to false. If you update your application without specifying this parameter, AllowNonRestoredState will be set to false, even if it was previously set to true.

application_detail.application_configuration_description.sql_application_configuration_description

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

Show child fields
application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[]
Show child fields
application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[].in_app_stream_names[]
application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[].input_id

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.

application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[].input_parallelism

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

Show child fields
application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[].input_parallelism.count

The number of in-application streams to create.

application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[].input_processing_configuration_description

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

Show child fields
application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[].input_processing_configuration_description.input_lambda_processor_description

Provides configuration information about the associated InputLambdaProcessorDescription

Show child fields
application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[].input_processing_configuration_description.input_lambda_processor_description.resource_arn

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

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

application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[].input_processing_configuration_description.input_lambda_processor_description.role_arn

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

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

application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[].input_schema

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.

Show child fields
application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[].input_schema.record_columns[]
Show child fields
application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[].input_schema.record_columns[].mapping

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

application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[].input_schema.record_columns[].name

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

application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[].input_schema.record_columns[].sql_type

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

application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[].input_schema.record_encoding

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

application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[].input_schema.record_format

Specifies the format of the records on the streaming source.

Show child fields
application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[].input_schema.record_format.mapping_parameters

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.

Show child fields
application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[].input_schema.record_format.mapping_parameters.csv_mapping_parameters

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

Show child fields
application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[].input_schema.record_format.mapping_parameters.csv_mapping_parameters.record_column_delimiter

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

application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[].input_schema.record_format.mapping_parameters.csv_mapping_parameters.record_row_delimiter

The row delimiter. For example, in a CSV format, '\n' is the typical row delimiter.

application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[].input_schema.record_format.mapping_parameters.json_mapping_parameters

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

Show child fields
application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[].input_schema.record_format.mapping_parameters.json_mapping_parameters.record_row_path

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

application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[].input_schema.record_format.record_format_type

The type of record format.

application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[].input_starting_position_configuration

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

Show child fields
application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[].input_starting_position_configuration.input_starting_position

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.

application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[].kinesis_firehose_input_description

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

Show child fields
application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[].kinesis_firehose_input_description.resource_arn

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

application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[].kinesis_firehose_input_description.role_arn

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

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

application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[].kinesis_streams_input_description

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

Show child fields
application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[].kinesis_streams_input_description.resource_arn

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

application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[].kinesis_streams_input_description.role_arn

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

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

application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[].name_prefix

The in-application name prefix.

application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[]
Show child fields
application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[].destination_schema

The data format used for writing data to the destination.

Show child fields
application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[].destination_schema.record_format_type

Specifies the format of the records on the output stream.

application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[].kinesis_firehose_output_description

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

Show child fields
application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[].kinesis_firehose_output_description.resource_arn

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

application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[].kinesis_firehose_output_description.role_arn

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

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

application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[].kinesis_streams_output_description

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

Show child fields
application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[].kinesis_streams_output_description.resource_arn

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

application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[].kinesis_streams_output_description.role_arn

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

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

application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[].lambda_output_description

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

Show child fields
application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[].lambda_output_description.resource_arn

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

application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[].lambda_output_description.role_arn

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

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

application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[].name

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

application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[].output_id

A unique identifier for the output configuration.

application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[]
Show child fields
application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[].reference_id

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.

application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[].reference_schema

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.

Show child fields
application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[].reference_schema.record_columns[]
Show child fields
application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[].reference_schema.record_columns[].mapping

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

application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[].reference_schema.record_columns[].name

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

application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[].reference_schema.record_columns[].sql_type

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

application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[].reference_schema.record_encoding

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

application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[].reference_schema.record_format

Specifies the format of the records on the streaming source.

Show child fields
application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[].reference_schema.record_format.mapping_parameters

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.

Show child fields
application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[].reference_schema.record_format.mapping_parameters.csv_mapping_parameters

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

Show child fields
application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[].reference_schema.record_format.mapping_parameters.csv_mapping_parameters.record_column_delimiter

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

application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[].reference_schema.record_format.mapping_parameters.csv_mapping_parameters.record_row_delimiter

The row delimiter. For example, in a CSV format, '\n' is the typical row delimiter.

application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[].reference_schema.record_format.mapping_parameters.json_mapping_parameters

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

Show child fields
application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[].reference_schema.record_format.mapping_parameters.json_mapping_parameters.record_row_path

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

application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[].reference_schema.record_format.record_format_type

The type of record format.

application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[].s3_reference_data_source_description

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

Show child fields
application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[].s3_reference_data_source_description.bucket_arn

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

application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[].s3_reference_data_source_description.file_key

Amazon S3 object key name.

application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[].s3_reference_data_source_description.reference_role_arn

The ARN of the IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf to populate the in-application reference table.

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

application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[].table_name

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

application_detail.application_configuration_description.vpc_configuration_descriptions[]
Show child fields
application_detail.application_configuration_description.vpc_configuration_descriptions[].security_group_ids[]
application_detail.application_configuration_description.vpc_configuration_descriptions[].subnet_ids[]
application_detail.application_configuration_description.vpc_configuration_descriptions[].vpc_configuration_id

The ID of the VPC configuration.

application_detail.application_configuration_description.vpc_configuration_descriptions[].vpc_id

The ID of the associated VPC.

application_detail.application_configuration_description.zeppelin_application_configuration_description

The configuration parameters for a Managed Service for Apache Flink Studio notebook.

Show child fields
application_detail.application_configuration_description.zeppelin_application_configuration_description.catalog_configuration_description

The Amazon Glue Data Catalog that is associated with the Managed Service for Apache Flink Studio notebook.

Show child fields
application_detail.application_configuration_description.zeppelin_application_configuration_description.catalog_configuration_description.glue_data_catalog_configuration_description

The configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Managed Service for Apache Flink Studio notebook.

Show child fields
application_detail.application_configuration_description.zeppelin_application_configuration_description.catalog_configuration_description.glue_data_catalog_configuration_description.database_arn

The Amazon Resource Name (ARN) of the database.

application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[]
Show child fields
application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[].artifact_type

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.

application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[].maven_reference_description

The parameters that are required to specify a Maven dependency.

Show child fields
application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[].maven_reference_description.artifact_id

The artifact ID of the Maven reference.

application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[].maven_reference_description.group_id

The group ID of the Maven reference.

application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[].maven_reference_description.version

The version of the Maven reference.

application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[].s3_content_location_description

For a Managed Service for Apache Flink 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.

Show child fields
application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[].s3_content_location_description.bucket_arn

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

application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[].s3_content_location_description.file_key

The file key for the object containing the application code.

application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[].s3_content_location_description.object_version

The version of the object containing the application code.

application_detail.application_configuration_description.zeppelin_application_configuration_description.deploy_as_application_configuration_description

The parameters required to deploy a Managed Service for Apache Flink Studio notebook as an application with durable state.

Show child fields
application_detail.application_configuration_description.zeppelin_application_configuration_description.deploy_as_application_configuration_description.s3_content_location_description

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

Show child fields
application_detail.application_configuration_description.zeppelin_application_configuration_description.deploy_as_application_configuration_description.s3_content_location_description.base_path

The base path for the S3 bucket.

application_detail.application_configuration_description.zeppelin_application_configuration_description.deploy_as_application_configuration_description.s3_content_location_description.bucket_arn

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

application_detail.application_configuration_description.zeppelin_application_configuration_description.monitoring_configuration_description

The monitoring configuration of a Managed Service for Apache Flink Studio notebook.

Show child fields
application_detail.application_configuration_description.zeppelin_application_configuration_description.monitoring_configuration_description.log_level

Describes the verbosity of the CloudWatch Logs for an application.

application_detail.application_description

The description of the application.

application_detail.application_maintenance_configuration_description

The details of the maintenance configuration for the application.

Show child fields
application_detail.application_maintenance_configuration_description.application_maintenance_window_end_time

The end time for the maintenance window.

application_detail.application_maintenance_configuration_description.application_maintenance_window_start_time

The start time for the maintenance window.

application_detail.application_mode

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.

application_detail.application_name

The name of the application.

application_detail.application_status

The status of the application.

application_detail.application_version_create_timestamp

The current timestamp when the application version was created.

application_detail.application_version_id

Provides the current application version. Managed Service for Apache Flink updates the ApplicationVersionId each time you update the application.

application_detail.application_version_rolled_back_from

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

application_detail.application_version_rolled_back_to

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

application_detail.application_version_updated_from

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

application_detail.cloud_watch_logging_option_descriptions[]
Show child fields
application_detail.cloud_watch_logging_option_descriptions[].cloud_watch_logging_option_id

The ID of the CloudWatch logging option description.

application_detail.cloud_watch_logging_option_descriptions[].log_stream_arn

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

application_detail.cloud_watch_logging_option_descriptions[].role_arn

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

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

application_detail.conditional_token

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

application_detail.create_timestamp

The current timestamp when the application was created.

application_detail.last_update_timestamp

The current timestamp when the application was last updated.

application_detail.runtime_environment

The runtime environment for the application.

application_detail.service_execution_role

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