Skip to content

Type definitions#

Index > RoboMaker > Type definitions

Auto-generated documentation for RoboMaker type annotations stubs module mypy-boto3-robomaker.

BatchDeleteWorldsRequestRequestTypeDef#

# BatchDeleteWorldsRequestRequestTypeDef definition

class BatchDeleteWorldsRequestRequestTypeDef(TypedDict):
    worlds: Sequence[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

BatchDescribeSimulationJobRequestRequestTypeDef#

# BatchDescribeSimulationJobRequestRequestTypeDef definition

class BatchDescribeSimulationJobRequestRequestTypeDef(TypedDict):
    jobs: Sequence[str],

BatchPolicyTypeDef#

# BatchPolicyTypeDef definition

class BatchPolicyTypeDef(TypedDict):
    timeoutInSeconds: NotRequired[int],
    maxConcurrency: NotRequired[int],

CancelDeploymentJobRequestRequestTypeDef#

# CancelDeploymentJobRequestRequestTypeDef definition

class CancelDeploymentJobRequestRequestTypeDef(TypedDict):
    job: str,

CancelSimulationJobBatchRequestRequestTypeDef#

# CancelSimulationJobBatchRequestRequestTypeDef definition

class CancelSimulationJobBatchRequestRequestTypeDef(TypedDict):
    batch: str,

CancelSimulationJobRequestRequestTypeDef#

# CancelSimulationJobRequestRequestTypeDef definition

class CancelSimulationJobRequestRequestTypeDef(TypedDict):
    job: str,

CancelWorldExportJobRequestRequestTypeDef#

# CancelWorldExportJobRequestRequestTypeDef definition

class CancelWorldExportJobRequestRequestTypeDef(TypedDict):
    job: str,

CancelWorldGenerationJobRequestRequestTypeDef#

# CancelWorldGenerationJobRequestRequestTypeDef definition

class CancelWorldGenerationJobRequestRequestTypeDef(TypedDict):
    job: str,

ComputeResponseTypeDef#

# ComputeResponseTypeDef definition

class ComputeResponseTypeDef(TypedDict):
    simulationUnitLimit: NotRequired[int],
    computeType: NotRequired[ComputeTypeType],  # (1)
    gpuUnitLimit: NotRequired[int],
  1. See ComputeTypeType

ComputeTypeDef#

# ComputeTypeDef definition

class ComputeTypeDef(TypedDict):
    simulationUnitLimit: NotRequired[int],
    computeType: NotRequired[ComputeTypeType],  # (1)
    gpuUnitLimit: NotRequired[int],
  1. See ComputeTypeType

CreateFleetRequestRequestTypeDef#

# CreateFleetRequestRequestTypeDef definition

class CreateFleetRequestRequestTypeDef(TypedDict):
    name: str,
    tags: NotRequired[Mapping[str, str]],

EnvironmentTypeDef#

# EnvironmentTypeDef definition

class EnvironmentTypeDef(TypedDict):
    uri: NotRequired[str],

RobotSoftwareSuiteTypeDef#

# RobotSoftwareSuiteTypeDef definition

class RobotSoftwareSuiteTypeDef(TypedDict):
    name: NotRequired[RobotSoftwareSuiteTypeType],  # (1)
    version: NotRequired[RobotSoftwareSuiteVersionTypeType],  # (2)
  1. See RobotSoftwareSuiteTypeType
  2. See RobotSoftwareSuiteVersionTypeType

SourceConfigTypeDef#

# SourceConfigTypeDef definition

class SourceConfigTypeDef(TypedDict):
    s3Bucket: NotRequired[str],
    s3Key: NotRequired[str],
    architecture: NotRequired[ArchitectureType],  # (1)
  1. See ArchitectureType

SourceTypeDef#

# SourceTypeDef definition

class SourceTypeDef(TypedDict):
    s3Bucket: NotRequired[str],
    s3Key: NotRequired[str],
    etag: NotRequired[str],
    architecture: NotRequired[ArchitectureType],  # (1)
  1. See ArchitectureType

CreateRobotApplicationVersionRequestRequestTypeDef#

# CreateRobotApplicationVersionRequestRequestTypeDef definition

class CreateRobotApplicationVersionRequestRequestTypeDef(TypedDict):
    application: str,
    currentRevisionId: NotRequired[str],
    s3Etags: NotRequired[Sequence[str]],
    imageDigest: NotRequired[str],

CreateRobotRequestRequestTypeDef#

# CreateRobotRequestRequestTypeDef definition

class CreateRobotRequestRequestTypeDef(TypedDict):
    name: str,
    architecture: ArchitectureType,  # (1)
    greengrassGroupId: str,
    tags: NotRequired[Mapping[str, str]],
  1. See ArchitectureType

RenderingEngineTypeDef#

# RenderingEngineTypeDef definition

class RenderingEngineTypeDef(TypedDict):
    name: NotRequired[RenderingEngineTypeType],  # (1)
    version: NotRequired[str],
  1. See RenderingEngineTypeType

SimulationSoftwareSuiteTypeDef#

# SimulationSoftwareSuiteTypeDef definition

class SimulationSoftwareSuiteTypeDef(TypedDict):
    name: NotRequired[SimulationSoftwareSuiteTypeType],  # (1)
    version: NotRequired[str],
  1. See SimulationSoftwareSuiteTypeType

CreateSimulationApplicationVersionRequestRequestTypeDef#

# CreateSimulationApplicationVersionRequestRequestTypeDef definition

class CreateSimulationApplicationVersionRequestRequestTypeDef(TypedDict):
    application: str,
    currentRevisionId: NotRequired[str],
    s3Etags: NotRequired[Sequence[str]],
    imageDigest: NotRequired[str],

DataSourceConfigTypeDef#

# DataSourceConfigTypeDef definition

class DataSourceConfigTypeDef(TypedDict):
    name: str,
    s3Bucket: str,
    s3Keys: Sequence[str],
    type: NotRequired[DataSourceTypeType],  # (1)
    destination: NotRequired[str],
  1. See DataSourceTypeType

LoggingConfigTypeDef#

# LoggingConfigTypeDef definition

class LoggingConfigTypeDef(TypedDict):
    recordAllRosTopics: NotRequired[bool],

OutputLocationTypeDef#

# OutputLocationTypeDef definition

class OutputLocationTypeDef(TypedDict):
    s3Bucket: NotRequired[str],
    s3Prefix: NotRequired[str],

VPCConfigTypeDef#

# VPCConfigTypeDef definition

class VPCConfigTypeDef(TypedDict):
    subnets: Sequence[str],
    securityGroups: NotRequired[Sequence[str]],
    assignPublicIp: NotRequired[bool],

VPCConfigResponseTypeDef#

# VPCConfigResponseTypeDef definition

class VPCConfigResponseTypeDef(TypedDict):
    subnets: NotRequired[List[str]],
    securityGroups: NotRequired[List[str]],
    vpcId: NotRequired[str],
    assignPublicIp: NotRequired[bool],

WorldCountTypeDef#

# WorldCountTypeDef definition

class WorldCountTypeDef(TypedDict):
    floorplanCount: NotRequired[int],
    interiorCountPerFloorplan: NotRequired[int],

TemplateLocationTypeDef#

# TemplateLocationTypeDef definition

class TemplateLocationTypeDef(TypedDict):
    s3Bucket: str,
    s3Key: str,

S3KeyOutputTypeDef#

# S3KeyOutputTypeDef definition

class S3KeyOutputTypeDef(TypedDict):
    s3Key: NotRequired[str],
    etag: NotRequired[str],

DeleteFleetRequestRequestTypeDef#

# DeleteFleetRequestRequestTypeDef definition

class DeleteFleetRequestRequestTypeDef(TypedDict):
    fleet: str,

DeleteRobotApplicationRequestRequestTypeDef#

# DeleteRobotApplicationRequestRequestTypeDef definition

class DeleteRobotApplicationRequestRequestTypeDef(TypedDict):
    application: str,
    applicationVersion: NotRequired[str],

DeleteRobotRequestRequestTypeDef#

# DeleteRobotRequestRequestTypeDef definition

class DeleteRobotRequestRequestTypeDef(TypedDict):
    robot: str,

DeleteSimulationApplicationRequestRequestTypeDef#

# DeleteSimulationApplicationRequestRequestTypeDef definition

class DeleteSimulationApplicationRequestRequestTypeDef(TypedDict):
    application: str,
    applicationVersion: NotRequired[str],

DeleteWorldTemplateRequestRequestTypeDef#

# DeleteWorldTemplateRequestRequestTypeDef definition

class DeleteWorldTemplateRequestRequestTypeDef(TypedDict):
    template: str,

DeploymentLaunchConfigPaginatorTypeDef#

# DeploymentLaunchConfigPaginatorTypeDef definition

class DeploymentLaunchConfigPaginatorTypeDef(TypedDict):
    packageName: str,
    launchFile: str,
    preLaunchFile: NotRequired[str],
    postLaunchFile: NotRequired[str],
    environmentVariables: NotRequired[Dict[str, str]],

DeploymentLaunchConfigTypeDef#

# DeploymentLaunchConfigTypeDef definition

class DeploymentLaunchConfigTypeDef(TypedDict):
    packageName: str,
    launchFile: str,
    preLaunchFile: NotRequired[str],
    postLaunchFile: NotRequired[str],
    environmentVariables: NotRequired[Mapping[str, str]],

S3ObjectTypeDef#

# S3ObjectTypeDef definition

class S3ObjectTypeDef(TypedDict):
    bucket: str,
    key: str,
    etag: NotRequired[str],

DeregisterRobotRequestRequestTypeDef#

# DeregisterRobotRequestRequestTypeDef definition

class DeregisterRobotRequestRequestTypeDef(TypedDict):
    fleet: str,
    robot: str,

DescribeDeploymentJobRequestRequestTypeDef#

# DescribeDeploymentJobRequestRequestTypeDef definition

class DescribeDeploymentJobRequestRequestTypeDef(TypedDict):
    job: str,

DescribeFleetRequestRequestTypeDef#

# DescribeFleetRequestRequestTypeDef definition

class DescribeFleetRequestRequestTypeDef(TypedDict):
    fleet: str,

RobotTypeDef#

# RobotTypeDef definition

class RobotTypeDef(TypedDict):
    arn: NotRequired[str],
    name: NotRequired[str],
    fleetArn: NotRequired[str],
    status: NotRequired[RobotStatusType],  # (1)
    greenGrassGroupId: NotRequired[str],
    createdAt: NotRequired[datetime],
    architecture: NotRequired[ArchitectureType],  # (2)
    lastDeploymentJob: NotRequired[str],
    lastDeploymentTime: NotRequired[datetime],
  1. See RobotStatusType
  2. See ArchitectureType

DescribeRobotApplicationRequestRequestTypeDef#

# DescribeRobotApplicationRequestRequestTypeDef definition

class DescribeRobotApplicationRequestRequestTypeDef(TypedDict):
    application: str,
    applicationVersion: NotRequired[str],

DescribeRobotRequestRequestTypeDef#

# DescribeRobotRequestRequestTypeDef definition

class DescribeRobotRequestRequestTypeDef(TypedDict):
    robot: str,

DescribeSimulationApplicationRequestRequestTypeDef#

# DescribeSimulationApplicationRequestRequestTypeDef definition

class DescribeSimulationApplicationRequestRequestTypeDef(TypedDict):
    application: str,
    application