WorkflowStep - Amazon Transfer Family
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

WorkflowStep

The basic building block of a workflow.

Contents

CopyStepDetails

Details for a step that performs a file copy.

Consists of the following values:

  • A description

  • An Amazon S3 location for the destination of the file copy.

  • A flag that indicates whether to overwrite an existing file of the same name. The default is FALSE.

Type: CopyStepDetails object

Required: No

CustomStepDetails

Details for a step that invokes an Amazon Lambda function.

Consists of the Lambda function's name, target, and timeout (in seconds).

Type: CustomStepDetails object

Required: No

DecryptStepDetails

Details for a step that decrypts an encrypted file.

Consists of the following values:

  • A descriptive name

  • An Amazon S3 or Amazon Elastic File System (Amazon EFS) location for the source file to decrypt.

  • An S3 or Amazon EFS location for the destination of the file decryption.

  • A flag that indicates whether to overwrite an existing file of the same name. The default is FALSE.

  • The type of encryption that's used. Currently, only PGP encryption is supported.

Type: DecryptStepDetails object

Required: No

DeleteStepDetails

Details for a step that deletes the file.

Type: DeleteStepDetails object

Required: No

TagStepDetails

Details for a step that creates one or more tags.

You specify one or more tags. Each tag contains a key-value pair.

Type: TagStepDetails object

Required: No

Type

Currently, the following step types are supported.

  • COPY - Copy the file to another location.

  • CUSTOM - Perform a custom step with an Amazon 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.

Type: String

Valid Values: COPY | CUSTOM | TAG | DELETE | DECRYPT

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: