[ 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

See ‘aws help’ for descriptions of global parameters.

Synopsis

  start-batch-job
--application-id <value>
--batch-job-identifier <value>
[--job-params <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--application-id (string)

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

--batch-job-identifier (structure)

The unique identifier of the batch job.

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

executionId -> (string)

The unique identifier of this execution of the batch job.