| Column Name | Column Data Type |
|---|
workflow_id Required Input Column
A unique identifier for the workflow. | VARCHAR |
_aws_profile Input Column
The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role. | STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
) |
Show child fields- _aws_profile.account_id
The AWS account id - _aws_profile.assumed_role_arn
The ARN of the assumed role - _aws_profile.name
The unique name of the profile. - _aws_profile.organization
Information about this profile's membership in the AWS organization. Show child fields- _aws_profile.organization.account_name
The name of account speciifed by the organization - _aws_profile.organization.id
The organization id - _aws_profile.organization.master_account
Show child fields- _aws_profile.organization.master_account.email
The organization master account email address - _aws_profile.organization.master_account.id
The organization master account id
- _aws_profile.organization.parents[]
Show child fields- _aws_profile.organization.parents[].id
The id of the parent - _aws_profile.organization.parents[].name
The name of the parent - _aws_profile.organization.parents[].tags[]
Show child fields- _aws_profile.organization.parents[].tags[].key
- _aws_profile.organization.parents[].tags[].value
- _aws_profile.organization.parents[].type
The type of parent can be an organization unit or a root
- _aws_profile.organization.tags[]
Show child fields- _aws_profile.organization.tags[].key
- _aws_profile.organization.tags[].value
- _aws_profile.type
The type of profile, either 'credentials' or 'assumed_role' - _aws_profile.via_profile_name
This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.
|
_aws_region Input Column
The AWS region to use. | VARCHAR |
workflow
The structure that contains the details of the workflow. | STRUCT(
"arn" VARCHAR,
"description" VARCHAR,
"steps" STRUCT(
"type" VARCHAR,
"copy_step_details" STRUCT(
"name" VARCHAR,
"destination_file_location" STRUCT(
"s3_file_location" STRUCT(
"bucket" VARCHAR,
"key" VARCHAR
),
"efs_file_location" STRUCT(
"file_system_id" VARCHAR,
"path" VARCHAR
)
),
"overwrite_existing" VARCHAR,
"source_file_location" VARCHAR
),
"custom_step_details" STRUCT(
"name" VARCHAR,
"target" VARCHAR,
"timeout_seconds" BIGINT,
"source_file_location" VARCHAR
),
"delete_step_details" STRUCT(
"name" VARCHAR,
"source_file_location" VARCHAR
),
"tag_step_details" STRUCT(
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"source_file_location" VARCHAR
),
"decrypt_step_details" STRUCT(
"name" VARCHAR,
"type" VARCHAR,
"source_file_location" VARCHAR,
"overwrite_existing" VARCHAR,
"destination_file_location" STRUCT(
"s3_file_location" STRUCT(
"bucket" VARCHAR,
"key" VARCHAR
),
"efs_file_location" STRUCT(
"file_system_id" VARCHAR,
"path" VARCHAR
)
)
)
)[],
"on_exception_steps" STRUCT(
"type" VARCHAR,
"copy_step_details" STRUCT(
"name" VARCHAR,
"destination_file_location" STRUCT(
"s3_file_location" STRUCT(
"bucket" VARCHAR,
"key" VARCHAR
),
"efs_file_location" STRUCT(
"file_system_id" VARCHAR,
"path" VARCHAR
)
),
"overwrite_existing" VARCHAR,
"source_file_location" VARCHAR
),
"custom_step_details" STRUCT(
"name" VARCHAR,
"target" VARCHAR,
"timeout_seconds" BIGINT,
"source_file_location" VARCHAR
),
"delete_step_details" STRUCT(
"name" VARCHAR,
"source_file_location" VARCHAR
),
"tag_step_details" STRUCT(
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"source_file_location" VARCHAR
),
"decrypt_step_details" STRUCT(
"name" VARCHAR,
"type" VARCHAR,
"source_file_location" VARCHAR,
"overwrite_existing" VARCHAR,
"destination_file_location" STRUCT(
"s3_file_location" STRUCT(
"bucket" VARCHAR,
"key" VARCHAR
),
"efs_file_location" STRUCT(
"file_system_id" VARCHAR,
"path" VARCHAR
)
)
)
)[],
"workflow_id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
) |
Show child fields- workflow.arn
Specifies the unique Amazon Resource Name (ARN) for the workflow. - workflow.description
Specifies the text description for the workflow. - workflow.on_exception_steps[]
Show child fields- workflow.on_exception_steps[].copy_step_details
Details for a step that performs a file copy. Consists of the following values: Show child fields- workflow.on_exception_steps[].copy_step_details.destination_file_location
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. The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date the file is uploaded in UTC. Show child fields- workflow.on_exception_steps[].copy_step_details.destination_file_location.efs_file_location
Specifies the details for the Amazon Elastic File System (Amazon EFS) file that's being decrypted. Show child fields- workflow.on_exception_steps[].copy_step_details.destination_file_location.efs_file_location.file_system_id
The identifier of the file system, assigned by Amazon EFS. - workflow.on_exception_steps[].copy_step_details.destination_file_location.efs_file_location.path
The pathname for the folder being used by a workflow.
- workflow.on_exception_steps[].copy_step_details.destination_file_location.s3_file_location
Specifies the details for the Amazon S3 file that's being copied or decrypted. Show child fields- workflow.on_exception_steps[].copy_step_details.destination_file_location.s3_file_location.bucket
Specifies the S3 bucket for the customer input file. - workflow.on_exception_steps[].copy_step_details.destination_file_location.s3_file_location.key
The name assigned to the file when it was created in Amazon S3. You use the object key to retrieve the object.
- workflow.on_exception_steps[].copy_step_details.name
The name of the step, used as an identifier. - workflow.on_exception_steps[].copy_step_details.overwrite_existing
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 is TRUE, the existing file is replaced with the file being processed. -
If OverwriteExisting is FALSE, nothing happens, and the workflow processing stops. - workflow.on_exception_steps[].copy_step_details.source_file_location
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}.
- workflow.on_exception_steps[].custom_step_details
Details for a step that invokes an Lambda function. Consists of the Lambda function's name, target, and timeout (in seconds). Show child fields- workflow.on_exception_steps[].custom_step_details.name
The name of the step, used as an identifier. - workflow.on_exception_steps[].custom_step_details.source_file_location
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}. - workflow.on_exception_steps[].custom_step_details.target
The ARN for the Lambda function that is being called. - workflow.on_exception_steps[].custom_step_details.timeout_seconds
Timeout, in seconds, for the step.
- workflow.on_exception_steps[].decrypt_step_details
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. Show child fields- workflow.on_exception_steps[].decrypt_step_details.destination_file_location
Specifies the location for the file being decrypted. 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 decrypt 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 decrypt uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload. The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date the file is uploaded in UTC. Show child fields- workflow.on_exception_steps[].decrypt_step_details.destination_file_location.efs_file_location
Specifies the details for the Amazon Elastic File System (Amazon EFS) file that's being decrypted. Show child fields- workflow.on_exception_steps[].decrypt_step_details.destination_file_location.efs_file_location.file_system_id
The identifier of the file system, assigned by Amazon EFS. - workflow.on_exception_steps[].decrypt_step_details.destination_file_location.efs_file_location.path
The pathname for the folder being used by a workflow.
- workflow.on_exception_steps[].decrypt_step_details.destination_file_location.s3_file_location
Specifies the details for the Amazon S3 file that's being copied or decrypted. Show child fields- workflow.on_exception_steps[].decrypt_step_details.destination_file_location.s3_file_location.bucket
Specifies the S3 bucket for the customer input file. - workflow.on_exception_steps[].decrypt_step_details.destination_file_location.s3_file_location.key
The name assigned to the file when it was created in Amazon S3. You use the object key to retrieve the object.
- workflow.on_exception_steps[].decrypt_step_details.name
The name of the step, used as an identifier. - workflow.on_exception_steps[].decrypt_step_details.overwrite_existing
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 is TRUE, the existing file is replaced with the file being processed. -
If OverwriteExisting is FALSE, nothing happens, and the workflow processing stops. - workflow.on_exception_steps[].decrypt_step_details.source_file_location
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}. - workflow.on_exception_steps[].decrypt_step_details.type
The type of encryption used. Currently, this value must be PGP.
- workflow.on_exception_steps[].delete_step_details
Details for a step that deletes the file. Show child fields- workflow.on_exception_steps[].delete_step_details.name
The name of the step, used as an identifier. - workflow.on_exception_steps[].delete_step_details.source_file_location
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}.
- workflow.on_exception_steps[].tag_step_details
Details for a step that creates one or more tags. You specify one or more tags. Each tag contains a key-value pair. Show child fields- workflow.on_exception_steps[].tag_step_details.name
The name of the step, used as an identifier. - workflow.on_exception_steps[].tag_step_details.source_file_location
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}. - workflow.on_exception_steps[].tag_step_details.tags[]
Show child fields- workflow.on_exception_steps[].tag_step_details.tags[].key
The name assigned to the tag that you create. - workflow.on_exception_steps[].tag_step_details.tags[].value
The value that corresponds to the key.
- workflow.on_exception_steps[].type
Currently, the following step types are supported. -
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.
- workflow.steps[]
Show child fields- workflow.steps[].copy_step_details
Details for a step that performs a file copy. Consists of the following values: Show child fields- workflow.steps[].copy_step_details.destination_file_location
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. The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date the file is uploaded in UTC. Show child fields- workflow.steps[].copy_step_details.destination_file_location.efs_file_location
Specifies the details for the Amazon Elastic File System (Amazon EFS) file that's being decrypted. Show child fields- workflow.steps[].copy_step_details.destination_file_location.efs_file_location.file_system_id
The identifier of the file system, assigned by Amazon EFS. - workflow.steps[].copy_step_details.destination_file_location.efs_file_location.path
The pathname for the folder being used by a workflow.
- workflow.steps[].copy_step_details.destination_file_location.s3_file_location
Specifies the details for the Amazon S3 file that's being copied or decrypted. Show child fields- workflow.steps[].copy_step_details.destination_file_location.s3_file_location.bucket
Specifies the S3 bucket for the customer input file. - workflow.steps[].copy_step_details.destination_file_location.s3_file_location.key
The name assigned to the file when it was created in Amazon S3. You use the object key to retrieve the object.
- workflow.steps[].copy_step_details.name
The name of the step, used as an identifier. - workflow.steps[].copy_step_details.overwrite_existing
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 is TRUE, the existing file is replaced with the file being processed. -
If OverwriteExisting is FALSE, nothing happens, and the workflow processing stops. - workflow.steps[].copy_step_details.source_file_location
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}.
- workflow.steps[].custom_step_details
Details for a step that invokes an Lambda function. Consists of the Lambda function's name, target, and timeout (in seconds). Show child fields- workflow.steps[].custom_step_details.name
The name of the step, used as an identifier. - workflow.steps[].custom_step_details.source_file_location
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}. - workflow.steps[].custom_step_details.target
The ARN for the Lambda function that is being called. - workflow.steps[].custom_step_details.timeout_seconds
Timeout, in seconds, for the step.
- workflow.steps[].decrypt_step_details
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. Show child fields- workflow.steps[].decrypt_step_details.destination_file_location
Specifies the location for the file being decrypted. 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 decrypt 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 decrypt uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload. The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date the file is uploaded in UTC. Show child fields- workflow.steps[].decrypt_step_details.destination_file_location.efs_file_location
Specifies the details for the Amazon Elastic File System (Amazon EFS) file that's being decrypted. Show child fields- workflow.steps[].decrypt_step_details.destination_file_location.efs_file_location.file_system_id
The identifier of the file system, assigned by Amazon EFS. - workflow.steps[].decrypt_step_details.destination_file_location.efs_file_location.path
The pathname for the folder being used by a workflow.
- workflow.steps[].decrypt_step_details.destination_file_location.s3_file_location
Specifies the details for the Amazon S3 file that's being copied or decrypted. Show child fields- workflow.steps[].decrypt_step_details.destination_file_location.s3_file_location.bucket
Specifies the S3 bucket for the customer input file. - workflow.steps[].decrypt_step_details.destination_file_location.s3_file_location.key
The name assigned to the file when it was created in Amazon S3. You use the object key to retrieve the object.
- workflow.steps[].decrypt_step_details.name
The name of the step, used as an identifier. - workflow.steps[].decrypt_step_details.overwrite_existing
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 is TRUE, the existing file is replaced with the file being processed. -
If OverwriteExisting is FALSE, nothing happens, and the workflow processing stops. - workflow.steps[].decrypt_step_details.source_file_location
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}. - workflow.steps[].decrypt_step_details.type
The type of encryption used. Currently, this value must be PGP.
- workflow.steps[].delete_step_details
Details for a step that deletes the file. Show child fields- workflow.steps[].delete_step_details.name
The name of the step, used as an identifier. - workflow.steps[].delete_step_details.source_file_location
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}.
- workflow.steps[].tag_step_details
Details for a step that creates one or more tags. You specify one or more tags. Each tag contains a key-value pair. Show child fields- workflow.steps[].tag_step_details.name
The name of the step, used as an identifier. - workflow.steps[].tag_step_details.source_file_location
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}. - workflow.steps[].tag_step_details.tags[]
Show child fields- workflow.steps[].tag_step_details.tags[].key
The name assigned to the tag that you create. - workflow.steps[].tag_step_details.tags[].value
The value that corresponds to the key.
- workflow.steps[].type
Currently, the following step types are supported. -
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.
- workflow.tags[]
Show child fields- workflow.tags[].key
The name assigned to the tag that you create. - workflow.tags[].value
Contains one or more values that you assigned to the key name you create.
- workflow.workflow_id
A unique identifier for the workflow.
|