# UpdateDataLakeDataset
<a name="API_UpdateDataLakeDataset"></a>

Enables you to programmatically update an AWS Supply Chain data lake dataset. Developers can update the description of a data lake dataset for a given instance ID, namespace, and dataset name.

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

```
PATCH /api/datalake/instance/instanceId/namespaces/namespace/datasets/name HTTP/1.1
Content-type: application/json

{
   "description": "string"
}
```

## URI Request Parameters
<a name="API_UpdateDataLakeDataset_RequestParameters"></a>

The request uses the following URI parameters.

 ** [instanceId](#API_UpdateDataLakeDataset_RequestSyntax) **   <a name="supplychain-UpdateDataLakeDataset-request-uri-instanceId"></a>
The AWS Chain instance identifier.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** [name](#API_UpdateDataLakeDataset_RequestSyntax) **   <a name="supplychain-UpdateDataLakeDataset-request-uri-name"></a>
The name of the dataset. For **asc** namespace, the name must be one of the supported data entities under [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html](https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html).  
Length Constraints: Minimum length of 1. Maximum length of 75.  
Pattern: `[a-z0-9_]+`   
Required: Yes

 ** [namespace](#API_UpdateDataLakeDataset_RequestSyntax) **   <a name="supplychain-UpdateDataLakeDataset-request-uri-namespace"></a>
The namespace of the dataset, besides the custom defined namespace, every instance comes with below pre-defined namespaces:  
+  **asc** - For information on the AWS Supply Chain supported datasets see [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html](https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html).
+  **default** - For datasets with custom user-defined schemas.
Length Constraints: Minimum length of 1. Maximum length of 50.  
Pattern: `[a-z0-9_]+`   
Required: Yes

## Request Body
<a name="API_UpdateDataLakeDataset_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_UpdateDataLakeDataset_RequestSyntax) **   <a name="supplychain-UpdateDataLakeDataset-request-description"></a>
The updated description of the data lake dataset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: No

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

```
HTTP/1.1 200
Content-type: application/json

{
   "dataset": { 
      "arn": "string",
      "createdTime": number,
      "description": "string",
      "instanceId": "string",
      "lastModifiedTime": number,
      "name": "string",
      "namespace": "string",
      "partitionSpec": { 
         "fields": [ 
            { 
               "name": "string",
               "transform": { 
                  "type": "string"
               }
            }
         ]
      },
      "schema": { 
         "fields": [ 
            { 
               "isRequired": boolean,
               "name": "string",
               "type": "string"
            }
         ],
         "name": "string",
         "primaryKeys": [ 
            { 
               "name": "string"
            }
         ]
      }
   }
}
```

## Response Elements
<a name="API_UpdateDataLakeDataset_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.

 ** [dataset](#API_UpdateDataLakeDataset_ResponseSyntax) **   <a name="supplychain-UpdateDataLakeDataset-response-dataset"></a>
The updated dataset details.  
Type: [DataLakeDataset](API_DataLakeDataset.md) object

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

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

 ** AccessDeniedException **   
You do not have the required privileges to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
Updating or deleting a resource can cause an inconsistent state.  
HTTP Status Code: 409

 ** InternalServerException **   
Unexpected error during processing of request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Request references a resource which does not exist.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
Request would cause a service quota to be exceeded.  
HTTP Status Code: 402

 ** ThrottlingException **   
Request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input does not satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

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