class CallAwsService (construct)

Language	Type name
.NET	Amazon.CDK.AWS.StepFunctions.Tasks.CallAwsService
Java	software.amazon.awscdk.services.stepfunctions.tasks.CallAwsService
Python	aws_cdk.aws_stepfunctions_tasks.CallAwsService
TypeScript (source)	@aws-cdk/aws-stepfunctions-tasks » CallAwsService

Implements IConstruct, IConstruct, IDependable, IChainable, INextable

A StepFunctions task to call an AWS service API.

Example

declare const myBucket: s3.Bucket;
const getObject = new tasks.CallAwsService(this, 'GetObject', {
  service: 's3',
  action: 'getObject',
  parameters: {
    Bucket: myBucket.bucketName,
    Key: sfn.JsonPath.stringAt('$.key')
  },
  iamResources: [myBucket.arnForObjects('*')],
});

Initializer

new CallAwsService(scope: Construct, id: string, props: CallAwsServiceProps)

Parameters

• scope Construct
• id string
• props CallAwsServiceProps

Construct Props

Name	Type	Description
action	string	The API action to call.
iamResources	string[]	The resources for the IAM statement that will be added to the state machine role's policy to allow the state machine to make the API call.
service	string	The AWS service to call.
comment?	string	An optional description for this state.
heartbeat?	Duration	Timeout for the heartbeat.
iamAction?	string	The action for the IAM statement that will be added to the state machine 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.
integrationPattern?	IntegrationPattern	AWS Step Functions integrates with services directly in the Amazon States Language.
outputPath?	string	JSONPath expression to select select a portion of the state output to pass to the next state.
parameters?	{ [string]: any }	Parameters for the API action call.
resultPath?	string	JSONPath expression to indicate where to inject the state's output.
resultSelector?	{ [string]: any }	The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
timeout?	Duration	Timeout for the state machine.

---

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 state machine 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.

---

service

Type: string

The AWS service to call.

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

---

comment?

Type: string (optional, default: No comment)

An optional description for this state.

---

heartbeat?

Type: Duration (optional, default: None)

Timeout for the heartbeat.

---

iamAction?

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

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

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.

---

inputPath?

Type: string (optional, default: The entire task input (JSON path '$'))

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?

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

See also: https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token

---

outputPath?

Type: string (optional, default: The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path '$'))

JSONPath expression to select select a portion of the state output to pass to the next state.

May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

---

parameters?

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

Parameters for the API action call.

Use PascalCase for the parameter names.

---

resultPath?

Type: string (optional, default: Replaces the entire input with the result (JSON path '$'))

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?

Type: { [string]: any } (optional, default: 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.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector

---

timeout?

Type: Duration (optional, default: None)

Timeout for the state machine.

Properties

Name	Type	Description
endStates	INextable[]	Continuable states of this Chainable.
id	string	Descriptive identifier for this chainable.
node	ConstructNode	The construct tree node associated with this construct.
startState	State	First state of this Chainable.
stateId	string	Tokenized string that evaluates to the state's ID.
taskMetrics?	TaskMetricsConfig
taskPolicies?	PolicyStatement[]

---

endStates

Type: INextable[]

Continuable states of this Chainable.

---

id

Type: string

Descriptive identifier for this chainable.

---

node

Type: ConstructNode

The construct tree node associated with this construct.

---

startState

Type: State

First state of this Chainable.

---

stateId

Type: string

Tokenized string that evaluates to the state's ID.

---

taskMetrics?

Type: TaskMetricsConfig (optional)

---

taskPolicies?

Type: PolicyStatement[] (optional)

Methods

Name	Description
addCatch(handler, props?)	Add a recovery handler for this state.
addPrefix(x)	Add a prefix to the stateId of this state.
addRetry(props?)	Add retry configuration for this state.
bindToGraph(graph)	Register this state as part of the given graph.
metric(metricName, props?)	Return the given named metric for this Task.
metricFailed(props?)	Metric for the number of times this activity fails.
metricHeartbeatTimedOut(props?)	Metric for the number of times the heartbeat times out for this activity.
metricRunTime(props?)	The interval, in milliseconds, between the time the Task starts and the time it closes.
metricScheduleTime(props?)	The interval, in milliseconds, for which the activity stays in the schedule state.
metricScheduled(props?)	Metric for the number of times this activity is scheduled.
metricStarted(props?)	Metric for the number of times this activity is started.
metricSucceeded(props?)	Metric for the number of times this activity succeeds.
metricTime(props?)	The interval, in milliseconds, between the time the activity is scheduled and the time it closes.
metricTimedOut(props?)	Metric for the number of times this activity times out.
next(next)	Continue normal execution with the given state.
toStateJson()	Return the Amazon States Language object for this state.
toString()	Returns a string representation of this construct.

---

addCatch(handler, props?)

public addCatch(handler: IChainable, props?: CatchProps): TaskStateBase

Parameters

• handler IChainable
• props CatchProps

Returns

• 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)

public addPrefix(x: string): void

Parameters

• x string

Add a prefix to the stateId of this state.

---

addRetry(props?)

public addRetry(props?: RetryProps): TaskStateBase

Parameters

• props RetryProps

Returns

• TaskStateBase

Add retry configuration for this state.

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

---

bindToGraph(graph)

public bindToGraph(graph: StateGraph): void

Parameters

• graph StateGraph

Register this state as part of the given graph.

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

---

metric(metricName, props?)

public metric(metricName: string, props?: MetricOptions): Metric

Parameters

• metricName string
• props MetricOptions

Returns

• Metric

Return the given named metric for this Task.

---

metricFailed(props?)

public metricFailed(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the number of times this activity fails.

---

metricHeartbeatTimedOut(props?)

public metricHeartbeatTimedOut(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the number of times the heartbeat times out for this activity.

---

metricRunTime(props?)

public metricRunTime(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

The interval, in milliseconds, between the time the Task starts and the time it closes.

---

metricScheduleTime(props?)

public metricScheduleTime(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

The interval, in milliseconds, for which the activity stays in the schedule state.

---

metricScheduled(props?)

public metricScheduled(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the number of times this activity is scheduled.

---

metricStarted(props?)

public metricStarted(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the number of times this activity is started.

---

metricSucceeded(props?)

public metricSucceeded(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the number of times this activity succeeds.

---

metricTime(props?)

public metricTime(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

The interval, in milliseconds, between the time the activity is scheduled and the time it closes.

---

metricTimedOut(props?)

public metricTimedOut(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the number of times this activity times out.

---

next(next)

public next(next: IChainable): Chain

Parameters

• next IChainable

Returns

• Chain

Continue normal execution with the given state.

---

toStateJson()

public toStateJson(): json

Returns

• json

Return the Amazon States Language object for this state.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.