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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the contents of a Spark notebook.

Creating a Request

data UpdateNotebook Source #

See: newUpdateNotebook smart constructor.

Constructors

UpdateNotebook'

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.
sessionId :: Maybe Text
The ID of the session in which the notebook will be updated.
notebookId :: Text
The ID of the notebook to update.
payload :: Text
The updated content for the notebook.
type' :: NotebookType
The notebook content type. Currently, the only valid type is IPYNB.

Instances

Instances details

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

newUpdateNotebook Source #

Arguments

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

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

UpdateNotebook, updateNotebook_sessionId - The ID of the session in which the notebook will be updated.

UpdateNotebook, updateNotebook_notebookId - The ID of the notebook to update.

$sel:payload:UpdateNotebook', updateNotebook_payload - The updated content for the notebook.

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

Request Lenses

updateNotebook_clientRequestToken :: Lens' UpdateNotebook (Maybe Text) Source #

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.

updateNotebook_sessionId :: Lens' UpdateNotebook (Maybe Text) Source #

The ID of the session in which the notebook will be updated.

updateNotebook_notebookId :: Lens' UpdateNotebook Text Source #

The ID of the notebook to update.

updateNotebook_payload :: Lens' UpdateNotebook Text Source #

The updated content for the notebook.

updateNotebook_type :: Lens' UpdateNotebook NotebookType Source #

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

Destructuring the Response

data UpdateNotebookResponse Source #

See: newUpdateNotebookResponse smart constructor.

Constructors

UpdateNotebookResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

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

newUpdateNotebookResponse Source #

Arguments

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

Create a value of UpdateNotebookResponse 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:httpStatus:UpdateNotebookResponse', updateNotebookResponse_httpStatus - The response's http status code.

Response Lenses

updateNotebookResponse_httpStatus :: Lens' UpdateNotebookResponse Int Source #

The response's http status code.