Skip to content
AWS for Query.Farm

aws.timestream_query.describe_scheduled_query

Example SQL Queries

SELECT * FROM
aws.timestream_query.describe_scheduled_query
WHERE
"scheduled_query_arn" = 'VALUE';

Description

Provides detailed information about a scheduled query.

Table Definition

Column NameColumn Data Type
scheduled_query_arn Required Input Column

The ARN of the scheduled query.

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.

scheduled_query

The scheduled query.

STRUCT(
    "arn" VARCHAR,
    "name" VARCHAR,
    "query_string" VARCHAR,
    "creation_time" TIMESTAMP_S,
    "state" VARCHAR,
    "previous_invocation_time" TIMESTAMP_S,
    "next_invocation_time" TIMESTAMP_S,
    "schedule_configuration" STRUCT(
        "schedule_expression" VARCHAR
    ),
    "notification_configuration" STRUCT(
        "sns_configuration" STRUCT(
            "topic_arn" VARCHAR
        )
    ),
    "target_configuration" STRUCT(
        "timestream_configuration" STRUCT(
            "database_name" VARCHAR,
            "table_name" VARCHAR,
            "time_column" VARCHAR,
            "dimension_mappings" STRUCT(
                "name" VARCHAR,
                "dimension_value_type" VARCHAR
            )[],
            "multi_measure_mappings" STRUCT(
                "target_multi_measure_name" VARCHAR,
                "multi_measure_attribute_mappings" STRUCT(
                    "source_column" VARCHAR,
                    "target_multi_measure_attribute_name" VARCHAR,
                    "measure_value_type" VARCHAR
                )[]
            ),
            "mixed_measure_mappings" STRUCT(
                "measure_name" VARCHAR,
                "source_column" VARCHAR,
                "target_measure_name" VARCHAR,
                "measure_value_type" VARCHAR,
                "multi_measure_attribute_mappings" STRUCT(
                    "source_column" VARCHAR,
                    "target_multi_measure_attribute_name" VARCHAR,
                    "measure_value_type" VARCHAR
                )[]
            )[],
            "measure_name_column" VARCHAR
        )
    ),
    "scheduled_query_execution_role_arn" VARCHAR,
    "kms_key_id" VARCHAR,
    "error_report_configuration" STRUCT(
        "s3_configuration" STRUCT(
            "bucket_name" VARCHAR,
            "object_key_prefix" VARCHAR,
            "encryption_option" VARCHAR
        )
    ),
    "last_run_summary" STRUCT(
        "invocation_time" TIMESTAMP_S,
        "trigger_time" TIMESTAMP_S,
        "run_status" VARCHAR,
        "execution_stats" STRUCT(
            "execution_time_in_millis" BIGINT,
            "data_writes" BIGINT,
            "bytes_metered" BIGINT,
            "cumulative_bytes_scanned" BIGINT,
            "records_ingested" BIGINT,
            "query_result_rows" BIGINT
        ),
        "error_report_location" STRUCT(
            "s3_report_location" STRUCT(
                "bucket_name" VARCHAR,
                "object_key" VARCHAR
            )
        ),
        "failure_reason" VARCHAR
    ),
    "recently_failed_runs" STRUCT(
        "invocation_time" TIMESTAMP_S,
        "trigger_time" TIMESTAMP_S,
        "run_status" VARCHAR,
        "execution_stats" STRUCT(
            "execution_time_in_millis" BIGINT,
            "data_writes" BIGINT,
            "bytes_metered" BIGINT,
            "cumulative_bytes_scanned" BIGINT,
            "records_ingested" BIGINT,
            "query_result_rows" BIGINT
        ),
        "error_report_location" STRUCT(
            "s3_report_location" STRUCT(
                "bucket_name" VARCHAR,
                "object_key" VARCHAR
            )
        ),
        "failure_reason" VARCHAR
    )[]
)
Show child fields
scheduled_query.arn

Scheduled query ARN.

scheduled_query.creation_time

Creation time of the scheduled query.

scheduled_query.error_report_configuration

Error-reporting configuration for the scheduled query.

Show child fields
scheduled_query.error_report_configuration.s3_configuration

The S3 configuration for the error reports.

Show child fields
scheduled_query.error_report_configuration.s3_configuration.bucket_name

Name of the S3 bucket under which error reports will be created.

scheduled_query.error_report_configuration.s3_configuration.encryption_option

Encryption at rest options for the error reports. If no encryption option is specified, Timestream will choose SSE_S3 as default.

scheduled_query.error_report_configuration.s3_configuration.object_key_prefix

Prefix for the error report key. Timestream by default adds the following prefix to the error report path.

scheduled_query.kms_key_id

A customer provided KMS key used to encrypt the scheduled query resource.

scheduled_query.last_run_summary

Runtime summary for the last scheduled query run.

Show child fields
scheduled_query.last_run_summary.error_report_location

S3 location for error report.

Show child fields
scheduled_query.last_run_summary.error_report_location.s3_report_location

The S3 location where error reports are written.

Show child fields
scheduled_query.last_run_summary.error_report_location.s3_report_location.bucket_name

S3 bucket name.

scheduled_query.last_run_summary.error_report_location.s3_report_location.object_key

S3 key.

scheduled_query.last_run_summary.execution_stats

Runtime statistics for a scheduled run.

Show child fields
scheduled_query.last_run_summary.execution_stats.bytes_metered

Bytes metered for a single scheduled query run.

scheduled_query.last_run_summary.execution_stats.cumulative_bytes_scanned

Bytes scanned for a single scheduled query run.

scheduled_query.last_run_summary.execution_stats.data_writes

Data writes metered for records ingested in a single scheduled query run.

scheduled_query.last_run_summary.execution_stats.execution_time_in_millis

Total time, measured in milliseconds, that was needed for the scheduled query run to complete.

scheduled_query.last_run_summary.execution_stats.query_result_rows

Number of rows present in the output from running a query before ingestion to destination data source.

scheduled_query.last_run_summary.execution_stats.records_ingested

The number of records ingested for a single scheduled query run.

scheduled_query.last_run_summary.failure_reason

Error message for the scheduled query in case of failure. You might have to look at the error report to get more detailed error reasons.

scheduled_query.last_run_summary.invocation_time

InvocationTime for this run. This is the time at which the query is scheduled to run. Parameter @scheduled_runtime can be used in the query to get the value.

scheduled_query.last_run_summary.run_status

The status of a scheduled query run.

scheduled_query.last_run_summary.trigger_time

The actual time when the query was run.

scheduled_query.name

Name of the scheduled query.

scheduled_query.next_invocation_time

The next time the scheduled query is scheduled to run.

scheduled_query.notification_configuration

Notification configuration.

Show child fields
scheduled_query.notification_configuration.sns_configuration

Details on SNS configuration.

Show child fields
scheduled_query.notification_configuration.sns_configuration.topic_arn

SNS topic ARN that the scheduled query status notifications will be sent to.

scheduled_query.previous_invocation_time

Last time the query was run.

scheduled_query.query_string

The query to be run.

scheduled_query.recently_failed_runs[]
Show child fields
scheduled_query.recently_failed_runs[].error_report_location

S3 location for error report.

Show child fields
scheduled_query.recently_failed_runs[].error_report_location.s3_report_location

The S3 location where error reports are written.

Show child fields
scheduled_query.recently_failed_runs[].error_report_location.s3_report_location.bucket_name

S3 bucket name.

scheduled_query.recently_failed_runs[].error_report_location.s3_report_location.object_key

S3 key.

scheduled_query.recently_failed_runs[].execution_stats

Runtime statistics for a scheduled run.

Show child fields
scheduled_query.recently_failed_runs[].execution_stats.bytes_metered

Bytes metered for a single scheduled query run.

scheduled_query.recently_failed_runs[].execution_stats.cumulative_bytes_scanned

Bytes scanned for a single scheduled query run.

scheduled_query.recently_failed_runs[].execution_stats.data_writes

Data writes metered for records ingested in a single scheduled query run.

scheduled_query.recently_failed_runs[].execution_stats.execution_time_in_millis

Total time, measured in milliseconds, that was needed for the scheduled query run to complete.

scheduled_query.recently_failed_runs[].execution_stats.query_result_rows

Number of rows present in the output from running a query before ingestion to destination data source.

scheduled_query.recently_failed_runs[].execution_stats.records_ingested

The number of records ingested for a single scheduled query run.

scheduled_query.recently_failed_runs[].failure_reason

Error message for the scheduled query in case of failure. You might have to look at the error report to get more detailed error reasons.

scheduled_query.recently_failed_runs[].invocation_time

InvocationTime for this run. This is the time at which the query is scheduled to run. Parameter @scheduled_runtime can be used in the query to get the value.

scheduled_query.recently_failed_runs[].run_status

The status of a scheduled query run.

scheduled_query.recently_failed_runs[].trigger_time

The actual time when the query was run.

scheduled_query.schedule_configuration

Schedule configuration.

Show child fields
scheduled_query.schedule_configuration.schedule_expression

An expression that denotes when to trigger the scheduled query run. This can be a cron expression or a rate expression.

scheduled_query.scheduled_query_execution_role_arn

IAM role that Timestream uses to run the schedule query.

scheduled_query.state

State of the scheduled query.

scheduled_query.target_configuration

Scheduled query target store configuration.

Show child fields
scheduled_query.target_configuration.timestream_configuration

Configuration needed to write data into the Timestream database and table.

Show child fields
scheduled_query.target_configuration.timestream_configuration.database_name

Name of Timestream database to which the query result will be written.

scheduled_query.target_configuration.timestream_configuration.dimension_mappings[]
Show child fields
scheduled_query.target_configuration.timestream_configuration.dimension_mappings[].dimension_value_type

Type for the dimension.

scheduled_query.target_configuration.timestream_configuration.dimension_mappings[].name

Column name from query result.

scheduled_query.target_configuration.timestream_configuration.measure_name_column

Name of the measure column.

scheduled_query.target_configuration.timestream_configuration.mixed_measure_mappings[]
Show child fields
scheduled_query.target_configuration.timestream_configuration.mixed_measure_mappings[].measure_name

Refers to the value of measure_name in a result row. This field is required if MeasureNameColumn is provided.

scheduled_query.target_configuration.timestream_configuration.mixed_measure_mappings[].measure_value_type

Type of the value that is to be read from sourceColumn. If the mapping is for MULTI, use MeasureValueType.MULTI.

scheduled_query.target_configuration.timestream_configuration.mixed_measure_mappings[].multi_measure_attribute_mappings[]
Show child fields
scheduled_query.target_configuration.timestream_configuration.mixed_measure_mappings[].multi_measure_attribute_mappings[].measure_value_type

Type of the attribute to be read from the source column.

scheduled_query.target_configuration.timestream_configuration.mixed_measure_mappings[].multi_measure_attribute_mappings[].source_column

Source column from where the attribute value is to be read.

scheduled_query.target_configuration.timestream_configuration.mixed_measure_mappings[].multi_measure_attribute_mappings[].target_multi_measure_attribute_name

Custom name to be used for attribute name in derived table. If not provided, source column name would be used.

scheduled_query.target_configuration.timestream_configuration.mixed_measure_mappings[].source_column

This field refers to the source column from which measure-value is to be read for result materialization.

scheduled_query.target_configuration.timestream_configuration.mixed_measure_mappings[].target_measure_name

Target measure name to be used. If not provided, the target measure name by default would be measure-name if provided, or sourceColumn otherwise.

scheduled_query.target_configuration.timestream_configuration.multi_measure_mappings

Multi-measure mappings.

Show child fields
scheduled_query.target_configuration.timestream_configuration.multi_measure_mappings.multi_measure_attribute_mappings[]
Show child fields
scheduled_query.target_configuration.timestream_configuration.multi_measure_mappings.multi_measure_attribute_mappings[].measure_value_type

Type of the attribute to be read from the source column.

scheduled_query.target_configuration.timestream_configuration.multi_measure_mappings.multi_measure_attribute_mappings[].source_column

Source column from where the attribute value is to be read.

scheduled_query.target_configuration.timestream_configuration.multi_measure_mappings.multi_measure_attribute_mappings[].target_multi_measure_attribute_name

Custom name to be used for attribute name in derived table. If not provided, source column name would be used.

scheduled_query.target_configuration.timestream_configuration.multi_measure_mappings.target_multi_measure_name

The name of the target multi-measure name in the derived table. This input is required when measureNameColumn is not provided. If MeasureNameColumn is provided, then value from that column will be used as multi-measure name.

scheduled_query.target_configuration.timestream_configuration.table_name

Name of Timestream table that the query result will be written to. The table should be within the same database that is provided in Timestream configuration.

scheduled_query.target_configuration.timestream_configuration.time_column

Column from query result that should be used as the time column in destination table. Column type for this should be TIMESTAMP.