AWS CLI Command Reference

[ aws . m2 ]

list-batch-job-executions

Description

Lists historical, current, and scheduled batch job executions for a specific application.

See also: AWS API Documentation

list-batch-job-executions is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: batchJobExecutions

Synopsis

  list-batch-job-executions
--application-id <value>
[--execution-ids <value>]
[--job-name <value>]
[--started-after <value>]
[--started-before <value>]
[--status <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

--application-id (string)

The unique identifier of the application.

--execution-ids (list)

The unique identifier of each batch job execution.

(string)

Syntax:

"string" "string" ...

--job-name (string)

The name of each batch job execution.

--started-after (timestamp)

The time after which the batch job executions started.

--started-before (timestamp)

The time before the batch job executions started.

--status (string)

The status of the batch job executions.

Possible values:

  • Submitting
  • Holding
  • Dispatching
  • Running
  • Cancelling
  • Cancelled
  • Succeeded
  • Failed
  • Purged
  • Succeeded With Warning

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

batchJobExecutions -> (list)

Returns a list of batch job executions for an application.

(structure)

A subset of the possible batch job attributes. Used in the batch job list.

applicationId -> (string)

The unique identifier of the application that hosts this batch job.

batchJobIdentifier -> (tagged union structure)

The unique identifier of this batch job.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: fileBatchJobIdentifier, restartBatchJobIdentifier, s3BatchJobIdentifier, scriptBatchJobIdentifier.

fileBatchJobIdentifier -> (structure)

Specifies a file associated with a specific batch job.

fileName -> (string)

The file name for the batch job identifier.

folderPath -> (string)

The relative path to the file name for the batch job identifier.

restartBatchJobIdentifier -> (structure)

Specifies the required information for restart, including executionId and JobStepRestartMarker .

executionId -> (string)

The executionId from the StartBatchJob response when the job ran for the first time.

jobStepRestartMarker -> (structure)

The step/procedure step information for a restart batch job operation.

fromProcStep -> (string)

The procedure step name that a batch job was restarted from.

fromStep -> (string)

The step name that a batch job was restarted from.

toProcStep -> (string)

The procedure step name that a batch job was restarted to.

toStep -> (string)

The step name that a batch job was restarted to.

s3BatchJobIdentifier -> (structure)

Specifies an Amazon S3 location that identifies the batch jobs that you want to run. Use this identifier to run ad hoc batch jobs.

bucket -> (string)

The Amazon S3 bucket that contains the batch job definitions.

identifier -> (tagged union structure)

Identifies the batch job definition. This identifier can also point to any batch job definition that already exists in the application or to one of the batch job definitions within the directory that is specified in keyPrefix .

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: fileName, scriptName.

fileName -> (string)

The name of the file that contains the batch job definition.

scriptName -> (string)

The name of the script that contains the batch job definition.

keyPrefix -> (string)

The key prefix that specifies the path to the folder in the S3 bucket that has the batch job definitions.

scriptBatchJobIdentifier -> (structure)

A batch job identifier in which the batch job to run is identified by the script name.

scriptName -> (string)

The name of the script containing the batch job definition.

endTime -> (timestamp)

The timestamp when this batch job execution ended.

executionId -> (string)

The unique identifier of this execution of the batch job.

jobId -> (string)

The unique identifier of a particular batch job.

jobName -> (string)

The name of a particular batch job.

jobType -> (string)

The type of a particular batch job execution.

returnCode -> (string)

The batch job return code from either the Blu Age or Micro Focus runtime engines. For more information, see Batch return codes in the IBM WebSphere Application Server documentation.

startTime -> (timestamp)

The timestamp when a particular batch job execution started.

status -> (string)

The status of a particular batch job execution.

nextToken -> (string)

A pagination token that’s returned when the response doesn’t contain all batch job executions.
© Copyright 2018, Amazon Web Services. Created using Sphinx.