Skip to content

aws.kinesisanalytics.describe_application

Example SQL Queries

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

Description

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.

Table Definition

Column NameColumn Data Type
application_name Required Input Column

Name of the application.

VARCHAR
_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.

_aws_region Input Column

The AWS region to use.

VARCHAR
application_detail

Provides a description of the application, such as the application Amazon Resource Name (ARN), status, latest version, and input and output configuration details.

STRUCT(
"application_name" VARCHAR,
"application_description" VARCHAR,
"application_arn" VARCHAR,
"application_status" VARCHAR,
"create_timestamp" TIMESTAMP_S,
"last_update_timestamp" TIMESTAMP_S,
"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
)[]
)
)[],
"cloud_watch_logging_option_descriptions" STRUCT(
"cloud_watch_logging_option_id" VARCHAR,
"log_stream_arn" VARCHAR,
"role_arn" VARCHAR
)[],
"application_code" VARCHAR,
"application_version_id" BIGINT
)
Show child fields
application_detail.application_arn

ARN of the application.

application_detail.application_code

Returns the application code that you provided to perform data analysis on any of the in-application streams in your application.

application_detail.application_description

Description of the application.

application_detail.application_name

Name of the application.

application_detail.application_status

Status of the application.

application_detail.application_version_id

Provides the current application version.

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

ID of the CloudWatch logging option description.

application_detail.cloud_watch_logging_option_descriptions[].log_stream_arn

ARN of the CloudWatch log to receive application messages.

application_detail.cloud_watch_logging_option_descriptions[].role_arn

IAM ARN of the role to use to send application messages. Note: To write application messages to CloudWatch, the IAM role used must have the PutLogEvents policy action enabled.

application_detail.create_timestamp

Time stamp when the application version was created.

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

Input ID associated with the application input. This is the ID that Amazon Kinesis Analytics assigns to each input configuration you add to your application.

application_detail.input_descriptions[].input_parallelism

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

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

Number of in-application streams to create. For more information, see Limits.

application_detail.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.input_descriptions[].input_processing_configuration_description.input_lambda_processor_description

Provides configuration information about the associated InputLambdaProcessorDescription.

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

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

application_detail.input_descriptions[].input_processing_configuration_description.input_lambda_processor_description.role_arn

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

application_detail.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.input_descriptions[].input_schema.record_columns[]
Show child fields
application_detail.input_descriptions[].input_schema.record_columns[].mapping

Reference to the data element in the streaming input or the reference data source. This element is required if the RecordFormatType is JSON.

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

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

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

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

application_detail.input_descriptions[].input_schema.record_encoding

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

application_detail.input_descriptions[].input_schema.record_format

Specifies the format of the records on the streaming source.

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

When configuring 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.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.input_descriptions[].input_schema.record_format.mapping_parameters.csv_mapping_parameters.record_column_delimiter

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

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

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

application_detail.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.input_descriptions[].input_schema.record_format.mapping_parameters.json_mapping_parameters.record_row_path

Path to the top-level parent that contains the records.

application_detail.input_descriptions[].input_schema.record_format.record_format_type

The type of record format.

application_detail.input_descriptions[].input_starting_position_configuration

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

Show child fields
application_detail.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, start at the request time stamp 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 Firehose delivery stream.

  • LAST_STOPPED_POINT - Resume reading from where the application last stopped reading.

application_detail.input_descriptions[].kinesis_firehose_input_description

If an Amazon Kinesis Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.

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

Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream.

application_detail.input_descriptions[].kinesis_firehose_input_description.role_arn

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

application_detail.input_descriptions[].kinesis_streams_input_description

If an Amazon Kinesis stream is configured as streaming source, provides Amazon Kinesis stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.

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

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

application_detail.input_descriptions[].kinesis_streams_input_description.role_arn

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

application_detail.input_descriptions[].name_prefix

In-application name prefix.

application_detail.last_update_timestamp

Time stamp when the application was last updated.

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

Data format used for writing data to the destination.

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

Specifies the format of the records on the output stream.

application_detail.output_descriptions[].kinesis_firehose_output_description

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

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

Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream.

application_detail.output_descriptions[].kinesis_firehose_output_description.role_arn

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

application_detail.output_descriptions[].kinesis_streams_output_description

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

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

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

application_detail.output_descriptions[].kinesis_streams_output_description.role_arn

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

application_detail.output_descriptions[].lambda_output_description

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

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

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

application_detail.output_descriptions[].lambda_output_description.role_arn

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

application_detail.output_descriptions[].name

Name of the in-application stream configured as output.

application_detail.output_descriptions[].output_id

A unique identifier for the output configuration.

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

ID of the reference data source. This is the ID that Amazon Kinesis Analytics assigns when you add the reference data source to your application using the AddApplicationReferenceDataSource operation.

application_detail.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.reference_data_source_descriptions[].reference_schema.record_columns[]
Show child fields
application_detail.reference_data_source_descriptions[].reference_schema.record_columns[].mapping

Reference to the data element in the streaming input or the reference data source. This element is required if the RecordFormatType is JSON.

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

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

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

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

application_detail.reference_data_source_descriptions[].reference_schema.record_encoding

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

application_detail.reference_data_source_descriptions[].reference_schema.record_format

Specifies the format of the records on the streaming source.

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

When configuring 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.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.reference_data_source_descriptions[].reference_schema.record_format.mapping_parameters.csv_mapping_parameters.record_column_delimiter

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

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

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

application_detail.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.reference_data_source_descriptions[].reference_schema.record_format.mapping_parameters.json_mapping_parameters.record_row_path

Path to the top-level parent that contains the records.

application_detail.reference_data_source_descriptions[].reference_schema.record_format.record_format_type

The type of record format.

application_detail.reference_data_source_descriptions[].s3_reference_data_source_description

Provides the S3 bucket name, the object key name that contains the reference data. It also provides the Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object and populate the in-application reference table.

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

Amazon Resource Name (ARN) of the S3 bucket.

application_detail.reference_data_source_descriptions[].s3_reference_data_source_description.file_key

Amazon S3 object key name.

application_detail.reference_data_source_descriptions[].s3_reference_data_source_description.reference_role_arn

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

application_detail.reference_data_source_descriptions[].table_name

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