UNPKG

105 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class RoboMaker extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: RoboMaker.Types.ClientConfiguration)
13 config: Config & RoboMaker.Types.ClientConfiguration;
14 /**
15 * Describes one or more simulation jobs.
16 */
17 batchDescribeSimulationJob(params: RoboMaker.Types.BatchDescribeSimulationJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.BatchDescribeSimulationJobResponse) => void): Request<RoboMaker.Types.BatchDescribeSimulationJobResponse, AWSError>;
18 /**
19 * Describes one or more simulation jobs.
20 */
21 batchDescribeSimulationJob(callback?: (err: AWSError, data: RoboMaker.Types.BatchDescribeSimulationJobResponse) => void): Request<RoboMaker.Types.BatchDescribeSimulationJobResponse, AWSError>;
22 /**
23 * Cancels the specified deployment job.
24 */
25 cancelDeploymentJob(params: RoboMaker.Types.CancelDeploymentJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.CancelDeploymentJobResponse) => void): Request<RoboMaker.Types.CancelDeploymentJobResponse, AWSError>;
26 /**
27 * Cancels the specified deployment job.
28 */
29 cancelDeploymentJob(callback?: (err: AWSError, data: RoboMaker.Types.CancelDeploymentJobResponse) => void): Request<RoboMaker.Types.CancelDeploymentJobResponse, AWSError>;
30 /**
31 * Cancels the specified simulation job.
32 */
33 cancelSimulationJob(params: RoboMaker.Types.CancelSimulationJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.CancelSimulationJobResponse) => void): Request<RoboMaker.Types.CancelSimulationJobResponse, AWSError>;
34 /**
35 * Cancels the specified simulation job.
36 */
37 cancelSimulationJob(callback?: (err: AWSError, data: RoboMaker.Types.CancelSimulationJobResponse) => void): Request<RoboMaker.Types.CancelSimulationJobResponse, AWSError>;
38 /**
39 * 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.
40 */
41 cancelSimulationJobBatch(params: RoboMaker.Types.CancelSimulationJobBatchRequest, callback?: (err: AWSError, data: RoboMaker.Types.CancelSimulationJobBatchResponse) => void): Request<RoboMaker.Types.CancelSimulationJobBatchResponse, AWSError>;
42 /**
43 * 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.
44 */
45 cancelSimulationJobBatch(callback?: (err: AWSError, data: RoboMaker.Types.CancelSimulationJobBatchResponse) => void): Request<RoboMaker.Types.CancelSimulationJobBatchResponse, AWSError>;
46 /**
47 * Deploys a specific version of a robot application to robots in a fleet. 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.
48 */
49 createDeploymentJob(params: RoboMaker.Types.CreateDeploymentJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateDeploymentJobResponse) => void): Request<RoboMaker.Types.CreateDeploymentJobResponse, AWSError>;
50 /**
51 * Deploys a specific version of a robot application to robots in a fleet. 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.
52 */
53 createDeploymentJob(callback?: (err: AWSError, data: RoboMaker.Types.CreateDeploymentJobResponse) => void): Request<RoboMaker.Types.CreateDeploymentJobResponse, AWSError>;
54 /**
55 * Creates a fleet, a logical group of robots running the same robot application.
56 */
57 createFleet(params: RoboMaker.Types.CreateFleetRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateFleetResponse) => void): Request<RoboMaker.Types.CreateFleetResponse, AWSError>;
58 /**
59 * Creates a fleet, a logical group of robots running the same robot application.
60 */
61 createFleet(callback?: (err: AWSError, data: RoboMaker.Types.CreateFleetResponse) => void): Request<RoboMaker.Types.CreateFleetResponse, AWSError>;
62 /**
63 * Creates a robot.
64 */
65 createRobot(params: RoboMaker.Types.CreateRobotRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateRobotResponse) => void): Request<RoboMaker.Types.CreateRobotResponse, AWSError>;
66 /**
67 * Creates a robot.
68 */
69 createRobot(callback?: (err: AWSError, data: RoboMaker.Types.CreateRobotResponse) => void): Request<RoboMaker.Types.CreateRobotResponse, AWSError>;
70 /**
71 * Creates a robot application.
72 */
73 createRobotApplication(params: RoboMaker.Types.CreateRobotApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateRobotApplicationResponse) => void): Request<RoboMaker.Types.CreateRobotApplicationResponse, AWSError>;
74 /**
75 * Creates a robot application.
76 */
77 createRobotApplication(callback?: (err: AWSError, data: RoboMaker.Types.CreateRobotApplicationResponse) => void): Request<RoboMaker.Types.CreateRobotApplicationResponse, AWSError>;
78 /**
79 * Creates a version of a robot application.
80 */
81 createRobotApplicationVersion(params: RoboMaker.Types.CreateRobotApplicationVersionRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateRobotApplicationVersionResponse) => void): Request<RoboMaker.Types.CreateRobotApplicationVersionResponse, AWSError>;
82 /**
83 * Creates a version of a robot application.
84 */
85 createRobotApplicationVersion(callback?: (err: AWSError, data: RoboMaker.Types.CreateRobotApplicationVersionResponse) => void): Request<RoboMaker.Types.CreateRobotApplicationVersionResponse, AWSError>;
86 /**
87 * Creates a simulation application.
88 */
89 createSimulationApplication(params: RoboMaker.Types.CreateSimulationApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateSimulationApplicationResponse) => void): Request<RoboMaker.Types.CreateSimulationApplicationResponse, AWSError>;
90 /**
91 * Creates a simulation application.
92 */
93 createSimulationApplication(callback?: (err: AWSError, data: RoboMaker.Types.CreateSimulationApplicationResponse) => void): Request<RoboMaker.Types.CreateSimulationApplicationResponse, AWSError>;
94 /**
95 * Creates a simulation application with a specific revision id.
96 */
97 createSimulationApplicationVersion(params: RoboMaker.Types.CreateSimulationApplicationVersionRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateSimulationApplicationVersionResponse) => void): Request<RoboMaker.Types.CreateSimulationApplicationVersionResponse, AWSError>;
98 /**
99 * Creates a simulation application with a specific revision id.
100 */
101 createSimulationApplicationVersion(callback?: (err: AWSError, data: RoboMaker.Types.CreateSimulationApplicationVersionResponse) => void): Request<RoboMaker.Types.CreateSimulationApplicationVersionResponse, AWSError>;
102 /**
103 * Creates a simulation job. After 90 days, simulation jobs expire and will be deleted. They will no longer be accessible.
104 */
105 createSimulationJob(params: RoboMaker.Types.CreateSimulationJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateSimulationJobResponse) => void): Request<RoboMaker.Types.CreateSimulationJobResponse, AWSError>;
106 /**
107 * Creates a simulation job. After 90 days, simulation jobs expire and will be deleted. They will no longer be accessible.
108 */
109 createSimulationJob(callback?: (err: AWSError, data: RoboMaker.Types.CreateSimulationJobResponse) => void): Request<RoboMaker.Types.CreateSimulationJobResponse, AWSError>;
110 /**
111 * Deletes a fleet.
112 */
113 deleteFleet(params: RoboMaker.Types.DeleteFleetRequest, callback?: (err: AWSError, data: RoboMaker.Types.DeleteFleetResponse) => void): Request<RoboMaker.Types.DeleteFleetResponse, AWSError>;
114 /**
115 * Deletes a fleet.
116 */
117 deleteFleet(callback?: (err: AWSError, data: RoboMaker.Types.DeleteFleetResponse) => void): Request<RoboMaker.Types.DeleteFleetResponse, AWSError>;
118 /**
119 * Deletes a robot.
120 */
121 deleteRobot(params: RoboMaker.Types.DeleteRobotRequest, callback?: (err: AWSError, data: RoboMaker.Types.DeleteRobotResponse) => void): Request<RoboMaker.Types.DeleteRobotResponse, AWSError>;
122 /**
123 * Deletes a robot.
124 */
125 deleteRobot(callback?: (err: AWSError, data: RoboMaker.Types.DeleteRobotResponse) => void): Request<RoboMaker.Types.DeleteRobotResponse, AWSError>;
126 /**
127 * Deletes a robot application.
128 */
129 deleteRobotApplication(params: RoboMaker.Types.DeleteRobotApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.DeleteRobotApplicationResponse) => void): Request<RoboMaker.Types.DeleteRobotApplicationResponse, AWSError>;
130 /**
131 * Deletes a robot application.
132 */
133 deleteRobotApplication(callback?: (err: AWSError, data: RoboMaker.Types.DeleteRobotApplicationResponse) => void): Request<RoboMaker.Types.DeleteRobotApplicationResponse, AWSError>;
134 /**
135 * Deletes a simulation application.
136 */
137 deleteSimulationApplication(params: RoboMaker.Types.DeleteSimulationApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.DeleteSimulationApplicationResponse) => void): Request<RoboMaker.Types.DeleteSimulationApplicationResponse, AWSError>;
138 /**
139 * Deletes a simulation application.
140 */
141 deleteSimulationApplication(callback?: (err: AWSError, data: RoboMaker.Types.DeleteSimulationApplicationResponse) => void): Request<RoboMaker.Types.DeleteSimulationApplicationResponse, AWSError>;
142 /**
143 * Deregisters a robot.
144 */
145 deregisterRobot(params: RoboMaker.Types.DeregisterRobotRequest, callback?: (err: AWSError, data: RoboMaker.Types.DeregisterRobotResponse) => void): Request<RoboMaker.Types.DeregisterRobotResponse, AWSError>;
146 /**
147 * Deregisters a robot.
148 */
149 deregisterRobot(callback?: (err: AWSError, data: RoboMaker.Types.DeregisterRobotResponse) => void): Request<RoboMaker.Types.DeregisterRobotResponse, AWSError>;
150 /**
151 * Describes a deployment job.
152 */
153 describeDeploymentJob(params: RoboMaker.Types.DescribeDeploymentJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.DescribeDeploymentJobResponse) => void): Request<RoboMaker.Types.DescribeDeploymentJobResponse, AWSError>;
154 /**
155 * Describes a deployment job.
156 */
157 describeDeploymentJob(callback?: (err: AWSError, data: RoboMaker.Types.DescribeDeploymentJobResponse) => void): Request<RoboMaker.Types.DescribeDeploymentJobResponse, AWSError>;
158 /**
159 * Describes a fleet.
160 */
161 describeFleet(params: RoboMaker.Types.DescribeFleetRequest, callback?: (err: AWSError, data: RoboMaker.Types.DescribeFleetResponse) => void): Request<RoboMaker.Types.DescribeFleetResponse, AWSError>;
162 /**
163 * Describes a fleet.
164 */
165 describeFleet(callback?: (err: AWSError, data: RoboMaker.Types.DescribeFleetResponse) => void): Request<RoboMaker.Types.DescribeFleetResponse, AWSError>;
166 /**
167 * Describes a robot.
168 */
169 describeRobot(params: RoboMaker.Types.DescribeRobotRequest, callback?: (err: AWSError, data: RoboMaker.Types.DescribeRobotResponse) => void): Request<RoboMaker.Types.DescribeRobotResponse, AWSError>;
170 /**
171 * Describes a robot.
172 */
173 describeRobot(callback?: (err: AWSError, data: RoboMaker.Types.DescribeRobotResponse) => void): Request<RoboMaker.Types.DescribeRobotResponse, AWSError>;
174 /**
175 * Describes a robot application.
176 */
177 describeRobotApplication(params: RoboMaker.Types.DescribeRobotApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.DescribeRobotApplicationResponse) => void): Request<RoboMaker.Types.DescribeRobotApplicationResponse, AWSError>;
178 /**
179 * Describes a robot application.
180 */
181 describeRobotApplication(callback?: (err: AWSError, data: RoboMaker.Types.DescribeRobotApplicationResponse) => void): Request<RoboMaker.Types.DescribeRobotApplicationResponse, AWSError>;
182 /**
183 * Describes a simulation application.
184 */
185 describeSimulationApplication(params: RoboMaker.Types.DescribeSimulationApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.DescribeSimulationApplicationResponse) => void): Request<RoboMaker.Types.DescribeSimulationApplicationResponse, AWSError>;
186 /**
187 * Describes a simulation application.
188 */
189 describeSimulationApplication(callback?: (err: AWSError, data: RoboMaker.Types.DescribeSimulationApplicationResponse) => void): Request<RoboMaker.Types.DescribeSimulationApplicationResponse, AWSError>;
190 /**
191 * Describes a simulation job.
192 */
193 describeSimulationJob(params: RoboMaker.Types.DescribeSimulationJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.DescribeSimulationJobResponse) => void): Request<RoboMaker.Types.DescribeSimulationJobResponse, AWSError>;
194 /**
195 * Describes a simulation job.
196 */
197 describeSimulationJob(callback?: (err: AWSError, data: RoboMaker.Types.DescribeSimulationJobResponse) => void): Request<RoboMaker.Types.DescribeSimulationJobResponse, AWSError>;
198 /**
199 * Describes a simulation job batch.
200 */
201 describeSimulationJobBatch(params: RoboMaker.Types.DescribeSimulationJobBatchRequest, callback?: (err: AWSError, data: RoboMaker.Types.DescribeSimulationJobBatchResponse) => void): Request<RoboMaker.Types.DescribeSimulationJobBatchResponse, AWSError>;
202 /**
203 * Describes a simulation job batch.
204 */
205 describeSimulationJobBatch(callback?: (err: AWSError, data: RoboMaker.Types.DescribeSimulationJobBatchResponse) => void): Request<RoboMaker.Types.DescribeSimulationJobBatchResponse, AWSError>;
206 /**
207 * Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.
208 */
209 listDeploymentJobs(params: RoboMaker.Types.ListDeploymentJobsRequest, callback?: (err: AWSError, data: RoboMaker.Types.ListDeploymentJobsResponse) => void): Request<RoboMaker.Types.ListDeploymentJobsResponse, AWSError>;
210 /**
211 * Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.
212 */
213 listDeploymentJobs(callback?: (err: AWSError, data: RoboMaker.Types.ListDeploymentJobsResponse) => void): Request<RoboMaker.Types.ListDeploymentJobsResponse, AWSError>;
214 /**
215 * Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.
216 */
217 listFleets(params: RoboMaker.Types.ListFleetsRequest, callback?: (err: AWSError, data: RoboMaker.Types.ListFleetsResponse) => void): Request<RoboMaker.Types.ListFleetsResponse, AWSError>;
218 /**
219 * Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.
220 */
221 listFleets(callback?: (err: AWSError, data: RoboMaker.Types.ListFleetsResponse) => void): Request<RoboMaker.Types.ListFleetsResponse, AWSError>;
222 /**
223 * Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications.
224 */
225 listRobotApplications(params: RoboMaker.Types.ListRobotApplicationsRequest, callback?: (err: AWSError, data: RoboMaker.Types.ListRobotApplicationsResponse) => void): Request<RoboMaker.Types.ListRobotApplicationsResponse, AWSError>;
226 /**
227 * Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications.
228 */
229 listRobotApplications(callback?: (err: AWSError, data: RoboMaker.Types.ListRobotApplicationsResponse) => void): Request<RoboMaker.Types.ListRobotApplicationsResponse, AWSError>;
230 /**
231 * Returns a list of robots. You can optionally provide filters to retrieve specific robots.
232 */
233 listRobots(params: RoboMaker.Types.ListRobotsRequest, callback?: (err: AWSError, data: RoboMaker.Types.ListRobotsResponse) => void): Request<RoboMaker.Types.ListRobotsResponse, AWSError>;
234 /**
235 * Returns a list of robots. You can optionally provide filters to retrieve specific robots.
236 */
237 listRobots(callback?: (err: AWSError, data: RoboMaker.Types.ListRobotsResponse) => void): Request<RoboMaker.Types.ListRobotsResponse, AWSError>;
238 /**
239 * Returns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications.
240 */
241 listSimulationApplications(params: RoboMaker.Types.ListSimulationApplicationsRequest, callback?: (err: AWSError, data: RoboMaker.Types.ListSimulationApplicationsResponse) => void): Request<RoboMaker.Types.ListSimulationApplicationsResponse, AWSError>;
242 /**
243 * Returns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications.
244 */
245 listSimulationApplications(callback?: (err: AWSError, data: RoboMaker.Types.ListSimulationApplicationsResponse) => void): Request<RoboMaker.Types.ListSimulationApplicationsResponse, AWSError>;
246 /**
247 * Returns a list simulation job batches. You can optionally provide filters to retrieve specific simulation batch jobs.
248 */
249 listSimulationJobBatches(params: RoboMaker.Types.ListSimulationJobBatchesRequest, callback?: (err: AWSError, data: RoboMaker.Types.ListSimulationJobBatchesResponse) => void): Request<RoboMaker.Types.ListSimulationJobBatchesResponse, AWSError>;
250 /**
251 * Returns a list simulation job batches. You can optionally provide filters to retrieve specific simulation batch jobs.
252 */
253 listSimulationJobBatches(callback?: (err: AWSError, data: RoboMaker.Types.ListSimulationJobBatchesResponse) => void): Request<RoboMaker.Types.ListSimulationJobBatchesResponse, AWSError>;
254 /**
255 * Returns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs.
256 */
257 listSimulationJobs(params: RoboMaker.Types.ListSimulationJobsRequest, callback?: (err: AWSError, data: RoboMaker.Types.ListSimulationJobsResponse) => void): Request<RoboMaker.Types.ListSimulationJobsResponse, AWSError>;
258 /**
259 * Returns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs.
260 */
261 listSimulationJobs(callback?: (err: AWSError, data: RoboMaker.Types.ListSimulationJobsResponse) => void): Request<RoboMaker.Types.ListSimulationJobsResponse, AWSError>;
262 /**
263 * Lists all tags on a AWS RoboMaker resource.
264 */
265 listTagsForResource(params: RoboMaker.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: RoboMaker.Types.ListTagsForResourceResponse) => void): Request<RoboMaker.Types.ListTagsForResourceResponse, AWSError>;
266 /**
267 * Lists all tags on a AWS RoboMaker resource.
268 */
269 listTagsForResource(callback?: (err: AWSError, data: RoboMaker.Types.ListTagsForResourceResponse) => void): Request<RoboMaker.Types.ListTagsForResourceResponse, AWSError>;
270 /**
271 * Registers a robot with a fleet.
272 */
273 registerRobot(params: RoboMaker.Types.RegisterRobotRequest, callback?: (err: AWSError, data: RoboMaker.Types.RegisterRobotResponse) => void): Request<RoboMaker.Types.RegisterRobotResponse, AWSError>;
274 /**
275 * Registers a robot with a fleet.
276 */
277 registerRobot(callback?: (err: AWSError, data: RoboMaker.Types.RegisterRobotResponse) => void): Request<RoboMaker.Types.RegisterRobotResponse, AWSError>;
278 /**
279 * Restarts a running simulation job.
280 */
281 restartSimulationJob(params: RoboMaker.Types.RestartSimulationJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.RestartSimulationJobResponse) => void): Request<RoboMaker.Types.RestartSimulationJobResponse, AWSError>;
282 /**
283 * Restarts a running simulation job.
284 */
285 restartSimulationJob(callback?: (err: AWSError, data: RoboMaker.Types.RestartSimulationJobResponse) => void): Request<RoboMaker.Types.RestartSimulationJobResponse, AWSError>;
286 /**
287 * Starts a new simulation job batch. The batch is defined using one or more SimulationJobRequest objects.
288 */
289 startSimulationJobBatch(params: RoboMaker.Types.StartSimulationJobBatchRequest, callback?: (err: AWSError, data: RoboMaker.Types.StartSimulationJobBatchResponse) => void): Request<RoboMaker.Types.StartSimulationJobBatchResponse, AWSError>;
290 /**
291 * Starts a new simulation job batch. The batch is defined using one or more SimulationJobRequest objects.
292 */
293 startSimulationJobBatch(callback?: (err: AWSError, data: RoboMaker.Types.StartSimulationJobBatchResponse) => void): Request<RoboMaker.Types.StartSimulationJobBatchResponse, AWSError>;
294 /**
295 * Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.
296 */
297 syncDeploymentJob(params: RoboMaker.Types.SyncDeploymentJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.SyncDeploymentJobResponse) => void): Request<RoboMaker.Types.SyncDeploymentJobResponse, AWSError>;
298 /**
299 * Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.
300 */
301 syncDeploymentJob(callback?: (err: AWSError, data: RoboMaker.Types.SyncDeploymentJobResponse) => void): Request<RoboMaker.Types.SyncDeploymentJobResponse, AWSError>;
302 /**
303 * 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.
304 */
305 tagResource(params: RoboMaker.Types.TagResourceRequest, callback?: (err: AWSError, data: RoboMaker.Types.TagResourceResponse) => void): Request<RoboMaker.Types.TagResourceResponse, AWSError>;
306 /**
307 * 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.
308 */
309 tagResource(callback?: (err: AWSError, data: RoboMaker.Types.TagResourceResponse) => void): Request<RoboMaker.Types.TagResourceResponse, AWSError>;
310 /**
311 * 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 .
312 */
313 untagResource(params: RoboMaker.Types.UntagResourceRequest, callback?: (err: AWSError, data: RoboMaker.Types.UntagResourceResponse) => void): Request<RoboMaker.Types.UntagResourceResponse, AWSError>;
314 /**
315 * 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 .
316 */
317 untagResource(callback?: (err: AWSError, data: RoboMaker.Types.UntagResourceResponse) => void): Request<RoboMaker.Types.UntagResourceResponse, AWSError>;
318 /**
319 * Updates a robot application.
320 */
321 updateRobotApplication(params: RoboMaker.Types.UpdateRobotApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.UpdateRobotApplicationResponse) => void): Request<RoboMaker.Types.UpdateRobotApplicationResponse, AWSError>;
322 /**
323 * Updates a robot application.
324 */
325 updateRobotApplication(callback?: (err: AWSError, data: RoboMaker.Types.UpdateRobotApplicationResponse) => void): Request<RoboMaker.Types.UpdateRobotApplicationResponse, AWSError>;
326 /**
327 * Updates a simulation application.
328 */
329 updateSimulationApplication(params: RoboMaker.Types.UpdateSimulationApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.UpdateSimulationApplicationResponse) => void): Request<RoboMaker.Types.UpdateSimulationApplicationResponse, AWSError>;
330 /**
331 * Updates a simulation application.
332 */
333 updateSimulationApplication(callback?: (err: AWSError, data: RoboMaker.Types.UpdateSimulationApplicationResponse) => void): Request<RoboMaker.Types.UpdateSimulationApplicationResponse, AWSError>;
334}
335declare namespace RoboMaker {
336 export type Architecture = "X86_64"|"ARM64"|"ARMHF"|string;
337 export type Arn = string;
338 export type Arns = Arn[];
339 export interface BatchDescribeSimulationJobRequest {
340 /**
341 * A list of Amazon Resource Names (ARNs) of simulation jobs to describe.
342 */
343 jobs: Arns;
344 }
345 export interface BatchDescribeSimulationJobResponse {
346 /**
347 * A list of simulation jobs.
348 */
349 jobs?: SimulationJobs;
350 /**
351 * A list of unprocessed simulation job Amazon Resource Names (ARNs).
352 */
353 unprocessedJobs?: Arns;
354 }
355 export interface BatchPolicy {
356 /**
357 * 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.
358 */
359 timeoutInSeconds?: BatchTimeoutInSeconds;
360 /**
361 * 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.
362 */
363 maxConcurrency?: MaxConcurrency;
364 }
365 export type BatchTimeoutInSeconds = number;
366 export type Boolean = boolean;
367 export type BoxedBoolean = boolean;
368 export interface CancelDeploymentJobRequest {
369 /**
370 * The deployment job ARN to cancel.
371 */
372 job: Arn;
373 }
374 export interface CancelDeploymentJobResponse {
375 }
376 export interface CancelSimulationJobBatchRequest {
377 /**
378 * The id of the batch to cancel.
379 */
380 batch: Arn;
381 }
382 export interface CancelSimulationJobBatchResponse {
383 }
384 export interface CancelSimulationJobRequest {
385 /**
386 * The simulation job ARN to cancel.
387 */
388 job: Arn;
389 }
390 export interface CancelSimulationJobResponse {
391 }
392 export type ClientRequestToken = string;
393 export type Command = string;
394 export interface CreateDeploymentJobRequest {
395 /**
396 * The requested deployment configuration.
397 */
398 deploymentConfig?: DeploymentConfig;
399 /**
400 * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
401 */
402 clientRequestToken: ClientRequestToken;
403 /**
404 * The Amazon Resource Name (ARN) of the fleet to deploy.
405 */
406 fleet: Arn;
407 /**
408 * The deployment application configuration.
409 */
410 deploymentApplicationConfigs: DeploymentApplicationConfigs;
411 /**
412 * A map that contains tag keys and tag values that are attached to the deployment job.
413 */
414 tags?: TagMap;
415 }
416 export interface CreateDeploymentJobResponse {
417 /**
418 * The Amazon Resource Name (ARN) of the deployment job.
419 */
420 arn?: Arn;
421 /**
422 * The target fleet for the deployment job.
423 */
424 fleet?: Arn;
425 /**
426 * The status of the deployment job.
427 */
428 status?: DeploymentStatus;
429 /**
430 * The deployment application configuration.
431 */
432 deploymentApplicationConfigs?: DeploymentApplicationConfigs;
433 /**
434 * The failure reason of the deployment job if it failed.
435 */
436 failureReason?: GenericString;
437 /**
438 * 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.
439 */
440 failureCode?: DeploymentJobErrorCode;
441 /**
442 * The time, in milliseconds since the epoch, when the fleet was created.
443 */
444 createdAt?: CreatedAt;
445 /**
446 * The deployment configuration.
447 */
448 deploymentConfig?: DeploymentConfig;
449 /**
450 * The list of all tags added to the deployment job.
451 */
452 tags?: TagMap;
453 }
454 export interface CreateFleetRequest {
455 /**
456 * The name of the fleet.
457 */
458 name: Name;
459 /**
460 * A map that contains tag keys and tag values that are attached to the fleet.
461 */
462 tags?: TagMap;
463 }
464 export interface CreateFleetResponse {
465 /**
466 * The Amazon Resource Name (ARN) of the fleet.
467 */
468 arn?: Arn;
469 /**
470 * The name of the fleet.
471 */
472 name?: Name;
473 /**
474 * The time, in milliseconds since the epoch, when the fleet was created.
475 */
476 createdAt?: CreatedAt;
477 /**
478 * The list of all tags added to the fleet.
479 */
480 tags?: TagMap;
481 }
482 export interface CreateRobotApplicationRequest {
483 /**
484 * The name of the robot application.
485 */
486 name: Name;
487 /**
488 * The sources of the robot application.
489 */
490 sources: SourceConfigs;
491 /**
492 * The robot software suite (ROS distribuition) used by the robot application.
493 */
494 robotSoftwareSuite: RobotSoftwareSuite;
495 /**
496 * A map that contains tag keys and tag values that are attached to the robot application.
497 */
498 tags?: TagMap;
499 }
500 export interface CreateRobotApplicationResponse {
501 /**
502 * The Amazon Resource Name (ARN) of the robot application.
503 */
504 arn?: Arn;
505 /**
506 * The name of the robot application.
507 */
508 name?: Name;
509 /**
510 * The version of the robot application.
511 */
512 version?: Version;
513 /**
514 * The sources of the robot application.
515 */
516 sources?: Sources;
517 /**
518 * The robot software suite (ROS distribution) used by the robot application.
519 */
520 robotSoftwareSuite?: RobotSoftwareSuite;
521 /**
522 * The time, in milliseconds since the epoch, when the robot application was last updated.
523 */
524 lastUpdatedAt?: LastUpdatedAt;
525 /**
526 * The revision id of the robot application.
527 */
528 revisionId?: RevisionId;
529 /**
530 * The list of all tags added to the robot application.
531 */
532 tags?: TagMap;
533 }
534 export interface CreateRobotApplicationVersionRequest {
535 /**
536 * The application information for the robot application.
537 */
538 application: Arn;
539 /**
540 * 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.
541 */
542 currentRevisionId?: RevisionId;
543 }
544 export interface CreateRobotApplicationVersionResponse {
545 /**
546 * The Amazon Resource Name (ARN) of the robot application.
547 */
548 arn?: Arn;
549 /**
550 * The name of the robot application.
551 */
552 name?: Name;
553 /**
554 * The version of the robot application.
555 */
556 version?: Version;
557 /**
558 * The sources of the robot application.
559 */
560 sources?: Sources;
561 /**
562 * The robot software suite (ROS distribution) used by the robot application.
563 */
564 robotSoftwareSuite?: RobotSoftwareSuite;
565 /**
566 * The time, in milliseconds since the epoch, when the robot application was last updated.
567 */
568 lastUpdatedAt?: LastUpdatedAt;
569 /**
570 * The revision id of the robot application.
571 */
572 revisionId?: RevisionId;
573 }
574 export interface CreateRobotRequest {
575 /**
576 * The name for the robot.
577 */
578 name: Name;
579 /**
580 * The target architecture of the robot.
581 */
582 architecture: Architecture;
583 /**
584 * The Greengrass group id.
585 */
586 greengrassGroupId: Id;
587 /**
588 * A map that contains tag keys and tag values that are attached to the robot.
589 */
590 tags?: TagMap;
591 }
592 export interface CreateRobotResponse {
593 /**
594 * The Amazon Resource Name (ARN) of the robot.
595 */
596 arn?: Arn;
597 /**
598 * The name of the robot.
599 */
600 name?: Name;
601 /**
602 * The time, in milliseconds since the epoch, when the robot was created.
603 */
604 createdAt?: CreatedAt;
605 /**
606 * The Amazon Resource Name (ARN) of the Greengrass group associated with the robot.
607 */
608 greengrassGroupId?: Id;
609 /**
610 * The target architecture of the robot.
611 */
612 architecture?: Architecture;
613 /**
614 * The list of all tags added to the robot.
615 */
616 tags?: TagMap;
617 }
618 export interface CreateSimulationApplicationRequest {
619 /**
620 * The name of the simulation application.
621 */
622 name: Name;
623 /**
624 * The sources of the simulation application.
625 */
626 sources: SourceConfigs;
627 /**
628 * The simulation software suite used by the simulation application.
629 */
630 simulationSoftwareSuite: SimulationSoftwareSuite;
631 /**
632 * The robot software suite (ROS distribution) used by the simulation application.
633 */
634 robotSoftwareSuite: RobotSoftwareSuite;
635 /**
636 * The rendering engine for the simulation application.
637 */
638 renderingEngine?: RenderingEngine;
639 /**
640 * A map that contains tag keys and tag values that are attached to the simulation application.
641 */
642 tags?: TagMap;
643 }
644 export interface CreateSimulationApplicationResponse {
645 /**
646 * The Amazon Resource Name (ARN) of the simulation application.
647 */
648 arn?: Arn;
649 /**
650 * The name of the simulation application.
651 */
652 name?: Name;
653 /**
654 * The version of the simulation application.
655 */
656 version?: Version;
657 /**
658 * The sources of the simulation application.
659 */
660 sources?: Sources;
661 /**
662 * The simulation software suite used by the simulation application.
663 */
664 simulationSoftwareSuite?: SimulationSoftwareSuite;
665 /**
666 * Information about the robot software suite (ROS distribution).
667 */
668 robotSoftwareSuite?: RobotSoftwareSuite;
669 /**
670 * The rendering engine for the simulation application.
671 */
672 renderingEngine?: RenderingEngine;
673 /**
674 * The time, in milliseconds since the epoch, when the simulation application was last updated.
675 */
676 lastUpdatedAt?: LastUpdatedAt;
677 /**
678 * The revision id of the simulation application.
679 */
680 revisionId?: RevisionId;
681 /**
682 * The list of all tags added to the simulation application.
683 */
684 tags?: TagMap;
685 }
686 export interface CreateSimulationApplicationVersionRequest {
687 /**
688 * The application information for the simulation application.
689 */
690 application: Arn;
691 /**
692 * 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.
693 */
694 currentRevisionId?: RevisionId;
695 }
696 export interface CreateSimulationApplicationVersionResponse {
697 /**
698 * The Amazon Resource Name (ARN) of the simulation application.
699 */
700 arn?: Arn;
701 /**
702 * The name of the simulation application.
703 */
704 name?: Name;
705 /**
706 * The version of the simulation application.
707 */
708 version?: Version;
709 /**
710 * The sources of the simulation application.
711 */
712 sources?: Sources;
713 /**
714 * The simulation software suite used by the simulation application.
715 */
716 simulationSoftwareSuite?: SimulationSoftwareSuite;
717 /**
718 * Information about the robot software suite (ROS distribution).
719 */
720 robotSoftwareSuite?: RobotSoftwareSuite;
721 /**
722 * The rendering engine for the simulation application.
723 */
724 renderingEngine?: RenderingEngine;
725 /**
726 * The time, in milliseconds since the epoch, when the simulation application was last updated.
727 */
728 lastUpdatedAt?: LastUpdatedAt;
729 /**
730 * The revision ID of the simulation application.
731 */
732 revisionId?: RevisionId;
733 }
734 export interface CreateSimulationJobRequest {
735 /**
736 * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
737 */
738 clientRequestToken?: ClientRequestToken;
739 /**
740 * Location for output files generated by the simulation job.
741 */
742 outputLocation?: OutputLocation;
743 /**
744 * The logging configuration.
745 */
746 loggingConfig?: LoggingConfig;
747 /**
748 * 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.
749 */
750 maxJobDurationInSeconds: JobDuration;
751 /**
752 * 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.
753 */
754 iamRole: IamRole;
755 /**
756 * The failure behavior the simulation job. Continue Restart the simulation job in the same host instance. Fail Stop the simulation job and terminate the instance.
757 */
758 failureBehavior?: FailureBehavior;
759 /**
760 * The robot application to use in the simulation job.
761 */
762 robotApplications?: RobotApplicationConfigs;
763 /**
764 * The simulation application to use in the simulation job.
765 */
766 simulationApplications?: SimulationApplicationConfigs;
767 /**
768 * 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.
769 */
770 dataSources?: DataSourceConfigs;
771 /**
772 * A map that contains tag keys and tag values that are attached to the simulation job.
773 */
774 tags?: TagMap;
775 /**
776 * 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.
777 */
778 vpcConfig?: VPCConfig;
779 }
780 export type CreateSimulationJobRequests = SimulationJobRequest[];
781 export interface CreateSimulationJobResponse {
782 /**
783 * The Amazon Resource Name (ARN) of the simulation job.
784 */
785 arn?: Arn;
786 /**
787 * The status of the simulation job.
788 */
789 status?: SimulationJobStatus;
790 /**
791 * The time, in milliseconds since the epoch, when the simulation job was last started.
792 */
793 lastStartedAt?: LastStartedAt;
794 /**
795 * The time, in milliseconds since the epoch, when the simulation job was last updated.
796 */
797 lastUpdatedAt?: LastUpdatedAt;
798 /**
799 * the failure behavior for the simulation job.
800 */
801 failureBehavior?: FailureBehavior;
802 /**
803 * 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.
804 */
805 failureCode?: SimulationJobErrorCode;
806 /**
807 * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
808 */
809 clientRequestToken?: ClientRequestToken;
810 /**
811 * Simulation job output files location.
812 */
813 outputLocation?: OutputLocation;
814 /**
815 * The logging configuration.
816 */
817 loggingConfig?: LoggingConfig;
818 /**
819 * The maximum simulation job duration in seconds.
820 */
821 maxJobDurationInSeconds?: JobDuration;
822 /**
823 * The simulation job execution duration in milliseconds.
824 */
825 simulationTimeMillis?: SimulationTimeMillis;
826 /**
827 * The IAM role that allows the simulation job to call the AWS APIs that are specified in its associated policies on your behalf.
828 */
829 iamRole?: IamRole;
830 /**
831 * The robot application used by the simulation job.
832 */
833 robotApplications?: RobotApplicationConfigs;
834 /**
835 * The simulation application used by the simulation job.
836 */
837 simulationApplications?: SimulationApplicationConfigs;
838 /**
839 * The data sources for the simulation job.
840 */
841 dataSources?: DataSources;
842 /**
843 * The list of all tags added to the simulation job.
844 */
845 tags?: TagMap;
846 /**
847 * Information about the vpc configuration.
848 */
849 vpcConfig?: VPCConfigResponse;
850 }
851 export type CreatedAt = Date;
852 export interface DataSource {
853 /**
854 * The name of the data source.
855 */
856 name?: Name;
857 /**
858 * The S3 bucket where the data files are located.
859 */
860 s3Bucket?: S3Bucket;
861 /**
862 * The list of S3 keys identifying the data source files.
863 */
864 s3Keys?: S3KeyOutputs;
865 }
866 export interface DataSourceConfig {
867 /**
868 * The name of the data source.
869 */
870 name: Name;
871 /**
872 * The S3 bucket where the data files are located.
873 */
874 s3Bucket: S3Bucket;
875 /**
876 * The list of S3 keys identifying the data source files.
877 */
878 s3Keys: S3Keys;
879 }
880 export type DataSourceConfigs = DataSourceConfig[];
881 export type DataSourceNames = Name[];
882 export type DataSources = DataSource[];
883 export interface DeleteFleetRequest {
884 /**
885 * The Amazon Resource Name (ARN) of the fleet.
886 */
887 fleet: Arn;
888 }
889 export interface DeleteFleetResponse {
890 }
891 export interface DeleteRobotApplicationRequest {
892 /**
893 * The Amazon Resource Name (ARN) of the the robot application.
894 */
895 application: Arn;
896 /**
897 * The version of the robot application to delete.
898 */
899 applicationVersion?: Version;
900 }
901 export interface DeleteRobotApplicationResponse {
902 }
903 export interface DeleteRobotRequest {
904 /**
905 * The Amazon Resource Name (ARN) of the robot.
906 */
907 robot: Arn;
908 }
909 export interface DeleteRobotResponse {
910 }
911 export interface DeleteSimulationApplicationRequest {
912 /**
913 * The application information for the simulation application to delete.
914 */
915 application: Arn;
916 /**
917 * The version of the simulation application to delete.
918 */
919 applicationVersion?: Version;
920 }
921 export interface DeleteSimulationApplicationResponse {
922 }
923 export interface DeploymentApplicationConfig {
924 /**
925 * The Amazon Resource Name (ARN) of the robot application.
926 */
927 application: Arn;
928 /**
929 * The version of the application.
930 */
931 applicationVersion: DeploymentVersion;
932 /**
933 * The launch configuration.
934 */
935 launchConfig: DeploymentLaunchConfig;
936 }
937 export type DeploymentApplicationConfigs = DeploymentApplicationConfig[];
938 export interface DeploymentConfig {
939 /**
940 * The percentage of robots receiving the deployment at the same time.
941 */
942 concurrentDeploymentPercentage?: Percentage;
943 /**
944 * The percentage of deployments that need to fail before stopping deployment.
945 */
946 failureThresholdPercentage?: Percentage;
947 /**
948 * 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.
949 */
950 robotDeploymentTimeoutInSeconds?: DeploymentTimeout;
951 /**
952 * The download condition file.
953 */
954 downloadConditionFile?: S3Object;
955 }
956 export interface DeploymentJob {
957 /**
958 * The Amazon Resource Name (ARN) of the deployment job.
959 */
960 arn?: Arn;
961 /**
962 * The Amazon Resource Name (ARN) of the fleet.
963 */
964 fleet?: Arn;
965 /**
966 * The status of the deployment job.
967 */
968 status?: DeploymentStatus;
969 /**
970 * The deployment application configuration.
971 */
972 deploymentApplicationConfigs?: DeploymentApplicationConfigs;
973 /**
974 * The deployment configuration.
975 */
976 deploymentConfig?: DeploymentConfig;
977 /**
978 * A short description of the reason why the deployment job failed.
979 */
980 failureReason?: GenericString;
981 /**
982 * The deployment job failure code.
983 */
984 failureCode?: DeploymentJobErrorCode;
985 /**
986 * The time, in milliseconds since the epoch, when the deployment job was created.
987 */
988 createdAt?: CreatedAt;
989 }
990 export type DeploymentJobErrorCode = "ResourceNotFound"|"EnvironmentSetupError"|"EtagMismatch"|"FailureThresholdBreached"|"RobotDeploymentAborted"|"RobotDeploymentNoResponse"|"RobotAgentConnectionTimeout"|"GreengrassDeploymentFailed"|"InvalidGreengrassGroup"|"MissingRobotArchitecture"|"MissingRobotApplicationArchitecture"|"MissingRobotDeploymentResource"|"GreengrassGroupVersionDoesNotExist"|"LambdaDeleted"|"ExtractingBundleFailure"|"PreLaunchFileFailure"|"PostLaunchFileFailure"|"BadPermissionError"|"DownloadConditionFailed"|"InternalServerError"|string;
991 export type DeploymentJobs = DeploymentJob[];
992 export interface DeploymentLaunchConfig {
993 /**
994 * The package name.
995 */
996 packageName: Command;
997 /**
998 * The deployment pre-launch file. This file will be executed prior to the launch file.
999 */
1000 preLaunchFile?: Path;
1001 /**
1002 * The launch file name.
1003 */
1004 launchFile: Command;
1005 /**
1006 * The deployment post-launch file. This file will be executed after the launch file.
1007 */
1008 postLaunchFile?: Path;
1009 /**
1010 * An array of key/value pairs specifying environment variables for the robot application
1011 */
1012 environmentVariables?: EnvironmentVariableMap;
1013 }
1014 export type DeploymentStatus = "Pending"|"Preparing"|"InProgress"|"Failed"|"Succeeded"|"Canceled"|string;
1015 export type DeploymentTimeout = number;
1016 export type DeploymentVersion = string;
1017 export interface DeregisterRobotRequest {
1018 /**
1019 * The Amazon Resource Name (ARN) of the fleet.
1020 */
1021 fleet: Arn;
1022 /**
1023 * The Amazon Resource Name (ARN) of the robot.
1024 */
1025 robot: Arn;
1026 }
1027 export interface DeregisterRobotResponse {
1028 /**
1029 * The Amazon Resource Name (ARN) of the fleet.
1030 */
1031 fleet?: Arn;
1032 /**
1033 * The Amazon Resource Name (ARN) of the robot.
1034 */
1035 robot?: Arn;
1036 }
1037 export interface DescribeDeploymentJobRequest {
1038 /**
1039 * The Amazon Resource Name (ARN) of the deployment job.
1040 */
1041 job: Arn;
1042 }
1043 export interface DescribeDeploymentJobResponse {
1044 /**
1045 * The Amazon Resource Name (ARN) of the deployment job.
1046 */
1047 arn?: Arn;
1048 /**
1049 * The Amazon Resource Name (ARN) of the fleet.
1050 */
1051 fleet?: Arn;
1052 /**
1053 * The status of the deployment job.
1054 */
1055 status?: DeploymentStatus;
1056 /**
1057 * The deployment configuration.
1058 */
1059 deploymentConfig?: DeploymentConfig;
1060 /**
1061 * The deployment application configuration.
1062 */
1063 deploymentApplicationConfigs?: DeploymentApplicationConfigs;
1064 /**
1065 * A short description of the reason why the deployment job failed.
1066 */
1067 failureReason?: GenericString;
1068 /**
1069 * The deployment job failure code.
1070 */
1071 failureCode?: DeploymentJobErrorCode;
1072 /**
1073 * The time, in milliseconds since the epoch, when the deployment job was created.
1074 */
1075 createdAt?: CreatedAt;
1076 /**
1077 * A list of robot deployment summaries.
1078 */
1079 robotDeploymentSummary?: RobotDeploymentSummary;
1080 /**
1081 * The list of all tags added to the specified deployment job.
1082 */
1083 tags?: TagMap;
1084 }
1085 export interface DescribeFleetRequest {
1086 /**
1087 * The Amazon Resource Name (ARN) of the fleet.
1088 */
1089 fleet: Arn;
1090 }
1091 export interface DescribeFleetResponse {
1092 /**
1093 * The name of the fleet.
1094 */
1095 name?: Name;
1096 /**
1097 * The Amazon Resource Name (ARN) of the fleet.
1098 */
1099 arn?: Arn;
1100 /**
1101 * A list of robots.
1102 */
1103 robots?: Robots;
1104 /**
1105 * The time, in milliseconds since the epoch, when the fleet was created.
1106 */
1107 createdAt?: CreatedAt;
1108 /**
1109 * The status of the last deployment.
1110 */
1111 lastDeploymentStatus?: DeploymentStatus;
1112 /**
1113 * The Amazon Resource Name (ARN) of the last deployment job.
1114 */
1115 lastDeploymentJob?: Arn;
1116 /**
1117 * The time of the last deployment.
1118 */
1119 lastDeploymentTime?: CreatedAt;
1120 /**
1121 * The list of all tags added to the specified fleet.
1122 */
1123 tags?: TagMap;
1124 }
1125 export interface DescribeRobotApplicationRequest {
1126 /**
1127 * The Amazon Resource Name (ARN) of the robot application.
1128 */
1129 application: Arn;
1130 /**
1131 * The version of the robot application to describe.
1132 */
1133 applicationVersion?: Version;
1134 }
1135 export interface DescribeRobotApplicationResponse {
1136 /**
1137 * The Amazon Resource Name (ARN) of the robot application.
1138 */
1139 arn?: Arn;
1140 /**
1141 * The name of the robot application.
1142 */
1143 name?: Name;
1144 /**
1145 * The version of the robot application.
1146 */
1147 version?: Version;
1148 /**
1149 * The sources of the robot application.
1150 */
1151 sources?: Sources;
1152 /**
1153 * The robot software suite (ROS distribution) used by the robot application.
1154 */
1155 robotSoftwareSuite?: RobotSoftwareSuite;
1156 /**
1157 * The revision id of the robot application.
1158 */
1159 revisionId?: RevisionId;
1160 /**
1161 * The time, in milliseconds since the epoch, when the robot application was last updated.
1162 */
1163 lastUpdatedAt?: LastUpdatedAt;
1164 /**
1165 * The list of all tags added to the specified robot application.
1166 */
1167 tags?: TagMap;
1168 }
1169 export interface DescribeRobotRequest {
1170 /**
1171 * The Amazon Resource Name (ARN) of the robot to be described.
1172 */
1173 robot: Arn;
1174 }
1175 export interface DescribeRobotResponse {
1176 /**
1177 * The Amazon Resource Name (ARN) of the robot.
1178 */
1179 arn?: Arn;
1180 /**
1181 * The name of the robot.
1182 */
1183 name?: Name;
1184 /**
1185 * The Amazon Resource Name (ARN) of the fleet.
1186 */
1187 fleetArn?: Arn;
1188 /**
1189 * The status of the fleet.
1190 */
1191 status?: RobotStatus;
1192 /**
1193 * The Greengrass group id.
1194 */
1195 greengrassGroupId?: Id;
1196 /**
1197 * The time, in milliseconds since the epoch, when the robot was created.
1198 */
1199 createdAt?: CreatedAt;
1200 /**
1201 * The target architecture of the robot application.
1202 */
1203 architecture?: Architecture;
1204 /**
1205 * The Amazon Resource Name (ARN) of the last deployment job.
1206 */
1207 lastDeploymentJob?: Arn;
1208 /**
1209 * The time of the last deployment job.
1210 */
1211 lastDeploymentTime?: CreatedAt;
1212 /**
1213 * The list of all tags added to the specified robot.
1214 */
1215 tags?: TagMap;
1216 }
1217 export interface DescribeSimulationApplicationRequest {
1218 /**
1219 * The application information for the simulation application.
1220 */
1221 application: Arn;
1222 /**
1223 * The version of the simulation application to describe.
1224 */
1225 applicationVersion?: Version;
1226 }
1227 export interface DescribeSimulationApplicationResponse {
1228 /**
1229 * The Amazon Resource Name (ARN) of the robot simulation application.
1230 */
1231 arn?: Arn;
1232 /**
1233 * The name of the simulation application.
1234 */
1235 name?: Name;
1236 /**
1237 * The version of the simulation application.
1238 */
1239 version?: Version;
1240 /**
1241 * The sources of the simulation application.
1242 */
1243 sources?: Sources;
1244 /**
1245 * The simulation software suite used by the simulation application.
1246 */
1247 simulationSoftwareSuite?: SimulationSoftwareSuite;
1248 /**
1249 * Information about the robot software suite (ROS distribution).
1250 */
1251 robotSoftwareSuite?: RobotSoftwareSuite;
1252 /**
1253 * The rendering engine for the simulation application.
1254 */
1255 renderingEngine?: RenderingEngine;
1256 /**
1257 * The revision id of the simulation application.
1258 */
1259 revisionId?: RevisionId;
1260 /**
1261 * The time, in milliseconds since the epoch, when the simulation application was last updated.
1262 */
1263 lastUpdatedAt?: LastUpdatedAt;
1264 /**
1265 * The list of all tags added to the specified simulation application.
1266 */
1267 tags?: TagMap;
1268 }
1269 export interface DescribeSimulationJobBatchRequest {
1270 /**
1271 * The id of the batch to describe.
1272 */
1273 batch: Arn;
1274 }
1275 export interface DescribeSimulationJobBatchResponse {
1276 /**
1277 * The Amazon Resource Name (ARN) of the batch.
1278 */
1279 arn?: Arn;
1280 /**
1281 * 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.
1282 */
1283 status?: SimulationJobBatchStatus;
1284 /**
1285 * The time, in milliseconds since the epoch, when the simulation job batch was last updated.
1286 */
1287 lastUpdatedAt?: LastUpdatedAt;
1288 /**
1289 * The time, in milliseconds since the epoch, when the simulation job batch was created.
1290 */
1291 createdAt?: CreatedAt;
1292 /**
1293 * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
1294 */
1295 clientRequestToken?: ClientRequestToken;
1296 /**
1297 * The batch policy.
1298 */
1299 batchPolicy?: BatchPolicy;
1300 /**
1301 * The failure code of the simulation job batch.
1302 */
1303 failureCode?: SimulationJobBatchErrorCode;
1304 /**
1305 * The reason the simulation job batch failed.
1306 */
1307 failureReason?: GenericString;
1308 /**
1309 * 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.
1310 */
1311 failedRequests?: FailedCreateSimulationJobRequests;
1312 /**
1313 * A list of pending simulation job requests. These requests have not yet been created into simulation jobs.
1314 */
1315 pendingRequests?: CreateSimulationJobRequests;
1316 /**
1317 * A list of created simulation job summaries.
1318 */
1319 createdRequests?: SimulationJobSummaries;
1320 /**
1321 * A map that contains tag keys and tag values that are attached to the simulation job batch.
1322 */
1323 tags?: TagMap;
1324 }
1325 export interface DescribeSimulationJobRequest {
1326 /**
1327 * The Amazon Resource Name (ARN) of the simulation job to be described.
1328 */
1329 job: Arn;
1330 }
1331 export interface DescribeSimulationJobResponse {
1332 /**
1333 * The Amazon Resource Name (ARN) of the simulation job.
1334 */
1335 arn?: Arn;
1336 /**
1337 * The name of the simulation job.
1338 */
1339 name?: Name;
1340 /**
1341 * The status of the simulation job.
1342 */
1343 status?: SimulationJobStatus;
1344 /**
1345 * The time, in milliseconds since the epoch, when the simulation job was last started.
1346 */
1347 lastStartedAt?: LastStartedAt;
1348 /**
1349 * The time, in milliseconds since the epoch, when the simulation job was last updated.
1350 */
1351 lastUpdatedAt?: LastUpdatedAt;
1352 /**
1353 * The failure behavior for the simulation job.
1354 */
1355 failureBehavior?: FailureBehavior;
1356 /**
1357 * 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.
1358 */
1359 failureCode?: SimulationJobErrorCode;
1360 /**
1361 * Details about why the simulation job failed. For more information about troubleshooting, see Troubleshooting.
1362 */
1363 failureReason?: GenericString;
1364 /**
1365 * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
1366 */
1367 clientRequestToken?: ClientRequestToken;
1368 /**
1369 * Location for output files generated by the simulation job.
1370 */
1371 outputLocation?: OutputLocation;
1372 /**
1373 * The logging configuration.
1374 */
1375 loggingConfig?: LoggingConfig;
1376 /**
1377 * The maximum job duration in seconds. The value must be 8 days (691,200 seconds) or less.
1378 */
1379 maxJobDurationInSeconds?: JobDuration;
1380 /**
1381 * The simulation job execution duration in milliseconds.
1382 */
1383 simulationTimeMillis?: SimulationTimeMillis;
1384 /**
1385 * The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf.
1386 */
1387 iamRole?: IamRole;
1388 /**
1389 * A list of robot applications.
1390 */
1391 robotApplications?: RobotApplicationConfigs;
1392 /**
1393 * A list of simulation applications.
1394 */
1395 simulationApplications?: SimulationApplicationConfigs;
1396 /**
1397 * The data sources for the simulation job.
1398 */
1399 dataSources?: DataSources;
1400 /**
1401 * The list of all tags added to the specified simulation job.
1402 */
1403 tags?: TagMap;
1404 /**
1405 * The VPC configuration.
1406 */
1407 vpcConfig?: VPCConfigResponse;
1408 /**
1409 * The network interface information for the simulation job.
1410 */
1411 networkInterface?: NetworkInterface;
1412 }
1413 export type EnvironmentVariableKey = string;
1414 export type EnvironmentVariableMap = {[key: string]: EnvironmentVariableValue};
1415 export type EnvironmentVariableValue = string;
1416 export type FailedAt = Date;
1417 export interface FailedCreateSimulationJobRequest {
1418 /**
1419 * The simulation job request.
1420 */
1421 request?: SimulationJobRequest;
1422 /**
1423 * The failure reason of the simulation job request.
1424 */
1425 failureReason?: GenericString;
1426 /**
1427 * The failure code.
1428 */
1429 failureCode?: SimulationJobErrorCode;
1430 /**
1431 * The time, in milliseconds since the epoch, when the simulation job batch failed.
1432 */
1433 failedAt?: FailedAt;
1434 }
1435 export type FailedCreateSimulationJobRequests = FailedCreateSimulationJobRequest[];
1436 export type FailureBehavior = "Fail"|"Continue"|string;
1437 export interface Filter {
1438 /**
1439 * The name of the filter.
1440 */
1441 name?: Name;
1442 /**
1443 * A list of values.
1444 */
1445 values?: FilterValues;
1446 }
1447 export type FilterValues = Name[];
1448 export type Filters = Filter[];
1449 export interface Fleet {
1450 /**
1451 * The name of the fleet.
1452 */
1453 name?: Name;
1454 /**
1455 * The Amazon Resource Name (ARN) of the fleet.
1456 */
1457 arn?: Arn;
1458 /**
1459 * The time, in milliseconds since the epoch, when the fleet was created.
1460 */
1461 createdAt?: CreatedAt;
1462 /**
1463 * The status of the last fleet deployment.
1464 */
1465 lastDeploymentStatus?: DeploymentStatus;
1466 /**
1467 * The Amazon Resource Name (ARN) of the last deployment job.
1468 */
1469 lastDeploymentJob?: Arn;
1470 /**
1471 * The time of the last deployment.
1472 */
1473 lastDeploymentTime?: CreatedAt;
1474 }
1475 export type Fleets = Fleet[];
1476 export type GenericInteger = number;
1477 export type GenericString = string;
1478 export type IamRole = string;
1479 export type Id = string;
1480 export type Integer = number;
1481 export type JobDuration = number;
1482 export type LastStartedAt = Date;
1483 export type LastUpdatedAt = Date;
1484 export interface LaunchConfig {
1485 /**
1486 * The package name.
1487 */
1488 packageName: Command;
1489 /**
1490 * The launch file name.
1491 */
1492 launchFile: Command;
1493 /**
1494 * The environment variables for the application launch.
1495 */
1496 environmentVariables?: EnvironmentVariableMap;
1497 /**
1498 * The port forwarding configuration.
1499 */
1500 portForwardingConfig?: PortForwardingConfig;
1501 /**
1502 * 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 luanch the component. It must have a graphical user interface.
1503 */
1504 streamUI?: Boolean;
1505 }
1506 export interface ListDeploymentJobsRequest {
1507 /**
1508 * 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.
1509 */
1510 filters?: Filters;
1511 /**
1512 * The nextToken value returned from a previous paginated ListDeploymentJobs request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
1513 */
1514 nextToken?: PaginationToken;
1515 /**
1516 * 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.
1517 */
1518 maxResults?: MaxResults;
1519 }
1520 export interface ListDeploymentJobsResponse {
1521 /**
1522 * A list of deployment jobs that meet the criteria of the request.
1523 */
1524 deploymentJobs?: DeploymentJobs;
1525 /**
1526 * The nextToken value to include in a future ListDeploymentJobs request. When the results of a ListDeploymentJobs request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
1527 */
1528 nextToken?: PaginationToken;
1529 }
1530 export interface ListFleetsRequest {
1531 /**
1532 * The nextToken value returned from a previous paginated ListFleets request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. 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.
1533 */
1534 nextToken?: PaginationToken;
1535 /**
1536 * 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.
1537 */
1538 maxResults?: MaxResults;
1539 /**
1540 * 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.
1541 */
1542 filters?: Filters;
1543 }
1544 export interface ListFleetsResponse {
1545 /**
1546 * A list of fleet details meeting the request criteria.
1547 */
1548 fleetDetails?: Fleets;
1549 /**
1550 * The nextToken value to include in a future ListDeploymentJobs request. When the results of a ListFleets request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
1551 */
1552 nextToken?: PaginationToken;
1553 }
1554 export interface ListRobotApplicationsRequest {
1555 /**
1556 * The version qualifier of the robot application.
1557 */
1558 versionQualifier?: VersionQualifier;
1559 /**
1560 * The nextToken value returned from a previous paginated ListRobotApplications request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
1561 */
1562 nextToken?: PaginationToken;
1563 /**
1564 * 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.
1565 */
1566 maxResults?: MaxResults;
1567 /**
1568 * 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.
1569 */
1570 filters?: Filters;
1571 }
1572 export interface ListRobotApplicationsResponse {
1573 /**
1574 * A list of robot application summaries that meet the criteria of the request.
1575 */
1576 robotApplicationSummaries?: RobotApplicationSummaries;
1577 /**
1578 * The nextToken value to include in a future ListRobotApplications request. When the results of a ListRobotApplications request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
1579 */
1580 nextToken?: PaginationToken;
1581 }
1582 export interface ListRobotsRequest {
1583 /**
1584 * The nextToken value returned from a previous paginated ListRobots request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
1585 */
1586 nextToken?: PaginationToken;
1587 /**
1588 * 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.
1589 */
1590 maxResults?: MaxResults;
1591 /**
1592 * 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.
1593 */
1594 filters?: Filters;
1595 }
1596 export interface ListRobotsResponse {
1597 /**
1598 * A list of robots that meet the criteria of the request.
1599 */
1600 robots?: Robots;
1601 /**
1602 * The nextToken value to include in a future ListRobots request. When the results of a ListRobot request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
1603 */
1604 nextToken?: PaginationToken;
1605 }
1606 export interface ListSimulationApplicationsRequest {
1607 /**
1608 * The version qualifier of the simulation application.
1609 */
1610 versionQualifier?: VersionQualifier;
1611 /**
1612 * The nextToken value returned from a previous paginated ListSimulationApplications request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
1613 */
1614 nextToken?: PaginationToken;
1615 /**
1616 * 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.
1617 */
1618 maxResults?: MaxResults;
1619 /**
1620 * 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.
1621 */
1622 filters?: Filters;
1623 }
1624 export interface ListSimulationApplicationsResponse {
1625 /**
1626 * A list of simulation application summaries that meet the criteria of the request.
1627 */
1628 simulationApplicationSummaries?: SimulationApplicationSummaries;
1629 /**
1630 * The nextToken value to include in a future ListSimulationApplications request. When the results of a ListRobot request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
1631 */
1632 nextToken?: PaginationToken;
1633 }
1634 export interface ListSimulationJobBatchesRequest {
1635 /**
1636 * The nextToken value returned from a previous paginated ListSimulationJobBatches request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
1637 */
1638 nextToken?: PaginationToken;
1639 /**
1640 * 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.
1641 */
1642 maxResults?: MaxResults;
1643 /**
1644 * Optional filters to limit results.
1645 */
1646 filters?: Filters;
1647 }
1648 export interface ListSimulationJobBatchesResponse {
1649 /**
1650 * A list of simulation job batch summaries.
1651 */
1652 simulationJobBatchSummaries?: SimulationJobBatchSummaries;
1653 /**
1654 * The nextToken value to include in a future ListSimulationJobBatches request. When the results of a ListSimulationJobBatches request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
1655 */
1656 nextToken?: PaginationToken;
1657 }
1658 export interface ListSimulationJobsRequest {
1659 /**
1660 * The nextToken value returned from a previous paginated ListSimulationJobs request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. 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.
1661 */
1662 nextToken?: PaginationToken;
1663 /**
1664 * 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.
1665 */
1666 maxResults?: MaxResults;
1667 /**
1668 * 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.
1669 */
1670 filters?: Filters;
1671 }
1672 export interface ListSimulationJobsResponse {
1673 /**
1674 * A list of simulation job summaries that meet the criteria of the request.
1675 */
1676 simulationJobSummaries: SimulationJobSummaries;
1677 /**
1678 * The nextToken value to include in a future ListSimulationJobs request. When the results of a ListRobot request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
1679 */
1680 nextToken?: PaginationToken;
1681 }
1682 export interface ListTagsForResourceRequest {
1683 /**
1684 * The AWS RoboMaker Amazon Resource Name (ARN) with tags to be listed.
1685 */
1686 resourceArn: Arn;
1687 }
1688 export interface ListTagsForResourceResponse {
1689 /**
1690 * The list of all tags added to the specified resource.
1691 */
1692 tags?: TagMap;
1693 }
1694 export interface LoggingConfig {
1695 /**
1696 * A boolean indicating whether to record all ROS topics.
1697 */
1698 recordAllRosTopics: BoxedBoolean;
1699 }
1700 export type MaxConcurrency = number;
1701 export type MaxResults = number;
1702 export type Name = string;
1703 export interface NetworkInterface {
1704 /**
1705 * The ID of the network interface.
1706 */
1707 networkInterfaceId?: GenericString;
1708 /**
1709 * The IPv4 address of the network interface within the subnet.
1710 */
1711 privateIpAddress?: GenericString;
1712 /**
1713 * The IPv4 public address of the network interface.
1714 */
1715 publicIpAddress?: GenericString;
1716 }
1717 export type NonEmptyString = string;
1718 export type NonSystemPort = number;
1719 export interface OutputLocation {
1720 /**
1721 * The S3 bucket for output.
1722 */
1723 s3Bucket?: S3Bucket;
1724 /**
1725 * The S3 folder in the s3Bucket where output files will be placed.
1726 */
1727 s3Prefix?: S3Key;
1728 }
1729 export type PaginationToken = string;
1730 export type Path = string;
1731 export type PercentDone = number;
1732 export type Percentage = number;
1733 export type Port = number;
1734 export interface PortForwardingConfig {
1735 /**
1736 * The port mappings for the configuration.
1737 */
1738 portMappings?: PortMappingList;
1739 }
1740 export interface PortMapping {
1741 /**
1742 * The port number on the simulation job instance to use as a remote connection point.
1743 */
1744 jobPort: Port;
1745 /**
1746 * The port number on the application.
1747 */
1748 applicationPort: NonSystemPort;
1749 /**
1750 * A Boolean indicating whether to enable this port mapping on public IP.
1751 */
1752 enableOnPublicIp?: Boolean;
1753 }
1754 export type PortMappingList = PortMapping[];
1755 export interface ProgressDetail {
1756 /**
1757 * 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.
1758 */
1759 currentProgress?: RobotDeploymentStep;
1760 /**
1761 * 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.
1762 */
1763 percentDone?: PercentDone;
1764 /**
1765 * 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.
1766 */
1767 estimatedTimeRemainingSeconds?: GenericInteger;
1768 /**
1769 * The Amazon Resource Name (ARN) of the deployment job.
1770 */
1771 targetResource?: GenericString;
1772 }
1773 export interface RegisterRobotRequest {
1774 /**
1775 * The Amazon Resource Name (ARN) of the fleet.
1776 */
1777 fleet: Arn;
1778 /**
1779 * The Amazon Resource Name (ARN) of the robot.
1780 */
1781 robot: Arn;
1782 }
1783 export interface RegisterRobotResponse {
1784 /**
1785 * The Amazon Resource Name (ARN) of the fleet that the robot will join.
1786 */
1787 fleet?: Arn;
1788 /**
1789 * Information about the robot registration.
1790 */
1791 robot?: Arn;
1792 }
1793 export interface RenderingEngine {
1794 /**
1795 * The name of the rendering engine.
1796 */
1797 name?: RenderingEngineType;
1798 /**
1799 * The version of the rendering engine.
1800 */
1801 version?: RenderingEngineVersionType;
1802 }
1803 export type RenderingEngineType = "OGRE"|string;
1804 export type RenderingEngineVersionType = string;
1805 export interface RestartSimulationJobRequest {
1806 /**
1807 * The Amazon Resource Name (ARN) of the simulation job.
1808 */
1809 job: Arn;
1810 }
1811 export interface RestartSimulationJobResponse {
1812 }
1813 export type RevisionId = string;
1814 export interface Robot {
1815 /**
1816 * The Amazon Resource Name (ARN) of the robot.
1817 */
1818 arn?: Arn;
1819 /**
1820 * The name of the robot.
1821 */
1822 name?: Name;
1823 /**
1824 * The Amazon Resource Name (ARN) of the fleet.
1825 */
1826 fleetArn?: Arn;
1827 /**
1828 * The status of the robot.
1829 */
1830 status?: RobotStatus;
1831 /**
1832 * The Greengrass group associated with the robot.
1833 */
1834 greenGrassGroupId?: Id;
1835 /**
1836 * The time, in milliseconds since the epoch, when the robot was created.
1837 */
1838 createdAt?: CreatedAt;
1839 /**
1840 * The architecture of the robot.
1841 */
1842 architecture?: Architecture;
1843 /**
1844 * The Amazon Resource Name (ARN) of the last deployment job.
1845 */
1846 lastDeploymentJob?: Arn;
1847 /**
1848 * The time of the last deployment.
1849 */
1850 lastDeploymentTime?: CreatedAt;
1851 }
1852 export interface RobotApplicationConfig {
1853 /**
1854 * The application information for the robot application.
1855 */
1856 application: Arn;
1857 /**
1858 * The version of the robot application.
1859 */
1860 applicationVersion?: Version;
1861 /**
1862 * The launch configuration for the robot application.
1863 */
1864 launchConfig: LaunchConfig;
1865 }
1866 export type RobotApplicationConfigs = RobotApplicationConfig[];
1867 export type RobotApplicationNames = Name[];
1868 export type RobotApplicationSummaries = RobotApplicationSummary[];
1869 export interface RobotApplicationSummary {
1870 /**
1871 * The name of the robot application.
1872 */
1873 name?: Name;
1874 /**
1875 * The Amazon Resource Name (ARN) of the robot.
1876 */
1877 arn?: Arn;
1878 /**
1879 * The version of the robot application.
1880 */
1881 version?: Version;
1882 /**
1883 * The time, in milliseconds since the epoch, when the robot application was last updated.
1884 */
1885 lastUpdatedAt?: LastUpdatedAt;
1886 /**
1887 * Information about a robot software suite (ROS distribution).
1888 */
1889 robotSoftwareSuite?: RobotSoftwareSuite;
1890 }
1891 export interface RobotDeployment {
1892 /**
1893 * The robot deployment Amazon Resource Name (ARN).
1894 */
1895 arn?: Arn;
1896 /**
1897 * The time, in milliseconds since the epoch, when the deployment was started.
1898 */
1899 deploymentStartTime?: CreatedAt;
1900 /**
1901 * The time, in milliseconds since the epoch, when the deployment finished.
1902 */
1903 deploymentFinishTime?: CreatedAt;
1904 /**
1905 * The status of the robot deployment.
1906 */
1907 status?: RobotStatus;
1908 /**
1909 * Information about how the deployment is progressing.
1910 */
1911 progressDetail?: ProgressDetail;
1912 /**
1913 * A short description of the reason why the robot deployment failed.
1914 */
1915 failureReason?: GenericString;
1916 /**
1917 * The robot deployment failure code.
1918 */
1919 failureCode?: DeploymentJobErrorCode;
1920 }
1921 export type RobotDeploymentStep = "Validating"|"DownloadingExtracting"|"ExecutingDownloadCondition"|"ExecutingPreLaunch"|"Launching"|"ExecutingPostLaunch"|"Finished"|string;
1922 export type RobotDeploymentSummary = RobotDeployment[];
1923 export interface RobotSoftwareSuite {
1924 /**
1925 * The name of the robot software suite (ROS distribution).
1926 */
1927 name?: RobotSoftwareSuiteType;
1928 /**
1929 * The version of the robot software suite (ROS distribution).
1930 */
1931 version?: RobotSoftwareSuiteVersionType;
1932 }
1933 export type RobotSoftwareSuiteType = "ROS"|"ROS2"|string;
1934 export type RobotSoftwareSuiteVersionType = "Kinetic"|"Melodic"|"Dashing"|string;
1935 export type RobotStatus = "Available"|"Registered"|"PendingNewDeployment"|"Deploying"|"Failed"|"InSync"|"NoResponse"|string;
1936 export type Robots = Robot[];
1937 export type S3Bucket = string;
1938 export type S3Etag = string;
1939 export type S3Key = string;
1940 export interface S3KeyOutput {
1941 /**
1942 * The S3 key.
1943 */
1944 s3Key?: S3Key;
1945 /**
1946 * The etag for the object.
1947 */
1948 etag?: S3Etag;
1949 }
1950 export type S3KeyOutputs = S3KeyOutput[];
1951 export type S3Keys = S3Key[];
1952 export interface S3Object {
1953 /**
1954 * The bucket containing the object.
1955 */
1956 bucket: S3Bucket;
1957 /**
1958 * The key of the object.
1959 */
1960 key: S3Key;
1961 /**
1962 * The etag of the object.
1963 */
1964 etag?: S3Etag;
1965 }
1966 export type SecurityGroups = NonEmptyString[];
1967 export interface SimulationApplicationConfig {
1968 /**
1969 * The application information for the simulation application.
1970 */
1971 application: Arn;
1972 /**
1973 * The version of the simulation application.
1974 */
1975 applicationVersion?: Version;
1976 /**
1977 * The launch configuration for the simulation application.
1978 */
1979 launchConfig: LaunchConfig;
1980 }
1981 export type SimulationApplicationConfigs = SimulationApplicationConfig[];
1982 export type SimulationApplicationNames = Name[];
1983 export type SimulationApplicationSummaries = SimulationApplicationSummary[];
1984 export interface SimulationApplicationSummary {
1985 /**
1986 * The name of the simulation application.
1987 */
1988 name?: Name;
1989 /**
1990 * The Amazon Resource Name (ARN) of the simulation application.
1991 */
1992 arn?: Arn;
1993 /**
1994 * The version of the simulation application.
1995 */
1996 version?: Version;
1997 /**
1998 * The time, in milliseconds since the epoch, when the simulation application was last updated.
1999 */
2000 lastUpdatedAt?: LastUpdatedAt;
2001 /**
2002 * Information about a robot software suite (ROS distribution).
2003 */
2004 robotSoftwareSuite?: RobotSoftwareSuite;
2005 /**
2006 * Information about a simulation software suite.
2007 */
2008 simulationSoftwareSuite?: SimulationSoftwareSuite;
2009 }
2010 export interface SimulationJob {
2011 /**
2012 * The Amazon Resource Name (ARN) of the simulation job.
2013 */
2014 arn?: Arn;
2015 /**
2016 * The name of the simulation job.
2017 */
2018 name?: Name;
2019 /**
2020 * Status of the simulation job.
2021 */
2022 status?: SimulationJobStatus;
2023 /**
2024 * The time, in milliseconds since the epoch, when the simulation job was last started.
2025 */
2026 lastStartedAt?: LastStartedAt;
2027 /**
2028 * The time, in milliseconds since the epoch, when the simulation job was last updated.
2029 */
2030 lastUpdatedAt?: LastUpdatedAt;
2031 /**
2032 * The failure behavior the simulation job. Continue Restart the simulation job in the same host instance. Fail Stop the simulation job and terminate the instance.
2033 */
2034 failureBehavior?: FailureBehavior;
2035 /**
2036 * The failure code of the simulation job if it failed.
2037 */
2038 failureCode?: SimulationJobErrorCode;
2039 /**
2040 * The reason why the simulation job failed.
2041 */
2042 failureReason?: GenericString;
2043 /**
2044 * A unique identifier for this SimulationJob request.
2045 */
2046 clientRequestToken?: ClientRequestToken;
2047 /**
2048 * Location for output files generated by the simulation job.
2049 */
2050 outputLocation?: OutputLocation;
2051 /**
2052 * The logging configuration.
2053 */
2054 loggingConfig?: LoggingConfig;
2055 /**
2056 * The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.
2057 */
2058 maxJobDurationInSeconds?: JobDuration;
2059 /**
2060 * The simulation job execution duration in milliseconds.
2061 */
2062 simulationTimeMillis?: SimulationTimeMillis;
2063 /**
2064 * 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.
2065 */
2066 iamRole?: IamRole;
2067 /**
2068 * A list of robot applications.
2069 */
2070 robotApplications?: RobotApplicationConfigs;
2071 /**
2072 * A list of simulation applications.
2073 */
2074 simulationApplications?: SimulationApplicationConfigs;
2075 /**
2076 * The data sources for the simulation job.
2077 */
2078 dataSources?: DataSources;
2079 /**
2080 * A map that contains tag keys and tag values that are attached to the simulation job.
2081 */
2082 tags?: TagMap;
2083 /**
2084 * VPC configuration information.
2085 */
2086 vpcConfig?: VPCConfigResponse;
2087 /**
2088 * Information about a network interface.
2089 */
2090 networkInterface?: NetworkInterface;
2091 }
2092 export type SimulationJobBatchErrorCode = "InternalServiceError"|string;
2093 export type SimulationJobBatchStatus = "Pending"|"InProgress"|"Failed"|"Completed"|"Canceled"|"Canceling"|"Completing"|"TimingOut"|"TimedOut"|string;
2094 export type SimulationJobBatchSummaries = SimulationJobBatchSummary[];
2095 export interface SimulationJobBatchSummary {
2096 /**
2097 * The Amazon Resource Name (ARN) of the batch.
2098 */
2099 arn?: Arn;
2100 /**
2101 * The time, in milliseconds since the epoch, when the simulation job batch was last updated.
2102 */
2103 lastUpdatedAt?: LastUpdatedAt;
2104 /**
2105 * The time, in milliseconds since the epoch, when the simulation job batch was created.
2106 */
2107 createdAt?: CreatedAt;
2108 /**
2109 * 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.
2110 */
2111 status?: SimulationJobBatchStatus;
2112 /**
2113 * The number of failed simulation job requests.
2114 */
2115 failedRequestCount?: Integer;
2116 /**
2117 * The number of pending simulation job requests.
2118 */
2119 pendingRequestCount?: Integer;
2120 /**
2121 * The number of created simulation job requests.
2122 */
2123 createdRequestCount?: Integer;
2124 }
2125 export type SimulationJobErrorCode = "InternalServiceError"|"RobotApplicationCrash"|"SimulationApplicationCrash"|"BadPermissionsRobotApplication"|"BadPermissionsSimulationApplication"|"BadPermissionsS3Object"|"BadPermissionsS3Output"|"BadPermissionsCloudwatchLogs"|"SubnetIpLimitExceeded"|"ENILimitExceeded"|"BadPermissionsUserCredentials"|"InvalidBundleRobotApplication"|"InvalidBundleSimulationApplication"|"InvalidS3Resource"|"LimitExceeded"|"MismatchedEtag"|"RobotApplicationVersionMismatchedEtag"|"SimulationApplicationVersionMismatchedEtag"|"ResourceNotFound"|"RequestThrottled"|"BatchTimedOut"|"BatchCanceled"|"InvalidInput"|"WrongRegionS3Bucket"|"WrongRegionS3Output"|"WrongRegionRobotApplication"|"WrongRegionSimulationApplication"|string;
2126 export interface SimulationJobRequest {
2127 outputLocation?: OutputLocation;
2128 loggingConfig?: LoggingConfig;
2129 /**
2130 * The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.
2131 */
2132 maxJobDurationInSeconds: JobDuration;
2133 /**
2134 * 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.
2135 */
2136 iamRole?: IamRole;
2137 /**
2138 * The failure behavior the simulation job. Continue Restart the simulation job in the same host instance. Fail Stop the simulation job and terminate the instance.
2139 */
2140 failureBehavior?: FailureBehavior;
2141 /**
2142 * Boolean indicating whether to use default simulation tool applications.
2143 */
2144 useDefaultApplications?: BoxedBoolean;
2145 /**
2146 * The robot applications to use in the simulation job.
2147 */
2148 robotApplications?: RobotApplicationConfigs;
2149 /**
2150 * The simulation applications to use in the simulation job.
2151 */
2152 simulationApplications?: SimulationApplicationConfigs;
2153 /**
2154 * 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.
2155 */
2156 dataSources?: DataSourceConfigs;
2157 vpcConfig?: VPCConfig;
2158 /**
2159 * A map that contains tag keys and tag values that are attached to the simulation job request.
2160 */
2161 tags?: TagMap;
2162 }
2163 export type SimulationJobStatus = "Pending"|"Preparing"|"Running"|"Restarting"|"Completed"|"Failed"|"RunningFailed"|"Terminating"|"Terminated"|"Canceled"|string;
2164 export type SimulationJobSummaries = SimulationJobSummary[];
2165 export interface SimulationJobSummary {
2166 /**
2167 * The Amazon Resource Name (ARN) of the simulation job.
2168 */
2169 arn?: Arn;
2170 /**
2171 * The time, in milliseconds since the epoch, when the simulation job was last updated.
2172 */
2173 lastUpdatedAt?: LastUpdatedAt;
2174 /**
2175 * The name of the simulation job.
2176 */
2177 name?: Name;
2178 /**
2179 * The status of the simulation job.
2180 */
2181 status?: SimulationJobStatus;
2182 /**
2183 * A list of simulation job simulation application names.
2184 */
2185 simulationApplicationNames?: SimulationApplicationNames;
2186 /**
2187 * A list of simulation job robot application names.
2188 */
2189 robotApplicationNames?: RobotApplicationNames;
2190 /**
2191 * The names of the data sources.
2192 */
2193 dataSourceNames?: DataSourceNames;
2194 }
2195 export type SimulationJobs = SimulationJob[];
2196 export interface SimulationSoftwareSuite {
2197 /**
2198 * The name of the simulation software suite.
2199 */
2200 name?: SimulationSoftwareSuiteType;
2201 /**
2202 * The version of the simulation software suite.
2203 */
2204 version?: SimulationSoftwareSuiteVersionType;
2205 }
2206 export type SimulationSoftwareSuiteType = "Gazebo"|"RosbagPlay"|string;
2207 export type SimulationSoftwareSuiteVersionType = string;
2208 export type SimulationTimeMillis = number;
2209 export interface Source {
2210 /**
2211 * The s3 bucket name.
2212 */
2213 s3Bucket?: S3Bucket;
2214 /**
2215 * The s3 object key.
2216 */
2217 s3Key?: S3Key;
2218 /**
2219 * A hash of the object specified by s3Bucket and s3Key.
2220 */
2221 etag?: S3Etag;
2222 /**
2223 * The taget processor architecture for the application.
2224 */
2225 architecture?: Architecture;
2226 }
2227 export interface SourceConfig {
2228 /**
2229 * The Amazon S3 bucket name.
2230 */
2231 s3Bucket?: S3Bucket;
2232 /**
2233 * The s3 object key.
2234 */
2235 s3Key?: S3Key;
2236 /**
2237 * The target processor architecture for the application.
2238 */
2239 architecture?: Architecture;
2240 }
2241 export type SourceConfigs = SourceConfig[];
2242 export type Sources = Source[];
2243 export interface StartSimulationJobBatchRequest {
2244 /**
2245 * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
2246 */
2247 clientRequestToken?: ClientRequestToken;
2248 /**
2249 * The batch policy.
2250 */
2251 batchPolicy?: BatchPolicy;
2252 /**
2253 * A list of simulation job requests to create in the batch.
2254 */
2255 createSimulationJobRequests: CreateSimulationJobRequests;
2256 /**
2257 * A map that contains tag keys and tag values that are attached to the deployment job batch.
2258 */
2259 tags?: TagMap;
2260 }
2261 export interface StartSimulationJobBatchResponse {
2262 /**
2263 * The Amazon Resource Name (arn) of the batch.
2264 */
2265 arn?: Arn;
2266 /**
2267 * 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.
2268 */
2269 status?: SimulationJobBatchStatus;
2270 /**
2271 * The time, in milliseconds since the epoch, when the simulation job batch was created.
2272 */
2273 createdAt?: CreatedAt;
2274 /**
2275 * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
2276 */
2277 clientRequestToken?: ClientRequestToken;
2278 /**
2279 * The batch policy.
2280 */
2281 batchPolicy?: BatchPolicy;
2282 /**
2283 * The failure code if the simulation job batch failed.
2284 */
2285 failureCode?: SimulationJobBatchErrorCode;
2286 /**
2287 * The reason the simulation job batch failed.
2288 */
2289 failureReason?: GenericString;
2290 /**
2291 * 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.
2292 */
2293 failedRequests?: FailedCreateSimulationJobRequests;
2294 /**
2295 * A list of pending simulation job requests. These requests have not yet been created into simulation jobs.
2296 */
2297 pendingRequests?: CreateSimulationJobRequests;
2298 /**
2299 * A list of created simulation job request summaries.
2300 */
2301 createdRequests?: SimulationJobSummaries;
2302 /**
2303 * A map that contains tag keys and tag values that are attached to the deployment job batch.
2304 */
2305 tags?: TagMap;
2306 }
2307 export type Subnets = NonEmptyString[];
2308 export interface SyncDeploymentJobRequest {
2309 /**
2310 * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
2311 */
2312 clientRequestToken: ClientRequestToken;
2313 /**
2314 * The target fleet for the synchronization.
2315 */
2316 fleet: Arn;
2317 }
2318 export interface SyncDeploymentJobResponse {
2319 /**
2320 * The Amazon Resource Name (ARN) of the synchronization request.
2321 */
2322 arn?: Arn;
2323 /**
2324 * The Amazon Resource Name (ARN) of the fleet.
2325 */
2326 fleet?: Arn;
2327 /**
2328 * The status of the synchronization job.
2329 */
2330 status?: DeploymentStatus;
2331 /**
2332 * Information about the deployment configuration.
2333 */
2334 deploymentConfig?: DeploymentConfig;
2335 /**
2336 * Information about the deployment application configurations.
2337 */
2338 deploymentApplicationConfigs?: DeploymentApplicationConfigs;
2339 /**
2340 * The failure reason if the job fails.
2341 */
2342 failureReason?: GenericString;
2343 /**
2344 * 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.
2345 */
2346 failureCode?: DeploymentJobErrorCode;
2347 /**
2348 * The time, in milliseconds since the epoch, when the fleet was created.
2349 */
2350 createdAt?: CreatedAt;
2351 }
2352 export type TagKey = string;
2353 export type TagKeyList = TagKey[];
2354 export type TagMap = {[key: string]: TagValue};
2355 export interface TagResourceRequest {
2356 /**
2357 * The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are tagging.
2358 */
2359 resourceArn: Arn;
2360 /**
2361 * A map that contains tag keys and tag values that are attached to the resource.
2362 */
2363 tags: TagMap;
2364 }
2365 export interface TagResourceResponse {
2366 }
2367 export type TagValue = string;
2368 export interface UntagResourceRequest {
2369 /**
2370 * The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are removing tags.
2371 */
2372 resourceArn: Arn;
2373 /**
2374 * A map that contains tag keys and tag values that will be unattached from the resource.
2375 */
2376 tagKeys: TagKeyList;
2377 }
2378 export interface UntagResourceResponse {
2379 }
2380 export interface UpdateRobotApplicationRequest {
2381 /**
2382 * The application information for the robot application.
2383 */
2384 application: Arn;
2385 /**
2386 * The sources of the robot application.
2387 */
2388 sources: SourceConfigs;
2389 /**
2390 * The robot software suite (ROS distribution) used by the robot application.
2391 */
2392 robotSoftwareSuite: RobotSoftwareSuite;
2393 /**
2394 * The revision id for the robot application.
2395 */
2396 currentRevisionId?: RevisionId;
2397 }
2398 export interface UpdateRobotApplicationResponse {
2399 /**
2400 * The Amazon Resource Name (ARN) of the updated robot application.
2401 */
2402 arn?: Arn;
2403 /**
2404 * The name of the robot application.
2405 */
2406 name?: Name;
2407 /**
2408 * The version of the robot application.
2409 */
2410 version?: Version;
2411 /**
2412 * The sources of the robot application.
2413 */
2414 sources?: Sources;
2415 /**
2416 * The robot software suite (ROS distribution) used by the robot application.
2417 */
2418 robotSoftwareSuite?: RobotSoftwareSuite;
2419 /**
2420 * The time, in milliseconds since the epoch, when the robot application was last updated.
2421 */
2422 lastUpdatedAt?: LastUpdatedAt;
2423 /**
2424 * The revision id of the robot application.
2425 */
2426 revisionId?: RevisionId;
2427 }
2428 export interface UpdateSimulationApplicationRequest {
2429 /**
2430 * The application information for the simulation application.
2431 */
2432 application: Arn;
2433 /**
2434 * The sources of the simulation application.
2435 */
2436 sources: SourceConfigs;
2437 /**
2438 * The simulation software suite used by the simulation application.
2439 */
2440 simulationSoftwareSuite: SimulationSoftwareSuite;
2441 /**
2442 * Information about the robot software suite (ROS distribution).
2443 */
2444 robotSoftwareSuite: RobotSoftwareSuite;
2445 /**
2446 * The rendering engine for the simulation application.
2447 */
2448 renderingEngine?: RenderingEngine;
2449 /**
2450 * The revision id for the robot application.
2451 */
2452 currentRevisionId?: RevisionId;
2453 }
2454 export interface UpdateSimulationApplicationResponse {
2455 /**
2456 * The Amazon Resource Name (ARN) of the updated simulation application.
2457 */
2458 arn?: Arn;
2459 /**
2460 * The name of the simulation application.
2461 */
2462 name?: Name;
2463 /**
2464 * The version of the robot application.
2465 */
2466 version?: Version;
2467 /**
2468 * The sources of the simulation application.
2469 */
2470 sources?: Sources;
2471 /**
2472 * The simulation software suite used by the simulation application.
2473 */
2474 simulationSoftwareSuite?: SimulationSoftwareSuite;
2475 /**
2476 * Information about the robot software suite (ROS distribution).
2477 */
2478 robotSoftwareSuite?: RobotSoftwareSuite;
2479 /**
2480 * The rendering engine for the simulation application.
2481 */
2482 renderingEngine?: RenderingEngine;
2483 /**
2484 * The time, in milliseconds since the epoch, when the simulation application was last updated.
2485 */
2486 lastUpdatedAt?: LastUpdatedAt;
2487 /**
2488 * The revision id of the simulation application.
2489 */
2490 revisionId?: RevisionId;
2491 }
2492 export interface VPCConfig {
2493 /**
2494 * A list of one or more subnet IDs in your VPC.
2495 */
2496 subnets: Subnets;
2497 /**
2498 * A list of one or more security groups IDs in your VPC.
2499 */
2500 securityGroups?: SecurityGroups;
2501 /**
2502 * A boolean indicating whether to assign a public IP address.
2503 */
2504 assignPublicIp?: Boolean;
2505 }
2506 export interface VPCConfigResponse {
2507 /**
2508 * A list of subnet IDs associated with the simulation job.
2509 */
2510 subnets?: Subnets;
2511 /**
2512 * A list of security group IDs associated with the simulation job.
2513 */
2514 securityGroups?: SecurityGroups;
2515 /**
2516 * The VPC ID associated with your simulation job.
2517 */
2518 vpcId?: GenericString;
2519 /**
2520 * A boolean indicating if a public IP was assigned.
2521 */
2522 assignPublicIp?: Boolean;
2523 }
2524 export type Version = string;
2525 export type VersionQualifier = string;
2526 /**
2527 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
2528 */
2529 export type apiVersion = "2018-06-29"|"latest"|string;
2530 export interface ClientApiVersions {
2531 /**
2532 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
2533 */
2534 apiVersion?: apiVersion;
2535 }
2536 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
2537 /**
2538 * Contains interfaces for use with the RoboMaker client.
2539 */
2540 export import Types = RoboMaker;
2541}
2542export = RoboMaker;