RoboMaker class

This section provides documentation for the AWS RoboMaker API operations.

Constructors

RoboMaker({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

batchDeleteWorlds({required List<String> worlds}) → Future<BatchDeleteWorldsResponse>
Deletes one or more worlds in a batch operation.
batchDescribeSimulationJob({required List<String> jobs}) → Future<BatchDescribeSimulationJobResponse>
Describes one or more simulation jobs.
cancelDeploymentJob({required String job}) → Future<void>
Cancels the specified deployment job.
cancelSimulationJob({required String job}) → Future<void>
Cancels the specified simulation job.
cancelSimulationJobBatch({required String batch}) → Future<void>
Cancels a simulation job batch. When you cancel a simulation job batch, you are also cancelling all of the active simulation jobs created as part of the batch.
cancelWorldExportJob({required String job}) → Future<void>
Cancels the specified export job.
cancelWorldGenerationJob({required String job}) → Future<void>
Cancels the specified world generator job.
close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
createDeploymentJob({required List<DeploymentApplicationConfig> deploymentApplicationConfigs, required String fleet, String? clientRequestToken, DeploymentConfig? deploymentConfig, Map<String, String>? tags}) → Future<CreateDeploymentJobResponse>
Deploys a specific version of a robot application to robots in a fleet.
createFleet({required String name, Map<String, String>? tags}) → Future<CreateFleetResponse>
Creates a fleet, a logical group of robots running the same robot application.
createRobot({required Architecture architecture, required String greengrassGroupId, required String name, Map<String, String>? tags}) → Future<CreateRobotResponse>
Creates a robot.
createRobotApplication({required String name, required RobotSoftwareSuite robotSoftwareSuite, required List<SourceConfig> sources, Map<String, String>? tags}) → Future<CreateRobotApplicationResponse>
Creates a robot application.
createRobotApplicationVersion({required String application, String? currentRevisionId}) → Future<CreateRobotApplicationVersionResponse>
Creates a version of a robot application.
createSimulationApplication({required String name, required RobotSoftwareSuite robotSoftwareSuite, required SimulationSoftwareSuite simulationSoftwareSuite, required List<SourceConfig> sources, RenderingEngine? renderingEngine, Map<String, String>? tags}) → Future<CreateSimulationApplicationResponse>
Creates a simulation application.
createSimulationApplicationVersion({required String application, String? currentRevisionId}) → Future<CreateSimulationApplicationVersionResponse>
Creates a simulation application with a specific revision id.
createSimulationJob({required String iamRole, required int maxJobDurationInSeconds, String? clientRequestToken, Compute? compute, List<DataSourceConfig>? dataSources, FailureBehavior? failureBehavior, LoggingConfig? loggingConfig, OutputLocation? outputLocation, List<RobotApplicationConfig>? robotApplications, List<SimulationApplicationConfig>? simulationApplications, Map<String, String>? tags, VPCConfig? vpcConfig}) → Future<CreateSimulationJobResponse>
Creates a simulation job.
createWorldExportJob({required String iamRole, required OutputLocation outputLocation, required List<String> worlds, String? clientRequestToken, Map<String, String>? tags}) → Future<CreateWorldExportJobResponse>
Creates a world export job.
createWorldGenerationJob({required String template, required WorldCount worldCount, String? clientRequestToken, Map<String, String>? tags, Map<String, String>? worldTags}) → Future<CreateWorldGenerationJobResponse>
Creates worlds using the specified template.
createWorldTemplate({String? clientRequestToken, String? name, Map<String, String>? tags, String? templateBody, TemplateLocation? templateLocation}) → Future<CreateWorldTemplateResponse>
Creates a world template.
deleteFleet({required String fleet}) → Future<void>
Deletes a fleet.
deleteRobot({required String robot}) → Future<void>
Deletes a robot.
deleteRobotApplication({required String application, String? applicationVersion}) → Future<void>
Deletes a robot application.
deleteSimulationApplication({required String application, String? applicationVersion}) → Future<void>
Deletes a simulation application.
deleteWorldTemplate({required String template}) → Future<void>
Deletes a world template.
deregisterRobot({required String fleet, required String robot}) → Future<DeregisterRobotResponse>
Deregisters a robot.
describeDeploymentJob({required String job}) → Future<DescribeDeploymentJobResponse>
Describes a deployment job.
describeFleet({required String fleet}) → Future<DescribeFleetResponse>
Describes a fleet.
describeRobot({required String robot}) → Future<DescribeRobotResponse>
Describes a robot.
describeRobotApplication({required String application, String? applicationVersion}) → Future<DescribeRobotApplicationResponse>
Describes a robot application.
describeSimulationApplication({required String application, String? applicationVersion}) → Future<DescribeSimulationApplicationResponse>
Describes a simulation application.
describeSimulationJob({required String job}) → Future<DescribeSimulationJobResponse>
Describes a simulation job.
describeSimulationJobBatch({required String batch}) → Future<DescribeSimulationJobBatchResponse>
Describes a simulation job batch.
describeWorld({required String world}) → Future<DescribeWorldResponse>
Describes a world.
describeWorldExportJob({required String job}) → Future<DescribeWorldExportJobResponse>
Describes a world export job.
describeWorldGenerationJob({required String job}) → Future<DescribeWorldGenerationJobResponse>
Describes a world generation job.
describeWorldTemplate({required String template}) → Future<DescribeWorldTemplateResponse>
Describes a world template.
getWorldTemplateBody({String? generationJob, String? template}) → Future<GetWorldTemplateBodyResponse>
Gets the world template body.
listDeploymentJobs({List<Filter>? filters, int? maxResults, String? nextToken}) → Future<ListDeploymentJobsResponse>
Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.
listFleets({List<Filter>? filters, int? maxResults, String? nextToken}) → Future<ListFleetsResponse>
Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.
listRobotApplications({List<Filter>? filters, int? maxResults, String? nextToken, String? versionQualifier}) → Future<ListRobotApplicationsResponse>
Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications.
listRobots({List<Filter>? filters, int? maxResults, String? nextToken}) → Future<ListRobotsResponse>
Returns a list of robots. You can optionally provide filters to retrieve specific robots.
listSimulationApplications({List<Filter>? filters, int? maxResults, String? nextToken, String? versionQualifier}) → Future<ListSimulationApplicationsResponse>
Returns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications.
listSimulationJobBatches({List<Filter>? filters, int? maxResults, String? nextToken}) → Future<ListSimulationJobBatchesResponse>
Returns a list simulation job batches. You can optionally provide filters to retrieve specific simulation batch jobs.
listSimulationJobs({List<Filter>? filters, int? maxResults, String? nextToken}) → Future<ListSimulationJobsResponse>
Returns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs.
listTagsForResource({required String resourceArn}) → Future<ListTagsForResourceResponse>
Lists all tags on a AWS RoboMaker resource.
listWorldExportJobs({List<Filter>? filters, int? maxResults, String? nextToken}) → Future<ListWorldExportJobsResponse>
Lists world export jobs.
listWorldGenerationJobs({List<Filter>? filters, int? maxResults, String? nextToken}) → Future<ListWorldGenerationJobsResponse>
Lists world generator jobs.
listWorlds({List<Filter>? filters, int? maxResults, String? nextToken}) → Future<ListWorldsResponse>
Lists worlds.
listWorldTemplates({int? maxResults, String? nextToken}) → Future<ListWorldTemplatesResponse>
Lists world templates.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerRobot({required String fleet, required String robot}) → Future<RegisterRobotResponse>
Registers a robot with a fleet.
restartSimulationJob({required String job}) → Future<void>
Restarts a running simulation job.
startSimulationJobBatch({required List<SimulationJobRequest> createSimulationJobRequests, BatchPolicy? batchPolicy, String? clientRequestToken, Map<String, String>? tags}) → Future<StartSimulationJobBatchResponse>
Starts a new simulation job batch. The batch is defined using one or more SimulationJobRequest objects.
syncDeploymentJob({required String fleet, String? clientRequestToken}) → Future<SyncDeploymentJobResponse>
Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.
tagResource({required String resourceArn, required Map<String, String> tags}) → Future<void>
Adds or edits tags for a AWS RoboMaker resource.
toString() → String
A string representation of this object.
inherited
untagResource({required String resourceArn, required List<String> tagKeys}) → Future<void>
Removes the specified tags from the specified AWS RoboMaker resource.
updateRobotApplication({required String application, required RobotSoftwareSuite robotSoftwareSuite, required List<SourceConfig> sources, String? currentRevisionId}) → Future<UpdateRobotApplicationResponse>
Updates a robot application.
updateSimulationApplication({required String application, required RobotSoftwareSuite robotSoftwareSuite, required SimulationSoftwareSuite simulationSoftwareSuite, required List<SourceConfig> sources, String? currentRevisionId, RenderingEngine? renderingEngine}) → Future<UpdateSimulationApplicationResponse>
Updates a simulation application.
updateWorldTemplate({required String template, String? name, String? templateBody, TemplateLocation? templateLocation}) → Future<UpdateWorldTemplateResponse>
Updates a world template.

Operators

operator ==(Object other) → bool
The equality operator.
inherited