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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Submits calculations for execution within a session. You can supply the code to run as an inline code block within the request or as an Amazon S3 URL.

Synopsis

Creating a Request

data StartCalculationExecution Source #

See: newStartCalculationExecution smart constructor.

Constructors

StartCalculationExecution'

Fields

calculationConfiguration :: Maybe CalculationConfiguration
Contains configuration information for the calculation.
clientRequestToken :: Maybe Text
A unique case-sensitive string used to ensure the request to create the calculation is idempotent (executes only once). If another StartCalculationExecutionRequest is received, the same response is returned and another calculation is not created. If a parameter has changed, an error is returned.
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 users. 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.
codeBlock :: Maybe Text
A string that contains the code of the calculation.
description :: Maybe Text
A description of the calculation.
sessionId :: Text
The session ID.

Instances

Instances details

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

newStartCalculationExecution Source #

Arguments

:: Text	`StartCalculationExecution`
-> StartCalculationExecution

Create a value of StartCalculationExecution 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:calculationConfiguration:StartCalculationExecution', startCalculationExecution_calculationConfiguration - Contains configuration information for the calculation.

$sel:clientRequestToken:StartCalculationExecution', startCalculationExecution_clientRequestToken - A unique case-sensitive string used to ensure the request to create the calculation is idempotent (executes only once). If another StartCalculationExecutionRequest is received, the same response is returned and another calculation is not created. If a parameter has changed, an error is returned.

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

StartCalculationExecution, startCalculationExecution_codeBlock - A string that contains the code of the calculation.

StartCalculationExecution, startCalculationExecution_description - A description of the calculation.

StartCalculationExecution, startCalculationExecution_sessionId - The session ID.

Request Lenses

startCalculationExecution_calculationConfiguration :: Lens' StartCalculationExecution (Maybe CalculationConfiguration) Source #

Contains configuration information for the calculation.

startCalculationExecution_clientRequestToken :: Lens' StartCalculationExecution (Maybe Text) Source #

A unique case-sensitive string used to ensure the request to create the calculation is idempotent (executes only once). If another StartCalculationExecutionRequest is received, the same response is returned and another calculation is not created. If a parameter has changed, an error is returned.

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

startCalculationExecution_codeBlock :: Lens' StartCalculationExecution (Maybe Text) Source #

A string that contains the code of the calculation.

startCalculationExecution_description :: Lens' StartCalculationExecution (Maybe Text) Source #

A description of the calculation.

startCalculationExecution_sessionId :: Lens' StartCalculationExecution Text Source #

The session ID.

Destructuring the Response

data StartCalculationExecutionResponse Source #

See: newStartCalculationExecutionResponse smart constructor.

Constructors

StartCalculationExecutionResponse'

Fields

calculationExecutionId :: Maybe Text
The calculation execution UUID.
state :: Maybe CalculationExecutionState
CREATING - The calculation is in the process of being created.
CREATED - The calculation has been created and is ready to run.
QUEUED - The calculation has been queued for processing.
RUNNING - The calculation is running.
CANCELING - A request to cancel the calculation has been received and the system is working to stop it.
CANCELED - The calculation is no longer running as the result of a cancel request.
COMPLETED - The calculation has completed without error.
FAILED - The calculation failed and is no longer running.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newStartCalculationExecutionResponse Source #

Arguments

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

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

StartCalculationExecutionResponse, startCalculationExecutionResponse_calculationExecutionId - The calculation execution UUID.

StartCalculationExecutionResponse, startCalculationExecutionResponse_state - CREATING - The calculation is in the process of being created.

CREATED - The calculation has been created and is ready to run.

QUEUED - The calculation has been queued for processing.

RUNNING - The calculation is running.

CANCELING - A request to cancel the calculation has been received and the system is working to stop it.

CANCELED - The calculation is no longer running as the result of a cancel request.

COMPLETED - The calculation has completed without error.

FAILED - The calculation failed and is no longer running.

$sel:httpStatus:StartCalculationExecutionResponse', startCalculationExecutionResponse_httpStatus - The response's http status code.

Response Lenses

startCalculationExecutionResponse_calculationExecutionId :: Lens' StartCalculationExecutionResponse (Maybe Text) Source #

The calculation execution UUID.

startCalculationExecutionResponse_state :: Lens' StartCalculationExecutionResponse (Maybe CalculationExecutionState) Source #

CREATING - The calculation is in the process of being created.