Class: Aws::Transfer::Types::WorkflowDetails

Inherits:

Struct

Object
Struct
Aws::Transfer::Types::WorkflowDetails

show all

Defined in:: gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb

Overview

Container for the WorkflowDetail data type. It is used by actions that trigger a workflow to begin execution.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#on_partial_upload ⇒ Array<Types::WorkflowDetail>
A trigger that starts a workflow if a file is only partially uploaded.
#on_upload ⇒ Array<Types::WorkflowDetail>
A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.

Instance Attribute Details

#on_partial_upload ⇒ `Array<Types::WorkflowDetail>`

A trigger that starts a workflow if a file is only partially uploaded. You can attach a workflow to a server that executes whenever there is a partial upload.

A partial upload occurs when a file is open when the session disconnects.

OnPartialUpload can contain a maximum of one WorkflowDetail object.

Returns:

(Array<Types::WorkflowDetail>)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 7244

class WorkflowDetails < Struct.new(
  :on_upload,
  :on_partial_upload)
  SENSITIVE = []
  include Aws::Structure
end

#on_upload ⇒ `Array<Types::WorkflowDetail>`

A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.

To remove an associated workflow from a server, you can provide an empty OnUpload object, as in the following example.

aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'

OnUpload can contain a maximum of one WorkflowDetail object.