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

start-batch-job

Description

Starts a batch job and returns the unique identifier of this execution of the batch job. The associated application must be running in order to start the batch job.

See also: AWS API Documentation

Synopsis

  start-batch-job
--application-id <value>
--batch-job-identifier <value>
[--job-params <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

--application-id (string)

The unique identifier of the application associated with this batch job.

--batch-job-identifier (tagged union structure)

The unique identifier of the batch job.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: fileBatchJobIdentifier, 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.

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.

Shorthand Syntax:

fileBatchJobIdentifier={fileName=string,folderPath=string},scriptBatchJobIdentifier={scriptName=string}

JSON Syntax:

{
  "fileBatchJobIdentifier": {
    "fileName": "string",
    "folderPath": "string"
  },
  "scriptBatchJobIdentifier": {
    "scriptName": "string"
  }
}

--job-params (map)

The collection of batch job parameters. For details about limits for keys and values, see Coding variables in JCL .

key -> (string)

Parameter key: the first character must be alphabetic. Can be of up to 8 alphanumeric characters.

value -> (string)

Parameter value can be of up to 44 alphanumeric characters.

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

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

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

executionId -> (string)

The unique identifier of this execution of the batch job.