You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Batch::Types::SubmitJobRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing SubmitJobRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  job_name: "String", # required
  job_queue: "String", # required
  array_properties: {
    size: 1,
  },
  depends_on: [
    {
      job_id: "String",
      type: "N_TO_N", # accepts N_TO_N, SEQUENTIAL
    },
  ],
  job_definition: "String", # required
  parameters: {
    "String" => "String",
  },
  container_overrides: {
    vcpus: 1,
    memory: 1,
    command: ["String"],
    environment: [
      {
        name: "String",
        value: "String",
      },
    ],
  },
  retry_strategy: {
    attempts: 1,
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#array_propertiesTypes::ArrayProperties

The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the AWS Batch User Guide.

Returns:

#container_overridesTypes::ContainerOverrides

A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive. You can override the default command for a container (that is specified in the job definition or the Docker image) with a command override. You can also override existing environment variables (that are specified in the job definition or Docker image) on a container or add new environment variables to it with an environment override.

Returns:

  • (Types::ContainerOverrides)

    A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive.

#depends_onArray<Types::JobDependency>

A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs so that each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.

Returns:

#job_definitionString

The job definition used by this job. This value can be either a name:revision or the Amazon Resource Name (ARN) for the job definition.

Returns:

  • (String)

    The job definition used by this job.

#job_nameString

The name of the job. The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Returns:

  • (String)

    The name of the job.

#job_queueString

The job queue into which the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.

Returns:

  • (String)

    The job queue into which the job is submitted.

#parametersHash<String,String>

Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

Returns:

  • (Hash<String,String>)

    Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition.

#retry_strategyTypes::RetryStrategy

The retry strategy to use for failed jobs from this SubmitJob operation. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.

Returns: