@lap v0.3 # Machine-readable API spec. Each @endpoint block is one API call. @api AWS RoboMaker @version 2018-06-29 @auth AWS SigV4 @endpoints 57 @hint download_for_search @toc batchDeleteWorlds(1), batchDescribeSimulationJob(1), cancelDeploymentJob(1), cancelSimulationJob(1), cancelSimulationJobBatch(1), cancelWorldExportJob(1), cancelWorldGenerationJob(1), createDeploymentJob(1), createFleet(1), createRobot(1), createRobotApplication(1), createRobotApplicationVersion(1), createSimulationApplication(1), createSimulationApplicationVersion(1), createSimulationJob(1), createWorldExportJob(1), createWorldGenerationJob(1), createWorldTemplate(1), deleteFleet(1), deleteRobot(1), deleteRobotApplication(1), deleteSimulationApplication(1), deleteWorldTemplate(1), deregisterRobot(1), describeDeploymentJob(1), describeFleet(1), describeRobot(1), describeRobotApplication(1), describeSimulationApplication(1), describeSimulationJob(1), describeSimulationJobBatch(1), describeWorld(1), describeWorldExportJob(1), describeWorldGenerationJob(1), describeWorldTemplate(1), getWorldTemplateBody(1), listDeploymentJobs(1), listFleets(1), listRobotApplications(1), listRobots(1), listSimulationApplications(1), listSimulationJobBatches(1), listSimulationJobs(1), tags(3), listWorldExportJobs(1), listWorldGenerationJobs(1), listWorldTemplates(1), listWorlds(1), registerRobot(1), restartSimulationJob(1), startSimulationJobBatch(1), syncDeploymentJob(1), updateRobotApplication(1), updateSimulationApplication(1), updateWorldTemplate(1) @group batchDeleteWorlds @endpoint POST /batchDeleteWorlds @required {worlds: [str]} @returns(200) {unprocessedWorlds: [str]?} @endgroup @group batchDescribeSimulationJob @endpoint POST /batchDescribeSimulationJob @required {jobs: [str]} @returns(200) {jobs: [SimulationJob]?, unprocessedJobs: [str]?} @endgroup @group cancelDeploymentJob @endpoint POST /cancelDeploymentJob @required {job: str} @endgroup @group cancelSimulationJob @endpoint POST /cancelSimulationJob @required {job: str} @endgroup @group cancelSimulationJobBatch @endpoint POST /cancelSimulationJobBatch @required {batch: str} @endgroup @group cancelWorldExportJob @endpoint POST /cancelWorldExportJob @required {job: str} @endgroup @group cancelWorldGenerationJob @endpoint POST /cancelWorldGenerationJob @required {job: str} @endgroup @group createDeploymentJob @endpoint POST /createDeploymentJob @required {clientRequestToken: str, fleet: str, deploymentApplicationConfigs: [DeploymentApplicationConfig]} @optional {deploymentConfig: DeploymentConfig, tags: map} @returns(200) {arn: str?, fleet: str?, status: str?, deploymentApplicationConfigs: [DeploymentApplicationConfig]?, failureReason: str?, failureCode: str?, createdAt: str(timestamp)?, deploymentConfig: DeploymentConfig?{concurrentDeploymentPercentage: int?, failureThresholdPercentage: int?, robotDeploymentTimeoutInSeconds: int(i64)?, downloadConditionFile: S3Object?{bucket: str, key: str, etag: str?}}, tags: map?} @endgroup @group createFleet @endpoint POST /createFleet @required {name: str} @optional {tags: map} @returns(200) {arn: str?, name: str?, createdAt: str(timestamp)?, tags: map?} @endgroup @group createRobot @endpoint POST /createRobot @required {name: str, architecture: str, greengrassGroupId: str} @optional {tags: map} @returns(200) {arn: str?, name: str?, createdAt: str(timestamp)?, greengrassGroupId: str?, architecture: str?, tags: map?} @endgroup @group createRobotApplication @endpoint POST /createRobotApplication @required {name: str, robotSoftwareSuite: RobotSoftwareSuite} @optional {sources: [SourceConfig], tags: map, environment: Environment} @returns(200) {arn: str?, name: str?, version: str?, sources: [Source]?, robotSoftwareSuite: RobotSoftwareSuite?{name: str?, version: str?}, lastUpdatedAt: str(timestamp)?, revisionId: str?, tags: map?, environment: Environment?{uri: str?}} @endgroup @group createRobotApplicationVersion @endpoint POST /createRobotApplicationVersion @required {application: str} @optional {currentRevisionId: str, s3Etags: [str], imageDigest: str} @returns(200) {arn: str?, name: str?, version: str?, sources: [Source]?, robotSoftwareSuite: RobotSoftwareSuite?{name: str?, version: str?}, lastUpdatedAt: str(timestamp)?, revisionId: str?, environment: Environment?{uri: str?}} @endgroup @group createSimulationApplication @endpoint POST /createSimulationApplication @required {name: str, simulationSoftwareSuite: SimulationSoftwareSuite, robotSoftwareSuite: RobotSoftwareSuite} @optional {sources: [SourceConfig], renderingEngine: RenderingEngine, tags: map, environment: Environment} @returns(200) {arn: str?, name: str?, version: str?, sources: [Source]?, simulationSoftwareSuite: SimulationSoftwareSuite?{name: str?, version: str?}, robotSoftwareSuite: RobotSoftwareSuite?{name: str?, version: str?}, renderingEngine: RenderingEngine?{name: str?, version: str?}, lastUpdatedAt: str(timestamp)?, revisionId: str?, tags: map?, environment: Environment?{uri: str?}} @endgroup @group createSimulationApplicationVersion @endpoint POST /createSimulationApplicationVersion @required {application: str} @optional {currentRevisionId: str, s3Etags: [str], imageDigest: str} @returns(200) {arn: str?, name: str?, version: str?, sources: [Source]?, simulationSoftwareSuite: SimulationSoftwareSuite?{name: str?, version: str?}, robotSoftwareSuite: RobotSoftwareSuite?{name: str?, version: str?}, renderingEngine: RenderingEngine?{name: str?, version: str?}, lastUpdatedAt: str(timestamp)?, revisionId: str?, environment: Environment?{uri: str?}} @endgroup @group createSimulationJob @endpoint POST /createSimulationJob @required {maxJobDurationInSeconds: int(i64), iamRole: str} @optional {clientRequestToken: str, outputLocation: OutputLocation, loggingConfig: LoggingConfig, failureBehavior: str, robotApplications: [RobotApplicationConfig], simulationApplications: [SimulationApplicationConfig], dataSources: [DataSourceConfig], tags: map, vpcConfig: VPCConfig, compute: Compute} @returns(200) {arn: str?, status: str?, lastStartedAt: str(timestamp)?, lastUpdatedAt: str(timestamp)?, failureBehavior: str?, failureCode: str?, clientRequestToken: str?, outputLocation: OutputLocation?{s3Bucket: str?, s3Prefix: str?}, loggingConfig: LoggingConfig?{recordAllRosTopics: bool?}, maxJobDurationInSeconds: int(i64)?, simulationTimeMillis: int(i64)?, iamRole: str?, robotApplications: [RobotApplicationConfig]?, simulationApplications: [SimulationApplicationConfig]?, dataSources: [DataSource]?, tags: map?, vpcConfig: VPCConfigResponse?{subnets: [str]?, securityGroups: [str]?, vpcId: str?, assignPublicIp: bool?}, compute: ComputeResponse?{simulationUnitLimit: int?, computeType: str?, gpuUnitLimit: int?}} @endgroup @group createWorldExportJob @endpoint POST /createWorldExportJob @required {worlds: [str], outputLocation: OutputLocation, iamRole: str} @optional {clientRequestToken: str, tags: map} @returns(200) {arn: str?, status: str?, createdAt: str(timestamp)?, failureCode: str?, clientRequestToken: str?, outputLocation: OutputLocation?{s3Bucket: str?, s3Prefix: str?}, iamRole: str?, tags: map?} @endgroup @group createWorldGenerationJob @endpoint POST /createWorldGenerationJob @required {template: str, worldCount: WorldCount} @optional {clientRequestToken: str, tags: map, worldTags: map} @returns(200) {arn: str?, status: str?, createdAt: str(timestamp)?, failureCode: str?, clientRequestToken: str?, template: str?, worldCount: WorldCount?{floorplanCount: int?, interiorCountPerFloorplan: int?}, tags: map?, worldTags: map?} @endgroup @group createWorldTemplate @endpoint POST /createWorldTemplate @optional {clientRequestToken: str, name: str, templateBody: str, templateLocation: TemplateLocation, tags: map} @returns(200) {arn: str?, clientRequestToken: str?, createdAt: str(timestamp)?, name: str?, tags: map?} @endgroup @group deleteFleet @endpoint POST /deleteFleet @required {fleet: str} @endgroup @group deleteRobot @endpoint POST /deleteRobot @required {robot: str} @endgroup @group deleteRobotApplication @endpoint POST /deleteRobotApplication @required {application: str} @optional {applicationVersion: str} @endgroup @group deleteSimulationApplication @endpoint POST /deleteSimulationApplication @required {application: str} @optional {applicationVersion: str} @endgroup @group deleteWorldTemplate @endpoint POST /deleteWorldTemplate @required {template: str} @endgroup @group deregisterRobot @endpoint POST /deregisterRobot @required {fleet: str, robot: str} @returns(200) {fleet: str?, robot: str?} @endgroup @group describeDeploymentJob @endpoint POST /describeDeploymentJob @required {job: str} @returns(200) {arn: str?, fleet: str?, status: str?, deploymentConfig: DeploymentConfig?{concurrentDeploymentPercentage: int?, failureThresholdPercentage: int?, robotDeploymentTimeoutInSeconds: int(i64)?, downloadConditionFile: S3Object?{bucket: str, key: str, etag: str?}}, deploymentApplicationConfigs: [DeploymentApplicationConfig]?, failureReason: str?, failureCode: str?, createdAt: str(timestamp)?, robotDeploymentSummary: [RobotDeployment]?, tags: map?} @endgroup @group describeFleet @endpoint POST /describeFleet @required {fleet: str} @returns(200) {name: str?, arn: str?, robots: [Robot]?, createdAt: str(timestamp)?, lastDeploymentStatus: str?, lastDeploymentJob: str?, lastDeploymentTime: str(timestamp)?, tags: map?} @endgroup @group describeRobot @endpoint POST /describeRobot @required {robot: str} @returns(200) {arn: str?, name: str?, fleetArn: str?, status: str?, greengrassGroupId: str?, createdAt: str(timestamp)?, architecture: str?, lastDeploymentJob: str?, lastDeploymentTime: str(timestamp)?, tags: map?} @endgroup @group describeRobotApplication @endpoint POST /describeRobotApplication @required {application: str} @optional {applicationVersion: str} @returns(200) {arn: str?, name: str?, version: str?, sources: [Source]?, robotSoftwareSuite: RobotSoftwareSuite?{name: str?, version: str?}, revisionId: str?, lastUpdatedAt: str(timestamp)?, tags: map?, environment: Environment?{uri: str?}, imageDigest: str?} @endgroup @group describeSimulationApplication @endpoint POST /describeSimulationApplication @required {application: str} @optional {applicationVersion: str} @returns(200) {arn: str?, name: str?, version: str?, sources: [Source]?, simulationSoftwareSuite: SimulationSoftwareSuite?{name: str?, version: str?}, robotSoftwareSuite: RobotSoftwareSuite?{name: str?, version: str?}, renderingEngine: RenderingEngine?{name: str?, version: str?}, revisionId: str?, lastUpdatedAt: str(timestamp)?, tags: map?, environment: Environment?{uri: str?}, imageDigest: str?} @endgroup @group describeSimulationJob @endpoint POST /describeSimulationJob @required {job: str} @returns(200) {arn: str?, name: str?, status: str?, lastStartedAt: str(timestamp)?, lastUpdatedAt: str(timestamp)?, failureBehavior: str?, failureCode: str?, failureReason: str?, clientRequestToken: str?, outputLocation: OutputLocation?{s3Bucket: str?, s3Prefix: str?}, loggingConfig: LoggingConfig?{recordAllRosTopics: bool?}, maxJobDurationInSeconds: int(i64)?, simulationTimeMillis: int(i64)?, iamRole: str?, robotApplications: [RobotApplicationConfig]?, simulationApplications: [SimulationApplicationConfig]?, dataSources: [DataSource]?, tags: map?, vpcConfig: VPCConfigResponse?{subnets: [str]?, securityGroups: [str]?, vpcId: str?, assignPublicIp: bool?}, networkInterface: NetworkInterface?{networkInterfaceId: str?, privateIpAddress: str?, publicIpAddress: str?}, compute: ComputeResponse?{simulationUnitLimit: int?, computeType: str?, gpuUnitLimit: int?}} @endgroup @group describeSimulationJobBatch @endpoint POST /describeSimulationJobBatch @required {batch: str} @returns(200) {arn: str?, status: str?, lastUpdatedAt: str(timestamp)?, createdAt: str(timestamp)?, clientRequestToken: str?, batchPolicy: BatchPolicy?{timeoutInSeconds: int(i64)?, maxConcurrency: int?}, failureCode: str?, failureReason: str?, failedRequests: [FailedCreateSimulationJobRequest]?, pendingRequests: [SimulationJobRequest]?, createdRequests: [SimulationJobSummary]?, tags: map?} @endgroup @group describeWorld @endpoint POST /describeWorld @required {world: str} @returns(200) {arn: str?, generationJob: str?, template: str?, createdAt: str(timestamp)?, tags: map?, worldDescriptionBody: str?} @endgroup @group describeWorldExportJob @endpoint POST /describeWorldExportJob @required {job: str} @returns(200) {arn: str?, status: str?, createdAt: str(timestamp)?, failureCode: str?, failureReason: str?, clientRequestToken: str?, worlds: [str]?, outputLocation: OutputLocation?{s3Bucket: str?, s3Prefix: str?}, iamRole: str?, tags: map?} @endgroup @group describeWorldGenerationJob @endpoint POST /describeWorldGenerationJob @required {job: str} @returns(200) {arn: str?, status: str?, createdAt: str(timestamp)?, failureCode: str?, failureReason: str?, clientRequestToken: str?, template: str?, worldCount: WorldCount?{floorplanCount: int?, interiorCountPerFloorplan: int?}, finishedWorldsSummary: FinishedWorldsSummary?{finishedCount: int?, succeededWorlds: [str]?, failureSummary: FailureSummary?{totalFailureCount: int?, failures: [WorldFailure]?}}, tags: map?, worldTags: map?} @endgroup @group describeWorldTemplate @endpoint POST /describeWorldTemplate @required {template: str} @returns(200) {arn: str?, clientRequestToken: str?, name: str?, createdAt: str(timestamp)?, lastUpdatedAt: str(timestamp)?, tags: map?, version: str?} @endgroup @group getWorldTemplateBody @endpoint POST /getWorldTemplateBody @optional {template: str, generationJob: str} @returns(200) {templateBody: str?} @endgroup @group listDeploymentJobs @endpoint POST /listDeploymentJobs @optional {filters: [Filter], nextToken: str, maxResults: int} @returns(200) {deploymentJobs: [DeploymentJob]?, nextToken: str?} @endgroup @group listFleets @endpoint POST /listFleets @optional {nextToken: str, maxResults: int, filters: [Filter]} @returns(200) {fleetDetails: [Fleet]?, nextToken: str?} @endgroup @group listRobotApplications @endpoint POST /listRobotApplications @optional {versionQualifier: str, nextToken: str, maxResults: int, filters: [Filter]} @returns(200) {robotApplicationSummaries: [RobotApplicationSummary]?, nextToken: str?} @endgroup @group listRobots @endpoint POST /listRobots @optional {nextToken: str, maxResults: int, filters: [Filter]} @returns(200) {robots: [Robot]?, nextToken: str?} @endgroup @group listSimulationApplications @endpoint POST /listSimulationApplications @optional {versionQualifier: str, nextToken: str, maxResults: int, filters: [Filter]} @returns(200) {simulationApplicationSummaries: [SimulationApplicationSummary]?, nextToken: str?} @endgroup @group listSimulationJobBatches @endpoint POST /listSimulationJobBatches @optional {nextToken: str, maxResults: int, filters: [Filter]} @returns(200) {simulationJobBatchSummaries: [SimulationJobBatchSummary]?, nextToken: str?} @endgroup @group listSimulationJobs @endpoint POST /listSimulationJobs @optional {nextToken: str, maxResults: int, filters: [Filter]} @returns(200) {simulationJobSummaries: [SimulationJobSummary], nextToken: str?} @endgroup @group tags @endpoint GET /tags/{resourceArn} @required {resourceArn: str} @returns(200) {tags: map?} @endgroup @group listWorldExportJobs @endpoint POST /listWorldExportJobs @optional {nextToken: str, maxResults: int, filters: [Filter]} @returns(200) {worldExportJobSummaries: [WorldExportJobSummary], nextToken: str?} @endgroup @group listWorldGenerationJobs @endpoint POST /listWorldGenerationJobs @optional {nextToken: str, maxResults: int, filters: [Filter]} @returns(200) {worldGenerationJobSummaries: [WorldGenerationJobSummary], nextToken: str?} @endgroup @group listWorldTemplates @endpoint POST /listWorldTemplates @optional {nextToken: str, maxResults: int} @returns(200) {templateSummaries: [TemplateSummary]?, nextToken: str?} @endgroup @group listWorlds @endpoint POST /listWorlds @optional {nextToken: str, maxResults: int, filters: [Filter]} @returns(200) {worldSummaries: [WorldSummary]?, nextToken: str?} @endgroup @group registerRobot @endpoint POST /registerRobot @required {fleet: str, robot: str} @returns(200) {fleet: str?, robot: str?} @endgroup @group restartSimulationJob @endpoint POST /restartSimulationJob @required {job: str} @endgroup @group startSimulationJobBatch @endpoint POST /startSimulationJobBatch @required {createSimulationJobRequests: [SimulationJobRequest]} @optional {clientRequestToken: str, batchPolicy: BatchPolicy, tags: map} @returns(200) {arn: str?, status: str?, createdAt: str(timestamp)?, clientRequestToken: str?, batchPolicy: BatchPolicy?{timeoutInSeconds: int(i64)?, maxConcurrency: int?}, failureCode: str?, failureReason: str?, failedRequests: [FailedCreateSimulationJobRequest]?, pendingRequests: [SimulationJobRequest]?, createdRequests: [SimulationJobSummary]?, tags: map?} @endgroup @group syncDeploymentJob @endpoint POST /syncDeploymentJob @required {clientRequestToken: str, fleet: str} @returns(200) {arn: str?, fleet: str?, status: str?, deploymentConfig: DeploymentConfig?{concurrentDeploymentPercentage: int?, failureThresholdPercentage: int?, robotDeploymentTimeoutInSeconds: int(i64)?, downloadConditionFile: S3Object?{bucket: str, key: str, etag: str?}}, deploymentApplicationConfigs: [DeploymentApplicationConfig]?, failureReason: str?, failureCode: str?, createdAt: str(timestamp)?} @endgroup @group tags @endpoint POST /tags/{resourceArn} @required {resourceArn: str, tags: map} @endpoint DELETE /tags/{resourceArn} @required {resourceArn: str, tagKeys: [str]} @endgroup @group updateRobotApplication @endpoint POST /updateRobotApplication @required {application: str, robotSoftwareSuite: RobotSoftwareSuite} @optional {sources: [SourceConfig], currentRevisionId: str, environment: Environment} @returns(200) {arn: str?, name: str?, version: str?, sources: [Source]?, robotSoftwareSuite: RobotSoftwareSuite?{name: str?, version: str?}, lastUpdatedAt: str(timestamp)?, revisionId: str?, environment: Environment?{uri: str?}} @endgroup @group updateSimulationApplication @endpoint POST /updateSimulationApplication @required {application: str, simulationSoftwareSuite: SimulationSoftwareSuite, robotSoftwareSuite: RobotSoftwareSuite} @optional {sources: [SourceConfig], renderingEngine: RenderingEngine, currentRevisionId: str, environment: Environment} @returns(200) {arn: str?, name: str?, version: str?, sources: [Source]?, simulationSoftwareSuite: SimulationSoftwareSuite?{name: str?, version: str?}, robotSoftwareSuite: RobotSoftwareSuite?{name: str?, version: str?}, renderingEngine: RenderingEngine?{name: str?, version: str?}, lastUpdatedAt: str(timestamp)?, revisionId: str?, environment: Environment?{uri: str?}} @endgroup @group updateWorldTemplate @endpoint POST /updateWorldTemplate @required {template: str} @optional {name: str, templateBody: str, templateLocation: TemplateLocation} @returns(200) {arn: str?, name: str?, createdAt: str(timestamp)?, lastUpdatedAt: str(timestamp)?} @endgroup @end