Package software.amazon.awscdk.services.stepfunctions.tasks

Class AthenaStartQueryExecution

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.services.stepfunctions.State

software.amazon.awscdk.services.stepfunctions.TaskStateBase

software.amazon.awscdk.services.stepfunctions.tasks.AthenaStartQueryExecution

All Implemented Interfaces:

IChainable, INextable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:18.665Z")
@Stability(Stable)
public class AthenaStartQueryExecution
extends TaskStateBase

Start an Athena Query as a Task.

Example:

 AthenaStartQueryExecution startQueryExecutionJob = AthenaStartQueryExecution.Builder.create(this, "Start Athena Query")
         .queryString(JsonPath.stringAt("$.queryString"))
         .queryExecutionContext(QueryExecutionContext.builder()
                 .databaseName("mydatabase")
                 .build())
         .resultConfiguration(ResultConfiguration.builder()
                 .encryptionConfiguration(EncryptionConfiguration.builder()
                         .encryptionOption(EncryptionOption.S3_MANAGED)
                         .build())
                 .outputLocation(Location.builder()
                         .bucketName("amzn-s3-demo-bucket")
                         .objectKey("folder")
                         .build())
                 .build())
         .executionParameters(List.of("param1", "param2"))
         .build();
 

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/connect-athena.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AthenaStartQueryExecution.Builder	A fluent builder for AthenaStartQueryExecution.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.IChainable

IChainable.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.INextable

INextable.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AthenaStartQueryExecution(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	AthenaStartQueryExecution(software.amazon.jsii.JsiiObjectRef objRef)
	AthenaStartQueryExecution(software.constructs.Construct scope, String id, AthenaStartQueryExecutionProps props)

Method Summary

Modifier and Type	Method	Description
protected TaskMetricsConfig	getTaskMetrics()
protected List<PolicyStatement>	getTaskPolicies()
static AthenaStartQueryExecution	jsonata(software.constructs.Construct scope, String id, AthenaStartQueryExecutionJsonataProps props)	Start an Athena Query as a Task using JSONata.
static AthenaStartQueryExecution	jsonPath(software.constructs.Construct scope, String id, AthenaStartQueryExecutionJsonPathProps props)	Start an Athena Query as a Task using JSONPath.

Methods inherited from class software.amazon.awscdk.services.stepfunctions.TaskStateBase

addCatch, addCatch, addRetry, addRetry, getEndStates, metric, metric, metricFailed, metricFailed, metricHeartbeatTimedOut, metricHeartbeatTimedOut, metricRunTime, metricRunTime, metricScheduled, metricScheduled, metricScheduleTime, metricScheduleTime, metricStarted, metricStarted, metricSucceeded, metricSucceeded, metricTime, metricTime, metricTimedOut, metricTimedOut, next, toStateJson, toStateJson, whenBoundToGraph

Methods inherited from class software.amazon.awscdk.services.stepfunctions.State

addBranch, addChoice, addChoice, addItemProcessor, addItemProcessor, addIterator, addPrefix, bindToGraph, filterNextables, findReachableEndStates, findReachableEndStates, findReachableStates, findReachableStates, getArguments, getAssign, getBranches, getComment, getDefaultChoice, getId, getInputPath, getIteration, getOutputPath, getOutputs, getParameters, getProcessor, getProcessorConfig, getProcessorMode, getQueryLanguage, getResultPath, getResultSelector, getStartState, getStateId, getStateName, makeDefault, makeNext, prefixStates, renderAssign, renderAssign, renderBranches, renderChoices, renderChoices, renderInputOutput, renderItemProcessor, renderIterator, renderNextEnd, renderQueryLanguage, renderQueryLanguage, renderResultSelector, renderRetryCatch, renderRetryCatch, setDefaultChoice, setIteration, setProcessor, setProcessorConfig, setProcessorMode, validateState

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

AthenaStartQueryExecution

protected AthenaStartQueryExecution(software.amazon.jsii.JsiiObjectRef objRef)

AthenaStartQueryExecution

protected AthenaStartQueryExecution(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

AthenaStartQueryExecution

@Stability(Stable)
public AthenaStartQueryExecution(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 AthenaStartQueryExecutionProps props)

Parameters:

scope - This parameter is required.

id - Descriptive identifier for this chainable. This parameter is required.

props - This parameter is required.

Method Details

jsonata

@Stability(Stable)
@NotNull
public static AthenaStartQueryExecution jsonata(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 AthenaStartQueryExecutionJsonataProps props)

Start an Athena Query as a Task using JSONata.

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

jsonPath

@Stability(Stable)
@NotNull
public static AthenaStartQueryExecution jsonPath(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 AthenaStartQueryExecutionJsonPathProps props)

Start an Athena Query as a Task using JSONPath.

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

getTaskMetrics

@Stability(Stable)
@Nullable
protected TaskMetricsConfig getTaskMetrics()

Specified by:

getTaskMetrics in class TaskStateBase

getTaskPolicies

@Stability(Stable)
@Nullable
protected List<PolicyStatement> getTaskPolicies()

Specified by:

getTaskPolicies in class TaskStateBase