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#
batch_delete_worlds#
Deletes one or more worlds in a batch operation.
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)
...
# batch_delete_worlds method usage example with argument unpacking
kwargs: BatchDeleteWorldsRequestRequestTypeDef = { # (1)
"worlds": ...,
}
parent.batch_delete_worlds(**kwargs)
batch_describe_simulation_job#
Describes one or more simulation jobs.
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)
...
# batch_describe_simulation_job method usage example with argument unpacking
kwargs: BatchDescribeSimulationJobRequestRequestTypeDef = { # (1)
"jobs": ...,
}
parent.batch_describe_simulation_job(**kwargs)
can_paginate#
Check if an operation can be paginated.
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:
...
cancel_deployment_job#
Cancels the specified deployment job.
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: CancelDeploymentJobRequestRequestTypeDef = { # (1)
"job": ...,
}
parent.cancel_deployment_job(**kwargs)
cancel_simulation_job#
Cancels the specified simulation job.
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: CancelSimulationJobRequestRequestTypeDef = { # (1)
"job": ...,
}
parent.cancel_simulation_job(**kwargs)
cancel_simulation_job_batch#
Cancels a simulation job batch.
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: CancelSimulationJobBatchRequestRequestTypeDef = { # (1)
"batch": ...,
}
parent.cancel_simulation_job_batch(**kwargs)
cancel_world_export_job#
Cancels the specified export job.
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: CancelWorldExportJobRequestRequestTypeDef = { # (1)
"job": ...,
}
parent.cancel_world_export_job(**kwargs)
cancel_world_generation_job#
Cancels the specified world generator job.
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: CancelWorldGenerationJobRequestRequestTypeDef = { # (1)
"job": ...,
}
parent.cancel_world_generation_job(**kwargs)
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("robomaker").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
create_deployment_job#
Deploys a specific version of a robot application to robots in a fleet.
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[DeploymentApplicationConfigTypeDef], # (1)
deploymentConfig: DeploymentConfigTypeDef = ..., # (2)
tags: Mapping[str, str] = ...,
) -> CreateDeploymentJobResponseTypeDef: # (3)
...
- See DeploymentApplicationConfigTypeDef
- See DeploymentConfigTypeDef
- See CreateDeploymentJobResponseTypeDef
# create_deployment_job method usage example with argument unpacking
kwargs: CreateDeploymentJobRequestRequestTypeDef = { # (1)
"clientRequestToken": ...,
"fleet": ...,
"deploymentApplicationConfigs": ...,
}
parent.create_deployment_job(**kwargs)
create_fleet#
Creates a fleet, a logical group of robots running the same robot application.
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)
...
# create_fleet method usage example with argument unpacking
kwargs: CreateFleetRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.create_fleet(**kwargs)
create_robot#
Creates a robot.
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)
...
# create_robot method usage example with argument unpacking
kwargs: CreateRobotRequestRequestTypeDef = { # (1)
"name": ...,
"architecture": ...,
"greengrassGroupId": ...,
}
parent.create_robot(**kwargs)
create_robot_application#
Creates a robot application.
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)
...
- See RobotSoftwareSuiteTypeDef
- See SourceConfigTypeDef
- See EnvironmentTypeDef
- See CreateRobotApplicationResponseTypeDef
# create_robot_application method usage example with argument unpacking
kwargs: CreateRobotApplicationRequestRequestTypeDef = { # (1)
"name": ...,
"robotSoftwareSuite": ...,
}
parent.create_robot_application(**kwargs)
create_robot_application_version#
Creates a version of a robot application.
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)
...
# create_robot_application_version method usage example with argument unpacking
kwargs: CreateRobotApplicationVersionRequestRequestTypeDef = { # (1)
"application": ...,
}
parent.create_robot_application_version(**kwargs)
create_simulation_application#
Creates a simulation application.
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)
...
- See SimulationSoftwareSuiteTypeDef
- See RobotSoftwareSuiteTypeDef
- See SourceConfigTypeDef
- See RenderingEngineTypeDef
- See EnvironmentTypeDef
- See CreateSimulationApplicationResponseTypeDef
# create_simulation_application method usage example with argument unpacking
kwargs: CreateSimulationApplicationRequestRequestTypeDef = { # (1)
"name": ...,
"simulationSoftwareSuite": ...,
"robotSoftwareSuite": ...,
}
parent.create_simulation_application(**kwargs)
create_simulation_application_version#
Creates a simulation application with a specific revision id.
Type annotations and code completion for boto3.client("robomaker").create_simulation_application_version
method.