| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Batch.Types
Contents
- Service Configuration
- Errors
- ArrayJobDependency
- AssignPublicIp
- CEState
- CEStatus
- CEType
- CRAllocationStrategy
- CRType
- DeviceCgroupPermission
- EFSAuthorizationConfigIAM
- EFSTransitEncryption
- JQState
- JQStatus
- JobDefinitionType
- JobStatus
- LogDriver
- PlatformCapability
- ResourceType
- RetryAction
- ArrayProperties
- ArrayPropertiesDetail
- ArrayPropertiesSummary
- AttemptContainerDetail
- AttemptDetail
- ComputeEnvironmentDetail
- ComputeEnvironmentOrder
- ComputeResource
- ComputeResourceUpdate
- ContainerDetail
- ContainerOverrides
- ContainerProperties
- ContainerSummary
- Device
- EFSAuthorizationConfig
- EFSVolumeConfiguration
- Ec2Configuration
- EvaluateOnExit
- FargatePlatformConfiguration
- Host
- JobDefinition
- JobDependency
- JobDetail
- JobQueueDetail
- JobSummary
- JobTimeout
- KeyValuePair
- KeyValuesPair
- LaunchTemplateSpecification
- LinuxParameters
- LogConfiguration
- MountPoint
- NetworkConfiguration
- NetworkInterface
- NodeDetails
- NodeOverrides
- NodeProperties
- NodePropertiesSummary
- NodePropertyOverride
- NodeRangeProperty
- ResourceRequirement
- RetryStrategy
- Secret
- Tmpfs
- Ulimit
- Volume
Description
Synopsis
- defaultService :: Service
- _ServerException :: AsError a => Getting (First ServiceError) a ServiceError
- _ClientException :: AsError a => Getting (First ServiceError) 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 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 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_size :: Lens' ArrayPropertiesDetail (Maybe Int)
- arrayPropertiesDetail_statusSummary :: Lens' ArrayPropertiesDetail (Maybe (HashMap Text Int))
- arrayPropertiesDetail_index :: Lens' ArrayPropertiesDetail (Maybe Int)
- data ArrayPropertiesSummary = ArrayPropertiesSummary' {}
- newArrayPropertiesSummary :: ArrayPropertiesSummary
- arrayPropertiesSummary_size :: Lens' ArrayPropertiesSummary (Maybe Int)
- arrayPropertiesSummary_index :: Lens' ArrayPropertiesSummary (Maybe Int)
- data AttemptContainerDetail = AttemptContainerDetail' {}
- newAttemptContainerDetail :: AttemptContainerDetail
- attemptContainerDetail_networkInterfaces :: Lens' AttemptContainerDetail (Maybe [NetworkInterface])
- attemptContainerDetail_taskArn :: Lens' AttemptContainerDetail (Maybe Text)
- attemptContainerDetail_containerInstanceArn :: Lens' AttemptContainerDetail (Maybe Text)
- attemptContainerDetail_reason :: Lens' AttemptContainerDetail (Maybe Text)
- attemptContainerDetail_logStreamName :: Lens' AttemptContainerDetail (Maybe Text)
- attemptContainerDetail_exitCode :: Lens' AttemptContainerDetail (Maybe Int)
- data AttemptDetail = AttemptDetail' {}
- newAttemptDetail :: AttemptDetail
- attemptDetail_stoppedAt :: Lens' AttemptDetail (Maybe Integer)
- attemptDetail_startedAt :: Lens' AttemptDetail (Maybe Integer)
- attemptDetail_container :: Lens' AttemptDetail (Maybe AttemptContainerDetail)
- attemptDetail_statusReason :: Lens' AttemptDetail (Maybe Text)
- data ComputeEnvironmentDetail = ComputeEnvironmentDetail' {}
- newComputeEnvironmentDetail :: Text -> Text -> Text -> ComputeEnvironmentDetail
- computeEnvironmentDetail_status :: Lens' ComputeEnvironmentDetail (Maybe CEStatus)
- computeEnvironmentDetail_state :: Lens' ComputeEnvironmentDetail (Maybe CEState)
- computeEnvironmentDetail_computeResources :: Lens' ComputeEnvironmentDetail (Maybe ComputeResource)
- computeEnvironmentDetail_statusReason :: Lens' ComputeEnvironmentDetail (Maybe Text)
- computeEnvironmentDetail_type :: Lens' ComputeEnvironmentDetail (Maybe CEType)
- computeEnvironmentDetail_serviceRole :: Lens' ComputeEnvironmentDetail (Maybe Text)
- computeEnvironmentDetail_tags :: Lens' ComputeEnvironmentDetail (Maybe (HashMap Text Text))
- computeEnvironmentDetail_computeEnvironmentName :: Lens' ComputeEnvironmentDetail Text
- computeEnvironmentDetail_computeEnvironmentArn :: Lens' ComputeEnvironmentDetail Text
- computeEnvironmentDetail_ecsClusterArn :: 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' {
- securityGroupIds :: Maybe [Text]
- instanceTypes :: Maybe [Text]
- instanceRole :: Maybe Text
- ec2KeyPair :: Maybe Text
- minvCpus :: Maybe Int
- ec2Configuration :: Maybe [Ec2Configuration]
- bidPercentage :: Maybe Int
- spotIamFleetRole :: Maybe Text
- imageId :: Maybe Text
- launchTemplate :: Maybe LaunchTemplateSpecification
- desiredvCpus :: Maybe Int
- allocationStrategy :: Maybe CRAllocationStrategy
- placementGroup :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- type' :: CRType
- maxvCpus :: Int
- subnets :: [Text]
- newComputeResource :: CRType -> Int -> ComputeResource
- computeResource_securityGroupIds :: Lens' ComputeResource (Maybe [Text])
- computeResource_instanceTypes :: Lens' ComputeResource (Maybe [Text])
- computeResource_instanceRole :: Lens' ComputeResource (Maybe Text)
- computeResource_ec2KeyPair :: Lens' ComputeResource (Maybe Text)
- computeResource_minvCpus :: Lens' ComputeResource (Maybe Int)
- computeResource_ec2Configuration :: Lens' ComputeResource (Maybe [Ec2Configuration])
- computeResource_bidPercentage :: Lens' ComputeResource (Maybe Int)
- computeResource_spotIamFleetRole :: Lens' ComputeResource (Maybe Text)
- computeResource_imageId :: Lens' ComputeResource (Maybe Text)
- computeResource_launchTemplate :: Lens' ComputeResource (Maybe LaunchTemplateSpecification)
- computeResource_desiredvCpus :: Lens' ComputeResource (Maybe Int)
- computeResource_allocationStrategy :: Lens' ComputeResource (Maybe CRAllocationStrategy)
- computeResource_placementGroup :: 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' {}
- newComputeResourceUpdate :: ComputeResourceUpdate
- computeResourceUpdate_securityGroupIds :: Lens' ComputeResourceUpdate (Maybe [Text])
- computeResourceUpdate_subnets :: Lens' ComputeResourceUpdate (Maybe [Text])
- computeResourceUpdate_minvCpus :: Lens' ComputeResourceUpdate (Maybe Int)
- computeResourceUpdate_maxvCpus :: Lens' ComputeResourceUpdate (Maybe Int)
- computeResourceUpdate_desiredvCpus :: Lens' ComputeResourceUpdate (Maybe Int)
- data ContainerDetail = ContainerDetail' {
- image :: Maybe Text
- command :: Maybe [Text]
- secrets :: Maybe [Secret]
- environment :: Maybe [KeyValuePair]
- networkInterfaces :: Maybe [NetworkInterface]
- taskArn :: Maybe Text
- ulimits :: Maybe [Ulimit]
- containerInstanceArn :: Maybe Text
- executionRoleArn :: Maybe Text
- privileged :: Maybe Bool
- jobRoleArn :: Maybe Text
- resourceRequirements :: Maybe [ResourceRequirement]
- instanceType :: Maybe Text
- memory :: Maybe Int
- user :: Maybe Text
- logConfiguration :: Maybe LogConfiguration
- linuxParameters :: Maybe LinuxParameters
- reason :: Maybe Text
- logStreamName :: Maybe Text
- mountPoints :: Maybe [MountPoint]
- exitCode :: Maybe Int
- fargatePlatformConfiguration :: Maybe FargatePlatformConfiguration
- vcpus :: Maybe Int
- readonlyRootFilesystem :: Maybe Bool
- volumes :: Maybe [Volume]
- networkConfiguration :: Maybe NetworkConfiguration
- newContainerDetail :: ContainerDetail
- containerDetail_image :: Lens' ContainerDetail (Maybe Text)
- containerDetail_command :: Lens' ContainerDetail (Maybe [Text])
- containerDetail_secrets :: Lens' ContainerDetail (Maybe [Secret])
- containerDetail_environment :: Lens' ContainerDetail (Maybe [KeyValuePair])
- containerDetail_networkInterfaces :: Lens' ContainerDetail (Maybe [NetworkInterface])
- containerDetail_taskArn :: Lens' ContainerDetail (Maybe Text)
- containerDetail_ulimits :: Lens' ContainerDetail (Maybe [Ulimit])
- containerDetail_containerInstanceArn :: Lens' ContainerDetail (Maybe Text)
- containerDetail_executionRoleArn :: Lens' ContainerDetail (Maybe Text)
- containerDetail_privileged :: Lens' ContainerDetail (Maybe Bool)
- containerDetail_jobRoleArn :: Lens' ContainerDetail (Maybe Text)
- containerDetail_resourceRequirements :: Lens' ContainerDetail (Maybe [ResourceRequirement])
- containerDetail_instanceType :: Lens' ContainerDetail (Maybe Text)
- containerDetail_memory :: Lens' ContainerDetail (Maybe Int)
- containerDetail_user :: Lens' ContainerDetail (Maybe Text)
- containerDetail_logConfiguration :: Lens' ContainerDetail (Maybe LogConfiguration)
- containerDetail_linuxParameters :: Lens' ContainerDetail (Maybe LinuxParameters)
- containerDetail_reason :: Lens' ContainerDetail (Maybe Text)
- containerDetail_logStreamName :: Lens' ContainerDetail (Maybe Text)
- containerDetail_mountPoints :: Lens' ContainerDetail (Maybe [MountPoint])
- containerDetail_exitCode :: Lens' ContainerDetail (Maybe Int)
- containerDetail_fargatePlatformConfiguration :: Lens' ContainerDetail (Maybe FargatePlatformConfiguration)
- containerDetail_vcpus :: Lens' ContainerDetail (Maybe Int)
- containerDetail_readonlyRootFilesystem :: Lens' ContainerDetail (Maybe Bool)
- containerDetail_volumes :: Lens' ContainerDetail (Maybe [Volume])
- containerDetail_networkConfiguration :: Lens' ContainerDetail (Maybe NetworkConfiguration)
- data ContainerOverrides = ContainerOverrides' {
- command :: Maybe [Text]
- environment :: Maybe [KeyValuePair]
- resourceRequirements :: Maybe [ResourceRequirement]
- instanceType :: Maybe Text
- memory :: Maybe Int
- vcpus :: Maybe Int
- newContainerOverrides :: ContainerOverrides
- containerOverrides_command :: Lens' ContainerOverrides (Maybe [Text])
- containerOverrides_environment :: Lens' ContainerOverrides (Maybe [KeyValuePair])
- containerOverrides_resourceRequirements :: Lens' ContainerOverrides (Maybe [ResourceRequirement])
- containerOverrides_instanceType :: Lens' ContainerOverrides (Maybe Text)
- containerOverrides_memory :: Lens' ContainerOverrides (Maybe Int)
- containerOverrides_vcpus :: Lens' ContainerOverrides (Maybe Int)
- data ContainerProperties = ContainerProperties' {
- image :: Maybe Text
- command :: Maybe [Text]
- secrets :: Maybe [Secret]
- environment :: Maybe [KeyValuePair]
- ulimits :: Maybe [Ulimit]
- executionRoleArn :: Maybe Text
- privileged :: Maybe Bool
- jobRoleArn :: Maybe Text
- resourceRequirements :: Maybe [ResourceRequirement]
- instanceType :: Maybe Text
- memory :: Maybe Int
- user :: Maybe Text
- logConfiguration :: Maybe LogConfiguration
- linuxParameters :: Maybe LinuxParameters
- mountPoints :: Maybe [MountPoint]
- fargatePlatformConfiguration :: Maybe FargatePlatformConfiguration
- vcpus :: Maybe Int
- readonlyRootFilesystem :: Maybe Bool
- volumes :: Maybe [Volume]
- networkConfiguration :: Maybe NetworkConfiguration
- newContainerProperties :: ContainerProperties
- containerProperties_image :: Lens' ContainerProperties (Maybe Text)
- containerProperties_command :: Lens' ContainerProperties (Maybe [Text])
- containerProperties_secrets :: Lens' ContainerProperties (Maybe [Secret])
- containerProperties_environment :: Lens' ContainerProperties (Maybe [KeyValuePair])
- containerProperties_ulimits :: Lens' ContainerProperties (Maybe [Ulimit])
- containerProperties_executionRoleArn :: Lens' ContainerProperties (Maybe Text)
- containerProperties_privileged :: Lens' ContainerProperties (Maybe Bool)
- containerProperties_jobRoleArn :: Lens' ContainerProperties (Maybe Text)
- containerProperties_resourceRequirements :: Lens' ContainerProperties (Maybe [ResourceRequirement])
- containerProperties_instanceType :: Lens' ContainerProperties (Maybe Text)
- containerProperties_memory :: Lens' ContainerProperties (Maybe Int)
- containerProperties_user :: Lens' ContainerProperties (Maybe Text)
- containerProperties_logConfiguration :: Lens' ContainerProperties (Maybe LogConfiguration)
- containerProperties_linuxParameters :: Lens' ContainerProperties (Maybe LinuxParameters)
- containerProperties_mountPoints :: Lens' ContainerProperties (Maybe [MountPoint])
- containerProperties_fargatePlatformConfiguration :: Lens' ContainerProperties (Maybe FargatePlatformConfiguration)
- containerProperties_vcpus :: Lens' ContainerProperties (Maybe Int)
- containerProperties_readonlyRootFilesystem :: Lens' ContainerProperties (Maybe Bool)
- containerProperties_volumes :: Lens' ContainerProperties (Maybe [Volume])
- containerProperties_networkConfiguration :: Lens' ContainerProperties (Maybe NetworkConfiguration)
- data ContainerSummary = ContainerSummary' {}
- newContainerSummary :: ContainerSummary
- containerSummary_reason :: Lens' ContainerSummary (Maybe Text)
- containerSummary_exitCode :: Lens' ContainerSummary (Maybe Int)
- 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_rootDirectory :: Lens' EFSVolumeConfiguration (Maybe Text)
- eFSVolumeConfiguration_transitEncryption :: Lens' EFSVolumeConfiguration (Maybe EFSTransitEncryption)
- eFSVolumeConfiguration_authorizationConfig :: Lens' EFSVolumeConfiguration (Maybe EFSAuthorizationConfig)
- eFSVolumeConfiguration_transitEncryptionPort :: Lens' EFSVolumeConfiguration (Maybe Int)
- eFSVolumeConfiguration_fileSystemId :: Lens' EFSVolumeConfiguration Text
- data Ec2Configuration = Ec2Configuration' {}
- newEc2Configuration :: Text -> Ec2Configuration
- ec2Configuration_imageIdOverride :: Lens' Ec2Configuration (Maybe Text)
- ec2Configuration_imageType :: Lens' Ec2Configuration 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 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' {
- status :: Maybe Text
- propagateTags :: Maybe Bool
- retryStrategy :: Maybe RetryStrategy
- platformCapabilities :: Maybe [PlatformCapability]
- parameters :: Maybe (HashMap Text Text)
- timeout :: Maybe JobTimeout
- containerProperties :: Maybe ContainerProperties
- nodeProperties :: Maybe NodeProperties
- tags :: Maybe (HashMap Text Text)
- jobDefinitionName :: Text
- jobDefinitionArn :: Text
- revision :: Int
- type' :: Text
- newJobDefinition :: Text -> Text -> Int -> Text -> JobDefinition
- jobDefinition_status :: Lens' JobDefinition (Maybe Text)
- jobDefinition_propagateTags :: Lens' JobDefinition (Maybe Bool)
- jobDefinition_retryStrategy :: Lens' JobDefinition (Maybe RetryStrategy)
- jobDefinition_platformCapabilities :: Lens' JobDefinition (Maybe [PlatformCapability])
- jobDefinition_parameters :: Lens' JobDefinition (Maybe (HashMap Text Text))
- jobDefinition_timeout :: Lens' JobDefinition (Maybe JobTimeout)
- jobDefinition_containerProperties :: Lens' JobDefinition (Maybe ContainerProperties)
- jobDefinition_nodeProperties :: Lens' JobDefinition (Maybe NodeProperties)
- jobDefinition_tags :: Lens' JobDefinition (Maybe (HashMap Text Text))
- 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' {
- stoppedAt :: Maybe Integer
- jobArn :: Maybe Text
- propagateTags :: Maybe Bool
- createdAt :: Maybe Integer
- retryStrategy :: Maybe RetryStrategy
- attempts :: Maybe [AttemptDetail]
- platformCapabilities :: Maybe [PlatformCapability]
- startedAt :: Maybe Integer
- dependsOn :: Maybe [JobDependency]
- container :: Maybe ContainerDetail
- nodeDetails :: Maybe NodeDetails
- parameters :: Maybe (HashMap Text Text)
- statusReason :: Maybe Text
- arrayProperties :: Maybe ArrayPropertiesDetail
- timeout :: Maybe JobTimeout
- nodeProperties :: Maybe NodeProperties
- tags :: Maybe (HashMap Text Text)
- jobName :: Text
- jobId :: Text
- jobQueue :: Text
- status :: JobStatus
- jobDefinition :: Text
- newJobDetail :: Text -> Text -> Text -> JobStatus -> Text -> JobDetail
- jobDetail_stoppedAt :: Lens' JobDetail (Maybe Integer)
- jobDetail_jobArn :: Lens' JobDetail (Maybe Text)
- jobDetail_propagateTags :: Lens' JobDetail (Maybe Bool)
- jobDetail_createdAt :: Lens' JobDetail (Maybe Integer)
- jobDetail_retryStrategy :: Lens' JobDetail (Maybe RetryStrategy)
- jobDetail_attempts :: Lens' JobDetail (Maybe [AttemptDetail])
- jobDetail_platformCapabilities :: Lens' JobDetail (Maybe [PlatformCapability])
- jobDetail_startedAt :: Lens' JobDetail (Maybe Integer)
- jobDetail_dependsOn :: Lens' JobDetail (Maybe [JobDependency])
- jobDetail_container :: Lens' JobDetail (Maybe ContainerDetail)
- jobDetail_nodeDetails :: Lens' JobDetail (Maybe NodeDetails)
- jobDetail_parameters :: Lens' JobDetail (Maybe (HashMap Text Text))
- jobDetail_statusReason :: Lens' JobDetail (Maybe Text)
- jobDetail_arrayProperties :: Lens' JobDetail (Maybe ArrayPropertiesDetail)
- jobDetail_timeout :: Lens' JobDetail (Maybe JobTimeout)
- jobDetail_nodeProperties :: Lens' JobDetail (Maybe NodeProperties)
- jobDetail_tags :: Lens' JobDetail (Maybe (HashMap Text Text))
- 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' {
- status :: Maybe JQStatus
- statusReason :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- jobQueueName :: Text
- jobQueueArn :: Text
- state :: JQState
- priority :: Int
- computeEnvironmentOrder :: [ComputeEnvironmentOrder]
- newJobQueueDetail :: Text -> Text -> JQState -> Int -> JobQueueDetail
- 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' {
- stoppedAt :: Maybe Integer
- status :: Maybe JobStatus
- jobArn :: Maybe Text
- createdAt :: Maybe Integer
- startedAt :: Maybe Integer
- container :: Maybe ContainerSummary
- jobDefinition :: Maybe Text
- statusReason :: Maybe Text
- arrayProperties :: Maybe ArrayPropertiesSummary
- nodeProperties :: Maybe NodePropertiesSummary
- jobId :: Text
- jobName :: Text
- newJobSummary :: Text -> Text -> JobSummary
- jobSummary_stoppedAt :: Lens' JobSummary (Maybe Integer)
- jobSummary_status :: Lens' JobSummary (Maybe JobStatus)
- jobSummary_jobArn :: Lens' JobSummary (Maybe Text)
- jobSummary_createdAt :: Lens' JobSummary (Maybe Integer)
- jobSummary_startedAt :: Lens' JobSummary (Maybe Integer)
- jobSummary_container :: Lens' JobSummary (Maybe ContainerSummary)
- jobSummary_jobDefinition :: Lens' JobSummary (Maybe Text)
- jobSummary_statusReason :: Lens' JobSummary (Maybe Text)
- jobSummary_arrayProperties :: Lens' JobSummary (Maybe ArrayPropertiesSummary)
- jobSummary_nodeProperties :: Lens' JobSummary (Maybe NodePropertiesSummary)
- 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_value :: Lens' KeyValuePair (Maybe Text)
- keyValuePair_name :: Lens' KeyValuePair (Maybe Text)
- data KeyValuesPair = KeyValuesPair' {}
- newKeyValuesPair :: KeyValuesPair
- keyValuesPair_values :: Lens' KeyValuesPair (Maybe [Text])
- keyValuesPair_name :: Lens' KeyValuesPair (Maybe Text)
- data LaunchTemplateSpecification = LaunchTemplateSpecification' {}
- newLaunchTemplateSpecification :: LaunchTemplateSpecification
- launchTemplateSpecification_launchTemplateName :: Lens' LaunchTemplateSpecification (Maybe Text)
- launchTemplateSpecification_launchTemplateId :: Lens' LaunchTemplateSpecification (Maybe Text)
- launchTemplateSpecification_version :: Lens' LaunchTemplateSpecification (Maybe Text)
- data LinuxParameters = LinuxParameters' {}
- newLinuxParameters :: LinuxParameters
- linuxParameters_sharedMemorySize :: Lens' LinuxParameters (Maybe Int)
- linuxParameters_initProcessEnabled :: Lens' LinuxParameters (Maybe Bool)
- linuxParameters_tmpfs :: Lens' LinuxParameters (Maybe [Tmpfs])
- linuxParameters_swappiness :: Lens' LinuxParameters (Maybe Int)
- linuxParameters_devices :: Lens' LinuxParameters (Maybe [Device])
- linuxParameters_maxSwap :: Lens' LinuxParameters (Maybe Int)
- 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
- sourceVolume :: Maybe Text
- readOnly :: Maybe Bool
- newMountPoint :: MountPoint
- mountPoint_containerPath :: Lens' MountPoint (Maybe Text)
- mountPoint_sourceVolume :: Lens' MountPoint (Maybe Text)
- mountPoint_readOnly :: Lens' MountPoint (Maybe Bool)
- data NetworkConfiguration = NetworkConfiguration' {}
- newNetworkConfiguration :: NetworkConfiguration
- networkConfiguration_assignPublicIp :: Lens' NetworkConfiguration (Maybe AssignPublicIp)
- data NetworkInterface = NetworkInterface' {}
- newNetworkInterface :: NetworkInterface
- networkInterface_ipv6Address :: Lens' NetworkInterface (Maybe Text)
- networkInterface_privateIpv4Address :: Lens' NetworkInterface (Maybe Text)
- networkInterface_attachmentId :: Lens' NetworkInterface (Maybe Text)
- data NodeDetails = NodeDetails' {}
- newNodeDetails :: NodeDetails
- nodeDetails_nodeIndex :: Lens' NodeDetails (Maybe Int)
- nodeDetails_isMainNode :: Lens' NodeDetails (Maybe Bool)
- data NodeOverrides = NodeOverrides' {}
- newNodeOverrides :: NodeOverrides
- nodeOverrides_numNodes :: Lens' NodeOverrides (Maybe Int)
- nodeOverrides_nodePropertyOverrides :: Lens' NodeOverrides (Maybe [NodePropertyOverride])
- 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_numNodes :: Lens' NodePropertiesSummary (Maybe Int)
- nodePropertiesSummary_nodeIndex :: Lens' NodePropertiesSummary (Maybe Int)
- nodePropertiesSummary_isMainNode :: Lens' NodePropertiesSummary (Maybe Bool)
- 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_evaluateOnExit :: Lens' RetryStrategy (Maybe [EvaluateOnExit])
- retryStrategy_attempts :: Lens' RetryStrategy (Maybe Int)
- data Secret = Secret' {}
- newSecret :: Text -> Text -> Secret
- secret_name :: Lens' Secret Text
- secret_valueFrom :: Lens' Secret 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 Volume = Volume' {}
- newVolume :: Volume
- volume_name :: Lens' Volume (Maybe Text)
- volume_efsVolumeConfiguration :: Lens' Volume (Maybe EFSVolumeConfiguration)
- volume_host :: Lens' Volume (Maybe Host)
Service Configuration
defaultService :: Service Source #
API version 2016-08-10 of the Amazon Batch SDK configuration.
Errors
_ServerException :: AsError a => Getting (First ServiceError) a ServiceError Source #
These errors are usually caused by a server issue.
_ClientException :: AsError a => Getting (First ServiceError) a ServiceError Source #
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that's not valid.
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
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
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 representing 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 representing 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: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.
$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.
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.
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.
ArrayPropertiesSummary
data ArrayPropertiesSummary Source #
An object representing 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:size:ArrayPropertiesSummary', arrayPropertiesSummary_size - The size of the array job. This parameter is returned for parent array
jobs.
$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.
arrayPropertiesSummary_size :: Lens' ArrayPropertiesSummary (Maybe Int) Source #
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.
AttemptContainerDetail
data AttemptContainerDetail Source #
An object representing 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:networkInterfaces:AttemptContainerDetail', attemptContainerDetail_networkInterfaces - The network interfaces associated with the job attempt.
$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.
$sel:containerInstanceArn:AttemptContainerDetail', attemptContainerDetail_containerInstanceArn - The Amazon Resource Name (ARN) of the Amazon ECS container instance that
hosts the job attempt.
$sel:reason:AttemptContainerDetail', attemptContainerDetail_reason - A short (255 max characters) human-readable string to provide additional
details about a running or stopped container.
$sel:logStreamName:AttemptContainerDetail', attemptContainerDetail_logStreamName - The name of the CloudWatch Logs log stream 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:exitCode:AttemptContainerDetail', attemptContainerDetail_exitCode - The exit code for the job attempt. A non-zero exit code is considered a
failure.
attemptContainerDetail_networkInterfaces :: Lens' AttemptContainerDetail (Maybe [NetworkInterface]) Source #
The network interfaces associated with the job attempt.
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.
attemptContainerDetail_containerInstanceArn :: Lens' AttemptContainerDetail (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Amazon ECS container instance that hosts the job attempt.
attemptContainerDetail_reason :: Lens' AttemptContainerDetail (Maybe Text) Source #
A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
attemptContainerDetail_logStreamName :: Lens' AttemptContainerDetail (Maybe Text) Source #
The name of the CloudWatch Logs log stream 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_exitCode :: Lens' AttemptContainerDetail (Maybe Int) Source #
The exit code for the job attempt. A non-zero exit code is considered a failure.
AttemptDetail
data AttemptDetail Source #
An object representing 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: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).
$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:container:AttemptDetail', attemptDetail_container - Details about the container in this job attempt.
$sel:statusReason:AttemptDetail', attemptDetail_statusReason - A short, human-readable string to provide additional details about 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).
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_container :: Lens' AttemptDetail (Maybe AttemptContainerDetail) Source #
Details about the container in this job attempt.
attemptDetail_statusReason :: Lens' AttemptDetail (Maybe Text) Source #
A short, human-readable string to provide additional details about the current status of the job attempt.
ComputeEnvironmentDetail
data ComputeEnvironmentDetail Source #
An object representing an Batch compute environment.
See: newComputeEnvironmentDetail smart constructor.
Constructors
| ComputeEnvironmentDetail' | |
Fields
| |
Instances
newComputeEnvironmentDetail Source #
Arguments
| :: Text | |
| -> 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:status:ComputeEnvironmentDetail', computeEnvironmentDetail_status - The current status of the compute environment (for example, CREATING
or VALID).
$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:computeResources:ComputeEnvironmentDetail', computeEnvironmentDetail_computeResources - The compute resources defined for the compute environment. For more
information, see
Compute Environments
in the Batch User Guide.
$sel:statusReason:ComputeEnvironmentDetail', computeEnvironmentDetail_statusReason - A short, human-readable string to provide additional details about the
current status of the compute environment.
$sel:type':ComputeEnvironmentDetail', computeEnvironmentDetail_type - The type of the compute environment: MANAGED or UNMANAGED. For more
information, see
Compute Environments
in the Batch User Guide.
$sel:serviceRole:ComputeEnvironmentDetail', computeEnvironmentDetail_serviceRole - The service role 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:tags:ComputeEnvironmentDetail', computeEnvironmentDetail_tags - The tags applied to the compute environment.
$sel:computeEnvironmentName:ComputeEnvironmentDetail', computeEnvironmentDetail_computeEnvironmentName - The name of the compute environment. Up to 128 letters (uppercase and
lowercase), numbers, hyphens, and underscores are allowed.
$sel:computeEnvironmentArn:ComputeEnvironmentDetail', computeEnvironmentDetail_computeEnvironmentArn - The Amazon Resource Name (ARN) of the compute environment.
$sel:ecsClusterArn:ComputeEnvironmentDetail', computeEnvironmentDetail_ecsClusterArn - The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used
by the compute environment.
computeEnvironmentDetail_status :: Lens' ComputeEnvironmentDetail (Maybe CEStatus) Source #
The current status of the compute environment (for example, CREATING
or VALID).
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_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_statusReason :: Lens' ComputeEnvironmentDetail (Maybe Text) Source #
A short, human-readable string to provide additional details about the current status of 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_serviceRole :: Lens' ComputeEnvironmentDetail (Maybe Text) Source #
The service role 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_tags :: Lens' ComputeEnvironmentDetail (Maybe (HashMap Text Text)) Source #
The tags applied to the compute environment.
computeEnvironmentDetail_computeEnvironmentName :: Lens' ComputeEnvironmentDetail Text Source #
The name of the compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
computeEnvironmentDetail_computeEnvironmentArn :: Lens' ComputeEnvironmentDetail Text Source #
The Amazon Resource Name (ARN) of the compute environment.
computeEnvironmentDetail_ecsClusterArn :: Lens' ComputeEnvironmentDetail Text Source #
The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.
ComputeEnvironmentOrder
data ComputeEnvironmentOrder Source #
The order in which compute environments are tried 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 representing 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:securityGroupIds:ComputeResource', computeResource_securityGroupIds - The Amazon EC2 security groups 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: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, and shouldn't be specified.
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: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, and shouldn't be specified.
$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, and shouldn't be specified.
$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, and shouldn't be specified.
$sel:ec2Configuration:ComputeResource', computeResource_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_AL1.
This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
$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.
This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
$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, and shouldn't be specified.
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: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, and shouldn't be specified.
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: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, and shouldn't be specified.
$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, and shouldn't be specified.
$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, and shouldn't be specified.
- 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 if the user is reaching
Amazon EC2 service limits
then additional jobs aren't run until the currently running jobs
have completed. This allocation strategy keeps costs lower but can
limit scaling. If you are using Spot Fleets with
BEST_FITthen the Spot Fleet IAM Role must be specified. - BEST_FIT_PROGRESSIVE
- Batch will select additional instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types with a lower cost per unit vCPU. If additional instances of the previously selected instance types aren't available, Batch will select new instance types.
- SPOT_CAPACITY_OPTIMIZED
- Batch will select one or more instance types that are large enough to meet the requirements of the jobs in the queue, with a preference 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, Batch might need to go above maxvCpus to meet your
capacity requirements. In this event, Batch never exceeds maxvCpus by
more than a single instance.
$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, and shouldn't be specified.
$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. These tags can't be updated or removed after the compute
environment is created.Aany changes to these tags require that you
create a new compute environment and remove the old compute environment.
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, and shouldn't be specified.
$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, 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.
computeResource_securityGroupIds :: Lens' ComputeResource (Maybe [Text]) Source #
The Amazon EC2 security groups 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_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, and shouldn't be specified.
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_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, and shouldn't be specified.
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, and shouldn't be specified.
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, and shouldn't be specified.
computeResource_ec2Configuration :: Lens' ComputeResource (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_AL1.
This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
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.
This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
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, and shouldn't be specified.
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_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, and shouldn't be specified.
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_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, and shouldn't be specified.
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, and shouldn't be specified.
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, and shouldn't be specified.
- 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 if the user is reaching
Amazon EC2 service limits
then additional jobs aren't run until the currently running jobs
have completed. This allocation strategy keeps costs lower but can
limit scaling. If you are using Spot Fleets with
BEST_FITthen the Spot Fleet IAM Role must be specified. - BEST_FIT_PROGRESSIVE
- Batch will select additional instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types with a lower cost per unit vCPU. If additional instances of the previously selected instance types aren't available, Batch will select new instance types.
- SPOT_CAPACITY_OPTIMIZED
- Batch will select one or more instance types that are large enough to meet the requirements of the jobs in the queue, with a preference 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, Batch might need to go above maxvCpus to meet your
capacity requirements. In this event, Batch never exceeds maxvCpus by
more than a single instance.
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, and shouldn't be specified.
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. These tags can't be updated or removed after the compute
environment is created.Aany changes to these tags require that you
create a new compute environment and remove the old compute environment.
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, and shouldn't be specified.
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, 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.
ComputeResourceUpdate
data ComputeResourceUpdate Source #
An object representing the attributes of a compute environment that can be updated. For more information, see 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:securityGroupIds:ComputeResourceUpdate', computeResourceUpdate_securityGroupIds - The Amazon EC2 security groups 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. This can't be
specified for EC2 compute resources. Providing an empty list is handled
as if this parameter wasn't specified and no change is made.
$sel:subnets:ComputeResourceUpdate', computeResourceUpdate_subnets - The VPC subnets where the compute resources are launched. Fargate
compute resources can contain up to 16 subnets. Providing an empty list
will be handled as if this parameter wasn't specified and no change is
made. This can't be specified for EC2 compute resources. For more
information, see
VPCs and Subnets
in the Amazon VPC User Guide.
$sel:minvCpus:ComputeResourceUpdate', computeResourceUpdate_minvCpus - The minimum number of Amazon EC2 vCPUs that an environment should
maintain.
This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
$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, 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:desiredvCpus:ComputeResourceUpdate', computeResourceUpdate_desiredvCpus - The desired number of Amazon EC2 vCPUS in the compute environment.
This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
computeResourceUpdate_securityGroupIds :: Lens' ComputeResourceUpdate (Maybe [Text]) Source #
The Amazon EC2 security groups 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. This can't be specified for EC2 compute resources. Providing an empty list is handled as if this parameter wasn't specified and no change is made.
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. Providing an empty list will be handled as if this parameter wasn't specified and no change is made. This can't be specified for EC2 compute resources. For more information, see VPCs and Subnets in the Amazon VPC User Guide.
computeResourceUpdate_minvCpus :: Lens' ComputeResourceUpdate (Maybe Int) Source #
The minimum number of Amazon EC2 vCPUs that an environment should maintain.
This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
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, 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_desiredvCpus :: Lens' ComputeResourceUpdate (Maybe Int) Source #
The desired number of Amazon EC2 vCPUS in the compute environment.
This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
ContainerDetail
data ContainerDetail Source #
An object representing 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:image:ContainerDetail', containerDetail_image - The image used to start the container.
$sel:command:ContainerDetail', containerDetail_command - The command that's passed to the container.
$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:environment:ContainerDetail', containerDetail_environment - The environment variables to pass to a container.
Environment variables must not start with AWS_BATCH; this naming
convention is reserved for variables that are set by the Batch service.
$sel:networkInterfaces:ContainerDetail', containerDetail_networkInterfaces - The network interfaces associated with the job.
$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:containerInstanceArn:ContainerDetail', containerDetail_containerInstanceArn - The Amazon Resource Name (ARN) of the container instance that the
container is running on.
$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: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:jobRoleArn:ContainerDetail', containerDetail_jobRoleArn - The Amazon Resource Name (ARN) associated with the job upon execution.
$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: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:memory:ContainerDetail', containerDetail_memory - For jobs run on EC2 resources that didn't specify memory requirements
using ResourceRequirement, the number of MiB of memory reserved for
the job. For other jobs, including all run on Fargate resources, see
resourceRequirements.
$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: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 into 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:linuxParameters:ContainerDetail', containerDetail_linuxParameters - Linux-specific modifications that are applied to the container, such as
details for device mappings.
$sel:reason:ContainerDetail', containerDetail_reason - A short (255 max characters) human-readable string to provide additional
details about a running or stopped container.
$sel:logStreamName:ContainerDetail', containerDetail_logStreamName - The name of the CloudWatch Logs log stream 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:mountPoints:ContainerDetail', containerDetail_mountPoints - The mount points for data volumes in your container.
$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: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 resourceRequirement 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: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:volumes:ContainerDetail', containerDetail_volumes - A list of volumes associated with the job.
$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.
containerDetail_image :: Lens' ContainerDetail (Maybe Text) Source #
The image used to start the container.
containerDetail_command :: Lens' ContainerDetail (Maybe [Text]) Source #
The command that's passed to the container.
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_environment :: Lens' ContainerDetail (Maybe [KeyValuePair]) Source #
The environment variables to pass to a container.
Environment variables must not start with AWS_BATCH; this naming
convention is reserved for variables that are set by the Batch service.
containerDetail_networkInterfaces :: Lens' ContainerDetail (Maybe [NetworkInterface]) Source #
The network interfaces associated with the job.
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_containerInstanceArn :: Lens' ContainerDetail (Maybe Text) Source #
The Amazon Resource Name (ARN) of the container instance that the container is running on.
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_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_jobRoleArn :: Lens' ContainerDetail (Maybe Text) Source #
The Amazon Resource Name (ARN) associated with the job upon execution.
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_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_memory :: Lens' ContainerDetail (Maybe Int) Source #
For jobs run on EC2 resources that didn't specify memory requirements
using ResourceRequirement, the number of MiB of memory reserved for
the job. For other jobs, including all run on Fargate resources, see
resourceRequirements.
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_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 into 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_linuxParameters :: Lens' ContainerDetail (Maybe LinuxParameters) Source #
Linux-specific modifications that are applied to the container, such as details for device mappings.
containerDetail_reason :: Lens' ContainerDetail (Maybe Text) Source #
A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
containerDetail_logStreamName :: Lens' ContainerDetail (Maybe Text) Source #
The name of the CloudWatch Logs log stream 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_mountPoints :: Lens' ContainerDetail (Maybe [MountPoint]) Source #
The mount points for data volumes in your container.
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_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 resourceRequirement 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_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_volumes :: Lens' ContainerDetail (Maybe [Volume]) Source #
A list of volumes associated with the job.
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.
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 must not start with AWS_BATCH; this naming
convention is reserved for variables that are set by the Batch service.
$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: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 indicates the amount of memory (in MiB) that's reserved
for the job. It overrides the memory parameter set in the job
definition, but doesn't override any memory requirement specified in
the ResourceRequirement structure in the job definition. To override
memory requirements that are specified in the ResourceRequirement
structure in the job definition, ResourceRequirement must be specified
in the SubmitJob request, with type set to MEMORY and value set
to the new value.
This parameter is supported for jobs that run on EC2 resources, but
isn't supported for jobs that run on Fargate resources. For these
resources, use resourceRequirement instead.
$sel:vcpus:ContainerOverrides', containerOverrides_vcpus - This parameter indicates the number of vCPUs reserved for the
container.It overrides the vcpus parameter that's set in the job
definition, but doesn't override any vCPU requirement specified in the
resourceRequirement structure in the job definition. To override vCPU
requirements that are specified in the ResourceRequirement structure
in the job definition, ResourceRequirement must be specified in the
SubmitJob request, with type set to VCPU and value set to the
new value.
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 parameter is supported for jobs that run on EC2 resources, but
isn't supported for jobs that run on Fargate resources. For Fargate
resources, you can only use resourceRequirement. For EC2 resources,
you can use either this parameter or resourceRequirement but not both.
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 must not start with AWS_BATCH; this naming
convention is reserved for variables that are set by the Batch service.
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_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 indicates the amount of memory (in MiB) that's reserved
for the job. It overrides the memory parameter set in the job
definition, but doesn't override any memory requirement specified in
the ResourceRequirement structure in the job definition. To override
memory requirements that are specified in the ResourceRequirement
structure in the job definition, ResourceRequirement must be specified
in the SubmitJob request, with type set to MEMORY and value set
to the new value.
This parameter is supported for jobs that run on EC2 resources, but
isn't supported for jobs that run on Fargate resources. For these
resources, use resourceRequirement instead.
containerOverrides_vcpus :: Lens' ContainerOverrides (Maybe Int) Source #
This parameter indicates the number of vCPUs reserved for the
container.It overrides the vcpus parameter that's set in the job
definition, but doesn't override any vCPU requirement specified in the
resourceRequirement structure in the job definition. To override vCPU
requirements that are specified in the ResourceRequirement structure
in the job definition, ResourceRequirement must be specified in the
SubmitJob request, with type set to VCPU and value set to the
new value.
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 parameter is supported for jobs that run on EC2 resources, but
isn't supported for jobs that run on Fargate resources. For Fargate
resources, you can only use resourceRequirement. For EC2 resources,
you can use either this parameter or resourceRequirement but not both.
ContainerProperties
data ContainerProperties Source #
Container properties are used in job definitions 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: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 . Up to 255 letters (uppercase and
lowercase), numbers, hyphens, underscores, colons, periods, forward
slashes, and number signs are allowed. 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 repositories use the full registry and
repository URI (for example,
012345678910.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: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:secrets:ContainerProperties', containerProperties_secrets - The secrets for the container. For more information, see
Specifying sensitive data
in the Batch User Guide.
$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 must not start with AWS_BATCH; this naming
convention is reserved for variables that are set by the Batch service.
$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: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: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: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:resourceRequirements:ContainerProperties', containerProperties_resourceRequirements - The type and amount of resources to assign to a container. The supported
resources include GPU, MEMORY, and VCPU.
$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:memory:ContainerProperties', containerProperties_memory - This parameter indicates 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.
This parameter maps to Memory in the
Create a container
section of the
Docker Remote API and the
--memory option to
docker run.
This parameter is supported on EC2 resources but isn't supported on
Fargate resources. For Fargate resources, you should specify the memory
requirement using resourceRequirement. You can also do this for EC2
resources.
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.
$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: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 into 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:linuxParameters:ContainerProperties', containerProperties_linuxParameters - Linux-specific modifications that are applied to the container, such as
details for device mappings.
$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: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:vcpus:ContainerProperties', containerProperties_vcpus - 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.
This parameter is supported on EC2 resources but isn't supported for
jobs that run on Fargate resources. For these resources, use
resourceRequirement instead. You can use this parameter or
resourceRequirements structure but not both.
This parameter isn't applicable to jobs that are running on Fargate
resources and shouldn't be provided. For jobs that run on Fargate
resources, you must specify the vCPU requirement for the job using
resourceRequirements.
$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:volumes:ContainerProperties', containerProperties_volumes - A list of data volumes used in a job.
$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.
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 . Up to 255 letters (uppercase and
lowercase), numbers, hyphens, underscores, colons, periods, forward
slashes, and number signs are allowed. 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 repositories use the full registry and
repository URI (for example,
012345678910.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_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_secrets :: Lens' ContainerProperties (Maybe [Secret]) Source #
The secrets for the container. For more information, see Specifying sensitive data in the Batch User Guide.
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 must not start with AWS_BATCH; this naming
convention is reserved for variables that are set by the Batch service.
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_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_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_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_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_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_memory :: Lens' ContainerProperties (Maybe Int) Source #
This parameter indicates 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.
This parameter maps to Memory in the
Create a container
section of the
Docker Remote API and the
--memory option to
docker run.
This parameter is supported on EC2 resources but isn't supported on
Fargate resources. For Fargate resources, you should specify the memory
requirement using resourceRequirement. You can also do this for EC2
resources.
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.
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_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 into 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_linuxParameters :: Lens' ContainerProperties (Maybe LinuxParameters) Source #
Linux-specific modifications that are applied to the container, such as details for device mappings.
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_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_vcpus :: Lens' ContainerProperties (Maybe Int) Source #
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.
This parameter is supported on EC2 resources but isn't supported for
jobs that run on Fargate resources. For these resources, use
resourceRequirement instead. You can use this parameter or
resourceRequirements structure but not both.
This parameter isn't applicable to jobs that are running on Fargate
resources and shouldn't be provided. For jobs that run on Fargate
resources, you must specify the vCPU requirement for the job using
resourceRequirements.
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_volumes :: Lens' ContainerProperties (Maybe [Volume]) Source #
A list of data volumes used in a job.
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.
ContainerSummary
data ContainerSummary Source #
An object representing 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:reason:ContainerSummary', containerSummary_reason - A short (255 max characters) human-readable string to provide additional
details about a running or stopped container.
$sel:exitCode:ContainerSummary', containerSummary_exitCode - 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 about a running or stopped container.
containerSummary_exitCode :: Lens' ContainerSummary (Maybe Int) Source #
The exit code to return upon completion.
Device
An object representing 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
| Eq Device Source # | |
| Read Device Source # | |
| Show Device Source # | |
| Generic Device Source # | |
| NFData Device Source # | |
Defined in Amazonka.Batch.Types.Device | |
| Hashable Device Source # | |
Defined in Amazonka.Batch.Types.Device | |
| ToJSON Device Source # | |
Defined in Amazonka.Batch.Types.Device | |
| FromJSON Device Source # | |
| type Rep Device Source # | |
Defined in Amazonka.Batch.Types.Device type Rep Device = D1 ('MetaData "Device" "Amazonka.Batch.Types.Device" "libZSservicesZSamazonka-batchZSamazonka-batch" '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 will enforce 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 will enforce 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: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:authorizationConfig:EFSVolumeConfiguration', eFSVolumeConfiguration_authorizationConfig - The authorization configuration details for the Amazon EFS file system.
$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_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_authorizationConfig :: Lens' EFSVolumeConfiguration (Maybe EFSAuthorizationConfig) Source #
The authorization configuration details for the Amazon EFS file system.
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 currently ECS_AL1
(Amazon Linux)
for non-GPU, non AWSGraviton instances. Starting on March 31, 2021, this
default will be changing to 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.
$sel:imageType:Ec2Configuration', ec2Configuration_imageType - The image type to match with the instance type to select an AMI. If the
imageIdOverride parameter isn't specified, then a recent
Amazon ECS-optimized AMI
(ECS_AL1) is used. Starting on March 31, 2021, this default will be
changing to ECS_AL2
(Amazon Linux 2).
- ECS_AL2
- Amazon Linux 2−
Default for all Amazon Web Services Graviton-based instance families
(for example,
C6g,M6g,R6g, andT4g) and can be used for all non-GPU instance types. - 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−Default for all non-GPU, non Amazon Web Services Graviton instance families. Amazon Linux is reaching the end-of-life of standard support. For more information, see Amazon Linux AMI.
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.
ec2Configuration_imageType :: Lens' Ec2Configuration Text Source #
The image type to match with the instance type to select an AMI. If the
imageIdOverride parameter isn't specified, then a recent
Amazon ECS-optimized AMI
(ECS_AL1) is used. Starting on March 31, 2021, this default will be
changing to ECS_AL2
(Amazon Linux 2).
- ECS_AL2
- Amazon Linux 2−
Default for all Amazon Web Services Graviton-based instance families
(for example,
C6g,M6g,R6g, andT4g) and can be used for all non-GPU instance types. - 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−Default for all non-GPU, non Amazon Web Services Graviton instance families. Amazon Linux is reaching the end-of-life of standard support. For more information, see Amazon Linux AMI.
EvaluateOnExit
data EvaluateOnExit Source #
Specifies a set of conditions to be met, and an action to take (RETRY
or EXIT) if all conditions are met.
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 in length. It can contain only numbers, and can optionally
end with an asterisk (*) so that only the start of the string needs to
be an exact match.
$sel:onReason:EvaluateOnExit', evaluateOnExit_onReason - Contains a glob pattern to match against the Reason returned for a
job. The pattern can be up to 512 characters in length. 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 be up to 512 characters in length. It can contain
letters, numbers, periods (.), colons (:), and white space (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 in length. It can contain only numbers, and can optionally
end with an asterisk (*) so that only the start of the string needs to
be an exact match.
evaluateOnExit_onReason :: Lens' EvaluateOnExit (Maybe Text) Source #
Contains a glob pattern to match against the Reason returned for a
job. The pattern can be up to 512 characters in length. 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 be up to 512 characters in length. It can contain
letters, numbers, periods (.), colons (:), and white space (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.
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 is stored. If this parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data isn't guaranteed to persist after the containers associated with it stop running.
See: newHost smart constructor.
Constructors
| Host' | |
Fields
| |
Instances
| Eq Host Source # | |
| Read Host Source # | |
| Show Host Source # | |
| Generic Host Source # | |
| NFData Host Source # | |
Defined in Amazonka.Batch.Types.Host | |
| Hashable Host Source # | |
Defined in Amazonka.Batch.Types.Host | |
| ToJSON Host Source # | |
Defined in Amazonka.Batch.Types.Host | |
| FromJSON Host Source # | |
| 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 and shouldn't be provided.
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 and shouldn't be provided.
JobDefinition
data JobDefinition Source #
An object representing 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:status:JobDefinition', jobDefinition_status - The status of the job definition.
$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 during task
creation. For tags with the same name, job tags are given priority over
job definitions tags. If the total number of combined tags from the job
and job definition is over 50, the job is moved to the FAILED state.
$sel:retryStrategy:JobDefinition', jobDefinition_retryStrategy - The retry strategy to use for failed jobs that are submitted with this
job definition.
$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: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:timeout:JobDefinition', jobDefinition_timeout - The timeout configuration for jobs that are submitted with this job
definition. You can specify a timeout duration after which Batch
terminates your jobs if they haven't finished.
$sel:containerProperties:JobDefinition', jobDefinition_containerProperties - An object with various properties specific to container-based jobs.
$sel:nodeProperties:JobDefinition', jobDefinition_nodeProperties - An object with various properties specific to multi-node parallel jobs.
If the job runs on Fargate resources, then you must not specify
nodeProperties; use containerProperties instead.
$sel:tags:JobDefinition', jobDefinition_tags - The tags applied to the job definition.
$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. 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_status :: Lens' JobDefinition (Maybe Text) Source #
The status of the job definition.
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 during task
creation. For tags with the same name, job tags are given priority over
job definitions tags. If the total number of combined tags from the job
and job definition is over 50, the job is moved to the FAILED state.
jobDefinition_retryStrategy :: Lens' JobDefinition (Maybe RetryStrategy) Source #
The retry strategy to use for failed jobs that are submitted with this job definition.
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_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_timeout :: Lens' JobDefinition (Maybe JobTimeout) Source #
The timeout configuration for jobs that are submitted with this job definition. You can specify a timeout duration after which Batch terminates your jobs if they haven't finished.
jobDefinition_containerProperties :: Lens' JobDefinition (Maybe ContainerProperties) Source #
An object with various properties specific to container-based jobs.
jobDefinition_nodeProperties :: Lens' JobDefinition (Maybe NodeProperties) Source #
An object with various properties specific to multi-node parallel jobs.
If the job runs on Fargate resources, then you must not specify
nodeProperties; use containerProperties instead.
jobDefinition_tags :: Lens' JobDefinition (Maybe (HashMap Text Text)) Source #
The tags applied to the job definition.
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. 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 representing 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 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 associated with this dependency.
jobDependency_type :: Lens' JobDependency (Maybe ArrayJobDependency) Source #
The type of the job dependency.
JobDetail
An object representing 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:stoppedAt:JobDetail', jobDetail_stoppedAt - The Unix timestamp (in milliseconds) for when the job was stopped (when
the job transitioned from the RUNNING state to a terminal state, such
as SUCCEEDED or FAILED).
$sel:jobArn:JobDetail', jobDetail_jobArn - The Amazon Resource Name (ARN) of the job.
$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 during task
creation. For tags with the same name, job tags are given priority over
job definitions tags. If the total number of combined tags from the job
and job definition is over 50, the job is moved to the FAILED state.
$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 (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:retryStrategy:JobDetail', jobDetail_retryStrategy - The retry strategy to use for this job if an attempt fails.
$sel:attempts:JobDetail', jobDetail_attempts - A list of job attempts associated with this job.
$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:startedAt:JobDetail', jobDetail_startedAt - The Unix timestamp (in milliseconds) for when the job was started (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.
$sel:dependsOn:JobDetail', jobDetail_dependsOn - A list of job IDs that this job depends on.
$sel:container:JobDetail', jobDetail_container - An object representing the details of the container that's associated
with the job.
$sel:nodeDetails:JobDetail', jobDetail_nodeDetails - An object representing the details of a node that's associated with a
multi-node parallel job.
$sel:parameters:JobDetail', jobDetail_parameters - Additional parameters passed to the job that replace parameter
substitution placeholders or override any corresponding parameter
defaults from the job definition.
$sel:statusReason:JobDetail', jobDetail_statusReason - A short, human-readable string to provide additional details about the
current status of the job.
$sel:arrayProperties:JobDetail', jobDetail_arrayProperties - The array properties of the job, if it is an array job.
$sel:timeout:JobDetail', jobDetail_timeout - The timeout configuration for the job.
$sel:nodeProperties:JobDetail', jobDetail_nodeProperties - An object representing the node properties of a multi-node parallel job.
This isn't applicable to jobs that are running on Fargate resources.
$sel:tags:JobDetail', jobDetail_tags - The tags applied to the job.
$sel:jobName:JobDetail', jobDetail_jobName - The name of the job.
$sel:jobId:JobDetail', jobDetail_jobId - The ID for the job.
$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 job definition that's used by this job.
jobDetail_stoppedAt :: Lens' JobDetail (Maybe Integer) Source #
The Unix timestamp (in milliseconds) for when the job was stopped (when
the job transitioned from the RUNNING state to a terminal state, such
as SUCCEEDED or FAILED).
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 during task
creation. For tags with the same name, job tags are given priority over
job definitions tags. If the total number of combined tags from the job
and job definition is over 50, the job is moved to the FAILED state.
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 (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_retryStrategy :: Lens' JobDetail (Maybe RetryStrategy) Source #
The retry strategy to use for this job if an attempt fails.
jobDetail_attempts :: Lens' JobDetail (Maybe [AttemptDetail]) Source #
A list of job attempts associated with this job.
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_startedAt :: Lens' JobDetail (Maybe Integer) Source #
The Unix timestamp (in milliseconds) for when the job was started (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_dependsOn :: Lens' JobDetail (Maybe [JobDependency]) Source #
A list of job IDs that this job depends on.
jobDetail_container :: Lens' JobDetail (Maybe ContainerDetail) Source #
An object representing the details of the container that's associated with the job.
jobDetail_nodeDetails :: Lens' JobDetail (Maybe NodeDetails) Source #
An object representing the details of a node that's associated with a multi-node parallel job.
jobDetail_parameters :: Lens' JobDetail (Maybe (HashMap Text Text)) Source #
Additional parameters passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.
jobDetail_statusReason :: Lens' JobDetail (Maybe Text) Source #
A short, human-readable string to provide additional details about the current status of the job.
jobDetail_arrayProperties :: Lens' JobDetail (Maybe ArrayPropertiesDetail) Source #
The array properties of the job, if it is an array job.
jobDetail_timeout :: Lens' JobDetail (Maybe JobTimeout) Source #
The timeout configuration for the job.
jobDetail_nodeProperties :: Lens' JobDetail (Maybe NodeProperties) Source #
An object representing the node properties of a multi-node parallel job.
This isn't applicable to jobs that are running on Fargate resources.
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.
JobQueueDetail
data JobQueueDetail Source #
An object representing the details of 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: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 about the
current status of the job queue.
$sel:tags:JobQueueDetail', jobQueueDetail_tags - The tags applied to the job queue. For more information, see
Tagging your Batch resources
in Batch User Guide.
$sel:jobQueueName:JobQueueDetail', jobQueueDetail_jobQueueName - The name of the job queue.
$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's able to accept jobs. If the job queue state is
DISABLED, new jobs can't be added to the queue, but jobs already in
the queue can finish.
$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_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 about the current status of the job queue.
jobQueueDetail_tags :: Lens' JobQueueDetail (Maybe (HashMap Text Text)) Source #
The tags applied to the job queue. For more information, see Tagging your Batch resources in Batch User Guide.
jobQueueDetail_jobQueueName :: Lens' JobQueueDetail Text Source #
The name of the job queue.
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's able to accept jobs. If the job queue state is
DISABLED, new jobs can't be added to the queue, but jobs already in
the queue can finish.
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 representing 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:stoppedAt:JobSummary', jobSummary_stoppedAt - The Unix timestamp for when the job was stopped (when the job
transitioned from the RUNNING state to a terminal state, such as
SUCCEEDED or FAILED).
$sel:status:JobSummary', jobSummary_status - The current status for the job.
$sel:jobArn:JobSummary', jobSummary_jobArn - The Amazon Resource Name (ARN) of the job.
$sel:createdAt:JobSummary', jobSummary_createdAt - The Unix timestamp 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:startedAt:JobSummary', jobSummary_startedAt - The Unix timestamp for when the job was started (when the job
transitioned from the STARTING state to the RUNNING state).
$sel:container:JobSummary', jobSummary_container - An object representing the details of the container that's associated
with the job.
$sel:jobDefinition:JobSummary', jobSummary_jobDefinition - The Amazon Resource Name (ARN) of the job definition.
$sel:statusReason:JobSummary', jobSummary_statusReason - A short, human-readable string to provide additional details about the
current status of the job.
$sel:arrayProperties:JobSummary', jobSummary_arrayProperties - The array properties of the job, if it is an array job.
$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:jobId:JobSummary', jobSummary_jobId - The ID of the job.
$sel:jobName:JobSummary', jobSummary_jobName - The name of the job.
jobSummary_stoppedAt :: Lens' JobSummary (Maybe Integer) Source #
The Unix timestamp for when the job was stopped (when the job
transitioned from the RUNNING state to a terminal state, such as
SUCCEEDED or FAILED).
jobSummary_status :: Lens' JobSummary (Maybe JobStatus) Source #
The current status for the job.
jobSummary_jobArn :: Lens' JobSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the job.
jobSummary_createdAt :: Lens' JobSummary (Maybe Integer) Source #
The Unix timestamp 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_startedAt :: Lens' JobSummary (Maybe Integer) Source #
The Unix timestamp for when the job was started (when the job
transitioned from the STARTING state to the RUNNING state).
jobSummary_container :: Lens' JobSummary (Maybe ContainerSummary) Source #
An object representing the details of the container that's associated with the job.
jobSummary_jobDefinition :: Lens' JobSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the job definition.
jobSummary_statusReason :: Lens' JobSummary (Maybe Text) Source #
A short, human-readable string to provide additional details about the current status of the job.
jobSummary_arrayProperties :: Lens' JobSummary (Maybe ArrayPropertiesSummary) Source #
The array properties of the job, if it is an array job.
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_jobId :: Lens' JobSummary Text Source #
The ID of the job.
jobSummary_jobName :: Lens' JobSummary Text Source #
The name of the job.
JobTimeout
data JobTimeout Source #
An object representing 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 time duration in seconds (measured from the job attempt's
startedAt timestamp) after which Batch terminates your jobs if they
have not finished. The minimum value for the timeout is 60 seconds.
jobTimeout_attemptDurationSeconds :: Lens' JobTimeout (Maybe Int) Source #
The time duration in seconds (measured from the job attempt's
startedAt timestamp) after which Batch terminates your jobs if they
have not finished. The minimum value for the timeout is 60 seconds.
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:value:KeyValuePair', keyValuePair_value - The value of the key-value pair. For environment variables, this is the
value of the environment variable.
$sel:name:KeyValuePair', keyValuePair_name - 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.
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.
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:values:KeyValuesPair', keyValuesPair_values - The filter values.
$sel:name:KeyValuesPair', keyValuesPair_name - The name of the filter. Filter names are case sensitive.
keyValuesPair_values :: Lens' KeyValuesPair (Maybe [Text]) Source #
The filter values.
keyValuesPair_name :: Lens' KeyValuesPair (Maybe Text) Source #
The name of the filter. Filter names are case sensitive.
LaunchTemplateSpecification
data LaunchTemplateSpecification Source #
An object representing a launch template 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:launchTemplateName:LaunchTemplateSpecification', launchTemplateSpecification_launchTemplateName - The name of the launch template.
$sel:launchTemplateId:LaunchTemplateSpecification', launchTemplateSpecification_launchTemplateId - The ID 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.
After the compute environment is created, the launch template version
that's used isn't changed, even if the $Default or $Latest version
for the launch template is updated. To use a new launch template
version, create a new compute environment, add the new compute
environment to the existing job queue, remove the old compute
environment from the job queue, and delete the old compute environment.
Default: $Default.
launchTemplateSpecification_launchTemplateName :: Lens' LaunchTemplateSpecification (Maybe Text) Source #
The name of the launch template.
launchTemplateSpecification_launchTemplateId :: Lens' LaunchTemplateSpecification (Maybe Text) Source #
The ID 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.
After the compute environment is created, the launch template version
that's used isn't changed, even if the $Default or $Latest version
for the launch template is updated. To use a new launch template
version, create a new compute environment, add the new compute
environment to the existing job queue, remove the old compute
environment from the job queue, and delete the old compute environment.
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: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 and shouldn't be provided.
$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 into your container instance and run the
following command: sudo docker version | grep "Server API version"
$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 and shouldn't be provided.
$sel:swappiness:LinuxParameters', linuxParameters_swappiness - This allows you to tune a container's memory swappiness behavior. A
swappiness value of 0 causes swapping not to happen unless
absolutely necessary. A swappiness value of 100 causes pages to be
swapped very aggressively. Accepted 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.
The Amazon ECS optimized AMIs don't have swap enabled by default. 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 will have a defaultswappinessvalue of 60, and the total swap usage will be limited to two times the memory reservation of the container.
This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
$sel:devices:LinuxParameters', linuxParameters_devices - Any 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 and shouldn't be provided.
$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 it is 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 and shouldn't be provided.
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 and shouldn't be provided.
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 into your container instance and run the
following command: sudo docker version | grep "Server API version"
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 and shouldn't be provided.
linuxParameters_swappiness :: Lens' LinuxParameters (Maybe Int) Source #
This allows you to tune a container's memory swappiness behavior. A
swappiness value of 0 causes swapping not to happen unless
absolutely necessary. A swappiness value of 100 causes pages to be
swapped very aggressively. Accepted 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.
The Amazon ECS optimized AMIs don't have swap enabled by default. 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 will have a defaultswappinessvalue of 60, and the total swap usage will be limited to two times the memory reservation of the container.
This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
linuxParameters_devices :: Lens' LinuxParameters (Maybe [Device]) Source #
Any 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 and shouldn't be provided.
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 it is 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 and shouldn't be provided.
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 into 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 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 into 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 into 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 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 into your container instance and run the
following command: sudo docker version | grep "Server API version"
MountPoint
data MountPoint Source #
Details on 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:sourceVolume:MountPoint', mountPoint_sourceVolume - The name of the volume to mount.
$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.
mountPoint_containerPath :: Lens' MountPoint (Maybe Text) Source #
The path on the container where the host volume is mounted.
mountPoint_sourceVolume :: Lens' MountPoint (Maybe Text) Source #
The name of the volume to mount.
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.
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 should have a public IP address. For a job
that is 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.
The default value is "DISABLED".
networkConfiguration_assignPublicIp :: Lens' NetworkConfiguration (Maybe AssignPublicIp) Source #
Indicates whether the job should have a public IP address. For a job that is 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. The default value is "DISABLED".
NetworkInterface
data NetworkInterface Source #
An object representing 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: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.
$sel:attachmentId:NetworkInterface', networkInterface_attachmentId - 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.
networkInterface_attachmentId :: Lens' NetworkInterface (Maybe Text) Source #
The attachment ID for the network interface.
NodeDetails
data NodeDetails Source #
An object representing 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:nodeIndex:NodeDetails', nodeDetails_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:isMainNode:NodeDetails', nodeDetails_isMainNode - 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 begins 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.
NodeOverrides
data NodeOverrides Source #
Object representing any node overrides to a job definition that's used in a SubmitJob API operation.
This isn't applicable to jobs that are running on Fargate resources and
shouldn't be provided; 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: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:
- 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 specified in the job definition must be fewer than the number of nodes specified in the override.
- The main node index specified in the job definition must be fewer than the number of nodes specified in the override.
$sel:nodePropertyOverrides:NodeOverrides', nodeOverrides_nodePropertyOverrides - 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:
- 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 specified in the job definition must be fewer than the number of nodes specified in the override.
- The main node index 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.
NodeProperties
data NodeProperties Source #
An object representing the node properties of a multi-node parallel job.
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 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 associated with a multi-node
parallel job.
nodeProperties_numNodes :: Lens' NodeProperties Int Source #
The number of nodes 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 associated with a multi-node parallel job.
NodePropertiesSummary
data NodePropertiesSummary Source #
An object representing 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:numNodes:NodePropertiesSummary', nodePropertiesSummary_numNodes - The number of nodes associated with 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:isMainNode:NodePropertiesSummary', nodePropertiesSummary_isMainNode - Specifies whether the current node is the main node for a multi-node
parallel job.
nodePropertiesSummary_numNodes :: Lens' NodePropertiesSummary (Maybe Int) Source #
The number of nodes associated with 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_isMainNode :: Lens' NodePropertiesSummary (Maybe Bool) Source #
Specifies whether the current node is the main node for a multi-node parallel job.
NodePropertyOverride
data NodePropertyOverride Source #
Object representing 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 should be 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 should be 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 representing 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 which 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 which 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. The number
of GPUs reserved for all containers in a job shouldn't exceed the
number of available GPUs on the compute resource that the job is
launched on.
GPUs are not 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, or 4- value = 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384
VCPU= 2 or 4- value = 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720
VCPU= 4
- 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.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 that VCPU value. The supported values are 0.25, 0.5, 1, 2, and 4- 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
$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. The number
of GPUs reserved for all containers in a job shouldn't exceed the
number of available GPUs on the compute resource that the job is
launched on.
GPUs are not 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, or 4- value = 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384
VCPU= 2 or 4- value = 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720
VCPU= 4
- 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.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 that VCPU value. The supported values are 0.25, 0.5, 1, 2, and 4- 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
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 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:evaluateOnExit:RetryStrategy', retryStrategy_evaluateOnExit - Array of up to 5 objects that specify conditions under which the job
should be retried or failed. If this parameter is specified, then the
attempts parameter must also be specified.
$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.
retryStrategy_evaluateOnExit :: Lens' RetryStrategy (Maybe [EvaluateOnExit]) Source #
Array of up to 5 objects that specify conditions under which the job
should be retried or failed. If this parameter is specified, then the
attempts parameter must also be specified.
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.
Secret
An object representing 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
| Eq Secret Source # | |
| Read Secret Source # | |
| Show Secret Source # | |
| Generic Secret Source # | |
| NFData Secret Source # | |
Defined in Amazonka.Batch.Types.Secret | |
| Hashable Secret Source # | |
Defined in Amazonka.Batch.Types.Secret | |
| ToJSON Secret Source # | |
Defined in Amazonka.Batch.Types.Secret | |
| FromJSON Secret Source # | |
| type Rep Secret Source # | |
Defined in Amazonka.Batch.Types.Secret type Rep Secret = D1 ('MetaData "Secret" "Amazonka.Batch.Types.Secret" "libZSservicesZSamazonka-batchZSamazonka-batch" '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 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 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 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 ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
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
| Eq Tmpfs Source # | |
| Read Tmpfs Source # | |
| Show Tmpfs Source # | |
| Generic Tmpfs Source # | |
| NFData Tmpfs Source # | |
Defined in Amazonka.Batch.Types.Tmpfs | |
| Hashable Tmpfs Source # | |
Defined in Amazonka.Batch.Types.Tmpfs | |
| ToJSON Tmpfs Source # | |
Defined in Amazonka.Batch.Types.Tmpfs | |
| FromJSON Tmpfs Source # | |
| type Rep Tmpfs Source # | |
Defined in Amazonka.Batch.Types.Tmpfs type Rep Tmpfs = D1 ('MetaData "Tmpfs" "Amazonka.Batch.Types.Tmpfs" "libZSservicesZSamazonka-batchZSamazonka-batch" '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
| Eq Ulimit Source # | |
| Read Ulimit Source # | |
| Show Ulimit Source # | |
| Generic Ulimit Source # | |
| NFData Ulimit Source # | |
Defined in Amazonka.Batch.Types.Ulimit | |
| Hashable Ulimit Source # | |
Defined in Amazonka.Batch.Types.Ulimit | |
| ToJSON Ulimit Source # | |
Defined in Amazonka.Batch.Types.Ulimit | |
| FromJSON Ulimit Source # | |
| type Rep Ulimit Source # | |
Defined in Amazonka.Batch.Types.Ulimit type Rep Ulimit = D1 ('MetaData "Ulimit" "Amazonka.Batch.Types.Ulimit" "libZSservicesZSamazonka-batchZSamazonka-batch" '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.
Volume
A data volume used in a job's container properties.
See: newVolume smart constructor.
Constructors
| Volume' | |
Fields
| |
Instances
| Eq Volume Source # | |
| Read Volume Source # | |
| Show Volume Source # | |
| Generic Volume Source # | |
| NFData Volume Source # | |
Defined in Amazonka.Batch.Types.Volume | |
| Hashable Volume Source # | |
Defined in Amazonka.Batch.Types.Volume | |
| ToJSON Volume Source # | |
Defined in Amazonka.Batch.Types.Volume | |
| FromJSON Volume Source # | |
| type Rep Volume Source # | |
Defined in Amazonka.Batch.Types.Volume type Rep Volume = D1 ('MetaData "Volume" "Amazonka.Batch.Types.Volume" "libZSservicesZSamazonka-batchZSamazonka-batch" 'False) (C1 ('MetaCons "Volume'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "efsVolumeConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EFSVolumeConfiguration)) :*: S1 ('MetaSel ('Just "host") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Host))))) | |
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:name:Volume', volume_name - The name of the volume. Up to 255 letters (uppercase and lowercase),
numbers, hyphens, and underscores are allowed. This name is referenced
in the sourceVolume parameter of container definition mountPoints.
$sel:efsVolumeConfiguration:Volume', volume_efsVolumeConfiguration - This parameter is specified when you are 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 is 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 associated with it stop running.
This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
volume_name :: Lens' Volume (Maybe Text) Source #
The name of the volume. Up to 255 letters (uppercase and lowercase),
numbers, hyphens, and underscores are allowed. 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 are 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 is 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 associated with it stop running.
This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.