WorkflowStep ¶

class WorkflowStep(TypedDict, closed=True):
    type: NotRequired["capo_transfer.types.workflow_step_type.WorkflowStepType"]
    """<p> Currently, the following step types are supported. </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>"""
    copy_step_details: NotRequired[
        "capo_transfer.types.copy_step_details.CopyStepDetails"
    ]
    """<p>Details for a step that performs a file copy.</p> <p> Consists of the following values: </p> <ul> <li> <p>A description</p> </li> <li> <p>An Amazon S3 location for the destination of the file copy.</p> </li> <li> <p>A flag that indicates whether to overwrite an existing file of the same name. The default is <code>FALSE</code>.</p> </li> </ul>"""
    custom_step_details: NotRequired[
        "capo_transfer.types.custom_step_details.CustomStepDetails"
    ]
    """<p>Details for a step that invokes an Lambda function.</p> <p>Consists of the Lambda function's name, target, and timeout (in seconds). </p>"""
    delete_step_details: NotRequired[
        "capo_transfer.types.delete_step_details.DeleteStepDetails"
    ]
    """<p>Details for a step that deletes the file.</p>"""
    tag_step_details: NotRequired["capo_transfer.types.tag_step_details.TagStepDetails"]
    """<p>Details for a step that creates one or more tags.</p> <p>You specify one or more tags. Each tag contains a key-value pair.</p>"""
    decrypt_step_details: NotRequired[
        "capo_transfer.types.decrypt_step_details.DecryptStepDetails"
    ]
    """<p>Details for a step that decrypts an encrypted file.</p> <p>Consists of the following values:</p> <ul> <li> <p>A descriptive name</p> </li> <li> <p>An Amazon S3 or Amazon Elastic File System (Amazon EFS) location for the source file to decrypt.</p> </li> <li> <p>An S3 or Amazon EFS location for the destination of the file decryption.</p> </li> <li> <p>A flag that indicates whether to overwrite an existing file of the same name. The default is <code>FALSE</code>.</p> </li> <li> <p>The type of encryption that's used. Currently, only PGP encryption is supported.</p> </li> </ul>"""