Class CallAwsService

A StepFunctions task to call an AWS service API.

Inheritance

object

State

TaskStateBase

CallAwsService

Implements

IChainable

INextable

Inherited Members

TaskStateBase.AddCatch(IChainable, ICatchProps)

TaskStateBase.AddRetry(IRetryProps)

TaskStateBase.Metric(string, IMetricOptions)

TaskStateBase.MetricFailed(IMetricOptions)

TaskStateBase.MetricHeartbeatTimedOut(IMetricOptions)

TaskStateBase.MetricRunTime(IMetricOptions)

TaskStateBase.MetricScheduled(IMetricOptions)

TaskStateBase.MetricScheduleTime(IMetricOptions)

TaskStateBase.MetricStarted(IMetricOptions)

TaskStateBase.MetricSucceeded(IMetricOptions)

TaskStateBase.MetricTime(IMetricOptions)

TaskStateBase.MetricTimedOut(IMetricOptions)

TaskStateBase.Next(IChainable)

TaskStateBase.ToStateJson(QueryLanguage?)

TaskStateBase.WhenBoundToGraph(StateGraph)

TaskStateBase.EndStates

State.FilterNextables(State[])

State.FindReachableEndStates(State, IFindStateOptions)

State.FindReachableStates(State, IFindStateOptions)

State.PrefixStates(IConstruct, string)

State.AddBranch(StateGraph)

State.AddChoice(Condition, State, IChoiceTransitionOptions)

State.AddItemProcessor(StateGraph, IProcessorConfig)

State.AddIterator(StateGraph)

State.AddPrefix(string)

State.BindToGraph(StateGraph)

State.MakeDefault(State)

State.MakeNext(State)

State.RenderAssign(QueryLanguage?)

State.RenderBranches()

State.RenderChoices(QueryLanguage?)

State.RenderInputOutput()

State.RenderItemProcessor()

State.RenderIterator()

State.RenderNextEnd()

State.RenderQueryLanguage(QueryLanguage?)

State.RenderResultSelector()

State.RenderRetryCatch(QueryLanguage?)

State.ValidateState()

State.Branches

State.Id

State.StartState

State.StateId

State.Arguments

State.Assign

State.Comment

State.InputPath

State.OutputPath

State.Outputs

State.Parameters

State.QueryLanguage

State.ResultPath

State.ResultSelector

State.StateName

State.DefaultChoice

State.Iteration

State.Processor

State.ProcessorConfig

State.ProcessorMode

Namespace: Amazon.CDK.AWS.StepFunctions.Tasks

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CallAwsService : TaskStateBase, IChainable, INextable

Syntax (vb)

Public Class CallAwsService Inherits TaskStateBase Implements IChainable, INextable

Remarks

ExampleMetadata: infused

Examples

Bucket myBucket;

            var getObject = new CallAwsService(this, "GetObject", new CallAwsServiceProps {
                Service = "s3",
                Action = "getObject",
                Parameters = new Dictionary<string, object> {
                    { "Bucket", myBucket.BucketName },
                    { "Key", JsonPath.StringAt("$.key") }
                },
                IamResources = new [] { myBucket.ArnForObjects("*") }
            });

Synopsis

Constructors

CallAwsService(Construct, string, ICallAwsServiceProps)

A StepFunctions task to call an AWS service API.

Properties

TaskMetrics	A StepFunctions task to call an AWS service API.
TaskPolicies	A StepFunctions task to call an AWS service API.

Methods

JsonPath(Construct, string, ICallAwsServiceJsonPathProps)	A StepFunctions task using JSONPath to call an AWS service API.
Jsonata(Construct, string, ICallAwsServiceJsonataProps)	A StepFunctions task using JSONata to call an AWS service API.

Constructors

CallAwsService(Construct, string, ICallAwsServiceProps)

A StepFunctions task to call an AWS service API.

public CallAwsService(Construct scope, string id, ICallAwsServiceProps props)

Parameters

scope Construct
id string: Descriptive identifier for this chainable.
props ICallAwsServiceProps

Remarks

ExampleMetadata: infused

Properties

TaskMetrics

A StepFunctions task to call an AWS service API.

protected override ITaskMetricsConfig? TaskMetrics { get; }

Property Value

ITaskMetricsConfig

Overrides

TaskStateBase.TaskMetrics

Remarks

ExampleMetadata: infused

TaskPolicies

A StepFunctions task to call an AWS service API.

protected override PolicyStatement[]? TaskPolicies { get; }

Property Value

PolicyStatement[]

Overrides

TaskStateBase.TaskPolicies

Remarks

ExampleMetadata: infused

Methods

JsonPath(Construct, string, ICallAwsServiceJsonPathProps)

A StepFunctions task using JSONPath to call an AWS service API.

public static CallAwsService JsonPath(Construct scope, string id, ICallAwsServiceJsonPathProps props)

Parameters

scope Construct
id string
props ICallAwsServiceJsonPathProps

Returns

CallAwsService

Remarks

ExampleMetadata: infused

Jsonata(Construct, string, ICallAwsServiceJsonataProps)

A StepFunctions task using JSONata to call an AWS service API.

public static CallAwsService Jsonata(Construct scope, string id, ICallAwsServiceJsonataProps props)

Parameters

scope Construct
id string
props ICallAwsServiceJsonataProps

Returns

CallAwsService

Remarks

ExampleMetadata: infused

Implements

IChainable

INextable