[ aws . transfer ]

describe-workflow

Description

Describes the specified workflow.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-workflow
--workflow-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--workflow-id (string)

A unique identifier for the workflow.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

Workflow -> (structure)

The structure that contains the details of the workflow.

Arn -> (string)

Specifies the unique Amazon Resource Name (ARN) for the workflow.

Description -> (string)

Specifies the text description for the workflow.

Steps -> (list)

Specifies the details for the steps that are in the specified workflow.

(structure)

The basic building block of a workflow.

Type -> (string)

Currently, the following step types are supported.

• COPY : copy the file to another location

• CUSTOM : custom step with a lambda target

• DELETE : delete the file

• TAG : add a tag to the file

CopyStepDetails -> (structure)

Details for a step that performs a file copy.

Consists of the following values:

• A description

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

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

Name -> (string)

The name of the step, used as an identifier.

DestinationFileLocation -> (structure)

Specifies the location for the file being copied. Only applicable for Copy type workflow steps. Use ${Transfer:username} in this field to parametrize the destination prefix by username.

S3FileLocation -> (structure)

Specifies the details for the S3 file being copied.

Bucket -> (string)

Specifies the S3 bucket for the customer input file.

Key -> (string)

The name assigned to the file when it was created in S3. You use the object key to retrieve the object.

EfsFileLocation -> (structure)

Reserved for future use.

FileSystemId -> (string)

The ID of the file system, assigned by Amazon EFS.

Path -> (string)

The pathname for the folder being used by a workflow.

OverwriteExisting -> (string)

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

SourceFileLocation -> (string)

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.

• Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.

• Enter ${original.file} to use the originally-uploaded file location as input for this step.

CustomStepDetails -> (structure)

Details for a step that invokes a lambda function.

Consists of the lambda function name, target, and timeout (in seconds).

Name -> (string)

The name of the step, used as an identifier.

Target -> (string)

The ARN for the lambda function that is being called.

TimeoutSeconds -> (integer)

Timeout, in seconds, for the step.

SourceFileLocation -> (string)

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.

• Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.

• Enter ${original.file} to use the originally-uploaded file location as input for this step.

DeleteStepDetails -> (structure)

Details for a step that deletes the file.

Name -> (string)

The name of the step, used as an identifier.

SourceFileLocation -> (string)

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.

• Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.

• Enter ${original.file} to use the originally-uploaded file location as input for this step.

TagStepDetails -> (structure)

Details for a step that creates one or more tags.

You specify one or more tags: each tag contains a key/value pair.

Name -> (string)

The name of the step, used as an identifier.

Tags -> (list)

Array that contains from 1 to 10 key/value pairs.

(structure)

Specifies the key-value pair that are assigned to a file during the execution of a Tagging step.

Key -> (string)

The name assigned to the tag that you create.

Value -> (string)

The value that corresponds to the key.

SourceFileLocation -> (string)

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.

• Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.

• Enter ${original.file} to use the originally-uploaded file location as input for this step.

OnExceptionSteps -> (list)

Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

(structure)

The basic building block of a workflow.

Type -> (string)

Currently, the following step types are supported.

• COPY : copy the file to another location

• CUSTOM : custom step with a lambda target

• DELETE : delete the file

• TAG : add a tag to the file

CopyStepDetails -> (structure)

Details for a step that performs a file copy.

Consists of the following values:

• A description

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

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

Name -> (string)

The name of the step, used as an identifier.

DestinationFileLocation -> (structure)

Specifies the location for the file being copied. Only applicable for Copy type workflow steps. Use ${Transfer:username} in this field to parametrize the destination prefix by username.

S3FileLocation -> (structure)

Specifies the details for the S3 file being copied.

Bucket -> (string)

Specifies the S3 bucket for the customer input file.

Key -> (string)

The name assigned to the file when it was created in S3. You use the object key to retrieve the object.

EfsFileLocation -> (structure)

Reserved for future use.

FileSystemId -> (string)

The ID of the file system, assigned by Amazon EFS.

Path -> (string)

The pathname for the folder being used by a workflow.

OverwriteExisting -> (string)

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

SourceFileLocation -> (string)

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.

• Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.

• Enter ${original.file} to use the originally-uploaded file location as input for this step.

CustomStepDetails -> (structure)

Details for a step that invokes a lambda function.

Consists of the lambda function name, target, and timeout (in seconds).

Name -> (string)

The name of the step, used as an identifier.

Target -> (string)

The ARN for the lambda function that is being called.

TimeoutSeconds -> (integer)

Timeout, in seconds, for the step.

SourceFileLocation -> (string)

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.

• Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.

• Enter ${original.file} to use the originally-uploaded file location as input for this step.

DeleteStepDetails -> (structure)

Details for a step that deletes the file.

Name -> (string)

The name of the step, used as an identifier.

SourceFileLocation -> (string)

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.

• Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.

• Enter ${original.file} to use the originally-uploaded file location as input for this step.

TagStepDetails -> (structure)

Details for a step that creates one or more tags.

You specify one or more tags: each tag contains a key/value pair.

Name -> (string)

The name of the step, used as an identifier.

Tags -> (list)

Array that contains from 1 to 10 key/value pairs.

(structure)

Specifies the key-value pair that are assigned to a file during the execution of a Tagging step.

Key -> (string)

The name assigned to the tag that you create.

Value -> (string)

The value that corresponds to the key.

SourceFileLocation -> (string)

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.

• Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.

• Enter ${original.file} to use the originally-uploaded file location as input for this step.

WorkflowId -> (string)

A unique identifier for the workflow.

Tags -> (list)

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

(structure)

Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to servers, users, and roles. A tag key can take more than one value. For example, to group servers for accounting purposes, you might create a tag called Group and assign the values Research and Accounting to that group.

Key -> (string)

The name assigned to the tag that you create.

Value -> (string)

Contains one or more values that you assigned to the key name you create.