Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetCrawler

Retrieves metadata for a specified crawler.

Request Syntax


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

Name

The name of the crawler to retrieve metadata for.

Type: String

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

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

Required: Yes

Response Syntax


{
   "Crawler": { 
      "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
   }
}

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.

Crawler

The metadata for the specified crawler.

Type: Crawler object

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

OperationTimeoutException

The operation timed out.

HTTP Status Code: 400