Skip to content
AWS for Query.Farm

aws.glue.list_crawls

Example SQL Queries

SELECT * FROM
aws.glue.list_crawls
WHERE
"crawler_name" = 'VALUE';

Description

Returns all the crawls of a specified crawler. Returns only the crawls that have occurred since the launch date of the crawler history feature, and only retains up to 12 months of crawls. Older crawls will not be returned.

You may use this API to:

  • Retrive all the crawls of a specified crawler.

  • Retrieve all the crawls of a specified crawler within a limited count.

  • Retrieve all the crawls of a specified crawler in a specific time range.

  • Retrieve all the crawls of a specified crawler with a particular state, crawl ID, or DPU hour value.

Table Definition

Column NameColumn Data Type
crawler_name Required Input Column

The name of the crawler whose runs you want to retrieve.

VARCHAR
filters Input Column

Filters the crawls by the criteria you specify in a list of CrawlsFilter objects.

STRUCT(
    "field_name" VARCHAR,
    "filter_operator" VARCHAR,
    "field_value" VARCHAR
)[]
Show child fields
filters[]
Show child fields
filters[].field_name

A key used to filter the crawler runs for a specified crawler. Valid values for each of the field names are:

  • CRAWL_ID: A string representing the UUID identifier for a crawl.

  • STATE: A string representing the state of the crawl.

  • START_TIME and END_TIME: The epoch timestamp in milliseconds.

  • DPU_HOUR: The number of data processing unit (DPU) hours used for the crawl.

filters[].field_value

The value provided for comparison on the crawl field.

filters[].filter_operator

A defined comparator that operates on the value. The available operators are:

  • GT: Greater than.

  • GE: Greater than or equal to.

  • LT: Less than.

  • LE: Less than or equal to.

  • EQ: Equal to.

  • NE: Not equal to.

max_results Input Column

The maximum number of results to return. The default is 20, and maximum is 100.

BIGINT
next_token Input Column

A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.

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
crawls

A list of CrawlerHistory objects representing the crawl runs that meet your criteria.

STRUCT(
    "crawl_id" VARCHAR,
    "state" VARCHAR,
    "start_time" TIMESTAMP_S,
    "end_time" TIMESTAMP_S,
    "summary" VARCHAR,
    "error_message" VARCHAR,
    "log_group" VARCHAR,
    "log_stream" VARCHAR,
    "message_prefix" VARCHAR,
    "dpu_hour" DOUBLE
)[]
Show child fields
crawls[]
Show child fields
crawls[].crawl_id

A UUID identifier for each crawl.

crawls[].dpu_hour

The number of data processing units (DPU) used in hours for the crawl.

crawls[].end_time

The date and time on which the crawl ended.

crawls[].error_message

If an error occurred, the error message associated with the crawl.

crawls[].log_group

The log group associated with the crawl.

crawls[].log_stream

The log stream associated with the crawl.

crawls[].message_prefix

The prefix for a CloudWatch message about this crawl.

crawls[].start_time

The date and time on which the crawl started.

crawls[].state

The state of the crawl.

crawls[].summary

A run summary for the specific crawl in JSON. Contains the catalog tables and partitions that were added, updated, or deleted.