list-executions¶

Description¶

Lists all executions for the specified workflow.

Synopsis¶

  list-executions
--workflow-id <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

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.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output¶

NextToken -> (string)

ListExecutions returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional executions.

WorkflowId -> (string)

A unique identifier for the workflow.

Executions -> (list)

Returns the details for each execution.

NextToken : returned from a call to several APIs, you can use pass it to a subsequent command to continue listing additional executions.

StartTime : timestamp indicating when the execution began.

Executions : details of the execution, including the execution ID, initial file location, and Service metadata.

Status : one of the following values: IN_PROGRESS , COMPLETED , EXCEPTION , HANDLING_EXEPTION .

(structure)

Returns properties of the execution that is specified.

ExecutionId -> (string)

A unique identifier for the execution of a workflow.

InitialFileLocation -> (structure)

A structure that describes the Amazon S3 or EFS file location. This is the file location when the execution begins: if the file is being copied, this is the initial (as opposed to destination) file location.

S3FileLocation -> (structure)

Specifies the S3 details for the file being used, such as bucket, ETag, and so forth.

Bucket -> (string)

Specifies the S3 bucket that contains the file being used.

Key -> (string)

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

VersionId -> (string)

Specifies the file version.

Etag -> (string)

The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata.

EfsFileLocation -> (structure)

Specifies the Amazon EFS identifier and the path for the file being used.

FileSystemId -> (string)

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

Path -> (string)

The pathname for the folder being used by a workflow.

ServiceMetadata -> (structure)

A container object for the session details that are associated with a workflow.

UserDetails -> (structure)

The Server ID (ServerId ), Session ID (SessionId ) and user (UserName ) make up the UserDetails .

UserName -> (string)

A unique string that identifies a user account associated with a server.

ServerId -> (string)

The system-assigned unique identifier for a Transfer server instance.

SessionId -> (string)

The system-assigned unique identifier for a session that corresponds to the workflow.

Status -> (string)

The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.

Table of Contents

Feedback

User Guide