AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . transfer ]

describe-workflow

Description

Describes the specified workflow.

See also: AWS API Documentation

Synopsis

  describe-workflow
--workflow-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--workflow-id (string)

A unique identifier for the workflow.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

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 ** - 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.

CopyStepDetails -> (structure)

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 .

Name -> (string)

The name of the step, used as an identifier.

DestinationFileLocation -> (structure)

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.

S3FileLocation -> (structure)

Specifies the details for the Amazon S3 file that's being copied or decrypted.

Bucket -> (string)

Specifies the S3 bucket for the customer input file.

Key -> (string)

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

EfsFileLocation -> (structure)

Specifies the details for the Amazon Elastic File System (Amazon EFS) file that's being decrypted.

FileSystemId -> (string)

The identifier 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 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.

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.

  • 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} .

CustomStepDetails -> (structure)

Details for a step that invokes an Lambda function.

Consists of the Lambda function's 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.

  • 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} .

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.

  • 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} .

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.

  • 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} .

DecryptStepDetails -> (structure)

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.

Name -> (string)

The name of the step, used as an identifier.

Type -> (string)

The type of encryption used. Currently, this value must be PGP .

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.

  • 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} .

OverwriteExisting -> (string)

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.

DestinationFileLocation -> (structure)

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.

Note

The system resolves UploadDate to a date format of YYYY-MM-DD , based on the date the file is uploaded in UTC.

S3FileLocation -> (structure)

Specifies the details for the Amazon S3 file that's being copied or decrypted.

Bucket -> (string)

Specifies the S3 bucket for the customer input file.

Key -> (string)

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

EfsFileLocation -> (structure)

Specifies the details for the Amazon Elastic File System (Amazon EFS) file that's being decrypted.

FileSystemId -> (string)

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

Path -> (string)

The pathname for the folder being used by a workflow.

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 ** - 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.

CopyStepDetails -> (structure)

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 .

Name -> (string)

The name of the step, used as an identifier.

DestinationFileLocation -> (structure)

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.

S3FileLocation -> (structure)

Specifies the details for the Amazon S3 file that's being copied or decrypted.

Bucket -> (string)

Specifies the S3 bucket for the customer input file.

Key -> (string)

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

EfsFileLocation -> (structure)

Specifies the details for the Amazon Elastic File System (Amazon EFS) file that's being decrypted.

FileSystemId -> (string)

The identifier 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 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.

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.

  • 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} .

CustomStepDetails -> (structure)

Details for a step that invokes an Lambda function.

Consists of the Lambda function's 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.

  • 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} .

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.

  • 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} .

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.

  • 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} .

DecryptStepDetails -> (structure)

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.

Name -> (string)

The name of the step, used as an identifier.

Type -> (string)

The type of encryption used. Currently, this value must be PGP .

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.

  • 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} .

OverwriteExisting -> (string)

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.

DestinationFileLocation -> (structure)

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.

Note

The system resolves UploadDate to a date format of YYYY-MM-DD , based on the date the file is uploaded in UTC.

S3FileLocation -> (structure)

Specifies the details for the Amazon S3 file that's being copied or decrypted.

Bucket -> (string)

Specifies the S3 bucket for the customer input file.

Key -> (string)

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

EfsFileLocation -> (structure)

Specifies the details for the Amazon Elastic File System (Amazon EFS) file that's being decrypted.

FileSystemId -> (string)

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

Path -> (string)

The pathname for the folder being used by a workflow.

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.