Skip to content

Type definitions#

Index > Batch > Type definitions

Auto-generated documentation for Batch type annotations stubs module mypy-boto3-batch.

ArrayPropertiesDetailTypeDef#

# ArrayPropertiesDetailTypeDef definition

class ArrayPropertiesDetailTypeDef(TypedDict):
    statusSummary: NotRequired[Dict[str, int]],
    size: NotRequired[int],
    index: NotRequired[int],

ArrayPropertiesSummaryTypeDef#

# ArrayPropertiesSummaryTypeDef definition

class ArrayPropertiesSummaryTypeDef(TypedDict):
    size: NotRequired[int],
    index: NotRequired[int],

ArrayPropertiesTypeDef#

# ArrayPropertiesTypeDef definition

class ArrayPropertiesTypeDef(TypedDict):
    size: NotRequired[int],

NetworkInterfaceTypeDef#

# NetworkInterfaceTypeDef definition

class NetworkInterfaceTypeDef(TypedDict):
    attachmentId: NotRequired[str],
    ipv6Address: NotRequired[str],
    privateIpv4Address: NotRequired[str],

CancelJobRequestRequestTypeDef#

# CancelJobRequestRequestTypeDef definition

class CancelJobRequestRequestTypeDef(TypedDict):
    jobId: str,
    reason: str,

EksConfigurationTypeDef#

# EksConfigurationTypeDef definition

class EksConfigurationTypeDef(TypedDict):
    eksClusterArn: str,
    kubernetesNamespace: str,

UpdatePolicyTypeDef#

# UpdatePolicyTypeDef definition

class UpdatePolicyTypeDef(TypedDict):
    terminateJobsOnUpdate: NotRequired[bool],
    jobExecutionTimeoutMinutes: NotRequired[int],

ComputeEnvironmentOrderTypeDef#

# ComputeEnvironmentOrderTypeDef definition

class ComputeEnvironmentOrderTypeDef(TypedDict):
    order: int,
    computeEnvironment: str,

Ec2ConfigurationTypeDef#

# Ec2ConfigurationTypeDef definition

class Ec2ConfigurationTypeDef(TypedDict):
    imageType: str,
    imageIdOverride: NotRequired[str],
    imageKubernetesVersion: NotRequired[str],

LaunchTemplateSpecificationTypeDef#

# LaunchTemplateSpecificationTypeDef definition

class LaunchTemplateSpecificationTypeDef(TypedDict):
    launchTemplateId: NotRequired[str],
    launchTemplateName: NotRequired[str],
    version: NotRequired[str],

EphemeralStorageTypeDef#

# EphemeralStorageTypeDef definition

class EphemeralStorageTypeDef(TypedDict):
    sizeInGiB: int,

FargatePlatformConfigurationTypeDef#

# FargatePlatformConfigurationTypeDef definition

class FargatePlatformConfigurationTypeDef(TypedDict):
    platformVersion: NotRequired[str],

KeyValuePairTypeDef#

# KeyValuePairTypeDef definition

class KeyValuePairTypeDef(TypedDict):
    name: NotRequired[str],
    value: NotRequired[str],

MountPointTypeDef#

# MountPointTypeDef definition

class MountPointTypeDef(TypedDict):
    containerPath: NotRequired[str],
    readOnly: NotRequired[bool],
    sourceVolume: NotRequired[str],

NetworkConfigurationTypeDef#

# NetworkConfigurationTypeDef definition

class NetworkConfigurationTypeDef(TypedDict):
    assignPublicIp: NotRequired[AssignPublicIpType],  # (1)
  1. See AssignPublicIpType

RepositoryCredentialsTypeDef#

# RepositoryCredentialsTypeDef definition

class RepositoryCredentialsTypeDef(TypedDict):
    credentialsParameter: str,

ResourceRequirementTypeDef#

# ResourceRequirementTypeDef definition

class ResourceRequirementTypeDef(TypedDict):
    value: str,
    type: ResourceTypeType,  # (1)
  1. See ResourceTypeType

RuntimePlatformTypeDef#

# RuntimePlatformTypeDef definition

class RuntimePlatformTypeDef(TypedDict):
    operatingSystemFamily: NotRequired[str],
    cpuArchitecture: NotRequired[str],

SecretTypeDef#

# SecretTypeDef definition

class SecretTypeDef(TypedDict):
    name: str,
    valueFrom: str,

UlimitTypeDef#

# UlimitTypeDef definition

class UlimitTypeDef(TypedDict):
    hardLimit: int,
    name: str,
    softLimit: int,

ContainerSummaryTypeDef#

# ContainerSummaryTypeDef definition

class ContainerSummaryTypeDef(TypedDict):
    exitCode: NotRequired[int],
    reason: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

DeleteComputeEnvironmentRequestRequestTypeDef#

# DeleteComputeEnvironmentRequestRequestTypeDef definition

class DeleteComputeEnvironmentRequestRequestTypeDef(TypedDict):
    computeEnvironment: str,

DeleteJobQueueRequestRequestTypeDef#

# DeleteJobQueueRequestRequestTypeDef definition

class DeleteJobQueueRequestRequestTypeDef(TypedDict):
    jobQueue: str,

DeleteSchedulingPolicyRequestRequestTypeDef#

# DeleteSchedulingPolicyRequestRequestTypeDef definition

class DeleteSchedulingPolicyRequestRequestTypeDef(TypedDict):
    arn: str,

DeregisterJobDefinitionRequestRequestTypeDef#

# DeregisterJobDefinitionRequestRequestTypeDef definition

class DeregisterJobDefinitionRequestRequestTypeDef(TypedDict):
    jobDefinition: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

DescribeComputeEnvironmentsRequestRequestTypeDef#

# DescribeComputeEnvironmentsRequestRequestTypeDef definition

class DescribeComputeEnvironmentsRequestRequestTypeDef(TypedDict):
    computeEnvironments: NotRequired[Sequence[str]],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

DescribeJobDefinitionsRequestRequestTypeDef#

# DescribeJobDefinitionsRequestRequestTypeDef definition

class DescribeJobDefinitionsRequestRequestTypeDef(TypedDict):
    jobDefinitions: NotRequired[Sequence[str]],
    maxResults: NotRequired[int],
    jobDefinitionName: NotRequired[str],
    status: NotRequired[str],
    nextToken: NotRequired[str],

DescribeJobQueuesRequestRequestTypeDef#

# DescribeJobQueuesRequestRequestTypeDef definition

class DescribeJobQueuesRequestRequestTypeDef(TypedDict):
    jobQueues: NotRequired[Sequence[str]],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

DescribeJobsRequestRequestTypeDef#

# DescribeJobsRequestRequestTypeDef definition

class DescribeJobsRequestRequestTypeDef(TypedDict):
    jobs: Sequence[str],

DescribeSchedulingPoliciesRequestRequestTypeDef#

# DescribeSchedulingPoliciesRequestRequestTypeDef definition

class DescribeSchedulingPoliciesRequestRequestTypeDef(TypedDict):
    arns: Sequence[str],

DeviceTypeDef#

# DeviceTypeDef definition

class DeviceTypeDef(TypedDict):
    hostPath: str,
    containerPath: NotRequired[str],
    permissions: NotRequired[List[DeviceCgroupPermissionType]],  # (1)
  1. See DeviceCgroupPermissionType

EFSAuthorizationConfigTypeDef#

# EFSAuthorizationConfigTypeDef definition

class EFSAuthorizationConfigTypeDef(TypedDict):
    accessPointId: NotRequired[str],
    iam: NotRequired[EFSAuthorizationConfigIAMType],  # (1)
  1. See EFSAuthorizationConfigIAMType

EksAttemptContainerDetailTypeDef#

# EksAttemptContainerDetailTypeDef definition

class EksAttemptContainerDetailTypeDef(TypedDict):
    exitCode: NotRequired[int],
    reason: NotRequired[str],

EksContainerEnvironmentVariableTypeDef#

# EksContainerEnvironmentVariableTypeDef definition

class EksContainerEnvironmentVariableTypeDef(TypedDict):
    name: str,
    value: NotRequired[str],

EksContainerResourceRequirementsTypeDef#

# EksContainerResourceRequirementsTypeDef definition

class EksContainerResourceRequirementsTypeDef(TypedDict):
    limits: NotRequired[Dict[str, str]],
    requests: NotRequired[Dict[str, str]],

EksContainerSecurityContextTypeDef#

# EksContainerSecurityContextTypeDef definition

class EksContainerSecurityContextTypeDef(TypedDict):
    runAsUser: NotRequired[int],
    runAsGroup: NotRequired[int],
    privileged: NotRequired[bool],
    readOnlyRootFilesystem: NotRequired[bool],
    runAsNonRoot: NotRequired[bool],

EksContainerVolumeMountTypeDef#

# EksContainerVolumeMountTypeDef definition

class EksContainerVolumeMountTypeDef(TypedDict):
    name: NotRequired[str],
    mountPath: NotRequired[str],
    readOnly: NotRequired[bool],

EksEmptyDirTypeDef#

# EksEmptyDirTypeDef definition

class EksEmptyDirTypeDef(TypedDict):
    medium: NotRequired[str],
    sizeLimit: NotRequired[str],

EksHostPathTypeDef#

# EksHostPathTypeDef definition

class EksHostPathTypeDef(TypedDict):
    path: NotRequired[str],

EksMetadataTypeDef#

# EksMetadataTypeDef definition

class EksMetadataTypeDef(TypedDict):
    labels: NotRequired[Dict[str, str]],

EksSecretTypeDef#

# EksSecretTypeDef definition

class EksSecretTypeDef(TypedDict):
    secretName: str,
    optional: NotRequired[bool],

EvaluateOnExitTypeDef#

# EvaluateOnExitTypeDef definition

class EvaluateOnExitTypeDef(TypedDict):
    action: RetryActionType,  # (1)
    onStatusReason: NotRequired[str],
    onReason: NotRequired[str],
    onExitCode: NotRequired[str],
  1. See RetryActionType

ShareAttributesTypeDef#

# ShareAttributesTypeDef definition

class ShareAttributesTypeDef(TypedDict):
    shareIdentifier: str,
    weightFactor: NotRequired[float],

HostTypeDef#

# HostTypeDef definition

class HostTypeDef(TypedDict):
    sourcePath: NotRequired[str],

JobTimeoutTypeDef#

# JobTimeoutTypeDef definition

class JobTimeoutTypeDef(TypedDict):
    attemptDurationSeconds: NotRequired[int],

JobDependencyTypeDef#

# JobDependencyTypeDef definition

class JobDependencyTypeDef(TypedDict):
    jobId: NotRequired[str],
    type: NotRequired[ArrayJobDependencyType],  # (1)
  1. See ArrayJobDependencyType

NodeDetailsTypeDef#

# NodeDetailsTypeDef definition

class NodeDetailsTypeDef(TypedDict):
    nodeIndex: NotRequired[int],
    isMainNode: NotRequired[bool],

NodePropertiesSummaryTypeDef#

# NodePropertiesSummaryTypeDef definition

class NodePropertiesSummaryTypeDef(TypedDict):
    isMainNode: NotRequired[bool],
    numNodes: NotRequired[int],
    nodeIndex: NotRequired[int],

KeyValuesPairTypeDef#

# KeyValuesPairTypeDef definition

class KeyValuesPairTypeDef(TypedDict):
    name: NotRequired[str],
    values: NotRequired[Sequence[str]],

TmpfsTypeDef#

# TmpfsTypeDef definition

class TmpfsTypeDef(TypedDict):
    containerPath: str,
    size: int,
    mountOptions: NotRequired[List[str]],

ListSchedulingPoliciesRequestRequestTypeDef#

# ListSchedulingPoliciesRequestRequestTypeDef definition

class ListSchedulingPoliciesRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

SchedulingPolicyListingDetailTypeDef#

# SchedulingPolicyListingDetailTypeDef definition

class SchedulingPolicyListingDetailTypeDef(TypedDict):
    arn: str,

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

TaskContainerDependencyTypeDef#

# TaskContainerDependencyTypeDef definition

class TaskContainerDependencyTypeDef(TypedDict):
    containerName: NotRequired[str],
    condition: NotRequired[str],

TerminateJobRequestRequestTypeDef#

# TerminateJobRequestRequestTypeDef definition

class TerminateJobRequestRequestTypeDef(TypedDict):
    jobId: str,
    reason: str,

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

AttemptContainerDetailTypeDef#

# AttemptContainerDetailTypeDef definition

class AttemptContainerDetailTypeDef(TypedDict):
    containerInstanceArn: NotRequired[str],
    taskArn: NotRequired[str],
    exitCode: NotRequired[int],
    reason: NotRequired[str],
    logStreamName: NotRequired[str],
    networkInterfaces: NotRequired[List[NetworkInterfaceTypeDef]],  # (1)
  1. See NetworkInterfaceTypeDef

CreateJobQueueRequestRequestTypeDef#

# CreateJobQueueRequestRequestTypeDef definition

class CreateJobQueueRequestRequestTypeDef(TypedDict):
    jobQueueName: str,
    priority: int,
    computeEnvironmentOrder: Sequence[ComputeEnvironmentOrderTypeDef],  # (1)
    state: NotRequired[JQStateType],  # (2)
    schedulingPolicyArn: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
  1. See ComputeEnvironmentOrderTypeDef
  2. See JQStateType

JobQueueDetailTypeDef#

# JobQueueDetailTypeDef definition

class JobQueueDetailTypeDef(TypedDict):
    jobQueueName: str,
    jobQueueArn: str,
    state: JQStateType,  # (1)
    priority: int,
    computeEnvironmentOrder: List[ComputeEnvironmentOrderTypeDef],  # (3)
    schedulingPolicyArn: NotRequired[str],
    status: NotRequired[JQStatusType],  # (2)
    statusReason: NotRequired[str],
    tags: NotRequired[Dict[str, str]],
  1. See JQStateType
  2. See JQStatusType
  3. See ComputeEnvironmentOrderTypeDef

UpdateJobQueueRequestRequestTypeDef#

# UpdateJobQueueRequestRequestTypeDef definition

class UpdateJobQueueRequestRequestTypeDef(TypedDict):
    jobQueue: str,
    state: NotRequired[JQStateType],  # (1)
    schedulingPolicyArn: NotRequired[str],
    priority: NotRequired[int],
    computeEnvironmentOrder: NotRequired[Sequence[ComputeEnvironmentOrderTypeDef]],  # (2)
  1. See JQStateType
  2. See ComputeEnvironmentOrderTypeDef

ComputeResourcePaginatorTypeDef#

# ComputeResourcePaginatorTypeDef definition

class ComputeResourcePaginatorTypeDef(TypedDict):
    type: CRTypeType,  # (1)
    maxvCpus: int,
    subnets: List[str],
    allocationStrategy: NotRequired[CRAllocationStrategyType],  # (2)
    minvCpus: NotRequired[int],
    desiredvCpus: NotRequired[int],
    instanceTypes: NotRequired[List[str]],
    imageId: NotRequired[str],
    securityGroupIds: NotRequired[List[str]],
    ec2KeyPair: NotRequired[str],
    instanceRole: NotRequired[str],
    tags: NotRequired[Dict[str, str]],
    placementGroup: NotRequired[str],
    bidPercentage: NotRequired[int],
    spotIamFleetRole: NotRequired[str],
    launchTemplate: NotRequired[LaunchTemplateSpecificationTypeDef],  # (3)
    ec2Configuration: NotRequired[List[Ec2ConfigurationTypeDef]],  # (4)
  1. See CRTypeType
  2. See CRAllocationStrategyType
  3. See LaunchTemplateSpecificationTypeDef
  4. See Ec2ConfigurationTypeDef

ComputeResourceTyp