# StartNotebookSync
<a name="API_StartNotebookSync"></a>

Starts a notebook sync in Amazon SageMaker Unified Studio. This operation syncs a notebook from a Git repository into a project.

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

```
POST /v2/domains/{{domainIdentifier}}/notebook-syncs HTTP/1.1
Content-type: application/json

{
   "clientToken": "{{string}}",
   "description": "{{string}}",
   "gitMetadata": { 
      "branch": "{{string}}",
      "commitHash": "{{string}}",
      "commitMessage": "{{string}}",
      "committedAt": {{number}},
      "connectionId": "{{string}}",
      "fileName": "{{string}}",
      "repository": "{{string}}"
   },
   "name": "{{string}}",
   "notebookId": "{{string}}",
   "owningProjectIdentifier": "{{string}}",
   "sourceLocation": { ... }
}
```

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

The request uses the following URI parameters.

 ** [domainIdentifier](#API_StartNotebookSync_RequestSyntax) **   <a name="datazone-StartNotebookSync-request-uri-domainIdentifier"></a>
The identifier of the Amazon SageMaker Unified Studio domain in which to sync the notebook.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

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

The request accepts the following data in JSON format.

 ** [clientToken](#API_StartNotebookSync_RequestSyntax) **   <a name="datazone-StartNotebookSync-request-clientToken"></a>
A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\x21-\x7E]+`   
Required: No

 ** [description](#API_StartNotebookSync_RequestSyntax) **   <a name="datazone-StartNotebookSync-request-description"></a>
The description of the notebook.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Required: No

 ** [gitMetadata](#API_StartNotebookSync_RequestSyntax) **   <a name="datazone-StartNotebookSync-request-gitMetadata"></a>
The Git metadata for the notebook sync, including repository, branch, and commit information.  
Type: [GitMetadata](API_GitMetadata.md) object  
Required: No

 ** [name](#API_StartNotebookSync_RequestSyntax) **   <a name="datazone-StartNotebookSync-request-name"></a>
The name of the notebook. The name must be between 1 and 256 characters.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** [notebookId](#API_StartNotebookSync_RequestSyntax) **   <a name="datazone-StartNotebookSync-request-notebookId"></a>
The identifier of an existing notebook to sync. If not specified, a new notebook is created.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: No

 ** [owningProjectIdentifier](#API_StartNotebookSync_RequestSyntax) **   <a name="datazone-StartNotebookSync-request-owningProjectIdentifier"></a>
The identifier of the project that will own the synced notebook.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [sourceLocation](#API_StartNotebookSync_RequestSyntax) **   <a name="datazone-StartNotebookSync-request-sourceLocation"></a>
The source location of the notebook to sync. This specifies the Amazon Simple Storage Service URI of the notebook file.  
Type: [SourceLocation](API_SourceLocation.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

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

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

{
   "createdAt": number,
   "createdBy": "string",
   "description": "string",
   "domainId": "string",
   "gitMetadata": { 
      "branch": "string",
      "commitHash": "string",
      "commitMessage": "string",
      "committedAt": number,
      "connectionId": "string",
      "fileName": "string",
      "repository": "string"
   },
   "name": "string",
   "notebookId": "string",
   "owningProjectId": "string",
   "sourceLocation": { ... },
   "status": "string"
}
```

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

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

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

 ** [createdAt](#API_StartNotebookSync_ResponseSyntax) **   <a name="datazone-StartNotebookSync-response-createdAt"></a>
The timestamp of when the notebook sync was started.  
Type: Timestamp

 ** [createdBy](#API_StartNotebookSync_ResponseSyntax) **   <a name="datazone-StartNotebookSync-response-createdBy"></a>
The identifier of the user who started the notebook sync.  
Type: String

 ** [description](#API_StartNotebookSync_ResponseSyntax) **   <a name="datazone-StartNotebookSync-response-description"></a>
The description of the synced notebook.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [domainId](#API_StartNotebookSync_ResponseSyntax) **   <a name="datazone-StartNotebookSync-response-domainId"></a>
The identifier of the Amazon SageMaker Unified Studio domain.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [gitMetadata](#API_StartNotebookSync_ResponseSyntax) **   <a name="datazone-StartNotebookSync-response-gitMetadata"></a>
The Git metadata associated with the synced notebook.  
Type: [GitMetadata](API_GitMetadata.md) object

 ** [name](#API_StartNotebookSync_ResponseSyntax) **   <a name="datazone-StartNotebookSync-response-name"></a>
The name of the synced notebook.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [notebookId](#API_StartNotebookSync_ResponseSyntax) **   <a name="datazone-StartNotebookSync-response-notebookId"></a>
The identifier of the synced notebook.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [owningProjectId](#API_StartNotebookSync_ResponseSyntax) **   <a name="datazone-StartNotebookSync-response-owningProjectId"></a>
The identifier of the project that owns the synced notebook.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [sourceLocation](#API_StartNotebookSync_ResponseSyntax) **   <a name="datazone-StartNotebookSync-response-sourceLocation"></a>
The source location from which the notebook was synced.  
Type: [SourceLocation](API_SourceLocation.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [status](#API_StartNotebookSync_ResponseSyntax) **   <a name="datazone-StartNotebookSync-response-status"></a>
The status of the notebook sync.  
Type: String  
Valid Values: `ACTIVE | ARCHIVED | SYNC_IN_PROGRESS | SYNC_FAILED` 

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

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

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

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

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

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