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

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.

Usage example

client = boto3.client("robomaker")

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

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

Method definition

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

1. See BatchDeleteWorldsResponseTypeDef

Usage example with kwargs

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

parent.batch_delete_worlds(**kwargs)

1. See BatchDeleteWorldsRequestRequestTypeDef

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

Method definition

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

1. See BatchDescribeSimulationJobResponseTypeDef

Usage example with kwargs

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

parent.batch_describe_simulation_job(**kwargs)

1. See BatchDescribeSimulationJobRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

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

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

Method definition

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

Usage example with kwargs

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

parent.cancel_deployment_job(**kwargs)

1. See CancelDeploymentJobRequestRequestTypeDef

cancel_simulation_job

Cancels the specified simulation job.

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

Method definition

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

Usage example with kwargs

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

parent.cancel_simulation_job(**kwargs)

1. See CancelSimulationJobRequestRequestTypeDef

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

Method definition

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

Usage example with kwargs

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

parent.cancel_simulation_job_batch(**kwargs)

1. See CancelSimulationJobBatchRequestRequestTypeDef

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

Method definition

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

Usage example with kwargs

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

parent.cancel_world_export_job(**kwargs)

1. See CancelWorldExportJobRequestRequestTypeDef

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

Method definition

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

Usage example with kwargs

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

parent.cancel_world_generation_job(**kwargs)

1. See CancelWorldGenerationJobRequestRequestTypeDef

close

Closes underlying endpoint connections.

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

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

Method definition

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

1. See DeploymentApplicationConfigTypeDef
2. See DeploymentConfigTypeDef
3. See CreateDeploymentJobResponseTypeDef

Usage example with kwargs

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

parent.create_deployment_job(**kwargs)

1. See CreateDeploymentJobRequestRequestTypeDef

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

Method definition

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

1. See CreateFleetResponseTypeDef

Usage example with kwargs

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

parent.create_fleet(**kwargs)

1. See CreateFleetRequestRequestTypeDef

create_robot

Creates a robot.

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

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

Usage example with kwargs

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

parent.create_robot(**kwargs)

1. See CreateRobotRequestRequestTypeDef

create_robot_application

Creates a robot application.

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

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 SourceConfigTypeDef
3. See EnvironmentTypeDef
4. See CreateRobotApplicationResponseTypeDef

Usage example with kwargs

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

parent.create_robot_application(**kwargs)

1. See CreateRobotApplicationRequestRequestTypeDef

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

Method definition

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

1. See CreateRobotApplicationVersionResponseTypeDef

Usage example with kwargs

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

parent.create_robot_application_version(**kwargs)

1. See CreateRobotApplicationVersionRequestRequestTypeDef

create_simulation_application

Creates a simulation application.

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

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 SourceConfigTypeDef
4. See RenderingEngineTypeDef
5. See EnvironmentTypeDef
6. See CreateSimulationApplicationResponseTypeDef

Usage example with kwargs

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

parent.create_simulation_application(**kwargs)

1. See CreateSimulationApplicationRequestRequestTypeDef

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. boto3 documentation

Method definition

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

1. See CreateSimulationApplicationVersionResponseTypeDef

Usage example with kwargs

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

parent.create_simulation_application_version(**kwargs)

1. See CreateSimulationApplicationVersionRequestRequestTypeDef

create_simulation_job

Creates a simulation job.

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

Method definition

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

1. See OutputLocationTypeDef
2. See LoggingConfigTypeDef
3. See FailureBehaviorType
4. See RobotApplicationConfigTypeDef
5. See SimulationApplicationConfigTypeDef
6. See DataSourceConfigTypeDef
7. See VPCConfigTypeDef
8. See ComputeTypeDef
9. See CreateSimulationJobResponseTypeDef

Usage example with kwargs

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

parent.create_simulation_job(**kwargs)

1. See CreateSimulationJobRequestRequestTypeDef

create_world_export_job

Creates a world export job.

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

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

Usage example with kwargs

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

parent.create_world_export_job(**kwargs)

1. See CreateWorldExportJobRequestRequestTypeDef

create_world_generation_job

Creates worlds using the specified template.

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

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

Usage example with kwargs

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

parent.create_world_generation_job(**kwargs)

1. See CreateWorldGenerationJobRequestRequestTypeDef

create_world_template

Creates a world template.

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

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

Usage example with kwargs

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

parent.create_world_template(**kwargs)

1. See CreateWorldTemplateRequestRequestTypeDef

delete_fleet

Deletes a fleet.

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

Method definition

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

Usage example with kwargs

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

parent.delete_fleet(**kwargs)

1. See DeleteFleetRequestRequestTypeDef

delete_robot

Deletes a robot.

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

Method definition

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

Usage example with kwargs

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

parent.delete_robot(**kwargs)

1. See DeleteRobotRequestRequestTypeDef

delete_robot_application

Deletes a robot application.

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

Method definition

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

Usage example with kwargs

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

parent.delete_robot_application(**kwargs)

1. See DeleteRobotApplicationRequestRequestTypeDef

delete_simulation_application

Deletes a simulation application.

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

Method definition

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

Usage example with kwargs

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

parent.delete_simulation_application(**kwargs)

1. See DeleteSimulationApplicationRequestRequestTypeDef

delete_world_template

Deletes a world template.

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

Method definition

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

Usage example with kwargs

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

parent.delete_world_template(**kwargs)

1. See DeleteWorldTemplateRequestRequestTypeDef

deregister_robot

Deregisters a robot.

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

Method definition

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

1. See DeregisterRobotResponseTypeDef

Usage example with kwargs

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

parent.deregister_robot(**kwargs)

1. See DeregisterRobotRequestRequestTypeDef

describe_deployment_job

Describes a deployment job.

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

Method definition

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

1. See DescribeDeploymentJobResponseTypeDef

Usage example with kwargs

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

parent.describe_deployment_job(**kwargs)

1. See DescribeDeploymentJobRequestRequestTypeDef

describe_fleet

Describes a fleet.

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

Method definition

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

1. See DescribeFleetResponseTypeDef

Usage example with kwargs

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

parent.describe_fleet(**kwargs)

1. See DescribeFleetRequestRequestTypeDef

describe_robot

Describes a robot.

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

Method definition

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

1. See DescribeRobotResponseTypeDef

Usage example with kwargs

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

parent.describe_robot(**kwargs)

1. See DescribeRobotRequestRequestTypeDef

describe_robot_application

Describes a robot application.

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

Method definition

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

1. See DescribeRobotApplicationResponseTypeDef

Usage example with kwargs

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

parent.describe_robot_application(**kwargs)

1. See DescribeRobotApplicationRequestRequestTypeDef

describe_simulation_application

Describes a simulation application.

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

Method definition

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

1. See DescribeSimulationApplicationResponseTypeDef

Usage example with kwargs

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

parent.describe_simulation_application(**kwargs)

1. See DescribeSimulationApplicationRequestRequestTypeDef

describe_simulation_job

Describes a simulation job.

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

Method definition

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

1. See DescribeSimulationJobResponseTypeDef

Usage example with kwargs

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

parent.describe_simulation_job(**kwargs)

1. See DescribeSimulationJobRequestRequestTypeDef

describe_simulation_job_batch

Describes a simulation job batch.

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

Method definition

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

1. See DescribeSimulationJobBatchResponseTypeDef

Usage example with kwargs

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

parent.describe_simulation_job_batch(**kwargs)

1. See DescribeSimulationJobBatchRequestRequestTypeDef

describe_world

Describes a world.

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

Method definition

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

1. See DescribeWorldResponseTypeDef

Usage example with kwargs

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

parent.describe_world(**kwargs)

1. See DescribeWorldRequestRequestTypeDef

describe_world_export_job

Describes a world export job.

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

Method definition

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

1. See DescribeWorldExportJobResponseTypeDef

Usage example with kwargs

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

parent.describe_world_export_job(**kwargs)

1. See DescribeWorldExportJobRequestRequestTypeDef

describe_world_generation_job

Describes a world generation job.

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

Method definition

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

1. See DescribeWorldGenerationJobResponseTypeDef

Usage example with kwargs

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

parent.describe_world_generation_job(**kwargs)

1. See DescribeWorldGenerationJobRequestRequestTypeDef

describe_world_template

Describes a world template.

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

Method definition

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

1. See DescribeWorldTemplateResponseTypeDef

Usage example with kwargs

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

parent.describe_world_template(**kwargs)

1. See DescribeWorldTemplateRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

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

Method definition

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

get_world_template_body

Gets the world template body.

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

Method definition

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

1. See GetWorldTemplateBodyResponseTypeDef

Usage example with kwargs

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

parent.get_world_template_body(**kwargs)

1. See GetWorldTemplateBodyRequestRequestTypeDef

list_deployment_jobs

Returns a list of deployment jobs for a fleet.

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

Method definition

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

1. See FilterTypeDef
2. See ListDeploymentJobsResponseTypeDef

Usage example with kwargs

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

parent.list_deployment_jobs(**kwargs)

1. See ListDeploymentJobsRequestRequestTypeDef

list_fleets

Returns a list of fleets.

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

Method definition

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

1. See FilterTypeDef
2. See ListFleetsResponseTypeDef

Usage example with kwargs

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

parent.list_fleets(**kwargs)

1. See ListFleetsRequestRequestTypeDef

list_robot_applications

Returns a list of robot application.

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

Method definition

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

1. See FilterTypeDef
2. See ListRobotApplicationsResponseTypeDef

Usage example with kwargs

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

parent.list_robot_applications(**kwargs)

1. See ListRobotApplicationsRequestRequestTypeDef

list_robots

Returns a list of robots.

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

Method definition

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

1. See FilterTypeDef
2. See ListRobotsResponseTypeDef

Usage example with kwargs

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

parent.list_robots(**kwargs)

1. See ListRobotsRequestRequestTypeDef

list_simulation_applications

Returns a list of simulation applications.

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

Method definition

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

1. See FilterTypeDef
2. See ListSimulationApplicationsResponseTypeDef

Usage example with kwargs

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

parent.list_simulation_applications(**kwargs)

1. See ListSimulationApplicationsRequestRequestTypeDef

list_simulation_job_batches

Returns a list simulation job batches.

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

Method definition

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

1. See FilterTypeDef
2. See ListSimulationJobBatchesResponseTypeDef

Usage example with kwargs

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

parent.list_simulation_job_batches(**kwargs)

1. See ListSimulationJobBatchesRequestRequestTypeDef

list_simulation_jobs

Returns a list of simulation jobs.

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

Method definition

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

1. See FilterTypeDef
2. See ListSimulationJobsResponseTypeDef

Usage example with kwargs

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

parent.list_simulation_jobs(**kwargs)

1. See ListSimulationJobsRequestRequestTypeDef

list_tags_for_resource

Lists all tags on a AWS RoboMaker resource.

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

Method definition

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

1. See ListTagsForResourceResponseTypeDef

Usage example with kwargs

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

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

list_world_export_jobs

Lists world export jobs.

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

Method definition

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

1. See FilterTypeDef
2. See ListWorldExportJobsResponseTypeDef

Usage example with kwargs

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

parent.list_world_export_jobs(**kwargs)

1. See ListWorldExportJobsRequestRequestTypeDef

list_world_generation_jobs

Lists world generator jobs.

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

Method definition

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

1. See FilterTypeDef
2. See ListWorldGenerationJobsResponseTypeDef

Usage example with kwargs

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

parent.list_world_generation_jobs(**kwargs)

1. See ListWorldGenerationJobsRequestRequestTypeDef

list_world_templates

Lists world templates.

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

Method definition

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

1. See ListWorldTemplatesResponseTypeDef

Usage example with kwargs

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

parent.list_world_templates(**kwargs)

1. See ListWorldTemplatesRequestRequestTypeDef

list_worlds

Lists worlds.

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

Method definition

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

1. See FilterTypeDef
2. See ListWorldsResponseTypeDef

Usage example with kwargs

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

parent.list_worlds(**kwargs)

1. See ListWorldsRequestRequestTypeDef

register_robot

Registers a robot with a fleet.

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

Method definition

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

1. See RegisterRobotResponseTypeDef

Usage example with kwargs

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

parent.register_robot(**kwargs)

1. See RegisterRobotRequestRequestTypeDef

restart_simulation_job

Restarts a running simulation job.

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

Method definition

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

Usage example with kwargs

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

parent.restart_simulation_job(**kwargs)

1. See RestartSimulationJobRequestRequestTypeDef

start_simulation_job_batch

Starts a new simulation job batch.

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

Method definition

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

1. See SimulationJobRequestTypeDef
2. See BatchPolicyTypeDef
3. See StartSimulationJobBatchResponseTypeDef

Usage example with kwargs

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

parent.start_simulation_job_batch(**kwargs)

1. See StartSimulationJobBatchRequestRequestTypeDef

sync_deployment_job

Syncrhonizes robots in a fleet to the latest deployment.

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

Method definition

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

1. See SyncDeploymentJobResponseTypeDef

Usage example with kwargs

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

parent.sync_deployment_job(**kwargs)

1. See SyncDeploymentJobRequestRequestTypeDef

tag_resource

Adds or edits tags for a AWS RoboMaker resource.

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

Method definition

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

Usage example with kwargs

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

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes the specified tags from the specified AWS RoboMaker resource.

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

Method definition

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

Usage example with kwargs

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

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_robot_application

Updates a robot application.

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

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 SourceConfigTypeDef
3. See EnvironmentTypeDef
4. See UpdateRobotApplicationResponseTypeDef

Usage example with kwargs

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

parent.update_robot_application(**kwargs)

1. See UpdateRobotApplicationRequestRequestTypeDef

update_simulation_application

Updates a simulation application.

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

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 SourceConfigTypeDef
4. See RenderingEngineTypeDef
5. See EnvironmentTypeDef
6. See UpdateSimulationApplicationResponseTypeDef

Usage example with kwargs

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

parent.update_simulation_application(**kwargs)

1. See UpdateSimulationApplicationRequestRequestTypeDef

update_world_template

Updates a world template.

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

Method definition

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

1. See TemplateLocationTypeDef
2. See UpdateWorldTemplateResponseTypeDef

Usage example with kwargs

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

parent.update_world_template(**kwargs)

1. See UpdateWorldTemplateRequestRequestTypeDef

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