Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

2.181.1

interface CallApiGatewayHttpApiEndpointJsonataProps

LanguageType name
.NETAmazon.CDK.AWS.StepFunctions.Tasks.CallApiGatewayHttpApiEndpointJsonataProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#CallApiGatewayHttpApiEndpointJsonataProps
Javasoftware.amazon.awscdk.services.stepfunctions.tasks.CallApiGatewayHttpApiEndpointJsonataProps
Pythonaws_cdk.aws_stepfunctions_tasks.CallApiGatewayHttpApiEndpointJsonataProps
TypeScript (source)aws-cdk-lib » aws_stepfunctions_tasks » CallApiGatewayHttpApiEndpointJsonataProps

Properties for calling an HTTP API Endpoint using JSONata.

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_stepfunctions as stepfunctions } from 'aws-cdk-lib';
import { aws_stepfunctions_tasks as stepfunctions_tasks } from 'aws-cdk-lib';

declare const assign: any;
declare const outputs: any;
declare const stack: cdk.Stack;
declare const taskInput: stepfunctions.TaskInput;
declare const taskRole: stepfunctions.TaskRole;
declare const timeout: stepfunctions.Timeout;
const callApiGatewayHttpApiEndpointJsonataProps: stepfunctions_tasks.CallApiGatewayHttpApiEndpointJsonataProps = {
  apiId: 'apiId',
  apiStack: stack,
  method: stepfunctions_tasks.HttpMethod.GET,

  // the properties below are optional
  apiPath: 'apiPath',
  assign: {
    assignKey: assign,
  },
  authType: stepfunctions_tasks.AuthType.NO_AUTH,
  comment: 'comment',
  credentials: {
    role: taskRole,
  },
  headers: taskInput,
  heartbeat: cdk.Duration.minutes(30),
  heartbeatTimeout: timeout,
  integrationPattern: stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
  outputs: outputs,
  queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
  queryParameters: taskInput,
  requestBody: taskInput,
  stageName: 'stageName',
  stateName: 'stateName',
  taskTimeout: timeout,
  timeout: cdk.Duration.minutes(30),
};

Properties

NameTypeDescription
apiIdstringThe Id of the API to call.
apiStackStackThe Stack in which the API is defined.
methodHttpMethodHttp method for the API.
apiPath?stringPath parameters appended after API endpoint.
assign?{ [string]: any }Workflow variables to store in this step.
authType?AuthTypeAuthentication methods.
comment?stringA comment describing this state.
credentials?CredentialsCredentials for an IAM Role that the State Machine assumes for executing the task.
headers?TaskInputHTTP request information that does not relate to contents of the request.
heartbeat?⚠️DurationTimeout for the heartbeat.
heartbeatTimeout?TimeoutTimeout for the heartbeat.
integrationPattern?IntegrationPatternAWS Step Functions integrates with services directly in the Amazon States Language.
outputs?anyUsed to specify and transform output from the state.
queryLanguage?QueryLanguageThe name of the query language used by the state.
queryParameters?TaskInputQuery strings attatched to end of request.
requestBody?TaskInputHTTP Request body.
stageName?stringName of the stage where the API is deployed to in API Gateway.
stateName?stringOptional name for this state.
taskTimeout?TimeoutTimeout for the task.
timeout?⚠️DurationTimeout for the task.

apiId

Type: string

The Id of the API to call.

apiStack

Type: Stack

The Stack in which the API is defined.

method

Type: HttpMethod

Http method for the API.

apiPath?

Type: string (optional, default: No path)

Path parameters appended after API endpoint.

assign?

Type: { [string]: any } (optional, default: Not assign variables)

Workflow variables to store in this step.

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

See also: https://docs.aws.amazon.com/step-functions/latest/dg/workflow-variables.html

authType?

Type: AuthType (optional, default: AuthType.NO_AUTH)

Authentication methods.

comment?

Type: string (optional, default: No comment)

A comment describing this state.

credentials?

Type: Credentials (optional, default: None (Task is executed using the State Machine's execution role))

Credentials for an IAM Role that the State Machine assumes for executing the task.

This enables cross-account resource invocations.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-access-cross-acct-resources.html

headers?

Type: TaskInput (optional, default: No headers)

HTTP request information that does not relate to contents of the request.

heartbeat?⚠️

⚠️ Deprecated: use heartbeatTimeout

Type: Duration (optional, default: None)

Timeout for the heartbeat.

heartbeatTimeout?

Type: Timeout (optional, default: None)

Timeout for the heartbeat.

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

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.

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

See also: https://docs.aws.amazon.com/step-functions/latest/dg/connect-supported-services.html

outputs?

Type: any (optional, default: $states.result or $states.errorOutput)

Used to specify and transform output from the state.

When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-input-output-filtering.html

queryLanguage?

Type: QueryLanguage (optional, default: 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.

queryParameters?

Type: TaskInput (optional, default: No query parameters)

Query strings attatched to end of request.

requestBody?

Type: TaskInput (optional, default: No request body)

HTTP Request body.

stageName?

Type: string (optional, default: '$default')

Name of the stage where the API is deployed to in API Gateway.

stateName?

Type: string (optional, default: The construct ID will be used as state name)

Optional name for this state.

taskTimeout?

Type: Timeout (optional, default: None)

Timeout for the task.

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

timeout?⚠️

⚠️ Deprecated: use taskTimeout

Type: Duration (optional, default: None)

Timeout for the task.

← PreviousNext →