Import Notebook

athena_import_notebook

R Documentation

Imports a single ipynb file to a Spark enabled workgroup

Description

Imports a single ipynb file to a Spark enabled workgroup. To import the notebook, the request must specify a value for either Payload or NoteBookS3LocationUri. If neither is specified or both are specified, an InvalidRequestException occurs. The maximum file size that can be imported is 10 megabytes. If an ipynb file with the same name already exists in the workgroup, throws an error.

Usage

athena_import_notebook(WorkGroup, Name, Payload, Type,
  NotebookS3LocationUri, ClientRequestToken)

Arguments

WorkGroup

[required] The name of the Spark enabled workgroup to import the notebook to.

Name

[required] The name of the notebook to import.

Payload

The notebook content to be imported. The payload must be in ipynb format.

Type

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

NotebookS3LocationUri

A URI that specifies the Amazon S3 location of a notebook file in ipynb format.

ClientRequestToken

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

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

Value

A list with the following syntax:

list(
  NotebookId = "string"
)

Request syntax

svc$import_notebook(
  WorkGroup = "string",
  Name = "string",
  Payload = "string",
  Type = "IPYNB",
  NotebookS3LocationUri = "string",
  ClientRequestToken = "string"
)