UNPKG

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