| 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 |
Amazonka.Batch.Types
Contents
- Service Configuration
- Errors
- ArrayJobDependency
- AssignPublicIp
- CEState
- CEStatus
- CEType
- CRAllocationStrategy
- CRType
- CRUpdateAllocationStrategy
- DeviceCgroupPermission
- EFSAuthorizationConfigIAM
- EFSTransitEncryption
- JQState
- JQStatus
- JobDefinitionType
- JobStatus
- LogDriver
- OrchestrationType
- PlatformCapability
- ResourceType
- RetryAction
- 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
Description
Synopsis
- defaultService :: Service
- _ClientException :: AsError a => Fold a ServiceError
- _ServerException :: AsError a => Fold a ServiceError
- newtype ArrayJobDependency where
- newtype AssignPublicIp where
- AssignPublicIp' { }
- pattern AssignPublicIp_DISABLED :: AssignPublicIp
- pattern AssignPublicIp_ENABLED :: AssignPublicIp
- newtype CEState where
- CEState' {
- fromCEState :: Text
- pattern CEState_DISABLED :: CEState
- pattern CEState_ENABLED :: CEState
- CEState' {
- newtype CEStatus where
- CEStatus' {
- fromCEStatus :: Text
- pattern CEStatus_CREATING :: CEStatus
- pattern CEStatus_DELETED :: CEStatus
- pattern CEStatus_DELETING :: CEStatus
- pattern CEStatus_INVALID :: CEStatus
- pattern CEStatus_UPDATING :: CEStatus
- pattern CEStatus_VALID :: CEStatus
- CEStatus' {
- newtype CEType where
- CEType' {
- fromCEType :: Text
- pattern CEType_MANAGED :: CEType
- pattern CEType_UNMANAGED :: CEType
- CEType' {
- newtype CRAllocationStrategy where
- newtype CRType where
- CRType' {
- fromCRType :: Text
- pattern CRType_EC2 :: CRType
- pattern CRType_FARGATE :: CRType
- pattern CRType_FARGATE_SPOT :: CRType
- pattern CRType_SPOT :: CRType
- CRType' {
- newtype CRUpdateAllocationStrategy where
- newtype DeviceCgroupPermission where
- newtype EFSAuthorizationConfigIAM where
- newtype EFSTransitEncryption where
- newtype JQState where
- JQState' {
- fromJQState :: Text
- pattern JQState_DISABLED :: JQState
- pattern JQState_ENABLED :: JQState
- JQState' {
- newtype JQStatus where
- JQStatus' {
- fromJQStatus :: Text
- pattern JQStatus_CREATING :: JQStatus
- pattern JQStatus_DELETED :: JQStatus
- pattern JQStatus_DELETING :: JQStatus
- pattern JQStatus_INVALID :: JQStatus
- pattern JQStatus_UPDATING :: JQStatus
- pattern JQStatus_VALID :: JQStatus
- JQStatus' {
- newtype JobDefinitionType where
- JobDefinitionType' { }
- pattern JobDefinitionType_Container :: JobDefinitionType
- pattern JobDefinitionType_Multinode :: JobDefinitionType
- newtype JobStatus where
- JobStatus' { }
- pattern JobStatus_FAILED :: JobStatus
- pattern JobStatus_PENDING :: JobStatus
- pattern JobStatus_RUNNABLE :: JobStatus
- pattern JobStatus_RUNNING :: JobStatus
- pattern JobStatus_STARTING :: JobStatus
- pattern JobStatus_SUBMITTED :: JobStatus
- pattern JobStatus_SUCCEEDED :: JobStatus
- newtype LogDriver where
- LogDriver' { }
- pattern LogDriver_Awslogs :: LogDriver
- pattern LogDriver_Fluentd :: LogDriver
- pattern LogDriver_Gelf :: LogDriver
- pattern LogDriver_Journald :: LogDriver
- pattern LogDriver_Json_file :: LogDriver
- pattern LogDriver_Splunk :: LogDriver
- pattern LogDriver_Syslog :: LogDriver
- newtype OrchestrationType where
- OrchestrationType' { }
- pattern OrchestrationType_ECS :: OrchestrationType
- pattern OrchestrationType_EKS :: OrchestrationType
- newtype PlatformCapability where
- PlatformCapability' { }
- pattern PlatformCapability_EC2 :: PlatformCapability
- pattern PlatformCapability_FARGATE :: PlatformCapability
- newtype ResourceType where
- ResourceType' { }
- pattern ResourceType_GPU :: ResourceType
- pattern ResourceType_MEMORY :: ResourceType
- pattern ResourceType_VCPU :: ResourceType
- newtype RetryAction where
- RetryAction' { }
- pattern RetryAction_EXIT :: RetryAction
- pattern RetryAction_RETRY :: RetryAction
- data ArrayProperties = ArrayProperties' {}
- newArrayProperties :: ArrayProperties
- arrayProperties_size :: Lens' ArrayProperties (Maybe Int)
- data ArrayPropertiesDetail = ArrayPropertiesDetail' {}
- newArrayPropertiesDetail :: ArrayPropertiesDetail
- arrayPropertiesDetail_index :: Lens' ArrayPropertiesDetail (Maybe Int)
- arrayPropertiesDetail_size :: Lens' ArrayPropertiesDetail (Maybe Int)
- arrayPropertiesDetail_statusSummary :: Lens' ArrayPropertiesDetail (Maybe (HashMap Text Int))
- data ArrayPropertiesSummary = ArrayPropertiesSummary' {}
- newArrayPropertiesSummary :: ArrayPropertiesSummary
- arrayPropertiesSummary_index :: Lens' ArrayPropertiesSummary (Maybe Int)
- arrayPropertiesSummary_size :: Lens' ArrayPropertiesSummary (Maybe Int)
- data AttemptContainerDetail = AttemptContainerDetail' {}
- newAttemptContainerDetail :: AttemptContainerDetail
- 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)
- data AttemptDetail = AttemptDetail' {}
- newAttemptDetail :: AttemptDetail
- attemptDetail_container :: Lens' AttemptDetail (Maybe AttemptContainerDetail)
- attemptDetail_startedAt :: Lens' AttemptDetail (Maybe Integer)
- attemptDetail_statusReason :: Lens' AttemptDetail (Maybe Text)
- attemptDetail_stoppedAt :: Lens' AttemptDetail (Maybe Integer)
- data ComputeEnvironmentDetail = ComputeEnvironmentDetail' {
- computeResources :: Maybe ComputeResource
- containerOrchestrationType :: Maybe OrchestrationType
- ecsClusterArn :: Maybe Text
- eksConfiguration :: Maybe EksConfiguration
- serviceRole :: Maybe Text
- state :: Maybe CEState
- status :: Maybe CEStatus
- statusReason :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- type' :: Maybe CEType
- unmanagedvCpus :: Maybe Int
- updatePolicy :: Maybe UpdatePolicy
- uuid :: Maybe Text
- computeEnvironmentName :: Text
- computeEnvironmentArn :: Text
- newComputeEnvironmentDetail :: Text -> Text -> ComputeEnvironmentDetail
- 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
- data ComputeEnvironmentOrder = ComputeEnvironmentOrder' {
- order :: Int
- computeEnvironment :: Text
- newComputeEnvironmentOrder :: Int -> Text -> ComputeEnvironmentOrder
- computeEnvironmentOrder_order :: Lens' ComputeEnvironmentOrder Int
- computeEnvironmentOrder_computeEnvironment :: Lens' ComputeEnvironmentOrder Text
- data ComputeResource = ComputeResource' {
- allocationStrategy :: Maybe CRAllocationStrategy
- bidPercentage :: Maybe Int
- desiredvCpus :: Maybe Int
- ec2Configuration :: Maybe [Ec2Configuration]
- ec2KeyPair :: Maybe Text
- imageId :: Maybe Text
- instanceRole :: Maybe Text
- instanceTypes :: Maybe [Text]
- launchTemplate :: Maybe LaunchTemplateSpecification
- minvCpus :: Maybe Int
- placementGroup :: Maybe Text
- securityGroupIds :: Maybe [Text]
- spotIamFleetRole :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- type' :: CRType
- maxvCpus :: Int
- subnets :: [Text]
- newComputeResource :: CRType -> Int -> ComputeResource
- 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]
- data ComputeResourceUpdate = ComputeResourceUpdate' {
- allocationStrategy :: Maybe CRUpdateAllocationStrategy
- bidPercentage :: Maybe Int
- desiredvCpus :: Maybe Int
- ec2Configuration :: Maybe [Ec2Configuration]
- ec2KeyPair :: Maybe Text
- imageId :: Maybe Text
- instanceRole :: Maybe Text
- instanceTypes :: Maybe [Text]
- launchTemplate :: Maybe LaunchTemplateSpecification
- maxvCpus :: Maybe Int
- minvCpus :: Maybe Int
- placementGroup :: Maybe Text
- securityGroupIds :: Maybe [Text]
- subnets :: Maybe [Text]
- tags :: Maybe (HashMap Text Text)
- type' :: Maybe CRType
- updateToLatestImageVersion :: Maybe Bool
- newComputeResourceUpdate :: ComputeResourceUpdate
- 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)
- data ContainerDetail = ContainerDetail' {
- command :: Maybe [Text]
- containerInstanceArn :: Maybe Text
- environment :: Maybe [KeyValuePair]
- executionRoleArn :: Maybe Text
- exitCode :: Maybe Int
- fargatePlatformConfiguration :: Maybe FargatePlatformConfiguration
- image :: Maybe Text
- instanceType :: Maybe Text
- jobRoleArn :: Maybe Text
- linuxParameters :: Maybe LinuxParameters
- logConfiguration :: Maybe LogConfiguration
- logStreamName :: Maybe Text
- memory :: Maybe Int
- mountPoints :: Maybe [MountPoint]
- networkConfiguration :: Maybe NetworkConfiguration
- networkInterfaces :: Maybe [NetworkInterface]
- privileged :: Maybe Bool
- readonlyRootFilesystem :: Maybe Bool
- reason :: Maybe Text
- resourceRequirements :: Maybe [ResourceRequirement]
- secrets :: Maybe [Secret]
- taskArn :: Maybe Text
- ulimits :: Maybe [Ulimit]
- user :: Maybe Text
- vcpus :: Maybe Int
- volumes :: Maybe [Volume]
- newContainerDetail :: ContainerDetail
- 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])
- data ContainerOverrides = ContainerOverrides' {
- command :: Maybe [Text]
- environment :: Maybe [KeyValuePair]
- instanceType :: Maybe Text
- memory :: Maybe Int
- resourceRequirements :: Maybe [ResourceRequirement]
- vcpus :: Maybe Int
- newContainerOverrides :: ContainerOverrides
- 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)
- data ContainerProperties = ContainerProperties' {
- command :: Maybe [Text]
- environment :: Maybe [KeyValuePair]
- executionRoleArn :: Maybe Text
- fargatePlatformConfiguration :: Maybe FargatePlatformConfiguration
- image :: Maybe Text
- instanceType :: Maybe Text
- jobRoleArn :: Maybe Text
- linuxParameters :: Maybe LinuxParameters
- logConfiguration :: Maybe LogConfiguration
- memory :: Maybe Int
- mountPoints :: Maybe [MountPoint]
- networkConfiguration :: Maybe NetworkConfiguration
- privileged :: Maybe Bool
- readonlyRootFilesystem :: Maybe Bool
- resourceRequirements :: Maybe [ResourceRequirement]
- secrets :: Maybe [Secret]
- ulimits :: Maybe [Ulimit]
- user :: Maybe Text
- vcpus :: Maybe Int
- volumes :: Maybe [Volume]
- newContainerProperties :: ContainerProperties
- 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])
- data ContainerSummary = ContainerSummary' {}
- newContainerSummary :: ContainerSummary
- containerSummary_exitCode :: Lens' ContainerSummary (Maybe Int)
- containerSummary_reason :: Lens' ContainerSummary (Maybe Text)
- data Device = Device' {}
- newDevice :: Text -> Device
- device_containerPath :: Lens' Device (Maybe Text)
- device_permissions :: Lens' Device (Maybe [DeviceCgroupPermission])
- device_hostPath :: Lens' Device Text
- data EFSAuthorizationConfig = EFSAuthorizationConfig' {}
- newEFSAuthorizationConfig :: EFSAuthorizationConfig
- eFSAuthorizationConfig_accessPointId :: Lens' EFSAuthorizationConfig (Maybe Text)
- eFSAuthorizationConfig_iam :: Lens' EFSAuthorizationConfig (Maybe EFSAuthorizationConfigIAM)
- data EFSVolumeConfiguration = EFSVolumeConfiguration' {}
- newEFSVolumeConfiguration :: Text -> EFSVolumeConfiguration
- 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
- data Ec2Configuration = Ec2Configuration' {}
- newEc2Configuration :: Text -> Ec2Configuration
- ec2Configuration_imageIdOverride :: Lens' Ec2Configuration (Maybe Text)
- ec2Configuration_imageKubernetesVersion :: Lens' Ec2Configuration (Maybe Text)
- ec2Configuration_imageType :: Lens' Ec2Configuration Text
- data EksAttemptContainerDetail = EksAttemptContainerDetail' {}
- newEksAttemptContainerDetail :: EksAttemptContainerDetail
- eksAttemptContainerDetail_exitCode :: Lens' EksAttemptContainerDetail (Maybe Int)
- eksAttemptContainerDetail_reason :: Lens' EksAttemptContainerDetail (Maybe Text)
- data EksAttemptDetail = EksAttemptDetail' {}
- newEksAttemptDetail :: EksAttemptDetail
- 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)
- data EksConfiguration = EksConfiguration' {}
- newEksConfiguration :: Text -> Text -> EksConfiguration
- eksConfiguration_eksClusterArn :: Lens' EksConfiguration Text
- eksConfiguration_kubernetesNamespace :: Lens' EksConfiguration Text
- data EksContainer = EksContainer' {}
- newEksContainer :: Text -> EksContainer
- 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
- data EksContainerDetail = EksContainerDetail' {
- args :: Maybe [Text]
- command :: Maybe [Text]
- env :: Maybe [EksContainerEnvironmentVariable]
- exitCode :: Maybe Int
- image :: Maybe Text
- imagePullPolicy :: Maybe Text
- name :: Maybe Text
- reason :: Maybe Text
- resources :: Maybe EksContainerResourceRequirements
- securityContext :: Maybe EksContainerSecurityContext
- volumeMounts :: Maybe [EksContainerVolumeMount]
- newEksContainerDetail :: EksContainerDetail
- 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])
- data EksContainerEnvironmentVariable = EksContainerEnvironmentVariable' {}
- newEksContainerEnvironmentVariable :: Text -> EksContainerEnvironmentVariable
- eksContainerEnvironmentVariable_value :: Lens' EksContainerEnvironmentVariable (Maybe Text)
- eksContainerEnvironmentVariable_name :: Lens' EksContainerEnvironmentVariable Text
- data EksContainerOverride = EksContainerOverride' {}
- newEksContainerOverride :: EksContainerOverride
- 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)
- data EksContainerResourceRequirements = EksContainerResourceRequirements' {}
- newEksContainerResourceRequirements :: EksContainerResourceRequirements
- eksContainerResourceRequirements_limits :: Lens' EksContainerResourceRequirements (Maybe (HashMap Text Text))
- eksContainerResourceRequirements_requests :: Lens' EksContainerResourceRequirements (Maybe (HashMap Text Text))
- data EksContainerSecurityContext = EksContainerSecurityContext' {}
- newEksContainerSecurityContext :: EksContainerSecurityContext
- 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)
- data EksContainerVolumeMount = EksContainerVolumeMount' {}
- newEksContainerVolumeMount :: EksContainerVolumeMount
- eksContainerVolumeMount_mountPath :: Lens' EksContainerVolumeMount (Maybe Text)
- eksContainerVolumeMount_name :: Lens' EksContainerVolumeMount (Maybe Text)
- eksContainerVolumeMount_readOnly :: Lens' EksContainerVolumeMount (Maybe Bool)
- data EksEmptyDir = EksEmptyDir' {}
- newEksEmptyDir :: EksEmptyDir
- eksEmptyDir_medium :: Lens' EksEmptyDir (Maybe Text)
- eksEmptyDir_sizeLimit :: Lens' EksEmptyDir (Maybe Text)
- data EksHostPath = EksHostPath' {}
- newEksHostPath :: EksHostPath
- eksHostPath_path :: Lens' EksHostPath (Maybe Text)
- data EksPodProperties = EksPodProperties' {
- containers :: Maybe [EksContainer]
- dnsPolicy :: Maybe Text
- hostNetwork :: Maybe Bool
- serviceAccountName :: Maybe Text
- volumes :: Maybe [EksVolume]
- newEksPodProperties :: EksPodProperties
- 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])
- data EksPodPropertiesDetail = EksPodPropertiesDetail' {}
- newEksPodPropertiesDetail :: EksPodPropertiesDetail
- 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])
- data EksPodPropertiesOverride = EksPodPropertiesOverride' {}
- newEksPodPropertiesOverride :: EksPodPropertiesOverride
- eksPodPropertiesOverride_containers :: Lens' EksPodPropertiesOverride (Maybe [EksContainerOverride])
- data EksProperties = EksProperties' {}
- newEksProperties :: EksProperties
- eksProperties_podProperties :: Lens' EksProperties (Maybe EksPodProperties)
- data EksPropertiesDetail = EksPropertiesDetail' {}
- newEksPropertiesDetail :: EksPropertiesDetail
- eksPropertiesDetail_podProperties :: Lens' EksPropertiesDetail (Maybe EksPodPropertiesDetail)
- data EksPropertiesOverride = EksPropertiesOverride' {}
- newEksPropertiesOverride :: EksPropertiesOverride
- eksPropertiesOverride_podProperties :: Lens' EksPropertiesOverride (Maybe EksPodPropertiesOverride)
- data EksSecret = EksSecret' {
- optional :: Maybe Bool
- secretName :: Text
- newEksSecret :: Text -> EksSecret
- eksSecret_optional :: Lens' EksSecret (Maybe Bool)
- eksSecret_secretName :: Lens' EksSecret Text
- data EksVolume = EksVolume' {}
- newEksVolume :: Text -> EksVolume
- eksVolume_emptyDir :: Lens' EksVolume (Maybe EksEmptyDir)
- eksVolume_hostPath :: Lens' EksVolume (Maybe EksHostPath)
- eksVolume_secret :: Lens' EksVolume (Maybe EksSecret)
- eksVolume_name :: Lens' EksVolume Text
- data EvaluateOnExit = EvaluateOnExit' {
- onExitCode :: Maybe Text
- onReason :: Maybe Text
- onStatusReason :: Maybe Text
- action :: RetryAction
- newEvaluateOnExit :: RetryAction -> EvaluateOnExit
- evaluateOnExit_onExitCode :: Lens' EvaluateOnExit (Maybe Text)
- evaluateOnExit_onReason :: Lens' EvaluateOnExit (Maybe Text)
- evaluateOnExit_onStatusReason :: Lens' EvaluateOnExit (Maybe Text)
- evaluateOnExit_action :: Lens' EvaluateOnExit RetryAction
- data FairsharePolicy = FairsharePolicy' {}
- newFairsharePolicy :: FairsharePolicy
- fairsharePolicy_computeReservation :: Lens' FairsharePolicy (Maybe Int)
- fairsharePolicy_shareDecaySeconds :: Lens' FairsharePolicy (Maybe Int)
- fairsharePolicy_shareDistribution :: Lens' FairsharePolicy (Maybe [ShareAttributes])
- data FargatePlatformConfiguration = FargatePlatformConfiguration' {}
- newFargatePlatformConfiguration :: FargatePlatformConfiguration
- fargatePlatformConfiguration_platformVersion :: Lens' FargatePlatformConfiguration (Maybe Text)
- data Host = Host' {
- sourcePath :: Maybe Text
- newHost :: Host
- host_sourcePath :: Lens' Host (Maybe Text)
- data JobDefinition = JobDefinition' {
- containerOrchestrationType :: Maybe OrchestrationType
- containerProperties :: Maybe ContainerProperties
- eksProperties :: Maybe EksProperties
- nodeProperties :: Maybe NodeProperties
- parameters :: Maybe (HashMap Text Text)
- platformCapabilities :: Maybe [PlatformCapability]
- propagateTags :: Maybe Bool
- retryStrategy :: Maybe RetryStrategy
- schedulingPriority :: Maybe Int
- status :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- timeout :: Maybe JobTimeout
- jobDefinitionName :: Text
- jobDefinitionArn :: Text
- revision :: Int
- type' :: Text
- newJobDefinition :: Text -> Text -> Int -> Text -> JobDefinition
- 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
- data JobDependency = JobDependency' {}
- newJobDependency :: JobDependency
- jobDependency_jobId :: Lens' JobDependency (Maybe Text)
- jobDependency_type :: Lens' JobDependency (Maybe ArrayJobDependency)
- data JobDetail = JobDetail' {
- arrayProperties :: Maybe ArrayPropertiesDetail
- attempts :: Maybe [AttemptDetail]
- container :: Maybe ContainerDetail
- createdAt :: Maybe Integer
- dependsOn :: Maybe [JobDependency]
- eksAttempts :: Maybe [EksAttemptDetail]
- eksProperties :: Maybe EksPropertiesDetail
- isCancelled :: Maybe Bool
- isTerminated :: Maybe Bool
- jobArn :: Maybe Text
- nodeDetails :: Maybe NodeDetails
- nodeProperties :: Maybe NodeProperties
- parameters :: Maybe (HashMap Text Text)
- platformCapabilities :: Maybe [PlatformCapability]
- propagateTags :: Maybe Bool
- retryStrategy :: Maybe RetryStrategy
- schedulingPriority :: Maybe Int
- shareIdentifier :: Maybe Text
- startedAt :: Maybe Integer
- statusReason :: Maybe Text
- stoppedAt :: Maybe Integer
- tags :: Maybe (HashMap Text Text)
- timeout :: Maybe JobTimeout
- jobName :: Text
- jobId :: Text
- jobQueue :: Text
- status :: JobStatus
- jobDefinition :: Text
- newJobDetail :: Text -> Text -> Text -> JobStatus -> Text -> JobDetail
- 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
- data JobQueueDetail = JobQueueDetail' {}
- newJobQueueDetail :: Text -> Text -> JQState -> Int -> JobQueueDetail
- 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]
- data JobSummary = JobSummary' {
- arrayProperties :: Maybe ArrayPropertiesSummary
- container :: Maybe ContainerSummary
- createdAt :: Maybe Integer
- jobArn :: Maybe Text
- jobDefinition :: Maybe Text
- nodeProperties :: Maybe NodePropertiesSummary
- startedAt :: Maybe Integer
- status :: Maybe JobStatus
- statusReason :: Maybe Text
- stoppedAt :: Maybe Integer
- jobId :: Text
- jobName :: Text
- newJobSummary :: Text -> Text -> JobSummary
- 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
- data JobTimeout = JobTimeout' {}
- newJobTimeout :: JobTimeout
- jobTimeout_attemptDurationSeconds :: Lens' JobTimeout (Maybe Int)
- data KeyValuePair = KeyValuePair' {}
- newKeyValuePair :: KeyValuePair
- keyValuePair_name :: Lens' KeyValuePair (Maybe Text)
- keyValuePair_value :: Lens' KeyValuePair (Maybe Text)
- data KeyValuesPair = KeyValuesPair' {}
- newKeyValuesPair :: KeyValuesPair
- keyValuesPair_name :: Lens' KeyValuesPair (Maybe Text)
- keyValuesPair_values :: Lens' KeyValuesPair (Maybe [Text])
- data LaunchTemplateSpecification = LaunchTemplateSpecification' {}
- newLaunchTemplateSpecification :: LaunchTemplateSpecification
- launchTemplateSpecification_launchTemplateId :: Lens' LaunchTemplateSpecification (Maybe Text)
- launchTemplateSpecification_launchTemplateName :: Lens' LaunchTemplateSpecification (Maybe Text)
- launchTemplateSpecification_version :: Lens' LaunchTemplateSpecification (Maybe Text)
- data LinuxParameters = LinuxParameters' {}
- newLinuxParameters :: LinuxParameters
- 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])
- data LogConfiguration = LogConfiguration' {}
- newLogConfiguration :: LogDriver -> LogConfiguration
- logConfiguration_options :: Lens' LogConfiguration (Maybe (HashMap Text Text))
- logConfiguration_secretOptions :: Lens' LogConfiguration (Maybe [Secret])
- logConfiguration_logDriver :: Lens' LogConfiguration LogDriver
- data MountPoint = MountPoint' {
- containerPath :: Maybe Text
- readOnly :: Maybe Bool
- sourceVolume :: Maybe Text
- newMountPoint :: MountPoint
- mountPoint_containerPath :: Lens' MountPoint (Maybe Text)
- mountPoint_readOnly :: Lens' MountPoint (Maybe Bool)
- mountPoint_sourceVolume :: Lens' MountPoint (Maybe Text)
- data NetworkConfiguration = NetworkConfiguration' {}
- newNetworkConfiguration :: NetworkConfiguration
- networkConfiguration_assignPublicIp :: Lens' NetworkConfiguration (Maybe AssignPublicIp)
- data NetworkInterface = NetworkInterface' {}
- newNetworkInterface :: NetworkInterface
- networkInterface_attachmentId :: Lens' NetworkInterface (Maybe Text)
- networkInterface_ipv6Address :: Lens' NetworkInterface (Maybe Text)
- networkInterface_privateIpv4Address :: Lens' NetworkInterface (Maybe Text)
- data NodeDetails = NodeDetails' {}
- newNodeDetails :: NodeDetails
- nodeDetails_isMainNode :: Lens' NodeDetails (Maybe Bool)
- nodeDetails_nodeIndex :: Lens' NodeDetails (Maybe Int)
- data NodeOverrides = NodeOverrides' {}
- newNodeOverrides :: NodeOverrides
- nodeOverrides_nodePropertyOverrides :: Lens' NodeOverrides (Maybe [NodePropertyOverride])
- nodeOverrides_numNodes :: Lens' NodeOverrides (Maybe Int)
- data NodeProperties = NodeProperties' {}
- newNodeProperties :: Int -> Int -> NodeProperties
- nodeProperties_numNodes :: Lens' NodeProperties Int
- nodeProperties_mainNode :: Lens' NodeProperties Int
- nodeProperties_nodeRangeProperties :: Lens' NodeProperties [NodeRangeProperty]
- data NodePropertiesSummary = NodePropertiesSummary' {}
- newNodePropertiesSummary :: NodePropertiesSummary
- nodePropertiesSummary_isMainNode :: Lens' NodePropertiesSummary (Maybe Bool)
- nodePropertiesSummary_nodeIndex :: Lens' NodePropertiesSummary (Maybe Int)
- nodePropertiesSummary_numNodes :: Lens' NodePropertiesSummary (Maybe Int)
- data NodePropertyOverride = NodePropertyOverride' {}
- newNodePropertyOverride :: Text -> NodePropertyOverride
- nodePropertyOverride_containerOverrides :: Lens' NodePropertyOverride (Maybe ContainerOverrides)
- nodePropertyOverride_targetNodes :: Lens' NodePropertyOverride Text
- data NodeRangeProperty = NodeRangeProperty' {}
- newNodeRangeProperty :: Text -> NodeRangeProperty
- nodeRangeProperty_container :: Lens' NodeRangeProperty (Maybe ContainerProperties)
- nodeRangeProperty_targetNodes :: Lens' NodeRangeProperty Text
- data ResourceRequirement = ResourceRequirement' {
- value :: Text
- type' :: ResourceType
- newResourceRequirement :: Text -> ResourceType -> ResourceRequirement
- resourceRequirement_value :: Lens' ResourceRequirement Text
- resourceRequirement_type :: Lens' ResourceRequirement ResourceType
- data RetryStrategy = RetryStrategy' {}
- newRetryStrategy :: RetryStrategy
- retryStrategy_attempts :: Lens' RetryStrategy (Maybe Int)
- retryStrategy_evaluateOnExit :: Lens' RetryStrategy (Maybe [EvaluateOnExit])
- data SchedulingPolicyDetail = SchedulingPolicyDetail' {}
- newSchedulingPolicyDetail :: Text -> Text -> SchedulingPolicyDetail
- schedulingPolicyDetail_fairsharePolicy :: Lens' SchedulingPolicyDetail (Maybe FairsharePolicy)
- schedulingPolicyDetail_tags :: Lens' SchedulingPolicyDetail (Maybe (HashMap Text Text))
- schedulingPolicyDetail_name :: Lens' SchedulingPolicyDetail Text
- schedulingPolicyDetail_arn :: Lens' SchedulingPolicyDetail Text
- data SchedulingPolicyListingDetail = SchedulingPolicyListingDetail' {}
- newSchedulingPolicyListingDetail :: Text -> SchedulingPolicyListingDetail
- schedulingPolicyListingDetail_arn :: Lens' SchedulingPolicyListingDetail Text
- data Secret = Secret' {}
- newSecret :: Text -> Text -> Secret
- secret_name :: Lens' Secret Text
- secret_valueFrom :: Lens' Secret Text
- data ShareAttributes = ShareAttributes' {}
- newShareAttributes :: Text -> ShareAttributes
- shareAttributes_weightFactor :: Lens' ShareAttributes (Maybe Double)
- shareAttributes_shareIdentifier :: Lens' ShareAttributes Text
- data Tmpfs = Tmpfs' {
- mountOptions :: Maybe [Text]
- containerPath :: Text
- size :: Int
- newTmpfs :: Text -> Int -> Tmpfs
- tmpfs_mountOptions :: Lens' Tmpfs (Maybe [Text])
- tmpfs_containerPath :: Lens' Tmpfs Text
- tmpfs_size :: Lens' Tmpfs Int
- data Ulimit = Ulimit' {}
- newUlimit :: Int -> Text -> Int -> Ulimit
- ulimit_hardLimit :: Lens' Ulimit Int
- ulimit_name :: Lens' Ulimit Text
- ulimit_softLimit :: Lens' Ulimit Int
- data UpdatePolicy = UpdatePolicy' {}
- newUpdatePolicy :: UpdatePolicy
- updatePolicy_jobExecutionTimeoutMinutes :: Lens' UpdatePolicy (Maybe Natural)
- updatePolicy_terminateJobsOnUpdate :: Lens' UpdatePolicy (Maybe Bool)
- data Volume = Volume' {}
- newVolume :: Volume
- volume_efsVolumeConfiguration :: Lens' Volume (Maybe EFSVolumeConfiguration)
- volume_host :: Lens' Volume (Maybe Host)
- volume_name :: Lens' Volume (Maybe Text)
Service Configuration
defaultService :: Service Source #
API version 2016-08-10 of the Amazon Batch SDK configuration.
Errors
_ClientException :: AsError a => Fold a ServiceError Source #
These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.
_ServerException :: AsError a => Fold a ServiceError Source #
These errors are usually caused by a server issue.
ArrayJobDependency
newtype ArrayJobDependency Source #
Constructors
| ArrayJobDependency' | |
Fields | |
Bundled Patterns
| pattern ArrayJobDependency_N_TO_N :: ArrayJobDependency | |
| pattern ArrayJobDependency_SEQUENTIAL :: ArrayJobDependency |
Instances
AssignPublicIp
newtype AssignPublicIp Source #
Constructors
| AssignPublicIp' | |
Fields | |
Bundled Patterns
| pattern AssignPublicIp_DISABLED :: AssignPublicIp | |
| pattern AssignPublicIp_ENABLED :: AssignPublicIp |
Instances
CEState
Constructors
| CEState' | |
Fields
| |
Bundled Patterns
| pattern CEState_DISABLED :: CEState | |
| pattern CEState_ENABLED :: CEState |
Instances
CEStatus
Constructors
| CEStatus' | |
Fields
| |
Bundled Patterns
| pattern CEStatus_CREATING :: CEStatus | |
| pattern CEStatus_DELETED :: CEStatus | |
| pattern CEStatus_DELETING :: CEStatus | |
| pattern CEStatus_INVALID :: CEStatus | |
| pattern CEStatus_UPDATING :: CEStatus | |
| pattern CEStatus_VALID :: CEStatus |
Instances
CEType
Constructors
| CEType' | |
Fields
| |
Bundled Patterns
| pattern CEType_MANAGED :: CEType | |
| pattern CEType_UNMANAGED :: CEType |
Instances
CRAllocationStrategy
newtype CRAllocationStrategy Source #
Constructors
| CRAllocationStrategy' | |
Fields | |
Bundled Patterns
Instances
CRType
Constructors
| CRType' | |
Fields
| |
Bundled Patterns
| pattern CRType_EC2 :: CRType | |
| pattern CRType_FARGATE :: CRType | |
| pattern CRType_FARGATE_SPOT :: CRType | |
| pattern CRType_SPOT :: CRType |
Instances
CRUpdateAllocationStrategy
newtype CRUpdateAllocationStrategy Source #
Constructors
| CRUpdateAllocationStrategy' | |
Fields | |
Bundled Patterns
| pattern CRUpdateAllocationStrategy_BEST_FIT_PROGRESSIVE :: CRUpdateAllocationStrategy | |
| pattern CRUpdateAllocationStrategy_SPOT_CAPACITY_OPTIMIZED :: CRUpdateAllocationStrategy |
Instances
DeviceCgroupPermission
newtype DeviceCgroupPermission Source #
Constructors
| DeviceCgroupPermission' | |
Fields | |
Bundled Patterns
| pattern DeviceCgroupPermission_MKNOD :: DeviceCgroupPermission | |
| pattern DeviceCgroupPermission_READ :: DeviceCgroupPermission | |
| pattern DeviceCgroupPermission_WRITE :: DeviceCgroupPermission |
Instances
EFSAuthorizationConfigIAM
newtype EFSAuthorizationConfigIAM Source #
Constructors
| EFSAuthorizationConfigIAM' | |
Fields | |
Bundled Patterns
| pattern EFSAuthorizationConfigIAM_DISABLED :: EFSAuthorizationConfigIAM | |
| pattern EFSAuthorizationConfigIAM_ENABLED :: EFSAuthorizationConfigIAM |
Instances
EFSTransitEncryption
newtype EFSTransitEncryption Source #
Constructors
| EFSTransitEncryption' | |
Fields | |
Bundled Patterns
| pattern EFSTransitEncryption_DISABLED :: EFSTransitEncryption | |
| pattern EFSTransitEncryption_ENABLED :: EFSTransitEncryption |
Instances
JQState
Constructors
| JQState' | |
Fields
| |
Bundled Patterns
| pattern JQState_DISABLED :: JQState | |
| pattern JQState_ENABLED :: JQState |
Instances
JQStatus
Constructors
| JQStatus' | |
Fields
| |
Bundled Patterns
| pattern JQStatus_CREATING :: JQStatus | |
| pattern JQStatus_DELETED :: JQStatus | |
| pattern JQStatus_DELETING :: JQStatus | |
| pattern JQStatus_INVALID :: JQStatus | |
| pattern JQStatus_UPDATING :: JQStatus | |
| pattern JQStatus_VALID :: JQStatus |
Instances
JobDefinitionType
newtype JobDefinitionType Source #
Constructors
| JobDefinitionType' | |
Fields | |
Bundled Patterns
| pattern JobDefinitionType_Container :: JobDefinitionType | |
| pattern JobDefinitionType_Multinode :: JobDefinitionType |
Instances
JobStatus
Constructors
| JobStatus' | |
Fields | |
Bundled Patterns
| pattern JobStatus_FAILED :: JobStatus | |
| pattern JobStatus_PENDING :: JobStatus | |
| pattern JobStatus_RUNNABLE :: JobStatus | |
| pattern JobStatus_RUNNING :: JobStatus | |
| pattern JobStatus_STARTING :: JobStatus | |
| pattern JobStatus_SUBMITTED :: JobStatus | |
| pattern JobStatus_SUCCEEDED :: JobStatus |
Instances
LogDriver
Constructors
| LogDriver' | |
Fields | |
Bundled Patterns
| pattern LogDriver_Awslogs :: LogDriver | |
| pattern LogDriver_Fluentd :: LogDriver | |
| pattern LogDriver_Gelf :: LogDriver | |
| pattern LogDriver_Journald :: LogDriver | |
| pattern LogDriver_Json_file :: LogDriver | |
| pattern LogDriver_Splunk :: LogDriver | |
| pattern LogDriver_Syslog :: LogDriver |
Instances
OrchestrationType
newtype OrchestrationType Source #
Constructors
| OrchestrationType' | |
Fields | |
Bundled Patterns
| pattern OrchestrationType_ECS :: OrchestrationType | |
| pattern OrchestrationType_EKS :: OrchestrationType |
Instances
PlatformCapability
newtype PlatformCapability Source #
Constructors
| PlatformCapability' | |
Fields | |
Bundled Patterns
| pattern PlatformCapability_EC2 :: PlatformCapability | |
| pattern PlatformCapability_FARGATE :: PlatformCapability |
Instances
ResourceType
newtype ResourceType Source #
Constructors
| ResourceType' | |
Fields | |
Bundled Patterns
| pattern ResourceType_GPU :: ResourceType | |
| pattern ResourceType_MEMORY :: ResourceType | |
| pattern ResourceType_VCPU :: ResourceType |
Instances
RetryAction
newtype RetryAction Source #
Constructors
| RetryAction' | |
Fields | |
Bundled Patterns
| pattern RetryAction_EXIT :: RetryAction | |
| pattern RetryAction_RETRY :: RetryAction |
Instances
ArrayProperties
data ArrayProperties Source #
An object that represents an Batch array job.
See: newArrayProperties smart constructor.
Constructors
| ArrayProperties' | |
Instances
newArrayProperties :: ArrayProperties Source #
Create a value of ArrayProperties with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:size:ArrayProperties', arrayProperties_size - The size of the array job.
arrayProperties_size :: Lens' ArrayProperties (Maybe Int) Source #
The size of the array job.
ArrayPropertiesDetail
data ArrayPropertiesDetail Source #
An object that represents the array properties of a job.
See: newArrayPropertiesDetail smart constructor.
Constructors
| ArrayPropertiesDetail' | |
Fields
| |
Instances
newArrayPropertiesDetail :: ArrayPropertiesDetail Source #
Create a value of ArrayPropertiesDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:index:ArrayPropertiesDetail', arrayPropertiesDetail_index - The job index within the array that's associated with this job. This
parameter is returned for array job children.
$sel:size:ArrayPropertiesDetail', arrayPropertiesDetail_size - The size of the array job. This parameter is returned for parent array
jobs.
$sel:statusSummary:ArrayPropertiesDetail', arrayPropertiesDetail_statusSummary - A summary of the number of array job children in each available job
status. This parameter is returned for parent array jobs.
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
data ArrayPropertiesSummary Source #
An object that represents the array properties of a job.
See: newArrayPropertiesSummary smart constructor.
Constructors
| ArrayPropertiesSummary' | |
Instances
newArrayPropertiesSummary :: ArrayPropertiesSummary Source #
Create a value of ArrayPropertiesSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:index:ArrayPropertiesSummary', arrayPropertiesSummary_index - The job index within the array that's associated with this job. This
parameter is returned for children of array jobs.
$sel:size:ArrayPropertiesSummary', arrayPropertiesSummary_size - The size of the array job. This parameter is returned for parent array
jobs.
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
data AttemptContainerDetail Source #
An object that represents the details of a container that's part of a job attempt.
See: newAttemptContainerDetail smart constructor.
Constructors
| AttemptContainerDetail' | |
Fields
| |
Instances
newAttemptContainerDetail :: AttemptContainerDetail Source #
Create a value of AttemptContainerDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:containerInstanceArn:AttemptContainerDetail', attemptContainerDetail_containerInstanceArn - The Amazon Resource Name (ARN) of the Amazon ECS container instance that
hosts the job attempt.
$sel:exitCode:AttemptContainerDetail', attemptContainerDetail_exitCode - The exit code for the job attempt. A non-zero exit code is considered
failed.
$sel:logStreamName:AttemptContainerDetail', attemptContainerDetail_logStreamName - The name of the CloudWatch Logs log stream that's associated with the
container. The log group for Batch jobs is /aws/batch/job. Each
container attempt receives a log stream name when they reach the
RUNNING status.
$sel:networkInterfaces:AttemptContainerDetail', attemptContainerDetail_networkInterfaces - The network interfaces that are associated with the job attempt.
$sel:reason:AttemptContainerDetail', attemptContainerDetail_reason - A short (255 max characters) human-readable string to provide additional
details for a running or stopped container.
$sel:taskArn:AttemptContainerDetail', attemptContainerDetail_taskArn - The Amazon Resource Name (ARN) of the Amazon ECS task that's associated
with the job attempt. Each container attempt receives a task ARN when
they reach the STARTING status.
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
data AttemptDetail Source #
An object that represents a job attempt.
See: newAttemptDetail smart constructor.
Constructors
| AttemptDetail' | |
Fields
| |
Instances
newAttemptDetail :: AttemptDetail Source #
Create a value of AttemptDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:container:AttemptDetail', attemptDetail_container - The details for the container in this job attempt.
$sel:startedAt:AttemptDetail', attemptDetail_startedAt - The Unix timestamp (in milliseconds) for when the attempt was started
(when the attempt transitioned from the STARTING state to the
RUNNING state).
$sel:statusReason:AttemptDetail', attemptDetail_statusReason - A short, human-readable string to provide additional details for the
current status of the job attempt.
$sel:stoppedAt:AttemptDetail', attemptDetail_stoppedAt - The Unix timestamp (in milliseconds) for when the attempt was stopped
(when the attempt transitioned from the RUNNING state to a terminal
state, such as SUCCEEDED or FAILED).
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
data ComputeEnvironmentDetail Source #
An object that represents an Batch compute environment.
See: newComputeEnvironmentDetail smart constructor.
Constructors
| ComputeEnvironmentDetail' | |
Fields
| |
Instances
newComputeEnvironmentDetail Source #
Arguments
| :: Text | |
| -> Text | |
| -> ComputeEnvironmentDetail |
Create a value of ComputeEnvironmentDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:computeResources:ComputeEnvironmentDetail', computeEnvironmentDetail_computeResources - The compute resources defined for the compute environment. For more
information, see
Compute environments
in the Batch User Guide.
$sel:containerOrchestrationType:ComputeEnvironmentDetail', computeEnvironmentDetail_containerOrchestrationType - The orchestration type of the compute environment. The valid values are
ECS (default) or EKS.
$sel:ecsClusterArn:ComputeEnvironmentDetail', computeEnvironmentDetail_ecsClusterArn - The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster that
the compute environment uses.
$sel:eksConfiguration:ComputeEnvironmentDetail', computeEnvironmentDetail_eksConfiguration - The configuration for the Amazon EKS cluster that supports the Batch
compute environment. Only specify this parameter if the
containerOrchestrationType is EKS.
$sel:serviceRole:ComputeEnvironmentDetail', computeEnvironmentDetail_serviceRole - The service role that's associated with the compute environment that
allows Batch to make calls to Amazon Web Services API operations on your
behalf. For more information, see
Batch service IAM role
in the Batch User Guide.
$sel:state:ComputeEnvironmentDetail', computeEnvironmentDetail_state - The state of the compute environment. The valid values are ENABLED or
DISABLED.
If the state is ENABLED, then the Batch scheduler can attempt to place
jobs from an associated job queue on the compute resources within the
environment. If the compute environment is managed, then it can scale
its instances out or in automatically based on the job queue demand.
If the state is DISABLED, then the Batch scheduler doesn't attempt to
place jobs within the environment. Jobs in a STARTING or RUNNING
state continue to progress normally. Managed compute environments in the
DISABLED state don't scale out. However, they scale in to minvCpus
value after instances become idle.
$sel:status:ComputeEnvironmentDetail', computeEnvironmentDetail_status - The current status of the compute environment (for example, CREATING
or VALID).
$sel:statusReason:ComputeEnvironmentDetail', computeEnvironmentDetail_statusReason - A short, human-readable string to provide additional details for the
current status of the compute environment.
ComputeEnvironmentDetail, computeEnvironmentDetail_tags - The tags applied to the compute environment.
ComputeEnvironmentDetail, computeEnvironmentDetail_type - The type of the compute environment: MANAGED or UNMANAGED. For more
information, see
Compute environments
in the Batch User Guide.
$sel:unmanagedvCpus:ComputeEnvironmentDetail', computeEnvironmentDetail_unmanagedvCpus - The maximum number of VCPUs expected to be used for an unmanaged compute
environment.
$sel:updatePolicy:ComputeEnvironmentDetail', computeEnvironmentDetail_updatePolicy - Specifies the infrastructure update policy for the compute environment.
For more information about infrastructure updates, see
Updating compute environments
in the Batch User Guide.
$sel:uuid:ComputeEnvironmentDetail', computeEnvironmentDetail_uuid - Unique identifier for the compute environment.
$sel:computeEnvironmentName:ComputeEnvironmentDetail', computeEnvironmentDetail_computeEnvironmentName - The name of the compute environment. It can be up to 128 characters
long. It can contain uppercase and lowercase letters, numbers, hyphens
(-), and underscores (_).
$sel:computeEnvironmentArn:ComputeEnvironmentDetail', computeEnvironmentDetail_computeEnvironmentArn - The Amazon Resource Name (ARN) of the compute environment.
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
data ComputeEnvironmentOrder Source #
The order that compute environments are tried in for job placement
within a queue. Compute environments are tried in ascending order. For
example, if two compute environments are associated with a job queue,
the compute environment with a lower order integer value is tried for
job placement first. Compute environments must be in the VALID state
before you can associate them with a job queue. All of the compute
environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE
or FARGATE_SPOT); EC2 and Fargate compute environments can't be
mixed.
All compute environments that are associated with a job queue must share the same architecture. Batch doesn't support mixing compute environment architecture types in a single job queue.
See: newComputeEnvironmentOrder smart constructor.
Constructors
| ComputeEnvironmentOrder' | |
Fields
| |
Instances
newComputeEnvironmentOrder Source #
Arguments
| :: Int | |
| -> Text | |
| -> ComputeEnvironmentOrder |
Create a value of ComputeEnvironmentOrder with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:order:ComputeEnvironmentOrder', computeEnvironmentOrder_order - The order of the compute environment. Compute environments are tried in
ascending order. For example, if two compute environments are associated
with a job queue, the compute environment with a lower order integer
value is tried for job placement first.
$sel:computeEnvironment:ComputeEnvironmentOrder', computeEnvironmentOrder_computeEnvironment - The Amazon Resource Name (ARN) of the compute environment.
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
data ComputeResource Source #
An object that represents an Batch compute resource. For more information, see Compute environments in the Batch User Guide.
See: newComputeResource smart constructor.
Constructors
| ComputeResource' | |
Fields
| |
Instances
Create a value of ComputeResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:allocationStrategy:ComputeResource', computeResource_allocationStrategy - The allocation strategy to use for the compute resource if not enough
instances of the best fitting instance type can be allocated. This might
be because of availability of the instance type in the Region or
Amazon EC2 service limits.
For more information, see
Allocation strategies
in the Batch User Guide.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- BEST_FIT (default)
- Batch selects an instance type that best fits the needs of the jobs
with a preference for the lowest-cost instance type. If additional
instances of the selected instance type aren't available, Batch
waits for the additional instances to be available. If there aren't
enough instances available or the user is reaching
Amazon EC2 service limits,
additional jobs aren't run until the currently running jobs are
completed. This allocation strategy keeps costs lower but can limit
scaling. If you're using Spot Fleets with
BEST_FIT, the Spot Fleet IAM Role must be specified. Compute resources that use aBEST_FITallocation strategy don't support infrastructure updates and can't update some parameters. For more information, see Updating compute environments in the Batch User Guide. - BEST_FIT_PROGRESSIVE
- Batch selects additional instance types that are large enough to meet the requirements of the jobs in the queue. Its preference is for instance types with lower cost vCPUs. If additional instances of the previously selected instance types aren't available, Batch selects new instance types.
- SPOT_CAPACITY_OPTIMIZED
- Batch selects one or more instance types that are large enough to meet the requirements of the jobs in the queue. Its preference is for instance types that are less likely to be interrupted. This allocation strategy is only available for Spot Instance compute resources.
With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED
strategies using On-Demand or Spot Instances, and the BEST_FIT
strategy using Spot Instances, Batch might need to exceed maxvCpus to
meet your capacity requirements. In this event, Batch never exceeds
maxvCpus by more than a single instance.
$sel:bidPercentage:ComputeResource', computeResource_bidPercentage - The maximum percentage that a Spot Instance price can be when compared
with the On-Demand price for that instance type before instances are
launched. For example, if your maximum percentage is 20%, then the Spot
price must be less than 20% of the current On-Demand price for that
Amazon EC2 instance. You always pay the lowest (market) price and never
more than your maximum percentage. If you leave this field empty, the
default value is 100% of the On-Demand price. For most use cases, we
recommend leaving this field empty.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
$sel:desiredvCpus:ComputeResource', computeResource_desiredvCpus - The desired number of Amazon EC2 vCPUS in the compute environment. Batch
modifies this value between the minimum and maximum values based on job
queue demand.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
$sel:ec2Configuration:ComputeResource', computeResource_ec2Configuration - Provides information that's used to select Amazon Machine Images (AMIs)
for EC2 instances in the compute environment. If Ec2Configuration
isn't specified, the default is ECS_AL2.
One or two values can be provided.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
$sel:ec2KeyPair:ComputeResource', computeResource_ec2KeyPair - The Amazon EC2 key pair that's used for instances launched in the
compute environment. You can use this key pair to log in to your
instances with SSH.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
$sel:imageId:ComputeResource', computeResource_imageId - The Amazon Machine Image (AMI) ID used for instances launched in the
compute environment. This parameter is overridden by the
imageIdOverride member of the Ec2Configuration structure.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer Guide.
$sel:instanceRole:ComputeResource', computeResource_instanceRole - The Amazon ECS instance profile applied to Amazon EC2 instances in a
compute environment. You can specify the short name or full Amazon
Resource Name (ARN) of an instance profile. For example,
ecsInstanceRole or
arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole .
For more information, see
Amazon ECS instance role
in the Batch User Guide.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
$sel:instanceTypes:ComputeResource', computeResource_instanceTypes - The instances types that can be launched. You can specify instance
families to launch any instance type within those families (for example,
c5 or p3), or you can specify specific sizes within a family (such
as c5.8xlarge). You can also choose optimal to select instance types
(from the C4, M4, and R4 instance families) that match the demand of
your job queues.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
When you create a compute environment, the instance types that you select for the compute environment must share the same architecture. For example, you can't mix x86 and ARM instances in the same compute environment.
Currently, optimal uses instance types from the C4, M4, and R4
instance families. In Regions that don't have instance types from those
instance families, instance types from the C5, M5, and R5 instance
families are used.
$sel:launchTemplate:ComputeResource', computeResource_launchTemplate - The launch template to use for your compute resources. Any other compute
resource parameters that you specify in a CreateComputeEnvironment API
operation override the same parameters in the launch template. You must
specify either the launch template ID or launch template name in the
request, but not both. For more information, see
Launch template support
in the Batch User Guide.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
$sel:minvCpus:ComputeResource', computeResource_minvCpus - The minimum number of Amazon EC2 vCPUs that an environment should
maintain (even if the compute environment is DISABLED).
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
$sel:placementGroup:ComputeResource', computeResource_placementGroup - The Amazon EC2 placement group to associate with your compute resources.
If you intend to submit multi-node parallel jobs to your compute
environment, you should consider creating a cluster placement group and
associate it with your compute resources. This keeps your multi-node
parallel job on a logical grouping of instances within a single
Availability Zone with high network flow potential. For more
information, see
Placement groups
in the Amazon EC2 User Guide for Linux Instances.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
$sel:securityGroupIds:ComputeResource', computeResource_securityGroupIds - The Amazon EC2 security groups that are associated with instances
launched in the compute environment. One or more security groups must be
specified, either in securityGroupIds or using a launch template
referenced in launchTemplate. This parameter is required for jobs that
are running on Fargate resources and must contain at least one security
group. Fargate doesn't support launch templates. If security groups are
specified using both securityGroupIds and launchTemplate, the values
in securityGroupIds are used.
$sel:spotIamFleetRole:ComputeResource', computeResource_spotIamFleetRole - The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role
applied to a SPOT compute environment. This role is required if the
allocation strategy set to BEST_FIT or if the allocation strategy
isn't specified. For more information, see
Amazon EC2 spot fleet role
in the Batch User Guide.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
To tag your Spot Instances on creation, the Spot Fleet IAM role specified here must use the newer AmazonEC2SpotFleetTaggingRole managed policy. The previously recommended AmazonEC2SpotFleetRole managed policy doesn't have the required permissions to tag Spot Instances. For more information, see Spot instances not tagged on creation in the Batch User Guide.
$sel:tags:ComputeResource', computeResource_tags - Key-value pair tags to be applied to EC2 resources that are launched in
the compute environment. For Batch, these take the form of
"String1": "String2", where String1 is the tag key and String2
is the tag value-for example,
{ "Name": "Batch Instance - C4OnDemand" }. This is helpful for
recognizing your Batch instances in the Amazon EC2 console. Updating
these tags requires an infrastructure update to the compute environment.
For more information, see
Updating compute environments
in the Batch User Guide. These tags aren't seen when using the Batch
ListTagsForResource API operation.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
$sel:type':ComputeResource', computeResource_type - The type of compute environment: EC2, SPOT, FARGATE, or
FARGATE_SPOT. For more information, see
Compute environments
in the Batch User Guide.
If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet
role with the spotIamFleetRole parameter. For more information, see
Amazon EC2 spot fleet role
in the Batch User Guide.
$sel:maxvCpus:ComputeResource', computeResource_maxvCpus - The maximum number of Amazon EC2 vCPUs that a compute environment can
reach.
With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED
allocation strategies using On-Demand or Spot Instances, and the
BEST_FIT strategy using Spot Instances, Batch might need to exceed
maxvCpus to meet your capacity requirements. In this event, Batch
never exceeds maxvCpus by more than a single instance. For example, no
more than a single instance from among those specified in your compute
environment is allocated.
$sel:subnets:ComputeResource', computeResource_subnets - The VPC subnets where the compute resources are launched. These subnets
must be within the same VPC. Fargate compute resources can contain up to
16 subnets. For more information, see
VPCs and subnets
in the Amazon VPC User Guide.
Batch on Amazon EC2 and Batch on Amazon EKS support Local Zones. For more information, see Local Zones in the Amazon EC2 User Guide for Linux Instances, Amazon EKS and Amazon Web Services Local Zones in the Amazon EKS User Guide and Amazon ECS clusters in Local Zones, Wavelength Zones, and Amazon Web Services Outposts in the Amazon ECS Developer Guide.
Batch on Fargate doesn't currently support Local Zones.
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_FITallocation 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
data ComputeResourceUpdate Source #
An object that represents the attributes of a compute environment that can be updated. For more information, see Updating compute environments in the Batch User Guide.
See: newComputeResourceUpdate smart constructor.
Constructors
| ComputeResourceUpdate' | |
Fields
| |
Instances
newComputeResourceUpdate :: ComputeResourceUpdate Source #
Create a value of ComputeResourceUpdate with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:allocationStrategy:ComputeResourceUpdate', computeResourceUpdate_allocationStrategy - The allocation strategy to use for the compute resource if there's not
enough instances of the best fitting instance type that can be
allocated. This might be because of availability of the instance type in
the Region or
Amazon EC2 service limits.
For more information, see
Allocation strategies
in the Batch User Guide.
When updating a compute environment, changing the allocation strategy
requires an infrastructure update of the compute environment. For more
information, see
Updating compute environments
in the Batch User Guide. BEST_FIT isn't supported when updating a
compute environment.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- BEST_FIT_PROGRESSIVE
- Batch selects additional instance types that are large enough to meet the requirements of the jobs in the queue. Its preference is for instance types with lower cost vCPUs. If additional instances of the previously selected instance types aren't available, Batch selects new instance types.
- SPOT_CAPACITY_OPTIMIZED
- Batch selects one or more instance types that are large enough to meet the requirements of the jobs in the queue. Its preference is for instance types that are less likely to be interrupted. This allocation strategy is only available for Spot Instance compute resources.
With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED
strategies using On-Demand or Spot Instances, and the BEST_FIT
strategy using Spot Instances, Batch might need to exceed maxvCpus to
meet your capacity requirements. In this event, Batch never exceeds
maxvCpus by more than a single instance.
$sel:bidPercentage:ComputeResourceUpdate', computeResourceUpdate_bidPercentage - The maximum percentage that a Spot Instance price can be when compared
with the On-Demand price for that instance type before instances are
launched. For example, if your maximum percentage is 20%, the Spot price
must be less than 20% of the current On-Demand price for that Amazon EC2
instance. You always pay the lowest (market) price and never more than
your maximum percentage. For most use cases, we recommend leaving this
field empty.
When updating a compute environment, changing the bid percentage requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
$sel:desiredvCpus:ComputeResourceUpdate', computeResourceUpdate_desiredvCpus - The desired number of Amazon EC2 vCPUS in the compute environment. Batch
modifies this value between the minimum and maximum values based on job
queue demand.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
Batch doesn't support changing the desired number of vCPUs of an existing compute environment. Don't specify this parameter for compute environments using Amazon EKS clusters.
$sel:ec2Configuration:ComputeResourceUpdate', computeResourceUpdate_ec2Configuration - Provides information used to select Amazon Machine Images (AMIs) for EC2
instances in the compute environment. If Ec2Configuration isn't
specified, the default is ECS_AL2.
When updating a compute environment, changing this setting requires an
infrastructure update of the compute environment. For more information,
see
Updating compute environments
in the Batch User Guide. To remove the EC2 configuration and any
custom AMI ID specified in imageIdOverride, set this value to an empty
string.
One or two values can be provided.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
$sel:ec2KeyPair:ComputeResourceUpdate', computeResourceUpdate_ec2KeyPair - The Amazon EC2 key pair that's used for instances launched in the
compute environment. You can use this key pair to log in to your
instances with SSH. To remove the Amazon EC2 key pair, set this value to
an empty string.
When updating a compute environment, changing the EC2 key pair requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
$sel:imageId:ComputeResourceUpdate', computeResourceUpdate_imageId - The Amazon Machine Image (AMI) ID used for instances launched in the
compute environment. This parameter is overridden by the
imageIdOverride member of the Ec2Configuration structure. To remove
the custom AMI ID and use the default AMI ID, set this value to an empty
string.
When updating a compute environment, changing the AMI ID requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer Guide.
$sel:instanceRole:ComputeResourceUpdate', computeResourceUpdate_instanceRole - The Amazon ECS instance profile applied to Amazon EC2 instances in a
compute environment. You can specify the short name or full Amazon
Resource Name (ARN) of an instance profile. For example,
ecsInstanceRole or
arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole .
For more information, see
Amazon ECS instance role
in the Batch User Guide.
When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
$sel:instanceTypes:ComputeResourceUpdate', computeResourceUpdate_instanceTypes - The instances types that can be launched. You can specify instance
families to launch any instance type within those families (for example,
c5 or p3), or you can specify specific sizes within a family (such
as c5.8xlarge). You can also choose optimal to select instance types
(from the C4, M4, and R4 instance families) that match the demand of
your job queues.
When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
When you create a compute environment, the instance types that you select for the compute environment must share the same architecture. For example, you can't mix x86 and ARM instances in the same compute environment.
Currently, optimal uses instance types from the C4, M4, and R4
instance families. In Regions that don't have instance types from those
instance families, instance types from the C5, M5, and R5 instance
families are used.
$sel:launchTemplate:ComputeResourceUpdate', computeResourceUpdate_launchTemplate - The updated launch template to use for your compute resources. You must
specify either the launch template ID or launch template name in the
request, but not both. For more information, see
Launch template support
in the Batch User Guide. To remove the custom launch template and use
the default launch template, set launchTemplateId or
launchTemplateName member of the launch template specification to an
empty string. Removing the launch template from a compute environment
will not remove the AMI specified in the launch template. In order to
update the AMI specified in a launch template, the
updateToLatestImageVersion parameter must be set to true.
When updating a compute environment, changing the launch template requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
$sel:maxvCpus:ComputeResourceUpdate', computeResourceUpdate_maxvCpus - The maximum number of Amazon EC2 vCPUs that an environment can reach.
With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED
allocation strategies using On-Demand or Spot Instances, and the
BEST_FIT strategy using Spot Instances, Batch might need to exceed
maxvCpus to meet your capacity requirements. In this event, Batch
never exceeds maxvCpus by more than a single instance. That is, no
more than a single instance from among those specified in your compute
environment.
$sel:minvCpus:ComputeResourceUpdate', computeResourceUpdate_minvCpus - The minimum number of Amazon EC2 vCPUs that an environment should
maintain (even if the compute environment is DISABLED).
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
$sel:placementGroup:ComputeResourceUpdate', computeResourceUpdate_placementGroup - The Amazon EC2 placement group to associate with your compute resources.
If you intend to submit multi-node parallel jobs to your compute
environment, you should consider creating a cluster placement group and
associate it with your compute resources. This keeps your multi-node
parallel job on a logical grouping of instances within a single
Availability Zone with high network flow potential. For more
information, see
Placement groups
in the Amazon EC2 User Guide for Linux Instances.
When updating a compute environment, changing the placement group requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
$sel:securityGroupIds:ComputeResourceUpdate', computeResourceUpdate_securityGroupIds - The Amazon EC2 security groups that are associated with instances
launched in the compute environment. This parameter is required for
Fargate compute resources, where it can contain up to 5 security groups.
For Fargate compute resources, providing an empty list is handled as if
this parameter wasn't specified and no change is made. For EC2 compute
resources, providing an empty list removes the security groups from the
compute resource.
When updating a compute environment, changing the EC2 security groups requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.
$sel:subnets:ComputeResourceUpdate', computeResourceUpdate_subnets - The VPC subnets where the compute resources are launched. Fargate
compute resources can contain up to 16 subnets. For Fargate compute
resources, providing an empty list will be handled as if this parameter
wasn't specified and no change is made. For EC2 compute resources,
providing an empty list removes the VPC subnets from the compute
resource. For more information, see
VPCs and subnets
in the Amazon VPC User Guide.
When updating a compute environment, changing the VPC subnets requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.
Batch on Amazon EC2 and Batch on Amazon EKS support Local Zones. For more information, see Local Zones in the Amazon EC2 User Guide for Linux Instances, Amazon EKS and Amazon Web Services Local Zones in the Amazon EKS User Guide and Amazon ECS clusters in Local Zones, Wavelength Zones, and Amazon Web Services Outposts in the Amazon ECS Developer Guide.
Batch on Fargate doesn't currently support Local Zones.
$sel:tags:ComputeResourceUpdate', computeResourceUpdate_tags - Key-value pair tags to be applied to EC2 resources that are launched in
the compute environment. For Batch, these take the form of
"String1": "String2", where String1 is the tag key and String2
is the tag value-for example,
{ "Name": "Batch Instance - C4OnDemand" }. This is helpful for
recognizing your Batch instances in the Amazon EC2 console. These tags
aren't seen when using the Batch ListTagsForResource API operation.
When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
$sel:type':ComputeResourceUpdate', computeResourceUpdate_type - The type of compute environment: EC2, SPOT, FARGATE, or
FARGATE_SPOT. For more information, see
Compute environments
in the Batch User Guide.
If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet
role with the spotIamFleetRole parameter. For more information, see
Amazon EC2 spot fleet role
in the Batch User Guide.
When updating a compute environment, changing the type of a compute environment requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.
$sel:updateToLatestImageVersion:ComputeResourceUpdate', computeResourceUpdate_updateToLatestImageVersion - Specifies whether the AMI ID is updated to the latest one that's
supported by Batch when the compute environment has an infrastructure
update. The default value is false.
An AMI ID can either be specified in the imageId or imageIdOverride
parameters or be determined by the launch template that's specified in
the launchTemplate parameter. If an AMI ID is specified any of these
ways, this parameter is ignored. For more information about to update
AMI IDs during an infrastructure update, see
Updating the AMI ID
in the Batch User Guide.
When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.
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
data ContainerDetail Source #
An object that represents the details of a container that's part of a job.
See: newContainerDetail smart constructor.
Constructors
| ContainerDetail' | |
Fields
| |
Instances
newContainerDetail :: ContainerDetail Source #
Create a value of ContainerDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:command:ContainerDetail', containerDetail_command - The command that's passed to the container.
$sel:containerInstanceArn:ContainerDetail', containerDetail_containerInstanceArn - The Amazon Resource Name (ARN) of the container instance that the
container is running on.
$sel:environment:ContainerDetail', containerDetail_environment - The environment variables to pass to a container.
Environment variables cannot start with "AWS_BATCH". This naming
convention is reserved for variables that Batch sets.
$sel:executionRoleArn:ContainerDetail', containerDetail_executionRoleArn - The Amazon Resource Name (ARN) of the execution role that Batch can
assume. For more information, see
Batch execution IAM role
in the Batch User Guide.
$sel:exitCode:ContainerDetail', containerDetail_exitCode - The exit code to return upon completion.
$sel:fargatePlatformConfiguration:ContainerDetail', containerDetail_fargatePlatformConfiguration - The platform configuration for jobs that are running on Fargate
resources. Jobs that are running on EC2 resources must not specify this
parameter.
$sel:image:ContainerDetail', containerDetail_image - The image used to start the container.
$sel:instanceType:ContainerDetail', containerDetail_instanceType - The instance type of the underlying host infrastructure of a multi-node
parallel job.
This parameter isn't applicable to jobs that are running on Fargate resources.
$sel:jobRoleArn:ContainerDetail', containerDetail_jobRoleArn - The Amazon Resource Name (ARN) that's associated with the job when run.
$sel:linuxParameters:ContainerDetail', containerDetail_linuxParameters - Linux-specific modifications that are applied to the container, such as
details for device mappings.
$sel:logConfiguration:ContainerDetail', containerDetail_logConfiguration - The log configuration specification for the container.
This parameter maps to LogConfig in the
Create a container
section of the
Docker Remote API and the
--log-driver option to
docker run. By default,
containers use the same logging driver that the Docker daemon uses.
However, the container might use a different logging driver than the
Docker daemon by specifying a log driver with this parameter in the
container definition. To use a different logging driver for a container,
the log system must be configured properly on the container instance.
Or, alternatively, it must be configured on a different log server for
remote logging options. For more information on the options for
different supported log drivers, see
Configure logging drivers
in the Docker documentation.
Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers might be available in future releases of the Amazon ECS container agent.
This parameter requires version 1.18 of the Docker Remote API or greater
on your container instance. To check the Docker Remote API version on
your container instance, log in to your container instance and run the
following command: sudo docker version | grep "Server API version"
The Amazon ECS container agent running on a container instance must
register the logging drivers available on that instance with the
ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers
placed on that instance can use these log configuration options. For
more information, see
Amazon ECS container agent configuration
in the Amazon Elastic Container Service Developer Guide.
$sel:logStreamName:ContainerDetail', containerDetail_logStreamName - The name of the Amazon CloudWatch Logs log stream that's associated
with the container. The log group for Batch jobs is /aws/batch/job.
Each container attempt receives a log stream name when they reach the
RUNNING status.
$sel:memory:ContainerDetail', containerDetail_memory - For jobs running on EC2 resources that didn't specify memory
requirements using resourceRequirements, the number of MiB of memory
reserved for the job. For other jobs, including all run on Fargate
resources, see resourceRequirements.
$sel:mountPoints:ContainerDetail', containerDetail_mountPoints - The mount points for data volumes in your container.
$sel:networkConfiguration:ContainerDetail', containerDetail_networkConfiguration - The network configuration for jobs that are running on Fargate
resources. Jobs that are running on EC2 resources must not specify this
parameter.
$sel:networkInterfaces:ContainerDetail', containerDetail_networkInterfaces - The network interfaces that are associated with the job.
$sel:privileged:ContainerDetail', containerDetail_privileged - When this parameter is true, the container is given elevated permissions
on the host container instance (similar to the root user). The default
value is false.
This parameter isn't applicable to jobs that are running on Fargate
resources and shouldn't be provided, or specified as false.
$sel:readonlyRootFilesystem:ContainerDetail', containerDetail_readonlyRootFilesystem - When this parameter is true, the container is given read-only access to
its root file system. This parameter maps to ReadonlyRootfs in the
Create a container
section of the
Docker Remote API and the
--read-only option to
docker run .
$sel:reason:ContainerDetail', containerDetail_reason - A short (255 max characters) human-readable string to provide additional
details for a running or stopped container.
$sel:resourceRequirements:ContainerDetail', containerDetail_resourceRequirements - The type and amount of resources to assign to a container. The supported
resources include GPU, MEMORY, and VCPU.
$sel:secrets:ContainerDetail', containerDetail_secrets - The secrets to pass to the container. For more information, see
Specifying sensitive data
in the Batch User Guide.
$sel:taskArn:ContainerDetail', containerDetail_taskArn - The Amazon Resource Name (ARN) of the Amazon ECS task that's associated
with the container job. Each container attempt receives a task ARN when
they reach the STARTING status.
$sel:ulimits:ContainerDetail', containerDetail_ulimits - A list of ulimit values to set in the container. This parameter maps
to Ulimits in the
Create a container
section of the
Docker Remote API and the
--ulimit option to
docker run.
This parameter isn't applicable to jobs that are running on Fargate resources.
$sel:user:ContainerDetail', containerDetail_user - The user name to use inside the container. This parameter maps to User
in the
Create a container
section of the
Docker Remote API and the
--user option to
docker run.
$sel:vcpus:ContainerDetail', containerDetail_vcpus - The number of vCPUs reserved for the container. For jobs that run on EC2
resources, you can specify the vCPU requirement for the job using
resourceRequirements, but you can't specify the vCPU requirements in
both the vcpus and resourceRequirements object. This parameter maps
to CpuShares in the
Create a container
section of the
Docker Remote API and the
--cpu-shares option to
docker run. Each vCPU is
equivalent to 1,024 CPU shares. You must specify at least one vCPU. This
is required but can be specified in several places. It must be specified
for each node at least once.
This parameter isn't applicable to jobs that run on Fargate resources.
For jobs that run on Fargate resources, you must specify the vCPU
requirement for the job using resourceRequirements.
$sel:volumes:ContainerDetail', containerDetail_volumes - A list of volumes that are associated with the job.
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
data ContainerOverrides Source #
The overrides that should be sent to a container.
See: newContainerOverrides smart constructor.
Constructors
| ContainerOverrides' | |
Fields
| |
Instances
newContainerOverrides :: ContainerOverrides Source #
Create a value of ContainerOverrides with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:command:ContainerOverrides', containerOverrides_command - The command to send to the container that overrides the default command
from the Docker image or the job definition.
$sel:environment:ContainerOverrides', containerOverrides_environment - The environment variables to send to the container. You can add new
environment variables, which are added to the container at launch, or
you can override the existing environment variables from the Docker
image or the job definition.
Environment variables cannot start with "AWS_BATCH". This naming
convention is reserved for variables that Batch sets.
$sel:instanceType:ContainerOverrides', containerOverrides_instanceType - The instance type to use for a multi-node parallel job.
This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.
$sel:memory:ContainerOverrides', containerOverrides_memory - This parameter is deprecated, use resourceRequirements to override the
memory requirements specified in the job definition. It's not supported
for jobs running on Fargate resources. For jobs that run on EC2
resources, it overrides the memory parameter set in the job
definition, but doesn't override any memory requirement that's
specified in the resourceRequirements structure in the job definition.
To override memory requirements that are specified in the
resourceRequirements structure in the job definition,
resourceRequirements must be specified in the SubmitJob request,
with type set to MEMORY and value set to the new value. For more
information, see
Can't override job definition resource requirements
in the Batch User Guide.
$sel:resourceRequirements:ContainerOverrides', containerOverrides_resourceRequirements - The type and amount of resources to assign to a container. This
overrides the settings in the job definition. The supported resources
include GPU, MEMORY, and VCPU.
$sel:vcpus:ContainerOverrides', containerOverrides_vcpus - This parameter is deprecated, use resourceRequirements to override the
vcpus parameter that's set in the job definition. It's not supported
for jobs running on Fargate resources. For jobs that run on EC2
resources, it overrides the vcpus parameter set in the job definition,
but doesn't override any vCPU requirement specified in the
resourceRequirements structure in the job definition. To override vCPU
requirements that are specified in the resourceRequirements structure
in the job definition, resourceRequirements must be specified in the
SubmitJob request, with type set to VCPU and value set to the
new value. For more information, see
Can't override job definition resource requirements
in the Batch User Guide.
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
data ContainerProperties Source #
Container properties are used for Amazon ECS based job definitions. These properties to describe the container that's launched as part of a job.
See: newContainerProperties smart constructor.
Constructors
| ContainerProperties' | |
Fields
| |
Instances
newContainerProperties :: ContainerProperties Source #
Create a value of ContainerProperties with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:command:ContainerProperties', containerProperties_command - The command that's passed to the container. This parameter maps to
Cmd in the
Create a container
section of the
Docker Remote API and the
COMMAND parameter to
docker run. For more
information, see
https://docs.docker.com/engine/reference/builder/#cmd.
$sel:environment:ContainerProperties', containerProperties_environment - The environment variables to pass to a container. This parameter maps to
Env in the
Create a container
section of the
Docker Remote API and the
--env option to
docker run.
We don't recommend using plaintext environment variables for sensitive information, such as credential data.
Environment variables cannot start with "AWS_BATCH". This naming
convention is reserved for variables that Batch sets.
$sel:executionRoleArn:ContainerProperties', containerProperties_executionRoleArn - The Amazon Resource Name (ARN) of the execution role that Batch can
assume. For jobs that run on Fargate resources, you must provide an
execution role. For more information, see
Batch execution IAM role
in the Batch User Guide.
$sel:fargatePlatformConfiguration:ContainerProperties', containerProperties_fargatePlatformConfiguration - The platform configuration for jobs that are running on Fargate
resources. Jobs that are running on EC2 resources must not specify this
parameter.
$sel:image:ContainerProperties', containerProperties_image - The image used to start a container. This string is passed directly to
the Docker daemon. Images in the Docker Hub registry are available by
default. Other repositories are specified with
repository-url/image:tag . It can be 255
characters long. It can contain uppercase and lowercase letters,
numbers, hyphens (-), underscores (_), colons (:), periods (.), forward
slashes (/), and number signs (#). This parameter maps to Image in
the
Create a container
section of the
Docker Remote API and the
IMAGE parameter of
docker run.
Docker image architecture must match the processor architecture of the compute resources that they're scheduled on. For example, ARM-based Docker images can only run on ARM-based compute resources.
- Images in Amazon ECR Public repositories use the full
registry/repository[:tag]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,
ubuntuormongo). - Images in other repositories on Docker Hub are qualified with an
organization name (for example,
amazon/amazon-ecs-agent). - Images in other online repositories are qualified further by a
domain name (for example,
quay.io/assemblyline/ubuntu).
$sel:instanceType:ContainerProperties', containerProperties_instanceType - The instance type to use for a multi-node parallel job. All node groups
in a multi-node parallel job must use the same instance type.
This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.
$sel:jobRoleArn:ContainerProperties', containerProperties_jobRoleArn - The Amazon Resource Name (ARN) of the IAM role that the container can
assume for Amazon Web Services permissions. For more information, see
IAM roles for tasks
in the Amazon Elastic Container Service Developer Guide.
$sel:linuxParameters:ContainerProperties', containerProperties_linuxParameters - Linux-specific modifications that are applied to the container, such as
details for device mappings.
$sel:logConfiguration:ContainerProperties', containerProperties_logConfiguration - The log configuration specification for the container.
This parameter maps to LogConfig in the
Create a container
section of the
Docker Remote API and the
--log-driver option to
docker run. By default,
containers use the same logging driver that the Docker daemon uses.
However the container might use a different logging driver than the
Docker daemon by specifying a log driver with this parameter in the
container definition. To use a different logging driver for a container,
the log system must be configured properly on the container instance (or
on a different log server for remote logging options). For more
information on the options for different supported log drivers, see
Configure logging drivers
in the Docker documentation.
Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type).
This parameter requires version 1.18 of the Docker Remote API or greater
on your container instance. To check the Docker Remote API version on
your container instance, log in to your container instance and run the
following command: sudo docker version | grep "Server API version"
The Amazon ECS container agent running on a container instance must
register the logging drivers available on that instance with the
ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers
placed on that instance can use these log configuration options. For
more information, see
Amazon ECS container agent configuration
in the Amazon Elastic Container Service Developer Guide.
$sel:memory:ContainerProperties', containerProperties_memory - This parameter is deprecated, use resourceRequirements to specify the
memory requirements for the job definition. It's not supported for jobs
running on Fargate resources. For jobs that run on EC2 resources, it
specifies the memory hard limit (in MiB) for a container. If your
container attempts to exceed the specified number, it's terminated. You
must specify at least 4 MiB of memory for a job using this parameter.
The memory hard limit can be specified in several places. It must be
specified for each node at least once.
$sel:mountPoints:ContainerProperties', containerProperties_mountPoints - The mount points for data volumes in your container. This parameter maps
to Volumes in the
Create a container
section of the
Docker Remote API and the
--volume option to
docker run.
$sel:networkConfiguration:ContainerProperties', containerProperties_networkConfiguration - The network configuration for jobs that are running on Fargate
resources. Jobs that are running on EC2 resources must not specify this
parameter.
$sel:privileged:ContainerProperties', containerProperties_privileged - When this parameter is true, the container is given elevated permissions
on the host container instance (similar to the root user). This
parameter maps to Privileged in the
Create a container
section of the
Docker Remote API and the
--privileged option to
docker run. The default
value is false.
This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or specified as false.
$sel:readonlyRootFilesystem:ContainerProperties', containerProperties_readonlyRootFilesystem - When this parameter is true, the container is given read-only access to
its root file system. This parameter maps to ReadonlyRootfs in the
Create a container
section of the
Docker Remote API and the
--read-only option to docker run.
$sel:resourceRequirements:ContainerProperties', containerProperties_resourceRequirements - The type and amount of resources to assign to a container. The supported
resources include GPU, MEMORY, and VCPU.
$sel:secrets:ContainerProperties', containerProperties_secrets - The secrets for the container. For more information, see
Specifying sensitive data
in the Batch User Guide.
$sel:ulimits:ContainerProperties', containerProperties_ulimits - A list of ulimits to set in the container. This parameter maps to
Ulimits in the
Create a container
section of the
Docker Remote API and the
--ulimit option to
docker run.
This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
$sel:user:ContainerProperties', containerProperties_user - The user name to use inside the container. This parameter maps to User
in the
Create a container
section of the
Docker Remote API and the
--user option to
docker run.
$sel:vcpus:ContainerProperties', containerProperties_vcpus - This parameter is deprecated, use resourceRequirements to specify the
vCPU requirements for the job definition. It's not supported for jobs
running on Fargate resources. For jobs running on EC2 resources, it
specifies the number of vCPUs reserved for the job.
Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to
CpuShares in the
Create a container
section of the
Docker Remote API and the
--cpu-shares option to
docker run. The number
of vCPUs must be specified but can be specified in several places. You
must specify it at least once for each node.
$sel:volumes:ContainerProperties', containerProperties_volumes - A list of data volumes used in a job.
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,
ubuntuormongo). - 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
data ContainerSummary Source #
An object that represents summary details of a container within a job.
See: newContainerSummary smart constructor.
Constructors
| ContainerSummary' | |
Instances
newContainerSummary :: ContainerSummary Source #
Create a value of ContainerSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:exitCode:ContainerSummary', containerSummary_exitCode - The exit code to return upon completion.
$sel:reason:ContainerSummary', containerSummary_reason - A short (255 max characters) human-readable string to provide additional
details for a running or stopped container.
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
An object that represents a container instance host device.
This object isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
See: newDevice smart constructor.
Constructors
| Device' | |
Fields
| |
Instances
| FromJSON Device Source # | |
| ToJSON Device Source # | |
Defined in Amazonka.Batch.Types.Device | |
| Generic Device Source # | |
| Read Device Source # | |
| Show Device Source # | |
| NFData Device Source # | |
Defined in Amazonka.Batch.Types.Device | |
| Eq Device Source # | |
| Hashable Device Source # | |
Defined in Amazonka.Batch.Types.Device | |
| type Rep Device Source # | |
Defined in Amazonka.Batch.Types.Device type Rep Device = D1 ('MetaData "Device" "Amazonka.Batch.Types.Device" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "Device'" 'PrefixI 'True) (S1 ('MetaSel ('Just "containerPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "permissions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DeviceCgroupPermission])) :*: S1 ('MetaSel ('Just "hostPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) | |
Create a value of Device with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:containerPath:Device', device_containerPath - The path inside the container that's used to expose the host device. By
default, the hostPath value is used.
$sel:permissions:Device', device_permissions - The explicit permissions to provide to the container for the device. By
default, the container has permissions for read, write, and mknod
for the device.
$sel:hostPath:Device', device_hostPath - The path for the device on the host container instance.
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
data EFSAuthorizationConfig Source #
The authorization configuration details for the Amazon EFS file system.
See: newEFSAuthorizationConfig smart constructor.
Constructors
| EFSAuthorizationConfig' | |
Fields
| |
Instances
newEFSAuthorizationConfig :: EFSAuthorizationConfig Source #
Create a value of EFSAuthorizationConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessPointId:EFSAuthorizationConfig', eFSAuthorizationConfig_accessPointId - The Amazon EFS access point ID to use. If an access point is specified,
the root directory value specified in the EFSVolumeConfiguration must
either be omitted or set to / which enforces the path set on the EFS
access point. If an access point is used, transit encryption must be
enabled in the EFSVolumeConfiguration. For more information, see
Working with Amazon EFS access points
in the Amazon Elastic File System User Guide.
$sel:iam:EFSAuthorizationConfig', eFSAuthorizationConfig_iam - Whether or not to use the Batch job IAM role defined in a job definition
when mounting the Amazon EFS file system. If enabled, transit encryption
must be enabled in the EFSVolumeConfiguration. If this parameter is
omitted, the default value of DISABLED is used. For more information,
see
Using Amazon EFS access points
in the Batch User Guide. EFS IAM authorization requires that
TransitEncryption be ENABLED and that a JobRoleArn is specified.
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
data EFSVolumeConfiguration Source #
This is used when you're using an Amazon Elastic File System file system for job storage. For more information, see Amazon EFS Volumes in the Batch User Guide.
See: newEFSVolumeConfiguration smart constructor.
Constructors
| EFSVolumeConfiguration' | |
Fields
| |
Instances
newEFSVolumeConfiguration Source #
Create a value of EFSVolumeConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:authorizationConfig:EFSVolumeConfiguration', eFSVolumeConfiguration_authorizationConfig - The authorization configuration details for the Amazon EFS file system.
$sel:rootDirectory:EFSVolumeConfiguration', eFSVolumeConfiguration_rootDirectory - The directory within the Amazon EFS file system to mount as the root
directory inside the host. If this parameter is omitted, the root of the
Amazon EFS volume is used instead. Specifying / has the same effect
as omitting this parameter. The maximum length is 4,096 characters.
If an EFS access point is specified in the authorizationConfig, the
root directory parameter must either be omitted or set to /, which
enforces the path set on the Amazon EFS access point.
$sel:transitEncryption:EFSVolumeConfiguration', eFSVolumeConfiguration_transitEncryption - Determines whether to enable encryption for Amazon EFS data in transit
between the Amazon ECS host and the Amazon EFS server. Transit
encryption must be enabled if Amazon EFS IAM authorization is used. If
this parameter is omitted, the default value of DISABLED is used. For
more information, see
Encrypting data in transit
in the Amazon Elastic File System User Guide.
$sel:transitEncryptionPort:EFSVolumeConfiguration', eFSVolumeConfiguration_transitEncryptionPort - The port to use when sending encrypted data between the Amazon ECS host
and the Amazon EFS server. If you don't specify a transit encryption
port, it uses the port selection strategy that the Amazon EFS mount
helper uses. The value must be between 0 and 65,535. For more
information, see
EFS mount helper
in the Amazon Elastic File System User Guide.
$sel:fileSystemId:EFSVolumeConfiguration', eFSVolumeConfiguration_fileSystemId - The Amazon EFS file system ID to use.
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
data Ec2Configuration Source #
Provides information used to select Amazon Machine Images (AMIs) for
instances in the compute environment. If Ec2Configuration isn't
specified, the default is ECS_AL2
(Amazon Linux 2).
This object isn't applicable to jobs that are running on Fargate resources.
See: newEc2Configuration smart constructor.
Constructors
| Ec2Configuration' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Ec2Configuration |
Create a value of Ec2Configuration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:imageIdOverride:Ec2Configuration', ec2Configuration_imageIdOverride - The AMI ID used for instances launched in the compute environment that
match the image type. This setting overrides the imageId set in the
computeResource object.
The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer Guide.
$sel:imageKubernetesVersion:Ec2Configuration', ec2Configuration_imageKubernetesVersion - The Kubernetes version for the compute environment. If you don't
specify a value, the latest version that Batch supports is used.
$sel:imageType:Ec2Configuration', ec2Configuration_imageType - The image type to match with the instance type to select an AMI. The
supported values are different for ECS and EKS resources.
- ECS
- If the
imageIdOverrideparameter 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 animageIdnor aimageIdOverrideparameter 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
P4andG4) 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
imageIdOverrideparameter 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 animageIdnor aimageIdOverrideparameter 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,
P4andG4) and can be used for all non Amazon Web Services Graviton-based instance types.
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
imageIdOverrideparameter 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 animageIdnor aimageIdOverrideparameter 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
P4andG4) 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
imageIdOverrideparameter 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 animageIdnor aimageIdOverrideparameter 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,
P4andG4) and can be used for all non Amazon Web Services Graviton-based instance types.
EksAttemptContainerDetail
data EksAttemptContainerDetail Source #
An object that represents the details for an attempt for a job attempt that an Amazon EKS container runs.
See: newEksAttemptContainerDetail smart constructor.
Constructors
| EksAttemptContainerDetail' | |
Instances
newEksAttemptContainerDetail :: EksAttemptContainerDetail Source #
Create a value of EksAttemptContainerDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:exitCode:EksAttemptContainerDetail', eksAttemptContainerDetail_exitCode - The exit code for the job attempt. A non-zero exit code is considered
failed.
$sel:reason:EksAttemptContainerDetail', eksAttemptContainerDetail_reason - A short (255 max characters) human-readable string to provide additional
details for a running or stopped container.
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
data EksAttemptDetail Source #
An object that represents the details of a job attempt for a job attempt by an Amazon EKS container.
See: newEksAttemptDetail smart constructor.
Constructors
| EksAttemptDetail' | |
Fields
| |
Instances
newEksAttemptDetail :: EksAttemptDetail Source #
Create a value of EksAttemptDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:containers:EksAttemptDetail', eksAttemptDetail_containers - The details for the final status of the containers for this job attempt.
$sel:nodeName:EksAttemptDetail', eksAttemptDetail_nodeName - The name of the node for this job attempt.
$sel:podName:EksAttemptDetail', eksAttemptDetail_podName - The name of the pod for this job attempt.
$sel:startedAt:EksAttemptDetail', eksAttemptDetail_startedAt - The Unix timestamp (in milliseconds) for when the attempt was started
(when the attempt transitioned from the STARTING state to the
RUNNING state).
$sel:statusReason:EksAttemptDetail', eksAttemptDetail_statusReason - A short, human-readable string to provide additional details for the
current status of the job attempt.
$sel:stoppedAt:EksAttemptDetail', eksAttemptDetail_stoppedAt - The Unix timestamp (in milliseconds) for when the attempt was stopped.
This happens when the attempt transitioned from the RUNNING state to a
terminal state, such as SUCCEEDED or FAILED.
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
data EksConfiguration Source #
Configuration for the Amazon EKS cluster that supports the Batch compute environment. The cluster must exist before the compute environment can be created.
See: newEksConfiguration smart constructor.
Constructors
| EksConfiguration' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> EksConfiguration |
Create a value of EksConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eksClusterArn:EksConfiguration', eksConfiguration_eksClusterArn - The Amazon Resource Name (ARN) of the Amazon EKS cluster. An example is
arn:aws:eks:us-east-1:123456789012:cluster/ClusterForBatch .
$sel:kubernetesNamespace:EksConfiguration', eksConfiguration_kubernetesNamespace - The namespace of the Amazon EKS cluster. Batch manages pods in this
namespace. The value can't left empty or null. It must be fewer than 64
characters long, can't be set to default, can't start with
"kube-," and must match this regular expression:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?$. For more information, see
Namespaces
in the Kubernetes documentation.
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
data EksContainer Source #
EKS container properties are used in job definitions for Amazon EKS based job definitions to describe the properties for a container node in the pod that's launched as part of a job. This can't be specified for Amazon ECS based job definitions.
See: newEksContainer smart constructor.
Constructors
| EksContainer' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> EksContainer |
Create a value of EksContainer with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:args:EksContainer', eksContainer_args - An array of arguments to the entrypoint. If this isn't specified, the
CMD of the container image is used. This corresponds to the args
member in the
Entrypoint
portion of the
Pod
in Kubernetes. Environment variable references are expanded using the
container's environment.
If the referenced environment variable doesn't exist, the reference in
the command isn't changed. For example, if the reference is to
"$(NAME1)" and the NAME1 environment variable doesn't exist, the
command string will remain "$(NAME1)." $$ is replaced with $,
and the resulting string isn't expanded. For example, $$(VAR_NAME) is
passed as $(VAR_NAME) whether or not the VAR_NAME environment
variable exists. For more information, see
CMD in the
Dockerfile reference and
Define a command and arguments for a pod
in the Kubernetes documentation.
$sel:command:EksContainer', eksContainer_command - The entrypoint for the container. This isn't run within a shell. If
this isn't specified, the ENTRYPOINT of the container image is used.
Environment variable references are expanded using the container's
environment.
If the referenced environment variable doesn't exist, the reference in
the command isn't changed. For example, if the reference is to
"$(NAME1)" and the NAME1 environment variable doesn't exist, the
command string will remain "$(NAME1)." $$ is replaced with $ and
the resulting string isn't expanded. For example, $$(VAR_NAME) will
be passed as $(VAR_NAME) whether or not the VAR_NAME environment
variable exists. The entrypoint can't be updated. For more information,
see
ENTRYPOINT
in the Dockerfile reference and
Define a command and arguments for a container
and
Entrypoint
in the Kubernetes documentation.
$sel:env:EksContainer', eksContainer_env - The environment variables to pass to a container.
Environment variables cannot start with "AWS_BATCH". This naming
convention is reserved for variables that Batch sets.
$sel:imagePullPolicy:EksContainer', eksContainer_imagePullPolicy - The image pull policy for the container. Supported values are Always,
IfNotPresent, and Never. This parameter defaults to IfNotPresent.
However, if the :latest tag is specified, it defaults to Always. For
more information, see
Updating images
in the Kubernetes documentation.
EksContainer, eksContainer_name - The name of the container. If the name isn't specified, the default
name "Default" is used. Each container in a pod must have a unique
name.
$sel:resources:EksContainer', eksContainer_resources - The type and amount of resources to assign to a container. The supported
resources include memory, cpu, and nvidia.com/gpu. For more
information, see
Resource management for pods and containers
in the Kubernetes documentation.
$sel:securityContext:EksContainer', eksContainer_securityContext - The security context for a job. For more information, see
Configure a security context for a pod or container
in the Kubernetes documentation.
$sel:volumeMounts:EksContainer', eksContainer_volumeMounts - The volume mounts for the container. Batch supports emptyDir,
hostPath, and secret volume types. For more information about
volumes and volume mounts in Kubernetes, see
Volumes in the
Kubernetes documentation.
$sel:image:EksContainer', eksContainer_image - The Docker image used to start the container.
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
data EksContainerDetail Source #
The details for container properties that are returned by DescribeJobs
for jobs that use Amazon EKS.
See: newEksContainerDetail smart constructor.
Constructors
| EksContainerDetail' | |
Fields
| |
Instances
newEksContainerDetail :: EksContainerDetail Source #
Create a value of EksContainerDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:args:EksContainerDetail', eksContainerDetail_args - An array of arguments to the entrypoint. If this isn't specified, the
CMD of the container image is used. This corresponds to the args
member in the
Entrypoint
portion of the
Pod
in Kubernetes. Environment variable references are expanded using the
container's environment.
If the referenced environment variable doesn't exist, the reference in
the command isn't changed. For example, if the reference is to
"$(NAME1)" and the NAME1 environment variable doesn't exist, the
command string will remain "$(NAME1)". $$ is replaced with $ and
the resulting string isn't expanded. For example, $$(VAR_NAME) is
passed as $(VAR_NAME) whether or not the VAR_NAME environment
variable exists. For more information, see
CMD in the
Dockerfile reference and
Define a command and arguments for a pod
in the Kubernetes documentation.
$sel:command:EksContainerDetail', eksContainerDetail_command - The entrypoint for the container. For more information, see
Entrypoint
in the Kubernetes documentation.
$sel:env:EksContainerDetail', eksContainerDetail_env - The environment variables to pass to a container.
Environment variables cannot start with "AWS_BATCH". This naming
convention is reserved for variables that Batch sets.
$sel:exitCode:EksContainerDetail', eksContainerDetail_exitCode - The exit code for the job attempt. A non-zero exit code is considered
failed.
$sel:image:EksContainerDetail', eksContainerDetail_image - The Docker image used to start the container.
$sel:imagePullPolicy:EksContainerDetail', eksContainerDetail_imagePullPolicy - The image pull policy for the container. Supported values are Always,
IfNotPresent, and Never. This parameter defaults to Always if the
:latest tag is specified, IfNotPresent otherwise. For more
information, see
Updating images
in the Kubernetes documentation.
EksContainerDetail, eksContainerDetail_name - The name of the container. If the name isn't specified, the default
name "Default" is used. Each container in a pod must have a unique
name.
$sel:reason:EksContainerDetail', eksContainerDetail_reason - A short human-readable string to provide additional details for a
running or stopped container. It can be up to 255 characters long.
$sel:resources:EksContainerDetail', eksContainerDetail_resources - The type and amount of resources to assign to a container. The supported
resources include memory, cpu, and nvidia.com/gpu. For more
information, see
Resource management for pods and containers
in the Kubernetes documentation.
$sel:securityContext:EksContainerDetail', eksContainerDetail_securityContext - The security context for a job. For more information, see
Configure a security context for a pod or container
in the Kubernetes documentation.
$sel:volumeMounts:EksContainerDetail', eksContainerDetail_volumeMounts - The volume mounts for the container. Batch supports emptyDir,
hostPath, and secret volume types. For more information about
volumes and volume mounts in Kubernetes, see
Volumes in the
Kubernetes documentation.
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
data EksContainerEnvironmentVariable Source #
An environment variable.
See: newEksContainerEnvironmentVariable smart constructor.
Constructors
| EksContainerEnvironmentVariable' | |
Instances
newEksContainerEnvironmentVariable Source #
Create a value of EksContainerEnvironmentVariable with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:EksContainerEnvironmentVariable', eksContainerEnvironmentVariable_value - The value of the environment variable.
$sel:name:EksContainerEnvironmentVariable', eksContainerEnvironmentVariable_name - The name of the environment variable.
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
data EksContainerOverride Source #
Object representing any Kubernetes overrides to a job definition that's used in a SubmitJob API operation.
See: newEksContainerOverride smart constructor.
Constructors
| EksContainerOverride' | |
Fields
| |
Instances
newEksContainerOverride :: EksContainerOverride Source #
Create a value of EksContainerOverride with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:args:EksContainerOverride', eksContainerOverride_args - The arguments to the entrypoint to send to the container that overrides
the default arguments from the Docker image or the job definition. For
more information, see
CMD in the
Dockerfile reference and
Define a command an arguments for a pod
in the Kubernetes documentation.
$sel:command:EksContainerOverride', eksContainerOverride_command - The command to send to the container that overrides the default command
from the Docker image or the job definition.
$sel:env:EksContainerOverride', eksContainerOverride_env - The environment variables to send to the container. You can add new
environment variables, which are added to the container at launch. Or,
you can override the existing environment variables from the Docker
image or the job definition.
Environment variables cannot start with "AWS_BATCH". This naming
convention is reserved for variables that Batch sets.
$sel:image:EksContainerOverride', eksContainerOverride_image - The override of the Docker image that's used to start the container.
$sel:resources:EksContainerOverride', eksContainerOverride_resources - The type and amount of resources to assign to a container. These
override the settings in the job definition. The supported resources
include memory, cpu, and nvidia.com/gpu. For more information,
see
Resource management for pods and containers
in the Kubernetes documentation.
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
data EksContainerResourceRequirements Source #
The type and amount of resources to assign to a container. The supported
resources include memory, cpu, and nvidia.com/gpu. For more
information, see
Resource management for pods and containers
in the Kubernetes documentation.
See: newEksContainerResourceRequirements smart constructor.
Constructors
| EksContainerResourceRequirements' | |
Fields
| |
Instances
newEksContainerResourceRequirements :: EksContainerResourceRequirements Source #
Create a value of EksContainerResourceRequirements with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:limits:EksContainerResourceRequirements', eksContainerResourceRequirements_limits - The type and quantity of the resources to reserve for the container. The
values vary based on the name that's specified. Resources can be
requested using either the limits or the requests objects.
- memory
- The memory hard limit (in MiB) for the container, using whole
integers, with a "Mi" suffix. If your container attempts to exceed
the memory specified, the container is terminated. You must specify
at least 4 MiB of memory for a job.
memorycan be specified inlimits,requests, or both. Ifmemoryis specified in both places, then the value that's specified inlimitsmust 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.cpucan be specified inlimits,requests, or both. Ifcpuis specified in both places, then the value that's specified inlimitsmust 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.
memorycan be specified inlimits,requests, or both. Ifmemoryis specified in both places, then the value that's specified inlimitsmust be equal to the value that's specified inrequests.
$sel:requests:EksContainerResourceRequirements', eksContainerResourceRequirements_requests - The type and quantity of the resources to request for the container. The
values vary based on the name that's specified. Resources can be
requested by using either the limits or the requests objects.
- memory
- The memory hard limit (in MiB) for the container, using whole
integers, with a "Mi" suffix. If your container attempts to exceed
the memory specified, the container is terminated. You must specify
at least 4 MiB of memory for a job.
memorycan be specified inlimits,requests, or both. Ifmemoryis specified in both, then the value that's specified inlimitsmust 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.cpucan be specified inlimits,requests, or both. Ifcpuis specified in both, then the value that's specified inlimitsmust 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/gpucan be specified inlimits,requests, or both. Ifnvidia.com/gpuis specified in both, then the value that's specified inlimitsmust be equal to the value that's specified inrequests.
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.
memorycan be specified inlimits,requests, or both. Ifmemoryis specified in both places, then the value that's specified inlimitsmust 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.cpucan be specified inlimits,requests, or both. Ifcpuis specified in both places, then the value that's specified inlimitsmust 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.
memorycan be specified inlimits,requests, or both. Ifmemoryis specified in both places, then the value that's specified inlimitsmust 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.
memorycan be specified inlimits,requests, or both. Ifmemoryis specified in both, then the value that's specified inlimitsmust 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.cpucan be specified inlimits,requests, or both. Ifcpuis specified in both, then the value that's specified inlimitsmust 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/gpucan be specified inlimits,requests, or both. Ifnvidia.com/gpuis specified in both, then the value that's specified inlimitsmust be equal to the value that's specified inrequests.
EksContainerSecurityContext
data EksContainerSecurityContext Source #
The security context for a job. For more information, see Configure a security context for a pod or container in the Kubernetes documentation.
See: newEksContainerSecurityContext smart constructor.
Constructors
| EksContainerSecurityContext' | |
Fields
| |
Instances
newEksContainerSecurityContext :: EksContainerSecurityContext Source #
Create a value of EksContainerSecurityContext with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:privileged:EksContainerSecurityContext', eksContainerSecurityContext_privileged - When this parameter is true, the container is given elevated
permissions on the host container instance. The level of permissions are
similar to the root user permissions. The default value is false.
This parameter maps to privileged policy in the
Privileged pod security policies
in the Kubernetes documentation.
$sel:readOnlyRootFilesystem:EksContainerSecurityContext', eksContainerSecurityContext_readOnlyRootFilesystem - When this parameter is true, the container is given read-only access
to its root file system. The default value is false. This parameter
maps to ReadOnlyRootFilesystem policy in the
Volumes and file systems pod security policies
in the Kubernetes documentation.
$sel:runAsGroup:EksContainerSecurityContext', eksContainerSecurityContext_runAsGroup - When this parameter is specified, the container is run as the specified
group ID (gid). If this parameter isn't specified, the default is the
group that's specified in the image metadata. This parameter maps to
RunAsGroup and MustRunAs policy in the
Users and groups pod security policies
in the Kubernetes documentation.
$sel:runAsNonRoot:EksContainerSecurityContext', eksContainerSecurityContext_runAsNonRoot - When this parameter is specified, the container is run as a user with a
uid other than 0. If this parameter isn't specified, so such rule is
enforced. This parameter maps to RunAsUser and MustRunAsNonRoot
policy in the
Users and groups pod security policies
in the Kubernetes documentation.
$sel:runAsUser:EksContainerSecurityContext', eksContainerSecurityContext_runAsUser - When this parameter is specified, the container is run as the specified
user ID (uid). If this parameter isn't specified, the default is the
user that's specified in the image metadata. This parameter maps to
RunAsUser and MustRanAs policy in the
Users and groups pod security policies
in the Kubernetes documentation.
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
data EksContainerVolumeMount Source #
The volume mounts for a container for an Amazon EKS job. For more information about volumes and volume mounts in Kubernetes, see Volumes in the Kubernetes documentation.
See: newEksContainerVolumeMount smart constructor.
Constructors
| EksContainerVolumeMount' | |
Fields
| |
Instances
newEksContainerVolumeMount :: EksContainerVolumeMount Source #
Create a value of EksContainerVolumeMount with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:mountPath:EksContainerVolumeMount', eksContainerVolumeMount_mountPath - The path on the container where the volume is mounted.
$sel:name:EksContainerVolumeMount', eksContainerVolumeMount_name - The name the volume mount. This must match the name of one of the
volumes in the pod.
$sel:readOnly:EksContainerVolumeMount', eksContainerVolumeMount_readOnly - If this value is true, the container has read-only access to the
volume. Otherwise, the container can write to the volume. The default
value is false.
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
data EksEmptyDir Source #
Specifies the configuration of a Kubernetes emptyDir volume. An
emptyDir volume is first created when a pod is assigned to a node. It
exists as long as that pod is running on that node. The emptyDir
volume is initially empty. All containers in the pod can read and write
the files in the emptyDir volume. However, the emptyDir volume can
be mounted at the same or different paths in each container. When a pod
is removed from a node for any reason, the data in the emptyDir is
deleted permanently. For more information, see
emptyDir
in the Kubernetes documentation.
See: newEksEmptyDir smart constructor.
Constructors
| EksEmptyDir' | |
Fields
| |
Instances
newEksEmptyDir :: EksEmptyDir Source #
Create a value of EksEmptyDir with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:medium:EksEmptyDir', eksEmptyDir_medium - The medium to store the volume. The default value is an empty string,
which uses the storage of the node.
- ""
- (Default) Use the disk storage of the node.
- "Memory"
- Use the
tmpfsvolume that's backed by the RAM of the node. Contents of the volume are lost when the node reboots, and any storage on the volume counts against the container's memory limit.
$sel:sizeLimit:EksEmptyDir', eksEmptyDir_sizeLimit - The maximum size of the volume. By default, there's no maximum size
defined.
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
tmpfsvolume 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
data EksHostPath Source #
Specifies the configuration of a Kubernetes hostPath volume. A
hostPath volume mounts an existing file or directory from the host
node's filesystem into your pod. For more information, see
hostPath
in the Kubernetes documentation.
See: newEksHostPath smart constructor.
Constructors
| EksHostPath' | |
Instances
newEksHostPath :: EksHostPath Source #
Create a value of EksHostPath with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:path:EksHostPath', eksHostPath_path - The path of the file or directory on the host to mount into containers
on the pod.
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
data EksPodProperties Source #
The properties for the pod.
See: newEksPodProperties smart constructor.
Constructors
| EksPodProperties' | |
Fields
| |
Instances
newEksPodProperties :: EksPodProperties Source #
Create a value of EksPodProperties with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:containers:EksPodProperties', eksPodProperties_containers - The properties of the container that's used on the Amazon EKS pod.
$sel:dnsPolicy:EksPodProperties', eksPodProperties_dnsPolicy - The DNS policy for the pod. The default value is ClusterFirst. If the
hostNetwork parameter is not specified, the default is
ClusterFirstWithHostNet. ClusterFirst indicates that any DNS query
that does not match the configured cluster domain suffix is forwarded to
the upstream nameserver inherited from the node. For more information,
see
Pod's DNS policy
in the Kubernetes documentation.
Valid values: Default | ClusterFirst | ClusterFirstWithHostNet
$sel:hostNetwork:EksPodProperties', eksPodProperties_hostNetwork - Indicates if the pod uses the hosts' network IP address. The default
value is true. Setting this to false enables the Kubernetes pod
networking model. Most Batch workloads are egress-only and don't
require the overhead of IP allocation for each pod for incoming
connections. For more information, see
Host namespaces
and
Pod networking
in the Kubernetes documentation.
$sel:serviceAccountName:EksPodProperties', eksPodProperties_serviceAccountName - The name of the service account that's used to run the pod. For more
information, see
Kubernetes service accounts
and
Configure a Kubernetes service account to assume an IAM role
in the Amazon EKS User Guide and
Configure service accounts for pods
in the Kubernetes documentation.
$sel:volumes:EksPodProperties', eksPodProperties_volumes - Specifies the volumes for a job definition that uses Amazon EKS
resources.
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
data EksPodPropertiesDetail Source #
The details for the pod.
See: newEksPodPropertiesDetail smart constructor.
Constructors
| EksPodPropertiesDetail' | |
Fields
| |
Instances
newEksPodPropertiesDetail :: EksPodPropertiesDetail Source #
Create a value of EksPodPropertiesDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:containers:EksPodPropertiesDetail', eksPodPropertiesDetail_containers - The properties of the container that's used on the Amazon EKS pod.
$sel:dnsPolicy:EksPodPropertiesDetail', eksPodPropertiesDetail_dnsPolicy - The DNS policy for the pod. The default value is ClusterFirst. If the
hostNetwork parameter is not specified, the default is
ClusterFirstWithHostNet. ClusterFirst indicates that any DNS query
that does not match the configured cluster domain suffix is forwarded to
the upstream nameserver inherited from the node. If no value was
specified for dnsPolicy in the
RegisterJobDefinition
API operation, then no value will be returned for dnsPolicy by either
of
DescribeJobDefinitions
or
DescribeJobs
API operations. The pod spec setting will contain either ClusterFirst
or ClusterFirstWithHostNet, depending on the value of the
hostNetwork parameter. For more information, see
Pod's DNS policy
in the Kubernetes documentation.
Valid values: Default | ClusterFirst | ClusterFirstWithHostNet
$sel:hostNetwork:EksPodPropertiesDetail', eksPodPropertiesDetail_hostNetwork - Indicates if the pod uses the hosts' network IP address. The default
value is true. Setting this to false enables the Kubernetes pod
networking model. Most Batch workloads are egress-only and don't
require the overhead of IP allocation for each pod for incoming
connections. For more information, see
Host namespaces
and
Pod networking
in the Kubernetes documentation.
$sel:nodeName:EksPodPropertiesDetail', eksPodPropertiesDetail_nodeName - The name of the node for this job.
$sel:podName:EksPodPropertiesDetail', eksPodPropertiesDetail_podName - The name of the pod for this job.
$sel:serviceAccountName:EksPodPropertiesDetail', eksPodPropertiesDetail_serviceAccountName - The name of the service account that's used to run the pod. For more
information, see
Kubernetes service accounts
and
Configure a Kubernetes service account to assume an IAM role
in the Amazon EKS User Guide and
Configure service accounts for pods
in the Kubernetes documentation.
$sel:volumes:EksPodPropertiesDetail', eksPodPropertiesDetail_volumes - Specifies the volumes for a job definition using Amazon EKS resources.
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
data EksPodPropertiesOverride Source #
An object that contains overrides for the Kubernetes pod properties of a job.
See: newEksPodPropertiesOverride smart constructor.
Constructors
| EksPodPropertiesOverride' | |
Fields
| |
Instances
newEksPodPropertiesOverride :: EksPodPropertiesOverride Source #
Create a value of EksPodPropertiesOverride with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:containers:EksPodPropertiesOverride', eksPodPropertiesOverride_containers - The overrides for the container that's used on the Amazon EKS pod.
eksPodPropertiesOverride_containers :: Lens' EksPodPropertiesOverride (Maybe [EksContainerOverride]) Source #
The overrides for the container that's used on the Amazon EKS pod.
EksProperties
data EksProperties Source #
An object that contains the properties for the Kubernetes resources of a job.
See: newEksProperties smart constructor.
Constructors
| EksProperties' | |
Fields
| |
Instances
newEksProperties :: EksProperties Source #
Create a value of EksProperties with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:podProperties:EksProperties', eksProperties_podProperties - The properties for the Kubernetes pod resources of a job.
eksProperties_podProperties :: Lens' EksProperties (Maybe EksPodProperties) Source #
The properties for the Kubernetes pod resources of a job.
EksPropertiesDetail
data EksPropertiesDetail Source #
An object that contains the details for the Kubernetes resources of a job.
See: newEksPropertiesDetail smart constructor.
Constructors
| EksPropertiesDetail' | |
Fields
| |
Instances
newEksPropertiesDetail :: EksPropertiesDetail Source #
Create a value of EksPropertiesDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:podProperties:EksPropertiesDetail', eksPropertiesDetail_podProperties - The properties for the Kubernetes pod resources of a job.
eksPropertiesDetail_podProperties :: Lens' EksPropertiesDetail (Maybe EksPodPropertiesDetail) Source #
The properties for the Kubernetes pod resources of a job.
EksPropertiesOverride
data EksPropertiesOverride Source #
An object that contains overrides for the Kubernetes resources of a job.
See: newEksPropertiesOverride smart constructor.
Constructors
| EksPropertiesOverride' | |
Fields
| |
Instances
newEksPropertiesOverride :: EksPropertiesOverride Source #
Create a value of EksPropertiesOverride with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:podProperties:EksPropertiesOverride', eksPropertiesOverride_podProperties - The overrides for the Kubernetes pod resources of a job.
eksPropertiesOverride_podProperties :: Lens' EksPropertiesOverride (Maybe EksPodPropertiesOverride) Source #
The overrides for the Kubernetes pod resources of a job.
EksSecret
Specifies the configuration of a Kubernetes secret volume. For more
information, see
secret in
the Kubernetes documentation.
See: newEksSecret smart constructor.
Constructors
| EksSecret' | |
Fields
| |
Instances
| FromJSON EksSecret Source # | |
| ToJSON EksSecret Source # | |
Defined in Amazonka.Batch.Types.EksSecret | |
| Generic EksSecret Source # | |
| Read EksSecret Source # | |
| Show EksSecret Source # | |
| NFData EksSecret Source # | |
Defined in Amazonka.Batch.Types.EksSecret | |
| Eq EksSecret Source # | |
| Hashable EksSecret Source # | |
Defined in Amazonka.Batch.Types.EksSecret | |
| type Rep EksSecret Source # | |
Defined in Amazonka.Batch.Types.EksSecret type Rep EksSecret = D1 ('MetaData "EksSecret" "Amazonka.Batch.Types.EksSecret" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "EksSecret'" 'PrefixI 'True) (S1 ('MetaSel ('Just "optional") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "secretName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of EksSecret with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:optional:EksSecret', eksSecret_optional - Specifies whether the secret or the secret's keys must be defined.
$sel:secretName:EksSecret', eksSecret_secretName - The name of the secret. The name must be allowed as a DNS subdomain
name. For more information, see
DNS subdomain names
in the Kubernetes documentation.
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
Specifies an Amazon EKS volume for a job definition.
See: newEksVolume smart constructor.
Constructors
| EksVolume' | |
Fields
| |
Instances
Create a value of EksVolume with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:emptyDir:EksVolume', eksVolume_emptyDir - Specifies the configuration of a Kubernetes emptyDir volume. For more
information, see
emptyDir
in the Kubernetes documentation.
$sel:hostPath:EksVolume', eksVolume_hostPath - Specifies the configuration of a Kubernetes hostPath volume. For more
information, see
hostPath
in the Kubernetes documentation.
$sel:secret:EksVolume', eksVolume_secret - Specifies the configuration of a Kubernetes secret volume. For more
information, see
secret in
the Kubernetes documentation.
$sel:name:EksVolume', eksVolume_name - The name of the volume. The name must be allowed as a DNS subdomain
name. For more information, see
DNS subdomain names
in the Kubernetes documentation.
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
data EvaluateOnExit Source #
Specifies an array of up to 5 conditions to be met, and an action to
take (RETRY or EXIT) if all conditions are met. If none of the
EvaluateOnExit conditions in a RetryStrategy match, then the job is
retried.
See: newEvaluateOnExit smart constructor.
Constructors
| EvaluateOnExit' | |
Fields
| |
Instances
Arguments
| :: RetryAction | |
| -> EvaluateOnExit |
Create a value of EvaluateOnExit with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:onExitCode:EvaluateOnExit', evaluateOnExit_onExitCode - Contains a glob pattern to match against the decimal representation of
the ExitCode returned for a job. The pattern can be up to 512
characters long. It can contain only numbers, and can end with an
asterisk (*) so that only the start of the string needs to be an exact
match.
The string can contain up to 512 characters.
$sel:onReason:EvaluateOnExit', evaluateOnExit_onReason - Contains a glob pattern to match against the Reason returned for a
job. The pattern can contain up to 512 characters. It can contain
letters, numbers, periods (.), colons (:), and white space (including
spaces and tabs). It can optionally end with an asterisk (*) so that
only the start of the string needs to be an exact match.
$sel:onStatusReason:EvaluateOnExit', evaluateOnExit_onStatusReason - Contains a glob pattern to match against the StatusReason returned for
a job. The pattern can contain up to 512 characters. It can contain
letters, numbers, periods (.), colons (:), and white spaces (including
spaces or tabs). It can optionally end with an asterisk (*) so that only
the start of the string needs to be an exact match.
$sel:action:EvaluateOnExit', evaluateOnExit_action - Specifies the action to take if all of the specified conditions
(onStatusReason, onReason, and onExitCode) are met. The values
aren't case sensitive.
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
data FairsharePolicy Source #
The fair share policy for a scheduling policy.
See: newFairsharePolicy smart constructor.
Constructors
| FairsharePolicy' | |
Fields
| |
Instances
newFairsharePolicy :: FairsharePolicy Source #
Create a value of FairsharePolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:computeReservation:FairsharePolicy', fairsharePolicy_computeReservation - A value used to reserve some of the available maximum vCPU for fair
share identifiers that aren't already used.
The reserved ratio is
(computeReservation/100)^ActiveFairShares where
ActiveFairShares is the number of active fair share
identifiers.
For example, a computeReservation value of 50 indicates that
Batchreserves 50% of the maximum available vCPU if there's only one
fair share identifier. It reserves 25% if there are two fair share
identifiers. It reserves 12.5% if there are three fair share
identifiers. A computeReservation value of 25 indicates that Batch
should reserve 25% of the maximum available vCPU if there's only one
fair share identifier, 6.25% if there are two fair share identifiers,
and 1.56% if there are three fair share identifiers.
The minimum value is 0 and the maximum value is 99.
$sel:shareDecaySeconds:FairsharePolicy', fairsharePolicy_shareDecaySeconds - The amount of time (in seconds) to use to calculate a fair share
percentage for each fair share identifier in use. A value of zero (0)
indicates that only current usage is measured. The decay allows for more
recently run jobs to have more weight than jobs that ran earlier. The
maximum supported value is 604800 (1 week).
$sel:shareDistribution:FairsharePolicy', fairsharePolicy_shareDistribution - An array of SharedIdentifier objects that contain the weights for the
fair share identifiers for the fair share policy. Fair share identifiers
that aren't included have a default weight of 1.0.
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
data FargatePlatformConfiguration Source #
The platform configuration for jobs that are running on Fargate resources. Jobs that run on EC2 resources must not specify this parameter.
See: newFargatePlatformConfiguration smart constructor.
Constructors
| FargatePlatformConfiguration' | |
Fields
| |
Instances
newFargatePlatformConfiguration :: FargatePlatformConfiguration Source #
Create a value of FargatePlatformConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:platformVersion:FargatePlatformConfiguration', fargatePlatformConfiguration_platformVersion - The Fargate platform version where the jobs are running. A platform
version is specified only for jobs that are running on Fargate
resources. If one isn't specified, the LATEST platform version is
used by default. This uses a recent, approved version of the Fargate
platform for compute resources. For more information, see
Fargate platform versions
in the Amazon Elastic Container Service Developer Guide.
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
Determine whether your data volume persists on the host container instance and where it's stored. If this parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.
See: newHost smart constructor.
Constructors
| Host' | |
Fields
| |
Instances
| FromJSON Host Source # | |
| ToJSON Host Source # | |
Defined in Amazonka.Batch.Types.Host | |
| Generic Host Source # | |
| Read Host Source # | |
| Show Host Source # | |
| NFData Host Source # | |
Defined in Amazonka.Batch.Types.Host | |
| Eq Host Source # | |
| Hashable Host Source # | |
Defined in Amazonka.Batch.Types.Host | |
| type Rep Host Source # | |
Defined in Amazonka.Batch.Types.Host | |
Create a value of Host with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sourcePath:Host', host_sourcePath - The path on the host container instance that's presented to the
container. If this parameter is empty, then the Docker daemon has
assigned a host path for you. If this parameter contains a file
location, then the data volume persists at the specified location on the
host container instance until you delete it manually. If the source path
location doesn't exist on the host container instance, the Docker
daemon creates it. If the location does exist, the contents of the
source path folder are exported.
This parameter isn't applicable to jobs that run on Fargate resources. Don't provide this for these jobs.
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
data JobDefinition Source #
An object that represents an Batch job definition.
See: newJobDefinition smart constructor.
Constructors
| JobDefinition' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Int | |
| -> Text | |
| -> JobDefinition |
Create a value of JobDefinition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:containerOrchestrationType:JobDefinition', jobDefinition_containerOrchestrationType - The orchestration type of the compute environment. The valid values are
ECS (default) or EKS.
$sel:containerProperties:JobDefinition', jobDefinition_containerProperties - An object with various properties specific to Amazon ECS based jobs.
Valid values are containerProperties, eksProperties, and
nodeProperties. Only one can be specified.
$sel:eksProperties:JobDefinition', jobDefinition_eksProperties - An object with various properties that are specific to Amazon EKS based
jobs. Valid values are containerProperties, eksProperties, and
nodeProperties. Only one can be specified.
$sel:nodeProperties:JobDefinition', jobDefinition_nodeProperties - An object with various properties that are specific to multi-node
parallel jobs. Valid values are containerProperties, eksProperties,
and nodeProperties. Only one can be specified.
If the job runs on Fargate resources, don't specify nodeProperties.
Use containerProperties instead.
$sel:parameters:JobDefinition', jobDefinition_parameters - Default parameters or parameter substitution placeholders that are set
in the job definition. Parameters are specified as a key-value pair
mapping. Parameters in a SubmitJob request override any corresponding
parameter defaults from the job definition. For more information about
specifying parameters, see
Job definition parameters
in the Batch User Guide.
$sel:platformCapabilities:JobDefinition', jobDefinition_platformCapabilities - The platform capabilities required by the job definition. If no value is
specified, it defaults to EC2. Jobs run on Fargate resources specify
FARGATE.
$sel:propagateTags:JobDefinition', jobDefinition_propagateTags - Specifies whether to propagate the tags from the job or job definition
to the corresponding Amazon ECS task. If no value is specified, the tags
aren't propagated. Tags can only be propagated to the tasks when the
tasks are created. For tags with the same name, job tags are given
priority over job definitions tags. If the total number of combined tags
from the job and job definition is over 50, the job is moved to the
FAILED state.
$sel:retryStrategy:JobDefinition', jobDefinition_retryStrategy - The retry strategy to use for failed jobs that are submitted with this
job definition.
$sel:schedulingPriority:JobDefinition', jobDefinition_schedulingPriority - The scheduling priority of the job definition. This only affects jobs in
job queues with a fair share policy. Jobs with a higher scheduling
priority are scheduled before jobs with a lower scheduling priority.
$sel:status:JobDefinition', jobDefinition_status - The status of the job definition.
$sel:tags:JobDefinition', jobDefinition_tags - The tags that are applied to the job definition.
$sel:timeout:JobDefinition', jobDefinition_timeout - The timeout time for jobs that are submitted with this job definition.
After the amount of time you specify passes, Batch terminates your jobs
if they aren't finished.
$sel:jobDefinitionName:JobDefinition', jobDefinition_jobDefinitionName - The name of the job definition.
$sel:jobDefinitionArn:JobDefinition', jobDefinition_jobDefinitionArn - The Amazon Resource Name (ARN) for the job definition.
$sel:revision:JobDefinition', jobDefinition_revision - The revision of the job definition.
$sel:type':JobDefinition', jobDefinition_type - The type of job definition. It's either container or multinode. If
the job is run on Fargate resources, then multinode isn't supported.
For more information about multi-node parallel jobs, see
Creating a multi-node parallel job definition
in the Batch User Guide.
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
data JobDependency Source #
An object that represents an Batch job dependency.
See: newJobDependency smart constructor.
Constructors
| JobDependency' | |
Instances
newJobDependency :: JobDependency Source #
Create a value of JobDependency with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:JobDependency', jobDependency_jobId - The job ID of the Batch job that's associated with this dependency.
$sel:type':JobDependency', jobDependency_type - The type of the job dependency.
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
An object that represents an Batch job.
See: newJobDetail smart constructor.
Constructors
| JobDetail' | |
Fields
| |
Instances
Create a value of JobDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arrayProperties:JobDetail', jobDetail_arrayProperties - The array properties of the job, if it's an array job.
JobDetail, jobDetail_attempts - A list of job attempts that are associated with this job.
JobDetail, jobDetail_container - An object that represents the details for the container that's
associated with the job.
$sel:createdAt:JobDetail', jobDetail_createdAt - The Unix timestamp (in milliseconds) for when the job was created. For
non-array jobs and parent array jobs, this is when the job entered the
SUBMITTED state. This is specifically at the time SubmitJob was
called. For array child jobs, this is when the child job was spawned by
its parent and entered the PENDING state.
$sel:dependsOn:JobDetail', jobDetail_dependsOn - A list of job IDs that this job depends on.
$sel:eksAttempts:JobDetail', jobDetail_eksAttempts - A list of job attempts that are associated with this job.
$sel:eksProperties:JobDetail', jobDetail_eksProperties - An object with various properties that are specific to Amazon EKS based
jobs. Only one of container, eksProperties, or nodeDetails is
specified.
$sel:isCancelled:JobDetail', jobDetail_isCancelled - Indicates whether the job is canceled.
$sel:isTerminated:JobDetail', jobDetail_isTerminated - Indicates whether the job is terminated.
$sel:jobArn:JobDetail', jobDetail_jobArn - The Amazon Resource Name (ARN) of the job.
$sel:nodeDetails:JobDetail', jobDetail_nodeDetails - An object that represents the details of a node that's associated with
a multi-node parallel job.
$sel:nodeProperties:JobDetail', jobDetail_nodeProperties - An object that represents the node properties of a multi-node parallel
job.
This isn't applicable to jobs that are running on Fargate resources.
$sel:parameters:JobDetail', jobDetail_parameters - Additional parameters that are passed to the job that replace parameter
substitution placeholders or override any corresponding parameter
defaults from the job definition.
$sel:platformCapabilities:JobDetail', jobDetail_platformCapabilities - The platform capabilities required by the job definition. If no value is
specified, it defaults to EC2. Jobs run on Fargate resources specify
FARGATE.
$sel:propagateTags:JobDetail', jobDetail_propagateTags - Specifies whether to propagate the tags from the job or job definition
to the corresponding Amazon ECS task. If no value is specified, the tags
aren't propagated. Tags can only be propagated to the tasks when the
tasks are created. For tags with the same name, job tags are given
priority over job definitions tags. If the total number of combined tags
from the job and job definition is over 50, the job is moved to the
FAILED state.
$sel:retryStrategy:JobDetail', jobDetail_retryStrategy - The retry strategy to use for this job if an attempt fails.
$sel:schedulingPriority:JobDetail', jobDetail_schedulingPriority - The scheduling policy of the job definition. This only affects jobs in
job queues with a fair share policy. Jobs with a higher scheduling
priority are scheduled before jobs with a lower scheduling priority.
$sel:shareIdentifier:JobDetail', jobDetail_shareIdentifier - The share identifier for the job.
JobDetail, jobDetail_startedAt - The Unix timestamp (in milliseconds) for when the job was started. More
specifically, it's when the job transitioned from the STARTING state
to the RUNNING state. This parameter isn't provided for child jobs of
array jobs or multi-node parallel jobs.
JobDetail, jobDetail_statusReason - A short, human-readable string to provide more details for the current
status of the job.
JobDetail, jobDetail_stoppedAt - The Unix timestamp (in milliseconds) for when the job was stopped. More
specifically, it's when the job transitioned from the RUNNING state
to a terminal state, such as SUCCEEDED or FAILED.
$sel:tags:JobDetail', jobDetail_tags - The tags that are applied to the job.
$sel:timeout:JobDetail', jobDetail_timeout - The timeout configuration for the job.
$sel:jobName:JobDetail', jobDetail_jobName - The job name.
JobDetail, jobDetail_jobId - The job ID.
$sel:jobQueue:JobDetail', jobDetail_jobQueue - The Amazon Resource Name (ARN) of the job queue that the job is
associated with.
$sel:status:JobDetail', jobDetail_status - The current status for the job.
If your jobs don't progress to STARTING, see
Jobs stuck in RUNNABLE status
in the troubleshooting section of the Batch User Guide.
$sel:jobDefinition:JobDetail', jobDetail_jobDefinition - The Amazon Resource Name (ARN) of the job definition that this job uses.
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
data JobQueueDetail Source #
An object that represents the details for an Batch job queue.
See: newJobQueueDetail smart constructor.
Constructors
| JobQueueDetail' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> JQState | |
| -> Int | |
| -> JobQueueDetail |
Create a value of JobQueueDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:schedulingPolicyArn:JobQueueDetail', jobQueueDetail_schedulingPolicyArn - The Amazon Resource Name (ARN) of the scheduling policy. The format is
aws:Partition:batch:Region:Account:scheduling-policy/Name .
For example,
aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.
$sel:status:JobQueueDetail', jobQueueDetail_status - The status of the job queue (for example, CREATING or VALID).
$sel:statusReason:JobQueueDetail', jobQueueDetail_statusReason - A short, human-readable string to provide additional details for the
current status of the job queue.
$sel:tags:JobQueueDetail', jobQueueDetail_tags - The tags that are applied to the job queue. For more information, see
Tagging your Batch resources
in Batch User Guide.
$sel:jobQueueName:JobQueueDetail', jobQueueDetail_jobQueueName - The job queue name.
$sel:jobQueueArn:JobQueueDetail', jobQueueDetail_jobQueueArn - The Amazon Resource Name (ARN) of the job queue.
$sel:state:JobQueueDetail', jobQueueDetail_state - Describes the ability of the queue to accept new jobs. If the job queue
state is ENABLED, it can accept jobs. If the job queue state is
DISABLED, new jobs can't be added to the queue, but jobs already in
the queue can finish.
$sel:priority:JobQueueDetail', jobQueueDetail_priority - The priority of the job queue. Job queues with a higher priority (or a
higher integer value for the priority parameter) are evaluated first
when associated with the same compute environment. Priority is
determined in descending order. For example, a job queue with a priority
value of 10 is given scheduling preference over a job queue with a
priority value of 1. All of the compute environments must be either
EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). EC2 and
Fargate compute environments can't be mixed.
$sel:computeEnvironmentOrder:JobQueueDetail', jobQueueDetail_computeEnvironmentOrder - The compute environments that are attached to the job queue and the
order that job placement is preferred. Compute environments are selected
for job placement in ascending order.
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
data JobSummary Source #
An object that represents summary details of a job.
See: newJobSummary smart constructor.
Constructors
| JobSummary' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> JobSummary |
Create a value of JobSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arrayProperties:JobSummary', jobSummary_arrayProperties - The array properties of the job, if it's an array job.
$sel:container:JobSummary', jobSummary_container - An object that represents the details of the container that's
associated with the job.
$sel:createdAt:JobSummary', jobSummary_createdAt - The Unix timestamp (in milliseconds) for when the job was created. For
non-array jobs and parent array jobs, this is when the job entered the
SUBMITTED state (at the time SubmitJob was called). For array child
jobs, this is when the child job was spawned by its parent and entered
the PENDING state.
$sel:jobArn:JobSummary', jobSummary_jobArn - The Amazon Resource Name (ARN) of the job.
$sel:jobDefinition:JobSummary', jobSummary_jobDefinition - The Amazon Resource Name (ARN) of the job definition.
$sel:nodeProperties:JobSummary', jobSummary_nodeProperties - The node properties for a single node in a job summary list.
This isn't applicable to jobs that are running on Fargate resources.
$sel:startedAt:JobSummary', jobSummary_startedAt - The Unix timestamp for when the job was started. More specifically,
it's when the job transitioned from the STARTING state to the
RUNNING state.
$sel:status:JobSummary', jobSummary_status - The current status for the job.
$sel:statusReason:JobSummary', jobSummary_statusReason - A short, human-readable string to provide more details for the current
status of the job.
$sel:stoppedAt:JobSummary', jobSummary_stoppedAt - The Unix timestamp for when the job was stopped. More specifically,
it's when the job transitioned from the RUNNING state to a terminal
state, such as SUCCEEDED or FAILED.
$sel:jobId:JobSummary', jobSummary_jobId - The job ID.
$sel:jobName:JobSummary', jobSummary_jobName - The job name.
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
data JobTimeout Source #
An object that represents a job timeout configuration.
See: newJobTimeout smart constructor.
Constructors
| JobTimeout' | |
Fields
| |
Instances
newJobTimeout :: JobTimeout Source #
Create a value of JobTimeout with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attemptDurationSeconds:JobTimeout', jobTimeout_attemptDurationSeconds - The job timeout time (in seconds) that's measured from the job
attempt's startedAt timestamp. After this time passes, Batch
terminates your jobs if they aren't finished. The minimum value for the
timeout is 60 seconds.
For array jobs, the timeout applies to the child jobs, not to the parent array job.
For multi-node parallel (MNP) jobs, the timeout applies to the whole job, not to the individual nodes.
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
data KeyValuePair Source #
A key-value pair object.
See: newKeyValuePair smart constructor.
Constructors
| KeyValuePair' | |
Instances
newKeyValuePair :: KeyValuePair Source #
Create a value of KeyValuePair with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:KeyValuePair', keyValuePair_name - The name of the key-value pair. For environment variables, this is the
name of the environment variable.
$sel:value:KeyValuePair', keyValuePair_value - The value of the key-value pair. For environment variables, this is the
value of the environment variable.
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
data KeyValuesPair Source #
A filter name and value pair that's used to return a more specific list
of results from a ListJobs API operation.
See: newKeyValuesPair smart constructor.
Constructors
| KeyValuesPair' | |
Instances
newKeyValuesPair :: KeyValuesPair Source #
Create a value of KeyValuesPair with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:KeyValuesPair', keyValuesPair_name - The name of the filter. Filter names are case sensitive.
$sel:values:KeyValuesPair', keyValuesPair_values - The filter values.
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
data LaunchTemplateSpecification Source #
An object that represents a launch template that's associated with a compute resource. You must specify either the launch template ID or launch template name in the request, but not both.
If security groups are specified using both the securityGroupIds
parameter of CreateComputeEnvironment and the launch template, the
values in the securityGroupIds parameter of CreateComputeEnvironment
will be used.
This object isn't applicable to jobs that are running on Fargate resources.
See: newLaunchTemplateSpecification smart constructor.
Constructors
| LaunchTemplateSpecification' | |
Fields
| |
Instances
newLaunchTemplateSpecification :: LaunchTemplateSpecification Source #
Create a value of LaunchTemplateSpecification with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:launchTemplateId:LaunchTemplateSpecification', launchTemplateSpecification_launchTemplateId - The ID of the launch template.
$sel:launchTemplateName:LaunchTemplateSpecification', launchTemplateSpecification_launchTemplateName - The name of the launch template.
$sel:version:LaunchTemplateSpecification', launchTemplateSpecification_version - The version number of the launch template, $Latest, or $Default.
If the value is $Latest, the latest version of the launch template is
used. If the value is $Default, the default version of the launch
template is used.
If the AMI ID that's used in a compute environment is from the launch
template, the AMI isn't changed when the compute environment is
updated. It's only changed if the updateToLatestImageVersion
parameter for the compute environment is set to true. During an
infrastructure update, if either $Latest or $Default is specified,
Batch re-evaluates the launch template version, and it might use a
different version of the launch template. This is the case even if the
launch template isn't specified in the update. When updating a compute
environment, changing the launch template requires an infrastructure
update of the compute environment. For more information, see
Updating compute environments
in the Batch User Guide.
Default: $Default.
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
data LinuxParameters Source #
Linux-specific modifications that are applied to the container, such as details for device mappings.
See: newLinuxParameters smart constructor.
Constructors
| LinuxParameters' | |
Fields
| |
Instances
newLinuxParameters :: LinuxParameters Source #
Create a value of LinuxParameters with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:devices:LinuxParameters', linuxParameters_devices - Any of the host devices to expose to the container. This parameter maps
to Devices in the
Create a container
section of the
Docker Remote API and the
--device option to
docker run.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.
$sel:initProcessEnabled:LinuxParameters', linuxParameters_initProcessEnabled - If true, run an init process inside the container that forwards
signals and reaps processes. This parameter maps to the --init option
to docker run. This
parameter requires version 1.25 of the Docker Remote API or greater on
your container instance. To check the Docker Remote API version on your
container instance, log in to your container instance and run the
following command: sudo docker version | grep "Server API version"
$sel:maxSwap:LinuxParameters', linuxParameters_maxSwap - The total amount of swap memory (in MiB) a container can use. This
parameter is translated to the --memory-swap option to
docker run where the
value is the sum of the container memory plus the maxSwap value. For
more information, see
--memory-swap details
in the Docker documentation.
If a maxSwap value of 0 is specified, the container doesn't use
swap. Accepted values are 0 or any positive integer. If the maxSwap
parameter is omitted, the container doesn't use the swap configuration
for the container instance that it's running on. A maxSwap value must
be set for the swappiness parameter to be used.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.
$sel:sharedMemorySize:LinuxParameters', linuxParameters_sharedMemorySize - The value for the size (in MiB) of the /dev/shm volume. This
parameter maps to the --shm-size option to
docker run.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.
$sel:swappiness:LinuxParameters', linuxParameters_swappiness - You can use this parameter to tune a container's memory swappiness
behavior. A swappiness value of 0 causes swapping to not occur
unless absolutely necessary. A swappiness value of 100 causes pages
to be swapped aggressively. Valid values are whole numbers between 0
and 100. If the swappiness parameter isn't specified, a default
value of 60 is used. If a value isn't specified for maxSwap, then
this parameter is ignored. If maxSwap is set to 0, the container
doesn't use swap. This parameter maps to the --memory-swappiness
option to docker run.
Consider the following when you use a per-container swap configuration.
Swap space must be enabled and allocated on the container instance for the containers to use.
By default, the Amazon ECS optimized AMIs don't have swap enabled. You must enable swap on the instance to use this feature. For more information, see Instance store swap volumes in the Amazon EC2 User Guide for Linux Instances or How do I allocate memory to work as swap space in an Amazon EC2 instance by using a swap file?
- The swap space parameters are only supported for job definitions using EC2 resources.
- If the
maxSwapandswappinessparameters are omitted from a job definition, each container has a defaultswappinessvalue of 60. Moreover, the total swap usage is limited to two times the memory reservation of the container.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.
$sel:tmpfs:LinuxParameters', linuxParameters_tmpfs - The container path, mount options, and size (in MiB) of the tmpfs
mount. This parameter maps to the --tmpfs option to
docker run.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide this parameter for this resource type.
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
maxSwapandswappinessparameters are omitted from a job definition, each container has a defaultswappinessvalue 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
data LogConfiguration Source #
Log configuration options to send to a custom log driver for the container.
See: newLogConfiguration smart constructor.
Constructors
| LogConfiguration' | |
Fields
| |
Instances
Arguments
| :: LogDriver | |
| -> LogConfiguration |
Create a value of LogConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:options:LogConfiguration', logConfiguration_options - The configuration options to send to the log driver. This parameter
requires version 1.19 of the Docker Remote API or greater on your
container instance. To check the Docker Remote API version on your
container instance, log in to your container instance and run the
following command: sudo docker version | grep "Server API version"
$sel:secretOptions:LogConfiguration', logConfiguration_secretOptions - The secrets to pass to the log configuration. For more information, see
Specifying sensitive data
in the Batch User Guide.
$sel:logDriver:LogConfiguration', logConfiguration_logDriver - The log driver to use for the container. The valid values that are
listed for this parameter are log drivers that the Amazon ECS container
agent can communicate with by default.
The supported log drivers are awslogs, fluentd, gelf, json-file,
journald, logentries, syslog, and splunk.
Jobs that are running on Fargate resources are restricted to the
awslogs and splunk log drivers.
- awslogs
- Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs log driver in the Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation.
- fluentd
- Specifies the Fluentd logging driver. For more information including usage and options, see Fluentd logging driver in the Docker documentation.
- gelf
- Specifies the Graylog Extended Format (GELF) logging driver. For more information including usage and options, see Graylog Extended Format logging driver in the Docker documentation.
- journald
- Specifies the journald logging driver. For more information including usage and options, see Journald logging driver in the Docker documentation.
- json-file
- Specifies the JSON file logging driver. For more information including usage and options, see JSON File logging driver in the Docker documentation.
- splunk
- Specifies the Splunk logging driver. For more information including usage and options, see Splunk logging driver in the Docker documentation.
- syslog
- Specifies the syslog logging driver. For more information including usage and options, see Syslog logging driver in the Docker documentation.
If you have a custom driver that's not listed earlier that you want to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you want to have included. However, Amazon Web Services doesn't currently support running modified copies of this software.
This parameter requires version 1.18 of the Docker Remote API or greater
on your container instance. To check the Docker Remote API version on
your container instance, log in to your container instance and run the
following command: sudo docker version | grep "Server API version"
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
data MountPoint Source #
Details for a Docker volume mount point that's used in a job's
container properties. This parameter maps to Volumes in the
Create a container
section of the Docker Remote API and the --volume option to docker
run.
See: newMountPoint smart constructor.
Constructors
| MountPoint' | |
Fields
| |
Instances
newMountPoint :: MountPoint Source #
Create a value of MountPoint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:containerPath:MountPoint', mountPoint_containerPath - The path on the container where the host volume is mounted.
$sel:readOnly:MountPoint', mountPoint_readOnly - If this value is true, the container has read-only access to the
volume. Otherwise, the container can write to the volume. The default
value is false.
$sel:sourceVolume:MountPoint', mountPoint_sourceVolume - The name of the volume to mount.
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
data NetworkConfiguration Source #
The network configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.
See: newNetworkConfiguration smart constructor.
Constructors
| NetworkConfiguration' | |
Fields
| |
Instances
newNetworkConfiguration :: NetworkConfiguration Source #
Create a value of NetworkConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:assignPublicIp:NetworkConfiguration', networkConfiguration_assignPublicIp - Indicates whether the job has a public IP address. For a job that's
running on Fargate resources in a private subnet to send outbound
traffic to the internet (for example, to pull container images), the
private subnet requires a NAT gateway be attached to route requests to
the internet. For more information, see
Amazon ECS task networking
in the Amazon Elastic Container Service Developer Guide. The default
value is "DISABLED".
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
data NetworkInterface Source #
An object that represents the elastic network interface for a multi-node parallel job node.
See: newNetworkInterface smart constructor.
Constructors
| NetworkInterface' | |
Fields
| |
Instances
newNetworkInterface :: NetworkInterface Source #
Create a value of NetworkInterface with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attachmentId:NetworkInterface', networkInterface_attachmentId - The attachment ID for the network interface.
$sel:ipv6Address:NetworkInterface', networkInterface_ipv6Address - The private IPv6 address for the network interface.
$sel:privateIpv4Address:NetworkInterface', networkInterface_privateIpv4Address - The private IPv4 address for the network interface.
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
data NodeDetails Source #
An object that represents the details of a multi-node parallel job node.
See: newNodeDetails smart constructor.
Constructors
| NodeDetails' | |
Instances
newNodeDetails :: NodeDetails Source #
Create a value of NodeDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:isMainNode:NodeDetails', nodeDetails_isMainNode - Specifies whether the current node is the main node for a multi-node
parallel job.
$sel:nodeIndex:NodeDetails', nodeDetails_nodeIndex - The node index for the node. Node index numbering starts at zero. This
index is also available on the node with the AWS_BATCH_JOB_NODE_INDEX
environment variable.
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
data NodeOverrides Source #
An object that represents any node overrides to a job definition that's used in a SubmitJob API operation.
This parameter isn't applicable to jobs that are running on Fargate
resources. Don't provide it for these jobs. Rather, use
containerOverrides instead.
See: newNodeOverrides smart constructor.
Constructors
| NodeOverrides' | |
Fields
| |
Instances
newNodeOverrides :: NodeOverrides Source #
Create a value of NodeOverrides with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nodePropertyOverrides:NodeOverrides', nodeOverrides_nodePropertyOverrides - The node property overrides for the job.
$sel:numNodes:NodeOverrides', nodeOverrides_numNodes - The number of nodes to use with a multi-node parallel job. This value
overrides the number of nodes that are specified in the job definition.
To use this override, you must meet the following conditions:
- There must be at least one node range in your job definition that
has an open upper boundary, such as
: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.
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
data NodeProperties Source #
An object that represents the node properties of a multi-node parallel job.
Node properties can't be specified for Amazon EKS based job definitions.
See: newNodeProperties smart constructor.
Constructors
| NodeProperties' | |
Fields
| |
Instances
Create a value of NodeProperties with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:numNodes:NodeProperties', nodeProperties_numNodes - The number of nodes that are associated with a multi-node parallel job.
$sel:mainNode:NodeProperties', nodeProperties_mainNode - Specifies the node index for the main node of a multi-node parallel job.
This node index value must be fewer than the number of nodes.
$sel:nodeRangeProperties:NodeProperties', nodeProperties_nodeRangeProperties - A list of node ranges and their properties that are associated with a
multi-node parallel job.
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
data NodePropertiesSummary Source #
An object that represents the properties of a node that's associated with a multi-node parallel job.
See: newNodePropertiesSummary smart constructor.
Constructors
| NodePropertiesSummary' | |
Fields
| |
Instances
newNodePropertiesSummary :: NodePropertiesSummary Source #
Create a value of NodePropertiesSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:isMainNode:NodePropertiesSummary', nodePropertiesSummary_isMainNode - Specifies whether the current node is the main node for a multi-node
parallel job.
$sel:nodeIndex:NodePropertiesSummary', nodePropertiesSummary_nodeIndex - The node index for the node. Node index numbering begins at zero. This
index is also available on the node with the AWS_BATCH_JOB_NODE_INDEX
environment variable.
$sel:numNodes:NodePropertiesSummary', nodePropertiesSummary_numNodes - The number of nodes that are associated with a multi-node parallel job.
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
data NodePropertyOverride Source #
The object that represents any node overrides to a job definition that's used in a SubmitJob API operation.
See: newNodePropertyOverride smart constructor.
Constructors
| NodePropertyOverride' | |
Fields
| |
Instances
newNodePropertyOverride Source #
Create a value of NodePropertyOverride with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:containerOverrides:NodePropertyOverride', nodePropertyOverride_containerOverrides - The overrides that are sent to a node range.
$sel:targetNodes:NodePropertyOverride', nodePropertyOverride_targetNodes - The range of nodes, using node index values, that's used to override. A
range of 0:3 indicates nodes with index values of 0 through 3. If
the starting range value is omitted (:n), then 0 is used to start
the range. If the ending range value is omitted (n:), then the highest
possible node index is used to end the range.
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
data NodeRangeProperty Source #
An object that represents the properties of the node range for a multi-node parallel job.
See: newNodeRangeProperty smart constructor.
Constructors
| NodeRangeProperty' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> NodeRangeProperty |
Create a value of NodeRangeProperty with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:container:NodeRangeProperty', nodeRangeProperty_container - The container details for the node range.
$sel:targetNodes:NodeRangeProperty', nodeRangeProperty_targetNodes - The range of nodes, using node index values. A range of 0:3 indicates
nodes with index values of 0 through 3. If the starting range value
is omitted (:n), then 0 is used to start the range. If the ending
range value is omitted (n:), then the highest possible node index is
used to end the range. Your accumulative node ranges must account for
all nodes (0:n). You can nest node ranges (for example, 0:10 and
4:5). In this case, the 4:5 range properties override the 0:10
properties.
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
data ResourceRequirement Source #
The type and amount of a resource to assign to a container. The
supported resources include GPU, MEMORY, and VCPU.
See: newResourceRequirement smart constructor.
Constructors
| ResourceRequirement' | |
Fields
| |
Instances
newResourceRequirement Source #
Arguments
| :: Text | |
| -> ResourceType | |
| -> ResourceRequirement |
Create a value of ResourceRequirement with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:ResourceRequirement', resourceRequirement_value - The quantity of the specified resource to reserve for the container. The
values vary based on the type specified.
- type="GPU"
- The number of physical GPUs to reserve for the container. Make sure
that the number of GPUs reserved for all containers in a job
doesn't exceed the number of available GPUs on the compute resource
that the job is launched on.
GPUs aren't available for jobs that are running on Fargate resources.
- type="MEMORY"
- The memory hard limit (in MiB) present to the container. This
parameter is supported for jobs that are running on EC2 resources.
If your container attempts to exceed the memory specified, the
container is terminated. This parameter maps to
Memoryin the Create a container section of the Docker Remote API and the--memoryoption 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 toMemoryin the Create a container section of the Docker Remote API and the--memoryoption 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
valueis the hard limit (in MiB), and must match one of the supported values and theVCPUvalues 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
CpuSharesin the Create a container section of the Docker Remote API and the--cpu-sharesoption 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
valuemust match one of the supported values and theMEMORYvalues must be one of the values supported for thatVCPUvalue. The supported values are 0.25, 0.5, 1, 2, 4, 8, and 16- value = 0.25
MEMORY= 512, 1024, or 2048- value = 0.5
MEMORY= 1024, 2048, 3072, or 4096- value = 1
MEMORY= 2048, 3072, 4096, 5120, 6144, 7168, or 8192- value = 2
MEMORY= 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384- value = 4
MEMORY= 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720- value = 8
MEMORY= 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344, or 61440- value = 16
MEMORY= 32768, 40960, 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880
$sel:type':ResourceRequirement', resourceRequirement_type - The type of resource to assign to a container. The supported resources
include GPU, MEMORY, and VCPU.
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
Memoryin the Create a container section of the Docker Remote API and the--memoryoption 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 toMemoryin the Create a container section of the Docker Remote API and the--memoryoption 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
valueis the hard limit (in MiB), and must match one of the supported values and theVCPUvalues 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
CpuSharesin the Create a container section of the Docker Remote API and the--cpu-sharesoption 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
valuemust match one of the supported values and theMEMORYvalues must be one of the values supported for thatVCPUvalue. 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
data RetryStrategy Source #
The retry strategy that's associated with a job. For more information, see Automated job retries in the Batch User Guide.
See: newRetryStrategy smart constructor.
Constructors
| RetryStrategy' | |
Fields
| |
Instances
newRetryStrategy :: RetryStrategy Source #
Create a value of RetryStrategy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attempts:RetryStrategy', retryStrategy_attempts - The number of times to move a job to the RUNNABLE status. You can
specify between 1 and 10 attempts. If the value of attempts is greater
than one, the job is retried on failure the same number of attempts as
the value.
$sel:evaluateOnExit:RetryStrategy', retryStrategy_evaluateOnExit - Array of up to 5 objects that specify the conditions where jobs are
retried or failed. If this parameter is specified, then the attempts
parameter must also be specified. If none of the listed conditions
match, then the job is retried.
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
data SchedulingPolicyDetail Source #
An object that represents a scheduling policy.
See: newSchedulingPolicyDetail smart constructor.
Constructors
| SchedulingPolicyDetail' | |
Fields
| |
Instances
newSchedulingPolicyDetail Source #
Arguments
| :: Text | |
| -> Text | |
| -> SchedulingPolicyDetail |
Create a value of SchedulingPolicyDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fairsharePolicy:SchedulingPolicyDetail', schedulingPolicyDetail_fairsharePolicy - The fair share policy for the scheduling policy.
$sel:tags:SchedulingPolicyDetail', schedulingPolicyDetail_tags - The tags that you apply to the scheduling policy to categorize and
organize your resources. Each tag consists of a key and an optional
value. For more information, see
Tagging Amazon Web Services resources
in Amazon Web Services General Reference.
$sel:name:SchedulingPolicyDetail', schedulingPolicyDetail_name - The name of the scheduling policy.
$sel:arn:SchedulingPolicyDetail', schedulingPolicyDetail_arn - The Amazon Resource Name (ARN) of the scheduling policy. An example is
arn:aws:batch:us-east-1:123456789012:scheduling-policy/HighPriority .
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
data SchedulingPolicyListingDetail Source #
An object that contains the details of a scheduling policy that's
returned in a ListSchedulingPolicy action.
See: newSchedulingPolicyListingDetail smart constructor.
Constructors
| SchedulingPolicyListingDetail' | |
Instances
newSchedulingPolicyListingDetail Source #
Create a value of SchedulingPolicyListingDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:SchedulingPolicyListingDetail', schedulingPolicyListingDetail_arn - Amazon Resource Name (ARN) of the scheduling policy.
schedulingPolicyListingDetail_arn :: Lens' SchedulingPolicyListingDetail Text Source #
Amazon Resource Name (ARN) of the scheduling policy.
Secret
An object that represents the secret to expose to your container. Secrets can be exposed to a container in the following ways:
- To inject sensitive data into your containers as environment
variables, use the
secretscontainer definition parameter. - To reference sensitive information in the log configuration of a
container, use the
secretOptionscontainer definition parameter.
For more information, see Specifying sensitive data in the Batch User Guide.
See: newSecret smart constructor.
Constructors
| Secret' | |
Fields
| |
Instances
| FromJSON Secret Source # | |
| ToJSON Secret Source # | |
Defined in Amazonka.Batch.Types.Secret | |
| Generic Secret Source # | |
| Read Secret Source # | |
| Show Secret Source # | |
| NFData Secret Source # | |
Defined in Amazonka.Batch.Types.Secret | |
| Eq Secret Source # | |
| Hashable Secret Source # | |
Defined in Amazonka.Batch.Types.Secret | |
| type Rep Secret Source # | |
Defined in Amazonka.Batch.Types.Secret type Rep Secret = D1 ('MetaData "Secret" "Amazonka.Batch.Types.Secret" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "Secret'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "valueFrom") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Secret with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:Secret', secret_name - The name of the secret.
$sel:valueFrom:Secret', secret_valueFrom - The secret to expose to the container. The supported values are either
the full Amazon Resource Name (ARN) of the Secrets Manager secret or the
full ARN of the parameter in the Amazon Web Services Systems Manager
Parameter Store.
If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job you're launching, then you can use either the full Amazon Resource Name (ARN) or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
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
data ShareAttributes Source #
Specifies the weights for the fair share identifiers for the fair share
policy. Fair share identifiers that aren't included have a default
weight of 1.0.
See: newShareAttributes smart constructor.
Constructors
| ShareAttributes' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ShareAttributes |
Create a value of ShareAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:weightFactor:ShareAttributes', shareAttributes_weightFactor - The weight factor for the fair share identifier. The default value is
1.0. A lower value has a higher priority for compute resources. For
example, jobs that use a share identifier with a weight factor of 0.125
(1/8) get 8 times the compute resources of jobs that use a share
identifier with a weight factor of 1.
The smallest supported value is 0.0001, and the largest supported value is 999.9999.
$sel:shareIdentifier:ShareAttributes', shareAttributes_shareIdentifier - A fair share identifier or fair share identifier prefix. If the string
ends with an asterisk (*), this entry specifies the weight factor to use
for fair share identifiers that start with that prefix. The list of fair
share identifiers in a fair share policy can't overlap. For example,
you can't have one that specifies a shareIdentifier of UserA* and
another that specifies a shareIdentifier of UserA-1.
There can be no more than 500 fair share identifiers active in a job queue.
The string is limited to 255 alphanumeric characters, and can be followed by an asterisk (*).
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
The container path, mount options, and size of the tmpfs mount.
This object isn't applicable to jobs that are running on Fargate resources.
See: newTmpfs smart constructor.
Constructors
| Tmpfs' | |
Fields
| |
Instances
| FromJSON Tmpfs Source # | |
| ToJSON Tmpfs Source # | |
Defined in Amazonka.Batch.Types.Tmpfs | |
| Generic Tmpfs Source # | |
| Read Tmpfs Source # | |
| Show Tmpfs Source # | |
| NFData Tmpfs Source # | |
Defined in Amazonka.Batch.Types.Tmpfs | |
| Eq Tmpfs Source # | |
| Hashable Tmpfs Source # | |
Defined in Amazonka.Batch.Types.Tmpfs | |
| type Rep Tmpfs Source # | |
Defined in Amazonka.Batch.Types.Tmpfs type Rep Tmpfs = D1 ('MetaData "Tmpfs" "Amazonka.Batch.Types.Tmpfs" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "Tmpfs'" 'PrefixI 'True) (S1 ('MetaSel ('Just "mountOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "containerPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))) | |
Create a value of Tmpfs with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:mountOptions:Tmpfs', tmpfs_mountOptions - The list of tmpfs volume mount options.
Valid values: "defaults" | "ro" | "rw" | "suid" |
"nosuid" | "dev" | "nodev" | "exec" | "noexec" |
"sync" | "async" | "dirsync" | "remount" | "mand" |
"nomand" | "atime" | "noatime" | "diratime" |
"nodiratime" | "bind" |
"rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime"
| "norelatime" | "strictatime" | "nostrictatime" |
"mode" | "uid" | "gid" | "nr_inodes" | "nr_blocks" |
"mpol"
$sel:containerPath:Tmpfs', tmpfs_containerPath - The absolute file path in the container where the tmpfs volume is
mounted.
$sel:size:Tmpfs', tmpfs_size - The size (in MiB) of the tmpfs volume.
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
The ulimit settings to pass to the container.
This object isn't applicable to jobs that are running on Fargate resources.
See: newUlimit smart constructor.
Constructors
| Ulimit' | |
Instances
| FromJSON Ulimit Source # | |
| ToJSON Ulimit Source # | |
Defined in Amazonka.Batch.Types.Ulimit | |
| Generic Ulimit Source # | |
| Read Ulimit Source # | |
| Show Ulimit Source # | |
| NFData Ulimit Source # | |
Defined in Amazonka.Batch.Types.Ulimit | |
| Eq Ulimit Source # | |
| Hashable Ulimit Source # | |
Defined in Amazonka.Batch.Types.Ulimit | |
| type Rep Ulimit Source # | |
Defined in Amazonka.Batch.Types.Ulimit type Rep Ulimit = D1 ('MetaData "Ulimit" "Amazonka.Batch.Types.Ulimit" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "Ulimit'" 'PrefixI 'True) (S1 ('MetaSel ('Just "hardLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "softLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))) | |
Create a value of Ulimit with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:hardLimit:Ulimit', ulimit_hardLimit - The hard limit for the ulimit type.
$sel:name:Ulimit', ulimit_name - The type of the ulimit.
$sel:softLimit:Ulimit', ulimit_softLimit - The soft limit for the ulimit type.
UpdatePolicy
data UpdatePolicy Source #
Specifies the infrastructure update policy for the compute environment. For more information about infrastructure updates, see Updating compute environments in the Batch User Guide.
See: newUpdatePolicy smart constructor.
Constructors
| UpdatePolicy' | |
Fields
| |
Instances
newUpdatePolicy :: UpdatePolicy Source #
Create a value of UpdatePolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobExecutionTimeoutMinutes:UpdatePolicy', updatePolicy_jobExecutionTimeoutMinutes - Specifies the job timeout (in minutes) when the compute environment
infrastructure is updated. The default value is 30.
$sel:terminateJobsOnUpdate:UpdatePolicy', updatePolicy_terminateJobsOnUpdate - Specifies whether jobs are automatically terminated when the computer
environment infrastructure is updated. The default value is false.
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
A data volume that's used in a job's container properties.
See: newVolume smart constructor.
Constructors
| Volume' | |
Fields
| |
Instances
| FromJSON Volume Source # | |
| ToJSON Volume Source # | |
Defined in Amazonka.Batch.Types.Volume | |
| Generic Volume Source # | |
| Read Volume Source # | |
| Show Volume Source # | |
| NFData Volume Source # | |
Defined in Amazonka.Batch.Types.Volume | |
| Eq Volume Source # | |
| Hashable Volume Source # | |
Defined in Amazonka.Batch.Types.Volume | |
| type Rep Volume Source # | |
Defined in Amazonka.Batch.Types.Volume type Rep Volume = D1 ('MetaData "Volume" "Amazonka.Batch.Types.Volume" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "Volume'" 'PrefixI 'True) (S1 ('MetaSel ('Just "efsVolumeConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EFSVolumeConfiguration)) :*: (S1 ('MetaSel ('Just "host") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Host)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) | |
Create a value of Volume with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:efsVolumeConfiguration:Volume', volume_efsVolumeConfiguration - This parameter is specified when you're using an Amazon Elastic File
System file system for job storage. Jobs that are running on Fargate
resources must specify a platformVersion of at least 1.4.0.
$sel:host:Volume', volume_host - The contents of the host parameter determine whether your data volume
persists on the host container instance and where it's stored. If the
host parameter is empty, then the Docker daemon assigns a host path for
your data volume. However, the data isn't guaranteed to persist after
the containers that are associated with it stop running.
This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
$sel:name:Volume', volume_name - The name of the volume. It can be up to 255 characters long. It can
contain uppercase and lowercase letters, numbers, hyphens (-), and
underscores (_). This name is referenced in the sourceVolume parameter
of container definition mountPoints.
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.