Request Syntax Request Parameters Response Elements Errors See Also

UpdateNotebook

Updates the contents of a Spark notebook.

Request Syntax


{
   "ClientRequestToken": "string",
   "NotebookId": "string",
   "Payload": "string",
   "SessionId": "string",
   "Type": "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

NotebookId

The ID of the notebook to update.

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: Yes

Payload

The updated content for the notebook.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 10485760.

Required: Yes

SessionId

The active notebook session ID. Required if the notebook has an active session.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No

Type

The notebook content type. Currently, the only valid type is IPYNB.

Type: String

Valid Values: IPYNB

Required: Yes

Response Elements

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

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