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],

JobStateTimeLimitActionTypeDef#

# JobStateTimeLimitActionTypeDef definition

class JobStateTimeLimitActionTypeDef(TypedDict):
    reason: str,
    state: JobStateTimeLimitActionsStateType,  # (1)
    maxTimeSeconds: int,
    action: JobStateTimeLimitActionsActionType,  # (2)
  1. See JobStateTimeLimitActionsStateType
  2. See JobStateTimeLimitActionsActionType

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

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

ComputeResourceTypeDef#

# ComputeResourceTypeDef definition

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

ComputeResourceUpdateTypeDef#

# ComputeResourceUpdateTypeDef definition

class ComputeResourceUpdateTypeDef(TypedDict):
    minvCpus: NotRequired[int],
    maxvCpus: NotRequired[int],
    desiredvCpus: NotRequired[int],
    subnets: NotRequired[Sequence[str]],
    securityGroupIds: NotRequired[Sequence[str]],
    allocationStrategy: NotRequired[CRUpdateAllocationStrategyType],  # (1)
    instanceTypes: NotRequired[Sequence[str]],
    ec2KeyPair: NotRequired[str],
    instanceRole: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
    placementGroup: NotRequired[str],
    bidPercentage: NotRequired[int],
    launchTemplate: NotRequired[LaunchTemplateSpecificationTypeDef],  # (2)
    ec2Configuration: NotRequired[Sequence[Ec2ConfigurationTypeDef]],  # (3)
    updateToLatestImageVersion: NotRequired[bool],
    type: NotRequired[CRTypeType],  # (4)
    imageId: NotRequired[str],
  1. See CRUpdateAllocationStrategyType
  2. See LaunchTemplateSpecificationTypeDef
  3. See Ec2ConfigurationTypeDef
  4. See CRTypeType

ContainerOverridesTypeDef#

# ContainerOverridesTypeDef definition

class ContainerOverridesTypeDef(TypedDict):
    vcpus: NotRequired[int],
    memory: NotRequired[int],
    command: NotRequired[Sequence[str]],
    instanceType: NotRequired[str],
    environment: NotRequired[Sequence[KeyValuePairTypeDef]],  # (1)
    resourceRequirements: NotRequired[Sequence[ResourceRequirementTypeDef]],  # (2)
  1. See KeyValuePairTypeDef
  2. See ResourceRequirementTypeDef

TaskContainerOverridesTypeDef#

# TaskContainerOverridesTypeDef definition

class TaskContainerOverridesTypeDef(TypedDict):
    command: NotRequired[Sequence[str]],
    environment: NotRequired[Sequence[KeyValuePairTypeDef]],  # (1)
    name: NotRequired[str],
    resourceRequirements: NotRequired[Sequence[ResourceRequirementTypeDef]],  # (2)
  1. See KeyValuePairTypeDef
  2. See ResourceRequirementTypeDef

LogConfigurationTypeDef#

# LogConfigurationTypeDef definition

class LogConfigurationTypeDef(TypedDict):
    logDriver: LogDriverType,  # (1)
    options: NotRequired[Dict[str, str]],
    secretOptions: NotRequired[List[SecretTypeDef]],  # (2)
  1. See LogDriverType
  2. See SecretTypeDef

CreateComputeEnvironmentResponseTypeDef#

# CreateComputeEnvironmentResponseTypeDef definition

class CreateComputeEnvironmentResponseTypeDef(TypedDict):
    computeEnvironmentName: str,
    computeEnvironmentArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateJobQueueResponseTypeDef#

# CreateJobQueueResponseTypeDef definition

class CreateJobQueueResponseTypeDef(TypedDict):
    jobQueueName: str,
    jobQueueArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateSchedulingPolicyResponseTypeDef#

# CreateSchedulingPolicyResponseTypeDef definition

class CreateSchedulingPolicyResponseTypeDef(TypedDict):
    name: str,
    arn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RegisterJobDefinitionResponseTypeDef#

# RegisterJobDefinitionResponseTypeDef definition

class RegisterJobDefinitionResponseTypeDef(TypedDict):
    jobDefinitionName: str,
    jobDefinitionArn: str,
    revision: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

SubmitJobResponseTypeDef#

# SubmitJobResponseTypeDef definition

class SubmitJobResponseTypeDef(TypedDict):
    jobArn: str,
    jobName: str,
    jobId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateComputeEnvironmentResponseTypeDef#

# UpdateComputeEnvironmentResponseTypeDef definition

class UpdateComputeEnvironmentResponseTypeDef(TypedDict):
    computeEnvironmentName: str,
    computeEnvironmentArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateJobQueueResponseTypeDef#

# UpdateJobQueueResponseTypeDef definition

class UpdateJobQueueResponseTypeDef(TypedDict):
    jobQueueName: str,
    jobQueueArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

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]],
    jobStateTimeLimitActions: NotRequired[Sequence[JobStateTimeLimitActionTypeDef]],  # (3)
  1. See ComputeEnvironmentOrderTypeDef
  2. See JQStateType
  3. See JobStateTimeLimitActionTypeDef

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]],
    jobStateTimeLimitActions: NotRequired[List[JobStateTimeLimitActionTypeDef]],  # (4)
  1. See JQStateType
  2. See JQStatusType
  3. See ComputeEnvironmentOrderTypeDef
  4. See JobStateTimeLimitActionTypeDef

UpdateJobQueueRequestRequestTypeDef#

# UpdateJobQueueRequestRequestTypeDef definition

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

DescribeComputeEnvironmentsRequestDescribeComputeEnvironmentsPaginateTypeDef#

# DescribeComputeEnvironmentsRequestDescribeComputeEnvironmentsPaginateTypeDef definition

class DescribeComputeEnvironmentsRequestDescribeComputeEnvironmentsPaginateTypeDef(TypedDict):
    computeEnvironments: NotRequired[Sequence[str]],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeJobDefinitionsRequestDescribeJobDefinitionsPaginateTypeDef#

# DescribeJobDefinitionsRequestDescribeJobDefinitionsPaginateTypeDef definition

class DescribeJobDefinitionsRequestDescribeJobDefinitionsPaginateTypeDef(TypedDict):
    jobDefinitions: NotRequired[Sequence[str]],
    jobDefinitionName: NotRequired[str],
    status: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeJobQueuesRequestDescribeJobQueuesPaginateTypeDef#

# DescribeJobQueuesRequestDescribeJobQueuesPaginateTypeDef definition

class DescribeJobQueuesRequestDescribeJobQueuesPaginateTypeDef(TypedDict):
    jobQueues: NotRequired[Sequence[str]],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListSchedulingPoliciesRequestListSchedulingPoliciesPaginateTypeDef#

# ListSchedulingPoliciesRequestListSchedulingPoliciesPaginateTypeDef definition

class ListSchedulingPoliciesRequestListSchedulingPoliciesPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

EFSVolumeConfigurationTypeDef#

# EFSVolumeConfigurationTypeDef definition

class EFSVolumeConfigurationTypeDef(TypedDict):
    fileSystemId: str,
    rootDirectory: NotRequired[str],
    transitEncryption: NotRequired[EFSTransitEncryptionType],  # (1)
    transitEncryptionPort: NotRequired[int],
    authorizationConfig: NotRequired[EFSAuthorizationConfigTypeDef],  # (2)
  1. See EFSTransitEncryptionType
  2. See EFSAuthorizationConfigTypeDef

EksAttemptDetailTypeDef#

# EksAttemptDetailTypeDef definition

class EksAttemptDetailTypeDef(TypedDict):
    containers: NotRequired[List[EksAttemptContainerDetailTypeDef]],  # (1)
    initContainers: NotRequired[List[EksAttemptContainerDetailTypeDef]],  # (1)
    podName: NotRequired[str],
    nodeName: NotRequired[str],
    startedAt: NotRequired[int],
    stoppedAt: NotRequired[int],
    statusReason: NotRequired[str],
  1. See EksAttemptContainerDetailTypeDef
  2. See EksAttemptContainerDetailTypeDef

EksContainerOverrideTypeDef#

# EksContainerOverrideTypeDef definition

class EksContainerOverrideTypeDef(TypedDict):
    name: NotRequired[str],
    image: NotRequired[str],
    command: NotRequired[Sequence[str]],
    args: NotRequired[Sequence[str]],
    env: NotRequired[Sequence[EksContainerEnvironmentVariableTypeDef]],  # (1)
    resources: NotRequired[EksContainerResourceRequirementsTypeDef],  # (2)
  1. See EksContainerEnvironmentVariableTypeDef
  2. See EksContainerResourceRequirementsTypeDef

EksContainerDetailTypeDef#

# EksContainerDetailTypeDef definition

class EksContainerDetailTypeDef(TypedDict):
    name: NotRequired[str],
    image: NotRequired[str],
    imagePullPolicy: NotRequired[str],
    command: NotRequired[List[str]],
    args: NotRequired[List[str]],
    env: NotRequired[List[EksContainerEnvironmentVariableTypeDef]],  # (1)
    resources: NotRequired[EksContainerResourceRequirementsTypeDef],  # (2)
    exitCode: NotRequired[int],
    reason: NotRequired[str],
    volumeMounts: NotRequired[List[EksContainerVolumeMountTypeDef]],  # (3)
    securityContext: NotRequired[EksContainerSecurityContextTypeDef],  # (4)
  1. See EksContainerEnvironmentVariableTypeDef
  2. See EksContainerResourceRequirementsTypeDef
  3. See EksContainerVolumeMountTypeDef
  4. See EksContainerSecurityContextTypeDef

EksContainerTypeDef#

# EksContainerTypeDef definition

class EksContainerTypeDef(TypedDict):
    image: str,
    name: NotRequired[str],
    imagePullPolicy: NotRequired[str],
    command: NotRequired[List[str]],
    args: NotRequired[List[str]],
    env: NotRequired[List[EksContainerEnvironmentVariableTypeDef]],  # (1)
    resources: NotRequired[EksContainerResourceRequirementsTypeDef],  # (2)
    volumeMounts: NotRequired[List[EksContainerVolumeMountTypeDef]],  # (3)
    securityContext: NotRequired[EksContainerSecurityContextTypeDef],  # (4)
  1. See EksContainerEnvironmentVariableTypeDef
  2. See EksContainerResourceRequirementsTypeDef
  3. See EksContainerVolumeMountTypeDef
  4. See EksContainerSecurityContextTypeDef

EksVolumeTypeDef#

# EksVolumeTypeDef definition

class EksVolumeTypeDef(TypedDict):
    name: str,
    hostPath: NotRequired[EksHostPathTypeDef],  # (1)
    emptyDir: NotRequired[EksEmptyDirTypeDef],  # (2)
    secret: NotRequired[EksSecretTypeDef],  # (3)
  1. See EksHostPathTypeDef
  2. See EksEmptyDirTypeDef
  3. See EksSecretTypeDef

RetryStrategyTypeDef#

# RetryStrategyTypeDef definition

class RetryStrategyTypeDef(TypedDict):
    attempts: NotRequired[int],
    evaluateOnExit: NotRequired[List[EvaluateOnExitTypeDef]],  # (1)
  1. See EvaluateOnExitTypeDef

FairsharePolicyTypeDef#

# FairsharePolicyTypeDef definition

class FairsharePolicyTypeDef(TypedDict):
    shareDecaySeconds: NotRequired[int],
    computeReservation: NotRequired[int],
    shareDistribution: NotRequired[Sequence[ShareAttributesTypeDef]],  # (1)
  1. See ShareAttributesTypeDef

JobSummaryTypeDef#

# JobSummaryTypeDef definition

class JobSummaryTypeDef(TypedDict):
    jobId: str,
    jobName: str,
    jobArn: NotRequired[str],
    createdAt: NotRequired[int],
    status: NotRequired[JobStatusType],  # (1)
    statusReason: NotRequired[str],
    startedAt: NotRequired[int],
    stoppedAt: NotRequired[int],
    container: NotRequired[ContainerSummaryTypeDef],  # (2)
    arrayProperties: NotRequired[ArrayPropertiesSummaryTypeDef],  # (3)
    nodeProperties: NotRequired[NodePropertiesSummaryTypeDef],  # (4)
    jobDefinition: NotRequired[str],
  1. See JobStatusType
  2. See ContainerSummaryTypeDef
  3. See ArrayPropertiesSummaryTypeDef
  4. See NodePropertiesSummaryTypeDef

ListJobsRequestListJobsPaginateTypeDef#

# ListJobsRequestListJobsPaginateTypeDef definition

class ListJobsRequestListJobsPaginateTypeDef(TypedDict):
    jobQueue: NotRequired[str],
    arrayJobId: NotRequired[str],
    multiNodeJobId: NotRequired[str],
    jobStatus: NotRequired[JobStatusType],  # (1)
    filters: NotRequired[Sequence[KeyValuesPairTypeDef]],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See JobStatusType
  2. See KeyValuesPairTypeDef
  3. See PaginatorConfigTypeDef

ListJobsRequestRequestTypeDef#

# ListJobsRequestRequestTypeDef definition

class ListJobsRequestRequestTypeDef(TypedDict):
    jobQueue: NotRequired[str],
    arrayJobId: NotRequired[str],
    multiNodeJobId: NotRequired[str],
    jobStatus: NotRequired[JobStatusType],  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    filters: NotRequired[Sequence[KeyValuesPairTypeDef]],  # (2)
  1. See JobStatusType
  2. See KeyValuesPairTypeDef

LinuxParametersTypeDef#

# LinuxParametersTypeDef definition

class LinuxParametersTypeDef(TypedDict):
    devices: NotRequired[List[DeviceTypeDef]],  # (1)
    initProcessEnabled: NotRequired[bool],
    sharedMemorySize: NotRequired[int],
    tmpfs: NotRequired[List[TmpfsTypeDef]],  # (2)
    maxSwap: NotRequired[int],
    swappiness: NotRequired[int],
  1. See DeviceTypeDef
  2. See TmpfsTypeDef

ListSchedulingPoliciesResponseTypeDef#

# ListSchedulingPoliciesResponseTypeDef definition

class ListSchedulingPoliciesResponseTypeDef(TypedDict):
    schedulingPolicies: List[SchedulingPolicyListingDetailTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SchedulingPolicyListingDetailTypeDef
  2. See ResponseMetadataTypeDef

AttemptDetailTypeDef#

# AttemptDetailTypeDef definition

class AttemptDetailTypeDef(TypedDict):
    container: NotRequired[AttemptContainerDetailTypeDef],  # (1)
    startedAt: NotRequired[int],
    stoppedAt: NotRequired[int],
    statusReason: NotRequired[str],
  1. See AttemptContainerDetailTypeDef

ComputeEnvironmentDetailPaginatorTypeDef#

# ComputeEnvironmentDetailPaginatorTypeDef definition

class ComputeEnvironmentDetailPaginatorTypeDef(TypedDict):
    computeEnvironmentName: str,
    computeEnvironmentArn: str,
    unmanagedvCpus: NotRequired[int],
    ecsClusterArn: NotRequired[str],
    tags: NotRequired[Dict[str, str]],
    type: NotRequired[CETypeType],  # (1)
    state: NotRequired[CEStateType],  # (2)
    status: NotRequired[CEStatusType],  # (3)
    statusReason: NotRequired[str],
    computeResources: NotRequired[ComputeResourcePaginatorTypeDef],  # (4)
    serviceRole: NotRequired[str],
    updatePolicy: NotRequired[UpdatePolicyTypeDef],  # (5)
    eksConfiguration: NotRequired[EksConfigurationTypeDef],  # (6)
    containerOrchestrationType: NotRequired[OrchestrationTypeType],  # (7)
    uuid: NotRequired[str],
  1. See CETypeType
  2. See CEStateType
  3. See CEStatusType
  4. See ComputeResourcePaginatorTypeDef
  5. See UpdatePolicyTypeDef
  6. See EksConfigurationTypeDef
  7. See OrchestrationTypeType

ComputeEnvironmentDetailTypeDef#

# ComputeEnvironmentDetailTypeDef definition

class ComputeEnvironmentDetailTypeDef(TypedDict):
    computeEnvironmentName: str,
    computeEnvironmentArn: str,
    unmanagedvCpus: NotRequired[int],
    ecsClusterArn: NotRequired[str],
    tags: NotRequired[Dict[str, str]],
    type: NotRequired[CETypeType],  # (1)
    state: NotRequired[CEStateType],  # (2)
    status: NotRequired[CEStatusType],  # (3)
    statusReason: NotRequired[str],
    computeResources: NotRequired[ComputeResourceTypeDef],  # (4)
    serviceRole: NotRequired[str],
    updatePolicy: NotRequired[UpdatePolicyTypeDef],  # (5)
    eksConfiguration: NotRequired[EksConfigurationTypeDef],  # (6)
    containerOrchestrationType: NotRequired[OrchestrationTypeType],  # (7)
    uuid: NotRequired[str],
  1. See CETypeType
  2. See CEStateType
  3. See CEStatusType
  4. See ComputeResourceTypeDef
  5. See UpdatePolicyTypeDef
  6. See EksConfigurationTypeDef
  7. See OrchestrationTypeType

CreateComputeEnvironmentRequestRequestTypeDef#

# CreateComputeEnvironmentRequestRequestTypeDef definition

class CreateComputeEnvironmentRequestRequestTypeDef(TypedDict):
    computeEnvironmentName: str,
    type: CETypeType,  # (1)
    state: NotRequired[CEStateType],  # (2)
    unmanagedvCpus: NotRequired[int],
    computeResources: NotRequired[ComputeResourceTypeDef],  # (3)
    serviceRole: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
    eksConfiguration: NotRequired[EksConfigurationTypeDef],  # (4)
  1. See CETypeType
  2. See CEStateType
  3. See ComputeResourceTypeDef
  4. See EksConfigurationTypeDef

UpdateComputeEnvironmentRequestRequestTypeDef#

# UpdateComputeEnvironmentRequestRequestTypeDef definition

class UpdateComputeEnvironmentRequestRequestTypeDef(TypedDict):
    computeEnvironment: str,
    state: NotRequired[CEStateType],  # (1)
    unmanagedvCpus: NotRequired[int],
    computeResources: NotRequired[ComputeResourceUpdateTypeDef],  # (2)
    serviceRole: NotRequired[str],
    updatePolicy: NotRequired[UpdatePolicyTypeDef],  # (3)
  1. See CEStateType
  2. See ComputeResourceUpdateTypeDef
  3. See UpdatePolicyTypeDef

TaskPropertiesOverrideTypeDef#

# TaskPropertiesOverrideTypeDef definition

class TaskPropertiesOverrideTypeDef(TypedDict):
    containers: NotRequired[Sequence[TaskContainerOverridesTypeDef]],  # (1)
  1. See TaskContainerOverridesTypeDef

DescribeJobQueuesResponseTypeDef#

# DescribeJobQueuesResponseTypeDef definition

class DescribeJobQueuesResponseTypeDef(TypedDict):
    jobQueues: List[JobQueueDetailTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobQueueDetailTypeDef
  2. See ResponseMetadataTypeDef

VolumeTypeDef#

# VolumeTypeDef definition

class VolumeTypeDef(TypedDict):
    host: NotRequired[HostTypeDef],  # (1)
    name: NotRequired[str],
    efsVolumeConfiguration: NotRequired[EFSVolumeConfigurationTypeDef],  # (2)
  1. See HostTypeDef
  2. See EFSVolumeConfigurationTypeDef

EksPodPropertiesOverrideTypeDef#

# EksPodPropertiesOverrideTypeDef definition

class EksPodPropertiesOverrideTypeDef(TypedDict):
    containers: NotRequired[Sequence[EksContainerOverrideTypeDef]],  # (1)
    initContainers: NotRequired[Sequence[EksContainerOverrideTypeDef]],  # (1)
    metadata: NotRequired[EksMetadataTypeDef],  # (3)
  1. See EksContainerOverrideTypeDef
  2. See EksContainerOverrideTypeDef
  3. See EksMetadataTypeDef

EksPodPropertiesDetailTypeDef#

# EksPodPropertiesDetailTypeDef definition

class EksPodPropertiesDetailTypeDef(TypedDict):
    serviceAccountName: NotRequired[str],
    hostNetwork: NotRequired[bool],
    dnsPolicy: NotRequired[str],
    containers: NotRequired[List[EksContainerDetailTypeDef]],  # (1)
    initContainers: NotRequired[List[EksContainerDetailTypeDef]],  # (1)
    volumes: NotRequired[List[EksVolumeTypeDef]],  # (3)
    podName: NotRequired[str],
    nodeName: NotRequired[str],
    metadata: NotRequired[EksMetadataTypeDef],  # (4)
    shareProcessNamespace: NotRequired[bool],
  1. See EksContainerDetailTypeDef
  2. See EksContainerDetailTypeDef
  3. See EksVolumeTypeDef
  4. See EksMetadataTypeDef

EksPodPropertiesTypeDef#

# EksPodPropertiesTypeDef definition

class EksPodPropertiesTypeDef(TypedDict):
    serviceAccountName: NotRequired[str],
    hostNetwork: NotRequired[bool],
    dnsPolicy: NotRequired[str],
    containers: NotRequired[List[EksContainerTypeDef]],  # (1)
    initContainers: NotRequired[List[EksContainerTypeDef]],  # (1)
    volumes: NotRequired[List[EksVolumeTypeDef]],  # (3)
    metadata: NotRequired[EksMetadataTypeDef],  # (4)
    shareProcessNamespace: NotRequired[bool],
  1. See EksContainerTypeDef
  2. See EksContainerTypeDef
  3. See EksVolumeTypeDef
  4. See EksMetadataTypeDef

CreateSchedulingPolicyRequestRequestTypeDef#

# CreateSchedulingPolicyRequestRequestTypeDef definition

class CreateSchedulingPolicyRequestRequestTypeDef(TypedDict):
    name: str,
    fairsharePolicy: NotRequired[FairsharePolicyTypeDef],  # (1)
    tags: NotRequired[Mapping[str, str]],
  1. See FairsharePolicyTypeDef

SchedulingPolicyDetailTypeDef#

# SchedulingPolicyDetailTypeDef definition

class SchedulingPolicyDetailTypeDef(TypedDict):
    name: str,
    arn: str,
    fairsharePolicy: NotRequired[FairsharePolicyTypeDef],  # (1)
    tags: NotRequired[Dict[str, str]],
  1. See FairsharePolicyTypeDef

UpdateSchedulingPolicyRequestRequestTypeDef#

# UpdateSchedulingPolicyRequestRequestTypeDef definition

class UpdateSchedulingPolicyRequestRequestTypeDef(TypedDict):
    arn: str,
    fairsharePolicy: NotRequired[FairsharePolicyTypeDef],  # (1)
  1. See FairsharePolicyTypeDef

ListJobsResponseTypeDef#

# ListJobsResponseTypeDef definition

class ListJobsResponseTypeDef(TypedDict):
    jobSummaryList: List[JobSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobSummaryTypeDef
  2. See ResponseMetadataTypeDef

TaskContainerDetailsTypeDef#

# TaskContainerDetailsTypeDef definition

class TaskContainerDetailsTypeDef(TypedDict):
    command: NotRequired[List[str]],
    dependsOn: NotRequired[List[TaskContainerDependencyTypeDef]],  # (1)
    environment: NotRequired[List[KeyValuePairTypeDef]],  # (2)
    essential: NotRequired[bool],
    image: NotRequired[str],
    linuxParameters: NotRequired[LinuxParametersTypeDef],  # (3)
    logConfiguration: NotRequired[LogConfigurationTypeDef],  # (4)
    mountPoints: NotRequired[List[MountPointTypeDef]],  # (5)
    name: NotRequired[str],
    privileged: NotRequired[bool],
    readonlyRootFilesystem: NotRequired[bool],
    repositoryCredentials: NotRequired[RepositoryCredentialsTypeDef],  # (6)
    resourceRequirements: NotRequired[List[ResourceRequirementTypeDef]],  # (7)
    secrets: NotRequired[List[SecretTypeDef]],  # (8)
    ulimits: NotRequired[List[UlimitTypeDef]],  # (9)
    user: NotRequired[str],
    exitCode: NotRequired[int],
    reason: NotRequired[str],
    logStreamName: NotRequired[str],
    networkInterfaces: NotRequired[List[NetworkInterfaceTypeDef]],  # (10)
  1. See TaskContainerDependencyTypeDef
  2. See KeyValuePairTypeDef
  3. See LinuxParametersTypeDef
  4. See LogConfigurationTypeDef
  5. See MountPointTypeDef
  6. See RepositoryCredentialsTypeDef
  7. See ResourceRequirementTypeDef
  8. See SecretTypeDef
  9. See UlimitTypeDef
  10. See NetworkInterfaceTypeDef

TaskContainerPropertiesTypeDef#

# TaskContainerPropertiesTypeDef definition

class TaskContainerPropertiesTypeDef(TypedDict):
    image: str,
    command: NotRequired[List[str]],
    dependsOn: NotRequired[List[TaskContainerDependencyTypeDef]],  # (1)
    environment: NotRequired[List[KeyValuePairTypeDef]],  # (2)
    essential: NotRequired[bool],
    linuxParameters: NotRequired[LinuxParametersTypeDef],  # (3)
    logConfiguration: NotRequired[LogConfigurationTypeDef],  # (4)
    mountPoints: NotRequired[List[MountPointTypeDef]],  # (5)
    name: NotRequired[str],
    privileged: NotRequired[bool],
    readonlyRootFilesystem: NotRequired[bool],
    repositoryCredentials: NotRequired[RepositoryCredentialsTypeDef],  # (6)
    resourceRequirements: NotRequired[List[ResourceRequirementTypeDef]],  # (7)
    secrets: NotRequired[List[SecretTypeDef]],  # (8)
    ulimits: NotRequired[List[UlimitTypeDef]],  # (9)
    user: NotRequired[str],
  1. See TaskContainerDependencyTypeDef
  2. See KeyValuePairTypeDef
  3. See LinuxParametersTypeDef
  4. See LogConfigurationTypeDef
  5. See MountPointTypeDef
  6. See RepositoryCredentialsTypeDef
  7. See ResourceRequirementTypeDef
  8. See SecretTypeDef
  9. See UlimitTypeDef

DescribeComputeEnvironmentsResponsePaginatorTypeDef#

# DescribeComputeEnvironmentsResponsePaginatorTypeDef definition

class DescribeComputeEnvironmentsResponsePaginatorTypeDef(TypedDict):
    computeEnvironments: List[ComputeEnvironmentDetailPaginatorTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ComputeEnvironmentDetailPaginatorTypeDef
  2. See ResponseMetadataTypeDef

DescribeComputeEnvironmentsResponseTypeDef#

# DescribeComputeEnvironmentsResponseTypeDef definition

class DescribeComputeEnvironmentsResponseTypeDef(TypedDict):
    computeEnvironments: List[ComputeEnvironmentDetailTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ComputeEnvironmentDetailTypeDef
  2. See ResponseMetadataTypeDef

EcsPropertiesOverrideTypeDef#

# EcsPropertiesOverrideTypeDef definition

class EcsPropertiesOverrideTypeDef(TypedDict):
    taskProperties: NotRequired[Sequence[TaskPropertiesOverrideTypeDef]],  # (1)
  1. See TaskPropertiesOverrideTypeDef

ContainerDetailTypeDef#

# ContainerDetailTypeDef definition

class ContainerDetailTypeDef(TypedDict):
    image: NotRequired[str],
    vcpus: NotRequired[int],
    memory: NotRequired[int],
    command: NotRequired[List[str]],
    jobRoleArn: NotRequired[str],
    executionRoleArn: NotRequired[str],
    volumes: NotRequired[List[VolumeTypeDef]],  # (1)
    environment: NotRequired[List[KeyValuePairTypeDef]],  # (2)
    mountPoints: NotRequired[List[MountPointTypeDef]],  # (3)
    readonlyRootFilesystem: NotRequired[bool],
    ulimits: NotRequired[List[UlimitTypeDef]],  # (4)
    privileged: NotRequired[bool],
    user: NotRequired[str],
    exitCode: NotRequired[int],
    reason: NotRequired[str],
    containerInstanceArn: NotRequired[str],
    taskArn: NotRequired[str],
    logStreamName: NotRequired[str],
    instanceType: NotRequired[str],
    networkInterfaces: NotRequired[List[NetworkInterfaceTypeDef]],  # (5)
    resourceRequirements: NotRequired[List[ResourceRequirementTypeDef]],  # (6)
    linuxParameters: NotRequired[LinuxParametersTypeDef],  # (7)
    logConfiguration: NotRequired[LogConfigurationTypeDef],  # (8)
    secrets: NotRequired[List[SecretTypeDef]],  # (9)
    networkConfiguration: NotRequired[NetworkConfigurationTypeDef],  # (10)
    fargatePlatformConfiguration: NotRequired[FargatePlatformConfigurationTypeDef],  # (11)
    ephemeralStorage: NotRequired[EphemeralStorageTypeDef],  # (12)
    runtimePlatform: NotRequired[RuntimePlatformTypeDef],  # (13)
    repositoryCredentials: NotRequired[RepositoryCredentialsTypeDef],  # (14)
  1. See VolumeTypeDef
  2. See KeyValuePairTypeDef
  3. See MountPointTypeDef
  4. See UlimitTypeDef
  5. See NetworkInterfaceTypeDef
  6. See ResourceRequirementTypeDef
  7. See LinuxParametersTypeDef
  8. See LogConfigurationTypeDef
  9. See SecretTypeDef
  10. See NetworkConfigurationTypeDef
  11. See FargatePlatformConfigurationTypeDef
  12. See EphemeralStorageTypeDef
  13. See RuntimePlatformTypeDef
  14. See RepositoryCredentialsTypeDef

ContainerPropertiesTypeDef#

# ContainerPropertiesTypeDef definition

class ContainerPropertiesTypeDef(TypedDict):
    image: NotRequired[str],
    vcpus: NotRequired[int],
    memory: NotRequired[int],
    command: NotRequired[List[str]],
    jobRoleArn: NotRequired[str],
    executionRoleArn: NotRequired[str],
    volumes: NotRequired[List[VolumeTypeDef]],  # (1)
    environment: NotRequired[List[KeyValuePairTypeDef]],  # (2)
    mountPoints: NotRequired[List[MountPointTypeDef]],  # (3)
    readonlyRootFilesystem: NotRequired[bool],
    privileged: NotRequired[bool],
    ulimits: NotRequired[List[UlimitTypeDef]],  # (4)
    user: NotRequired[str],
    instanceType: NotRequired[str],
    resourceRequirements: NotRequired[List[ResourceRequirementTypeDef]],  # (5)
    linuxParameters: NotRequired[LinuxParametersTypeDef],  # (6)
    logConfiguration: NotRequired[LogConfigurationTypeDef],  # (7)
    secrets: NotRequired[List[SecretTypeDef]],  # (8)
    networkConfiguration: NotRequired[NetworkConfigurationTypeDef],  # (9)
    fargatePlatformConfiguration: NotRequired[FargatePlatformConfigurationTypeDef],  # (10)
    ephemeralStorage: NotRequired[EphemeralStorageTypeDef],  # (11)
    runtimePlatform: NotRequired[RuntimePlatformTypeDef],  # (12)
    repositoryCredentials: NotRequired[RepositoryCredentialsTypeDef],  # (13)
  1. See VolumeTypeDef
  2. See KeyValuePairTypeDef
  3. See MountPointTypeDef
  4. See UlimitTypeDef
  5. See ResourceRequirementTypeDef
  6. See LinuxParametersTypeDef
  7. See LogConfigurationTypeDef
  8. See SecretTypeDef
  9. See NetworkConfigurationTypeDef
  10. See FargatePlatformConfigurationTypeDef
  11. See EphemeralStorageTypeDef
  12. See RuntimePlatformTypeDef
  13. See RepositoryCredentialsTypeDef

EksPropertiesOverrideTypeDef#

# EksPropertiesOverrideTypeDef definition

class EksPropertiesOverrideTypeDef(TypedDict):
    podProperties: NotRequired[EksPodPropertiesOverrideTypeDef],  # (1)
  1. See EksPodPropertiesOverrideTypeDef

EksPropertiesDetailTypeDef#

# EksPropertiesDetailTypeDef definition

class EksPropertiesDetailTypeDef(TypedDict):
    podProperties: NotRequired[EksPodPropertiesDetailTypeDef],  # (1)
  1. See EksPodPropertiesDetailTypeDef

EksPropertiesTypeDef#

# EksPropertiesTypeDef definition

class EksPropertiesTypeDef(TypedDict):
    podProperties: NotRequired[EksPodPropertiesTypeDef],  # (1)
  1. See EksPodPropertiesTypeDef

DescribeSchedulingPoliciesResponseTypeDef#

# DescribeSchedulingPoliciesResponseTypeDef definition

class DescribeSchedulingPoliciesResponseTypeDef(TypedDict):
    schedulingPolicies: List[SchedulingPolicyDetailTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SchedulingPolicyDetailTypeDef
  2. See ResponseMetadataTypeDef

EcsTaskDetailsTypeDef#

# EcsTaskDetailsTypeDef definition

class EcsTaskDetailsTypeDef(TypedDict):
    containers: NotRequired[List[TaskContainerDetailsTypeDef]],  # (1)
    containerInstanceArn: NotRequired[str],
    taskArn: NotRequired[str],
    ephemeralStorage: NotRequired[EphemeralStorageTypeDef],  # (2)
    executionRoleArn: NotRequired[str],
    platformVersion: NotRequired[str],
    ipcMode: NotRequired[str],
    taskRoleArn: NotRequired[str],
    pidMode: NotRequired[str],
    networkConfiguration: NotRequired[NetworkConfigurationTypeDef],  # (3)
    runtimePlatform: NotRequired[RuntimePlatformTypeDef],  # (4)
    volumes: NotRequired[List[VolumeTypeDef]],  # (5)
  1. See TaskContainerDetailsTypeDef
  2. See EphemeralStorageTypeDef
  3. See NetworkConfigurationTypeDef
  4. See RuntimePlatformTypeDef
  5. See VolumeTypeDef

EcsTaskPropertiesTypeDef#

# EcsTaskPropertiesTypeDef definition

class EcsTaskPropertiesTypeDef(TypedDict):
    containers: List[TaskContainerPropertiesTypeDef],  # (1)
    ephemeralStorage: NotRequired[EphemeralStorageTypeDef],  # (2)
    executionRoleArn: NotRequired[str],
    platformVersion: NotRequired[str],
    ipcMode: NotRequired[str],
    taskRoleArn: NotRequired[str],
    pidMode: NotRequired[str],
    networkConfiguration: NotRequired[NetworkConfigurationTypeDef],  # (3)
    runtimePlatform: NotRequired[RuntimePlatformTypeDef],  # (4)
    volumes: NotRequired[List[VolumeTypeDef]],  # (5)
  1. See TaskContainerPropertiesTypeDef
  2. See EphemeralStorageTypeDef
  3. See NetworkConfigurationTypeDef
  4. See RuntimePlatformTypeDef
  5. See VolumeTypeDef

NodePropertyOverrideTypeDef#

# NodePropertyOverrideTypeDef definition

class NodePropertyOverrideTypeDef(TypedDict):
    targetNodes: str,
    containerOverrides: NotRequired[ContainerOverridesTypeDef],  # (1)
    ecsPropertiesOverride: NotRequired[EcsPropertiesOverrideTypeDef],  # (2)
    instanceTypes: NotRequired[Sequence[str]],
  1. See ContainerOverridesTypeDef
  2. See EcsPropertiesOverrideTypeDef

EcsPropertiesDetailTypeDef#

# EcsPropertiesDetailTypeDef definition

class EcsPropertiesDetailTypeDef(TypedDict):
    taskProperties: NotRequired[List[EcsTaskDetailsTypeDef]],  # (1)
  1. See EcsTaskDetailsTypeDef

EcsPropertiesTypeDef#

# EcsPropertiesTypeDef definition

class EcsPropertiesTypeDef(TypedDict):
    taskProperties: List[EcsTaskPropertiesTypeDef],  # (1)
  1. See EcsTaskPropertiesTypeDef

NodeOverridesTypeDef#

# NodeOverridesTypeDef definition

class NodeOverridesTypeDef(TypedDict):
    numNodes: NotRequired[int],
    nodePropertyOverrides: NotRequired[Sequence[NodePropertyOverrideTypeDef]],  # (1)
  1. See NodePropertyOverrideTypeDef

NodeRangePropertyTypeDef#

# NodeRangePropertyTypeDef definition

class NodeRangePropertyTypeDef(TypedDict):
    targetNodes: str,
    container: NotRequired[ContainerPropertiesTypeDef],  # (1)
    instanceTypes: NotRequired[List[str]],
    ecsProperties: NotRequired[EcsPropertiesTypeDef],  # (2)
  1. See ContainerPropertiesTypeDef
  2. See EcsPropertiesTypeDef

SubmitJobRequestRequestTypeDef#

# SubmitJobRequestRequestTypeDef definition

class SubmitJobRequestRequestTypeDef(TypedDict):
    jobName: str,
    jobQueue: str,
    jobDefinition: str,
    shareIdentifier: NotRequired[str],
    schedulingPriorityOverride: NotRequired[int],
    arrayProperties: NotRequired[ArrayPropertiesTypeDef],  # (1)
    dependsOn: NotRequired[Sequence[JobDependencyTypeDef]],  # (2)
    parameters: NotRequired[Mapping[str, str]],
    containerOverrides: NotRequired[ContainerOverridesTypeDef],  # (3)
    nodeOverrides: NotRequired[NodeOverridesTypeDef],  # (4)
    retryStrategy: NotRequired[RetryStrategyTypeDef],  # (5)
    propagateTags: NotRequired[bool],
    timeout: NotRequired[JobTimeoutTypeDef],  # (6)
    tags: NotRequired[Mapping[str, str]],
    eksPropertiesOverride: NotRequired[EksPropertiesOverrideTypeDef],  # (7)
    ecsPropertiesOverride: NotRequired[EcsPropertiesOverrideTypeDef],  # (8)
  1. See ArrayPropertiesTypeDef
  2. See JobDependencyTypeDef
  3. See ContainerOverridesTypeDef
  4. See NodeOverridesTypeDef
  5. See RetryStrategyTypeDef
  6. See JobTimeoutTypeDef
  7. See EksPropertiesOverrideTypeDef
  8. See EcsPropertiesOverrideTypeDef

NodePropertiesTypeDef#

# NodePropertiesTypeDef definition

class NodePropertiesTypeDef(TypedDict):
    numNodes: int,
    mainNode: int,
    nodeRangeProperties: List[NodeRangePropertyTypeDef],  # (1)
  1. See NodeRangePropertyTypeDef

JobDefinitionTypeDef#

# JobDefinitionTypeDef definition

class JobDefinitionTypeDef(TypedDict):
    jobDefinitionName: str,
    jobDefinitionArn: str,
    revision: int,
    type: str,
    status: NotRequired[str],
    schedulingPriority: NotRequired[int],
    parameters: NotRequired[Dict[str, str]],
    retryStrategy: NotRequired[RetryStrategyTypeDef],  # (1)
    containerProperties: NotRequired[ContainerPropertiesTypeDef],  # (2)
    timeout: NotRequired[JobTimeoutTypeDef],  # (3)
    nodeProperties: NotRequired[NodePropertiesTypeDef],  # (4)
    tags: NotRequired[Dict[str, str]],
    propagateTags: NotRequired[bool],
    platformCapabilities: NotRequired[List[PlatformCapabilityType]],  # (5)
    ecsProperties: NotRequired[EcsPropertiesTypeDef],  # (6)
    eksProperties: NotRequired[EksPropertiesTypeDef],  # (7)
    containerOrchestrationType: NotRequired[OrchestrationTypeType],  # (8)
  1. See RetryStrategyTypeDef
  2. See ContainerPropertiesTypeDef
  3. See JobTimeoutTypeDef
  4. See NodePropertiesTypeDef
  5. See PlatformCapabilityType
  6. See EcsPropertiesTypeDef
  7. See EksPropertiesTypeDef
  8. See OrchestrationTypeType

JobDetailTypeDef#

# JobDetailTypeDef definition

class JobDetailTypeDef(TypedDict):
    jobName: str,
    jobId: str,
    jobQueue: str,
    status: JobStatusType,  # (1)
    startedAt: int,
    jobDefinition: str,
    jobArn: NotRequired[str],
    shareIdentifier: NotRequired[str],
    schedulingPriority: NotRequired[int],
    attempts: NotRequired[List[AttemptDetailTypeDef]],  # (2)
    statusReason: NotRequired[str],
    createdAt: NotRequired[int],
    retryStrategy: NotRequired[RetryStrategyTypeDef],  # (3)
    stoppedAt: NotRequired[int],
    dependsOn: NotRequired[List[JobDependencyTypeDef]],  # (4)
    parameters: NotRequired[Dict[str, str]],
    container: NotRequired[ContainerDetailTypeDef],  # (5)
    nodeDetails: NotRequired[NodeDetailsTypeDef],  # (6)
    nodeProperties: NotRequired[NodePropertiesTypeDef],  # (7)
    arrayProperties: NotRequired[ArrayPropertiesDetailTypeDef],  # (8)
    timeout: NotRequired[JobTimeoutTypeDef],  # (9)
    tags: NotRequired[Dict[str, str]],
    propagateTags: NotRequired[bool],
    platformCapabilities: NotRequired[List[PlatformCapabilityType]],  # (10)
    eksProperties: NotRequired[EksPropertiesDetailTypeDef],  # (11)
    eksAttempts: NotRequired[List[EksAttemptDetailTypeDef]],  # (12)
    ecsProperties: NotRequired[EcsPropertiesDetailTypeDef],  # (13)
    isCancelled: NotRequired[bool],
    isTerminated: NotRequired[bool],
  1. See JobStatusType
  2. See AttemptDetailTypeDef
  3. See RetryStrategyTypeDef
  4. See JobDependencyTypeDef
  5. See ContainerDetailTypeDef
  6. See NodeDetailsTypeDef
  7. See NodePropertiesTypeDef
  8. See ArrayPropertiesDetailTypeDef
  9. See JobTimeoutTypeDef
  10. See PlatformCapabilityType
  11. See EksPropertiesDetailTypeDef
  12. See EksAttemptDetailTypeDef
  13. See EcsPropertiesDetailTypeDef

RegisterJobDefinitionRequestRequestTypeDef#

# RegisterJobDefinitionRequestRequestTypeDef definition

class RegisterJobDefinitionRequestRequestTypeDef(TypedDict):
    jobDefinitionName: str,
    type: JobDefinitionTypeType,  # (1)
    parameters: NotRequired[Mapping[str, str]],
    schedulingPriority: NotRequired[int],
    containerProperties: NotRequired[ContainerPropertiesTypeDef],  # (2)
    nodeProperties: NotRequired[NodePropertiesTypeDef],  # (3)
    retryStrategy: NotRequired[RetryStrategyTypeDef],  # (4)
    propagateTags: NotRequired[bool],
    timeout: NotRequired[JobTimeoutTypeDef],  # (5)
    tags: NotRequired[Mapping[str, str]],
    platformCapabilities: NotRequired[Sequence[PlatformCapabilityType]],  # (6)
    eksProperties: NotRequired[EksPropertiesTypeDef],  # (7)
    ecsProperties: NotRequired[EcsPropertiesTypeDef],  # (8)
  1. See JobDefinitionTypeType
  2. See ContainerPropertiesTypeDef
  3. See NodePropertiesTypeDef
  4. See RetryStrategyTypeDef
  5. See JobTimeoutTypeDef
  6. See PlatformCapabilityType
  7. See EksPropertiesTypeDef
  8. See EcsPropertiesTypeDef

DescribeJobDefinitionsResponseTypeDef#

# DescribeJobDefinitionsResponseTypeDef definition

class DescribeJobDefinitionsResponseTypeDef(TypedDict):
    jobDefinitions: List[JobDefinitionTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobDefinitionTypeDef
  2. See ResponseMetadataTypeDef

DescribeJobsResponseTypeDef#

# DescribeJobsResponseTypeDef definition

class DescribeJobsResponseTypeDef(TypedDict):
    jobs: List[JobDetailTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobDetailTypeDef
  2. See ResponseMetadataTypeDef