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

batch-get-job-entity

Description

Get batched job details for a worker.

See also: AWS API Documentation

batch-get-job-entity uses document type values. Document types follow the JSON data model where valid values are: strings, numbers, booleans, null, arrays, and objects. For command input, options and nested parameters that are labeled with the type document must be provided as JSON. Shorthand syntax does not support document types.

Synopsis

  batch-get-job-entity
--farm-id <value>
--fleet-id <value>
--identifiers <value>
--worker-id <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

--farm-id (string)

The farm ID of the worker that's fetching job details. The worker must have an assignment on a job to fetch job details.

--fleet-id (string)

The fleet ID of the worker that's fetching job details. The worker must have an assignment on a job to fetch job details.

--identifiers (list)

The job identifiers to include within the job entity batch details.

(tagged union structure)

The details of a job entity identifier.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: environmentDetails, jobAttachmentDetails, jobDetails, stepDetails.

environmentDetails -> (structure)

The environment details.

environmentId -> (string)

The environment ID.

jobId -> (string)

The job ID.

jobAttachmentDetails -> (structure)

The job attachment details.

jobId -> (string)

The job ID.

jobDetails -> (structure)

The job details.

jobId -> (string)

The job ID.

stepDetails -> (structure)

The step details.

jobId -> (string)

The job ID.

stepId -> (string)

The step ID.

Shorthand Syntax:

environmentDetails={environmentId=string,jobId=string},jobAttachmentDetails={jobId=string},jobDetails={jobId=string},stepDetails={jobId=string,stepId=string} ...

JSON Syntax:

[
  {
    "environmentDetails": {
      "environmentId": "string",
      "jobId": "string"
    },
    "jobAttachmentDetails": {
      "jobId": "string"
    },
    "jobDetails": {
      "jobId": "string"
    },
    "stepDetails": {
      "jobId": "string",
      "stepId": "string"
    }
  }
  ...
]

--worker-id (string)

The worker ID of the worker containing the job details to get.

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

entities -> (list)

A list of the job entities, or details, in the batch.

(tagged union structure)

The details of a job entity.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: environmentDetails, jobAttachmentDetails, jobDetails, stepDetails.

environmentDetails -> (structure)

The environment details for the job entity.

environmentId -> (string)

The environment ID.

jobId -> (string)

The job ID.

schemaVersion -> (string)

The schema version in the environment.

template -> (document)

The template used for the environment.

jobAttachmentDetails -> (structure)

The job attachment details.

attachments -> (structure)

The job attachments.

fileSystem -> (string)

The file system.

manifests -> (list)

A list of manifests which describe job attachment configurations.

(structure)

The details of the manifest that links a job's source information.

fileSystemLocationName -> (string)

The file system location name.

inputManifestHash -> (string)

The has value of the file.

inputManifestPath -> (string)

The file path.

outputRelativeDirectories -> (list)

The file path relative to the directory.

(string)

rootPath -> (string)

The file's root path.

rootPathFormat -> (string)

The format of the root path.

jobId -> (string)

The job ID.

jobDetails -> (structure)

The job details.

jobAttachmentSettings -> (structure)

The job attachment settings.

rootPrefix -> (string)

The root prefix.

s3BucketName -> (string)

The Amazon S3 bucket name.

jobId -> (string)

The job ID.

jobRunAsUser -> (structure)

The user name and group that the job uses when run.

posix -> (structure)

The user and group that the jobs in the queue run as.

group -> (string)

The name of the POSIX user's group.

user -> (string)

The name of the POSIX user.

runAs -> (string)

Specifies whether the job should run using the queue's system user or if the job should run using the worker agent system user.

windows -> (structure)

Identifies a Microsoft Windows user.

passwordArn -> (string)

The password ARN for the Windows user.

user -> (string)

The user.

logGroupName -> (string)

The log group name.

parameters -> (map)

The parameters.

key -> (string)

value -> (tagged union structure)

The details of job parameters.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: float, int, path, string.

float -> (string)

A double precision IEEE-754 floating point number represented as a string.

int -> (string)

A signed integer represented as a string.

path -> (string)

A file system path represented as a string.

string -> (string)

A UTF-8 string.

pathMappingRules -> (list)

The path mapping rules.

(structure)

The details of a source and destination path.

destinationPath -> (string)

The destination path.

sourcePath -> (string)

The source path.

sourcePathFormat -> (string)

The source path format.

queueRoleArn -> (string)

The queue role ARN.

schemaVersion -> (string)

The schema version.

stepDetails -> (structure)

The step details.

dependencies -> (list)

The dependencies for a step.

(string)

jobId -> (string)

The job ID.

schemaVersion -> (string)

The schema version for a step template.

stepId -> (string)

The step ID.

template -> (document)

The template for a step.

errors -> (list)

A list of errors from the job error logs for the batch.

(tagged union structure)

The error for the job entity.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: environmentDetails, jobAttachmentDetails, jobDetails, stepDetails.

environmentDetails -> (structure)

The environment details for the failed job entity.

code -> (string)

The error code.

environmentId -> (string)

The environment ID.

jobId -> (string)

The job ID.

message -> (string)

The error message detailing the error's cause.

jobAttachmentDetails -> (structure)

The job attachment details for the failed job entity.

code -> (string)

The error code.

jobId -> (string)

The job ID.

message -> (string)

The error message detailing the error's cause.

jobDetails -> (structure)

The job details for the failed job entity.

code -> (string)

The error code.

jobId -> (string)

The job ID.

message -> (string)

The error message detailing the error's cause.

stepDetails -> (structure)

The step details for the failed job entity.

code -> (string)

The error code.

jobId -> (string)

The job ID.

message -> (string)

The error message detailing the error's cause.

stepId -> (string)

The step ID.