Skip to content

Typed dictionaries

Index > Batch > Typed dictionaries

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

ArrayPropertiesDetailTypeDef

Usage Example
from mypy_boto3_batch.type_defs import ArrayPropertiesDetailTypeDef

def get_value() -> ArrayPropertiesDetailTypeDef:
    return {
        "statusSummary": ...,
    }
Definition
class ArrayPropertiesDetailTypeDef(TypedDict):
    statusSummary: NotRequired[Dict[str, int]],
    size: NotRequired[int],
    index: NotRequired[int],

ArrayPropertiesSummaryTypeDef

Usage Example
from mypy_boto3_batch.type_defs import ArrayPropertiesSummaryTypeDef

def get_value() -> ArrayPropertiesSummaryTypeDef:
    return {
        "size": ...,
    }
Definition
class ArrayPropertiesSummaryTypeDef(TypedDict):
    size: NotRequired[int],
    index: NotRequired[int],

ArrayPropertiesTypeDef

Usage Example
from mypy_boto3_batch.type_defs import ArrayPropertiesTypeDef

def get_value() -> ArrayPropertiesTypeDef:
    return {
        "size": ...,
    }
Definition
class ArrayPropertiesTypeDef(TypedDict):
    size: NotRequired[int],

NetworkInterfaceTypeDef

Usage Example
from mypy_boto3_batch.type_defs import NetworkInterfaceTypeDef

def get_value() -> NetworkInterfaceTypeDef:
    return {
        "attachmentId": ...,
    }
Definition
class NetworkInterfaceTypeDef(TypedDict):
    attachmentId: NotRequired[str],
    ipv6Address: NotRequired[str],
    privateIpv4Address: NotRequired[str],

CancelJobRequestRequestTypeDef

Usage Example
from mypy_boto3_batch.type_defs import CancelJobRequestRequestTypeDef

def get_value() -> CancelJobRequestRequestTypeDef:
    return {
        "jobId": ...,
        "reason": ...,
    }
Definition
class CancelJobRequestRequestTypeDef(TypedDict):
    jobId: str,
    reason: str,

UpdatePolicyTypeDef

Usage Example
from mypy_boto3_batch.type_defs import UpdatePolicyTypeDef

def get_value() -> UpdatePolicyTypeDef:
    return {
        "terminateJobsOnUpdate": ...,
    }
Definition
class UpdatePolicyTypeDef(TypedDict):
    terminateJobsOnUpdate: NotRequired[bool],
    jobExecutionTimeoutMinutes: NotRequired[int],

ComputeEnvironmentOrderTypeDef

Usage Example
from mypy_boto3_batch.type_defs import ComputeEnvironmentOrderTypeDef

def get_value() -> ComputeEnvironmentOrderTypeDef:
    return {
        "order": ...,
        "computeEnvironment": ...,
    }
Definition
class ComputeEnvironmentOrderTypeDef(TypedDict):
    order: int,
    computeEnvironment: str,

Ec2ConfigurationTypeDef

Usage Example
from mypy_boto3_batch.type_defs import Ec2ConfigurationTypeDef

def get_value() -> Ec2ConfigurationTypeDef:
    return {
        "imageType": ...,
    }
Definition
class Ec2ConfigurationTypeDef(TypedDict):
    imageType: str,
    imageIdOverride: NotRequired[str],

LaunchTemplateSpecificationTypeDef

Usage Example
from mypy_boto3_batch.type_defs import LaunchTemplateSpecificationTypeDef

def get_value() -> LaunchTemplateSpecificationTypeDef:
    return {
        "launchTemplateId": ...,
    }
Definition
class LaunchTemplateSpecificationTypeDef(TypedDict):
    launchTemplateId: NotRequired[str],
    launchTemplateName: NotRequired[str],
    version: NotRequired[str],

FargatePlatformConfigurationTypeDef

Usage Example
from mypy_boto3_batch.type_defs import FargatePlatformConfigurationTypeDef

def get_value() -> FargatePlatformConfigurationTypeDef:
    return {
        "platformVersion": ...,
    }
Definition
class FargatePlatformConfigurationTypeDef(TypedDict):
    platformVersion: NotRequired[str],

KeyValuePairTypeDef

Usage Example
from mypy_boto3_batch.type_defs import KeyValuePairTypeDef

def get_value() -> KeyValuePairTypeDef:
    return {
        "name": ...,
    }
Definition
class KeyValuePairTypeDef(TypedDict):
    name: NotRequired[str],
    value: NotRequired[str],

MountPointTypeDef

Usage Example
from mypy_boto3_batch.type_defs import MountPointTypeDef

def get_value() -> MountPointTypeDef:
    return {
        "containerPath": ...,
    }
Definition
class MountPointTypeDef(TypedDict):
    containerPath: NotRequired[str],
    readOnly: NotRequired[bool],
    sourceVolume: NotRequired[str],

NetworkConfigurationTypeDef

Usage Example
from mypy_boto3_batch.type_defs import NetworkConfigurationTypeDef

def get_value() -> NetworkConfigurationTypeDef:
    return {
        "assignPublicIp": ...,
    }
Definition
class NetworkConfigurationTypeDef(TypedDict):
    assignPublicIp: NotRequired[AssignPublicIpType],  # (1)
  1. See AssignPublicIpType

ResourceRequirementTypeDef

Usage Example
from mypy_boto3_batch.type_defs import ResourceRequirementTypeDef

def get_value() -> ResourceRequirementTypeDef:
    return {
        "value": ...,
        "type": ...,
    }
Definition
class ResourceRequirementTypeDef(TypedDict):
    value: str,
    type: ResourceTypeType,  # (1)
  1. See ResourceTypeType

SecretTypeDef

Usage Example
from mypy_boto3_batch.type_defs import SecretTypeDef

def get_value() -> SecretTypeDef:
    return {
        "name": ...,
        "valueFrom": ...,
    }
Definition
class SecretTypeDef(TypedDict):
    name: str,
    valueFrom: str,

UlimitTypeDef

Usage Example
from mypy_boto3_batch.type_defs import UlimitTypeDef

def get_value() -> UlimitTypeDef:
    return {
        "hardLimit": ...,
        "name": ...,
        "softLimit": ...,
    }
Definition
class UlimitTypeDef(TypedDict):
    hardLimit: int,
    name: str,
    softLimit: int,

ContainerSummaryTypeDef

Usage Example
from mypy_boto3_batch.type_defs import ContainerSummaryTypeDef

def get_value() -> ContainerSummaryTypeDef:
    return {
        "exitCode": ...,
    }
Definition
class ContainerSummaryTypeDef(TypedDict):
    exitCode: NotRequired[int],
    reason: NotRequired[str],

ResponseMetadataTypeDef

Usage Example
from mypy_boto3_batch.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
Definition
class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

DeleteComputeEnvironmentRequestRequestTypeDef

Usage Example
from mypy_boto3_batch.type_defs import DeleteComputeEnvironmentRequestRequestTypeDef

def get_value() -> DeleteComputeEnvironmentRequestRequestTypeDef:
    return {
        "computeEnvironment": ...,
    }
Definition
class DeleteComputeEnvironmentRequestRequestTypeDef(TypedDict):
    computeEnvironment: str,

DeleteJobQueueRequestRequestTypeDef

Usage Example
from mypy_boto3_batch.type_defs import DeleteJobQueueRequestRequestTypeDef

def get_value() -> DeleteJobQueueRequestRequestTypeDef:
    return {
        "jobQueue": ...,
    }
Definition
class DeleteJobQueueRequestRequestTypeDef(TypedDict):
    jobQueue: str,

DeleteSchedulingPolicyRequestRequestTypeDef

Usage Example
from mypy_boto3_batch.type_defs import DeleteSchedulingPolicyRequestRequestTypeDef

def get_value() -> DeleteSchedulingPolicyRequestRequestTypeDef:
    return {
        "arn": ...,
    }
Definition
class DeleteSchedulingPolicyRequestRequestTypeDef(TypedDict):
    arn: str,

DeregisterJobDefinitionRequestRequestTypeDef

Usage Example
from mypy_boto3_batch.type_defs import DeregisterJobDefinitionRequestRequestTypeDef

def get_value() -> DeregisterJobDefinitionRequestRequestTypeDef:
    return {
        "jobDefinition": ...,
    }
Definition
class DeregisterJobDefinitionRequestRequestTypeDef(TypedDict):
    jobDefinition: str,

PaginatorConfigTypeDef

Usage Example
from mypy_boto3_batch.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }
Definition
class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

DescribeComputeEnvironmentsRequestRequestTypeDef

Usage Example
from mypy_boto3_batch.type_defs import DescribeComputeEnvironmentsRequestRequestTypeDef

def get_value() -> DescribeComputeEnvironmentsRequestRequestTypeDef:
    return {
        "computeEnvironments": ...,
    }
Definition
class DescribeComputeEnvironmentsRequestRequestTypeDef(TypedDict):
    computeEnvironments: NotRequired[Sequence[str]],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

DescribeJobDefinitionsRequestRequestTypeDef

Usage Example
from mypy_boto3_batch.type_defs import DescribeJobDefinitionsRequestRequestTypeDef

def get_value() -> DescribeJobDefinitionsRequestRequestTypeDef:
    return {
        "jobDefinitions": ...,
    }
Definition
class DescribeJobDefinitionsRequestRequestTypeDef(TypedDict):
    jobDefinitions: NotRequired[Sequence[str]],
    maxResults: NotRequired[int],
    jobDefinitionName: NotRequired[str],
    status: NotRequired[str],
    nextToken: NotRequired[str],

DescribeJobQueuesRequestRequestTypeDef

Usage Example
from mypy_boto3_batch.type_defs import DescribeJobQueuesRequestRequestTypeDef

def get_value() -> DescribeJobQueuesRequestRequestTypeDef:
    return {
        "jobQueues": ...,
    }
Definition
class DescribeJobQueuesRequestRequestTypeDef(TypedDict):
    jobQueues: NotRequired[Sequence[str]],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

DescribeJobsRequestRequestTypeDef

Usage Example
from mypy_boto3_batch.type_defs import DescribeJobsRequestRequestTypeDef

def get_value() -> DescribeJobsRequestRequestTypeDef:
    return {
        "jobs": ...,
    }
Definition
class DescribeJobsRequestRequestTypeDef(TypedDict):
    jobs: Sequence[str],

DescribeSchedulingPoliciesRequestRequestTypeDef

Usage Example
from mypy_boto3_batch.type_defs import DescribeSchedulingPoliciesRequestRequestTypeDef

def get_value() -> DescribeSchedulingPoliciesRequestRequestTypeDef:
    return {
        "arns": ...,
    }
Definition
class DescribeSchedulingPoliciesRequestRequestTypeDef(TypedDict):
    arns: Sequence[str],

DeviceTypeDef

Usage Example
from mypy_boto3_batch.type_defs import DeviceTypeDef

def get_value() -> DeviceTypeDef:
    return {
        "hostPath": ...,
    }
Definition
class DeviceTypeDef(TypedDict):
    hostPath: str,
    containerPath: NotRequired[str],
    permissions: NotRequired[List[DeviceCgroupPermissionType]],  # (1)
  1. See DeviceCgroupPermissionType

EFSAuthorizationConfigTypeDef

Usage Example
from mypy_boto3_batch.type_defs import EFSAuthorizationConfigTypeDef

def get_value() -> EFSAuthorizationConfigTypeDef:
    return {
        "accessPointId": ...,
    }
Definition
class EFSAuthorizationConfigTypeDef(TypedDict):
    accessPointId: NotRequired[str],
    iam: NotRequired[EFSAuthorizationConfigIAMType],  # (1)
  1. See EFSAuthorizationConfigIAMType

EvaluateOnExitTypeDef

Usage Example
from mypy_boto3_batch.type_defs import EvaluateOnExitTypeDef

def get_value() -> EvaluateOnExitTypeDef:
    return {
        "action": ...,
    }
Definition
class EvaluateOnExitTypeDef(TypedDict):
    action: RetryActionType,  # (1)
    onStatusReason: NotRequired[str],
    onReason: NotRequired[str],
    onExitCode: NotRequired[str],
  1. See RetryActionType

ShareAttributesTypeDef

Usage Example
from mypy_boto3_batch.type_defs import ShareAttributesTypeDef

def get_value() -> ShareAttributesTypeDef:
    return {
        "shareIdentifier": ...,
    }
Definition
class ShareAttributesTypeDef(TypedDict):
    shareIdentifier: str,
    weightFactor: NotRequired[float],

HostTypeDef

Usage Example
from mypy_boto3_batch.type_defs import HostTypeDef

def get_value() -> HostTypeDef:
    return {
        "sourcePath": ...,
    }
Definition
class HostTypeDef(TypedDict):
    sourcePath: NotRequired[str],

JobTimeoutTypeDef

Usage Example
from mypy_boto3_batch.type_defs import JobTimeoutTypeDef

def get_value() -> JobTimeoutTypeDef:
    return {
        "attemptDurationSeconds": ...,
    }
Definition
class JobTimeoutTypeDef(TypedDict):
    attemptDurationSeconds: NotRequired[int],

JobDependencyTypeDef

Usage Example
from mypy_boto3_batch.type_defs import JobDependencyTypeDef

def get_value() -> JobDependencyTypeDef:
    return {
        "jobId": ...,
    }
Definition
class JobDependencyTypeDef(TypedDict):
    jobId: NotRequired[str],
    type: NotRequired[ArrayJobDependencyType],  # (1)
  1. See ArrayJobDependencyType

NodeDetailsTypeDef

Usage Example
from mypy_boto3_batch.type_defs import NodeDetailsTypeDef

def get_value() -> NodeDetailsTypeDef:
    return {
        "nodeIndex": ...,
    }
Definition
class NodeDetailsTypeDef(TypedDict):
    nodeIndex: NotRequired[int],
    isMainNode: NotRequired[bool],

NodePropertiesSummaryTypeDef

Usage Example
from mypy_boto3_batch.type_defs import NodePropertiesSummaryTypeDef

def get_value() -> NodePropertiesSummaryTypeDef:
    return {
        "isMainNode": ...,
    }
Definition
class NodePropertiesSummaryTypeDef(TypedDict):
    isMainNode: NotRequired[bool],
    numNodes: NotRequired[int],
    nodeIndex: NotRequired[int],

KeyValuesPairTypeDef

Usage Example
from mypy_boto3_batch.type_defs import KeyValuesPairTypeDef

def get_value() -> KeyValuesPairTypeDef:
    return {
        "name": ...,
    }
Definition
class KeyValuesPairTypeDef(TypedDict):
    name: NotRequired[str],
    values: NotRequired[Sequence[str]],

TmpfsTypeDef

Usage Example
from mypy_boto3_batch.type_defs import TmpfsTypeDef

def get_value() -> TmpfsTypeDef:
    return {
        "containerPath": ...,
        "size": ...,
    }
Definition
class TmpfsTypeDef(TypedDict):
    containerPath: str,
    size: int,
    mountOptions: NotRequired[List[str]],

ListSchedulingPoliciesRequestRequestTypeDef

Usage Example
from mypy_boto3_batch.type_defs import ListSchedulingPoliciesRequestRequestTypeDef

def get_value() -> ListSchedulingPoliciesRequestRequestTypeDef:
    return {
        "maxResults": ...,
    }
Definition
class ListSchedulingPoliciesRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

SchedulingPolicyListingDetailTypeDef

Usage Example
from mypy_boto3_batch.type_defs import SchedulingPolicyListingDetailTypeDef

def get_value() -> SchedulingPolicyListingDetailTypeDef:
    return {
        "arn": ...,
    }
Definition
class SchedulingPolicyListingDetailTypeDef(TypedDict):
    arn: str,

ListTagsForResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_batch.type_defs import ListTagsForResourceRequestRequestTypeDef

def get_value() -> ListTagsForResourceRequestRequestTypeDef:
    return {
        "resourceArn": ...,
    }
Definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

TagResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_batch.type_defs import TagResourceRequestRequestTypeDef

def get_value() -> TagResourceRequestRequestTypeDef:
    return {
        "resourceArn": ...,
        "tags": ...,
    }
Definition
class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

TerminateJobRequestRequestTypeDef

Usage Example
from mypy_boto3_batch.type_defs import TerminateJobRequestRequestTypeDef

def get_value() -> TerminateJobRequestRequestTypeDef:
    return {
        "jobId": ...,
        "reason": ...,
    }
Definition
class TerminateJobRequestRequestTypeDef(TypedDict):
    jobId: str,
    reason: str,

UntagResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_batch.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef:
    return {
        "resourceArn": ...,
        "tagKeys": ...,
    }
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

AttemptContainerDetailTypeDef

Usage Example
from mypy_boto3_batch.type_defs import AttemptContainerDetailTypeDef

def get_value() -> AttemptContainerDetailTypeDef:
    return {
        "containerInstanceArn": ...,
    }
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

Usage Example
from mypy_boto3_batch.type_defs import CreateJobQueueRequestRequestTypeDef

def get_value() -> CreateJobQueueRequestRequestTypeDef:
    return {
        "jobQueueName": ...,
        "priority": ...,
        "computeEnvironmentOrder": ...,
    }
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

Usage Example
from mypy_boto3_batch.type_defs import JobQueueDetailTypeDef

def get_value() -> JobQueueDetailTypeDef:
    return {
        "jobQueueName": ...,
        "jobQueueArn": ...,
        "state": ...,
        "priority": ...,
        "computeEnvironmentOrder": ...,
    }
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

Usage Example
from mypy_boto3_batch.type_defs import UpdateJobQueueRequestRequestTypeDef

def get_value() -> UpdateJobQueueRequestRequestTypeDef:
    return {
        "jobQueue": ...,
    }
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

ComputeResourceTypeDef

Usage Example
from mypy_boto3_batch.type_defs import ComputeResourceTypeDef

def get_value() -> ComputeResourceTypeDef:
    return {
        "type": ...,
        "maxvCpus": ...,
        "subnets": ...,
    }
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

Usage Example
from mypy_boto3_batch.type_defs import ComputeResourceUpdateTypeDef

def get_value() -> ComputeResourceUpdateTypeDef:
    return {
        "minvCpus": ...,
    }
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

Usage Example
from mypy_boto3_batch.type_defs import ContainerOverridesTypeDef

def get_value() -> ContainerOverridesTypeDef:
    return {
        "vcpus": ...,
    }
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

LogConfigurationTypeDef

Usage Example
from mypy_boto3_batch.type_defs import LogConfigurationTypeDef

def get_value() -> LogConfigurationTypeDef:
    return {
        "logDriver": ...,
    }
Definition
class LogConfigurationTypeDef(TypedDict):
    logDriver: LogDriverType,  # (1)
    options: NotRequired[Dict[str, str]],
    secretOptions: NotRequired[List[SecretTypeDef]],  # (2)
  1. See LogDriverType
  2. See SecretTypeDef

CreateComputeEnvironmentResponseTypeDef

Usage Example
from mypy_boto3_batch.type_defs import CreateComputeEnvironmentResponseTypeDef

def get_value() -> CreateComputeEnvironmentResponseTypeDef:
    return {
        "computeEnvironmentName": ...,
        "computeEnvironmentArn": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateComputeEnvironmentResponseTypeDef(TypedDict):
    computeEnvironmentName: str,
    computeEnvironmentArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateJobQueueResponseTypeDef

Usage Example
from mypy_boto3_batch.type_defs import CreateJobQueueResponseTypeDef

def get_value() -> CreateJobQueueResponseTypeDef:
    return {
        "jobQueueName": ...,
        "jobQueueArn": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateJobQueueResponseTypeDef(TypedDict):
    jobQueueName: str,
    jobQueueArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateSchedulingPolicyResponseTypeDef

Usage Example
from mypy_boto3_batch.type_defs import CreateSchedulingPolicyResponseTypeDef

def get_value() -> CreateSchedulingPolicyResponseTypeDef:
    return {
        "name": ...,
        "arn": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateSchedulingPolicyResponseTypeDef(TypedDict):
    name: str,
    arn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef

Usage Example
from mypy_boto3_batch.type_defs import ListTagsForResourceResponseTypeDef

def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "tags": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RegisterJobDefinitionResponseTypeDef

Usage Example
from mypy_boto3_batch.type_defs import RegisterJobDefinitionResponseTypeDef

def get_value() -> RegisterJobDefinitionResponseTypeDef:
    return {
        "jobDefinitionName": ...,
        "jobDefinitionArn": ...,
        "revision": ...,
        "ResponseMetadata": ...,
    }
Definition
class RegisterJobDefinitionResponseTypeDef(TypedDict):
    jobDefinitionName: str,
    jobDefinitionArn: str,
    revision: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

SubmitJobResponseTypeDef

Usage Example
from mypy_boto3_batch.type_defs import SubmitJobResponseTypeDef

def get_value() -> SubmitJobResponseTypeDef:
    return {
        "jobArn": ...,
        "jobName": ...,
        "jobId": ...,
        "ResponseMetadata": ...,
    }
Definition
class SubmitJobResponseTypeDef(TypedDict):
    jobArn: str,
    jobName: str,
    jobId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateComputeEnvironmentResponseTypeDef

Usage Example
from mypy_boto3_batch.type_defs import UpdateComputeEnvironmentResponseTypeDef

def get_value() -> UpdateComputeEnvironmentResponseTypeDef:
    return {
        "computeEnvironmentName": ...,
        "computeEnvironmentArn": ...,
        "ResponseMetadata": ...,
    }
Definition
class UpdateComputeEnvironmentResponseTypeDef(TypedDict):
    computeEnvironmentName: str,
    computeEnvironmentArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateJobQueueResponseTypeDef

Usage Example
from mypy_boto3_batch.type_defs import UpdateJobQueueResponseTypeDef

def get_value() -> UpdateJobQueueResponseTypeDef:
    return {
        "jobQueueName": ...,
        "jobQueueArn": ...,
        "ResponseMetadata": ...,
    }
Definition
class UpdateJobQueueResponseTypeDef(TypedDict):
    jobQueueName: str,
    jobQueueArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeComputeEnvironmentsRequestDescribeComputeEnvironmentsPaginateTypeDef

Usage Example
from mypy_boto3_batch.type_defs import DescribeComputeEnvironmentsRequestDescribeComputeEnvironmentsPaginateTypeDef

def get_value() -> DescribeComputeEnvironmentsRequestDescribeComputeEnvironmentsPaginateTypeDef:
    return {
        "computeEnvironments": ...,
    }
Definition
class DescribeComputeEnvironmentsRequestDescribeComputeEnvironmentsPaginateTypeDef(TypedDict):
    computeEnvironments: NotRequired[Sequence[str]],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeJobDefinitionsRequestDescribeJobDefinitionsPaginateTypeDef

Usage Example
from mypy_boto3_batch.type_defs import DescribeJobDefinitionsRequestDescribeJobDefinitionsPaginateTypeDef

def get_value() -> DescribeJobDefinitionsRequestDescribeJobDefinitionsPaginateTypeDef:
    return {
        "jobDefinitions": ...,
    }
Definition
class DescribeJobDefinitionsRequestDescribeJobDefinitionsPaginateTypeDef(TypedDict):
    jobDefinitions: NotRequired[Sequence[str]],
    jobDefinitionName: NotRequired[str],
    status: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeJobQueuesRequestDescribeJobQueuesPaginateTypeDef

Usage Example
from mypy_boto3_batch.type_defs import DescribeJobQueuesRequestDescribeJobQueuesPaginateTypeDef

def get_value() -> DescribeJobQueuesRequestDescribeJobQueuesPaginateTypeDef:
    return {
        "jobQueues": ...,
    }
Definition
class DescribeJobQueuesRequestDescribeJobQueuesPaginateTypeDef(TypedDict):
    jobQueues: NotRequired[Sequence[str]],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListSchedulingPoliciesRequestListSchedulingPoliciesPaginateTypeDef

Usage Example
from mypy_boto3_batch.type_defs import ListSchedulingPoliciesRequestListSchedulingPoliciesPaginateTypeDef

def get_value() -> ListSchedulingPoliciesRequestListSchedulingPoliciesPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }
Definition
class ListSchedulingPoliciesRequestListSchedulingPoliciesPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

EFSVolumeConfigurationTypeDef

Usage Example
from mypy_boto3_batch.type_defs import EFSVolumeConfigurationTypeDef

def get_value() -> EFSVolumeConfigurationTypeDef:
    return {
        "fileSystemId": ...,
    }
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

RetryStrategyTypeDef

Usage Example
from mypy_boto3_batch.type_defs import RetryStrategyTypeDef

def get_value() -> RetryStrategyTypeDef:
    return {
        "attempts": ...,
    }
Definition
class RetryStrategyTypeDef(TypedDict):
    attempts: NotRequired[int],
    evaluateOnExit: NotRequired[List[EvaluateOnExitTypeDef]],  # (1)
  1. See EvaluateOnExitTypeDef

FairsharePolicyTypeDef

Usage Example
from mypy_boto3_batch.type_defs import FairsharePolicyTypeDef

def get_value() -> FairsharePolicyTypeDef:
    return {
        "shareDecaySeconds": ...,
    }
Definition
class FairsharePolicyTypeDef(TypedDict):
    shareDecaySeconds: NotRequired[int],
    computeReservation: NotRequired[int],
    shareDistribution: NotRequired[Sequence[ShareAttributesTypeDef]],  # (1)
  1. See ShareAttributesTypeDef

JobSummaryTypeDef

Usage Example
from mypy_boto3_batch.type_defs import JobSummaryTypeDef

def get_value() -> JobSummaryTypeDef:
    return {
        "jobId": ...,
        "jobName": ...,
    }
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

Usage Example
from mypy_boto3_batch.type_defs import ListJobsRequestListJobsPaginateTypeDef

def get_value() -> ListJobsRequestListJobsPaginateTypeDef:
    return {
        "jobQueue": ...,
    }
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

Usage Example
from mypy_boto3_batch.type_defs import ListJobsRequestRequestTypeDef

def get_value() -> ListJobsRequestRequestTypeDef:
    return {
        "jobQueue": ...,
    }
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

Usage Example
from mypy_boto3_batch.type_defs import LinuxParametersTypeDef

def get_value() -> LinuxParametersTypeDef:
    return {
        "devices": ...,
    }
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

Usage Example
from mypy_boto3_batch.type_defs import ListSchedulingPoliciesResponseTypeDef

def get_value() -> ListSchedulingPoliciesResponseTypeDef:
    return {
        "schedulingPolicies": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListSchedulingPoliciesResponseTypeDef(TypedDict):
    schedulingPolicies: List[SchedulingPolicyListingDetailTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SchedulingPolicyListingDetailTypeDef
  2. See ResponseMetadataTypeDef

AttemptDetailTypeDef

Usage Example
from mypy_boto3_batch.type_defs import AttemptDetailTypeDef

def get_value() -> AttemptDetailTypeDef:
    return {
        "container": ...,
    }
Definition
class AttemptDetailTypeDef(TypedDict):
    container: NotRequired[AttemptContainerDetailTypeDef],  # (1)
    startedAt: NotRequired[int],
    stoppedAt: NotRequired[int],
    statusReason: NotRequired[str],
  1. See AttemptContainerDetailTypeDef

DescribeJobQueuesResponseTypeDef

Usage Example
from mypy_boto3_batch.type_defs import DescribeJobQueuesResponseTypeDef

def get_value() -> DescribeJobQueuesResponseTypeDef:
    return {
        "jobQueues": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class DescribeJobQueuesResponseTypeDef(TypedDict):
    jobQueues: List[JobQueueDetailTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobQueueDetailTypeDef
  2. See ResponseMetadataTypeDef

ComputeEnvironmentDetailTypeDef

Usage Example
from mypy_boto3_batch.type_defs import ComputeEnvironmentDetailTypeDef

def get_value() -> ComputeEnvironmentDetailTypeDef:
    return {
        "computeEnvironmentName": ...,
        "computeEnvironmentArn": ...,
    }
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)
  1. See CETypeType
  2. See CEStateType
  3. See CEStatusType
  4. See ComputeResourceTypeDef
  5. See UpdatePolicyTypeDef

CreateComputeEnvironmentRequestRequestTypeDef

Usage Example
from mypy_boto3_batch.type_defs import CreateComputeEnvironmentRequestRequestTypeDef

def get_value() -> CreateComputeEnvironmentRequestRequestTypeDef:
    return {
        "computeEnvironmentName": ...,
        "type": ...,
    }
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]],
  1. See CETypeType
  2. See CEStateType
  3. See ComputeResourceTypeDef

UpdateComputeEnvironmentRequestRequestTypeDef

Usage Example
from mypy_boto3_batch.type_defs import UpdateComputeEnvironmentRequestRequestTypeDef

def get_value() -> UpdateComputeEnvironmentRequestRequestTypeDef:
    return {
        "computeEnvironment": ...,
    }
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

NodePropertyOverrideTypeDef

Usage Example
from mypy_boto3_batch.type_defs import NodePropertyOverrideTypeDef

def get_value() -> NodePropertyOverrideTypeDef:
    return {
        "targetNodes": ...,
    }
Definition
class NodePropertyOverrideTypeDef(TypedDict):
    targetNodes: str,
    containerOverrides: NotRequired[ContainerOverridesTypeDef],  # (1)
  1. See ContainerOverridesTypeDef

VolumeTypeDef

Usage Example
from mypy_boto3_batch.type_defs import VolumeTypeDef

def get_value() -> VolumeTypeDef:
    return {
        "host": ...,
    }
Definition
class VolumeTypeDef(TypedDict):
    host: NotRequired[HostTypeDef],  # (1)
    name: NotRequired[str],
    efsVolumeConfiguration: NotRequired[EFSVolumeConfigurationTypeDef],  # (2)
  1. See HostTypeDef
  2. See EFSVolumeConfigurationTypeDef

CreateSchedulingPolicyRequestRequestTypeDef

Usage Example
from mypy_boto3_batch.type_defs import CreateSchedulingPolicyRequestRequestTypeDef

def get_value() -> CreateSchedulingPolicyRequestRequestTypeDef:
    return {
        "name": ...,
    }
Definition
class CreateSchedulingPolicyRequestRequestTypeDef(TypedDict):
    name: str,
    fairsharePolicy: NotRequired[FairsharePolicyTypeDef],  # (1)
    tags: NotRequired[Mapping[str, str]],
  1. See FairsharePolicyTypeDef

SchedulingPolicyDetailTypeDef

Usage Example
from mypy_boto3_batch.type_defs import SchedulingPolicyDetailTypeDef

def get_value() -> SchedulingPolicyDetailTypeDef:
    return {
        "name": ...,
        "arn": ...,
    }
Definition
class SchedulingPolicyDetailTypeDef(TypedDict):
    name: str,
    arn: str,
    fairsharePolicy: NotRequired[FairsharePolicyTypeDef],  # (1)
    tags: NotRequired[Dict[str, str]],
  1. See FairsharePolicyTypeDef

UpdateSchedulingPolicyRequestRequestTypeDef

Usage Example
from mypy_boto3_batch.type_defs import UpdateSchedulingPolicyRequestRequestTypeDef

def get_value() -> UpdateSchedulingPolicyRequestRequestTypeDef:
    return {
        "arn": ...,
    }
Definition
class UpdateSchedulingPolicyRequestRequestTypeDef(TypedDict):
    arn: str,
    fairsharePolicy: NotRequired[FairsharePolicyTypeDef],  # (1)
  1. See FairsharePolicyTypeDef

ListJobsResponseTypeDef

Usage Example
from mypy_boto3_batch.type_defs import ListJobsResponseTypeDef

def get_value() -> ListJobsResponseTypeDef:
    return {
        "jobSummaryList": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListJobsResponseTypeDef(TypedDict):
    jobSummaryList: List[JobSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobSummaryTypeDef
  2. See ResponseMetadataTypeDef

DescribeComputeEnvironmentsResponseTypeDef

Usage Example
from mypy_boto3_batch.type_defs import DescribeComputeEnvironmentsResponseTypeDef

def get_value() -> DescribeComputeEnvironmentsResponseTypeDef:
    return {
        "computeEnvironments": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class DescribeComputeEnvironmentsResponseTypeDef(TypedDict):
    computeEnvironments: List[ComputeEnvironmentDetailTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ComputeEnvironmentDetailTypeDef
  2. See ResponseMetadataTypeDef

NodeOverridesTypeDef

Usage Example
from mypy_boto3_batch.type_defs import NodeOverridesTypeDef

def get_value() -> NodeOverridesTypeDef:
    return {
        "numNodes": ...,
    }
Definition
class NodeOverridesTypeDef(TypedDict):
    numNodes: NotRequired[int],
    nodePropertyOverrides: NotRequired[Sequence[NodePropertyOverrideTypeDef]],  # (1)
  1. See NodePropertyOverrideTypeDef

ContainerDetailTypeDef

Usage Example
from mypy_boto3_batch.type_defs import ContainerDetailTypeDef

def get_value() -> ContainerDetailTypeDef:
    return {
        "image": ...,
    }
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)
  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

ContainerPropertiesTypeDef

Usage Example
from mypy_boto3_batch.type_defs import ContainerPropertiesTypeDef

def get_value() -> ContainerPropertiesTypeDef:
    return {
        "image": ...,
    }
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)
  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

DescribeSchedulingPoliciesResponseTypeDef

Usage Example
from mypy_boto3_batch.type_defs import DescribeSchedulingPoliciesResponseTypeDef

def get_value() -> DescribeSchedulingPoliciesResponseTypeDef:
    return {
        "schedulingPolicies": ...,
        "ResponseMetadata": ...,
    }
Definition
class DescribeSchedulingPoliciesResponseTypeDef(TypedDict):
    schedulingPolicies: List[SchedulingPolicyDetailTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SchedulingPolicyDetailTypeDef
  2. See ResponseMetadataTypeDef

SubmitJobRequestRequestTypeDef

Usage Example
from mypy_boto3_batch.type_defs import SubmitJobRequestRequestTypeDef

def get_value() -> SubmitJobRequestRequestTypeDef:
    return {
        "jobName": ...,
        "jobQueue": ...,
        "jobDefinition": ...,
    }
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]],
  1. See ArrayPropertiesTypeDef
  2. See JobDependencyTypeDef
  3. See ContainerOverridesTypeDef
  4. See NodeOverridesTypeDef
  5. See RetryStrategyTypeDef
  6. See JobTimeoutTypeDef

NodeRangePropertyTypeDef

Usage Example
from mypy_boto3_batch.type_defs import NodeRangePropertyTypeDef

def get_value() -> NodeRangePropertyTypeDef:
    return {
        "targetNodes": ...,
    }
Definition
class NodeRangePropertyTypeDef(TypedDict):
    targetNodes: str,
    container: NotRequired[ContainerPropertiesTypeDef],  # (1)
  1. See ContainerPropertiesTypeDef

NodePropertiesTypeDef

Usage Example
from mypy_boto3_batch.type_defs import NodePropertiesTypeDef

def get_value() -> NodePropertiesTypeDef:
    return {
        "numNodes": ...,
        "mainNode": ...,
        "nodeRangeProperties": ...,
    }
Definition
class NodePropertiesTypeDef(TypedDict):
    numNodes: int,
    mainNode: int,
    nodeRangeProperties: List[NodeRangePropertyTypeDef],  # (1)
  1. See NodeRangePropertyTypeDef

JobDefinitionTypeDef

Usage Example
from mypy_boto3_batch.type_defs import JobDefinitionTypeDef

def get_value() -> JobDefinitionTypeDef:
    return {
        "jobDefinitionName": ...,
        "jobDefinitionArn": ...,
        "revision": ...,
        "type": ...,
    }
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)
  1. See RetryStrategyTypeDef
  2. See ContainerPropertiesTypeDef
  3. See JobTimeoutTypeDef
  4. See NodePropertiesTypeDef
  5. See PlatformCapabilityType

JobDetailTypeDef

Usage Example
from mypy_boto3_batch.type_defs import JobDetailTypeDef

def get_value() -> JobDetailTypeDef:
    return {
        "jobName": ...,
        "jobId": ...,
        "jobQueue": ...,
        "status": ...,
        "startedAt": ...,
        "jobDefinition": ...,
    }
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)
  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

RegisterJobDefinitionRequestRequestTypeDef

Usage Example
from mypy_boto3_batch.type_defs import RegisterJobDefinitionRequestRequestTypeDef

def get_value() -> RegisterJobDefinitionRequestRequestTypeDef:
    return {
        "jobDefinitionName": ...,
        "type": ...,
    }
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)
  1. See JobDefinitionTypeType
  2. See ContainerPropertiesTypeDef
  3. See NodePropertiesTypeDef
  4. See RetryStrategyTypeDef
  5. See JobTimeoutTypeDef
  6. See PlatformCapabilityType

DescribeJobDefinitionsResponseTypeDef

Usage Example
from mypy_boto3_batch.type_defs import DescribeJobDefinitionsResponseTypeDef

def get_value() -> DescribeJobDefinitionsResponseTypeDef:
    return {
        "jobDefinitions": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class DescribeJobDefinitionsResponseTypeDef(TypedDict):
    jobDefinitions: List[JobDefinitionTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobDefinitionTypeDef
  2. See ResponseMetadataTypeDef

DescribeJobsResponseTypeDef

Usage Example
from mypy_boto3_batch.type_defs import DescribeJobsResponseTypeDef

def get_value() -> DescribeJobsResponseTypeDef:
    return {
        "jobs": ...,
        "ResponseMetadata": ...,
    }
Definition
class DescribeJobsResponseTypeDef(TypedDict):
    jobs: List[JobDetailTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobDetailTypeDef
  2. See ResponseMetadataTypeDef