Skip to content
AWS for Query.Farm

aws.cloudwatch.get_metric_stream

Example SQL Queries

SELECT * FROM
aws.cloudwatch.get_metric_stream
WHERE
"name" = 'VALUE';

Description

Returns information about the metric stream that you specify.

Table Definition

Column NameColumn Data Type
name Required Input Column

The name of the metric stream.

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.

arn

The ARN of the metric stream.

VARCHAR
creation_date

The date that the metric stream was created.

TIMESTAMP_S
exclude_filters

If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are not streamed by this metric stream. In this case, all other metric namespaces in the account are streamed by this metric stream.

STRUCT(
    "namespace" VARCHAR,
    "metric_names" VARCHAR[]
)[]
Show child fields
exclude_filters[]
Show child fields
exclude_filters[].metric_names[]
exclude_filters[].namespace

The name of the metric namespace for this filter.

The namespace can contain only ASCII printable characters (ASCII range 32 through 126). It must contain at least one non-whitespace character.

firehose_arn

The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this metric stream.

VARCHAR
include_filters

If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are streamed by this metric stream.

STRUCT(
    "namespace" VARCHAR,
    "metric_names" VARCHAR[]
)[]
Show child fields
include_filters[]
Show child fields
include_filters[].metric_names[]
include_filters[].namespace

The name of the metric namespace for this filter.

The namespace can contain only ASCII printable characters (ASCII range 32 through 126). It must contain at least one non-whitespace character.

include_linked_accounts_metrics

If this is true and this metric stream is in a monitoring account, then the stream includes metrics from source accounts that the monitoring account is linked to.

BOOLEAN
last_update_date

The date of the most recent update to the metric stream's configuration.

TIMESTAMP_S
output_format

The output format for the stream. Valid values are json, opentelemetry1.0, and opentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats.

VARCHAR
role_arn

The ARN of the IAM role that is used by this metric stream.

VARCHAR
state

The state of the metric stream. The possible values are running and stopped.

VARCHAR
statistics_configurations

Each entry in this array displays information about one or more metrics that include additional statistics in the metric stream. For more information about the additional statistics, see CloudWatch statistics definitions. 

STRUCT(
    "include_metrics" STRUCT(
        "namespace" VARCHAR,
        "metric_name" VARCHAR
    )[],
    "additional_statistics" VARCHAR[]
)[]
Show child fields
statistics_configurations[]
Show child fields
statistics_configurations[].additional_statistics[]
statistics_configurations[].include_metrics[]
Show child fields
statistics_configurations[].include_metrics[].metric_name

The name of the metric.

statistics_configurations[].include_metrics[].namespace

The namespace of the metric.