interface AthenaStartQueryExecutionProps

Language	Type name
.NET	Amazon.CDK.AWS.StepFunctions.Tasks.AthenaStartQueryExecutionProps
Java	software.amazon.awscdk.services.stepfunctions.tasks.AthenaStartQueryExecutionProps
Python	aws_cdk.aws_stepfunctions_tasks.AthenaStartQueryExecutionProps
TypeScript (source)	@aws-cdk/aws-stepfunctions-tasks » AthenaStartQueryExecutionProps

Properties for starting a Query Execution.

Example

const startQueryExecutionJob = new tasks.AthenaStartQueryExecution(this, 'Athena Start Query', {
  queryString: sfn.JsonPath.format('select contacts where year={};', sfn.JsonPath.stringAt('$.year')),
  queryExecutionContext: {
    databaseName: 'interactions',
  },
  resultConfiguration: {
    encryptionConfiguration: {
      encryptionOption: tasks.EncryptionOption.S3_MANAGED,
    },
    outputLocation: {
      bucketName: 'mybucket',
      objectKey: 'myprefix',
    },
  },
  integrationPattern: sfn.IntegrationPattern.RUN_JOB,
});

Properties

Name	Type	Description
queryString	string	Query that will be started.
clientRequestToken?	string	Unique string string to ensure idempotence.
comment?	string	An optional description for this state.
heartbeat?	Duration	Timeout for the heartbeat.
inputPath?	string	JSONPath expression to select part of the state to be the input to this state.
integrationPattern?	IntegrationPattern	AWS Step Functions integrates with services directly in the Amazon States Language.
outputPath?	string	JSONPath expression to select select a portion of the state output to pass to the next state.
queryExecutionContext?	QueryExecutionContext	Database within which query executes.
resultConfiguration?	ResultConfiguration	Configuration on how and where to save query.
resultPath?	string	JSONPath expression to indicate where to inject the state's output.
resultSelector?	{ [string]: any }	The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
timeout?	Duration	Timeout for the state machine.
workGroup?	string	Configuration on how and where to save query.

---

queryString

Type: string

Query that will be started.

---

clientRequestToken?

Type: string (optional, default: No client request token)

Unique string string to ensure idempotence.

---

comment?

Type: string (optional, default: No comment)

An optional description for this state.

---

heartbeat?

Type: Duration (optional, default: None)

Timeout for the heartbeat.

---

inputPath?

Type: string (optional, default: The entire task input (JSON path '$'))

JSONPath expression to select part of the state to be the input to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.

---

integrationPattern?

Type: IntegrationPattern (optional, default: IntegrationPattern.REQUEST_RESPONSE for most tasks. IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.)

AWS Step Functions integrates with services directly in the Amazon States Language.

You can control these AWS services using service integration patterns

See also: https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token

---

outputPath?

Type: string (optional, default: The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path '$'))

JSONPath expression to select select a portion of the state output to pass to the next state.

May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

---

queryExecutionContext?

Type: QueryExecutionContext (optional, default: No query execution context)

Database within which query executes.

---

resultConfiguration?

Type: ResultConfiguration (optional, default: No result configuration)

Configuration on how and where to save query.

---

resultPath?

Type: string (optional, default: Replaces the entire input with the result (JSON path '$'))

JSONPath expression to indicate where to inject the state's output.

May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.

---

resultSelector?

Type: { [string]: any } (optional, default: None)

The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector

---

timeout?

Type: Duration (optional, default: None)

Timeout for the state machine.

---

workGroup?

Type: string (optional, default: No work group)

Configuration on how and where to save query.