Skip to content

List Crawls

glue_list_crawls R Documentation

Returns all the crawls of a specified crawler

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.

Usage

glue_list_crawls(CrawlerName, MaxResults, Filters, NextToken)

Arguments

CrawlerName

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

MaxResults

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

Filters

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

NextToken

A continuation token, if this is a continuation call.

Value

A list with the following syntax:

list(
  Crawls = list(
    list(
      CrawlId = "string",
      State = "RUNNING"|"COMPLETED"|"FAILED"|"STOPPED",
      StartTime = as.POSIXct(
        "2015-01-01"
      ),
      EndTime = as.POSIXct(
        "2015-01-01"
      ),
      Summary = "string",
      ErrorMessage = "string",
      LogGroup = "string",
      LogStream = "string",
      MessagePrefix = "string",
      DPUHour = 123.0
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_crawls(
  CrawlerName = "string",
  MaxResults = 123,
  Filters = list(
    list(
      FieldName = "CRAWL_ID"|"STATE"|"START_TIME"|"END_TIME"|"DPU_HOUR",
      FilterOperator = "GT"|"GE"|"LT"|"LE"|"EQ"|"NE",
      FieldValue = "string"
    )
  ),
  NextToken = "string"
)