# UpdateSchema
<a name="API_UpdateSchema"></a>

Updates the description, compatibility setting, or version checkpoint for a schema set.

For updating the compatibility setting, the call will not validate compatibility for the entire set of schema versions with the new compatibility setting. If the value for `Compatibility` is provided, the `VersionNumber` (a checkpoint) is also required. The API will validate the checkpoint version number for consistency.

If the value for the `VersionNumber` (checkpoint) is provided, `Compatibility` is optional and this can be used to set/reset a checkpoint for the schema.

This update will happen only if the schema is in the AVAILABLE state.

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

```
{
   "Compatibility": "string",
   "Description": "string",
   "SchemaId": { 
      "RegistryName": "string",
      "SchemaArn": "string",
      "SchemaName": "string"
   },
   "SchemaVersionNumber": { 
      "LatestVersion": boolean,
      "VersionNumber": number
   }
}
```

## Request Parameters
<a name="API_UpdateSchema_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.

 ** [Compatibility](#API_UpdateSchema_RequestSyntax) **   <a name="Glue-UpdateSchema-request-Compatibility"></a>
The new compatibility setting for the schema.  
Type: String  
Valid Values: `NONE | DISABLED | BACKWARD | BACKWARD_ALL | FORWARD | FORWARD_ALL | FULL | FULL_ALL`   
Required: No

 ** [Description](#API_UpdateSchema_RequestSyntax) **   <a name="Glue-UpdateSchema-request-Description"></a>
The new description for the schema.  
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

 ** [SchemaId](#API_UpdateSchema_RequestSyntax) **   <a name="Glue-UpdateSchema-request-SchemaId"></a>
This is a wrapper structure to contain schema identity fields. The structure contains:  
+ SchemaId\$1SchemaArn: The Amazon Resource Name (ARN) of the schema. One of `SchemaArn` or `SchemaName` has to be provided.
+ SchemaId\$1SchemaName: The name of the schema. One of `SchemaArn` or `SchemaName` has to be provided.
Type: [SchemaId](API_SchemaId.md) object  
Required: Yes

 ** [SchemaVersionNumber](#API_UpdateSchema_RequestSyntax) **   <a name="Glue-UpdateSchema-request-SchemaVersionNumber"></a>
Version number required for check pointing. One of `VersionNumber` or `Compatibility` has to be provided.  
Type: [SchemaVersionNumber](API_SchemaVersionNumber.md) object  
Required: No

## Response Syntax
<a name="API_UpdateSchema_ResponseSyntax"></a>

```
{
   "RegistryName": "string",
   "SchemaArn": "string",
   "SchemaName": "string"
}
```

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

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

The following data is returned in JSON format by the service.

 ** [RegistryName](#API_UpdateSchema_ResponseSyntax) **   <a name="Glue-UpdateSchema-response-RegistryName"></a>
The name of the registry that contains the schema.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9-_$#.]+` 

 ** [SchemaArn](#API_UpdateSchema_ResponseSyntax) **   <a name="Glue-UpdateSchema-response-SchemaArn"></a>
The Amazon Resource Name (ARN) of the schema.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10240.  
Pattern: `arn:aws(-(cn|us-gov|iso(-[bef])?))?:glue:.*` 

 ** [SchemaName](#API_UpdateSchema_ResponseSyntax) **   <a name="Glue-UpdateSchema-response-SchemaName"></a>
The name of the schema.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9-_$#.]+` 

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

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

 ** AccessDeniedException **   
Access to a resource was denied.    
 ** Message **   
A message describing the problem.
HTTP Status Code: 400

 ** ConcurrentModificationException **   
Two processes are trying to modify a resource simultaneously.    
 ** 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

 ** InternalServiceException **   
An internal service error occurred.    
 ** Message **   
A message describing the problem.
HTTP Status Code: 500

 ** 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

## See Also
<a name="API_UpdateSchema_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/UpdateSchema) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/glue-2017-03-31/UpdateSchema) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/glue-2017-03-31/UpdateSchema) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/glue-2017-03-31/UpdateSchema) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/glue-2017-03-31/UpdateSchema) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/glue-2017-03-31/UpdateSchema) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/glue-2017-03-31/UpdateSchema) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/glue-2017-03-31/UpdateSchema) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/glue-2017-03-31/UpdateSchema) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/glue-2017-03-31/UpdateSchema)