# CreateNotebook
<a name="API_CreateNotebook"></a>

Creates an empty `ipynb` file in the specified Apache Spark enabled workgroup. Throws an error if a file in the workgroup with the same name already exists.

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

```
{
   "ClientRequestToken": "string",
   "Name": "string",
   "WorkGroup": "string"
}
```

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

 ** [ClientRequestToken](#API_CreateNotebook_RequestSyntax) **   <a name="athena-CreateNotebook-request-ClientRequestToken"></a>
A unique case-sensitive string used to ensure the request to create the notebook is idempotent (executes only once).  
This token is listed as not required because Amazon SDKs (for example the Amazon SDK for Java) auto-generate the token for you. If you are not using the Amazon SDK or the Amazon CLI, you must provide this token or the action will fail.
Type: String  
Length Constraints: Minimum length of 1. Maximum 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: No

 ** [Name](#API_CreateNotebook_RequestSyntax) **   <a name="athena-CreateNotebook-request-Name"></a>
The name of the `ipynb` file to be created in the Spark workgroup, without the `.ipynb` extension.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `(?!.*[/:\\])[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]+`   
Required: Yes

 ** [WorkGroup](#API_CreateNotebook_RequestSyntax) **   <a name="athena-CreateNotebook-request-WorkGroup"></a>
The name of the Spark enabled workgroup in which the notebook will be created.  
Type: String  
Pattern: `[a-zA-Z0-9._-]{1,128}`   
Required: Yes

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

```
{
   "NotebookId": "string"
}
```

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

 ** [NotebookId](#API_CreateNotebook_ResponseSyntax) **   <a name="athena-CreateNotebook-response-NotebookId"></a>
A unique identifier for the notebook.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

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

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

 ** InternalServerException **   
Indicates a platform issue, which may be due to a transient condition or outage.  
HTTP Status Code: 500

 ** InvalidRequestException **   
Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.    
 ** AthenaErrorCode **   
The error code returned when the query execution failed to process, or when the processing request for the named query failed.
HTTP Status Code: 400

 ** TooManyRequestsException **   
Indicates that the request was throttled.    
 ** Reason **   
The reason for the query throttling, for example, when it exceeds the concurrent query limit.
HTTP Status Code: 400

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

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