Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetCrawlerMetrics

Retrieves metrics about specified crawlers.

Request Syntax


{
   "CrawlerNameList": [ "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.

CrawlerNameList

A list of the names of crawlers about which to retrieve metrics.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 100 items.

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

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

Required: No

MaxResults

The maximum size of a list to return.

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


{
   "CrawlerMetricsList": [ 
      { 
         "CrawlerName": "string",
         "LastRuntimeSeconds": number,
         "MedianRuntimeSeconds": number,
         "StillEstimating": boolean,
         "TablesCreated": number,
         "TablesDeleted": number,
         "TablesUpdated": number,
         "TimeLeftSeconds": number
      }
   ],
   "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.

CrawlerMetricsList

A list of metrics for the specified crawler.

Type: Array of CrawlerMetrics objects

NextToken

A continuation token, if the returned list does not contain the last metric available.

Type: String

Errors

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

OperationTimeoutException

The operation timed out.

HTTP Status Code: 400