AthenaStartQueryExecutionJsonPathProps Struct

Properties for starting a Query Execution using JSONPath.

Source: aws-stepfunctions-tasks/lib/athena/start-query-execution.ts
Type last changed: v2.178.0 · 6 Feb 2025

Example

// 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

assignoptional{ [key: string]: any }assignoptionaltyping.Mapping[str, Any]assignoptionalMap<String, Object>AssignoptionalIDictionary<string, object>Assignoptional*map[string]interface{}#

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.

clientRequestTokenoptionalstringclient_request_tokenoptionalstrclientRequestTokenoptionalStringClientRequestTokenoptionalstringClientRequestTokenoptional*string#

Unique string string to ensure idempotence.

Default: No client request token

commentoptionalstringcommentoptionalstrcommentoptionalStringCommentoptionalstringCommentoptional*string#

A comment describing this state.

Default: No comment

credentialsoptionalCredentialscredentialsoptionalCredentialscredentialsoptionalCredentialsCredentialsoptionalCredentialsCredentialsoptionalCredentials#

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.

executionParametersoptionalstring[]execution_parametersoptionaltyping.List[str]executionParametersoptionalList<String>ExecutionParametersoptionalstring[]ExecutionParametersoptional*[]*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.

heartbeatoptionalDurationheartbeatoptionalDurationheartbeatoptionalDurationHeartbeatoptionalDurationHeartbeatoptionalDuration= Nonedeprecated#

use `heartbeatTimeout`

heartbeatTimeoutoptionalTimeoutheartbeat_timeoutoptionalTimeoutheartbeatTimeoutoptionalTimeoutHeartbeatTimeoutoptionalTimeoutHeartbeatTimeoutoptionalTimeout= None#

Timeout for the heartbeat.

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

inputPathoptionalstringinput_pathoptionalstrinputPathoptionalStringInputPathoptionalstringInputPathoptional*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 {}.

integrationPatternoptionalIntegrationPatternintegration_patternoptionalIntegrationPatternintegrationPatternoptionalIntegrationPatternIntegrationPatternoptionalIntegrationPatternIntegrationPatternoptionalIntegrationPattern#

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.

outputPathoptionalstringoutput_pathoptionalstroutputPathoptionalStringOutputPathoptionalstringOutputPathoptional*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 {}.

queryExecutionContextoptionalQueryExecutionContextquery_execution_contextoptionalQueryExecutionContextqueryExecutionContextoptionalQueryExecutionContextQueryExecutionContextoptionalQueryExecutionContextQueryExecutionContextoptionalQueryExecutionContext#

Database within which query executes.

Default: No query execution context

queryLanguageoptionalQueryLanguagequery_languageoptionalQueryLanguagequeryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguage= 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.

queryStringstringquery_stringstrqueryStringStringQueryStringstringQueryString*stringrequired#

Query that will be started.

resultConfigurationoptionalResultConfigurationresult_configurationoptionalResultConfigurationresultConfigurationoptionalResultConfigurationResultConfigurationoptionalResultConfigurationResultConfigurationoptionalResultConfiguration#

Configuration on how and where to save query.

Default: No result configuration

resultPathoptionalstringresult_pathoptionalstrresultPathoptionalStringResultPathoptionalstringResultPathoptional*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.

resultReuseConfigurationMaxAgeoptionalDurationresult_reuse_configuration_max_ageoptionalDurationresultReuseConfigurationMaxAgeoptionalDurationResultReuseConfigurationMaxAgeoptionalDurationResultReuseConfigurationMaxAgeoptionalDuration#

Specifies, in minutes, the maximum age of a previous query result that Athena should consider for reuse.

Default: Query results are not reused

resultSelectoroptional{ [key: string]: any }result_selectoroptionaltyping.Mapping[str, Any]resultSelectoroptionalMap<String, Object>ResultSelectoroptionalIDictionary<string, object>ResultSelectoroptional*map[string]interface{}= 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.

stateNameoptionalstringstate_nameoptionalstrstateNameoptionalStringStateNameoptionalstringStateNameoptional*string#

Optional name for this state.

Default: The construct ID will be used as state name

taskTimeoutoptionalTimeouttask_timeoutoptionalTimeouttaskTimeoutoptionalTimeoutTaskTimeoutoptionalTimeoutTaskTimeoutoptionalTimeout= None#

Timeout for the task.

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

timeoutoptionalDurationtimeoutoptionalDurationtimeoutoptionalDurationTimeoutoptionalDurationTimeoutoptionalDuration= Nonedeprecated#

use `taskTimeout`

workGroupoptionalstringwork_groupoptionalstrworkGroupoptionalStringWorkGroupoptionalstringWorkGroupoptional*string#

Configuration on how and where to save query.

Default: No work group

AthenaStartQueryExecutionJsonPathProps Struct ​

Example ​

Properties ​

AthenaStartQueryExecutionJsonPathProps Struct

Example

Properties