Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Operations
- CancelJob
- CreateComputeEnvironment
- CreateJobQueue
- CreateSchedulingPolicy
- DeleteComputeEnvironment
- DeleteJobQueue
- DeleteSchedulingPolicy
- DeregisterJobDefinition
- DescribeComputeEnvironments
- DescribeJobDefinitions
- DescribeJobQueues
- DescribeJobs
- DescribeSchedulingPolicies
- ListJobs
- ListSchedulingPolicies
- ListTagsForResource
- RegisterJobDefinition
- SubmitJob
- TagResource
- TerminateJob
- UntagResource
- UpdateComputeEnvironment
- UpdateJobQueue
- UpdateSchedulingPolicy
- Types
- ArrayProperties
- ArrayPropertiesDetail
- ArrayPropertiesSummary
- AttemptContainerDetail
- AttemptDetail
- ComputeEnvironmentDetail
- ComputeEnvironmentOrder
- ComputeResource
- ComputeResourceUpdate
- ContainerDetail
- ContainerOverrides
- ContainerProperties
- ContainerSummary
- Device
- EFSAuthorizationConfig
- EFSVolumeConfiguration
- Ec2Configuration
- EksAttemptContainerDetail
- EksAttemptDetail
- EksConfiguration
- EksContainer
- EksContainerDetail
- EksContainerEnvironmentVariable
- EksContainerOverride
- EksContainerResourceRequirements
- EksContainerSecurityContext
- EksContainerVolumeMount
- EksEmptyDir
- EksHostPath
- EksPodProperties
- EksPodPropertiesDetail
- EksPodPropertiesOverride
- EksProperties
- EksPropertiesDetail
- EksPropertiesOverride
- EksSecret
- EksVolume
- EvaluateOnExit
- FairsharePolicy
- FargatePlatformConfiguration
- Host
- JobDefinition
- JobDependency
- JobDetail
- JobQueueDetail
- JobSummary
- JobTimeout
- KeyValuePair
- KeyValuesPair
- LaunchTemplateSpecification
- LinuxParameters
- LogConfiguration
- MountPoint
- NetworkConfiguration
- NetworkInterface
- NodeDetails
- NodeOverrides
- NodeProperties
- NodePropertiesSummary
- NodePropertyOverride
- NodeRangeProperty
- ResourceRequirement
- RetryStrategy
- SchedulingPolicyDetail
- SchedulingPolicyListingDetail
- Secret
- ShareAttributes
- Tmpfs
- Ulimit
- UpdatePolicy
- Volume
Synopsis
- cancelJob_jobId :: Lens' CancelJob Text
- cancelJob_reason :: Lens' CancelJob Text
- cancelJobResponse_httpStatus :: Lens' CancelJobResponse Int
- createComputeEnvironment_computeResources :: Lens' CreateComputeEnvironment (Maybe ComputeResource)
- createComputeEnvironment_eksConfiguration :: Lens' CreateComputeEnvironment (Maybe EksConfiguration)
- createComputeEnvironment_serviceRole :: Lens' CreateComputeEnvironment (Maybe Text)
- createComputeEnvironment_state :: Lens' CreateComputeEnvironment (Maybe CEState)
- createComputeEnvironment_tags :: Lens' CreateComputeEnvironment (Maybe (HashMap Text Text))
- createComputeEnvironment_unmanagedvCpus :: Lens' CreateComputeEnvironment (Maybe Int)
- createComputeEnvironment_computeEnvironmentName :: Lens' CreateComputeEnvironment Text
- createComputeEnvironment_type :: Lens' CreateComputeEnvironment CEType
- createComputeEnvironmentResponse_computeEnvironmentArn :: Lens' CreateComputeEnvironmentResponse (Maybe Text)
- createComputeEnvironmentResponse_computeEnvironmentName :: Lens' CreateComputeEnvironmentResponse (Maybe Text)
- createComputeEnvironmentResponse_httpStatus :: Lens' CreateComputeEnvironmentResponse Int
- createJobQueue_schedulingPolicyArn :: Lens' CreateJobQueue (Maybe Text)
- createJobQueue_state :: Lens' CreateJobQueue (Maybe JQState)
- createJobQueue_tags :: Lens' CreateJobQueue (Maybe (HashMap Text Text))
- createJobQueue_jobQueueName :: Lens' CreateJobQueue Text
- createJobQueue_priority :: Lens' CreateJobQueue Int
- createJobQueue_computeEnvironmentOrder :: Lens' CreateJobQueue [ComputeEnvironmentOrder]
- createJobQueueResponse_httpStatus :: Lens' CreateJobQueueResponse Int
- createJobQueueResponse_jobQueueName :: Lens' CreateJobQueueResponse Text
- createJobQueueResponse_jobQueueArn :: Lens' CreateJobQueueResponse Text
- createSchedulingPolicy_fairsharePolicy :: Lens' CreateSchedulingPolicy (Maybe FairsharePolicy)
- createSchedulingPolicy_tags :: Lens' CreateSchedulingPolicy (Maybe (HashMap Text Text))
- createSchedulingPolicy_name :: Lens' CreateSchedulingPolicy Text
- createSchedulingPolicyResponse_httpStatus :: Lens' CreateSchedulingPolicyResponse Int
- createSchedulingPolicyResponse_name :: Lens' CreateSchedulingPolicyResponse Text
- createSchedulingPolicyResponse_arn :: Lens' CreateSchedulingPolicyResponse Text
- deleteComputeEnvironment_computeEnvironment :: Lens' DeleteComputeEnvironment Text
- deleteComputeEnvironmentResponse_httpStatus :: Lens' DeleteComputeEnvironmentResponse Int
- deleteJobQueue_jobQueue :: Lens' DeleteJobQueue Text
- deleteJobQueueResponse_httpStatus :: Lens' DeleteJobQueueResponse Int
- deleteSchedulingPolicy_arn :: Lens' DeleteSchedulingPolicy Text
- deleteSchedulingPolicyResponse_httpStatus :: Lens' DeleteSchedulingPolicyResponse Int
- deregisterJobDefinition_jobDefinition :: Lens' DeregisterJobDefinition Text
- deregisterJobDefinitionResponse_httpStatus :: Lens' DeregisterJobDefinitionResponse Int
- describeComputeEnvironments_computeEnvironments :: Lens' DescribeComputeEnvironments (Maybe [Text])
- describeComputeEnvironments_maxResults :: Lens' DescribeComputeEnvironments (Maybe Int)
- describeComputeEnvironments_nextToken :: Lens' DescribeComputeEnvironments (Maybe Text)
- describeComputeEnvironmentsResponse_computeEnvironments :: Lens' DescribeComputeEnvironmentsResponse (Maybe [ComputeEnvironmentDetail])
- describeComputeEnvironmentsResponse_nextToken :: Lens' DescribeComputeEnvironmentsResponse (Maybe Text)
- describeComputeEnvironmentsResponse_httpStatus :: Lens' DescribeComputeEnvironmentsResponse Int
- describeJobDefinitions_jobDefinitionName :: Lens' DescribeJobDefinitions (Maybe Text)
- describeJobDefinitions_jobDefinitions :: Lens' DescribeJobDefinitions (Maybe [Text])
- describeJobDefinitions_maxResults :: Lens' DescribeJobDefinitions (Maybe Int)
- describeJobDefinitions_nextToken :: Lens' DescribeJobDefinitions (Maybe Text)
- describeJobDefinitions_status :: Lens' DescribeJobDefinitions (Maybe Text)
- describeJobDefinitionsResponse_jobDefinitions :: Lens' DescribeJobDefinitionsResponse (Maybe [JobDefinition])
- describeJobDefinitionsResponse_nextToken :: Lens' DescribeJobDefinitionsResponse (Maybe Text)
- describeJobDefinitionsResponse_httpStatus :: Lens' DescribeJobDefinitionsResponse Int
- describeJobQueues_jobQueues :: Lens' DescribeJobQueues (Maybe [Text])
- describeJobQueues_maxResults :: Lens' DescribeJobQueues (Maybe Int)
- describeJobQueues_nextToken :: Lens' DescribeJobQueues (Maybe Text)
- describeJobQueuesResponse_jobQueues :: Lens' DescribeJobQueuesResponse (Maybe [JobQueueDetail])
- describeJobQueuesResponse_nextToken :: Lens' DescribeJobQueuesResponse (Maybe Text)
- describeJobQueuesResponse_httpStatus :: Lens' DescribeJobQueuesResponse Int
- describeJobs_jobs :: Lens' DescribeJobs [Text]
- describeJobsResponse_jobs :: Lens' DescribeJobsResponse (Maybe [JobDetail])
- describeJobsResponse_httpStatus :: Lens' DescribeJobsResponse Int
- describeSchedulingPolicies_arns :: Lens' DescribeSchedulingPolicies [Text]
- describeSchedulingPoliciesResponse_schedulingPolicies :: Lens' DescribeSchedulingPoliciesResponse (Maybe [SchedulingPolicyDetail])
- describeSchedulingPoliciesResponse_httpStatus :: Lens' DescribeSchedulingPoliciesResponse Int
- listJobs_arrayJobId :: Lens' ListJobs (Maybe Text)
- listJobs_filters :: Lens' ListJobs (Maybe [KeyValuesPair])
- listJobs_jobQueue :: Lens' ListJobs (Maybe Text)
- listJobs_jobStatus :: Lens' ListJobs (Maybe JobStatus)
- listJobs_maxResults :: Lens' ListJobs (Maybe Int)
- listJobs_multiNodeJobId :: Lens' ListJobs (Maybe Text)
- listJobs_nextToken :: Lens' ListJobs (Maybe Text)
- listJobsResponse_nextToken :: Lens' ListJobsResponse (Maybe Text)
- listJobsResponse_httpStatus :: Lens' ListJobsResponse Int
- listJobsResponse_jobSummaryList :: Lens' ListJobsResponse [JobSummary]
- listSchedulingPolicies_maxResults :: Lens' ListSchedulingPolicies (Maybe Int)
- listSchedulingPolicies_nextToken :: Lens' ListSchedulingPolicies (Maybe Text)
- listSchedulingPoliciesResponse_nextToken :: Lens' ListSchedulingPoliciesResponse (Maybe Text)
- listSchedulingPoliciesResponse_schedulingPolicies :: Lens' ListSchedulingPoliciesResponse (Maybe [SchedulingPolicyListingDetail])
- listSchedulingPoliciesResponse_httpStatus :: Lens' ListSchedulingPoliciesResponse Int
- listTagsForResource_resourceArn :: Lens' ListTagsForResource Text
- listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text))
- listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
- registerJobDefinition_containerProperties :: Lens' RegisterJobDefinition (Maybe ContainerProperties)
- registerJobDefinition_eksProperties :: Lens' RegisterJobDefinition (Maybe EksProperties)
- registerJobDefinition_nodeProperties :: Lens' RegisterJobDefinition (Maybe NodeProperties)
- registerJobDefinition_parameters :: Lens' RegisterJobDefinition (Maybe (HashMap Text Text))
- registerJobDefinition_platformCapabilities :: Lens' RegisterJobDefinition (Maybe [PlatformCapability])
- registerJobDefinition_propagateTags :: Lens' RegisterJobDefinition (Maybe Bool)
- registerJobDefinition_retryStrategy :: Lens' RegisterJobDefinition (Maybe RetryStrategy)
- registerJobDefinition_schedulingPriority :: Lens' RegisterJobDefinition (Maybe Int)
- registerJobDefinition_tags :: Lens' RegisterJobDefinition (Maybe (HashMap Text Text))
- registerJobDefinition_timeout :: Lens' RegisterJobDefinition (Maybe JobTimeout)
- registerJobDefinition_jobDefinitionName :: Lens' RegisterJobDefinition Text
- registerJobDefinition_type :: Lens' RegisterJobDefinition JobDefinitionType
- registerJobDefinitionResponse_httpStatus :: Lens' RegisterJobDefinitionResponse Int
- registerJobDefinitionResponse_jobDefinitionName :: Lens' RegisterJobDefinitionResponse Text
- registerJobDefinitionResponse_jobDefinitionArn :: Lens' RegisterJobDefinitionResponse Text
- registerJobDefinitionResponse_revision :: Lens' RegisterJobDefinitionResponse Int
- submitJob_arrayProperties :: Lens' SubmitJob (Maybe ArrayProperties)
- submitJob_containerOverrides :: Lens' SubmitJob (Maybe ContainerOverrides)
- submitJob_dependsOn :: Lens' SubmitJob (Maybe [JobDependency])
- submitJob_eksPropertiesOverride :: Lens' SubmitJob (Maybe EksPropertiesOverride)
- submitJob_nodeOverrides :: Lens' SubmitJob (Maybe NodeOverrides)
- submitJob_parameters :: Lens' SubmitJob (Maybe (HashMap Text Text))
- submitJob_propagateTags :: Lens' SubmitJob (Maybe Bool)
- submitJob_retryStrategy :: Lens' SubmitJob (Maybe RetryStrategy)
- submitJob_schedulingPriorityOverride :: Lens' SubmitJob (Maybe Int)
- submitJob_shareIdentifier :: Lens' SubmitJob (Maybe Text)
- submitJob_tags :: Lens' SubmitJob (Maybe (HashMap Text Text))
- submitJob_timeout :: Lens' SubmitJob (Maybe JobTimeout)
- submitJob_jobName :: Lens' SubmitJob Text
- submitJob_jobQueue :: Lens' SubmitJob Text
- submitJob_jobDefinition :: Lens' SubmitJob Text
- submitJobResponse_jobArn :: Lens' SubmitJobResponse (Maybe Text)
- submitJobResponse_httpStatus :: Lens' SubmitJobResponse Int
- submitJobResponse_jobName :: Lens' SubmitJobResponse Text
- submitJobResponse_jobId :: Lens' SubmitJobResponse Text
- tagResource_resourceArn :: Lens' TagResource Text
- tagResource_tags :: Lens' TagResource (HashMap Text Text)
- tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int
- terminateJob_jobId :: Lens' TerminateJob Text
- terminateJob_reason :: Lens' TerminateJob Text
- terminateJobResponse_httpStatus :: Lens' TerminateJobResponse Int
- untagResource_resourceArn :: Lens' UntagResource Text
- untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text)
- untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int
- updateComputeEnvironment_computeResources :: Lens' UpdateComputeEnvironment (Maybe ComputeResourceUpdate)
- updateComputeEnvironment_serviceRole :: Lens' UpdateComputeEnvironment (Maybe Text)
- updateComputeEnvironment_state :: Lens' UpdateComputeEnvironment (Maybe CEState)
- updateComputeEnvironment_unmanagedvCpus :: Lens' UpdateComputeEnvironment (Maybe Int)
- updateComputeEnvironment_updatePolicy :: Lens' UpdateComputeEnvironment (Maybe UpdatePolicy)
- updateComputeEnvironment_computeEnvironment :: Lens' UpdateComputeEnvironment Text
- updateComputeEnvironmentResponse_computeEnvironmentArn :: Lens' UpdateComputeEnvironmentResponse (Maybe Text)
- updateComputeEnvironmentResponse_computeEnvironmentName :: Lens' UpdateComputeEnvironmentResponse (Maybe Text)
- updateComputeEnvironmentResponse_httpStatus :: Lens' UpdateComputeEnvironmentResponse Int
- updateJobQueue_computeEnvironmentOrder :: Lens' UpdateJobQueue (Maybe [ComputeEnvironmentOrder])
- updateJobQueue_priority :: Lens' UpdateJobQueue (Maybe Int)
- updateJobQueue_schedulingPolicyArn :: Lens' UpdateJobQueue (Maybe Text)
- updateJobQueue_state :: Lens' UpdateJobQueue (Maybe JQState)
- updateJobQueue_jobQueue :: Lens' UpdateJobQueue Text
- updateJobQueueResponse_jobQueueArn :: Lens' UpdateJobQueueResponse (Maybe Text)
- updateJobQueueResponse_jobQueueName :: Lens' UpdateJobQueueResponse (Maybe Text)
- updateJobQueueResponse_httpStatus :: Lens' UpdateJobQueueResponse Int
- updateSchedulingPolicy_fairsharePolicy :: Lens' UpdateSchedulingPolicy (Maybe FairsharePolicy)
- updateSchedulingPolicy_arn :: Lens' UpdateSchedulingPolicy Text
- updateSchedulingPolicyResponse_httpStatus :: Lens' UpdateSchedulingPolicyResponse Int
- arrayProperties_size :: Lens' ArrayProperties (Maybe Int)
- arrayPropertiesDetail_index :: Lens' ArrayPropertiesDetail (Maybe Int)
- arrayPropertiesDetail_size :: Lens' ArrayPropertiesDetail (Maybe Int)
- arrayPropertiesDetail_statusSummary :: Lens' ArrayPropertiesDetail (Maybe (HashMap Text Int))
- arrayPropertiesSummary_index :: Lens' ArrayPropertiesSummary (Maybe Int)
- arrayPropertiesSummary_size :: Lens' ArrayPropertiesSummary (Maybe Int)
- attemptContainerDetail_containerInstanceArn :: Lens' AttemptContainerDetail (Maybe Text)
- attemptContainerDetail_exitCode :: Lens' AttemptContainerDetail (Maybe Int)
- attemptContainerDetail_logStreamName :: Lens' AttemptContainerDetail (Maybe Text)
- attemptContainerDetail_networkInterfaces :: Lens' AttemptContainerDetail (Maybe [NetworkInterface])
- attemptContainerDetail_reason :: Lens' AttemptContainerDetail (Maybe Text)
- attemptContainerDetail_taskArn :: Lens' AttemptContainerDetail (Maybe Text)
- attemptDetail_container :: Lens' AttemptDetail (Maybe AttemptContainerDetail)
- attemptDetail_startedAt :: Lens' AttemptDetail (Maybe Integer)
- attemptDetail_statusReason :: Lens' AttemptDetail (Maybe Text)
- attemptDetail_stoppedAt :: Lens' AttemptDetail (Maybe Integer)
- computeEnvironmentDetail_computeResources :: Lens' ComputeEnvironmentDetail (Maybe ComputeResource)
- computeEnvironmentDetail_containerOrchestrationType :: Lens' ComputeEnvironmentDetail (Maybe OrchestrationType)
- computeEnvironmentDetail_ecsClusterArn :: Lens' ComputeEnvironmentDetail (Maybe Text)
- computeEnvironmentDetail_eksConfiguration :: Lens' ComputeEnvironmentDetail (Maybe EksConfiguration)
- computeEnvironmentDetail_serviceRole :: Lens' ComputeEnvironmentDetail (Maybe Text)
- computeEnvironmentDetail_state :: Lens' ComputeEnvironmentDetail (Maybe CEState)
- computeEnvironmentDetail_status :: Lens' ComputeEnvironmentDetail (Maybe CEStatus)
- computeEnvironmentDetail_statusReason :: Lens' ComputeEnvironmentDetail (Maybe Text)
- computeEnvironmentDetail_tags :: Lens' ComputeEnvironmentDetail (Maybe (HashMap Text Text))
- computeEnvironmentDetail_type :: Lens' ComputeEnvironmentDetail (Maybe CEType)
- computeEnvironmentDetail_unmanagedvCpus :: Lens' ComputeEnvironmentDetail (Maybe Int)
- computeEnvironmentDetail_updatePolicy :: Lens' ComputeEnvironmentDetail (Maybe UpdatePolicy)
- computeEnvironmentDetail_uuid :: Lens' ComputeEnvironmentDetail (Maybe Text)
- computeEnvironmentDetail_computeEnvironmentName :: Lens' ComputeEnvironmentDetail Text
- computeEnvironmentDetail_computeEnvironmentArn :: Lens' ComputeEnvironmentDetail Text
- computeEnvironmentOrder_order :: Lens' ComputeEnvironmentOrder Int
- computeEnvironmentOrder_computeEnvironment :: Lens' ComputeEnvironmentOrder Text
- computeResource_allocationStrategy :: Lens' ComputeResource (Maybe CRAllocationStrategy)
- computeResource_bidPercentage :: Lens' ComputeResource (Maybe Int)
- computeResource_desiredvCpus :: Lens' ComputeResource (Maybe Int)
- computeResource_ec2Configuration :: Lens' ComputeResource (Maybe [Ec2Configuration])
- computeResource_ec2KeyPair :: Lens' ComputeResource (Maybe Text)
- computeResource_imageId :: Lens' ComputeResource (Maybe Text)
- computeResource_instanceRole :: Lens' ComputeResource (Maybe Text)
- computeResource_instanceTypes :: Lens' ComputeResource (Maybe [Text])
- computeResource_launchTemplate :: Lens' ComputeResource (Maybe LaunchTemplateSpecification)
- computeResource_minvCpus :: Lens' ComputeResource (Maybe Int)
- computeResource_placementGroup :: Lens' ComputeResource (Maybe Text)
- computeResource_securityGroupIds :: Lens' ComputeResource (Maybe [Text])
- computeResource_spotIamFleetRole :: Lens' ComputeResource (Maybe Text)
- computeResource_tags :: Lens' ComputeResource (Maybe (HashMap Text Text))
- computeResource_type :: Lens' ComputeResource CRType
- computeResource_maxvCpus :: Lens' ComputeResource Int
- computeResource_subnets :: Lens' ComputeResource [Text]
- computeResourceUpdate_allocationStrategy :: Lens' ComputeResourceUpdate (Maybe CRUpdateAllocationStrategy)
- computeResourceUpdate_bidPercentage :: Lens' ComputeResourceUpdate (Maybe Int)
- computeResourceUpdate_desiredvCpus :: Lens' ComputeResourceUpdate (Maybe Int)
- computeResourceUpdate_ec2Configuration :: Lens' ComputeResourceUpdate (Maybe [Ec2Configuration])
- computeResourceUpdate_ec2KeyPair :: Lens' ComputeResourceUpdate (Maybe Text)
- computeResourceUpdate_imageId :: Lens' ComputeResourceUpdate (Maybe Text)
- computeResourceUpdate_instanceRole :: Lens' ComputeResourceUpdate (Maybe Text)
- computeResourceUpdate_instanceTypes :: Lens' ComputeResourceUpdate (Maybe [Text])
- computeResourceUpdate_launchTemplate :: Lens' ComputeResourceUpdate (Maybe LaunchTemplateSpecification)
- computeResourceUpdate_maxvCpus :: Lens' ComputeResourceUpdate (Maybe Int)
- computeResourceUpdate_minvCpus :: Lens' ComputeResourceUpdate (Maybe Int)
- computeResourceUpdate_placementGroup :: Lens' ComputeResourceUpdate (Maybe Text)
- computeResourceUpdate_securityGroupIds :: Lens' ComputeResourceUpdate (Maybe [Text])
- computeResourceUpdate_subnets :: Lens' ComputeResourceUpdate (Maybe [Text])
- computeResourceUpdate_tags :: Lens' ComputeResourceUpdate (Maybe (HashMap Text Text))
- computeResourceUpdate_type :: Lens' ComputeResourceUpdate (Maybe CRType)
- computeResourceUpdate_updateToLatestImageVersion :: Lens' ComputeResourceUpdate (Maybe Bool)
- containerDetail_command :: Lens' ContainerDetail (Maybe [Text])
- containerDetail_containerInstanceArn :: Lens' ContainerDetail (Maybe Text)
- containerDetail_environment :: Lens' ContainerDetail (Maybe [KeyValuePair])
- containerDetail_executionRoleArn :: Lens' ContainerDetail (Maybe Text)
- containerDetail_exitCode :: Lens' ContainerDetail (Maybe Int)
- containerDetail_fargatePlatformConfiguration :: Lens' ContainerDetail (Maybe FargatePlatformConfiguration)
- containerDetail_image :: Lens' ContainerDetail (Maybe Text)
- containerDetail_instanceType :: Lens' ContainerDetail (Maybe Text)
- containerDetail_jobRoleArn :: Lens' ContainerDetail (Maybe Text)
- containerDetail_linuxParameters :: Lens' ContainerDetail (Maybe LinuxParameters)
- containerDetail_logConfiguration :: Lens' ContainerDetail (Maybe LogConfiguration)
- containerDetail_logStreamName :: Lens' ContainerDetail (Maybe Text)
- containerDetail_memory :: Lens' ContainerDetail (Maybe Int)
- containerDetail_mountPoints :: Lens' ContainerDetail (Maybe [MountPoint])
- containerDetail_networkConfiguration :: Lens' ContainerDetail (Maybe NetworkConfiguration)
- containerDetail_networkInterfaces :: Lens' ContainerDetail (Maybe [NetworkInterface])
- containerDetail_privileged :: Lens' ContainerDetail (Maybe Bool)
- containerDetail_readonlyRootFilesystem :: Lens' ContainerDetail (Maybe Bool)
- containerDetail_reason :: Lens' ContainerDetail (Maybe Text)
- containerDetail_resourceRequirements :: Lens' ContainerDetail (Maybe [ResourceRequirement])
- containerDetail_secrets :: Lens' ContainerDetail (Maybe [Secret])
- containerDetail_taskArn :: Lens' ContainerDetail (Maybe Text)
- containerDetail_ulimits :: Lens' ContainerDetail (Maybe [Ulimit])
- containerDetail_user :: Lens' ContainerDetail (Maybe Text)
- containerDetail_vcpus :: Lens' ContainerDetail (Maybe Int)
- containerDetail_volumes :: Lens' ContainerDetail (Maybe [Volume])
- containerOverrides_command :: Lens' ContainerOverrides (Maybe [Text])
- containerOverrides_environment :: Lens' ContainerOverrides (Maybe [KeyValuePair])
- containerOverrides_instanceType :: Lens' ContainerOverrides (Maybe Text)
- containerOverrides_memory :: Lens' ContainerOverrides (Maybe Int)
- containerOverrides_resourceRequirements :: Lens' ContainerOverrides (Maybe [ResourceRequirement])
- containerOverrides_vcpus :: Lens' ContainerOverrides (Maybe Int)
- containerProperties_command :: Lens' ContainerProperties (Maybe [Text])
- containerProperties_environment :: Lens' ContainerProperties (Maybe [KeyValuePair])
- containerProperties_executionRoleArn :: Lens' ContainerProperties (Maybe Text)
- containerProperties_fargatePlatformConfiguration :: Lens' ContainerProperties (Maybe FargatePlatformConfiguration)
- containerProperties_image :: Lens' ContainerProperties (Maybe Text)
- containerProperties_instanceType :: Lens' ContainerProperties (Maybe Text)
- containerProperties_jobRoleArn :: Lens' ContainerProperties (Maybe Text)
- containerProperties_linuxParameters :: Lens' ContainerProperties (Maybe LinuxParameters)
- containerProperties_logConfiguration :: Lens' ContainerProperties (Maybe LogConfiguration)
- containerProperties_memory :: Lens' ContainerProperties (Maybe Int)
- containerProperties_mountPoints :: Lens' ContainerProperties (Maybe [MountPoint])
- containerProperties_networkConfiguration :: Lens' ContainerProperties (Maybe NetworkConfiguration)
- containerProperties_privileged :: Lens' ContainerProperties (Maybe Bool)
- containerProperties_readonlyRootFilesystem :: Lens' ContainerProperties (Maybe Bool)
- containerProperties_resourceRequirements :: Lens' ContainerProperties (Maybe [ResourceRequirement])
- containerProperties_secrets :: Lens' ContainerProperties (Maybe [Secret])
- containerProperties_ulimits :: Lens' ContainerProperties (Maybe [Ulimit])
- containerProperties_user :: Lens' ContainerProperties (Maybe Text)
- containerProperties_vcpus :: Lens' ContainerProperties (Maybe Int)
- containerProperties_volumes :: Lens' ContainerProperties (Maybe [Volume])
- containerSummary_exitCode :: Lens' ContainerSummary (Maybe Int)
- containerSummary_reason :: Lens' ContainerSummary (Maybe Text)
- device_containerPath :: Lens' Device (Maybe Text)
- device_permissions :: Lens' Device (Maybe [DeviceCgroupPermission])
- device_hostPath :: Lens' Device Text
- eFSAuthorizationConfig_accessPointId :: Lens' EFSAuthorizationConfig (Maybe Text)
- eFSAuthorizationConfig_iam :: Lens' EFSAuthorizationConfig (Maybe EFSAuthorizationConfigIAM)
- eFSVolumeConfiguration_authorizationConfig :: Lens' EFSVolumeConfiguration (Maybe EFSAuthorizationConfig)
- eFSVolumeConfiguration_rootDirectory :: Lens' EFSVolumeConfiguration (Maybe Text)
- eFSVolumeConfiguration_transitEncryption :: Lens' EFSVolumeConfiguration (Maybe EFSTransitEncryption)
- eFSVolumeConfiguration_transitEncryptionPort :: Lens' EFSVolumeConfiguration (Maybe Int)
- eFSVolumeConfiguration_fileSystemId :: Lens' EFSVolumeConfiguration Text
- ec2Configuration_imageIdOverride :: Lens' Ec2Configuration (Maybe Text)
- ec2Configuration_imageKubernetesVersion :: Lens' Ec2Configuration (Maybe Text)
- ec2Configuration_imageType :: Lens' Ec2Configuration Text
- eksAttemptContainerDetail_exitCode :: Lens' EksAttemptContainerDetail (Maybe Int)
- eksAttemptContainerDetail_reason :: Lens' EksAttemptContainerDetail (Maybe Text)
- eksAttemptDetail_containers :: Lens' EksAttemptDetail (Maybe [EksAttemptContainerDetail])
- eksAttemptDetail_nodeName :: Lens' EksAttemptDetail (Maybe Text)
- eksAttemptDetail_podName :: Lens' EksAttemptDetail (Maybe Text)
- eksAttemptDetail_startedAt :: Lens' EksAttemptDetail (Maybe Integer)
- eksAttemptDetail_statusReason :: Lens' EksAttemptDetail (Maybe Text)
- eksAttemptDetail_stoppedAt :: Lens' EksAttemptDetail (Maybe Integer)
- eksConfiguration_eksClusterArn :: Lens' EksConfiguration Text
- eksConfiguration_kubernetesNamespace :: Lens' EksConfiguration Text
- eksContainer_args :: Lens' EksContainer (Maybe [Text])
- eksContainer_command :: Lens' EksContainer (Maybe [Text])
- eksContainer_env :: Lens' EksContainer (Maybe [EksContainerEnvironmentVariable])
- eksContainer_imagePullPolicy :: Lens' EksContainer (Maybe Text)
- eksContainer_name :: Lens' EksContainer (Maybe Text)
- eksContainer_resources :: Lens' EksContainer (Maybe EksContainerResourceRequirements)
- eksContainer_securityContext :: Lens' EksContainer (Maybe EksContainerSecurityContext)
- eksContainer_volumeMounts :: Lens' EksContainer (Maybe [EksContainerVolumeMount])
- eksContainer_image :: Lens' EksContainer Text
- eksContainerDetail_args :: Lens' EksContainerDetail (Maybe [Text])
- eksContainerDetail_command :: Lens' EksContainerDetail (Maybe [Text])
- eksContainerDetail_env :: Lens' EksContainerDetail (Maybe [EksContainerEnvironmentVariable])
- eksContainerDetail_exitCode :: Lens' EksContainerDetail (Maybe Int)
- eksContainerDetail_image :: Lens' EksContainerDetail (Maybe Text)
- eksContainerDetail_imagePullPolicy :: Lens' EksContainerDetail (Maybe Text)
- eksContainerDetail_name :: Lens' EksContainerDetail (Maybe Text)
- eksContainerDetail_reason :: Lens' EksContainerDetail (Maybe Text)
- eksContainerDetail_resources :: Lens' EksContainerDetail (Maybe EksContainerResourceRequirements)
- eksContainerDetail_securityContext :: Lens' EksContainerDetail (Maybe EksContainerSecurityContext)
- eksContainerDetail_volumeMounts :: Lens' EksContainerDetail (Maybe [EksContainerVolumeMount])
- eksContainerEnvironmentVariable_value :: Lens' EksContainerEnvironmentVariable (Maybe Text)
- eksContainerEnvironmentVariable_name :: Lens' EksContainerEnvironmentVariable Text
- eksContainerOverride_args :: Lens' EksContainerOverride (Maybe [Text])
- eksContainerOverride_command :: Lens' EksContainerOverride (Maybe [Text])
- eksContainerOverride_env :: Lens' EksContainerOverride (Maybe [EksContainerEnvironmentVariable])
- eksContainerOverride_image :: Lens' EksContainerOverride (Maybe Text)
- eksContainerOverride_resources :: Lens' EksContainerOverride (Maybe EksContainerResourceRequirements)
- eksContainerResourceRequirements_limits :: Lens' EksContainerResourceRequirements (Maybe (HashMap Text Text))
- eksContainerResourceRequirements_requests :: Lens' EksContainerResourceRequirements (Maybe (HashMap Text Text))
- eksContainerSecurityContext_privileged :: Lens' EksContainerSecurityContext (Maybe Bool)
- eksContainerSecurityContext_readOnlyRootFilesystem :: Lens' EksContainerSecurityContext (Maybe Bool)
- eksContainerSecurityContext_runAsGroup :: Lens' EksContainerSecurityContext (Maybe Integer)
- eksContainerSecurityContext_runAsNonRoot :: Lens' EksContainerSecurityContext (Maybe Bool)
- eksContainerSecurityContext_runAsUser :: Lens' EksContainerSecurityContext (Maybe Integer)
- eksContainerVolumeMount_mountPath :: Lens' EksContainerVolumeMount (Maybe Text)
- eksContainerVolumeMount_name :: Lens' EksContainerVolumeMount (Maybe Text)
- eksContainerVolumeMount_readOnly :: Lens' EksContainerVolumeMount (Maybe Bool)
- eksEmptyDir_medium :: Lens' EksEmptyDir (Maybe Text)
- eksEmptyDir_sizeLimit :: Lens' EksEmptyDir (Maybe Text)
- eksHostPath_path :: Lens' EksHostPath (Maybe Text)
- eksPodProperties_containers :: Lens' EksPodProperties (Maybe [EksContainer])
- eksPodProperties_dnsPolicy :: Lens' EksPodProperties (Maybe Text)
- eksPodProperties_hostNetwork :: Lens' EksPodProperties (Maybe Bool)
- eksPodProperties_serviceAccountName :: Lens' EksPodProperties (Maybe Text)
- eksPodProperties_volumes :: Lens' EksPodProperties (Maybe [EksVolume])
- eksPodPropertiesDetail_containers :: Lens' EksPodPropertiesDetail (Maybe [EksContainerDetail])
- eksPodPropertiesDetail_dnsPolicy :: Lens' EksPodPropertiesDetail (Maybe Text)
- eksPodPropertiesDetail_hostNetwork :: Lens' EksPodPropertiesDetail (Maybe Bool)
- eksPodPropertiesDetail_nodeName :: Lens' EksPodPropertiesDetail (Maybe Text)
- eksPodPropertiesDetail_podName :: Lens' EksPodPropertiesDetail (Maybe Text)
- eksPodPropertiesDetail_serviceAccountName :: Lens' EksPodPropertiesDetail (Maybe Text)
- eksPodPropertiesDetail_volumes :: Lens' EksPodPropertiesDetail (Maybe [EksVolume])
- eksPodPropertiesOverride_containers :: Lens' EksPodPropertiesOverride (Maybe [EksContainerOverride])
- eksProperties_podProperties :: Lens' EksProperties (Maybe EksPodProperties)
- eksPropertiesDetail_podProperties :: Lens' EksPropertiesDetail (Maybe EksPodPropertiesDetail)
- eksPropertiesOverride_podProperties :: Lens' EksPropertiesOverride (Maybe EksPodPropertiesOverride)
- eksSecret_optional :: Lens' EksSecret (Maybe Bool)
- eksSecret_secretName :: Lens' EksSecret Text
- eksVolume_emptyDir :: Lens' EksVolume (Maybe EksEmptyDir)
- eksVolume_hostPath :: Lens' EksVolume (Maybe EksHostPath)
- eksVolume_secret :: Lens' EksVolume (Maybe EksSecret)
- eksVolume_name :: Lens' EksVolume Text
- evaluateOnExit_onExitCode :: Lens' EvaluateOnExit (Maybe Text)
- evaluateOnExit_onReason :: Lens' EvaluateOnExit (Maybe Text)
- evaluateOnExit_onStatusReason :: Lens' EvaluateOnExit (Maybe Text)
- evaluateOnExit_action :: Lens' EvaluateOnExit RetryAction
- fairsharePolicy_computeReservation :: Lens' FairsharePolicy (Maybe Int)
- fairsharePolicy_shareDecaySeconds :: Lens' FairsharePolicy (Maybe Int)
- fairsharePolicy_shareDistribution :: Lens' FairsharePolicy (Maybe [ShareAttributes])
- fargatePlatformConfiguration_platformVersion :: Lens' FargatePlatformConfiguration (Maybe Text)
- host_sourcePath :: Lens' Host (Maybe Text)
- jobDefinition_containerOrchestrationType :: Lens' JobDefinition (Maybe OrchestrationType)
- jobDefinition_containerProperties :: Lens' JobDefinition (Maybe ContainerProperties)
- jobDefinition_eksProperties :: Lens' JobDefinition (Maybe EksProperties)
- jobDefinition_nodeProperties :: Lens' JobDefinition (Maybe NodeProperties)
- jobDefinition_parameters :: Lens' JobDefinition (Maybe (HashMap Text Text))
- jobDefinition_platformCapabilities :: Lens' JobDefinition (Maybe [PlatformCapability])
- jobDefinition_propagateTags :: Lens' JobDefinition (Maybe Bool)
- jobDefinition_retryStrategy :: Lens' JobDefinition (Maybe RetryStrategy)
- jobDefinition_schedulingPriority :: Lens' JobDefinition (Maybe Int)
- jobDefinition_status :: Lens' JobDefinition (Maybe Text)
- jobDefinition_tags :: Lens' JobDefinition (Maybe (HashMap Text Text))
- jobDefinition_timeout :: Lens' JobDefinition (Maybe JobTimeout)
- jobDefinition_jobDefinitionName :: Lens' JobDefinition Text
- jobDefinition_jobDefinitionArn :: Lens' JobDefinition Text
- jobDefinition_revision :: Lens' JobDefinition Int
- jobDefinition_type :: Lens' JobDefinition Text
- jobDependency_jobId :: Lens' JobDependency (Maybe Text)
- jobDependency_type :: Lens' JobDependency (Maybe ArrayJobDependency)
- jobDetail_arrayProperties :: Lens' JobDetail (Maybe ArrayPropertiesDetail)
- jobDetail_attempts :: Lens' JobDetail (Maybe [AttemptDetail])
- jobDetail_container :: Lens' JobDetail (Maybe ContainerDetail)
- jobDetail_createdAt :: Lens' JobDetail (Maybe Integer)
- jobDetail_dependsOn :: Lens' JobDetail (Maybe [JobDependency])
- jobDetail_eksAttempts :: Lens' JobDetail (Maybe [EksAttemptDetail])
- jobDetail_eksProperties :: Lens' JobDetail (Maybe EksPropertiesDetail)
- jobDetail_isCancelled :: Lens' JobDetail (Maybe Bool)
- jobDetail_isTerminated :: Lens' JobDetail (Maybe Bool)
- jobDetail_jobArn :: Lens' JobDetail (Maybe Text)
- jobDetail_nodeDetails :: Lens' JobDetail (Maybe NodeDetails)
- jobDetail_nodeProperties :: Lens' JobDetail (Maybe NodeProperties)
- jobDetail_parameters :: Lens' JobDetail (Maybe (HashMap Text Text))
- jobDetail_platformCapabilities :: Lens' JobDetail (Maybe [PlatformCapability])
- jobDetail_propagateTags :: Lens' JobDetail (Maybe Bool)
- jobDetail_retryStrategy :: Lens' JobDetail (Maybe RetryStrategy)
- jobDetail_schedulingPriority :: Lens' JobDetail (Maybe Int)
- jobDetail_shareIdentifier :: Lens' JobDetail (Maybe Text)
- jobDetail_startedAt :: Lens' JobDetail (Maybe Integer)
- jobDetail_statusReason :: Lens' JobDetail (Maybe Text)
- jobDetail_stoppedAt :: Lens' JobDetail (Maybe Integer)
- jobDetail_tags :: Lens' JobDetail (Maybe (HashMap Text Text))
- jobDetail_timeout :: Lens' JobDetail (Maybe JobTimeout)
- jobDetail_jobName :: Lens' JobDetail Text
- jobDetail_jobId :: Lens' JobDetail Text
- jobDetail_jobQueue :: Lens' JobDetail Text
- jobDetail_status :: Lens' JobDetail JobStatus
- jobDetail_jobDefinition :: Lens' JobDetail Text
- jobQueueDetail_schedulingPolicyArn :: Lens' JobQueueDetail (Maybe Text)
- jobQueueDetail_status :: Lens' JobQueueDetail (Maybe JQStatus)
- jobQueueDetail_statusReason :: Lens' JobQueueDetail (Maybe Text)
- jobQueueDetail_tags :: Lens' JobQueueDetail (Maybe (HashMap Text Text))
- jobQueueDetail_jobQueueName :: Lens' JobQueueDetail Text
- jobQueueDetail_jobQueueArn :: Lens' JobQueueDetail Text
- jobQueueDetail_state :: Lens' JobQueueDetail JQState
- jobQueueDetail_priority :: Lens' JobQueueDetail Int
- jobQueueDetail_computeEnvironmentOrder :: Lens' JobQueueDetail [ComputeEnvironmentOrder]
- jobSummary_arrayProperties :: Lens' JobSummary (Maybe ArrayPropertiesSummary)
- jobSummary_container :: Lens' JobSummary (Maybe ContainerSummary)
- jobSummary_createdAt :: Lens' JobSummary (Maybe Integer)
- jobSummary_jobArn :: Lens' JobSummary (Maybe Text)
- jobSummary_jobDefinition :: Lens' JobSummary (Maybe Text)
- jobSummary_nodeProperties :: Lens' JobSummary (Maybe NodePropertiesSummary)
- jobSummary_startedAt :: Lens' JobSummary (Maybe Integer)
- jobSummary_status :: Lens' JobSummary (Maybe JobStatus)
- jobSummary_statusReason :: Lens' JobSummary (Maybe Text)
- jobSummary_stoppedAt :: Lens' JobSummary (Maybe Integer)
- jobSummary_jobId :: Lens' JobSummary Text
- jobSummary_jobName :: Lens' JobSummary Text
- jobTimeout_attemptDurationSeconds :: Lens' JobTimeout (Maybe Int)
- keyValuePair_name :: Lens' KeyValuePair (Maybe Text)
- keyValuePair_value :: Lens' KeyValuePair (Maybe Text)
- keyValuesPair_name :: Lens' KeyValuesPair (Maybe Text)
- keyValuesPair_values :: Lens' KeyValuesPair (Maybe [Text])
- launchTemplateSpecification_launchTemplateId :: Lens' LaunchTemplateSpecification (Maybe Text)
- launchTemplateSpecification_launchTemplateName :: Lens' LaunchTemplateSpecification (Maybe Text)
- launchTemplateSpecification_version :: Lens' LaunchTemplateSpecification (Maybe Text)
- linuxParameters_devices :: Lens' LinuxParameters (Maybe [Device])
- linuxParameters_initProcessEnabled :: Lens' LinuxParameters (Maybe Bool)
- linuxParameters_maxSwap :: Lens' LinuxParameters (Maybe Int)
- linuxParameters_sharedMemorySize :: Lens' LinuxParameters (Maybe Int)
- linuxParameters_swappiness :: Lens' LinuxParameters (Maybe Int)
- linuxParameters_tmpfs :: Lens' LinuxParameters (Maybe [Tmpfs])
- logConfiguration_options :: Lens' LogConfiguration (Maybe (HashMap Text Text))
- logConfiguration_secretOptions :: Lens' LogConfiguration (Maybe [Secret])
- logConfiguration_logDriver :: Lens' LogConfiguration LogDriver
- mountPoint_containerPath :: Lens' MountPoint (Maybe Text)
- mountPoint_readOnly :: Lens' MountPoint (Maybe Bool)
- mountPoint_sourceVolume :: Lens' MountPoint (Maybe Text)
- networkConfiguration_assignPublicIp :: Lens' NetworkConfiguration (Maybe AssignPublicIp)
- networkInterface_attachmentId :: Lens' NetworkInterface (Maybe Text)
- networkInterface_ipv6Address :: Lens' NetworkInterface (Maybe Text)
- networkInterface_privateIpv4Address :: Lens' NetworkInterface (Maybe Text)
- nodeDetails_isMainNode :: Lens' NodeDetails (Maybe Bool)
- nodeDetails_nodeIndex :: Lens' NodeDetails (Maybe Int)
- nodeOverrides_nodePropertyOverrides :: Lens' NodeOverrides (Maybe [NodePropertyOverride])
- nodeOverrides_numNodes :: Lens' NodeOverrides (Maybe Int)
- nodeProperties_numNodes :: Lens' NodeProperties Int
- nodeProperties_mainNode :: Lens' NodeProperties Int
- nodeProperties_nodeRangeProperties :: Lens' NodeProperties [NodeRangeProperty]
- nodePropertiesSummary_isMainNode :: Lens' NodePropertiesSummary (Maybe Bool)
- nodePropertiesSummary_nodeIndex :: Lens' NodePropertiesSummary (Maybe Int)
- nodePropertiesSummary_numNodes :: Lens' NodePropertiesSummary (Maybe Int)
- nodePropertyOverride_containerOverrides :: Lens' NodePropertyOverride (Maybe ContainerOverrides)
- nodePropertyOverride_targetNodes :: Lens' NodePropertyOverride Text
- nodeRangeProperty_container :: Lens' NodeRangeProperty (Maybe ContainerProperties)
- nodeRangeProperty_targetNodes :: Lens' NodeRangeProperty Text
- resourceRequirement_value :: Lens' ResourceRequirement Text
- resourceRequirement_type :: Lens' ResourceRequirement ResourceType
- retryStrategy_attempts :: Lens' RetryStrategy (Maybe Int)
- retryStrategy_evaluateOnExit :: Lens' RetryStrategy (Maybe [EvaluateOnExit])
- schedulingPolicyDetail_fairsharePolicy :: Lens' SchedulingPolicyDetail (Maybe FairsharePolicy)
- schedulingPolicyDetail_tags :: Lens' SchedulingPolicyDetail (Maybe (HashMap Text Text))
- schedulingPolicyDetail_name :: Lens' SchedulingPolicyDetail Text
- schedulingPolicyDetail_arn :: Lens' SchedulingPolicyDetail Text
- schedulingPolicyListingDetail_arn :: Lens' SchedulingPolicyListingDetail Text
- secret_name :: Lens' Secret Text
- secret_valueFrom :: Lens' Secret Text
- shareAttributes_weightFactor :: Lens' ShareAttributes (Maybe Double)
- shareAttributes_shareIdentifier :: Lens' ShareAttributes Text
- tmpfs_mountOptions :: Lens' Tmpfs (Maybe [Text])
- tmpfs_containerPath :: Lens' Tmpfs Text
- tmpfs_size :: Lens' Tmpfs Int
- ulimit_hardLimit :: Lens' Ulimit Int
- ulimit_name :: Lens' Ulimit Text
- ulimit_softLimit :: Lens' Ulimit Int
- updatePolicy_jobExecutionTimeoutMinutes :: Lens' UpdatePolicy (Maybe Natural)
- updatePolicy_terminateJobsOnUpdate :: Lens' UpdatePolicy (Maybe Bool)
- volume_efsVolumeConfiguration :: Lens' Volume (Maybe EFSVolumeConfiguration)
- volume_host :: Lens' Volume (Maybe Host)
- volume_name :: Lens' Volume (Maybe Text)
Operations
CancelJob
cancelJob_reason :: Lens' CancelJob Text Source #
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.
cancelJobResponse_httpStatus :: Lens' CancelJobResponse Int Source #
The response's http status code.
CreateComputeEnvironment
createComputeEnvironment_computeResources :: Lens' CreateComputeEnvironment (Maybe ComputeResource) Source #
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_eksConfiguration :: Lens' CreateComputeEnvironment (Maybe EksConfiguration) Source #
The details for the Amazon EKS cluster that supports the compute environment.
createComputeEnvironment_serviceRole :: Lens' CreateComputeEnvironment (Maybe Text) Source #
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_state :: Lens' CreateComputeEnvironment (Maybe CEState) Source #
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_tags :: Lens' CreateComputeEnvironment (Maybe (HashMap Text Text)) Source #
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_unmanagedvCpus :: Lens' CreateComputeEnvironment (Maybe Int) Source #
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_computeEnvironmentName :: Lens' CreateComputeEnvironment Text Source #
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_type :: Lens' CreateComputeEnvironment CEType Source #
The type of the compute environment: MANAGED
or UNMANAGED
. For more
information, see
Compute Environments
in the Batch User Guide.
createComputeEnvironmentResponse_computeEnvironmentArn :: Lens' CreateComputeEnvironmentResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the compute environment.
createComputeEnvironmentResponse_computeEnvironmentName :: Lens' CreateComputeEnvironmentResponse (Maybe Text) Source #
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 (_).
createComputeEnvironmentResponse_httpStatus :: Lens' CreateComputeEnvironmentResponse Int Source #
The response's http status code.
CreateJobQueue
createJobQueue_schedulingPolicyArn :: Lens' CreateJobQueue (Maybe Text) Source #
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_state :: Lens' CreateJobQueue (Maybe JQState) Source #
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_tags :: Lens' CreateJobQueue (Maybe (HashMap Text Text)) Source #
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_jobQueueName :: Lens' CreateJobQueue Text Source #
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_priority :: Lens' CreateJobQueue Int Source #
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_computeEnvironmentOrder :: Lens' CreateJobQueue [ComputeEnvironmentOrder] Source #
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.
createJobQueueResponse_httpStatus :: Lens' CreateJobQueueResponse Int Source #
The response's http status code.
createJobQueueResponse_jobQueueName :: Lens' CreateJobQueueResponse Text Source #
The name of the job queue.
createJobQueueResponse_jobQueueArn :: Lens' CreateJobQueueResponse Text Source #
The Amazon Resource Name (ARN) of the job queue.
CreateSchedulingPolicy
createSchedulingPolicy_fairsharePolicy :: Lens' CreateSchedulingPolicy (Maybe FairsharePolicy) Source #
The fair share policy of the scheduling policy.
createSchedulingPolicy_tags :: Lens' CreateSchedulingPolicy (Maybe (HashMap Text Text)) Source #
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_name :: Lens' CreateSchedulingPolicy Text Source #
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 (_).
createSchedulingPolicyResponse_httpStatus :: Lens' CreateSchedulingPolicyResponse Int Source #
The response's http status code.
createSchedulingPolicyResponse_name :: Lens' CreateSchedulingPolicyResponse Text Source #
The name of the scheduling policy.
createSchedulingPolicyResponse_arn :: Lens' CreateSchedulingPolicyResponse Text Source #
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
deleteComputeEnvironment_computeEnvironment :: Lens' DeleteComputeEnvironment Text Source #
The name or Amazon Resource Name (ARN) of the compute environment to delete.
deleteComputeEnvironmentResponse_httpStatus :: Lens' DeleteComputeEnvironmentResponse Int Source #
The response's http status code.
DeleteJobQueue
deleteJobQueue_jobQueue :: Lens' DeleteJobQueue Text Source #
The short name or full Amazon Resource Name (ARN) of the queue to delete.
deleteJobQueueResponse_httpStatus :: Lens' DeleteJobQueueResponse Int Source #
The response's http status code.
DeleteSchedulingPolicy
deleteSchedulingPolicy_arn :: Lens' DeleteSchedulingPolicy Text Source #
The Amazon Resource Name (ARN) of the scheduling policy to delete.
deleteSchedulingPolicyResponse_httpStatus :: Lens' DeleteSchedulingPolicyResponse Int Source #
The response's http status code.
DeregisterJobDefinition
deregisterJobDefinition_jobDefinition :: Lens' DeregisterJobDefinition Text Source #
The name and revision (name:revision
) or full Amazon Resource Name
(ARN) of the job definition to deregister.
deregisterJobDefinitionResponse_httpStatus :: Lens' DeregisterJobDefinitionResponse Int Source #
The response's http status code.
DescribeComputeEnvironments
describeComputeEnvironments_computeEnvironments :: Lens' DescribeComputeEnvironments (Maybe [Text]) Source #
A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.
describeComputeEnvironments_maxResults :: Lens' DescribeComputeEnvironments (Maybe Int) Source #
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_nextToken :: Lens' DescribeComputeEnvironments (Maybe Text) Source #
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.
describeComputeEnvironmentsResponse_computeEnvironments :: Lens' DescribeComputeEnvironmentsResponse (Maybe [ComputeEnvironmentDetail]) Source #
The list of compute environments.
describeComputeEnvironmentsResponse_nextToken :: Lens' DescribeComputeEnvironmentsResponse (Maybe Text) Source #
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.
describeComputeEnvironmentsResponse_httpStatus :: Lens' DescribeComputeEnvironmentsResponse Int Source #
The response's http status code.
DescribeJobDefinitions
describeJobDefinitions_jobDefinitionName :: Lens' DescribeJobDefinitions (Maybe Text) Source #
The name of the job definition to describe.
describeJobDefinitions_jobDefinitions :: Lens' DescribeJobDefinitions (Maybe [Text]) Source #
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}
.
describeJobDefinitions_maxResults :: Lens' DescribeJobDefinitions (Maybe Int) Source #
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_nextToken :: Lens' DescribeJobDefinitions (Maybe Text) Source #
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_status :: Lens' DescribeJobDefinitions (Maybe Text) Source #
The status used to filter job definitions.
describeJobDefinitionsResponse_jobDefinitions :: Lens' DescribeJobDefinitionsResponse (Maybe [JobDefinition]) Source #
The list of job definitions.
describeJobDefinitionsResponse_nextToken :: Lens' DescribeJobDefinitionsResponse (Maybe Text) Source #
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.
describeJobDefinitionsResponse_httpStatus :: Lens' DescribeJobDefinitionsResponse Int Source #
The response's http status code.
DescribeJobQueues
describeJobQueues_jobQueues :: Lens' DescribeJobQueues (Maybe [Text]) Source #
A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.
describeJobQueues_maxResults :: Lens' DescribeJobQueues (Maybe Int) Source #
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_nextToken :: Lens' DescribeJobQueues (Maybe Text) Source #
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.
describeJobQueuesResponse_jobQueues :: Lens' DescribeJobQueuesResponse (Maybe [JobQueueDetail]) Source #
The list of job queues.
describeJobQueuesResponse_nextToken :: Lens' DescribeJobQueuesResponse (Maybe Text) Source #
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.
describeJobQueuesResponse_httpStatus :: Lens' DescribeJobQueuesResponse Int Source #
The response's http status code.
DescribeJobs
describeJobs_jobs :: Lens' DescribeJobs [Text] Source #
A list of up to 100 job IDs.
describeJobsResponse_jobs :: Lens' DescribeJobsResponse (Maybe [JobDetail]) Source #
The list of jobs.
describeJobsResponse_httpStatus :: Lens' DescribeJobsResponse Int Source #
The response's http status code.
DescribeSchedulingPolicies
describeSchedulingPolicies_arns :: Lens' DescribeSchedulingPolicies [Text] Source #
A list of up to 100 scheduling policy Amazon Resource Name (ARN) entries.
describeSchedulingPoliciesResponse_schedulingPolicies :: Lens' DescribeSchedulingPoliciesResponse (Maybe [SchedulingPolicyDetail]) Source #
The list of scheduling policies.
describeSchedulingPoliciesResponse_httpStatus :: Lens' DescribeSchedulingPoliciesResponse Int Source #
The response's http status code.
ListJobs
listJobs_arrayJobId :: Lens' ListJobs (Maybe Text) Source #
The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.
listJobs_filters :: Lens' ListJobs (Maybe [KeyValuesPair]) Source #
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 bothTest1
andtest1
, andtest1*
matches bothtest1
andTest10
. When theJOB_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 onlyjd1
, andjd1*
matches bothjd1
andjd1A
. The version of the job definition that's used doesn't affect the sort order. When theJOB_DEFINITION
filter is used and the ARN is used (which is in the formarn:${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_jobQueue :: Lens' ListJobs (Maybe Text) Source #
The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.
listJobs_jobStatus :: Lens' ListJobs (Maybe JobStatus) Source #
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.
listJobs_maxResults :: Lens' ListJobs (Maybe Int) Source #
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.
listJobs_multiNodeJobId :: Lens' ListJobs (Maybe Text) Source #
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_nextToken :: Lens' ListJobs (Maybe Text) Source #
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.
listJobsResponse_nextToken :: Lens' ListJobsResponse (Maybe Text) Source #
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.
listJobsResponse_httpStatus :: Lens' ListJobsResponse Int Source #
The response's http status code.
listJobsResponse_jobSummaryList :: Lens' ListJobsResponse [JobSummary] Source #
A list of job summaries that match the request.
ListSchedulingPolicies
listSchedulingPolicies_maxResults :: Lens' ListSchedulingPolicies (Maybe Int) Source #
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_nextToken :: Lens' ListSchedulingPolicies (Maybe Text) Source #
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.
listSchedulingPoliciesResponse_nextToken :: Lens' ListSchedulingPoliciesResponse (Maybe Text) Source #
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.
listSchedulingPoliciesResponse_schedulingPolicies :: Lens' ListSchedulingPoliciesResponse (Maybe [SchedulingPolicyListingDetail]) Source #
A list of scheduling policies that match the request.
listSchedulingPoliciesResponse_httpStatus :: Lens' ListSchedulingPoliciesResponse Int Source #
The response's http status code.
ListTagsForResource
listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #
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.
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #
The tags for the resource.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #
The response's http status code.
RegisterJobDefinition
registerJobDefinition_containerProperties :: Lens' RegisterJobDefinition (Maybe ContainerProperties) Source #
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_eksProperties :: Lens' RegisterJobDefinition (Maybe EksProperties) Source #
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_nodeProperties :: Lens' RegisterJobDefinition (Maybe NodeProperties) Source #
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_parameters :: Lens' RegisterJobDefinition (Maybe (HashMap Text Text)) Source #
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_platformCapabilities :: Lens' RegisterJobDefinition (Maybe [PlatformCapability]) Source #
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_propagateTags :: Lens' RegisterJobDefinition (Maybe Bool) Source #
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_retryStrategy :: Lens' RegisterJobDefinition (Maybe RetryStrategy) Source #
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_schedulingPriority :: Lens' RegisterJobDefinition (Maybe Int) Source #
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_tags :: Lens' RegisterJobDefinition (Maybe (HashMap Text Text)) Source #
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_timeout :: Lens' RegisterJobDefinition (Maybe JobTimeout) Source #
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_jobDefinitionName :: Lens' RegisterJobDefinition Text Source #
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_type :: Lens' RegisterJobDefinition JobDefinitionType Source #
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.
registerJobDefinitionResponse_httpStatus :: Lens' RegisterJobDefinitionResponse Int Source #
The response's http status code.
registerJobDefinitionResponse_jobDefinitionName :: Lens' RegisterJobDefinitionResponse Text Source #
The name of the job definition.
registerJobDefinitionResponse_jobDefinitionArn :: Lens' RegisterJobDefinitionResponse Text Source #
The Amazon Resource Name (ARN) of the job definition.
registerJobDefinitionResponse_revision :: Lens' RegisterJobDefinitionResponse Int Source #
The revision of the job definition.
SubmitJob
submitJob_arrayProperties :: Lens' SubmitJob (Maybe ArrayProperties) Source #
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_containerOverrides :: Lens' SubmitJob (Maybe ContainerOverrides) Source #
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_dependsOn :: Lens' SubmitJob (Maybe [JobDependency]) Source #
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.
submitJob_eksPropertiesOverride :: Lens' SubmitJob (Maybe EksPropertiesOverride) Source #
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.
submitJob_nodeOverrides :: Lens' SubmitJob (Maybe NodeOverrides) Source #
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_parameters :: Lens' SubmitJob (Maybe (HashMap Text Text)) Source #
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_propagateTags :: Lens' SubmitJob (Maybe Bool) Source #
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_retryStrategy :: Lens' SubmitJob (Maybe RetryStrategy) Source #
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.
submitJob_schedulingPriorityOverride :: Lens' SubmitJob (Maybe Int) Source #
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_shareIdentifier :: Lens' SubmitJob (Maybe Text) Source #
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_tags :: Lens' SubmitJob (Maybe (HashMap Text Text)) Source #
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_timeout :: Lens' SubmitJob (Maybe JobTimeout) Source #
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_jobName :: Lens' SubmitJob Text Source #
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_jobQueue :: Lens' SubmitJob Text Source #
The job queue where the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.
submitJob_jobDefinition :: Lens' SubmitJob Text Source #
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.
submitJobResponse_jobArn :: Lens' SubmitJobResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) for the job.
submitJobResponse_httpStatus :: Lens' SubmitJobResponse Int Source #
The response's http status code.
submitJobResponse_jobName :: Lens' SubmitJobResponse Text Source #
The name of the job.
submitJobResponse_jobId :: Lens' SubmitJobResponse Text Source #
The unique identifier for the job.
TagResource
tagResource_resourceArn :: Lens' TagResource Text Source #
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_tags :: Lens' TagResource (HashMap Text Text) Source #
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.
tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #
The response's http status code.
TerminateJob
terminateJob_jobId :: Lens' TerminateJob Text Source #
The Batch job ID of the job to terminate.
terminateJob_reason :: Lens' TerminateJob Text Source #
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.
terminateJobResponse_httpStatus :: Lens' TerminateJobResponse Int Source #
The response's http status code.
UntagResource
untagResource_resourceArn :: Lens' UntagResource Text Source #
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.
untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #
The keys of the tags to be removed.
untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #
The response's http status code.
UpdateComputeEnvironment
updateComputeEnvironment_computeResources :: Lens' UpdateComputeEnvironment (Maybe ComputeResourceUpdate) Source #
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_serviceRole :: Lens' UpdateComputeEnvironment (Maybe Text) Source #
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_state :: Lens' UpdateComputeEnvironment (Maybe CEState) Source #
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_unmanagedvCpus :: Lens' UpdateComputeEnvironment (Maybe Int) Source #
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_updatePolicy :: Lens' UpdateComputeEnvironment (Maybe UpdatePolicy) Source #
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_computeEnvironment :: Lens' UpdateComputeEnvironment Text Source #
The name or full Amazon Resource Name (ARN) of the compute environment to update.
updateComputeEnvironmentResponse_computeEnvironmentArn :: Lens' UpdateComputeEnvironmentResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the compute environment.
updateComputeEnvironmentResponse_computeEnvironmentName :: Lens' UpdateComputeEnvironmentResponse (Maybe Text) Source #
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 (_).
updateComputeEnvironmentResponse_httpStatus :: Lens' UpdateComputeEnvironmentResponse Int Source #
The response's http status code.
UpdateJobQueue
updateJobQueue_computeEnvironmentOrder :: Lens' UpdateJobQueue (Maybe [ComputeEnvironmentOrder]) Source #
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_priority :: Lens' UpdateJobQueue (Maybe Int) Source #
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_schedulingPolicyArn :: Lens' UpdateJobQueue (Maybe Text) Source #
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_state :: Lens' UpdateJobQueue (Maybe JQState) Source #
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_jobQueue :: Lens' UpdateJobQueue Text Source #
The name or the Amazon Resource Name (ARN) of the job queue.
updateJobQueueResponse_jobQueueArn :: Lens' UpdateJobQueueResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the job queue.
updateJobQueueResponse_jobQueueName :: Lens' UpdateJobQueueResponse (Maybe Text) Source #
The name of the job queue.
updateJobQueueResponse_httpStatus :: Lens' UpdateJobQueueResponse Int Source #
The response's http status code.
UpdateSchedulingPolicy
updateSchedulingPolicy_fairsharePolicy :: Lens' UpdateSchedulingPolicy (Maybe FairsharePolicy) Source #
The fair share policy.
updateSchedulingPolicy_arn :: Lens' UpdateSchedulingPolicy Text Source #
The Amazon Resource Name (ARN) of the scheduling policy to update.
updateSchedulingPolicyResponse_httpStatus :: Lens' UpdateSchedulingPolicyResponse Int Source #
The response's http status code.
Types
ArrayProperties
arrayProperties_size :: Lens' ArrayProperties (Maybe Int) Source #
The size of the array job.
ArrayPropertiesDetail
arrayPropertiesDetail_index :: Lens' ArrayPropertiesDetail (Maybe Int) Source #
The job index within the array that's associated with this job. This parameter is returned for array job children.
arrayPropertiesDetail_size :: Lens' ArrayPropertiesDetail (Maybe Int) Source #
The size of the array job. This parameter is returned for parent array jobs.
arrayPropertiesDetail_statusSummary :: Lens' ArrayPropertiesDetail (Maybe (HashMap Text Int)) Source #
A summary of the number of array job children in each available job status. This parameter is returned for parent array jobs.
ArrayPropertiesSummary
arrayPropertiesSummary_index :: Lens' ArrayPropertiesSummary (Maybe Int) Source #
The job index within the array that's associated with this job. This parameter is returned for children of array jobs.
arrayPropertiesSummary_size :: Lens' ArrayPropertiesSummary (Maybe Int) Source #
The size of the array job. This parameter is returned for parent array jobs.
AttemptContainerDetail
attemptContainerDetail_containerInstanceArn :: Lens' AttemptContainerDetail (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Amazon ECS container instance that hosts the job attempt.
attemptContainerDetail_exitCode :: Lens' AttemptContainerDetail (Maybe Int) Source #
The exit code for the job attempt. A non-zero exit code is considered failed.
attemptContainerDetail_logStreamName :: Lens' AttemptContainerDetail (Maybe Text) Source #
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.
attemptContainerDetail_networkInterfaces :: Lens' AttemptContainerDetail (Maybe [NetworkInterface]) Source #
The network interfaces that are associated with the job attempt.
attemptContainerDetail_reason :: Lens' AttemptContainerDetail (Maybe Text) Source #
A short (255 max characters) human-readable string to provide additional details for a running or stopped container.
attemptContainerDetail_taskArn :: Lens' AttemptContainerDetail (Maybe Text) Source #
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
attemptDetail_container :: Lens' AttemptDetail (Maybe AttemptContainerDetail) Source #
The details for the container in this job attempt.
attemptDetail_startedAt :: Lens' AttemptDetail (Maybe Integer) Source #
The Unix timestamp (in milliseconds) for when the attempt was started
(when the attempt transitioned from the STARTING
state to the
RUNNING
state).
attemptDetail_statusReason :: Lens' AttemptDetail (Maybe Text) Source #
A short, human-readable string to provide additional details for the current status of the job attempt.
attemptDetail_stoppedAt :: Lens' AttemptDetail (Maybe Integer) Source #
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
computeEnvironmentDetail_computeResources :: Lens' ComputeEnvironmentDetail (Maybe ComputeResource) Source #
The compute resources defined for the compute environment. For more information, see Compute environments in the Batch User Guide.
computeEnvironmentDetail_containerOrchestrationType :: Lens' ComputeEnvironmentDetail (Maybe OrchestrationType) Source #
The orchestration type of the compute environment. The valid values are
ECS
(default) or EKS
.
computeEnvironmentDetail_ecsClusterArn :: Lens' ComputeEnvironmentDetail (Maybe Text) Source #
The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster that the compute environment uses.
computeEnvironmentDetail_eksConfiguration :: Lens' ComputeEnvironmentDetail (Maybe EksConfiguration) Source #
The configuration for the Amazon EKS cluster that supports the Batch
compute environment. Only specify this parameter if the
containerOrchestrationType
is EKS
.
computeEnvironmentDetail_serviceRole :: Lens' ComputeEnvironmentDetail (Maybe Text) Source #
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.
computeEnvironmentDetail_state :: Lens' ComputeEnvironmentDetail (Maybe CEState) Source #
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.
computeEnvironmentDetail_status :: Lens' ComputeEnvironmentDetail (Maybe CEStatus) Source #
The current status of the compute environment (for example, CREATING
or VALID
).
computeEnvironmentDetail_statusReason :: Lens' ComputeEnvironmentDetail (Maybe Text) Source #
A short, human-readable string to provide additional details for the current status of the compute environment.
computeEnvironmentDetail_tags :: Lens' ComputeEnvironmentDetail (Maybe (HashMap Text Text)) Source #
The tags applied to the compute environment.
computeEnvironmentDetail_type :: Lens' ComputeEnvironmentDetail (Maybe CEType) Source #
The type of the compute environment: MANAGED
or UNMANAGED
. For more
information, see
Compute environments
in the Batch User Guide.
computeEnvironmentDetail_unmanagedvCpus :: Lens' ComputeEnvironmentDetail (Maybe Int) Source #
The maximum number of VCPUs expected to be used for an unmanaged compute environment.
computeEnvironmentDetail_updatePolicy :: Lens' ComputeEnvironmentDetail (Maybe 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.
computeEnvironmentDetail_uuid :: Lens' ComputeEnvironmentDetail (Maybe Text) Source #
Unique identifier for the compute environment.
computeEnvironmentDetail_computeEnvironmentName :: Lens' ComputeEnvironmentDetail Text Source #
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 (_).
computeEnvironmentDetail_computeEnvironmentArn :: Lens' ComputeEnvironmentDetail Text Source #
The Amazon Resource Name (ARN) of the compute environment.
ComputeEnvironmentOrder
computeEnvironmentOrder_order :: Lens' ComputeEnvironmentOrder Int Source #
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.
computeEnvironmentOrder_computeEnvironment :: Lens' ComputeEnvironmentOrder Text Source #
The Amazon Resource Name (ARN) of the compute environment.
ComputeResource
computeResource_allocationStrategy :: Lens' ComputeResource (Maybe CRAllocationStrategy) Source #
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 aBEST_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.
computeResource_bidPercentage :: Lens' ComputeResource (Maybe Int) Source #
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.
computeResource_desiredvCpus :: Lens' ComputeResource (Maybe Int) Source #
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.
computeResource_ec2Configuration :: Lens' ComputeResource (Maybe [Ec2Configuration]) Source #
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.
computeResource_ec2KeyPair :: Lens' ComputeResource (Maybe Text) Source #
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.
computeResource_imageId :: Lens' ComputeResource (Maybe Text) Source #
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.
computeResource_instanceRole :: Lens' ComputeResource (Maybe Text) Source #
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.
computeResource_instanceTypes :: Lens' ComputeResource (Maybe [Text]) Source #
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.
computeResource_launchTemplate :: Lens' ComputeResource (Maybe LaunchTemplateSpecification) Source #
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.
computeResource_minvCpus :: Lens' ComputeResource (Maybe Int) Source #
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.
computeResource_placementGroup :: Lens' ComputeResource (Maybe Text) Source #
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.
computeResource_securityGroupIds :: Lens' ComputeResource (Maybe [Text]) Source #
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.
computeResource_spotIamFleetRole :: Lens' ComputeResource (Maybe Text) Source #
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.
computeResource_tags :: Lens' ComputeResource (Maybe (HashMap Text Text)) Source #
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.
computeResource_type :: Lens' ComputeResource CRType Source #
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.
computeResource_maxvCpus :: Lens' ComputeResource Int Source #
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.
computeResource_subnets :: Lens' ComputeResource [Text] Source #
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
computeResourceUpdate_allocationStrategy :: Lens' ComputeResourceUpdate (Maybe CRUpdateAllocationStrategy) Source #
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.
computeResourceUpdate_bidPercentage :: Lens' ComputeResourceUpdate (Maybe Int) Source #
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.
computeResourceUpdate_desiredvCpus :: Lens' ComputeResourceUpdate (Maybe Int) Source #
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.
computeResourceUpdate_ec2Configuration :: Lens' ComputeResourceUpdate (Maybe [Ec2Configuration]) Source #
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.
computeResourceUpdate_ec2KeyPair :: Lens' ComputeResourceUpdate (Maybe Text) Source #
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.
computeResourceUpdate_imageId :: Lens' ComputeResourceUpdate (Maybe Text) Source #
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.
computeResourceUpdate_instanceRole :: Lens' ComputeResourceUpdate (Maybe Text) Source #
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.
computeResourceUpdate_instanceTypes :: Lens' ComputeResourceUpdate (Maybe [Text]) Source #
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.
computeResourceUpdate_launchTemplate :: Lens' ComputeResourceUpdate (Maybe LaunchTemplateSpecification) Source #
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.
computeResourceUpdate_maxvCpus :: Lens' ComputeResourceUpdate (Maybe Int) Source #
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.
computeResourceUpdate_minvCpus :: Lens' ComputeResourceUpdate (Maybe Int) Source #
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.
computeResourceUpdate_placementGroup :: Lens' ComputeResourceUpdate (Maybe Text) Source #
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.
computeResourceUpdate_securityGroupIds :: Lens' ComputeResourceUpdate (Maybe [Text]) Source #
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.
computeResourceUpdate_subnets :: Lens' ComputeResourceUpdate (Maybe [Text]) Source #
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.
computeResourceUpdate_tags :: Lens' ComputeResourceUpdate (Maybe (HashMap Text Text)) Source #
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.
computeResourceUpdate_type :: Lens' ComputeResourceUpdate (Maybe CRType) Source #
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.
computeResourceUpdate_updateToLatestImageVersion :: Lens' ComputeResourceUpdate (Maybe Bool) Source #
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
containerDetail_command :: Lens' ContainerDetail (Maybe [Text]) Source #
The command that's passed to the container.
containerDetail_containerInstanceArn :: Lens' ContainerDetail (Maybe Text) Source #
The Amazon Resource Name (ARN) of the container instance that the container is running on.
containerDetail_environment :: Lens' ContainerDetail (Maybe [KeyValuePair]) Source #
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.
containerDetail_executionRoleArn :: Lens' ContainerDetail (Maybe Text) Source #
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.
containerDetail_exitCode :: Lens' ContainerDetail (Maybe Int) Source #
The exit code to return upon completion.
containerDetail_fargatePlatformConfiguration :: Lens' ContainerDetail (Maybe FargatePlatformConfiguration) Source #
The platform configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.
containerDetail_image :: Lens' ContainerDetail (Maybe Text) Source #
The image used to start the container.
containerDetail_instanceType :: Lens' ContainerDetail (Maybe Text) Source #
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.
containerDetail_jobRoleArn :: Lens' ContainerDetail (Maybe Text) Source #
The Amazon Resource Name (ARN) that's associated with the job when run.
containerDetail_linuxParameters :: Lens' ContainerDetail (Maybe LinuxParameters) Source #
Linux-specific modifications that are applied to the container, such as details for device mappings.
containerDetail_logConfiguration :: Lens' ContainerDetail (Maybe LogConfiguration) Source #
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.
containerDetail_logStreamName :: Lens' ContainerDetail (Maybe Text) Source #
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.
containerDetail_memory :: Lens' ContainerDetail (Maybe Int) Source #
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
.
containerDetail_mountPoints :: Lens' ContainerDetail (Maybe [MountPoint]) Source #
The mount points for data volumes in your container.
containerDetail_networkConfiguration :: Lens' ContainerDetail (Maybe 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.
containerDetail_networkInterfaces :: Lens' ContainerDetail (Maybe [NetworkInterface]) Source #
The network interfaces that are associated with the job.
containerDetail_privileged :: Lens' ContainerDetail (Maybe Bool) Source #
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
.
containerDetail_readonlyRootFilesystem :: Lens' ContainerDetail (Maybe Bool) Source #
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 .
containerDetail_reason :: Lens' ContainerDetail (Maybe Text) Source #
A short (255 max characters) human-readable string to provide additional details for a running or stopped container.
containerDetail_resourceRequirements :: Lens' ContainerDetail (Maybe [ResourceRequirement]) Source #
The type and amount of resources to assign to a container. The supported
resources include GPU
, MEMORY
, and VCPU
.
containerDetail_secrets :: Lens' ContainerDetail (Maybe [Secret]) Source #
The secrets to pass to the container. For more information, see Specifying sensitive data in the Batch User Guide.
containerDetail_taskArn :: Lens' ContainerDetail (Maybe Text) Source #
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.
containerDetail_ulimits :: Lens' ContainerDetail (Maybe [Ulimit]) Source #
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.
containerDetail_user :: Lens' ContainerDetail (Maybe Text) Source #
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.
containerDetail_vcpus :: Lens' ContainerDetail (Maybe Int) Source #
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
.
containerDetail_volumes :: Lens' ContainerDetail (Maybe [Volume]) Source #
A list of volumes that are associated with the job.
ContainerOverrides
containerOverrides_command :: Lens' ContainerOverrides (Maybe [Text]) Source #
The command to send to the container that overrides the default command from the Docker image or the job definition.
containerOverrides_environment :: Lens' ContainerOverrides (Maybe [KeyValuePair]) Source #
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.
containerOverrides_instanceType :: Lens' ContainerOverrides (Maybe Text) Source #
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.
containerOverrides_memory :: Lens' ContainerOverrides (Maybe Int) Source #
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.
containerOverrides_resourceRequirements :: Lens' ContainerOverrides (Maybe [ResourceRequirement]) Source #
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
.
containerOverrides_vcpus :: Lens' ContainerOverrides (Maybe Int) Source #
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
containerProperties_command :: Lens' ContainerProperties (Maybe [Text]) Source #
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.
containerProperties_environment :: Lens' ContainerProperties (Maybe [KeyValuePair]) Source #
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.
containerProperties_executionRoleArn :: Lens' ContainerProperties (Maybe Text) Source #
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.
containerProperties_fargatePlatformConfiguration :: Lens' ContainerProperties (Maybe FargatePlatformConfiguration) Source #
The platform configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.
containerProperties_image :: Lens' ContainerProperties (Maybe Text) Source #
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]
orregistry/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
ormongo
). - 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
).
containerProperties_instanceType :: Lens' ContainerProperties (Maybe Text) Source #
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.
containerProperties_jobRoleArn :: Lens' ContainerProperties (Maybe Text) Source #
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.
containerProperties_linuxParameters :: Lens' ContainerProperties (Maybe LinuxParameters) Source #
Linux-specific modifications that are applied to the container, such as details for device mappings.
containerProperties_logConfiguration :: Lens' ContainerProperties (Maybe LogConfiguration) Source #
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.
containerProperties_memory :: Lens' ContainerProperties (Maybe Int) Source #
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.
containerProperties_mountPoints :: Lens' ContainerProperties (Maybe [MountPoint]) Source #
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.
containerProperties_networkConfiguration :: Lens' ContainerProperties (Maybe 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.
containerProperties_privileged :: Lens' ContainerProperties (Maybe Bool) Source #
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.
containerProperties_readonlyRootFilesystem :: Lens' ContainerProperties (Maybe Bool) Source #
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
.
containerProperties_resourceRequirements :: Lens' ContainerProperties (Maybe [ResourceRequirement]) Source #
The type and amount of resources to assign to a container. The supported
resources include GPU
, MEMORY
, and VCPU
.
containerProperties_secrets :: Lens' ContainerProperties (Maybe [Secret]) Source #
The secrets for the container. For more information, see Specifying sensitive data in the Batch User Guide.
containerProperties_ulimits :: Lens' ContainerProperties (Maybe [Ulimit]) Source #
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.
containerProperties_user :: Lens' ContainerProperties (Maybe Text) Source #
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.
containerProperties_vcpus :: Lens' ContainerProperties (Maybe Int) Source #
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.
containerProperties_volumes :: Lens' ContainerProperties (Maybe [Volume]) Source #
A list of data volumes used in a job.
ContainerSummary
containerSummary_exitCode :: Lens' ContainerSummary (Maybe Int) Source #
The exit code to return upon completion.
containerSummary_reason :: Lens' ContainerSummary (Maybe Text) Source #
A short (255 max characters) human-readable string to provide additional details for a running or stopped container.
Device
device_containerPath :: Lens' Device (Maybe Text) Source #
The path inside the container that's used to expose the host device. By
default, the hostPath
value is used.
device_permissions :: Lens' Device (Maybe [DeviceCgroupPermission]) Source #
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.
device_hostPath :: Lens' Device Text Source #
The path for the device on the host container instance.
EFSAuthorizationConfig
eFSAuthorizationConfig_accessPointId :: Lens' EFSAuthorizationConfig (Maybe Text) Source #
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.
eFSAuthorizationConfig_iam :: Lens' EFSAuthorizationConfig (Maybe EFSAuthorizationConfigIAM) Source #
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
eFSVolumeConfiguration_authorizationConfig :: Lens' EFSVolumeConfiguration (Maybe EFSAuthorizationConfig) Source #
The authorization configuration details for the Amazon EFS file system.
eFSVolumeConfiguration_rootDirectory :: Lens' EFSVolumeConfiguration (Maybe Text) Source #
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.
eFSVolumeConfiguration_transitEncryption :: Lens' EFSVolumeConfiguration (Maybe EFSTransitEncryption) Source #
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.
eFSVolumeConfiguration_transitEncryptionPort :: Lens' EFSVolumeConfiguration (Maybe Int) Source #
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.
eFSVolumeConfiguration_fileSystemId :: Lens' EFSVolumeConfiguration Text Source #
The Amazon EFS file system ID to use.
Ec2Configuration
ec2Configuration_imageIdOverride :: Lens' Ec2Configuration (Maybe Text) Source #
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.
ec2Configuration_imageKubernetesVersion :: Lens' Ec2Configuration (Maybe Text) Source #
The Kubernetes version for the compute environment. If you don't specify a value, the latest version that Batch supports is used.
ec2Configuration_imageType :: Lens' Ec2Configuration Text Source #
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 animageId
nor aimageIdOverride
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
andG4
) 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 animageId
nor aimageIdOverride
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
andG4
) and can be used for all non Amazon Web Services Graviton-based instance types.
EksAttemptContainerDetail
eksAttemptContainerDetail_exitCode :: Lens' EksAttemptContainerDetail (Maybe Int) Source #
The exit code for the job attempt. A non-zero exit code is considered failed.
eksAttemptContainerDetail_reason :: Lens' EksAttemptContainerDetail (Maybe Text) Source #
A short (255 max characters) human-readable string to provide additional details for a running or stopped container.
EksAttemptDetail
eksAttemptDetail_containers :: Lens' EksAttemptDetail (Maybe [EksAttemptContainerDetail]) Source #
The details for the final status of the containers for this job attempt.
eksAttemptDetail_nodeName :: Lens' EksAttemptDetail (Maybe Text) Source #
The name of the node for this job attempt.
eksAttemptDetail_podName :: Lens' EksAttemptDetail (Maybe Text) Source #
The name of the pod for this job attempt.
eksAttemptDetail_startedAt :: Lens' EksAttemptDetail (Maybe Integer) Source #
The Unix timestamp (in milliseconds) for when the attempt was started
(when the attempt transitioned from the STARTING
state to the
RUNNING
state).
eksAttemptDetail_statusReason :: Lens' EksAttemptDetail (Maybe Text) Source #
A short, human-readable string to provide additional details for the current status of the job attempt.
eksAttemptDetail_stoppedAt :: Lens' EksAttemptDetail (Maybe Integer) Source #
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
eksConfiguration_eksClusterArn :: Lens' EksConfiguration Text Source #
The Amazon Resource Name (ARN) of the Amazon EKS cluster. An example is
arn:
aws
:eks:
us-east-1
:
123456789012
:cluster/
ClusterForBatch
.
eksConfiguration_kubernetesNamespace :: Lens' EksConfiguration Text Source #
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
eksContainer_args :: Lens' EksContainer (Maybe [Text]) Source #
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.
eksContainer_command :: Lens' EksContainer (Maybe [Text]) Source #
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.
eksContainer_env :: Lens' EksContainer (Maybe [EksContainerEnvironmentVariable]) Source #
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.
eksContainer_imagePullPolicy :: Lens' EksContainer (Maybe Text) Source #
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_name :: Lens' EksContainer (Maybe Text) Source #
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.
eksContainer_resources :: Lens' EksContainer (Maybe 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.
eksContainer_securityContext :: Lens' EksContainer (Maybe 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.
eksContainer_volumeMounts :: Lens' EksContainer (Maybe [EksContainerVolumeMount]) Source #
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.
eksContainer_image :: Lens' EksContainer Text Source #
The Docker image used to start the container.
EksContainerDetail
eksContainerDetail_args :: Lens' EksContainerDetail (Maybe [Text]) Source #
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.
eksContainerDetail_command :: Lens' EksContainerDetail (Maybe [Text]) Source #
The entrypoint for the container. For more information, see Entrypoint in the Kubernetes documentation.
eksContainerDetail_env :: Lens' EksContainerDetail (Maybe [EksContainerEnvironmentVariable]) Source #
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.
eksContainerDetail_exitCode :: Lens' EksContainerDetail (Maybe Int) Source #
The exit code for the job attempt. A non-zero exit code is considered failed.
eksContainerDetail_image :: Lens' EksContainerDetail (Maybe Text) Source #
The Docker image used to start the container.
eksContainerDetail_imagePullPolicy :: Lens' EksContainerDetail (Maybe Text) Source #
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_name :: Lens' EksContainerDetail (Maybe Text) Source #
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.
eksContainerDetail_reason :: Lens' EksContainerDetail (Maybe Text) Source #
A short human-readable string to provide additional details for a running or stopped container. It can be up to 255 characters long.
eksContainerDetail_resources :: Lens' EksContainerDetail (Maybe 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.
eksContainerDetail_securityContext :: Lens' EksContainerDetail (Maybe 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.
eksContainerDetail_volumeMounts :: Lens' EksContainerDetail (Maybe [EksContainerVolumeMount]) Source #
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
eksContainerEnvironmentVariable_value :: Lens' EksContainerEnvironmentVariable (Maybe Text) Source #
The value of the environment variable.
eksContainerEnvironmentVariable_name :: Lens' EksContainerEnvironmentVariable Text Source #
The name of the environment variable.
EksContainerOverride
eksContainerOverride_args :: Lens' EksContainerOverride (Maybe [Text]) Source #
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.
eksContainerOverride_command :: Lens' EksContainerOverride (Maybe [Text]) Source #
The command to send to the container that overrides the default command from the Docker image or the job definition.
eksContainerOverride_env :: Lens' EksContainerOverride (Maybe [EksContainerEnvironmentVariable]) Source #
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.
eksContainerOverride_image :: Lens' EksContainerOverride (Maybe Text) Source #
The override of the Docker image that's used to start the container.
eksContainerOverride_resources :: Lens' EksContainerOverride (Maybe EksContainerResourceRequirements) Source #
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
eksContainerResourceRequirements_limits :: Lens' EksContainerResourceRequirements (Maybe (HashMap Text Text)) Source #
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 inlimits
,requests
, or both. Ifmemory
is specified in both places, then the value that's specified inlimits
must be equal to the value that's specified inrequests
.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 inlimits
,requests
, or both. Ifcpu
is specified in both places, then the value that's specified inlimits
must be at least as large as the value that's specified inrequests
. - nvidia.com/gpu
- The number of GPUs that's reserved for the container. Values must
be a whole integer.
memory
can be specified inlimits
,requests
, or both. Ifmemory
is specified in both places, then the value that's specified inlimits
must be equal to the value that's specified inrequests
.
eksContainerResourceRequirements_requests :: Lens' EksContainerResourceRequirements (Maybe (HashMap Text Text)) Source #
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 inlimits
,requests
, or both. Ifmemory
is specified in both, then the value that's specified inlimits
must be equal to the value that's specified inrequests
.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 inlimits
,requests
, or both. Ifcpu
is specified in both, then the value that's specified inlimits
must be at least as large as the value that's specified inrequests
. - 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 inlimits
,requests
, or both. Ifnvidia.com/gpu
is specified in both, then the value that's specified inlimits
must be equal to the value that's specified inrequests
.
EksContainerSecurityContext
eksContainerSecurityContext_privileged :: Lens' EksContainerSecurityContext (Maybe Bool) Source #
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.
eksContainerSecurityContext_readOnlyRootFilesystem :: Lens' EksContainerSecurityContext (Maybe Bool) Source #
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.
eksContainerSecurityContext_runAsGroup :: Lens' EksContainerSecurityContext (Maybe Integer) Source #
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.
eksContainerSecurityContext_runAsNonRoot :: Lens' EksContainerSecurityContext (Maybe Bool) Source #
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.
eksContainerSecurityContext_runAsUser :: Lens' EksContainerSecurityContext (Maybe Integer) Source #
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
eksContainerVolumeMount_mountPath :: Lens' EksContainerVolumeMount (Maybe Text) Source #
The path on the container where the volume is mounted.
eksContainerVolumeMount_name :: Lens' EksContainerVolumeMount (Maybe Text) Source #
The name the volume mount. This must match the name of one of the volumes in the pod.
eksContainerVolumeMount_readOnly :: Lens' EksContainerVolumeMount (Maybe Bool) Source #
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
eksEmptyDir_medium :: Lens' EksEmptyDir (Maybe Text) Source #
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.
eksEmptyDir_sizeLimit :: Lens' EksEmptyDir (Maybe Text) Source #
The maximum size of the volume. By default, there's no maximum size defined.
EksHostPath
eksHostPath_path :: Lens' EksHostPath (Maybe Text) Source #
The path of the file or directory on the host to mount into containers on the pod.
EksPodProperties
eksPodProperties_containers :: Lens' EksPodProperties (Maybe [EksContainer]) Source #
The properties of the container that's used on the Amazon EKS pod.
eksPodProperties_dnsPolicy :: Lens' EksPodProperties (Maybe Text) Source #
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
eksPodProperties_hostNetwork :: Lens' EksPodProperties (Maybe Bool) Source #
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.
eksPodProperties_serviceAccountName :: Lens' EksPodProperties (Maybe Text) Source #
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.
eksPodProperties_volumes :: Lens' EksPodProperties (Maybe [EksVolume]) Source #
Specifies the volumes for a job definition that uses Amazon EKS resources.
EksPodPropertiesDetail
eksPodPropertiesDetail_containers :: Lens' EksPodPropertiesDetail (Maybe [EksContainerDetail]) Source #
The properties of the container that's used on the Amazon EKS pod.
eksPodPropertiesDetail_dnsPolicy :: Lens' EksPodPropertiesDetail (Maybe Text) Source #
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
eksPodPropertiesDetail_hostNetwork :: Lens' EksPodPropertiesDetail (Maybe Bool) Source #
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.
eksPodPropertiesDetail_nodeName :: Lens' EksPodPropertiesDetail (Maybe Text) Source #
The name of the node for this job.
eksPodPropertiesDetail_podName :: Lens' EksPodPropertiesDetail (Maybe Text) Source #
The name of the pod for this job.
eksPodPropertiesDetail_serviceAccountName :: Lens' EksPodPropertiesDetail (Maybe Text) Source #
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.
eksPodPropertiesDetail_volumes :: Lens' EksPodPropertiesDetail (Maybe [EksVolume]) Source #
Specifies the volumes for a job definition using Amazon EKS resources.
EksPodPropertiesOverride
eksPodPropertiesOverride_containers :: Lens' EksPodPropertiesOverride (Maybe [EksContainerOverride]) Source #
The overrides for the container that's used on the Amazon EKS pod.
EksProperties
eksProperties_podProperties :: Lens' EksProperties (Maybe EksPodProperties) Source #
The properties for the Kubernetes pod resources of a job.
EksPropertiesDetail
eksPropertiesDetail_podProperties :: Lens' EksPropertiesDetail (Maybe EksPodPropertiesDetail) Source #
The properties for the Kubernetes pod resources of a job.
EksPropertiesOverride
eksPropertiesOverride_podProperties :: Lens' EksPropertiesOverride (Maybe EksPodPropertiesOverride) Source #
The overrides for the Kubernetes pod resources of a job.
EksSecret
eksSecret_optional :: Lens' EksSecret (Maybe Bool) Source #
Specifies whether the secret or the secret's keys must be defined.
eksSecret_secretName :: Lens' EksSecret Text Source #
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
eksVolume_emptyDir :: Lens' EksVolume (Maybe EksEmptyDir) Source #
Specifies the configuration of a Kubernetes emptyDir
volume. For more
information, see
emptyDir
in the Kubernetes documentation.
eksVolume_hostPath :: Lens' EksVolume (Maybe EksHostPath) Source #
Specifies the configuration of a Kubernetes hostPath
volume. For more
information, see
hostPath
in the Kubernetes documentation.
eksVolume_secret :: Lens' EksVolume (Maybe EksSecret) Source #
Specifies the configuration of a Kubernetes secret
volume. For more
information, see
secret in
the Kubernetes documentation.
eksVolume_name :: Lens' EksVolume Text Source #
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
evaluateOnExit_onExitCode :: Lens' EvaluateOnExit (Maybe Text) Source #
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.
evaluateOnExit_onReason :: Lens' EvaluateOnExit (Maybe Text) Source #
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.
evaluateOnExit_onStatusReason :: Lens' EvaluateOnExit (Maybe Text) Source #
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.
evaluateOnExit_action :: Lens' EvaluateOnExit RetryAction Source #
Specifies the action to take if all of the specified conditions
(onStatusReason
, onReason
, and onExitCode
) are met. The values
aren't case sensitive.
FairsharePolicy
fairsharePolicy_computeReservation :: Lens' FairsharePolicy (Maybe Int) Source #
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.
fairsharePolicy_shareDecaySeconds :: Lens' FairsharePolicy (Maybe Int) Source #
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).
fairsharePolicy_shareDistribution :: Lens' FairsharePolicy (Maybe [ShareAttributes]) Source #
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
fargatePlatformConfiguration_platformVersion :: Lens' FargatePlatformConfiguration (Maybe Text) Source #
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
host_sourcePath :: Lens' Host (Maybe Text) Source #
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
jobDefinition_containerOrchestrationType :: Lens' JobDefinition (Maybe OrchestrationType) Source #
The orchestration type of the compute environment. The valid values are
ECS
(default) or EKS
.
jobDefinition_containerProperties :: Lens' JobDefinition (Maybe ContainerProperties) Source #
An object with various properties specific to Amazon ECS based jobs.
Valid values are containerProperties
, eksProperties
, and
nodeProperties
. Only one can be specified.
jobDefinition_eksProperties :: Lens' JobDefinition (Maybe EksProperties) Source #
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.
jobDefinition_nodeProperties :: Lens' JobDefinition (Maybe NodeProperties) Source #
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.
jobDefinition_parameters :: Lens' JobDefinition (Maybe (HashMap Text Text)) Source #
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.
jobDefinition_platformCapabilities :: Lens' JobDefinition (Maybe [PlatformCapability]) Source #
The platform capabilities required by the job definition. If no value is
specified, it defaults to EC2
. Jobs run on Fargate resources specify
FARGATE
.
jobDefinition_propagateTags :: Lens' JobDefinition (Maybe Bool) Source #
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.
jobDefinition_retryStrategy :: Lens' JobDefinition (Maybe RetryStrategy) Source #
The retry strategy to use for failed jobs that are submitted with this job definition.
jobDefinition_schedulingPriority :: Lens' JobDefinition (Maybe Int) Source #
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.
jobDefinition_status :: Lens' JobDefinition (Maybe Text) Source #
The status of the job definition.
jobDefinition_tags :: Lens' JobDefinition (Maybe (HashMap Text Text)) Source #
The tags that are applied to the job definition.
jobDefinition_timeout :: Lens' JobDefinition (Maybe JobTimeout) Source #
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.
jobDefinition_jobDefinitionName :: Lens' JobDefinition Text Source #
The name of the job definition.
jobDefinition_jobDefinitionArn :: Lens' JobDefinition Text Source #
The Amazon Resource Name (ARN) for the job definition.
jobDefinition_revision :: Lens' JobDefinition Int Source #
The revision of the job definition.
jobDefinition_type :: Lens' JobDefinition Text Source #
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
jobDependency_jobId :: Lens' JobDependency (Maybe Text) Source #
The job ID of the Batch job that's associated with this dependency.
jobDependency_type :: Lens' JobDependency (Maybe ArrayJobDependency) Source #
The type of the job dependency.
JobDetail
jobDetail_arrayProperties :: Lens' JobDetail (Maybe ArrayPropertiesDetail) Source #
The array properties of the job, if it's an array job.
jobDetail_attempts :: Lens' JobDetail (Maybe [AttemptDetail]) Source #
A list of job attempts that are associated with this job.
jobDetail_container :: Lens' JobDetail (Maybe ContainerDetail) Source #
An object that represents the details for the container that's associated with the job.
jobDetail_createdAt :: Lens' JobDetail (Maybe Integer) Source #
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.
jobDetail_dependsOn :: Lens' JobDetail (Maybe [JobDependency]) Source #
A list of job IDs that this job depends on.
jobDetail_eksAttempts :: Lens' JobDetail (Maybe [EksAttemptDetail]) Source #
A list of job attempts that are associated with this job.
jobDetail_eksProperties :: Lens' JobDetail (Maybe EksPropertiesDetail) Source #
An object with various properties that are specific to Amazon EKS based
jobs. Only one of container
, eksProperties
, or nodeDetails
is
specified.
jobDetail_isCancelled :: Lens' JobDetail (Maybe Bool) Source #
Indicates whether the job is canceled.
jobDetail_isTerminated :: Lens' JobDetail (Maybe Bool) Source #
Indicates whether the job is terminated.
jobDetail_nodeDetails :: Lens' JobDetail (Maybe NodeDetails) Source #
An object that represents the details of a node that's associated with a multi-node parallel job.
jobDetail_nodeProperties :: Lens' JobDetail (Maybe NodeProperties) Source #
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.
jobDetail_parameters :: Lens' JobDetail (Maybe (HashMap Text Text)) Source #
Additional parameters that are passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.
jobDetail_platformCapabilities :: Lens' JobDetail (Maybe [PlatformCapability]) Source #
The platform capabilities required by the job definition. If no value is
specified, it defaults to EC2
. Jobs run on Fargate resources specify
FARGATE
.
jobDetail_propagateTags :: Lens' JobDetail (Maybe Bool) Source #
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.
jobDetail_retryStrategy :: Lens' JobDetail (Maybe RetryStrategy) Source #
The retry strategy to use for this job if an attempt fails.
jobDetail_schedulingPriority :: Lens' JobDetail (Maybe Int) Source #
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.
jobDetail_startedAt :: Lens' JobDetail (Maybe Integer) Source #
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_statusReason :: Lens' JobDetail (Maybe Text) Source #
A short, human-readable string to provide more details for the current status of the job.
jobDetail_stoppedAt :: Lens' JobDetail (Maybe Integer) Source #
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
.
jobDetail_tags :: Lens' JobDetail (Maybe (HashMap Text Text)) Source #
The tags that are applied to the job.
jobDetail_timeout :: Lens' JobDetail (Maybe JobTimeout) Source #
The timeout configuration for the job.
jobDetail_jobQueue :: Lens' JobDetail Text Source #
The Amazon Resource Name (ARN) of the job queue that the job is associated with.
jobDetail_status :: Lens' JobDetail JobStatus Source #
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.
jobDetail_jobDefinition :: Lens' JobDetail Text Source #
The Amazon Resource Name (ARN) of the job definition that this job uses.
JobQueueDetail
jobQueueDetail_schedulingPolicyArn :: Lens' JobQueueDetail (Maybe Text) Source #
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
.
jobQueueDetail_status :: Lens' JobQueueDetail (Maybe JQStatus) Source #
The status of the job queue (for example, CREATING
or VALID
).
jobQueueDetail_statusReason :: Lens' JobQueueDetail (Maybe Text) Source #
A short, human-readable string to provide additional details for the current status of the job queue.
jobQueueDetail_tags :: Lens' JobQueueDetail (Maybe (HashMap Text Text)) Source #
The tags that are applied to the job queue. For more information, see Tagging your Batch resources in Batch User Guide.
jobQueueDetail_jobQueueName :: Lens' JobQueueDetail Text Source #
The job queue name.
jobQueueDetail_jobQueueArn :: Lens' JobQueueDetail Text Source #
The Amazon Resource Name (ARN) of the job queue.
jobQueueDetail_state :: Lens' JobQueueDetail JQState Source #
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.
jobQueueDetail_priority :: Lens' JobQueueDetail Int Source #
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.
jobQueueDetail_computeEnvironmentOrder :: Lens' JobQueueDetail [ComputeEnvironmentOrder] Source #
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
jobSummary_arrayProperties :: Lens' JobSummary (Maybe ArrayPropertiesSummary) Source #
The array properties of the job, if it's an array job.
jobSummary_container :: Lens' JobSummary (Maybe ContainerSummary) Source #
An object that represents the details of the container that's associated with the job.
jobSummary_createdAt :: Lens' JobSummary (Maybe Integer) Source #
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.
jobSummary_jobArn :: Lens' JobSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the job.
jobSummary_jobDefinition :: Lens' JobSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the job definition.
jobSummary_nodeProperties :: Lens' JobSummary (Maybe NodePropertiesSummary) Source #
The node properties for a single node in a job summary list.
This isn't applicable to jobs that are running on Fargate resources.
jobSummary_startedAt :: Lens' JobSummary (Maybe Integer) Source #
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.
jobSummary_status :: Lens' JobSummary (Maybe JobStatus) Source #
The current status for the job.
jobSummary_statusReason :: Lens' JobSummary (Maybe Text) Source #
A short, human-readable string to provide more details for the current status of the job.
jobSummary_stoppedAt :: Lens' JobSummary (Maybe Integer) Source #
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
.
jobSummary_jobId :: Lens' JobSummary Text Source #
The job ID.
jobSummary_jobName :: Lens' JobSummary Text Source #
The job name.
JobTimeout
jobTimeout_attemptDurationSeconds :: Lens' JobTimeout (Maybe Int) Source #
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
keyValuePair_name :: Lens' KeyValuePair (Maybe Text) Source #
The name of the key-value pair. For environment variables, this is the name of the environment variable.
keyValuePair_value :: Lens' KeyValuePair (Maybe Text) Source #
The value of the key-value pair. For environment variables, this is the value of the environment variable.
KeyValuesPair
keyValuesPair_name :: Lens' KeyValuesPair (Maybe Text) Source #
The name of the filter. Filter names are case sensitive.
keyValuesPair_values :: Lens' KeyValuesPair (Maybe [Text]) Source #
The filter values.
LaunchTemplateSpecification
launchTemplateSpecification_launchTemplateId :: Lens' LaunchTemplateSpecification (Maybe Text) Source #
The ID of the launch template.
launchTemplateSpecification_launchTemplateName :: Lens' LaunchTemplateSpecification (Maybe Text) Source #
The name of the launch template.
launchTemplateSpecification_version :: Lens' LaunchTemplateSpecification (Maybe Text) Source #
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
linuxParameters_devices :: Lens' LinuxParameters (Maybe [Device]) Source #
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.
linuxParameters_initProcessEnabled :: Lens' LinuxParameters (Maybe Bool) Source #
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"
linuxParameters_maxSwap :: Lens' LinuxParameters (Maybe Int) Source #
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.
linuxParameters_sharedMemorySize :: Lens' LinuxParameters (Maybe Int) Source #
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.
linuxParameters_swappiness :: Lens' LinuxParameters (Maybe Int) Source #
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
andswappiness
parameters are omitted from a job definition, each container has a defaultswappiness
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.
linuxParameters_tmpfs :: Lens' LinuxParameters (Maybe [Tmpfs]) Source #
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
logConfiguration_options :: Lens' LogConfiguration (Maybe (HashMap Text Text)) Source #
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"
logConfiguration_secretOptions :: Lens' LogConfiguration (Maybe [Secret]) Source #
The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Batch User Guide.
logConfiguration_logDriver :: Lens' LogConfiguration LogDriver Source #
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
mountPoint_containerPath :: Lens' MountPoint (Maybe Text) Source #
The path on the container where the host volume is mounted.
mountPoint_readOnly :: Lens' MountPoint (Maybe Bool) Source #
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
.
mountPoint_sourceVolume :: Lens' MountPoint (Maybe Text) Source #
The name of the volume to mount.
NetworkConfiguration
networkConfiguration_assignPublicIp :: Lens' NetworkConfiguration (Maybe AssignPublicIp) Source #
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
networkInterface_attachmentId :: Lens' NetworkInterface (Maybe Text) Source #
The attachment ID for the network interface.
networkInterface_ipv6Address :: Lens' NetworkInterface (Maybe Text) Source #
The private IPv6 address for the network interface.
networkInterface_privateIpv4Address :: Lens' NetworkInterface (Maybe Text) Source #
The private IPv4 address for the network interface.
NodeDetails
nodeDetails_isMainNode :: Lens' NodeDetails (Maybe Bool) Source #
Specifies whether the current node is the main node for a multi-node parallel job.
nodeDetails_nodeIndex :: Lens' NodeDetails (Maybe Int) Source #
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
nodeOverrides_nodePropertyOverrides :: Lens' NodeOverrides (Maybe [NodePropertyOverride]) Source #
The node property overrides for the job.
nodeOverrides_numNodes :: Lens' NodeOverrides (Maybe Int) Source #
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
:
orn:
. - 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
nodeProperties_numNodes :: Lens' NodeProperties Int Source #
The number of nodes that are associated with a multi-node parallel job.
nodeProperties_mainNode :: Lens' NodeProperties Int Source #
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.
nodeProperties_nodeRangeProperties :: Lens' NodeProperties [NodeRangeProperty] Source #
A list of node ranges and their properties that are associated with a multi-node parallel job.
NodePropertiesSummary
nodePropertiesSummary_isMainNode :: Lens' NodePropertiesSummary (Maybe Bool) Source #
Specifies whether the current node is the main node for a multi-node parallel job.
nodePropertiesSummary_nodeIndex :: Lens' NodePropertiesSummary (Maybe Int) Source #
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.
nodePropertiesSummary_numNodes :: Lens' NodePropertiesSummary (Maybe Int) Source #
The number of nodes that are associated with a multi-node parallel job.
NodePropertyOverride
nodePropertyOverride_containerOverrides :: Lens' NodePropertyOverride (Maybe ContainerOverrides) Source #
The overrides that are sent to a node range.
nodePropertyOverride_targetNodes :: Lens' NodePropertyOverride Text Source #
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
nodeRangeProperty_container :: Lens' NodeRangeProperty (Maybe ContainerProperties) Source #
The container details for the node range.
nodeRangeProperty_targetNodes :: Lens' NodeRangeProperty Text Source #
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
resourceRequirement_value :: Lens' ResourceRequirement Text Source #
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 toMemory
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 theVCPU
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 theMEMORY
values must be one of the values supported for thatVCPU
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
resourceRequirement_type :: Lens' ResourceRequirement ResourceType Source #
The type of resource to assign to a container. The supported resources
include GPU
, MEMORY
, and VCPU
.
RetryStrategy
retryStrategy_attempts :: Lens' RetryStrategy (Maybe Int) Source #
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.
retryStrategy_evaluateOnExit :: Lens' RetryStrategy (Maybe [EvaluateOnExit]) Source #
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
schedulingPolicyDetail_fairsharePolicy :: Lens' SchedulingPolicyDetail (Maybe FairsharePolicy) Source #
The fair share policy for the scheduling policy.
schedulingPolicyDetail_tags :: Lens' SchedulingPolicyDetail (Maybe (HashMap Text Text)) Source #
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.
schedulingPolicyDetail_name :: Lens' SchedulingPolicyDetail Text Source #
The name of the scheduling policy.
schedulingPolicyDetail_arn :: Lens' SchedulingPolicyDetail Text Source #
The Amazon Resource Name (ARN) of the scheduling policy. An example is
arn:
aws
:batch:
us-east-1
:
123456789012
:scheduling-policy/
HighPriority
.
SchedulingPolicyListingDetail
schedulingPolicyListingDetail_arn :: Lens' SchedulingPolicyListingDetail Text Source #
Amazon Resource Name (ARN) of the scheduling policy.
Secret
secret_valueFrom :: Lens' Secret Text Source #
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
shareAttributes_weightFactor :: Lens' ShareAttributes (Maybe Double) Source #
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.
shareAttributes_shareIdentifier :: Lens' ShareAttributes Text Source #
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
tmpfs_mountOptions :: Lens' Tmpfs (Maybe [Text]) Source #
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
"
tmpfs_containerPath :: Lens' Tmpfs Text Source #
The absolute file path in the container where the tmpfs
volume is
mounted.
Ulimit
UpdatePolicy
updatePolicy_jobExecutionTimeoutMinutes :: Lens' UpdatePolicy (Maybe Natural) Source #
Specifies the job timeout (in minutes) when the compute environment infrastructure is updated. The default value is 30.
updatePolicy_terminateJobsOnUpdate :: Lens' UpdatePolicy (Maybe Bool) Source #
Specifies whether jobs are automatically terminated when the computer
environment infrastructure is updated. The default value is false
.
Volume
volume_efsVolumeConfiguration :: Lens' Volume (Maybe EFSVolumeConfiguration) Source #
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
.
volume_host :: Lens' Volume (Maybe Host) Source #
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.