# AthenaStartQueryExecutionJsonPathProps

Properties for starting a Query Execution using JSONPath.

Extends: AthenaStartQueryExecutionJsonPathProps
Extends: TaskStateJsonPathBaseProps

- Source: [`aws-stepfunctions-tasks/lib/athena/start-query-execution.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-stepfunctions-tasks/lib/athena/start-query-execution.ts#L66)
- Type last changed: v2.178.0 · 6 Feb 2025

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_kms as kms } from 'aws-cdk-lib';
import { aws_stepfunctions as stepfunctions } from 'aws-cdk-lib';
import { aws_stepfunctions_tasks as stepfunctions_tasks } from 'aws-cdk-lib';

declare const assign: any;
declare const key: kms.Key;
declare const resultSelector: any;
declare const taskRole: stepfunctions.TaskRole;
declare const timeout: stepfunctions.Timeout;
const athenaStartQueryExecutionJsonPathProps: stepfunctions_tasks.AthenaStartQueryExecutionJsonPathProps = {
  queryString: 'queryString',

  // the properties below are optional
  assign: {
    assignKey: assign,
  },
  clientRequestToken: 'clientRequestToken',
  comment: 'comment',
  credentials: {
    role: taskRole,
  },
  executionParameters: ['executionParameters'],
  heartbeat: cdk.Duration.minutes(30),
  heartbeatTimeout: timeout,
  inputPath: 'inputPath',
  integrationPattern: stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
  outputPath: 'outputPath',
  queryExecutionContext: {
    catalogName: 'catalogName',
    databaseName: 'databaseName',
  },
  queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
  resultConfiguration: {
    encryptionConfiguration: {
      encryptionOption: stepfunctions_tasks.EncryptionOption.S3_MANAGED,

      // the properties below are optional
      encryptionKey: key,
    },
    outputLocation: {
      bucketName: 'bucketName',
      objectKey: 'objectKey',

      // the properties below are optional
      objectVersion: 'objectVersion',
    },
  },
  resultPath: 'resultPath',
  resultReuseConfigurationMaxAge: cdk.Duration.minutes(30),
  resultSelector: {
    resultSelectorKey: resultSelector,
  },
  stateName: 'stateName',
  taskTimeout: timeout,
  timeout: cdk.Duration.minutes(30),
  workGroup: 'workGroup',
};
```

## Properties

- `assign`: { [key: string]: any } — Workflow variables to store in this step.

  **Default:** Not assign variables

  Using workflow variables, you can store data in a step and retrieve that data in future steps.

- `clientRequestToken`: string — Unique string string to ensure idempotence.

  **Default:** No client request token

- `comment`: string — A comment describing this state.

  **Default:** No comment

- `credentials`: [Credentials](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.Credentials.html) — Credentials for an IAM Role that the State Machine assumes for executing the task.

  **Default:** None (Task is executed using the State Machine's execution role)

  This enables cross-account resource invocations.

- `executionParameters`: string[] — A list of values for the parameters in a query.

  **Default:** No parameters

  The values are applied sequentially to the parameters in the query in the order
  in which the parameters occur.

- `heartbeat`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) = None — use `heartbeatTimeout`

- `heartbeatTimeout`: [Timeout](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.Timeout.html) = None — Timeout for the heartbeat.

  [disable-awslint:duration-prop-type] is needed because all props interface in
  aws-stepfunctions-tasks extend this interface

- `inputPath`: string = $ — 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`: [IntegrationPattern](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.IntegrationPattern.html) — AWS Step Functions integrates with services directly in the Amazon States Language.

  **Default:** `IntegrationPattern.REQUEST_RESPONSE` for most tasks. `IntegrationPattern.RUN_JOB` for the following exceptions: `BatchSubmitJob`, `EmrAddStep`, `EmrCreateCluster`, `EmrTerminationCluster`, and `EmrContainersStartJobRun`.

  You can control these AWS services using service integration patterns.

  Depending on the AWS Service, the Service Integration Pattern availability will vary.

- `outputPath`: string = $ — JSONPath expression to select part of the state to be the output to this state.

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

- `queryExecutionContext`: [QueryExecutionContext](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions_tasks.QueryExecutionContext.html) — Database within which query executes.

  **Default:** No query execution context

- `queryLanguage`: [QueryLanguage](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.QueryLanguage.html) = JSONPath — The name of the query language used by the state.

  If the state does not contain a `queryLanguage` field,
  then it will use the query language specified in the top-level `queryLanguage` field.

- `queryString`: string (required) — Query that will be started.

- `resultConfiguration`: [ResultConfiguration](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions_tasks.ResultConfiguration.html) — Configuration on how and where to save query.

  **Default:** No result configuration

- `resultPath`: string = $ — 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.

- `resultReuseConfigurationMaxAge`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) — Specifies, in minutes, the maximum age of a previous query result that Athena should consider for reuse.

  **Default:** Query results are not reused

- `resultSelector`: { [key: string]: any } = 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.

- `stateName`: string — Optional name for this state.

  **Default:** The construct ID will be used as state name

- `taskTimeout`: [Timeout](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.Timeout.html) = None — Timeout for the task.

  [disable-awslint:duration-prop-type] is needed because all props interface in
  aws-stepfunctions-tasks extend this interface

- `timeout`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) = None — use `taskTimeout`

- `workGroup`: string — Configuration on how and where to save query.

  **Default:** No work group