- 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.
StartCrawlerCommand
Starts a crawl using the specified crawler, regardless of what is scheduled. If the crawler is already running, returns a CrawlerRunningException .
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { GlueClient, StartCrawlerCommand } from "@aws-sdk/client-glue"; // ES Modules import
// const { GlueClient, StartCrawlerCommand } = require("@aws-sdk/client-glue"); // CommonJS import
const client = new GlueClient(config);
const input = { // StartCrawlerRequest
Name: "STRING_VALUE", // required
};
const command = new StartCrawlerCommand(input);
const response = await client.send(command);
// {};
StartCrawlerCommand Input
See StartCrawlerCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
NameRequired | string | undefined | Name of the crawler to start. |
StartCrawlerCommand Output
See StartCrawlerCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| CrawlerRunningException | client | The operation cannot be performed because the crawler is already running. |
| 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. |