GetCrawlers
Retrieves metadata for all crawlers defined in the customer account.
Request Syntax
{
"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.
- MaxResults
-
The number of crawlers to return on each call.
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
Response Syntax
{
"Crawlers": [
{
"Classifiers": [ "string" ],
"Configuration": "string",
"CrawlElapsedTime": number,
"CrawlerSecurityConfiguration": "string",
"CreationTime": number,
"DatabaseName": "string",
"Description": "string",
"LakeFormationConfiguration": {
"AccountId": "string",
"UseLakeFormationCredentials": boolean
},
"LastCrawl": {
"ErrorMessage": "string",
"LogGroup": "string",
"LogStream": "string",
"MessagePrefix": "string",
"StartTime": number,
"Status": "string"
},
"LastUpdated": number,
"LineageConfiguration": {
"CrawlerLineageSettings": "string"
},
"Name": "string",
"RecrawlPolicy": {
"RecrawlBehavior": "string"
},
"Role": "string",
"Schedule": {
"ScheduleExpression": "string",
"State": "string"
},
"SchemaChangePolicy": {
"DeleteBehavior": "string",
"UpdateBehavior": "string"
},
"State": "string",
"TablePrefix": "string",
"Targets": {
"CatalogTargets": [
{
"ConnectionName": "string",
"DatabaseName": "string",
"DlqEventQueueArn": "string",
"EventQueueArn": "string",
"Tables": [ "string" ]
}
],
"DeltaTargets": [
{
"ConnectionName": "string",
"CreateNativeDeltaTable": boolean,
"DeltaTables": [ "string" ],
"WriteManifest": boolean
}
],
"DynamoDBTargets": [
{
"Path": "string",
"scanAll": boolean,
"scanRate": number
}
],
"HudiTargets": [
{
"ConnectionName": "string",
"Exclusions": [ "string" ],
"MaximumTraversalDepth": number,
"Paths": [ "string" ]
}
],
"IcebergTargets": [
{
"ConnectionName": "string",
"Exclusions": [ "string" ],
"MaximumTraversalDepth": number,
"Paths": [ "string" ]
}
],
"JdbcTargets": [
{
"ConnectionName": "string",
"EnableAdditionalMetadata": [ "string" ],
"Exclusions": [ "string" ],
"Path": "string"
}
],
"MongoDBTargets": [
{
"ConnectionName": "string",
"Path": "string",
"ScanAll": boolean
}
],
"S3Targets": [
{
"ConnectionName": "string",
"DlqEventQueueArn": "string",
"EventQueueArn": "string",
"Exclusions": [ "string" ],
"Path": "string",
"SampleSize": number
}
]
},
"Version": 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.
Errors
For information about the errors that are common to all actions, see Common Errors.
- OperationTimeoutException
-
The operation timed out.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
