DeadlineCloud module#
Index > DeadlineCloud
Auto-generated documentation for DeadlineCloud type annotations stubs module types-boto3-deadline.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy_boto3_builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.35.86' mypy_boto3_builder
- Select
boto3
AWS SDK. - Add
DeadlineCloud
service. - Use provided commands to install generated packages.
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and DeadlineCloud
.
From PyPI with pip#
Install types-boto3
for DeadlineCloud
service.
# install with boto3 type annotations
python -m pip install 'types-boto3[deadline]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[deadline]'
# standalone installation
python -m pip install types-boto3-deadline
How to uninstall#
python -m pip uninstall -y types-boto3-deadline
Usage#
Code samples can be found in Examples.
DeadlineCloudClient#
Type annotations and code completion for boto3.client("deadline")
as DeadlineCloudClient
boto3 documentation
# DeadlineCloudClient usage example
from boto3.session import Session
from types_boto3_deadline.client import DeadlineCloudClient
def get_client() -> DeadlineCloudClient:
return Session().client("deadline")
Paginators#
Type annotations and code completion for paginators
from boto3.client("deadline").get_paginator("...")
.
# GetSessionsStatisticsAggregationPaginator usage example
from boto3.session import Session
from types_boto3_deadline.paginator import GetSessionsStatisticsAggregationPaginator
def get_get_sessions_statistics_aggregation_paginator() -> GetSessionsStatisticsAggregationPaginator:
return Session().client("deadline").get_paginator("get_sessions_statistics_aggregation"))
- GetSessionsStatisticsAggregationPaginator
- ListAvailableMeteredProductsPaginator
- ListBudgetsPaginator
- ListFarmMembersPaginator
- ListFarmsPaginator
- ListFleetMembersPaginator
- ListFleetsPaginator
- ListJobMembersPaginator
- ListJobParameterDefinitionsPaginator
- ListJobsPaginator
- ListLicenseEndpointsPaginator
- ListMeteredProductsPaginator
- ListMonitorsPaginator
- ListQueueEnvironmentsPaginator
- ListQueueFleetAssociationsPaginator
- ListQueueMembersPaginator
- ListQueuesPaginator
- ListSessionActionsPaginator
- ListSessionsForWorkerPaginator
- ListSessionsPaginator
- ListStepConsumersPaginator
- ListStepDependenciesPaginator
- ListStepsPaginator
- ListStorageProfilesForQueuePaginator
- ListStorageProfilesPaginator
- ListTasksPaginator
- ListWorkersPaginator
Waiters#
Type annotations and code completion for waiters
from boto3.client("deadline").get_waiter("...")
.
# FleetActiveWaiter usage example
from boto3.session import Session
from types_boto3_deadline.waiter import FleetActiveWaiter
def get_fleet_active_waiter() -> FleetActiveWaiter:
return Session().client("deadline").get_waiter("fleet_active")
- FleetActiveWaiter
- JobCreateCompleteWaiter
- LicenseEndpointDeletedWaiter
- LicenseEndpointValidWaiter
- QueueFleetAssociationStoppedWaiter
- QueueSchedulingBlockedWaiter
- QueueSchedulingWaiter
Literals#
Type annotations for literals used in methods and schema.
# AcceleratorNameType usage example
from types_boto3_deadline.literals import AcceleratorNameType
def get_value() -> AcceleratorNameType:
return "a10g"
- AcceleratorNameType
- AcceleratorTypeType
- AutoScalingModeType
- AutoScalingStatusType
- BudgetActionTypeType
- BudgetStatusType
- ComparisonOperatorType
- CompletedStatusType
- CpuArchitectureTypeType
- CreateJobTargetTaskRunStatusType
- CustomerManagedFleetOperatingSystemFamilyType
- DefaultQueueBudgetActionType
- DependencyConsumerResolutionStatusType
- DesiredWorkerStatusType
- Ec2MarketTypeType
- EnvironmentTemplateTypeType
- FileSystemLocationTypeType
- FleetActiveWaiterName
- FleetStatusType
- GetSessionsStatisticsAggregationPaginatorName
- JobAttachmentsFileSystemType
- JobCreateCompleteWaiterName
- JobEntityErrorCodeType
- JobLifecycleStatusType
- JobTargetTaskRunStatusType
- JobTemplateTypeType
- LicenseEndpointDeletedWaiterName
- LicenseEndpointStatusType
- LicenseEndpointValidWaiterName
- ListAvailableMeteredProductsPaginatorName
- ListBudgetsPaginatorName
- ListFarmMembersPaginatorName
- ListFarmsPaginatorName
- ListFleetMembersPaginatorName
- ListFleetsPaginatorName
- ListJobMembersPaginatorName
- ListJobParameterDefinitionsPaginatorName
- ListJobsPaginatorName
- ListLicenseEndpointsPaginatorName
- ListMeteredProductsPaginatorName
- ListMonitorsPaginatorName
- ListQueueEnvironmentsPaginatorName
- ListQueueFleetAssociationsPaginatorName
- ListQueueMembersPaginatorName
- ListQueuesPaginatorName
- ListSessionActionsPaginatorName
- ListSessionsForWorkerPaginatorName
- ListSessionsPaginatorName
- ListStepConsumersPaginatorName
- ListStepDependenciesPaginatorName
- ListStepsPaginatorName
- ListStorageProfilesForQueuePaginatorName
- ListStorageProfilesPaginatorName
- ListTasksPaginatorName
- ListWorkersPaginatorName
- LogicalOperatorType
- MembershipLevelType
- PathFormatType
- PeriodType
- PrincipalTypeType
- QueueBlockedReasonType
- QueueFleetAssociationStatusType
- QueueFleetAssociationStoppedWaiterName
- QueueSchedulingBlockedWaiterName
- QueueSchedulingWaiterName
- QueueStatusType
- RunAsType
- ServiceManagedFleetOperatingSystemFamilyType
- SessionActionStatusType
- SessionLifecycleStatusType
- SessionLifecycleTargetStatusType
- SessionsStatisticsAggregationStatusType
- SortOrderType
- StepLifecycleStatusType
- StepParameterTypeType
- StepTargetTaskRunStatusType
- StorageProfileOperatingSystemFamilyType
- TaskRunStatusType
- TaskTargetRunStatusType
- UpdateJobLifecycleStatusType
- UpdateQueueFleetAssociationStatusType
- UpdatedWorkerStatusType
- UsageGroupByFieldType
- UsageStatisticType
- UsageTypeType
- WorkerStatusType
- DeadlineCloudServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- WaiterName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AcceleratorCountRangeTypeDef
- AcceleratorSelectionTypeDef
- AcceleratorTotalMemoryMiBRangeTypeDef
- AssignedEnvironmentEnterSessionActionDefinitionTypeDef
- AssignedEnvironmentExitSessionActionDefinitionTypeDef
- AssignedSyncInputJobAttachmentsSessionActionDefinitionTypeDef
- LogConfigurationTypeDef
- TaskParameterValueTypeDef
- AssociateMemberToFarmRequestRequestTypeDef
- AssociateMemberToFleetRequestRequestTypeDef
- AssociateMemberToJobRequestRequestTypeDef
- AssociateMemberToQueueRequestRequestTypeDef
- AssumeFleetRoleForReadRequestRequestTypeDef
- AwsCredentialsTypeDef
- ResponseMetadataTypeDef
- AssumeFleetRoleForWorkerRequestRequestTypeDef
- AssumeQueueRoleForReadRequestRequestTypeDef
- AssumeQueueRoleForUserRequestRequestTypeDef
- AssumeQueueRoleForWorkerRequestRequestTypeDef
- ManifestPropertiesOutputTypeDef
- BudgetActionToAddTypeDef
- BudgetActionToRemoveTypeDef
- FixedBudgetScheduleOutputTypeDef
- ConsumedUsagesTypeDef
- UsageTrackingResourceTypeDef
- S3LocationTypeDef
- CreateFarmRequestRequestTypeDef
- JobParameterTypeDef
- CreateLicenseEndpointRequestRequestTypeDef
- CreateMonitorRequestRequestTypeDef
- CreateQueueEnvironmentRequestRequestTypeDef
- CreateQueueFleetAssociationRequestRequestTypeDef
- JobAttachmentSettingsTypeDef
- FileSystemLocationTypeDef
- FleetAmountCapabilityTypeDef
- FleetAttributeCapabilityOutputTypeDef
- MemoryMiBRangeTypeDef
- VCpuCountRangeTypeDef
- FleetAttributeCapabilityTypeDef
- TimestampTypeDef
- DeleteBudgetRequestRequestTypeDef
- DeleteFarmRequestRequestTypeDef
- DeleteFleetRequestRequestTypeDef
- DeleteLicenseEndpointRequestRequestTypeDef
- DeleteMeteredProductRequestRequestTypeDef
- DeleteMonitorRequestRequestTypeDef
- DeleteQueueEnvironmentRequestRequestTypeDef
- DeleteQueueFleetAssociationRequestRequestTypeDef
- DeleteQueueRequestRequestTypeDef
- DeleteStorageProfileRequestRequestTypeDef
- DeleteWorkerRequestRequestTypeDef
- DependencyCountsTypeDef
- DisassociateMemberFromFarmRequestRequestTypeDef
- DisassociateMemberFromFleetRequestRequestTypeDef
- DisassociateMemberFromJobRequestRequestTypeDef
- DisassociateMemberFromQueueRequestRequestTypeDef
- Ec2EbsVolumeTypeDef
- EnvironmentDetailsEntityTypeDef
- EnvironmentDetailsErrorTypeDef
- EnvironmentDetailsIdentifiersTypeDef
- EnvironmentEnterSessionActionDefinitionSummaryTypeDef
- EnvironmentEnterSessionActionDefinitionTypeDef
- EnvironmentExitSessionActionDefinitionSummaryTypeDef
- EnvironmentExitSessionActionDefinitionTypeDef
- FarmMemberTypeDef
- FarmSummaryTypeDef
- FieldSortExpressionTypeDef
- FleetMemberTypeDef
- GetBudgetRequestRequestTypeDef
- ResponseBudgetActionTypeDef
- GetFarmRequestRequestTypeDef
- GetFleetRequestRequestTypeDef
- WaiterConfigTypeDef
- JobAttachmentDetailsErrorTypeDef
- JobDetailsErrorTypeDef
- StepDetailsErrorTypeDef
- GetJobRequestRequestTypeDef
- GetLicenseEndpointRequestRequestTypeDef
- GetMonitorRequestRequestTypeDef
- GetQueueEnvironmentRequestRequestTypeDef
- GetQueueFleetAssociationRequestRequestTypeDef
- GetQueueRequestRequestTypeDef
- GetSessionActionRequestRequestTypeDef
- GetSessionRequestRequestTypeDef
- PaginatorConfigTypeDef
- GetSessionsStatisticsAggregationRequestRequestTypeDef
- GetStepRequestRequestTypeDef
- GetStorageProfileForQueueRequestRequestTypeDef
- GetStorageProfileRequestRequestTypeDef
- GetTaskRequestRequestTypeDef
- GetWorkerRequestRequestTypeDef
- IpAddressesOutputTypeDef
- IpAddressesTypeDef
- JobAttachmentDetailsIdentifiersTypeDef
- PathMappingRuleTypeDef
- JobDetailsIdentifiersTypeDef
- StepDetailsIdentifiersTypeDef
- StepDetailsEntityTypeDef
- JobMemberTypeDef
- PosixUserTypeDef
- WindowsUserTypeDef
- JobSummaryTypeDef
- LicenseEndpointSummaryTypeDef
- ListAvailableMeteredProductsRequestRequestTypeDef
- MeteredProductSummaryTypeDef
- ListBudgetsRequestRequestTypeDef
- ListFarmMembersRequestRequestTypeDef
- ListFarmsRequestRequestTypeDef
- ListFleetMembersRequestRequestTypeDef
- ListFleetsRequestRequestTypeDef
- ListJobMembersRequestRequestTypeDef
- ListJobParameterDefinitionsRequestRequestTypeDef
- ListJobsRequestRequestTypeDef
- ListLicenseEndpointsRequestRequestTypeDef
- ListMeteredProductsRequestRequestTypeDef
- ListMonitorsRequestRequestTypeDef
- MonitorSummaryTypeDef
- ListQueueEnvironmentsRequestRequestTypeDef
- QueueEnvironmentSummaryTypeDef
- ListQueueFleetAssociationsRequestRequestTypeDef
- QueueFleetAssociationSummaryTypeDef
- ListQueueMembersRequestRequestTypeDef
- QueueMemberTypeDef
- ListQueuesRequestRequestTypeDef
- QueueSummaryTypeDef
- ListSessionActionsRequestRequestTypeDef
- ListSessionsForWorkerRequestRequestTypeDef
- WorkerSessionSummaryTypeDef
- ListSessionsRequestRequestTypeDef
- SessionSummaryTypeDef
- ListStepConsumersRequestRequestTypeDef
- StepConsumerTypeDef
- ListStepDependenciesRequestRequestTypeDef
- StepDependencyTypeDef
- ListStepsRequestRequestTypeDef
- ListStorageProfilesForQueueRequestRequestTypeDef
- StorageProfileSummaryTypeDef
- ListStorageProfilesRequestRequestTypeDef
- ListTagsForResourceRequestRequestTypeDef
- ListTasksRequestRequestTypeDef
- ListWorkersRequestRequestTypeDef
- ManifestPropertiesTypeDef
- ParameterFilterExpressionTypeDef
- ParameterSortExpressionTypeDef
- StepParameterTypeDef
- PutMeteredProductRequestRequestTypeDef
- SearchTermFilterExpressionTypeDef
- StringFilterExpressionTypeDef
- UserJobsFirstTypeDef
- ServiceManagedEc2InstanceMarketOptionsTypeDef
- SyncInputJobAttachmentsSessionActionDefinitionSummaryTypeDef
- TaskRunSessionActionDefinitionSummaryTypeDef
- SyncInputJobAttachmentsSessionActionDefinitionTypeDef
- SessionsStatisticsResourcesTypeDef
- StatsTypeDef
- StepAmountCapabilityTypeDef
- StepAttributeCapabilityTypeDef
- TagResourceRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- UpdateFarmRequestRequestTypeDef
- UpdateJobRequestRequestTypeDef
- UpdateMonitorRequestRequestTypeDef
- UpdateQueueEnvironmentRequestRequestTypeDef
- UpdateQueueFleetAssociationRequestRequestTypeDef
- UpdateSessionRequestRequestTypeDef
- UpdateStepRequestRequestTypeDef
- UpdateTaskRequestRequestTypeDef
- WorkerAmountCapabilityTypeDef
- WorkerAttributeCapabilityTypeDef
- AcceleratorCapabilitiesOutputTypeDef
- AcceleratorCapabilitiesTypeDef
- AssignedTaskRunSessionActionDefinitionTypeDef
- TaskRunSessionActionDefinitionTypeDef
- TaskSearchSummaryTypeDef
- TaskSummaryTypeDef
- AssumeFleetRoleForReadResponseTypeDef
- AssumeFleetRoleForWorkerResponseTypeDef
- AssumeQueueRoleForReadResponseTypeDef
- AssumeQueueRoleForUserResponseTypeDef
- AssumeQueueRoleForWorkerResponseTypeDef
- CopyJobTemplateResponseTypeDef
- CreateBudgetResponseTypeDef
- CreateFarmResponseTypeDef
- CreateFleetResponseTypeDef
- CreateJobResponseTypeDef
- CreateLicenseEndpointResponseTypeDef
- CreateMonitorResponseTypeDef
- CreateQueueEnvironmentResponseTypeDef
- CreateQueueResponseTypeDef
- CreateStorageProfileResponseTypeDef
- CreateWorkerResponseTypeDef
- GetFarmResponseTypeDef
- GetLicenseEndpointResponseTypeDef
- GetMonitorResponseTypeDef
- GetQueueEnvironmentResponseTypeDef
- GetQueueFleetAssociationResponseTypeDef
- GetTaskResponseTypeDef
- ListJobParameterDefinitionsResponseTypeDef
- ListTagsForResourceResponseTypeDef
- StartSessionsStatisticsAggregationResponseTypeDef
- UpdateWorkerResponseTypeDef
- AttachmentsOutputTypeDef
- BudgetScheduleOutputTypeDef
- BudgetSummaryTypeDef
- CopyJobTemplateRequestRequestTypeDef
- JobSearchSummaryTypeDef
- CreateStorageProfileRequestRequestTypeDef
- GetStorageProfileForQueueResponseTypeDef
- GetStorageProfileResponseTypeDef
- UpdateStorageProfileRequestRequestTypeDef
- FleetCapabilitiesTypeDef
- CustomerManagedWorkerCapabilitiesOutputTypeDef
- CustomerManagedWorkerCapabilitiesTypeDef
- FleetAttributeCapabilityUnionTypeDef
- DateTimeFilterExpressionTypeDef
- FixedBudgetScheduleTypeDef
- UpdatedSessionActionInfoTypeDef
- StepSummaryTypeDef
- ListFarmMembersResponseTypeDef
- ListFarmsResponseTypeDef
- ListFleetMembersResponseTypeDef
- GetFleetRequestWaitTypeDef
- GetJobRequestWaitTypeDef
- GetLicenseEndpointRequestWaitTypeDef
- GetQueueFleetAssociationRequestWaitTypeDef
- GetQueueRequestWaitTypeDef
- GetJobEntityErrorTypeDef
- GetSessionsStatisticsAggregationRequestPaginateTypeDef
- ListAvailableMeteredProductsRequestPaginateTypeDef
- ListBudgetsRequestPaginateTypeDef
- ListFarmMembersRequestPaginateTypeDef
- ListFarmsRequestPaginateTypeDef
- ListFleetMembersRequestPaginateTypeDef
- ListFleetsRequestPaginateTypeDef
- ListJobMembersRequestPaginateTypeDef
- ListJobParameterDefinitionsRequestPaginateTypeDef
- ListJobsRequestPaginateTypeDef
- ListLicenseEndpointsRequestPaginateTypeDef
- ListMeteredProductsRequestPaginateTypeDef
- ListMonitorsRequestPaginateTypeDef
- ListQueueEnvironmentsRequestPaginateTypeDef
- ListQueueFleetAssociationsRequestPaginateTypeDef
- ListQueueMembersRequestPaginateTypeDef
- ListQueuesRequestPaginateTypeDef
- ListSessionActionsRequestPaginateTypeDef
- ListSessionsForWorkerRequestPaginateTypeDef
- ListSessionsRequestPaginateTypeDef
- ListStepConsumersRequestPaginateTypeDef
- ListStepDependenciesRequestPaginateTypeDef
- ListStepsRequestPaginateTypeDef
- ListStorageProfilesForQueueRequestPaginateTypeDef
- ListStorageProfilesRequestPaginateTypeDef
- ListTasksRequestPaginateTypeDef
- ListWorkersRequestPaginateTypeDef
- HostPropertiesResponseTypeDef
- IpAddressesUnionTypeDef
- JobEntityIdentifiersUnionTypeDef
- ListJobMembersResponseTypeDef
- JobRunAsUserTypeDef
- ListJobsResponseTypeDef
- ListLicenseEndpointsResponseTypeDef
- ListAvailableMeteredProductsResponseTypeDef
- ListMeteredProductsResponseTypeDef
- ListMonitorsResponseTypeDef
- ListQueueEnvironmentsResponseTypeDef
- ListQueueFleetAssociationsResponseTypeDef
- ListQueueMembersResponseTypeDef
- ListQueuesResponseTypeDef
- ListSessionsForWorkerResponseTypeDef
- ListSessionsResponseTypeDef
- ListStepConsumersResponseTypeDef
- ListStepDependenciesResponseTypeDef
- ListStorageProfilesForQueueResponseTypeDef
- ListStorageProfilesResponseTypeDef
- ManifestPropertiesUnionTypeDef
- ParameterSpaceTypeDef
- SearchSortExpressionTypeDef
- SessionActionDefinitionSummaryTypeDef
- StartSessionsStatisticsAggregationRequestRequestTypeDef
- StatisticsTypeDef
- StepRequiredCapabilitiesTypeDef
- WorkerCapabilitiesTypeDef
- ServiceManagedEc2InstanceCapabilitiesOutputTypeDef
- AcceleratorCapabilitiesUnionTypeDef
- AssignedSessionActionDefinitionTypeDef
- SessionActionDefinitionTypeDef
- SearchTasksResponseTypeDef
- ListTasksResponseTypeDef
- GetJobResponseTypeDef
- JobAttachmentDetailsEntityTypeDef
- GetBudgetResponseTypeDef
- ListBudgetsResponseTypeDef
- SearchJobsResponseTypeDef
- CustomerManagedFleetConfigurationOutputTypeDef
- CustomerManagedWorkerCapabilitiesUnionTypeDef
- SearchFilterExpressionTypeDef
- FixedBudgetScheduleUnionTypeDef
- UpdateWorkerScheduleRequestRequestTypeDef
- ListStepsResponseTypeDef
- GetSessionResponseTypeDef
- GetWorkerResponseTypeDef
- WorkerSearchSummaryTypeDef
- WorkerSummaryTypeDef
- HostPropertiesRequestTypeDef
- BatchGetJobEntityRequestRequestTypeDef
- CreateQueueRequestRequestTypeDef
- GetQueueResponseTypeDef
- JobDetailsEntityTypeDef
- UpdateQueueRequestRequestTypeDef
- AttachmentsTypeDef
- StepSearchSummaryTypeDef
- SessionActionSummaryTypeDef
- GetSessionsStatisticsAggregationResponseTypeDef
- GetStepResponseTypeDef
- ServiceManagedEc2FleetConfigurationOutputTypeDef
- ServiceManagedEc2InstanceCapabilitiesTypeDef
- AssignedSessionActionTypeDef
- GetSessionActionResponseTypeDef
- CustomerManagedFleetConfigurationTypeDef
- SearchGroupedFilterExpressionsTypeDef
- BudgetScheduleTypeDef
- SearchWorkersResponseTypeDef
- ListWorkersResponseTypeDef
- CreateWorkerRequestRequestTypeDef
- UpdateWorkerRequestRequestTypeDef
- JobEntityTypeDef
- CreateJobRequestRequestTypeDef
- SearchStepsResponseTypeDef
- ListSessionActionsResponseTypeDef
- FleetConfigurationOutputTypeDef
- ServiceManagedEc2InstanceCapabilitiesUnionTypeDef
- AssignedSessionTypeDef
- CustomerManagedFleetConfigurationUnionTypeDef
- SearchJobsRequestRequestTypeDef
- SearchStepsRequestRequestTypeDef
- SearchTasksRequestRequestTypeDef
- SearchWorkersRequestRequestTypeDef
- CreateBudgetRequestRequestTypeDef
- UpdateBudgetRequestRequestTypeDef
- BatchGetJobEntityResponseTypeDef
- FleetSummaryTypeDef
- GetFleetResponseTypeDef
- ServiceManagedEc2FleetConfigurationTypeDef
- UpdateWorkerScheduleResponseTypeDef
- ListFleetsResponseTypeDef
- ServiceManagedEc2FleetConfigurationUnionTypeDef
- FleetConfigurationTypeDef
- CreateFleetRequestRequestTypeDef
- UpdateFleetRequestRequestTypeDef