Skip to content
AWS for Query.Farm

aws.iot.describe_fleet_metric

Example SQL Queries

SELECT * FROM
aws.iot.describe_fleet_metric
WHERE
"metric_name" = 'VALUE';

Description

Gets information about the specified fleet metric.

Requires permission to access the DescribeFleetMetric action.

Table Definition

Column NameColumn Data Type
metric_name Required Input Column

The name of the fleet metric to describe.

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
aggregation_field

The field to aggregate.

VARCHAR
aggregation_type

The type of the aggregation query.

STRUCT(
    "name" VARCHAR,
    "values" VARCHAR[]
)
Show child fields
aggregation_type.name

The name of the aggregation type.

aggregation_type.values[]
creation_date

The date when the fleet metric is created.

TIMESTAMP_S
description

The fleet metric description.

VARCHAR
index_name

The name of the index to search.

VARCHAR
last_modified_date

The date when the fleet metric is last modified.

TIMESTAMP_S
metric_arn

The ARN of the fleet metric to describe.

VARCHAR
period

The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.

BIGINT
query_string

The search query string.

VARCHAR
query_version

The query version.

VARCHAR
unit

Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric.

VARCHAR
version

The version of the fleet metric.

BIGINT