class Aws::Transfer::Types::CreateWorkflowRequest
@note When making an API call, you may pass CreateWorkflowRequest
data as a hash: { description: "WorkflowDescription", steps: [ # required { type: "COPY", # accepts COPY, CUSTOM, TAG, DELETE copy_step_details: { name: "WorkflowStepName", destination_file_location: { s3_file_location: { bucket: "S3Bucket", key: "S3Key", }, efs_file_location: { file_system_id: "EfsFileSystemId", path: "EfsPath", }, }, overwrite_existing: "TRUE", # accepts TRUE, FALSE }, custom_step_details: { name: "WorkflowStepName", target: "CustomStepTarget", timeout_seconds: 1, }, delete_step_details: { name: "WorkflowStepName", }, tag_step_details: { name: "WorkflowStepName", tags: [ { key: "S3TagKey", # required value: "S3TagValue", # required }, ], }, }, ], on_exception_steps: [ { type: "COPY", # accepts COPY, CUSTOM, TAG, DELETE copy_step_details: { name: "WorkflowStepName", destination_file_location: { s3_file_location: { bucket: "S3Bucket", key: "S3Key", }, efs_file_location: { file_system_id: "EfsFileSystemId", path: "EfsPath", }, }, overwrite_existing: "TRUE", # accepts TRUE, FALSE }, custom_step_details: { name: "WorkflowStepName", target: "CustomStepTarget", timeout_seconds: 1, }, delete_step_details: { name: "WorkflowStepName", }, tag_step_details: { name: "WorkflowStepName", tags: [ { key: "S3TagKey", # required value: "S3TagValue", # required }, ], }, }, ], tags: [ { key: "TagKey", # required value: "TagValue", # required }, ], }
@!attribute [rw] description
A textual description for the workflow. @return [String]
@!attribute [rw] steps
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*\: custom step with a lambda target * *Delete*\: delete the file * *Tag*\: add a tag to the file For file location, you specify either the S3 bucket and key, or the EFS filesystem ID and path. @return [Array<Types::WorkflowStep>]
@!attribute [rw] on_exception_steps
Specifies the steps (actions) to take if any errors are encountered during execution of the workflow. @return [Array<Types::WorkflowStep>]
@!attribute [rw] tags
Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose. @return [Array<Types::Tag>]
@see docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateWorkflowRequest AWS API Documentation
Constants
- SENSITIVE