Start Calculation Execution

athena_start_calculation_execution

R Documentation

Submits calculations for execution within a session

Description

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

The request syntax requires the StartCalculationExecutionRequest$CodeBlock parameter or the CalculationConfiguration$CodeBlock parameter, but not both. Because CalculationConfiguration$CodeBlock is deprecated, use the StartCalculationExecutionRequest$CodeBlock parameter instead.

Usage

athena_start_calculation_execution(SessionId, Description,
  CalculationConfiguration, CodeBlock, ClientRequestToken)

Arguments

SessionId

[required] The session ID.

Description

A description of the calculation.

CalculationConfiguration

Contains configuration information for the calculation.

CodeBlock

A string that contains the code of the calculation. Use this parameter instead of CalculationConfiguration$CodeBlock, which is deprecated.

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.

Value

A list with the following syntax:

list(
  CalculationExecutionId = "string",
  State = "CREATING"|"CREATED"|"QUEUED"|"RUNNING"|"CANCELING"|"CANCELED"|"COMPLETED"|"FAILED"
)

Request syntax

svc$start_calculation_execution(
  SessionId = "string",
  Description = "string",
  CalculationConfiguration = list(
    CodeBlock = "string"
  ),
  CodeBlock = "string",
  ClientRequestToken = "string"
)