crawls
Creates, updates, deletes, gets or lists a crawls resource.
Overview
| Name | crawls |
| Type | Resource |
| Id | aws.glue.crawls |
Fields
The following fields are returned by SELECT queries:
- list_crawls
| Name | Datatype | Description |
|---|---|---|
crawls | array | A list of CrawlerHistory objects representing the crawl runs that meet your criteria. |
next_token | string | A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_crawls | select | region | 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. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- list_crawls
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.
SELECT
crawls,
next_token
FROM aws.glue.crawls
WHERE region = '{{ region }}' -- required
;