Skip to content
AWS for Query.Farm

aws.lookoutmetrics.describe_metric_set

Example SQL Queries

SELECT * FROM
aws.lookoutmetrics.describe_metric_set
WHERE
"metric_set_arn" = 'VALUE';

Description

Describes a dataset.

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.

Table Definition

Column NameColumn Data Type
metric_set_arn Required Input Column

The ARN of the dataset.

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
anomaly_detector_arn

The ARN of the detector that contains the dataset.

VARCHAR
creation_time

The time at which the dataset was created.

TIMESTAMP_S
dimension_filter_list

The dimensions and their values that were used to filter the dataset.

STRUCT(
    "name" VARCHAR,
    "filter_list" STRUCT(
        "dimension_value" VARCHAR,
        "filter_operation" VARCHAR
    )[]
)[]
Show child fields
dimension_filter_list[]
Show child fields
dimension_filter_list[].filter_list[]
Show child fields
dimension_filter_list[].filter_list[].dimension_value

The value that you want to include in the filter.

dimension_filter_list[].filter_list[].filter_operation

The condition to apply.

dimension_filter_list[].name

The dimension that you want to filter on.

dimension_list

A list of the dimensions chosen for analysis.

VARCHAR[]
Show child fields
dimension_list[]
last_modification_time

The time at which the dataset was last modified.

TIMESTAMP_S
metric_list

A list of the metrics defined by the dataset.

STRUCT(
    "metric_name" VARCHAR,
    "aggregation_function" VARCHAR,
    "namespace" VARCHAR
)[]
Show child fields
metric_list[]
Show child fields
metric_list[].aggregation_function

The function with which the metric is calculated.

metric_list[].metric_name

The name of the metric.

metric_list[].namespace

The namespace for the metric.

metric_set_description

The dataset's description.

VARCHAR
metric_set_frequency

The interval at which the data will be analyzed for anomalies.

VARCHAR
metric_set_name

The name of the dataset.

VARCHAR
metric_source

Contains information about the dataset's source data.

STRUCT(
    "s3_source_config" STRUCT(
        "role_arn" VARCHAR,
        "templated_path_list" VARCHAR[],
        "historical_data_path_list" VARCHAR[],
        "file_format_descriptor" STRUCT(
            "csv_format_descriptor" STRUCT(
                "file_compression" VARCHAR,
                "charset" VARCHAR,
                "contains_header" BOOLEAN,
                "delimiter" VARCHAR,
                "header_list" VARCHAR[],
                "quote_symbol" VARCHAR
            ),
            "json_format_descriptor" STRUCT(
                "file_compression" VARCHAR,
                "charset" VARCHAR
            )
        )
    ),
    "app_flow_config" STRUCT(
        "role_arn" VARCHAR,
        "flow_name" VARCHAR
    ),
    "cloud_watch_config" STRUCT(
        "role_arn" VARCHAR,
        "back_test_configuration" STRUCT(
            "run_back_test_mode" BOOLEAN
        )
    ),
    "rds_source_config" STRUCT(
        "db_instance_identifier" VARCHAR,
        "database_host" VARCHAR,
        "database_port" BIGINT,
        "secret_manager_arn" VARCHAR,
        "database_name" VARCHAR,
        "table_name" VARCHAR,
        "role_arn" VARCHAR,
        "vpc_configuration" STRUCT(
            "subnet_id_list" VARCHAR[],
            "security_group_id_list" VARCHAR[]
        )
    ),
    "redshift_source_config" STRUCT(
        "cluster_identifier" VARCHAR,
        "database_host" VARCHAR,
        "database_port" BIGINT,
        "secret_manager_arn" VARCHAR,
        "database_name" VARCHAR,
        "table_name" VARCHAR,
        "role_arn" VARCHAR,
        "vpc_configuration" STRUCT(
            "subnet_id_list" VARCHAR[],
            "security_group_id_list" VARCHAR[]
        )
    ),
    "athena_source_config" STRUCT(
        "role_arn" VARCHAR,
        "database_name" VARCHAR,
        "data_catalog" VARCHAR,
        "table_name" VARCHAR,
        "work_group_name" VARCHAR,
        "s3_results_path" VARCHAR,
        "back_test_configuration" STRUCT(
            "run_back_test_mode" BOOLEAN
        )
    )
)
Show child fields
metric_source.app_flow_config

Details about an AppFlow datasource.

Show child fields
metric_source.app_flow_config.flow_name

name of the flow.

metric_source.app_flow_config.role_arn

An IAM role that gives Amazon Lookout for Metrics permission to access the flow.

metric_source.athena_source_config

Details about an Amazon Athena datasource.

Show child fields
metric_source.athena_source_config.back_test_configuration

Settings for backtest mode.

Show child fields
metric_source.athena_source_config.back_test_configuration.run_back_test_mode

Run a backtest instead of monitoring new data.

metric_source.athena_source_config.data_catalog

The database's data catalog.

metric_source.athena_source_config.database_name

The database's name.

metric_source.athena_source_config.role_arn

An IAM role that gives Amazon Lookout for Metrics permission to access the data.

metric_source.athena_source_config.s3_results_path

The database's results path.

metric_source.athena_source_config.table_name

The database's table name.

metric_source.athena_source_config.work_group_name

The database's work group name.

metric_source.cloud_watch_config

Details about an Amazon CloudWatch monitoring datasource.

Show child fields
metric_source.cloud_watch_config.back_test_configuration

Settings for backtest mode.

Show child fields
metric_source.cloud_watch_config.back_test_configuration.run_back_test_mode

Run a backtest instead of monitoring new data.

metric_source.cloud_watch_config.role_arn

An IAM role that gives Amazon Lookout for Metrics permission to access data in Amazon CloudWatch.

metric_source.rds_source_config

Details about an Amazon Relational Database Service (RDS) datasource.

Show child fields
metric_source.rds_source_config.database_host

The host name of the database.

metric_source.rds_source_config.database_name

The name of the RDS database.

metric_source.rds_source_config.database_port

The port number where the database can be accessed.

metric_source.rds_source_config.db_instance_identifier

A string identifying the database instance.

metric_source.rds_source_config.role_arn

The Amazon Resource Name (ARN) of the role.

metric_source.rds_source_config.secret_manager_arn

The Amazon Resource Name (ARN) of the AWS Secrets Manager role.

metric_source.rds_source_config.table_name

The name of the table in the database.

metric_source.rds_source_config.vpc_configuration

An object containing information about the Amazon Virtual Private Cloud (VPC) configuration.

Show child fields
metric_source.rds_source_config.vpc_configuration.security_group_id_list[]
metric_source.rds_source_config.vpc_configuration.subnet_id_list[]
metric_source.redshift_source_config

Details about an Amazon Redshift database datasource.

Show child fields
metric_source.redshift_source_config.cluster_identifier

A string identifying the Redshift cluster.

metric_source.redshift_source_config.database_host

The name of the database host.

metric_source.redshift_source_config.database_name

The Redshift database name.

metric_source.redshift_source_config.database_port

The port number where the database can be accessed.

metric_source.redshift_source_config.role_arn

The Amazon Resource Name (ARN) of the role providing access to the database.

metric_source.redshift_source_config.secret_manager_arn

The Amazon Resource Name (ARN) of the AWS Secrets Manager role.

metric_source.redshift_source_config.table_name

The table name of the Redshift database.

metric_source.redshift_source_config.vpc_configuration

Contains information about the Amazon Virtual Private Cloud (VPC) configuration.

Show child fields
metric_source.redshift_source_config.vpc_configuration.security_group_id_list[]
metric_source.redshift_source_config.vpc_configuration.subnet_id_list[]
metric_source.s3_source_config

Contains information about the configuration of the S3 bucket that contains source files.

Show child fields
metric_source.s3_source_config.file_format_descriptor

Contains information about a source file's formatting.

Show child fields
metric_source.s3_source_config.file_format_descriptor.csv_format_descriptor

Contains information about how a source CSV data file should be analyzed.

Show child fields
metric_source.s3_source_config.file_format_descriptor.csv_format_descriptor.charset

The character set in which the source CSV file is written.

metric_source.s3_source_config.file_format_descriptor.csv_format_descriptor.contains_header

Whether or not the source CSV file contains a header.

metric_source.s3_source_config.file_format_descriptor.csv_format_descriptor.delimiter

The character used to delimit the source CSV file.

metric_source.s3_source_config.file_format_descriptor.csv_format_descriptor.file_compression

The level of compression of the source CSV file.

metric_source.s3_source_config.file_format_descriptor.csv_format_descriptor.header_list[]
metric_source.s3_source_config.file_format_descriptor.csv_format_descriptor.quote_symbol

The character used as a quote character.

metric_source.s3_source_config.file_format_descriptor.json_format_descriptor

Contains information about how a source JSON data file should be analyzed.

Show child fields
metric_source.s3_source_config.file_format_descriptor.json_format_descriptor.charset

The character set in which the source JSON file is written.

metric_source.s3_source_config.file_format_descriptor.json_format_descriptor.file_compression

The level of compression of the source CSV file.

metric_source.s3_source_config.historical_data_path_list[]
metric_source.s3_source_config.role_arn

The ARN of an IAM role that has read and write access permissions to the source S3 bucket.

metric_source.s3_source_config.templated_path_list[]
offset

After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3, Redshift, Athena and datasources.

BIGINT
timestamp_column

Contains information about the column used for tracking time in your source data.

STRUCT(
    "column_name" VARCHAR,
    "column_format" VARCHAR
)
Show child fields
timestamp_column.column_format

The format of the timestamp column.

timestamp_column.column_name

The name of the timestamp column.

timezone

The time zone in which the dataset's data was recorded.

VARCHAR