Skip to content

WorkflowDetails

Used by
Source code in docs_src/capo_transfer/types/workflow_details.py 
12
13
14
15
16
17
18
19
20
class WorkflowDetails(TypedDict, closed=True):
    on_upload: NotRequired[
        "capo_transfer.types.on_upload_workflow_details.OnUploadWorkflowDetails"
    ]
    """<p>A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.</p> <p>To remove an associated workflow from a server, you can provide an empty <code>OnUpload</code> object, as in the following example.</p> <p> <code>aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'</code> </p> <note> <p> <code>OnUpload</code> can contain a maximum of one <code>WorkflowDetail</code> object.</p> </note>"""
    on_partial_upload: NotRequired[
        "capo_transfer.types.on_partial_upload_workflow_details.OnPartialUploadWorkflowDetails"
    ]
    """<p>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.</p> <p>A <i>partial upload</i> occurs when a file is open when the session disconnects.</p> <note> <p> <code>OnPartialUpload</code> can contain a maximum of one <code>WorkflowDetail</code> object.</p> </note>"""

on_partial_upload instance-attribute 

on_partial_upload: NotRequired[OnPartialUploadWorkflowDetails]

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.

on_upload instance-attribute 

on_upload: NotRequired[OnUploadWorkflowDetails]

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.