Skip to content

StartCalculationExecutionRequest

Source code in docs_src/capo_athena/types/start_calculation_execution_request.py
class StartCalculationExecutionRequest(TypedDict, closed=True):
    session_id: "capo_athena.types.session_id.SessionId"
    """<p>The session ID.</p>"""
    description: NotRequired["capo_athena.types.description_string.DescriptionString"]
    """<p>A description of the calculation.</p>"""
    calculation_configuration: NotRequired[
        "capo_athena.types.calculation_configuration.CalculationConfiguration"
    ]
    """<p>Contains configuration information for the calculation.</p>"""
    code_block: NotRequired["capo_athena.types.code_block.CodeBlock"]
    """<p>A string that contains the code of the calculation. Use this parameter instead of <a>CalculationConfiguration$CodeBlock</a>, which is deprecated.</p>"""
    client_request_token: NotRequired[
        "capo_athena.types.idempotency_token.IdempotencyToken"
    ]
    """<p>A unique case-sensitive string used to ensure the request to create the calculation is idempotent (executes only once). If another <code>StartCalculationExecutionRequest</code> is received, the same response is returned and another calculation is not created. If a parameter has changed, an error is returned.</p> <important> <p>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.</p> </important>"""

calculation_configuration instance-attribute

calculation_configuration: NotRequired[CalculationConfiguration]

Contains configuration information for the calculation.

client_request_token instance-attribute

client_request_token: NotRequired[IdempotencyToken]

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.

code_block instance-attribute

code_block: NotRequired[CodeBlock]

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

description instance-attribute

description: NotRequired[DescriptionString]

A description of the calculation.

session_id instance-attribute

session_id: SessionId

The session ID.