Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Athena.ImportNotebook

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Imports a single ipynb file to a Spark enabled workgroup. 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.

Creating a Request

data ImportNotebook Source #

See: newImportNotebook smart constructor.

Constructors

ImportNotebook'

Fields

clientRequestToken :: Maybe Text
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.
workGroup :: Text
The name of the Spark enabled workgroup to import the notebook to.
name :: Text
The name of the notebook to import.
payload :: Text
The notebook content to be imported.
type' :: NotebookType
The notebook content type. Currently, the only valid type is IPYNB.

Instances

Instances details

ToJSON ImportNotebook Source #
Instance details Defined in Amazonka.Athena.ImportNotebook Methods toJSON :: ImportNotebook -> Value # toEncoding :: ImportNotebook -> Encoding # toJSONList :: [ImportNotebook] -> Value # toEncodingList :: [ImportNotebook] -> Encoding #
ToHeaders ImportNotebook Source #
Instance details Defined in Amazonka.Athena.ImportNotebook Methods toHeaders :: ImportNotebook -> [Header] #
ToPath ImportNotebook Source #
Instance details Defined in Amazonka.Athena.ImportNotebook Methods toPath :: ImportNotebook -> ByteString #
ToQuery ImportNotebook Source #
Instance details Defined in Amazonka.Athena.ImportNotebook Methods toQuery :: ImportNotebook -> QueryString #
AWSRequest ImportNotebook Source #
Instance details Defined in Amazonka.Athena.ImportNotebook Associated Types type AWSResponse ImportNotebook # Methods request :: (Service -> Service) -> ImportNotebook -> Request ImportNotebook # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ImportNotebook -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ImportNotebook))) #
Generic ImportNotebook Source #
Instance details Defined in Amazonka.Athena.ImportNotebook Associated Types type Rep ImportNotebook :: Type -> Type # Methods from :: ImportNotebook -> Rep ImportNotebook x # to :: Rep ImportNotebook x -> ImportNotebook #
Read ImportNotebook Source #
Instance details Defined in Amazonka.Athena.ImportNotebook Methods readsPrec :: Int -> ReadS ImportNotebook # readList :: ReadS [ImportNotebook] # readPrec :: ReadPrec ImportNotebook # readListPrec :: ReadPrec [ImportNotebook] #
Show ImportNotebook Source #
Instance details Defined in Amazonka.Athena.ImportNotebook Methods showsPrec :: Int -> ImportNotebook -> ShowS # show :: ImportNotebook -> String # showList :: [ImportNotebook] -> ShowS #
NFData ImportNotebook Source #
Instance details Defined in Amazonka.Athena.ImportNotebook Methods rnf :: ImportNotebook -> () #
Eq ImportNotebook Source #
Instance details Defined in Amazonka.Athena.ImportNotebook Methods (==) :: ImportNotebook -> ImportNotebook -> Bool # (/=) :: ImportNotebook -> ImportNotebook -> Bool #
Hashable ImportNotebook Source #
Instance details Defined in Amazonka.Athena.ImportNotebook Methods hashWithSalt :: Int -> ImportNotebook -> Int # hash :: ImportNotebook -> Int #
type AWSResponse ImportNotebook Source #
Instance details Defined in Amazonka.Athena.ImportNotebook type AWSResponse ImportNotebook = ImportNotebookResponse
type Rep ImportNotebook Source #
Instance details Defined in Amazonka.Athena.ImportNotebook type Rep ImportNotebook = D1 ('MetaData "ImportNotebook" "Amazonka.Athena.ImportNotebook" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "ImportNotebook'" '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) :: (S1 ('MetaSel ('Just "payload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 NotebookType)))))

newImportNotebook Source #

Arguments

:: Text	`ImportNotebook`
-> Text	`ImportNotebook`
-> Text	`$sel:payload:ImportNotebook'`
-> NotebookType	`ImportNotebook`
-> ImportNotebook

Create a value of ImportNotebook 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:ImportNotebook', importNotebook_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.

ImportNotebook, importNotebook_workGroup - The name of the Spark enabled workgroup to import the notebook to.

ImportNotebook, importNotebook_name - The name of the notebook to import.

$sel:payload:ImportNotebook', importNotebook_payload - The notebook content to be imported.

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

Request Lenses

importNotebook_clientRequestToken :: Lens' ImportNotebook (Maybe Text) Source #

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.

importNotebook_workGroup :: Lens' ImportNotebook Text Source #

The name of the Spark enabled workgroup to import the notebook to.

importNotebook_name :: Lens' ImportNotebook Text Source #

The name of the notebook to import.

importNotebook_payload :: Lens' ImportNotebook Text Source #

The notebook content to be imported.

importNotebook_type :: Lens' ImportNotebook NotebookType Source #

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

Destructuring the Response

data ImportNotebookResponse Source #

See: newImportNotebookResponse smart constructor.

Constructors

ImportNotebookResponse'
Fields notebookId :: Maybe Text The ID of the notebook to import. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ImportNotebookResponse Source #
Instance details Defined in Amazonka.Athena.ImportNotebook Associated Types type Rep ImportNotebookResponse :: Type -> Type # Methods from :: ImportNotebookResponse -> Rep ImportNotebookResponse x # to :: Rep ImportNotebookResponse x -> ImportNotebookResponse #
Read ImportNotebookResponse Source #
Instance details Defined in Amazonka.Athena.ImportNotebook Methods readsPrec :: Int -> ReadS ImportNotebookResponse # readList :: ReadS [ImportNotebookResponse] # readPrec :: ReadPrec ImportNotebookResponse # readListPrec :: ReadPrec [ImportNotebookResponse] #
Show ImportNotebookResponse Source #
Instance details Defined in Amazonka.Athena.ImportNotebook Methods showsPrec :: Int -> ImportNotebookResponse -> ShowS # show :: ImportNotebookResponse -> String # showList :: [ImportNotebookResponse] -> ShowS #
NFData ImportNotebookResponse Source #
Instance details Defined in Amazonka.Athena.ImportNotebook Methods rnf :: ImportNotebookResponse -> () #
Eq ImportNotebookResponse Source #
Instance details Defined in Amazonka.Athena.ImportNotebook Methods (==) :: ImportNotebookResponse -> ImportNotebookResponse -> Bool # (/=) :: ImportNotebookResponse -> ImportNotebookResponse -> Bool #
type Rep ImportNotebookResponse Source #
Instance details Defined in Amazonka.Athena.ImportNotebook type Rep ImportNotebookResponse = D1 ('MetaData "ImportNotebookResponse" "Amazonka.Athena.ImportNotebook" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "ImportNotebookResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "notebookId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newImportNotebookResponse Source #

Arguments

:: Int	`$sel:httpStatus:ImportNotebookResponse'`
-> ImportNotebookResponse

Create a value of ImportNotebookResponse 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:

ImportNotebookResponse, importNotebookResponse_notebookId - The ID of the notebook to import.

$sel:httpStatus:ImportNotebookResponse', importNotebookResponse_httpStatus - The response's http status code.

Response Lenses

importNotebookResponse_notebookId :: Lens' ImportNotebookResponse (Maybe Text) Source #

The ID of the notebook to import.

importNotebookResponse_httpStatus :: Lens' ImportNotebookResponse Int Source #

The response's http status code.