@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSRoboMaker
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSRoboMaker
instead.
This section provides documentation for the AWS RoboMaker API operations.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
static final String ENDPOINT_PREFIX
BatchDeleteWorldsResult batchDeleteWorlds(BatchDeleteWorldsRequest batchDeleteWorldsRequest)
Deletes one or more worlds in a batch operation.
batchDeleteWorldsRequest
- InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.BatchDescribeSimulationJobResult batchDescribeSimulationJob(BatchDescribeSimulationJobRequest batchDescribeSimulationJobRequest)
Describes one or more simulation jobs.
batchDescribeSimulationJobRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.@Deprecated CancelDeploymentJobResult cancelDeploymentJob(CancelDeploymentJobRequest cancelDeploymentJobRequest)
Cancels the specified deployment job.
This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.
cancelDeploymentJobRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.CancelSimulationJobResult cancelSimulationJob(CancelSimulationJobRequest cancelSimulationJobRequest)
Cancels the specified simulation job.
cancelSimulationJobRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.CancelSimulationJobBatchResult cancelSimulationJobBatch(CancelSimulationJobBatchRequest cancelSimulationJobBatchRequest)
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.
cancelSimulationJobBatchRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.CancelWorldExportJobResult cancelWorldExportJob(CancelWorldExportJobRequest cancelWorldExportJobRequest)
Cancels the specified export job.
cancelWorldExportJobRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.CancelWorldGenerationJobResult cancelWorldGenerationJob(CancelWorldGenerationJobRequest cancelWorldGenerationJobRequest)
Cancels the specified world generator job.
cancelWorldGenerationJobRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.@Deprecated CreateDeploymentJobResult createDeploymentJob(CreateDeploymentJobRequest createDeploymentJobRequest)
Deploys a specific version of a robot application to robots in a fleet.
This API is no longer supported and will throw an error if used.
The robot application must have a numbered applicationVersion
for consistency reasons. To create a
new version, use CreateRobotApplicationVersion
or see Creating a Robot
Application Version.
After 90 days, deployment jobs expire and will be deleted. They will no longer be accessible.
createDeploymentJobRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
exceeds the maximum number allowed.ConcurrentDeploymentException
- The failure percentage threshold percentage was met.IdempotentParameterMismatchException
- The request uses the same client token as a previous, but non-identical request. Do not reuse a client
token with different requests, unless the requests are identical.@Deprecated CreateFleetResult createFleet(CreateFleetRequest createFleetRequest)
Creates a fleet, a logical group of robots running the same robot application.
This API is no longer supported and will throw an error if used.
createFleetRequest
- InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
exceeds the maximum number allowed.@Deprecated CreateRobotResult createRobot(CreateRobotRequest createRobotRequest)
Creates a robot.
This API is no longer supported and will throw an error if used.
createRobotRequest
- InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
exceeds the maximum number allowed.ResourceAlreadyExistsException
- The specified resource already exists.CreateRobotApplicationResult createRobotApplication(CreateRobotApplicationRequest createRobotApplicationRequest)
Creates a robot application.
createRobotApplicationRequest
- InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.ResourceAlreadyExistsException
- The specified resource already exists.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
exceeds the maximum number allowed.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.IdempotentParameterMismatchException
- The request uses the same client token as a previous, but non-identical request. Do not reuse a client
token with different requests, unless the requests are identical.CreateRobotApplicationVersionResult createRobotApplicationVersion(CreateRobotApplicationVersionRequest createRobotApplicationVersionRequest)
Creates a version of a robot application.
createRobotApplicationVersionRequest
- InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.IdempotentParameterMismatchException
- The request uses the same client token as a previous, but non-identical request. Do not reuse a client
token with different requests, unless the requests are identical.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
exceeds the maximum number allowed.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.CreateSimulationApplicationResult createSimulationApplication(CreateSimulationApplicationRequest createSimulationApplicationRequest)
Creates a simulation application.
createSimulationApplicationRequest
- InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.ResourceAlreadyExistsException
- The specified resource already exists.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
exceeds the maximum number allowed.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.IdempotentParameterMismatchException
- The request uses the same client token as a previous, but non-identical request. Do not reuse a client
token with different requests, unless the requests are identical.CreateSimulationApplicationVersionResult createSimulationApplicationVersion(CreateSimulationApplicationVersionRequest createSimulationApplicationVersionRequest)
Creates a simulation application with a specific revision id.
createSimulationApplicationVersionRequest
- InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.IdempotentParameterMismatchException
- The request uses the same client token as a previous, but non-identical request. Do not reuse a client
token with different requests, unless the requests are identical.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
exceeds the maximum number allowed.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.CreateSimulationJobResult createSimulationJob(CreateSimulationJobRequest createSimulationJobRequest)
Creates a simulation job.
After 90 days, simulation jobs expire and will be deleted. They will no longer be accessible.
createSimulationJobRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
exceeds the maximum number allowed.IdempotentParameterMismatchException
- The request uses the same client token as a previous, but non-identical request. Do not reuse a client
token with different requests, unless the requests are identical.ServiceUnavailableException
- The request has failed due to a temporary failure of the server.CreateWorldExportJobResult createWorldExportJob(CreateWorldExportJobRequest createWorldExportJobRequest)
Creates a world export job.
createWorldExportJobRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.IdempotentParameterMismatchException
- The request uses the same client token as a previous, but non-identical request. Do not reuse a client
token with different requests, unless the requests are identical.ServiceUnavailableException
- The request has failed due to a temporary failure of the server.CreateWorldGenerationJobResult createWorldGenerationJob(CreateWorldGenerationJobRequest createWorldGenerationJobRequest)
Creates worlds using the specified template.
createWorldGenerationJobRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
exceeds the maximum number allowed.IdempotentParameterMismatchException
- The request uses the same client token as a previous, but non-identical request. Do not reuse a client
token with different requests, unless the requests are identical.ServiceUnavailableException
- The request has failed due to a temporary failure of the server.CreateWorldTemplateResult createWorldTemplate(CreateWorldTemplateRequest createWorldTemplateRequest)
Creates a world template.
createWorldTemplateRequest
- InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.ResourceAlreadyExistsException
- The specified resource already exists.ResourceNotFoundException
- The specified resource does not exist.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
exceeds the maximum number allowed.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.@Deprecated DeleteFleetResult deleteFleet(DeleteFleetRequest deleteFleetRequest)
Deletes a fleet.
This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.
deleteFleetRequest
- InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.@Deprecated DeleteRobotResult deleteRobot(DeleteRobotRequest deleteRobotRequest)
Deletes a robot.
This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.
deleteRobotRequest
- InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.DeleteRobotApplicationResult deleteRobotApplication(DeleteRobotApplicationRequest deleteRobotApplicationRequest)
Deletes a robot application.
deleteRobotApplicationRequest
- InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.DeleteSimulationApplicationResult deleteSimulationApplication(DeleteSimulationApplicationRequest deleteSimulationApplicationRequest)
Deletes a simulation application.
deleteSimulationApplicationRequest
- InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.DeleteWorldTemplateResult deleteWorldTemplate(DeleteWorldTemplateRequest deleteWorldTemplateRequest)
Deletes a world template.
deleteWorldTemplateRequest
- InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.@Deprecated DeregisterRobotResult deregisterRobot(DeregisterRobotRequest deregisterRobotRequest)
Deregisters a robot.
This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.
deregisterRobotRequest
- InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.ResourceNotFoundException
- The specified resource does not exist.@Deprecated DescribeDeploymentJobResult describeDeploymentJob(DescribeDeploymentJobRequest describeDeploymentJobRequest)
Describes a deployment job.
This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.
describeDeploymentJobRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.@Deprecated DescribeFleetResult describeFleet(DescribeFleetRequest describeFleetRequest)
Describes a fleet.
This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.
describeFleetRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.@Deprecated DescribeRobotResult describeRobot(DescribeRobotRequest describeRobotRequest)
Describes a robot.
This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.
describeRobotRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.DescribeRobotApplicationResult describeRobotApplication(DescribeRobotApplicationRequest describeRobotApplicationRequest)
Describes a robot application.
describeRobotApplicationRequest
- InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.DescribeSimulationApplicationResult describeSimulationApplication(DescribeSimulationApplicationRequest describeSimulationApplicationRequest)
Describes a simulation application.
describeSimulationApplicationRequest
- InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.DescribeSimulationJobResult describeSimulationJob(DescribeSimulationJobRequest describeSimulationJobRequest)
Describes a simulation job.
describeSimulationJobRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.DescribeSimulationJobBatchResult describeSimulationJobBatch(DescribeSimulationJobBatchRequest describeSimulationJobBatchRequest)
Describes a simulation job batch.
describeSimulationJobBatchRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.DescribeWorldResult describeWorld(DescribeWorldRequest describeWorldRequest)
Describes a world.
describeWorldRequest
- InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.DescribeWorldExportJobResult describeWorldExportJob(DescribeWorldExportJobRequest describeWorldExportJobRequest)
Describes a world export job.
describeWorldExportJobRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.DescribeWorldGenerationJobResult describeWorldGenerationJob(DescribeWorldGenerationJobRequest describeWorldGenerationJobRequest)
Describes a world generation job.
describeWorldGenerationJobRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.DescribeWorldTemplateResult describeWorldTemplate(DescribeWorldTemplateRequest describeWorldTemplateRequest)
Describes a world template.
describeWorldTemplateRequest
- InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.GetWorldTemplateBodyResult getWorldTemplateBody(GetWorldTemplateBodyRequest getWorldTemplateBodyRequest)
Gets the world template body.
getWorldTemplateBodyRequest
- InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.@Deprecated ListDeploymentJobsResult listDeploymentJobs(ListDeploymentJobsRequest listDeploymentJobsRequest)
Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.
This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.
listDeploymentJobsRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.@Deprecated ListFleetsResult listFleets(ListFleetsRequest listFleetsRequest)
Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.
This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.
listFleetsRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.ListRobotApplicationsResult listRobotApplications(ListRobotApplicationsRequest listRobotApplicationsRequest)
Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications.
listRobotApplicationsRequest
- InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.@Deprecated ListRobotsResult listRobots(ListRobotsRequest listRobotsRequest)
Returns a list of robots. You can optionally provide filters to retrieve specific robots.
This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.
listRobotsRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.ListSimulationApplicationsResult listSimulationApplications(ListSimulationApplicationsRequest listSimulationApplicationsRequest)
Returns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications.
listSimulationApplicationsRequest
- InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.ListSimulationJobBatchesResult listSimulationJobBatches(ListSimulationJobBatchesRequest listSimulationJobBatchesRequest)
Returns a list simulation job batches. You can optionally provide filters to retrieve specific simulation batch jobs.
listSimulationJobBatchesRequest
- InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.ListSimulationJobsResult listSimulationJobs(ListSimulationJobsRequest listSimulationJobsRequest)
Returns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs.
listSimulationJobsRequest
- InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags on a AWS RoboMaker resource.
listTagsForResourceRequest
- InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.ResourceNotFoundException
- The specified resource does not exist.InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.ListWorldExportJobsResult listWorldExportJobs(ListWorldExportJobsRequest listWorldExportJobsRequest)
Lists world export jobs.
listWorldExportJobsRequest
- InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.ListWorldGenerationJobsResult listWorldGenerationJobs(ListWorldGenerationJobsRequest listWorldGenerationJobsRequest)
Lists world generator jobs.
listWorldGenerationJobsRequest
- InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.ListWorldTemplatesResult listWorldTemplates(ListWorldTemplatesRequest listWorldTemplatesRequest)
Lists world templates.
listWorldTemplatesRequest
- InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.ListWorldsResult listWorlds(ListWorldsRequest listWorldsRequest)
Lists worlds.
listWorldsRequest
- InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.@Deprecated RegisterRobotResult registerRobot(RegisterRobotRequest registerRobotRequest)
Registers a robot with a fleet.
This API is no longer supported and will throw an error if used.
registerRobotRequest
- InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
exceeds the maximum number allowed.ResourceNotFoundException
- The specified resource does not exist.RestartSimulationJobResult restartSimulationJob(RestartSimulationJobRequest restartSimulationJobRequest)
Restarts a running simulation job.
restartSimulationJobRequest
- ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
exceeds the maximum number allowed.InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.StartSimulationJobBatchResult startSimulationJobBatch(StartSimulationJobBatchRequest startSimulationJobBatchRequest)
Starts a new simulation job batch. The batch is defined using one or more SimulationJobRequest
objects.
startSimulationJobBatchRequest
- InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
exceeds the maximum number allowed.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.IdempotentParameterMismatchException
- The request uses the same client token as a previous, but non-identical request. Do not reuse a client
token with different requests, unless the requests are identical.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.@Deprecated SyncDeploymentJobResult syncDeploymentJob(SyncDeploymentJobRequest syncDeploymentJobRequest)
Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.
This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.
syncDeploymentJobRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
exceeds the maximum number allowed.ConcurrentDeploymentException
- The failure percentage threshold percentage was met.IdempotentParameterMismatchException
- The request uses the same client token as a previous, but non-identical request. Do not reuse a client
token with different requests, unless the requests are identical.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Adds or edits tags for a AWS RoboMaker resource.
Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty strings.
For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.
tagResourceRequest
- InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.ResourceNotFoundException
- The specified resource does not exist.InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes the specified tags from the specified AWS RoboMaker resource.
To remove a tag, specify the tag key. To change the tag value of an existing tag key, use TagResource
.
untagResourceRequest
- InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.ResourceNotFoundException
- The specified resource does not exist.InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.UpdateRobotApplicationResult updateRobotApplication(UpdateRobotApplicationRequest updateRobotApplicationRequest)
Updates a robot application.
updateRobotApplicationRequest
- InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.ResourceNotFoundException
- The specified resource does not exist.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
exceeds the maximum number allowed.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.UpdateSimulationApplicationResult updateSimulationApplication(UpdateSimulationApplicationRequest updateSimulationApplicationRequest)
Updates a simulation application.
updateSimulationApplicationRequest
- InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.ResourceNotFoundException
- The specified resource does not exist.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
exceeds the maximum number allowed.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.UpdateWorldTemplateResult updateWorldTemplate(UpdateWorldTemplateRequest updateWorldTemplateRequest)
Updates a world template.
updateWorldTemplateRequest
- InvalidParameterException
- A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message
provides an explanation of the error value.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- AWS RoboMaker is temporarily unable to process the request. Try your call again.InternalServerException
- AWS RoboMaker experienced a service issue. Try your call again.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request
- The originally executed request.