Skip to content
AWS for Query.Farm

aws.logs.describe_query_definitions

Example SQL Queries

SELECT * FROM
aws.logs.describe_query_definitions;

Description

This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions. You can retrieve query definitions from the current account or from a source account that is linked to the current account.

You can use the queryDefinitionNamePrefix parameter to limit the results to only the query definitions that have names that start with a certain string.

Table Definition

Column NameColumn Data Type
max_results Input Column

Limits the number of returned query definitions to the specified number.

BIGINT
next_token Input Column

The token for the next set of items to return. The token expires after 24 hours.

VARCHAR
query_definition_name_prefix Input Column

Use this parameter to filter your results to only the query definitions that have names that start with the prefix you specify.

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
query_definitions

The list of query definitions that match your request.

STRUCT(
    "query_definition_id" VARCHAR,
    "name" VARCHAR,
    "query_string" VARCHAR,
    "last_modified" BIGINT,
    "log_group_names" VARCHAR[]
)[]
Show child fields
query_definitions[]
Show child fields
query_definitions[].last_modified

The date that the query definition was most recently modified.

query_definitions[].log_group_names[]
query_definitions[].name

The name of the query definition.

query_definitions[].query_definition_id

The unique ID of the query definition.

query_definitions[].query_string

The query string to use for this definition. For more information, see CloudWatch Logs Insights Query Syntax.