openapi: 3.0.0 info: version: '2018-06-29' x-release: v4 title: AWS RoboMaker description: This section provides documentation for the AWS RoboMaker API operations. x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: robomaker x-aws-signingName: robomaker x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/robomaker-2018-06-29.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/robomaker/ servers: - url: http://robomaker.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The RoboMaker multi-region endpoint - url: https://robomaker.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The RoboMaker multi-region endpoint - url: http://robomaker.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The RoboMaker endpoint for China (Beijing) and China (Ningxia) - url: https://robomaker.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The RoboMaker endpoint for China (Beijing) and China (Ningxia) x-hasEquivalentPaths: true paths: /batchDeleteWorlds: post: operationId: BatchDeleteWorlds description: Deletes one or more worlds in a batch operation. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/BatchDeleteWorldsResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - worlds properties: worlds: description: A list of Amazon Resource Names (arns) that correspond to worlds to delete. type: array items: $ref: '#/components/schemas/Arn' minItems: 1 maxItems: 100 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /batchDescribeSimulationJob: post: operationId: BatchDescribeSimulationJob description: Describes one or more simulation jobs. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/BatchDescribeSimulationJobResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - jobs properties: jobs: description: A list of Amazon Resource Names (ARNs) of simulation jobs to describe. type: array items: $ref: '#/components/schemas/Arn' minItems: 1 maxItems: 100 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /cancelDeploymentJob: post: deprecated: true operationId: CancelDeploymentJob description:

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.

 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CancelDeploymentJobResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - job properties: job: description: The deployment job ARN to cancel. type: string pattern: arn:.* minLength: 1 maxLength: 1224 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /cancelSimulationJob: post: operationId: CancelSimulationJob description: Cancels the specified simulation job. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CancelSimulationJobResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - job properties: job: description: The simulation job ARN to cancel. type: string pattern: arn:.* minLength: 1 maxLength: 1224 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /cancelSimulationJobBatch: post: operationId: CancelSimulationJobBatch description: '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. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CancelSimulationJobBatchResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - batch properties: batch: description: The id of the batch to cancel. type: string pattern: arn:.* minLength: 1 maxLength: 1224 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /cancelWorldExportJob: post: operationId: CancelWorldExportJob description: Cancels the specified export job. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CancelWorldExportJobResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - job properties: job: description: The Amazon Resource Name (arn) of the world export job to cancel. type: string pattern: arn:.* minLength: 1 maxLength: 1224 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /cancelWorldGenerationJob: post: operationId: CancelWorldGenerationJob description: Cancels the specified world generator job. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CancelWorldGenerationJobResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - job properties: job: description: The Amazon Resource Name (arn) of the world generator job to cancel. type: string pattern: arn:.* minLength: 1 maxLength: 1224 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /createDeploymentJob: post: deprecated: true operationId: CreateDeploymentJob description:

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.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateDeploymentJobResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '484': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '485': description: ConcurrentDeploymentException content: application/json: schema: $ref: '#/components/schemas/ConcurrentDeploymentException' '486': description: IdempotentParameterMismatchException content: application/json: schema: $ref: '#/components/schemas/IdempotentParameterMismatchException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - clientRequestToken - fleet - deploymentApplicationConfigs properties: deploymentConfig: description: Information about a deployment configuration. type: object properties: concurrentDeploymentPercentage: allOf: - $ref: '#/components/schemas/Percentage' - description: The percentage of robots receiving the deployment at the same time. failureThresholdPercentage: allOf: - $ref: '#/components/schemas/Percentage' - description: The percentage of deployments that need to fail before stopping deployment. robotDeploymentTimeoutInSeconds: allOf: - $ref: '#/components/schemas/DeploymentTimeout' - description: The amount of time, in seconds, to wait for deployment to a single robot to complete. Choose a time between 1 minute and 7 days. The default is 5 hours. downloadConditionFile: allOf: - $ref: '#/components/schemas/S3Object' - description: The download condition file. clientRequestToken: description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. type: string pattern: '[a-zA-Z0-9_\-=]*' minLength: 1 maxLength: 64 fleet: description: The Amazon Resource Name (ARN) of the fleet to deploy. type: string pattern: arn:.* minLength: 1 maxLength: 1224 deploymentApplicationConfigs: description: The deployment application configuration. type: array items: $ref: '#/components/schemas/DeploymentApplicationConfig' minItems: 1 maxItems: 1 tags: description: A map that contains tag keys and tag values that are attached to the deployment job. type: object minProperties: 0 maxProperties: 50 additionalProperties: $ref: '#/components/schemas/TagValue' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /createFleet: post: deprecated: true operationId: CreateFleet description:

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.

 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateFleetResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '483': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - name properties: name: description: The name of the fleet. type: string pattern: '[a-zA-Z0-9_\-]*' minLength: 1 maxLength: 255 tags: description: A map that contains tag keys and tag values that are attached to the fleet. type: object minProperties: 0 maxProperties: 50 additionalProperties: $ref: '#/components/schemas/TagValue' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /createRobot: post: deprecated: true operationId: CreateRobot description:

Creates a robot.

This API is no longer supported and will throw an error if used.

 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateRobotResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '483': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '484': description: ResourceAlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/ResourceAlreadyExistsException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - name - architecture - greengrassGroupId properties: name: description: The name for the robot. type: string pattern: '[a-zA-Z0-9_\-]*' minLength: 1 maxLength: 255 architecture: description: The target architecture of the robot. type: string enum: - X86_64 - ARM64 - ARMHF greengrassGroupId: description: The Greengrass group id. type: string pattern: .* minLength: 1 maxLength: 1224 tags: description: A map that contains tag keys and tag values that are attached to the robot. type: object minProperties: 0 maxProperties: 50 additionalProperties: $ref: '#/components/schemas/TagValue' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /createRobotApplication: post: operationId: CreateRobotApplication description: 'Creates a robot application. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateRobotApplicationResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: ResourceAlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/ResourceAlreadyExistsException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '484': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '485': description: IdempotentParameterMismatchException content: application/json: schema: $ref: '#/components/schemas/IdempotentParameterMismatchException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - name - robotSoftwareSuite properties: name: description: The name of the robot application. type: string pattern: '[a-zA-Z0-9_\-]*' minLength: 1 maxLength: 255 sources: description: The sources of the robot application. type: array items: $ref: '#/components/schemas/SourceConfig' robotSoftwareSuite: description: Information about a robot software suite (ROS distribution). type: object properties: name: allOf: - $ref: '#/components/schemas/RobotSoftwareSuiteType' - description: The name of the robot software suite (ROS distribution). version: allOf: - $ref: '#/components/schemas/RobotSoftwareSuiteVersionType' - description: The version of the robot software suite (ROS distribution). tags: description: A map that contains tag keys and tag values that are attached to the robot application. type: object minProperties: 0 maxProperties: 50 additionalProperties: $ref: '#/components/schemas/TagValue' environment: description: The object that contains the Docker image URI for either your robot or simulation applications. type: object properties: uri: allOf: - $ref: '#/components/schemas/RepositoryUrl' - description: The Docker image URI for either your robot or simulation applications. parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /createRobotApplicationVersion: post: operationId: CreateRobotApplicationVersion description: Creates a version of a robot application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateRobotApplicationVersionResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: IdempotentParameterMismatchException content: application/json: schema: $ref: '#/components/schemas/IdempotentParameterMismatchException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '484': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - application properties: application: description: The application information for the robot application. type: string pattern: arn:.* minLength: 1 maxLength: 1224 currentRevisionId: description: The current revision id for the robot application. If you provide a value and it matches the latest revision ID, a new version will be created. type: string pattern: '[a-zA-Z0-9_.\-]*' minLength: 1 maxLength: 40 s3Etags: description: The Amazon S3 identifier for the zip file bundle that you use for your robot application. type: array items: $ref: '#/components/schemas/S3Etag' imageDigest: description: A SHA256 identifier for the Docker image that you use for your robot application. type: string pattern: '[Ss][Hh][Aa]256:[0-9a-fA-F]{64}' minLength: 0 maxLength: 72 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /createSimulationApplication: post: operationId: CreateSimulationApplication description: Creates a simulation application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateSimulationApplicationResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: ResourceAlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/ResourceAlreadyExistsException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '484': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '485': description: IdempotentParameterMismatchException content: application/json: schema: $ref: '#/components/schemas/IdempotentParameterMismatchException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - name - simulationSoftwareSuite - robotSoftwareSuite properties: name: description: The name of the simulation application. type: string pattern: '[a-zA-Z0-9_\-]*' minLength: 1 maxLength: 255 sources: description: The sources of the simulation application. type: array items: $ref: '#/components/schemas/SourceConfig' simulationSoftwareSuite: description: Information about a simulation software suite. type: object properties: name: allOf: - $ref: '#/components/schemas/SimulationSoftwareSuiteType' - description: The name of the simulation software suite. version: allOf: - $ref: '#/components/schemas/SimulationSoftwareSuiteVersionType' - description: The version of the simulation software suite. robotSoftwareSuite: description: Information about a robot software suite (ROS distribution). type: object properties: name: allOf: - $ref: '#/components/schemas/RobotSoftwareSuiteType' - description: The name of the robot software suite (ROS distribution). version: allOf: - $ref: '#/components/schemas/RobotSoftwareSuiteVersionType' - description: The version of the robot software suite (ROS distribution). renderingEngine: description: Information about a rendering engine. type: object properties: name: allOf: - $ref: '#/components/schemas/RenderingEngineType' - description: The name of the rendering engine. version: allOf: - $ref: '#/components/schemas/RenderingEngineVersionType' - description: The version of the rendering engine. tags: description: A map that contains tag keys and tag values that are attached to the simulation application. type: object minProperties: 0 maxProperties: 50 additionalProperties: $ref: '#/components/schemas/TagValue' environment: description: The object that contains the Docker image URI for either your robot or simulation applications. type: object properties: uri: allOf: - $ref: '#/components/schemas/RepositoryUrl' - description: The Docker image URI for either your robot or simulation applications. parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /createSimulationApplicationVersion: post: operationId: CreateSimulationApplicationVersion description: Creates a simulation application with a specific revision id. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateSimulationApplicationVersionResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: IdempotentParameterMismatchException content: application/json: schema: $ref: '#/components/schemas/IdempotentParameterMismatchException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '484': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - application properties: application: description: The application information for the simulation application. type: string pattern: arn:.* minLength: 1 maxLength: 1224 currentRevisionId: description: The current revision id for the simulation application. If you provide a value and it matches the latest revision ID, a new version will be created. type: string pattern: '[a-zA-Z0-9_.\-]*' minLength: 1 maxLength: 40 s3Etags: description: The Amazon S3 eTag identifier for the zip file bundle that you use to create the simulation application. type: array items: $ref: '#/components/schemas/S3Etag' imageDigest: description: The SHA256 digest used to identify the Docker image URI used to created the simulation application. type: string pattern: '[Ss][Hh][Aa]256:[0-9a-fA-F]{64}' minLength: 0 maxLength: 72 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /createSimulationJob: post: operationId: CreateSimulationJob description:

Creates a simulation job.

After 90 days, simulation jobs expire and will be deleted. They will no longer be accessible.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateSimulationJobResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '484': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '485': description: IdempotentParameterMismatchException content: application/json: schema: $ref: '#/components/schemas/IdempotentParameterMismatchException' '486': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - maxJobDurationInSeconds - iamRole properties: clientRequestToken: description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. type: string pattern: '[a-zA-Z0-9_\-=]*' minLength: 1 maxLength: 64 outputLocation: description: The output location. type: object properties: s3Bucket: allOf: - $ref: '#/components/schemas/S3Bucket' - description: The S3 bucket for output. s3Prefix: allOf: - $ref: '#/components/schemas/S3Key' - description: The S3 folder in the s3Bucket where output files will be placed. loggingConfig: description: The logging configuration. type: object properties: recordAllRosTopics: allOf: - $ref: '#/components/schemas/BoxedBoolean' - deprecated: true description:

A boolean indicating whether to record all ROS topics.

This API is no longer supported and will throw an error if used.

AWS RoboMaker is ending support for ROS software suite. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/software-support-policy.html. maxJobDurationInSeconds: description: The maximum simulation job duration in seconds (up to 14 days or 1,209,600 seconds. When maxJobDurationInSeconds is reached, the simulation job will status will transition to Completed. type: integer iamRole: description: 'The IAM role name that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. This is how credentials are passed in to your simulation job. ' type: string pattern: arn:aws:iam::\w+:role/.* minLength: 1 maxLength: 255 failureBehavior: description:

The failure behavior the simulation job.

Continue

Leaves the instance running for its maximum timeout duration after a 4XX error code.

Fail

Stop the simulation job and terminate the instance.

type: string enum: - Fail - Continue robotApplications: description: The robot application to use in the simulation job. type: array items: $ref: '#/components/schemas/RobotApplicationConfig' minItems: 1 maxItems: 1 simulationApplications: description: The simulation application to use in the simulation job. type: array items: $ref: '#/components/schemas/SimulationApplicationConfig' minItems: 1 maxItems: 1 dataSources: description:

Specify data sources to mount read-only files from S3 into your simulation. These files are available under /opt/robomaker/datasources/data_source_name.

There is a limit of 100 files and a combined size of 25GB for all DataSourceConfig objects.

type: array items: $ref: '#/components/schemas/DataSourceConfig' minItems: 1 maxItems: 6 tags: description: A map that contains tag keys and tag values that are attached to the simulation job. type: object minProperties: 0 maxProperties: 50 additionalProperties: $ref: '#/components/schemas/TagValue' vpcConfig: description: If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and two subnet IDs. type: object properties: subnets: allOf: - $ref: '#/components/schemas/Subnets' - description: A list of one or more subnet IDs in your VPC. securityGroups: allOf: - $ref: '#/components/schemas/SecurityGroups' - description: A list of one or more security groups IDs in your VPC. assignPublicIp: allOf: - $ref: '#/components/schemas/Boolean' - description: A boolean indicating whether to assign a public IP address. compute: description: Compute information for the simulation job. type: object properties: simulationUnitLimit: allOf: - $ref: '#/components/schemas/SimulationUnit' - description: 'The simulation unit limit. Your simulation is allocated CPU and memory proportional to the supplied simulation unit limit. A simulation unit is 1 vcpu and 2GB of memory. You are only billed for the SU utilization you consume up to the maximum value provided. The default is 15. ' computeType: allOf: - $ref: '#/components/schemas/ComputeType' - description: Compute type information for the simulation job. gpuUnitLimit: allOf: - $ref: '#/components/schemas/GPUUnit' - description: Compute GPU unit limit for the simulation job. It is the same as the number of GPUs allocated to the SimulationJob. parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /createWorldExportJob: post: operationId: CreateWorldExportJob description: Creates a world export job. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateWorldExportJobResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '484': description: IdempotentParameterMismatchException content: application/json: schema: $ref: '#/components/schemas/IdempotentParameterMismatchException' '485': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - worlds - outputLocation - iamRole properties: clientRequestToken: description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. type: string pattern: '[a-zA-Z0-9_\-=]*' minLength: 1 maxLength: 64 worlds: description: A list of Amazon Resource Names (arns) that correspond to worlds to export. type: array items: $ref: '#/components/schemas/Arn' minItems: 1 maxItems: 100 outputLocation: description: The output location. type: object properties: s3Bucket: allOf: - $ref: '#/components/schemas/S3Bucket' - description: The S3 bucket for output. s3Prefix: allOf: - $ref: '#/components/schemas/S3Key' - description: The S3 folder in the s3Bucket where output files will be placed. iamRole: description: The IAM role that the world export process uses to access the Amazon S3 bucket and put the export. type: string pattern: arn:aws:iam::\w+:role/.* minLength: 1 maxLength: 255 tags: description: A map that contains tag keys and tag values that are attached to the world export job. type: object minProperties: 0 maxProperties: 50 additionalProperties: $ref: '#/components/schemas/TagValue' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /createWorldGenerationJob: post: operationId: CreateWorldGenerationJob description: Creates worlds using the specified template. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateWorldGenerationJobResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '484': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '485': description: IdempotentParameterMismatchException content: application/json: schema: $ref: '#/components/schemas/IdempotentParameterMismatchException' '486': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - template - worldCount properties: clientRequestToken: description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. type: string pattern: '[a-zA-Z0-9_\-=]*' minLength: 1 maxLength: 64 template: description: The Amazon Resource Name (arn) of the world template describing the worlds you want to create. type: string pattern: arn:.* minLength: 1 maxLength: 1224 worldCount: description:

The number of worlds that will be created. You can configure the number of unique floorplans and the number of unique interiors for each floor plan. For example, if you want 1 world with 20 unique interiors, you set floorplanCount = 1 and interiorCountPerFloorplan = 20. This will result in 20 worlds (floorplanCount * interiorCountPerFloorplan).

If you set floorplanCount = 4 and interiorCountPerFloorplan = 5, there will be 20 worlds with 5 unique floor plans.

type: object properties: floorplanCount: allOf: - $ref: '#/components/schemas/FloorplanCount' - description: The number of unique floorplans. interiorCountPerFloorplan: allOf: - $ref: '#/components/schemas/InteriorCountPerFloorplan' - description: The number of unique interiors per floorplan. tags: description: A map that contains tag keys and tag values that are attached to the world generator job. type: object minProperties: 0 maxProperties: 50 additionalProperties: $ref: '#/components/schemas/TagValue' worldTags: description: A map that contains tag keys and tag values that are attached to the generated worlds. type: object minProperties: 0 maxProperties: 50 additionalProperties: $ref: '#/components/schemas/TagValue' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /createWorldTemplate: post: operationId: CreateWorldTemplate description: Creates a world template. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateWorldTemplateResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: ResourceAlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/ResourceAlreadyExistsException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '484': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '485': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: [] requestBody: required: true content: application/json: schema: type: object properties: clientRequestToken: description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. type: string pattern: '[a-zA-Z0-9_\-=]*' minLength: 1 maxLength: 64 name: description: The name of the world template. type: string pattern: .* minLength: 0 maxLength: 255 templateBody: description: The world template body. type: string pattern: '[\S\s]+' minLength: 1 maxLength: 262144 templateLocation: description: Information about a template location. type: object properties: s3Bucket: allOf: - $ref: '#/components/schemas/S3Bucket' - description: The Amazon S3 bucket name. s3Key: allOf: - $ref: '#/components/schemas/S3Key' - description: The list of S3 keys identifying the data source files. tags: description: A map that contains tag keys and tag values that are attached to the world template. type: object minProperties: 0 maxProperties: 50 additionalProperties: $ref: '#/components/schemas/TagValue' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /deleteFleet: post: deprecated: true operationId: DeleteFleet description:

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.

 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteFleetResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - fleet properties: fleet: description: The Amazon Resource Name (ARN) of the fleet. type: string pattern: arn:.* minLength: 1 maxLength: 1224 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /deleteRobot: post: deprecated: true operationId: DeleteRobot description:

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.

 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteRobotResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - robot properties: robot: description: The Amazon Resource Name (ARN) of the robot. type: string pattern: arn:.* minLength: 1 maxLength: 1224 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /deleteRobotApplication: post: operationId: DeleteRobotApplication description: Deletes a robot application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteRobotApplicationResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - application properties: application: description: The Amazon Resource Name (ARN) of the the robot application. type: string pattern: arn:.* minLength: 1 maxLength: 1224 applicationVersion: description: The version of the robot application to delete. type: string pattern: (\$LATEST)|[0-9]* minLength: 1 maxLength: 255 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /deleteSimulationApplication: post: operationId: DeleteSimulationApplication description: Deletes a simulation application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteSimulationApplicationResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - application properties: application: description: The application information for the simulation application to delete. type: string pattern: arn:.* minLength: 1 maxLength: 1224 applicationVersion: description: The version of the simulation application to delete. type: string pattern: (\$LATEST)|[0-9]* minLength: 1 maxLength: 255 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /deleteWorldTemplate: post: operationId: DeleteWorldTemplate description: Deletes a world template. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteWorldTemplateResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - template properties: template: description: The Amazon Resource Name (arn) of the world template you want to delete. type: string pattern: arn:.* minLength: 1 maxLength: 1224 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /deregisterRobot: post: deprecated: true operationId: DeregisterRobot description:

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.

 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeregisterRobotResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - fleet - robot properties: fleet: description: The Amazon Resource Name (ARN) of the fleet. type: string pattern: arn:.* minLength: 1 maxLength: 1224 robot: description: The Amazon Resource Name (ARN) of the robot. type: string pattern: arn:.* minLength: 1 maxLength: 1224 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /describeDeploymentJob: post: deprecated: true operationId: DescribeDeploymentJob description:

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.

 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeDeploymentJobResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - job properties: job: description: The Amazon Resource Name (ARN) of the deployment job. type: string pattern: arn:.* minLength: 1 maxLength: 1224 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /describeFleet: post: deprecated: true operationId: DescribeFleet description:

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.

 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeFleetResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - fleet properties: fleet: description: The Amazon Resource Name (ARN) of the fleet. type: string pattern: arn:.* minLength: 1 maxLength: 1224 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /describeRobot: post: deprecated: true operationId: DescribeRobot description:

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.

 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeRobotResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - robot properties: robot: description: The Amazon Resource Name (ARN) of the robot to be described. type: string pattern: arn:.* minLength: 1 maxLength: 1224 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /describeRobotApplication: post: operationId: DescribeRobotApplication description: Describes a robot application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeRobotApplicationResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - application properties: application: description: The Amazon Resource Name (ARN) of the robot application. type: string pattern: arn:.* minLength: 1 maxLength: 1224 applicationVersion: description: The version of the robot application to describe. type: string pattern: (\$LATEST)|[0-9]* minLength: 1 maxLength: 255 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /describeSimulationApplication: post: operationId: DescribeSimulationApplication description: Describes a simulation application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeSimulationApplicationResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - application properties: application: description: The application information for the simulation application. type: string pattern: arn:.* minLength: 1 maxLength: 1224 applicationVersion: description: The version of the simulation application to describe. type: string pattern: (\$LATEST)|[0-9]* minLength: 1 maxLength: 255 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /describeSimulationJob: post: operationId: DescribeSimulationJob description: Describes a simulation job. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeSimulationJobResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - job properties: job: description: The Amazon Resource Name (ARN) of the simulation job to be described. type: string pattern: arn:.* minLength: 1 maxLength: 1224 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /describeSimulationJobBatch: post: operationId: DescribeSimulationJobBatch description: Describes a simulation job batch. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeSimulationJobBatchResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - batch properties: batch: description: The id of the batch to describe. type: string pattern: arn:.* minLength: 1 maxLength: 1224 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /describeWorld: post: operationId: DescribeWorld description: Describes a world. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeWorldResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - world properties: world: description: The Amazon Resource Name (arn) of the world you want to describe. type: string pattern: arn:.* minLength: 1 maxLength: 1224 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /describeWorldExportJob: post: operationId: DescribeWorldExportJob description: Describes a world export job. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeWorldExportJobResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - job properties: job: description: The Amazon Resource Name (arn) of the world export job to describe. type: string pattern: arn:.* minLength: 1 maxLength: 1224 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /describeWorldGenerationJob: post: operationId: DescribeWorldGenerationJob description: Describes a world generation job. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeWorldGenerationJobResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - job properties: job: description: The Amazon Resource Name (arn) of the world generation job to describe. type: string pattern: arn:.* minLength: 1 maxLength: 1224 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /describeWorldTemplate: post: operationId: DescribeWorldTemplate description: Describes a world template. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeWorldTemplateResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - template properties: template: description: The Amazon Resource Name (arn) of the world template you want to describe. type: string pattern: arn:.* minLength: 1 maxLength: 1224 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /getWorldTemplateBody: post: operationId: GetWorldTemplateBody description: Gets the world template body. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetWorldTemplateBodyResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: [] requestBody: required: true content: application/json: schema: type: object properties: template: description: The Amazon Resource Name (arn) of the world template. type: string pattern: arn:.* minLength: 1 maxLength: 1224 generationJob: description: The Amazon Resource Name (arn) of the world generator job. type: string pattern: arn:.* minLength: 1 maxLength: 1224 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /listDeploymentJobs: post: deprecated: true operationId: ListDeploymentJobs description:

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.

 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListDeploymentJobsResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: - name: maxResults in: query schema: type: string description: Pagination limit required: false - name: nextToken in: query schema: type: string description: Pagination token required: false requestBody: required: true content: application/json: schema: type: object properties: filters: description:

Optional filters to limit results.

The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status InProgress or the status Pending.

type: array items: $ref: '#/components/schemas/Filter' minItems: 1 maxItems: 1 nextToken: description: "If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListDeploymentJobs again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. " type: string pattern: '[a-zA-Z0-9_.\-\/+=]*' minLength: 1 maxLength: 2048 maxResults: description: 'When this parameter is used, ListDeploymentJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListDeploymentJobs request with the returned nextToken value. This value can be between 1 and 200. If this parameter is not used, then ListDeploymentJobs returns up to 200 results and a nextToken value if applicable. ' type: integer parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /listFleets: post: deprecated: true operationId: ListFleets description:

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.

 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListFleetsResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: - name: maxResults in: query schema: type: string description: Pagination limit required: false - name: nextToken in: query schema: type: string description: Pagination token required: false requestBody: required: true content: application/json: schema: type: object properties: nextToken: description:

If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListFleets again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

 type: string pattern: '[a-zA-Z0-9_.\-\/+=]*' minLength: 1 maxLength: 2048 maxResults: description: 'When this parameter is used, ListFleets only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListFleets request with the returned nextToken value. This value can be between 1 and 200. If this parameter is not used, then ListFleets returns up to 200 results and a nextToken value if applicable. ' type: integer filters: description:

Optional filters to limit results.

The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.

type: array items: $ref: '#/components/schemas/Filter' minItems: 1 maxItems: 1 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /listRobotApplications: post: operationId: ListRobotApplications description: Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListRobotApplicationsResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: - name: maxResults in: query schema: type: string description: Pagination limit required: false - name: nextToken in: query schema: type: string description: Pagination token required: false requestBody: required: true content: application/json: schema: type: object properties: versionQualifier: description: The version qualifier of the robot application. type: string pattern: ALL minLength: 1 maxLength: 255 nextToken: description: "If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListRobotApplications again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. " type: string pattern: '[a-zA-Z0-9_.\-\/+=]*' minLength: 1 maxLength: 2048 maxResults: description: 'When this parameter is used, ListRobotApplications only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListRobotApplications request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListRobotApplications returns up to 100 results and a nextToken value if applicable. ' type: integer filters: description:

Optional filters to limit results.

The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.

type: array items: $ref: '#/components/schemas/Filter' minItems: 1 maxItems: 1 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /listRobots: post: deprecated: true operationId: ListRobots description:

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.

 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListRobotsResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: - name: maxResults in: query schema: type: string description: Pagination limit required: false - name: nextToken in: query schema: type: string description: Pagination token required: false requestBody: required: true content: application/json: schema: type: object properties: nextToken: description: "If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListRobots again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. " type: string pattern: '[a-zA-Z0-9_.\-\/+=]*' minLength: 1 maxLength: 2048 maxResults: description: 'When this parameter is used, ListRobots only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListRobots request with the returned nextToken value. This value can be between 1 and 200. If this parameter is not used, then ListRobots returns up to 200 results and a nextToken value if applicable. ' type: integer filters: description:

Optional filters to limit results.

The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Registered or the status Available.

type: array items: $ref: '#/components/schemas/Filter' minItems: 1 maxItems: 1 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /listSimulationApplications: post: operationId: ListSimulationApplications description: 'Returns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListSimulationApplicationsResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: - name: maxResults in: query schema: type: string description: Pagination limit required: false - name: nextToken in: query schema: type: string description: Pagination token required: false requestBody: required: true content: application/json: schema: type: object properties: versionQualifier: description: The version qualifier of the simulation application. type: string pattern: ALL minLength: 1 maxLength: 255 nextToken: description: "If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationApplications again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. " type: string pattern: '[a-zA-Z0-9_.\-\/+=]*' minLength: 1 maxLength: 2048 maxResults: description: 'When this parameter is used, ListSimulationApplications only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListSimulationApplications request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListSimulationApplications returns up to 100 results and a nextToken value if applicable. ' type: integer filters: description:

Optional list of filters to limit results.

The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.

type: array items: $ref: '#/components/schemas/Filter' minItems: 1 maxItems: 1 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /listSimulationJobBatches: post: operationId: ListSimulationJobBatches description: 'Returns a list simulation job batches. You can optionally provide filters to retrieve specific simulation batch jobs. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListSimulationJobBatchesResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: - name: maxResults in: query schema: type: string description: Pagination limit required: false - name: nextToken in: query schema: type: string description: Pagination token required: false requestBody: required: true content: application/json: schema: type: object properties: nextToken: description: "If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationJobBatches again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. " type: string pattern: '[a-zA-Z0-9_.\-\/+=]*' minLength: 1 maxLength: 2048 maxResults: description: 'When this parameter is used, ListSimulationJobBatches only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListSimulationJobBatches request with the returned nextToken value. ' type: integer filters: description: Optional filters to limit results. type: array items: $ref: '#/components/schemas/Filter' minItems: 1 maxItems: 1 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /listSimulationJobs: post: operationId: ListSimulationJobs description: 'Returns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListSimulationJobsResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: - name: maxResults in: query schema: type: string description: Pagination limit required: false - name: nextToken in: query schema: type: string description: Pagination token required: false requestBody: required: true content: application/json: schema: type: object properties: nextToken: description: "If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationJobs again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. " type: string pattern: '[a-zA-Z0-9_.\-\/+=]*' minLength: 1 maxLength: 2048 maxResults: description: 'When this parameter is used, ListSimulationJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListSimulationJobs request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then ListSimulationJobs returns up to 1000 results and a nextToken value if applicable. ' type: integer filters: description:

Optional filters to limit results.

The filter names status and simulationApplicationName and robotApplicationName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Preparing or the status Running.

type: array items: $ref: '#/components/schemas/Filter' minItems: 1 maxItems: 1 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /tags/{resourceArn}: get: operationId: ListTagsForResource description: Lists all tags on a AWS RoboMaker resource. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListTagsForResourceResponse' '480': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: - name: resourceArn in: path required: true description: The AWS RoboMaker Amazon Resource Name (ARN) with tags to be listed. schema: type: string pattern: arn:.* minLength: 1 maxLength: 1224 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: TagResource description:

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.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TagResourceResponse' '480': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: - name: resourceArn in: path required: true description: The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are tagging. schema: type: string pattern: arn:.* minLength: 1 maxLength: 1224 requestBody: required: true content: application/json: schema: type: object required: - tags properties: tags: description: A map that contains tag keys and tag values that are attached to the resource. type: object minProperties: 0 maxProperties: 50 additionalProperties: $ref: '#/components/schemas/TagValue' /listWorldExportJobs: post: operationId: ListWorldExportJobs description: Lists world export jobs. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListWorldExportJobsResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: - name: maxResults in: query schema: type: string description: Pagination limit required: false - name: nextToken in: query schema: type: string description: Pagination token required: false requestBody: required: true content: application/json: schema: type: object properties: nextToken: description: "If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorldExportJobs again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. " type: string pattern: '[a-zA-Z0-9_.\-\/+=]*' minLength: 1 maxLength: 2048 maxResults: description: 'When this parameter is used, ListWorldExportJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListWorldExportJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorldExportJobs returns up to 100 results and a nextToken value if applicable. ' type: integer filters: description: Optional filters to limit results. You can use generationJobId and templateId. type: array items: $ref: '#/components/schemas/Filter' minItems: 1 maxItems: 1 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /listWorldGenerationJobs: post: operationId: ListWorldGenerationJobs description: Lists world generator jobs. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListWorldGenerationJobsResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: - name: maxResults in: query schema: type: string description: Pagination limit required: false - name: nextToken in: query schema: type: string description: Pagination token required: false requestBody: required: true content: application/json: schema: type: object properties: nextToken: description: "If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorldGenerationJobsRequest again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. " type: string pattern: '[a-zA-Z0-9_.\-\/+=]*' minLength: 1 maxLength: 2048 maxResults: description: 'When this parameter is used, ListWorldGeneratorJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListWorldGeneratorJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorldGeneratorJobs returns up to 100 results and a nextToken value if applicable. ' type: integer filters: description: Optional filters to limit results. You can use status and templateId. type: array items: $ref: '#/components/schemas/Filter' minItems: 1 maxItems: 1 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /listWorldTemplates: post: operationId: ListWorldTemplates description: Lists world templates. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListWorldTemplatesResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: - name: maxResults in: query schema: type: string description: Pagination limit required: false - name: nextToken in: query schema: type: string description: Pagination token required: false requestBody: required: true content: application/json: schema: type: object properties: nextToken: description: "If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorldTemplates again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. " type: string pattern: '[a-zA-Z0-9_.\-\/+=]*' minLength: 1 maxLength: 2048 maxResults: description: 'When this parameter is used, ListWorldTemplates only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListWorldTemplates request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorldTemplates returns up to 100 results and a nextToken value if applicable. ' type: integer parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /listWorlds: post: operationId: ListWorlds description: Lists worlds. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListWorldsResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: - name: maxResults in: query schema: type: string description: Pagination limit required: false - name: nextToken in: query schema: type: string description: Pagination token required: false requestBody: required: true content: application/json: schema: type: object properties: nextToken: description: "If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorlds again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. " type: string pattern: '[a-zA-Z0-9_.\-\/+=]*' minLength: 1 maxLength: 2048 maxResults: description: 'When this parameter is used, ListWorlds only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListWorlds request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorlds returns up to 100 results and a nextToken value if applicable. ' type: integer filters: description: Optional filters to limit results. You can use status. type: array items: $ref: '#/components/schemas/Filter' minItems: 1 maxItems: 1 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /registerRobot: post: deprecated: true operationId: RegisterRobot description:

Registers a robot with a fleet.

This API is no longer supported and will throw an error if used.

 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RegisterRobotResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '483': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '484': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - fleet - robot properties: fleet: description: The Amazon Resource Name (ARN) of the fleet. type: string pattern: arn:.* minLength: 1 maxLength: 1224 robot: description: The Amazon Resource Name (ARN) of the robot. type: string pattern: arn:.* minLength: 1 maxLength: 1224 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /restartSimulationJob: post: operationId: RestartSimulationJob description: Restarts a running simulation job. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RestartSimulationJobResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '484': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - job properties: job: description: The Amazon Resource Name (ARN) of the simulation job. type: string pattern: arn:.* minLength: 1 maxLength: 1224 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /startSimulationJobBatch: post: operationId: StartSimulationJobBatch description: 'Starts a new simulation job batch. The batch is defined using one or more SimulationJobRequest objects. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StartSimulationJobBatchResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '483': description: IdempotentParameterMismatchException content: application/json: schema: $ref: '#/components/schemas/IdempotentParameterMismatchException' '484': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - createSimulationJobRequests properties: clientRequestToken: description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. type: string pattern: '[a-zA-Z0-9_\-=]*' minLength: 1 maxLength: 64 batchPolicy: description: Information about the batch policy. type: object properties: timeoutInSeconds: allOf: - $ref: '#/components/schemas/BatchTimeoutInSeconds' - description:

The amount of time, in seconds, to wait for the batch to complete.

If a batch times out, and there are pending requests that were failing due to an internal failure (like InternalServiceError), they will be moved to the failed list and the batch status will be Failed. If the pending requests were failing for any other reason, the failed pending requests will be moved to the failed list and the batch status will be TimedOut.

maxConcurrency: allOf: - $ref: '#/components/schemas/MaxConcurrency' - description: '

The number of active simulation jobs create as part of the batch that can be in an active state at the same time.

Active states include: Pending,Preparing, Running, Restarting, RunningFailed and Terminating. All other states are terminal states.

' createSimulationJobRequests: description: A list of simulation job requests to create in the batch. type: array items: $ref: '#/components/schemas/SimulationJobRequest' minItems: 1 maxItems: 1000 tags: description: A map that contains tag keys and tag values that are attached to the deployment job batch. type: object minProperties: 0 maxProperties: 50 additionalProperties: $ref: '#/components/schemas/TagValue' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /syncDeploymentJob: post: deprecated: true operationId: SyncDeploymentJob description:

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.

 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/SyncDeploymentJobResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '482': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '484': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '485': description: ConcurrentDeploymentException content: application/json: schema: $ref: '#/components/schemas/ConcurrentDeploymentException' '486': description: IdempotentParameterMismatchException content: application/json: schema: $ref: '#/components/schemas/IdempotentParameterMismatchException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - clientRequestToken - fleet properties: clientRequestToken: description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. type: string pattern: '[a-zA-Z0-9_\-=]*' minLength: 1 maxLength: 64 fleet: description: The target fleet for the synchronization. type: string pattern: arn:.* minLength: 1 maxLength: 1224 parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /tags/{resourceArn}#tagKeys: delete: operationId: UntagResource description:

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 .

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UntagResourceResponse' '480': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: - name: resourceArn in: path required: true description: The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are removing tags. schema: type: string pattern: arn:.* minLength: 1 maxLength: 1224 - name: tagKeys in: query required: true description: A map that contains tag keys and tag values that will be unattached from the resource. schema: type: array items: $ref: '#/components/schemas/TagKey' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /updateRobotApplication: post: operationId: UpdateRobotApplication description: Updates a robot application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateRobotApplicationResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '484': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - application - robotSoftwareSuite properties: application: description: The application information for the robot application. type: string pattern: arn:.* minLength: 1 maxLength: 1224 sources: description: The sources of the robot application. type: array items: $ref: '#/components/schemas/SourceConfig' robotSoftwareSuite: description: Information about a robot software suite (ROS distribution). type: object properties: name: allOf: - $ref: '#/components/schemas/RobotSoftwareSuiteType' - description: The name of the robot software suite (ROS distribution). version: allOf: - $ref: '#/components/schemas/RobotSoftwareSuiteVersionType' - description: The version of the robot software suite (ROS distribution). currentRevisionId: description: The revision id for the robot application. type: string pattern: '[a-zA-Z0-9_.\-]*' minLength: 1 maxLength: 40 environment: description: The object that contains the Docker image URI for either your robot or simulation applications. type: object properties: uri: allOf: - $ref: '#/components/schemas/RepositoryUrl' - description: The Docker image URI for either your robot or simulation applications. parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /updateSimulationApplication: post: operationId: UpdateSimulationApplication description: Updates a simulation application. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateSimulationApplicationResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '484': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - application - simulationSoftwareSuite - robotSoftwareSuite properties: application: description: The application information for the simulation application. type: string pattern: arn:.* minLength: 1 maxLength: 1224 sources: description: The sources of the simulation application. type: array items: $ref: '#/components/schemas/SourceConfig' simulationSoftwareSuite: description: Information about a simulation software suite. type: object properties: name: allOf: - $ref: '#/components/schemas/SimulationSoftwareSuiteType' - description: The name of the simulation software suite. version: allOf: - $ref: '#/components/schemas/SimulationSoftwareSuiteVersionType' - description: The version of the simulation software suite. robotSoftwareSuite: description: Information about a robot software suite (ROS distribution). type: object properties: name: allOf: - $ref: '#/components/schemas/RobotSoftwareSuiteType' - description: The name of the robot software suite (ROS distribution). version: allOf: - $ref: '#/components/schemas/RobotSoftwareSuiteVersionType' - description: The version of the robot software suite (ROS distribution). renderingEngine: description: Information about a rendering engine. type: object properties: name: allOf: - $ref: '#/components/schemas/RenderingEngineType' - description: The name of the rendering engine. version: allOf: - $ref: '#/components/schemas/RenderingEngineVersionType' - description: The version of the rendering engine. currentRevisionId: description: The revision id for the robot application. type: string pattern: '[a-zA-Z0-9_.\-]*' minLength: 1 maxLength: 40 environment: description: The object that contains the Docker image URI for either your robot or simulation applications. type: object properties: uri: allOf: - $ref: '#/components/schemas/RepositoryUrl' - description: The Docker image URI for either your robot or simulation applications. parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /updateWorldTemplate: post: operationId: UpdateWorldTemplate description: Updates a world template. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateWorldTemplateResponse' '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - template properties: template: description: The Amazon Resource Name (arn) of the world template to update. type: string pattern: arn:.* minLength: 1 maxLength: 1224 name: description: The name of the template. type: string pattern: .* minLength: 0 maxLength: 255 templateBody: description: The world template body. type: string pattern: '[\S\s]+' minLength: 1 maxLength: 262144 templateLocation: description: Information about a template location. type: object properties: s3Bucket: allOf: - $ref: '#/components/schemas/S3Bucket' - description: The Amazon S3 bucket name. s3Key: allOf: - $ref: '#/components/schemas/S3Key' - description: The list of S3 keys identifying the data source files. parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' components: parameters: X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 schemas: BatchDeleteWorldsResponse: type: object properties: unprocessedWorlds: allOf: - $ref: '#/components/schemas/Arns' - description: A list of unprocessed worlds associated with the call. These worlds were not deleted. Arn: type: string pattern: arn:.* minLength: 1 maxLength: 1224 InvalidParameterException: {} ThrottlingException: {} InternalServerException: {} BatchDescribeSimulationJobResponse: type: object properties: jobs: allOf: - $ref: '#/components/schemas/SimulationJobs' - description: A list of simulation jobs. unprocessedJobs: allOf: - $ref: '#/components/schemas/Arns' - description: A list of unprocessed simulation job Amazon Resource Names (ARNs). ResourceNotFoundException: {} CancelDeploymentJobResponse: type: object deprecated: true properties: {} description: Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html. CancelSimulationJobResponse: type: object properties: {} CancelSimulationJobBatchResponse: type: object properties: {} CancelWorldExportJobResponse: type: object properties: {} CancelWorldGenerationJobResponse: type: object properties: {} CreateDeploymentJobResponse: type: object deprecated: true properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the deployment job. fleet: allOf: - $ref: '#/components/schemas/Arn' - description: The target fleet for the deployment job. status: allOf: - $ref: '#/components/schemas/DeploymentStatus' - description: The status of the deployment job. deploymentApplicationConfigs: allOf: - $ref: '#/components/schemas/DeploymentApplicationConfigs' - description: The deployment application configuration. failureReason: allOf: - $ref: '#/components/schemas/GenericString' - description: The failure reason of the deployment job if it failed. failureCode: allOf: - $ref: '#/components/schemas/DeploymentJobErrorCode' - description:

The failure code of the simulation job if it failed:

BadPermissionError

AWS Greengrass requires a service-level role permission to access other services. The role must include the AWSGreengrassResourceAccessRolePolicy managed policy.

ExtractingBundleFailure

The robot application could not be extracted from the bundle.

FailureThresholdBreached

The percentage of robots that could not be updated exceeded the percentage set for the deployment.

GreengrassDeploymentFailed

The robot application could not be deployed to the robot.

GreengrassGroupVersionDoesNotExist

The AWS Greengrass group or version associated with a robot is missing.

InternalServerError

An internal error has occurred. Retry your request, but if the problem persists, contact us with details.

MissingRobotApplicationArchitecture

The robot application does not have a source that matches the architecture of the robot.

MissingRobotDeploymentResource

One or more of the resources specified for the robot application are missing. For example, does the robot application have the correct launch package and launch file?

PostLaunchFileFailure

The post-launch script failed.

PreLaunchFileFailure

The pre-launch script failed.

ResourceNotFound

One or more deployment resources are missing. For example, do robot application source bundles still exist?

RobotDeploymentNoResponse

There is no response from the robot. It might not be powered on or connected to the internet.

createdAt: allOf: - $ref: '#/components/schemas/CreatedAt' - description: The time, in milliseconds since the epoch, when the fleet was created. deploymentConfig: allOf: - $ref: '#/components/schemas/DeploymentConfig' - description: The deployment configuration. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: The list of all tags added to the deployment job. description: AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html. Percentage: type: integer minimum: 1 maximum: 100 DeploymentTimeout: type: integer S3Object: type: object required: - bucket - key properties: bucket: allOf: - $ref: '#/components/schemas/S3Bucket' - description: The bucket containing the object. key: allOf: - $ref: '#/components/schemas/S3Key' - description: The key of the object. etag: allOf: - $ref: '#/components/schemas/S3Etag' - description: The etag of the object. description: Information about an S3 object. DeploymentApplicationConfig: type: object required: - application - applicationVersion - launchConfig properties: application: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the robot application. applicationVersion: allOf: - $ref: '#/components/schemas/DeploymentVersion' - description: The version of the application. launchConfig: allOf: - $ref: '#/components/schemas/DeploymentLaunchConfig' - description: The launch configuration. description: Information about a deployment application configuration. TagValue: type: string pattern: '[a-zA-Z0-9 _.\-\/+=:]*' minLength: 0 maxLength: 256 LimitExceededException: {} ConcurrentDeploymentException: {} IdempotentParameterMismatchException: {} CreateFleetResponse: type: object deprecated: true properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the fleet. name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the fleet. createdAt: allOf: - $ref: '#/components/schemas/CreatedAt' - description: The time, in milliseconds since the epoch, when the fleet was created. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: The list of all tags added to the fleet. description: AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html. CreateRobotResponse: type: object deprecated: true properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the robot. name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the robot. createdAt: allOf: - $ref: '#/components/schemas/CreatedAt' - description: The time, in milliseconds since the epoch, when the robot was created. greengrassGroupId: allOf: - $ref: '#/components/schemas/Id' - description: The Amazon Resource Name (ARN) of the Greengrass group associated with the robot. architecture: allOf: - $ref: '#/components/schemas/Architecture' - description: The target architecture of the robot. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: The list of all tags added to the robot. description: AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html. ResourceAlreadyExistsException: {} CreateRobotApplicationResponse: type: object properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the robot application. name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the robot application. version: allOf: - $ref: '#/components/schemas/Version' - description: The version of the robot application. sources: allOf: - $ref: '#/components/schemas/Sources' - description: The sources of the robot application. robotSoftwareSuite: allOf: - $ref: '#/components/schemas/RobotSoftwareSuite' - description: The robot software suite (ROS distribution) used by the robot application. lastUpdatedAt: allOf: - $ref: '#/components/schemas/LastUpdatedAt' - description: The time, in milliseconds since the epoch, when the robot application was last updated. revisionId: allOf: - $ref: '#/components/schemas/RevisionId' - description: The revision id of the robot application. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: The list of all tags added to the robot application. environment: allOf: - $ref: '#/components/schemas/Environment' - description: An object that contains the Docker image URI used to a create your robot application. SourceConfig: type: object properties: s3Bucket: allOf: - $ref: '#/components/schemas/S3Bucket' - description: The Amazon S3 bucket name. s3Key: allOf: - $ref: '#/components/schemas/S3Key' - description: The s3 object key. architecture: allOf: - $ref: '#/components/schemas/Architecture' - description: The target processor architecture for the application. description: Information about a source configuration. RobotSoftwareSuiteType: type: string enum: - ROS - ROS2 - General RobotSoftwareSuiteVersionType: type: string enum: - Kinetic - Melodic - Dashing - Foxy RepositoryUrl: type: string pattern: .+ minLength: 1 maxLength: 1024 CreateRobotApplicationVersionResponse: type: object properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the robot application. name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the robot application. version: allOf: - $ref: '#/components/schemas/Version' - description: The version of the robot application. sources: allOf: - $ref: '#/components/schemas/Sources' - description: The sources of the robot application. robotSoftwareSuite: allOf: - $ref: '#/components/schemas/RobotSoftwareSuite' - description: The robot software suite (ROS distribution) used by the robot application. lastUpdatedAt: allOf: - $ref: '#/components/schemas/LastUpdatedAt' - description: The time, in milliseconds since the epoch, when the robot application was last updated. revisionId: allOf: - $ref: '#/components/schemas/RevisionId' - description: The revision id of the robot application. environment: allOf: - $ref: '#/components/schemas/Environment' - description: The object that contains the Docker image URI used to create your robot application. S3Etag: type: string CreateSimulationApplicationResponse: type: object properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the simulation application. name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the simulation application. version: allOf: - $ref: '#/components/schemas/Version' - description: The version of the simulation application. sources: allOf: - $ref: '#/components/schemas/Sources' - description: The sources of the simulation application. simulationSoftwareSuite: allOf: - $ref: '#/components/schemas/SimulationSoftwareSuite' - description: The simulation software suite used by the simulation application. robotSoftwareSuite: allOf: - $ref: '#/components/schemas/RobotSoftwareSuite' - description: Information about the robot software suite (ROS distribution). renderingEngine: allOf: - $ref: '#/components/schemas/RenderingEngine' - description: The rendering engine for the simulation application. lastUpdatedAt: allOf: - $ref: '#/components/schemas/LastUpdatedAt' - description: The time, in milliseconds since the epoch, when the simulation application was last updated. revisionId: allOf: - $ref: '#/components/schemas/RevisionId' - description: The revision id of the simulation application. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: The list of all tags added to the simulation application. environment: allOf: - $ref: '#/components/schemas/Environment' - description: The object that contains the Docker image URI that you used to create your simulation application. SimulationSoftwareSuiteType: type: string enum: - Gazebo - RosbagPlay - SimulationRuntime SimulationSoftwareSuiteVersionType: type: string pattern: 7|9|11|Kinetic|Melodic|Dashing|Foxy minLength: 0 maxLength: 1024 RenderingEngineType: type: string enum: - OGRE RenderingEngineVersionType: type: string pattern: 1.x minLength: 1 maxLength: 4 CreateSimulationApplicationVersionResponse: type: object properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the simulation application. name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the simulation application. version: allOf: - $ref: '#/components/schemas/Version' - description: The version of the simulation application. sources: allOf: - $ref: '#/components/schemas/Sources' - description: The sources of the simulation application. simulationSoftwareSuite: allOf: - $ref: '#/components/schemas/SimulationSoftwareSuite' - description: The simulation software suite used by the simulation application. robotSoftwareSuite: allOf: - $ref: '#/components/schemas/RobotSoftwareSuite' - description: Information about the robot software suite (ROS distribution). renderingEngine: allOf: - $ref: '#/components/schemas/RenderingEngine' - description: The rendering engine for the simulation application. lastUpdatedAt: allOf: - $ref: '#/components/schemas/LastUpdatedAt' - description: The time, in milliseconds since the epoch, when the simulation application was last updated. revisionId: allOf: - $ref: '#/components/schemas/RevisionId' - description: The revision ID of the simulation application. environment: allOf: - $ref: '#/components/schemas/Environment' - description: The object that contains the Docker image URI used to create the simulation application. CreateSimulationJobResponse: type: object properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the simulation job. status: allOf: - $ref: '#/components/schemas/SimulationJobStatus' - description: The status of the simulation job. lastStartedAt: allOf: - $ref: '#/components/schemas/LastStartedAt' - description: The time, in milliseconds since the epoch, when the simulation job was last started. lastUpdatedAt: allOf: - $ref: '#/components/schemas/LastUpdatedAt' - description: The time, in milliseconds since the epoch, when the simulation job was last updated. failureBehavior: allOf: - $ref: '#/components/schemas/FailureBehavior' - description: the failure behavior for the simulation job. failureCode: allOf: - $ref: '#/components/schemas/SimulationJobErrorCode' - description:

The failure code of the simulation job if it failed:

InternalServiceError

Internal service error.

RobotApplicationCrash

Robot application exited abnormally.

SimulationApplicationCrash

Simulation application exited abnormally.

BadPermissionsRobotApplication

Robot application bundle could not be downloaded.

BadPermissionsSimulationApplication

Simulation application bundle could not be downloaded.

BadPermissionsS3Output

Unable to publish outputs to customer-provided S3 bucket.

BadPermissionsCloudwatchLogs

Unable to publish logs to customer-provided CloudWatch Logs resource.

SubnetIpLimitExceeded

Subnet IP limit exceeded.

ENILimitExceeded

ENI limit exceeded.

BadPermissionsUserCredentials

Unable to use the Role provided.

InvalidBundleRobotApplication

Robot bundle cannot be extracted (invalid format, bundling error, or other issue).

InvalidBundleSimulationApplication

Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).

RobotApplicationVersionMismatchedEtag

Etag for RobotApplication does not match value during version creation.

SimulationApplicationVersionMismatchedEtag

Etag for SimulationApplication does not match value during version creation.

clientRequestToken: allOf: - $ref: '#/components/schemas/ClientRequestToken' - description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. outputLocation: allOf: - $ref: '#/components/schemas/OutputLocation' - description: Simulation job output files location. loggingConfig: allOf: - $ref: '#/components/schemas/LoggingConfig' - description: The logging configuration. maxJobDurationInSeconds: allOf: - $ref: '#/components/schemas/JobDuration' - description: 'The maximum simulation job duration in seconds. ' simulationTimeMillis: allOf: - $ref: '#/components/schemas/SimulationTimeMillis' - description: The simulation job execution duration in milliseconds. iamRole: allOf: - $ref: '#/components/schemas/IamRole' - description: The IAM role that allows the simulation job to call the AWS APIs that are specified in its associated policies on your behalf. robotApplications: allOf: - $ref: '#/components/schemas/RobotApplicationConfigs' - description: The robot application used by the simulation job. simulationApplications: allOf: - $ref: '#/components/schemas/SimulationApplicationConfigs' - description: The simulation application used by the simulation job. dataSources: allOf: - $ref: '#/components/schemas/DataSources' - description: The data sources for the simulation job. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: The list of all tags added to the simulation job. vpcConfig: allOf: - $ref: '#/components/schemas/VPCConfigResponse' - description: Information about the vpc configuration. compute: allOf: - $ref: '#/components/schemas/ComputeResponse' - description: Compute information for the simulation job. S3Bucket: type: string pattern: '[a-z0-9][a-z0-9.\-]*[a-z0-9]' minLength: 3 maxLength: 63 S3Key: type: string pattern: .* minLength: 1 maxLength: 1024 BoxedBoolean: type: boolean RobotApplicationConfig: type: object required: - application - launchConfig properties: application: allOf: - $ref: '#/components/schemas/Arn' - description: The application information for the robot application. applicationVersion: allOf: - $ref: '#/components/schemas/Version' - description: The version of the robot application. launchConfig: allOf: - $ref: '#/components/schemas/LaunchConfig' - description: The launch configuration for the robot application. uploadConfigurations: allOf: - $ref: '#/components/schemas/UploadConfigurations' - description: The upload configurations for the robot application. useDefaultUploadConfigurations: allOf: - $ref: '#/components/schemas/BoxedBoolean' - deprecated: true description:

A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.

If you set this value, you must specify an outputLocation.

This API is no longer supported and will throw an error if used.

AWS RoboMaker is ending support for ROS software suite. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/software-support-policy.html. tools: allOf: - $ref: '#/components/schemas/Tools' - description: Information about tools configured for the robot application. useDefaultTools: allOf: - $ref: '#/components/schemas/BoxedBoolean' - deprecated: true description:

A Boolean indicating whether to use default robot application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False.

This API is no longer supported and will throw an error if used.

AWS RoboMaker is ending support for ROS software suite. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/software-support-policy.html. description: Application configuration information for a robot. SimulationApplicationConfig: type: object required: - application - launchConfig properties: application: allOf: - $ref: '#/components/schemas/Arn' - description: The application information for the simulation application. applicationVersion: allOf: - $ref: '#/components/schemas/Version' - description: The version of the simulation application. launchConfig: allOf: - $ref: '#/components/schemas/LaunchConfig' - description: The launch configuration for the simulation application. uploadConfigurations: allOf: - $ref: '#/components/schemas/UploadConfigurations' - description: Information about upload configurations for the simulation application. worldConfigs: allOf: - $ref: '#/components/schemas/WorldConfigs' - description: A list of world configurations. useDefaultUploadConfigurations: allOf: - $ref: '#/components/schemas/BoxedBoolean' - deprecated: true description:

A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.

If you set this value, you must specify an outputLocation.

This API is no longer supported and will throw an error if used.

AWS RoboMaker is ending support for ROS software suite. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/software-support-policy.html. tools: allOf: - $ref: '#/components/schemas/Tools' - description: Information about tools configured for the simulation application. useDefaultTools: allOf: - $ref: '#/components/schemas/BoxedBoolean' - deprecated: true description:

A Boolean indicating whether to use default simulation application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False.

This API is no longer supported and will throw an error if used.

AWS RoboMaker is ending support for ROS software suite. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/software-support-policy.html. description: Information about a simulation application configuration. DataSourceConfig: type: object required: - name - s3Bucket - s3Keys properties: name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the data source. s3Bucket: allOf: - $ref: '#/components/schemas/S3Bucket' - description: The S3 bucket where the data files are located. s3Keys: allOf: - $ref: '#/components/schemas/S3KeysOrPrefixes' - description: The list of S3 keys identifying the data source files. type: allOf: - $ref: '#/components/schemas/DataSourceType' - description:

The data type for the data source that you're using for your container image or simulation job. You can use this field to specify whether your data source is an Archive, an Amazon S3 prefix, or a file.

If you don't specify a field, the default value is File.

destination: allOf: - $ref: '#/components/schemas/Path' - description:

The location where your files are mounted in the container image.

If you've specified the type of the data source as an Archive, you must provide an Amazon S3 object key to your archive. The object key must point to either a .zip or .tar.gz file.

If you've specified the type of the data source as a Prefix, you provide the Amazon S3 prefix that points to the files that you are using for your data source.

If you've specified the type of the data source as a File, you provide the Amazon S3 path to the file that you're using as your data source.

description: Information about a data source. Subnets: type: array items: $ref: '#/components/schemas/NonEmptyString' minItems: 1 maxItems: 16 SecurityGroups: type: array items: $ref: '#/components/schemas/NonEmptyString' minItems: 1 maxItems: 5 Boolean: type: boolean SimulationUnit: type: integer minimum: 1 maximum: 15 ComputeType: type: string enum: - CPU - GPU_AND_CPU GPUUnit: type: integer minimum: 0 maximum: 1 ServiceUnavailableException: {} CreateWorldExportJobResponse: type: object properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the world export job. status: allOf: - $ref: '#/components/schemas/WorldExportJobStatus' - description:

The status of the world export job.

Pending

The world export job request is pending.

Running

The world export job is running.

Completed

The world export job completed.

Failed

The world export job failed. See failureCode for more information.

Canceled

The world export job was cancelled.

Canceling

The world export job is being cancelled.

createdAt: allOf: - $ref: '#/components/schemas/CreatedAt' - description: The time, in milliseconds since the epoch, when the world export job was created. failureCode: allOf: - $ref: '#/components/schemas/WorldExportJobErrorCode' - description:

The failure code of the world export job if it failed:

InternalServiceError

Internal service error.

LimitExceeded

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

ResourceNotFound

The specified resource could not be found.

RequestThrottled

The request was throttled.

InvalidInput

An input parameter in the request is not valid.

AllWorldGenerationFailed

All of the worlds in the world generation job failed. This can happen if your worldCount is greater than 50 or less than 1.

For more information about troubleshooting WorldForge, see Troubleshooting Simulation WorldForge.

clientRequestToken: allOf: - $ref: '#/components/schemas/ClientRequestToken' - description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. outputLocation: $ref: '#/components/schemas/OutputLocation' iamRole: allOf: - $ref: '#/components/schemas/IamRole' - description: 'The IAM role that the world export process uses to access the Amazon S3 bucket and put the export. ' tags: allOf: - $ref: '#/components/schemas/TagMap' - description: A map that contains tag keys and tag values that are attached to the world export job. CreateWorldGenerationJobResponse: type: object properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the world generator job. status: allOf: - $ref: '#/components/schemas/WorldGenerationJobStatus' - description:

The status of the world generator job.

Pending

The world generator job request is pending.

Running

The world generator job is running.

Completed

The world generator job completed.

Failed

The world generator job failed. See failureCode for more information.

PartialFailed

Some worlds did not generate.

Canceled

The world generator job was cancelled.

Canceling

The world generator job is being cancelled.

createdAt: allOf: - $ref: '#/components/schemas/CreatedAt' - description: The time, in milliseconds since the epoch, when the world generator job was created. failureCode: allOf: - $ref: '#/components/schemas/WorldGenerationJobErrorCode' - description:

The failure code of the world generator job if it failed:

InternalServiceError

Internal service error.

LimitExceeded

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

ResourceNotFound

The specified resource could not be found.

RequestThrottled

The request was throttled.

InvalidInput

An input parameter in the request is not valid.

clientRequestToken: allOf: - $ref: '#/components/schemas/ClientRequestToken' - description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. template: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (arn) of the world template. worldCount: allOf: - $ref: '#/components/schemas/WorldCount' - description: 'Information about the world count. ' tags: allOf: - $ref: '#/components/schemas/TagMap' - description: A map that contains tag keys and tag values that are attached to the world generator job. worldTags: allOf: - $ref: '#/components/schemas/TagMap' - description: A map that contains tag keys and tag values that are attached to the generated worlds. FloorplanCount: type: integer InteriorCountPerFloorplan: type: integer CreateWorldTemplateResponse: type: object properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the world template. clientRequestToken: allOf: - $ref: '#/components/schemas/ClientRequestToken' - description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. createdAt: allOf: - $ref: '#/components/schemas/CreatedAt' - description: The time, in milliseconds since the epoch, when the world template was created. name: allOf: - $ref: '#/components/schemas/TemplateName' - description: The name of the world template. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: A map that contains tag keys and tag values that are attached to the world template. DeleteFleetResponse: type: object deprecated: true properties: {} description: Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html. DeleteRobotResponse: type: object deprecated: true properties: {} description: Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html. DeleteRobotApplicationResponse: type: object properties: {} DeleteSimulationApplicationResponse: type: object properties: {} DeleteWorldTemplateResponse: type: object properties: {} DeregisterRobotResponse: type: object deprecated: true properties: fleet: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the fleet. robot: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the robot. description: Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html. DescribeDeploymentJobResponse: type: object deprecated: true properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the deployment job. fleet: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the fleet. status: allOf: - $ref: '#/components/schemas/DeploymentStatus' - description: The status of the deployment job. deploymentConfig: allOf: - $ref: '#/components/schemas/DeploymentConfig' - description: The deployment configuration. deploymentApplicationConfigs: allOf: - $ref: '#/components/schemas/DeploymentApplicationConfigs' - description: The deployment application configuration. failureReason: allOf: - $ref: '#/components/schemas/GenericString' - description: A short description of the reason why the deployment job failed. failureCode: allOf: - $ref: '#/components/schemas/DeploymentJobErrorCode' - description: The deployment job failure code. createdAt: allOf: - $ref: '#/components/schemas/CreatedAt' - description: The time, in milliseconds since the epoch, when the deployment job was created. robotDeploymentSummary: allOf: - $ref: '#/components/schemas/RobotDeploymentSummary' - description: A list of robot deployment summaries. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: The list of all tags added to the specified deployment job. description: Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html. DescribeFleetResponse: type: object deprecated: true properties: name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the fleet. arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the fleet. robots: allOf: - $ref: '#/components/schemas/Robots' - description: A list of robots. createdAt: allOf: - $ref: '#/components/schemas/CreatedAt' - description: The time, in milliseconds since the epoch, when the fleet was created. lastDeploymentStatus: allOf: - $ref: '#/components/schemas/DeploymentStatus' - description: The status of the last deployment. lastDeploymentJob: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the last deployment job. lastDeploymentTime: allOf: - $ref: '#/components/schemas/CreatedAt' - description: The time of the last deployment. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: The list of all tags added to the specified fleet. description: Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html. DescribeRobotResponse: type: object deprecated: true properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the robot. name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the robot. fleetArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the fleet. status: allOf: - $ref: '#/components/schemas/RobotStatus' - description: The status of the fleet. greengrassGroupId: allOf: - $ref: '#/components/schemas/Id' - description: The Greengrass group id. createdAt: allOf: - $ref: '#/components/schemas/CreatedAt' - description: The time, in milliseconds since the epoch, when the robot was created. architecture: allOf: - $ref: '#/components/schemas/Architecture' - description: The target architecture of the robot application. lastDeploymentJob: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the last deployment job. lastDeploymentTime: allOf: - $ref: '#/components/schemas/CreatedAt' - description: The time of the last deployment job. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: The list of all tags added to the specified robot. description: Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html. DescribeRobotApplicationResponse: type: object properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the robot application. name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the robot application. version: allOf: - $ref: '#/components/schemas/Version' - description: The version of the robot application. sources: allOf: - $ref: '#/components/schemas/Sources' - description: The sources of the robot application. robotSoftwareSuite: allOf: - $ref: '#/components/schemas/RobotSoftwareSuite' - description: The robot software suite (ROS distribution) used by the robot application. revisionId: allOf: - $ref: '#/components/schemas/RevisionId' - description: The revision id of the robot application. lastUpdatedAt: allOf: - $ref: '#/components/schemas/LastUpdatedAt' - description: The time, in milliseconds since the epoch, when the robot application was last updated. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: The list of all tags added to the specified robot application. environment: allOf: - $ref: '#/components/schemas/Environment' - description: The object that contains the Docker image URI used to create the robot application. imageDigest: allOf: - $ref: '#/components/schemas/ImageDigest' - description: A SHA256 identifier for the Docker image that you use for your robot application. DescribeSimulationApplicationResponse: type: object properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the robot simulation application. name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the simulation application. version: allOf: - $ref: '#/components/schemas/Version' - description: The version of the simulation application. sources: allOf: - $ref: '#/components/schemas/Sources' - description: The sources of the simulation application. simulationSoftwareSuite: allOf: - $ref: '#/components/schemas/SimulationSoftwareSuite' - description: The simulation software suite used by the simulation application. robotSoftwareSuite: allOf: - $ref: '#/components/schemas/RobotSoftwareSuite' - description: Information about the robot software suite (ROS distribution). renderingEngine: allOf: - $ref: '#/components/schemas/RenderingEngine' - description: The rendering engine for the simulation application. revisionId: allOf: - $ref: '#/components/schemas/RevisionId' - description: The revision id of the simulation application. lastUpdatedAt: allOf: - $ref: '#/components/schemas/LastUpdatedAt' - description: The time, in milliseconds since the epoch, when the simulation application was last updated. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: The list of all tags added to the specified simulation application. environment: allOf: - $ref: '#/components/schemas/Environment' - description: The object that contains the Docker image URI used to create the simulation application. imageDigest: allOf: - $ref: '#/components/schemas/ImageDigest' - description: A SHA256 identifier for the Docker image that you use for your simulation application. DescribeSimulationJobResponse: type: object properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the simulation job. name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the simulation job. status: allOf: - $ref: '#/components/schemas/SimulationJobStatus' - description: The status of the simulation job. lastStartedAt: allOf: - $ref: '#/components/schemas/LastStartedAt' - description: The time, in milliseconds since the epoch, when the simulation job was last started. lastUpdatedAt: allOf: - $ref: '#/components/schemas/LastUpdatedAt' - description: The time, in milliseconds since the epoch, when the simulation job was last updated. failureBehavior: allOf: - $ref: '#/components/schemas/FailureBehavior' - description: The failure behavior for the simulation job. failureCode: allOf: - $ref: '#/components/schemas/SimulationJobErrorCode' - description:

The failure code of the simulation job if it failed:

InternalServiceError

Internal service error.

RobotApplicationCrash

Robot application exited abnormally.

SimulationApplicationCrash

Simulation application exited abnormally.

BadPermissionsRobotApplication

Robot application bundle could not be downloaded.

BadPermissionsSimulationApplication

Simulation application bundle could not be downloaded.

BadPermissionsS3Output

Unable to publish outputs to customer-provided S3 bucket.

BadPermissionsCloudwatchLogs

Unable to publish logs to customer-provided CloudWatch Logs resource.

SubnetIpLimitExceeded

Subnet IP limit exceeded.

ENILimitExceeded

ENI limit exceeded.

BadPermissionsUserCredentials

Unable to use the Role provided.

InvalidBundleRobotApplication

Robot bundle cannot be extracted (invalid format, bundling error, or other issue).

InvalidBundleSimulationApplication

Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).

RobotApplicationVersionMismatchedEtag

Etag for RobotApplication does not match value during version creation.

SimulationApplicationVersionMismatchedEtag

Etag for SimulationApplication does not match value during version creation.

failureReason: allOf: - $ref: '#/components/schemas/GenericString' - description: Details about why the simulation job failed. For more information about troubleshooting, see Troubleshooting. clientRequestToken: allOf: - $ref: '#/components/schemas/ClientRequestToken' - description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. outputLocation: allOf: - $ref: '#/components/schemas/OutputLocation' - description: Location for output files generated by the simulation job. loggingConfig: allOf: - $ref: '#/components/schemas/LoggingConfig' - description: The logging configuration. maxJobDurationInSeconds: allOf: - $ref: '#/components/schemas/JobDuration' - description: The maximum job duration in seconds. The value must be 8 days (691,200 seconds) or less. simulationTimeMillis: allOf: - $ref: '#/components/schemas/SimulationTimeMillis' - description: The simulation job execution duration in milliseconds. iamRole: allOf: - $ref: '#/components/schemas/IamRole' - description: The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. robotApplications: allOf: - $ref: '#/components/schemas/RobotApplicationConfigs' - description: A list of robot applications. simulationApplications: allOf: - $ref: '#/components/schemas/SimulationApplicationConfigs' - description: A list of simulation applications. dataSources: allOf: - $ref: '#/components/schemas/DataSources' - description: The data sources for the simulation job. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: The list of all tags added to the specified simulation job. vpcConfig: allOf: - $ref: '#/components/schemas/VPCConfigResponse' - description: The VPC configuration. networkInterface: allOf: - $ref: '#/components/schemas/NetworkInterface' - description: The network interface information for the simulation job. compute: allOf: - $ref: '#/components/schemas/ComputeResponse' - description: Compute information for the simulation job. DescribeSimulationJobBatchResponse: type: object properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the batch. status: allOf: - $ref: '#/components/schemas/SimulationJobBatchStatus' - description:

The status of the batch.

Pending

The simulation job batch request is pending.

InProgress

The simulation job batch is in progress.

Failed

The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like InternalServiceError). See failureCode and failureReason for more information.

Completed

The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to InternalServiceError and (2) when all created simulation jobs have reached a terminal state (for example, Completed or Failed).

Canceled

The simulation batch job was cancelled.

Canceling

The simulation batch job is being cancelled.

Completing

The simulation batch job is completing.

TimingOut

The simulation job batch is timing out.

If a batch timing out, and there are pending requests that were failing due to an internal failure (like InternalServiceError), the batch status will be Failed. If there are no such failing request, the batch status will be TimedOut.

TimedOut

The simulation batch job timed out.

lastUpdatedAt: allOf: - $ref: '#/components/schemas/LastUpdatedAt' - description: The time, in milliseconds since the epoch, when the simulation job batch was last updated. createdAt: allOf: - $ref: '#/components/schemas/CreatedAt' - description: The time, in milliseconds since the epoch, when the simulation job batch was created. clientRequestToken: allOf: - $ref: '#/components/schemas/ClientRequestToken' - description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. batchPolicy: allOf: - $ref: '#/components/schemas/BatchPolicy' - description: The batch policy. failureCode: allOf: - $ref: '#/components/schemas/SimulationJobBatchErrorCode' - description: The failure code of the simulation job batch. failureReason: allOf: - $ref: '#/components/schemas/GenericString' - description: The reason the simulation job batch failed. failedRequests: allOf: - $ref: '#/components/schemas/FailedCreateSimulationJobRequests' - description: 'A list of failed create simulation job requests. The request failed to be created into a simulation job. Failed requests do not have a simulation job ID. ' pendingRequests: allOf: - $ref: '#/components/schemas/CreateSimulationJobRequests' - description: A list of pending simulation job requests. These requests have not yet been created into simulation jobs. createdRequests: allOf: - $ref: '#/components/schemas/SimulationJobSummaries' - description: A list of created simulation job summaries. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: A map that contains tag keys and tag values that are attached to the simulation job batch. DescribeWorldResponse: type: object properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (arn) of the world. generationJob: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (arn) of the world generation job that generated the world. template: allOf: - $ref: '#/components/schemas/Arn' - description: The world template. createdAt: allOf: - $ref: '#/components/schemas/CreatedAt' - description: The time, in milliseconds since the epoch, when the world was created. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: A map that contains tag keys and tag values that are attached to the world. worldDescriptionBody: allOf: - $ref: '#/components/schemas/Json' - description: Returns the JSON formatted string that describes the contents of your world. DescribeWorldExportJobResponse: type: object properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the world export job. status: allOf: - $ref: '#/components/schemas/WorldExportJobStatus' - description:

The status of the world export job.

Pending

The world export job request is pending.

Running

The world export job is running.

Completed

The world export job completed.

Failed

The world export job failed. See failureCode and failureReason for more information.

Canceled

The world export job was cancelled.

Canceling

The world export job is being cancelled.

createdAt: allOf: - $ref: '#/components/schemas/CreatedAt' - description: The time, in milliseconds since the epoch, when the world export job was created. failureCode: allOf: - $ref: '#/components/schemas/WorldExportJobErrorCode' - description:

The failure code of the world export job if it failed:

InternalServiceError

Internal service error.

LimitExceeded

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

ResourceNotFound

The specified resource could not be found.

RequestThrottled

The request was throttled.

InvalidInput

An input parameter in the request is not valid.

failureReason: allOf: - $ref: '#/components/schemas/GenericString' - description: The reason why the world export job failed. clientRequestToken: allOf: - $ref: '#/components/schemas/ClientRequestToken' - description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. worlds: allOf: - $ref: '#/components/schemas/Arns' - description: A list of Amazon Resource Names (arns) that correspond to worlds to be exported. outputLocation: $ref: '#/components/schemas/OutputLocation' iamRole: allOf: - $ref: '#/components/schemas/IamRole' - description: The IAM role that the world export process uses to access the Amazon S3 bucket and put the export. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: A map that contains tag keys and tag values that are attached to the world export job. DescribeWorldGenerationJobResponse: type: object properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the world generation job. status: allOf: - $ref: '#/components/schemas/WorldGenerationJobStatus' - description:

The status of the world generation job:

Pending

The world generation job request is pending.

Running

The world generation job is running.

Completed

The world generation job completed.

Failed

The world generation job failed. See failureCode for more information.

PartialFailed

Some worlds did not generate.

Canceled

The world generation job was cancelled.

Canceling

The world generation job is being cancelled.

createdAt: allOf: - $ref: '#/components/schemas/CreatedAt' - description: The time, in milliseconds since the epoch, when the world generation job was created. failureCode: allOf: - $ref: '#/components/schemas/WorldGenerationJobErrorCode' - description:

The failure code of the world generation job if it failed:

InternalServiceError

Internal service error.

LimitExceeded

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

ResourceNotFound

The specified resource could not be found.

RequestThrottled

The request was throttled.

InvalidInput

An input parameter in the request is not valid.

failureReason: allOf: - $ref: '#/components/schemas/GenericString' - description: The reason why the world generation job failed. clientRequestToken: allOf: - $ref: '#/components/schemas/ClientRequestToken' - description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. template: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (arn) of the world template. worldCount: allOf: - $ref: '#/components/schemas/WorldCount' - description: Information about the world count. finishedWorldsSummary: allOf: - $ref: '#/components/schemas/FinishedWorldsSummary' - description: Summary information about finished worlds. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: A map that contains tag keys and tag values that are attached to the world generation job. worldTags: allOf: - $ref: '#/components/schemas/TagMap' - description: A map that contains tag keys and tag values that are attached to the generated worlds. DescribeWorldTemplateResponse: type: object properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the world template. clientRequestToken: allOf: - $ref: '#/components/schemas/ClientRequestToken' - description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. name: allOf: - $ref: '#/components/schemas/TemplateName' - description: The name of the world template. createdAt: allOf: - $ref: '#/components/schemas/CreatedAt' - description: The time, in milliseconds since the epoch, when the world template was created. lastUpdatedAt: allOf: - $ref: '#/components/schemas/LastUpdatedAt' - description: The time, in milliseconds since the epoch, when the world template was last updated. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: A map that contains tag keys and tag values that are attached to the world template. version: allOf: - $ref: '#/components/schemas/GenericString' - description: The version of the world template that you're using. GetWorldTemplateBodyResponse: type: object properties: templateBody: allOf: - $ref: '#/components/schemas/Json' - description: The world template body. ListDeploymentJobsResponse: type: object deprecated: true properties: deploymentJobs: allOf: - $ref: '#/components/schemas/DeploymentJobs' - description: A list of deployment jobs that meet the criteria of the request. nextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: "If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListDeploymentJobs again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. " description: Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html. Filter: type: object properties: name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the filter. values: allOf: - $ref: '#/components/schemas/FilterValues' - description: A list of values. description: Information about a filter. ListFleetsResponse: type: object deprecated: true properties: fleetDetails: allOf: - $ref: '#/components/schemas/Fleets' - description: A list of fleet details meeting the request criteria. nextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: "If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListFleets again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. " description: Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html. ListRobotApplicationsResponse: type: object properties: robotApplicationSummaries: allOf: - $ref: '#/components/schemas/RobotApplicationSummaries' - description: A list of robot application summaries that meet the criteria of the request. nextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: "If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListRobotApplications again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. " ListRobotsResponse: type: object deprecated: true properties: robots: allOf: - $ref: '#/components/schemas/Robots' - description: A list of robots that meet the criteria of the request. nextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: "If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListRobots again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. " description: Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html. ListSimulationApplicationsResponse: type: object properties: simulationApplicationSummaries: allOf: - $ref: '#/components/schemas/SimulationApplicationSummaries' - description: A list of simulation application summaries that meet the criteria of the request. nextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: "If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationApplications again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. " ListSimulationJobBatchesResponse: type: object properties: simulationJobBatchSummaries: allOf: - $ref: '#/components/schemas/SimulationJobBatchSummaries' - description: A list of simulation job batch summaries. nextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: "If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationJobBatches again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. " ListSimulationJobsResponse: type: object required: - simulationJobSummaries properties: simulationJobSummaries: allOf: - $ref: '#/components/schemas/SimulationJobSummaries' - description: A list of simulation job summaries that meet the criteria of the request. nextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: "If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationJobs again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. " ListTagsForResourceResponse: type: object properties: tags: allOf: - $ref: '#/components/schemas/TagMap' - description: The list of all tags added to the specified resource. ListWorldExportJobsResponse: type: object required: - worldExportJobSummaries properties: worldExportJobSummaries: allOf: - $ref: '#/components/schemas/WorldExportJobSummaries' - description: Summary information for world export jobs. nextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: "If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorldExportJobsRequest again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. " ListWorldGenerationJobsResponse: type: object required: - worldGenerationJobSummaries properties: worldGenerationJobSummaries: allOf: - $ref: '#/components/schemas/WorldGenerationJobSummaries' - description: Summary information for world generator jobs. nextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: "If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorldGeneratorJobsRequest again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. " ListWorldTemplatesResponse: type: object properties: templateSummaries: allOf: - $ref: '#/components/schemas/TemplateSummaries' - description: Summary information for templates. nextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: "If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorldTemplates again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. " ListWorldsResponse: type: object properties: worldSummaries: allOf: - $ref: '#/components/schemas/WorldSummaries' - description: Summary information for worlds. nextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: "If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorlds again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. " RegisterRobotResponse: type: object deprecated: true properties: fleet: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the fleet that the robot will join. robot: allOf: - $ref: '#/components/schemas/Arn' - description: Information about the robot registration. description: AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html. RestartSimulationJobResponse: type: object properties: {} StartSimulationJobBatchResponse: type: object properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (arn) of the batch. status: allOf: - $ref: '#/components/schemas/SimulationJobBatchStatus' - description:

The status of the simulation job batch.

Pending

The simulation job batch request is pending.

InProgress

The simulation job batch is in progress.

Failed

The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like InternalServiceError). See failureCode and failureReason for more information.

Completed

The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to InternalServiceError and (2) when all created simulation jobs have reached a terminal state (for example, Completed or Failed).

Canceled

The simulation batch job was cancelled.

Canceling

The simulation batch job is being cancelled.

Completing

The simulation batch job is completing.

TimingOut

The simulation job batch is timing out.

If a batch timing out, and there are pending requests that were failing due to an internal failure (like InternalServiceError), the batch status will be Failed. If there are no such failing request, the batch status will be TimedOut.

TimedOut

The simulation batch job timed out.

createdAt: allOf: - $ref: '#/components/schemas/CreatedAt' - description: The time, in milliseconds since the epoch, when the simulation job batch was created. clientRequestToken: allOf: - $ref: '#/components/schemas/ClientRequestToken' - description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. batchPolicy: allOf: - $ref: '#/components/schemas/BatchPolicy' - description: The batch policy. failureCode: allOf: - $ref: '#/components/schemas/SimulationJobBatchErrorCode' - description: The failure code if the simulation job batch failed. failureReason: allOf: - $ref: '#/components/schemas/GenericString' - description: The reason the simulation job batch failed. failedRequests: allOf: - $ref: '#/components/schemas/FailedCreateSimulationJobRequests' - description: 'A list of failed simulation job requests. The request failed to be created into a simulation job. Failed requests do not have a simulation job ID. ' pendingRequests: allOf: - $ref: '#/components/schemas/CreateSimulationJobRequests' - description: A list of pending simulation job requests. These requests have not yet been created into simulation jobs. createdRequests: allOf: - $ref: '#/components/schemas/SimulationJobSummaries' - description: A list of created simulation job request summaries. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: A map that contains tag keys and tag values that are attached to the deployment job batch. BatchTimeoutInSeconds: type: integer MaxConcurrency: type: integer SimulationJobRequest: type: object required: - maxJobDurationInSeconds properties: outputLocation: $ref: '#/components/schemas/OutputLocation' loggingConfig: $ref: '#/components/schemas/LoggingConfig' maxJobDurationInSeconds: allOf: - $ref: '#/components/schemas/JobDuration' - description: The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less. iamRole: allOf: - $ref: '#/components/schemas/IamRole' - description: 'The IAM role name that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. This is how credentials are passed in to your simulation job. ' failureBehavior: allOf: - $ref: '#/components/schemas/FailureBehavior' - description:

The failure behavior the simulation job.

Continue

Leaves the host running for its maximum timeout duration after a 4XX error code.

Fail

Stop the simulation job and terminate the instance.

useDefaultApplications: allOf: - $ref: '#/components/schemas/BoxedBoolean' - description: 'A Boolean indicating whether to use default applications in the simulation job. Default applications include Gazebo, rqt, rviz and terminal access. ' robotApplications: allOf: - $ref: '#/components/schemas/RobotApplicationConfigs' - description: The robot applications to use in the simulation job. simulationApplications: allOf: - $ref: '#/components/schemas/SimulationApplicationConfigs' - description: The simulation applications to use in the simulation job. dataSources: allOf: - $ref: '#/components/schemas/DataSourceConfigs' - description:

Specify data sources to mount read-only files from S3 into your simulation. These files are available under /opt/robomaker/datasources/data_source_name.

There is a limit of 100 files and a combined size of 25GB for all DataSourceConfig objects.

vpcConfig: $ref: '#/components/schemas/VPCConfig' compute: allOf: - $ref: '#/components/schemas/Compute' - description: Compute information for the simulation job tags: allOf: - $ref: '#/components/schemas/TagMap' - description: A map that contains tag keys and tag values that are attached to the simulation job request. description: Information about a simulation job request. SyncDeploymentJobResponse: type: object deprecated: true properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the synchronization request. fleet: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the fleet. status: allOf: - $ref: '#/components/schemas/DeploymentStatus' - description: The status of the synchronization job. deploymentConfig: allOf: - $ref: '#/components/schemas/DeploymentConfig' - description: Information about the deployment configuration. deploymentApplicationConfigs: allOf: - $ref: '#/components/schemas/DeploymentApplicationConfigs' - description: Information about the deployment application configurations. failureReason: allOf: - $ref: '#/components/schemas/GenericString' - description: The failure reason if the job fails. failureCode: allOf: - $ref: '#/components/schemas/DeploymentJobErrorCode' - description:

The failure code if the job fails:

InternalServiceError

Internal service error.

RobotApplicationCrash

Robot application exited abnormally.

SimulationApplicationCrash

Simulation application exited abnormally.

BadPermissionsRobotApplication

Robot application bundle could not be downloaded.

BadPermissionsSimulationApplication

Simulation application bundle could not be downloaded.

BadPermissionsS3Output

Unable to publish outputs to customer-provided S3 bucket.

BadPermissionsCloudwatchLogs

Unable to publish logs to customer-provided CloudWatch Logs resource.

SubnetIpLimitExceeded

Subnet IP limit exceeded.

ENILimitExceeded

ENI limit exceeded.

BadPermissionsUserCredentials

Unable to use the Role provided.

InvalidBundleRobotApplication

Robot bundle cannot be extracted (invalid format, bundling error, or other issue).

InvalidBundleSimulationApplication

Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).

RobotApplicationVersionMismatchedEtag

Etag for RobotApplication does not match value during version creation.

SimulationApplicationVersionMismatchedEtag

Etag for SimulationApplication does not match value during version creation.

createdAt: allOf: - $ref: '#/components/schemas/CreatedAt' - description: The time, in milliseconds since the epoch, when the fleet was created. description: Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html. TagResourceResponse: type: object properties: {} UntagResourceResponse: type: object properties: {} TagKey: type: string pattern: '[a-zA-Z0-9 _.\-\/+=:]*' minLength: 1 maxLength: 128 UpdateRobotApplicationResponse: type: object properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the updated robot application. name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the robot application. version: allOf: - $ref: '#/components/schemas/Version' - description: The version of the robot application. sources: allOf: - $ref: '#/components/schemas/Sources' - description: The sources of the robot application. robotSoftwareSuite: allOf: - $ref: '#/components/schemas/RobotSoftwareSuite' - description: The robot software suite (ROS distribution) used by the robot application. lastUpdatedAt: allOf: - $ref: '#/components/schemas/LastUpdatedAt' - description: The time, in milliseconds since the epoch, when the robot application was last updated. revisionId: allOf: - $ref: '#/components/schemas/RevisionId' - description: The revision id of the robot application. environment: allOf: - $ref: '#/components/schemas/Environment' - description: The object that contains the Docker image URI for your robot application. UpdateSimulationApplicationResponse: type: object properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the updated simulation application. name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the simulation application. version: allOf: - $ref: '#/components/schemas/Version' - description: The version of the robot application. sources: allOf: - $ref: '#/components/schemas/Sources' - description: The sources of the simulation application. simulationSoftwareSuite: allOf: - $ref: '#/components/schemas/SimulationSoftwareSuite' - description: The simulation software suite used by the simulation application. robotSoftwareSuite: allOf: - $ref: '#/components/schemas/RobotSoftwareSuite' - description: Information about the robot software suite (ROS distribution). renderingEngine: allOf: - $ref: '#/components/schemas/RenderingEngine' - description: The rendering engine for the simulation application. lastUpdatedAt: allOf: - $ref: '#/components/schemas/LastUpdatedAt' - description: The time, in milliseconds since the epoch, when the simulation application was last updated. revisionId: allOf: - $ref: '#/components/schemas/RevisionId' - description: The revision id of the simulation application. environment: allOf: - $ref: '#/components/schemas/Environment' - description: The object that contains the Docker image URI used for your simulation application. UpdateWorldTemplateResponse: type: object properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (arn) of the world template. name: allOf: - $ref: '#/components/schemas/TemplateName' - description: The name of the world template. createdAt: allOf: - $ref: '#/components/schemas/CreatedAt' - description: The time, in milliseconds since the epoch, when the world template was created. lastUpdatedAt: allOf: - $ref: '#/components/schemas/LastUpdatedAt' - description: The time, in milliseconds since the epoch, when the world template was last updated. Architecture: type: string enum: - X86_64 - ARM64 - ARMHF Arns: type: array items: $ref: '#/components/schemas/Arn' minItems: 1 maxItems: 100 BatchDeleteWorldsRequest: type: object required: - worlds title: BatchDeleteWorldsRequest properties: worlds: allOf: - $ref: '#/components/schemas/Arns' - description: A list of Amazon Resource Names (arns) that correspond to worlds to delete. BatchDescribeSimulationJobRequest: type: object required: - jobs title: BatchDescribeSimulationJobRequest properties: jobs: allOf: - $ref: '#/components/schemas/Arns' - description: A list of Amazon Resource Names (ARNs) of simulation jobs to describe. SimulationJobs: type: array items: $ref: '#/components/schemas/SimulationJob' BatchPolicy: type: object properties: timeoutInSeconds: allOf: - $ref: '#/components/schemas/BatchTimeoutInSeconds' - description:

The amount of time, in seconds, to wait for the batch to complete.

If a batch times out, and there are pending requests that were failing due to an internal failure (like InternalServiceError), they will be moved to the failed list and the batch status will be Failed. If the pending requests were failing for any other reason, the failed pending requests will be moved to the failed list and the batch status will be TimedOut.

maxConcurrency: allOf: - $ref: '#/components/schemas/MaxConcurrency' - description: '

The number of active simulation jobs create as part of the batch that can be in an active state at the same time.

Active states include: Pending,Preparing, Running, Restarting, RunningFailed and Terminating. All other states are terminal states.

' description: Information about the batch policy. CancelDeploymentJobRequest: type: object required: - job deprecated: true title: CancelDeploymentJobRequest properties: job: allOf: - $ref: '#/components/schemas/Arn' - description: The deployment job ARN to cancel. description: Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html. CancelSimulationJobBatchRequest: type: object required: - batch title: CancelSimulationJobBatchRequest properties: batch: allOf: - $ref: '#/components/schemas/Arn' - description: The id of the batch to cancel. CancelSimulationJobRequest: type: object required: - job title: CancelSimulationJobRequest properties: job: allOf: - $ref: '#/components/schemas/Arn' - description: The simulation job ARN to cancel. CancelWorldExportJobRequest: type: object required: - job title: CancelWorldExportJobRequest properties: job: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (arn) of the world export job to cancel. CancelWorldGenerationJobRequest: type: object required: - job title: CancelWorldGenerationJobRequest properties: job: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (arn) of the world generator job to cancel. ClientRequestToken: type: string pattern: '[a-zA-Z0-9_\-=]*' minLength: 1 maxLength: 64 Command: type: string pattern: '[a-zA-Z0-9_.\-]*' minLength: 1 maxLength: 1024 NonEmptyString: type: string pattern: .+ minLength: 1 maxLength: 255 CommandList: type: array items: $ref: '#/components/schemas/NonEmptyString' Compute: type: object properties: simulationUnitLimit: allOf: - $ref: '#/components/schemas/SimulationUnit' - description: 'The simulation unit limit. Your simulation is allocated CPU and memory proportional to the supplied simulation unit limit. A simulation unit is 1 vcpu and 2GB of memory. You are only billed for the SU utilization you consume up to the maximum value provided. The default is 15. ' computeType: allOf: - $ref: '#/components/schemas/ComputeType' - description: Compute type information for the simulation job. gpuUnitLimit: allOf: - $ref: '#/components/schemas/GPUUnit' - description: Compute GPU unit limit for the simulation job. It is the same as the number of GPUs allocated to the SimulationJob. description: Compute information for the simulation job. ComputeResponse: type: object properties: simulationUnitLimit: allOf: - $ref: '#/components/schemas/SimulationUnit' - description: 'The simulation unit limit. Your simulation is allocated CPU and memory proportional to the supplied simulation unit limit. A simulation unit is 1 vcpu and 2GB of memory. You are only billed for the SU utilization you consume up to the maximum value provided. The default is 15. ' computeType: allOf: - $ref: '#/components/schemas/ComputeType' - description: Compute type response information for the simulation job. gpuUnitLimit: allOf: - $ref: '#/components/schemas/GPUUnit' - description: Compute GPU unit limit for the simulation job. It is the same as the number of GPUs allocated to the SimulationJob. description: Compute information for the simulation job DeploymentConfig: type: object properties: concurrentDeploymentPercentage: allOf: - $ref: '#/components/schemas/Percentage' - description: The percentage of robots receiving the deployment at the same time. failureThresholdPercentage: allOf: - $ref: '#/components/schemas/Percentage' - description: The percentage of deployments that need to fail before stopping deployment. robotDeploymentTimeoutInSeconds: allOf: - $ref: '#/components/schemas/DeploymentTimeout' - description: The amount of time, in seconds, to wait for deployment to a single robot to complete. Choose a time between 1 minute and 7 days. The default is 5 hours. downloadConditionFile: allOf: - $ref: '#/components/schemas/S3Object' - description: The download condition file. description: Information about a deployment configuration. DeploymentApplicationConfigs: type: array items: $ref: '#/components/schemas/DeploymentApplicationConfig' minItems: 1 maxItems: 1 TagMap: type: object minProperties: 0 maxProperties: 50 additionalProperties: $ref: '#/components/schemas/TagValue' CreateDeploymentJobRequest: type: object required: - clientRequestToken - fleet - deploymentApplicationConfigs deprecated: true title: CreateDeploymentJobRequest properties: deploymentConfig: allOf: - $ref: '#/components/schemas/DeploymentConfig' - description: The requested deployment configuration. clientRequestToken: allOf: - $ref: '#/components/schemas/ClientRequestToken' - description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. fleet: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the fleet to deploy. deploymentApplicationConfigs: allOf: - $ref: '#/components/schemas/DeploymentApplicationConfigs' - description: The deployment application configuration. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: A map that contains tag keys and tag values that are attached to the deployment job. description: AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html. DeploymentStatus: type: string enum: - Pending - Preparing - InProgress - Failed - Succeeded - Canceled GenericString: type: string pattern: .* minLength: 0 maxLength: 1024 DeploymentJobErrorCode: type: string enum: - ResourceNotFound - EnvironmentSetupError - EtagMismatch - FailureThresholdBreached - RobotDeploymentAborted - RobotDeploymentNoResponse - RobotAgentConnectionTimeout - GreengrassDeploymentFailed - InvalidGreengrassGroup - MissingRobotArchitecture - MissingRobotApplicationArchitecture - MissingRobotDeploymentResource - GreengrassGroupVersionDoesNotExist - LambdaDeleted - ExtractingBundleFailure - PreLaunchFileFailure - PostLaunchFileFailure - BadPermissionError - DownloadConditionFailed - BadLambdaAssociated - InternalServerError - RobotApplicationDoesNotExist - DeploymentFleetDoesNotExist - FleetDeploymentTimeout CreatedAt: type: string format: date-time Name: type: string pattern: '[a-zA-Z0-9_\-]*' minLength: 1 maxLength: 255 CreateFleetRequest: type: object required: - name deprecated: true title: CreateFleetRequest properties: name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the fleet. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: A map that contains tag keys and tag values that are attached to the fleet. description: AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html. SourceConfigs: type: array items: $ref: '#/components/schemas/SourceConfig' RobotSoftwareSuite: type: object properties: name: allOf: - $ref: '#/components/schemas/RobotSoftwareSuiteType' - description: The name of the robot software suite (ROS distribution). version: allOf: - $ref: '#/components/schemas/RobotSoftwareSuiteVersionType' - description: The version of the robot software suite (ROS distribution). description: Information about a robot software suite (ROS distribution). Environment: type: object properties: uri: allOf: - $ref: '#/components/schemas/RepositoryUrl' - description: The Docker image URI for either your robot or simulation applications. description: The object that contains the Docker image URI for either your robot or simulation applications. CreateRobotApplicationRequest: type: object required: - name - robotSoftwareSuite title: CreateRobotApplicationRequest properties: name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the robot application. sources: allOf: - $ref: '#/components/schemas/SourceConfigs' - description: The sources of the robot application. robotSoftwareSuite: allOf: - $ref: '#/components/schemas/RobotSoftwareSuite' - description: The robot software suite (ROS distribuition) used by the robot application. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: A map that contains tag keys and tag values that are attached to the robot application. environment: allOf: - $ref: '#/components/schemas/Environment' - description: The object that contains that URI of the Docker image that you use for your robot application. Version: type: string pattern: (\$LATEST)|[0-9]* minLength: 1 maxLength: 255 Sources: type: array items: $ref: '#/components/schemas/Source' LastUpdatedAt: type: string format: date-time RevisionId: type: string pattern: '[a-zA-Z0-9_.\-]*' minLength: 1 maxLength: 40 S3Etags: type: array items: $ref: '#/components/schemas/S3Etag' ImageDigest: type: string pattern: '[Ss][Hh][Aa]256:[0-9a-fA-F]{64}' minLength: 0 maxLength: 72 CreateRobotApplicationVersionRequest: type: object required: - application title: CreateRobotApplicationVersionRequest properties: application: allOf: - $ref: '#/components/schemas/Arn' - description: The application information for the robot application. currentRevisionId: allOf: - $ref: '#/components/schemas/RevisionId' - description: The current revision id for the robot application. If you provide a value and it matches the latest revision ID, a new version will be created. s3Etags: allOf: - $ref: '#/components/schemas/S3Etags' - description: The Amazon S3 identifier for the zip file bundle that you use for your robot application. imageDigest: allOf: - $ref: '#/components/schemas/ImageDigest' - description: A SHA256 identifier for the Docker image that you use for your robot application. Id: type: string pattern: .* minLength: 1 maxLength: 1224 CreateRobotRequest: type: object required: - name - architecture - greengrassGroupId deprecated: true title: CreateRobotRequest properties: name: allOf: - $ref: '#/components/schemas/Name' - description: The name for the robot. architecture: allOf: - $ref: '#/components/schemas/Architecture' - description: The target architecture of the robot. greengrassGroupId: allOf: - $ref: '#/components/schemas/Id' - description: The Greengrass group id. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: A map that contains tag keys and tag values that are attached to the robot. description: AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html. SimulationSoftwareSuite: type: object properties: name: allOf: - $ref: '#/components/schemas/SimulationSoftwareSuiteType' - description: The name of the simulation software suite. version: allOf: - $ref: '#/components/schemas/SimulationSoftwareSuiteVersionType' - description: The version of the simulation software suite. description: Information about a simulation software suite. RenderingEngine: type: object properties: name: allOf: - $ref: '#/components/schemas/RenderingEngineType' - description: The name of the rendering engine. version: allOf: - $ref: '#/components/schemas/RenderingEngineVersionType' - description: The version of the rendering engine. description: Information about a rendering engine. CreateSimulationApplicationRequest: type: object required: - name - simulationSoftwareSuite - robotSoftwareSuite title: CreateSimulationApplicationRequest properties: name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the simulation application. sources: allOf: - $ref: '#/components/schemas/SourceConfigs' - description: The sources of the simulation application. simulationSoftwareSuite: allOf: - $ref: '#/components/schemas/SimulationSoftwareSuite' - description: The simulation software suite used by the simulation application. robotSoftwareSuite: allOf: - $ref: '#/components/schemas/RobotSoftwareSuite' - description: The robot software suite (ROS distribution) used by the simulation application. renderingEngine: allOf: - $ref: '#/components/schemas/RenderingEngine' - description: The rendering engine for the simulation application. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: A map that contains tag keys and tag values that are attached to the simulation application. environment: allOf: - $ref: '#/components/schemas/Environment' - description: The object that contains the Docker image URI used to create your simulation application. CreateSimulationApplicationVersionRequest: type: object required: - application title: CreateSimulationApplicationVersionRequest properties: application: allOf: - $ref: '#/components/schemas/Arn' - description: The application information for the simulation application. currentRevisionId: allOf: - $ref: '#/components/schemas/RevisionId' - description: The current revision id for the simulation application. If you provide a value and it matches the latest revision ID, a new version will be created. s3Etags: allOf: - $ref: '#/components/schemas/S3Etags' - description: The Amazon S3 eTag identifier for the zip file bundle that you use to create the simulation application. imageDigest: allOf: - $ref: '#/components/schemas/ImageDigest' - description: The SHA256 digest used to identify the Docker image URI used to created the simulation application. OutputLocation: type: object properties: s3Bucket: allOf: - $ref: '#/components/schemas/S3Bucket' - description: The S3 bucket for output. s3Prefix: allOf: - $ref: '#/components/schemas/S3Key' - description: The S3 folder in the s3Bucket where output files will be placed. description: The output location. LoggingConfig: type: object properties: recordAllRosTopics: allOf: - $ref: '#/components/schemas/BoxedBoolean' - deprecated: true description:

A boolean indicating whether to record all ROS topics.

This API is no longer supported and will throw an error if used.

AWS RoboMaker is ending support for ROS software suite. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/software-support-policy.html. description: The logging configuration. JobDuration: type: integer IamRole: type: string pattern: arn:aws:iam::\w+:role/.* minLength: 1 maxLength: 255 FailureBehavior: type: string enum: - Fail - Continue RobotApplicationConfigs: type: array items: $ref: '#/components/schemas/RobotApplicationConfig' minItems: 1 maxItems: 1 SimulationApplicationConfigs: type: array items: $ref: '#/components/schemas/SimulationApplicationConfig' minItems: 1 maxItems: 1 DataSourceConfigs: type: array items: $ref: '#/components/schemas/DataSourceConfig' minItems: 1 maxItems: 6 VPCConfig: type: object required: - subnets properties: subnets: allOf: - $ref: '#/components/schemas/Subnets' - description: A list of one or more subnet IDs in your VPC. securityGroups: allOf: - $ref: '#/components/schemas/SecurityGroups' - description: A list of one or more security groups IDs in your VPC. assignPublicIp: allOf: - $ref: '#/components/schemas/Boolean' - description: A boolean indicating whether to assign a public IP address. description: If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and two subnet IDs. CreateSimulationJobRequest: type: object required: - maxJobDurationInSeconds - iamRole title: CreateSimulationJobRequest properties: clientRequestToken: allOf: - $ref: '#/components/schemas/ClientRequestToken' - description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. outputLocation: allOf: - $ref: '#/components/schemas/OutputLocation' - description: Location for output files generated by the simulation job. loggingConfig: allOf: - $ref: '#/components/schemas/LoggingConfig' - description: The logging configuration. maxJobDurationInSeconds: allOf: - $ref: '#/components/schemas/JobDuration' - description: The maximum simulation job duration in seconds (up to 14 days or 1,209,600 seconds. When maxJobDurationInSeconds is reached, the simulation job will status will transition to Completed. iamRole: allOf: - $ref: '#/components/schemas/IamRole' - description: 'The IAM role name that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. This is how credentials are passed in to your simulation job. ' failureBehavior: allOf: - $ref: '#/components/schemas/FailureBehavior' - description:

The failure behavior the simulation job.

Continue

Leaves the instance running for its maximum timeout duration after a 4XX error code.

Fail

Stop the simulation job and terminate the instance.

robotApplications: allOf: - $ref: '#/components/schemas/RobotApplicationConfigs' - description: The robot application to use in the simulation job. simulationApplications: allOf: - $ref: '#/components/schemas/SimulationApplicationConfigs' - description: The simulation application to use in the simulation job. dataSources: allOf: - $ref: '#/components/schemas/DataSourceConfigs' - description:

Specify data sources to mount read-only files from S3 into your simulation. These files are available under /opt/robomaker/datasources/data_source_name.

There is a limit of 100 files and a combined size of 25GB for all DataSourceConfig objects.

tags: allOf: - $ref: '#/components/schemas/TagMap' - description: A map that contains tag keys and tag values that are attached to the simulation job. vpcConfig: allOf: - $ref: '#/components/schemas/VPCConfig' - description: 'If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID. ' compute: allOf: - $ref: '#/components/schemas/Compute' - description: Compute information for the simulation job. CreateSimulationJobRequests: type: array items: $ref: '#/components/schemas/SimulationJobRequest' minItems: 1 maxItems: 1000 SimulationJobStatus: type: string enum: - Pending - Preparing - Running - Restarting - Completed - Failed - RunningFailed - Terminating - Terminated - Canceled LastStartedAt: type: string format: date-time SimulationJobErrorCode: type: string enum: - InternalServiceError - RobotApplicationCrash - SimulationApplicationCrash - RobotApplicationHealthCheckFailure - SimulationApplicationHealthCheckFailure - BadPermissionsRobotApplication - BadPermissionsSimulationApplication - BadPermissionsS3Object - BadPermissionsS3Output - BadPermissionsCloudwatchLogs - SubnetIpLimitExceeded - ENILimitExceeded - BadPermissionsUserCredentials - InvalidBundleRobotApplication - InvalidBundleSimulationApplication - InvalidS3Resource - ThrottlingError - LimitExceeded - MismatchedEtag - RobotApplicationVersionMismatchedEtag - SimulationApplicationVersionMismatchedEtag - ResourceNotFound - RequestThrottled - BatchTimedOut - BatchCanceled - InvalidInput - WrongRegionS3Bucket - WrongRegionS3Output - WrongRegionRobotApplication - WrongRegionSimulationApplication - UploadContentMismatchError SimulationTimeMillis: type: integer DataSources: type: array items: $ref: '#/components/schemas/DataSource' VPCConfigResponse: type: object properties: subnets: allOf: - $ref: '#/components/schemas/Subnets' - description: A list of subnet IDs associated with the simulation job. securityGroups: allOf: - $ref: '#/components/schemas/SecurityGroups' - description: A list of security group IDs associated with the simulation job. vpcId: allOf: - $ref: '#/components/schemas/GenericString' - description: The VPC ID associated with your simulation job. assignPublicIp: allOf: - $ref: '#/components/schemas/Boolean' - description: A boolean indicating if a public IP was assigned. description: VPC configuration associated with your simulation job. CreateWorldExportJobRequest: type: object required: - worlds - outputLocation - iamRole title: CreateWorldExportJobRequest properties: clientRequestToken: allOf: - $ref: '#/components/schemas/ClientRequestToken' - description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. worlds: allOf: - $ref: '#/components/schemas/Arns' - description: A list of Amazon Resource Names (arns) that correspond to worlds to export. outputLocation: $ref: '#/components/schemas/OutputLocation' iamRole: allOf: - $ref: '#/components/schemas/IamRole' - description: The IAM role that the world export process uses to access the Amazon S3 bucket and put the export. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: A map that contains tag keys and tag values that are attached to the world export job. WorldExportJobStatus: type: string enum: - Pending - Running - Completed - Failed - Canceling - Canceled WorldExportJobErrorCode: type: string enum: - InternalServiceError - LimitExceeded - ResourceNotFound - RequestThrottled - InvalidInput - AccessDenied WorldCount: type: object properties: floorplanCount: allOf: - $ref: '#/components/schemas/FloorplanCount' - description: The number of unique floorplans. interiorCountPerFloorplan: allOf: - $ref: '#/components/schemas/InteriorCountPerFloorplan' - description: The number of unique interiors per floorplan. description:

The number of worlds that will be created. You can configure the number of unique floorplans and the number of unique interiors for each floor plan. For example, if you want 1 world with 20 unique interiors, you set floorplanCount = 1 and interiorCountPerFloorplan = 20. This will result in 20 worlds (floorplanCount * interiorCountPerFloorplan).

If you set floorplanCount = 4 and interiorCountPerFloorplan = 5, there will be 20 worlds with 5 unique floor plans.

CreateWorldGenerationJobRequest: type: object required: - template - worldCount title: CreateWorldGenerationJobRequest properties: clientRequestToken: allOf: - $ref: '#/components/schemas/ClientRequestToken' - description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. template: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (arn) of the world template describing the worlds you want to create. worldCount: allOf: - $ref: '#/components/schemas/WorldCount' - description: Information about the world count. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: A map that contains tag keys and tag values that are attached to the world generator job. worldTags: allOf: - $ref: '#/components/schemas/TagMap' - description: A map that contains tag keys and tag values that are attached to the generated worlds. WorldGenerationJobStatus: type: string enum: - Pending - Running - Completed - Failed - PartialFailed - Canceling - Canceled WorldGenerationJobErrorCode: type: string enum: - InternalServiceError - LimitExceeded - ResourceNotFound - RequestThrottled - InvalidInput - AllWorldGenerationFailed TemplateName: type: string pattern: .* minLength: 0 maxLength: 255 Json: type: string pattern: '[\S\s]+' minLength: 1 maxLength: 262144 TemplateLocation: type: object required: - s3Bucket - s3Key properties: s3Bucket: allOf: - $ref: '#/components/schemas/S3Bucket' - description: The Amazon S3 bucket name. s3Key: allOf: - $ref: '#/components/schemas/S3Key' - description: The list of S3 keys identifying the data source files. description: Information about a template location. CreateWorldTemplateRequest: type: object title: CreateWorldTemplateRequest properties: clientRequestToken: allOf: - $ref: '#/components/schemas/ClientRequestToken' - description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. name: allOf: - $ref: '#/components/schemas/TemplateName' - description: The name of the world template. templateBody: allOf: - $ref: '#/components/schemas/Json' - description: The world template body. templateLocation: allOf: - $ref: '#/components/schemas/TemplateLocation' - description: The location of the world template. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: A map that contains tag keys and tag values that are attached to the world template. S3KeyOutputs: type: array items: $ref: '#/components/schemas/S3KeyOutput' DataSourceType: type: string enum: - Prefix - Archive - File Path: type: string pattern: .* minLength: 1 maxLength: 1024 DataSource: type: object properties: name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the data source. s3Bucket: allOf: - $ref: '#/components/schemas/S3Bucket' - description: The S3 bucket where the data files are located. s3Keys: allOf: - $ref: '#/components/schemas/S3KeyOutputs' - description: The list of S3 keys identifying the data source files. type: allOf: - $ref: '#/components/schemas/DataSourceType' - description:

The data type for the data source that you're using for your container image or simulation job. You can use this field to specify whether your data source is an Archive, an Amazon S3 prefix, or a file.

If you don't specify a field, the default value is File.

destination: allOf: - $ref: '#/components/schemas/Path' - description:

The location where your files are mounted in the container image.

If you've specified the type of the data source as an Archive, you must provide an Amazon S3 object key to your archive. The object key must point to either a .zip or .tar.gz file.

If you've specified the type of the data source as a Prefix, you provide the Amazon S3 prefix that points to the files that you are using for your data source.

If you've specified the type of the data source as a File, you provide the Amazon S3 path to the file that you're using as your data source.

description: Information about a data source. S3KeysOrPrefixes: type: array items: $ref: '#/components/schemas/S3KeyOrPrefix' minItems: 1 maxItems: 100 DataSourceNames: type: array items: $ref: '#/components/schemas/Name' DeleteFleetRequest: type: object required: - fleet deprecated: true title: DeleteFleetRequest properties: fleet: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the fleet. description: Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html. DeleteRobotApplicationRequest: type: object required: - application title: DeleteRobotApplicationRequest properties: application: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the the robot application. applicationVersion: allOf: - $ref: '#/components/schemas/Version' - description: The version of the robot application to delete. DeleteRobotRequest: type: object required: - robot deprecated: true title: DeleteRobotRequest properties: robot: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the robot. description: Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html. DeleteSimulationApplicationRequest: type: object required: - application title: DeleteSimulationApplicationRequest properties: application: allOf: - $ref: '#/components/schemas/Arn' - description: The application information for the simulation application to delete. applicationVersion: allOf: - $ref: '#/components/schemas/Version' - description: The version of the simulation application to delete. DeleteWorldTemplateRequest: type: object required: - template title: DeleteWorldTemplateRequest properties: template: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (arn) of the world template you want to delete. DeploymentVersion: type: string pattern: '[0-9]*' minLength: 1 maxLength: 255 DeploymentLaunchConfig: type: object required: - packageName - launchFile properties: packageName: allOf: - $ref: '#/components/schemas/Command' - description: The package name. preLaunchFile: allOf: - $ref: '#/components/schemas/Path' - description: The deployment pre-launch file. This file will be executed prior to the launch file. launchFile: allOf: - $ref: '#/components/schemas/Command' - description: The launch file name. postLaunchFile: allOf: - $ref: '#/components/schemas/Path' - description: The deployment post-launch file. This file will be executed after the launch file. environmentVariables: allOf: - $ref: '#/components/schemas/EnvironmentVariableMap' - description: An array of key/value pairs specifying environment variables for the robot application description: Configuration information for a deployment launch. DeploymentJob: type: object properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the deployment job. fleet: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the fleet. status: allOf: - $ref: '#/components/schemas/DeploymentStatus' - description: The status of the deployment job. deploymentApplicationConfigs: allOf: - $ref: '#/components/schemas/DeploymentApplicationConfigs' - description: The deployment application configuration. deploymentConfig: allOf: - $ref: '#/components/schemas/DeploymentConfig' - description: The deployment configuration. failureReason: allOf: - $ref: '#/components/schemas/GenericString' - description: A short description of the reason why the deployment job failed. failureCode: allOf: - $ref: '#/components/schemas/DeploymentJobErrorCode' - description: The deployment job failure code. createdAt: allOf: - $ref: '#/components/schemas/CreatedAt' - description: The time, in milliseconds since the epoch, when the deployment job was created. description: Information about a deployment job. DeploymentJobs: type: array items: $ref: '#/components/schemas/DeploymentJob' minItems: 0 maxItems: 200 EnvironmentVariableMap: type: object minProperties: 0 maxProperties: 20 additionalProperties: $ref: '#/components/schemas/EnvironmentVariableValue' DeregisterRobotRequest: type: object required: - fleet - robot deprecated: true title: DeregisterRobotRequest properties: fleet: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the fleet. robot: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the robot. description: Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html. DescribeDeploymentJobRequest: type: object required: - job deprecated: true title: DescribeDeploymentJobRequest properties: job: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the deployment job. description: Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html. RobotDeploymentSummary: type: array items: $ref: '#/components/schemas/RobotDeployment' DescribeFleetRequest: type: object required: - fleet deprecated: true title: DescribeFleetRequest properties: fleet: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the fleet. description: Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html. Robots: type: array items: $ref: '#/components/schemas/Robot' minItems: 0 maxItems: 1000 DescribeRobotApplicationRequest: type: object required: - application title: DescribeRobotApplicationRequest properties: application: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the robot application. applicationVersion: allOf: - $ref: '#/components/schemas/Version' - description: The version of the robot application to describe. DescribeRobotRequest: type: object required: - robot deprecated: true title: DescribeRobotRequest properties: robot: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the robot to be described. description: Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html. RobotStatus: type: string enum: - Available - Registered - PendingNewDeployment - Deploying - Failed - InSync - NoResponse DescribeSimulationApplicationRequest: type: object required: - application title: DescribeSimulationApplicationRequest properties: application: allOf: - $ref: '#/components/schemas/Arn' - description: The application information for the simulation application. applicationVersion: allOf: - $ref: '#/components/schemas/Version' - description: The version of the simulation application to describe. DescribeSimulationJobBatchRequest: type: object required: - batch title: DescribeSimulationJobBatchRequest properties: batch: allOf: - $ref: '#/components/schemas/Arn' - description: The id of the batch to describe. SimulationJobBatchStatus: type: string enum: - Pending - InProgress - Failed - Completed - Canceled - Canceling - Completing - TimingOut - TimedOut SimulationJobBatchErrorCode: type: string enum: - InternalServiceError FailedCreateSimulationJobRequests: type: array items: $ref: '#/components/schemas/FailedCreateSimulationJobRequest' SimulationJobSummaries: type: array items: $ref: '#/components/schemas/SimulationJobSummary' minItems: 0 maxItems: 100 DescribeSimulationJobRequest: type: object required: - job title: DescribeSimulationJobRequest properties: job: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the simulation job to be described. NetworkInterface: type: object properties: networkInterfaceId: allOf: - $ref: '#/components/schemas/GenericString' - description: The ID of the network interface. privateIpAddress: allOf: - $ref: '#/components/schemas/GenericString' - description: The IPv4 address of the network interface within the subnet. publicIpAddress: allOf: - $ref: '#/components/schemas/GenericString' - description: The IPv4 public address of the network interface. description: Describes a network interface. DescribeWorldExportJobRequest: type: object required: - job title: DescribeWorldExportJobRequest properties: job: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (arn) of the world export job to describe. DescribeWorldGenerationJobRequest: type: object required: - job title: DescribeWorldGenerationJobRequest properties: job: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (arn) of the world generation job to describe. FinishedWorldsSummary: type: object properties: finishedCount: allOf: - $ref: '#/components/schemas/Integer' - description: The total number of finished worlds. succeededWorlds: allOf: - $ref: '#/components/schemas/Arns' - description: A list of worlds that succeeded. failureSummary: allOf: - $ref: '#/components/schemas/FailureSummary' - description: Information about worlds that failed. description: Information about worlds that finished. DescribeWorldRequest: type: object required: - world title: DescribeWorldRequest properties: world: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (arn) of the world you want to describe. DescribeWorldTemplateRequest: type: object required: - template title: DescribeWorldTemplateRequest properties: template: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (arn) of the world template you want to describe. EnvironmentVariableKey: type: string pattern: '[A-Z_][A-Z0-9_]*' minLength: 1 maxLength: 1024 EnvironmentVariableValue: type: string pattern: .* minLength: 1 maxLength: 1024 ExitBehavior: type: string enum: - FAIL - RESTART FailedAt: type: string format: date-time FailedCreateSimulationJobRequest: type: object properties: request: allOf: - $ref: '#/components/schemas/SimulationJobRequest' - description: The simulation job request. failureReason: allOf: - $ref: '#/components/schemas/GenericString' - description: The failure reason of the simulation job request. failureCode: allOf: - $ref: '#/components/schemas/SimulationJobErrorCode' - description: The failure code. failedAt: allOf: - $ref: '#/components/schemas/FailedAt' - description: The time, in milliseconds since the epoch, when the simulation job batch failed. description: Information about a failed create simulation job request. Integer: type: integer WorldFailures: type: array items: $ref: '#/components/schemas/WorldFailure' minItems: 0 maxItems: 100 FailureSummary: type: object properties: totalFailureCount: allOf: - $ref: '#/components/schemas/Integer' - description: The total number of failures. failures: allOf: - $ref: '#/components/schemas/WorldFailures' - description: The worlds that failed. description: Information about worlds that failed. FilterValues: type: array items: $ref: '#/components/schemas/Name' minItems: 1 maxItems: 1 Filters: type: array items: $ref: '#/components/schemas/Filter' minItems: 1 maxItems: 1 Fleet: type: object properties: name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the fleet. arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the fleet. createdAt: allOf: - $ref: '#/components/schemas/CreatedAt' - description: The time, in milliseconds since the epoch, when the fleet was created. lastDeploymentStatus: allOf: - $ref: '#/components/schemas/DeploymentStatus' - description: The status of the last fleet deployment. lastDeploymentJob: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the last deployment job. lastDeploymentTime: allOf: - $ref: '#/components/schemas/CreatedAt' - description: The time of the last deployment. description: Information about a fleet. Fleets: type: array items: $ref: '#/components/schemas/Fleet' minItems: 0 maxItems: 200 GenericInteger: type: integer GetWorldTemplateBodyRequest: type: object title: GetWorldTemplateBodyRequest properties: template: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (arn) of the world template. generationJob: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (arn) of the world generator job. PortForwardingConfig: type: object properties: portMappings: allOf: - $ref: '#/components/schemas/PortMappingList' - description: The port mappings for the configuration. description: Configuration information for port forwarding. LaunchConfig: type: object properties: packageName: allOf: - $ref: '#/components/schemas/Command' - description: The package name. launchFile: allOf: - $ref: '#/components/schemas/Command' - description: The launch file name. environmentVariables: allOf: - $ref: '#/components/schemas/EnvironmentVariableMap' - description: The environment variables for the application launch. portForwardingConfig: allOf: - $ref: '#/components/schemas/PortForwardingConfig' - description: The port forwarding configuration. streamUI: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Boolean indicating whether a streaming session will be configured for the application. If True, AWS RoboMaker will configure a connection so you can interact with your application as it is running in the simulation. You must configure and launch the component. It must have a graphical user interface. ' command: allOf: - $ref: '#/components/schemas/CommandList' - description:

If you've specified General as the value for your RobotSoftwareSuite, you can use this field to specify a list of commands for your container image.

If you've specified SimulationRuntime as the value for your SimulationSoftwareSuite, you can use this field to specify a list of commands for your container image.

description: Information about a launch configuration. PaginationToken: type: string pattern: '[a-zA-Z0-9_.\-\/+=]*' minLength: 1 maxLength: 2048 MaxResults: type: integer ListDeploymentJobsRequest: type: object deprecated: true title: ListDeploymentJobsRequest properties: filters: allOf: - $ref: '#/components/schemas/Filters' - description:

Optional filters to limit results.

The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status InProgress or the status Pending.

nextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: "If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListDeploymentJobs again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. " maxResults: allOf: - $ref: '#/components/schemas/MaxResults' - description: 'When this parameter is used, ListDeploymentJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListDeploymentJobs request with the returned nextToken value. This value can be between 1 and 200. If this parameter is not used, then ListDeploymentJobs returns up to 200 results and a nextToken value if applicable. ' description: Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html. ListFleetsRequest: type: object deprecated: true title: ListFleetsRequest properties: nextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description:

If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListFleets again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

 maxResults: allOf: - $ref: '#/components/schemas/MaxResults' - description: 'When this parameter is used, ListFleets only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListFleets request with the returned nextToken value. This value can be between 1 and 200. If this parameter is not used, then ListFleets returns up to 200 results and a nextToken value if applicable. ' filters: allOf: - $ref: '#/components/schemas/Filters' - description:

Optional filters to limit results.

The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.

description: Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html. VersionQualifier: type: string pattern: ALL minLength: 1 maxLength: 255 ListRobotApplicationsRequest: type: object title: ListRobotApplicationsRequest properties: versionQualifier: allOf: - $ref: '#/components/schemas/VersionQualifier' - description: The version qualifier of the robot application. nextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: "If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListRobotApplications again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. " maxResults: allOf: - $ref: '#/components/schemas/MaxResults' - description: 'When this parameter is used, ListRobotApplications only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListRobotApplications request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListRobotApplications returns up to 100 results and a nextToken value if applicable. ' filters: allOf: - $ref: '#/components/schemas/Filters' - description:

Optional filters to limit results.

The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.

RobotApplicationSummaries: type: array items: $ref: '#/components/schemas/RobotApplicationSummary' minItems: 0 maxItems: 100 ListRobotsRequest: type: object deprecated: true title: ListRobotsRequest properties: nextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: "If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListRobots again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. " maxResults: allOf: - $ref: '#/components/schemas/MaxResults' - description: 'When this parameter is used, ListRobots only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListRobots request with the returned nextToken value. This value can be between 1 and 200. If this parameter is not used, then ListRobots returns up to 200 results and a nextToken value if applicable. ' filters: allOf: - $ref: '#/components/schemas/Filters' - description:

Optional filters to limit results.

The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Registered or the status Available.

description: Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html. ListSimulationApplicationsRequest: type: object title: ListSimulationApplicationsRequest properties: versionQualifier: allOf: - $ref: '#/components/schemas/VersionQualifier' - description: The version qualifier of the simulation application. nextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: "If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationApplications again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. " maxResults: allOf: - $ref: '#/components/schemas/MaxResults' - description: 'When this parameter is used, ListSimulationApplications only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListSimulationApplications request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListSimulationApplications returns up to 100 results and a nextToken value if applicable. ' filters: allOf: - $ref: '#/components/schemas/Filters' - description:

Optional list of filters to limit results.

The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.

SimulationApplicationSummaries: type: array items: $ref: '#/components/schemas/SimulationApplicationSummary' minItems: 0 maxItems: 100 ListSimulationJobBatchesRequest: type: object title: ListSimulationJobBatchesRequest properties: nextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: "If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationJobBatches again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. " maxResults: allOf: - $ref: '#/components/schemas/MaxResults' - description: 'When this parameter is used, ListSimulationJobBatches only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListSimulationJobBatches request with the returned nextToken value. ' filters: allOf: - $ref: '#/components/schemas/Filters' - description: Optional filters to limit results. SimulationJobBatchSummaries: type: array items: $ref: '#/components/schemas/SimulationJobBatchSummary' ListSimulationJobsRequest: type: object title: ListSimulationJobsRequest properties: nextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: "If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationJobs again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. " maxResults: allOf: - $ref: '#/components/schemas/MaxResults' - description: 'When this parameter is used, ListSimulationJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListSimulationJobs request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then ListSimulationJobs returns up to 1000 results and a nextToken value if applicable. ' filters: allOf: - $ref: '#/components/schemas/Filters' - description:

Optional filters to limit results.

The filter names status and simulationApplicationName and robotApplicationName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Preparing or the status Running.

ListTagsForResourceRequest: type: object title: ListTagsForResourceRequest properties: {} ListWorldExportJobsRequest: type: object title: ListWorldExportJobsRequest properties: nextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: "If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorldExportJobs again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. " maxResults: allOf: - $ref: '#/components/schemas/MaxResults' - description: 'When this parameter is used, ListWorldExportJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListWorldExportJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorldExportJobs returns up to 100 results and a nextToken value if applicable. ' filters: allOf: - $ref: '#/components/schemas/Filters' - description: Optional filters to limit results. You can use generationJobId and templateId. WorldExportJobSummaries: type: array items: $ref: '#/components/schemas/WorldExportJobSummary' minItems: 0 maxItems: 100 ListWorldGenerationJobsRequest: type: object title: ListWorldGenerationJobsRequest properties: nextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: "If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorldGenerationJobsRequest again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. " maxResults: allOf: - $ref: '#/components/schemas/MaxResults' - description: 'When this parameter is used, ListWorldGeneratorJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListWorldGeneratorJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorldGeneratorJobs returns up to 100 results and a nextToken value if applicable. ' filters: allOf: - $ref: '#/components/schemas/Filters' - description: Optional filters to limit results. You can use status and templateId. WorldGenerationJobSummaries: type: array items: $ref: '#/components/schemas/WorldGenerationJobSummary' minItems: 0 maxItems: 100 ListWorldTemplatesRequest: type: object title: ListWorldTemplatesRequest properties: nextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: "If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorldTemplates again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. " maxResults: allOf: - $ref: '#/components/schemas/MaxResults' - description: 'When this parameter is used, ListWorldTemplates only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListWorldTemplates request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorldTemplates returns up to 100 results and a nextToken value if applicable. ' TemplateSummaries: type: array items: $ref: '#/components/schemas/TemplateSummary' ListWorldsRequest: type: object title: ListWorldsRequest properties: nextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: "If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorlds again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null. " maxResults: allOf: - $ref: '#/components/schemas/MaxResults' - description: 'When this parameter is used, ListWorlds only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListWorlds request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorlds returns up to 100 results and a nextToken value if applicable. ' filters: allOf: - $ref: '#/components/schemas/Filters' - description: Optional filters to limit results. You can use status. WorldSummaries: type: array items: $ref: '#/components/schemas/WorldSummary' NonSystemPort: type: integer minimum: 1024 maximum: 65535 PercentDone: type: number format: float minimum: 0 maximum: 100 Port: type: integer minimum: 1 maximum: 65535 PortMappingList: type: array items: $ref: '#/components/schemas/PortMapping' minItems: 0 maxItems: 10 PortMapping: type: object required: - jobPort - applicationPort properties: jobPort: allOf: - $ref: '#/components/schemas/Port' - description: 'The port number on the simulation job instance to use as a remote connection point. ' applicationPort: allOf: - $ref: '#/components/schemas/NonSystemPort' - description: The port number on the application. enableOnPublicIp: allOf: - $ref: '#/components/schemas/Boolean' - description: A Boolean indicating whether to enable this port mapping on public IP. description: An object representing a port mapping. RobotDeploymentStep: type: string enum: - Validating - DownloadingExtracting - ExecutingDownloadCondition - ExecutingPreLaunch - Launching - ExecutingPostLaunch - Finished ProgressDetail: type: object properties: currentProgress: allOf: - $ref: '#/components/schemas/RobotDeploymentStep' - description:

The current progress status.

Validating

Validating the deployment.

DownloadingExtracting

Downloading and extracting the bundle on the robot.

ExecutingPreLaunch

Executing pre-launch script(s) if provided.

Launching

Launching the robot application.

ExecutingPostLaunch

Executing post-launch script(s) if provided.

Finished

Deployment is complete.

percentDone: allOf: - $ref: '#/components/schemas/PercentDone' - description: Precentage of the step that is done. This currently only applies to the Downloading/Extracting step of the deployment. It is empty for other steps. estimatedTimeRemainingSeconds: allOf: - $ref: '#/components/schemas/GenericInteger' - description: Estimated amount of time in seconds remaining in the step. This currently only applies to the Downloading/Extracting step of the deployment. It is empty for other steps. targetResource: allOf: - $ref: '#/components/schemas/GenericString' - description: The Amazon Resource Name (ARN) of the deployment job. description: Information about the progress of a deployment job. RegisterRobotRequest: type: object required: - fleet - robot deprecated: true title: RegisterRobotRequest properties: fleet: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the fleet. robot: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the robot. description: AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html. RestartSimulationJobRequest: type: object required: - job title: RestartSimulationJobRequest properties: job: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the simulation job. Robot: type: object properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the robot. name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the robot. fleetArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the fleet. status: allOf: - $ref: '#/components/schemas/RobotStatus' - description: The status of the robot. greenGrassGroupId: allOf: - $ref: '#/components/schemas/Id' - description: The Greengrass group associated with the robot. createdAt: allOf: - $ref: '#/components/schemas/CreatedAt' - description: The time, in milliseconds since the epoch, when the robot was created. architecture: allOf: - $ref: '#/components/schemas/Architecture' - description: The architecture of the robot. lastDeploymentJob: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the last deployment job. lastDeploymentTime: allOf: - $ref: '#/components/schemas/CreatedAt' - description: The time of the last deployment. description: Information about a robot. UploadConfigurations: type: array items: $ref: '#/components/schemas/UploadConfiguration' minItems: 0 maxItems: 10 Tools: type: array items: $ref: '#/components/schemas/Tool' minItems: 0 maxItems: 10 RobotApplicationNames: type: array items: $ref: '#/components/schemas/Name' RobotApplicationSummary: type: object properties: name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the robot application. arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the robot. version: allOf: - $ref: '#/components/schemas/Version' - description: The version of the robot application. lastUpdatedAt: allOf: - $ref: '#/components/schemas/LastUpdatedAt' - description: The time, in milliseconds since the epoch, when the robot application was last updated. robotSoftwareSuite: allOf: - $ref: '#/components/schemas/RobotSoftwareSuite' - description: Information about a robot software suite (ROS distribution). description: Summary information for a robot application. RobotDeployment: type: object properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The robot deployment Amazon Resource Name (ARN). deploymentStartTime: allOf: - $ref: '#/components/schemas/CreatedAt' - description: The time, in milliseconds since the epoch, when the deployment was started. deploymentFinishTime: allOf: - $ref: '#/components/schemas/CreatedAt' - description: The time, in milliseconds since the epoch, when the deployment finished. status: allOf: - $ref: '#/components/schemas/RobotStatus' - description: The status of the robot deployment. progressDetail: allOf: - $ref: '#/components/schemas/ProgressDetail' - description: Information about how the deployment is progressing. failureReason: allOf: - $ref: '#/components/schemas/GenericString' - description: A short description of the reason why the robot deployment failed. failureCode: allOf: - $ref: '#/components/schemas/DeploymentJobErrorCode' - description: The robot deployment failure code. description: Information about a robot deployment. S3KeyOrPrefix: type: string pattern: .* minLength: 0 maxLength: 1024 S3KeyOutput: type: object properties: s3Key: allOf: - $ref: '#/components/schemas/S3KeyOrPrefix' - description: The S3 key. etag: allOf: - $ref: '#/components/schemas/S3Etag' - description: The etag for the object. description: Information about S3 keys. WorldConfigs: type: array items: $ref: '#/components/schemas/WorldConfig' minItems: 0 maxItems: 1 SimulationApplicationNames: type: array items: $ref: '#/components/schemas/Name' SimulationApplicationSummary: type: object properties: name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the simulation application. arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the simulation application. version: allOf: - $ref: '#/components/schemas/Version' - description: The version of the simulation application. lastUpdatedAt: allOf: - $ref: '#/components/schemas/LastUpdatedAt' - description: The time, in milliseconds since the epoch, when the simulation application was last updated. robotSoftwareSuite: allOf: - $ref: '#/components/schemas/RobotSoftwareSuite' - description: Information about a robot software suite (ROS distribution). simulationSoftwareSuite: allOf: - $ref: '#/components/schemas/SimulationSoftwareSuite' - description: Information about a simulation software suite. description: Summary information for a simulation application. SimulationJob: type: object properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the simulation job. name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the simulation job. status: allOf: - $ref: '#/components/schemas/SimulationJobStatus' - description: Status of the simulation job. lastStartedAt: allOf: - $ref: '#/components/schemas/LastStartedAt' - description: The time, in milliseconds since the epoch, when the simulation job was last started. lastUpdatedAt: allOf: - $ref: '#/components/schemas/LastUpdatedAt' - description: The time, in milliseconds since the epoch, when the simulation job was last updated. failureBehavior: allOf: - $ref: '#/components/schemas/FailureBehavior' - description:

The failure behavior the simulation job.

Continue

Leaves the host running for its maximum timeout duration after a 4XX error code.

Fail

Stop the simulation job and terminate the instance.

failureCode: allOf: - $ref: '#/components/schemas/SimulationJobErrorCode' - description: The failure code of the simulation job if it failed. failureReason: allOf: - $ref: '#/components/schemas/GenericString' - description: The reason why the simulation job failed. clientRequestToken: allOf: - $ref: '#/components/schemas/ClientRequestToken' - description: A unique identifier for this SimulationJob request. outputLocation: allOf: - $ref: '#/components/schemas/OutputLocation' - description: Location for output files generated by the simulation job. loggingConfig: allOf: - $ref: '#/components/schemas/LoggingConfig' - description: The logging configuration. maxJobDurationInSeconds: allOf: - $ref: '#/components/schemas/JobDuration' - description: The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less. simulationTimeMillis: allOf: - $ref: '#/components/schemas/SimulationTimeMillis' - description: The simulation job execution duration in milliseconds. iamRole: allOf: - $ref: '#/components/schemas/IamRole' - description: 'The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. This is how credentials are passed in to your simulation job. ' robotApplications: allOf: - $ref: '#/components/schemas/RobotApplicationConfigs' - description: A list of robot applications. simulationApplications: allOf: - $ref: '#/components/schemas/SimulationApplicationConfigs' - description: A list of simulation applications. dataSources: allOf: - $ref: '#/components/schemas/DataSources' - description: The data sources for the simulation job. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: A map that contains tag keys and tag values that are attached to the simulation job. vpcConfig: allOf: - $ref: '#/components/schemas/VPCConfigResponse' - description: VPC configuration information. networkInterface: allOf: - $ref: '#/components/schemas/NetworkInterface' - description: Information about a network interface. compute: allOf: - $ref: '#/components/schemas/ComputeResponse' - description: Compute information for the simulation job description: Information about a simulation job. SimulationJobBatchSummary: type: object properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the batch. lastUpdatedAt: allOf: - $ref: '#/components/schemas/LastUpdatedAt' - description: The time, in milliseconds since the epoch, when the simulation job batch was last updated. createdAt: allOf: - $ref: '#/components/schemas/CreatedAt' - description: The time, in milliseconds since the epoch, when the simulation job batch was created. status: allOf: - $ref: '#/components/schemas/SimulationJobBatchStatus' - description:

The status of the simulation job batch.

Pending

The simulation job batch request is pending.

InProgress

The simulation job batch is in progress.

Failed

The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like InternalServiceError). See failureCode and failureReason for more information.

Completed

The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to InternalServiceError and (2) when all created simulation jobs have reached a terminal state (for example, Completed or Failed).

Canceled

The simulation batch job was cancelled.

Canceling

The simulation batch job is being cancelled.

Completing

The simulation batch job is completing.

TimingOut

The simulation job batch is timing out.

If a batch timing out, and there are pending requests that were failing due to an internal failure (like InternalServiceError), the batch status will be Failed. If there are no such failing request, the batch status will be TimedOut.

TimedOut

The simulation batch job timed out.

failedRequestCount: allOf: - $ref: '#/components/schemas/Integer' - description: The number of failed simulation job requests. pendingRequestCount: allOf: - $ref: '#/components/schemas/Integer' - description: The number of pending simulation job requests. createdRequestCount: allOf: - $ref: '#/components/schemas/Integer' - description: The number of created simulation job requests. description: Information about a simulation job batch. SimulationJobSummary: type: object properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the simulation job. lastUpdatedAt: allOf: - $ref: '#/components/schemas/LastUpdatedAt' - description: The time, in milliseconds since the epoch, when the simulation job was last updated. name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the simulation job. status: allOf: - $ref: '#/components/schemas/SimulationJobStatus' - description: The status of the simulation job. simulationApplicationNames: allOf: - $ref: '#/components/schemas/SimulationApplicationNames' - description: A list of simulation job simulation application names. robotApplicationNames: allOf: - $ref: '#/components/schemas/RobotApplicationNames' - description: A list of simulation job robot application names. dataSourceNames: allOf: - $ref: '#/components/schemas/DataSourceNames' - description: The names of the data sources. computeType: allOf: - $ref: '#/components/schemas/ComputeType' - description: The compute type for the simulation job summary. description: Summary information for a simulation job. Source: type: object properties: s3Bucket: allOf: - $ref: '#/components/schemas/S3Bucket' - description: The s3 bucket name. s3Key: allOf: - $ref: '#/components/schemas/S3Key' - description: The s3 object key. etag: allOf: - $ref: '#/components/schemas/S3Etag' - description: A hash of the object specified by s3Bucket and s3Key. architecture: allOf: - $ref: '#/components/schemas/Architecture' - description: The taget processor architecture for the application. description: Information about a source. StartSimulationJobBatchRequest: type: object required: - createSimulationJobRequests title: StartSimulationJobBatchRequest properties: clientRequestToken: allOf: - $ref: '#/components/schemas/ClientRequestToken' - description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. batchPolicy: allOf: - $ref: '#/components/schemas/BatchPolicy' - description: The batch policy. createSimulationJobRequests: allOf: - $ref: '#/components/schemas/CreateSimulationJobRequests' - description: A list of simulation job requests to create in the batch. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: A map that contains tag keys and tag values that are attached to the deployment job batch. SyncDeploymentJobRequest: type: object required: - clientRequestToken - fleet deprecated: true title: SyncDeploymentJobRequest properties: clientRequestToken: allOf: - $ref: '#/components/schemas/ClientRequestToken' - description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. fleet: allOf: - $ref: '#/components/schemas/Arn' - description: The target fleet for the synchronization. description: Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html. TagKeyList: type: array items: $ref: '#/components/schemas/TagKey' TagResourceRequest: type: object required: - tags title: TagResourceRequest properties: tags: allOf: - $ref: '#/components/schemas/TagMap' - description: A map that contains tag keys and tag values that are attached to the resource. TemplateSummary: type: object properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the template. createdAt: allOf: - $ref: '#/components/schemas/CreatedAt' - description: The time, in milliseconds since the epoch, when the template was created. lastUpdatedAt: allOf: - $ref: '#/components/schemas/LastUpdatedAt' - description: The time, in milliseconds since the epoch, when the template was last updated. name: allOf: - $ref: '#/components/schemas/TemplateName' - description: The name of the template. version: allOf: - $ref: '#/components/schemas/GenericString' - description: The version of the template that you're using. description: Summary information for a template. UnrestrictedCommand: type: string pattern: .* minLength: 1 maxLength: 1024 Tool: type: object required: - name - command properties: streamUI: allOf: - $ref: '#/components/schemas/BoxedBoolean' - description: 'Boolean indicating whether a streaming session will be configured for the tool. If True, AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False. ' name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the tool. command: allOf: - $ref: '#/components/schemas/UnrestrictedCommand' - description: Command-line arguments for the tool. It must include the tool executable name. streamOutputToCloudWatch: allOf: - $ref: '#/components/schemas/BoxedBoolean' - description: 'Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False. ' exitBehavior: allOf: - $ref: '#/components/schemas/ExitBehavior' - description: 'Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART. ' description: Information about a tool. Tools are used in a simulation job. UntagResourceRequest: type: object title: UntagResourceRequest properties: {} UpdateRobotApplicationRequest: type: object required: - application - robotSoftwareSuite title: UpdateRobotApplicationRequest properties: application: allOf: - $ref: '#/components/schemas/Arn' - description: The application information for the robot application. sources: allOf: - $ref: '#/components/schemas/SourceConfigs' - description: The sources of the robot application. robotSoftwareSuite: allOf: - $ref: '#/components/schemas/RobotSoftwareSuite' - description: The robot software suite (ROS distribution) used by the robot application. currentRevisionId: allOf: - $ref: '#/components/schemas/RevisionId' - description: The revision id for the robot application. environment: allOf: - $ref: '#/components/schemas/Environment' - description: The object that contains the Docker image URI for your robot application. UpdateSimulationApplicationRequest: type: object required: - application - simulationSoftwareSuite - robotSoftwareSuite title: UpdateSimulationApplicationRequest properties: application: allOf: - $ref: '#/components/schemas/Arn' - description: The application information for the simulation application. sources: allOf: - $ref: '#/components/schemas/SourceConfigs' - description: The sources of the simulation application. simulationSoftwareSuite: allOf: - $ref: '#/components/schemas/SimulationSoftwareSuite' - description: The simulation software suite used by the simulation application. robotSoftwareSuite: allOf: - $ref: '#/components/schemas/RobotSoftwareSuite' - description: Information about the robot software suite (ROS distribution). renderingEngine: allOf: - $ref: '#/components/schemas/RenderingEngine' - description: The rendering engine for the simulation application. currentRevisionId: allOf: - $ref: '#/components/schemas/RevisionId' - description: The revision id for the robot application. environment: allOf: - $ref: '#/components/schemas/Environment' - description: The object that contains the Docker image URI for your simulation application. UpdateWorldTemplateRequest: type: object required: - template title: UpdateWorldTemplateRequest properties: template: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (arn) of the world template to update. name: allOf: - $ref: '#/components/schemas/TemplateName' - description: The name of the template. templateBody: allOf: - $ref: '#/components/schemas/Json' - description: The world template body. templateLocation: allOf: - $ref: '#/components/schemas/TemplateLocation' - description: The location of the world template. UploadBehavior: type: string enum: - UPLOAD_ON_TERMINATE - UPLOAD_ROLLING_AUTO_REMOVE UploadConfiguration: type: object required: - name - path - uploadBehavior properties: name: allOf: - $ref: '#/components/schemas/Name' - description:

A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the simulation output location to determine the final path.

For example, if your simulation output location is s3://my-bucket and your upload configuration name is robot-test, your files will be uploaded to s3://my-bucket/<simid>/<runid>/robot-test.

path: allOf: - $ref: '#/components/schemas/Path' - description: ' Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of ** as a super asterisk. For example, specifying /var/log/**.log causes all .log files in the /var/log directory tree to be collected. For more examples, see Glob Library. ' uploadBehavior: allOf: - $ref: '#/components/schemas/UploadBehavior' - description:

Specifies when to upload the files:

UPLOAD_ON_TERMINATE

Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.

If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.

UPLOAD_ROLLING_AUTO_REMOVE

Matching files are uploaded as they are created. They are deleted after they are uploaded. The specified path is checked every 5 seconds. A final check is made when all of your code (including tools) have stopped.

description: 'Provides upload configuration information. Files are uploaded from the simulation job to a location you specify. ' WorldConfig: type: object properties: world: allOf: - $ref: '#/components/schemas/Arn' - description: The world generated by Simulation WorldForge. description: Configuration information for a world. WorldExportJobSummary: type: object properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the world export job. status: allOf: - $ref: '#/components/schemas/WorldExportJobStatus' - description:

The status of the world export job.

Pending

The world export job request is pending.

Running

The world export job is running.

Completed

The world export job completed.

Failed

The world export job failed. See failureCode for more information.

Canceled

The world export job was cancelled.

Canceling

The world export job is being cancelled.

createdAt: allOf: - $ref: '#/components/schemas/CreatedAt' - description: The time, in milliseconds since the epoch, when the world export job was created. worlds: allOf: - $ref: '#/components/schemas/Arns' - description: A list of worlds. outputLocation: $ref: '#/components/schemas/OutputLocation' description: Information about a world export job. WorldFailure: type: object properties: failureCode: allOf: - $ref: '#/components/schemas/WorldGenerationJobErrorCode' - description:

The failure code of the world export job if it failed:

InternalServiceError

Internal service error.

LimitExceeded

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

ResourceNotFound

The specified resource could not be found.

RequestThrottled

The request was throttled.

InvalidInput

An input parameter in the request is not valid.

sampleFailureReason: allOf: - $ref: '#/components/schemas/GenericString' - description: 'The sample reason why the world failed. World errors are aggregated. A sample is used as the sampleFailureReason. ' failureCount: allOf: - $ref: '#/components/schemas/Integer' - description: The number of failed worlds. description: Information about a failed world. WorldGenerationJobSummary: type: object properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the world generator job. template: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (arn) of the world template. createdAt: allOf: - $ref: '#/components/schemas/CreatedAt' - description: The time, in milliseconds since the epoch, when the world generator job was created. status: allOf: - $ref: '#/components/schemas/WorldGenerationJobStatus' - description:

The status of the world generator job:

Pending

The world generator job request is pending.

Running

The world generator job is running.

Completed

The world generator job completed.

Failed

The world generator job failed. See failureCode for more information.

PartialFailed

Some worlds did not generate.

Canceled

The world generator job was cancelled.

Canceling

The world generator job is being cancelled.

worldCount: allOf: - $ref: '#/components/schemas/WorldCount' - description: Information about the world count. succeededWorldCount: allOf: - $ref: '#/components/schemas/Integer' - description: The number of worlds that were generated. failedWorldCount: allOf: - $ref: '#/components/schemas/Integer' - description: The number of worlds that failed. description: Information about a world generator job. WorldSummary: type: object properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the world. createdAt: allOf: - $ref: '#/components/schemas/CreatedAt' - description: The time, in milliseconds since the epoch, when the world was created. generationJob: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (arn) of the world generation job. template: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (arn) of the world template. description: Information about a world. security: - hmac: []