Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListCrawls

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.

Request Syntax


{
   "CrawlerName": "string",
   "Filters": [ 
      { 
         "FieldName": "string",
         "FieldValue": "string",
         "FilterOperator": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

CrawlerName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: Yes

Filters

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

Type: Array of CrawlsFilter objects

Required: No

MaxResults

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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

NextToken

A continuation token, if this is a continuation call.

Type: String

Required: No

Response Syntax


{
   "Crawls": [ 
      { 
         "CrawlId": "string",
         "DPUHour": number,
         "EndTime": number,
         "ErrorMessage": "string",
         "LogGroup": "string",
         "LogStream": "string",
         "MessagePrefix": "string",
         "StartTime": number,
         "State": "string",
         "Summary": "string"
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Crawls

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

Type: Array of CrawlerHistory objects

NextToken

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

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

EntityNotFoundException

A specified entity does not exist

HTTP Status Code: 400

InvalidInputException

The input provided was not valid.

HTTP Status Code: 400

OperationTimeoutException

The operation timed out.

HTTP Status Code: 400