Skip to content

Type definitions#

Index > DeadlineCloud > Type definitions

Auto-generated documentation for DeadlineCloud type annotations stubs module mypy-boto3-deadline.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

FleetAttributeCapabilityUnionTypeDef#

# FleetAttributeCapabilityUnionTypeDef definition

FleetAttributeCapabilityUnionTypeDef = Union[
    FleetAttributeCapabilityTypeDef,  # (1)
    FleetAttributeCapabilityOutputTypeDef,  # (2)
]
  1. See FleetAttributeCapabilityTypeDef
  2. See FleetAttributeCapabilityOutputTypeDef

IpAddressesUnionTypeDef#

# IpAddressesUnionTypeDef definition

IpAddressesUnionTypeDef = Union[
    IpAddressesTypeDef,  # (1)
    IpAddressesOutputTypeDef,  # (2)
]
  1. See IpAddressesTypeDef
  2. See IpAddressesOutputTypeDef

ManifestPropertiesUnionTypeDef#

# ManifestPropertiesUnionTypeDef definition

ManifestPropertiesUnionTypeDef = Union[
    ManifestPropertiesTypeDef,  # (1)
    ManifestPropertiesOutputTypeDef,  # (2)
]
  1. See ManifestPropertiesTypeDef
  2. See ManifestPropertiesOutputTypeDef

AcceleratorCapabilitiesUnionTypeDef#

# AcceleratorCapabilitiesUnionTypeDef definition

AcceleratorCapabilitiesUnionTypeDef = Union[
    AcceleratorCapabilitiesTypeDef,  # (1)
    AcceleratorCapabilitiesOutputTypeDef,  # (2)
]
  1. See AcceleratorCapabilitiesTypeDef
  2. See AcceleratorCapabilitiesOutputTypeDef

FixedBudgetScheduleUnionTypeDef#

# FixedBudgetScheduleUnionTypeDef definition

FixedBudgetScheduleUnionTypeDef = Union[
    FixedBudgetScheduleTypeDef,  # (1)
    FixedBudgetScheduleOutputTypeDef,  # (2)
]
  1. See FixedBudgetScheduleTypeDef
  2. See FixedBudgetScheduleOutputTypeDef

CustomerManagedWorkerCapabilitiesUnionTypeDef#

# CustomerManagedWorkerCapabilitiesUnionTypeDef definition

CustomerManagedWorkerCapabilitiesUnionTypeDef = Union[
    CustomerManagedWorkerCapabilitiesTypeDef,  # (1)
    CustomerManagedWorkerCapabilitiesOutputTypeDef,  # (2)
]
  1. See CustomerManagedWorkerCapabilitiesTypeDef
  2. See CustomerManagedWorkerCapabilitiesOutputTypeDef

ServiceManagedEc2InstanceCapabilitiesUnionTypeDef#

# ServiceManagedEc2InstanceCapabilitiesUnionTypeDef definition

ServiceManagedEc2InstanceCapabilitiesUnionTypeDef = Union[
    ServiceManagedEc2InstanceCapabilitiesTypeDef,  # (1)
    ServiceManagedEc2InstanceCapabilitiesOutputTypeDef,  # (2)
]
  1. See ServiceManagedEc2InstanceCapabilitiesTypeDef
  2. See ServiceManagedEc2InstanceCapabilitiesOutputTypeDef

CustomerManagedFleetConfigurationUnionTypeDef#

# CustomerManagedFleetConfigurationUnionTypeDef definition

CustomerManagedFleetConfigurationUnionTypeDef = Union[
    CustomerManagedFleetConfigurationTypeDef,  # (1)
    CustomerManagedFleetConfigurationOutputTypeDef,  # (2)
]
  1. See CustomerManagedFleetConfigurationTypeDef
  2. See CustomerManagedFleetConfigurationOutputTypeDef

ServiceManagedEc2FleetConfigurationUnionTypeDef#

# ServiceManagedEc2FleetConfigurationUnionTypeDef definition

ServiceManagedEc2FleetConfigurationUnionTypeDef = Union[
    ServiceManagedEc2FleetConfigurationTypeDef,  # (1)
    ServiceManagedEc2FleetConfigurationOutputTypeDef,  # (2)
]
  1. See ServiceManagedEc2FleetConfigurationTypeDef
  2. See ServiceManagedEc2FleetConfigurationOutputTypeDef

AcceleratorCountRangeTypeDef#

# AcceleratorCountRangeTypeDef definition

class AcceleratorCountRangeTypeDef(TypedDict):
    min: int,
    max: NotRequired[int],

AcceleratorSelectionTypeDef#

# AcceleratorSelectionTypeDef definition

class AcceleratorSelectionTypeDef(TypedDict):
    name: AcceleratorNameType,  # (1)
    runtime: NotRequired[str],
  1. See AcceleratorNameType

AcceleratorTotalMemoryMiBRangeTypeDef#

# AcceleratorTotalMemoryMiBRangeTypeDef definition

class AcceleratorTotalMemoryMiBRangeTypeDef(TypedDict):
    min: int,
    max: NotRequired[int],

AssignedEnvironmentEnterSessionActionDefinitionTypeDef#

# AssignedEnvironmentEnterSessionActionDefinitionTypeDef definition

class AssignedEnvironmentEnterSessionActionDefinitionTypeDef(TypedDict):
    environmentId: str,

AssignedEnvironmentExitSessionActionDefinitionTypeDef#

# AssignedEnvironmentExitSessionActionDefinitionTypeDef definition

class AssignedEnvironmentExitSessionActionDefinitionTypeDef(TypedDict):
    environmentId: str,

AssignedSyncInputJobAttachmentsSessionActionDefinitionTypeDef#

# AssignedSyncInputJobAttachmentsSessionActionDefinitionTypeDef definition

class AssignedSyncInputJobAttachmentsSessionActionDefinitionTypeDef(TypedDict):
    stepId: NotRequired[str],

LogConfigurationTypeDef#

# LogConfigurationTypeDef definition

class LogConfigurationTypeDef(TypedDict):
    logDriver: str,
    options: NotRequired[Dict[str, str]],
    parameters: NotRequired[Dict[str, str]],
    error: NotRequired[str],

TaskParameterValueTypeDef#

# TaskParameterValueTypeDef definition

class TaskParameterValueTypeDef(TypedDict):
    int: NotRequired[str],
    float: NotRequired[str],
    string: NotRequired[str],
    path: NotRequired[str],

AssociateMemberToFarmRequestRequestTypeDef#

# AssociateMemberToFarmRequestRequestTypeDef definition

class AssociateMemberToFarmRequestRequestTypeDef(TypedDict):
    farmId: str,
    principalId: str,
    principalType: PrincipalTypeType,  # (1)
    identityStoreId: str,
    membershipLevel: MembershipLevelType,  # (2)
  1. See PrincipalTypeType
  2. See MembershipLevelType

AssociateMemberToFleetRequestRequestTypeDef#

# AssociateMemberToFleetRequestRequestTypeDef definition

class AssociateMemberToFleetRequestRequestTypeDef(TypedDict):
    farmId: str,
    fleetId: str,
    principalId: str,
    principalType: PrincipalTypeType,  # (1)
    identityStoreId: str,
    membershipLevel: MembershipLevelType,  # (2)
  1. See PrincipalTypeType
  2. See MembershipLevelType

AssociateMemberToJobRequestRequestTypeDef#

# AssociateMemberToJobRequestRequestTypeDef definition

class AssociateMemberToJobRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    jobId: str,
    principalId: str,
    principalType: PrincipalTypeType,  # (1)
    identityStoreId: str,
    membershipLevel: MembershipLevelType,  # (2)
  1. See PrincipalTypeType
  2. See MembershipLevelType

AssociateMemberToQueueRequestRequestTypeDef#

# AssociateMemberToQueueRequestRequestTypeDef definition

class AssociateMemberToQueueRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    principalId: str,
    principalType: PrincipalTypeType,  # (1)
    identityStoreId: str,
    membershipLevel: MembershipLevelType,  # (2)
  1. See PrincipalTypeType
  2. See MembershipLevelType

AssumeFleetRoleForReadRequestRequestTypeDef#

# AssumeFleetRoleForReadRequestRequestTypeDef definition

class AssumeFleetRoleForReadRequestRequestTypeDef(TypedDict):
    farmId: str,
    fleetId: str,

AwsCredentialsTypeDef#

# AwsCredentialsTypeDef definition

class AwsCredentialsTypeDef(TypedDict):
    accessKeyId: str,
    secretAccessKey: str,
    sessionToken: str,
    expiration: datetime,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

AssumeFleetRoleForWorkerRequestRequestTypeDef#

# AssumeFleetRoleForWorkerRequestRequestTypeDef definition

class AssumeFleetRoleForWorkerRequestRequestTypeDef(TypedDict):
    farmId: str,
    fleetId: str,
    workerId: str,

AssumeQueueRoleForReadRequestRequestTypeDef#

# AssumeQueueRoleForReadRequestRequestTypeDef definition

class AssumeQueueRoleForReadRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: str,

AssumeQueueRoleForUserRequestRequestTypeDef#

# AssumeQueueRoleForUserRequestRequestTypeDef definition

class AssumeQueueRoleForUserRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: str,

AssumeQueueRoleForWorkerRequestRequestTypeDef#

# AssumeQueueRoleForWorkerRequestRequestTypeDef definition

class AssumeQueueRoleForWorkerRequestRequestTypeDef(TypedDict):
    farmId: str,
    fleetId: str,
    workerId: str,
    queueId: str,

ManifestPropertiesOutputTypeDef#

# ManifestPropertiesOutputTypeDef definition

class ManifestPropertiesOutputTypeDef(TypedDict):
    rootPath: str,
    rootPathFormat: PathFormatType,  # (1)
    fileSystemLocationName: NotRequired[str],
    outputRelativeDirectories: NotRequired[List[str]],
    inputManifestPath: NotRequired[str],
    inputManifestHash: NotRequired[str],
  1. See PathFormatType

BudgetActionToAddTypeDef#

# BudgetActionToAddTypeDef definition

class BudgetActionToAddTypeDef(TypedDict):
    type: BudgetActionTypeType,  # (1)
    thresholdPercentage: float,
    description: NotRequired[str],
  1. See BudgetActionTypeType

BudgetActionToRemoveTypeDef#

# BudgetActionToRemoveTypeDef definition

class BudgetActionToRemoveTypeDef(TypedDict):
    type: BudgetActionTypeType,  # (1)
    thresholdPercentage: float,
  1. See BudgetActionTypeType

FixedBudgetScheduleOutputTypeDef#

# FixedBudgetScheduleOutputTypeDef definition

class FixedBudgetScheduleOutputTypeDef(TypedDict):
    startTime: datetime,
    endTime: datetime,

ConsumedUsagesTypeDef#

# ConsumedUsagesTypeDef definition

class ConsumedUsagesTypeDef(TypedDict):
    approximateDollarUsage: float,

UsageTrackingResourceTypeDef#

# UsageTrackingResourceTypeDef definition

class UsageTrackingResourceTypeDef(TypedDict):
    queueId: NotRequired[str],

S3LocationTypeDef#

# S3LocationTypeDef definition

class S3LocationTypeDef(TypedDict):
    bucketName: str,
    key: str,

CreateFarmRequestRequestTypeDef#

# CreateFarmRequestRequestTypeDef definition

class CreateFarmRequestRequestTypeDef(TypedDict):
    displayName: str,
    clientToken: NotRequired[str],
    description: NotRequired[str],
    kmsKeyArn: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],

JobParameterTypeDef#

# JobParameterTypeDef definition

class JobParameterTypeDef(TypedDict):
    int: NotRequired[str],
    float: NotRequired[str],
    string: NotRequired[str],
    path: NotRequired[str],

CreateLicenseEndpointRequestRequestTypeDef#

# CreateLicenseEndpointRequestRequestTypeDef definition

class CreateLicenseEndpointRequestRequestTypeDef(TypedDict):
    vpcId: str,
    subnetIds: Sequence[str],
    securityGroupIds: Sequence[str],
    clientToken: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],

CreateMonitorRequestRequestTypeDef#

# CreateMonitorRequestRequestTypeDef definition

class CreateMonitorRequestRequestTypeDef(TypedDict):
    displayName: str,
    identityCenterInstanceArn: str,
    subdomain: str,
    roleArn: str,
    clientToken: NotRequired[str],

CreateQueueEnvironmentRequestRequestTypeDef#

# CreateQueueEnvironmentRequestRequestTypeDef definition

class CreateQueueEnvironmentRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    priority: int,
    templateType: EnvironmentTemplateTypeType,  # (1)
    template: str,
    clientToken: NotRequired[str],
  1. See EnvironmentTemplateTypeType

CreateQueueFleetAssociationRequestRequestTypeDef#

# CreateQueueFleetAssociationRequestRequestTypeDef definition

class CreateQueueFleetAssociationRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    fleetId: str,

JobAttachmentSettingsTypeDef#

# JobAttachmentSettingsTypeDef definition

class JobAttachmentSettingsTypeDef(TypedDict):
    s3BucketName: str,
    rootPrefix: str,

FileSystemLocationTypeDef#

# FileSystemLocationTypeDef definition

class FileSystemLocationTypeDef(TypedDict):
    name: str,
    path: str,
    type: FileSystemLocationTypeType,  # (1)
  1. See FileSystemLocationTypeType

FleetAmountCapabilityTypeDef#

# FleetAmountCapabilityTypeDef definition

class FleetAmountCapabilityTypeDef(TypedDict):
    name: str,
    min: float,
    max: NotRequired[float],

FleetAttributeCapabilityOutputTypeDef#

# FleetAttributeCapabilityOutputTypeDef definition

class FleetAttributeCapabilityOutputTypeDef(TypedDict):
    name: str,
    values: List[str],

MemoryMiBRangeTypeDef#

# MemoryMiBRangeTypeDef definition

class MemoryMiBRangeTypeDef(TypedDict):
    min: int,
    max: NotRequired[int],

VCpuCountRangeTypeDef#

# VCpuCountRangeTypeDef definition

class VCpuCountRangeTypeDef(TypedDict):
    min: int,
    max: NotRequired[int],

DeleteBudgetRequestRequestTypeDef#

# DeleteBudgetRequestRequestTypeDef definition

class DeleteBudgetRequestRequestTypeDef(TypedDict):
    farmId: str,
    budgetId: str,

DeleteFarmRequestRequestTypeDef#

# DeleteFarmRequestRequestTypeDef definition

class DeleteFarmRequestRequestTypeDef(TypedDict):
    farmId: str,

DeleteFleetRequestRequestTypeDef#

# DeleteFleetRequestRequestTypeDef definition

class DeleteFleetRequestRequestTypeDef(TypedDict):
    farmId: str,
    fleetId: str,
    clientToken: NotRequired[str],

DeleteLicenseEndpointRequestRequestTypeDef#

# DeleteLicenseEndpointRequestRequestTypeDef definition

class DeleteLicenseEndpointRequestRequestTypeDef(TypedDict):
    licenseEndpointId: str,

DeleteMeteredProductRequestRequestTypeDef#

# DeleteMeteredProductRequestRequestTypeDef definition

class DeleteMeteredProductRequestRequestTypeDef(TypedDict):
    licenseEndpointId: str,
    productId: str,

DeleteMonitorRequestRequestTypeDef#

# DeleteMonitorRequestRequestTypeDef definition

class DeleteMonitorRequestRequestTypeDef(TypedDict):
    monitorId: str,

DeleteQueueEnvironmentRequestRequestTypeDef#

# DeleteQueueEnvironmentRequestRequestTypeDef definition

class DeleteQueueEnvironmentRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    queueEnvironmentId: str,

DeleteQueueFleetAssociationRequestRequestTypeDef#

# DeleteQueueFleetAssociationRequestRequestTypeDef definition

class DeleteQueueFleetAssociationRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    fleetId: str,

DeleteQueueRequestRequestTypeDef#

# DeleteQueueRequestRequestTypeDef definition

class DeleteQueueRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: str,

DeleteStorageProfileRequestRequestTypeDef#

# DeleteStorageProfileRequestRequestTypeDef definition

class DeleteStorageProfileRequestRequestTypeDef(TypedDict):
    farmId: str,
    storageProfileId: str,

DeleteWorkerRequestRequestTypeDef#

# DeleteWorkerRequestRequestTypeDef definition

class DeleteWorkerRequestRequestTypeDef(TypedDict):
    farmId: str,
    fleetId: str,
    workerId: str,

DependencyCountsTypeDef#

# DependencyCountsTypeDef definition

class DependencyCountsTypeDef(TypedDict):
    dependenciesResolved: int,
    dependenciesUnresolved: int,
    consumersResolved: int,
    consumersUnresolved: int,

DisassociateMemberFromFarmRequestRequestTypeDef#

# DisassociateMemberFromFarmRequestRequestTypeDef definition

class DisassociateMemberFromFarmRequestRequestTypeDef(TypedDict):
    farmId: str,
    principalId: str,

DisassociateMemberFromFleetRequestRequestTypeDef#

# DisassociateMemberFromFleetRequestRequestTypeDef definition

class DisassociateMemberFromFleetRequestRequestTypeDef(TypedDict):
    farmId: str,
    fleetId: str,
    principalId: str,

DisassociateMemberFromJobRequestRequestTypeDef#

# DisassociateMemberFromJobRequestRequestTypeDef definition

class DisassociateMemberFromJobRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    jobId: str,
    principalId: str,

DisassociateMemberFromQueueRequestRequestTypeDef#

# DisassociateMemberFromQueueRequestRequestTypeDef definition

class DisassociateMemberFromQueueRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    principalId: str,

Ec2EbsVolumeTypeDef#

# Ec2EbsVolumeTypeDef definition

class Ec2EbsVolumeTypeDef(TypedDict):
    sizeGiB: NotRequired[int],
    iops: NotRequired[int],
    throughputMiB: NotRequired[int],

EnvironmentDetailsEntityTypeDef#

# EnvironmentDetailsEntityTypeDef definition

class EnvironmentDetailsEntityTypeDef(TypedDict):
    jobId: str,
    environmentId: str,
    schemaVersion: str,
    template: Dict[str, Any],

EnvironmentDetailsErrorTypeDef#

# EnvironmentDetailsErrorTypeDef definition

class EnvironmentDetailsErrorTypeDef(TypedDict):
    jobId: str,
    environmentId: str,
    code: JobEntityErrorCodeType,  # (1)
    message: str,
  1. See JobEntityErrorCodeType

EnvironmentDetailsIdentifiersTypeDef#

# EnvironmentDetailsIdentifiersTypeDef definition

class EnvironmentDetailsIdentifiersTypeDef(TypedDict):
    jobId: str,
    environmentId: str,

EnvironmentEnterSessionActionDefinitionSummaryTypeDef#

# EnvironmentEnterSessionActionDefinitionSummaryTypeDef definition

class EnvironmentEnterSessionActionDefinitionSummaryTypeDef(TypedDict):
    environmentId: str,

EnvironmentEnterSessionActionDefinitionTypeDef#

# EnvironmentEnterSessionActionDefinitionTypeDef definition

class EnvironmentEnterSessionActionDefinitionTypeDef(TypedDict):
    environmentId: str,

EnvironmentExitSessionActionDefinitionSummaryTypeDef#

# EnvironmentExitSessionActionDefinitionSummaryTypeDef definition

class EnvironmentExitSessionActionDefinitionSummaryTypeDef(TypedDict):
    environmentId: str,

EnvironmentExitSessionActionDefinitionTypeDef#

# EnvironmentExitSessionActionDefinitionTypeDef definition

class EnvironmentExitSessionActionDefinitionTypeDef(TypedDict):
    environmentId: str,

FarmMemberTypeDef#

# FarmMemberTypeDef definition

class FarmMemberTypeDef(TypedDict):
    farmId: str,
    principalId: str,
    principalType: PrincipalTypeType,  # (1)
    identityStoreId: str,
    membershipLevel: MembershipLevelType,  # (2)
  1. See PrincipalTypeType
  2. See MembershipLevelType

FarmSummaryTypeDef#

# FarmSummaryTypeDef definition

class FarmSummaryTypeDef(TypedDict):
    farmId: str,
    displayName: str,
    createdAt: datetime,
    createdBy: str,
    kmsKeyArn: NotRequired[str],
    updatedAt: NotRequired[datetime],
    updatedBy: NotRequired[str],

FieldSortExpressionTypeDef#

# FieldSortExpressionTypeDef definition

class FieldSortExpressionTypeDef(TypedDict):
    sortOrder: SortOrderType,  # (1)
    name: str,
  1. See SortOrderType

FleetAttributeCapabilityTypeDef#

# FleetAttributeCapabilityTypeDef definition

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

FleetMemberTypeDef#

# FleetMemberTypeDef definition

class FleetMemberTypeDef(TypedDict):
    farmId: str,
    fleetId: str,
    principalId: str,
    principalType: PrincipalTypeType,  # (1)
    identityStoreId: str,
    membershipLevel: MembershipLevelType,  # (2)
  1. See PrincipalTypeType
  2. See MembershipLevelType

GetBudgetRequestRequestTypeDef#

# GetBudgetRequestRequestTypeDef definition

class GetBudgetRequestRequestTypeDef(TypedDict):
    farmId: str,
    budgetId: str,

ResponseBudgetActionTypeDef#

# ResponseBudgetActionTypeDef definition

class ResponseBudgetActionTypeDef(TypedDict):
    type: BudgetActionTypeType,  # (1)
    thresholdPercentage: float,
    description: NotRequired[str],
  1. See BudgetActionTypeType

GetFarmRequestRequestTypeDef#

# GetFarmRequestRequestTypeDef definition

class GetFarmRequestRequestTypeDef(TypedDict):
    farmId: str,

WaiterConfigTypeDef#

# WaiterConfigTypeDef definition

class WaiterConfigTypeDef(TypedDict):
    Delay: NotRequired[int],
    MaxAttempts: NotRequired[int],

GetFleetRequestRequestTypeDef#

# GetFleetRequestRequestTypeDef definition

class GetFleetRequestRequestTypeDef(TypedDict):
    farmId: str,
    fleetId: str,

JobAttachmentDetailsErrorTypeDef#

# JobAttachmentDetailsErrorTypeDef definition

class JobAttachmentDetailsErrorTypeDef(TypedDict):
    jobId: str,
    code: JobEntityErrorCodeType,  # (1)
    message: str,
  1. See JobEntityErrorCodeType

JobDetailsErrorTypeDef#

# JobDetailsErrorTypeDef definition

class JobDetailsErrorTypeDef(TypedDict):
    jobId: str,
    code: JobEntityErrorCodeType,  # (1)
    message: str,
  1. See JobEntityErrorCodeType

StepDetailsErrorTypeDef#

# StepDetailsErrorTypeDef definition

class StepDetailsErrorTypeDef(TypedDict):
    jobId: str,
    stepId: str,
    code: JobEntityErrorCodeType,  # (1)
    message: str,
  1. See JobEntityErrorCodeType

GetJobRequestRequestTypeDef#

# GetJobRequestRequestTypeDef definition

class GetJobRequestRequestTypeDef(TypedDict):
    farmId: str,
    jobId: str,
    queueId: str,

GetLicenseEndpointRequestRequestTypeDef#

# GetLicenseEndpointRequestRequestTypeDef definition

class GetLicenseEndpointRequestRequestTypeDef(TypedDict):
    licenseEndpointId: str,

GetMonitorRequestRequestTypeDef#

# GetMonitorRequestRequestTypeDef definition

class GetMonitorRequestRequestTypeDef(TypedDict):
    monitorId: str,

GetQueueEnvironmentRequestRequestTypeDef#

# GetQueueEnvironmentRequestRequestTypeDef definition

class GetQueueEnvironmentRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    queueEnvironmentId: str,

GetQueueFleetAssociationRequestRequestTypeDef#

# GetQueueFleetAssociationRequestRequestTypeDef definition

class GetQueueFleetAssociationRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    fleetId: str,

GetQueueRequestRequestTypeDef#

# GetQueueRequestRequestTypeDef definition

class GetQueueRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: str,

GetSessionActionRequestRequestTypeDef#

# GetSessionActionRequestRequestTypeDef definition

class GetSessionActionRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    jobId: str,
    sessionActionId: str,

GetSessionRequestRequestTypeDef#

# GetSessionRequestRequestTypeDef definition

class GetSessionRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    jobId: str,
    sessionId: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

GetSessionsStatisticsAggregationRequestRequestTypeDef#

# GetSessionsStatisticsAggregationRequestRequestTypeDef definition

class GetSessionsStatisticsAggregationRequestRequestTypeDef(TypedDict):
    farmId: str,
    aggregationId: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

GetStepRequestRequestTypeDef#

# GetStepRequestRequestTypeDef definition

class GetStepRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    jobId: str,
    stepId: str,

GetStorageProfileForQueueRequestRequestTypeDef#

# GetStorageProfileForQueueRequestRequestTypeDef definition

class GetStorageProfileForQueueRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    storageProfileId: str,

GetStorageProfileRequestRequestTypeDef#

# GetStorageProfileRequestRequestTypeDef definition

class GetStorageProfileRequestRequestTypeDef(TypedDict):
    farmId: str,
    storageProfileId: str,

GetTaskRequestRequestTypeDef#

# GetTaskRequestRequestTypeDef definition

class GetTaskRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    jobId: str,
    stepId: str,
    taskId: str,

GetWorkerRequestRequestTypeDef#

# GetWorkerRequestRequestTypeDef definition

class GetWorkerRequestRequestTypeDef(TypedDict):
    farmId: str,
    fleetId: str,
    workerId: str,

IpAddressesOutputTypeDef#

# IpAddressesOutputTypeDef definition

class IpAddressesOutputTypeDef(TypedDict):
    ipV4Addresses: NotRequired[List[str]],
    ipV6Addresses: NotRequired[List[str]],

IpAddressesTypeDef#

# IpAddressesTypeDef definition

class IpAddressesTypeDef(TypedDict):
    ipV4Addresses: NotRequired[Sequence[str]],
    ipV6Addresses: NotRequired[Sequence[str]],

JobAttachmentDetailsIdentifiersTypeDef#

# JobAttachmentDetailsIdentifiersTypeDef definition

class JobAttachmentDetailsIdentifiersTypeDef(TypedDict):
    jobId: str,

PathMappingRuleTypeDef#

# PathMappingRuleTypeDef definition

class PathMappingRuleTypeDef(TypedDict):
    sourcePathFormat: PathFormatType,  # (1)
    sourcePath: str,
    destinationPath: str,
  1. See PathFormatType

JobDetailsIdentifiersTypeDef#

# JobDetailsIdentifiersTypeDef definition

class JobDetailsIdentifiersTypeDef(TypedDict):
    jobId: str,

StepDetailsIdentifiersTypeDef#

# StepDetailsIdentifiersTypeDef definition

class StepDetailsIdentifiersTypeDef(TypedDict):
    jobId: str,
    stepId: str,

StepDetailsEntityTypeDef#

# StepDetailsEntityTypeDef definition

class StepDetailsEntityTypeDef(TypedDict):
    jobId: str,
    stepId: str,
    schemaVersion: str,
    template: Dict[str, Any],
    dependencies: List[str],

JobMemberTypeDef#

# JobMemberTypeDef definition

class JobMemberTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    jobId: str,
    principalId: str,
    principalType: PrincipalTypeType,  # (1)
    identityStoreId: str,
    membershipLevel: MembershipLevelType,  # (2)
  1. See PrincipalTypeType
  2. See MembershipLevelType

PosixUserTypeDef#

# PosixUserTypeDef definition

class PosixUserTypeDef(TypedDict):
    user: str,
    group: str,

WindowsUserTypeDef#

# WindowsUserTypeDef definition

class WindowsUserTypeDef(TypedDict):
    user: str,
    passwordArn: str,

JobSummaryTypeDef#

# JobSummaryTypeDef definition

class JobSummaryTypeDef(TypedDict):
    jobId: str,
    name: str,
    lifecycleStatus: JobLifecycleStatusType,  # (1)
    lifecycleStatusMessage: str,
    priority: int,
    createdAt: datetime,
    createdBy: str,
    updatedAt: NotRequired[datetime],
    updatedBy: NotRequired[str],
    startedAt: NotRequired[datetime],
    endedAt: NotRequired[datetime],
    taskRunStatus: NotRequired[TaskRunStatusType],  # (2)
    targetTaskRunStatus: NotRequired[JobTargetTaskRunStatusType],  # (3)
    taskRunStatusCounts: NotRequired[Dict[TaskRunStatusType, int]],  # (4)
    maxFailedTasksCount: NotRequired[int],
    maxRetriesPerTask: NotRequired[int],
    sourceJobId: NotRequired[str],
  1. See JobLifecycleStatusType
  2. See TaskRunStatusType
  3. See JobTargetTaskRunStatusType
  4. See TaskRunStatusType

LicenseEndpointSummaryTypeDef#

# LicenseEndpointSummaryTypeDef definition

class LicenseEndpointSummaryTypeDef(TypedDict):
    licenseEndpointId: NotRequired[str],
    status: NotRequired[LicenseEndpointStatusType],  # (1)
    statusMessage: NotRequired[str],
    vpcId: NotRequired[str],
  1. See LicenseEndpointStatusType

ListAvailableMeteredProductsRequestRequestTypeDef#

# ListAvailableMeteredProductsRequestRequestTypeDef definition

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

MeteredProductSummaryTypeDef#

# MeteredProductSummaryTypeDef definition

class MeteredProductSummaryTypeDef(TypedDict):
    productId: str,
    family: str,
    vendor: str,
    port: int,

ListBudgetsRequestRequestTypeDef#

# ListBudgetsRequestRequestTypeDef definition

class ListBudgetsRequestRequestTypeDef(TypedDict):
    farmId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    status: NotRequired[BudgetStatusType],  # (1)
  1. See BudgetStatusType

ListFarmMembersRequestRequestTypeDef#

# ListFarmMembersRequestRequestTypeDef definition

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

ListFarmsRequestRequestTypeDef#

# ListFarmsRequestRequestTypeDef definition

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

ListFleetMembersRequestRequestTypeDef#

# ListFleetMembersRequestRequestTypeDef definition

class ListFleetMembersRequestRequestTypeDef(TypedDict):
    farmId: str,
    fleetId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListFleetsRequestRequestTypeDef#

# ListFleetsRequestRequestTypeDef definition

class ListFleetsRequestRequestTypeDef(TypedDict):
    farmId: str,
    principalId: NotRequired[str],
    displayName: NotRequired[str],
    status: NotRequired[FleetStatusType],  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See FleetStatusType

ListJobMembersRequestRequestTypeDef#

# ListJobMembersRequestRequestTypeDef definition

class ListJobMembersRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    jobId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListJobParameterDefinitionsRequestRequestTypeDef#

# ListJobParameterDefinitionsRequestRequestTypeDef definition

class ListJobParameterDefinitionsRequestRequestTypeDef(TypedDict):
    farmId: str,
    jobId: str,
    queueId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListJobsRequestRequestTypeDef#

# ListJobsRequestRequestTypeDef definition

class ListJobsRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    principalId: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListLicenseEndpointsRequestRequestTypeDef#

# ListLicenseEndpointsRequestRequestTypeDef definition

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

ListMeteredProductsRequestRequestTypeDef#

# ListMeteredProductsRequestRequestTypeDef definition

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

ListMonitorsRequestRequestTypeDef#

# ListMonitorsRequestRequestTypeDef definition

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

MonitorSummaryTypeDef#

# MonitorSummaryTypeDef definition

class MonitorSummaryTypeDef(TypedDict):
    monitorId: str,
    displayName: str,
    subdomain: str,
    url: str,
    roleArn: str,
    identityCenterInstanceArn: str,
    identityCenterApplicationArn: str,
    createdAt: datetime,
    createdBy: str,
    updatedAt: NotRequired[datetime],
    updatedBy: NotRequired[str],

ListQueueEnvironmentsRequestRequestTypeDef#

# ListQueueEnvironmentsRequestRequestTypeDef definition

class ListQueueEnvironmentsRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

QueueEnvironmentSummaryTypeDef#

# QueueEnvironmentSummaryTypeDef definition

class QueueEnvironmentSummaryTypeDef(TypedDict):
    queueEnvironmentId: str,
    name: str,
    priority: int,

ListQueueFleetAssociationsRequestRequestTypeDef#

# ListQueueFleetAssociationsRequestRequestTypeDef definition

class ListQueueFleetAssociationsRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: NotRequired[str],
    fleetId: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

QueueFleetAssociationSummaryTypeDef#

# QueueFleetAssociationSummaryTypeDef definition

class QueueFleetAssociationSummaryTypeDef(TypedDict):
    queueId: str,
    fleetId: str,
    status: QueueFleetAssociationStatusType,  # (1)
    createdAt: datetime,
    createdBy: str,
    updatedAt: NotRequired[datetime],
    updatedBy: NotRequired[str],
  1. See QueueFleetAssociationStatusType

ListQueueMembersRequestRequestTypeDef#

# ListQueueMembersRequestRequestTypeDef definition

class ListQueueMembersRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

QueueMemberTypeDef#

# QueueMemberTypeDef definition

class QueueMemberTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    principalId: str,
    principalType: PrincipalTypeType,  # (1)
    identityStoreId: str,
    membershipLevel: MembershipLevelType,  # (2)
  1. See PrincipalTypeType
  2. See MembershipLevelType

ListQueuesRequestRequestTypeDef#

# ListQueuesRequestRequestTypeDef definition

class ListQueuesRequestRequestTypeDef(TypedDict):
    farmId: str,
    principalId: NotRequired[str],
    status: NotRequired[QueueStatusType],  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See QueueStatusType

QueueSummaryTypeDef#

# QueueSummaryTypeDef definition

class QueueSummaryTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    displayName: str,
    status: QueueStatusType,  # (1)
    defaultBudgetAction: DefaultQueueBudgetActionType,  # (2)
    createdAt: datetime,
    createdBy: str,
    blockedReason: NotRequired[QueueBlockedReasonType],  # (3)
    updatedAt: NotRequired[datetime],
    updatedBy: NotRequired[str],
  1. See QueueStatusType
  2. See DefaultQueueBudgetActionType
  3. See QueueBlockedReasonType

ListSessionActionsRequestRequestTypeDef#

# ListSessionActionsRequestRequestTypeDef definition

class ListSessionActionsRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    jobId: str,
    sessionId: NotRequired[str],
    taskId: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListSessionsForWorkerRequestRequestTypeDef#

# ListSessionsForWorkerRequestRequestTypeDef definition

class ListSessionsForWorkerRequestRequestTypeDef(TypedDict):
    farmId: str,
    fleetId: str,
    workerId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

WorkerSessionSummaryTypeDef#

# WorkerSessionSummaryTypeDef definition

class WorkerSessionSummaryTypeDef(TypedDict):
    sessionId: str,
    queueId: str,
    jobId: str,
    startedAt: datetime,
    lifecycleStatus: SessionLifecycleStatusType,  # (1)
    endedAt: NotRequired[datetime],
    targetLifecycleStatus: NotRequired[SessionLifecycleTargetStatusType],  # (2)
  1. See SessionLifecycleStatusType
  2. See SessionLifecycleTargetStatusType

ListSessionsRequestRequestTypeDef#

# ListSessionsRequestRequestTypeDef definition

class ListSessionsRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    jobId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

SessionSummaryTypeDef#

# SessionSummaryTypeDef definition

class SessionSummaryTypeDef(TypedDict):
    sessionId: str,
    fleetId: str,
    workerId: str,
    startedAt: datetime,
    lifecycleStatus: SessionLifecycleStatusType,  # (1)
    endedAt: NotRequired[datetime],
    updatedAt: NotRequired[datetime],
    updatedBy: NotRequired[str],
    targetLifecycleStatus: NotRequired[SessionLifecycleTargetStatusType],  # (2)
  1. See SessionLifecycleStatusType
  2. See SessionLifecycleTargetStatusType

ListStepConsumersRequestRequestTypeDef#

# ListStepConsumersRequestRequestTypeDef definition

class ListStepConsumersRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    jobId: str,
    stepId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

StepConsumerTypeDef#

# StepConsumerTypeDef definition

class StepConsumerTypeDef(TypedDict):
    stepId: str,
    status: DependencyConsumerResolutionStatusType,  # (1)
  1. See DependencyConsumerResolutionStatusType

ListStepDependenciesRequestRequestTypeDef#

# ListStepDependenciesRequestRequestTypeDef definition

class ListStepDependenciesRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    jobId: str,
    stepId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

StepDependencyTypeDef#

# StepDependencyTypeDef definition

class StepDependencyTypeDef(TypedDict):
    stepId: str,
    status: DependencyConsumerResolutionStatusType,  # (1)
  1. See DependencyConsumerResolutionStatusType

ListStepsRequestRequestTypeDef#

# ListStepsRequestRequestTypeDef definition

class ListStepsRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    jobId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListStorageProfilesForQueueRequestRequestTypeDef#

# ListStorageProfilesForQueueRequestRequestTypeDef definition

class ListStorageProfilesForQueueRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

StorageProfileSummaryTypeDef#

# StorageProfileSummaryTypeDef definition

class StorageProfileSummaryTypeDef(TypedDict):
    storageProfileId: str,
    displayName: str,
    osFamily: StorageProfileOperatingSystemFamilyType,  # (1)
  1. See StorageProfileOperatingSystemFamilyType

ListStorageProfilesRequestRequestTypeDef#

# ListStorageProfilesRequestRequestTypeDef definition

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

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

ListTasksRequestRequestTypeDef#

# ListTasksRequestRequestTypeDef definition

class ListTasksRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    jobId: str,
    stepId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListWorkersRequestRequestTypeDef#

# ListWorkersRequestRequestTypeDef definition

class ListWorkersRequestRequestTypeDef(TypedDict):
    farmId: str,
    fleetId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ManifestPropertiesTypeDef#

# ManifestPropertiesTypeDef definition

class ManifestPropertiesTypeDef(TypedDict):
    rootPath: str,
    rootPathFormat: PathFormatType,  # (1)
    fileSystemLocationName: NotRequired[str],
    outputRelativeDirectories: NotRequired[Sequence[str]],
    inputManifestPath: NotRequired[str],
    inputManifestHash: NotRequired[str],
  1. See PathFormatType

ParameterFilterExpressionTypeDef#

# ParameterFilterExpressionTypeDef definition

class ParameterFilterExpressionTypeDef(TypedDict):
    name: str,
    operator: ComparisonOperatorType,  # (1)
    value: str,
  1. See ComparisonOperatorType

ParameterSortExpressionTypeDef#

# ParameterSortExpressionTypeDef definition

class ParameterSortExpressionTypeDef(TypedDict):
    sortOrder: SortOrderType,  # (1)
    name: str,
  1. See SortOrderType

StepParameterTypeDef#

# StepParameterTypeDef definition

class StepParameterTypeDef(TypedDict):
    name: str,
    type: StepParameterTypeType,  # (1)
  1. See StepParameterTypeType

PutMeteredProductRequestRequestTypeDef#

# PutMeteredProductRequestRequestTypeDef definition

class PutMeteredProductRequestRequestTypeDef(TypedDict):
    licenseEndpointId: str,
    productId: str,

SearchTermFilterExpressionTypeDef#

# SearchTermFilterExpressionTypeDef definition

class SearchTermFilterExpressionTypeDef(TypedDict):
    searchTerm: str,

StringFilterExpressionTypeDef#

# StringFilterExpressionTypeDef definition

class StringFilterExpressionTypeDef(TypedDict):
    name: str,
    operator: ComparisonOperatorType,  # (1)
    value: str,
  1. See ComparisonOperatorType

UserJobsFirstTypeDef#

# UserJobsFirstTypeDef definition

class UserJobsFirstTypeDef(TypedDict):
    userIdentityId: str,

ServiceManagedEc2InstanceMarketOptionsTypeDef#

# ServiceManagedEc2InstanceMarketOptionsTypeDef definition

class ServiceManagedEc2InstanceMarketOptionsTypeDef(TypedDict):
    type: Ec2MarketTypeType,  # (1)
  1. See Ec2MarketTypeType

SyncInputJobAttachmentsSessionActionDefinitionSummaryTypeDef#

# SyncInputJobAttachmentsSessionActionDefinitionSummaryTypeDef definition

class SyncInputJobAttachmentsSessionActionDefinitionSummaryTypeDef(TypedDict):
    stepId: NotRequired[str],

TaskRunSessionActionDefinitionSummaryTypeDef#

# TaskRunSessionActionDefinitionSummaryTypeDef definition

class TaskRunSessionActionDefinitionSummaryTypeDef(TypedDict):
    taskId: str,
    stepId: str,

SyncInputJobAttachmentsSessionActionDefinitionTypeDef#

# SyncInputJobAttachmentsSessionActionDefinitionTypeDef definition

class SyncInputJobAttachmentsSessionActionDefinitionTypeDef(TypedDict):
    stepId: NotRequired[str],

SessionsStatisticsResourcesTypeDef#

# SessionsStatisticsResourcesTypeDef definition

class SessionsStatisticsResourcesTypeDef(TypedDict):
    queueIds: NotRequired[Sequence[str]],
    fleetIds: NotRequired[Sequence[str]],

StatsTypeDef#

# StatsTypeDef definition

class StatsTypeDef(TypedDict):
    min: NotRequired[float],
    max: NotRequired[float],
    avg: NotRequired[float],
    sum: NotRequired[float],

StepAmountCapabilityTypeDef#

# StepAmountCapabilityTypeDef definition

class StepAmountCapabilityTypeDef(TypedDict):
    name: str,
    min: NotRequired[float],
    max: NotRequired[float],
    value: NotRequired[float],

StepAttributeCapabilityTypeDef#

# StepAttributeCapabilityTypeDef definition

class StepAttributeCapabilityTypeDef(TypedDict):
    name: str,
    anyOf: NotRequired[List[str]],
    allOf: NotRequired[List[str]],

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

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

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

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

UpdateFarmRequestRequestTypeDef#

# UpdateFarmRequestRequestTypeDef definition

class UpdateFarmRequestRequestTypeDef(TypedDict):
    farmId: str,
    displayName: NotRequired[str],
    description: NotRequired[str],

UpdateJobRequestRequestTypeDef#

# UpdateJobRequestRequestTypeDef definition

class UpdateJobRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    jobId: str,
    clientToken: NotRequired[str],
    targetTaskRunStatus: NotRequired[JobTargetTaskRunStatusType],  # (1)
    priority: NotRequired[int],
    maxFailedTasksCount: NotRequired[int],
    maxRetriesPerTask: NotRequired[int],
    lifecycleStatus: NotRequired[UpdateJobLifecycleStatusType],  # (2)
  1. See JobTargetTaskRunStatusType
  2. See UpdateJobLifecycleStatusType

UpdateMonitorRequestRequestTypeDef#

# UpdateMonitorRequestRequestTypeDef definition

class UpdateMonitorRequestRequestTypeDef(TypedDict):
    monitorId: str,
    subdomain: NotRequired[str],
    displayName: NotRequired[str],
    roleArn: NotRequired[str],

UpdateQueueEnvironmentRequestRequestTypeDef#

# UpdateQueueEnvironmentRequestRequestTypeDef definition

class UpdateQueueEnvironmentRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    queueEnvironmentId: str,
    clientToken: NotRequired[str],
    priority: NotRequired[int],
    templateType: NotRequired[EnvironmentTemplateTypeType],  # (1)
    template: NotRequired[str],
  1. See EnvironmentTemplateTypeType

UpdateQueueFleetAssociationRequestRequestTypeDef#

# UpdateQueueFleetAssociationRequestRequestTypeDef definition

class UpdateQueueFleetAssociationRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    fleetId: str,
    status: UpdateQueueFleetAssociationStatusType,  # (1)
  1. See UpdateQueueFleetAssociationStatusType

UpdateSessionRequestRequestTypeDef#

# UpdateSessionRequestRequestTypeDef definition

class UpdateSessionRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    jobId: str,
    sessionId: str,
    targetLifecycleStatus: SessionLifecycleTargetStatusType,  # (1)
    clientToken: NotRequired[str],
  1. See SessionLifecycleTargetStatusType

UpdateStepRequestRequestTypeDef#

# UpdateStepRequestRequestTypeDef definition

class UpdateStepRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    jobId: str,
    stepId: str,
    targetTaskRunStatus: StepTargetTaskRunStatusType,  # (1)
    clientToken: NotRequired[str],
  1. See StepTargetTaskRunStatusType

UpdateTaskRequestRequestTypeDef#

# UpdateTaskRequestRequestTypeDef definition

class UpdateTaskRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    jobId: str,
    stepId: str,
    taskId: str,
    targetRunStatus: TaskTargetRunStatusType,  # (1)
    clientToken: NotRequired[str],
  1. See TaskTargetRunStatusType

WorkerAmountCapabilityTypeDef#

# WorkerAmountCapabilityTypeDef definition

class WorkerAmountCapabilityTypeDef(TypedDict):
    name: str,
    value: float,

WorkerAttributeCapabilityTypeDef#

# WorkerAttributeCapabilityTypeDef definition

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

AcceleratorCapabilitiesOutputTypeDef#

# AcceleratorCapabilitiesOutputTypeDef definition

class AcceleratorCapabilitiesOutputTypeDef(TypedDict):
    selections: List[AcceleratorSelectionTypeDef],  # (1)
    count: NotRequired[AcceleratorCountRangeTypeDef],  # (2)
  1. See AcceleratorSelectionTypeDef
  2. See AcceleratorCountRangeTypeDef

AcceleratorCapabilitiesTypeDef#

# AcceleratorCapabilitiesTypeDef definition

class AcceleratorCapabilitiesTypeDef(TypedDict):
    selections: Sequence[AcceleratorSelectionTypeDef],  # (1)
    count: NotRequired[AcceleratorCountRangeTypeDef],  # (2)
  1. See AcceleratorSelectionTypeDef
  2. See AcceleratorCountRangeTypeDef

AssignedTaskRunSessionActionDefinitionTypeDef#

# AssignedTaskRunSessionActionDefinitionTypeDef definition

class AssignedTaskRunSessionActionDefinitionTypeDef(TypedDict):
    taskId: str,
    stepId: str,
    parameters: Dict[str, TaskParameterValueTypeDef],  # (1)
  1. See TaskParameterValueTypeDef

TaskRunSessionActionDefinitionTypeDef#

# TaskRunSessionActionDefinitionTypeDef definition

class TaskRunSessionActionDefinitionTypeDef(TypedDict):
    taskId: str,
    stepId: str,
    parameters: Dict[str, TaskParameterValueTypeDef],  # (1)
  1. See TaskParameterValueTypeDef

TaskSearchSummaryTypeDef#

# TaskSearchSummaryTypeDef definition

class TaskSearchSummaryTypeDef(TypedDict):
    taskId: NotRequired[str],
    stepId: NotRequired[str],
    jobId: NotRequired[str],
    queueId: NotRequired[str],
    runStatus: NotRequired[TaskRunStatusType],  # (1)
    targetRunStatus: NotRequired[TaskTargetRunStatusType],  # (2)
    parameters: NotRequired[Dict[str, TaskParameterValueTypeDef]],  # (3)
    failureRetryCount: NotRequired[int],
    startedAt: NotRequired[datetime],
    endedAt: NotRequired[datetime],
  1. See TaskRunStatusType
  2. See TaskTargetRunStatusType
  3. See TaskParameterValueTypeDef

TaskSummaryTypeDef#

# TaskSummaryTypeDef definition

class TaskSummaryTypeDef(TypedDict):
    taskId: str,
    createdAt: datetime,
    createdBy: str,
    runStatus: TaskRunStatusType,  # (1)
    targetRunStatus: NotRequired[TaskTargetRunStatusType],  # (2)
    failureRetryCount: NotRequired[int],
    parameters: NotRequired[Dict[str, TaskParameterValueTypeDef]],  # (3)
    startedAt: NotRequired[datetime],
    endedAt: NotRequired[datetime],
    updatedAt: NotRequired[datetime],
    updatedBy: NotRequired[str],
    latestSessionActionId: NotRequired[str],
  1. See TaskRunStatusType
  2. See TaskTargetRunStatusType
  3. See TaskParameterValueTypeDef

AssumeFleetRoleForReadResponseTypeDef#

# AssumeFleetRoleForReadResponseTypeDef definition

class AssumeFleetRoleForReadResponseTypeDef(TypedDict):
    credentials: AwsCredentialsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AwsCredentialsTypeDef
  2. See ResponseMetadataTypeDef

AssumeFleetRoleForWorkerResponseTypeDef#

# AssumeFleetRoleForWorkerResponseTypeDef definition

class AssumeFleetRoleForWorkerResponseTypeDef(TypedDict):
    credentials: AwsCredentialsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AwsCredentialsTypeDef
  2. See ResponseMetadataTypeDef

AssumeQueueRoleForReadResponseTypeDef#

# AssumeQueueRoleForReadResponseTypeDef definition

class AssumeQueueRoleForReadResponseTypeDef(TypedDict):
    credentials: AwsCredentialsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AwsCredentialsTypeDef
  2. See ResponseMetadataTypeDef

AssumeQueueRoleForUserResponseTypeDef#

# AssumeQueueRoleForUserResponseTypeDef definition

class AssumeQueueRoleForUserResponseTypeDef(TypedDict):
    credentials: AwsCredentialsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AwsCredentialsTypeDef
  2. See ResponseMetadataTypeDef

AssumeQueueRoleForWorkerResponseTypeDef#

# AssumeQueueRoleForWorkerResponseTypeDef definition

class AssumeQueueRoleForWorkerResponseTypeDef(TypedDict):
    credentials: AwsCredentialsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AwsCredentialsTypeDef
  2. See ResponseMetadataTypeDef

CopyJobTemplateResponseTypeDef#

# CopyJobTemplateResponseTypeDef definition

class CopyJobTemplateResponseTypeDef(TypedDict):
    templateType: JobTemplateTypeType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobTemplateTypeType
  2. See ResponseMetadataTypeDef

CreateBudgetResponseTypeDef#

# CreateBudgetResponseTypeDef definition

class CreateBudgetResponseTypeDef(TypedDict):
    budgetId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateFarmResponseTypeDef#

# CreateFarmResponseTypeDef definition

class CreateFarmResponseTypeDef(TypedDict):
    farmId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateFleetResponseTypeDef#

# CreateFleetResponseTypeDef definition

class CreateFleetResponseTypeDef(TypedDict):
    fleetId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateJobResponseTypeDef#

# CreateJobResponseTypeDef definition

class CreateJobResponseTypeDef(TypedDict):
    jobId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateLicenseEndpointResponseTypeDef#

# CreateLicenseEndpointResponseTypeDef definition

class CreateLicenseEndpointResponseTypeDef(TypedDict):
    licenseEndpointId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateMonitorResponseTypeDef#

# CreateMonitorResponseTypeDef definition

class CreateMonitorResponseTypeDef(TypedDict):
    monitorId: str,
    identityCenterApplicationArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateQueueEnvironmentResponseTypeDef#

# CreateQueueEnvironmentResponseTypeDef definition

class CreateQueueEnvironmentResponseTypeDef(TypedDict):
    queueEnvironmentId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateQueueResponseTypeDef#

# CreateQueueResponseTypeDef definition

class CreateQueueResponseTypeDef(TypedDict):
    queueId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateStorageProfileResponseTypeDef#

# CreateStorageProfileResponseTypeDef definition

class CreateStorageProfileResponseTypeDef(TypedDict):
    storageProfileId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateWorkerResponseTypeDef#

# CreateWorkerResponseTypeDef definition

class CreateWorkerResponseTypeDef(TypedDict):
    workerId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetFarmResponseTypeDef#

# GetFarmResponseTypeDef definition

class GetFarmResponseTypeDef(TypedDict):
    farmId: str,
    displayName: str,
    description: str,
    kmsKeyArn: str,
    createdAt: datetime,
    createdBy: str,
    updatedAt: datetime,
    updatedBy: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetLicenseEndpointResponseTypeDef#

# GetLicenseEndpointResponseTypeDef definition

class GetLicenseEndpointResponseTypeDef(TypedDict):
    licenseEndpointId: str,
    status: LicenseEndpointStatusType,  # (1)
    statusMessage: str,
    vpcId: str,
    dnsName: str,
    subnetIds: List[str],
    securityGroupIds: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See LicenseEndpointStatusType
  2. See ResponseMetadataTypeDef

GetMonitorResponseTypeDef#

# GetMonitorResponseTypeDef definition

class GetMonitorResponseTypeDef(TypedDict):
    monitorId: str,
    displayName: str,
    subdomain: str,
    url: str,
    roleArn: str,
    identityCenterInstanceArn: str,
    identityCenterApplicationArn: str,
    createdAt: datetime,
    createdBy: str,
    updatedAt: datetime,
    updatedBy: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetQueueEnvironmentResponseTypeDef#

# GetQueueEnvironmentResponseTypeDef definition

class GetQueueEnvironmentResponseTypeDef(TypedDict):
    queueEnvironmentId: str,
    name: str,
    priority: int,
    templateType: EnvironmentTemplateTypeType,  # (1)
    template: str,
    createdAt: datetime,
    createdBy: str,
    updatedAt: datetime,
    updatedBy: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EnvironmentTemplateTypeType
  2. See ResponseMetadataTypeDef

GetQueueFleetAssociationResponseTypeDef#

# GetQueueFleetAssociationResponseTypeDef definition

class GetQueueFleetAssociationResponseTypeDef(TypedDict):
    queueId: str,
    fleetId: str,
    status: QueueFleetAssociationStatusType,  # (1)
    createdAt: datetime,
    createdBy: str,
    updatedAt: datetime,
    updatedBy: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See QueueFleetAssociationStatusType
  2. See ResponseMetadataTypeDef

GetTaskResponseTypeDef#

# GetTaskResponseTypeDef definition

class GetTaskResponseTypeDef(TypedDict):
    taskId: str,
    createdAt: datetime,
    createdBy: str,
    runStatus: TaskRunStatusType,  # (1)
    targetRunStatus: TaskTargetRunStatusType,  # (2)
    failureRetryCount: int,
    parameters: Dict[str, TaskParameterValueTypeDef],  # (3)
    startedAt: datetime,
    endedAt: datetime,
    updatedAt: datetime,
    updatedBy: str,
    latestSessionActionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See TaskRunStatusType
  2. See TaskTargetRunStatusType
  3. See TaskParameterValueTypeDef
  4. See ResponseMetadataTypeDef

ListJobParameterDefinitionsResponseTypeDef#

# ListJobParameterDefinitionsResponseTypeDef definition

class ListJobParameterDefinitionsResponseTypeDef(TypedDict):
    jobParameterDefinitions: List[Dict[str, Any]],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
    nextToken: NotRequired[str],
  1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

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

StartSessionsStatisticsAggregationResponseTypeDef#

# StartSessionsStatisticsAggregationResponseTypeDef definition

class StartSessionsStatisticsAggregationResponseTypeDef(TypedDict):
    aggregationId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateWorkerResponseTypeDef#

# UpdateWorkerResponseTypeDef definition

class UpdateWorkerResponseTypeDef(TypedDict):
    log: LogConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See LogConfigurationTypeDef
  2. See ResponseMetadataTypeDef

AttachmentsOutputTypeDef#

# AttachmentsOutputTypeDef definition

class AttachmentsOutputTypeDef(TypedDict):
    manifests: List[ManifestPropertiesOutputTypeDef],  # (1)
    fileSystem: NotRequired[JobAttachmentsFileSystemType],  # (2)
  1. See ManifestPropertiesOutputTypeDef
  2. See JobAttachmentsFileSystemType

BudgetScheduleOutputTypeDef#

# BudgetScheduleOutputTypeDef definition

class BudgetScheduleOutputTypeDef(TypedDict):
    fixed: NotRequired[FixedBudgetScheduleOutputTypeDef],  # (1)
  1. See FixedBudgetScheduleOutputTypeDef

BudgetSummaryTypeDef#

# BudgetSummaryTypeDef definition

class BudgetSummaryTypeDef(TypedDict):
    budgetId: str,
    usageTrackingResource: UsageTrackingResourceTypeDef,  # (1)
    status: BudgetStatusType,  # (2)
    displayName: str,
    approximateDollarLimit: float,
    usages: ConsumedUsagesTypeDef,  # (3)
    createdBy: str,
    createdAt: datetime,
    description: NotRequired[str],
    updatedBy: NotRequired[str],
    updatedAt: NotRequired[datetime],
  1. See UsageTrackingResourceTypeDef
  2. See BudgetStatusType
  3. See ConsumedUsagesTypeDef

CopyJobTemplateRequestRequestTypeDef#

# CopyJobTemplateRequestRequestTypeDef definition

class CopyJobTemplateRequestRequestTypeDef(TypedDict):
    farmId: str,
    jobId: str,
    queueId: str,
    targetS3Location: S3LocationTypeDef,  # (1)
  1. See S3LocationTypeDef

JobSearchSummaryTypeDef#

# JobSearchSummaryTypeDef definition

class JobSearchSummaryTypeDef(TypedDict):
    jobId: NotRequired[str],
    queueId: NotRequired[str],
    name: NotRequired[str],
    lifecycleStatus: NotRequired[JobLifecycleStatusType],  # (1)
    lifecycleStatusMessage: NotRequired[str],
    taskRunStatus: NotRequired[TaskRunStatusType],  # (2)
    targetTaskRunStatus: NotRequired[JobTargetTaskRunStatusType],  # (3)
    taskRunStatusCounts: NotRequired[Dict[TaskRunStatusType, int]],  # (4)
    priority: NotRequired[int],
    maxFailedTasksCount: NotRequired[int],
    maxRetriesPerTask: NotRequired[int],
    createdBy: NotRequired[str],
    createdAt: NotRequired[datetime],
    endedAt: NotRequired[datetime],
    startedAt: NotRequired[datetime],
    jobParameters: NotRequired[Dict[str, JobParameterTypeDef]],  # (5)
    sourceJobId: NotRequired[str],
  1. See JobLifecycleStatusType
  2. See TaskRunStatusType
  3. See JobTargetTaskRunStatusType
  4. See TaskRunStatusType
  5. See JobParameterTypeDef

CreateStorageProfileRequestRequestTypeDef#

# CreateStorageProfileRequestRequestTypeDef definition

class CreateStorageProfileRequestRequestTypeDef(TypedDict):
    farmId: str,
    displayName: str,
    osFamily: StorageProfileOperatingSystemFamilyType,  # (1)
    clientToken: NotRequired[str],
    fileSystemLocations: NotRequired[Sequence[FileSystemLocationTypeDef]],  # (2)
  1. See StorageProfileOperatingSystemFamilyType
  2. See FileSystemLocationTypeDef

GetStorageProfileForQueueResponseTypeDef#

# GetStorageProfileForQueueResponseTypeDef definition

class GetStorageProfileForQueueResponseTypeDef(TypedDict):
    storageProfileId: str,
    displayName: str,
    osFamily: StorageProfileOperatingSystemFamilyType,  # (1)
    fileSystemLocations: List[FileSystemLocationTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See StorageProfileOperatingSystemFamilyType
  2. See FileSystemLocationTypeDef
  3. See ResponseMetadataTypeDef

GetStorageProfileResponseTypeDef#

# GetStorageProfileResponseTypeDef definition

class GetStorageProfileResponseTypeDef(TypedDict):
    storageProfileId: str,
    displayName: str,
    osFamily: StorageProfileOperatingSystemFamilyType,  # (1)
    createdAt: datetime,
    createdBy: str,
    updatedAt: datetime,
    updatedBy: str,
    fileSystemLocations: List[FileSystemLocationTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See StorageProfileOperatingSystemFamilyType
  2. See FileSystemLocationTypeDef
  3. See ResponseMetadataTypeDef

UpdateStorageProfileRequestRequestTypeDef#

# UpdateStorageProfileRequestRequestTypeDef definition

class UpdateStorageProfileRequestRequestTypeDef(TypedDict):
    farmId: str,
    storageProfileId: str,
    clientToken: NotRequired[str],
    displayName: NotRequired[str],
    osFamily: NotRequired[StorageProfileOperatingSystemFamilyType],  # (1)
    fileSystemLocationsToAdd: NotRequired[Sequence[FileSystemLocationTypeDef]],  # (2)
    fileSystemLocationsToRemove: NotRequired[Sequence[FileSystemLocationTypeDef]],  # (2)
  1. See StorageProfileOperatingSystemFamilyType
  2. See FileSystemLocationTypeDef
  3. See FileSystemLocationTypeDef

FleetCapabilitiesTypeDef#

# FleetCapabilitiesTypeDef definition

class FleetCapabilitiesTypeDef(TypedDict):
    amounts: NotRequired[List[FleetAmountCapabilityTypeDef]],  # (1)
    attributes: NotRequired[List[FleetAttributeCapabilityOutputTypeDef]],  # (2)
  1. See FleetAmountCapabilityTypeDef
  2. See FleetAttributeCapabilityOutputTypeDef

CustomerManagedWorkerCapabilitiesOutputTypeDef#

# CustomerManagedWorkerCapabilitiesOutputTypeDef definition

class CustomerManagedWorkerCapabilitiesOutputTypeDef(TypedDict):
    vCpuCount: VCpuCountRangeTypeDef,  # (1)
    memoryMiB: MemoryMiBRangeTypeDef,  # (2)
    osFamily: CustomerManagedFleetOperatingSystemFamilyType,  # (6)
    cpuArchitectureType: CpuArchitectureTypeType,  # (7)
    acceleratorTypes: NotRequired[List[AcceleratorTypeType]],  # (3)
    acceleratorCount: NotRequired[AcceleratorCountRangeTypeDef],  # (4)
    acceleratorTotalMemoryMiB: NotRequired[AcceleratorTotalMemoryMiBRangeTypeDef],  # (5)
    customAmounts: NotRequired[List[FleetAmountCapabilityTypeDef]],  # (8)
    customAttributes: NotRequired[List[FleetAttributeCapabilityOutputTypeDef]],  # (9)
  1. See VCpuCountRangeTypeDef
  2. See MemoryMiBRangeTypeDef
  3. See AcceleratorTypeType
  4. See AcceleratorCountRangeTypeDef
  5. See AcceleratorTotalMemoryMiBRangeTypeDef
  6. See CustomerManagedFleetOperatingSystemFamilyType
  7. See CpuArchitectureTypeType
  8. See FleetAmountCapabilityTypeDef
  9. See FleetAttributeCapabilityOutputTypeDef

DateTimeFilterExpressionTypeDef#

# DateTimeFilterExpressionTypeDef definition

class DateTimeFilterExpressionTypeDef(TypedDict):
    name: str,
    operator: ComparisonOperatorType,  # (1)
    dateTime: TimestampTypeDef,
  1. See ComparisonOperatorType

FixedBudgetScheduleTypeDef#

# FixedBudgetScheduleTypeDef definition

class FixedBudgetScheduleTypeDef(TypedDict):
    startTime: TimestampTypeDef,
    endTime: TimestampTypeDef,

UpdatedSessionActionInfoTypeDef#

# UpdatedSessionActionInfoTypeDef definition

class UpdatedSessionActionInfoTypeDef(TypedDict):
    completedStatus: NotRequired[CompletedStatusType],  # (1)
    processExitCode: NotRequired[int],
    progressMessage: NotRequired[str],
    startedAt: NotRequired[TimestampTypeDef],
    endedAt: NotRequired[TimestampTypeDef],
    updatedAt: NotRequired[TimestampTypeDef],
    progressPercent: NotRequired[float],
  1. See CompletedStatusType

StepSummaryTypeDef#

# StepSummaryTypeDef definition

class StepSummaryTypeDef(TypedDict):
    stepId: str,
    name: str,
    lifecycleStatus: StepLifecycleStatusType,  # (1)
    taskRunStatus: TaskRunStatusType,  # (2)
    taskRunStatusCounts: Dict[TaskRunStatusType, int],  # (3)
    createdAt: datetime,
    createdBy: str,
    lifecycleStatusMessage: NotRequired[str],
    targetTaskRunStatus: NotRequired[StepTargetTaskRunStatusType],  # (4)
    updatedAt: NotRequired[datetime],
    updatedBy: NotRequired[str],
    startedAt: NotRequired[datetime],
    endedAt: NotRequired[datetime],
    dependencyCounts: NotRequired[DependencyCountsTypeDef],  # (5)
  1. See StepLifecycleStatusType
  2. See TaskRunStatusType
  3. See TaskRunStatusType
  4. See StepTargetTaskRunStatusType
  5. See DependencyCountsTypeDef

ListFarmMembersResponseTypeDef#

# ListFarmMembersResponseTypeDef definition

class ListFarmMembersResponseTypeDef(TypedDict):
    members: List[FarmMemberTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See FarmMemberTypeDef
  2. See ResponseMetadataTypeDef

ListFarmsResponseTypeDef#

# ListFarmsResponseTypeDef definition

class ListFarmsResponseTypeDef(TypedDict):
    farms: List[FarmSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See FarmSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListFleetMembersResponseTypeDef#

# ListFleetMembersResponseTypeDef definition

class ListFleetMembersResponseTypeDef(TypedDict):
    members: List[FleetMemberTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See FleetMemberTypeDef
  2. See ResponseMetadataTypeDef

GetFleetRequestFleetActiveWaitTypeDef#

# GetFleetRequestFleetActiveWaitTypeDef definition

class GetFleetRequestFleetActiveWaitTypeDef(TypedDict):
    farmId: str,
    fleetId: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

GetJobRequestJobCreateCompleteWaitTypeDef#

# GetJobRequestJobCreateCompleteWaitTypeDef definition

class GetJobRequestJobCreateCompleteWaitTypeDef(TypedDict):
    farmId: str,
    jobId: str,
    queueId: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

GetLicenseEndpointRequestLicenseEndpointDeletedWaitTypeDef#

# GetLicenseEndpointRequestLicenseEndpointDeletedWaitTypeDef definition

class GetLicenseEndpointRequestLicenseEndpointDeletedWaitTypeDef(TypedDict):
    licenseEndpointId: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

GetLicenseEndpointRequestLicenseEndpointValidWaitTypeDef#

# GetLicenseEndpointRequestLicenseEndpointValidWaitTypeDef definition

class GetLicenseEndpointRequestLicenseEndpointValidWaitTypeDef(TypedDict):
    licenseEndpointId: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

GetQueueFleetAssociationRequestQueueFleetAssociationStoppedWaitTypeDef#

# GetQueueFleetAssociationRequestQueueFleetAssociationStoppedWaitTypeDef definition

class GetQueueFleetAssociationRequestQueueFleetAssociationStoppedWaitTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    fleetId: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

GetQueueRequestQueueSchedulingBlockedWaitTypeDef#

# GetQueueRequestQueueSchedulingBlockedWaitTypeDef definition

class GetQueueRequestQueueSchedulingBlockedWaitTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

GetQueueRequestQueueSchedulingWaitTypeDef#

# GetQueueRequestQueueSchedulingWaitTypeDef definition

class GetQueueRequestQueueSchedulingWaitTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

GetJobEntityErrorTypeDef#

# GetJobEntityErrorTypeDef definition

class GetJobEntityErrorTypeDef(TypedDict):
    jobDetails: NotRequired[JobDetailsErrorTypeDef],  # (1)
    jobAttachmentDetails: NotRequired[JobAttachmentDetailsErrorTypeDef],  # (2)
    stepDetails: NotRequired[StepDetailsErrorTypeDef],  # (3)
    environmentDetails: NotRequired[EnvironmentDetailsErrorTypeDef],  # (4)
  1. See JobDetailsErrorTypeDef
  2. See JobAttachmentDetailsErrorTypeDef
  3. See StepDetailsErrorTypeDef
  4. See EnvironmentDetailsErrorTypeDef

GetSessionsStatisticsAggregationRequestGetSessionsStatisticsAggregationPaginateTypeDef#

# GetSessionsStatisticsAggregationRequestGetSessionsStatisticsAggregationPaginateTypeDef definition

class GetSessionsStatisticsAggregationRequestGetSessionsStatisticsAggregationPaginateTypeDef(TypedDict):
    farmId: str,
    aggregationId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListAvailableMeteredProductsRequestListAvailableMeteredProductsPaginateTypeDef#

# ListAvailableMeteredProductsRequestListAvailableMeteredProductsPaginateTypeDef definition

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

ListBudgetsRequestListBudgetsPaginateTypeDef#

# ListBudgetsRequestListBudgetsPaginateTypeDef definition

class ListBudgetsRequestListBudgetsPaginateTypeDef(TypedDict):
    farmId: str,
    status: NotRequired[BudgetStatusType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See BudgetStatusType
  2. See PaginatorConfigTypeDef

ListFarmMembersRequestListFarmMembersPaginateTypeDef#

# ListFarmMembersRequestListFarmMembersPaginateTypeDef definition

class ListFarmMembersRequestListFarmMembersPaginateTypeDef(TypedDict):
    farmId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListFarmsRequestListFarmsPaginateTypeDef#

# ListFarmsRequestListFarmsPaginateTypeDef definition

class ListFarmsRequestListFarmsPaginateTypeDef(TypedDict):
    principalId: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListFleetMembersRequestListFleetMembersPaginateTypeDef#

# ListFleetMembersRequestListFleetMembersPaginateTypeDef definition

class ListFleetMembersRequestListFleetMembersPaginateTypeDef(TypedDict):
    farmId: str,
    fleetId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListFleetsRequestListFleetsPaginateTypeDef#

# ListFleetsRequestListFleetsPaginateTypeDef definition

class ListFleetsRequestListFleetsPaginateTypeDef(TypedDict):
    farmId: str,
    principalId: NotRequired[str],
    displayName: NotRequired[str],
    status: NotRequired[FleetStatusType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See FleetStatusType
  2. See PaginatorConfigTypeDef

ListJobMembersRequestListJobMembersPaginateTypeDef#

# ListJobMembersRequestListJobMembersPaginateTypeDef definition

class ListJobMembersRequestListJobMembersPaginateTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    jobId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListJobParameterDefinitionsRequestListJobParameterDefinitionsPaginateTypeDef#

# ListJobParameterDefinitionsRequestListJobParameterDefinitionsPaginateTypeDef definition

class ListJobParameterDefinitionsRequestListJobParameterDefinitionsPaginateTypeDef(TypedDict):
    farmId: str,
    jobId: str,
    queueId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListJobsRequestListJobsPaginateTypeDef#

# ListJobsRequestListJobsPaginateTypeDef definition

class ListJobsRequestListJobsPaginateTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    principalId: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListLicenseEndpointsRequestListLicenseEndpointsPaginateTypeDef#

# ListLicenseEndpointsRequestListLicenseEndpointsPaginateTypeDef definition

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

ListMeteredProductsRequestListMeteredProductsPaginateTypeDef#

# ListMeteredProductsRequestListMeteredProductsPaginateTypeDef definition

class ListMeteredProductsRequestListMeteredProductsPaginateTypeDef(TypedDict):
    licenseEndpointId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListMonitorsRequestListMonitorsPaginateTypeDef#

# ListMonitorsRequestListMonitorsPaginateTypeDef definition

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

ListQueueEnvironmentsRequestListQueueEnvironmentsPaginateTypeDef#

# ListQueueEnvironmentsRequestListQueueEnvironmentsPaginateTypeDef definition

class ListQueueEnvironmentsRequestListQueueEnvironmentsPaginateTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListQueueFleetAssociationsRequestListQueueFleetAssociationsPaginateTypeDef#

# ListQueueFleetAssociationsRequestListQueueFleetAssociationsPaginateTypeDef definition

class ListQueueFleetAssociationsRequestListQueueFleetAssociationsPaginateTypeDef(TypedDict):
    farmId: str,
    queueId: NotRequired[str],
    fleetId: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListQueueMembersRequestListQueueMembersPaginateTypeDef#

# ListQueueMembersRequestListQueueMembersPaginateTypeDef definition

class ListQueueMembersRequestListQueueMembersPaginateTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListQueuesRequestListQueuesPaginateTypeDef#

# ListQueuesRequestListQueuesPaginateTypeDef definition

class ListQueuesRequestListQueuesPaginateTypeDef(TypedDict):
    farmId: str,
    principalId: NotRequired[str],
    status: NotRequired[QueueStatusType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See QueueStatusType
  2. See PaginatorConfigTypeDef

ListSessionActionsRequestListSessionActionsPaginateTypeDef#

# ListSessionActionsRequestListSessionActionsPaginateTypeDef definition

class ListSessionActionsRequestListSessionActionsPaginateTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    jobId: str,
    sessionId: NotRequired[str],
    taskId: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListSessionsForWorkerRequestListSessionsForWorkerPaginateTypeDef#

# ListSessionsForWorkerRequestListSessionsForWorkerPaginateTypeDef definition

class ListSessionsForWorkerRequestListSessionsForWorkerPaginateTypeDef(TypedDict):
    farmId: str,
    fleetId: str,
    workerId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListSessionsRequestListSessionsPaginateTypeDef#

# ListSessionsRequestListSessionsPaginateTypeDef definition

class ListSessionsRequestListSessionsPaginateTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    jobId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListStepConsumersRequestListStepConsumersPaginateTypeDef#

# ListStepConsumersRequestListStepConsumersPaginateTypeDef definition

class ListStepConsumersRequestListStepConsumersPaginateTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    jobId: str,
    stepId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListStepDependenciesRequestListStepDependenciesPaginateTypeDef#

# ListStepDependenciesRequestListStepDependenciesPaginateTypeDef definition

class ListStepDependenciesRequestListStepDependenciesPaginateTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    jobId: str,
    stepId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListStepsRequestListStepsPaginateTypeDef#

# ListStepsRequestListStepsPaginateTypeDef definition

class ListStepsRequestListStepsPaginateTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    jobId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListStorageProfilesForQueueRequestListStorageProfilesForQueuePaginateTypeDef#

# ListStorageProfilesForQueueRequestListStorageProfilesForQueuePaginateTypeDef definition

class ListStorageProfilesForQueueRequestListStorageProfilesForQueuePaginateTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListStorageProfilesRequestListStorageProfilesPaginateTypeDef#

# ListStorageProfilesRequestListStorageProfilesPaginateTypeDef definition

class ListStorageProfilesRequestListStorageProfilesPaginateTypeDef(TypedDict):
    farmId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTasksRequestListTasksPaginateTypeDef#

# ListTasksRequestListTasksPaginateTypeDef definition

class ListTasksRequestListTasksPaginateTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    jobId: str,
    stepId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListWorkersRequestListWorkersPaginateTypeDef#

# ListWorkersRequestListWorkersPaginateTypeDef definition

class ListWorkersRequestListWorkersPaginateTypeDef(TypedDict):
    farmId: str,
    fleetId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

HostPropertiesResponseTypeDef#

# HostPropertiesResponseTypeDef definition

class HostPropertiesResponseTypeDef(TypedDict):
    ipAddresses: NotRequired[IpAddressesOutputTypeDef],  # (1)
    hostName: NotRequired[str],
    ec2InstanceArn: NotRequired[str],
    ec2InstanceType: NotRequired[str],
  1. See IpAddressesOutputTypeDef

JobEntityIdentifiersUnionTypeDef#

# JobEntityIdentifiersUnionTypeDef definition

class JobEntityIdentifiersUnionTypeDef(TypedDict):
    jobDetails: NotRequired[JobDetailsIdentifiersTypeDef],  # (1)
    jobAttachmentDetails: NotRequired[JobAttachmentDetailsIdentifiersTypeDef],  # (2)
    stepDetails: NotRequired[StepDetailsIdentifiersTypeDef],  # (3)
    environmentDetails: NotRequired[EnvironmentDetailsIdentifiersTypeDef],  # (4)
  1. See JobDetailsIdentifiersTypeDef
  2. See JobAttachmentDetailsIdentifiersTypeDef
  3. See StepDetailsIdentifiersTypeDef
  4. See EnvironmentDetailsIdentifiersTypeDef

ListJobMembersResponseTypeDef#

# ListJobMembersResponseTypeDef definition

class ListJobMembersResponseTypeDef(TypedDict):
    members: List[JobMemberTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See JobMemberTypeDef
  2. See ResponseMetadataTypeDef

JobRunAsUserTypeDef#

# JobRunAsUserTypeDef definition

class JobRunAsUserTypeDef(TypedDict):
    runAs: RunAsType,  # (3)
    posix: NotRequired[PosixUserTypeDef],  # (1)
    windows: NotRequired[WindowsUserTypeDef],  # (2)
  1. See PosixUserTypeDef
  2. See WindowsUserTypeDef
  3. See RunAsType

ListJobsResponseTypeDef#

# ListJobsResponseTypeDef definition

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

ListLicenseEndpointsResponseTypeDef#

# ListLicenseEndpointsResponseTypeDef definition

class ListLicenseEndpointsResponseTypeDef(TypedDict):
    licenseEndpoints: List[LicenseEndpointSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See LicenseEndpointSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListAvailableMeteredProductsResponseTypeDef#

# ListAvailableMeteredProductsResponseTypeDef definition

class ListAvailableMeteredProductsResponseTypeDef(TypedDict):
    meteredProducts: List[MeteredProductSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See MeteredProductSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListMeteredProductsResponseTypeDef#

# ListMeteredProductsResponseTypeDef definition

class ListMeteredProductsResponseTypeDef(TypedDict):
    meteredProducts: List[MeteredProductSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See MeteredProductSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListMonitorsResponseTypeDef#

# ListMonitorsResponseTypeDef definition

class ListMonitorsResponseTypeDef(TypedDict):
    monitors: List[MonitorSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See MonitorSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListQueueEnvironmentsResponseTypeDef#

# ListQueueEnvironmentsResponseTypeDef definition

class ListQueueEnvironmentsResponseTypeDef(TypedDict):
    environments: List[QueueEnvironmentSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See QueueEnvironmentSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListQueueFleetAssociationsResponseTypeDef#

# ListQueueFleetAssociationsResponseTypeDef definition

class ListQueueFleetAssociationsResponseTypeDef(TypedDict):
    queueFleetAssociations: List[QueueFleetAssociationSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See QueueFleetAssociationSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListQueueMembersResponseTypeDef#

# ListQueueMembersResponseTypeDef definition

class ListQueueMembersResponseTypeDef(TypedDict):
    members: List[QueueMemberTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See QueueMemberTypeDef
  2. See ResponseMetadataTypeDef

ListQueuesResponseTypeDef#

# ListQueuesResponseTypeDef definition

class ListQueuesResponseTypeDef(TypedDict):
    queues: List[QueueSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See QueueSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListSessionsForWorkerResponseTypeDef#

# ListSessionsForWorkerResponseTypeDef definition

class ListSessionsForWorkerResponseTypeDef(TypedDict):
    sessions: List[WorkerSessionSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See WorkerSessionSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListSessionsResponseTypeDef#

# ListSessionsResponseTypeDef definition

class ListSessionsResponseTypeDef(TypedDict):
    sessions: List[SessionSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See SessionSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListStepConsumersResponseTypeDef#

# ListStepConsumersResponseTypeDef definition

class ListStepConsumersResponseTypeDef(TypedDict):
    consumers: List[StepConsumerTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See StepConsumerTypeDef
  2. See ResponseMetadataTypeDef

ListStepDependenciesResponseTypeDef#

# ListStepDependenciesResponseTypeDef definition

class ListStepDependenciesResponseTypeDef(TypedDict):
    dependencies: List[StepDependencyTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See StepDependencyTypeDef
  2. See ResponseMetadataTypeDef

ListStorageProfilesForQueueResponseTypeDef#

# ListStorageProfilesForQueueResponseTypeDef definition

class ListStorageProfilesForQueueResponseTypeDef(TypedDict):
    storageProfiles: List[StorageProfileSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See StorageProfileSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListStorageProfilesResponseTypeDef#

# ListStorageProfilesResponseTypeDef definition

class ListStorageProfilesResponseTypeDef(TypedDict):
    storageProfiles: List[StorageProfileSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See StorageProfileSummaryTypeDef
  2. See ResponseMetadataTypeDef

ParameterSpaceTypeDef#

# ParameterSpaceTypeDef definition

class ParameterSpaceTypeDef(TypedDict):
    parameters: List[StepParameterTypeDef],  # (1)
    combination: NotRequired[str],
  1. See StepParameterTypeDef

SearchSortExpressionTypeDef#

# SearchSortExpressionTypeDef definition

class SearchSortExpressionTypeDef(TypedDict):
    userJobsFirst: NotRequired[UserJobsFirstTypeDef],  # (1)
    fieldSort: NotRequired[FieldSortExpressionTypeDef],  # (2)
    parameterSort: NotRequired[ParameterSortExpressionTypeDef],  # (3)
  1. See UserJobsFirstTypeDef
  2. See FieldSortExpressionTypeDef
  3. See ParameterSortExpressionTypeDef

SessionActionDefinitionSummaryTypeDef#

# SessionActionDefinitionSummaryTypeDef definition

class SessionActionDefinitionSummaryTypeDef(TypedDict):
    envEnter: NotRequired[EnvironmentEnterSessionActionDefinitionSummaryTypeDef],  # (1)
    envExit: NotRequired[EnvironmentExitSessionActionDefinitionSummaryTypeDef],  # (2)
    taskRun: NotRequired[TaskRunSessionActionDefinitionSummaryTypeDef],  # (3)
    syncInputJobAttachments: NotRequired[SyncInputJobAttachmentsSessionActionDefinitionSummaryTypeDef],  # (4)
  1. See EnvironmentEnterSessionActionDefinitionSummaryTypeDef
  2. See EnvironmentExitSessionActionDefinitionSummaryTypeDef
  3. See TaskRunSessionActionDefinitionSummaryTypeDef
  4. See SyncInputJobAttachmentsSessionActionDefinitionSummaryTypeDef

StartSessionsStatisticsAggregationRequestRequestTypeDef#

# StartSessionsStatisticsAggregationRequestRequestTypeDef definition

class StartSessionsStatisticsAggregationRequestRequestTypeDef(TypedDict):
    farmId: str,
    resourceIds: SessionsStatisticsResourcesTypeDef,  # (1)
    startTime: TimestampTypeDef,
    endTime: TimestampTypeDef,
    groupBy: Sequence[UsageGroupByFieldType],  # (2)
    statistics: Sequence[UsageStatisticType],  # (3)
    timezone: NotRequired[str],
    period: NotRequired[PeriodType],  # (4)
  1. See SessionsStatisticsResourcesTypeDef
  2. See UsageGroupByFieldType
  3. See UsageStatisticType
  4. See PeriodType

StatisticsTypeDef#

# StatisticsTypeDef definition

class StatisticsTypeDef(TypedDict):
    count: int,
    costInUsd: StatsTypeDef,  # (2)
    runtimeInSeconds: StatsTypeDef,  # (2)
    queueId: NotRequired[str],
    fleetId: NotRequired[str],
    jobId: NotRequired[str],
    jobName: NotRequired[str],
    userId: NotRequired[str],
    usageType: NotRequired[UsageTypeType],  # (1)
    licenseProduct: NotRequired[str],
    instanceType: NotRequired[str],
    aggregationStartTime: NotRequired[datetime],
    aggregationEndTime: NotRequired[datetime],
  1. See UsageTypeType
  2. See StatsTypeDef
  3. See StatsTypeDef

StepRequiredCapabilitiesTypeDef#

# StepRequiredCapabilitiesTypeDef definition

class StepRequiredCapabilitiesTypeDef(TypedDict):
    attributes: List[StepAttributeCapabilityTypeDef],  # (1)
    amounts: List[StepAmountCapabilityTypeDef],  # (2)
  1. See StepAttributeCapabilityTypeDef
  2. See StepAmountCapabilityTypeDef

WorkerCapabilitiesTypeDef#

# WorkerCapabilitiesTypeDef definition

class WorkerCapabilitiesTypeDef(TypedDict):
    amounts: Sequence[WorkerAmountCapabilityTypeDef],  # (1)
    attributes: Sequence[WorkerAttributeCapabilityTypeDef],  # (2)
  1. See WorkerAmountCapabilityTypeDef
  2. See WorkerAttributeCapabilityTypeDef

ServiceManagedEc2InstanceCapabilitiesOutputTypeDef#

# ServiceManagedEc2InstanceCapabilitiesOutputTypeDef definition

class ServiceManagedEc2InstanceCapabilitiesOutputTypeDef(TypedDict):
    vCpuCount: VCpuCountRangeTypeDef,  # (1)
    memoryMiB: MemoryMiBRangeTypeDef,  # (2)
    osFamily: ServiceManagedFleetOperatingSystemFamilyType,  # (3)
    cpuArchitectureType: CpuArchitectureTypeType,  # (4)
    rootEbsVolume: NotRequired[Ec2EbsVolumeTypeDef],  # (5)
    acceleratorCapabilities: NotRequired[AcceleratorCapabilitiesOutputTypeDef],  # (6)
    allowedInstanceTypes: NotRequired[List[str]],
    excludedInstanceTypes: NotRequired[List[str]],
    customAmounts: NotRequired[List[FleetAmountCapabilityTypeDef]],  # (7)
    customAttributes: NotRequired[List[FleetAttributeCapabilityOutputTypeDef]],  # (8)
  1. See VCpuCountRangeTypeDef
  2. See MemoryMiBRangeTypeDef
  3. See ServiceManagedFleetOperatingSystemFamilyType
  4. See CpuArchitectureTypeType
  5. See Ec2EbsVolumeTypeDef
  6. See AcceleratorCapabilitiesOutputTypeDef
  7. See FleetAmountCapabilityTypeDef
  8. See FleetAttributeCapabilityOutputTypeDef

AssignedSessionActionDefinitionTypeDef#

# AssignedSessionActionDefinitionTypeDef definition

class AssignedSessionActionDefinitionTypeDef(TypedDict):
    envEnter: NotRequired[AssignedEnvironmentEnterSessionActionDefinitionTypeDef],  # (1)
    envExit: NotRequired[AssignedEnvironmentExitSessionActionDefinitionTypeDef],  # (2)
    taskRun: NotRequired[AssignedTaskRunSessionActionDefinitionTypeDef],  # (3)
    syncInputJobAttachments: NotRequired[AssignedSyncInputJobAttachmentsSessionActionDefinitionTypeDef],  # (4)
  1. See AssignedEnvironmentEnterSessionActionDefinitionTypeDef
  2. See AssignedEnvironmentExitSessionActionDefinitionTypeDef
  3. See AssignedTaskRunSessionActionDefinitionTypeDef
  4. See AssignedSyncInputJobAttachmentsSessionActionDefinitionTypeDef

SessionActionDefinitionTypeDef#

# SessionActionDefinitionTypeDef definition

class SessionActionDefinitionTypeDef(TypedDict):
    envEnter: NotRequired[EnvironmentEnterSessionActionDefinitionTypeDef],  # (1)
    envExit: NotRequired[EnvironmentExitSessionActionDefinitionTypeDef],  # (2)
    taskRun: NotRequired[TaskRunSessionActionDefinitionTypeDef],  # (3)
    syncInputJobAttachments: NotRequired[SyncInputJobAttachmentsSessionActionDefinitionTypeDef],  # (4)
  1. See EnvironmentEnterSessionActionDefinitionTypeDef
  2. See EnvironmentExitSessionActionDefinitionTypeDef
  3. See TaskRunSessionActionDefinitionTypeDef
  4. See SyncInputJobAttachmentsSessionActionDefinitionTypeDef

SearchTasksResponseTypeDef#

# SearchTasksResponseTypeDef definition

class SearchTasksResponseTypeDef(TypedDict):
    tasks: List[TaskSearchSummaryTypeDef],  # (1)
    nextItemOffset: int,
    totalResults: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TaskSearchSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListTasksResponseTypeDef#

# ListTasksResponseTypeDef definition

class ListTasksResponseTypeDef(TypedDict):
    tasks: List[TaskSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See TaskSummaryTypeDef
  2. See ResponseMetadataTypeDef

GetJobResponseTypeDef#

# GetJobResponseTypeDef definition

class GetJobResponseTypeDef(TypedDict):
    jobId: str,
    name: str,
    lifecycleStatus: JobLifecycleStatusType,  # (1)
    lifecycleStatusMessage: str,
    priority: int,
    createdAt: datetime,
    createdBy: str,
    updatedAt: datetime,
    updatedBy: str,
    startedAt: datetime,
    endedAt: datetime,
    taskRunStatus: TaskRunStatusType,  # (2)
    targetTaskRunStatus: JobTargetTaskRunStatusType,  # (3)
    taskRunStatusCounts: Dict[TaskRunStatusType, int],  # (4)
    storageProfileId: str,
    maxFailedTasksCount: int,
    maxRetriesPerTask: int,
    parameters: Dict[str, JobParameterTypeDef],  # (5)
    attachments: AttachmentsOutputTypeDef,  # (6)
    description: str,
    sourceJobId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (7)
  1. See JobLifecycleStatusType
  2. See TaskRunStatusType
  3. See JobTargetTaskRunStatusType
  4. See TaskRunStatusType
  5. See JobParameterTypeDef
  6. See AttachmentsOutputTypeDef
  7. See ResponseMetadataTypeDef

JobAttachmentDetailsEntityTypeDef#

# JobAttachmentDetailsEntityTypeDef definition

class JobAttachmentDetailsEntityTypeDef(TypedDict):
    jobId: str,
    attachments: AttachmentsOutputTypeDef,  # (1)
  1. See AttachmentsOutputTypeDef

GetBudgetResponseTypeDef#

# GetBudgetResponseTypeDef definition

class GetBudgetResponseTypeDef(TypedDict):
    budgetId: str,
    usageTrackingResource: UsageTrackingResourceTypeDef,  # (1)
    status: BudgetStatusType,  # (2)
    displayName: str,
    description: str,
    approximateDollarLimit: float,
    usages: ConsumedUsagesTypeDef,  # (3)
    actions: List[ResponseBudgetActionTypeDef],  # (4)
    schedule: BudgetScheduleOutputTypeDef,  # (5)
    createdBy: str,
    createdAt: datetime,
    updatedBy: str,
    updatedAt: datetime,
    queueStoppedAt: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See UsageTrackingResourceTypeDef
  2. See BudgetStatusType
  3. See ConsumedUsagesTypeDef
  4. See ResponseBudgetActionTypeDef
  5. See BudgetScheduleOutputTypeDef
  6. See ResponseMetadataTypeDef

ListBudgetsResponseTypeDef#

# ListBudgetsResponseTypeDef definition

class ListBudgetsResponseTypeDef(TypedDict):
    budgets: List[BudgetSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See BudgetSummaryTypeDef
  2. See ResponseMetadataTypeDef

SearchJobsResponseTypeDef#

# SearchJobsResponseTypeDef definition

class SearchJobsResponseTypeDef(TypedDict):
    jobs: List[JobSearchSummaryTypeDef],  # (1)
    nextItemOffset: int,
    totalResults: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobSearchSummaryTypeDef
  2. See ResponseMetadataTypeDef

CustomerManagedFleetConfigurationOutputTypeDef#

# CustomerManagedFleetConfigurationOutputTypeDef definition

class CustomerManagedFleetConfigurationOutputTypeDef(TypedDict):
    mode: AutoScalingModeType,  # (1)
    workerCapabilities: CustomerManagedWorkerCapabilitiesOutputTypeDef,  # (2)
    storageProfileId: NotRequired[str],
  1. See AutoScalingModeType
  2. See CustomerManagedWorkerCapabilitiesOutputTypeDef

SearchFilterExpressionTypeDef#

# SearchFilterExpressionTypeDef definition

class SearchFilterExpressionTypeDef(TypedDict):
    dateTimeFilter: NotRequired[DateTimeFilterExpressionTypeDef],  # (1)
    parameterFilter: NotRequired[ParameterFilterExpressionTypeDef],  # (2)
    searchTermFilter: NotRequired[SearchTermFilterExpressionTypeDef],  # (3)
    stringFilter: NotRequired[StringFilterExpressionTypeDef],  # (4)
    groupFilter: NotRequired[Mapping[str, Any]],
  1. See DateTimeFilterExpressionTypeDef
  2. See ParameterFilterExpressionTypeDef
  3. See SearchTermFilterExpressionTypeDef
  4. See StringFilterExpressionTypeDef

UpdateWorkerScheduleRequestRequestTypeDef#

# UpdateWorkerScheduleRequestRequestTypeDef definition

class UpdateWorkerScheduleRequestRequestTypeDef(TypedDict):
    farmId: str,
    fleetId: str,
    workerId: str,
    updatedSessionActions: NotRequired[Mapping[str, UpdatedSessionActionInfoTypeDef]],  # (1)
  1. See UpdatedSessionActionInfoTypeDef

ListStepsResponseTypeDef#

# ListStepsResponseTypeDef definition

class ListStepsResponseTypeDef(TypedDict):
    steps: List[StepSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See StepSummaryTypeDef
  2. See ResponseMetadataTypeDef

CustomerManagedWorkerCapabilitiesTypeDef#

# CustomerManagedWorkerCapabilitiesTypeDef definition

class CustomerManagedWorkerCapabilitiesTypeDef(TypedDict):
    vCpuCount: VCpuCountRangeTypeDef,  # (1)
    memoryMiB: MemoryMiBRangeTypeDef,  # (2)
    osFamily: CustomerManagedFleetOperatingSystemFamilyType,  # (6)
    cpuArchitectureType: CpuArchitectureTypeType,  # (7)
    acceleratorTypes: NotRequired[Sequence[AcceleratorTypeType]],  # (3)
    acceleratorCount: NotRequired[AcceleratorCountRangeTypeDef],  # (4)
    acceleratorTotalMemoryMiB: NotRequired[AcceleratorTotalMemoryMiBRangeTypeDef],  # (5)
    customAmounts: NotRequired[Sequence[FleetAmountCapabilityTypeDef]],  # (8)
    customAttributes: NotRequired[Sequence[FleetAttributeCapabilityUnionTypeDef]],  # (9)
  1. See VCpuCountRangeTypeDef
  2. See MemoryMiBRangeTypeDef
  3. See AcceleratorTypeType
  4. See AcceleratorCountRangeTypeDef
  5. See AcceleratorTotalMemoryMiBRangeTypeDef
  6. See CustomerManagedFleetOperatingSystemFamilyType
  7. See CpuArchitectureTypeType
  8. See FleetAmountCapabilityTypeDef
  9. See FleetAttributeCapabilityTypeDef FleetAttributeCapabilityOutputTypeDef

GetSessionResponseTypeDef#

# GetSessionResponseTypeDef definition

class GetSessionResponseTypeDef(TypedDict):
    sessionId: str,
    fleetId: str,
    workerId: str,
    startedAt: datetime,
    log: LogConfigurationTypeDef,  # (1)
    lifecycleStatus: SessionLifecycleStatusType,  # (2)
    endedAt: datetime,
    updatedAt: datetime,
    updatedBy: str,
    targetLifecycleStatus: SessionLifecycleTargetStatusType,  # (3)
    hostProperties: HostPropertiesResponseTypeDef,  # (4)
    workerLog: LogConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See LogConfigurationTypeDef
  2. See SessionLifecycleStatusType
  3. See SessionLifecycleTargetStatusType
  4. See HostPropertiesResponseTypeDef
  5. See LogConfigurationTypeDef
  6. See ResponseMetadataTypeDef

GetWorkerResponseTypeDef#

# GetWorkerResponseTypeDef definition

class GetWorkerResponseTypeDef(TypedDict):
    workerId: str,
    farmId: str,
    fleetId: str,
    hostProperties: HostPropertiesResponseTypeDef,  # (1)
    status: WorkerStatusType,  # (2)
    log: LogConfigurationTypeDef,  # (3)
    createdAt: datetime,
    createdBy: str,
    updatedAt: datetime,
    updatedBy: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See HostPropertiesResponseTypeDef
  2. See WorkerStatusType
  3. See LogConfigurationTypeDef
  4. See ResponseMetadataTypeDef

WorkerSearchSummaryTypeDef#

# WorkerSearchSummaryTypeDef definition

class WorkerSearchSummaryTypeDef(TypedDict):
    fleetId: NotRequired[str],
    workerId: NotRequired[str],
    status: NotRequired[WorkerStatusType],  # (1)
    hostProperties: NotRequired[HostPropertiesResponseTypeDef],  # (2)
    createdBy: NotRequired[str],
    createdAt: NotRequired[datetime],
    updatedBy: NotRequired[str],
    updatedAt: NotRequired[datetime],
  1. See WorkerStatusType
  2. See HostPropertiesResponseTypeDef

WorkerSummaryTypeDef#

# WorkerSummaryTypeDef definition

class WorkerSummaryTypeDef(TypedDict):
    workerId: str,
    farmId: str,
    fleetId: str,
    status: WorkerStatusType,  # (1)
    createdAt: datetime,
    createdBy: str,
    hostProperties: NotRequired[HostPropertiesResponseTypeDef],  # (2)
    log: NotRequired[LogConfigurationTypeDef],  # (3)
    updatedAt: NotRequired[datetime],
    updatedBy: NotRequired[str],
  1. See WorkerStatusType
  2. See HostPropertiesResponseTypeDef
  3. See LogConfigurationTypeDef

HostPropertiesRequestTypeDef#

# HostPropertiesRequestTypeDef definition

class HostPropertiesRequestTypeDef(TypedDict):
    ipAddresses: NotRequired[IpAddressesUnionTypeDef],  # (1)
    hostName: NotRequired[str],
  1. See IpAddressesTypeDef IpAddressesOutputTypeDef

BatchGetJobEntityRequestRequestTypeDef#

# BatchGetJobEntityRequestRequestTypeDef definition

class BatchGetJobEntityRequestRequestTypeDef(TypedDict):
    farmId: str,
    fleetId: str,
    workerId: str,
    identifiers: Sequence[JobEntityIdentifiersUnionTypeDef],  # (1)
  1. See JobEntityIdentifiersUnionTypeDef

CreateQueueRequestRequestTypeDef#

# CreateQueueRequestRequestTypeDef definition

class CreateQueueRequestRequestTypeDef(TypedDict):
    farmId: str,
    displayName: str,
    clientToken: NotRequired[str],
    description: NotRequired[str],
    defaultBudgetAction: NotRequired[DefaultQueueBudgetActionType],  # (1)
    jobAttachmentSettings: NotRequired[JobAttachmentSettingsTypeDef],  # (2)
    roleArn: NotRequired[str],
    jobRunAsUser: NotRequired[JobRunAsUserTypeDef],  # (3)
    requiredFileSystemLocationNames: NotRequired[Sequence[str]],
    allowedStorageProfileIds: NotRequired[Sequence[str]],
    tags: NotRequired[Mapping[str, str]],
  1. See DefaultQueueBudgetActionType
  2. See JobAttachmentSettingsTypeDef
  3. See JobRunAsUserTypeDef

GetQueueResponseTypeDef#

# GetQueueResponseTypeDef definition

class GetQueueResponseTypeDef(TypedDict):
    queueId: str,
    displayName: str,
    description: str,
    farmId: str,
    status: QueueStatusType,  # (1)
    defaultBudgetAction: DefaultQueueBudgetActionType,  # (2)
    blockedReason: QueueBlockedReasonType,  # (3)
    jobAttachmentSettings: JobAttachmentSettingsTypeDef,  # (4)
    roleArn: str,
    requiredFileSystemLocationNames: List[str],
    allowedStorageProfileIds: List[str],
    jobRunAsUser: JobRunAsUserTypeDef,  # (5)
    createdAt: datetime,
    createdBy: str,
    updatedAt: datetime,
    updatedBy: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See QueueStatusType
  2. See DefaultQueueBudgetActionType
  3. See QueueBlockedReasonType
  4. See JobAttachmentSettingsTypeDef
  5. See JobRunAsUserTypeDef
  6. See ResponseMetadataTypeDef

JobDetailsEntityTypeDef#

# JobDetailsEntityTypeDef definition

class JobDetailsEntityTypeDef(TypedDict):
    jobId: str,
    logGroupName: str,
    schemaVersion: str,
    jobAttachmentSettings: NotRequired[JobAttachmentSettingsTypeDef],  # (1)
    jobRunAsUser: NotRequired[JobRunAsUserTypeDef],  # (2)
    queueRoleArn: NotRequired[str],
    parameters: NotRequired[Dict[str, JobParameterTypeDef]],  # (3)
    pathMappingRules: NotRequired[List[PathMappingRuleTypeDef]],  # (4)
  1. See JobAttachmentSettingsTypeDef
  2. See JobRunAsUserTypeDef
  3. See JobParameterTypeDef
  4. See PathMappingRuleTypeDef

UpdateQueueRequestRequestTypeDef#

# UpdateQueueRequestRequestTypeDef definition

class UpdateQueueRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    clientToken: NotRequired[str],
    displayName: NotRequired[str],
    description: NotRequired[str],
    defaultBudgetAction: NotRequired[DefaultQueueBudgetActionType],  # (1)
    jobAttachmentSettings: NotRequired[JobAttachmentSettingsTypeDef],  # (2)
    roleArn: NotRequired[str],
    jobRunAsUser: NotRequired[JobRunAsUserTypeDef],  # (3)
    requiredFileSystemLocationNamesToAdd: NotRequired[Sequence[str]],
    requiredFileSystemLocationNamesToRemove: NotRequired[Sequence[str]],
    allowedStorageProfileIdsToAdd: NotRequired[Sequence[str]],
    allowedStorageProfileIdsToRemove: NotRequired[Sequence[str]],
  1. See DefaultQueueBudgetActionType
  2. See JobAttachmentSettingsTypeDef
  3. See JobRunAsUserTypeDef

AttachmentsTypeDef#

# AttachmentsTypeDef definition

class AttachmentsTypeDef(TypedDict):
    manifests: Sequence[ManifestPropertiesUnionTypeDef],  # (1)
    fileSystem: NotRequired[JobAttachmentsFileSystemType],  # (2)
  1. See ManifestPropertiesTypeDef ManifestPropertiesOutputTypeDef
  2. See JobAttachmentsFileSystemType

StepSearchSummaryTypeDef#

# StepSearchSummaryTypeDef definition

class StepSearchSummaryTypeDef(TypedDict):
    stepId: NotRequired[str],
    jobId: NotRequired[str],
    queueId: NotRequired[str],
    name: NotRequired[str],
    lifecycleStatus: NotRequired[StepLifecycleStatusType],  # (1)
    lifecycleStatusMessage: NotRequired[str],
    taskRunStatus: NotRequired[TaskRunStatusType],  # (2)
    targetTaskRunStatus: NotRequired[StepTargetTaskRunStatusType],  # (3)
    taskRunStatusCounts: NotRequired[Dict[TaskRunStatusType, int]],  # (4)
    createdAt: NotRequired[datetime],
    startedAt: NotRequired[datetime],
    endedAt: NotRequired[datetime],
    parameterSpace: NotRequired[ParameterSpaceTypeDef],  # (5)
  1. See StepLifecycleStatusType
  2. See TaskRunStatusType
  3. See StepTargetTaskRunStatusType
  4. See TaskRunStatusType
  5. See ParameterSpaceTypeDef

SessionActionSummaryTypeDef#

# SessionActionSummaryTypeDef definition

class SessionActionSummaryTypeDef(TypedDict):
    sessionActionId: str,
    status: SessionActionStatusType,  # (1)
    definition: SessionActionDefinitionSummaryTypeDef,  # (2)
    startedAt: NotRequired[datetime],
    endedAt: NotRequired[datetime],
    workerUpdatedAt: NotRequired[datetime],
    progressPercent: NotRequired[float],
  1. See SessionActionStatusType
  2. See SessionActionDefinitionSummaryTypeDef

GetSessionsStatisticsAggregationResponseTypeDef#

# GetSessionsStatisticsAggregationResponseTypeDef definition

class GetSessionsStatisticsAggregationResponseTypeDef(TypedDict):
    statistics: List[StatisticsTypeDef],  # (1)
    status: SessionsStatisticsAggregationStatusType,  # (2)
    statusMessage: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
    nextToken: NotRequired[str],
  1. See StatisticsTypeDef
  2. See SessionsStatisticsAggregationStatusType
  3. See ResponseMetadataTypeDef

GetStepResponseTypeDef#

# GetStepResponseTypeDef definition

class GetStepResponseTypeDef(TypedDict):
    stepId: str,
    name: str,
    lifecycleStatus: StepLifecycleStatusType,  # (1)
    lifecycleStatusMessage: str,
    taskRunStatus: TaskRunStatusType,  # (2)
    taskRunStatusCounts: Dict[TaskRunStatusType, int],  # (3)
    targetTaskRunStatus: StepTargetTaskRunStatusType,  # (4)
    createdAt: datetime,
    createdBy: str,
    updatedAt: datetime,
    updatedBy: str,
    startedAt: datetime,
    endedAt: datetime,
    dependencyCounts: DependencyCountsTypeDef,  # (5)
    requiredCapabilities: StepRequiredCapabilitiesTypeDef,  # (6)
    parameterSpace: ParameterSpaceTypeDef,  # (7)
    description: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (8)
  1. See StepLifecycleStatusType
  2. See TaskRunStatusType
  3. See TaskRunStatusType
  4. See StepTargetTaskRunStatusType
  5. See DependencyCountsTypeDef
  6. See StepRequiredCapabilitiesTypeDef
  7. See ParameterSpaceTypeDef
  8. See ResponseMetadataTypeDef

ServiceManagedEc2FleetConfigurationOutputTypeDef#

# ServiceManagedEc2FleetConfigurationOutputTypeDef definition

class ServiceManagedEc2FleetConfigurationOutputTypeDef(TypedDict):
    instanceCapabilities: ServiceManagedEc2InstanceCapabilitiesOutputTypeDef,  # (1)
    instanceMarketOptions: ServiceManagedEc2InstanceMarketOptionsTypeDef,  # (2)
  1. See ServiceManagedEc2InstanceCapabilitiesOutputTypeDef
  2. See ServiceManagedEc2InstanceMarketOptionsTypeDef

ServiceManagedEc2InstanceCapabilitiesTypeDef#

# ServiceManagedEc2InstanceCapabilitiesTypeDef definition

class ServiceManagedEc2InstanceCapabilitiesTypeDef(TypedDict):
    vCpuCount: VCpuCountRangeTypeDef,  # (1)
    memoryMiB: MemoryMiBRangeTypeDef,  # (2)
    osFamily: ServiceManagedFleetOperatingSystemFamilyType,  # (3)
    cpuArchitectureType: CpuArchitectureTypeType,  # (4)
    rootEbsVolume: NotRequired[Ec2EbsVolumeTypeDef],  # (5)
    acceleratorCapabilities: NotRequired[AcceleratorCapabilitiesUnionTypeDef],  # (6)
    allowedInstanceTypes: NotRequired[Sequence[str]],
    excludedInstanceTypes: NotRequired[Sequence[str]],
    customAmounts: NotRequired[Sequence[FleetAmountCapabilityTypeDef]],  # (7)
    customAttributes: NotRequired[Sequence[FleetAttributeCapabilityTypeDef]],  # (8)
  1. See VCpuCountRangeTypeDef
  2. See MemoryMiBRangeTypeDef
  3. See ServiceManagedFleetOperatingSystemFamilyType
  4. See CpuArchitectureTypeType
  5. See Ec2EbsVolumeTypeDef
  6. See AcceleratorCapabilitiesTypeDef AcceleratorCapabilitiesOutputTypeDef
  7. See FleetAmountCapabilityTypeDef
  8. See FleetAttributeCapabilityTypeDef

AssignedSessionActionTypeDef#

# AssignedSessionActionTypeDef definition

class AssignedSessionActionTypeDef(TypedDict):
    sessionActionId: str,
    definition: AssignedSessionActionDefinitionTypeDef,  # (1)
  1. See AssignedSessionActionDefinitionTypeDef

GetSessionActionResponseTypeDef#

# GetSessionActionResponseTypeDef definition

class GetSessionActionResponseTypeDef(TypedDict):
    sessionActionId: str,
    status: SessionActionStatusType,  # (1)
    startedAt: datetime,
    endedAt: datetime,
    workerUpdatedAt: datetime,
    progressPercent: float,
    sessionId: str,
    processExitCode: int,
    progressMessage: str,
    definition: SessionActionDefinitionTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See SessionActionStatusType
  2. See SessionActionDefinitionTypeDef
  3. See ResponseMetadataTypeDef

SearchGroupedFilterExpressionsTypeDef#

# SearchGroupedFilterExpressionsTypeDef definition

class SearchGroupedFilterExpressionsTypeDef(TypedDict):
    filters: Sequence[SearchFilterExpressionTypeDef],  # (1)
    operator: LogicalOperatorType,  # (2)
  1. See SearchFilterExpressionTypeDef
  2. See LogicalOperatorType

BudgetScheduleTypeDef#

# BudgetScheduleTypeDef definition

class BudgetScheduleTypeDef(TypedDict):
    fixed: NotRequired[FixedBudgetScheduleUnionTypeDef],  # (1)
  1. See FixedBudgetScheduleTypeDef FixedBudgetScheduleOutputTypeDef

SearchWorkersResponseTypeDef#

# SearchWorkersResponseTypeDef definition

class SearchWorkersResponseTypeDef(TypedDict):
    workers: List[WorkerSearchSummaryTypeDef],  # (1)
    nextItemOffset: int,
    totalResults: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WorkerSearchSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListWorkersResponseTypeDef#

# ListWorkersResponseTypeDef definition

class ListWorkersResponseTypeDef(TypedDict):
    workers: List[WorkerSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See WorkerSummaryTypeDef
  2. See ResponseMetadataTypeDef

CreateWorkerRequestRequestTypeDef#

# CreateWorkerRequestRequestTypeDef definition

class CreateWorkerRequestRequestTypeDef(TypedDict):
    farmId: str,
    fleetId: str,
    hostProperties: NotRequired[HostPropertiesRequestTypeDef],  # (1)
    clientToken: NotRequired[str],
  1. See HostPropertiesRequestTypeDef

UpdateWorkerRequestRequestTypeDef#

# UpdateWorkerRequestRequestTypeDef definition

class UpdateWorkerRequestRequestTypeDef(TypedDict):
    farmId: str,
    fleetId: str,
    workerId: str,
    status: NotRequired[UpdatedWorkerStatusType],  # (1)
    capabilities: NotRequired[WorkerCapabilitiesTypeDef],  # (2)
    hostProperties: NotRequired[HostPropertiesRequestTypeDef],  # (3)
  1. See UpdatedWorkerStatusType
  2. See WorkerCapabilitiesTypeDef
  3. See HostPropertiesRequestTypeDef

JobEntityTypeDef#

# JobEntityTypeDef definition

class JobEntityTypeDef(TypedDict):
    jobDetails: NotRequired[JobDetailsEntityTypeDef],  # (1)
    jobAttachmentDetails: NotRequired[JobAttachmentDetailsEntityTypeDef],  # (2)
    stepDetails: NotRequired[StepDetailsEntityTypeDef],  # (3)
    environmentDetails: NotRequired[EnvironmentDetailsEntityTypeDef],  # (4)
  1. See JobDetailsEntityTypeDef
  2. See JobAttachmentDetailsEntityTypeDef
  3. See StepDetailsEntityTypeDef
  4. See EnvironmentDetailsEntityTypeDef

CreateJobRequestRequestTypeDef#

# CreateJobRequestRequestTypeDef definition

class CreateJobRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueId: str,
    priority: int,
    clientToken: NotRequired[str],
    template: NotRequired[str],
    templateType: NotRequired[JobTemplateTypeType],  # (1)
    parameters: NotRequired[Mapping[str, JobParameterTypeDef]],  # (2)
    attachments: NotRequired[AttachmentsTypeDef],  # (3)
    storageProfileId: NotRequired[str],
    targetTaskRunStatus: NotRequired[CreateJobTargetTaskRunStatusType],  # (4)
    maxFailedTasksCount: NotRequired[int],
    maxRetriesPerTask: NotRequired[int],
    sourceJobId: NotRequired[str],
  1. See JobTemplateTypeType
  2. See JobParameterTypeDef
  3. See AttachmentsTypeDef
  4. See CreateJobTargetTaskRunStatusType

SearchStepsResponseTypeDef#

# SearchStepsResponseTypeDef definition

class SearchStepsResponseTypeDef(TypedDict):
    steps: List[StepSearchSummaryTypeDef],  # (1)
    nextItemOffset: int,
    totalResults: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StepSearchSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListSessionActionsResponseTypeDef#

# ListSessionActionsResponseTypeDef definition

class ListSessionActionsResponseTypeDef(TypedDict):
    sessionActions: List[SessionActionSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See SessionActionSummaryTypeDef
  2. See ResponseMetadataTypeDef

FleetConfigurationOutputTypeDef#

# FleetConfigurationOutputTypeDef definition

class FleetConfigurationOutputTypeDef(TypedDict):
    customerManaged: NotRequired[CustomerManagedFleetConfigurationOutputTypeDef],  # (1)
    serviceManagedEc2: NotRequired[ServiceManagedEc2FleetConfigurationOutputTypeDef],  # (2)
  1. See CustomerManagedFleetConfigurationOutputTypeDef
  2. See ServiceManagedEc2FleetConfigurationOutputTypeDef

AssignedSessionTypeDef#

# AssignedSessionTypeDef definition

class AssignedSessionTypeDef(TypedDict):
    queueId: str,
    jobId: str,
    sessionActions: List[AssignedSessionActionTypeDef],  # (1)
    logConfiguration: LogConfigurationTypeDef,  # (2)
  1. See AssignedSessionActionTypeDef
  2. See LogConfigurationTypeDef

SearchJobsRequestRequestTypeDef#

# SearchJobsRequestRequestTypeDef definition

class SearchJobsRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueIds: Sequence[str],
    itemOffset: int,
    filterExpressions: NotRequired[SearchGroupedFilterExpressionsTypeDef],  # (1)
    sortExpressions: NotRequired[Sequence[SearchSortExpressionTypeDef]],  # (2)
    pageSize: NotRequired[int],
  1. See SearchGroupedFilterExpressionsTypeDef
  2. See SearchSortExpressionTypeDef

SearchStepsRequestRequestTypeDef#

# SearchStepsRequestRequestTypeDef definition

class SearchStepsRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueIds: Sequence[str],
    itemOffset: int,
    jobId: NotRequired[str],
    filterExpressions: NotRequired[SearchGroupedFilterExpressionsTypeDef],  # (1)
    sortExpressions: NotRequired[Sequence[SearchSortExpressionTypeDef]],  # (2)
    pageSize: NotRequired[int],
  1. See SearchGroupedFilterExpressionsTypeDef
  2. See SearchSortExpressionTypeDef

SearchTasksRequestRequestTypeDef#

# SearchTasksRequestRequestTypeDef definition

class SearchTasksRequestRequestTypeDef(TypedDict):
    farmId: str,
    queueIds: Sequence[str],
    itemOffset: int,
    jobId: NotRequired[str],
    filterExpressions: NotRequired[SearchGroupedFilterExpressionsTypeDef],  # (1)
    sortExpressions: NotRequired[Sequence[SearchSortExpressionTypeDef]],  # (2)
    pageSize: NotRequired[int],
  1. See SearchGroupedFilterExpressionsTypeDef
  2. See SearchSortExpressionTypeDef

SearchWorkersRequestRequestTypeDef#

# SearchWorkersRequestRequestTypeDef definition

class SearchWorkersRequestRequestTypeDef(TypedDict):
    farmId: str,
    fleetIds: Sequence[str],
    itemOffset: int,
    filterExpressions: NotRequired[SearchGroupedFilterExpressionsTypeDef],  # (1)
    sortExpressions: NotRequired[Sequence[SearchSortExpressionTypeDef]],  # (2)
    pageSize: NotRequired[int],
  1. See SearchGroupedFilterExpressionsTypeDef
  2. See SearchSortExpressionTypeDef

CreateBudgetRequestRequestTypeDef#

# CreateBudgetRequestRequestTypeDef definition

class CreateBudgetRequestRequestTypeDef(TypedDict):
    farmId: str,
    usageTrackingResource: UsageTrackingResourceTypeDef,  # (1)
    displayName: str,
    approximateDollarLimit: float,
    actions: Sequence[BudgetActionToAddTypeDef],  # (2)
    schedule: BudgetScheduleTypeDef,  # (3)
    clientToken: NotRequired[str],
    description: NotRequired[str],
  1. See UsageTrackingResourceTypeDef
  2. See BudgetActionToAddTypeDef
  3. See BudgetScheduleTypeDef

UpdateBudgetRequestRequestTypeDef#

# UpdateBudgetRequestRequestTypeDef definition

class UpdateBudgetRequestRequestTypeDef(TypedDict):
    farmId: str,
    budgetId: str,
    clientToken: NotRequired[str],
    displayName: NotRequired[str],
    description: NotRequired[str],
    status: NotRequired[BudgetStatusType],  # (1)
    approximateDollarLimit: NotRequired[float],
    actionsToAdd: NotRequired[Sequence[BudgetActionToAddTypeDef]],  # (2)
    actionsToRemove: NotRequired[Sequence[BudgetActionToRemoveTypeDef]],  # (3)
    schedule: NotRequired[BudgetScheduleTypeDef],  # (4)
  1. See BudgetStatusType
  2. See BudgetActionToAddTypeDef
  3. See BudgetActionToRemoveTypeDef
  4. See BudgetScheduleTypeDef

CustomerManagedFleetConfigurationTypeDef#

# CustomerManagedFleetConfigurationTypeDef definition

class CustomerManagedFleetConfigurationTypeDef(TypedDict):
    mode: AutoScalingModeType,  # (1)
    workerCapabilities: CustomerManagedWorkerCapabilitiesUnionTypeDef,  # (2)
    storageProfileId: NotRequired[str],
  1. See AutoScalingModeType
  2. See CustomerManagedWorkerCapabilitiesTypeDef CustomerManagedWorkerCapabilitiesOutputTypeDef

BatchGetJobEntityResponseTypeDef#

# BatchGetJobEntityResponseTypeDef definition

class BatchGetJobEntityResponseTypeDef(TypedDict):
    entities: List[JobEntityTypeDef],  # (1)
    errors: List[GetJobEntityErrorTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See JobEntityTypeDef
  2. See GetJobEntityErrorTypeDef
  3. See ResponseMetadataTypeDef

FleetSummaryTypeDef#

# FleetSummaryTypeDef definition

class FleetSummaryTypeDef(TypedDict):
    fleetId: str,
    farmId: str,
    displayName: str,
    status: FleetStatusType,  # (1)
    workerCount: int,
    minWorkerCount: int,
    maxWorkerCount: int,
    configuration: FleetConfigurationOutputTypeDef,  # (3)
    createdAt: datetime,
    createdBy: str,
    autoScalingStatus: NotRequired[AutoScalingStatusType],  # (2)
    targetWorkerCount: NotRequired[int],
    updatedAt: NotRequired[datetime],
    updatedBy: NotRequired[str],
  1. See FleetStatusType
  2. See AutoScalingStatusType
  3. See FleetConfigurationOutputTypeDef

GetFleetResponseTypeDef#

# GetFleetResponseTypeDef definition

class GetFleetResponseTypeDef(TypedDict):
    fleetId: str,
    farmId: str,
    displayName: str,
    description: str,
    status: FleetStatusType,  # (1)
    autoScalingStatus: AutoScalingStatusType,  # (2)
    targetWorkerCount: int,
    workerCount: int,
    minWorkerCount: int,
    maxWorkerCount: int,
    configuration: FleetConfigurationOutputTypeDef,  # (3)
    capabilities: FleetCapabilitiesTypeDef,  # (4)
    roleArn: str,
    createdAt: datetime,
    createdBy: str,
    updatedAt: datetime,
    updatedBy: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See FleetStatusType
  2. See AutoScalingStatusType
  3. See FleetConfigurationOutputTypeDef
  4. See FleetCapabilitiesTypeDef
  5. See ResponseMetadataTypeDef

ServiceManagedEc2FleetConfigurationTypeDef#

# ServiceManagedEc2FleetConfigurationTypeDef definition

class ServiceManagedEc2FleetConfigurationTypeDef(TypedDict):
    instanceCapabilities: ServiceManagedEc2InstanceCapabilitiesUnionTypeDef,  # (1)
    instanceMarketOptions: ServiceManagedEc2InstanceMarketOptionsTypeDef,  # (2)
  1. See ServiceManagedEc2InstanceCapabilitiesTypeDef ServiceManagedEc2InstanceCapabilitiesOutputTypeDef
  2. See ServiceManagedEc2InstanceMarketOptionsTypeDef

UpdateWorkerScheduleResponseTypeDef#

# UpdateWorkerScheduleResponseTypeDef definition

class UpdateWorkerScheduleResponseTypeDef(TypedDict):
    assignedSessions: Dict[str, AssignedSessionTypeDef],  # (1)
    cancelSessionActions: Dict[str, List[str]],
    desiredWorkerStatus: DesiredWorkerStatusType,  # (2)
    updateIntervalSeconds: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See AssignedSessionTypeDef
  2. See DesiredWorkerStatusType
  3. See ResponseMetadataTypeDef

ListFleetsResponseTypeDef#

# ListFleetsResponseTypeDef definition

class ListFleetsResponseTypeDef(TypedDict):
    fleets: List[FleetSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See FleetSummaryTypeDef
  2. See ResponseMetadataTypeDef

FleetConfigurationTypeDef#

# FleetConfigurationTypeDef definition

class FleetConfigurationTypeDef(TypedDict):
    customerManaged: NotRequired[CustomerManagedFleetConfigurationUnionTypeDef],  # (1)
    serviceManagedEc2: NotRequired[ServiceManagedEc2FleetConfigurationUnionTypeDef],  # (2)
  1. See CustomerManagedFleetConfigurationTypeDef CustomerManagedFleetConfigurationOutputTypeDef
  2. See ServiceManagedEc2FleetConfigurationTypeDef ServiceManagedEc2FleetConfigurationOutputTypeDef

CreateFleetRequestRequestTypeDef#

# CreateFleetRequestRequestTypeDef definition

class CreateFleetRequestRequestTypeDef(TypedDict):
    farmId: str,
    displayName: str,
    roleArn: str,
    maxWorkerCount: int,
    configuration: FleetConfigurationTypeDef,  # (1)
    clientToken: NotRequired[str],
    description: NotRequired[str],
    minWorkerCount: NotRequired[int],
    tags: NotRequired[Mapping[str, str]],
  1. See FleetConfigurationTypeDef

UpdateFleetRequestRequestTypeDef#

# UpdateFleetRequestRequestTypeDef definition

class UpdateFleetRequestRequestTypeDef(TypedDict):
    farmId: str,
    fleetId: str,
    clientToken: NotRequired[str],
    displayName: NotRequired[str],
    description: NotRequired[str],
    roleArn: NotRequired[str],
    minWorkerCount: NotRequired[int],
    maxWorkerCount: NotRequired[int],
    configuration: NotRequired[FleetConfigurationTypeDef],  # (1)
  1. See FleetConfigurationTypeDef