@datafire/amazonaws_states v5.0.0

@datafire/amazonaws_states

Client library for AWS Step Functions

Installation and Usage

npm install --save @datafire/amazonaws_states

let amazonaws_states = require('@datafire/amazonaws_states').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_states.CreateActivity({
  "name": ""
}).then(data => {
  console.log(data);
});

Description

AWS Step Functions AWS Step Functions is a service that lets you coordinate the components of distributed applications and microservices using visual workflows. You can use Step Functions to build applications from individual components, each of which performs a discrete function, or task, allowing you to scale and change applications quickly. Step Functions provides a console that helps visualize the components of your application as a series of steps. Step Functions automatically triggers and tracks each step, and retries steps when there are errors, so your application executes predictably and in the right order every time. Step Functions logs the state of each step, so you can quickly diagnose and debug any issues. Step Functions manages operations and underlying infrastructure to ensure your application is available at any scale. You can run tasks on AWS, your own servers, or any system that has access to AWS. You can access and use Step Functions using the console, the AWS SDKs, or an HTTP API. For more information about Step Functions, see the AWS Step Functions Developer Guide .

Actions

CreateActivity

amazonaws_states.CreateActivity({
  "name": ""
}, context)

Input

• input object
  • name required Name

Output

• output CreateActivityOutput

CreateStateMachine

amazonaws_states.CreateStateMachine({
  "name": "",
  "definition": "",
  "roleArn": ""
}, context)

Input

• input object
  • definition required Definition
  • name required Name
  • roleArn required Arn

Output

• output CreateStateMachineOutput

DeleteActivity

amazonaws_states.DeleteActivity({
  "activityArn": ""
}, context)

Input

• input object
  • activityArn required Arn

Output

• output DeleteActivityOutput

DeleteStateMachine

amazonaws_states.DeleteStateMachine({
  "stateMachineArn": ""
}, context)

Input

• input object
  • stateMachineArn required Arn

Output

• output DeleteStateMachineOutput

DescribeActivity

amazonaws_states.DescribeActivity({
  "activityArn": ""
}, context)

Input

• input object
  • activityArn required Arn

Output

• output DescribeActivityOutput

DescribeExecution

amazonaws_states.DescribeExecution({
  "executionArn": ""
}, context)

Input

• input object
  • executionArn required Arn

Output

• output DescribeExecutionOutput

DescribeStateMachine

amazonaws_states.DescribeStateMachine({
  "stateMachineArn": ""
}, context)

Input

• input object
  • stateMachineArn required Arn

Output

• output DescribeStateMachineOutput

DescribeStateMachineForExecution

amazonaws_states.DescribeStateMachineForExecution({
  "executionArn": ""
}, context)

Input

• input object
  • executionArn required Arn

Output

• output DescribeStateMachineForExecutionOutput

GetActivityTask

amazonaws_states.GetActivityTask({
  "activityArn": ""
}, context)

Input

• input object
  • activityArn required Arn
  • workerName Name

Output

• output GetActivityTaskOutput

GetExecutionHistory

amazonaws_states.GetExecutionHistory({
  "executionArn": ""
}, context)

Input

• input object
  • maxResults string
  • nextToken string
  • executionArn required Arn
  • maxResults PageSize
  • nextToken PageToken
  • reverseOrder ReverseOrder

Output

• output GetExecutionHistoryOutput

ListActivities

amazonaws_states.ListActivities({}, context)

Input

• input object
  • maxResults string
  • nextToken string
  • maxResults PageSize
  • nextToken PageToken

Output

• output ListActivitiesOutput

ListExecutions

amazonaws_states.ListExecutions({
  "stateMachineArn": ""
}, context)

Input

• input object
  • maxResults string
  • nextToken string
  • maxResults PageSize
  • nextToken PageToken
  • stateMachineArn required Arn
  • statusFilter ExecutionStatus

Output

• output ListExecutionsOutput

ListStateMachines

amazonaws_states.ListStateMachines({}, context)

Input

• input object
  • maxResults string
  • nextToken string
  • maxResults PageSize
  • nextToken PageToken

Output

• output ListStateMachinesOutput

SendTaskFailure

amazonaws_states.SendTaskFailure({
  "taskToken": ""
}, context)

Input

• input object
  • cause Cause
  • error Error
  • taskToken required TaskToken

Output

• output SendTaskFailureOutput

SendTaskHeartbeat

amazonaws_states.SendTaskHeartbeat({
  "taskToken": ""
}, context)

Input

• input object
  • taskToken required TaskToken

Output

• output SendTaskHeartbeatOutput

SendTaskSuccess

amazonaws_states.SendTaskSuccess({
  "taskToken": "",
  "output": ""
}, context)

Input

• input object
  • output required Data
  • taskToken required TaskToken

Output

• output SendTaskSuccessOutput

StartExecution

amazonaws_states.StartExecution({
  "stateMachineArn": ""
}, context)

Input

• input object
  • input Data
  • name Name
  • stateMachineArn required Arn

Output

• output StartExecutionOutput

StopExecution

amazonaws_states.StopExecution({
  "executionArn": ""
}, context)

Input

• input object
  • cause Cause
  • error Error
  • executionArn required Arn

Output

• output StopExecutionOutput

UpdateStateMachine

amazonaws_states.UpdateStateMachine({
  "stateMachineArn": ""
}, context)

Input

• input object
  • definition Definition
  • roleArn Arn
  • stateMachineArn required Arn

Output

• output UpdateStateMachineOutput

Definitions

ActivityDoesNotExist

• ActivityDoesNotExist object: The specified activity does not exist.
  • message ErrorMessage

ActivityFailedEventDetails

• ActivityFailedEventDetails object: Contains details about an activity which failed during an execution.
  • cause Cause
  • error Error

ActivityLimitExceeded

• ActivityLimitExceeded object: The maximum number of activities has been reached. Existing activities must be deleted before a new activity can be created.
  • message ErrorMessage

ActivityList

• ActivityList array
  • items ActivityListItem

ActivityListItem

• ActivityListItem object: Contains details about an activity.
  • activityArn required Arn
  • creationDate required Timestamp
  • name required Name

ActivityScheduleFailedEventDetails

• ActivityScheduleFailedEventDetails object: Contains details about an activity schedule failure which occurred during an execution.
  • cause Cause
  • error Error

ActivityScheduledEventDetails

• ActivityScheduledEventDetails object: Contains details about an activity scheduled during an execution.
  • heartbeatInSeconds TimeoutInSeconds
  • input Data
  • resource required Arn
  • timeoutInSeconds TimeoutInSeconds

ActivityStartedEventDetails

• ActivityStartedEventDetails object: Contains details about the start of an activity during an execution.
  • workerName Identity

ActivitySucceededEventDetails

• ActivitySucceededEventDetails object: Contains details about an activity which successfully terminated during an execution.
  • output Data

ActivityTimedOutEventDetails

• ActivityTimedOutEventDetails object: Contains details about an activity timeout which occurred during an execution.
  • cause Cause
  • error Error

ActivityWorkerLimitExceeded

• ActivityWorkerLimitExceeded object: The maximum number of workers concurrently polling for activity tasks has been reached.
  • message ErrorMessage

Arn

• Arn string

Cause

• Cause string

CreateActivityInput

• CreateActivityInput object
  • name required Name

CreateActivityOutput

• CreateActivityOutput object
  • activityArn required Arn
  • creationDate required Timestamp

CreateStateMachineInput

• CreateStateMachineInput object
  • definition required Definition
  • name required Name
  • roleArn required Arn

CreateStateMachineOutput

• CreateStateMachineOutput object
  • creationDate required Timestamp
  • stateMachineArn required Arn

Data

• Data string

Definition

• Definition string

DeleteActivityInput

• DeleteActivityInput object
  • activityArn required Arn

DeleteActivityOutput

• DeleteActivityOutput object

DeleteStateMachineInput

• DeleteStateMachineInput object
  • stateMachineArn required Arn

DeleteStateMachineOutput

• DeleteStateMachineOutput object

DescribeActivityInput

• DescribeActivityInput object
  • activityArn required Arn

DescribeActivityOutput

• DescribeActivityOutput object
  • activityArn required Arn
  • creationDate required Timestamp
  • name required Name

DescribeExecutionInput

• DescribeExecutionInput object
  • executionArn required Arn

DescribeExecutionOutput

• DescribeExecutionOutput object
  • executionArn required Arn
  • input required Data
  • name Name
  • output Data
  • startDate required Timestamp
  • stateMachineArn required Arn
  • status required ExecutionStatus
  • stopDate Timestamp

DescribeStateMachineForExecutionInput

• DescribeStateMachineForExecutionInput object
  • executionArn required Arn

DescribeStateMachineForExecutionOutput

• DescribeStateMachineForExecutionOutput object
  • definition required Definition
  • name required Name
  • roleArn required Arn
  • stateMachineArn required Arn
  • updateDate required Timestamp

DescribeStateMachineInput

• DescribeStateMachineInput object
  • stateMachineArn required Arn

DescribeStateMachineOutput

• DescribeStateMachineOutput object
  • creationDate required Timestamp
  • definition required Definition
  • name required Name
  • roleArn required Arn
  • stateMachineArn required Arn
  • status StateMachineStatus

Error

• Error string

ErrorMessage

• ErrorMessage string

EventId

• EventId integer

ExecutionAbortedEventDetails

• ExecutionAbortedEventDetails object: Contains details about an abort of an execution.
  • cause Cause
  • error Error

ExecutionAlreadyExists

• ExecutionAlreadyExists object: The execution has the same name as another execution (but a different input). Executions with the same name and input are considered idempotent.
  • message ErrorMessage

ExecutionDoesNotExist

• ExecutionDoesNotExist object: The specified execution does not exist.
  • message ErrorMessage

ExecutionFailedEventDetails

• ExecutionFailedEventDetails object: Contains details about an execution failure event.
  • cause Cause
  • error Error

ExecutionLimitExceeded

• ExecutionLimitExceeded object: The maximum number of running executions has been reached. Running executions must end or be stopped before a new execution can be started.
  • message ErrorMessage

ExecutionList

• ExecutionList array
  • items ExecutionListItem

ExecutionListItem

• ExecutionListItem object: Contains details about an execution.
  • executionArn required Arn
  • name required Name
  • startDate required Timestamp
  • stateMachineArn required Arn
  • status required ExecutionStatus
  • stopDate Timestamp

ExecutionStartedEventDetails

• ExecutionStartedEventDetails object: Contains details about the start of the execution.
  • input Data
  • roleArn Arn

ExecutionStatus

• ExecutionStatus string (values: RUNNING, SUCCEEDED, FAILED, TIMED_OUT, ABORTED)

ExecutionSucceededEventDetails

• ExecutionSucceededEventDetails object: Contains details about the successful termination of the execution.
  • output Data

ExecutionTimedOutEventDetails

• ExecutionTimedOutEventDetails object: Contains details about the execution timeout which occurred during the execution.
  • cause Cause
  • error Error

GetActivityTaskInput

• GetActivityTaskInput object
  • activityArn required Arn
  • workerName Name

GetActivityTaskOutput

• GetActivityTaskOutput object
  • input Data
  • taskToken TaskToken

GetExecutionHistoryInput

• GetExecutionHistoryInput object
  • executionArn required Arn
  • maxResults PageSize
  • nextToken PageToken
  • reverseOrder ReverseOrder

GetExecutionHistoryOutput

• GetExecutionHistoryOutput object
  • events required HistoryEventList
  • nextToken PageToken

HistoryEvent

• HistoryEvent object: Contains details about the events of an execution.
  • activityFailedEventDetails ActivityFailedEventDetails
  • activityScheduleFailedEventDetails ActivityScheduleFailedEventDetails
  • activityScheduledEventDetails ActivityScheduledEventDetails
  • activityStartedEventDetails ActivityStartedEventDetails
  • activitySucceededEventDetails ActivitySucceededEventDetails
  • activityTimedOutEventDetails ActivityTimedOutEventDetails
  • executionAbortedEventDetails ExecutionAbortedEventDetails
  • executionFailedEventDetails ExecutionFailedEventDetails
  • executionStartedEventDetails ExecutionStartedEventDetails
  • executionSucceededEventDetails ExecutionSucceededEventDetails
  • executionTimedOutEventDetails ExecutionTimedOutEventDetails
  • id required EventId
  • lambdaFunctionFailedEventDetails LambdaFunctionFailedEventDetails
  • lambdaFunctionScheduleFailedEventDetails LambdaFunctionScheduleFailedEventDetails
  • lambdaFunctionScheduledEventDetails LambdaFunctionScheduledEventDetails
  • lambdaFunctionStartFailedEventDetails LambdaFunctionStartFailedEventDetails
  • lambdaFunctionSucceededEventDetails LambdaFunctionSucceededEventDetails
  • lambdaFunctionTimedOutEventDetails LambdaFunctionTimedOutEventDetails
  • previousEventId EventId
  • stateEnteredEventDetails StateEnteredEventDetails
  • stateExitedEventDetails StateExitedEventDetails
  • timestamp required Timestamp
  • type required HistoryEventType

HistoryEventList

• HistoryEventList array: Contains details about the events which occurred during an execution.
  • items HistoryEvent

HistoryEventType

• HistoryEventType string (values: ActivityFailed, ActivityScheduleFailed, ActivityScheduled, ActivityStarted, ActivitySucceeded, ActivityTimedOut, ChoiceStateEntered, ChoiceStateExited, ExecutionFailed, ExecutionStarted, ExecutionSucceeded, ExecutionAborted, ExecutionTimedOut, FailStateEntered, LambdaFunctionFailed, LambdaFunctionScheduleFailed, LambdaFunctionScheduled, LambdaFunctionStartFailed, LambdaFunctionStarted, LambdaFunctionSucceeded, LambdaFunctionTimedOut, SucceedStateEntered, SucceedStateExited, TaskStateAborted, TaskStateEntered, TaskStateExited, PassStateEntered, PassStateExited, ParallelStateAborted, ParallelStateEntered, ParallelStateExited, ParallelStateFailed, ParallelStateStarted, ParallelStateSucceeded, WaitStateAborted, WaitStateEntered, WaitStateExited)

Identity

• Identity string

InvalidArn

• InvalidArn object: The provided Amazon Resource Name (ARN) is invalid.
  • message ErrorMessage

InvalidDefinition

• InvalidDefinition object: The provided Amazon States Language definition is invalid.
  • message ErrorMessage

InvalidExecutionInput

• InvalidExecutionInput object: The provided JSON input data is invalid.
  • message ErrorMessage

InvalidName

• InvalidName object: The provided name is invalid.
  • message ErrorMessage

InvalidOutput

• InvalidOutput object: The provided JSON output data is invalid.
  • message ErrorMessage

InvalidToken

• InvalidToken object: The provided token is invalid.
  • message ErrorMessage

LambdaFunctionFailedEventDetails

• LambdaFunctionFailedEventDetails object: Contains details about a lambda function which failed during an execution.
  • cause Cause
  • error Error

LambdaFunctionScheduleFailedEventDetails

• LambdaFunctionScheduleFailedEventDetails object: Contains details about a failed lambda function schedule event which occurred during an execution.
  • cause Cause
  • error Error

LambdaFunctionScheduledEventDetails

• LambdaFunctionScheduledEventDetails object: Contains details about a lambda function scheduled during an execution.
  • input Data
  • resource required Arn
  • timeoutInSeconds TimeoutInSeconds

LambdaFunctionStartFailedEventDetails

• LambdaFunctionStartFailedEventDetails object: Contains details about a lambda function which failed to start during an execution.
  • cause Cause
  • error Error

LambdaFunctionSucceededEventDetails

• LambdaFunctionSucceededEventDetails object: Contains details about a lambda function which successfully terminated during an execution.
  • output Data

LambdaFunctionTimedOutEventDetails

• LambdaFunctionTimedOutEventDetails object: Contains details about a lambda function timeout which occurred during an execution.
  • cause Cause
  • error Error

ListActivitiesInput

• ListActivitiesInput object
  • maxResults PageSize
  • nextToken PageToken

ListActivitiesOutput

• ListActivitiesOutput object
  • activities required ActivityList
  • nextToken PageToken

ListExecutionsInput

• ListExecutionsInput object
  • maxResults PageSize
  • nextToken PageToken
  • stateMachineArn required Arn
  • statusFilter ExecutionStatus

ListExecutionsOutput

• ListExecutionsOutput object
  • executions required ExecutionList
  • nextToken PageToken

ListStateMachinesInput

• ListStateMachinesInput object
  • maxResults PageSize
  • nextToken PageToken

ListStateMachinesOutput

• ListStateMachinesOutput object
  • nextToken PageToken
  • stateMachines required StateMachineList

MissingRequiredParameter

• MissingRequiredParameter object: Request is missing a required parameter. This error occurs if both definition and roleArn are not specified.
  • message ErrorMessage

Name

• Name string

PageSize

• PageSize integer

PageToken

• PageToken string

ReverseOrder

• ReverseOrder boolean

SendTaskFailureInput

• SendTaskFailureInput object
  • cause Cause
  • error Error
  • taskToken required TaskToken

SendTaskFailureOutput

• SendTaskFailureOutput object

SendTaskHeartbeatInput

• SendTaskHeartbeatInput object
  • taskToken required TaskToken

SendTaskHeartbeatOutput

• SendTaskHeartbeatOutput object

SendTaskSuccessInput

• SendTaskSuccessInput object
  • output required Data
  • taskToken required TaskToken

SendTaskSuccessOutput

• SendTaskSuccessOutput object

StartExecutionInput

• StartExecutionInput object
  • input Data
  • name Name
  • stateMachineArn required Arn

StartExecutionOutput

• StartExecutionOutput object
  • executionArn required Arn
  • startDate required Timestamp

StateEnteredEventDetails

• StateEnteredEventDetails object: Contains details about a state entered during an execution.
  • input Data
  • name required Name

StateExitedEventDetails

• StateExitedEventDetails object: Contains details about an exit from a state during an execution.
  • name required Name
  • output Data

StateMachineAlreadyExists

• StateMachineAlreadyExists object: A state machine with the same name but a different definition or role ARN already exists.
  • message ErrorMessage

StateMachineDeleting

• StateMachineDeleting object: The specified state machine is being deleted.
  • message ErrorMessage

StateMachineDoesNotExist

• StateMachineDoesNotExist object: The specified state machine does not exist.
  • message ErrorMessage

StateMachineLimitExceeded

• StateMachineLimitExceeded object: The maximum number of state machines has been reached. Existing state machines must be deleted before a new state machine can be created.
  • message ErrorMessage

StateMachineList

• StateMachineList array
  • items StateMachineListItem

StateMachineListItem

• StateMachineListItem object: Contains details about the state machine.
  • creationDate required Timestamp
  • name required Name
  • stateMachineArn required Arn

StateMachineStatus

• StateMachineStatus string (values: ACTIVE, DELETING)

StopExecutionInput

• StopExecutionInput object
  • cause Cause
  • error Error
  • executionArn required Arn

StopExecutionOutput

• StopExecutionOutput object
  • stopDate required Timestamp

TaskDoesNotExist

• TaskDoesNotExist object
  • message ErrorMessage

TaskTimedOut

• TaskTimedOut object
  • message ErrorMessage

TaskToken

• TaskToken string

TimeoutInSeconds

• TimeoutInSeconds integer

Timestamp

• Timestamp string

UpdateStateMachineInput

• UpdateStateMachineInput object
  • definition Definition
  • roleArn Arn
  • stateMachineArn required Arn

UpdateStateMachineOutput

• UpdateStateMachineOutput object
  • updateDate required Timestamp