CopyStepDetails
Each step type has its own StepDetails
structure.
Contents
- DestinationFileLocation
-
Specifies the location for the file being copied. Use
${Transfer:UserName}
or${Transfer:UploadDate}
in this field to parametrize the destination prefix by username or uploaded date.-
Set the value of
DestinationFileLocation
to${Transfer:UserName}
to copy uploaded files to an Amazon S3 bucket that is prefixed with the name of the Transfer Family user that uploaded the file. -
Set the value of
DestinationFileLocation
to${Transfer:UploadDate}
to copy uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload.Note
The system resolves
UploadDate
to a date format of YYYY-MM-DD, based on the date the file is uploaded in UTC.
Type: InputFileLocation object
Required: No
-
- Name
-
The name of the step, used as an identifier.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 30.
Pattern:
[\w-]*
Required: No
- OverwriteExisting
-
A flag that indicates whether to overwrite an existing file of the same name. The default is
FALSE
.If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:
-
If
OverwriteExisting
isTRUE
, the existing file is replaced with the file being processed. -
If
OverwriteExisting
isFALSE
, nothing happens, and the workflow processing stops.
Type: String
Valid Values:
TRUE | FALSE
Required: No
-
- SourceFileLocation
-
Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.
-
To use the previous file as the input, enter
${previous.file}
. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. -
To use the originally uploaded file location as input for this step, enter
${original.file}
.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
\$\{(\w+.)+\w+\}
Required: No
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: