RoboMakerClient

Index > RoboMaker > RoboMakerClient

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

RoboMakerClient

Type annotations and code completion for boto3.client("robomaker"). boto3 documentation

# RoboMakerClient usage example

from boto3.session import Session
from mypy_boto3_robomaker.client import RoboMakerClient

def get_robomaker_client() -> RoboMakerClient:
    return Session().client("robomaker")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("robomaker").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("robomaker")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.ConcurrentDeploymentException,
    client.exceptions.IdempotentParameterMismatchException,
    client.exceptions.InternalServerException,
    client.exceptions.InvalidParameterException,
    client.exceptions.LimitExceededException,
    client.exceptions.ResourceAlreadyExistsException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceUnavailableException,
    client.exceptions.ThrottlingException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_robomaker.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods

can_paginate

Type annotations and code completion for boto3.client("robomaker").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url

Type annotations and code completion for boto3.client("robomaker").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

batch_delete_worlds

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").batch_delete_worlds method. boto3 documentation

# batch_delete_worlds method definition

def batch_delete_worlds(
    self,
    *,
    worlds: Sequence[str],
) -> BatchDeleteWorldsResponseTypeDef:  # (1)
    ...

1. See BatchDeleteWorldsResponseTypeDef

# batch_delete_worlds method usage example with argument unpacking

kwargs: BatchDeleteWorldsRequestTypeDef = {  # (1)
    "worlds": ...,
}

parent.batch_delete_worlds(**kwargs)

1. See BatchDeleteWorldsRequestTypeDef

batch_describe_simulation_job

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").batch_describe_simulation_job method. boto3 documentation

# batch_describe_simulation_job method definition

def batch_describe_simulation_job(
    self,
    *,
    jobs: Sequence[str],
) -> BatchDescribeSimulationJobResponseTypeDef:  # (1)
    ...

1. See BatchDescribeSimulationJobResponseTypeDef

# batch_describe_simulation_job method usage example with argument unpacking

kwargs: BatchDescribeSimulationJobRequestTypeDef = {  # (1)
    "jobs": ...,
}

parent.batch_describe_simulation_job(**kwargs)

1. See BatchDescribeSimulationJobRequestTypeDef

cancel_deployment_job

This API is no longer supported.

Type annotations and code completion for boto3.client("robomaker").cancel_deployment_job method. boto3 documentation

# cancel_deployment_job method definition

def cancel_deployment_job(
    self,
    *,
    job: str,
) -> Dict[str, Any]:
    ...

# cancel_deployment_job method usage example with argument unpacking

kwargs: CancelDeploymentJobRequestTypeDef = {  # (1)
    "job": ...,
}

parent.cancel_deployment_job(**kwargs)

1. See CancelDeploymentJobRequestTypeDef

cancel_simulation_job

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").cancel_simulation_job method. boto3 documentation

# cancel_simulation_job method definition

def cancel_simulation_job(
    self,
    *,
    job: str,
) -> Dict[str, Any]:
    ...

# cancel_simulation_job method usage example with argument unpacking

kwargs: CancelSimulationJobRequestTypeDef = {  # (1)
    "job": ...,
}

parent.cancel_simulation_job(**kwargs)

1. See CancelSimulationJobRequestTypeDef

cancel_simulation_job_batch

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").cancel_simulation_job_batch method. boto3 documentation

# cancel_simulation_job_batch method definition

def cancel_simulation_job_batch(
    self,
    *,
    batch: str,
) -> Dict[str, Any]:
    ...

# cancel_simulation_job_batch method usage example with argument unpacking

kwargs: CancelSimulationJobBatchRequestTypeDef = {  # (1)
    "batch": ...,
}

parent.cancel_simulation_job_batch(**kwargs)

1. See CancelSimulationJobBatchRequestTypeDef

cancel_world_export_job

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").cancel_world_export_job method. boto3 documentation

# cancel_world_export_job method definition

def cancel_world_export_job(
    self,
    *,
    job: str,
) -> Dict[str, Any]:
    ...

# cancel_world_export_job method usage example with argument unpacking

kwargs: CancelWorldExportJobRequestTypeDef = {  # (1)
    "job": ...,
}

parent.cancel_world_export_job(**kwargs)

1. See CancelWorldExportJobRequestTypeDef

cancel_world_generation_job

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").cancel_world_generation_job method. boto3 documentation

# cancel_world_generation_job method definition

def cancel_world_generation_job(
    self,
    *,
    job: str,
) -> Dict[str, Any]:
    ...

# cancel_world_generation_job method usage example with argument unpacking

kwargs: CancelWorldGenerationJobRequestTypeDef = {  # (1)
    "job": ...,
}

parent.cancel_world_generation_job(**kwargs)

1. See CancelWorldGenerationJobRequestTypeDef

create_deployment_job

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").create_deployment_job method. boto3 documentation

# create_deployment_job method definition

def create_deployment_job(
    self,
    *,
    clientRequestToken: str,
    fleet: str,
    deploymentApplicationConfigs: Sequence[DeploymentApplicationConfigUnionTypeDef],  # (1)
    deploymentConfig: DeploymentConfigTypeDef = ...,  # (2)
    tags: Mapping[str, str] = ...,
) -> CreateDeploymentJobResponseTypeDef:  # (3)
    ...

1. See Sequence[DeploymentApplicationConfigUnionTypeDef]
2. See DeploymentConfigTypeDef
3. See CreateDeploymentJobResponseTypeDef

# create_deployment_job method usage example with argument unpacking

kwargs: CreateDeploymentJobRequestTypeDef = {  # (1)
    "clientRequestToken": ...,
    "fleet": ...,
    "deploymentApplicationConfigs": ...,
}

parent.create_deployment_job(**kwargs)

1. See CreateDeploymentJobRequestTypeDef

create_fleet

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").create_fleet method. boto3 documentation

# create_fleet method definition

def create_fleet(
    self,
    *,
    name: str,
    tags: Mapping[str, str] = ...,
) -> CreateFleetResponseTypeDef:  # (1)
    ...

1. See CreateFleetResponseTypeDef

# create_fleet method usage example with argument unpacking

kwargs: CreateFleetRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_fleet(**kwargs)

1. See CreateFleetRequestTypeDef

create_robot

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").create_robot method. boto3 documentation

# create_robot method definition

def create_robot(
    self,
    *,
    name: str,
    architecture: ArchitectureType,  # (1)
    greengrassGroupId: str,
    tags: Mapping[str, str] = ...,
) -> CreateRobotResponseTypeDef:  # (2)
    ...

1. See ArchitectureType
2. See CreateRobotResponseTypeDef

# create_robot method usage example with argument unpacking

kwargs: CreateRobotRequestTypeDef = {  # (1)
    "name": ...,
    "architecture": ...,
    "greengrassGroupId": ...,
}

parent.create_robot(**kwargs)

1. See CreateRobotRequestTypeDef

create_robot_application

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").create_robot_application method. boto3 documentation

# create_robot_application method definition

def create_robot_application(
    self,
    *,
    name: str,
    robotSoftwareSuite: RobotSoftwareSuiteTypeDef,  # (1)
    sources: Sequence[SourceConfigTypeDef] = ...,  # (2)
    tags: Mapping[str, str] = ...,
    environment: EnvironmentTypeDef = ...,  # (3)
) -> CreateRobotApplicationResponseTypeDef:  # (4)
    ...

1. See RobotSoftwareSuiteTypeDef
2. See Sequence[SourceConfigTypeDef]
3. See EnvironmentTypeDef
4. See CreateRobotApplicationResponseTypeDef

# create_robot_application method usage example with argument unpacking

kwargs: CreateRobotApplicationRequestTypeDef = {  # (1)
    "name": ...,
    "robotSoftwareSuite": ...,
}

parent.create_robot_application(**kwargs)

1. See CreateRobotApplicationRequestTypeDef

create_robot_application_version

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").create_robot_application_version method. boto3 documentation

# create_robot_application_version method definition

def create_robot_application_version(
    self,
    *,
    application: str,
    currentRevisionId: str = ...,
    s3Etags: Sequence[str] = ...,
    imageDigest: str = ...,
) -> CreateRobotApplicationVersionResponseTypeDef:  # (1)
    ...

1. See CreateRobotApplicationVersionResponseTypeDef

# create_robot_application_version method usage example with argument unpacking

kwargs: CreateRobotApplicationVersionRequestTypeDef = {  # (1)
    "application": ...,
}

parent.create_robot_application_version(**kwargs)

1. See CreateRobotApplicationVersionRequestTypeDef

create_simulation_application

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").create_simulation_application method. boto3 documentation

# create_simulation_application method definition

def create_simulation_application(
    self,
    *,
    name: str,
    simulationSoftwareSuite: SimulationSoftwareSuiteTypeDef,  # (1)
    robotSoftwareSuite: RobotSoftwareSuiteTypeDef,  # (2)
    sources: Sequence[SourceConfigTypeDef] = ...,  # (3)
    renderingEngine: RenderingEngineTypeDef = ...,  # (4)
    tags: Mapping[str, str] = ...,
    environment: EnvironmentTypeDef = ...,  # (5)
) -> CreateSimulationApplicationResponseTypeDef:  # (6)
    ...

1. See SimulationSoftwareSuiteTypeDef
2. See RobotSoftwareSuiteTypeDef
3. See Sequence[SourceConfigTypeDef]
4. See RenderingEngineTypeDef
5. See EnvironmentTypeDef
6. See CreateSimulationApplicationResponseTypeDef

# create_simulation_application method usage example with argument unpacking

kwargs: CreateSimulationApplicationRequestTypeDef = {  # (1)
    "name": ...,
    "simulationSoftwareSuite": ...,
    "robotSoftwareSuite": ...,
}

parent.create_simulation_application(**kwargs)

1. See CreateSimulationApplicationRequestTypeDef

create_simulation_application_version

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").create_simulation_application_version method. boto3 documentation

# create_simulation_application_version method definition

def create_simulation_application_version(
    self,
    *,
    application: str,
    currentRevisionId: str = ...,
    s3Etags: Sequence[str] = ...,
    imageDigest: str = ...,
) -> CreateSimulationApplicationVersionResponseTypeDef:  # (1)
    ...

1. See CreateSimulationApplicationVersionResponseTypeDef

# create_simulation_application_version method usage example with argument unpacking

kwargs: CreateSimulationApplicationVersionRequestTypeDef = {  # (1)
    "application": ...,
}

parent.create_simulation_application_version(**kwargs)

1. See CreateSimulationApplicationVersionRequestTypeDef

create_simulation_job

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").create_simulation_job method. boto3 documentation

# create_simulation_job method definition

def create_simulation_job(
    self,
    *,
    maxJobDurationInSeconds: int,
    iamRole: str,
    clientRequestToken: str = ...,
    outputLocation: OutputLocationTypeDef = ...,  # (1)
    loggingConfig: LoggingConfigTypeDef = ...,  # (2)
    failureBehavior: FailureBehaviorType = ...,  # (3)
    robotApplications: Sequence[RobotApplicationConfigUnionTypeDef] = ...,  # (4)
    simulationApplications: Sequence[SimulationApplicationConfigUnionTypeDef] = ...,  # (5)
    dataSources: Sequence[DataSourceConfigUnionTypeDef] = ...,  # (6)
    tags: Mapping[str, str] = ...,
    vpcConfig: VPCConfigUnionTypeDef = ...,  # (7)
    compute: ComputeTypeDef = ...,  # (8)
) -> CreateSimulationJobResponseTypeDef:  # (9)
    ...

1. See OutputLocationTypeDef
2. See LoggingConfigTypeDef
3. See FailureBehaviorType
4. See Sequence[RobotApplicationConfigUnionTypeDef]
5. See Sequence[SimulationApplicationConfigUnionTypeDef]
6. See Sequence[DataSourceConfigUnionTypeDef]
7. See VPCConfigUnionTypeDef
8. See ComputeTypeDef
9. See CreateSimulationJobResponseTypeDef

# create_simulation_job method usage example with argument unpacking

kwargs: CreateSimulationJobRequestTypeDef = {  # (1)
    "maxJobDurationInSeconds": ...,
    "iamRole": ...,
}

parent.create_simulation_job(**kwargs)

1. See CreateSimulationJobRequestTypeDef

create_world_export_job

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").create_world_export_job method. boto3 documentation

# create_world_export_job method definition

def create_world_export_job(
    self,
    *,
    worlds: Sequence[str],
    outputLocation: OutputLocationTypeDef,  # (1)
    iamRole: str,
    clientRequestToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateWorldExportJobResponseTypeDef:  # (2)
    ...

1. See OutputLocationTypeDef
2. See CreateWorldExportJobResponseTypeDef

# create_world_export_job method usage example with argument unpacking

kwargs: CreateWorldExportJobRequestTypeDef = {  # (1)
    "worlds": ...,
    "outputLocation": ...,
    "iamRole": ...,
}

parent.create_world_export_job(**kwargs)

1. See CreateWorldExportJobRequestTypeDef

create_world_generation_job

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").create_world_generation_job method. boto3 documentation

# create_world_generation_job method definition

def create_world_generation_job(
    self,
    *,
    template: str,
    worldCount: WorldCountTypeDef,  # (1)
    clientRequestToken: str = ...,
    tags: Mapping[str, str] = ...,
    worldTags: Mapping[str, str] = ...,
) -> CreateWorldGenerationJobResponseTypeDef:  # (2)
    ...

1. See WorldCountTypeDef
2. See CreateWorldGenerationJobResponseTypeDef

# create_world_generation_job method usage example with argument unpacking

kwargs: CreateWorldGenerationJobRequestTypeDef = {  # (1)
    "template": ...,
    "worldCount": ...,
}

parent.create_world_generation_job(**kwargs)

1. See CreateWorldGenerationJobRequestTypeDef

create_world_template

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").create_world_template method. boto3 documentation

# create_world_template method definition

def create_world_template(
    self,
    *,
    clientRequestToken: str = ...,
    name: str = ...,
    templateBody: str = ...,
    templateLocation: TemplateLocationTypeDef = ...,  # (1)
    tags: Mapping[str, str] = ...,
) -> CreateWorldTemplateResponseTypeDef:  # (2)
    ...

1. See TemplateLocationTypeDef
2. See CreateWorldTemplateResponseTypeDef

# create_world_template method usage example with argument unpacking

kwargs: CreateWorldTemplateRequestTypeDef = {  # (1)
    "clientRequestToken": ...,
}

parent.create_world_template(**kwargs)

1. See CreateWorldTemplateRequestTypeDef

delete_fleet

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").delete_fleet method. boto3 documentation

# delete_fleet method definition

def delete_fleet(
    self,
    *,
    fleet: str,
) -> Dict[str, Any]:
    ...

# delete_fleet method usage example with argument unpacking

kwargs: DeleteFleetRequestTypeDef = {  # (1)
    "fleet": ...,
}

parent.delete_fleet(**kwargs)

1. See DeleteFleetRequestTypeDef

delete_robot

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").delete_robot method. boto3 documentation

# delete_robot method definition

def delete_robot(
    self,
    *,
    robot: str,
) -> Dict[str, Any]:
    ...

# delete_robot method usage example with argument unpacking

kwargs: DeleteRobotRequestTypeDef = {  # (1)
    "robot": ...,
}

parent.delete_robot(**kwargs)

1. See DeleteRobotRequestTypeDef

delete_robot_application

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").delete_robot_application method. boto3 documentation

# delete_robot_application method definition

def delete_robot_application(
    self,
    *,
    application: str,
    applicationVersion: str = ...,
) -> Dict[str, Any]:
    ...

# delete_robot_application method usage example with argument unpacking

kwargs: DeleteRobotApplicationRequestTypeDef = {  # (1)
    "application": ...,
}

parent.delete_robot_application(**kwargs)

1. See DeleteRobotApplicationRequestTypeDef

delete_simulation_application

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").delete_simulation_application method. boto3 documentation

# delete_simulation_application method definition

def delete_simulation_application(
    self,
    *,
    application: str,
    applicationVersion: str = ...,
) -> Dict[str, Any]:
    ...

# delete_simulation_application method usage example with argument unpacking

kwargs: DeleteSimulationApplicationRequestTypeDef = {  # (1)
    "application": ...,
}

parent.delete_simulation_application(**kwargs)

1. See DeleteSimulationApplicationRequestTypeDef

delete_world_template

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").delete_world_template method. boto3 documentation

# delete_world_template method definition

def delete_world_template(
    self,
    *,
    template: str,
) -> Dict[str, Any]:
    ...

# delete_world_template method usage example with argument unpacking

kwargs: DeleteWorldTemplateRequestTypeDef = {  # (1)
    "template": ...,
}

parent.delete_world_template(**kwargs)

1. See DeleteWorldTemplateRequestTypeDef

deregister_robot

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").deregister_robot method. boto3 documentation

# deregister_robot method definition

def deregister_robot(
    self,
    *,
    fleet: str,
    robot: str,
) -> DeregisterRobotResponseTypeDef:  # (1)
    ...

1. See DeregisterRobotResponseTypeDef

# deregister_robot method usage example with argument unpacking

kwargs: DeregisterRobotRequestTypeDef = {  # (1)
    "fleet": ...,
    "robot": ...,
}

parent.deregister_robot(**kwargs)

1. See DeregisterRobotRequestTypeDef

describe_deployment_job

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").describe_deployment_job method. boto3 documentation

# describe_deployment_job method definition

def describe_deployment_job(
    self,
    *,
    job: str,
) -> DescribeDeploymentJobResponseTypeDef:  # (1)
    ...

1. See DescribeDeploymentJobResponseTypeDef

# describe_deployment_job method usage example with argument unpacking

kwargs: DescribeDeploymentJobRequestTypeDef = {  # (1)
    "job": ...,
}

parent.describe_deployment_job(**kwargs)

1. See DescribeDeploymentJobRequestTypeDef

describe_fleet

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").describe_fleet method. boto3 documentation

# describe_fleet method definition

def describe_fleet(
    self,
    *,
    fleet: str,
) -> DescribeFleetResponseTypeDef:  # (1)
    ...

1. See DescribeFleetResponseTypeDef

# describe_fleet method usage example with argument unpacking

kwargs: DescribeFleetRequestTypeDef = {  # (1)
    "fleet": ...,
}

parent.describe_fleet(**kwargs)

1. See DescribeFleetRequestTypeDef

describe_robot

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").describe_robot method. boto3 documentation

# describe_robot method definition

def describe_robot(
    self,
    *,
    robot: str,
) -> DescribeRobotResponseTypeDef:  # (1)
    ...

1. See DescribeRobotResponseTypeDef

# describe_robot method usage example with argument unpacking

kwargs: DescribeRobotRequestTypeDef = {  # (1)
    "robot": ...,
}

parent.describe_robot(**kwargs)

1. See DescribeRobotRequestTypeDef

describe_robot_application

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").describe_robot_application method. boto3 documentation

# describe_robot_application method definition

def describe_robot_application(
    self,
    *,
    application: str,
    applicationVersion: str = ...,
) -> DescribeRobotApplicationResponseTypeDef:  # (1)
    ...

1. See DescribeRobotApplicationResponseTypeDef

# describe_robot_application method usage example with argument unpacking

kwargs: DescribeRobotApplicationRequestTypeDef = {  # (1)
    "application": ...,
}

parent.describe_robot_application(**kwargs)

1. See DescribeRobotApplicationRequestTypeDef

describe_simulation_application

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").describe_simulation_application method. boto3 documentation

# describe_simulation_application method definition

def describe_simulation_application(
    self,
    *,
    application: str,
    applicationVersion: str = ...,
) -> DescribeSimulationApplicationResponseTypeDef:  # (1)
    ...

1. See DescribeSimulationApplicationResponseTypeDef

# describe_simulation_application method usage example with argument unpacking

kwargs: DescribeSimulationApplicationRequestTypeDef = {  # (1)
    "application": ...,
}

parent.describe_simulation_application(**kwargs)

1. See DescribeSimulationApplicationRequestTypeDef

describe_simulation_job

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").describe_simulation_job method. boto3 documentation

# describe_simulation_job method definition

def describe_simulation_job(
    self,
    *,
    job: str,
) -> DescribeSimulationJobResponseTypeDef:  # (1)
    ...

1. See DescribeSimulationJobResponseTypeDef

# describe_simulation_job method usage example with argument unpacking

kwargs: DescribeSimulationJobRequestTypeDef = {  # (1)
    "job": ...,
}

parent.describe_simulation_job(**kwargs)

1. See DescribeSimulationJobRequestTypeDef

describe_simulation_job_batch

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").describe_simulation_job_batch method. boto3 documentation

# describe_simulation_job_batch method definition

def describe_simulation_job_batch(
    self,
    *,
    batch: str,
) -> DescribeSimulationJobBatchResponseTypeDef:  # (1)
    ...

1. See DescribeSimulationJobBatchResponseTypeDef

# describe_simulation_job_batch method usage example with argument unpacking

kwargs: DescribeSimulationJobBatchRequestTypeDef = {  # (1)
    "batch": ...,
}

parent.describe_simulation_job_batch(**kwargs)

1. See DescribeSimulationJobBatchRequestTypeDef

describe_world

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").describe_world method. boto3 documentation

# describe_world method definition

def describe_world(
    self,
    *,
    world: str,
) -> DescribeWorldResponseTypeDef:  # (1)
    ...

1. See DescribeWorldResponseTypeDef

# describe_world method usage example with argument unpacking

kwargs: DescribeWorldRequestTypeDef = {  # (1)
    "world": ...,
}

parent.describe_world(**kwargs)

1. See DescribeWorldRequestTypeDef

describe_world_export_job

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").describe_world_export_job method. boto3 documentation

# describe_world_export_job method definition

def describe_world_export_job(
    self,
    *,
    job: str,
) -> DescribeWorldExportJobResponseTypeDef:  # (1)
    ...

1. See DescribeWorldExportJobResponseTypeDef

# describe_world_export_job method usage example with argument unpacking

kwargs: DescribeWorldExportJobRequestTypeDef = {  # (1)
    "job": ...,
}

parent.describe_world_export_job(**kwargs)

1. See DescribeWorldExportJobRequestTypeDef

describe_world_generation_job

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").describe_world_generation_job method. boto3 documentation

# describe_world_generation_job method definition

def describe_world_generation_job(
    self,
    *,
    job: str,
) -> DescribeWorldGenerationJobResponseTypeDef:  # (1)
    ...

1. See DescribeWorldGenerationJobResponseTypeDef

# describe_world_generation_job method usage example with argument unpacking

kwargs: DescribeWorldGenerationJobRequestTypeDef = {  # (1)
    "job": ...,
}

parent.describe_world_generation_job(**kwargs)

1. See DescribeWorldGenerationJobRequestTypeDef

describe_world_template

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").describe_world_template method. boto3 documentation

# describe_world_template method definition

def describe_world_template(
    self,
    *,
    template: str,
) -> DescribeWorldTemplateResponseTypeDef:  # (1)
    ...

1. See DescribeWorldTemplateResponseTypeDef

# describe_world_template method usage example with argument unpacking

kwargs: DescribeWorldTemplateRequestTypeDef = {  # (1)
    "template": ...,
}

parent.describe_world_template(**kwargs)

1. See DescribeWorldTemplateRequestTypeDef

get_world_template_body

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").get_world_template_body method. boto3 documentation

# get_world_template_body method definition

def get_world_template_body(
    self,
    *,
    template: str = ...,
    generationJob: str = ...,
) -> GetWorldTemplateBodyResponseTypeDef:  # (1)
    ...

1. See GetWorldTemplateBodyResponseTypeDef

# get_world_template_body method usage example with argument unpacking

kwargs: GetWorldTemplateBodyRequestTypeDef = {  # (1)
    "template": ...,
}

parent.get_world_template_body(**kwargs)

1. See GetWorldTemplateBodyRequestTypeDef

list_deployment_jobs

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").list_deployment_jobs method. boto3 documentation

# list_deployment_jobs method definition

def list_deployment_jobs(
    self,
    *,
    filters: Sequence[FilterTypeDef] = ...,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListDeploymentJobsResponseTypeDef:  # (2)
    ...

1. See Sequence[FilterTypeDef]
2. See ListDeploymentJobsResponseTypeDef

# list_deployment_jobs method usage example with argument unpacking

kwargs: ListDeploymentJobsRequestTypeDef = {  # (1)
    "filters": ...,
}

parent.list_deployment_jobs(**kwargs)

1. See ListDeploymentJobsRequestTypeDef

list_fleets

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").list_fleets method. boto3 documentation

# list_fleets method definition

def list_fleets(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
    filters: Sequence[FilterTypeDef] = ...,  # (1)
) -> ListFleetsResponseTypeDef:  # (2)
    ...

1. See Sequence[FilterTypeDef]
2. See ListFleetsResponseTypeDef

# list_fleets method usage example with argument unpacking

kwargs: ListFleetsRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_fleets(**kwargs)

1. See ListFleetsRequestTypeDef

list_robot_applications

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").list_robot_applications method. boto3 documentation

# list_robot_applications method definition

def list_robot_applications(
    self,
    *,
    versionQualifier: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
    filters: Sequence[FilterTypeDef] = ...,  # (1)
) -> ListRobotApplicationsResponseTypeDef:  # (2)
    ...

1. See Sequence[FilterTypeDef]
2. See ListRobotApplicationsResponseTypeDef

# list_robot_applications method usage example with argument unpacking

kwargs: ListRobotApplicationsRequestTypeDef = {  # (1)
    "versionQualifier": ...,
}

parent.list_robot_applications(**kwargs)

1. See ListRobotApplicationsRequestTypeDef

list_robots

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").list_robots method. boto3 documentation

# list_robots method definition

def list_robots(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
    filters: Sequence[FilterTypeDef] = ...,  # (1)
) -> ListRobotsResponseTypeDef:  # (2)
    ...

1. See Sequence[FilterTypeDef]
2. See ListRobotsResponseTypeDef

# list_robots method usage example with argument unpacking

kwargs: ListRobotsRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_robots(**kwargs)

1. See ListRobotsRequestTypeDef

list_simulation_applications

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").list_simulation_applications method. boto3 documentation

# list_simulation_applications method definition

def list_simulation_applications(
    self,
    *,
    versionQualifier: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
    filters: Sequence[FilterTypeDef] = ...,  # (1)
) -> ListSimulationApplicationsResponseTypeDef:  # (2)
    ...

1. See Sequence[FilterTypeDef]
2. See ListSimulationApplicationsResponseTypeDef

# list_simulation_applications method usage example with argument unpacking

kwargs: ListSimulationApplicationsRequestTypeDef = {  # (1)
    "versionQualifier": ...,
}

parent.list_simulation_applications(**kwargs)

1. See ListSimulationApplicationsRequestTypeDef

list_simulation_job_batches

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").list_simulation_job_batches method. boto3 documentation

# list_simulation_job_batches method definition

def list_simulation_job_batches(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
    filters: Sequence[FilterTypeDef] = ...,  # (1)
) -> ListSimulationJobBatchesResponseTypeDef:  # (2)
    ...

1. See Sequence[FilterTypeDef]
2. See ListSimulationJobBatchesResponseTypeDef

# list_simulation_job_batches method usage example with argument unpacking

kwargs: ListSimulationJobBatchesRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_simulation_job_batches(**kwargs)

1. See ListSimulationJobBatchesRequestTypeDef

list_simulation_jobs

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").list_simulation_jobs method. boto3 documentation

# list_simulation_jobs method definition

def list_simulation_jobs(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
    filters: Sequence[FilterTypeDef] = ...,  # (1)
) -> ListSimulationJobsResponseTypeDef:  # (2)
    ...

1. See Sequence[FilterTypeDef]
2. See ListSimulationJobsResponseTypeDef

# list_simulation_jobs method usage example with argument unpacking

kwargs: ListSimulationJobsRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_simulation_jobs(**kwargs)

1. See ListSimulationJobsRequestTypeDef

list_tags_for_resource

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestTypeDef

list_world_export_jobs

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").list_world_export_jobs method. boto3 documentation

# list_world_export_jobs method definition

def list_world_export_jobs(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
    filters: Sequence[FilterTypeDef] = ...,  # (1)
) -> ListWorldExportJobsResponseTypeDef:  # (2)
    ...

1. See Sequence[FilterTypeDef]
2. See ListWorldExportJobsResponseTypeDef

# list_world_export_jobs method usage example with argument unpacking

kwargs: ListWorldExportJobsRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_world_export_jobs(**kwargs)

1. See ListWorldExportJobsRequestTypeDef

list_world_generation_jobs

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").list_world_generation_jobs method. boto3 documentation

# list_world_generation_jobs method definition

def list_world_generation_jobs(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
    filters: Sequence[FilterTypeDef] = ...,  # (1)
) -> ListWorldGenerationJobsResponseTypeDef:  # (2)
    ...

1. See Sequence[FilterTypeDef]
2. See ListWorldGenerationJobsResponseTypeDef

# list_world_generation_jobs method usage example with argument unpacking

kwargs: ListWorldGenerationJobsRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_world_generation_jobs(**kwargs)

1. See ListWorldGenerationJobsRequestTypeDef

list_world_templates

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").list_world_templates method. boto3 documentation

# list_world_templates method definition

def list_world_templates(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListWorldTemplatesResponseTypeDef:  # (1)
    ...

1. See ListWorldTemplatesResponseTypeDef

# list_world_templates method usage example with argument unpacking

kwargs: ListWorldTemplatesRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_world_templates(**kwargs)

1. See ListWorldTemplatesRequestTypeDef

list_worlds

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").list_worlds method. boto3 documentation

# list_worlds method definition

def list_worlds(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
    filters: Sequence[FilterTypeDef] = ...,  # (1)
) -> ListWorldsResponseTypeDef:  # (2)
    ...

1. See Sequence[FilterTypeDef]
2. See ListWorldsResponseTypeDef

# list_worlds method usage example with argument unpacking

kwargs: ListWorldsRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_worlds(**kwargs)

1. See ListWorldsRequestTypeDef

register_robot

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").register_robot method. boto3 documentation

# register_robot method definition

def register_robot(
    self,
    *,
    fleet: str,
    robot: str,
) -> RegisterRobotResponseTypeDef:  # (1)
    ...

1. See RegisterRobotResponseTypeDef

# register_robot method usage example with argument unpacking

kwargs: RegisterRobotRequestTypeDef = {  # (1)
    "fleet": ...,
    "robot": ...,
}

parent.register_robot(**kwargs)

1. See RegisterRobotRequestTypeDef

restart_simulation_job

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").restart_simulation_job method. boto3 documentation

# restart_simulation_job method definition

def restart_simulation_job(
    self,
    *,
    job: str,
) -> Dict[str, Any]:
    ...

# restart_simulation_job method usage example with argument unpacking

kwargs: RestartSimulationJobRequestTypeDef = {  # (1)
    "job": ...,
}

parent.restart_simulation_job(**kwargs)

1. See RestartSimulationJobRequestTypeDef

start_simulation_job_batch

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").start_simulation_job_batch method. boto3 documentation

# start_simulation_job_batch method definition

def start_simulation_job_batch(
    self,
    *,
    createSimulationJobRequests: Sequence[SimulationJobRequestUnionTypeDef],  # (1)
    clientRequestToken: str = ...,
    batchPolicy: BatchPolicyTypeDef = ...,  # (2)
    tags: Mapping[str, str] = ...,
) -> StartSimulationJobBatchResponseTypeDef:  # (3)
    ...

1. See Sequence[SimulationJobRequestUnionTypeDef]
2. See BatchPolicyTypeDef
3. See StartSimulationJobBatchResponseTypeDef

# start_simulation_job_batch method usage example with argument unpacking

kwargs: StartSimulationJobBatchRequestTypeDef = {  # (1)
    "createSimulationJobRequests": ...,
}

parent.start_simulation_job_batch(**kwargs)

1. See StartSimulationJobBatchRequestTypeDef

sync_deployment_job

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").sync_deployment_job method. boto3 documentation

# sync_deployment_job method definition

def sync_deployment_job(
    self,
    *,
    clientRequestToken: str,
    fleet: str,
) -> SyncDeploymentJobResponseTypeDef:  # (1)
    ...

1. See SyncDeploymentJobResponseTypeDef

# sync_deployment_job method usage example with argument unpacking

kwargs: SyncDeploymentJobRequestTypeDef = {  # (1)
    "clientRequestToken": ...,
    "fleet": ...,
}

parent.sync_deployment_job(**kwargs)

1. See SyncDeploymentJobRequestTypeDef

tag_resource

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

untag_resource

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestTypeDef

update_robot_application

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").update_robot_application method. boto3 documentation

# update_robot_application method definition

def update_robot_application(
    self,
    *,
    application: str,
    robotSoftwareSuite: RobotSoftwareSuiteTypeDef,  # (1)
    sources: Sequence[SourceConfigTypeDef] = ...,  # (2)
    currentRevisionId: str = ...,
    environment: EnvironmentTypeDef = ...,  # (3)
) -> UpdateRobotApplicationResponseTypeDef:  # (4)
    ...

1. See RobotSoftwareSuiteTypeDef
2. See Sequence[SourceConfigTypeDef]
3. See EnvironmentTypeDef
4. See UpdateRobotApplicationResponseTypeDef

# update_robot_application method usage example with argument unpacking

kwargs: UpdateRobotApplicationRequestTypeDef = {  # (1)
    "application": ...,
    "robotSoftwareSuite": ...,
}

parent.update_robot_application(**kwargs)

1. See UpdateRobotApplicationRequestTypeDef

update_simulation_application

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").update_simulation_application method. boto3 documentation

# update_simulation_application method definition

def update_simulation_application(
    self,
    *,
    application: str,
    simulationSoftwareSuite: SimulationSoftwareSuiteTypeDef,  # (1)
    robotSoftwareSuite: RobotSoftwareSuiteTypeDef,  # (2)
    sources: Sequence[SourceConfigTypeDef] = ...,  # (3)
    renderingEngine: RenderingEngineTypeDef = ...,  # (4)
    currentRevisionId: str = ...,
    environment: EnvironmentTypeDef = ...,  # (5)
) -> UpdateSimulationApplicationResponseTypeDef:  # (6)
    ...

1. See SimulationSoftwareSuiteTypeDef
2. See RobotSoftwareSuiteTypeDef
3. See Sequence[SourceConfigTypeDef]
4. See RenderingEngineTypeDef
5. See EnvironmentTypeDef
6. See UpdateSimulationApplicationResponseTypeDef

# update_simulation_application method usage example with argument unpacking

kwargs: UpdateSimulationApplicationRequestTypeDef = {  # (1)
    "application": ...,
    "simulationSoftwareSuite": ...,
    "robotSoftwareSuite": ...,
}

parent.update_simulation_application(**kwargs)

1. See UpdateSimulationApplicationRequestTypeDef

update_world_template

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker.

Type annotations and code completion for boto3.client("robomaker").update_world_template method. boto3 documentation

# update_world_template method definition

def update_world_template(
    self,
    *,
    template: str,
    name: str = ...,
    templateBody: str = ...,
    templateLocation: TemplateLocationTypeDef = ...,  # (1)
) -> UpdateWorldTemplateResponseTypeDef:  # (2)
    ...

1. See TemplateLocationTypeDef
2. See UpdateWorldTemplateResponseTypeDef

# update_world_template method usage example with argument unpacking

kwargs: UpdateWorldTemplateRequestTypeDef = {  # (1)
    "template": ...,
}

parent.update_world_template(**kwargs)

1. See UpdateWorldTemplateRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("robomaker").get_paginator method with overloads.

• client.get_paginator("list_deployment_jobs") -> ListDeploymentJobsPaginator
• client.get_paginator("list_fleets") -> ListFleetsPaginator
• client.get_paginator("list_robot_applications") -> ListRobotApplicationsPaginator
• client.get_paginator("list_robots") -> ListRobotsPaginator
• client.get_paginator("list_simulation_applications") -> ListSimulationApplicationsPaginator
• client.get_paginator("list_simulation_job_batches") -> ListSimulationJobBatchesPaginator
• client.get_paginator("list_simulation_jobs") -> ListSimulationJobsPaginator
• client.get_paginator("list_world_export_jobs") -> ListWorldExportJobsPaginator
• client.get_paginator("list_world_generation_jobs") -> ListWorldGenerationJobsPaginator
• client.get_paginator("list_world_templates") -> ListWorldTemplatesPaginator
• client.get_paginator("list_worlds") -> ListWorldsPaginator