Amazonka.Athena.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.

Creating a Request

data CreateNotebook

See: newCreateNotebook smart constructor.

Constructors

CreateNotebook'

Fields

• clientRequestToken :: Maybe Text

  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 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.

• workGroup :: Text

  The name of the Spark enabled workgroup in which the notebook will be created.

• name :: Text

  The name of the ipynb file to be created in the Spark workgroup, without the .ipynb extension.

Instances

ToJSON CreateNotebook

Defined in Amazonka.Athena.CreateNotebook

Methods

toJSON :: CreateNotebook -> Value

toEncoding :: CreateNotebook -> Encoding

toJSONList :: [CreateNotebook] -> Value

toEncodingList :: [CreateNotebook] -> Encoding

ToHeaders CreateNotebook

Defined in Amazonka.Athena.CreateNotebook

Methods

toHeaders :: CreateNotebook -> [Header]

ToPath CreateNotebook

Defined in Amazonka.Athena.CreateNotebook

Methods

toPath :: CreateNotebook -> ByteString

ToQuery CreateNotebook

Defined in Amazonka.Athena.CreateNotebook

Methods

toQuery :: CreateNotebook -> QueryString

AWSRequest CreateNotebook

Defined in Amazonka.Athena.CreateNotebook

Associated Types

type AWSResponse CreateNotebook

Methods

request :: (Service -> Service) -> CreateNotebook -> Request CreateNotebook

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateNotebook -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateNotebook)))

Generic CreateNotebook

Defined in Amazonka.Athena.CreateNotebook

Associated Types

type Rep CreateNotebook :: Type -> Type

Methods

from :: CreateNotebook -> Rep CreateNotebook x

to :: Rep CreateNotebook x -> CreateNotebook

Read CreateNotebook

Defined in Amazonka.Athena.CreateNotebook

Methods

readsPrec :: Int -> ReadS CreateNotebook

readList :: ReadS [CreateNotebook]

readPrec :: ReadPrec CreateNotebook

readListPrec :: ReadPrec [CreateNotebook]

Show CreateNotebook

Defined in Amazonka.Athena.CreateNotebook

Methods

showsPrec :: Int -> CreateNotebook -> ShowS

show :: CreateNotebook -> String

showList :: [CreateNotebook] -> ShowS

NFData CreateNotebook

Defined in Amazonka.Athena.CreateNotebook

Methods

rnf :: CreateNotebook -> ()

Eq CreateNotebook

Defined in Amazonka.Athena.CreateNotebook

Methods

(==) :: CreateNotebook -> CreateNotebook -> Bool

(/=) :: CreateNotebook -> CreateNotebook -> Bool

Hashable CreateNotebook

Defined in Amazonka.Athena.CreateNotebook

Methods

hashWithSalt :: Int -> CreateNotebook -> Int

hash :: CreateNotebook -> Int

type AWSResponse CreateNotebook

Defined in Amazonka.Athena.CreateNotebook

type AWSResponse CreateNotebook = CreateNotebookResponse

type Rep CreateNotebook

Defined in Amazonka.Athena.CreateNotebook

type Rep CreateNotebook = D1 ('MetaData "CreateNotebook" "Amazonka.Athena.CreateNotebook" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "CreateNotebook'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "workGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateNotebook

Arguments

:: Text

CreateNotebook

-> Text

CreateNotebook

-> CreateNotebook

Create a value of CreateNotebook with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:clientRequestToken:CreateNotebook', createNotebook_clientRequestToken - 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 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.

CreateNotebook, createNotebook_workGroup - The name of the Spark enabled workgroup in which the notebook will be created.

CreateNotebook, createNotebook_name - The name of the ipynb file to be created in the Spark workgroup, without the .ipynb extension.

Request Lenses

createNotebook_clientRequestToken :: Lens' CreateNotebook (Maybe Text)

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 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.

createNotebook_workGroup :: Lens' CreateNotebook Text

The name of the Spark enabled workgroup in which the notebook will be created.

createNotebook_name :: Lens' CreateNotebook Text

The name of the ipynb file to be created in the Spark workgroup, without the .ipynb extension.

Destructuring the Response

data CreateNotebookResponse

See: newCreateNotebookResponse smart constructor.

Constructors

CreateNotebookResponse'

Fields

• notebookId :: Maybe Text

  A unique identifier for the notebook.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateNotebookResponse

Defined in Amazonka.Athena.CreateNotebook

Associated Types

type Rep CreateNotebookResponse :: Type -> Type

Methods

from :: CreateNotebookResponse -> Rep CreateNotebookResponse x

to :: Rep CreateNotebookResponse x -> CreateNotebookResponse

Read CreateNotebookResponse

Defined in Amazonka.Athena.CreateNotebook

Methods

readsPrec :: Int -> ReadS CreateNotebookResponse

readList :: ReadS [CreateNotebookResponse]

readPrec :: ReadPrec CreateNotebookResponse

readListPrec :: ReadPrec [CreateNotebookResponse]

Show CreateNotebookResponse

Defined in Amazonka.Athena.CreateNotebook

Methods

showsPrec :: Int -> CreateNotebookResponse -> ShowS

show :: CreateNotebookResponse -> String

showList :: [CreateNotebookResponse] -> ShowS

NFData CreateNotebookResponse

Defined in Amazonka.Athena.CreateNotebook

Methods

rnf :: CreateNotebookResponse -> ()

Eq CreateNotebookResponse

Defined in Amazonka.Athena.CreateNotebook

Methods

(==) :: CreateNotebookResponse -> CreateNotebookResponse -> Bool

(/=) :: CreateNotebookResponse -> CreateNotebookResponse -> Bool

type Rep CreateNotebookResponse

Defined in Amazonka.Athena.CreateNotebook

type Rep CreateNotebookResponse = D1 ('MetaData "CreateNotebookResponse" "Amazonka.Athena.CreateNotebook" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "CreateNotebookResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "notebookId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateNotebookResponse

Arguments

:: Int

$sel:httpStatus:CreateNotebookResponse'

-> CreateNotebookResponse

Create a value of CreateNotebookResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateNotebookResponse, createNotebookResponse_notebookId - A unique identifier for the notebook.

$sel:httpStatus:CreateNotebookResponse', createNotebookResponse_httpStatus - The response's http status code.

Response Lenses

createNotebookResponse_notebookId :: Lens' CreateNotebookResponse (Maybe Text)

A unique identifier for the notebook.

createNotebookResponse_httpStatus :: Lens' CreateNotebookResponse Int

The response's http status code.