/AWS1/CL_TRN=>CREATEWORKFLOW()
¶
About CreateWorkflow¶
Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes.
After creating a workflow, you can associate the workflow created with any transfer servers by specifying the workflow-details
field in CreateServer
and UpdateServer
operations.
Method Signature¶
IMPORTING¶
Required arguments:¶
IT_STEPS
TYPE /AWS1/CL_TRNWORKFLOWSTEP=>TT_WORKFLOWSTEPS
TT_WORKFLOWSTEPS
¶
Specifies the details for the steps that are in the specified workflow.
The
TYPE
specifies which of the following actions is being taken for this step.
COPY
- Copy the file to another location.
CUSTOM
- Perform a custom step with an Lambda function target.
DECRYPT
- Decrypt a file that was encrypted before it was uploaded.
DELETE
- Delete the file.
TAG
- Add a tag to the file.Currently, copying and tagging are supported only on S3.
For file location, you specify either the Amazon S3 bucket and key, or the Amazon EFS file system ID and path.
Optional arguments:¶
IV_DESCRIPTION
TYPE /AWS1/TRNWORKFLOWDESCRIPTION
/AWS1/TRNWORKFLOWDESCRIPTION
¶
A textual description for the workflow.
IT_ONEXCEPTIONSTEPS
TYPE /AWS1/CL_TRNWORKFLOWSTEP=>TT_WORKFLOWSTEPS
TT_WORKFLOWSTEPS
¶
Specifies the steps (actions) to take if errors are encountered during execution of the workflow.
For custom steps, the Lambda function needs to send
FAILURE
to the call back API to kick off the exception steps. Additionally, if the Lambda does not sendSUCCESS
before it times out, the exception steps are executed.
IT_TAGS
TYPE /AWS1/CL_TRNTAG=>TT_TAGS
TT_TAGS
¶
Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.