amazonka-batch-2.0: Amazon Batch SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Batch

Contents

Description

Derived from API version 2016-08-10 of the AWS service descriptions, licensed under Apache 2.0.

Batch

Using Batch, you can run batch computing workloads on the Amazon Web Services Cloud. Batch computing is a common means for developers, scientists, and engineers to access large amounts of compute resources. Batch uses the advantages of the batch computing to remove the undifferentiated heavy lifting of configuring and managing required infrastructure. At the same time, it also adopts a familiar batch computing software approach. You can use Batch to efficiently provision resources d, and work toward eliminating capacity constraints, reducing your overall compute costs, and delivering results more quickly.

As a fully managed service, Batch can run batch computing workloads of any scale. Batch automatically provisions compute resources and optimizes workload distribution based on the quantity and scale of your specific workloads. With Batch, there's no need to install or manage batch computing software. This means that you can focus on analyzing results and solving your specific problems instead.

Synopsis

Service Configuration

defaultService :: Service Source #

API version 2016-08-10 of the Amazon Batch SDK configuration.

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by Batch.

ClientException

_ClientException :: AsError a => Fold a ServiceError Source #

These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException

_ServerException :: AsError a => Fold a ServiceError Source #

These errors are usually caused by a server issue.

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

CancelJob

data CancelJob Source #

Contains the parameters for CancelJob.

See: newCancelJob smart constructor.

Constructors

CancelJob' Text Text 

Instances

Instances details
ToJSON CancelJob Source # 
Instance details

Defined in Amazonka.Batch.CancelJob

ToHeaders CancelJob Source # 
Instance details

Defined in Amazonka.Batch.CancelJob

Methods

toHeaders :: CancelJob -> [Header] #

ToPath CancelJob Source # 
Instance details

Defined in Amazonka.Batch.CancelJob

ToQuery CancelJob Source # 
Instance details

Defined in Amazonka.Batch.CancelJob

AWSRequest CancelJob Source # 
Instance details

Defined in Amazonka.Batch.CancelJob

Associated Types

type AWSResponse CancelJob #

Generic CancelJob Source # 
Instance details

Defined in Amazonka.Batch.CancelJob

Associated Types

type Rep CancelJob :: Type -> Type #

Read CancelJob Source # 
Instance details

Defined in Amazonka.Batch.CancelJob

Show CancelJob Source # 
Instance details

Defined in Amazonka.Batch.CancelJob

NFData CancelJob Source # 
Instance details

Defined in Amazonka.Batch.CancelJob

Methods

rnf :: CancelJob -> () #

Eq CancelJob Source # 
Instance details

Defined in Amazonka.Batch.CancelJob

Hashable CancelJob Source # 
Instance details

Defined in Amazonka.Batch.CancelJob

type AWSResponse CancelJob Source # 
Instance details

Defined in Amazonka.Batch.CancelJob

type Rep CancelJob Source # 
Instance details

Defined in Amazonka.Batch.CancelJob

type Rep CancelJob = D1 ('MetaData "CancelJob" "Amazonka.Batch.CancelJob" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "CancelJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCancelJob Source #

Create a value of CancelJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CancelJob, cancelJob_jobId - The Batch job ID of the job to cancel.

CancelJob, cancelJob_reason - A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the Batch activity logs.

data CancelJobResponse Source #

See: newCancelJobResponse smart constructor.

Constructors

CancelJobResponse' Int 

Instances

Instances details
Generic CancelJobResponse Source # 
Instance details

Defined in Amazonka.Batch.CancelJob

Associated Types

type Rep CancelJobResponse :: Type -> Type #

Read CancelJobResponse Source # 
Instance details

Defined in Amazonka.Batch.CancelJob

Show CancelJobResponse Source # 
Instance details

Defined in Amazonka.Batch.CancelJob

NFData CancelJobResponse Source # 
Instance details

Defined in Amazonka.Batch.CancelJob

Methods

rnf :: CancelJobResponse -> () #

Eq CancelJobResponse Source # 
Instance details

Defined in Amazonka.Batch.CancelJob

type Rep CancelJobResponse Source # 
Instance details

Defined in Amazonka.Batch.CancelJob

type Rep CancelJobResponse = D1 ('MetaData "CancelJobResponse" "Amazonka.Batch.CancelJob" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "CancelJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCancelJobResponse Source #

Create a value of CancelJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:CancelJobResponse', cancelJobResponse_httpStatus - The response's http status code.

CreateComputeEnvironment

data CreateComputeEnvironment Source #

Contains the parameters for CreateComputeEnvironment.

See: newCreateComputeEnvironment smart constructor.

Instances

Instances details
ToJSON CreateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.CreateComputeEnvironment

ToHeaders CreateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.CreateComputeEnvironment

ToPath CreateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.CreateComputeEnvironment

ToQuery CreateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.CreateComputeEnvironment

AWSRequest CreateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.CreateComputeEnvironment

Generic CreateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.CreateComputeEnvironment

Associated Types

type Rep CreateComputeEnvironment :: Type -> Type #

Read CreateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.CreateComputeEnvironment

Show CreateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.CreateComputeEnvironment

NFData CreateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.CreateComputeEnvironment

Eq CreateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.CreateComputeEnvironment

Hashable CreateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.CreateComputeEnvironment

type AWSResponse CreateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.CreateComputeEnvironment

type Rep CreateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.CreateComputeEnvironment

newCreateComputeEnvironment Source #

Create a value of CreateComputeEnvironment with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateComputeEnvironment, createComputeEnvironment_computeResources - Details about the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see Compute Environments in the Batch User Guide.

CreateComputeEnvironment, createComputeEnvironment_eksConfiguration - The details for the Amazon EKS cluster that supports the compute environment.

CreateComputeEnvironment, createComputeEnvironment_serviceRole - The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf. For more information, see Batch service IAM role in the Batch User Guide.

If your account already created the Batch service-linked role, that role is used by default for your compute environment unless you specify a different role here. If the Batch service-linked role doesn't exist in your account, and no role is specified here, the service attempts to create the Batch service-linked role in your account.

If your specified role has a path other than /, then you must specify either the full role ARN (recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/, specify /foo/bar as the role name. For more information, see Friendly names and paths in the IAM User Guide.

Depending on how you created your Batch service role, its ARN might contain the service-role path prefix. When you only specify the name of the service role, Batch assumes that your ARN doesn't use the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.

CreateComputeEnvironment, createComputeEnvironment_state - The state of the compute environment. If the state is ENABLED, then the compute environment accepts jobs from a queue and can scale out automatically based on queues.

If the state is ENABLED, then the Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.

If the state is DISABLED, then the Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state don't scale out. However, they scale in to minvCpus value after instances become idle.

CreateComputeEnvironment, createComputeEnvironment_tags - The tags that you apply to the compute environment to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General Reference.

These tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't propagate to the underlying compute resources.

CreateComputeEnvironment, createComputeEnvironment_unmanagedvCpus - The maximum number of vCPUs for an unmanaged compute environment. This parameter is only used for fair share scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn't provided for a fair share job queue, no vCPU capacity is reserved.

This parameter is only supported when the type parameter is set to UNMANAGED.

CreateComputeEnvironment, createComputeEnvironment_computeEnvironmentName - The name for your compute environment. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

CreateComputeEnvironment, createComputeEnvironment_type - The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the Batch User Guide.

data CreateComputeEnvironmentResponse Source #

See: newCreateComputeEnvironmentResponse smart constructor.

Instances

Instances details
Generic CreateComputeEnvironmentResponse Source # 
Instance details

Defined in Amazonka.Batch.CreateComputeEnvironment

Associated Types

type Rep CreateComputeEnvironmentResponse :: Type -> Type #

Read CreateComputeEnvironmentResponse Source # 
Instance details

Defined in Amazonka.Batch.CreateComputeEnvironment

Show CreateComputeEnvironmentResponse Source # 
Instance details

Defined in Amazonka.Batch.CreateComputeEnvironment

NFData CreateComputeEnvironmentResponse Source # 
Instance details

Defined in Amazonka.Batch.CreateComputeEnvironment

Eq CreateComputeEnvironmentResponse Source # 
Instance details

Defined in Amazonka.Batch.CreateComputeEnvironment

type Rep CreateComputeEnvironmentResponse Source # 
Instance details

Defined in Amazonka.Batch.CreateComputeEnvironment

type Rep CreateComputeEnvironmentResponse = D1 ('MetaData "CreateComputeEnvironmentResponse" "Amazonka.Batch.CreateComputeEnvironment" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "CreateComputeEnvironmentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "computeEnvironmentArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "computeEnvironmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateComputeEnvironmentResponse Source #

Create a value of CreateComputeEnvironmentResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateComputeEnvironmentResponse, createComputeEnvironmentResponse_computeEnvironmentArn - The Amazon Resource Name (ARN) of the compute environment.

CreateComputeEnvironment, createComputeEnvironmentResponse_computeEnvironmentName - The name of the compute environment. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

$sel:httpStatus:CreateComputeEnvironmentResponse', createComputeEnvironmentResponse_httpStatus - The response's http status code.

CreateJobQueue

data CreateJobQueue Source #

Contains the parameters for CreateJobQueue.

See: newCreateJobQueue smart constructor.

Instances

Instances details
ToJSON CreateJobQueue Source # 
Instance details

Defined in Amazonka.Batch.CreateJobQueue

ToHeaders CreateJobQueue Source # 
Instance details

Defined in Amazonka.Batch.CreateJobQueue

ToPath CreateJobQueue Source # 
Instance details

Defined in Amazonka.Batch.CreateJobQueue

ToQuery CreateJobQueue Source # 
Instance details

Defined in Amazonka.Batch.CreateJobQueue

AWSRequest CreateJobQueue Source # 
Instance details

Defined in Amazonka.Batch.CreateJobQueue

Associated Types

type AWSResponse CreateJobQueue #

Generic CreateJobQueue Source # 
Instance details

Defined in Amazonka.Batch.CreateJobQueue

Associated Types

type Rep CreateJobQueue :: Type -> Type #

Read CreateJobQueue Source # 
Instance details

Defined in Amazonka.Batch.CreateJobQueue

Show CreateJobQueue Source # 
Instance details

Defined in Amazonka.Batch.CreateJobQueue

NFData CreateJobQueue Source # 
Instance details

Defined in Amazonka.Batch.CreateJobQueue

Methods

rnf :: CreateJobQueue -> () #

Eq CreateJobQueue Source # 
Instance details

Defined in Amazonka.Batch.CreateJobQueue

Hashable CreateJobQueue Source # 
Instance details

Defined in Amazonka.Batch.CreateJobQueue

type AWSResponse CreateJobQueue Source # 
Instance details

Defined in Amazonka.Batch.CreateJobQueue

type Rep CreateJobQueue Source # 
Instance details

Defined in Amazonka.Batch.CreateJobQueue

type Rep CreateJobQueue = D1 ('MetaData "CreateJobQueue" "Amazonka.Batch.CreateJobQueue" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "CreateJobQueue'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "schedulingPolicyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JQState)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :*: (S1 ('MetaSel ('Just "jobQueueName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "priority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "computeEnvironmentOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ComputeEnvironmentOrder])))))

newCreateJobQueue Source #

Create a value of CreateJobQueue with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateJobQueue, createJobQueue_schedulingPolicyArn - The Amazon Resource Name (ARN) of the fair share scheduling policy. If this parameter is specified, the job queue uses a fair share scheduling policy. If this parameter isn't specified, the job queue uses a first in, first out (FIFO) scheduling policy. After a job queue is created, you can replace but can't remove the fair share scheduling policy. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . An example is aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.

CreateJobQueue, createJobQueue_state - The state of the job queue. If the job queue state is ENABLED, it is able to accept jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs already in the queue can finish.

CreateJobQueue, createJobQueue_tags - The tags that you apply to the job queue to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources in Batch User Guide.

CreateJobQueue, createJobQueue_jobQueueName - The name of the job queue. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

CreateJobQueue, createJobQueue_priority - The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order. For example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.

CreateJobQueue, createJobQueue_computeEnvironmentOrder - The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment runs a specific job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to three compute environments with a job queue. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.

All compute environments that are associated with a job queue must share the same architecture. Batch doesn't support mixing compute environment architecture types in a single job queue.

data CreateJobQueueResponse Source #

See: newCreateJobQueueResponse smart constructor.

Instances

Instances details
Generic CreateJobQueueResponse Source # 
Instance details

Defined in Amazonka.Batch.CreateJobQueue

Associated Types

type Rep CreateJobQueueResponse :: Type -> Type #

Read CreateJobQueueResponse Source # 
Instance details

Defined in Amazonka.Batch.CreateJobQueue

Show CreateJobQueueResponse Source # 
Instance details

Defined in Amazonka.Batch.CreateJobQueue

NFData CreateJobQueueResponse Source # 
Instance details

Defined in Amazonka.Batch.CreateJobQueue

Methods

rnf :: CreateJobQueueResponse -> () #

Eq CreateJobQueueResponse Source # 
Instance details

Defined in Amazonka.Batch.CreateJobQueue

type Rep CreateJobQueueResponse Source # 
Instance details

Defined in Amazonka.Batch.CreateJobQueue

type Rep CreateJobQueueResponse = D1 ('MetaData "CreateJobQueueResponse" "Amazonka.Batch.CreateJobQueue" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "CreateJobQueueResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "jobQueueName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "jobQueueArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateJobQueueResponse Source #

Create a value of CreateJobQueueResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:CreateJobQueueResponse', createJobQueueResponse_httpStatus - The response's http status code.

CreateJobQueue, createJobQueueResponse_jobQueueName - The name of the job queue.

CreateJobQueueResponse, createJobQueueResponse_jobQueueArn - The Amazon Resource Name (ARN) of the job queue.

CreateSchedulingPolicy

data CreateSchedulingPolicy Source #

Contains the parameters for CreateSchedulingPolicy.

See: newCreateSchedulingPolicy smart constructor.

Instances

Instances details
ToJSON CreateSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.CreateSchedulingPolicy

ToHeaders CreateSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.CreateSchedulingPolicy

ToPath CreateSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.CreateSchedulingPolicy

ToQuery CreateSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.CreateSchedulingPolicy

AWSRequest CreateSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.CreateSchedulingPolicy

Associated Types

type AWSResponse CreateSchedulingPolicy #

Generic CreateSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.CreateSchedulingPolicy

Associated Types

type Rep CreateSchedulingPolicy :: Type -> Type #

Read CreateSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.CreateSchedulingPolicy

Show CreateSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.CreateSchedulingPolicy

NFData CreateSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.CreateSchedulingPolicy

Methods

rnf :: CreateSchedulingPolicy -> () #

Eq CreateSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.CreateSchedulingPolicy

Hashable CreateSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.CreateSchedulingPolicy

type AWSResponse CreateSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.CreateSchedulingPolicy

type Rep CreateSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.CreateSchedulingPolicy

type Rep CreateSchedulingPolicy = D1 ('MetaData "CreateSchedulingPolicy" "Amazonka.Batch.CreateSchedulingPolicy" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "CreateSchedulingPolicy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fairsharePolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FairsharePolicy)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateSchedulingPolicy Source #

Create a value of CreateSchedulingPolicy with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateSchedulingPolicy, createSchedulingPolicy_fairsharePolicy - The fair share policy of the scheduling policy.

CreateSchedulingPolicy, createSchedulingPolicy_tags - The tags that you apply to the scheduling policy to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General Reference.

These tags can be updated or removed using the TagResource and UntagResource API operations.

CreateSchedulingPolicy, createSchedulingPolicy_name - The name of the scheduling policy. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

data CreateSchedulingPolicyResponse Source #

See: newCreateSchedulingPolicyResponse smart constructor.

Instances

Instances details
Generic CreateSchedulingPolicyResponse Source # 
Instance details

Defined in Amazonka.Batch.CreateSchedulingPolicy

Associated Types

type Rep CreateSchedulingPolicyResponse :: Type -> Type #

Read CreateSchedulingPolicyResponse Source # 
Instance details

Defined in Amazonka.Batch.CreateSchedulingPolicy

Show CreateSchedulingPolicyResponse Source # 
Instance details

Defined in Amazonka.Batch.CreateSchedulingPolicy

NFData CreateSchedulingPolicyResponse Source # 
Instance details

Defined in Amazonka.Batch.CreateSchedulingPolicy

Eq CreateSchedulingPolicyResponse Source # 
Instance details

Defined in Amazonka.Batch.CreateSchedulingPolicy

type Rep CreateSchedulingPolicyResponse Source # 
Instance details

Defined in Amazonka.Batch.CreateSchedulingPolicy

type Rep CreateSchedulingPolicyResponse = D1 ('MetaData "CreateSchedulingPolicyResponse" "Amazonka.Batch.CreateSchedulingPolicy" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "CreateSchedulingPolicyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateSchedulingPolicyResponse Source #

Create a value of CreateSchedulingPolicyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:CreateSchedulingPolicyResponse', createSchedulingPolicyResponse_httpStatus - The response's http status code.

CreateSchedulingPolicy, createSchedulingPolicyResponse_name - The name of the scheduling policy.

CreateSchedulingPolicyResponse, createSchedulingPolicyResponse_arn - The Amazon Resource Name (ARN) of the scheduling policy. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.

DeleteComputeEnvironment

data DeleteComputeEnvironment Source #

Contains the parameters for DeleteComputeEnvironment.

See: newDeleteComputeEnvironment smart constructor.

Instances

Instances details
ToJSON DeleteComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.DeleteComputeEnvironment

ToHeaders DeleteComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.DeleteComputeEnvironment

ToPath DeleteComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.DeleteComputeEnvironment

ToQuery DeleteComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.DeleteComputeEnvironment

AWSRequest DeleteComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.DeleteComputeEnvironment

Generic DeleteComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.DeleteComputeEnvironment

Associated Types

type Rep DeleteComputeEnvironment :: Type -> Type #

Read DeleteComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.DeleteComputeEnvironment

Show DeleteComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.DeleteComputeEnvironment

NFData DeleteComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.DeleteComputeEnvironment

Eq DeleteComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.DeleteComputeEnvironment

Hashable DeleteComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.DeleteComputeEnvironment

type AWSResponse DeleteComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.DeleteComputeEnvironment

type Rep DeleteComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.DeleteComputeEnvironment

type Rep DeleteComputeEnvironment = D1 ('MetaData "DeleteComputeEnvironment" "Amazonka.Batch.DeleteComputeEnvironment" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "DeleteComputeEnvironment'" 'PrefixI 'True) (S1 ('MetaSel ('Just "computeEnvironment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteComputeEnvironment Source #

Create a value of DeleteComputeEnvironment with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteComputeEnvironment, deleteComputeEnvironment_computeEnvironment - The name or Amazon Resource Name (ARN) of the compute environment to delete.

data DeleteComputeEnvironmentResponse Source #

See: newDeleteComputeEnvironmentResponse smart constructor.

Instances

Instances details
Generic DeleteComputeEnvironmentResponse Source # 
Instance details

Defined in Amazonka.Batch.DeleteComputeEnvironment

Associated Types

type Rep DeleteComputeEnvironmentResponse :: Type -> Type #

Read DeleteComputeEnvironmentResponse Source # 
Instance details

Defined in Amazonka.Batch.DeleteComputeEnvironment

Show DeleteComputeEnvironmentResponse Source # 
Instance details

Defined in Amazonka.Batch.DeleteComputeEnvironment

NFData DeleteComputeEnvironmentResponse Source # 
Instance details

Defined in Amazonka.Batch.DeleteComputeEnvironment

Eq DeleteComputeEnvironmentResponse Source # 
Instance details

Defined in Amazonka.Batch.DeleteComputeEnvironment

type Rep DeleteComputeEnvironmentResponse Source # 
Instance details

Defined in Amazonka.Batch.DeleteComputeEnvironment

type Rep DeleteComputeEnvironmentResponse = D1 ('MetaData "DeleteComputeEnvironmentResponse" "Amazonka.Batch.DeleteComputeEnvironment" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "DeleteComputeEnvironmentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteComputeEnvironmentResponse Source #

Create a value of DeleteComputeEnvironmentResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:DeleteComputeEnvironmentResponse', deleteComputeEnvironmentResponse_httpStatus - The response's http status code.

DeleteJobQueue

data DeleteJobQueue Source #

Contains the parameters for DeleteJobQueue.

See: newDeleteJobQueue smart constructor.

Constructors

DeleteJobQueue' Text 

Instances

Instances details
ToJSON DeleteJobQueue Source # 
Instance details

Defined in Amazonka.Batch.DeleteJobQueue

ToHeaders DeleteJobQueue Source # 
Instance details

Defined in Amazonka.Batch.DeleteJobQueue

ToPath DeleteJobQueue Source # 
Instance details

Defined in Amazonka.Batch.DeleteJobQueue

ToQuery DeleteJobQueue Source # 
Instance details

Defined in Amazonka.Batch.DeleteJobQueue

AWSRequest DeleteJobQueue Source # 
Instance details

Defined in Amazonka.Batch.DeleteJobQueue

Associated Types

type AWSResponse DeleteJobQueue #

Generic DeleteJobQueue Source # 
Instance details

Defined in Amazonka.Batch.DeleteJobQueue

Associated Types

type Rep DeleteJobQueue :: Type -> Type #

Read DeleteJobQueue Source # 
Instance details

Defined in Amazonka.Batch.DeleteJobQueue

Show DeleteJobQueue Source # 
Instance details

Defined in Amazonka.Batch.DeleteJobQueue

NFData DeleteJobQueue Source # 
Instance details

Defined in Amazonka.Batch.DeleteJobQueue

Methods

rnf :: DeleteJobQueue -> () #

Eq DeleteJobQueue Source # 
Instance details

Defined in Amazonka.Batch.DeleteJobQueue

Hashable DeleteJobQueue Source # 
Instance details

Defined in Amazonka.Batch.DeleteJobQueue

type AWSResponse DeleteJobQueue Source # 
Instance details

Defined in Amazonka.Batch.DeleteJobQueue

type Rep DeleteJobQueue Source # 
Instance details

Defined in Amazonka.Batch.DeleteJobQueue

type Rep DeleteJobQueue = D1 ('MetaData "DeleteJobQueue" "Amazonka.Batch.DeleteJobQueue" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "DeleteJobQueue'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobQueue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteJobQueue Source #

Create a value of DeleteJobQueue with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteJobQueue, deleteJobQueue_jobQueue - The short name or full Amazon Resource Name (ARN) of the queue to delete.

data DeleteJobQueueResponse Source #

See: newDeleteJobQueueResponse smart constructor.

Instances

Instances details
Generic DeleteJobQueueResponse Source # 
Instance details

Defined in Amazonka.Batch.DeleteJobQueue

Associated Types

type Rep DeleteJobQueueResponse :: Type -> Type #

Read DeleteJobQueueResponse Source # 
Instance details

Defined in Amazonka.Batch.DeleteJobQueue

Show DeleteJobQueueResponse Source # 
Instance details

Defined in Amazonka.Batch.DeleteJobQueue

NFData DeleteJobQueueResponse Source # 
Instance details

Defined in Amazonka.Batch.DeleteJobQueue

Methods

rnf :: DeleteJobQueueResponse -> () #

Eq DeleteJobQueueResponse Source # 
Instance details

Defined in Amazonka.Batch.DeleteJobQueue

type Rep DeleteJobQueueResponse Source # 
Instance details

Defined in Amazonka.Batch.DeleteJobQueue

type Rep DeleteJobQueueResponse = D1 ('MetaData "DeleteJobQueueResponse" "Amazonka.Batch.DeleteJobQueue" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "DeleteJobQueueResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteJobQueueResponse Source #

Create a value of DeleteJobQueueResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:DeleteJobQueueResponse', deleteJobQueueResponse_httpStatus - The response's http status code.

DeleteSchedulingPolicy

data DeleteSchedulingPolicy Source #

Contains the parameters for DeleteSchedulingPolicy.

See: newDeleteSchedulingPolicy smart constructor.

Instances

Instances details
ToJSON DeleteSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.DeleteSchedulingPolicy

ToHeaders DeleteSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.DeleteSchedulingPolicy

ToPath DeleteSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.DeleteSchedulingPolicy

ToQuery DeleteSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.DeleteSchedulingPolicy

AWSRequest DeleteSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.DeleteSchedulingPolicy

Associated Types

type AWSResponse DeleteSchedulingPolicy #

Generic DeleteSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.DeleteSchedulingPolicy

Associated Types

type Rep DeleteSchedulingPolicy :: Type -> Type #

Read DeleteSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.DeleteSchedulingPolicy

Show DeleteSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.DeleteSchedulingPolicy

NFData DeleteSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.DeleteSchedulingPolicy

Methods

rnf :: DeleteSchedulingPolicy -> () #

Eq DeleteSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.DeleteSchedulingPolicy

Hashable DeleteSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.DeleteSchedulingPolicy

type AWSResponse DeleteSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.DeleteSchedulingPolicy

type Rep DeleteSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.DeleteSchedulingPolicy

type Rep DeleteSchedulingPolicy = D1 ('MetaData "DeleteSchedulingPolicy" "Amazonka.Batch.DeleteSchedulingPolicy" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "DeleteSchedulingPolicy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteSchedulingPolicy Source #

Create a value of DeleteSchedulingPolicy with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteSchedulingPolicy, deleteSchedulingPolicy_arn - The Amazon Resource Name (ARN) of the scheduling policy to delete.

data DeleteSchedulingPolicyResponse Source #

See: newDeleteSchedulingPolicyResponse smart constructor.

Instances

Instances details
Generic DeleteSchedulingPolicyResponse Source # 
Instance details

Defined in Amazonka.Batch.DeleteSchedulingPolicy

Associated Types

type Rep DeleteSchedulingPolicyResponse :: Type -> Type #

Read DeleteSchedulingPolicyResponse Source # 
Instance details

Defined in Amazonka.Batch.DeleteSchedulingPolicy

Show DeleteSchedulingPolicyResponse Source # 
Instance details

Defined in Amazonka.Batch.DeleteSchedulingPolicy

NFData DeleteSchedulingPolicyResponse Source # 
Instance details

Defined in Amazonka.Batch.DeleteSchedulingPolicy

Eq DeleteSchedulingPolicyResponse Source # 
Instance details

Defined in Amazonka.Batch.DeleteSchedulingPolicy

type Rep DeleteSchedulingPolicyResponse Source # 
Instance details

Defined in Amazonka.Batch.DeleteSchedulingPolicy

type Rep DeleteSchedulingPolicyResponse = D1 ('MetaData "DeleteSchedulingPolicyResponse" "Amazonka.Batch.DeleteSchedulingPolicy" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "DeleteSchedulingPolicyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteSchedulingPolicyResponse Source #

Create a value of DeleteSchedulingPolicyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:DeleteSchedulingPolicyResponse', deleteSchedulingPolicyResponse_httpStatus - The response's http status code.

DeregisterJobDefinition

data DeregisterJobDefinition Source #

See: newDeregisterJobDefinition smart constructor.

Instances

Instances details
ToJSON DeregisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.DeregisterJobDefinition

ToHeaders DeregisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.DeregisterJobDefinition

ToPath DeregisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.DeregisterJobDefinition

ToQuery DeregisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.DeregisterJobDefinition

AWSRequest DeregisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.DeregisterJobDefinition

Generic DeregisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.DeregisterJobDefinition

Associated Types

type Rep DeregisterJobDefinition :: Type -> Type #

Read DeregisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.DeregisterJobDefinition

Show DeregisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.DeregisterJobDefinition

NFData DeregisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.DeregisterJobDefinition

Methods

rnf :: DeregisterJobDefinition -> () #

Eq DeregisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.DeregisterJobDefinition

Hashable DeregisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.DeregisterJobDefinition

type AWSResponse DeregisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.DeregisterJobDefinition

type Rep DeregisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.DeregisterJobDefinition

type Rep DeregisterJobDefinition = D1 ('MetaData "DeregisterJobDefinition" "Amazonka.Batch.DeregisterJobDefinition" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "DeregisterJobDefinition'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeregisterJobDefinition Source #

Create a value of DeregisterJobDefinition with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeregisterJobDefinition, deregisterJobDefinition_jobDefinition - The name and revision (name:revision) or full Amazon Resource Name (ARN) of the job definition to deregister.

data DeregisterJobDefinitionResponse Source #

See: newDeregisterJobDefinitionResponse smart constructor.

Instances

Instances details
Generic DeregisterJobDefinitionResponse Source # 
Instance details

Defined in Amazonka.Batch.DeregisterJobDefinition

Associated Types

type Rep DeregisterJobDefinitionResponse :: Type -> Type #

Read DeregisterJobDefinitionResponse Source # 
Instance details

Defined in Amazonka.Batch.DeregisterJobDefinition

Show DeregisterJobDefinitionResponse Source # 
Instance details

Defined in Amazonka.Batch.DeregisterJobDefinition

NFData DeregisterJobDefinitionResponse Source # 
Instance details

Defined in Amazonka.Batch.DeregisterJobDefinition

Eq DeregisterJobDefinitionResponse Source # 
Instance details

Defined in Amazonka.Batch.DeregisterJobDefinition

type Rep DeregisterJobDefinitionResponse Source # 
Instance details

Defined in Amazonka.Batch.DeregisterJobDefinition

type Rep DeregisterJobDefinitionResponse = D1 ('MetaData "DeregisterJobDefinitionResponse" "Amazonka.Batch.DeregisterJobDefinition" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "DeregisterJobDefinitionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeregisterJobDefinitionResponse Source #

Create a value of DeregisterJobDefinitionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:DeregisterJobDefinitionResponse', deregisterJobDefinitionResponse_httpStatus - The response's http status code.

DescribeComputeEnvironments (Paginated)

data DescribeComputeEnvironments Source #

Contains the parameters for DescribeComputeEnvironments.

See: newDescribeComputeEnvironments smart constructor.

Instances

Instances details
ToJSON DescribeComputeEnvironments Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

ToHeaders DescribeComputeEnvironments Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

ToPath DescribeComputeEnvironments Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

ToQuery DescribeComputeEnvironments Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

AWSPager DescribeComputeEnvironments Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

AWSRequest DescribeComputeEnvironments Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

Generic DescribeComputeEnvironments Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

Associated Types

type Rep DescribeComputeEnvironments :: Type -> Type #

Read DescribeComputeEnvironments Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

Show DescribeComputeEnvironments Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

NFData DescribeComputeEnvironments Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

Eq DescribeComputeEnvironments Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

Hashable DescribeComputeEnvironments Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

type AWSResponse DescribeComputeEnvironments Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

type Rep DescribeComputeEnvironments Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

type Rep DescribeComputeEnvironments = D1 ('MetaData "DescribeComputeEnvironments" "Amazonka.Batch.DescribeComputeEnvironments" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "DescribeComputeEnvironments'" 'PrefixI 'True) (S1 ('MetaSel ('Just "computeEnvironments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribeComputeEnvironments :: DescribeComputeEnvironments Source #

Create a value of DescribeComputeEnvironments with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeComputeEnvironments, describeComputeEnvironments_computeEnvironments - A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.

$sel:maxResults:DescribeComputeEnvironments', describeComputeEnvironments_maxResults - The maximum number of cluster results returned by DescribeComputeEnvironments in paginated output. When this parameter is used, DescribeComputeEnvironments only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeComputeEnvironments request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeComputeEnvironments returns up to 100 results and a nextToken value if applicable.

DescribeComputeEnvironments, describeComputeEnvironments_nextToken - The nextToken value returned from a previous paginated DescribeComputeEnvironments request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

data DescribeComputeEnvironmentsResponse Source #

Instances

Instances details
Generic DescribeComputeEnvironmentsResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

Read DescribeComputeEnvironmentsResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

Show DescribeComputeEnvironmentsResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

NFData DescribeComputeEnvironmentsResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

Eq DescribeComputeEnvironmentsResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

type Rep DescribeComputeEnvironmentsResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

type Rep DescribeComputeEnvironmentsResponse = D1 ('MetaData "DescribeComputeEnvironmentsResponse" "Amazonka.Batch.DescribeComputeEnvironments" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "DescribeComputeEnvironmentsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "computeEnvironments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ComputeEnvironmentDetail])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeComputeEnvironmentsResponse Source #

Create a value of DescribeComputeEnvironmentsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeComputeEnvironments, describeComputeEnvironmentsResponse_computeEnvironments - The list of compute environments.

DescribeComputeEnvironments, describeComputeEnvironmentsResponse_nextToken - The nextToken value to include in a future DescribeComputeEnvironments request. When the results of a DescribeComputeEnvironments request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

$sel:httpStatus:DescribeComputeEnvironmentsResponse', describeComputeEnvironmentsResponse_httpStatus - The response's http status code.

DescribeJobDefinitions (Paginated)

data DescribeJobDefinitions Source #

Contains the parameters for DescribeJobDefinitions.

See: newDescribeJobDefinitions smart constructor.

Instances

Instances details
ToJSON DescribeJobDefinitions Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

ToHeaders DescribeJobDefinitions Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

ToPath DescribeJobDefinitions Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

ToQuery DescribeJobDefinitions Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

AWSPager DescribeJobDefinitions Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

AWSRequest DescribeJobDefinitions Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

Associated Types

type AWSResponse DescribeJobDefinitions #

Generic DescribeJobDefinitions Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

Associated Types

type Rep DescribeJobDefinitions :: Type -> Type #

Read DescribeJobDefinitions Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

Show DescribeJobDefinitions Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

NFData DescribeJobDefinitions Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

Methods

rnf :: DescribeJobDefinitions -> () #

Eq DescribeJobDefinitions Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

Hashable DescribeJobDefinitions Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

type AWSResponse DescribeJobDefinitions Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

type Rep DescribeJobDefinitions Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

type Rep DescribeJobDefinitions = D1 ('MetaData "DescribeJobDefinitions" "Amazonka.Batch.DescribeJobDefinitions" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "DescribeJobDefinitions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "jobDefinitionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobDefinitions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDescribeJobDefinitions :: DescribeJobDefinitions Source #

Create a value of DescribeJobDefinitions with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeJobDefinitions, describeJobDefinitions_jobDefinitionName - The name of the job definition to describe.

DescribeJobDefinitions, describeJobDefinitions_jobDefinitions - A list of up to 100 job definitions. Each entry in the list can either be an ARN in the format arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision} or a short version using the form ${JobDefinitionName}:${Revision}.

$sel:maxResults:DescribeJobDefinitions', describeJobDefinitions_maxResults - The maximum number of results returned by DescribeJobDefinitions in paginated output. When this parameter is used, DescribeJobDefinitions only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeJobDefinitions returns up to 100 results and a nextToken value if applicable.

DescribeJobDefinitions, describeJobDefinitions_nextToken - The nextToken value returned from a previous paginated DescribeJobDefinitions request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

DescribeJobDefinitions, describeJobDefinitions_status - The status used to filter job definitions.

data DescribeJobDefinitionsResponse Source #

See: newDescribeJobDefinitionsResponse smart constructor.

Instances

Instances details
Generic DescribeJobDefinitionsResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

Associated Types

type Rep DescribeJobDefinitionsResponse :: Type -> Type #

Read DescribeJobDefinitionsResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

Show DescribeJobDefinitionsResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

NFData DescribeJobDefinitionsResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

Eq DescribeJobDefinitionsResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

type Rep DescribeJobDefinitionsResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobDefinitions

type Rep DescribeJobDefinitionsResponse = D1 ('MetaData "DescribeJobDefinitionsResponse" "Amazonka.Batch.DescribeJobDefinitions" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "DescribeJobDefinitionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobDefinitions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [JobDefinition])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeJobDefinitionsResponse Source #

Create a value of DescribeJobDefinitionsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeJobDefinitions, describeJobDefinitionsResponse_jobDefinitions - The list of job definitions.

DescribeJobDefinitions, describeJobDefinitionsResponse_nextToken - The nextToken value to include in a future DescribeJobDefinitions request. When the results of a DescribeJobDefinitions request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

$sel:httpStatus:DescribeJobDefinitionsResponse', describeJobDefinitionsResponse_httpStatus - The response's http status code.

DescribeJobQueues (Paginated)

data DescribeJobQueues Source #

Contains the parameters for DescribeJobQueues.

See: newDescribeJobQueues smart constructor.

Instances

Instances details
ToJSON DescribeJobQueues Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobQueues

ToHeaders DescribeJobQueues Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobQueues

ToPath DescribeJobQueues Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobQueues

ToQuery DescribeJobQueues Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobQueues

AWSPager DescribeJobQueues Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobQueues

AWSRequest DescribeJobQueues Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobQueues

Associated Types

type AWSResponse DescribeJobQueues #

Generic DescribeJobQueues Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobQueues

Associated Types

type Rep DescribeJobQueues :: Type -> Type #

Read DescribeJobQueues Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobQueues

Show DescribeJobQueues Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobQueues

NFData DescribeJobQueues Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobQueues

Methods

rnf :: DescribeJobQueues -> () #

Eq DescribeJobQueues Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobQueues

Hashable DescribeJobQueues Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobQueues

type AWSResponse DescribeJobQueues Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobQueues

type Rep DescribeJobQueues Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobQueues

type Rep DescribeJobQueues = D1 ('MetaData "DescribeJobQueues" "Amazonka.Batch.DescribeJobQueues" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "DescribeJobQueues'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobQueues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribeJobQueues :: DescribeJobQueues Source #

Create a value of DescribeJobQueues with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeJobQueues, describeJobQueues_jobQueues - A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.

$sel:maxResults:DescribeJobQueues', describeJobQueues_maxResults - The maximum number of results returned by DescribeJobQueues in paginated output. When this parameter is used, DescribeJobQueues only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobQueues request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeJobQueues returns up to 100 results and a nextToken value if applicable.

DescribeJobQueues, describeJobQueues_nextToken - The nextToken value returned from a previous paginated DescribeJobQueues request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

data DescribeJobQueuesResponse Source #

See: newDescribeJobQueuesResponse smart constructor.

Instances

Instances details
Generic DescribeJobQueuesResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobQueues

Associated Types

type Rep DescribeJobQueuesResponse :: Type -> Type #

Read DescribeJobQueuesResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobQueues

Show DescribeJobQueuesResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobQueues

NFData DescribeJobQueuesResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobQueues

Eq DescribeJobQueuesResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobQueues

type Rep DescribeJobQueuesResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobQueues

type Rep DescribeJobQueuesResponse = D1 ('MetaData "DescribeJobQueuesResponse" "Amazonka.Batch.DescribeJobQueues" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "DescribeJobQueuesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobQueues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [JobQueueDetail])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeJobQueuesResponse Source #

Create a value of DescribeJobQueuesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeJobQueues, describeJobQueuesResponse_jobQueues - The list of job queues.

DescribeJobQueues, describeJobQueuesResponse_nextToken - The nextToken value to include in a future DescribeJobQueues request. When the results of a DescribeJobQueues request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

$sel:httpStatus:DescribeJobQueuesResponse', describeJobQueuesResponse_httpStatus - The response's http status code.

DescribeJobs

data DescribeJobs Source #

Contains the parameters for DescribeJobs.

See: newDescribeJobs smart constructor.

Constructors

DescribeJobs' [Text] 

Instances

Instances details
ToJSON DescribeJobs Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobs

ToHeaders DescribeJobs Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobs

ToPath DescribeJobs Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobs

ToQuery DescribeJobs Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobs

AWSRequest DescribeJobs Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobs

Associated Types

type AWSResponse DescribeJobs #

Generic DescribeJobs Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobs

Associated Types

type Rep DescribeJobs :: Type -> Type #

Read DescribeJobs Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobs

Show DescribeJobs Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobs

NFData DescribeJobs Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobs

Methods

rnf :: DescribeJobs -> () #

Eq DescribeJobs Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobs

Hashable DescribeJobs Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobs

type AWSResponse DescribeJobs Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobs

type Rep DescribeJobs Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobs

type Rep DescribeJobs = D1 ('MetaData "DescribeJobs" "Amazonka.Batch.DescribeJobs" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "DescribeJobs'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))

newDescribeJobs :: DescribeJobs Source #

Create a value of DescribeJobs with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeJobs, describeJobs_jobs - A list of up to 100 job IDs.

data DescribeJobsResponse Source #

See: newDescribeJobsResponse smart constructor.

Instances

Instances details
Generic DescribeJobsResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobs

Associated Types

type Rep DescribeJobsResponse :: Type -> Type #

Read DescribeJobsResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobs

Show DescribeJobsResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobs

NFData DescribeJobsResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobs

Methods

rnf :: DescribeJobsResponse -> () #

Eq DescribeJobsResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobs

type Rep DescribeJobsResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeJobs

type Rep DescribeJobsResponse = D1 ('MetaData "DescribeJobsResponse" "Amazonka.Batch.DescribeJobs" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "DescribeJobsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [JobDetail])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeJobsResponse Source #

Create a value of DescribeJobsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeJobs, describeJobsResponse_jobs - The list of jobs.

$sel:httpStatus:DescribeJobsResponse', describeJobsResponse_httpStatus - The response's http status code.

DescribeSchedulingPolicies

data DescribeSchedulingPolicies Source #

Contains the parameters for DescribeSchedulingPolicies.

See: newDescribeSchedulingPolicies smart constructor.

Instances

Instances details
ToJSON DescribeSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.DescribeSchedulingPolicies

ToHeaders DescribeSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.DescribeSchedulingPolicies

ToPath DescribeSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.DescribeSchedulingPolicies

ToQuery DescribeSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.DescribeSchedulingPolicies

AWSRequest DescribeSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.DescribeSchedulingPolicies

Generic DescribeSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.DescribeSchedulingPolicies

Associated Types

type Rep DescribeSchedulingPolicies :: Type -> Type #

Read DescribeSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.DescribeSchedulingPolicies

Show DescribeSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.DescribeSchedulingPolicies

NFData DescribeSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.DescribeSchedulingPolicies

Eq DescribeSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.DescribeSchedulingPolicies

Hashable DescribeSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.DescribeSchedulingPolicies

type AWSResponse DescribeSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.DescribeSchedulingPolicies

type Rep DescribeSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.DescribeSchedulingPolicies

type Rep DescribeSchedulingPolicies = D1 ('MetaData "DescribeSchedulingPolicies" "Amazonka.Batch.DescribeSchedulingPolicies" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "DescribeSchedulingPolicies'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))

newDescribeSchedulingPolicies :: DescribeSchedulingPolicies Source #

Create a value of DescribeSchedulingPolicies with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:arns:DescribeSchedulingPolicies', describeSchedulingPolicies_arns - A list of up to 100 scheduling policy Amazon Resource Name (ARN) entries.

data DescribeSchedulingPoliciesResponse Source #

Instances

Instances details
Generic DescribeSchedulingPoliciesResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeSchedulingPolicies

Associated Types

type Rep DescribeSchedulingPoliciesResponse :: Type -> Type #

Read DescribeSchedulingPoliciesResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeSchedulingPolicies

Show DescribeSchedulingPoliciesResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeSchedulingPolicies

NFData DescribeSchedulingPoliciesResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeSchedulingPolicies

Eq DescribeSchedulingPoliciesResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeSchedulingPolicies

type Rep DescribeSchedulingPoliciesResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeSchedulingPolicies

type Rep DescribeSchedulingPoliciesResponse = D1 ('MetaData "DescribeSchedulingPoliciesResponse" "Amazonka.Batch.DescribeSchedulingPolicies" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "DescribeSchedulingPoliciesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "schedulingPolicies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SchedulingPolicyDetail])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeSchedulingPoliciesResponse Source #

Create a value of DescribeSchedulingPoliciesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:schedulingPolicies:DescribeSchedulingPoliciesResponse', describeSchedulingPoliciesResponse_schedulingPolicies - The list of scheduling policies.

$sel:httpStatus:DescribeSchedulingPoliciesResponse', describeSchedulingPoliciesResponse_httpStatus - The response's http status code.

ListJobs (Paginated)

data ListJobs Source #

Contains the parameters for ListJobs.

See: newListJobs smart constructor.

Instances

Instances details
ToJSON ListJobs Source # 
Instance details

Defined in Amazonka.Batch.ListJobs

ToHeaders ListJobs Source # 
Instance details

Defined in Amazonka.Batch.ListJobs

Methods

toHeaders :: ListJobs -> [Header] #

ToPath ListJobs Source # 
Instance details

Defined in Amazonka.Batch.ListJobs

ToQuery ListJobs Source # 
Instance details

Defined in Amazonka.Batch.ListJobs

AWSPager ListJobs Source # 
Instance details

Defined in Amazonka.Batch.ListJobs

AWSRequest ListJobs Source # 
Instance details

Defined in Amazonka.Batch.ListJobs

Associated Types

type AWSResponse ListJobs #

Generic ListJobs Source # 
Instance details

Defined in Amazonka.Batch.ListJobs

Associated Types

type Rep ListJobs :: Type -> Type #

Methods

from :: ListJobs -> Rep ListJobs x #

to :: Rep ListJobs x -> ListJobs #

Read ListJobs Source # 
Instance details

Defined in Amazonka.Batch.ListJobs

Show ListJobs Source # 
Instance details

Defined in Amazonka.Batch.ListJobs

NFData ListJobs Source # 
Instance details

Defined in Amazonka.Batch.ListJobs

Methods

rnf :: ListJobs -> () #

Eq ListJobs Source # 
Instance details

Defined in Amazonka.Batch.ListJobs

Hashable ListJobs Source # 
Instance details

Defined in Amazonka.Batch.ListJobs

Methods

hashWithSalt :: Int -> ListJobs -> Int #

hash :: ListJobs -> Int #

type AWSResponse ListJobs Source # 
Instance details

Defined in Amazonka.Batch.ListJobs

type Rep ListJobs Source # 
Instance details

Defined in Amazonka.Batch.ListJobs

newListJobs :: ListJobs Source #

Create a value of ListJobs with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:arrayJobId:ListJobs', listJobs_arrayJobId - The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.

$sel:filters:ListJobs', listJobs_filters - The filter to apply to the query. Only one filter can be used at a time. When the filter is used, jobStatus is ignored. The filter doesn't apply to child jobs in an array or multi-node parallel (MNP) jobs. The results are sorted by the createdAt field, with the most recent jobs being first.

JOB_NAME
The value of the filter is a case-insensitive match for the job name. If the value ends with an asterisk (*), the filter matches any job name that begins with the string before the '*'. This corresponds to the jobName value. For example, test1 matches both Test1 and test1, and test1* matches both test1 and Test10. When the JOB_NAME filter is used, the results are grouped by the job name and version.
JOB_DEFINITION
The value for the filter is the name or Amazon Resource Name (ARN) of the job definition. This corresponds to the jobDefinition value. The value is case sensitive. When the value for the filter is the job definition name, the results include all the jobs that used any revision of that job definition name. If the value ends with an asterisk (*), the filter matches any job definition name that begins with the string before the '*'. For example, jd1 matches only jd1, and jd1* matches both jd1 and jd1A. The version of the job definition that's used doesn't affect the sort order. When the JOB_DEFINITION filter is used and the ARN is used (which is in the form arn:${Partition}:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}), the results include jobs that used the specified revision of the job definition. Asterisk (*) isn't supported when the ARN is used.
BEFORE_CREATED_AT
The value for the filter is the time that's before the job was created. This corresponds to the createdAt value. The value is a string representation of the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.
AFTER_CREATED_AT
The value for the filter is the time that's after the job was created. This corresponds to the createdAt value. The value is a string representation of the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.

ListJobs, listJobs_jobQueue - The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.

$sel:jobStatus:ListJobs', listJobs_jobStatus - The job status used to filter jobs in the specified queue. If the filters parameter is specified, the jobStatus parameter is ignored and jobs with any status are returned. If you don't specify a status, only RUNNING jobs are returned.

$sel:maxResults:ListJobs', listJobs_maxResults - The maximum number of results returned by ListJobs in paginated output. When this parameter is used, ListJobs only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another ListJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListJobs returns up to 100 results and a nextToken value if applicable.

$sel:multiNodeJobId:ListJobs', listJobs_multiNodeJobId - The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job.

ListJobs, listJobs_nextToken - The nextToken value returned from a previous paginated ListJobs request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

data ListJobsResponse Source #

See: newListJobsResponse smart constructor.

Instances

Instances details
Generic ListJobsResponse Source # 
Instance details

Defined in Amazonka.Batch.ListJobs

Associated Types

type Rep ListJobsResponse :: Type -> Type #

Read ListJobsResponse Source # 
Instance details

Defined in Amazonka.Batch.ListJobs

Show ListJobsResponse Source # 
Instance details

Defined in Amazonka.Batch.ListJobs

NFData ListJobsResponse Source # 
Instance details

Defined in Amazonka.Batch.ListJobs

Methods

rnf :: ListJobsResponse -> () #

Eq ListJobsResponse Source # 
Instance details

Defined in Amazonka.Batch.ListJobs

type Rep ListJobsResponse Source # 
Instance details

Defined in Amazonka.Batch.ListJobs

type Rep ListJobsResponse = D1 ('MetaData "ListJobsResponse" "Amazonka.Batch.ListJobs" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "ListJobsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "jobSummaryList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [JobSummary]))))

newListJobsResponse Source #

Create a value of ListJobsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListJobs, listJobsResponse_nextToken - The nextToken value to include in a future ListJobs request. When the results of a ListJobs request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

$sel:httpStatus:ListJobsResponse', listJobsResponse_httpStatus - The response's http status code.

$sel:jobSummaryList:ListJobsResponse', listJobsResponse_jobSummaryList - A list of job summaries that match the request.

ListSchedulingPolicies (Paginated)

data ListSchedulingPolicies Source #

Contains the parameters for ListSchedulingPolicies.

See: newListSchedulingPolicies smart constructor.

Instances

Instances details
ToJSON ListSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

ToHeaders ListSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

ToPath ListSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

ToQuery ListSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

AWSPager ListSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

AWSRequest ListSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

Associated Types

type AWSResponse ListSchedulingPolicies #

Generic ListSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

Associated Types

type Rep ListSchedulingPolicies :: Type -> Type #

Read ListSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

Show ListSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

NFData ListSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

Methods

rnf :: ListSchedulingPolicies -> () #

Eq ListSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

Hashable ListSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

type AWSResponse ListSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

type Rep ListSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

type Rep ListSchedulingPolicies = D1 ('MetaData "ListSchedulingPolicies" "Amazonka.Batch.ListSchedulingPolicies" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "ListSchedulingPolicies'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListSchedulingPolicies :: ListSchedulingPolicies Source #

Create a value of ListSchedulingPolicies with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:maxResults:ListSchedulingPolicies', listSchedulingPolicies_maxResults - The maximum number of results that's returned by ListSchedulingPolicies in paginated output. When this parameter is used, ListSchedulingPolicies only returns maxResults results in a single page and a nextToken response element. You can see the remaining results of the initial request by sending another ListSchedulingPolicies request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, ListSchedulingPolicies returns up to 100 results and a nextToken value if applicable.

ListSchedulingPolicies, listSchedulingPolicies_nextToken - The nextToken value that's returned from a previous paginated ListSchedulingPolicies request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

data ListSchedulingPoliciesResponse Source #

See: newListSchedulingPoliciesResponse smart constructor.

Instances

Instances details
Generic ListSchedulingPoliciesResponse Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

Associated Types

type Rep ListSchedulingPoliciesResponse :: Type -> Type #

Read ListSchedulingPoliciesResponse Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

Show ListSchedulingPoliciesResponse Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

NFData ListSchedulingPoliciesResponse Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

Eq ListSchedulingPoliciesResponse Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

type Rep ListSchedulingPoliciesResponse Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

type Rep ListSchedulingPoliciesResponse = D1 ('MetaData "ListSchedulingPoliciesResponse" "Amazonka.Batch.ListSchedulingPolicies" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "ListSchedulingPoliciesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "schedulingPolicies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SchedulingPolicyListingDetail])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListSchedulingPoliciesResponse Source #

Create a value of ListSchedulingPoliciesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListSchedulingPolicies, listSchedulingPoliciesResponse_nextToken - The nextToken value to include in a future ListSchedulingPolicies request. When the results of a ListSchedulingPolicies request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

$sel:schedulingPolicies:ListSchedulingPoliciesResponse', listSchedulingPoliciesResponse_schedulingPolicies - A list of scheduling policies that match the request.

$sel:httpStatus:ListSchedulingPoliciesResponse', listSchedulingPoliciesResponse_httpStatus - The response's http status code.

ListTagsForResource

data ListTagsForResource Source #

Contains the parameters for ListTagsForResource.

See: newListTagsForResource smart constructor.

Instances

Instances details
ToHeaders ListTagsForResource Source # 
Instance details

Defined in Amazonka.Batch.ListTagsForResource

ToPath ListTagsForResource Source # 
Instance details

Defined in Amazonka.Batch.ListTagsForResource

ToQuery ListTagsForResource Source # 
Instance details

Defined in Amazonka.Batch.ListTagsForResource

AWSRequest ListTagsForResource Source # 
Instance details

Defined in Amazonka.Batch.ListTagsForResource

Associated Types

type AWSResponse ListTagsForResource #

Generic ListTagsForResource Source # 
Instance details

Defined in Amazonka.Batch.ListTagsForResource

Associated Types

type Rep ListTagsForResource :: Type -> Type #

Read ListTagsForResource Source # 
Instance details

Defined in Amazonka.Batch.ListTagsForResource

Show ListTagsForResource Source # 
Instance details

Defined in Amazonka.Batch.ListTagsForResource

NFData ListTagsForResource Source # 
Instance details

Defined in Amazonka.Batch.ListTagsForResource

Methods

rnf :: ListTagsForResource -> () #

Eq ListTagsForResource Source # 
Instance details

Defined in Amazonka.Batch.ListTagsForResource

Hashable ListTagsForResource Source # 
Instance details

Defined in Amazonka.Batch.ListTagsForResource

type AWSResponse ListTagsForResource Source # 
Instance details

Defined in Amazonka.Batch.ListTagsForResource

type Rep ListTagsForResource Source # 
Instance details

Defined in Amazonka.Batch.ListTagsForResource

type Rep ListTagsForResource = D1 ('MetaData "ListTagsForResource" "Amazonka.Batch.ListTagsForResource" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "ListTagsForResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newListTagsForResource Source #

Create a value of ListTagsForResource with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:resourceArn:ListTagsForResource', listTagsForResource_resourceArn - The Amazon Resource Name (ARN) that identifies the resource that tags are listed for. Batch resources that support tags are compute environments, jobs, job definitions, job queues, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.

data ListTagsForResourceResponse Source #

See: newListTagsForResourceResponse smart constructor.

Instances

Instances details
Generic ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.Batch.ListTagsForResource

Associated Types

type Rep ListTagsForResourceResponse :: Type -> Type #

Read ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.Batch.ListTagsForResource

Show ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.Batch.ListTagsForResource

NFData ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.Batch.ListTagsForResource

Eq ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.Batch.ListTagsForResource

type Rep ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.Batch.ListTagsForResource

type Rep ListTagsForResourceResponse = D1 ('MetaData "ListTagsForResourceResponse" "Amazonka.Batch.ListTagsForResource" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "ListTagsForResourceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newListTagsForResourceResponse Source #

Create a value of ListTagsForResourceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListTagsForResourceResponse, listTagsForResourceResponse_tags - The tags for the resource.

$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.

RegisterJobDefinition

data RegisterJobDefinition Source #

Contains the parameters for RegisterJobDefinition.

See: newRegisterJobDefinition smart constructor.

Instances

Instances details
ToJSON RegisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.RegisterJobDefinition

ToHeaders RegisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.RegisterJobDefinition

ToPath RegisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.RegisterJobDefinition

ToQuery RegisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.RegisterJobDefinition

AWSRequest RegisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.RegisterJobDefinition

Associated Types

type AWSResponse RegisterJobDefinition #

Generic RegisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.RegisterJobDefinition

Associated Types

type Rep RegisterJobDefinition :: Type -> Type #

Read RegisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.RegisterJobDefinition

Show RegisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.RegisterJobDefinition

NFData RegisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.RegisterJobDefinition

Methods

rnf :: RegisterJobDefinition -> () #

Eq RegisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.RegisterJobDefinition

Hashable RegisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.RegisterJobDefinition

type AWSResponse RegisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.RegisterJobDefinition

type Rep RegisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.RegisterJobDefinition

type Rep RegisterJobDefinition = D1 ('MetaData "RegisterJobDefinition" "Amazonka.Batch.RegisterJobDefinition" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "RegisterJobDefinition'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "containerProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContainerProperties)) :*: (S1 ('MetaSel ('Just "eksProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EksProperties)) :*: S1 ('MetaSel ('Just "nodeProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NodeProperties)))) :*: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "platformCapabilities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PlatformCapability])) :*: S1 ('MetaSel ('Just "propagateTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :*: ((S1 ('MetaSel ('Just "retryStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RetryStrategy)) :*: (S1 ('MetaSel ('Just "schedulingPriority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :*: (S1 ('MetaSel ('Just "timeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobTimeout)) :*: (S1 ('MetaSel ('Just "jobDefinitionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JobDefinitionType))))))

newRegisterJobDefinition Source #

Create a value of RegisterJobDefinition with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

RegisterJobDefinition, registerJobDefinition_containerProperties - An object with various properties specific to Amazon ECS based single-node container-based jobs. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties. This must not be specified for Amazon EKS based job definitions.

If the job runs on Fargate resources, then you must not specify nodeProperties; use only containerProperties.

RegisterJobDefinition, registerJobDefinition_eksProperties - An object with various properties that are specific to Amazon EKS based jobs. This must not be specified for Amazon ECS based job definitions.

RegisterJobDefinition, registerJobDefinition_nodeProperties - An object with various properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the Batch User Guide. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

If the job runs on Fargate resources, then you must not specify nodeProperties; use containerProperties instead.

If the job runs on Amazon EKS resources, then you must not specify nodeProperties.

RegisterJobDefinition, registerJobDefinition_parameters - Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

RegisterJobDefinition, registerJobDefinition_platformCapabilities - The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. To run the job on Fargate resources, specify FARGATE.

If the job runs on Amazon EKS resources, then you must not specify platformCapabilities.

RegisterJobDefinition, registerJobDefinition_propagateTags - 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 are not 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.

If the job runs on Amazon EKS resources, then you must not specify propagateTags.

RegisterJobDefinition, registerJobDefinition_retryStrategy - The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that's specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it isn't retried.

RegisterJobDefinition, registerJobDefinition_schedulingPriority - The scheduling priority for jobs that are submitted with this job definition. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.

The minimum supported value is 0 and the maximum supported value is 9999.

RegisterJobDefinition, registerJobDefinition_tags - The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Batch User Guide.

RegisterJobDefinition, registerJobDefinition_timeout - The timeout configuration for jobs that are submitted with this job definition, after which Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that's specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the Batch User Guide.

RegisterJobDefinition, registerJobDefinition_jobDefinitionName - The name of the job definition to register. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

RegisterJobDefinition, registerJobDefinition_type - The type of job definition. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Batch User Guide.

If the job is run on Fargate resources, then multinode isn't supported.

data RegisterJobDefinitionResponse Source #

See: newRegisterJobDefinitionResponse smart constructor.

Instances

Instances details
Generic RegisterJobDefinitionResponse Source # 
Instance details

Defined in Amazonka.Batch.RegisterJobDefinition

Associated Types

type Rep RegisterJobDefinitionResponse :: Type -> Type #

Read RegisterJobDefinitionResponse Source # 
Instance details

Defined in Amazonka.Batch.RegisterJobDefinition

Show RegisterJobDefinitionResponse Source # 
Instance details

Defined in Amazonka.Batch.RegisterJobDefinition

NFData RegisterJobDefinitionResponse Source # 
Instance details

Defined in Amazonka.Batch.RegisterJobDefinition

Eq RegisterJobDefinitionResponse Source # 
Instance details

Defined in Amazonka.Batch.RegisterJobDefinition

type Rep RegisterJobDefinitionResponse Source # 
Instance details

Defined in Amazonka.Batch.RegisterJobDefinition

type Rep RegisterJobDefinitionResponse = D1 ('MetaData "RegisterJobDefinitionResponse" "Amazonka.Batch.RegisterJobDefinition" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "RegisterJobDefinitionResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "jobDefinitionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "jobDefinitionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "revision") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newRegisterJobDefinitionResponse Source #

Create a value of RegisterJobDefinitionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:RegisterJobDefinitionResponse', registerJobDefinitionResponse_httpStatus - The response's http status code.

RegisterJobDefinition, registerJobDefinitionResponse_jobDefinitionName - The name of the job definition.

RegisterJobDefinitionResponse, registerJobDefinitionResponse_jobDefinitionArn - The Amazon Resource Name (ARN) of the job definition.

RegisterJobDefinitionResponse, registerJobDefinitionResponse_revision - The revision of the job definition.

SubmitJob

data SubmitJob Source #

Contains the parameters for SubmitJob.

See: newSubmitJob smart constructor.

Instances

Instances details
ToJSON SubmitJob Source # 
Instance details

Defined in Amazonka.Batch.SubmitJob

ToHeaders SubmitJob Source # 
Instance details

Defined in Amazonka.Batch.SubmitJob

Methods

toHeaders :: SubmitJob -> [Header] #

ToPath SubmitJob Source # 
Instance details

Defined in Amazonka.Batch.SubmitJob

ToQuery SubmitJob Source # 
Instance details

Defined in Amazonka.Batch.SubmitJob

AWSRequest SubmitJob Source # 
Instance details

Defined in Amazonka.Batch.SubmitJob

Associated Types

type AWSResponse SubmitJob #

Generic SubmitJob Source # 
Instance details

Defined in Amazonka.Batch.SubmitJob

Associated Types

type Rep SubmitJob :: Type -> Type #

Read SubmitJob Source # 
Instance details

Defined in Amazonka.Batch.SubmitJob

Show SubmitJob Source # 
Instance details

Defined in Amazonka.Batch.SubmitJob

NFData SubmitJob Source # 
Instance details

Defined in Amazonka.Batch.SubmitJob

Methods

rnf :: SubmitJob -> () #

Eq SubmitJob Source # 
Instance details

Defined in Amazonka.Batch.SubmitJob

Hashable SubmitJob Source # 
Instance details

Defined in Amazonka.Batch.SubmitJob

type AWSResponse SubmitJob Source # 
Instance details

Defined in Amazonka.Batch.SubmitJob

type Rep SubmitJob Source # 
Instance details

Defined in Amazonka.Batch.SubmitJob

type Rep SubmitJob = D1 ('MetaData "SubmitJob" "Amazonka.Batch.SubmitJob" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "SubmitJob'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arrayProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ArrayProperties)) :*: (S1 ('MetaSel ('Just "containerOverrides") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContainerOverrides)) :*: S1 ('MetaSel ('Just "dependsOn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [JobDependency])))) :*: ((S1 ('MetaSel ('Just "eksPropertiesOverride") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EksPropertiesOverride)) :*: S1 ('MetaSel ('Just "nodeOverrides") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NodeOverrides))) :*: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "propagateTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :*: (((S1 ('MetaSel ('Just "retryStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RetryStrategy)) :*: S1 ('MetaSel ('Just "schedulingPriorityOverride") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "shareIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :*: ((S1 ('MetaSel ('Just "timeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobTimeout)) :*: S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "jobQueue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "jobDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newSubmitJob Source #

Create a value of SubmitJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

SubmitJob, submitJob_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 Batch User Guide.

SubmitJob, submitJob_containerOverrides - An object with various properties that override the defaults for the job definition 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.

SubmitJob, submitJob_dependsOn - 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.

$sel:eksPropertiesOverride:SubmitJob', submitJob_eksPropertiesOverride - An object that can only be specified for jobs that are run on Amazon EKS resources with various properties that override defaults for the job definition.

$sel:nodeOverrides:SubmitJob', submitJob_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 that are running on Fargate resources; use containerOverrides instead.

SubmitJob, submitJob_parameters - 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.

SubmitJob, submitJob_propagateTags - 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.

SubmitJob, submitJob_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.

$sel:schedulingPriorityOverride:SubmitJob', submitJob_schedulingPriorityOverride - The scheduling priority for the job. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority. This overrides any scheduling priority in the job definition.

The minimum supported value is 0 and the maximum supported value is 9999.

SubmitJob, submitJob_shareIdentifier - The share identifier for the job. If the job queue doesn't have a scheduling policy, then this parameter must not be specified. If the job queue has a scheduling policy, then this parameter must be specified.

SubmitJob, submitJob_tags - 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 Amazon Web Services Resources in Amazon Web Services General Reference.

SubmitJob, submitJob_timeout - The timeout configuration for this SubmitJob operation. You can specify a timeout duration after which 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 in the Amazon Elastic Container Service Developer Guide.

SubmitJob, submitJob_jobName - 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 (_).

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

SubmitJob, submitJob_jobDefinition - 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.

data SubmitJobResponse Source #

See: newSubmitJobResponse smart constructor.

Instances

Instances details
Generic SubmitJobResponse Source # 
Instance details

Defined in Amazonka.Batch.SubmitJob

Associated Types

type Rep SubmitJobResponse :: Type -> Type #

Read SubmitJobResponse Source # 
Instance details

Defined in Amazonka.Batch.SubmitJob

Show SubmitJobResponse Source # 
Instance details

Defined in Amazonka.Batch.SubmitJob

NFData SubmitJobResponse Source # 
Instance details

Defined in Amazonka.Batch.SubmitJob

Methods

rnf :: SubmitJobResponse -> () #

Eq SubmitJobResponse Source # 
Instance details

Defined in Amazonka.Batch.SubmitJob

type Rep SubmitJobResponse Source # 
Instance details

Defined in Amazonka.Batch.SubmitJob

type Rep SubmitJobResponse = D1 ('MetaData "SubmitJobResponse" "Amazonka.Batch.SubmitJob" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "SubmitJobResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "jobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newSubmitJobResponse Source #

Create a value of SubmitJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

SubmitJobResponse, submitJobResponse_jobArn - The Amazon Resource Name (ARN) for the job.

$sel:httpStatus:SubmitJobResponse', submitJobResponse_httpStatus - The response's http status code.

SubmitJob, submitJobResponse_jobName - The name of the job.

SubmitJobResponse, submitJobResponse_jobId - The unique identifier for the job.

TagResource

data TagResource Source #

Contains the parameters for TagResource.

See: newTagResource smart constructor.

Instances

Instances details
ToJSON TagResource Source # 
Instance details

Defined in Amazonka.Batch.TagResource

ToHeaders TagResource Source # 
Instance details

Defined in Amazonka.Batch.TagResource

Methods

toHeaders :: TagResource -> [Header] #

ToPath TagResource Source # 
Instance details

Defined in Amazonka.Batch.TagResource

ToQuery TagResource Source # 
Instance details

Defined in Amazonka.Batch.TagResource

AWSRequest TagResource Source # 
Instance details

Defined in Amazonka.Batch.TagResource

Associated Types

type AWSResponse TagResource #

Generic TagResource Source # 
Instance details

Defined in Amazonka.Batch.TagResource

Associated Types

type Rep TagResource :: Type -> Type #

Read TagResource Source # 
Instance details

Defined in Amazonka.Batch.TagResource

Show TagResource Source # 
Instance details

Defined in Amazonka.Batch.TagResource

NFData TagResource Source # 
Instance details

Defined in Amazonka.Batch.TagResource

Methods

rnf :: TagResource -> () #

Eq TagResource Source # 
Instance details

Defined in Amazonka.Batch.TagResource

Hashable TagResource Source # 
Instance details

Defined in Amazonka.Batch.TagResource

type AWSResponse TagResource Source # 
Instance details

Defined in Amazonka.Batch.TagResource

type Rep TagResource Source # 
Instance details

Defined in Amazonka.Batch.TagResource

type Rep TagResource = D1 ('MetaData "TagResource" "Amazonka.Batch.TagResource" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "TagResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Text))))

newTagResource Source #

Create a value of TagResource with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:resourceArn:TagResource', tagResource_resourceArn - The Amazon Resource Name (ARN) of the resource that tags are added to. Batch resources that support tags are compute environments, jobs, job definitions, job queues, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.

TagResource, tagResource_tags - The tags that you apply to the resource to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General Reference.

data TagResourceResponse Source #

See: newTagResourceResponse smart constructor.

Instances

Instances details
Generic TagResourceResponse Source # 
Instance details

Defined in Amazonka.Batch.TagResource

Associated Types

type Rep TagResourceResponse :: Type -> Type #

Read TagResourceResponse Source # 
Instance details

Defined in Amazonka.Batch.TagResource

Show TagResourceResponse Source # 
Instance details

Defined in Amazonka.Batch.TagResource

NFData TagResourceResponse Source # 
Instance details

Defined in Amazonka.Batch.TagResource

Methods

rnf :: TagResourceResponse -> () #

Eq TagResourceResponse Source # 
Instance details

Defined in Amazonka.Batch.TagResource

type Rep TagResourceResponse Source # 
Instance details

Defined in Amazonka.Batch.TagResource

type Rep TagResourceResponse = D1 ('MetaData "TagResourceResponse" "Amazonka.Batch.TagResource" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "TagResourceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newTagResourceResponse Source #

Create a value of TagResourceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.

TerminateJob

data TerminateJob Source #

Contains the parameters for TerminateJob.

See: newTerminateJob smart constructor.

Constructors

TerminateJob' Text Text 

Instances

Instances details
ToJSON TerminateJob Source # 
Instance details

Defined in Amazonka.Batch.TerminateJob

ToHeaders TerminateJob Source # 
Instance details

Defined in Amazonka.Batch.TerminateJob

ToPath TerminateJob Source # 
Instance details

Defined in Amazonka.Batch.TerminateJob

ToQuery TerminateJob Source # 
Instance details

Defined in Amazonka.Batch.TerminateJob

AWSRequest TerminateJob Source # 
Instance details

Defined in Amazonka.Batch.TerminateJob

Associated Types

type AWSResponse TerminateJob #

Generic TerminateJob Source # 
Instance details

Defined in Amazonka.Batch.TerminateJob

Associated Types

type Rep TerminateJob :: Type -> Type #

Read TerminateJob Source # 
Instance details

Defined in Amazonka.Batch.TerminateJob

Show TerminateJob Source # 
Instance details

Defined in Amazonka.Batch.TerminateJob

NFData TerminateJob Source # 
Instance details

Defined in Amazonka.Batch.TerminateJob

Methods

rnf :: TerminateJob -> () #

Eq TerminateJob Source # 
Instance details

Defined in Amazonka.Batch.TerminateJob

Hashable TerminateJob Source # 
Instance details

Defined in Amazonka.Batch.TerminateJob

type AWSResponse TerminateJob Source # 
Instance details

Defined in Amazonka.Batch.TerminateJob

type Rep TerminateJob Source # 
Instance details

Defined in Amazonka.Batch.TerminateJob

type Rep TerminateJob = D1 ('MetaData "TerminateJob" "Amazonka.Batch.TerminateJob" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "TerminateJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newTerminateJob Source #

Create a value of TerminateJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

TerminateJob, terminateJob_jobId - The Batch job ID of the job to terminate.

TerminateJob, terminateJob_reason - A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the Batch activity logs.

data TerminateJobResponse Source #

See: newTerminateJobResponse smart constructor.

Instances

Instances details
Generic TerminateJobResponse Source # 
Instance details

Defined in Amazonka.Batch.TerminateJob

Associated Types

type Rep TerminateJobResponse :: Type -> Type #

Read TerminateJobResponse Source # 
Instance details

Defined in Amazonka.Batch.TerminateJob

Show TerminateJobResponse Source # 
Instance details

Defined in Amazonka.Batch.TerminateJob

NFData TerminateJobResponse Source # 
Instance details

Defined in Amazonka.Batch.TerminateJob

Methods

rnf :: TerminateJobResponse -> () #

Eq TerminateJobResponse Source # 
Instance details

Defined in Amazonka.Batch.TerminateJob

type Rep TerminateJobResponse Source # 
Instance details

Defined in Amazonka.Batch.TerminateJob

type Rep TerminateJobResponse = D1 ('MetaData "TerminateJobResponse" "Amazonka.Batch.TerminateJob" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "TerminateJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newTerminateJobResponse Source #

Create a value of TerminateJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:TerminateJobResponse', terminateJobResponse_httpStatus - The response's http status code.

UntagResource

data UntagResource Source #

Contains the parameters for UntagResource.

See: newUntagResource smart constructor.

Instances

Instances details
ToHeaders UntagResource Source # 
Instance details

Defined in Amazonka.Batch.UntagResource

ToPath UntagResource Source # 
Instance details

Defined in Amazonka.Batch.UntagResource

ToQuery UntagResource Source # 
Instance details

Defined in Amazonka.Batch.UntagResource

AWSRequest UntagResource Source # 
Instance details

Defined in Amazonka.Batch.UntagResource

Associated Types

type AWSResponse UntagResource #

Generic UntagResource Source # 
Instance details

Defined in Amazonka.Batch.UntagResource

Associated Types

type Rep UntagResource :: Type -> Type #

Read UntagResource Source # 
Instance details

Defined in Amazonka.Batch.UntagResource

Show UntagResource Source # 
Instance details

Defined in Amazonka.Batch.UntagResource

NFData UntagResource Source # 
Instance details

Defined in Amazonka.Batch.UntagResource

Methods

rnf :: UntagResource -> () #

Eq UntagResource Source # 
Instance details

Defined in Amazonka.Batch.UntagResource

Hashable UntagResource Source # 
Instance details

Defined in Amazonka.Batch.UntagResource

type AWSResponse UntagResource Source # 
Instance details

Defined in Amazonka.Batch.UntagResource

type Rep UntagResource Source # 
Instance details

Defined in Amazonka.Batch.UntagResource

type Rep UntagResource = D1 ('MetaData "UntagResource" "Amazonka.Batch.UntagResource" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "UntagResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tagKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text))))

newUntagResource Source #

Create a value of UntagResource with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:resourceArn:UntagResource', untagResource_resourceArn - The Amazon Resource Name (ARN) of the resource from which to delete tags. Batch resources that support tags are compute environments, jobs, job definitions, job queues, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.

$sel:tagKeys:UntagResource', untagResource_tagKeys - The keys of the tags to be removed.

data UntagResourceResponse Source #

See: newUntagResourceResponse smart constructor.

Instances

Instances details
Generic UntagResourceResponse Source # 
Instance details

Defined in Amazonka.Batch.UntagResource

Associated Types

type Rep UntagResourceResponse :: Type -> Type #

Read UntagResourceResponse Source # 
Instance details

Defined in Amazonka.Batch.UntagResource

Show UntagResourceResponse Source # 
Instance details

Defined in Amazonka.Batch.UntagResource

NFData UntagResourceResponse Source # 
Instance details

Defined in Amazonka.Batch.UntagResource

Methods

rnf :: UntagResourceResponse -> () #

Eq UntagResourceResponse Source # 
Instance details

Defined in Amazonka.Batch.UntagResource

type Rep UntagResourceResponse Source # 
Instance details

Defined in Amazonka.Batch.UntagResource

type Rep UntagResourceResponse = D1 ('MetaData "UntagResourceResponse" "Amazonka.Batch.UntagResource" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "UntagResourceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUntagResourceResponse Source #

Create a value of UntagResourceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.

UpdateComputeEnvironment

data UpdateComputeEnvironment Source #

Contains the parameters for UpdateComputeEnvironment.

See: newUpdateComputeEnvironment smart constructor.

Instances

Instances details
ToJSON UpdateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.UpdateComputeEnvironment

ToHeaders UpdateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.UpdateComputeEnvironment

ToPath UpdateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.UpdateComputeEnvironment

ToQuery UpdateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.UpdateComputeEnvironment

AWSRequest UpdateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.UpdateComputeEnvironment

Generic UpdateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.UpdateComputeEnvironment

Associated Types

type Rep UpdateComputeEnvironment :: Type -> Type #

Read UpdateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.UpdateComputeEnvironment

Show UpdateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.UpdateComputeEnvironment

NFData UpdateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.UpdateComputeEnvironment

Eq UpdateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.UpdateComputeEnvironment

Hashable UpdateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.UpdateComputeEnvironment

type AWSResponse UpdateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.UpdateComputeEnvironment

type Rep UpdateComputeEnvironment Source # 
Instance details

Defined in Amazonka.Batch.UpdateComputeEnvironment

type Rep UpdateComputeEnvironment = D1 ('MetaData "UpdateComputeEnvironment" "Amazonka.Batch.UpdateComputeEnvironment" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "UpdateComputeEnvironment'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "computeResources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ComputeResourceUpdate)) :*: (S1 ('MetaSel ('Just "serviceRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CEState)))) :*: (S1 ('MetaSel ('Just "unmanagedvCpus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "updatePolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UpdatePolicy)) :*: S1 ('MetaSel ('Just "computeEnvironment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateComputeEnvironment Source #

Create a value of UpdateComputeEnvironment with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateComputeEnvironment, updateComputeEnvironment_computeResources - Details of the compute resources managed by the compute environment. Required for a managed compute environment. For more information, see Compute Environments in the Batch User Guide.

UpdateComputeEnvironment, updateComputeEnvironment_serviceRole - The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf. For more information, see Batch service IAM role in the Batch User Guide.

If the compute environment has a service-linked role, it can't be changed to use a regular IAM role. Likewise, if the compute environment has a regular IAM role, it can't be changed to use a service-linked role. To update the parameters for the compute environment that require an infrastructure update to change, the AWSServiceRoleForBatch service-linked role must be used. For more information, see Updating compute environments in the Batch User Guide.

If your specified role has a path other than /, then you must either specify the full role ARN (recommended) or prefix the role name with the path.

Depending on how you created your Batch service role, its ARN might contain the service-role path prefix. When you only specify the name of the service role, Batch assumes that your ARN doesn't use the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.

UpdateComputeEnvironment, updateComputeEnvironment_state - The state of the compute environment. Compute environments in the ENABLED state can accept jobs from a queue and scale in or out automatically based on the workload demand of its associated queues.

If the state is ENABLED, then the Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.

If the state is DISABLED, then the Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state don't scale out. However, they scale in to minvCpus value after instances become idle.

UpdateComputeEnvironment, updateComputeEnvironment_unmanagedvCpus - The maximum number of vCPUs expected to be used for an unmanaged compute environment. Don't specify this parameter for a managed compute environment. This parameter is only used for fair share scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn't provided for a fair share job queue, no vCPU capacity is reserved.

UpdateComputeEnvironment, updateComputeEnvironment_updatePolicy - Specifies the updated infrastructure update policy for the compute environment. For more information about infrastructure updates, see Updating compute environments in the Batch User Guide.

UpdateComputeEnvironment, updateComputeEnvironment_computeEnvironment - The name or full Amazon Resource Name (ARN) of the compute environment to update.

data UpdateComputeEnvironmentResponse Source #

See: newUpdateComputeEnvironmentResponse smart constructor.

Instances

Instances details
Generic UpdateComputeEnvironmentResponse Source # 
Instance details

Defined in Amazonka.Batch.UpdateComputeEnvironment

Associated Types

type Rep UpdateComputeEnvironmentResponse :: Type -> Type #

Read UpdateComputeEnvironmentResponse Source # 
Instance details

Defined in Amazonka.Batch.UpdateComputeEnvironment

Show UpdateComputeEnvironmentResponse Source # 
Instance details

Defined in Amazonka.Batch.UpdateComputeEnvironment

NFData UpdateComputeEnvironmentResponse Source # 
Instance details

Defined in Amazonka.Batch.UpdateComputeEnvironment

Eq UpdateComputeEnvironmentResponse Source # 
Instance details

Defined in Amazonka.Batch.UpdateComputeEnvironment

type Rep UpdateComputeEnvironmentResponse Source # 
Instance details

Defined in Amazonka.Batch.UpdateComputeEnvironment

type Rep UpdateComputeEnvironmentResponse = D1 ('MetaData "UpdateComputeEnvironmentResponse" "Amazonka.Batch.UpdateComputeEnvironment" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "UpdateComputeEnvironmentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "computeEnvironmentArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "computeEnvironmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newUpdateComputeEnvironmentResponse Source #

Create a value of UpdateComputeEnvironmentResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateComputeEnvironmentResponse, updateComputeEnvironmentResponse_computeEnvironmentArn - The Amazon Resource Name (ARN) of the compute environment.

UpdateComputeEnvironmentResponse, updateComputeEnvironmentResponse_computeEnvironmentName - The name of the compute environment. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

$sel:httpStatus:UpdateComputeEnvironmentResponse', updateComputeEnvironmentResponse_httpStatus - The response's http status code.

UpdateJobQueue

data UpdateJobQueue Source #

Contains the parameters for UpdateJobQueue.

See: newUpdateJobQueue smart constructor.

Instances

Instances details
ToJSON UpdateJobQueue Source # 
Instance details

Defined in Amazonka.Batch.UpdateJobQueue

ToHeaders UpdateJobQueue Source # 
Instance details

Defined in Amazonka.Batch.UpdateJobQueue

ToPath UpdateJobQueue Source # 
Instance details

Defined in Amazonka.Batch.UpdateJobQueue

ToQuery UpdateJobQueue Source # 
Instance details

Defined in Amazonka.Batch.UpdateJobQueue

AWSRequest UpdateJobQueue Source # 
Instance details

Defined in Amazonka.Batch.UpdateJobQueue

Associated Types

type AWSResponse UpdateJobQueue #

Generic UpdateJobQueue Source # 
Instance details

Defined in Amazonka.Batch.UpdateJobQueue

Associated Types

type Rep UpdateJobQueue :: Type -> Type #

Read UpdateJobQueue Source # 
Instance details

Defined in Amazonka.Batch.UpdateJobQueue

Show UpdateJobQueue Source # 
Instance details

Defined in Amazonka.Batch.UpdateJobQueue

NFData UpdateJobQueue Source # 
Instance details

Defined in Amazonka.Batch.UpdateJobQueue

Methods

rnf :: UpdateJobQueue -> () #

Eq UpdateJobQueue Source # 
Instance details

Defined in Amazonka.Batch.UpdateJobQueue

Hashable UpdateJobQueue Source # 
Instance details

Defined in Amazonka.Batch.UpdateJobQueue

type AWSResponse UpdateJobQueue Source # 
Instance details

Defined in Amazonka.Batch.UpdateJobQueue

type Rep UpdateJobQueue Source # 
Instance details

Defined in Amazonka.Batch.UpdateJobQueue

type Rep UpdateJobQueue = D1 ('MetaData "UpdateJobQueue" "Amazonka.Batch.UpdateJobQueue" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "UpdateJobQueue'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "computeEnvironmentOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ComputeEnvironmentOrder])) :*: S1 ('MetaSel ('Just "priority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "schedulingPolicyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JQState)) :*: S1 ('MetaSel ('Just "jobQueue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateJobQueue Source #

Create a value of UpdateJobQueue with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateJobQueue, updateJobQueue_computeEnvironmentOrder - Details the set of compute environments mapped to a job queue and their order relative to each other. This is one of the parameters used by the job scheduler to determine which compute environment runs a given job. Compute environments must be in the VALID state before you can associate them with a job queue. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed.

All compute environments that are associated with a job queue must share the same architecture. Batch doesn't support mixing compute environment architecture types in a single job queue.

UpdateJobQueue, updateJobQueue_priority - The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order. For example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed.

UpdateJobQueue, updateJobQueue_schedulingPolicyArn - Amazon Resource Name (ARN) of the fair share scheduling policy. Once a job queue is created, the fair share scheduling policy can be replaced but not removed. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.

UpdateJobQueue, updateJobQueue_state - Describes the queue's ability to accept new jobs. If the job queue state is ENABLED, it can accept jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs already in the queue can finish.

UpdateJobQueue, updateJobQueue_jobQueue - The name or the Amazon Resource Name (ARN) of the job queue.

data UpdateJobQueueResponse Source #

See: newUpdateJobQueueResponse smart constructor.

Instances

Instances details
Generic UpdateJobQueueResponse Source # 
Instance details

Defined in Amazonka.Batch.UpdateJobQueue

Associated Types

type Rep UpdateJobQueueResponse :: Type -> Type #

Read UpdateJobQueueResponse Source # 
Instance details

Defined in Amazonka.Batch.UpdateJobQueue

Show UpdateJobQueueResponse Source # 
Instance details

Defined in Amazonka.Batch.UpdateJobQueue

NFData UpdateJobQueueResponse Source # 
Instance details

Defined in Amazonka.Batch.UpdateJobQueue

Methods

rnf :: UpdateJobQueueResponse -> () #

Eq UpdateJobQueueResponse Source # 
Instance details

Defined in Amazonka.Batch.UpdateJobQueue

type Rep UpdateJobQueueResponse Source # 
Instance details

Defined in Amazonka.Batch.UpdateJobQueue

type Rep UpdateJobQueueResponse = D1 ('MetaData "UpdateJobQueueResponse" "Amazonka.Batch.UpdateJobQueue" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "UpdateJobQueueResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobQueueArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "jobQueueName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newUpdateJobQueueResponse Source #

Create a value of UpdateJobQueueResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateJobQueueResponse, updateJobQueueResponse_jobQueueArn - The Amazon Resource Name (ARN) of the job queue.

UpdateJobQueueResponse, updateJobQueueResponse_jobQueueName - The name of the job queue.

$sel:httpStatus:UpdateJobQueueResponse', updateJobQueueResponse_httpStatus - The response's http status code.

UpdateSchedulingPolicy

data UpdateSchedulingPolicy Source #

Contains the parameters for UpdateSchedulingPolicy.

See: newUpdateSchedulingPolicy smart constructor.

Instances

Instances details
ToJSON UpdateSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.UpdateSchedulingPolicy

ToHeaders UpdateSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.UpdateSchedulingPolicy

ToPath UpdateSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.UpdateSchedulingPolicy

ToQuery UpdateSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.UpdateSchedulingPolicy

AWSRequest UpdateSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.UpdateSchedulingPolicy

Associated Types

type AWSResponse UpdateSchedulingPolicy #

Generic UpdateSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.UpdateSchedulingPolicy

Associated Types

type Rep UpdateSchedulingPolicy :: Type -> Type #

Read UpdateSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.UpdateSchedulingPolicy

Show UpdateSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.UpdateSchedulingPolicy

NFData UpdateSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.UpdateSchedulingPolicy

Methods

rnf :: UpdateSchedulingPolicy -> () #

Eq UpdateSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.UpdateSchedulingPolicy

Hashable UpdateSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.UpdateSchedulingPolicy

type AWSResponse UpdateSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.UpdateSchedulingPolicy

type Rep UpdateSchedulingPolicy Source # 
Instance details

Defined in Amazonka.Batch.UpdateSchedulingPolicy

type Rep UpdateSchedulingPolicy = D1 ('MetaData "UpdateSchedulingPolicy" "Amazonka.Batch.UpdateSchedulingPolicy" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "UpdateSchedulingPolicy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fairsharePolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FairsharePolicy)) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newUpdateSchedulingPolicy Source #

Create a value of UpdateSchedulingPolicy with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateSchedulingPolicy, updateSchedulingPolicy_fairsharePolicy - The fair share policy.

UpdateSchedulingPolicy, updateSchedulingPolicy_arn - The Amazon Resource Name (ARN) of the scheduling policy to update.

data UpdateSchedulingPolicyResponse Source #

See: newUpdateSchedulingPolicyResponse smart constructor.

Instances

Instances details
Generic UpdateSchedulingPolicyResponse Source # 
Instance details

Defined in Amazonka.Batch.UpdateSchedulingPolicy

Associated Types

type Rep UpdateSchedulingPolicyResponse :: Type -> Type #

Read UpdateSchedulingPolicyResponse Source # 
Instance details

Defined in Amazonka.Batch.UpdateSchedulingPolicy

Show UpdateSchedulingPolicyResponse Source # 
Instance details

Defined in Amazonka.Batch.UpdateSchedulingPolicy

NFData UpdateSchedulingPolicyResponse Source # 
Instance details

Defined in Amazonka.Batch.UpdateSchedulingPolicy

Eq UpdateSchedulingPolicyResponse Source # 
Instance details

Defined in Amazonka.Batch.UpdateSchedulingPolicy

type Rep UpdateSchedulingPolicyResponse Source # 
Instance details

Defined in Amazonka.Batch.UpdateSchedulingPolicy

type Rep UpdateSchedulingPolicyResponse = D1 ('MetaData "UpdateSchedulingPolicyResponse" "Amazonka.Batch.UpdateSchedulingPolicy" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "UpdateSchedulingPolicyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateSchedulingPolicyResponse Source #

Create a value of UpdateSchedulingPolicyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:UpdateSchedulingPolicyResponse', updateSchedulingPolicyResponse_httpStatus - The response's http status code.

Types

ArrayJobDependency

newtype ArrayJobDependency Source #

Instances

Instances details
FromJSON ArrayJobDependency Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayJobDependency

FromJSONKey ArrayJobDependency Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayJobDependency

ToJSON ArrayJobDependency Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayJobDependency

ToJSONKey ArrayJobDependency Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayJobDependency

ToByteString ArrayJobDependency Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayJobDependency

ToHeader ArrayJobDependency Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayJobDependency

ToLog ArrayJobDependency Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayJobDependency

ToQuery ArrayJobDependency Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayJobDependency

FromText ArrayJobDependency Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayJobDependency

ToText ArrayJobDependency Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayJobDependency

FromXML ArrayJobDependency Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayJobDependency

ToXML ArrayJobDependency Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayJobDependency

Generic ArrayJobDependency Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayJobDependency

Associated Types

type Rep ArrayJobDependency :: Type -> Type #

Read ArrayJobDependency Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayJobDependency

Show ArrayJobDependency Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayJobDependency

NFData ArrayJobDependency Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayJobDependency

Methods

rnf :: ArrayJobDependency -> () #

Eq ArrayJobDependency Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayJobDependency

Ord ArrayJobDependency Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayJobDependency

Hashable ArrayJobDependency Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayJobDependency

type Rep ArrayJobDependency Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayJobDependency

type Rep ArrayJobDependency = D1 ('MetaData "ArrayJobDependency" "Amazonka.Batch.Types.ArrayJobDependency" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'True) (C1 ('MetaCons "ArrayJobDependency'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromArrayJobDependency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

AssignPublicIp

newtype AssignPublicIp Source #

Constructors

AssignPublicIp' 

Instances

Instances details
FromJSON AssignPublicIp Source # 
Instance details

Defined in Amazonka.Batch.Types.AssignPublicIp

FromJSONKey AssignPublicIp Source # 
Instance details

Defined in Amazonka.Batch.Types.AssignPublicIp

ToJSON AssignPublicIp Source # 
Instance details

Defined in Amazonka.Batch.Types.AssignPublicIp

ToJSONKey AssignPublicIp Source # 
Instance details

Defined in Amazonka.Batch.Types.AssignPublicIp

ToByteString AssignPublicIp Source # 
Instance details

Defined in Amazonka.Batch.Types.AssignPublicIp

ToHeader AssignPublicIp Source # 
Instance details

Defined in Amazonka.Batch.Types.AssignPublicIp

ToLog AssignPublicIp Source # 
Instance details

Defined in Amazonka.Batch.Types.AssignPublicIp

ToQuery AssignPublicIp Source # 
Instance details

Defined in Amazonka.Batch.Types.AssignPublicIp

FromText AssignPublicIp Source # 
Instance details

Defined in Amazonka.Batch.Types.AssignPublicIp

ToText AssignPublicIp Source # 
Instance details

Defined in Amazonka.Batch.Types.AssignPublicIp

FromXML AssignPublicIp Source # 
Instance details

Defined in Amazonka.Batch.Types.AssignPublicIp

ToXML AssignPublicIp Source # 
Instance details

Defined in Amazonka.Batch.Types.AssignPublicIp

Methods

toXML :: AssignPublicIp -> XML #

Generic AssignPublicIp Source # 
Instance details

Defined in Amazonka.Batch.Types.AssignPublicIp

Associated Types

type Rep AssignPublicIp :: Type -> Type #

Read AssignPublicIp Source # 
Instance details

Defined in Amazonka.Batch.Types.AssignPublicIp

Show AssignPublicIp Source # 
Instance details

Defined in Amazonka.Batch.Types.AssignPublicIp

NFData AssignPublicIp Source # 
Instance details

Defined in Amazonka.Batch.Types.AssignPublicIp

Methods

rnf :: AssignPublicIp -> () #

Eq AssignPublicIp Source # 
Instance details

Defined in Amazonka.Batch.Types.AssignPublicIp

Ord AssignPublicIp Source # 
Instance details

Defined in Amazonka.Batch.Types.AssignPublicIp

Hashable AssignPublicIp Source # 
Instance details

Defined in Amazonka.Batch.Types.AssignPublicIp

type Rep AssignPublicIp Source # 
Instance details

Defined in Amazonka.Batch.Types.AssignPublicIp

type Rep AssignPublicIp = D1 ('MetaData "AssignPublicIp" "Amazonka.Batch.Types.AssignPublicIp" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'True) (C1 ('MetaCons "AssignPublicIp'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromAssignPublicIp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

CEState

newtype CEState Source #

Constructors

CEState' 

Fields

Bundled Patterns

pattern CEState_DISABLED :: CEState 
pattern CEState_ENABLED :: CEState 

Instances

Instances details
FromJSON CEState Source # 
Instance details

Defined in Amazonka.Batch.Types.CEState

FromJSONKey CEState Source # 
Instance details

Defined in Amazonka.Batch.Types.CEState

ToJSON CEState Source # 
Instance details

Defined in Amazonka.Batch.Types.CEState

ToJSONKey CEState Source # 
Instance details

Defined in Amazonka.Batch.Types.CEState

ToByteString CEState Source # 
Instance details

Defined in Amazonka.Batch.Types.CEState

Methods

toBS :: CEState -> ByteString #

ToHeader CEState Source # 
Instance details

Defined in Amazonka.Batch.Types.CEState

Methods

toHeader :: HeaderName -> CEState -> [Header] #

ToLog CEState Source # 
Instance details

Defined in Amazonka.Batch.Types.CEState

ToQuery CEState Source # 
Instance details

Defined in Amazonka.Batch.Types.CEState

FromText CEState Source # 
Instance details

Defined in Amazonka.Batch.Types.CEState

ToText CEState Source # 
Instance details

Defined in Amazonka.Batch.Types.CEState

Methods

toText :: CEState -> Text #

FromXML CEState Source # 
Instance details

Defined in Amazonka.Batch.Types.CEState

ToXML CEState Source # 
Instance details

Defined in Amazonka.Batch.Types.CEState

Methods

toXML :: CEState -> XML #

Generic CEState Source # 
Instance details

Defined in Amazonka.Batch.Types.CEState

Associated Types

type Rep CEState :: Type -> Type #

Methods

from :: CEState -> Rep CEState x #

to :: Rep CEState x -> CEState #

Read CEState Source # 
Instance details

Defined in Amazonka.Batch.Types.CEState

Show CEState Source # 
Instance details

Defined in Amazonka.Batch.Types.CEState

NFData CEState Source # 
Instance details

Defined in Amazonka.Batch.Types.CEState

Methods

rnf :: CEState -> () #

Eq CEState Source # 
Instance details

Defined in Amazonka.Batch.Types.CEState

Methods

(==) :: CEState -> CEState -> Bool #

(/=) :: CEState -> CEState -> Bool #

Ord CEState Source # 
Instance details

Defined in Amazonka.Batch.Types.CEState

Hashable CEState Source # 
Instance details

Defined in Amazonka.Batch.Types.CEState

Methods

hashWithSalt :: Int -> CEState -> Int #

hash :: CEState -> Int #

type Rep CEState Source # 
Instance details

Defined in Amazonka.Batch.Types.CEState

type Rep CEState = D1 ('MetaData "CEState" "Amazonka.Batch.Types.CEState" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'True) (C1 ('MetaCons "CEState'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromCEState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

CEStatus

newtype CEStatus Source #

Constructors

CEStatus' 

Fields

Bundled Patterns

pattern CEStatus_CREATING :: CEStatus 
pattern CEStatus_DELETED :: CEStatus 
pattern CEStatus_DELETING :: CEStatus 
pattern CEStatus_INVALID :: CEStatus 
pattern CEStatus_UPDATING :: CEStatus 
pattern CEStatus_VALID :: CEStatus 

Instances

Instances details
FromJSON CEStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.CEStatus

FromJSONKey CEStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.CEStatus

ToJSON CEStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.CEStatus

ToJSONKey CEStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.CEStatus

ToByteString CEStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.CEStatus

Methods

toBS :: CEStatus -> ByteString #

ToHeader CEStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.CEStatus

Methods

toHeader :: HeaderName -> CEStatus -> [Header] #

ToLog CEStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.CEStatus

ToQuery CEStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.CEStatus

FromText CEStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.CEStatus

ToText CEStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.CEStatus

Methods

toText :: CEStatus -> Text #

FromXML CEStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.CEStatus

ToXML CEStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.CEStatus

Methods

toXML :: CEStatus -> XML #

Generic CEStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.CEStatus

Associated Types

type Rep CEStatus :: Type -> Type #

Methods

from :: CEStatus -> Rep CEStatus x #

to :: Rep CEStatus x -> CEStatus #

Read CEStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.CEStatus

Show CEStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.CEStatus

NFData CEStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.CEStatus

Methods

rnf :: CEStatus -> () #

Eq CEStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.CEStatus

Ord CEStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.CEStatus

Hashable CEStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.CEStatus

Methods

hashWithSalt :: Int -> CEStatus -> Int #

hash :: CEStatus -> Int #

type Rep CEStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.CEStatus

type Rep CEStatus = D1 ('MetaData "CEStatus" "Amazonka.Batch.Types.CEStatus" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'True) (C1 ('MetaCons "CEStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromCEStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

CEType

newtype CEType Source #

Constructors

CEType' 

Fields

Bundled Patterns

pattern CEType_MANAGED :: CEType 
pattern CEType_UNMANAGED :: CEType 

Instances

Instances details
FromJSON CEType Source # 
Instance details

Defined in Amazonka.Batch.Types.CEType

FromJSONKey CEType Source # 
Instance details

Defined in Amazonka.Batch.Types.CEType

ToJSON CEType Source # 
Instance details

Defined in Amazonka.Batch.Types.CEType

ToJSONKey CEType Source # 
Instance details

Defined in Amazonka.Batch.Types.CEType

ToByteString CEType Source # 
Instance details

Defined in Amazonka.Batch.Types.CEType

Methods

toBS :: CEType -> ByteString #

ToHeader CEType Source # 
Instance details

Defined in Amazonka.Batch.Types.CEType

Methods

toHeader :: HeaderName -> CEType -> [Header] #

ToLog CEType Source # 
Instance details

Defined in Amazonka.Batch.Types.CEType

ToQuery CEType Source # 
Instance details

Defined in Amazonka.Batch.Types.CEType

FromText CEType Source # 
Instance details

Defined in Amazonka.Batch.Types.CEType

ToText CEType Source # 
Instance details

Defined in Amazonka.Batch.Types.CEType

Methods

toText :: CEType -> Text #

FromXML CEType Source # 
Instance details

Defined in Amazonka.Batch.Types.CEType

ToXML CEType Source # 
Instance details

Defined in Amazonka.Batch.Types.CEType

Methods

toXML :: CEType -> XML #

Generic CEType Source # 
Instance details

Defined in Amazonka.Batch.Types.CEType

Associated Types

type Rep CEType :: Type -> Type #

Methods

from :: CEType -> Rep CEType x #

to :: Rep CEType x -> CEType #

Read CEType Source # 
Instance details

Defined in Amazonka.Batch.Types.CEType

Show CEType Source # 
Instance details

Defined in Amazonka.Batch.Types.CEType

NFData CEType Source # 
Instance details

Defined in Amazonka.Batch.Types.CEType

Methods

rnf :: CEType -> () #

Eq CEType Source # 
Instance details

Defined in Amazonka.Batch.Types.CEType

Methods

(==) :: CEType -> CEType -> Bool #

(/=) :: CEType -> CEType -> Bool #

Ord CEType Source # 
Instance details

Defined in Amazonka.Batch.Types.CEType

Hashable CEType Source # 
Instance details

Defined in Amazonka.Batch.Types.CEType

Methods

hashWithSalt :: Int -> CEType -> Int #

hash :: CEType -> Int #

type Rep CEType Source # 
Instance details

Defined in Amazonka.Batch.Types.CEType

type Rep CEType = D1 ('MetaData "CEType" "Amazonka.Batch.Types.CEType" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'True) (C1 ('MetaCons "CEType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromCEType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

CRAllocationStrategy

newtype CRAllocationStrategy Source #

Instances

Instances details
FromJSON CRAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRAllocationStrategy

FromJSONKey CRAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRAllocationStrategy

ToJSON CRAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRAllocationStrategy

ToJSONKey CRAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRAllocationStrategy

ToByteString CRAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRAllocationStrategy

ToHeader CRAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRAllocationStrategy

ToLog CRAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRAllocationStrategy

ToQuery CRAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRAllocationStrategy

FromText CRAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRAllocationStrategy

ToText CRAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRAllocationStrategy

FromXML CRAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRAllocationStrategy

ToXML CRAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRAllocationStrategy

Generic CRAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRAllocationStrategy

Associated Types

type Rep CRAllocationStrategy :: Type -> Type #

Read CRAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRAllocationStrategy

Show CRAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRAllocationStrategy

NFData CRAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRAllocationStrategy

Methods

rnf :: CRAllocationStrategy -> () #

Eq CRAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRAllocationStrategy

Ord CRAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRAllocationStrategy

Hashable CRAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRAllocationStrategy

type Rep CRAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRAllocationStrategy

type Rep CRAllocationStrategy = D1 ('MetaData "CRAllocationStrategy" "Amazonka.Batch.Types.CRAllocationStrategy" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'True) (C1 ('MetaCons "CRAllocationStrategy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromCRAllocationStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

CRType

newtype CRType Source #

Constructors

CRType' 

Fields

Bundled Patterns

pattern CRType_EC2 :: CRType 
pattern CRType_FARGATE :: CRType 
pattern CRType_FARGATE_SPOT :: CRType 
pattern CRType_SPOT :: CRType 

Instances

Instances details
FromJSON CRType Source # 
Instance details

Defined in Amazonka.Batch.Types.CRType

FromJSONKey CRType Source # 
Instance details

Defined in Amazonka.Batch.Types.CRType

ToJSON CRType Source # 
Instance details

Defined in Amazonka.Batch.Types.CRType

ToJSONKey CRType Source # 
Instance details

Defined in Amazonka.Batch.Types.CRType

ToByteString CRType Source # 
Instance details

Defined in Amazonka.Batch.Types.CRType

Methods

toBS :: CRType -> ByteString #

ToHeader CRType Source # 
Instance details

Defined in Amazonka.Batch.Types.CRType

Methods

toHeader :: HeaderName -> CRType -> [Header] #

ToLog CRType Source # 
Instance details

Defined in Amazonka.Batch.Types.CRType

ToQuery CRType Source # 
Instance details

Defined in Amazonka.Batch.Types.CRType

FromText CRType Source # 
Instance details

Defined in Amazonka.Batch.Types.CRType

ToText CRType Source # 
Instance details

Defined in Amazonka.Batch.Types.CRType

Methods

toText :: CRType -> Text #

FromXML CRType Source # 
Instance details

Defined in Amazonka.Batch.Types.CRType

ToXML CRType Source # 
Instance details

Defined in Amazonka.Batch.Types.CRType

Methods

toXML :: CRType -> XML #

Generic CRType Source # 
Instance details

Defined in Amazonka.Batch.Types.CRType

Associated Types

type Rep CRType :: Type -> Type #

Methods

from :: CRType -> Rep CRType x #

to :: Rep CRType x -> CRType #

Read CRType Source # 
Instance details

Defined in Amazonka.Batch.Types.CRType

Show CRType Source # 
Instance details

Defined in Amazonka.Batch.Types.CRType

NFData CRType Source # 
Instance details

Defined in Amazonka.Batch.Types.CRType

Methods

rnf :: CRType -> () #

Eq CRType Source # 
Instance details

Defined in Amazonka.Batch.Types.CRType

Methods

(==) :: CRType -> CRType -> Bool #

(/=) :: CRType -> CRType -> Bool #

Ord CRType Source # 
Instance details

Defined in Amazonka.Batch.Types.CRType

Hashable CRType Source # 
Instance details

Defined in Amazonka.Batch.Types.CRType

Methods

hashWithSalt :: Int -> CRType -> Int #

hash :: CRType -> Int #

type Rep CRType Source # 
Instance details

Defined in Amazonka.Batch.Types.CRType

type Rep CRType = D1 ('MetaData "CRType" "Amazonka.Batch.Types.CRType" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'True) (C1 ('MetaCons "CRType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromCRType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

CRUpdateAllocationStrategy

newtype CRUpdateAllocationStrategy Source #

Instances

Instances details
FromJSON CRUpdateAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRUpdateAllocationStrategy

FromJSONKey CRUpdateAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRUpdateAllocationStrategy

ToJSON CRUpdateAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRUpdateAllocationStrategy

ToJSONKey CRUpdateAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRUpdateAllocationStrategy

ToByteString CRUpdateAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRUpdateAllocationStrategy

ToHeader CRUpdateAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRUpdateAllocationStrategy

ToLog CRUpdateAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRUpdateAllocationStrategy

ToQuery CRUpdateAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRUpdateAllocationStrategy

FromText CRUpdateAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRUpdateAllocationStrategy

ToText CRUpdateAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRUpdateAllocationStrategy

FromXML CRUpdateAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRUpdateAllocationStrategy

ToXML CRUpdateAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRUpdateAllocationStrategy

Generic CRUpdateAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRUpdateAllocationStrategy

Associated Types

type Rep CRUpdateAllocationStrategy :: Type -> Type #

Read CRUpdateAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRUpdateAllocationStrategy

Show CRUpdateAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRUpdateAllocationStrategy

NFData CRUpdateAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRUpdateAllocationStrategy

Eq CRUpdateAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRUpdateAllocationStrategy

Ord CRUpdateAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRUpdateAllocationStrategy

Hashable CRUpdateAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRUpdateAllocationStrategy

type Rep CRUpdateAllocationStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.CRUpdateAllocationStrategy

type Rep CRUpdateAllocationStrategy = D1 ('MetaData "CRUpdateAllocationStrategy" "Amazonka.Batch.Types.CRUpdateAllocationStrategy" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'True) (C1 ('MetaCons "CRUpdateAllocationStrategy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromCRUpdateAllocationStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

DeviceCgroupPermission

newtype DeviceCgroupPermission Source #

Instances

Instances details
FromJSON DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.Batch.Types.DeviceCgroupPermission

FromJSONKey DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.Batch.Types.DeviceCgroupPermission

ToJSON DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.Batch.Types.DeviceCgroupPermission

ToJSONKey DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.Batch.Types.DeviceCgroupPermission

ToByteString DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.Batch.Types.DeviceCgroupPermission

ToHeader DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.Batch.Types.DeviceCgroupPermission

ToLog DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.Batch.Types.DeviceCgroupPermission

ToQuery DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.Batch.Types.DeviceCgroupPermission

FromText DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.Batch.Types.DeviceCgroupPermission

ToText DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.Batch.Types.DeviceCgroupPermission

FromXML DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.Batch.Types.DeviceCgroupPermission

ToXML DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.Batch.Types.DeviceCgroupPermission

Generic DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.Batch.Types.DeviceCgroupPermission

Associated Types

type Rep DeviceCgroupPermission :: Type -> Type #

Read DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.Batch.Types.DeviceCgroupPermission

Show DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.Batch.Types.DeviceCgroupPermission

NFData DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.Batch.Types.DeviceCgroupPermission

Methods

rnf :: DeviceCgroupPermission -> () #

Eq DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.Batch.Types.DeviceCgroupPermission

Ord DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.Batch.Types.DeviceCgroupPermission

Hashable DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.Batch.Types.DeviceCgroupPermission

type Rep DeviceCgroupPermission Source # 
Instance details

Defined in Amazonka.Batch.Types.DeviceCgroupPermission

type Rep DeviceCgroupPermission = D1 ('MetaData "DeviceCgroupPermission" "Amazonka.Batch.Types.DeviceCgroupPermission" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'True) (C1 ('MetaCons "DeviceCgroupPermission'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDeviceCgroupPermission") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

EFSAuthorizationConfigIAM

newtype EFSAuthorizationConfigIAM Source #

Instances

Instances details
FromJSON EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSAuthorizationConfigIAM

FromJSONKey EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSAuthorizationConfigIAM

ToJSON EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSAuthorizationConfigIAM

ToJSONKey EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSAuthorizationConfigIAM

ToByteString EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSAuthorizationConfigIAM

ToHeader EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSAuthorizationConfigIAM

ToLog EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSAuthorizationConfigIAM

ToQuery EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSAuthorizationConfigIAM

FromText EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSAuthorizationConfigIAM

ToText EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSAuthorizationConfigIAM

FromXML EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSAuthorizationConfigIAM

ToXML EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSAuthorizationConfigIAM

Generic EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSAuthorizationConfigIAM

Associated Types

type Rep EFSAuthorizationConfigIAM :: Type -> Type #

Read EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSAuthorizationConfigIAM

Show EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSAuthorizationConfigIAM

NFData EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSAuthorizationConfigIAM

Eq EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSAuthorizationConfigIAM

Ord EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSAuthorizationConfigIAM

Hashable EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSAuthorizationConfigIAM

type Rep EFSAuthorizationConfigIAM Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSAuthorizationConfigIAM

type Rep EFSAuthorizationConfigIAM = D1 ('MetaData "EFSAuthorizationConfigIAM" "Amazonka.Batch.Types.EFSAuthorizationConfigIAM" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'True) (C1 ('MetaCons "EFSAuthorizationConfigIAM'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromEFSAuthorizationConfigIAM") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

EFSTransitEncryption

newtype EFSTransitEncryption Source #

Instances

Instances details
FromJSON EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSTransitEncryption

FromJSONKey EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSTransitEncryption

ToJSON EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSTransitEncryption

ToJSONKey EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSTransitEncryption

ToByteString EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSTransitEncryption

ToHeader EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSTransitEncryption

ToLog EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSTransitEncryption

ToQuery EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSTransitEncryption

FromText EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSTransitEncryption

ToText EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSTransitEncryption

FromXML EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSTransitEncryption

ToXML EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSTransitEncryption

Generic EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSTransitEncryption

Associated Types

type Rep EFSTransitEncryption :: Type -> Type #

Read EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSTransitEncryption

Show EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSTransitEncryption

NFData EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSTransitEncryption

Methods

rnf :: EFSTransitEncryption -> () #

Eq EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSTransitEncryption

Ord EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSTransitEncryption

Hashable EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSTransitEncryption

type Rep EFSTransitEncryption Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSTransitEncryption

type Rep EFSTransitEncryption = D1 ('MetaData "EFSTransitEncryption" "Amazonka.Batch.Types.EFSTransitEncryption" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'True) (C1 ('MetaCons "EFSTransitEncryption'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromEFSTransitEncryption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

JQState

newtype JQState Source #

Constructors

JQState' 

Fields

Bundled Patterns

pattern JQState_DISABLED :: JQState 
pattern JQState_ENABLED :: JQState 

Instances

Instances details
FromJSON JQState Source # 
Instance details

Defined in Amazonka.Batch.Types.JQState

FromJSONKey JQState Source # 
Instance details

Defined in Amazonka.Batch.Types.JQState

ToJSON JQState Source # 
Instance details

Defined in Amazonka.Batch.Types.JQState

ToJSONKey JQState Source # 
Instance details

Defined in Amazonka.Batch.Types.JQState

ToByteString JQState Source # 
Instance details

Defined in Amazonka.Batch.Types.JQState

Methods

toBS :: JQState -> ByteString #

ToHeader JQState Source # 
Instance details

Defined in Amazonka.Batch.Types.JQState

Methods

toHeader :: HeaderName -> JQState -> [Header] #

ToLog JQState Source # 
Instance details

Defined in Amazonka.Batch.Types.JQState

ToQuery JQState Source # 
Instance details

Defined in Amazonka.Batch.Types.JQState

FromText JQState Source # 
Instance details

Defined in Amazonka.Batch.Types.JQState

ToText JQState Source # 
Instance details

Defined in Amazonka.Batch.Types.JQState

Methods

toText :: JQState -> Text #

FromXML JQState Source # 
Instance details

Defined in Amazonka.Batch.Types.JQState

ToXML JQState Source # 
Instance details

Defined in Amazonka.Batch.Types.JQState

Methods

toXML :: JQState -> XML #

Generic JQState Source # 
Instance details

Defined in Amazonka.Batch.Types.JQState

Associated Types

type Rep JQState :: Type -> Type #

Methods

from :: JQState -> Rep JQState x #

to :: Rep JQState x -> JQState #

Read JQState Source # 
Instance details

Defined in Amazonka.Batch.Types.JQState

Show JQState Source # 
Instance details

Defined in Amazonka.Batch.Types.JQState

NFData JQState Source # 
Instance details

Defined in Amazonka.Batch.Types.JQState

Methods

rnf :: JQState -> () #

Eq JQState Source # 
Instance details

Defined in Amazonka.Batch.Types.JQState

Methods

(==) :: JQState -> JQState -> Bool #

(/=) :: JQState -> JQState -> Bool #

Ord JQState Source # 
Instance details

Defined in Amazonka.Batch.Types.JQState

Hashable JQState Source # 
Instance details

Defined in Amazonka.Batch.Types.JQState

Methods

hashWithSalt :: Int -> JQState -> Int #

hash :: JQState -> Int #

type Rep JQState Source # 
Instance details

Defined in Amazonka.Batch.Types.JQState

type Rep JQState = D1 ('MetaData "JQState" "Amazonka.Batch.Types.JQState" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'True) (C1 ('MetaCons "JQState'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromJQState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

JQStatus

newtype JQStatus Source #

Constructors

JQStatus' 

Fields

Bundled Patterns

pattern JQStatus_CREATING :: JQStatus 
pattern JQStatus_DELETED :: JQStatus 
pattern JQStatus_DELETING :: JQStatus 
pattern JQStatus_INVALID :: JQStatus 
pattern JQStatus_UPDATING :: JQStatus 
pattern JQStatus_VALID :: JQStatus 

Instances

Instances details
FromJSON JQStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JQStatus

FromJSONKey JQStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JQStatus

ToJSON JQStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JQStatus

ToJSONKey JQStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JQStatus

ToByteString JQStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JQStatus

Methods

toBS :: JQStatus -> ByteString #

ToHeader JQStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JQStatus

Methods

toHeader :: HeaderName -> JQStatus -> [Header] #

ToLog JQStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JQStatus

ToQuery JQStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JQStatus

FromText JQStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JQStatus

ToText JQStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JQStatus

Methods

toText :: JQStatus -> Text #

FromXML JQStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JQStatus

ToXML JQStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JQStatus

Methods

toXML :: JQStatus -> XML #

Generic JQStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JQStatus

Associated Types

type Rep JQStatus :: Type -> Type #

Methods

from :: JQStatus -> Rep JQStatus x #

to :: Rep JQStatus x -> JQStatus #

Read JQStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JQStatus

Show JQStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JQStatus

NFData JQStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JQStatus

Methods

rnf :: JQStatus -> () #

Eq JQStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JQStatus

Ord JQStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JQStatus

Hashable JQStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JQStatus

Methods

hashWithSalt :: Int -> JQStatus -> Int #

hash :: JQStatus -> Int #

type Rep JQStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JQStatus

type Rep JQStatus = D1 ('MetaData "JQStatus" "Amazonka.Batch.Types.JQStatus" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'True) (C1 ('MetaCons "JQStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromJQStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

JobDefinitionType

newtype JobDefinitionType Source #

Instances

Instances details
FromJSON JobDefinitionType Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDefinitionType

FromJSONKey JobDefinitionType Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDefinitionType

ToJSON JobDefinitionType Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDefinitionType

ToJSONKey JobDefinitionType Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDefinitionType

ToByteString JobDefinitionType Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDefinitionType

ToHeader JobDefinitionType Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDefinitionType

ToLog JobDefinitionType Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDefinitionType

ToQuery JobDefinitionType Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDefinitionType

FromText JobDefinitionType Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDefinitionType

ToText JobDefinitionType Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDefinitionType

FromXML JobDefinitionType Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDefinitionType

ToXML JobDefinitionType Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDefinitionType

Generic JobDefinitionType Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDefinitionType

Associated Types

type Rep JobDefinitionType :: Type -> Type #

Read JobDefinitionType Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDefinitionType

Show JobDefinitionType Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDefinitionType

NFData JobDefinitionType Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDefinitionType

Methods

rnf :: JobDefinitionType -> () #

Eq JobDefinitionType Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDefinitionType

Ord JobDefinitionType Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDefinitionType

Hashable JobDefinitionType Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDefinitionType

type Rep JobDefinitionType Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDefinitionType

type Rep JobDefinitionType = D1 ('MetaData "JobDefinitionType" "Amazonka.Batch.Types.JobDefinitionType" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'True) (C1 ('MetaCons "JobDefinitionType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromJobDefinitionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

JobStatus

newtype JobStatus Source #

Constructors

JobStatus' 

Fields

Instances

Instances details
FromJSON JobStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JobStatus

FromJSONKey JobStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JobStatus

ToJSON JobStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JobStatus

ToJSONKey JobStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JobStatus

ToByteString JobStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JobStatus

Methods

toBS :: JobStatus -> ByteString #

ToHeader JobStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JobStatus

ToLog JobStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JobStatus

ToQuery JobStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JobStatus

FromText JobStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JobStatus

ToText JobStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JobStatus

Methods

toText :: JobStatus -> Text #

FromXML JobStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JobStatus

ToXML JobStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JobStatus

Methods

toXML :: JobStatus -> XML #

Generic JobStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JobStatus

Associated Types

type Rep JobStatus :: Type -> Type #

Read JobStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JobStatus

Show JobStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JobStatus

NFData JobStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JobStatus

Methods

rnf :: JobStatus -> () #

Eq JobStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JobStatus

Ord JobStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JobStatus

Hashable JobStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JobStatus

type Rep JobStatus Source # 
Instance details

Defined in Amazonka.Batch.Types.JobStatus

type Rep JobStatus = D1 ('MetaData "JobStatus" "Amazonka.Batch.Types.JobStatus" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'True) (C1 ('MetaCons "JobStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromJobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

LogDriver

newtype LogDriver Source #

Constructors

LogDriver' 

Fields

Instances

Instances details
FromJSON LogDriver Source # 
Instance details

Defined in Amazonka.Batch.Types.LogDriver

FromJSONKey LogDriver Source # 
Instance details

Defined in Amazonka.Batch.Types.LogDriver

ToJSON LogDriver Source # 
Instance details

Defined in Amazonka.Batch.Types.LogDriver

ToJSONKey LogDriver Source # 
Instance details

Defined in Amazonka.Batch.Types.LogDriver

ToByteString LogDriver Source # 
Instance details

Defined in Amazonka.Batch.Types.LogDriver

Methods

toBS :: LogDriver -> ByteString #

ToHeader LogDriver Source # 
Instance details

Defined in Amazonka.Batch.Types.LogDriver

ToLog LogDriver Source # 
Instance details

Defined in Amazonka.Batch.Types.LogDriver

ToQuery LogDriver Source # 
Instance details

Defined in Amazonka.Batch.Types.LogDriver

FromText LogDriver Source # 
Instance details

Defined in Amazonka.Batch.Types.LogDriver

ToText LogDriver Source # 
Instance details

Defined in Amazonka.Batch.Types.LogDriver

Methods

toText :: LogDriver -> Text #

FromXML LogDriver Source # 
Instance details

Defined in Amazonka.Batch.Types.LogDriver

ToXML LogDriver Source # 
Instance details

Defined in Amazonka.Batch.Types.LogDriver

Methods

toXML :: LogDriver -> XML #

Generic LogDriver Source # 
Instance details

Defined in Amazonka.Batch.Types.LogDriver

Associated Types

type Rep LogDriver :: Type -> Type #

Read LogDriver Source # 
Instance details

Defined in Amazonka.Batch.Types.LogDriver

Show LogDriver Source # 
Instance details

Defined in Amazonka.Batch.Types.LogDriver

NFData LogDriver Source # 
Instance details

Defined in Amazonka.Batch.Types.LogDriver

Methods

rnf :: LogDriver -> () #

Eq LogDriver Source # 
Instance details

Defined in Amazonka.Batch.Types.LogDriver

Ord LogDriver Source # 
Instance details

Defined in Amazonka.Batch.Types.LogDriver

Hashable LogDriver Source # 
Instance details

Defined in Amazonka.Batch.Types.LogDriver

type Rep LogDriver Source # 
Instance details

Defined in Amazonka.Batch.Types.LogDriver

type Rep LogDriver = D1 ('MetaData "LogDriver" "Amazonka.Batch.Types.LogDriver" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'True) (C1 ('MetaCons "LogDriver'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromLogDriver") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

OrchestrationType

newtype OrchestrationType Source #

Instances

Instances details
FromJSON OrchestrationType Source # 
Instance details

Defined in Amazonka.Batch.Types.OrchestrationType

FromJSONKey OrchestrationType Source # 
Instance details

Defined in Amazonka.Batch.Types.OrchestrationType

ToJSON OrchestrationType Source # 
Instance details

Defined in Amazonka.Batch.Types.OrchestrationType

ToJSONKey OrchestrationType Source # 
Instance details

Defined in Amazonka.Batch.Types.OrchestrationType

ToByteString OrchestrationType Source # 
Instance details

Defined in Amazonka.Batch.Types.OrchestrationType

ToHeader OrchestrationType Source # 
Instance details

Defined in Amazonka.Batch.Types.OrchestrationType

ToLog OrchestrationType Source # 
Instance details

Defined in Amazonka.Batch.Types.OrchestrationType

ToQuery OrchestrationType Source # 
Instance details

Defined in Amazonka.Batch.Types.OrchestrationType

FromText OrchestrationType Source # 
Instance details

Defined in Amazonka.Batch.Types.OrchestrationType

ToText OrchestrationType Source # 
Instance details

Defined in Amazonka.Batch.Types.OrchestrationType

FromXML OrchestrationType Source # 
Instance details

Defined in Amazonka.Batch.Types.OrchestrationType

ToXML OrchestrationType Source # 
Instance details

Defined in Amazonka.Batch.Types.OrchestrationType

Generic OrchestrationType Source # 
Instance details

Defined in Amazonka.Batch.Types.OrchestrationType

Associated Types

type Rep OrchestrationType :: Type -> Type #

Read OrchestrationType Source # 
Instance details

Defined in Amazonka.Batch.Types.OrchestrationType

Show OrchestrationType Source # 
Instance details

Defined in Amazonka.Batch.Types.OrchestrationType

NFData OrchestrationType Source # 
Instance details

Defined in Amazonka.Batch.Types.OrchestrationType

Methods

rnf :: OrchestrationType -> () #

Eq OrchestrationType Source # 
Instance details

Defined in Amazonka.Batch.Types.OrchestrationType

Ord OrchestrationType Source # 
Instance details

Defined in Amazonka.Batch.Types.OrchestrationType

Hashable OrchestrationType Source # 
Instance details

Defined in Amazonka.Batch.Types.OrchestrationType

type Rep OrchestrationType Source # 
Instance details

Defined in Amazonka.Batch.Types.OrchestrationType

type Rep OrchestrationType = D1 ('MetaData "OrchestrationType" "Amazonka.Batch.Types.OrchestrationType" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'True) (C1 ('MetaCons "OrchestrationType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromOrchestrationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

PlatformCapability

newtype PlatformCapability Source #

Instances

Instances details
FromJSON PlatformCapability Source # 
Instance details

Defined in Amazonka.Batch.Types.PlatformCapability

FromJSONKey PlatformCapability Source # 
Instance details

Defined in Amazonka.Batch.Types.PlatformCapability

ToJSON PlatformCapability Source # 
Instance details

Defined in Amazonka.Batch.Types.PlatformCapability

ToJSONKey PlatformCapability Source # 
Instance details

Defined in Amazonka.Batch.Types.PlatformCapability

ToByteString PlatformCapability Source # 
Instance details

Defined in Amazonka.Batch.Types.PlatformCapability

ToHeader PlatformCapability Source # 
Instance details

Defined in Amazonka.Batch.Types.PlatformCapability

ToLog PlatformCapability Source # 
Instance details

Defined in Amazonka.Batch.Types.PlatformCapability

ToQuery PlatformCapability Source # 
Instance details

Defined in Amazonka.Batch.Types.PlatformCapability

FromText PlatformCapability Source # 
Instance details

Defined in Amazonka.Batch.Types.PlatformCapability

ToText PlatformCapability Source # 
Instance details

Defined in Amazonka.Batch.Types.PlatformCapability

FromXML PlatformCapability Source # 
Instance details

Defined in Amazonka.Batch.Types.PlatformCapability

ToXML PlatformCapability Source # 
Instance details

Defined in Amazonka.Batch.Types.PlatformCapability

Generic PlatformCapability Source # 
Instance details

Defined in Amazonka.Batch.Types.PlatformCapability

Associated Types

type Rep PlatformCapability :: Type -> Type #

Read PlatformCapability Source # 
Instance details

Defined in Amazonka.Batch.Types.PlatformCapability

Show PlatformCapability Source # 
Instance details

Defined in Amazonka.Batch.Types.PlatformCapability

NFData PlatformCapability Source # 
Instance details

Defined in Amazonka.Batch.Types.PlatformCapability

Methods

rnf :: PlatformCapability -> () #

Eq PlatformCapability Source # 
Instance details

Defined in Amazonka.Batch.Types.PlatformCapability

Ord PlatformCapability Source # 
Instance details

Defined in Amazonka.Batch.Types.PlatformCapability

Hashable PlatformCapability Source # 
Instance details

Defined in Amazonka.Batch.Types.PlatformCapability

type Rep PlatformCapability Source # 
Instance details

Defined in Amazonka.Batch.Types.PlatformCapability

type Rep PlatformCapability = D1 ('MetaData "PlatformCapability" "Amazonka.Batch.Types.PlatformCapability" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'True) (C1 ('MetaCons "PlatformCapability'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromPlatformCapability") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ResourceType

newtype ResourceType Source #

Constructors

ResourceType' 

Instances

Instances details
FromJSON ResourceType Source # 
Instance details

Defined in Amazonka.Batch.Types.ResourceType

FromJSONKey ResourceType Source # 
Instance details

Defined in Amazonka.Batch.Types.ResourceType

ToJSON ResourceType Source # 
Instance details

Defined in Amazonka.Batch.Types.ResourceType

ToJSONKey ResourceType Source # 
Instance details

Defined in Amazonka.Batch.Types.ResourceType

ToByteString ResourceType Source # 
Instance details

Defined in Amazonka.Batch.Types.ResourceType

ToHeader ResourceType Source # 
Instance details

Defined in Amazonka.Batch.Types.ResourceType

ToLog ResourceType Source # 
Instance details

Defined in Amazonka.Batch.Types.ResourceType

ToQuery ResourceType Source # 
Instance details

Defined in Amazonka.Batch.Types.ResourceType

FromText ResourceType Source # 
Instance details

Defined in Amazonka.Batch.Types.ResourceType

ToText ResourceType Source # 
Instance details

Defined in Amazonka.Batch.Types.ResourceType

Methods

toText :: ResourceType -> Text #

FromXML ResourceType Source # 
Instance details

Defined in Amazonka.Batch.Types.ResourceType

ToXML ResourceType Source # 
Instance details

Defined in Amazonka.Batch.Types.ResourceType

Methods

toXML :: ResourceType -> XML #

Generic ResourceType Source # 
Instance details

Defined in Amazonka.Batch.Types.ResourceType

Associated Types

type Rep ResourceType :: Type -> Type #

Read ResourceType Source # 
Instance details

Defined in Amazonka.Batch.Types.ResourceType

Show ResourceType Source # 
Instance details

Defined in Amazonka.Batch.Types.ResourceType

NFData ResourceType Source # 
Instance details

Defined in Amazonka.Batch.Types.ResourceType

Methods

rnf :: ResourceType -> () #

Eq ResourceType Source # 
Instance details

Defined in Amazonka.Batch.Types.ResourceType

Ord ResourceType Source # 
Instance details

Defined in Amazonka.Batch.Types.ResourceType

Hashable ResourceType Source # 
Instance details

Defined in Amazonka.Batch.Types.ResourceType

type Rep ResourceType Source # 
Instance details

Defined in Amazonka.Batch.Types.ResourceType

type Rep ResourceType = D1 ('MetaData "ResourceType" "Amazonka.Batch.Types.ResourceType" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'True) (C1 ('MetaCons "ResourceType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromResourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

RetryAction

newtype RetryAction Source #

Constructors

RetryAction' 

Bundled Patterns

pattern RetryAction_EXIT :: RetryAction 
pattern RetryAction_RETRY :: RetryAction 

Instances

Instances details
FromJSON RetryAction Source # 
Instance details

Defined in Amazonka.Batch.Types.RetryAction

FromJSONKey RetryAction Source # 
Instance details

Defined in Amazonka.Batch.Types.RetryAction

ToJSON RetryAction Source # 
Instance details

Defined in Amazonka.Batch.Types.RetryAction

ToJSONKey RetryAction Source # 
Instance details

Defined in Amazonka.Batch.Types.RetryAction

ToByteString RetryAction Source # 
Instance details

Defined in Amazonka.Batch.Types.RetryAction

ToHeader RetryAction Source # 
Instance details

Defined in Amazonka.Batch.Types.RetryAction

ToLog RetryAction Source # 
Instance details

Defined in Amazonka.Batch.Types.RetryAction

ToQuery RetryAction Source # 
Instance details

Defined in Amazonka.Batch.Types.RetryAction

FromText RetryAction Source # 
Instance details

Defined in Amazonka.Batch.Types.RetryAction

ToText RetryAction Source # 
Instance details

Defined in Amazonka.Batch.Types.RetryAction

Methods

toText :: RetryAction -> Text #

FromXML RetryAction Source # 
Instance details

Defined in Amazonka.Batch.Types.RetryAction

ToXML RetryAction Source # 
Instance details

Defined in Amazonka.Batch.Types.RetryAction

Methods

toXML :: RetryAction -> XML #

Generic RetryAction Source # 
Instance details

Defined in Amazonka.Batch.Types.RetryAction

Associated Types

type Rep RetryAction :: Type -> Type #

Read RetryAction Source # 
Instance details

Defined in Amazonka.Batch.Types.RetryAction

Show RetryAction Source # 
Instance details

Defined in Amazonka.Batch.Types.RetryAction

NFData RetryAction Source # 
Instance details

Defined in Amazonka.Batch.Types.RetryAction

Methods

rnf :: RetryAction -> () #

Eq RetryAction Source # 
Instance details

Defined in Amazonka.Batch.Types.RetryAction

Ord RetryAction Source # 
Instance details

Defined in Amazonka.Batch.Types.RetryAction

Hashable RetryAction Source # 
Instance details

Defined in Amazonka.Batch.Types.RetryAction

type Rep RetryAction Source # 
Instance details

Defined in Amazonka.Batch.Types.RetryAction

type Rep RetryAction = D1 ('MetaData "RetryAction" "Amazonka.Batch.Types.RetryAction" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'True) (C1 ('MetaCons "RetryAction'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromRetryAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ArrayProperties

data ArrayProperties Source #

An object that represents an Batch array job.

See: newArrayProperties smart constructor.

Constructors

ArrayProperties' (Maybe Int) 

Instances

Instances details
ToJSON ArrayProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayProperties

Generic ArrayProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayProperties

Associated Types

type Rep ArrayProperties :: Type -> Type #

Read ArrayProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayProperties

Show ArrayProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayProperties

NFData ArrayProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayProperties

Methods

rnf :: ArrayProperties -> () #

Eq ArrayProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayProperties

Hashable ArrayProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayProperties

type Rep ArrayProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayProperties

type Rep ArrayProperties = D1 ('MetaData "ArrayProperties" "Amazonka.Batch.Types.ArrayProperties" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "ArrayProperties'" 'PrefixI 'True) (S1 ('MetaSel ('Just "size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))

newArrayProperties :: ArrayProperties Source #

Create a value of ArrayProperties with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:size:ArrayProperties', arrayProperties_size - The size of the array job.

ArrayPropertiesDetail

data ArrayPropertiesDetail Source #

An object that represents the array properties of a job.

See: newArrayPropertiesDetail smart constructor.

Instances

Instances details
FromJSON ArrayPropertiesDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayPropertiesDetail

Generic ArrayPropertiesDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayPropertiesDetail

Associated Types

type Rep ArrayPropertiesDetail :: Type -> Type #

Read ArrayPropertiesDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayPropertiesDetail

Show ArrayPropertiesDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayPropertiesDetail

NFData ArrayPropertiesDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayPropertiesDetail

Methods

rnf :: ArrayPropertiesDetail -> () #

Eq ArrayPropertiesDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayPropertiesDetail

Hashable ArrayPropertiesDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayPropertiesDetail

type Rep ArrayPropertiesDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayPropertiesDetail

type Rep ArrayPropertiesDetail = D1 ('MetaData "ArrayPropertiesDetail" "Amazonka.Batch.Types.ArrayPropertiesDetail" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "ArrayPropertiesDetail'" 'PrefixI 'True) (S1 ('MetaSel ('Just "index") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "statusSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Int))))))

newArrayPropertiesDetail :: ArrayPropertiesDetail Source #

Create a value of ArrayPropertiesDetail with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:index:ArrayPropertiesDetail', arrayPropertiesDetail_index - The job index within the array that's associated with this job. This parameter is returned for array job children.

$sel:size:ArrayPropertiesDetail', arrayPropertiesDetail_size - The size of the array job. This parameter is returned for parent array jobs.

$sel:statusSummary:ArrayPropertiesDetail', arrayPropertiesDetail_statusSummary - A summary of the number of array job children in each available job status. This parameter is returned for parent array jobs.

ArrayPropertiesSummary

data ArrayPropertiesSummary Source #

An object that represents the array properties of a job.

See: newArrayPropertiesSummary smart constructor.

Instances

Instances details
FromJSON ArrayPropertiesSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayPropertiesSummary

Generic ArrayPropertiesSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayPropertiesSummary

Associated Types

type Rep ArrayPropertiesSummary :: Type -> Type #

Read ArrayPropertiesSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayPropertiesSummary

Show ArrayPropertiesSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayPropertiesSummary

NFData ArrayPropertiesSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayPropertiesSummary

Methods

rnf :: ArrayPropertiesSummary -> () #

Eq ArrayPropertiesSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayPropertiesSummary

Hashable ArrayPropertiesSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayPropertiesSummary

type Rep ArrayPropertiesSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.ArrayPropertiesSummary

type Rep ArrayPropertiesSummary = D1 ('MetaData "ArrayPropertiesSummary" "Amazonka.Batch.Types.ArrayPropertiesSummary" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "ArrayPropertiesSummary'" 'PrefixI 'True) (S1 ('MetaSel ('Just "index") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))

newArrayPropertiesSummary :: ArrayPropertiesSummary Source #

Create a value of ArrayPropertiesSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:index:ArrayPropertiesSummary', arrayPropertiesSummary_index - The job index within the array that's associated with this job. This parameter is returned for children of array jobs.

$sel:size:ArrayPropertiesSummary', arrayPropertiesSummary_size - The size of the array job. This parameter is returned for parent array jobs.

AttemptContainerDetail

data AttemptContainerDetail Source #

An object that represents the details of a container that's part of a job attempt.

See: newAttemptContainerDetail smart constructor.

Instances

Instances details
FromJSON AttemptContainerDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.AttemptContainerDetail

Generic AttemptContainerDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.AttemptContainerDetail

Associated Types

type Rep AttemptContainerDetail :: Type -> Type #

Read AttemptContainerDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.AttemptContainerDetail

Show AttemptContainerDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.AttemptContainerDetail

NFData AttemptContainerDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.AttemptContainerDetail

Methods

rnf :: AttemptContainerDetail -> () #

Eq AttemptContainerDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.AttemptContainerDetail

Hashable AttemptContainerDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.AttemptContainerDetail

type Rep AttemptContainerDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.AttemptContainerDetail

type Rep AttemptContainerDetail = D1 ('MetaData "AttemptContainerDetail" "Amazonka.Batch.Types.AttemptContainerDetail" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "AttemptContainerDetail'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "containerInstanceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "exitCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "logStreamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "networkInterfaces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [NetworkInterface])) :*: (S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "taskArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newAttemptContainerDetail :: AttemptContainerDetail Source #

Create a value of AttemptContainerDetail with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:containerInstanceArn:AttemptContainerDetail', attemptContainerDetail_containerInstanceArn - The Amazon Resource Name (ARN) of the Amazon ECS container instance that hosts the job attempt.

$sel:exitCode:AttemptContainerDetail', attemptContainerDetail_exitCode - The exit code for the job attempt. A non-zero exit code is considered failed.

$sel:logStreamName:AttemptContainerDetail', attemptContainerDetail_logStreamName - The name of the CloudWatch Logs log stream that's associated with the container. The log group for Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach the RUNNING status.

$sel:networkInterfaces:AttemptContainerDetail', attemptContainerDetail_networkInterfaces - The network interfaces that are associated with the job attempt.

$sel:reason:AttemptContainerDetail', attemptContainerDetail_reason - A short (255 max characters) human-readable string to provide additional details for a running or stopped container.

$sel:taskArn:AttemptContainerDetail', attemptContainerDetail_taskArn - The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the job attempt. Each container attempt receives a task ARN when they reach the STARTING status.

AttemptDetail

data AttemptDetail Source #

An object that represents a job attempt.

See: newAttemptDetail smart constructor.

Instances

Instances details
FromJSON AttemptDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.AttemptDetail

Generic AttemptDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.AttemptDetail

Associated Types

type Rep AttemptDetail :: Type -> Type #

Read AttemptDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.AttemptDetail

Show AttemptDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.AttemptDetail

NFData AttemptDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.AttemptDetail

Methods

rnf :: AttemptDetail -> () #

Eq AttemptDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.AttemptDetail

Hashable AttemptDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.AttemptDetail

type Rep AttemptDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.AttemptDetail

type Rep AttemptDetail = D1 ('MetaData "AttemptDetail" "Amazonka.Batch.Types.AttemptDetail" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "AttemptDetail'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "container") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttemptContainerDetail)) :*: S1 ('MetaSel ('Just "startedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "statusReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "stoppedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))))

newAttemptDetail :: AttemptDetail Source #

Create a value of AttemptDetail with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:container:AttemptDetail', attemptDetail_container - The details for the container in this job attempt.

$sel:startedAt:AttemptDetail', attemptDetail_startedAt - The Unix timestamp (in milliseconds) for when the attempt was started (when the attempt transitioned from the STARTING state to the RUNNING state).

$sel:statusReason:AttemptDetail', attemptDetail_statusReason - A short, human-readable string to provide additional details for the current status of the job attempt.

$sel:stoppedAt:AttemptDetail', attemptDetail_stoppedAt - The Unix timestamp (in milliseconds) for when the attempt was stopped (when the attempt transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED).

ComputeEnvironmentDetail

data ComputeEnvironmentDetail Source #

An object that represents an Batch compute environment.

See: newComputeEnvironmentDetail smart constructor.

Instances

Instances details
FromJSON ComputeEnvironmentDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.ComputeEnvironmentDetail

Generic ComputeEnvironmentDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.ComputeEnvironmentDetail

Associated Types

type Rep ComputeEnvironmentDetail :: Type -> Type #

Read ComputeEnvironmentDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.ComputeEnvironmentDetail

Show ComputeEnvironmentDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.ComputeEnvironmentDetail

NFData ComputeEnvironmentDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.ComputeEnvironmentDetail

Eq ComputeEnvironmentDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.ComputeEnvironmentDetail

Hashable ComputeEnvironmentDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.ComputeEnvironmentDetail

type Rep ComputeEnvironmentDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.ComputeEnvironmentDetail

type Rep ComputeEnvironmentDetail = D1 ('MetaData "ComputeEnvironmentDetail" "Amazonka.Batch.Types.ComputeEnvironmentDetail" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "ComputeEnvironmentDetail'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "computeResources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ComputeResource)) :*: (S1 ('MetaSel ('Just "containerOrchestrationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OrchestrationType)) :*: S1 ('MetaSel ('Just "ecsClusterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "eksConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EksConfiguration)) :*: S1 ('MetaSel ('Just "serviceRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CEState)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CEStatus))))) :*: (((S1 ('MetaSel ('Just "statusReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :*: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CEType)) :*: S1 ('MetaSel ('Just "unmanagedvCpus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: ((S1 ('MetaSel ('Just "updatePolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UpdatePolicy)) :*: S1 ('MetaSel ('Just "uuid") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "computeEnvironmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "computeEnvironmentArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newComputeEnvironmentDetail Source #

Create a value of ComputeEnvironmentDetail with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:computeResources:ComputeEnvironmentDetail', computeEnvironmentDetail_computeResources - The compute resources defined for the compute environment. For more information, see Compute environments in the Batch User Guide.

$sel:containerOrchestrationType:ComputeEnvironmentDetail', computeEnvironmentDetail_containerOrchestrationType - The orchestration type of the compute environment. The valid values are ECS (default) or EKS.

$sel:ecsClusterArn:ComputeEnvironmentDetail', computeEnvironmentDetail_ecsClusterArn - The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster that the compute environment uses.

$sel:eksConfiguration:ComputeEnvironmentDetail', computeEnvironmentDetail_eksConfiguration - The configuration for the Amazon EKS cluster that supports the Batch compute environment. Only specify this parameter if the containerOrchestrationType is EKS.

$sel:serviceRole:ComputeEnvironmentDetail', computeEnvironmentDetail_serviceRole - The service role that's associated with the compute environment that allows Batch to make calls to Amazon Web Services API operations on your behalf. For more information, see Batch service IAM role in the Batch User Guide.

$sel:state:ComputeEnvironmentDetail', computeEnvironmentDetail_state - The state of the compute environment. The valid values are ENABLED or DISABLED.

If the state is ENABLED, then the Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically based on the job queue demand.

If the state is DISABLED, then the Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state don't scale out. However, they scale in to minvCpus value after instances become idle.

$sel:status:ComputeEnvironmentDetail', computeEnvironmentDetail_status - The current status of the compute environment (for example, CREATING or VALID).

$sel:statusReason:ComputeEnvironmentDetail', computeEnvironmentDetail_statusReason - A short, human-readable string to provide additional details for the current status of the compute environment.

ComputeEnvironmentDetail, computeEnvironmentDetail_tags - The tags applied to the compute environment.

ComputeEnvironmentDetail, computeEnvironmentDetail_type - The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute environments in the Batch User Guide.

$sel:unmanagedvCpus:ComputeEnvironmentDetail', computeEnvironmentDetail_unmanagedvCpus - The maximum number of VCPUs expected to be used for an unmanaged compute environment.

$sel:updatePolicy:ComputeEnvironmentDetail', computeEnvironmentDetail_updatePolicy - Specifies the infrastructure update policy for the compute environment. For more information about infrastructure updates, see Updating compute environments in the Batch User Guide.

$sel:uuid:ComputeEnvironmentDetail', computeEnvironmentDetail_uuid - Unique identifier for the compute environment.

$sel:computeEnvironmentName:ComputeEnvironmentDetail', computeEnvironmentDetail_computeEnvironmentName - The name of the compute environment. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

$sel:computeEnvironmentArn:ComputeEnvironmentDetail', computeEnvironmentDetail_computeEnvironmentArn - The Amazon Resource Name (ARN) of the compute environment.

ComputeEnvironmentOrder

data ComputeEnvironmentOrder Source #

The order that compute environments are tried in for job placement within a queue. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first. Compute environments must be in the VALID state before you can associate them with a job queue. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.

All compute environments that are associated with a job queue must share the same architecture. Batch doesn't support mixing compute environment architecture types in a single job queue.

See: newComputeEnvironmentOrder smart constructor.

Instances

Instances details
FromJSON ComputeEnvironmentOrder Source # 
Instance details

Defined in Amazonka.Batch.Types.ComputeEnvironmentOrder

ToJSON ComputeEnvironmentOrder Source # 
Instance details

Defined in Amazonka.Batch.Types.ComputeEnvironmentOrder

Generic ComputeEnvironmentOrder Source # 
Instance details

Defined in Amazonka.Batch.Types.ComputeEnvironmentOrder

Associated Types

type Rep ComputeEnvironmentOrder :: Type -> Type #

Read ComputeEnvironmentOrder Source # 
Instance details

Defined in Amazonka.Batch.Types.ComputeEnvironmentOrder

Show ComputeEnvironmentOrder Source # 
Instance details

Defined in Amazonka.Batch.Types.ComputeEnvironmentOrder

NFData ComputeEnvironmentOrder Source # 
Instance details

Defined in Amazonka.Batch.Types.ComputeEnvironmentOrder

Methods

rnf :: ComputeEnvironmentOrder -> () #

Eq ComputeEnvironmentOrder Source # 
Instance details

Defined in Amazonka.Batch.Types.ComputeEnvironmentOrder

Hashable ComputeEnvironmentOrder Source # 
Instance details

Defined in Amazonka.Batch.Types.ComputeEnvironmentOrder

type Rep ComputeEnvironmentOrder Source # 
Instance details

Defined in Amazonka.Batch.Types.ComputeEnvironmentOrder

type Rep ComputeEnvironmentOrder = D1 ('MetaData "ComputeEnvironmentOrder" "Amazonka.Batch.Types.ComputeEnvironmentOrder" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "ComputeEnvironmentOrder'" 'PrefixI 'True) (S1 ('MetaSel ('Just "order") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "computeEnvironment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newComputeEnvironmentOrder Source #

Create a value of ComputeEnvironmentOrder with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:order:ComputeEnvironmentOrder', computeEnvironmentOrder_order - The order of the compute environment. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first.

$sel:computeEnvironment:ComputeEnvironmentOrder', computeEnvironmentOrder_computeEnvironment - The Amazon Resource Name (ARN) of the compute environment.

ComputeResource

data ComputeResource Source #

An object that represents an Batch compute resource. For more information, see Compute environments in the Batch User Guide.

See: newComputeResource smart constructor.

Instances

Instances details
FromJSON ComputeResource Source # 
Instance details

Defined in Amazonka.Batch.Types.ComputeResource

ToJSON ComputeResource Source # 
Instance details

Defined in Amazonka.Batch.Types.ComputeResource

Generic ComputeResource Source # 
Instance details

Defined in Amazonka.Batch.Types.ComputeResource

Associated Types

type Rep ComputeResource :: Type -> Type #

Read ComputeResource Source # 
Instance details

Defined in Amazonka.Batch.Types.ComputeResource

Show ComputeResource Source # 
Instance details

Defined in Amazonka.Batch.Types.ComputeResource

NFData ComputeResource Source # 
Instance details

Defined in Amazonka.Batch.Types.ComputeResource

Methods

rnf :: ComputeResource -> () #

Eq ComputeResource Source # 
Instance details

Defined in Amazonka.Batch.Types.ComputeResource

Hashable ComputeResource Source # 
Instance details

Defined in Amazonka.Batch.Types.ComputeResource

type Rep ComputeResource Source # 
Instance details

Defined in Amazonka.Batch.Types.ComputeResource

type Rep ComputeResource = D1 ('MetaData "ComputeResource" "Amazonka.Batch.Types.ComputeResource" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "ComputeResource'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "allocationStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CRAllocationStrategy)) :*: S1 ('MetaSel ('Just "bidPercentage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "desiredvCpus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "ec2Configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Ec2Configuration])))) :*: ((S1 ('MetaSel ('Just "ec2KeyPair") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "imageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "instanceRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "instanceTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :*: (((S1 ('MetaSel ('Just "launchTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LaunchTemplateSpecification)) :*: S1 ('MetaSel ('Just "minvCpus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "placementGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :*: ((S1 ('MetaSel ('Just "spotIamFleetRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :*: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CRType) :*: (S1 ('MetaSel ('Just "maxvCpus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "subnets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))))))

newComputeResource Source #

Create a value of ComputeResource with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:allocationStrategy:ComputeResource', computeResource_allocationStrategy - The allocation strategy to use for the compute resource if not enough instances of the best fitting instance type can be allocated. This might be because of availability of the instance type in the Region or Amazon EC2 service limits. For more information, see Allocation strategies in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

BEST_FIT (default)
Batch selects an instance type that best fits the needs of the jobs with a preference for the lowest-cost instance type. If additional instances of the selected instance type aren't available, Batch waits for the additional instances to be available. If there aren't enough instances available or the user is reaching Amazon EC2 service limits, additional jobs aren't run until the currently running jobs are completed. This allocation strategy keeps costs lower but can limit scaling. If you're using Spot Fleets with BEST_FIT, the Spot Fleet IAM Role must be specified. Compute resources that use a BEST_FIT allocation strategy don't support infrastructure updates and can't update some parameters. For more information, see Updating compute environments in the Batch User Guide.
BEST_FIT_PROGRESSIVE
Batch selects additional instance types that are large enough to meet the requirements of the jobs in the queue. Its preference is for instance types with lower cost vCPUs. If additional instances of the previously selected instance types aren't available, Batch selects new instance types.
SPOT_CAPACITY_OPTIMIZED
Batch selects one or more instance types that are large enough to meet the requirements of the jobs in the queue. Its preference is for instance types that are less likely to be interrupted. This allocation strategy is only available for Spot Instance compute resources.

With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance.

$sel:bidPercentage:ComputeResource', computeResource_bidPercentage - The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand price. For most use cases, we recommend leaving this field empty.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

$sel:desiredvCpus:ComputeResource', computeResource_desiredvCpus - The desired number of Amazon EC2 vCPUS in the compute environment. Batch modifies this value between the minimum and maximum values based on job queue demand.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

$sel:ec2Configuration:ComputeResource', computeResource_ec2Configuration - Provides information that's used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment. If Ec2Configuration isn't specified, the default is ECS_AL2.

One or two values can be provided.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

$sel:ec2KeyPair:ComputeResource', computeResource_ec2KeyPair - The Amazon EC2 key pair that's used for instances launched in the compute environment. You can use this key pair to log in to your instances with SSH.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

$sel:imageId:ComputeResource', computeResource_imageId - The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is overridden by the imageIdOverride member of the Ec2Configuration structure.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer Guide.

$sel:instanceRole:ComputeResource', computeResource_instanceRole - The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, ecsInstanceRole or arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole . For more information, see Amazon ECS instance role in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

$sel:instanceTypes:ComputeResource', computeResource_instanceTypes - The instances types that can be launched. You can specify instance families to launch any instance type within those families (for example, c5 or p3), or you can specify specific sizes within a family (such as c5.8xlarge). You can also choose optimal to select instance types (from the C4, M4, and R4 instance families) that match the demand of your job queues.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

When you create a compute environment, the instance types that you select for the compute environment must share the same architecture. For example, you can't mix x86 and ARM instances in the same compute environment.

Currently, optimal uses instance types from the C4, M4, and R4 instance families. In Regions that don't have instance types from those instance families, instance types from the C5, M5, and R5 instance families are used.

$sel:launchTemplate:ComputeResource', computeResource_launchTemplate - The launch template to use for your compute resources. Any other compute resource parameters that you specify in a CreateComputeEnvironment API operation override the same parameters in the launch template. You must specify either the launch template ID or launch template name in the request, but not both. For more information, see Launch template support in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

$sel:minvCpus:ComputeResource', computeResource_minvCpus - The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is DISABLED).

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

$sel:placementGroup:ComputeResource', computeResource_placementGroup - The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel jobs to your compute environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential. For more information, see Placement groups in the Amazon EC2 User Guide for Linux Instances.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

$sel:securityGroupIds:ComputeResource', computeResource_securityGroupIds - The Amazon EC2 security groups that are associated with instances launched in the compute environment. One or more security groups must be specified, either in securityGroupIds or using a launch template referenced in launchTemplate. This parameter is required for jobs that are running on Fargate resources and must contain at least one security group. Fargate doesn't support launch templates. If security groups are specified using both securityGroupIds and launchTemplate, the values in securityGroupIds are used.

$sel:spotIamFleetRole:ComputeResource', computeResource_spotIamFleetRole - The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment. This role is required if the allocation strategy set to BEST_FIT or if the allocation strategy isn't specified. For more information, see Amazon EC2 spot fleet role in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

To tag your Spot Instances on creation, the Spot Fleet IAM role specified here must use the newer AmazonEC2SpotFleetTaggingRole managed policy. The previously recommended AmazonEC2SpotFleetRole managed policy doesn't have the required permissions to tag Spot Instances. For more information, see Spot instances not tagged on creation in the Batch User Guide.

$sel:tags:ComputeResource', computeResource_tags - Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For Batch, these take the form of "String1": "String2", where String1 is the tag key and String2 is the tag value-for example, { "Name": "Batch Instance - C4OnDemand" }. This is helpful for recognizing your Batch instances in the Amazon EC2 console. Updating these tags requires an infrastructure update to the compute environment. For more information, see Updating compute environments in the Batch User Guide. These tags aren't seen when using the Batch ListTagsForResource API operation.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

$sel:type':ComputeResource', computeResource_type - The type of compute environment: EC2, SPOT, FARGATE, or FARGATE_SPOT. For more information, see Compute environments in the Batch User Guide.

If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the spotIamFleetRole parameter. For more information, see Amazon EC2 spot fleet role in the Batch User Guide.

$sel:maxvCpus:ComputeResource', computeResource_maxvCpus - The maximum number of Amazon EC2 vCPUs that a compute environment can reach.

With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance. For example, no more than a single instance from among those specified in your compute environment is allocated.

$sel:subnets:ComputeResource', computeResource_subnets - The VPC subnets where the compute resources are launched. These subnets must be within the same VPC. Fargate compute resources can contain up to 16 subnets. For more information, see VPCs and subnets in the Amazon VPC User Guide.

Batch on Amazon EC2 and Batch on Amazon EKS support Local Zones. For more information, see Local Zones in the Amazon EC2 User Guide for Linux Instances, Amazon EKS and Amazon Web Services Local Zones in the Amazon EKS User Guide and Amazon ECS clusters in Local Zones, Wavelength Zones, and Amazon Web Services Outposts in the Amazon ECS Developer Guide.

Batch on Fargate doesn't currently support Local Zones.

ComputeResourceUpdate

data ComputeResourceUpdate Source #

An object that represents the attributes of a compute environment that can be updated. For more information, see Updating compute environments in the Batch User Guide.

See: newComputeResourceUpdate smart constructor.

Instances

Instances details
ToJSON ComputeResourceUpdate Source # 
Instance details

Defined in Amazonka.Batch.Types.ComputeResourceUpdate

Generic ComputeResourceUpdate Source # 
Instance details

Defined in Amazonka.Batch.Types.ComputeResourceUpdate

Associated Types

type Rep ComputeResourceUpdate :: Type -> Type #

Read ComputeResourceUpdate Source # 
Instance details

Defined in Amazonka.Batch.Types.ComputeResourceUpdate

Show ComputeResourceUpdate Source # 
Instance details

Defined in Amazonka.Batch.Types.ComputeResourceUpdate

NFData ComputeResourceUpdate Source # 
Instance details

Defined in Amazonka.Batch.Types.ComputeResourceUpdate

Methods

rnf :: ComputeResourceUpdate -> () #

Eq ComputeResourceUpdate Source # 
Instance details

Defined in Amazonka.Batch.Types.ComputeResourceUpdate

Hashable ComputeResourceUpdate Source # 
Instance details

Defined in Amazonka.Batch.Types.ComputeResourceUpdate

type Rep ComputeResourceUpdate Source # 
Instance details

Defined in Amazonka.Batch.Types.ComputeResourceUpdate

type Rep ComputeResourceUpdate = D1 ('MetaData "ComputeResourceUpdate" "Amazonka.Batch.Types.ComputeResourceUpdate" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "ComputeResourceUpdate'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "allocationStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CRUpdateAllocationStrategy)) :*: S1 ('MetaSel ('Just "bidPercentage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "desiredvCpus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "ec2Configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Ec2Configuration])))) :*: ((S1 ('MetaSel ('Just "ec2KeyPair") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "imageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "instanceRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "instanceTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :*: (((S1 ('MetaSel ('Just "launchTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LaunchTemplateSpecification)) :*: S1 ('MetaSel ('Just "maxvCpus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "minvCpus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "placementGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "subnets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CRType)) :*: S1 ('MetaSel ('Just "updateToLatestImageVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))))))

newComputeResourceUpdate :: ComputeResourceUpdate Source #

Create a value of ComputeResourceUpdate with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:allocationStrategy:ComputeResourceUpdate', computeResourceUpdate_allocationStrategy - The allocation strategy to use for the compute resource if there's not enough instances of the best fitting instance type that can be allocated. This might be because of availability of the instance type in the Region or Amazon EC2 service limits. For more information, see Allocation strategies in the Batch User Guide.

When updating a compute environment, changing the allocation strategy requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide. BEST_FIT isn't supported when updating a compute environment.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

BEST_FIT_PROGRESSIVE
Batch selects additional instance types that are large enough to meet the requirements of the jobs in the queue. Its preference is for instance types with lower cost vCPUs. If additional instances of the previously selected instance types aren't available, Batch selects new instance types.
SPOT_CAPACITY_OPTIMIZED
Batch selects one or more instance types that are large enough to meet the requirements of the jobs in the queue. Its preference is for instance types that are less likely to be interrupted. This allocation strategy is only available for Spot Instance compute resources.

With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance.

$sel:bidPercentage:ComputeResourceUpdate', computeResourceUpdate_bidPercentage - The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, the Spot price must be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage. For most use cases, we recommend leaving this field empty.

When updating a compute environment, changing the bid percentage requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

$sel:desiredvCpus:ComputeResourceUpdate', computeResourceUpdate_desiredvCpus - The desired number of Amazon EC2 vCPUS in the compute environment. Batch modifies this value between the minimum and maximum values based on job queue demand.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

Batch doesn't support changing the desired number of vCPUs of an existing compute environment. Don't specify this parameter for compute environments using Amazon EKS clusters.

$sel:ec2Configuration:ComputeResourceUpdate', computeResourceUpdate_ec2Configuration - Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment. If Ec2Configuration isn't specified, the default is ECS_AL2.

When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide. To remove the EC2 configuration and any custom AMI ID specified in imageIdOverride, set this value to an empty string.

One or two values can be provided.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

$sel:ec2KeyPair:ComputeResourceUpdate', computeResourceUpdate_ec2KeyPair - The Amazon EC2 key pair that's used for instances launched in the compute environment. You can use this key pair to log in to your instances with SSH. To remove the Amazon EC2 key pair, set this value to an empty string.

When updating a compute environment, changing the EC2 key pair requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

$sel:imageId:ComputeResourceUpdate', computeResourceUpdate_imageId - The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is overridden by the imageIdOverride member of the Ec2Configuration structure. To remove the custom AMI ID and use the default AMI ID, set this value to an empty string.

When updating a compute environment, changing the AMI ID requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer Guide.

$sel:instanceRole:ComputeResourceUpdate', computeResourceUpdate_instanceRole - The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, ecsInstanceRole or arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole . For more information, see Amazon ECS instance role in the Batch User Guide.

When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

$sel:instanceTypes:ComputeResourceUpdate', computeResourceUpdate_instanceTypes - The instances types that can be launched. You can specify instance families to launch any instance type within those families (for example, c5 or p3), or you can specify specific sizes within a family (such as c5.8xlarge). You can also choose optimal to select instance types (from the C4, M4, and R4 instance families) that match the demand of your job queues.

When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

When you create a compute environment, the instance types that you select for the compute environment must share the same architecture. For example, you can't mix x86 and ARM instances in the same compute environment.

Currently, optimal uses instance types from the C4, M4, and R4 instance families. In Regions that don't have instance types from those instance families, instance types from the C5, M5, and R5 instance families are used.

$sel:launchTemplate:ComputeResourceUpdate', computeResourceUpdate_launchTemplate - The updated launch template to use for your compute resources. You must specify either the launch template ID or launch template name in the request, but not both. For more information, see Launch template support in the Batch User Guide. To remove the custom launch template and use the default launch template, set launchTemplateId or launchTemplateName member of the launch template specification to an empty string. Removing the launch template from a compute environment will not remove the AMI specified in the launch template. In order to update the AMI specified in a launch template, the updateToLatestImageVersion parameter must be set to true.

When updating a compute environment, changing the launch template requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

$sel:maxvCpus:ComputeResourceUpdate', computeResourceUpdate_maxvCpus - The maximum number of Amazon EC2 vCPUs that an environment can reach.

With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance. That is, no more than a single instance from among those specified in your compute environment.

$sel:minvCpus:ComputeResourceUpdate', computeResourceUpdate_minvCpus - The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is DISABLED).

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

$sel:placementGroup:ComputeResourceUpdate', computeResourceUpdate_placementGroup - The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel jobs to your compute environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential. For more information, see Placement groups in the Amazon EC2 User Guide for Linux Instances.

When updating a compute environment, changing the placement group requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

$sel:securityGroupIds:ComputeResourceUpdate', computeResourceUpdate_securityGroupIds - The Amazon EC2 security groups that are associated with instances launched in the compute environment. This parameter is required for Fargate compute resources, where it can contain up to 5 security groups. For Fargate compute resources, providing an empty list is handled as if this parameter wasn't specified and no change is made. For EC2 compute resources, providing an empty list removes the security groups from the compute resource.

When updating a compute environment, changing the EC2 security groups requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

$sel:subnets:ComputeResourceUpdate', computeResourceUpdate_subnets - The VPC subnets where the compute resources are launched. Fargate compute resources can contain up to 16 subnets. For Fargate compute resources, providing an empty list will be handled as if this parameter wasn't specified and no change is made. For EC2 compute resources, providing an empty list removes the VPC subnets from the compute resource. For more information, see VPCs and subnets in the Amazon VPC User Guide.

When updating a compute environment, changing the VPC subnets requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

Batch on Amazon EC2 and Batch on Amazon EKS support Local Zones. For more information, see Local Zones in the Amazon EC2 User Guide for Linux Instances, Amazon EKS and Amazon Web Services Local Zones in the Amazon EKS User Guide and Amazon ECS clusters in Local Zones, Wavelength Zones, and Amazon Web Services Outposts in the Amazon ECS Developer Guide.

Batch on Fargate doesn't currently support Local Zones.

$sel:tags:ComputeResourceUpdate', computeResourceUpdate_tags - Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For Batch, these take the form of "String1": "String2", where String1 is the tag key and String2 is the tag value-for example, { "Name": "Batch Instance - C4OnDemand" }. This is helpful for recognizing your Batch instances in the Amazon EC2 console. These tags aren't seen when using the Batch ListTagsForResource API operation.

When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

$sel:type':ComputeResourceUpdate', computeResourceUpdate_type - The type of compute environment: EC2, SPOT, FARGATE, or FARGATE_SPOT. For more information, see Compute environments in the Batch User Guide.

If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the spotIamFleetRole parameter. For more information, see Amazon EC2 spot fleet role in the Batch User Guide.

When updating a compute environment, changing the type of a compute environment requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

$sel:updateToLatestImageVersion:ComputeResourceUpdate', computeResourceUpdate_updateToLatestImageVersion - Specifies whether the AMI ID is updated to the latest one that's supported by Batch when the compute environment has an infrastructure update. The default value is false.

An AMI ID can either be specified in the imageId or imageIdOverride parameters or be determined by the launch template that's specified in the launchTemplate parameter. If an AMI ID is specified any of these ways, this parameter is ignored. For more information about to update AMI IDs during an infrastructure update, see Updating the AMI ID in the Batch User Guide.

When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

ContainerDetail

data ContainerDetail Source #

An object that represents the details of a container that's part of a job.

See: newContainerDetail smart constructor.

Instances

Instances details
FromJSON ContainerDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.ContainerDetail

Generic ContainerDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.ContainerDetail

Associated Types

type Rep ContainerDetail :: Type -> Type #

Read ContainerDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.ContainerDetail

Show ContainerDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.ContainerDetail

NFData ContainerDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.ContainerDetail

Methods

rnf :: ContainerDetail -> () #

Eq ContainerDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.ContainerDetail

Hashable ContainerDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.ContainerDetail

type Rep ContainerDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.ContainerDetail

type Rep ContainerDetail = D1 ('MetaData "ContainerDetail" "Amazonka.Batch.Types.ContainerDetail" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "ContainerDetail'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "command") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "containerInstanceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "environment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [KeyValuePair])))) :*: (S1 ('MetaSel ('Just "executionRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "exitCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "fargatePlatformConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FargatePlatformConfiguration))))) :*: ((S1 ('MetaSel ('Just "image") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "instanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "linuxParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LinuxParameters)) :*: S1 ('MetaSel ('Just "logConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LogConfiguration))) :*: (S1 ('MetaSel ('Just "logStreamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "memory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))) :*: (((S1 ('MetaSel ('Just "mountPoints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MountPoint])) :*: (S1 ('MetaSel ('Just "networkConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NetworkConfiguration)) :*: S1 ('MetaSel ('Just "networkInterfaces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [NetworkInterface])))) :*: (S1 ('MetaSel ('Just "privileged") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "readonlyRootFilesystem") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "resourceRequirements") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ResourceRequirement])) :*: (S1 ('MetaSel ('Just "secrets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Secret])) :*: S1 ('MetaSel ('Just "taskArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "ulimits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Ulimit])) :*: S1 ('MetaSel ('Just "user") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "vcpus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "volumes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Volume]))))))))

newContainerDetail :: ContainerDetail Source #

Create a value of ContainerDetail with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:command:ContainerDetail', containerDetail_command - The command that's passed to the container.

$sel:containerInstanceArn:ContainerDetail', containerDetail_containerInstanceArn - The Amazon Resource Name (ARN) of the container instance that the container is running on.

$sel:environment:ContainerDetail', containerDetail_environment - The environment variables to pass to a container.

Environment variables cannot start with "AWS_BATCH". This naming convention is reserved for variables that Batch sets.

$sel:executionRoleArn:ContainerDetail', containerDetail_executionRoleArn - The Amazon Resource Name (ARN) of the execution role that Batch can assume. For more information, see Batch execution IAM role in the Batch User Guide.

$sel:exitCode:ContainerDetail', containerDetail_exitCode - The exit code to return upon completion.

$sel:fargatePlatformConfiguration:ContainerDetail', containerDetail_fargatePlatformConfiguration - The platform configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.

$sel:image:ContainerDetail', containerDetail_image - The image used to start the container.

$sel:instanceType:ContainerDetail', containerDetail_instanceType - The instance type of the underlying host infrastructure of a multi-node parallel job.

This parameter isn't applicable to jobs that are running on Fargate resources.

$sel:jobRoleArn:ContainerDetail', containerDetail_jobRoleArn - The Amazon Resource Name (ARN) that's associated with the job when run.

$sel:linuxParameters:ContainerDetail', containerDetail_linuxParameters - Linux-specific modifications that are applied to the container, such as details for device mappings.

$sel:logConfiguration:ContainerDetail', containerDetail_logConfiguration - The log configuration specification for the container.

This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance. Or, alternatively, it must be configured on a different log server for remote logging options. For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers might be available in future releases of the Amazon ECS container agent.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version | grep "Server API version"

The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide.

$sel:logStreamName:ContainerDetail', containerDetail_logStreamName - The name of the Amazon CloudWatch Logs log stream that's associated with the container. The log group for Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach the RUNNING status.

$sel:memory:ContainerDetail', containerDetail_memory - For jobs running on EC2 resources that didn't specify memory requirements using resourceRequirements, the number of MiB of memory reserved for the job. For other jobs, including all run on Fargate resources, see resourceRequirements.

$sel:mountPoints:ContainerDetail', containerDetail_mountPoints - The mount points for data volumes in your container.

$sel:networkConfiguration:ContainerDetail', containerDetail_networkConfiguration - The network configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.

$sel:networkInterfaces:ContainerDetail', containerDetail_networkInterfaces - The network interfaces that are associated with the job.

$sel:privileged:ContainerDetail', containerDetail_privileged - When this parameter is true, the container is given elevated permissions on the host container instance (similar to the root user). The default value is false.

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or specified as false.

$sel:readonlyRootFilesystem:ContainerDetail', containerDetail_readonlyRootFilesystem - When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run .

$sel:reason:ContainerDetail', containerDetail_reason - A short (255 max characters) human-readable string to provide additional details for a running or stopped container.

$sel:resourceRequirements:ContainerDetail', containerDetail_resourceRequirements - The type and amount of resources to assign to a container. The supported resources include GPU, MEMORY, and VCPU.

$sel:secrets:ContainerDetail', containerDetail_secrets - The secrets to pass to the container. For more information, see Specifying sensitive data in the Batch User Guide.

$sel:taskArn:ContainerDetail', containerDetail_taskArn - The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the container job. Each container attempt receives a task ARN when they reach the STARTING status.

$sel:ulimits:ContainerDetail', containerDetail_ulimits - A list of ulimit values to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.

This parameter isn't applicable to jobs that are running on Fargate resources.

$sel:user:ContainerDetail', containerDetail_user - The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.

$sel:vcpus:ContainerDetail', containerDetail_vcpus - The number of vCPUs reserved for the container. For jobs that run on EC2 resources, you can specify the vCPU requirement for the job using resourceRequirements, but you can't specify the vCPU requirements in both the vcpus and resourceRequirements object. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required but can be specified in several places. It must be specified for each node at least once.

This parameter isn't applicable to jobs that run on Fargate resources. For jobs that run on Fargate resources, you must specify the vCPU requirement for the job using resourceRequirements.

$sel:volumes:ContainerDetail', containerDetail_volumes - A list of volumes that are associated with the job.

ContainerOverrides

data ContainerOverrides Source #

The overrides that should be sent to a container.

See: newContainerOverrides smart constructor.

Instances

Instances details
ToJSON ContainerOverrides Source # 
Instance details

Defined in Amazonka.Batch.Types.ContainerOverrides

Generic ContainerOverrides Source # 
Instance details

Defined in Amazonka.Batch.Types.ContainerOverrides

Associated Types

type Rep ContainerOverrides :: Type -> Type #

Read ContainerOverrides Source # 
Instance details

Defined in Amazonka.Batch.Types.ContainerOverrides

Show ContainerOverrides Source # 
Instance details

Defined in Amazonka.Batch.Types.ContainerOverrides

NFData ContainerOverrides Source # 
Instance details

Defined in Amazonka.Batch.Types.ContainerOverrides

Methods

rnf :: ContainerOverrides -> () #

Eq ContainerOverrides Source # 
Instance details

Defined in Amazonka.Batch.Types.ContainerOverrides

Hashable ContainerOverrides Source # 
Instance details

Defined in Amazonka.Batch.Types.ContainerOverrides

type Rep ContainerOverrides Source # 
Instance details

Defined in Amazonka.Batch.Types.ContainerOverrides

type Rep ContainerOverrides = D1 ('MetaData "ContainerOverrides" "Amazonka.Batch.Types.ContainerOverrides" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "ContainerOverrides'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "command") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "environment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [KeyValuePair])) :*: S1 ('MetaSel ('Just "instanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "memory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "resourceRequirements") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ResourceRequirement])) :*: S1 ('MetaSel ('Just "vcpus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))))

newContainerOverrides :: ContainerOverrides Source #

Create a value of ContainerOverrides with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:command:ContainerOverrides', containerOverrides_command - The command to send to the container that overrides the default command from the Docker image or the job definition.

$sel:environment:ContainerOverrides', containerOverrides_environment - The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the job definition.

Environment variables cannot start with "AWS_BATCH". This naming convention is reserved for variables that Batch sets.

$sel:instanceType:ContainerOverrides', containerOverrides_instanceType - The instance type to use for a multi-node parallel job.

This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.

$sel:memory:ContainerOverrides', containerOverrides_memory - This parameter is deprecated, use resourceRequirements to override the memory requirements specified in the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on EC2 resources, it overrides the memory parameter set in the job definition, but doesn't override any memory requirement that's specified in the resourceRequirements structure in the job definition. To override memory requirements that are specified in the resourceRequirements structure in the job definition, resourceRequirements must be specified in the SubmitJob request, with type set to MEMORY and value set to the new value. For more information, see Can't override job definition resource requirements in the Batch User Guide.

$sel:resourceRequirements:ContainerOverrides', containerOverrides_resourceRequirements - The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include GPU, MEMORY, and VCPU.

$sel:vcpus:ContainerOverrides', containerOverrides_vcpus - This parameter is deprecated, use resourceRequirements to override the vcpus parameter that's set in the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on EC2 resources, it overrides the vcpus parameter set in the job definition, but doesn't override any vCPU requirement specified in the resourceRequirements structure in the job definition. To override vCPU requirements that are specified in the resourceRequirements structure in the job definition, resourceRequirements must be specified in the SubmitJob request, with type set to VCPU and value set to the new value. For more information, see Can't override job definition resource requirements in the Batch User Guide.

ContainerProperties

data ContainerProperties Source #

Container properties are used for Amazon ECS based job definitions. These properties to describe the container that's launched as part of a job.

See: newContainerProperties smart constructor.

Instances

Instances details
FromJSON ContainerProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.ContainerProperties

ToJSON ContainerProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.ContainerProperties

Generic ContainerProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.ContainerProperties

Associated Types

type Rep ContainerProperties :: Type -> Type #

Read ContainerProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.ContainerProperties

Show ContainerProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.ContainerProperties

NFData ContainerProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.ContainerProperties

Methods

rnf :: ContainerProperties -> () #

Eq ContainerProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.ContainerProperties

Hashable ContainerProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.ContainerProperties

type Rep ContainerProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.ContainerProperties

type Rep ContainerProperties = D1 ('MetaData "ContainerProperties" "Amazonka.Batch.Types.ContainerProperties" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "ContainerProperties'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "command") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "environment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [KeyValuePair]))) :*: (S1 ('MetaSel ('Just "executionRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "fargatePlatformConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FargatePlatformConfiguration)) :*: S1 ('MetaSel ('Just "image") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "instanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "linuxParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LinuxParameters)) :*: (S1 ('MetaSel ('Just "logConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LogConfiguration)) :*: S1 ('MetaSel ('Just "memory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))) :*: (((S1 ('MetaSel ('Just "mountPoints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MountPoint])) :*: S1 ('MetaSel ('Just "networkConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NetworkConfiguration))) :*: (S1 ('MetaSel ('Just "privileged") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "readonlyRootFilesystem") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "resourceRequirements") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ResourceRequirement]))))) :*: ((S1 ('MetaSel ('Just "secrets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Secret])) :*: S1 ('MetaSel ('Just "ulimits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Ulimit]))) :*: (S1 ('MetaSel ('Just "user") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "vcpus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "volumes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Volume]))))))))

newContainerProperties :: ContainerProperties Source #

Create a value of ContainerProperties with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:command:ContainerProperties', containerProperties_command - The command that's passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.

$sel:environment:ContainerProperties', containerProperties_environment - The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.

We don't recommend using plaintext environment variables for sensitive information, such as credential data.

Environment variables cannot start with "AWS_BATCH". This naming convention is reserved for variables that Batch sets.

$sel:executionRoleArn:ContainerProperties', containerProperties_executionRoleArn - The Amazon Resource Name (ARN) of the execution role that Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. For more information, see Batch execution IAM role in the Batch User Guide.

$sel:fargatePlatformConfiguration:ContainerProperties', containerProperties_fargatePlatformConfiguration - The platform configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.

$sel:image:ContainerProperties', containerProperties_image - The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag . It can be 255 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), underscores (_), colons (:), periods (.), forward slashes (/), and number signs (#). This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.

Docker image architecture must match the processor architecture of the compute resources that they're scheduled on. For example, ARM-based Docker images can only run on ARM-based compute resources.

  • Images in Amazon ECR Public repositories use the full registry/repository[:tag] or registry/repository[@digest] naming conventions. For example, public.ecr.aws/registry_alias/my-web-app:latest .
  • Images in Amazon ECR repositories use the full registry and repository URI (for example, 123456789012.dkr.ecr.<region-name>.amazonaws.com/<repository-name>).
  • Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).
  • Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).
  • Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).

$sel:instanceType:ContainerProperties', containerProperties_instanceType - The instance type to use for a multi-node parallel job. All node groups in a multi-node parallel job must use the same instance type.

This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.

$sel:jobRoleArn:ContainerProperties', containerProperties_jobRoleArn - The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more information, see IAM roles for tasks in the Amazon Elastic Container Service Developer Guide.

$sel:linuxParameters:ContainerProperties', containerProperties_linuxParameters - Linux-specific modifications that are applied to the container, such as details for device mappings.

$sel:logConfiguration:ContainerProperties', containerProperties_logConfiguration - The log configuration specification for the container.

This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container might use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type).

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version | grep "Server API version"

The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide.

$sel:memory:ContainerProperties', containerProperties_memory - This parameter is deprecated, use resourceRequirements to specify the memory requirements for the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on EC2 resources, it specifies the memory hard limit (in MiB) for a container. If your container attempts to exceed the specified number, it's terminated. You must specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be specified in several places. It must be specified for each node at least once.

$sel:mountPoints:ContainerProperties', containerProperties_mountPoints - The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.

$sel:networkConfiguration:ContainerProperties', containerProperties_networkConfiguration - The network configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.

$sel:privileged:ContainerProperties', containerProperties_privileged - When this parameter is true, the container is given elevated permissions on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run. The default value is false.

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or specified as false.

$sel:readonlyRootFilesystem:ContainerProperties', containerProperties_readonlyRootFilesystem - When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.

$sel:resourceRequirements:ContainerProperties', containerProperties_resourceRequirements - The type and amount of resources to assign to a container. The supported resources include GPU, MEMORY, and VCPU.

$sel:secrets:ContainerProperties', containerProperties_secrets - The secrets for the container. For more information, see Specifying sensitive data in the Batch User Guide.

$sel:ulimits:ContainerProperties', containerProperties_ulimits - A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.

$sel:user:ContainerProperties', containerProperties_user - The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.

$sel:vcpus:ContainerProperties', containerProperties_vcpus - This parameter is deprecated, use resourceRequirements to specify the vCPU requirements for the job definition. It's not supported for jobs running on Fargate resources. For jobs running on EC2 resources, it specifies the number of vCPUs reserved for the job.

Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. The number of vCPUs must be specified but can be specified in several places. You must specify it at least once for each node.

$sel:volumes:ContainerProperties', containerProperties_volumes - A list of data volumes used in a job.

ContainerSummary

data ContainerSummary Source #

An object that represents summary details of a container within a job.

See: newContainerSummary smart constructor.

Instances

Instances details
FromJSON ContainerSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.ContainerSummary

Generic ContainerSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.ContainerSummary

Associated Types

type Rep ContainerSummary :: Type -> Type #

Read ContainerSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.ContainerSummary

Show ContainerSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.ContainerSummary

NFData ContainerSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.ContainerSummary

Methods

rnf :: ContainerSummary -> () #

Eq ContainerSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.ContainerSummary

Hashable ContainerSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.ContainerSummary

type Rep ContainerSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.ContainerSummary

type Rep ContainerSummary = D1 ('MetaData "ContainerSummary" "Amazonka.Batch.Types.ContainerSummary" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "ContainerSummary'" 'PrefixI 'True) (S1 ('MetaSel ('Just "exitCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newContainerSummary :: ContainerSummary Source #

Create a value of ContainerSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:exitCode:ContainerSummary', containerSummary_exitCode - The exit code to return upon completion.

$sel:reason:ContainerSummary', containerSummary_reason - A short (255 max characters) human-readable string to provide additional details for a running or stopped container.

Device

data Device Source #

An object that represents a container instance host device.

This object isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.

See: newDevice smart constructor.

Instances

Instances details
FromJSON Device Source # 
Instance details

Defined in Amazonka.Batch.Types.Device

ToJSON Device Source # 
Instance details

Defined in Amazonka.Batch.Types.Device

Generic Device Source # 
Instance details

Defined in Amazonka.Batch.Types.Device

Associated Types

type Rep Device :: Type -> Type #

Methods

from :: Device -> Rep Device x #

to :: Rep Device x -> Device #

Read Device Source # 
Instance details

Defined in Amazonka.Batch.Types.Device

Show Device Source # 
Instance details

Defined in Amazonka.Batch.Types.Device

NFData Device Source # 
Instance details

Defined in Amazonka.Batch.Types.Device

Methods

rnf :: Device -> () #

Eq Device Source # 
Instance details

Defined in Amazonka.Batch.Types.Device

Methods

(==) :: Device -> Device -> Bool #

(/=) :: Device -> Device -> Bool #

Hashable Device Source # 
Instance details

Defined in Amazonka.Batch.Types.Device

Methods

hashWithSalt :: Int -> Device -> Int #

hash :: Device -> Int #

type Rep Device Source # 
Instance details

Defined in Amazonka.Batch.Types.Device

type Rep Device = D1 ('MetaData "Device" "Amazonka.Batch.Types.Device" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "Device'" 'PrefixI 'True) (S1 ('MetaSel ('Just "containerPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "permissions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DeviceCgroupPermission])) :*: S1 ('MetaSel ('Just "hostPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDevice Source #

Create a value of Device with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:containerPath:Device', device_containerPath - The path inside the container that's used to expose the host device. By default, the hostPath value is used.

$sel:permissions:Device', device_permissions - The explicit permissions to provide to the container for the device. By default, the container has permissions for read, write, and mknod for the device.

$sel:hostPath:Device', device_hostPath - The path for the device on the host container instance.

EFSAuthorizationConfig

data EFSAuthorizationConfig Source #

The authorization configuration details for the Amazon EFS file system.

See: newEFSAuthorizationConfig smart constructor.

Instances

Instances details
FromJSON EFSAuthorizationConfig Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSAuthorizationConfig

ToJSON EFSAuthorizationConfig Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSAuthorizationConfig

Generic EFSAuthorizationConfig Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSAuthorizationConfig

Associated Types

type Rep EFSAuthorizationConfig :: Type -> Type #

Read EFSAuthorizationConfig Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSAuthorizationConfig

Show EFSAuthorizationConfig Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSAuthorizationConfig

NFData EFSAuthorizationConfig Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSAuthorizationConfig

Methods

rnf :: EFSAuthorizationConfig -> () #

Eq EFSAuthorizationConfig Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSAuthorizationConfig

Hashable EFSAuthorizationConfig Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSAuthorizationConfig

type Rep EFSAuthorizationConfig Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSAuthorizationConfig

type Rep EFSAuthorizationConfig = D1 ('MetaData "EFSAuthorizationConfig" "Amazonka.Batch.Types.EFSAuthorizationConfig" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "EFSAuthorizationConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accessPointId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "iam") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EFSAuthorizationConfigIAM))))

newEFSAuthorizationConfig :: EFSAuthorizationConfig Source #

Create a value of EFSAuthorizationConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accessPointId:EFSAuthorizationConfig', eFSAuthorizationConfig_accessPointId - The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the EFSVolumeConfiguration must either be omitted or set to / which enforces the path set on the EFS access point. If an access point is used, transit encryption must be enabled in the EFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide.

$sel:iam:EFSAuthorizationConfig', eFSAuthorizationConfig_iam - Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS access points in the Batch User Guide. EFS IAM authorization requires that TransitEncryption be ENABLED and that a JobRoleArn is specified.

EFSVolumeConfiguration

data EFSVolumeConfiguration Source #

This is used when you're using an Amazon Elastic File System file system for job storage. For more information, see Amazon EFS Volumes in the Batch User Guide.

See: newEFSVolumeConfiguration smart constructor.

Instances

Instances details
FromJSON EFSVolumeConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSVolumeConfiguration

ToJSON EFSVolumeConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSVolumeConfiguration

Generic EFSVolumeConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSVolumeConfiguration

Associated Types

type Rep EFSVolumeConfiguration :: Type -> Type #

Read EFSVolumeConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSVolumeConfiguration

Show EFSVolumeConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSVolumeConfiguration

NFData EFSVolumeConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSVolumeConfiguration

Methods

rnf :: EFSVolumeConfiguration -> () #

Eq EFSVolumeConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSVolumeConfiguration

Hashable EFSVolumeConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSVolumeConfiguration

type Rep EFSVolumeConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSVolumeConfiguration

type Rep EFSVolumeConfiguration = D1 ('MetaData "EFSVolumeConfiguration" "Amazonka.Batch.Types.EFSVolumeConfiguration" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "EFSVolumeConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "authorizationConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EFSAuthorizationConfig)) :*: S1 ('MetaSel ('Just "rootDirectory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "transitEncryption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EFSTransitEncryption)) :*: (S1 ('MetaSel ('Just "transitEncryptionPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "fileSystemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newEFSVolumeConfiguration Source #

Create a value of EFSVolumeConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:authorizationConfig:EFSVolumeConfiguration', eFSVolumeConfiguration_authorizationConfig - The authorization configuration details for the Amazon EFS file system.

$sel:rootDirectory:EFSVolumeConfiguration', eFSVolumeConfiguration_rootDirectory - The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume is used instead. Specifying / has the same effect as omitting this parameter. The maximum length is 4,096 characters.

If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to /, which enforces the path set on the Amazon EFS access point.

$sel:transitEncryption:EFSVolumeConfiguration', eFSVolumeConfiguration_transitEncryption - Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide.

$sel:transitEncryptionPort:EFSVolumeConfiguration', eFSVolumeConfiguration_transitEncryptionPort - The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you don't specify a transit encryption port, it uses the port selection strategy that the Amazon EFS mount helper uses. The value must be between 0 and 65,535. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.

$sel:fileSystemId:EFSVolumeConfiguration', eFSVolumeConfiguration_fileSystemId - The Amazon EFS file system ID to use.

Ec2Configuration

data Ec2Configuration Source #

Provides information used to select Amazon Machine Images (AMIs) for instances in the compute environment. If Ec2Configuration isn't specified, the default is ECS_AL2 (Amazon Linux 2).

This object isn't applicable to jobs that are running on Fargate resources.

See: newEc2Configuration smart constructor.

Instances

Instances details
FromJSON Ec2Configuration Source # 
Instance details

Defined in Amazonka.Batch.Types.Ec2Configuration

ToJSON Ec2Configuration Source # 
Instance details

Defined in Amazonka.Batch.Types.Ec2Configuration

Generic Ec2Configuration Source # 
Instance details

Defined in Amazonka.Batch.Types.Ec2Configuration

Associated Types

type Rep Ec2Configuration :: Type -> Type #

Read Ec2Configuration Source # 
Instance details

Defined in Amazonka.Batch.Types.Ec2Configuration

Show Ec2Configuration Source # 
Instance details

Defined in Amazonka.Batch.Types.Ec2Configuration

NFData Ec2Configuration Source # 
Instance details

Defined in Amazonka.Batch.Types.Ec2Configuration

Methods

rnf :: Ec2Configuration -> () #

Eq Ec2Configuration Source # 
Instance details

Defined in Amazonka.Batch.Types.Ec2Configuration

Hashable Ec2Configuration Source # 
Instance details

Defined in Amazonka.Batch.Types.Ec2Configuration

type Rep Ec2Configuration Source # 
Instance details

Defined in Amazonka.Batch.Types.Ec2Configuration

type Rep Ec2Configuration = D1 ('MetaData "Ec2Configuration" "Amazonka.Batch.Types.Ec2Configuration" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "Ec2Configuration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "imageIdOverride") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "imageKubernetesVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "imageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newEc2Configuration Source #

Create a value of Ec2Configuration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:imageIdOverride:Ec2Configuration', ec2Configuration_imageIdOverride - The AMI ID used for instances launched in the compute environment that match the image type. This setting overrides the imageId set in the computeResource object.

The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer Guide.

$sel:imageKubernetesVersion:Ec2Configuration', ec2Configuration_imageKubernetesVersion - The Kubernetes version for the compute environment. If you don't specify a value, the latest version that Batch supports is used.

$sel:imageType:Ec2Configuration', ec2Configuration_imageType - The image type to match with the instance type to select an AMI. The supported values are different for ECS and EKS resources.

ECS
If the imageIdOverride parameter isn't specified, then a recent Amazon ECS-optimized Amazon Linux 2 AMI (ECS_AL2) is used. If a new image type is specified in an update, but neither an imageId nor a imageIdOverride parameter is specified, then the latest Amazon ECS optimized AMI for that image type that's supported by Batch is used.
ECS_AL2
Amazon Linux 2: Default for all non-GPU instance families.
ECS_AL2_NVIDIA
Amazon Linux 2 (GPU): Default for all GPU instance families (for example P4 and G4) and can be used for all non Amazon Web Services Graviton-based instance types.
ECS_AL1
Amazon Linux. Amazon Linux has reached the end-of-life of standard support. For more information, see Amazon Linux AMI.
EKS
If the imageIdOverride parameter isn't specified, then a recent Amazon EKS-optimized Amazon Linux AMI (EKS_AL2) is used. If a new image type is specified in an update, but neither an imageId nor a imageIdOverride parameter is specified, then the latest Amazon EKS optimized AMI for that image type that Batch supports is used.
EKS_AL2
Amazon Linux 2: Default for all non-GPU instance families.
EKS_AL2_NVIDIA
Amazon Linux 2 (accelerated): Default for all GPU instance families (for example, P4 and G4) and can be used for all non Amazon Web Services Graviton-based instance types.

EksAttemptContainerDetail

data EksAttemptContainerDetail Source #

An object that represents the details for an attempt for a job attempt that an Amazon EKS container runs.

See: newEksAttemptContainerDetail smart constructor.

Instances

Instances details
FromJSON EksAttemptContainerDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksAttemptContainerDetail

Generic EksAttemptContainerDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksAttemptContainerDetail

Associated Types

type Rep EksAttemptContainerDetail :: Type -> Type #

Read EksAttemptContainerDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksAttemptContainerDetail

Show EksAttemptContainerDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksAttemptContainerDetail

NFData EksAttemptContainerDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksAttemptContainerDetail

Eq EksAttemptContainerDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksAttemptContainerDetail

Hashable EksAttemptContainerDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksAttemptContainerDetail

type Rep EksAttemptContainerDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksAttemptContainerDetail

type Rep EksAttemptContainerDetail = D1 ('MetaData "EksAttemptContainerDetail" "Amazonka.Batch.Types.EksAttemptContainerDetail" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "EksAttemptContainerDetail'" 'PrefixI 'True) (S1 ('MetaSel ('Just "exitCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newEksAttemptContainerDetail :: EksAttemptContainerDetail Source #

Create a value of EksAttemptContainerDetail with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:exitCode:EksAttemptContainerDetail', eksAttemptContainerDetail_exitCode - The exit code for the job attempt. A non-zero exit code is considered failed.

$sel:reason:EksAttemptContainerDetail', eksAttemptContainerDetail_reason - A short (255 max characters) human-readable string to provide additional details for a running or stopped container.

EksAttemptDetail

data EksAttemptDetail Source #

An object that represents the details of a job attempt for a job attempt by an Amazon EKS container.

See: newEksAttemptDetail smart constructor.

Instances

Instances details
FromJSON EksAttemptDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksAttemptDetail

Generic EksAttemptDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksAttemptDetail

Associated Types

type Rep EksAttemptDetail :: Type -> Type #

Read EksAttemptDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksAttemptDetail

Show EksAttemptDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksAttemptDetail

NFData EksAttemptDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksAttemptDetail

Methods

rnf :: EksAttemptDetail -> () #

Eq EksAttemptDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksAttemptDetail

Hashable EksAttemptDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksAttemptDetail

type Rep EksAttemptDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksAttemptDetail

newEksAttemptDetail :: EksAttemptDetail Source #

Create a value of EksAttemptDetail with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:containers:EksAttemptDetail', eksAttemptDetail_containers - The details for the final status of the containers for this job attempt.

$sel:nodeName:EksAttemptDetail', eksAttemptDetail_nodeName - The name of the node for this job attempt.

$sel:podName:EksAttemptDetail', eksAttemptDetail_podName - The name of the pod for this job attempt.

$sel:startedAt:EksAttemptDetail', eksAttemptDetail_startedAt - The Unix timestamp (in milliseconds) for when the attempt was started (when the attempt transitioned from the STARTING state to the RUNNING state).

$sel:statusReason:EksAttemptDetail', eksAttemptDetail_statusReason - A short, human-readable string to provide additional details for the current status of the job attempt.

$sel:stoppedAt:EksAttemptDetail', eksAttemptDetail_stoppedAt - The Unix timestamp (in milliseconds) for when the attempt was stopped. This happens when the attempt transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED.

EksConfiguration

data EksConfiguration Source #

Configuration for the Amazon EKS cluster that supports the Batch compute environment. The cluster must exist before the compute environment can be created.

See: newEksConfiguration smart constructor.

Instances

Instances details
FromJSON EksConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.EksConfiguration

ToJSON EksConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.EksConfiguration

Generic EksConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.EksConfiguration

Associated Types

type Rep EksConfiguration :: Type -> Type #

Read EksConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.EksConfiguration

Show EksConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.EksConfiguration

NFData EksConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.EksConfiguration

Methods

rnf :: EksConfiguration -> () #

Eq EksConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.EksConfiguration

Hashable EksConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.EksConfiguration

type Rep EksConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.EksConfiguration

type Rep EksConfiguration = D1 ('MetaData "EksConfiguration" "Amazonka.Batch.Types.EksConfiguration" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "EksConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "eksClusterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "kubernetesNamespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newEksConfiguration Source #

Create a value of EksConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:eksClusterArn:EksConfiguration', eksConfiguration_eksClusterArn - The Amazon Resource Name (ARN) of the Amazon EKS cluster. An example is arn:aws:eks:us-east-1:123456789012:cluster/ClusterForBatch .

$sel:kubernetesNamespace:EksConfiguration', eksConfiguration_kubernetesNamespace - The namespace of the Amazon EKS cluster. Batch manages pods in this namespace. The value can't left empty or null. It must be fewer than 64 characters long, can't be set to default, can't start with "kube-," and must match this regular expression: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$. For more information, see Namespaces in the Kubernetes documentation.

EksContainer

data EksContainer Source #

EKS container properties are used in job definitions for Amazon EKS based job definitions to describe the properties for a container node in the pod that's launched as part of a job. This can't be specified for Amazon ECS based job definitions.

See: newEksContainer smart constructor.

Instances

Instances details
FromJSON EksContainer Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainer

ToJSON EksContainer Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainer

Generic EksContainer Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainer

Associated Types

type Rep EksContainer :: Type -> Type #

Read EksContainer Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainer

Show EksContainer Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainer

NFData EksContainer Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainer

Methods

rnf :: EksContainer -> () #

Eq EksContainer Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainer

Hashable EksContainer Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainer

type Rep EksContainer Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainer

newEksContainer Source #

Create a value of EksContainer with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:args:EksContainer', eksContainer_args - An array of arguments to the entrypoint. If this isn't specified, the CMD of the container image is used. This corresponds to the args member in the Entrypoint portion of the Pod in Kubernetes. Environment variable references are expanded using the container's environment.

If the referenced environment variable doesn't exist, the reference in the command isn't changed. For example, if the reference is to "$(NAME1)" and the NAME1 environment variable doesn't exist, the command string will remain "$(NAME1)." $$ is replaced with $, and the resulting string isn't expanded. For example, $$(VAR_NAME) is passed as $(VAR_NAME) whether or not the VAR_NAME environment variable exists. For more information, see CMD in the Dockerfile reference and Define a command and arguments for a pod in the Kubernetes documentation.

$sel:command:EksContainer', eksContainer_command - The entrypoint for the container. This isn't run within a shell. If this isn't specified, the ENTRYPOINT of the container image is used. Environment variable references are expanded using the container's environment.

If the referenced environment variable doesn't exist, the reference in the command isn't changed. For example, if the reference is to "$(NAME1)" and the NAME1 environment variable doesn't exist, the command string will remain "$(NAME1)." $$ is replaced with $ and the resulting string isn't expanded. For example, $$(VAR_NAME) will be passed as $(VAR_NAME) whether or not the VAR_NAME environment variable exists. The entrypoint can't be updated. For more information, see ENTRYPOINT in the Dockerfile reference and Define a command and arguments for a container and Entrypoint in the Kubernetes documentation.

$sel:env:EksContainer', eksContainer_env - The environment variables to pass to a container.

Environment variables cannot start with "AWS_BATCH". This naming convention is reserved for variables that Batch sets.

$sel:imagePullPolicy:EksContainer', eksContainer_imagePullPolicy - The image pull policy for the container. Supported values are Always, IfNotPresent, and Never. This parameter defaults to IfNotPresent. However, if the :latest tag is specified, it defaults to Always. For more information, see Updating images in the Kubernetes documentation.

EksContainer, eksContainer_name - The name of the container. If the name isn't specified, the default name "Default" is used. Each container in a pod must have a unique name.

$sel:resources:EksContainer', eksContainer_resources - The type and amount of resources to assign to a container. The supported resources include memory, cpu, and nvidia.com/gpu. For more information, see Resource management for pods and containers in the Kubernetes documentation.

$sel:securityContext:EksContainer', eksContainer_securityContext - The security context for a job. For more information, see Configure a security context for a pod or container in the Kubernetes documentation.

$sel:volumeMounts:EksContainer', eksContainer_volumeMounts - The volume mounts for the container. Batch supports emptyDir, hostPath, and secret volume types. For more information about volumes and volume mounts in Kubernetes, see Volumes in the Kubernetes documentation.

$sel:image:EksContainer', eksContainer_image - The Docker image used to start the container.

EksContainerDetail

data EksContainerDetail Source #

The details for container properties that are returned by DescribeJobs for jobs that use Amazon EKS.

See: newEksContainerDetail smart constructor.

Instances

Instances details
FromJSON EksContainerDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerDetail

Generic EksContainerDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerDetail

Associated Types

type Rep EksContainerDetail :: Type -> Type #

Read EksContainerDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerDetail

Show EksContainerDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerDetail

NFData EksContainerDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerDetail

Methods

rnf :: EksContainerDetail -> () #

Eq EksContainerDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerDetail

Hashable EksContainerDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerDetail

type Rep EksContainerDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerDetail

type Rep EksContainerDetail = D1 ('MetaData "EksContainerDetail" "Amazonka.Batch.Types.EksContainerDetail" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "EksContainerDetail'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "args") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "command") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "env") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EksContainerEnvironmentVariable])) :*: (S1 ('MetaSel ('Just "exitCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "image") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "imagePullPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "resources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EksContainerResourceRequirements)) :*: (S1 ('MetaSel ('Just "securityContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EksContainerSecurityContext)) :*: S1 ('MetaSel ('Just "volumeMounts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EksContainerVolumeMount])))))))

newEksContainerDetail :: EksContainerDetail Source #

Create a value of EksContainerDetail with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:args:EksContainerDetail', eksContainerDetail_args - An array of arguments to the entrypoint. If this isn't specified, the CMD of the container image is used. This corresponds to the args member in the Entrypoint portion of the Pod in Kubernetes. Environment variable references are expanded using the container's environment.

If the referenced environment variable doesn't exist, the reference in the command isn't changed. For example, if the reference is to "$(NAME1)" and the NAME1 environment variable doesn't exist, the command string will remain "$(NAME1)". $$ is replaced with $ and the resulting string isn't expanded. For example, $$(VAR_NAME) is passed as $(VAR_NAME) whether or not the VAR_NAME environment variable exists. For more information, see CMD in the Dockerfile reference and Define a command and arguments for a pod in the Kubernetes documentation.

$sel:command:EksContainerDetail', eksContainerDetail_command - The entrypoint for the container. For more information, see Entrypoint in the Kubernetes documentation.

$sel:env:EksContainerDetail', eksContainerDetail_env - The environment variables to pass to a container.

Environment variables cannot start with "AWS_BATCH". This naming convention is reserved for variables that Batch sets.

$sel:exitCode:EksContainerDetail', eksContainerDetail_exitCode - The exit code for the job attempt. A non-zero exit code is considered failed.

$sel:image:EksContainerDetail', eksContainerDetail_image - The Docker image used to start the container.

$sel:imagePullPolicy:EksContainerDetail', eksContainerDetail_imagePullPolicy - The image pull policy for the container. Supported values are Always, IfNotPresent, and Never. This parameter defaults to Always if the :latest tag is specified, IfNotPresent otherwise. For more information, see Updating images in the Kubernetes documentation.

EksContainerDetail, eksContainerDetail_name - The name of the container. If the name isn't specified, the default name "Default" is used. Each container in a pod must have a unique name.

$sel:reason:EksContainerDetail', eksContainerDetail_reason - A short human-readable string to provide additional details for a running or stopped container. It can be up to 255 characters long.

$sel:resources:EksContainerDetail', eksContainerDetail_resources - The type and amount of resources to assign to a container. The supported resources include memory, cpu, and nvidia.com/gpu. For more information, see Resource management for pods and containers in the Kubernetes documentation.

$sel:securityContext:EksContainerDetail', eksContainerDetail_securityContext - The security context for a job. For more information, see Configure a security context for a pod or container in the Kubernetes documentation.

$sel:volumeMounts:EksContainerDetail', eksContainerDetail_volumeMounts - The volume mounts for the container. Batch supports emptyDir, hostPath, and secret volume types. For more information about volumes and volume mounts in Kubernetes, see Volumes in the Kubernetes documentation.

EksContainerEnvironmentVariable

data EksContainerEnvironmentVariable Source #

An environment variable.

See: newEksContainerEnvironmentVariable smart constructor.

Instances

Instances details
FromJSON EksContainerEnvironmentVariable Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerEnvironmentVariable

ToJSON EksContainerEnvironmentVariable Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerEnvironmentVariable

Generic EksContainerEnvironmentVariable Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerEnvironmentVariable

Associated Types

type Rep EksContainerEnvironmentVariable :: Type -> Type #

Read EksContainerEnvironmentVariable Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerEnvironmentVariable

Show EksContainerEnvironmentVariable Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerEnvironmentVariable

NFData EksContainerEnvironmentVariable Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerEnvironmentVariable

Eq EksContainerEnvironmentVariable Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerEnvironmentVariable

Hashable EksContainerEnvironmentVariable Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerEnvironmentVariable

type Rep EksContainerEnvironmentVariable Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerEnvironmentVariable

type Rep EksContainerEnvironmentVariable = D1 ('MetaData "EksContainerEnvironmentVariable" "Amazonka.Batch.Types.EksContainerEnvironmentVariable" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "EksContainerEnvironmentVariable'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newEksContainerEnvironmentVariable Source #

Create a value of EksContainerEnvironmentVariable with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:value:EksContainerEnvironmentVariable', eksContainerEnvironmentVariable_value - The value of the environment variable.

$sel:name:EksContainerEnvironmentVariable', eksContainerEnvironmentVariable_name - The name of the environment variable.

EksContainerOverride

data EksContainerOverride Source #

Object representing any Kubernetes overrides to a job definition that's used in a SubmitJob API operation.

See: newEksContainerOverride smart constructor.

Instances

Instances details
ToJSON EksContainerOverride Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerOverride

Generic EksContainerOverride Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerOverride

Associated Types

type Rep EksContainerOverride :: Type -> Type #

Read EksContainerOverride Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerOverride

Show EksContainerOverride Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerOverride

NFData EksContainerOverride Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerOverride

Methods

rnf :: EksContainerOverride -> () #

Eq EksContainerOverride Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerOverride

Hashable EksContainerOverride Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerOverride

type Rep EksContainerOverride Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerOverride

newEksContainerOverride :: EksContainerOverride Source #

Create a value of EksContainerOverride with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:args:EksContainerOverride', eksContainerOverride_args - The arguments to the entrypoint to send to the container that overrides the default arguments from the Docker image or the job definition. For more information, see CMD in the Dockerfile reference and Define a command an arguments for a pod in the Kubernetes documentation.

$sel:command:EksContainerOverride', eksContainerOverride_command - The command to send to the container that overrides the default command from the Docker image or the job definition.

$sel:env:EksContainerOverride', eksContainerOverride_env - The environment variables to send to the container. You can add new environment variables, which are added to the container at launch. Or, you can override the existing environment variables from the Docker image or the job definition.

Environment variables cannot start with "AWS_BATCH". This naming convention is reserved for variables that Batch sets.

$sel:image:EksContainerOverride', eksContainerOverride_image - The override of the Docker image that's used to start the container.

$sel:resources:EksContainerOverride', eksContainerOverride_resources - The type and amount of resources to assign to a container. These override the settings in the job definition. The supported resources include memory, cpu, and nvidia.com/gpu. For more information, see Resource management for pods and containers in the Kubernetes documentation.

EksContainerResourceRequirements

data EksContainerResourceRequirements Source #

The type and amount of resources to assign to a container. The supported resources include memory, cpu, and nvidia.com/gpu. For more information, see Resource management for pods and containers in the Kubernetes documentation.

See: newEksContainerResourceRequirements smart constructor.

Instances

Instances details
FromJSON EksContainerResourceRequirements Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerResourceRequirements

ToJSON EksContainerResourceRequirements Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerResourceRequirements

Generic EksContainerResourceRequirements Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerResourceRequirements

Associated Types

type Rep EksContainerResourceRequirements :: Type -> Type #

Read EksContainerResourceRequirements Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerResourceRequirements

Show EksContainerResourceRequirements Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerResourceRequirements

NFData EksContainerResourceRequirements Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerResourceRequirements

Eq EksContainerResourceRequirements Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerResourceRequirements

Hashable EksContainerResourceRequirements Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerResourceRequirements

type Rep EksContainerResourceRequirements Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerResourceRequirements

type Rep EksContainerResourceRequirements = D1 ('MetaData "EksContainerResourceRequirements" "Amazonka.Batch.Types.EksContainerResourceRequirements" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "EksContainerResourceRequirements'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "requests") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))

newEksContainerResourceRequirements :: EksContainerResourceRequirements Source #

Create a value of EksContainerResourceRequirements with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:limits:EksContainerResourceRequirements', eksContainerResourceRequirements_limits - The type and quantity of the resources to reserve for the container. The values vary based on the name that's specified. Resources can be requested using either the limits or the requests objects.

memory
The memory hard limit (in MiB) for the container, using whole integers, with a "Mi" suffix. If your container attempts to exceed the memory specified, the container is terminated. You must specify at least 4 MiB of memory for a job. memory can be specified in limits, requests, or both. If memory is specified in both places, then the value that's specified in limits must be equal to the value that's specified in requests.

To maximize your resource utilization, provide your jobs with as much memory as possible for the specific instance type that you are using. To learn how, see Memory management in the Batch User Guide.

cpu
The number of CPUs that's reserved for the container. Values must be an even multiple of 0.25. cpu can be specified in limits, requests, or both. If cpu is specified in both places, then the value that's specified in limits must be at least as large as the value that's specified in requests.
nvidia.com/gpu
The number of GPUs that's reserved for the container. Values must be a whole integer. memory can be specified in limits, requests, or both. If memory is specified in both places, then the value that's specified in limits must be equal to the value that's specified in requests.

$sel:requests:EksContainerResourceRequirements', eksContainerResourceRequirements_requests - The type and quantity of the resources to request for the container. The values vary based on the name that's specified. Resources can be requested by using either the limits or the requests objects.

memory
The memory hard limit (in MiB) for the container, using whole integers, with a "Mi" suffix. If your container attempts to exceed the memory specified, the container is terminated. You must specify at least 4 MiB of memory for a job. memory can be specified in limits, requests, or both. If memory is specified in both, then the value that's specified in limits must be equal to the value that's specified in requests.

If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory management in the Batch User Guide.

cpu
The number of CPUs that are reserved for the container. Values must be an even multiple of 0.25. cpu can be specified in limits, requests, or both. If cpu is specified in both, then the value that's specified in limits must be at least as large as the value that's specified in requests.
nvidia.com/gpu
The number of GPUs that are reserved for the container. Values must be a whole integer. nvidia.com/gpu can be specified in limits, requests, or both. If nvidia.com/gpu is specified in both, then the value that's specified in limits must be equal to the value that's specified in requests.

EksContainerSecurityContext

data EksContainerSecurityContext Source #

The security context for a job. For more information, see Configure a security context for a pod or container in the Kubernetes documentation.

See: newEksContainerSecurityContext smart constructor.

Instances

Instances details
FromJSON EksContainerSecurityContext Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerSecurityContext

ToJSON EksContainerSecurityContext Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerSecurityContext

Generic EksContainerSecurityContext Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerSecurityContext

Associated Types

type Rep EksContainerSecurityContext :: Type -> Type #

Read EksContainerSecurityContext Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerSecurityContext

Show EksContainerSecurityContext Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerSecurityContext

NFData EksContainerSecurityContext Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerSecurityContext

Eq EksContainerSecurityContext Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerSecurityContext

Hashable EksContainerSecurityContext Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerSecurityContext

type Rep EksContainerSecurityContext Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerSecurityContext

type Rep EksContainerSecurityContext = D1 ('MetaData "EksContainerSecurityContext" "Amazonka.Batch.Types.EksContainerSecurityContext" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "EksContainerSecurityContext'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "privileged") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "readOnlyRootFilesystem") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "runAsGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "runAsNonRoot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "runAsUser") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))))

newEksContainerSecurityContext :: EksContainerSecurityContext Source #

Create a value of EksContainerSecurityContext with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:privileged:EksContainerSecurityContext', eksContainerSecurityContext_privileged - When this parameter is true, the container is given elevated permissions on the host container instance. The level of permissions are similar to the root user permissions. The default value is false. This parameter maps to privileged policy in the Privileged pod security policies in the Kubernetes documentation.

$sel:readOnlyRootFilesystem:EksContainerSecurityContext', eksContainerSecurityContext_readOnlyRootFilesystem - When this parameter is true, the container is given read-only access to its root file system. The default value is false. This parameter maps to ReadOnlyRootFilesystem policy in the Volumes and file systems pod security policies in the Kubernetes documentation.

$sel:runAsGroup:EksContainerSecurityContext', eksContainerSecurityContext_runAsGroup - When this parameter is specified, the container is run as the specified group ID (gid). If this parameter isn't specified, the default is the group that's specified in the image metadata. This parameter maps to RunAsGroup and MustRunAs policy in the Users and groups pod security policies in the Kubernetes documentation.

$sel:runAsNonRoot:EksContainerSecurityContext', eksContainerSecurityContext_runAsNonRoot - When this parameter is specified, the container is run as a user with a uid other than 0. If this parameter isn't specified, so such rule is enforced. This parameter maps to RunAsUser and MustRunAsNonRoot policy in the Users and groups pod security policies in the Kubernetes documentation.

$sel:runAsUser:EksContainerSecurityContext', eksContainerSecurityContext_runAsUser - When this parameter is specified, the container is run as the specified user ID (uid). If this parameter isn't specified, the default is the user that's specified in the image metadata. This parameter maps to RunAsUser and MustRanAs policy in the Users and groups pod security policies in the Kubernetes documentation.

EksContainerVolumeMount

data EksContainerVolumeMount Source #

The volume mounts for a container for an Amazon EKS job. For more information about volumes and volume mounts in Kubernetes, see Volumes in the Kubernetes documentation.

See: newEksContainerVolumeMount smart constructor.

Instances

Instances details
FromJSON EksContainerVolumeMount Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerVolumeMount

ToJSON EksContainerVolumeMount Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerVolumeMount

Generic EksContainerVolumeMount Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerVolumeMount

Associated Types

type Rep EksContainerVolumeMount :: Type -> Type #

Read EksContainerVolumeMount Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerVolumeMount

Show EksContainerVolumeMount Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerVolumeMount

NFData EksContainerVolumeMount Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerVolumeMount

Methods

rnf :: EksContainerVolumeMount -> () #

Eq EksContainerVolumeMount Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerVolumeMount

Hashable EksContainerVolumeMount Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerVolumeMount

type Rep EksContainerVolumeMount Source # 
Instance details

Defined in Amazonka.Batch.Types.EksContainerVolumeMount

type Rep EksContainerVolumeMount = D1 ('MetaData "EksContainerVolumeMount" "Amazonka.Batch.Types.EksContainerVolumeMount" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "EksContainerVolumeMount'" 'PrefixI 'True) (S1 ('MetaSel ('Just "mountPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "readOnly") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))

newEksContainerVolumeMount :: EksContainerVolumeMount Source #

Create a value of EksContainerVolumeMount with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:mountPath:EksContainerVolumeMount', eksContainerVolumeMount_mountPath - The path on the container where the volume is mounted.

$sel:name:EksContainerVolumeMount', eksContainerVolumeMount_name - The name the volume mount. This must match the name of one of the volumes in the pod.

$sel:readOnly:EksContainerVolumeMount', eksContainerVolumeMount_readOnly - If this value is true, the container has read-only access to the volume. Otherwise, the container can write to the volume. The default value is false.

EksEmptyDir

data EksEmptyDir Source #

Specifies the configuration of a Kubernetes emptyDir volume. An emptyDir volume is first created when a pod is assigned to a node. It exists as long as that pod is running on that node. The emptyDir volume is initially empty. All containers in the pod can read and write the files in the emptyDir volume. However, the emptyDir volume can be mounted at the same or different paths in each container. When a pod is removed from a node for any reason, the data in the emptyDir is deleted permanently. For more information, see emptyDir in the Kubernetes documentation.

See: newEksEmptyDir smart constructor.

Constructors

EksEmptyDir' (Maybe Text) (Maybe Text) 

Instances

Instances details
FromJSON EksEmptyDir Source # 
Instance details

Defined in Amazonka.Batch.Types.EksEmptyDir

ToJSON EksEmptyDir Source # 
Instance details

Defined in Amazonka.Batch.Types.EksEmptyDir

Generic EksEmptyDir Source # 
Instance details

Defined in Amazonka.Batch.Types.EksEmptyDir

Associated Types

type Rep EksEmptyDir :: Type -> Type #

Read EksEmptyDir Source # 
Instance details

Defined in Amazonka.Batch.Types.EksEmptyDir

Show EksEmptyDir Source # 
Instance details

Defined in Amazonka.Batch.Types.EksEmptyDir

NFData EksEmptyDir Source # 
Instance details

Defined in Amazonka.Batch.Types.EksEmptyDir

Methods

rnf :: EksEmptyDir -> () #

Eq EksEmptyDir Source # 
Instance details

Defined in Amazonka.Batch.Types.EksEmptyDir

Hashable EksEmptyDir Source # 
Instance details

Defined in Amazonka.Batch.Types.EksEmptyDir

type Rep EksEmptyDir Source # 
Instance details

Defined in Amazonka.Batch.Types.EksEmptyDir

type Rep EksEmptyDir = D1 ('MetaData "EksEmptyDir" "Amazonka.Batch.Types.EksEmptyDir" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "EksEmptyDir'" 'PrefixI 'True) (S1 ('MetaSel ('Just "medium") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sizeLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newEksEmptyDir :: EksEmptyDir Source #

Create a value of EksEmptyDir with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:medium:EksEmptyDir', eksEmptyDir_medium - The medium to store the volume. The default value is an empty string, which uses the storage of the node.

""
(Default) Use the disk storage of the node.
"Memory"
Use the tmpfs volume that's backed by the RAM of the node. Contents of the volume are lost when the node reboots, and any storage on the volume counts against the container's memory limit.

$sel:sizeLimit:EksEmptyDir', eksEmptyDir_sizeLimit - The maximum size of the volume. By default, there's no maximum size defined.

EksHostPath

data EksHostPath Source #

Specifies the configuration of a Kubernetes hostPath volume. A hostPath volume mounts an existing file or directory from the host node's filesystem into your pod. For more information, see hostPath in the Kubernetes documentation.

See: newEksHostPath smart constructor.

Constructors

EksHostPath' (Maybe Text) 

Instances

Instances details
FromJSON EksHostPath Source # 
Instance details

Defined in Amazonka.Batch.Types.EksHostPath

ToJSON EksHostPath Source # 
Instance details

Defined in Amazonka.Batch.Types.EksHostPath

Generic EksHostPath Source # 
Instance details

Defined in Amazonka.Batch.Types.EksHostPath

Associated Types

type Rep EksHostPath :: Type -> Type #

Read EksHostPath Source # 
Instance details

Defined in Amazonka.Batch.Types.EksHostPath

Show EksHostPath Source # 
Instance details

Defined in Amazonka.Batch.Types.EksHostPath

NFData EksHostPath Source # 
Instance details

Defined in Amazonka.Batch.Types.EksHostPath

Methods

rnf :: EksHostPath -> () #

Eq EksHostPath Source # 
Instance details

Defined in Amazonka.Batch.Types.EksHostPath

Hashable EksHostPath Source # 
Instance details

Defined in Amazonka.Batch.Types.EksHostPath

type Rep EksHostPath Source # 
Instance details

Defined in Amazonka.Batch.Types.EksHostPath

type Rep EksHostPath = D1 ('MetaData "EksHostPath" "Amazonka.Batch.Types.EksHostPath" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "EksHostPath'" 'PrefixI 'True) (S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newEksHostPath :: EksHostPath Source #

Create a value of EksHostPath with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:path:EksHostPath', eksHostPath_path - The path of the file or directory on the host to mount into containers on the pod.

EksPodProperties

data EksPodProperties Source #

The properties for the pod.

See: newEksPodProperties smart constructor.

Instances

Instances details
FromJSON EksPodProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPodProperties

ToJSON EksPodProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPodProperties

Generic EksPodProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPodProperties

Associated Types

type Rep EksPodProperties :: Type -> Type #

Read EksPodProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPodProperties

Show EksPodProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPodProperties

NFData EksPodProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPodProperties

Methods

rnf :: EksPodProperties -> () #

Eq EksPodProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPodProperties

Hashable EksPodProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPodProperties

type Rep EksPodProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPodProperties

type Rep EksPodProperties = D1 ('MetaData "EksPodProperties" "Amazonka.Batch.Types.EksPodProperties" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "EksPodProperties'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "containers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EksContainer])) :*: S1 ('MetaSel ('Just "dnsPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "hostNetwork") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "serviceAccountName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "volumes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EksVolume]))))))

newEksPodProperties :: EksPodProperties Source #

Create a value of EksPodProperties with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:containers:EksPodProperties', eksPodProperties_containers - The properties of the container that's used on the Amazon EKS pod.

$sel:dnsPolicy:EksPodProperties', eksPodProperties_dnsPolicy - The DNS policy for the pod. The default value is ClusterFirst. If the hostNetwork parameter is not specified, the default is ClusterFirstWithHostNet. ClusterFirst indicates that any DNS query that does not match the configured cluster domain suffix is forwarded to the upstream nameserver inherited from the node. For more information, see Pod's DNS policy in the Kubernetes documentation.

Valid values: Default | ClusterFirst | ClusterFirstWithHostNet

$sel:hostNetwork:EksPodProperties', eksPodProperties_hostNetwork - Indicates if the pod uses the hosts' network IP address. The default value is true. Setting this to false enables the Kubernetes pod networking model. Most Batch workloads are egress-only and don't require the overhead of IP allocation for each pod for incoming connections. For more information, see Host namespaces and Pod networking in the Kubernetes documentation.

$sel:serviceAccountName:EksPodProperties', eksPodProperties_serviceAccountName - The name of the service account that's used to run the pod. For more information, see Kubernetes service accounts and Configure a Kubernetes service account to assume an IAM role in the Amazon EKS User Guide and Configure service accounts for pods in the Kubernetes documentation.

$sel:volumes:EksPodProperties', eksPodProperties_volumes - Specifies the volumes for a job definition that uses Amazon EKS resources.

EksPodPropertiesDetail

data EksPodPropertiesDetail Source #

The details for the pod.

See: newEksPodPropertiesDetail smart constructor.

Instances

Instances details
FromJSON EksPodPropertiesDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPodPropertiesDetail

Generic EksPodPropertiesDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPodPropertiesDetail

Associated Types

type Rep EksPodPropertiesDetail :: Type -> Type #

Read EksPodPropertiesDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPodPropertiesDetail

Show EksPodPropertiesDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPodPropertiesDetail

NFData EksPodPropertiesDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPodPropertiesDetail

Methods

rnf :: EksPodPropertiesDetail -> () #

Eq EksPodPropertiesDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPodPropertiesDetail

Hashable EksPodPropertiesDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPodPropertiesDetail

type Rep EksPodPropertiesDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPodPropertiesDetail

type Rep EksPodPropertiesDetail = D1 ('MetaData "EksPodPropertiesDetail" "Amazonka.Batch.Types.EksPodPropertiesDetail" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "EksPodPropertiesDetail'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "containers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EksContainerDetail])) :*: (S1 ('MetaSel ('Just "dnsPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "hostNetwork") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "nodeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "podName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "serviceAccountName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "volumes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EksVolume]))))))

newEksPodPropertiesDetail :: EksPodPropertiesDetail Source #

Create a value of EksPodPropertiesDetail with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:containers:EksPodPropertiesDetail', eksPodPropertiesDetail_containers - The properties of the container that's used on the Amazon EKS pod.

$sel:dnsPolicy:EksPodPropertiesDetail', eksPodPropertiesDetail_dnsPolicy - The DNS policy for the pod. The default value is ClusterFirst. If the hostNetwork parameter is not specified, the default is ClusterFirstWithHostNet. ClusterFirst indicates that any DNS query that does not match the configured cluster domain suffix is forwarded to the upstream nameserver inherited from the node. If no value was specified for dnsPolicy in the RegisterJobDefinition API operation, then no value will be returned for dnsPolicy by either of DescribeJobDefinitions or DescribeJobs API operations. The pod spec setting will contain either ClusterFirst or ClusterFirstWithHostNet, depending on the value of the hostNetwork parameter. For more information, see Pod's DNS policy in the Kubernetes documentation.

Valid values: Default | ClusterFirst | ClusterFirstWithHostNet

$sel:hostNetwork:EksPodPropertiesDetail', eksPodPropertiesDetail_hostNetwork - Indicates if the pod uses the hosts' network IP address. The default value is true. Setting this to false enables the Kubernetes pod networking model. Most Batch workloads are egress-only and don't require the overhead of IP allocation for each pod for incoming connections. For more information, see Host namespaces and Pod networking in the Kubernetes documentation.

$sel:nodeName:EksPodPropertiesDetail', eksPodPropertiesDetail_nodeName - The name of the node for this job.

$sel:podName:EksPodPropertiesDetail', eksPodPropertiesDetail_podName - The name of the pod for this job.

$sel:serviceAccountName:EksPodPropertiesDetail', eksPodPropertiesDetail_serviceAccountName - The name of the service account that's used to run the pod. For more information, see Kubernetes service accounts and Configure a Kubernetes service account to assume an IAM role in the Amazon EKS User Guide and Configure service accounts for pods in the Kubernetes documentation.

$sel:volumes:EksPodPropertiesDetail', eksPodPropertiesDetail_volumes - Specifies the volumes for a job definition using Amazon EKS resources.

EksPodPropertiesOverride

data EksPodPropertiesOverride Source #

An object that contains overrides for the Kubernetes pod properties of a job.

See: newEksPodPropertiesOverride smart constructor.

Instances

Instances details
ToJSON EksPodPropertiesOverride Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPodPropertiesOverride

Generic EksPodPropertiesOverride Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPodPropertiesOverride

Associated Types

type Rep EksPodPropertiesOverride :: Type -> Type #

Read EksPodPropertiesOverride Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPodPropertiesOverride

Show EksPodPropertiesOverride Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPodPropertiesOverride

NFData EksPodPropertiesOverride Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPodPropertiesOverride

Eq EksPodPropertiesOverride Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPodPropertiesOverride

Hashable EksPodPropertiesOverride Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPodPropertiesOverride

type Rep EksPodPropertiesOverride Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPodPropertiesOverride

type Rep EksPodPropertiesOverride = D1 ('MetaData "EksPodPropertiesOverride" "Amazonka.Batch.Types.EksPodPropertiesOverride" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "EksPodPropertiesOverride'" 'PrefixI 'True) (S1 ('MetaSel ('Just "containers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EksContainerOverride]))))

newEksPodPropertiesOverride :: EksPodPropertiesOverride Source #

Create a value of EksPodPropertiesOverride with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:containers:EksPodPropertiesOverride', eksPodPropertiesOverride_containers - The overrides for the container that's used on the Amazon EKS pod.

EksProperties

data EksProperties Source #

An object that contains the properties for the Kubernetes resources of a job.

See: newEksProperties smart constructor.

Instances

Instances details
FromJSON EksProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.EksProperties

ToJSON EksProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.EksProperties

Generic EksProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.EksProperties

Associated Types

type Rep EksProperties :: Type -> Type #

Read EksProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.EksProperties

Show EksProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.EksProperties

NFData EksProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.EksProperties

Methods

rnf :: EksProperties -> () #

Eq EksProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.EksProperties

Hashable EksProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.EksProperties

type Rep EksProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.EksProperties

type Rep EksProperties = D1 ('MetaData "EksProperties" "Amazonka.Batch.Types.EksProperties" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "EksProperties'" 'PrefixI 'True) (S1 ('MetaSel ('Just "podProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EksPodProperties))))

newEksProperties :: EksProperties Source #

Create a value of EksProperties with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:podProperties:EksProperties', eksProperties_podProperties - The properties for the Kubernetes pod resources of a job.

EksPropertiesDetail

data EksPropertiesDetail Source #

An object that contains the details for the Kubernetes resources of a job.

See: newEksPropertiesDetail smart constructor.

Instances

Instances details
FromJSON EksPropertiesDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPropertiesDetail

Generic EksPropertiesDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPropertiesDetail

Associated Types

type Rep EksPropertiesDetail :: Type -> Type #

Read EksPropertiesDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPropertiesDetail

Show EksPropertiesDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPropertiesDetail

NFData EksPropertiesDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPropertiesDetail

Methods

rnf :: EksPropertiesDetail -> () #

Eq EksPropertiesDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPropertiesDetail

Hashable EksPropertiesDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPropertiesDetail

type Rep EksPropertiesDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPropertiesDetail

type Rep EksPropertiesDetail = D1 ('MetaData "EksPropertiesDetail" "Amazonka.Batch.Types.EksPropertiesDetail" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "EksPropertiesDetail'" 'PrefixI 'True) (S1 ('MetaSel ('Just "podProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EksPodPropertiesDetail))))

newEksPropertiesDetail :: EksPropertiesDetail Source #

Create a value of EksPropertiesDetail with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:podProperties:EksPropertiesDetail', eksPropertiesDetail_podProperties - The properties for the Kubernetes pod resources of a job.

EksPropertiesOverride

data EksPropertiesOverride Source #

An object that contains overrides for the Kubernetes resources of a job.

See: newEksPropertiesOverride smart constructor.

Instances

Instances details
ToJSON EksPropertiesOverride Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPropertiesOverride

Generic EksPropertiesOverride Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPropertiesOverride

Associated Types

type Rep EksPropertiesOverride :: Type -> Type #

Read EksPropertiesOverride Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPropertiesOverride

Show EksPropertiesOverride Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPropertiesOverride

NFData EksPropertiesOverride Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPropertiesOverride

Methods

rnf :: EksPropertiesOverride -> () #

Eq EksPropertiesOverride Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPropertiesOverride

Hashable EksPropertiesOverride Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPropertiesOverride

type Rep EksPropertiesOverride Source # 
Instance details

Defined in Amazonka.Batch.Types.EksPropertiesOverride

type Rep EksPropertiesOverride = D1 ('MetaData "EksPropertiesOverride" "Amazonka.Batch.Types.EksPropertiesOverride" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "EksPropertiesOverride'" 'PrefixI 'True) (S1 ('MetaSel ('Just "podProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EksPodPropertiesOverride))))

newEksPropertiesOverride :: EksPropertiesOverride Source #

Create a value of EksPropertiesOverride with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:podProperties:EksPropertiesOverride', eksPropertiesOverride_podProperties - The overrides for the Kubernetes pod resources of a job.

EksSecret

data EksSecret Source #

Specifies the configuration of a Kubernetes secret volume. For more information, see secret in the Kubernetes documentation.

See: newEksSecret smart constructor.

Constructors

EksSecret' (Maybe Bool) Text 

Instances

Instances details
FromJSON EksSecret Source # 
Instance details

Defined in Amazonka.Batch.Types.EksSecret

ToJSON EksSecret Source # 
Instance details

Defined in Amazonka.Batch.Types.EksSecret

Generic EksSecret Source # 
Instance details

Defined in Amazonka.Batch.Types.EksSecret

Associated Types

type Rep EksSecret :: Type -> Type #

Read EksSecret Source # 
Instance details

Defined in Amazonka.Batch.Types.EksSecret

Show EksSecret Source # 
Instance details

Defined in Amazonka.Batch.Types.EksSecret

NFData EksSecret Source # 
Instance details

Defined in Amazonka.Batch.Types.EksSecret

Methods

rnf :: EksSecret -> () #

Eq EksSecret Source # 
Instance details

Defined in Amazonka.Batch.Types.EksSecret

Hashable EksSecret Source # 
Instance details

Defined in Amazonka.Batch.Types.EksSecret

type Rep EksSecret Source # 
Instance details

Defined in Amazonka.Batch.Types.EksSecret

type Rep EksSecret = D1 ('MetaData "EksSecret" "Amazonka.Batch.Types.EksSecret" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "EksSecret'" 'PrefixI 'True) (S1 ('MetaSel ('Just "optional") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "secretName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newEksSecret Source #

Create a value of EksSecret with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:optional:EksSecret', eksSecret_optional - Specifies whether the secret or the secret's keys must be defined.

$sel:secretName:EksSecret', eksSecret_secretName - The name of the secret. The name must be allowed as a DNS subdomain name. For more information, see DNS subdomain names in the Kubernetes documentation.

EksVolume

data EksVolume Source #

Specifies an Amazon EKS volume for a job definition.

See: newEksVolume smart constructor.

Instances

Instances details
FromJSON EksVolume Source # 
Instance details

Defined in Amazonka.Batch.Types.EksVolume

ToJSON EksVolume Source # 
Instance details

Defined in Amazonka.Batch.Types.EksVolume

Generic EksVolume Source # 
Instance details

Defined in Amazonka.Batch.Types.EksVolume

Associated Types

type Rep EksVolume :: Type -> Type #

Read EksVolume Source # 
Instance details

Defined in Amazonka.Batch.Types.EksVolume

Show EksVolume Source # 
Instance details

Defined in Amazonka.Batch.Types.EksVolume

NFData EksVolume Source # 
Instance details

Defined in Amazonka.Batch.Types.EksVolume

Methods

rnf :: EksVolume -> () #

Eq EksVolume Source # 
Instance details

Defined in Amazonka.Batch.Types.EksVolume

Hashable EksVolume Source # 
Instance details

Defined in Amazonka.Batch.Types.EksVolume

type Rep EksVolume Source # 
Instance details

Defined in Amazonka.Batch.Types.EksVolume

type Rep EksVolume = D1 ('MetaData "EksVolume" "Amazonka.Batch.Types.EksVolume" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "EksVolume'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "emptyDir") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EksEmptyDir)) :*: S1 ('MetaSel ('Just "hostPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EksHostPath))) :*: (S1 ('MetaSel ('Just "secret") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EksSecret)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newEksVolume Source #

Create a value of EksVolume with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:emptyDir:EksVolume', eksVolume_emptyDir - Specifies the configuration of a Kubernetes emptyDir volume. For more information, see emptyDir in the Kubernetes documentation.

$sel:hostPath:EksVolume', eksVolume_hostPath - Specifies the configuration of a Kubernetes hostPath volume. For more information, see hostPath in the Kubernetes documentation.

$sel:secret:EksVolume', eksVolume_secret - Specifies the configuration of a Kubernetes secret volume. For more information, see secret in the Kubernetes documentation.

$sel:name:EksVolume', eksVolume_name - The name of the volume. The name must be allowed as a DNS subdomain name. For more information, see DNS subdomain names in the Kubernetes documentation.

EvaluateOnExit

data EvaluateOnExit Source #

Specifies an array of up to 5 conditions to be met, and an action to take (RETRY or EXIT) if all conditions are met. If none of the EvaluateOnExit conditions in a RetryStrategy match, then the job is retried.

See: newEvaluateOnExit smart constructor.

Instances

Instances details
FromJSON EvaluateOnExit Source # 
Instance details

Defined in Amazonka.Batch.Types.EvaluateOnExit

ToJSON EvaluateOnExit Source # 
Instance details

Defined in Amazonka.Batch.Types.EvaluateOnExit

Generic EvaluateOnExit Source # 
Instance details

Defined in Amazonka.Batch.Types.EvaluateOnExit

Associated Types

type Rep EvaluateOnExit :: Type -> Type #

Read EvaluateOnExit Source # 
Instance details

Defined in Amazonka.Batch.Types.EvaluateOnExit

Show EvaluateOnExit Source # 
Instance details

Defined in Amazonka.Batch.Types.EvaluateOnExit

NFData EvaluateOnExit Source # 
Instance details

Defined in Amazonka.Batch.Types.EvaluateOnExit

Methods

rnf :: EvaluateOnExit -> () #

Eq EvaluateOnExit Source # 
Instance details

Defined in Amazonka.Batch.Types.EvaluateOnExit

Hashable EvaluateOnExit Source # 
Instance details

Defined in Amazonka.Batch.Types.EvaluateOnExit

type Rep EvaluateOnExit Source # 
Instance details

Defined in Amazonka.Batch.Types.EvaluateOnExit

type Rep EvaluateOnExit = D1 ('MetaData "EvaluateOnExit" "Amazonka.Batch.Types.EvaluateOnExit" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "EvaluateOnExit'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "onExitCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "onReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "onStatusReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "action") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RetryAction))))

newEvaluateOnExit Source #

Create a value of EvaluateOnExit with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:onExitCode:EvaluateOnExit', evaluateOnExit_onExitCode - Contains a glob pattern to match against the decimal representation of the ExitCode returned for a job. The pattern can be up to 512 characters long. It can contain only numbers, and can end with an asterisk (*) so that only the start of the string needs to be an exact match.

The string can contain up to 512 characters.

$sel:onReason:EvaluateOnExit', evaluateOnExit_onReason - Contains a glob pattern to match against the Reason returned for a job. The pattern can contain up to 512 characters. It can contain letters, numbers, periods (.), colons (:), and white space (including spaces and tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.

$sel:onStatusReason:EvaluateOnExit', evaluateOnExit_onStatusReason - Contains a glob pattern to match against the StatusReason returned for a job. The pattern can contain up to 512 characters. It can contain letters, numbers, periods (.), colons (:), and white spaces (including spaces or tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.

$sel:action:EvaluateOnExit', evaluateOnExit_action - Specifies the action to take if all of the specified conditions (onStatusReason, onReason, and onExitCode) are met. The values aren't case sensitive.

FairsharePolicy

data FairsharePolicy Source #

The fair share policy for a scheduling policy.

See: newFairsharePolicy smart constructor.

Instances

Instances details
FromJSON FairsharePolicy Source # 
Instance details

Defined in Amazonka.Batch.Types.FairsharePolicy

ToJSON FairsharePolicy Source # 
Instance details

Defined in Amazonka.Batch.Types.FairsharePolicy

Generic FairsharePolicy Source # 
Instance details

Defined in Amazonka.Batch.Types.FairsharePolicy

Associated Types

type Rep FairsharePolicy :: Type -> Type #

Read FairsharePolicy Source # 
Instance details

Defined in Amazonka.Batch.Types.FairsharePolicy

Show FairsharePolicy Source # 
Instance details

Defined in Amazonka.Batch.Types.FairsharePolicy

NFData FairsharePolicy Source # 
Instance details

Defined in Amazonka.Batch.Types.FairsharePolicy

Methods

rnf :: FairsharePolicy -> () #

Eq FairsharePolicy Source # 
Instance details

Defined in Amazonka.Batch.Types.FairsharePolicy

Hashable FairsharePolicy Source # 
Instance details

Defined in Amazonka.Batch.Types.FairsharePolicy

type Rep FairsharePolicy Source # 
Instance details

Defined in Amazonka.Batch.Types.FairsharePolicy

type Rep FairsharePolicy = D1 ('MetaData "FairsharePolicy" "Amazonka.Batch.Types.FairsharePolicy" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "FairsharePolicy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "computeReservation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "shareDecaySeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "shareDistribution") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ShareAttributes])))))

newFairsharePolicy :: FairsharePolicy Source #

Create a value of FairsharePolicy with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:computeReservation:FairsharePolicy', fairsharePolicy_computeReservation - A value used to reserve some of the available maximum vCPU for fair share identifiers that aren't already used.

The reserved ratio is (computeReservation/100)^ActiveFairShares where ActiveFairShares is the number of active fair share identifiers.

For example, a computeReservation value of 50 indicates that Batchreserves 50% of the maximum available vCPU if there's only one fair share identifier. It reserves 25% if there are two fair share identifiers. It reserves 12.5% if there are three fair share identifiers. A computeReservation value of 25 indicates that Batch should reserve 25% of the maximum available vCPU if there's only one fair share identifier, 6.25% if there are two fair share identifiers, and 1.56% if there are three fair share identifiers.

The minimum value is 0 and the maximum value is 99.

$sel:shareDecaySeconds:FairsharePolicy', fairsharePolicy_shareDecaySeconds - The amount of time (in seconds) to use to calculate a fair share percentage for each fair share identifier in use. A value of zero (0) indicates that only current usage is measured. The decay allows for more recently run jobs to have more weight than jobs that ran earlier. The maximum supported value is 604800 (1 week).

$sel:shareDistribution:FairsharePolicy', fairsharePolicy_shareDistribution - An array of SharedIdentifier objects that contain the weights for the fair share identifiers for the fair share policy. Fair share identifiers that aren't included have a default weight of 1.0.

FargatePlatformConfiguration

data FargatePlatformConfiguration Source #

The platform configuration for jobs that are running on Fargate resources. Jobs that run on EC2 resources must not specify this parameter.

See: newFargatePlatformConfiguration smart constructor.

Instances

Instances details
FromJSON FargatePlatformConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.FargatePlatformConfiguration

ToJSON FargatePlatformConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.FargatePlatformConfiguration

Generic FargatePlatformConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.FargatePlatformConfiguration

Associated Types

type Rep FargatePlatformConfiguration :: Type -> Type #

Read FargatePlatformConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.FargatePlatformConfiguration

Show FargatePlatformConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.FargatePlatformConfiguration

NFData FargatePlatformConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.FargatePlatformConfiguration

Eq FargatePlatformConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.FargatePlatformConfiguration

Hashable FargatePlatformConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.FargatePlatformConfiguration

type Rep FargatePlatformConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.FargatePlatformConfiguration

type Rep FargatePlatformConfiguration = D1 ('MetaData "FargatePlatformConfiguration" "Amazonka.Batch.Types.FargatePlatformConfiguration" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "FargatePlatformConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "platformVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newFargatePlatformConfiguration :: FargatePlatformConfiguration Source #

Create a value of FargatePlatformConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:platformVersion:FargatePlatformConfiguration', fargatePlatformConfiguration_platformVersion - The Fargate platform version where the jobs are running. A platform version is specified only for jobs that are running on Fargate resources. If one isn't specified, the LATEST platform version is used by default. This uses a recent, approved version of the Fargate platform for compute resources. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

Host

data Host Source #

Determine whether your data volume persists on the host container instance and where it's stored. If this parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.

See: newHost smart constructor.

Constructors

Host' (Maybe Text) 

Instances

Instances details
FromJSON Host Source # 
Instance details

Defined in Amazonka.Batch.Types.Host

ToJSON Host Source # 
Instance details

Defined in Amazonka.Batch.Types.Host

Generic Host Source # 
Instance details

Defined in Amazonka.Batch.Types.Host

Associated Types

type Rep Host :: Type -> Type #

Methods

from :: Host -> Rep Host x #

to :: Rep Host x -> Host #

Read Host Source # 
Instance details

Defined in Amazonka.Batch.Types.Host

Show Host Source # 
Instance details

Defined in Amazonka.Batch.Types.Host

Methods

showsPrec :: Int -> Host -> ShowS #

show :: Host -> String #

showList :: [Host] -> ShowS #

NFData Host Source # 
Instance details

Defined in Amazonka.Batch.Types.Host

Methods

rnf :: Host -> () #

Eq Host Source # 
Instance details

Defined in Amazonka.Batch.Types.Host

Methods

(==) :: Host -> Host -> Bool #

(/=) :: Host -> Host -> Bool #

Hashable Host Source # 
Instance details

Defined in Amazonka.Batch.Types.Host

Methods

hashWithSalt :: Int -> Host -> Int #

hash :: Host -> Int #

type Rep Host Source # 
Instance details

Defined in Amazonka.Batch.Types.Host

type Rep Host = D1 ('MetaData "Host" "Amazonka.Batch.Types.Host" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "Host'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sourcePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newHost :: Host Source #

Create a value of Host with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:sourcePath:Host', host_sourcePath - The path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If this parameter contains a file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the source path location doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.

This parameter isn't applicable to jobs that run on Fargate resources. Don't provide this for these jobs.

JobDefinition

data JobDefinition Source #

An object that represents an Batch job definition.

See: newJobDefinition smart constructor.

Instances

Instances details
FromJSON JobDefinition Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDefinition

Generic JobDefinition Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDefinition

Associated Types

type Rep JobDefinition :: Type -> Type #

Read JobDefinition Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDefinition

Show JobDefinition Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDefinition

NFData JobDefinition Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDefinition

Methods

rnf :: JobDefinition -> () #

Eq JobDefinition Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDefinition

Hashable JobDefinition Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDefinition

type Rep JobDefinition Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDefinition

type Rep JobDefinition = D1 ('MetaData "JobDefinition" "Amazonka.Batch.Types.JobDefinition" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "JobDefinition'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "containerOrchestrationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OrchestrationType)) :*: S1 ('MetaSel ('Just "containerProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContainerProperties))) :*: (S1 ('MetaSel ('Just "eksProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EksProperties)) :*: S1 ('MetaSel ('Just "nodeProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NodeProperties)))) :*: ((S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "platformCapabilities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PlatformCapability]))) :*: (S1 ('MetaSel ('Just "propagateTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "retryStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RetryStrategy))))) :*: (((S1 ('MetaSel ('Just "schedulingPriority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "timeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobTimeout)))) :*: ((S1 ('MetaSel ('Just "jobDefinitionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "jobDefinitionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "revision") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newJobDefinition Source #

Create a value of JobDefinition with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:containerOrchestrationType:JobDefinition', jobDefinition_containerOrchestrationType - The orchestration type of the compute environment. The valid values are ECS (default) or EKS.

$sel:containerProperties:JobDefinition', jobDefinition_containerProperties - An object with various properties specific to Amazon ECS based jobs. Valid values are containerProperties, eksProperties, and nodeProperties. Only one can be specified.

$sel:eksProperties:JobDefinition', jobDefinition_eksProperties - An object with various properties that are specific to Amazon EKS based jobs. Valid values are containerProperties, eksProperties, and nodeProperties. Only one can be specified.

$sel:nodeProperties:JobDefinition', jobDefinition_nodeProperties - An object with various properties that are specific to multi-node parallel jobs. Valid values are containerProperties, eksProperties, and nodeProperties. Only one can be specified.

If the job runs on Fargate resources, don't specify nodeProperties. Use containerProperties instead.

$sel:parameters:JobDefinition', jobDefinition_parameters - Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition. For more information about specifying parameters, see Job definition parameters in the Batch User Guide.

$sel:platformCapabilities:JobDefinition', jobDefinition_platformCapabilities - The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.

$sel:propagateTags:JobDefinition', jobDefinition_propagateTags - 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 when the tasks are created. 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.

$sel:retryStrategy:JobDefinition', jobDefinition_retryStrategy - The retry strategy to use for failed jobs that are submitted with this job definition.

$sel:schedulingPriority:JobDefinition', jobDefinition_schedulingPriority - The scheduling priority of the job definition. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.

$sel:status:JobDefinition', jobDefinition_status - The status of the job definition.

$sel:tags:JobDefinition', jobDefinition_tags - The tags that are applied to the job definition.

$sel:timeout:JobDefinition', jobDefinition_timeout - The timeout time for jobs that are submitted with this job definition. After the amount of time you specify passes, Batch terminates your jobs if they aren't finished.

$sel:jobDefinitionName:JobDefinition', jobDefinition_jobDefinitionName - The name of the job definition.

$sel:jobDefinitionArn:JobDefinition', jobDefinition_jobDefinitionArn - The Amazon Resource Name (ARN) for the job definition.

$sel:revision:JobDefinition', jobDefinition_revision - The revision of the job definition.

$sel:type':JobDefinition', jobDefinition_type - The type of job definition. It's either container or multinode. If the job is run on Fargate resources, then multinode isn't supported. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Batch User Guide.

JobDependency

data JobDependency Source #

An object that represents an Batch job dependency.

See: newJobDependency smart constructor.

Instances

Instances details
FromJSON JobDependency Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDependency

ToJSON JobDependency Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDependency

Generic JobDependency Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDependency

Associated Types

type Rep JobDependency :: Type -> Type #

Read JobDependency Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDependency

Show JobDependency Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDependency

NFData JobDependency Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDependency

Methods

rnf :: JobDependency -> () #

Eq JobDependency Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDependency

Hashable JobDependency Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDependency

type Rep JobDependency Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDependency

type Rep JobDependency = D1 ('MetaData "JobDependency" "Amazonka.Batch.Types.JobDependency" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "JobDependency'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ArrayJobDependency))))

newJobDependency :: JobDependency Source #

Create a value of JobDependency with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:JobDependency', jobDependency_jobId - The job ID of the Batch job that's associated with this dependency.

$sel:type':JobDependency', jobDependency_type - The type of the job dependency.

JobDetail

data JobDetail Source #

An object that represents an Batch job.

See: newJobDetail smart constructor.

Instances

Instances details
FromJSON JobDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDetail

Generic JobDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDetail

Associated Types

type Rep JobDetail :: Type -> Type #

Read JobDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDetail

Show JobDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDetail

NFData JobDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDetail

Methods

rnf :: JobDetail -> () #

Eq JobDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDetail

Hashable JobDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDetail

type Rep JobDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.JobDetail

type Rep JobDetail = D1 ('MetaData "JobDetail" "Amazonka.Batch.Types.JobDetail" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "JobDetail'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "arrayProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ArrayPropertiesDetail)) :*: (S1 ('MetaSel ('Just "attempts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AttemptDetail])) :*: S1 ('MetaSel ('Just "container") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContainerDetail)))) :*: ((S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "dependsOn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [JobDependency]))) :*: (S1 ('MetaSel ('Just "eksAttempts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EksAttemptDetail])) :*: S1 ('MetaSel ('Just "eksProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EksPropertiesDetail))))) :*: ((S1 ('MetaSel ('Just "isCancelled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "isTerminated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "jobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "nodeDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NodeDetails)) :*: S1 ('MetaSel ('Just "nodeProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NodeProperties))) :*: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "platformCapabilities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PlatformCapability])))))) :*: (((S1 ('MetaSel ('Just "propagateTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "retryStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RetryStrategy)) :*: S1 ('MetaSel ('Just "schedulingPriority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: ((S1 ('MetaSel ('Just "shareIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "startedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "statusReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "stoppedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))) :*: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "timeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobTimeout)) :*: S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: ((S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "jobQueue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JobStatus) :*: S1 ('MetaSel ('Just "jobDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newJobDetail Source #

Create a value of JobDetail with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:arrayProperties:JobDetail', jobDetail_arrayProperties - The array properties of the job, if it's an array job.

JobDetail, jobDetail_attempts - A list of job attempts that are associated with this job.

JobDetail, jobDetail_container - An object that represents the details for the container that's associated with the job.

$sel:createdAt:JobDetail', jobDetail_createdAt - The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the SUBMITTED state. This is specifically at the time SubmitJob was called. For array child jobs, this is when the child job was spawned by its parent and entered the PENDING state.

$sel:dependsOn:JobDetail', jobDetail_dependsOn - A list of job IDs that this job depends on.

$sel:eksAttempts:JobDetail', jobDetail_eksAttempts - A list of job attempts that are associated with this job.

$sel:eksProperties:JobDetail', jobDetail_eksProperties - An object with various properties that are specific to Amazon EKS based jobs. Only one of container, eksProperties, or nodeDetails is specified.

$sel:isCancelled:JobDetail', jobDetail_isCancelled - Indicates whether the job is canceled.

$sel:isTerminated:JobDetail', jobDetail_isTerminated - Indicates whether the job is terminated.

$sel:jobArn:JobDetail', jobDetail_jobArn - The Amazon Resource Name (ARN) of the job.

$sel:nodeDetails:JobDetail', jobDetail_nodeDetails - An object that represents the details of a node that's associated with a multi-node parallel job.

$sel:nodeProperties:JobDetail', jobDetail_nodeProperties - An object that represents the node properties of a multi-node parallel job.

This isn't applicable to jobs that are running on Fargate resources.

$sel:parameters:JobDetail', jobDetail_parameters - Additional parameters that are passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.

$sel:platformCapabilities:JobDetail', jobDetail_platformCapabilities - The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.

$sel:propagateTags:JobDetail', jobDetail_propagateTags - 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 when the tasks are created. 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.

$sel:retryStrategy:JobDetail', jobDetail_retryStrategy - The retry strategy to use for this job if an attempt fails.

$sel:schedulingPriority:JobDetail', jobDetail_schedulingPriority - The scheduling policy of the job definition. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.

$sel:shareIdentifier:JobDetail', jobDetail_shareIdentifier - The share identifier for the job.

JobDetail, jobDetail_startedAt - The Unix timestamp (in milliseconds) for when the job was started. More specifically, it's when the job transitioned from the STARTING state to the RUNNING state. This parameter isn't provided for child jobs of array jobs or multi-node parallel jobs.

JobDetail, jobDetail_statusReason - A short, human-readable string to provide more details for the current status of the job.

JobDetail, jobDetail_stoppedAt - The Unix timestamp (in milliseconds) for when the job was stopped. More specifically, it's when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED.

$sel:tags:JobDetail', jobDetail_tags - The tags that are applied to the job.

$sel:timeout:JobDetail', jobDetail_timeout - The timeout configuration for the job.

$sel:jobName:JobDetail', jobDetail_jobName - The job name.

JobDetail, jobDetail_jobId - The job ID.

$sel:jobQueue:JobDetail', jobDetail_jobQueue - The Amazon Resource Name (ARN) of the job queue that the job is associated with.

$sel:status:JobDetail', jobDetail_status - The current status for the job.

If your jobs don't progress to STARTING, see Jobs stuck in RUNNABLE status in the troubleshooting section of the Batch User Guide.

$sel:jobDefinition:JobDetail', jobDetail_jobDefinition - The Amazon Resource Name (ARN) of the job definition that this job uses.

JobQueueDetail

data JobQueueDetail Source #

An object that represents the details for an Batch job queue.

See: newJobQueueDetail smart constructor.

Instances

Instances details
FromJSON JobQueueDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.JobQueueDetail

Generic JobQueueDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.JobQueueDetail

Associated Types

type Rep JobQueueDetail :: Type -> Type #

Read JobQueueDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.JobQueueDetail

Show JobQueueDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.JobQueueDetail

NFData JobQueueDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.JobQueueDetail

Methods

rnf :: JobQueueDetail -> () #

Eq JobQueueDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.JobQueueDetail

Hashable JobQueueDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.JobQueueDetail

type Rep JobQueueDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.JobQueueDetail

newJobQueueDetail Source #

Create a value of JobQueueDetail with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:schedulingPolicyArn:JobQueueDetail', jobQueueDetail_schedulingPolicyArn - The Amazon Resource Name (ARN) of the scheduling policy. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.

$sel:status:JobQueueDetail', jobQueueDetail_status - The status of the job queue (for example, CREATING or VALID).

$sel:statusReason:JobQueueDetail', jobQueueDetail_statusReason - A short, human-readable string to provide additional details for the current status of the job queue.

$sel:tags:JobQueueDetail', jobQueueDetail_tags - The tags that are applied to the job queue. For more information, see Tagging your Batch resources in Batch User Guide.

$sel:jobQueueName:JobQueueDetail', jobQueueDetail_jobQueueName - The job queue name.

$sel:jobQueueArn:JobQueueDetail', jobQueueDetail_jobQueueArn - The Amazon Resource Name (ARN) of the job queue.

$sel:state:JobQueueDetail', jobQueueDetail_state - Describes the ability of the queue to accept new jobs. If the job queue state is ENABLED, it can accept jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs already in the queue can finish.

$sel:priority:JobQueueDetail', jobQueueDetail_priority - The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order. For example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed.

$sel:computeEnvironmentOrder:JobQueueDetail', jobQueueDetail_computeEnvironmentOrder - The compute environments that are attached to the job queue and the order that job placement is preferred. Compute environments are selected for job placement in ascending order.

JobSummary

data JobSummary Source #

An object that represents summary details of a job.

See: newJobSummary smart constructor.

Instances

Instances details
FromJSON JobSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.JobSummary

Generic JobSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.JobSummary

Associated Types

type Rep JobSummary :: Type -> Type #

Read JobSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.JobSummary

Show JobSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.JobSummary

NFData JobSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.JobSummary

Methods

rnf :: JobSummary -> () #

Eq JobSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.JobSummary

Hashable JobSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.JobSummary

type Rep JobSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.JobSummary

type Rep JobSummary = D1 ('MetaData "JobSummary" "Amazonka.Batch.Types.JobSummary" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "JobSummary'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arrayProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ArrayPropertiesSummary)) :*: (S1 ('MetaSel ('Just "container") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContainerSummary)) :*: S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :*: (S1 ('MetaSel ('Just "jobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "jobDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "nodeProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NodePropertiesSummary))))) :*: ((S1 ('MetaSel ('Just "startedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)) :*: S1 ('MetaSel ('Just "statusReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "stoppedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newJobSummary Source #

Create a value of JobSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:arrayProperties:JobSummary', jobSummary_arrayProperties - The array properties of the job, if it's an array job.

$sel:container:JobSummary', jobSummary_container - An object that represents the details of the container that's associated with the job.

$sel:createdAt:JobSummary', jobSummary_createdAt - The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the SUBMITTED state (at the time SubmitJob was called). For array child jobs, this is when the child job was spawned by its parent and entered the PENDING state.

$sel:jobArn:JobSummary', jobSummary_jobArn - The Amazon Resource Name (ARN) of the job.

$sel:jobDefinition:JobSummary', jobSummary_jobDefinition - The Amazon Resource Name (ARN) of the job definition.

$sel:nodeProperties:JobSummary', jobSummary_nodeProperties - The node properties for a single node in a job summary list.

This isn't applicable to jobs that are running on Fargate resources.

$sel:startedAt:JobSummary', jobSummary_startedAt - The Unix timestamp for when the job was started. More specifically, it's when the job transitioned from the STARTING state to the RUNNING state.

$sel:status:JobSummary', jobSummary_status - The current status for the job.

$sel:statusReason:JobSummary', jobSummary_statusReason - A short, human-readable string to provide more details for the current status of the job.

$sel:stoppedAt:JobSummary', jobSummary_stoppedAt - The Unix timestamp for when the job was stopped. More specifically, it's when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED.

$sel:jobId:JobSummary', jobSummary_jobId - The job ID.

$sel:jobName:JobSummary', jobSummary_jobName - The job name.

JobTimeout

data JobTimeout Source #

An object that represents a job timeout configuration.

See: newJobTimeout smart constructor.

Constructors

JobTimeout' (Maybe Int) 

Instances

Instances details
FromJSON JobTimeout Source # 
Instance details

Defined in Amazonka.Batch.Types.JobTimeout

ToJSON JobTimeout Source # 
Instance details

Defined in Amazonka.Batch.Types.JobTimeout

Generic JobTimeout Source # 
Instance details

Defined in Amazonka.Batch.Types.JobTimeout

Associated Types

type Rep JobTimeout :: Type -> Type #

Read JobTimeout Source # 
Instance details

Defined in Amazonka.Batch.Types.JobTimeout

Show JobTimeout Source # 
Instance details

Defined in Amazonka.Batch.Types.JobTimeout

NFData JobTimeout Source # 
Instance details

Defined in Amazonka.Batch.Types.JobTimeout

Methods

rnf :: JobTimeout -> () #

Eq JobTimeout Source # 
Instance details

Defined in Amazonka.Batch.Types.JobTimeout

Hashable JobTimeout Source # 
Instance details

Defined in Amazonka.Batch.Types.JobTimeout

type Rep JobTimeout Source # 
Instance details

Defined in Amazonka.Batch.Types.JobTimeout

type Rep JobTimeout = D1 ('MetaData "JobTimeout" "Amazonka.Batch.Types.JobTimeout" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "JobTimeout'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attemptDurationSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))

newJobTimeout :: JobTimeout Source #

Create a value of JobTimeout with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:attemptDurationSeconds:JobTimeout', jobTimeout_attemptDurationSeconds - The job timeout time (in seconds) that's measured from the job attempt's startedAt timestamp. After this time passes, Batch terminates your jobs if they aren't finished. The minimum value for the timeout is 60 seconds.

For array jobs, the timeout applies to the child jobs, not to the parent array job.

For multi-node parallel (MNP) jobs, the timeout applies to the whole job, not to the individual nodes.

KeyValuePair

data KeyValuePair Source #

A key-value pair object.

See: newKeyValuePair smart constructor.

Constructors

KeyValuePair' (Maybe Text) (Maybe Text) 

Instances

Instances details
FromJSON KeyValuePair Source # 
Instance details

Defined in Amazonka.Batch.Types.KeyValuePair

ToJSON KeyValuePair Source # 
Instance details

Defined in Amazonka.Batch.Types.KeyValuePair

Generic KeyValuePair Source # 
Instance details

Defined in Amazonka.Batch.Types.KeyValuePair

Associated Types

type Rep KeyValuePair :: Type -> Type #

Read KeyValuePair Source # 
Instance details

Defined in Amazonka.Batch.Types.KeyValuePair

Show KeyValuePair Source # 
Instance details

Defined in Amazonka.Batch.Types.KeyValuePair

NFData KeyValuePair Source # 
Instance details

Defined in Amazonka.Batch.Types.KeyValuePair

Methods

rnf :: KeyValuePair -> () #

Eq KeyValuePair Source # 
Instance details

Defined in Amazonka.Batch.Types.KeyValuePair

Hashable KeyValuePair Source # 
Instance details

Defined in Amazonka.Batch.Types.KeyValuePair

type Rep KeyValuePair Source # 
Instance details

Defined in Amazonka.Batch.Types.KeyValuePair

type Rep KeyValuePair = D1 ('MetaData "KeyValuePair" "Amazonka.Batch.Types.KeyValuePair" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "KeyValuePair'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newKeyValuePair :: KeyValuePair Source #

Create a value of KeyValuePair with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:name:KeyValuePair', keyValuePair_name - The name of the key-value pair. For environment variables, this is the name of the environment variable.

$sel:value:KeyValuePair', keyValuePair_value - The value of the key-value pair. For environment variables, this is the value of the environment variable.

KeyValuesPair

data KeyValuesPair Source #

A filter name and value pair that's used to return a more specific list of results from a ListJobs API operation.

See: newKeyValuesPair smart constructor.

Constructors

KeyValuesPair' (Maybe Text) (Maybe [Text]) 

Instances

Instances details
ToJSON KeyValuesPair Source # 
Instance details

Defined in Amazonka.Batch.Types.KeyValuesPair

Generic KeyValuesPair Source # 
Instance details

Defined in Amazonka.Batch.Types.KeyValuesPair

Associated Types

type Rep KeyValuesPair :: Type -> Type #

Read KeyValuesPair Source # 
Instance details

Defined in Amazonka.Batch.Types.KeyValuesPair

Show KeyValuesPair Source # 
Instance details

Defined in Amazonka.Batch.Types.KeyValuesPair

NFData KeyValuesPair Source # 
Instance details

Defined in Amazonka.Batch.Types.KeyValuesPair

Methods

rnf :: KeyValuesPair -> () #

Eq KeyValuesPair Source # 
Instance details

Defined in Amazonka.Batch.Types.KeyValuesPair

Hashable KeyValuesPair Source # 
Instance details

Defined in Amazonka.Batch.Types.KeyValuesPair

type Rep KeyValuesPair Source # 
Instance details

Defined in Amazonka.Batch.Types.KeyValuesPair

type Rep KeyValuesPair = D1 ('MetaData "KeyValuesPair" "Amazonka.Batch.Types.KeyValuesPair" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "KeyValuesPair'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))

newKeyValuesPair :: KeyValuesPair Source #

Create a value of KeyValuesPair with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:name:KeyValuesPair', keyValuesPair_name - The name of the filter. Filter names are case sensitive.

$sel:values:KeyValuesPair', keyValuesPair_values - The filter values.

LaunchTemplateSpecification

data LaunchTemplateSpecification Source #

An object that represents a launch template that's associated with a compute resource. You must specify either the launch template ID or launch template name in the request, but not both.

If security groups are specified using both the securityGroupIds parameter of CreateComputeEnvironment and the launch template, the values in the securityGroupIds parameter of CreateComputeEnvironment will be used.

This object isn't applicable to jobs that are running on Fargate resources.

See: newLaunchTemplateSpecification smart constructor.

Instances

Instances details
FromJSON LaunchTemplateSpecification Source # 
Instance details

Defined in Amazonka.Batch.Types.LaunchTemplateSpecification

ToJSON LaunchTemplateSpecification Source # 
Instance details

Defined in Amazonka.Batch.Types.LaunchTemplateSpecification

Generic LaunchTemplateSpecification Source # 
Instance details

Defined in Amazonka.Batch.Types.LaunchTemplateSpecification

Associated Types

type Rep LaunchTemplateSpecification :: Type -> Type #

Read LaunchTemplateSpecification Source # 
Instance details

Defined in Amazonka.Batch.Types.LaunchTemplateSpecification

Show LaunchTemplateSpecification Source # 
Instance details

Defined in Amazonka.Batch.Types.LaunchTemplateSpecification

NFData LaunchTemplateSpecification Source # 
Instance details

Defined in Amazonka.Batch.Types.LaunchTemplateSpecification

Eq LaunchTemplateSpecification Source # 
Instance details

Defined in Amazonka.Batch.Types.LaunchTemplateSpecification

Hashable LaunchTemplateSpecification Source # 
Instance details

Defined in Amazonka.Batch.Types.LaunchTemplateSpecification

type Rep LaunchTemplateSpecification Source # 
Instance details

Defined in Amazonka.Batch.Types.LaunchTemplateSpecification

type Rep LaunchTemplateSpecification = D1 ('MetaData "LaunchTemplateSpecification" "Amazonka.Batch.Types.LaunchTemplateSpecification" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "LaunchTemplateSpecification'" 'PrefixI 'True) (S1 ('MetaSel ('Just "launchTemplateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "launchTemplateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newLaunchTemplateSpecification :: LaunchTemplateSpecification Source #

Create a value of LaunchTemplateSpecification with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:launchTemplateId:LaunchTemplateSpecification', launchTemplateSpecification_launchTemplateId - The ID of the launch template.

$sel:launchTemplateName:LaunchTemplateSpecification', launchTemplateSpecification_launchTemplateName - The name of the launch template.

$sel:version:LaunchTemplateSpecification', launchTemplateSpecification_version - The version number of the launch template, $Latest, or $Default.

If the value is $Latest, the latest version of the launch template is used. If the value is $Default, the default version of the launch template is used.

If the AMI ID that's used in a compute environment is from the launch template, the AMI isn't changed when the compute environment is updated. It's only changed if the updateToLatestImageVersion parameter for the compute environment is set to true. During an infrastructure update, if either $Latest or $Default is specified, Batch re-evaluates the launch template version, and it might use a different version of the launch template. This is the case even if the launch template isn't specified in the update. When updating a compute environment, changing the launch template requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

Default: $Default.

LinuxParameters

data LinuxParameters Source #

Linux-specific modifications that are applied to the container, such as details for device mappings.

See: newLinuxParameters smart constructor.

Instances

Instances details
FromJSON LinuxParameters Source # 
Instance details

Defined in Amazonka.Batch.Types.LinuxParameters

ToJSON LinuxParameters Source # 
Instance details

Defined in Amazonka.Batch.Types.LinuxParameters

Generic LinuxParameters Source # 
Instance details

Defined in Amazonka.Batch.Types.LinuxParameters

Associated Types

type Rep LinuxParameters :: Type -> Type #

Read LinuxParameters Source # 
Instance details

Defined in Amazonka.Batch.Types.LinuxParameters

Show LinuxParameters Source # 
Instance details

Defined in Amazonka.Batch.Types.LinuxParameters

NFData LinuxParameters Source # 
Instance details

Defined in Amazonka.Batch.Types.LinuxParameters

Methods

rnf :: LinuxParameters -> () #

Eq LinuxParameters Source # 
Instance details

Defined in Amazonka.Batch.Types.LinuxParameters

Hashable LinuxParameters Source # 
Instance details

Defined in Amazonka.Batch.Types.LinuxParameters

type Rep LinuxParameters Source # 
Instance details

Defined in Amazonka.Batch.Types.LinuxParameters

type Rep LinuxParameters = D1 ('MetaData "LinuxParameters" "Amazonka.Batch.Types.LinuxParameters" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "LinuxParameters'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "devices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Device])) :*: (S1 ('MetaSel ('Just "initProcessEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "maxSwap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: (S1 ('MetaSel ('Just "sharedMemorySize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "swappiness") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "tmpfs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tmpfs]))))))

newLinuxParameters :: LinuxParameters Source #

Create a value of LinuxParameters with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:devices:LinuxParameters', linuxParameters_devices - Any of the host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

$sel:initProcessEnabled:LinuxParameters', linuxParameters_initProcessEnabled - If true, run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version | grep "Server API version"

$sel:maxSwap:LinuxParameters', linuxParameters_maxSwap - The total amount of swap memory (in MiB) a container can use. This parameter is translated to the --memory-swap option to docker run where the value is the sum of the container memory plus the maxSwap value. For more information, see --memory-swap details in the Docker documentation.

If a maxSwap value of 0 is specified, the container doesn't use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container doesn't use the swap configuration for the container instance that it's running on. A maxSwap value must be set for the swappiness parameter to be used.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

$sel:sharedMemorySize:LinuxParameters', linuxParameters_sharedMemorySize - The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

$sel:swappiness:LinuxParameters', linuxParameters_swappiness - You can use this parameter to tune a container's memory swappiness behavior. A swappiness value of 0 causes swapping to not occur unless absolutely necessary. A swappiness value of 100 causes pages to be swapped aggressively. Valid values are whole numbers between 0 and 100. If the swappiness parameter isn't specified, a default value of 60 is used. If a value isn't specified for maxSwap, then this parameter is ignored. If maxSwap is set to 0, the container doesn't use swap. This parameter maps to the --memory-swappiness option to docker run.

Consider the following when you use a per-container swap configuration.

  • Swap space must be enabled and allocated on the container instance for the containers to use.

    By default, the Amazon ECS optimized AMIs don't have swap enabled. You must enable swap on the instance to use this feature. For more information, see Instance store swap volumes in the Amazon EC2 User Guide for Linux Instances or How do I allocate memory to work as swap space in an Amazon EC2 instance by using a swap file?

  • The swap space parameters are only supported for job definitions using EC2 resources.
  • If the maxSwap and swappiness parameters are omitted from a job definition, each container has a default swappiness value of 60. Moreover, the total swap usage is limited to two times the memory reservation of the container.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

$sel:tmpfs:LinuxParameters', linuxParameters_tmpfs - The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide this parameter for this resource type.

LogConfiguration

data LogConfiguration Source #

Log configuration options to send to a custom log driver for the container.

See: newLogConfiguration smart constructor.

Instances

Instances details
FromJSON LogConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.LogConfiguration

ToJSON LogConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.LogConfiguration

Generic LogConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.LogConfiguration

Associated Types

type Rep LogConfiguration :: Type -> Type #

Read LogConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.LogConfiguration

Show LogConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.LogConfiguration

NFData LogConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.LogConfiguration

Methods

rnf :: LogConfiguration -> () #

Eq LogConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.LogConfiguration

Hashable LogConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.LogConfiguration

type Rep LogConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.LogConfiguration

type Rep LogConfiguration = D1 ('MetaData "LogConfiguration" "Amazonka.Batch.Types.LogConfiguration" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "LogConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "options") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "secretOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Secret])) :*: S1 ('MetaSel ('Just "logDriver") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LogDriver))))

newLogConfiguration Source #

Create a value of LogConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:options:LogConfiguration', logConfiguration_options - The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version | grep "Server API version"

$sel:secretOptions:LogConfiguration', logConfiguration_secretOptions - The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Batch User Guide.

$sel:logDriver:LogConfiguration', logConfiguration_logDriver - The log driver to use for the container. The valid values that are listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.

The supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries, syslog, and splunk.

Jobs that are running on Fargate resources are restricted to the awslogs and splunk log drivers.

awslogs
Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs log driver in the Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation.
fluentd
Specifies the Fluentd logging driver. For more information including usage and options, see Fluentd logging driver in the Docker documentation.
gelf
Specifies the Graylog Extended Format (GELF) logging driver. For more information including usage and options, see Graylog Extended Format logging driver in the Docker documentation.
journald
Specifies the journald logging driver. For more information including usage and options, see Journald logging driver in the Docker documentation.
json-file
Specifies the JSON file logging driver. For more information including usage and options, see JSON File logging driver in the Docker documentation.
splunk
Specifies the Splunk logging driver. For more information including usage and options, see Splunk logging driver in the Docker documentation.
syslog
Specifies the syslog logging driver. For more information including usage and options, see Syslog logging driver in the Docker documentation.

If you have a custom driver that's not listed earlier that you want to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you want to have included. However, Amazon Web Services doesn't currently support running modified copies of this software.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version | grep "Server API version"

MountPoint

data MountPoint Source #

Details for a Docker volume mount point that's used in a job's container properties. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.

See: newMountPoint smart constructor.

Constructors

MountPoint' (Maybe Text) (Maybe Bool) (Maybe Text) 

Instances

Instances details
FromJSON MountPoint Source # 
Instance details

Defined in Amazonka.Batch.Types.MountPoint

ToJSON MountPoint Source # 
Instance details

Defined in Amazonka.Batch.Types.MountPoint

Generic MountPoint Source # 
Instance details

Defined in Amazonka.Batch.Types.MountPoint

Associated Types

type Rep MountPoint :: Type -> Type #

Read MountPoint Source # 
Instance details

Defined in Amazonka.Batch.Types.MountPoint

Show MountPoint Source # 
Instance details

Defined in Amazonka.Batch.Types.MountPoint

NFData MountPoint Source # 
Instance details

Defined in Amazonka.Batch.Types.MountPoint

Methods

rnf :: MountPoint -> () #

Eq MountPoint Source # 
Instance details

Defined in Amazonka.Batch.Types.MountPoint

Hashable MountPoint Source # 
Instance details

Defined in Amazonka.Batch.Types.MountPoint

type Rep MountPoint Source # 
Instance details

Defined in Amazonka.Batch.Types.MountPoint

type Rep MountPoint = D1 ('MetaData "MountPoint" "Amazonka.Batch.Types.MountPoint" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "MountPoint'" 'PrefixI 'True) (S1 ('MetaSel ('Just "containerPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "readOnly") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "sourceVolume") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newMountPoint :: MountPoint Source #

Create a value of MountPoint with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:containerPath:MountPoint', mountPoint_containerPath - The path on the container where the host volume is mounted.

$sel:readOnly:MountPoint', mountPoint_readOnly - If this value is true, the container has read-only access to the volume. Otherwise, the container can write to the volume. The default value is false.

$sel:sourceVolume:MountPoint', mountPoint_sourceVolume - The name of the volume to mount.

NetworkConfiguration

data NetworkConfiguration Source #

The network configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.

See: newNetworkConfiguration smart constructor.

Instances

Instances details
FromJSON NetworkConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.NetworkConfiguration

ToJSON NetworkConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.NetworkConfiguration

Generic NetworkConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.NetworkConfiguration

Associated Types

type Rep NetworkConfiguration :: Type -> Type #

Read NetworkConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.NetworkConfiguration

Show NetworkConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.NetworkConfiguration

NFData NetworkConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.NetworkConfiguration

Methods

rnf :: NetworkConfiguration -> () #

Eq NetworkConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.NetworkConfiguration

Hashable NetworkConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.NetworkConfiguration

type Rep NetworkConfiguration Source # 
Instance details

Defined in Amazonka.Batch.Types.NetworkConfiguration

type Rep NetworkConfiguration = D1 ('MetaData "NetworkConfiguration" "Amazonka.Batch.Types.NetworkConfiguration" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "NetworkConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "assignPublicIp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AssignPublicIp))))

newNetworkConfiguration :: NetworkConfiguration Source #

Create a value of NetworkConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:assignPublicIp:NetworkConfiguration', networkConfiguration_assignPublicIp - Indicates whether the job has a public IP address. For a job that's running on Fargate resources in a private subnet to send outbound traffic to the internet (for example, to pull container images), the private subnet requires a NAT gateway be attached to route requests to the internet. For more information, see Amazon ECS task networking in the Amazon Elastic Container Service Developer Guide. The default value is "DISABLED".

NetworkInterface

data NetworkInterface Source #

An object that represents the elastic network interface for a multi-node parallel job node.

See: newNetworkInterface smart constructor.

Instances

Instances details
FromJSON NetworkInterface Source # 
Instance details

Defined in Amazonka.Batch.Types.NetworkInterface

Generic NetworkInterface Source # 
Instance details

Defined in Amazonka.Batch.Types.NetworkInterface

Associated Types

type Rep NetworkInterface :: Type -> Type #

Read NetworkInterface Source # 
Instance details

Defined in Amazonka.Batch.Types.NetworkInterface

Show NetworkInterface Source # 
Instance details

Defined in Amazonka.Batch.Types.NetworkInterface

NFData NetworkInterface Source # 
Instance details

Defined in Amazonka.Batch.Types.NetworkInterface

Methods

rnf :: NetworkInterface -> () #

Eq NetworkInterface Source # 
Instance details

Defined in Amazonka.Batch.Types.NetworkInterface

Hashable NetworkInterface Source # 
Instance details

Defined in Amazonka.Batch.Types.NetworkInterface

type Rep NetworkInterface Source # 
Instance details

Defined in Amazonka.Batch.Types.NetworkInterface

type Rep NetworkInterface = D1 ('MetaData "NetworkInterface" "Amazonka.Batch.Types.NetworkInterface" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "NetworkInterface'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attachmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "ipv6Address") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "privateIpv4Address") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newNetworkInterface :: NetworkInterface Source #

Create a value of NetworkInterface with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:attachmentId:NetworkInterface', networkInterface_attachmentId - The attachment ID for the network interface.

$sel:ipv6Address:NetworkInterface', networkInterface_ipv6Address - The private IPv6 address for the network interface.

$sel:privateIpv4Address:NetworkInterface', networkInterface_privateIpv4Address - The private IPv4 address for the network interface.

NodeDetails

data NodeDetails Source #

An object that represents the details of a multi-node parallel job node.

See: newNodeDetails smart constructor.

Constructors

NodeDetails' (Maybe Bool) (Maybe Int) 

Instances

Instances details
FromJSON NodeDetails Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeDetails

Generic NodeDetails Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeDetails

Associated Types

type Rep NodeDetails :: Type -> Type #

Read NodeDetails Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeDetails

Show NodeDetails Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeDetails

NFData NodeDetails Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeDetails

Methods

rnf :: NodeDetails -> () #

Eq NodeDetails Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeDetails

Hashable NodeDetails Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeDetails

type Rep NodeDetails Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeDetails

type Rep NodeDetails = D1 ('MetaData "NodeDetails" "Amazonka.Batch.Types.NodeDetails" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "NodeDetails'" 'PrefixI 'True) (S1 ('MetaSel ('Just "isMainNode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "nodeIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))

newNodeDetails :: NodeDetails Source #

Create a value of NodeDetails with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:isMainNode:NodeDetails', nodeDetails_isMainNode - Specifies whether the current node is the main node for a multi-node parallel job.

$sel:nodeIndex:NodeDetails', nodeDetails_nodeIndex - The node index for the node. Node index numbering starts at zero. This index is also available on the node with the AWS_BATCH_JOB_NODE_INDEX environment variable.

NodeOverrides

data NodeOverrides Source #

An object that represents any node overrides to a job definition that's used in a SubmitJob API operation.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs. Rather, use containerOverrides instead.

See: newNodeOverrides smart constructor.

Instances

Instances details
ToJSON NodeOverrides Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeOverrides

Generic NodeOverrides Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeOverrides

Associated Types

type Rep NodeOverrides :: Type -> Type #

Read NodeOverrides Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeOverrides

Show NodeOverrides Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeOverrides

NFData NodeOverrides Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeOverrides

Methods

rnf :: NodeOverrides -> () #

Eq NodeOverrides Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeOverrides

Hashable NodeOverrides Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeOverrides

type Rep NodeOverrides Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeOverrides

type Rep NodeOverrides = D1 ('MetaData "NodeOverrides" "Amazonka.Batch.Types.NodeOverrides" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "NodeOverrides'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nodePropertyOverrides") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [NodePropertyOverride])) :*: S1 ('MetaSel ('Just "numNodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))

newNodeOverrides :: NodeOverrides Source #

Create a value of NodeOverrides with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nodePropertyOverrides:NodeOverrides', nodeOverrides_nodePropertyOverrides - The node property overrides for the job.

$sel:numNodes:NodeOverrides', nodeOverrides_numNodes - The number of nodes to use with a multi-node parallel job. This value overrides the number of nodes that are specified in the job definition. To use this override, you must meet the following conditions:

  • There must be at least one node range in your job definition that has an open upper boundary, such as : or n:.
  • The lower boundary of the node range that's specified in the job definition must be fewer than the number of nodes specified in the override.
  • The main node index that's specified in the job definition must be fewer than the number of nodes specified in the override.

NodeProperties

data NodeProperties Source #

An object that represents the node properties of a multi-node parallel job.

Node properties can't be specified for Amazon EKS based job definitions.

See: newNodeProperties smart constructor.

Instances

Instances details
FromJSON NodeProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeProperties

ToJSON NodeProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeProperties

Generic NodeProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeProperties

Associated Types

type Rep NodeProperties :: Type -> Type #

Read NodeProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeProperties

Show NodeProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeProperties

NFData NodeProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeProperties

Methods

rnf :: NodeProperties -> () #

Eq NodeProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeProperties

Hashable NodeProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeProperties

type Rep NodeProperties Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeProperties

type Rep NodeProperties = D1 ('MetaData "NodeProperties" "Amazonka.Batch.Types.NodeProperties" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "NodeProperties'" 'PrefixI 'True) (S1 ('MetaSel ('Just "numNodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "mainNode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "nodeRangeProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [NodeRangeProperty]))))

newNodeProperties Source #

Create a value of NodeProperties with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:numNodes:NodeProperties', nodeProperties_numNodes - The number of nodes that are associated with a multi-node parallel job.

$sel:mainNode:NodeProperties', nodeProperties_mainNode - Specifies the node index for the main node of a multi-node parallel job. This node index value must be fewer than the number of nodes.

$sel:nodeRangeProperties:NodeProperties', nodeProperties_nodeRangeProperties - A list of node ranges and their properties that are associated with a multi-node parallel job.

NodePropertiesSummary

data NodePropertiesSummary Source #

An object that represents the properties of a node that's associated with a multi-node parallel job.

See: newNodePropertiesSummary smart constructor.

Instances

Instances details
FromJSON NodePropertiesSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.NodePropertiesSummary

Generic NodePropertiesSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.NodePropertiesSummary

Associated Types

type Rep NodePropertiesSummary :: Type -> Type #

Read NodePropertiesSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.NodePropertiesSummary

Show NodePropertiesSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.NodePropertiesSummary

NFData NodePropertiesSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.NodePropertiesSummary

Methods

rnf :: NodePropertiesSummary -> () #

Eq NodePropertiesSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.NodePropertiesSummary

Hashable NodePropertiesSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.NodePropertiesSummary

type Rep NodePropertiesSummary Source # 
Instance details

Defined in Amazonka.Batch.Types.NodePropertiesSummary

type Rep NodePropertiesSummary = D1 ('MetaData "NodePropertiesSummary" "Amazonka.Batch.Types.NodePropertiesSummary" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "NodePropertiesSummary'" 'PrefixI 'True) (S1 ('MetaSel ('Just "isMainNode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "nodeIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "numNodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))

newNodePropertiesSummary :: NodePropertiesSummary Source #

Create a value of NodePropertiesSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:isMainNode:NodePropertiesSummary', nodePropertiesSummary_isMainNode - Specifies whether the current node is the main node for a multi-node parallel job.

$sel:nodeIndex:NodePropertiesSummary', nodePropertiesSummary_nodeIndex - The node index for the node. Node index numbering begins at zero. This index is also available on the node with the AWS_BATCH_JOB_NODE_INDEX environment variable.

$sel:numNodes:NodePropertiesSummary', nodePropertiesSummary_numNodes - The number of nodes that are associated with a multi-node parallel job.

NodePropertyOverride

data NodePropertyOverride Source #

The object that represents any node overrides to a job definition that's used in a SubmitJob API operation.

See: newNodePropertyOverride smart constructor.

Instances

Instances details
ToJSON NodePropertyOverride Source # 
Instance details

Defined in Amazonka.Batch.Types.NodePropertyOverride

Generic NodePropertyOverride Source # 
Instance details

Defined in Amazonka.Batch.Types.NodePropertyOverride

Associated Types

type Rep NodePropertyOverride :: Type -> Type #

Read NodePropertyOverride Source # 
Instance details

Defined in Amazonka.Batch.Types.NodePropertyOverride

Show NodePropertyOverride Source # 
Instance details

Defined in Amazonka.Batch.Types.NodePropertyOverride

NFData NodePropertyOverride Source # 
Instance details

Defined in Amazonka.Batch.Types.NodePropertyOverride

Methods

rnf :: NodePropertyOverride -> () #

Eq NodePropertyOverride Source # 
Instance details

Defined in Amazonka.Batch.Types.NodePropertyOverride

Hashable NodePropertyOverride Source # 
Instance details

Defined in Amazonka.Batch.Types.NodePropertyOverride

type Rep NodePropertyOverride Source # 
Instance details

Defined in Amazonka.Batch.Types.NodePropertyOverride

type Rep NodePropertyOverride = D1 ('MetaData "NodePropertyOverride" "Amazonka.Batch.Types.NodePropertyOverride" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "NodePropertyOverride'" 'PrefixI 'True) (S1 ('MetaSel ('Just "containerOverrides") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContainerOverrides)) :*: S1 ('MetaSel ('Just "targetNodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newNodePropertyOverride Source #

Create a value of NodePropertyOverride with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:containerOverrides:NodePropertyOverride', nodePropertyOverride_containerOverrides - The overrides that are sent to a node range.

$sel:targetNodes:NodePropertyOverride', nodePropertyOverride_targetNodes - The range of nodes, using node index values, that's used to override. A range of 0:3 indicates nodes with index values of 0 through 3. If the starting range value is omitted (:n), then 0 is used to start the range. If the ending range value is omitted (n:), then the highest possible node index is used to end the range.

NodeRangeProperty

data NodeRangeProperty Source #

An object that represents the properties of the node range for a multi-node parallel job.

See: newNodeRangeProperty smart constructor.

Instances

Instances details
FromJSON NodeRangeProperty Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeRangeProperty

ToJSON NodeRangeProperty Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeRangeProperty

Generic NodeRangeProperty Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeRangeProperty

Associated Types

type Rep NodeRangeProperty :: Type -> Type #

Read NodeRangeProperty Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeRangeProperty

Show NodeRangeProperty Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeRangeProperty

NFData NodeRangeProperty Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeRangeProperty

Methods

rnf :: NodeRangeProperty -> () #

Eq NodeRangeProperty Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeRangeProperty

Hashable NodeRangeProperty Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeRangeProperty

type Rep NodeRangeProperty Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeRangeProperty

type Rep NodeRangeProperty = D1 ('MetaData "NodeRangeProperty" "Amazonka.Batch.Types.NodeRangeProperty" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "NodeRangeProperty'" 'PrefixI 'True) (S1 ('MetaSel ('Just "container") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContainerProperties)) :*: S1 ('MetaSel ('Just "targetNodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newNodeRangeProperty Source #

Create a value of NodeRangeProperty with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:container:NodeRangeProperty', nodeRangeProperty_container - The container details for the node range.

$sel:targetNodes:NodeRangeProperty', nodeRangeProperty_targetNodes - The range of nodes, using node index values. A range of 0:3 indicates nodes with index values of 0 through 3. If the starting range value is omitted (:n), then 0 is used to start the range. If the ending range value is omitted (n:), then the highest possible node index is used to end the range. Your accumulative node ranges must account for all nodes (0:n). You can nest node ranges (for example, 0:10 and 4:5). In this case, the 4:5 range properties override the 0:10 properties.

ResourceRequirement

data ResourceRequirement Source #

The type and amount of a resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.

See: newResourceRequirement smart constructor.

Instances

Instances details
FromJSON ResourceRequirement Source # 
Instance details

Defined in Amazonka.Batch.Types.ResourceRequirement

ToJSON ResourceRequirement Source # 
Instance details

Defined in Amazonka.Batch.Types.ResourceRequirement

Generic ResourceRequirement Source # 
Instance details

Defined in Amazonka.Batch.Types.ResourceRequirement

Associated Types

type Rep ResourceRequirement :: Type -> Type #

Read ResourceRequirement Source # 
Instance details

Defined in Amazonka.Batch.Types.ResourceRequirement

Show ResourceRequirement Source # 
Instance details

Defined in Amazonka.Batch.Types.ResourceRequirement

NFData ResourceRequirement Source # 
Instance details

Defined in Amazonka.Batch.Types.ResourceRequirement

Methods

rnf :: ResourceRequirement -> () #

Eq ResourceRequirement Source # 
Instance details

Defined in Amazonka.Batch.Types.ResourceRequirement

Hashable ResourceRequirement Source # 
Instance details

Defined in Amazonka.Batch.Types.ResourceRequirement

type Rep ResourceRequirement Source # 
Instance details

Defined in Amazonka.Batch.Types.ResourceRequirement

type Rep ResourceRequirement = D1 ('MetaData "ResourceRequirement" "Amazonka.Batch.Types.ResourceRequirement" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "ResourceRequirement'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ResourceType)))

newResourceRequirement Source #

Create a value of ResourceRequirement with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:value:ResourceRequirement', resourceRequirement_value - The quantity of the specified resource to reserve for the container. The values vary based on the type specified.

type="GPU"
The number of physical GPUs to reserve for the container. Make sure that the number of GPUs reserved for all containers in a job doesn't exceed the number of available GPUs on the compute resource that the job is launched on.

GPUs aren't available for jobs that are running on Fargate resources.

type="MEMORY"
The memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are running on EC2 resources. If your container attempts to exceed the memory specified, the container is terminated. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.

If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory management in the Batch User Guide.

For jobs that are running on Fargate resources, then value is the hard limit (in MiB), and must match one of the supported values and the VCPU values must be one of the values supported for that memory value.

value = 512
VCPU = 0.25
value = 1024
VCPU = 0.25 or 0.5
value = 2048
VCPU = 0.25, 0.5, or 1
value = 3072
VCPU = 0.5, or 1
value = 4096
VCPU = 0.5, 1, or 2
value = 5120, 6144, or 7168
VCPU = 1 or 2
value = 8192
VCPU = 1, 2, 4, or 8
value = 9216, 10240, 11264, 12288, 13312, 14336, or 15360
VCPU = 2 or 4
value = 16384
VCPU = 2, 4, or 8
value = 17408, 18432, 19456, 21504, 22528, 23552, 25600, 26624, 27648, 29696, or 30720
VCPU = 4
value = 20480, 24576, or 28672
VCPU = 4 or 8
value = 36864, 45056, 53248, or 61440
VCPU = 8
value = 32768, 40960, 49152, or 57344
VCPU = 8 or 16
value = 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880
VCPU = 16
type="VCPU"
The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. For EC2 resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be specified for each node at least once.

The default for the Fargate On-Demand vCPU resource count quota is 6 vCPUs. For more information about Fargate quotas, see Fargate quotas in the Amazon Web Services General Reference.

For jobs that are running on Fargate resources, then value must match one of the supported values and the MEMORY values must be one of the values supported for that VCPU value. The supported values are 0.25, 0.5, 1, 2, 4, 8, and 16

value = 0.25
MEMORY = 512, 1024, or 2048
value = 0.5
MEMORY = 1024, 2048, 3072, or 4096
value = 1
MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192
value = 2
MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384
value = 4
MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720
value = 8
MEMORY = 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344, or 61440
value = 16
MEMORY = 32768, 40960, 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880

$sel:type':ResourceRequirement', resourceRequirement_type - The type of resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.

RetryStrategy

data RetryStrategy Source #

The retry strategy that's associated with a job. For more information, see Automated job retries in the Batch User Guide.

See: newRetryStrategy smart constructor.

Instances

Instances details
FromJSON RetryStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.RetryStrategy

ToJSON RetryStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.RetryStrategy

Generic RetryStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.RetryStrategy

Associated Types

type Rep RetryStrategy :: Type -> Type #

Read RetryStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.RetryStrategy

Show RetryStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.RetryStrategy

NFData RetryStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.RetryStrategy

Methods

rnf :: RetryStrategy -> () #

Eq RetryStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.RetryStrategy

Hashable RetryStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.RetryStrategy

type Rep RetryStrategy Source # 
Instance details

Defined in Amazonka.Batch.Types.RetryStrategy

type Rep RetryStrategy = D1 ('MetaData "RetryStrategy" "Amazonka.Batch.Types.RetryStrategy" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "RetryStrategy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attempts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "evaluateOnExit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EvaluateOnExit]))))

newRetryStrategy :: RetryStrategy Source #

Create a value of RetryStrategy with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:attempts:RetryStrategy', retryStrategy_attempts - The number of times to move a job to the RUNNABLE status. You can specify between 1 and 10 attempts. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value.

$sel:evaluateOnExit:RetryStrategy', retryStrategy_evaluateOnExit - Array of up to 5 objects that specify the conditions where jobs are retried or failed. If this parameter is specified, then the attempts parameter must also be specified. If none of the listed conditions match, then the job is retried.

SchedulingPolicyDetail

data SchedulingPolicyDetail Source #

An object that represents a scheduling policy.

See: newSchedulingPolicyDetail smart constructor.

Instances

Instances details
FromJSON SchedulingPolicyDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.SchedulingPolicyDetail

Generic SchedulingPolicyDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.SchedulingPolicyDetail

Associated Types

type Rep SchedulingPolicyDetail :: Type -> Type #

Read SchedulingPolicyDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.SchedulingPolicyDetail

Show SchedulingPolicyDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.SchedulingPolicyDetail

NFData SchedulingPolicyDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.SchedulingPolicyDetail

Methods

rnf :: SchedulingPolicyDetail -> () #

Eq SchedulingPolicyDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.SchedulingPolicyDetail

Hashable SchedulingPolicyDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.SchedulingPolicyDetail

type Rep SchedulingPolicyDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.SchedulingPolicyDetail

type Rep SchedulingPolicyDetail = D1 ('MetaData "SchedulingPolicyDetail" "Amazonka.Batch.Types.SchedulingPolicyDetail" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "SchedulingPolicyDetail'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "fairsharePolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FairsharePolicy)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newSchedulingPolicyDetail Source #

Create a value of SchedulingPolicyDetail with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:fairsharePolicy:SchedulingPolicyDetail', schedulingPolicyDetail_fairsharePolicy - The fair share policy for the scheduling policy.

$sel:tags:SchedulingPolicyDetail', schedulingPolicyDetail_tags - The tags that you apply to the scheduling policy to categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services resources in Amazon Web Services General Reference.

$sel:name:SchedulingPolicyDetail', schedulingPolicyDetail_name - The name of the scheduling policy.

$sel:arn:SchedulingPolicyDetail', schedulingPolicyDetail_arn - The Amazon Resource Name (ARN) of the scheduling policy. An example is arn:aws:batch:us-east-1:123456789012:scheduling-policy/HighPriority .

SchedulingPolicyListingDetail

data SchedulingPolicyListingDetail Source #

An object that contains the details of a scheduling policy that's returned in a ListSchedulingPolicy action.

See: newSchedulingPolicyListingDetail smart constructor.

Instances

Instances details
FromJSON SchedulingPolicyListingDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.SchedulingPolicyListingDetail

Generic SchedulingPolicyListingDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.SchedulingPolicyListingDetail

Associated Types

type Rep SchedulingPolicyListingDetail :: Type -> Type #

Read SchedulingPolicyListingDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.SchedulingPolicyListingDetail

Show SchedulingPolicyListingDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.SchedulingPolicyListingDetail

NFData SchedulingPolicyListingDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.SchedulingPolicyListingDetail

Eq SchedulingPolicyListingDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.SchedulingPolicyListingDetail

Hashable SchedulingPolicyListingDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.SchedulingPolicyListingDetail

type Rep SchedulingPolicyListingDetail Source # 
Instance details

Defined in Amazonka.Batch.Types.SchedulingPolicyListingDetail

type Rep SchedulingPolicyListingDetail = D1 ('MetaData "SchedulingPolicyListingDetail" "Amazonka.Batch.Types.SchedulingPolicyListingDetail" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "SchedulingPolicyListingDetail'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newSchedulingPolicyListingDetail Source #

Create a value of SchedulingPolicyListingDetail with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:arn:SchedulingPolicyListingDetail', schedulingPolicyListingDetail_arn - Amazon Resource Name (ARN) of the scheduling policy.

Secret

data Secret Source #

An object that represents the secret to expose to your container. Secrets can be exposed to a container in the following ways:

  • To inject sensitive data into your containers as environment variables, use the secrets container definition parameter.
  • To reference sensitive information in the log configuration of a container, use the secretOptions container definition parameter.

For more information, see Specifying sensitive data in the Batch User Guide.

See: newSecret smart constructor.

Constructors

Secret' Text Text 

Instances

Instances details
FromJSON Secret Source # 
Instance details

Defined in Amazonka.Batch.Types.Secret

ToJSON Secret Source # 
Instance details

Defined in Amazonka.Batch.Types.Secret

Generic Secret Source # 
Instance details

Defined in Amazonka.Batch.Types.Secret

Associated Types

type Rep Secret :: Type -> Type #

Methods

from :: Secret -> Rep Secret x #

to :: Rep Secret x -> Secret #

Read Secret Source # 
Instance details

Defined in Amazonka.Batch.Types.Secret

Show Secret Source # 
Instance details

Defined in Amazonka.Batch.Types.Secret

NFData Secret Source # 
Instance details

Defined in Amazonka.Batch.Types.Secret

Methods

rnf :: Secret -> () #

Eq Secret Source # 
Instance details

Defined in Amazonka.Batch.Types.Secret

Methods

(==) :: Secret -> Secret -> Bool #

(/=) :: Secret -> Secret -> Bool #

Hashable Secret Source # 
Instance details

Defined in Amazonka.Batch.Types.Secret

Methods

hashWithSalt :: Int -> Secret -> Int #

hash :: Secret -> Int #

type Rep Secret Source # 
Instance details

Defined in Amazonka.Batch.Types.Secret

type Rep Secret = D1 ('MetaData "Secret" "Amazonka.Batch.Types.Secret" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "Secret'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "valueFrom") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newSecret Source #

Create a value of Secret with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:name:Secret', secret_name - The name of the secret.

$sel:valueFrom:Secret', secret_valueFrom - The secret to expose to the container. The supported values are either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job you're launching, then you can use either the full Amazon Resource Name (ARN) or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.

ShareAttributes

data ShareAttributes Source #

Specifies the weights for the fair share identifiers for the fair share policy. Fair share identifiers that aren't included have a default weight of 1.0.

See: newShareAttributes smart constructor.

Instances

Instances details
FromJSON ShareAttributes Source # 
Instance details

Defined in Amazonka.Batch.Types.ShareAttributes

ToJSON ShareAttributes Source # 
Instance details

Defined in Amazonka.Batch.Types.ShareAttributes

Generic ShareAttributes Source # 
Instance details

Defined in Amazonka.Batch.Types.ShareAttributes

Associated Types

type Rep ShareAttributes :: Type -> Type #

Read ShareAttributes Source # 
Instance details

Defined in Amazonka.Batch.Types.ShareAttributes

Show ShareAttributes Source # 
Instance details

Defined in Amazonka.Batch.Types.ShareAttributes

NFData ShareAttributes Source # 
Instance details

Defined in Amazonka.Batch.Types.ShareAttributes

Methods

rnf :: ShareAttributes -> () #

Eq ShareAttributes Source # 
Instance details

Defined in Amazonka.Batch.Types.ShareAttributes

Hashable ShareAttributes Source # 
Instance details

Defined in Amazonka.Batch.Types.ShareAttributes

type Rep ShareAttributes Source # 
Instance details

Defined in Amazonka.Batch.Types.ShareAttributes

type Rep ShareAttributes = D1 ('MetaData "ShareAttributes" "Amazonka.Batch.Types.ShareAttributes" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "ShareAttributes'" 'PrefixI 'True) (S1 ('MetaSel ('Just "weightFactor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "shareIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newShareAttributes Source #

Create a value of ShareAttributes with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:weightFactor:ShareAttributes', shareAttributes_weightFactor - The weight factor for the fair share identifier. The default value is 1.0. A lower value has a higher priority for compute resources. For example, jobs that use a share identifier with a weight factor of 0.125 (1/8) get 8 times the compute resources of jobs that use a share identifier with a weight factor of 1.

The smallest supported value is 0.0001, and the largest supported value is 999.9999.

$sel:shareIdentifier:ShareAttributes', shareAttributes_shareIdentifier - A fair share identifier or fair share identifier prefix. If the string ends with an asterisk (*), this entry specifies the weight factor to use for fair share identifiers that start with that prefix. The list of fair share identifiers in a fair share policy can't overlap. For example, you can't have one that specifies a shareIdentifier of UserA* and another that specifies a shareIdentifier of UserA-1.

There can be no more than 500 fair share identifiers active in a job queue.

The string is limited to 255 alphanumeric characters, and can be followed by an asterisk (*).

Tmpfs

data Tmpfs Source #

The container path, mount options, and size of the tmpfs mount.

This object isn't applicable to jobs that are running on Fargate resources.

See: newTmpfs smart constructor.

Constructors

Tmpfs' (Maybe [Text]) Text Int 

Instances

Instances details
FromJSON Tmpfs Source # 
Instance details

Defined in Amazonka.Batch.Types.Tmpfs

ToJSON Tmpfs Source # 
Instance details

Defined in Amazonka.Batch.Types.Tmpfs

Generic Tmpfs Source # 
Instance details

Defined in Amazonka.Batch.Types.Tmpfs

Associated Types

type Rep Tmpfs :: Type -> Type #

Methods

from :: Tmpfs -> Rep Tmpfs x #

to :: Rep Tmpfs x -> Tmpfs #

Read Tmpfs Source # 
Instance details

Defined in Amazonka.Batch.Types.Tmpfs

Show Tmpfs Source # 
Instance details

Defined in Amazonka.Batch.Types.Tmpfs

Methods

showsPrec :: Int -> Tmpfs -> ShowS #

show :: Tmpfs -> String #

showList :: [Tmpfs] -> ShowS #

NFData Tmpfs Source # 
Instance details

Defined in Amazonka.Batch.Types.Tmpfs

Methods

rnf :: Tmpfs -> () #

Eq Tmpfs Source # 
Instance details

Defined in Amazonka.Batch.Types.Tmpfs

Methods

(==) :: Tmpfs -> Tmpfs -> Bool #

(/=) :: Tmpfs -> Tmpfs -> Bool #

Hashable Tmpfs Source # 
Instance details

Defined in Amazonka.Batch.Types.Tmpfs

Methods

hashWithSalt :: Int -> Tmpfs -> Int #

hash :: Tmpfs -> Int #

type Rep Tmpfs Source # 
Instance details

Defined in Amazonka.Batch.Types.Tmpfs

type Rep Tmpfs = D1 ('MetaData "Tmpfs" "Amazonka.Batch.Types.Tmpfs" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "Tmpfs'" 'PrefixI 'True) (S1 ('MetaSel ('Just "mountOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "containerPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newTmpfs Source #

Create a value of Tmpfs with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:mountOptions:Tmpfs', tmpfs_mountOptions - The list of tmpfs volume mount options.

Valid values: "defaults" | "ro" | "rw" | "suid" | "nosuid" | "dev" | "nodev" | "exec" | "noexec" | "sync" | "async" | "dirsync" | "remount" | "mand" | "nomand" | "atime" | "noatime" | "diratime" | "nodiratime" | "bind" | "rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | "norelatime" | "strictatime" | "nostrictatime" | "mode" | "uid" | "gid" | "nr_inodes" | "nr_blocks" | "mpol"

$sel:containerPath:Tmpfs', tmpfs_containerPath - The absolute file path in the container where the tmpfs volume is mounted.

$sel:size:Tmpfs', tmpfs_size - The size (in MiB) of the tmpfs volume.

Ulimit

data Ulimit Source #

The ulimit settings to pass to the container.

This object isn't applicable to jobs that are running on Fargate resources.

See: newUlimit smart constructor.

Constructors

Ulimit' Int Text Int 

Instances

Instances details
FromJSON Ulimit Source # 
Instance details

Defined in Amazonka.Batch.Types.Ulimit

ToJSON Ulimit Source # 
Instance details

Defined in Amazonka.Batch.Types.Ulimit

Generic Ulimit Source # 
Instance details

Defined in Amazonka.Batch.Types.Ulimit

Associated Types

type Rep Ulimit :: Type -> Type #

Methods

from :: Ulimit -> Rep Ulimit x #

to :: Rep Ulimit x -> Ulimit #

Read Ulimit Source # 
Instance details

Defined in Amazonka.Batch.Types.Ulimit

Show Ulimit Source # 
Instance details

Defined in Amazonka.Batch.Types.Ulimit

NFData Ulimit Source # 
Instance details

Defined in Amazonka.Batch.Types.Ulimit

Methods

rnf :: Ulimit -> () #

Eq Ulimit Source # 
Instance details

Defined in Amazonka.Batch.Types.Ulimit

Methods

(==) :: Ulimit -> Ulimit -> Bool #

(/=) :: Ulimit -> Ulimit -> Bool #

Hashable Ulimit Source # 
Instance details

Defined in Amazonka.Batch.Types.Ulimit

Methods

hashWithSalt :: Int -> Ulimit -> Int #

hash :: Ulimit -> Int #

type Rep Ulimit Source # 
Instance details

Defined in Amazonka.Batch.Types.Ulimit

type Rep Ulimit = D1 ('MetaData "Ulimit" "Amazonka.Batch.Types.Ulimit" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "Ulimit'" 'PrefixI 'True) (S1 ('MetaSel ('Just "hardLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "softLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newUlimit Source #

Create a value of Ulimit with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:hardLimit:Ulimit', ulimit_hardLimit - The hard limit for the ulimit type.

$sel:name:Ulimit', ulimit_name - The type of the ulimit.

$sel:softLimit:Ulimit', ulimit_softLimit - The soft limit for the ulimit type.

UpdatePolicy

data UpdatePolicy Source #

Specifies the infrastructure update policy for the compute environment. For more information about infrastructure updates, see Updating compute environments in the Batch User Guide.

See: newUpdatePolicy smart constructor.

Instances

Instances details
FromJSON UpdatePolicy Source # 
Instance details

Defined in Amazonka.Batch.Types.UpdatePolicy

ToJSON UpdatePolicy Source # 
Instance details

Defined in Amazonka.Batch.Types.UpdatePolicy

Generic UpdatePolicy Source # 
Instance details

Defined in Amazonka.Batch.Types.UpdatePolicy

Associated Types

type Rep UpdatePolicy :: Type -> Type #

Read UpdatePolicy Source # 
Instance details

Defined in Amazonka.Batch.Types.UpdatePolicy

Show UpdatePolicy Source # 
Instance details

Defined in Amazonka.Batch.Types.UpdatePolicy

NFData UpdatePolicy Source # 
Instance details

Defined in Amazonka.Batch.Types.UpdatePolicy

Methods

rnf :: UpdatePolicy -> () #

Eq UpdatePolicy Source # 
Instance details

Defined in Amazonka.Batch.Types.UpdatePolicy

Hashable UpdatePolicy Source # 
Instance details

Defined in Amazonka.Batch.Types.UpdatePolicy

type Rep UpdatePolicy Source # 
Instance details

Defined in Amazonka.Batch.Types.UpdatePolicy

type Rep UpdatePolicy = D1 ('MetaData "UpdatePolicy" "Amazonka.Batch.Types.UpdatePolicy" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "UpdatePolicy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobExecutionTimeoutMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "terminateJobsOnUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))

newUpdatePolicy :: UpdatePolicy Source #

Create a value of UpdatePolicy with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobExecutionTimeoutMinutes:UpdatePolicy', updatePolicy_jobExecutionTimeoutMinutes - Specifies the job timeout (in minutes) when the compute environment infrastructure is updated. The default value is 30.

$sel:terminateJobsOnUpdate:UpdatePolicy', updatePolicy_terminateJobsOnUpdate - Specifies whether jobs are automatically terminated when the computer environment infrastructure is updated. The default value is false.

Volume

data Volume Source #

A data volume that's used in a job's container properties.

See: newVolume smart constructor.

Instances

Instances details
FromJSON Volume Source # 
Instance details

Defined in Amazonka.Batch.Types.Volume

ToJSON Volume Source # 
Instance details

Defined in Amazonka.Batch.Types.Volume

Generic Volume Source # 
Instance details

Defined in Amazonka.Batch.Types.Volume

Associated Types

type Rep Volume :: Type -> Type #

Methods

from :: Volume -> Rep Volume x #

to :: Rep Volume x -> Volume #

Read Volume Source # 
Instance details

Defined in Amazonka.Batch.Types.Volume

Show Volume Source # 
Instance details

Defined in Amazonka.Batch.Types.Volume

NFData Volume Source # 
Instance details

Defined in Amazonka.Batch.Types.Volume

Methods

rnf :: Volume -> () #

Eq Volume Source # 
Instance details

Defined in Amazonka.Batch.Types.Volume

Methods

(==) :: Volume -> Volume -> Bool #

(/=) :: Volume -> Volume -> Bool #

Hashable Volume Source # 
Instance details

Defined in Amazonka.Batch.Types.Volume

Methods

hashWithSalt :: Int -> Volume -> Int #

hash :: Volume -> Int #

type Rep Volume Source # 
Instance details

Defined in Amazonka.Batch.Types.Volume

type Rep Volume = D1 ('MetaData "Volume" "Amazonka.Batch.Types.Volume" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "Volume'" 'PrefixI 'True) (S1 ('MetaSel ('Just "efsVolumeConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EFSVolumeConfiguration)) :*: (S1 ('MetaSel ('Just "host") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Host)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newVolume :: Volume Source #

Create a value of Volume with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:efsVolumeConfiguration:Volume', volume_efsVolumeConfiguration - This parameter is specified when you're using an Amazon Elastic File System file system for job storage. Jobs that are running on Fargate resources must specify a platformVersion of at least 1.4.0.

$sel:host:Volume', volume_host - The contents of the host parameter determine whether your data volume persists on the host container instance and where it's stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.

$sel:name:Volume', volume_name - The name of the volume. It can be up to 255 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_). This name is referenced in the sourceVolume parameter of container definition mountPoints.