get-job-run¶

Description¶

Displays detailed information about a job run.

Synopsis¶

  get-job-run
--application-id <value>
--job-run-id <value>
[--cli-input-json | --cli-input-yaml]
[--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 ID of the application on which the job run is submitted.

--job-run-id (string)

The ID of the job run.

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

jobRun -> (structure)

The output displays information about the job run.

applicationId -> (string)

The ID of the application the job is running on.

jobRunId -> (string)

The ID of the job run.

name -> (string)

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

arn -> (string)

The execution role ARN of the job run.

createdBy -> (string)

The user who created the job run.

createdAt -> (timestamp)

The date and time when the job run was created.

updatedAt -> (timestamp)

The date and time when the job run was updated.

executionRole -> (string)

The execution role ARN of the job run.

state -> (string)

The state of the job run.

stateDetails -> (string)

The state details of the job run.

releaseLabel -> (string)

The EMR release version associated with the application your job is running on.

configurationOverrides -> (structure)

The configuration settings that are used to override default configuration.

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.

jobDriver -> (tagged union structure)

The job driver for the job run.

Note

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

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.

tags -> (map)

The tags assigned to the job run.

key -> (string)

value -> (string)

totalResourceUtilization -> (structure)

The aggregate vCPU, memory, and storage resources used from the time job start executing till the time job is terminated, rounded up to the nearest second.

vCPUHour -> (double)

The aggregated vCPU used per hour from the time job start executing till the time job is terminated.

memoryGBHour -> (double)

The aggregated memory used per hour from the time job start executing till the time job is terminated.

storageGBHour -> (double)

The aggregated storage used per hour from the time job start executing till the time job is terminated.

networkConfiguration -> (structure)

The network configuration for customer VPC connectivity.

subnetIds -> (list)

The array of subnet Ids for customer VPC connectivity.

(string)

securityGroupIds -> (list)

The array of security group Ids for customer VPC connectivity.

(string)

totalExecutionDurationSeconds -> (integer)

The job run total execution duration in seconds. This field is only available for job runs in a COMPLETED , FAILED , or CANCELLED state.

Table of Contents

Feedback

User Guide