NAME

Paws::Batch::SubmitJob - Arguments for method SubmitJob on Paws::Batch

DESCRIPTION

This class represents the parameters used for calling the method SubmitJob on the AWS Batch service. Use the attributes of this class as arguments to method SubmitJob.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SubmitJob.

SYNOPSIS

    my $batch = Paws->service('Batch');
# To submit a job to a queue
# This example submits a simple container job called example to the HighPriority
# job queue.
    my $SubmitJobResponse = $batch->SubmitJob(
      'JobDefinition' => 'sleep60',
      'JobName'       => 'example',
      'JobQueue'      => 'HighPriority'
    );
    # Results:
    my $jobId   = $SubmitJobResponse->jobId;
    my $jobName = $SubmitJobResponse->jobName;
    # Returns a L<Paws::Batch::SubmitJobResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/batch/SubmitJob>

ATTRIBUTES

ArrayProperties => Paws::Batch::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 (https://docs.aws.amazon.com/batch/latest/userguide/array_jobs.html) in the AWS Batch User Guide.

ContainerOverrides => Paws::Batch::ContainerOverrides

A list of container overrides in the 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, which is specified in the job definition or the Docker image, with a "command" override. You can also override existing environment variables on a container or add new environment variables to it with an "environment" override.

DependsOn => ArrayRef[Paws::Batch::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. 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.

REQUIRED JobDefinition => Str

The job definition used by this job. This value can be one of "name", "name:revision", or the Amazon Resource Name (ARN) for the job definition. If "name" is specified without a revision then the latest active revision is used.

REQUIRED JobName => Str

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.

REQUIRED JobQueue => Str

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

NodeOverrides => Paws::Batch::NodeOverrides

A list of node overrides in JSON format that specify the node range to target and the container overrides for that node range.

This parameter isn't applicable to jobs running on Fargate resources; use "containerOverrides" instead.

Parameters => Paws::Batch::ParametersMap

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.

PropagateTags => Bool

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the "FAILED" state. When specified, this overrides the tag propagation setting in the job definition.

RetryStrategy => Paws::Batch::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.

Tags => Paws::Batch::TagrisTagsMap

The tags that you apply to the job request to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in AWS General Reference.

Timeout => Paws::Batch::JobTimeout

The timeout configuration for this SubmitJob operation. You can specify a timeout duration after which AWS Batch terminates your jobs if they haven't finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job. For more information, see Job Timeouts (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/job_timeouts.html) in the Amazon Elastic Container Service Developer Guide.

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>