interface CallApiGatewayRestApiEndpointJsonataProps

Language	Type name
.NET	`Amazon.CDK.AWS.StepFunctions.Tasks.CallApiGatewayRestApiEndpointJsonataProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#CallApiGatewayRestApiEndpointJsonataProps`
Java	`software.amazon.awscdk.services.stepfunctions.tasks.CallApiGatewayRestApiEndpointJsonataProps`
Python	`aws_cdk.aws_stepfunctions_tasks.CallApiGatewayRestApiEndpointJsonataProps`
TypeScript (source)	`aws-cdk-lib` » `aws_stepfunctions_tasks` » `CallApiGatewayRestApiEndpointJsonataProps`

Properties for calling an REST API Endpoint using JSONata.

Example

import * as apigateway from 'aws-cdk-lib/aws-apigateway';
declare const api: apigateway.RestApi;

tasks.CallApiGatewayRestApiEndpoint.jsonata(this, 'Endpoint', {
  api,
  stageName: 'Stage',
  method: tasks.HttpMethod.PUT,
  integrationPattern: sfn.IntegrationPattern.WAIT_FOR_TASK_TOKEN,
  headers: sfn.TaskInput.fromObject({
    TaskToken: '{% States.Array($states.context.taskToken) %}',
  }),
});

Properties

Name	Type	Description
api	`IRestApi`	API to call.
method	`HttpMethod`	Http method for the API.
stageName	`string`	Name of the stage where the API is deployed to in API Gateway.
apiPath?	`string`	Path parameters appended after API endpoint.
assign?	`{ [string]: any }`	Workflow variables to store in this step.
authType?	`AuthType`	Authentication methods.
comment?	`string`	A comment describing this state.
credentials?	`Credentials`	Credentials for an IAM Role that the State Machine assumes for executing the task.
headers?	`TaskInput`	HTTP request information that does not relate to contents of the request.
heartbeat?⚠️	`Duration`	Timeout for the heartbeat.
heartbeatTimeout?	`Timeout`	Timeout for the heartbeat.
integrationPattern?	`IntegrationPattern`	AWS Step Functions integrates with services directly in the Amazon States Language.
outputs?	`any`	Used to specify and transform output from the state.
queryLanguage?	`QueryLanguage`	The name of the query language used by the state.
queryParameters?	`TaskInput`	Query strings attatched to end of request.
region?	`string`	Specify a custom Region where the API is deployed, e.g. 'us-east-1'.
requestBody?	`TaskInput`	HTTP Request body.
stateName?	`string`	Optional name for this state.
taskTimeout?	`Timeout`	Timeout for the task.
timeout?⚠️	`Duration`	Timeout for the task.

api

Type: IRestApi

API to call.

method

Type: HttpMethod

Http method for the API.

stageName

Type: string

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

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.

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.

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.

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.

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.

region?

Type: string (optional, default: Uses the Region of the stack containing the api.)

Specify a custom Region where the API is deployed, e.g. 'us-east-1'.

requestBody?

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

HTTP Request body.

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.

Select your cookie preferences