Skip to content

CreateWorkflowRequest

Source code in docs_src/capo_transfer/types/create_workflow_request.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class CreateWorkflowRequest(TypedDict, closed=True):
    description: NotRequired[
        "capo_transfer.types.workflow_description.WorkflowDescription"
    ]
    """<p>A textual description for the workflow.</p>"""
    steps: "capo_transfer.types.workflow_steps.WorkflowSteps"
    """<p>Specifies the details for the steps that are in the specified workflow.</p> <p> The <code>TYPE</code> specifies which of the following actions is being taken for this step. </p> <ul> <li> <p> <b> <code>COPY</code> </b> - Copy the file to another location.</p> </li> <li> <p> <b> <code>CUSTOM</code> </b> - Perform a custom step with an Lambda function target.</p> </li> <li> <p> <b> <code>DECRYPT</code> </b> - Decrypt a file that was encrypted before it was uploaded.</p> </li> <li> <p> <b> <code>DELETE</code> </b> - Delete the file.</p> </li> <li> <p> <b> <code>TAG</code> </b> - Add a tag to the file.</p> </li> </ul> <note> <p> Currently, copying and tagging are supported only on S3. </p> </note> <p> For file location, you specify either the Amazon S3 bucket and key, or the Amazon EFS file system ID and path. </p>"""
    on_exception_steps: NotRequired["capo_transfer.types.workflow_steps.WorkflowSteps"]
    """<p>Specifies the steps (actions) to take if errors are encountered during execution of the workflow.</p> <note> <p>For custom steps, the Lambda function needs to send <code>FAILURE</code> to the call back API to kick off the exception steps. Additionally, if the Lambda does not send <code>SUCCESS</code> before it times out, the exception steps are executed.</p> </note>"""
    tags: NotRequired["capo_transfer.types.tags.Tags"]
    """<p>Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.</p>"""
    structured_log_destinations: NotRequired[
        "capo_transfer.types.structured_log_destinations.StructuredLogDestinations"
    ]
    """<p>Specifies the log groups to which your workflow logs are sent.</p> <p>To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:</p> <p> <code>arn:partition:logs:region-name:amazon-account-id:log-group:log-group-name:*</code> </p> <p>For example, <code>arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*</code> </p>"""

description instance-attribute 

description: NotRequired[WorkflowDescription]

A textual description for the workflow.

on_exception_steps instance-attribute 

on_exception_steps: NotRequired[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 send SUCCESS before it times out, the exception steps are executed.

steps instance-attribute 

steps: 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.

structured_log_destinations instance-attribute 

structured_log_destinations: NotRequired[StructuredLogDestinations]

Specifies the log groups to which your workflow logs are sent.

To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:

arn:partition:logs:region-name:amazon-account-id:log-group:log-group-name:*

For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*

tags instance-attribute 

tags: NotRequired[Tags]

Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.