# UpdateCrawler
<a name="API_UpdateCrawler"></a>

Updates a crawler. If a crawler is running, you must stop it using `StopCrawler` before updating it.

## Request Syntax
<a name="API_UpdateCrawler_RequestSyntax"></a>

```
{
   "Classifiers": [ "string" ],
   "Configuration": "string",
   "CrawlerSecurityConfiguration": "string",
   "DatabaseName": "string",
   "Description": "string",
   "LakeFormationConfiguration": { 
      "AccountId": "string",
      "UseLakeFormationCredentials": boolean
   },
   "LineageConfiguration": { 
      "CrawlerLineageSettings": "string"
   },
   "Name": "string",
   "RecrawlPolicy": { 
      "RecrawlBehavior": "string"
   },
   "Role": "string",
   "Schedule": "string",
   "SchemaChangePolicy": { 
      "DeleteBehavior": "string",
      "UpdateBehavior": "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
         }
      ]
   }
}
```

## Request Parameters
<a name="API_UpdateCrawler_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Classifiers](#API_UpdateCrawler_RequestSyntax) **   <a name="Glue-UpdateCrawler-request-Classifiers"></a>
A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*`   
Required: No

 ** [Configuration](#API_UpdateCrawler_RequestSyntax) **   <a name="Glue-UpdateCrawler-request-Configuration"></a>
Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see [Setting crawler configuration options](https://docs.aws.amazon.com/glue/latest/dg/crawler-configuration.html).  
Type: String  
Required: No

 ** [CrawlerSecurityConfiguration](#API_UpdateCrawler_RequestSyntax) **   <a name="Glue-UpdateCrawler-request-CrawlerSecurityConfiguration"></a>
The name of the `SecurityConfiguration` structure to be used by this crawler.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Required: No

 ** [DatabaseName](#API_UpdateCrawler_RequestSyntax) **   <a name="Glue-UpdateCrawler-request-DatabaseName"></a>
The AWS Glue database where results are stored, such as: `arn:aws:daylight:us-east-1::database/sometable/*`.  
Type: String  
Required: No

 ** [Description](#API_UpdateCrawler_RequestSyntax) **   <a name="Glue-UpdateCrawler-request-Description"></a>
A description of the new crawler.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*`   
Required: No

 ** [LakeFormationConfiguration](#API_UpdateCrawler_RequestSyntax) **   <a name="Glue-UpdateCrawler-request-LakeFormationConfiguration"></a>
Specifies AWS Lake Formation configuration settings for the crawler.  
Type: [LakeFormationConfiguration](API_LakeFormationConfiguration.md) object  
Required: No

 ** [LineageConfiguration](#API_UpdateCrawler_RequestSyntax) **   <a name="Glue-UpdateCrawler-request-LineageConfiguration"></a>
Specifies data lineage configuration settings for the crawler.  
Type: [LineageConfiguration](API_LineageConfiguration.md) object  
Required: No

 ** [Name](#API_UpdateCrawler_RequestSyntax) **   <a name="Glue-UpdateCrawler-request-Name"></a>
Name of the new crawler.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*`   
Required: Yes

 ** [RecrawlPolicy](#API_UpdateCrawler_RequestSyntax) **   <a name="Glue-UpdateCrawler-request-RecrawlPolicy"></a>
A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.  
Type: [RecrawlPolicy](API_RecrawlPolicy.md) object  
Required: No

 ** [Role](#API_UpdateCrawler_RequestSyntax) **   <a name="Glue-UpdateCrawler-request-Role"></a>
The IAM role or Amazon Resource Name (ARN) of an IAM role that is used by the new crawler to access customer resources.  
Type: String  
Required: No

 ** [Schedule](#API_UpdateCrawler_RequestSyntax) **   <a name="Glue-UpdateCrawler-request-Schedule"></a>
A `cron` expression used to specify the schedule (see [Time-Based Schedules for Jobs and Crawlers](https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html). For example, to run something every day at 12:15 UTC, you would specify: `cron(15 12 * * ? *)`.  
Type: String  
Required: No

 ** [SchemaChangePolicy](#API_UpdateCrawler_RequestSyntax) **   <a name="Glue-UpdateCrawler-request-SchemaChangePolicy"></a>
The policy for the crawler's update and deletion behavior.  
Type: [SchemaChangePolicy](API_SchemaChangePolicy.md) object  
Required: No

 ** [TablePrefix](#API_UpdateCrawler_RequestSyntax) **   <a name="Glue-UpdateCrawler-request-TablePrefix"></a>
The table prefix used for catalog tables that are created.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Required: No

 ** [Targets](#API_UpdateCrawler_RequestSyntax) **   <a name="Glue-UpdateCrawler-request-Targets"></a>
A list of targets to crawl.  
Type: [CrawlerTargets](API_CrawlerTargets.md) object  
Required: No

## Response Elements
<a name="API_UpdateCrawler_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateCrawler_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CrawlerRunningException **   
The operation cannot be performed because the crawler is already running.    
 ** Message **   
A message describing the problem.
HTTP Status Code: 400

 ** EntityNotFoundException **   
A specified entity does not exist    
 ** FromFederationSource **   
Indicates whether or not the exception relates to a federated source.  
 ** Message **   
A message describing the problem.
HTTP Status Code: 400

 ** InvalidInputException **   
The input provided was not valid.    
 ** FromFederationSource **   
Indicates whether or not the exception relates to a federated source.  
 ** Message **   
A message describing the problem.
HTTP Status Code: 400

 ** OperationTimeoutException **   
The operation timed out.    
 ** Message **   
A message describing the problem.
HTTP Status Code: 400

 ** VersionMismatchException **   
There was a version conflict.    
 ** Message **   
A message describing the problem.
HTTP Status Code: 400

## See Also
<a name="API_UpdateCrawler_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/glue-2017-03-31/UpdateCrawler) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/glue-2017-03-31/UpdateCrawler) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/glue-2017-03-31/UpdateCrawler) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/glue-2017-03-31/UpdateCrawler) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/glue-2017-03-31/UpdateCrawler) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/glue-2017-03-31/UpdateCrawler) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/glue-2017-03-31/UpdateCrawler) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/glue-2017-03-31/UpdateCrawler) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/glue-2017-03-31/UpdateCrawler) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/glue-2017-03-31/UpdateCrawler)