SendWorkflowStepStateCommand

Suggest an Edit

Sends a callback for asynchronous custom steps.

The ExecutionId, WorkflowId, and Token are passed to the target resource during execution of a custom step of a workflow. You must include those with their callback as well as providing a status.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { TransferClient, SendWorkflowStepStateCommand } from "@aws-sdk/client-transfer"; // ES Modules import
// const { TransferClient, SendWorkflowStepStateCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
const client = new TransferClient(config);
const input = { // SendWorkflowStepStateRequest
  WorkflowId: "STRING_VALUE", // required
  ExecutionId: "STRING_VALUE", // required
  Token: "STRING_VALUE", // required
  Status: "SUCCESS" || "FAILURE", // required
};
const command = new SendWorkflowStepStateCommand(input);
const response = await client.send(command);
// {};

SendWorkflowStepStateCommand Input

See SendWorkflowStepStateCommandInput for more details

Parameter
Type
Description
ExecutionId
Required
string | undefined

A unique identifier for the execution of a workflow.

Status
Required
CustomStepStatus | undefined

Indicates whether the specified step succeeded or failed.

Token
Required
string | undefined

Used to distinguish between multiple callbacks for multiple Lambda steps within the same execution.

WorkflowId
Required
string | undefined

A unique identifier for the workflow.

SendWorkflowStepStateCommand Output

See SendWorkflowStepStateCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

InternalServiceError
server

This exception is thrown when an error occurs in the Transfer Family service.

InvalidRequestException
client

This exception is thrown when the client submits a malformed request.

ResourceNotFoundException
client

This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

ServiceUnavailableException
server

The request has failed because the Amazon Web ServicesTransfer Family service is not available.

ThrottlingException
client

The request was denied due to request throttling.

TransferServiceException
Base exception class for all service exceptions from Transfer service.