Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateNotebook

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


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

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ClientRequestToken

A unique case-sensitive string used to ensure the request to create the notebook is idempotent (executes only once).

Important

This token is listed as not required because AWS SDKs (for example the AWS SDK for Java) auto-generate the token for you. If you are not using the AWS SDK or the AWS 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

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

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


{
   "NotebookId": "string"
}

Response Elements

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

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

For information about the errors that are common to all actions, see Common Errors.

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.

HTTP Status Code: 400

TooManyRequestsException

Indicates that the request was throttled.

HTTP Status Code: 400