interface CallAwsServiceCrossRegionJsonataProps

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

Properties for calling an AWS service's API action using JSONata from your state machine across regions.

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_iam as iam } 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 parameters: any;
declare const policyStatement: iam.PolicyStatement;
declare const taskRole: stepfunctions.TaskRole;
declare const timeout: stepfunctions.Timeout;
const callAwsServiceCrossRegionJsonataProps: stepfunctions_tasks.CallAwsServiceCrossRegionJsonataProps = {
  action: 'action',
  iamResources: ['iamResources'],
  region: 'region',
  service: 'service',

  // the properties below are optional
  additionalIamStatements: [policyStatement],
  assign: {
    assignKey: assign,
  },
  comment: 'comment',
  credentials: {
    role: taskRole,
  },
  endpoint: 'endpoint',
  heartbeat: cdk.Duration.minutes(30),
  heartbeatTimeout: timeout,
  iamAction: 'iamAction',
  integrationPattern: stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
  outputs: outputs,
  parameters: {
    parametersKey: parameters,
  },
  queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
  retryOnServiceExceptions: false,
  stateName: 'stateName',
  taskTimeout: timeout,
  timeout: cdk.Duration.minutes(30),
};

Properties

Name	Type	Description
action	string	The API action to call.
iamResources	string[]	The resources for the IAM statement that will be added to the Lambda function role's policy to allow the state machine to make the API call.
region	string	The AWS region to call this AWS API for.
service	string	The AWS service to call in AWS SDK for JavaScript v3 format.
additionalIamStatements?	PolicyStatement[]	Additional IAM statements that will be added to the state machine role's policy.
assign?	{ [string]: any }	Workflow variables to store in this step.
comment?	string	A comment describing this state.
credentials?	Credentials	Credentials for an IAM Role that the State Machine assumes for executing the task.
endpoint?	string	The AWS API endpoint.
heartbeat?⚠️	Duration	Timeout for the heartbeat.
heartbeatTimeout?	Timeout	Timeout for the heartbeat.
iamAction?	string	The action for the IAM statement that will be added to the Lambda function role's policy to allow the state machine to make the API call.
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.
parameters?	{ [string]: any }	Parameters for the API action call in AWS SDK for JavaScript v3 format.
queryLanguage?	QueryLanguage	The name of the query language used by the state.
retryOnServiceExceptions?	boolean	Whether to retry on the backend Lambda service exceptions.
stateName?	string	Optional name for this state.
taskTimeout?	Timeout	Timeout for the task.
timeout?⚠️	Duration	Timeout for the task.

---

action

Type: string

The API action to call.

Use camelCase.

---

iamResources

Type: string[]

The resources for the IAM statement that will be added to the Lambda function role's policy to allow the state machine to make the API call.

---

region

Type: string

The AWS region to call this AWS API for. Example

'us-east-1'

---

service

Type: string

The AWS service to call in AWS SDK for JavaScript v3 format.

See also: https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/ Example

's3'

---

additionalIamStatements?

Type: PolicyStatement[] (optional, default: no additional statements are added)

Additional IAM statements that will be added to the state machine role's policy.

Use in the case where the call requires more than a single statement to be executed, e.g. rekognition:detectLabels requires also S3 permissions to read the object on which it must act.

---

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

---

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

---

endpoint?

Type: string (optional, default: Do not override API endpoint.)

The AWS API endpoint.

---

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

---

iamAction?

Type: string (optional, default: service:action)

The action for the IAM statement that will be added to the Lambda function role's policy to allow the state machine to make the API call.

By default the action for this IAM statement will be service:action.

Use in the case where the IAM action name does not match with the API service/action name, e.g. s3:ListBuckets requires s3:ListAllMyBuckets.

---

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

---

parameters?

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

Parameters for the API action call in AWS SDK for JavaScript v3 format.

---

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.

---

retryOnServiceExceptions?

Type: boolean (optional, default: true)

Whether to retry on the backend Lambda service exceptions.

This handles Lambda.ServiceException, Lambda.AWSLambdaException, Lambda.SdkClientException, and Lambda.ClientExecutionTimeoutException with an interval of 2 seconds, a back-off rate of 2 and 6 maximum attempts.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/bp-lambda-serviceexception.html

---

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.