# CallAwsServiceCrossRegion

A Step Functions task to call an AWS service API across regions.

This task creates a Lambda function to call cross-region AWS API and invokes it.

Extends: Construct › State › TaskStateBase › CallAwsServiceCrossRegion
Implements: IChainable, INextable, IConstruct, IDependable

- Source: [`aws-stepfunctions-tasks/lib/lambda/call-aws-service-cross-region.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-stepfunctions-tasks/lib/lambda/call-aws-service-cross-region.ts#L121)
- Type last changed: v2.178.0 · 6 Feb 2025

## Example

```ts
declare const myBucket: s3.Bucket;
const getObject = new tasks.CallAwsServiceCrossRegion(this, 'GetObject', {
  region: 'ap-northeast-1',
  service: 's3',
  action: 'getObject',
  parameters: {
    Bucket: myBucket.bucketName,
    Key: sfn.JsonPath.stringAt('$.key')
  },
  iamResources: [myBucket.arnForObjects('*')],
});
```

## Initializer

```ts
new CallAwsServiceCrossRegion(scope: Construct, id: string, props: CallAwsServiceCrossRegionProps)
```

## Construct Props

- `action`: string (required) — The API action to call.

  Use camelCase.

- `additionalIamStatements`: [PolicyStatement](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.PolicyStatement.html)[] — Additional IAM statements that will be added to the state machine role's policy.

  **Default:** no additional statements are added

  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`: { [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.

- `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.

- `endpoint`: string — The AWS API endpoint.

  **Default:** Do not override API endpoint.

  Be aware that if you set this to a value from the Step Functions state
  (e.g. `sfn.JsonPath.stringAt('$.endpoint')`), the endpoint is controlled
  at runtime by whoever can start the state machine execution. This could
  allow them to redirect the authenticated AWS API call to a server they
  control, allowing them to intercept and replay that specific API call.

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

- `iamAction`: string = 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`.

- `iamResources`: string[] (required) — 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.

- `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 {}.

- `outputs`: any — Used to specify and transform output from the state.

  **Default:** $states.result or $states.errorOutput

  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.

- `parameters`: { [key: string]: any } — Parameters for the API action call in AWS SDK for JavaScript v3 format.

  **Default:** no parameters

- `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.

- `region`: string (required) — The AWS region to call this AWS API for.

  ```ts
  'us-east-1'
  ```

- `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.

- `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.

- `retryOnServiceExceptions`: boolean = 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.

- `service`: string (required) — The AWS service to call in AWS SDK for JavaScript v3 format.

  ```ts
  's3'
  ```

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

## Properties

- `endStates`: [INextable](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.INextable.html)[] — Continuable states of this Chainable.

- `id`: string — Descriptive identifier for this chainable.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) — The tree node.

- `startState`: [State](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.State.html) — First state of this Chainable.

- `stateId`: string — Tokenized string that evaluates to the state's ID.

## Methods

- `addCatch(handler: IChainable, props?: CatchProps): TaskStateBase` — Add a recovery handler for this state.

  When a particular error occurs, execution will continue at the error
  handler instead of failing the state machine execution.

- `addPrefix(x: string): void` — Add a prefix to the stateId of this state.

- `addRetry(props?: RetryProps): TaskStateBase` — Add retry configuration for this state.

  This controls if and how the execution will be retried if a particular
  error occurs.

- `bindToGraph(graph: StateGraph): void` — Register this state as part of the given graph.

  Don't call this. It will be called automatically when you work
  with states normally.

- `filterNextables(states: State[]): INextable[]` (static) — Return only the states that allow chaining from an array of states.

- `findReachableEndStates(start: State, options?: FindStateOptions): State[]` (static) — Find the set of end states states reachable through transitions from the given start state.

- `findReachableStates(start: State, options?: FindStateOptions): State[]` (static) — Find the set of states reachable through transitions from the given start state.

  This does not retrieve states from within sub-graphs, such as states within a Parallel state's branch.

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `jsonata(scope: Construct, id: string, props: CallAwsServiceCrossRegionJsonataProps): CallAwsServiceCrossRegion // chainable` (static) — A Step Functions task using JSONata to call an AWS service API across regions.

  This task creates a Lambda function to call cross-region AWS API and invokes it.

- `jsonPath(scope: Construct, id: string, props: CallAwsServiceCrossRegionJsonPathProps): CallAwsServiceCrossRegion // chainable` (static) — A Step Functions task using JSONPath to call an AWS service API across regions.

  This task creates a Lambda function to call cross-region AWS API and invokes it.

- `metric(metricName: string, props?: MetricOptions): Metric` — Return the given named metric for this Task.

- `metricFailed(props?: MetricOptions): Metric` — Metric for the number of times this activity fails.

- `metricHeartbeatTimedOut(props?: MetricOptions): Metric` — Metric for the number of times the heartbeat times out for this activity.

- `metricRunTime(props?: MetricOptions): Metric` — The interval, in milliseconds, between the time the Task starts and the time it closes.

- `metricScheduled(props?: MetricOptions): Metric` — Metric for the number of times this activity is scheduled.

- `metricScheduleTime(props?: MetricOptions): Metric` — The interval, in milliseconds, for which the activity stays in the schedule state.

- `metricStarted(props?: MetricOptions): Metric` — Metric for the number of times this activity is started.

- `metricSucceeded(props?: MetricOptions): Metric` — Metric for the number of times this activity succeeds.

- `metricTime(props?: MetricOptions): Metric` — The interval, in milliseconds, between the time the activity is scheduled and the time it closes.

- `metricTimedOut(props?: MetricOptions): Metric` — Metric for the number of times this activity times out.

- `next(next: IChainable): Chain` — Continue normal execution with the given state.

- `prefixStates(root: IConstruct, prefix: string): void` (static) — Add a prefix to the stateId of all States found in a construct tree.

- `toStateJson(topLevelQueryLanguage?: QueryLanguage): json` — Return the Amazon States Language object for this state.

- `toString(): string` — Returns a string representation of this construct.

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.

  **Parameters**

  - `mixins` — The mixins to apply.

  **Returns:** This construct for chaining