[ aws . emr-serverless ]

start-job-run

Description

Starts a job run.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  start-job-run
--application-id <value>
[--client-token <value>]
--execution-role-arn <value>
[--job-driver <value>]
[--configuration-overrides <value>]
[--tags <value>]
[--execution-timeout-minutes <value>]
[--name <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--application-id (string)

The ID of the application on which to run the job.

--client-token (string)

The client idempotency token of the job run to start. Its value must be unique for each request.

--execution-role-arn (string)

The execution role ARN for the job run.

--job-driver (structure)

The job driver for the job run.

sparkSubmit -> (structure)

The job driver parameters specified for Spark.

entryPoint -> (string)

The entry point for the Spark submit job run.

entryPointArguments -> (list)

The arguments for the Spark submit job run.

(string)

sparkSubmitParameters -> (string)

The parameters for the Spark submit job run.

hive -> (structure)

The job driver parameters specified for Hive.

query -> (string)

The query for the Hive job run.

initQueryFile -> (string)

The query file for the Hive job run.

parameters -> (string)

The parameters for the Hive job run.

Shorthand Syntax:

sparkSubmit={entryPoint=string,entryPointArguments=[string,string],sparkSubmitParameters=string},hive={query=string,initQueryFile=string,parameters=string}

JSON Syntax:

{
  "sparkSubmit": {
    "entryPoint": "string",
    "entryPointArguments": ["string", ...],
    "sparkSubmitParameters": "string"
  },
  "hive": {
    "query": "string",
    "initQueryFile": "string",
    "parameters": "string"
  }
}

--configuration-overrides (structure)

The configuration overrides for the job run.

applicationConfiguration -> (list)

The override configurations for the application.

(structure)

A configuration specification to be used when provisioning an application. A configuration consists of a classification, properties, and optional nested configurations. A classification refers to an application-specific configuration file. Properties are the settings you want to change in that file.

classification -> (string)

The classification within a configuration.

properties -> (map)

A set of properties specified within a configuration classification.

key -> (string)

value -> (string)

configurations -> (list)

A list of additional configurations to apply within a configuration object.

(structure)

A configuration specification to be used when provisioning an application. A configuration consists of a classification, properties, and optional nested configurations. A classification refers to an application-specific configuration file. Properties are the settings you want to change in that file.

classification -> (string)

The classification within a configuration.

properties -> (map)

A set of properties specified within a configuration classification.

key -> (string)

value -> (string)

monitoringConfiguration -> (structure)

The override configurations for monitoring.

s3MonitoringConfiguration -> (structure)

The Amazon S3 configuration for monitoring log publishing.

logUri -> (string)

The Amazon S3 destination URI for log publishing.

encryptionKeyArn -> (string)

The KMS key ARN to encrypt the logs published to the given Amazon S3 destination.

managedPersistenceMonitoringConfiguration -> (structure)

The managed log persistence configuration for a job run.

enabled -> (boolean)

Enables managed logging and defaults to true. If set to false, managed logging will be turned off.

encryptionKeyArn -> (string)

The KMS key ARN to encrypt the logs stored in managed log persistence.

Shorthand Syntax:

applicationConfiguration=[{classification=string,properties={KeyName1=string,KeyName2=string},( ... recursive ... )},{classification=string,properties={KeyName1=string,KeyName2=string},( ... recursive ... )}],monitoringConfiguration={s3MonitoringConfiguration={logUri=string,encryptionKeyArn=string},managedPersistenceMonitoringConfiguration={enabled=boolean,encryptionKeyArn=string}}

JSON Syntax:

{
  "applicationConfiguration": [
    {
      "classification": "string",
      "properties": {"string": "string"
        ...},
      "configurations": [
        {
          "classification": "string",
          "properties": {"string": "string"
            ...},
          "configurations":
        }
        ...
      ]
    }
    ...
  ],
  "monitoringConfiguration": {
    "s3MonitoringConfiguration": {
      "logUri": "string",
      "encryptionKeyArn": "string"
    },
    "managedPersistenceMonitoringConfiguration": {
      "enabled": true|false,
      "encryptionKeyArn": "string"
    }
  }
}

--tags (map)

The tags assigned to the job run.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

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

--execution-timeout-minutes (long)

The maximum duration for the job run to run. If the job run runs beyond this duration, it will be automatically cancelled.

--name (string)

The optional job run name. This doesn’t have to be unique.

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

applicationId -> (string)

This output displays the application ID on which the job run was submitted.

jobRunId -> (string)

The output contains the ID of the started job run.

arn -> (string)

The output lists the execution role ARN of the job run.