- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
GetCrawlerCommand
Retrieves metadata for a specified crawler.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { GlueClient, GetCrawlerCommand } from "@aws-sdk/client-glue"; // ES Modules import
// const { GlueClient, GetCrawlerCommand } = require("@aws-sdk/client-glue"); // CommonJS import
const client = new GlueClient(config);
const input = { // GetCrawlerRequest
Name: "STRING_VALUE", // required
};
const command = new GetCrawlerCommand(input);
const response = await client.send(command);
// { // GetCrawlerResponse
// Crawler: { // Crawler
// Name: "STRING_VALUE",
// Role: "STRING_VALUE",
// Targets: { // CrawlerTargets
// S3Targets: [ // S3TargetList
// { // S3Target
// Path: "STRING_VALUE",
// Exclusions: [ // PathList
// "STRING_VALUE",
// ],
// ConnectionName: "STRING_VALUE",
// SampleSize: Number("int"),
// EventQueueArn: "STRING_VALUE",
// DlqEventQueueArn: "STRING_VALUE",
// },
// ],
// JdbcTargets: [ // JdbcTargetList
// { // JdbcTarget
// ConnectionName: "STRING_VALUE",
// Path: "STRING_VALUE",
// Exclusions: [
// "STRING_VALUE",
// ],
// EnableAdditionalMetadata: [ // EnableAdditionalMetadata
// "COMMENTS" || "RAWTYPES",
// ],
// },
// ],
// MongoDBTargets: [ // MongoDBTargetList
// { // MongoDBTarget
// ConnectionName: "STRING_VALUE",
// Path: "STRING_VALUE",
// ScanAll: true || false,
// },
// ],
// DynamoDBTargets: [ // DynamoDBTargetList
// { // DynamoDBTarget
// Path: "STRING_VALUE",
// scanAll: true || false,
// scanRate: Number("double"),
// },
// ],
// CatalogTargets: [ // CatalogTargetList
// { // CatalogTarget
// DatabaseName: "STRING_VALUE", // required
// Tables: [ // CatalogTablesList // required
// "STRING_VALUE",
// ],
// ConnectionName: "STRING_VALUE",
// EventQueueArn: "STRING_VALUE",
// DlqEventQueueArn: "STRING_VALUE",
// },
// ],
// DeltaTargets: [ // DeltaTargetList
// { // DeltaTarget
// DeltaTables: [
// "STRING_VALUE",
// ],
// ConnectionName: "STRING_VALUE",
// WriteManifest: true || false,
// CreateNativeDeltaTable: true || false,
// },
// ],
// IcebergTargets: [ // IcebergTargetList
// { // IcebergTarget
// Paths: [
// "STRING_VALUE",
// ],
// ConnectionName: "STRING_VALUE",
// Exclusions: [
// "STRING_VALUE",
// ],
// MaximumTraversalDepth: Number("int"),
// },
// ],
// HudiTargets: [ // HudiTargetList
// { // HudiTarget
// Paths: "<PathList>",
// ConnectionName: "STRING_VALUE",
// Exclusions: "<PathList>",
// MaximumTraversalDepth: Number("int"),
// },
// ],
// },
// DatabaseName: "STRING_VALUE",
// Description: "STRING_VALUE",
// Classifiers: [ // ClassifierNameList
// "STRING_VALUE",
// ],
// RecrawlPolicy: { // RecrawlPolicy
// RecrawlBehavior: "CRAWL_EVERYTHING" || "CRAWL_NEW_FOLDERS_ONLY" || "CRAWL_EVENT_MODE",
// },
// SchemaChangePolicy: { // SchemaChangePolicy
// UpdateBehavior: "LOG" || "UPDATE_IN_DATABASE",
// DeleteBehavior: "LOG" || "DELETE_FROM_DATABASE" || "DEPRECATE_IN_DATABASE",
// },
// LineageConfiguration: { // LineageConfiguration
// CrawlerLineageSettings: "ENABLE" || "DISABLE",
// },
// State: "READY" || "RUNNING" || "STOPPING",
// TablePrefix: "STRING_VALUE",
// Schedule: { // Schedule
// ScheduleExpression: "STRING_VALUE",
// State: "SCHEDULED" || "NOT_SCHEDULED" || "TRANSITIONING",
// },
// CrawlElapsedTime: Number("long"),
// CreationTime: new Date("TIMESTAMP"),
// LastUpdated: new Date("TIMESTAMP"),
// LastCrawl: { // LastCrawlInfo
// Status: "SUCCEEDED" || "CANCELLED" || "FAILED",
// ErrorMessage: "STRING_VALUE",
// LogGroup: "STRING_VALUE",
// LogStream: "STRING_VALUE",
// MessagePrefix: "STRING_VALUE",
// StartTime: new Date("TIMESTAMP"),
// },
// Version: Number("long"),
// Configuration: "STRING_VALUE",
// CrawlerSecurityConfiguration: "STRING_VALUE",
// LakeFormationConfiguration: { // LakeFormationConfiguration
// UseLakeFormationCredentials: true || false,
// AccountId: "STRING_VALUE",
// },
// },
// };
GetCrawlerCommand Input
See GetCrawlerCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
Name Required | string | undefined | The name of the crawler to retrieve metadata for. |
GetCrawlerCommand Output
See GetCrawlerCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Crawler | Crawler | undefined | The metadata for the specified crawler. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
EntityNotFoundException | client | A specified entity does not exist |
OperationTimeoutException | client | The operation timed out. |
GlueServiceException | Base exception class for all service exceptions from Glue service. |