[ aws . deadline ]

create-job

Description

Creates a job. A job is a render submission submitted by a user. It contains specific job properties outlined as steps and tasks.

See also: AWS API Documentation

Synopsis

  create-job
[--attachments <value>]
[--client-token <value>]
--farm-id <value>
[--max-failed-tasks-count <value>]
[--max-retries-per-task <value>]
[--parameters <value>]
--priority <value>
--queue-id <value>
[--storage-profile-id <value>]
[--target-task-run-status <value>]
--template <value>
--template-type <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

--attachments (structure)

The attachments for the job. Attach files required for the job to run to a render job.

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.

JSON Syntax:

{
  "fileSystem": "COPIED"|"VIRTUAL",
  "manifests": [
    {
      "fileSystemLocationName": "string",
      "inputManifestHash": "string",
      "inputManifestPath": "string",
      "outputRelativeDirectories": ["string", ...],
      "rootPath": "string",
      "rootPathFormat": "windows"|"posix"
    }
    ...
  ]
}

--client-token (string)

The unique token which the server uses to recognize retries of the same request.

--farm-id (string)

The farm ID of the farm to connect to the job.

--max-failed-tasks-count (integer)

The number of task failures before the job stops running and is marked as FAILED .

--max-retries-per-task (integer)

The maximum number of retries for a job.

--parameters (map)

The parameters for the job.

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.

Shorthand Syntax:

KeyName1=float=string,int=string,path=string,string=string,KeyName2=float=string,int=string,path=string,string=string

JSON Syntax:

{"string": {
      "float": "string",
      "int": "string",
      "path": "string",
      "string": "string"
    }
  ...}

--priority (integer)

The priority of the job on a scale of 1 to 100. The highest priority is 1.

--queue-id (string)

The ID of the queue that the job is submitted to.

--storage-profile-id (string)

The storage profile ID for the storage profile to connect to the job.

--target-task-run-status (string)

The initial status of the job’s tasks when they are created. Tasks that are created with a SUSPENDED status will not run until you update their status.

Possible values:

• READY
• SUSPENDED

--template (string)

The job template to use for this job.

--template-type (string)

The file type for the job template.

Possible values:

• JSON
• YAML

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

jobId -> (string)

The job ID.