PipeTargetBatchJobParameters

The parameters for using an Batch job as a target.

Amazon Web ServicesEvent-DrivenIntegrationMessagingServerless

Properties

Name Type Description
ArrayProperties object
ContainerOverrides object
DependsOn object
JobDefinition object
JobName object
Parameters object
RetryStrategy object
View JSON Schema on GitHub

JSON Schema

amazon-eventbridge-pipes-pipe-target-batch-job-parameters-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-eventbridge-pipes/refs/heads/main/json-schema/amazon-eventbridge-pipes-pipe-target-batch-job-parameters-schema.json",
  "title": "PipeTargetBatchJobParameters",
  "description": "The parameters for using an Batch job as a target.",
  "type": "object",
  "properties": {
    "ArrayProperties": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BatchArrayProperties"
        },
        {
          "description": "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. This parameter is used only if the target is an Batch job."
        }
      ]
    },
    "ContainerOverrides": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BatchContainerOverrides"
        },
        {
          "description": "The overrides that are sent to a container."
        }
      ]
    },
    "DependsOn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BatchDependsOn"
        },
        {
          "description": "A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a <code>SEQUENTIAL</code> 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 <code>N_TO_N</code> type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin."
        }
      ]
    },
    "JobDefinition": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The job definition used by this job. This value can be one of <code>name</code>, <code>name:revision</code>, or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used."
        }
      ]
    },
    "JobName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_)."
        }
      ]
    },
    "Parameters": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BatchParametersMap"
        },
        {
          "description": "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 included here override any corresponding parameter defaults from the job definition."
        }
      ]
    },
    "RetryStrategy": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BatchRetryStrategy"
        },
        {
          "description": "The retry strategy to use for failed jobs. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition."
        }
      ]
    }
  },
  "required": [
    "JobDefinition",
    "JobName"
  ]
}