RoboMaker module#
Index > RoboMaker
Auto-generated documentation for RoboMaker type annotations stubs module mypy-boto3-robomaker.
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-stubs
AWS SDK. - Add
RoboMaker
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 RoboMaker
.
From PyPI with pip#
Install boto3-stubs
for RoboMaker
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[robomaker]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[robomaker]'
# standalone installation
python -m pip install mypy-boto3-robomaker
How to uninstall#
python -m pip uninstall -y mypy-boto3-robomaker
Usage#
Code samples can be found in Examples.
RoboMakerClient#
Type annotations and code completion for boto3.client("robomaker")
as RoboMakerClient
boto3 documentation
# RoboMakerClient usage example
from boto3.session import Session
from mypy_boto3_robomaker.client import RoboMakerClient
def get_client() -> RoboMakerClient:
return Session().client("robomaker")
Paginators#
Type annotations and code completion for paginators
from boto3.client("robomaker").get_paginator("...")
.
# ListDeploymentJobsPaginator usage example
from boto3.session import Session
from mypy_boto3_robomaker.paginator import ListDeploymentJobsPaginator
def get_list_deployment_jobs_paginator() -> ListDeploymentJobsPaginator:
return Session().client("robomaker").get_paginator("list_deployment_jobs"))
- ListDeploymentJobsPaginator
- ListFleetsPaginator
- ListRobotApplicationsPaginator
- ListRobotsPaginator
- ListSimulationApplicationsPaginator
- ListSimulationJobBatchesPaginator
- ListSimulationJobsPaginator
- ListWorldExportJobsPaginator
- ListWorldGenerationJobsPaginator
- ListWorldTemplatesPaginator
- ListWorldsPaginator
Literals#
Type annotations for literals used in methods and schema.
# ArchitectureType usage example
from mypy_boto3_robomaker.literals import ArchitectureType
def get_value() -> ArchitectureType:
return "ARM64"
- ArchitectureType
- ComputeTypeType
- DataSourceTypeType
- DeploymentJobErrorCodeType
- DeploymentStatusType
- ExitBehaviorType
- FailureBehaviorType
- ListDeploymentJobsPaginatorName
- ListFleetsPaginatorName
- ListRobotApplicationsPaginatorName
- ListRobotsPaginatorName
- ListSimulationApplicationsPaginatorName
- ListSimulationJobBatchesPaginatorName
- ListSimulationJobsPaginatorName
- ListWorldExportJobsPaginatorName
- ListWorldGenerationJobsPaginatorName
- ListWorldTemplatesPaginatorName
- ListWorldsPaginatorName
- RenderingEngineTypeType
- RobotDeploymentStepType
- RobotSoftwareSuiteTypeType
- RobotSoftwareSuiteVersionTypeType
- RobotStatusType
- SimulationJobBatchErrorCodeType
- SimulationJobBatchStatusType
- SimulationJobErrorCodeType
- SimulationJobStatusType
- SimulationSoftwareSuiteTypeType
- UploadBehaviorType
- WorldExportJobErrorCodeType
- WorldExportJobStatusType
- WorldGenerationJobErrorCodeType
- WorldGenerationJobStatusType
- RoboMakerServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- BatchDeleteWorldsRequestRequestTypeDef
- ResponseMetadataTypeDef
- BatchDescribeSimulationJobRequestRequestTypeDef
- BatchPolicyTypeDef
- CancelDeploymentJobRequestRequestTypeDef
- CancelSimulationJobBatchRequestRequestTypeDef
- CancelSimulationJobRequestRequestTypeDef
- CancelWorldExportJobRequestRequestTypeDef
- CancelWorldGenerationJobRequestRequestTypeDef
- ComputeResponseTypeDef
- ComputeTypeDef
- CreateFleetRequestRequestTypeDef
- EnvironmentTypeDef
- RobotSoftwareSuiteTypeDef
- SourceConfigTypeDef
- SourceTypeDef
- CreateRobotApplicationVersionRequestRequestTypeDef
- CreateRobotRequestRequestTypeDef
- RenderingEngineTypeDef
- SimulationSoftwareSuiteTypeDef
- CreateSimulationApplicationVersionRequestRequestTypeDef
- LoggingConfigTypeDef
- OutputLocationTypeDef
- VPCConfigTypeDef
- VPCConfigResponseTypeDef
- WorldCountTypeDef
- TemplateLocationTypeDef
- DataSourceConfigOutputTypeDef
- DataSourceConfigTypeDef
- S3KeyOutputTypeDef
- DeleteFleetRequestRequestTypeDef
- DeleteRobotApplicationRequestRequestTypeDef
- DeleteRobotRequestRequestTypeDef
- DeleteSimulationApplicationRequestRequestTypeDef
- DeleteWorldTemplateRequestRequestTypeDef
- DeploymentLaunchConfigOutputTypeDef
- S3ObjectTypeDef
- DeploymentLaunchConfigTypeDef
- DeregisterRobotRequestRequestTypeDef
- DescribeDeploymentJobRequestRequestTypeDef
- DescribeFleetRequestRequestTypeDef
- RobotTypeDef
- DescribeRobotApplicationRequestRequestTypeDef
- DescribeRobotRequestRequestTypeDef
- DescribeSimulationApplicationRequestRequestTypeDef
- DescribeSimulationJobBatchRequestRequestTypeDef
- SimulationJobSummaryTypeDef
- DescribeSimulationJobRequestRequestTypeDef
- NetworkInterfaceTypeDef
- DescribeWorldExportJobRequestRequestTypeDef
- DescribeWorldGenerationJobRequestRequestTypeDef
- DescribeWorldRequestRequestTypeDef
- DescribeWorldTemplateRequestRequestTypeDef
- WorldFailureTypeDef
- FilterTypeDef
- FleetTypeDef
- GetWorldTemplateBodyRequestRequestTypeDef
- PaginatorConfigTypeDef
- SimulationJobBatchSummaryTypeDef
- ListTagsForResourceRequestRequestTypeDef
- ListWorldTemplatesRequestRequestTypeDef
- TemplateSummaryTypeDef
- WorldSummaryTypeDef
- PortMappingTypeDef
- ProgressDetailTypeDef
- RegisterRobotRequestRequestTypeDef
- RestartSimulationJobRequestRequestTypeDef
- ToolTypeDef
- UploadConfigurationTypeDef
- WorldConfigTypeDef
- VPCConfigOutputTypeDef
- SyncDeploymentJobRequestRequestTypeDef
- TagResourceRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- BatchDeleteWorldsResponseTypeDef
- CreateFleetResponseTypeDef
- CreateRobotResponseTypeDef
- CreateWorldTemplateResponseTypeDef
- DeregisterRobotResponseTypeDef
- DescribeRobotResponseTypeDef
- DescribeWorldResponseTypeDef
- DescribeWorldTemplateResponseTypeDef
- GetWorldTemplateBodyResponseTypeDef
- ListTagsForResourceResponseTypeDef
- RegisterRobotResponseTypeDef
- UpdateWorldTemplateResponseTypeDef
- RobotApplicationSummaryTypeDef
- CreateRobotApplicationRequestRequestTypeDef
- UpdateRobotApplicationRequestRequestTypeDef
- CreateRobotApplicationResponseTypeDef
- CreateRobotApplicationVersionResponseTypeDef
- DescribeRobotApplicationResponseTypeDef
- UpdateRobotApplicationResponseTypeDef
- CreateSimulationApplicationRequestRequestTypeDef
- CreateSimulationApplicationResponseTypeDef
- CreateSimulationApplicationVersionResponseTypeDef
- DescribeSimulationApplicationResponseTypeDef
- SimulationApplicationSummaryTypeDef
- UpdateSimulationApplicationRequestRequestTypeDef
- UpdateSimulationApplicationResponseTypeDef
- CreateWorldExportJobRequestRequestTypeDef
- CreateWorldExportJobResponseTypeDef
- DescribeWorldExportJobResponseTypeDef
- WorldExportJobSummaryTypeDef
- CreateWorldGenerationJobRequestRequestTypeDef
- CreateWorldGenerationJobResponseTypeDef
- WorldGenerationJobSummaryTypeDef
- CreateWorldTemplateRequestRequestTypeDef
- UpdateWorldTemplateRequestRequestTypeDef
- DataSourceConfigUnionTypeDef
- DataSourceTypeDef
- DeploymentApplicationConfigOutputTypeDef
- DeploymentConfigTypeDef
- DeploymentLaunchConfigUnionTypeDef
- DescribeFleetResponseTypeDef
- ListRobotsResponseTypeDef
- ListSimulationJobsResponseTypeDef
- FailureSummaryTypeDef
- ListDeploymentJobsRequestRequestTypeDef
- ListFleetsRequestRequestTypeDef
- ListRobotApplicationsRequestRequestTypeDef
- ListRobotsRequestRequestTypeDef
- ListSimulationApplicationsRequestRequestTypeDef
- ListSimulationJobBatchesRequestRequestTypeDef
- ListSimulationJobsRequestRequestTypeDef
- ListWorldExportJobsRequestRequestTypeDef
- ListWorldGenerationJobsRequestRequestTypeDef
- ListWorldsRequestRequestTypeDef
- ListFleetsResponseTypeDef
- ListDeploymentJobsRequestPaginateTypeDef
- ListFleetsRequestPaginateTypeDef
- ListRobotApplicationsRequestPaginateTypeDef
- ListRobotsRequestPaginateTypeDef
- ListSimulationApplicationsRequestPaginateTypeDef
- ListSimulationJobBatchesRequestPaginateTypeDef
- ListSimulationJobsRequestPaginateTypeDef
- ListWorldExportJobsRequestPaginateTypeDef
- ListWorldGenerationJobsRequestPaginateTypeDef
- ListWorldTemplatesRequestPaginateTypeDef
- ListWorldsRequestPaginateTypeDef
- ListSimulationJobBatchesResponseTypeDef
- ListWorldTemplatesResponseTypeDef
- ListWorldsResponseTypeDef
- PortForwardingConfigOutputTypeDef
- PortForwardingConfigTypeDef
- RobotDeploymentTypeDef
- VPCConfigUnionTypeDef
- ListRobotApplicationsResponseTypeDef
- ListSimulationApplicationsResponseTypeDef
- ListWorldExportJobsResponseTypeDef
- ListWorldGenerationJobsResponseTypeDef
- CreateDeploymentJobResponseTypeDef
- DeploymentJobTypeDef
- SyncDeploymentJobResponseTypeDef
- DeploymentApplicationConfigTypeDef
- FinishedWorldsSummaryTypeDef
- LaunchConfigOutputTypeDef
- PortForwardingConfigUnionTypeDef
- DescribeDeploymentJobResponseTypeDef
- ListDeploymentJobsResponseTypeDef
- DeploymentApplicationConfigUnionTypeDef
- DescribeWorldGenerationJobResponseTypeDef
- RobotApplicationConfigOutputTypeDef
- SimulationApplicationConfigOutputTypeDef
- LaunchConfigTypeDef
- CreateDeploymentJobRequestRequestTypeDef
- CreateSimulationJobResponseTypeDef
- DescribeSimulationJobResponseTypeDef
- SimulationJobRequestOutputTypeDef
- SimulationJobTypeDef
- LaunchConfigUnionTypeDef
- FailedCreateSimulationJobRequestTypeDef
- BatchDescribeSimulationJobResponseTypeDef
- RobotApplicationConfigTypeDef
- SimulationApplicationConfigTypeDef
- DescribeSimulationJobBatchResponseTypeDef
- StartSimulationJobBatchResponseTypeDef
- RobotApplicationConfigUnionTypeDef
- SimulationApplicationConfigUnionTypeDef
- CreateSimulationJobRequestRequestTypeDef
- SimulationJobRequestTypeDef
- SimulationJobRequestUnionTypeDef
- StartSimulationJobBatchRequestRequestTypeDef