Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListCrawlers

Retrieves the names of all crawler resources in this AWS account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.

This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.

Request Syntax


{
   "MaxResults": number,
   "NextToken": "string",
   "Tags": { 
      "string" : "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.

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 request.

Type: String

Required: No

Tags

Specifies to return only these tagged resources.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax


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

CrawlerNames

The names of all crawlers in the account, or the crawlers with the specified tags.

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]*

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