UNPKG

81 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 simulation job.
24 */
25 cancelSimulationJob(params: RoboMaker.Types.CancelSimulationJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.CancelSimulationJobResponse) => void): Request<RoboMaker.Types.CancelSimulationJobResponse, AWSError>;
26 /**
27 * Cancels the specified simulation job.
28 */
29 cancelSimulationJob(callback?: (err: AWSError, data: RoboMaker.Types.CancelSimulationJobResponse) => void): Request<RoboMaker.Types.CancelSimulationJobResponse, AWSError>;
30 /**
31 * 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.
32 */
33 createDeploymentJob(params: RoboMaker.Types.CreateDeploymentJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateDeploymentJobResponse) => void): Request<RoboMaker.Types.CreateDeploymentJobResponse, AWSError>;
34 /**
35 * 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.
36 */
37 createDeploymentJob(callback?: (err: AWSError, data: RoboMaker.Types.CreateDeploymentJobResponse) => void): Request<RoboMaker.Types.CreateDeploymentJobResponse, AWSError>;
38 /**
39 * Creates a fleet, a logical group of robots running the same robot application.
40 */
41 createFleet(params: RoboMaker.Types.CreateFleetRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateFleetResponse) => void): Request<RoboMaker.Types.CreateFleetResponse, AWSError>;
42 /**
43 * Creates a fleet, a logical group of robots running the same robot application.
44 */
45 createFleet(callback?: (err: AWSError, data: RoboMaker.Types.CreateFleetResponse) => void): Request<RoboMaker.Types.CreateFleetResponse, AWSError>;
46 /**
47 * Creates a robot.
48 */
49 createRobot(params: RoboMaker.Types.CreateRobotRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateRobotResponse) => void): Request<RoboMaker.Types.CreateRobotResponse, AWSError>;
50 /**
51 * Creates a robot.
52 */
53 createRobot(callback?: (err: AWSError, data: RoboMaker.Types.CreateRobotResponse) => void): Request<RoboMaker.Types.CreateRobotResponse, AWSError>;
54 /**
55 * Creates a robot application.
56 */
57 createRobotApplication(params: RoboMaker.Types.CreateRobotApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateRobotApplicationResponse) => void): Request<RoboMaker.Types.CreateRobotApplicationResponse, AWSError>;
58 /**
59 * Creates a robot application.
60 */
61 createRobotApplication(callback?: (err: AWSError, data: RoboMaker.Types.CreateRobotApplicationResponse) => void): Request<RoboMaker.Types.CreateRobotApplicationResponse, AWSError>;
62 /**
63 * Creates a version of a robot application.
64 */
65 createRobotApplicationVersion(params: RoboMaker.Types.CreateRobotApplicationVersionRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateRobotApplicationVersionResponse) => void): Request<RoboMaker.Types.CreateRobotApplicationVersionResponse, AWSError>;
66 /**
67 * Creates a version of a robot application.
68 */
69 createRobotApplicationVersion(callback?: (err: AWSError, data: RoboMaker.Types.CreateRobotApplicationVersionResponse) => void): Request<RoboMaker.Types.CreateRobotApplicationVersionResponse, AWSError>;
70 /**
71 * Creates a simulation application.
72 */
73 createSimulationApplication(params: RoboMaker.Types.CreateSimulationApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateSimulationApplicationResponse) => void): Request<RoboMaker.Types.CreateSimulationApplicationResponse, AWSError>;
74 /**
75 * Creates a simulation application.
76 */
77 createSimulationApplication(callback?: (err: AWSError, data: RoboMaker.Types.CreateSimulationApplicationResponse) => void): Request<RoboMaker.Types.CreateSimulationApplicationResponse, AWSError>;
78 /**
79 * Creates a simulation application with a specific revision id.
80 */
81 createSimulationApplicationVersion(params: RoboMaker.Types.CreateSimulationApplicationVersionRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateSimulationApplicationVersionResponse) => void): Request<RoboMaker.Types.CreateSimulationApplicationVersionResponse, AWSError>;
82 /**
83 * Creates a simulation application with a specific revision id.
84 */
85 createSimulationApplicationVersion(callback?: (err: AWSError, data: RoboMaker.Types.CreateSimulationApplicationVersionResponse) => void): Request<RoboMaker.Types.CreateSimulationApplicationVersionResponse, AWSError>;
86 /**
87 * Creates a simulation job.
88 */
89 createSimulationJob(params: RoboMaker.Types.CreateSimulationJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.CreateSimulationJobResponse) => void): Request<RoboMaker.Types.CreateSimulationJobResponse, AWSError>;
90 /**
91 * Creates a simulation job.
92 */
93 createSimulationJob(callback?: (err: AWSError, data: RoboMaker.Types.CreateSimulationJobResponse) => void): Request<RoboMaker.Types.CreateSimulationJobResponse, AWSError>;
94 /**
95 * Deletes a fleet.
96 */
97 deleteFleet(params: RoboMaker.Types.DeleteFleetRequest, callback?: (err: AWSError, data: RoboMaker.Types.DeleteFleetResponse) => void): Request<RoboMaker.Types.DeleteFleetResponse, AWSError>;
98 /**
99 * Deletes a fleet.
100 */
101 deleteFleet(callback?: (err: AWSError, data: RoboMaker.Types.DeleteFleetResponse) => void): Request<RoboMaker.Types.DeleteFleetResponse, AWSError>;
102 /**
103 * Deletes a robot.
104 */
105 deleteRobot(params: RoboMaker.Types.DeleteRobotRequest, callback?: (err: AWSError, data: RoboMaker.Types.DeleteRobotResponse) => void): Request<RoboMaker.Types.DeleteRobotResponse, AWSError>;
106 /**
107 * Deletes a robot.
108 */
109 deleteRobot(callback?: (err: AWSError, data: RoboMaker.Types.DeleteRobotResponse) => void): Request<RoboMaker.Types.DeleteRobotResponse, AWSError>;
110 /**
111 * Deletes a robot application.
112 */
113 deleteRobotApplication(params: RoboMaker.Types.DeleteRobotApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.DeleteRobotApplicationResponse) => void): Request<RoboMaker.Types.DeleteRobotApplicationResponse, AWSError>;
114 /**
115 * Deletes a robot application.
116 */
117 deleteRobotApplication(callback?: (err: AWSError, data: RoboMaker.Types.DeleteRobotApplicationResponse) => void): Request<RoboMaker.Types.DeleteRobotApplicationResponse, AWSError>;
118 /**
119 * Deletes a simulation application.
120 */
121 deleteSimulationApplication(params: RoboMaker.Types.DeleteSimulationApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.DeleteSimulationApplicationResponse) => void): Request<RoboMaker.Types.DeleteSimulationApplicationResponse, AWSError>;
122 /**
123 * Deletes a simulation application.
124 */
125 deleteSimulationApplication(callback?: (err: AWSError, data: RoboMaker.Types.DeleteSimulationApplicationResponse) => void): Request<RoboMaker.Types.DeleteSimulationApplicationResponse, AWSError>;
126 /**
127 * Deregisters a robot.
128 */
129 deregisterRobot(params: RoboMaker.Types.DeregisterRobotRequest, callback?: (err: AWSError, data: RoboMaker.Types.DeregisterRobotResponse) => void): Request<RoboMaker.Types.DeregisterRobotResponse, AWSError>;
130 /**
131 * Deregisters a robot.
132 */
133 deregisterRobot(callback?: (err: AWSError, data: RoboMaker.Types.DeregisterRobotResponse) => void): Request<RoboMaker.Types.DeregisterRobotResponse, AWSError>;
134 /**
135 * Describes a deployment job. [Does it work regardless of deployment status, e.g. Failed?]
136 */
137 describeDeploymentJob(params: RoboMaker.Types.DescribeDeploymentJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.DescribeDeploymentJobResponse) => void): Request<RoboMaker.Types.DescribeDeploymentJobResponse, AWSError>;
138 /**
139 * Describes a deployment job. [Does it work regardless of deployment status, e.g. Failed?]
140 */
141 describeDeploymentJob(callback?: (err: AWSError, data: RoboMaker.Types.DescribeDeploymentJobResponse) => void): Request<RoboMaker.Types.DescribeDeploymentJobResponse, AWSError>;
142 /**
143 * Describes a fleet.
144 */
145 describeFleet(params: RoboMaker.Types.DescribeFleetRequest, callback?: (err: AWSError, data: RoboMaker.Types.DescribeFleetResponse) => void): Request<RoboMaker.Types.DescribeFleetResponse, AWSError>;
146 /**
147 * Describes a fleet.
148 */
149 describeFleet(callback?: (err: AWSError, data: RoboMaker.Types.DescribeFleetResponse) => void): Request<RoboMaker.Types.DescribeFleetResponse, AWSError>;
150 /**
151 * Describes a robot.
152 */
153 describeRobot(params: RoboMaker.Types.DescribeRobotRequest, callback?: (err: AWSError, data: RoboMaker.Types.DescribeRobotResponse) => void): Request<RoboMaker.Types.DescribeRobotResponse, AWSError>;
154 /**
155 * Describes a robot.
156 */
157 describeRobot(callback?: (err: AWSError, data: RoboMaker.Types.DescribeRobotResponse) => void): Request<RoboMaker.Types.DescribeRobotResponse, AWSError>;
158 /**
159 * Describes a robot application.
160 */
161 describeRobotApplication(params: RoboMaker.Types.DescribeRobotApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.DescribeRobotApplicationResponse) => void): Request<RoboMaker.Types.DescribeRobotApplicationResponse, AWSError>;
162 /**
163 * Describes a robot application.
164 */
165 describeRobotApplication(callback?: (err: AWSError, data: RoboMaker.Types.DescribeRobotApplicationResponse) => void): Request<RoboMaker.Types.DescribeRobotApplicationResponse, AWSError>;
166 /**
167 * Describes a simulation application.
168 */
169 describeSimulationApplication(params: RoboMaker.Types.DescribeSimulationApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.DescribeSimulationApplicationResponse) => void): Request<RoboMaker.Types.DescribeSimulationApplicationResponse, AWSError>;
170 /**
171 * Describes a simulation application.
172 */
173 describeSimulationApplication(callback?: (err: AWSError, data: RoboMaker.Types.DescribeSimulationApplicationResponse) => void): Request<RoboMaker.Types.DescribeSimulationApplicationResponse, AWSError>;
174 /**
175 * Describes a simulation job.
176 */
177 describeSimulationJob(params: RoboMaker.Types.DescribeSimulationJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.DescribeSimulationJobResponse) => void): Request<RoboMaker.Types.DescribeSimulationJobResponse, AWSError>;
178 /**
179 * Describes a simulation job.
180 */
181 describeSimulationJob(callback?: (err: AWSError, data: RoboMaker.Types.DescribeSimulationJobResponse) => void): Request<RoboMaker.Types.DescribeSimulationJobResponse, AWSError>;
182 /**
183 * Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.
184 */
185 listDeploymentJobs(params: RoboMaker.Types.ListDeploymentJobsRequest, callback?: (err: AWSError, data: RoboMaker.Types.ListDeploymentJobsResponse) => void): Request<RoboMaker.Types.ListDeploymentJobsResponse, AWSError>;
186 /**
187 * Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.
188 */
189 listDeploymentJobs(callback?: (err: AWSError, data: RoboMaker.Types.ListDeploymentJobsResponse) => void): Request<RoboMaker.Types.ListDeploymentJobsResponse, AWSError>;
190 /**
191 * Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.
192 */
193 listFleets(params: RoboMaker.Types.ListFleetsRequest, callback?: (err: AWSError, data: RoboMaker.Types.ListFleetsResponse) => void): Request<RoboMaker.Types.ListFleetsResponse, AWSError>;
194 /**
195 * Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.
196 */
197 listFleets(callback?: (err: AWSError, data: RoboMaker.Types.ListFleetsResponse) => void): Request<RoboMaker.Types.ListFleetsResponse, AWSError>;
198 /**
199 * Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications.
200 */
201 listRobotApplications(params: RoboMaker.Types.ListRobotApplicationsRequest, callback?: (err: AWSError, data: RoboMaker.Types.ListRobotApplicationsResponse) => void): Request<RoboMaker.Types.ListRobotApplicationsResponse, AWSError>;
202 /**
203 * Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications.
204 */
205 listRobotApplications(callback?: (err: AWSError, data: RoboMaker.Types.ListRobotApplicationsResponse) => void): Request<RoboMaker.Types.ListRobotApplicationsResponse, AWSError>;
206 /**
207 * Returns a list of robots. You can optionally provide filters to retrieve specific robots.
208 */
209 listRobots(params: RoboMaker.Types.ListRobotsRequest, callback?: (err: AWSError, data: RoboMaker.Types.ListRobotsResponse) => void): Request<RoboMaker.Types.ListRobotsResponse, AWSError>;
210 /**
211 * Returns a list of robots. You can optionally provide filters to retrieve specific robots.
212 */
213 listRobots(callback?: (err: AWSError, data: RoboMaker.Types.ListRobotsResponse) => void): Request<RoboMaker.Types.ListRobotsResponse, AWSError>;
214 /**
215 * Returns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications.
216 */
217 listSimulationApplications(params: RoboMaker.Types.ListSimulationApplicationsRequest, callback?: (err: AWSError, data: RoboMaker.Types.ListSimulationApplicationsResponse) => void): Request<RoboMaker.Types.ListSimulationApplicationsResponse, AWSError>;
218 /**
219 * Returns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications.
220 */
221 listSimulationApplications(callback?: (err: AWSError, data: RoboMaker.Types.ListSimulationApplicationsResponse) => void): Request<RoboMaker.Types.ListSimulationApplicationsResponse, AWSError>;
222 /**
223 * Returns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs.
224 */
225 listSimulationJobs(params: RoboMaker.Types.ListSimulationJobsRequest, callback?: (err: AWSError, data: RoboMaker.Types.ListSimulationJobsResponse) => void): Request<RoboMaker.Types.ListSimulationJobsResponse, AWSError>;
226 /**
227 * Returns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs.
228 */
229 listSimulationJobs(callback?: (err: AWSError, data: RoboMaker.Types.ListSimulationJobsResponse) => void): Request<RoboMaker.Types.ListSimulationJobsResponse, AWSError>;
230 /**
231 * Lists all tags on a AWS RoboMaker resource.
232 */
233 listTagsForResource(params: RoboMaker.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: RoboMaker.Types.ListTagsForResourceResponse) => void): Request<RoboMaker.Types.ListTagsForResourceResponse, AWSError>;
234 /**
235 * Lists all tags on a AWS RoboMaker resource.
236 */
237 listTagsForResource(callback?: (err: AWSError, data: RoboMaker.Types.ListTagsForResourceResponse) => void): Request<RoboMaker.Types.ListTagsForResourceResponse, AWSError>;
238 /**
239 * Registers a robot with a fleet.
240 */
241 registerRobot(params: RoboMaker.Types.RegisterRobotRequest, callback?: (err: AWSError, data: RoboMaker.Types.RegisterRobotResponse) => void): Request<RoboMaker.Types.RegisterRobotResponse, AWSError>;
242 /**
243 * Registers a robot with a fleet.
244 */
245 registerRobot(callback?: (err: AWSError, data: RoboMaker.Types.RegisterRobotResponse) => void): Request<RoboMaker.Types.RegisterRobotResponse, AWSError>;
246 /**
247 * Restarts a running simulation job.
248 */
249 restartSimulationJob(params: RoboMaker.Types.RestartSimulationJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.RestartSimulationJobResponse) => void): Request<RoboMaker.Types.RestartSimulationJobResponse, AWSError>;
250 /**
251 * Restarts a running simulation job.
252 */
253 restartSimulationJob(callback?: (err: AWSError, data: RoboMaker.Types.RestartSimulationJobResponse) => void): Request<RoboMaker.Types.RestartSimulationJobResponse, AWSError>;
254 /**
255 * Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.
256 */
257 syncDeploymentJob(params: RoboMaker.Types.SyncDeploymentJobRequest, callback?: (err: AWSError, data: RoboMaker.Types.SyncDeploymentJobResponse) => void): Request<RoboMaker.Types.SyncDeploymentJobResponse, AWSError>;
258 /**
259 * Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.
260 */
261 syncDeploymentJob(callback?: (err: AWSError, data: RoboMaker.Types.SyncDeploymentJobResponse) => void): Request<RoboMaker.Types.SyncDeploymentJobResponse, AWSError>;
262 /**
263 * 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.
264 */
265 tagResource(params: RoboMaker.Types.TagResourceRequest, callback?: (err: AWSError, data: RoboMaker.Types.TagResourceResponse) => void): Request<RoboMaker.Types.TagResourceResponse, AWSError>;
266 /**
267 * 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.
268 */
269 tagResource(callback?: (err: AWSError, data: RoboMaker.Types.TagResourceResponse) => void): Request<RoboMaker.Types.TagResourceResponse, AWSError>;
270 /**
271 * 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 .
272 */
273 untagResource(params: RoboMaker.Types.UntagResourceRequest, callback?: (err: AWSError, data: RoboMaker.Types.UntagResourceResponse) => void): Request<RoboMaker.Types.UntagResourceResponse, AWSError>;
274 /**
275 * 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 .
276 */
277 untagResource(callback?: (err: AWSError, data: RoboMaker.Types.UntagResourceResponse) => void): Request<RoboMaker.Types.UntagResourceResponse, AWSError>;
278 /**
279 * Updates a robot application.
280 */
281 updateRobotApplication(params: RoboMaker.Types.UpdateRobotApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.UpdateRobotApplicationResponse) => void): Request<RoboMaker.Types.UpdateRobotApplicationResponse, AWSError>;
282 /**
283 * Updates a robot application.
284 */
285 updateRobotApplication(callback?: (err: AWSError, data: RoboMaker.Types.UpdateRobotApplicationResponse) => void): Request<RoboMaker.Types.UpdateRobotApplicationResponse, AWSError>;
286 /**
287 * Updates a simulation application.
288 */
289 updateSimulationApplication(params: RoboMaker.Types.UpdateSimulationApplicationRequest, callback?: (err: AWSError, data: RoboMaker.Types.UpdateSimulationApplicationResponse) => void): Request<RoboMaker.Types.UpdateSimulationApplicationResponse, AWSError>;
290 /**
291 * Updates a simulation application.
292 */
293 updateSimulationApplication(callback?: (err: AWSError, data: RoboMaker.Types.UpdateSimulationApplicationResponse) => void): Request<RoboMaker.Types.UpdateSimulationApplicationResponse, AWSError>;
294}
295declare namespace RoboMaker {
296 export type Architecture = "X86_64"|"ARM64"|"ARMHF"|string;
297 export type Arn = string;
298 export type Arns = Arn[];
299 export interface BatchDescribeSimulationJobRequest {
300 /**
301 * A list of Amazon Resource Names (ARNs) of simulation jobs to describe.
302 */
303 jobs: Arns;
304 }
305 export interface BatchDescribeSimulationJobResponse {
306 /**
307 * A list of simulation jobs.
308 */
309 jobs?: SimulationJobs;
310 /**
311 * A list of unprocessed simulation job Amazon Resource Names (ARNs).
312 */
313 unprocessedJobs?: Arns;
314 }
315 export type Boolean = boolean;
316 export interface CancelSimulationJobRequest {
317 /**
318 * The simulation job ARN to cancel.
319 */
320 job: Arn;
321 }
322 export interface CancelSimulationJobResponse {
323 }
324 export type ClientRequestToken = string;
325 export interface CreateDeploymentJobRequest {
326 /**
327 * The requested deployment configuration.
328 */
329 deploymentConfig?: DeploymentConfig;
330 /**
331 * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
332 */
333 clientRequestToken: ClientRequestToken;
334 /**
335 * The Amazon Resource Name (ARN) of the fleet to deploy.
336 */
337 fleet: Arn;
338 /**
339 * The deployment application configuration.
340 */
341 deploymentApplicationConfigs: DeploymentApplicationConfigs;
342 /**
343 * A map that contains tag keys and tag values that are attached to the deployment job.
344 */
345 tags?: TagMap;
346 }
347 export interface CreateDeploymentJobResponse {
348 /**
349 * The Amazon Resource Name (ARN) of the deployment job.
350 */
351 arn?: Arn;
352 /**
353 * The target fleet for the deployment job.
354 */
355 fleet?: Arn;
356 /**
357 * The status of the deployment job.
358 */
359 status?: DeploymentStatus;
360 /**
361 * The deployment application configuration.
362 */
363 deploymentApplicationConfigs?: DeploymentApplicationConfigs;
364 /**
365 * The failure reason of the deployment job if it failed.
366 */
367 failureReason?: GenericString;
368 /**
369 * 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.
370 */
371 failureCode?: DeploymentJobErrorCode;
372 /**
373 * The time, in milliseconds since the epoch, when the fleet was created.
374 */
375 createdAt?: CreatedAt;
376 /**
377 * The deployment configuration.
378 */
379 deploymentConfig?: DeploymentConfig;
380 /**
381 * The list of all tags added to the deployment job.
382 */
383 tags?: TagMap;
384 }
385 export interface CreateFleetRequest {
386 /**
387 * The name of the fleet.
388 */
389 name: Name;
390 /**
391 * A map that contains tag keys and tag values that are attached to the fleet.
392 */
393 tags?: TagMap;
394 }
395 export interface CreateFleetResponse {
396 /**
397 * The Amazon Resource Name (ARN) of the fleet.
398 */
399 arn?: Arn;
400 /**
401 * The name of the fleet.
402 */
403 name?: Name;
404 /**
405 * The time, in milliseconds since the epoch, when the fleet was created.
406 */
407 createdAt?: CreatedAt;
408 /**
409 * The list of all tags added to the fleet.
410 */
411 tags?: TagMap;
412 }
413 export interface CreateRobotApplicationRequest {
414 /**
415 * The name of the robot application.
416 */
417 name: Name;
418 /**
419 * The sources of the robot application.
420 */
421 sources: SourceConfigs;
422 /**
423 * The robot software suite used by the robot application.
424 */
425 robotSoftwareSuite: RobotSoftwareSuite;
426 /**
427 * A map that contains tag keys and tag values that are attached to the robot application.
428 */
429 tags?: TagMap;
430 }
431 export interface CreateRobotApplicationResponse {
432 /**
433 * The Amazon Resource Name (ARN) of the robot application.
434 */
435 arn?: Arn;
436 /**
437 * The name of the robot application.
438 */
439 name?: Name;
440 /**
441 * The version of the robot application.
442 */
443 version?: Version;
444 /**
445 * The sources of the robot application.
446 */
447 sources?: Sources;
448 /**
449 * The robot software suite used by the robot application.
450 */
451 robotSoftwareSuite?: RobotSoftwareSuite;
452 /**
453 * The time, in milliseconds since the epoch, when the robot application was last updated.
454 */
455 lastUpdatedAt?: LastUpdatedAt;
456 /**
457 * The revision id of the robot application.
458 */
459 revisionId?: RevisionId;
460 /**
461 * The list of all tags added to the robot application.
462 */
463 tags?: TagMap;
464 }
465 export interface CreateRobotApplicationVersionRequest {
466 /**
467 * The application information for the robot application.
468 */
469 application: Arn;
470 /**
471 * 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.
472 */
473 currentRevisionId?: RevisionId;
474 }
475 export interface CreateRobotApplicationVersionResponse {
476 /**
477 * The Amazon Resource Name (ARN) of the robot application.
478 */
479 arn?: Arn;
480 /**
481 * The name of the robot application.
482 */
483 name?: Name;
484 /**
485 * The version of the robot application.
486 */
487 version?: Version;
488 /**
489 * The sources of the robot application.
490 */
491 sources?: Sources;
492 /**
493 * The robot software suite used by the robot application.
494 */
495 robotSoftwareSuite?: RobotSoftwareSuite;
496 /**
497 * The time, in milliseconds since the epoch, when the robot application was last updated.
498 */
499 lastUpdatedAt?: LastUpdatedAt;
500 /**
501 * The revision id of the robot application.
502 */
503 revisionId?: RevisionId;
504 }
505 export interface CreateRobotRequest {
506 /**
507 * The name for the robot.
508 */
509 name: Name;
510 /**
511 * The target architecture of the robot.
512 */
513 architecture: Architecture;
514 /**
515 * The Greengrass group id.
516 */
517 greengrassGroupId: Id;
518 /**
519 * A map that contains tag keys and tag values that are attached to the robot.
520 */
521 tags?: TagMap;
522 }
523 export interface CreateRobotResponse {
524 /**
525 * The Amazon Resource Name (ARN) of the robot.
526 */
527 arn?: Arn;
528 /**
529 * The name of the robot.
530 */
531 name?: Name;
532 /**
533 * The time, in milliseconds since the epoch, when the robot was created.
534 */
535 createdAt?: CreatedAt;
536 /**
537 * The Amazon Resource Name (ARN) of the Greengrass group associated with the robot.
538 */
539 greengrassGroupId?: Id;
540 /**
541 * The target architecture of the robot.
542 */
543 architecture?: Architecture;
544 /**
545 * The list of all tags added to the robot.
546 */
547 tags?: TagMap;
548 }
549 export interface CreateSimulationApplicationRequest {
550 /**
551 * The name of the simulation application.
552 */
553 name: Name;
554 /**
555 * The sources of the simulation application.
556 */
557 sources: SourceConfigs;
558 /**
559 * The simulation software suite used by the simulation application.
560 */
561 simulationSoftwareSuite: SimulationSoftwareSuite;
562 /**
563 * The robot software suite of the simulation application.
564 */
565 robotSoftwareSuite: RobotSoftwareSuite;
566 /**
567 * The rendering engine for the simulation application.
568 */
569 renderingEngine: RenderingEngine;
570 /**
571 * A map that contains tag keys and tag values that are attached to the simulation application.
572 */
573 tags?: TagMap;
574 }
575 export interface CreateSimulationApplicationResponse {
576 /**
577 * The Amazon Resource Name (ARN) of the simulation application.
578 */
579 arn?: Arn;
580 /**
581 * The name of the simulation application.
582 */
583 name?: Name;
584 /**
585 * The version of the simulation application.
586 */
587 version?: Version;
588 /**
589 * The sources of the simulation application.
590 */
591 sources?: Sources;
592 /**
593 * The simulation software suite used by the simulation application.
594 */
595 simulationSoftwareSuite?: SimulationSoftwareSuite;
596 /**
597 * Information about the robot software suite.
598 */
599 robotSoftwareSuite?: RobotSoftwareSuite;
600 /**
601 * The rendering engine for the simulation application.
602 */
603 renderingEngine?: RenderingEngine;
604 /**
605 * The time, in milliseconds since the epoch, when the simulation application was last updated.
606 */
607 lastUpdatedAt?: LastUpdatedAt;
608 /**
609 * The revision id of the simulation application.
610 */
611 revisionId?: RevisionId;
612 /**
613 * The list of all tags added to the simulation application.
614 */
615 tags?: TagMap;
616 }
617 export interface CreateSimulationApplicationVersionRequest {
618 /**
619 * The application information for the simulation application.
620 */
621 application: Arn;
622 /**
623 * 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.
624 */
625 currentRevisionId?: RevisionId;
626 }
627 export interface CreateSimulationApplicationVersionResponse {
628 /**
629 * The Amazon Resource Name (ARN) of the simulation application.
630 */
631 arn?: Arn;
632 /**
633 * The name of the simulation application.
634 */
635 name?: Name;
636 /**
637 * The version of the simulation application.
638 */
639 version?: Version;
640 /**
641 * The sources of the simulation application.
642 */
643 sources?: Sources;
644 /**
645 * The simulation software suite used by the simulation application.
646 */
647 simulationSoftwareSuite?: SimulationSoftwareSuite;
648 /**
649 * Information about the robot software suite.
650 */
651 robotSoftwareSuite?: RobotSoftwareSuite;
652 /**
653 * The rendering engine for the simulation application.
654 */
655 renderingEngine?: RenderingEngine;
656 /**
657 * The time, in milliseconds since the epoch, when the simulation application was last updated.
658 */
659 lastUpdatedAt?: LastUpdatedAt;
660 /**
661 * The revision ID of the simulation application.
662 */
663 revisionId?: RevisionId;
664 }
665 export interface CreateSimulationJobRequest {
666 /**
667 * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
668 */
669 clientRequestToken?: ClientRequestToken;
670 /**
671 * Location for output files generated by the simulation job.
672 */
673 outputLocation?: OutputLocation;
674 /**
675 * 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.
676 */
677 maxJobDurationInSeconds: JobDuration;
678 /**
679 * 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.
680 */
681 iamRole: IamRole;
682 /**
683 * 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.
684 */
685 failureBehavior?: FailureBehavior;
686 /**
687 * The robot application to use in the simulation job.
688 */
689 robotApplications?: RobotApplicationConfigs;
690 /**
691 * The simulation application to use in the simulation job.
692 */
693 simulationApplications?: SimulationApplicationConfigs;
694 /**
695 * A map that contains tag keys and tag values that are attached to the simulation job.
696 */
697 tags?: TagMap;
698 /**
699 * 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.
700 */
701 vpcConfig?: VPCConfig;
702 }
703 export interface CreateSimulationJobResponse {
704 /**
705 * The Amazon Resource Name (ARN) of the simulation job.
706 */
707 arn?: Arn;
708 /**
709 * The status of the simulation job.
710 */
711 status?: SimulationJobStatus;
712 /**
713 * The time, in milliseconds since the epoch, when the simulation job was last updated.
714 */
715 lastUpdatedAt?: LastUpdatedAt;
716 /**
717 * the failure behavior for the simulation job.
718 */
719 failureBehavior?: FailureBehavior;
720 /**
721 * 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.
722 */
723 failureCode?: SimulationJobErrorCode;
724 /**
725 * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
726 */
727 clientRequestToken?: ClientRequestToken;
728 /**
729 * Simulation job output files location.
730 */
731 outputLocation?: OutputLocation;
732 /**
733 * The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.
734 */
735 maxJobDurationInSeconds?: JobDuration;
736 /**
737 * The simulation job execution duration in milliseconds.
738 */
739 simulationTimeMillis?: SimulationTimeMillis;
740 /**
741 * The IAM role that allows the simulation job to call the AWS APIs that are specified in its associated policies on your behalf.
742 */
743 iamRole?: IamRole;
744 /**
745 * The robot application used by the simulation job.
746 */
747 robotApplications?: RobotApplicationConfigs;
748 /**
749 * The simulation application used by the simulation job.
750 */
751 simulationApplications?: SimulationApplicationConfigs;
752 /**
753 * The list of all tags added to the simulation job.
754 */
755 tags?: TagMap;
756 /**
757 * Information about the vpc configuration.
758 */
759 vpcConfig?: VPCConfigResponse;
760 }
761 export type CreatedAt = Date;
762 export interface DeleteFleetRequest {
763 /**
764 * The Amazon Resource Name (ARN) of the fleet.
765 */
766 fleet: Arn;
767 }
768 export interface DeleteFleetResponse {
769 }
770 export interface DeleteRobotApplicationRequest {
771 /**
772 * The Amazon Resource Name (ARN) of the the robot application.
773 */
774 application: Arn;
775 /**
776 * The version of the robot application to delete.
777 */
778 applicationVersion?: Version;
779 }
780 export interface DeleteRobotApplicationResponse {
781 }
782 export interface DeleteRobotRequest {
783 /**
784 * The Amazon Resource Name (ARN) of the robot.
785 */
786 robot: Arn;
787 }
788 export interface DeleteRobotResponse {
789 }
790 export interface DeleteSimulationApplicationRequest {
791 /**
792 * The application information for the simulation application to delete.
793 */
794 application: Arn;
795 /**
796 * The version of the simulation application to delete.
797 */
798 applicationVersion?: Version;
799 }
800 export interface DeleteSimulationApplicationResponse {
801 }
802 export interface DeploymentApplicationConfig {
803 /**
804 * The Amazon Resource Name (ARN) of the robot application.
805 */
806 application: Arn;
807 /**
808 * The version of the application.
809 */
810 applicationVersion: DeploymentVersion;
811 /**
812 * The launch configuration.
813 */
814 launchConfig: DeploymentLaunchConfig;
815 }
816 export type DeploymentApplicationConfigs = DeploymentApplicationConfig[];
817 export interface DeploymentConfig {
818 /**
819 * The percentage of robots receiving the deployment at the same time.
820 */
821 concurrentDeploymentPercentage?: Percentage;
822 /**
823 * The percentage of deployments that need to fail before stopping deployment.
824 */
825 failureThresholdPercentage?: Percentage;
826 }
827 export interface DeploymentJob {
828 /**
829 * The Amazon Resource Name (ARN) of the deployment job.
830 */
831 arn?: Arn;
832 /**
833 * The Amazon Resource Name (ARN) of the fleet.
834 */
835 fleet?: Arn;
836 /**
837 * The status of the deployment job.
838 */
839 status?: DeploymentStatus;
840 /**
841 * The deployment application configuration.
842 */
843 deploymentApplicationConfigs?: DeploymentApplicationConfigs;
844 /**
845 * The deployment configuration.
846 */
847 deploymentConfig?: DeploymentConfig;
848 /**
849 * A short description of the reason why the deployment job failed.
850 */
851 failureReason?: GenericString;
852 /**
853 * The deployment job failure code.
854 */
855 failureCode?: DeploymentJobErrorCode;
856 /**
857 * The time, in milliseconds since the epoch, when the deployment job was created.
858 */
859 createdAt?: CreatedAt;
860 }
861 export type DeploymentJobErrorCode = "ResourceNotFound"|"FailureThresholdBreached"|"RobotDeploymentNoResponse"|"GreengrassDeploymentFailed"|"MissingRobotArchitecture"|"MissingRobotApplicationArchitecture"|"MissingRobotDeploymentResource"|"GreengrassGroupVersionDoesNotExist"|"ExtractingBundleFailure"|"PreLaunchFileFailure"|"PostLaunchFileFailure"|"BadPermissionError"|"InternalServerError"|string;
862 export type DeploymentJobs = DeploymentJob[];
863 export interface DeploymentLaunchConfig {
864 /**
865 * The package name.
866 */
867 packageName: GenericString;
868 /**
869 * The deployment pre-launch file. This file will be executed prior to the launch file.
870 */
871 preLaunchFile?: GenericString;
872 /**
873 * The launch file name.
874 */
875 launchFile: GenericString;
876 /**
877 * The deployment post-launch file. This file will be executed after the launch file.
878 */
879 postLaunchFile?: GenericString;
880 /**
881 * An array of key/value pairs specifying environment variables for the robot application
882 */
883 environmentVariables?: EnvironmentVariableMap;
884 }
885 export type DeploymentStatus = "Pending"|"Preparing"|"InProgress"|"Failed"|"Succeeded"|string;
886 export type DeploymentVersion = string;
887 export interface DeregisterRobotRequest {
888 /**
889 * The Amazon Resource Name (ARN) of the fleet.
890 */
891 fleet: Arn;
892 /**
893 * The Amazon Resource Name (ARN) of the robot.
894 */
895 robot: Arn;
896 }
897 export interface DeregisterRobotResponse {
898 /**
899 * The Amazon Resource Name (ARN) of the fleet.
900 */
901 fleet?: Arn;
902 /**
903 * The Amazon Resource Name (ARN) of the robot.
904 */
905 robot?: Arn;
906 }
907 export interface DescribeDeploymentJobRequest {
908 /**
909 * The Amazon Resource Name (ARN) of the deployment job.
910 */
911 job: Arn;
912 }
913 export interface DescribeDeploymentJobResponse {
914 /**
915 * The Amazon Resource Name (ARN) of the deployment job.
916 */
917 arn?: Arn;
918 /**
919 * The Amazon Resource Name (ARN) of the fleet.
920 */
921 fleet?: Arn;
922 /**
923 * The status of the deployment job.
924 */
925 status?: DeploymentStatus;
926 /**
927 * The deployment configuration.
928 */
929 deploymentConfig?: DeploymentConfig;
930 /**
931 * The deployment application configuration.
932 */
933 deploymentApplicationConfigs?: DeploymentApplicationConfigs;
934 /**
935 * A short description of the reason why the deployment job failed.
936 */
937 failureReason?: GenericString;
938 /**
939 * The deployment job failure code.
940 */
941 failureCode?: DeploymentJobErrorCode;
942 /**
943 * The time, in milliseconds since the epoch, when the deployment job was created.
944 */
945 createdAt?: CreatedAt;
946 /**
947 * A list of robot deployment summaries.
948 */
949 robotDeploymentSummary?: RobotDeploymentSummary;
950 /**
951 * The list of all tags added to the specified deployment job.
952 */
953 tags?: TagMap;
954 }
955 export interface DescribeFleetRequest {
956 /**
957 * The Amazon Resource Name (ARN) of the fleet.
958 */
959 fleet: Arn;
960 }
961 export interface DescribeFleetResponse {
962 /**
963 * The name of the fleet.
964 */
965 name?: Name;
966 /**
967 * The Amazon Resource Name (ARN) of the fleet.
968 */
969 arn?: Arn;
970 /**
971 * A list of robots.
972 */
973 robots?: Robots;
974 /**
975 * The time, in milliseconds since the epoch, when the fleet was created.
976 */
977 createdAt?: CreatedAt;
978 /**
979 * The status of the last deployment.
980 */
981 lastDeploymentStatus?: DeploymentStatus;
982 /**
983 * The Amazon Resource Name (ARN) of the last deployment job.
984 */
985 lastDeploymentJob?: Arn;
986 /**
987 * The time of the last deployment.
988 */
989 lastDeploymentTime?: CreatedAt;
990 /**
991 * The list of all tags added to the specified fleet.
992 */
993 tags?: TagMap;
994 }
995 export interface DescribeRobotApplicationRequest {
996 /**
997 * The Amazon Resource Name (ARN) of the robot application.
998 */
999 application: Arn;
1000 /**
1001 * The version of the robot application to describe.
1002 */
1003 applicationVersion?: Version;
1004 }
1005 export interface DescribeRobotApplicationResponse {
1006 /**
1007 * The Amazon Resource Name (ARN) of the robot application.
1008 */
1009 arn?: Arn;
1010 /**
1011 * The name of the robot application.
1012 */
1013 name?: Name;
1014 /**
1015 * The version of the robot application.
1016 */
1017 version?: Version;
1018 /**
1019 * The sources of the robot application.
1020 */
1021 sources?: Sources;
1022 /**
1023 * The robot software suite used by the robot application.
1024 */
1025 robotSoftwareSuite?: RobotSoftwareSuite;
1026 /**
1027 * The revision id of the robot application.
1028 */
1029 revisionId?: RevisionId;
1030 /**
1031 * The time, in milliseconds since the epoch, when the robot application was last updated.
1032 */
1033 lastUpdatedAt?: LastUpdatedAt;
1034 /**
1035 * The list of all tags added to the specified robot application.
1036 */
1037 tags?: TagMap;
1038 }
1039 export interface DescribeRobotRequest {
1040 /**
1041 * The Amazon Resource Name (ARN) of the robot to be described.
1042 */
1043 robot: Arn;
1044 }
1045 export interface DescribeRobotResponse {
1046 /**
1047 * The Amazon Resource Name (ARN) of the robot.
1048 */
1049 arn?: Arn;
1050 /**
1051 * The name of the robot.
1052 */
1053 name?: Name;
1054 /**
1055 * The Amazon Resource Name (ARN) of the fleet.
1056 */
1057 fleetArn?: Arn;
1058 /**
1059 * The status of the fleet.
1060 */
1061 status?: RobotStatus;
1062 /**
1063 * The Greengrass group id.
1064 */
1065 greengrassGroupId?: Id;
1066 /**
1067 * The time, in milliseconds since the epoch, when the robot was created.
1068 */
1069 createdAt?: CreatedAt;
1070 /**
1071 * The target architecture of the robot application.
1072 */
1073 architecture?: Architecture;
1074 /**
1075 * The Amazon Resource Name (ARN) of the last deployment job.
1076 */
1077 lastDeploymentJob?: Arn;
1078 /**
1079 * The time of the last deployment job.
1080 */
1081 lastDeploymentTime?: CreatedAt;
1082 /**
1083 * The list of all tags added to the specified robot.
1084 */
1085 tags?: TagMap;
1086 }
1087 export interface DescribeSimulationApplicationRequest {
1088 /**
1089 * The application information for the simulation application.
1090 */
1091 application: Arn;
1092 /**
1093 * The version of the simulation application to describe.
1094 */
1095 applicationVersion?: Version;
1096 }
1097 export interface DescribeSimulationApplicationResponse {
1098 /**
1099 * The Amazon Resource Name (ARN) of the robot simulation application.
1100 */
1101 arn?: Arn;
1102 /**
1103 * The name of the simulation application.
1104 */
1105 name?: Name;
1106 /**
1107 * The version of the simulation application.
1108 */
1109 version?: Version;
1110 /**
1111 * The sources of the simulation application.
1112 */
1113 sources?: Sources;
1114 /**
1115 * The simulation software suite used by the simulation application.
1116 */
1117 simulationSoftwareSuite?: SimulationSoftwareSuite;
1118 /**
1119 * Information about the robot software suite.
1120 */
1121 robotSoftwareSuite?: RobotSoftwareSuite;
1122 /**
1123 * The rendering engine for the simulation application.
1124 */
1125 renderingEngine?: RenderingEngine;
1126 /**
1127 * The revision id of the simulation application.
1128 */
1129 revisionId?: RevisionId;
1130 /**
1131 * The time, in milliseconds since the epoch, when the simulation application was last updated.
1132 */
1133 lastUpdatedAt?: LastUpdatedAt;
1134 /**
1135 * The list of all tags added to the specified simulation application.
1136 */
1137 tags?: TagMap;
1138 }
1139 export interface DescribeSimulationJobRequest {
1140 /**
1141 * The Amazon Resource Name (ARN) of the simulation job to be described.
1142 */
1143 job: Arn;
1144 }
1145 export interface DescribeSimulationJobResponse {
1146 /**
1147 * The Amazon Resource Name (ARN) of the simulation job.
1148 */
1149 arn?: Arn;
1150 /**
1151 * The name of the simulation job.
1152 */
1153 name?: Name;
1154 /**
1155 * The status of the simulation job.
1156 */
1157 status?: SimulationJobStatus;
1158 /**
1159 * The time, in milliseconds since the epoch, when the simulation job was last updated.
1160 */
1161 lastUpdatedAt?: LastUpdatedAt;
1162 /**
1163 * The failure behavior for the simulation job.
1164 */
1165 failureBehavior?: FailureBehavior;
1166 /**
1167 * 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.
1168 */
1169 failureCode?: SimulationJobErrorCode;
1170 /**
1171 * Details about why the simulation job failed. For more information about troubleshooting, see Troubleshooting.
1172 */
1173 failureReason?: GenericString;
1174 /**
1175 * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
1176 */
1177 clientRequestToken?: ClientRequestToken;
1178 /**
1179 * Location for output files generated by the simulation job.
1180 */
1181 outputLocation?: OutputLocation;
1182 /**
1183 * The maximum job duration in seconds. The value must be 8 days (691,200 seconds) or less.
1184 */
1185 maxJobDurationInSeconds?: JobDuration;
1186 /**
1187 * The simulation job execution duration in milliseconds.
1188 */
1189 simulationTimeMillis?: SimulationTimeMillis;
1190 /**
1191 * The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf.
1192 */
1193 iamRole?: IamRole;
1194 /**
1195 * A list of robot applications.
1196 */
1197 robotApplications?: RobotApplicationConfigs;
1198 /**
1199 * A list of simulation applications.
1200 */
1201 simulationApplications?: SimulationApplicationConfigs;
1202 /**
1203 * The list of all tags added to the specified simulation job.
1204 */
1205 tags?: TagMap;
1206 /**
1207 * The VPC configuration.
1208 */
1209 vpcConfig?: VPCConfigResponse;
1210 }
1211 export type EnvironmentVariableKey = string;
1212 export type EnvironmentVariableMap = {[key: string]: EnvironmentVariableValue};
1213 export type EnvironmentVariableValue = string;
1214 export type FailureBehavior = "Fail"|"Continue"|string;
1215 export interface Filter {
1216 /**
1217 * The name of the filter.
1218 */
1219 name?: Name;
1220 /**
1221 * A list of values.
1222 */
1223 values?: FilterValues;
1224 }
1225 export type FilterValues = Name[];
1226 export type Filters = Filter[];
1227 export interface Fleet {
1228 /**
1229 * The name of the fleet.
1230 */
1231 name?: Name;
1232 /**
1233 * The Amazon Resource Name (ARN) of the fleet.
1234 */
1235 arn?: Arn;
1236 /**
1237 * The time, in milliseconds since the epoch, when the fleet was created.
1238 */
1239 createdAt?: CreatedAt;
1240 /**
1241 * The status of the last fleet deployment.
1242 */
1243 lastDeploymentStatus?: DeploymentStatus;
1244 /**
1245 * The Amazon Resource Name (ARN) of the last deployment job.
1246 */
1247 lastDeploymentJob?: Arn;
1248 /**
1249 * The time of the last deployment.
1250 */
1251 lastDeploymentTime?: CreatedAt;
1252 }
1253 export type Fleets = Fleet[];
1254 export type GenericString = string;
1255 export type IamRole = string;
1256 export type Id = string;
1257 export type JobDuration = number;
1258 export type LastUpdatedAt = Date;
1259 export interface LaunchConfig {
1260 /**
1261 * The package name.
1262 */
1263 packageName: GenericString;
1264 /**
1265 * The launch file name.
1266 */
1267 launchFile: GenericString;
1268 /**
1269 * The environment variables for the application launch.
1270 */
1271 environmentVariables?: EnvironmentVariableMap;
1272 }
1273 export interface ListDeploymentJobsRequest {
1274 /**
1275 * Optional filters to limit results.
1276 */
1277 filters?: Filters;
1278 /**
1279 * 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. 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.
1280 */
1281 nextToken?: PaginationToken;
1282 /**
1283 * The maximum number of deployment job results returned by ListDeploymentJobs in paginated output. 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 100. If this parameter is not used, then ListDeploymentJobs returns up to 100 results and a nextToken value if applicable.
1284 */
1285 maxResults?: MaxResults;
1286 }
1287 export interface ListDeploymentJobsResponse {
1288 /**
1289 * A list of deployment jobs that meet the criteria of the request.
1290 */
1291 deploymentJobs?: DeploymentJobs;
1292 /**
1293 * 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.
1294 */
1295 nextToken?: PaginationToken;
1296 }
1297 export interface ListFleetsRequest {
1298 /**
1299 * 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.
1300 */
1301 nextToken?: PaginationToken;
1302 /**
1303 * The maximum number of deployment job results returned by ListFleets in paginated output. 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 100. If this parameter is not used, then ListFleets returns up to 100 results and a nextToken value if applicable.
1304 */
1305 maxResults?: MaxResults;
1306 /**
1307 * Optional filters to limit results.
1308 */
1309 filters?: Filters;
1310 }
1311 export interface ListFleetsResponse {
1312 /**
1313 * A list of fleet details meeting the request criteria.
1314 */
1315 fleetDetails?: Fleets;
1316 /**
1317 * 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.
1318 */
1319 nextToken?: PaginationToken;
1320 }
1321 export interface ListRobotApplicationsRequest {
1322 /**
1323 * The version qualifier of the robot application.
1324 */
1325 versionQualifier?: VersionQualifier;
1326 /**
1327 * 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. 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.
1328 */
1329 nextToken?: PaginationToken;
1330 /**
1331 * The maximum number of deployment job results returned by ListRobotApplications in paginated output. 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 ListFleets 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.
1332 */
1333 maxResults?: MaxResults;
1334 /**
1335 * Optional filters to limit results.
1336 */
1337 filters?: Filters;
1338 }
1339 export interface ListRobotApplicationsResponse {
1340 /**
1341 * A list of robot application summaries that meet the criteria of the request.
1342 */
1343 robotApplicationSummaries?: RobotApplicationSummaries;
1344 /**
1345 * 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.
1346 */
1347 nextToken?: PaginationToken;
1348 }
1349 export interface ListRobotsRequest {
1350 /**
1351 * 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. 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.
1352 */
1353 nextToken?: PaginationToken;
1354 /**
1355 * The maximum number of deployment job results returned by ListRobots in paginated output. 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 ListFleets request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListRobots returns up to 100 results and a nextToken value if applicable.
1356 */
1357 maxResults?: MaxResults;
1358 /**
1359 * Optional filters to limit results.
1360 */
1361 filters?: Filters;
1362 }
1363 export interface ListRobotsResponse {
1364 /**
1365 * A list of robots that meet the criteria of the request.
1366 */
1367 robots?: Robots;
1368 /**
1369 * 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.
1370 */
1371 nextToken?: PaginationToken;
1372 }
1373 export interface ListSimulationApplicationsRequest {
1374 /**
1375 * The version qualifier of the simulation application.
1376 */
1377 versionQualifier?: VersionQualifier;
1378 /**
1379 * 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. 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.
1380 */
1381 nextToken?: PaginationToken;
1382 /**
1383 * The maximum number of deployment job results returned by ListSimulationApplications in paginated output. 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 ListFleets 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.
1384 */
1385 maxResults?: MaxResults;
1386 /**
1387 * Optional list of filters to limit results. The only valid filter name is name.
1388 */
1389 filters?: Filters;
1390 }
1391 export interface ListSimulationApplicationsResponse {
1392 /**
1393 * A list of simulation application summaries that meet the criteria of the request.
1394 */
1395 simulationApplicationSummaries?: SimulationApplicationSummaries;
1396 /**
1397 * 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.
1398 */
1399 nextToken?: PaginationToken;
1400 }
1401 export interface ListSimulationJobsRequest {
1402 /**
1403 * 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.
1404 */
1405 nextToken?: PaginationToken;
1406 /**
1407 * The maximum number of deployment job results returned by ListSimulationJobs in paginated output. 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 ListFleets request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListSimulationJobs returns up to 100 results and a nextToken value if applicable.
1408 */
1409 maxResults?: MaxResults;
1410 /**
1411 * Optional filters to limit results.
1412 */
1413 filters?: Filters;
1414 }
1415 export interface ListSimulationJobsResponse {
1416 /**
1417 * A list of simulation job summaries that meet the criteria of the request.
1418 */
1419 simulationJobSummaries: SimulationJobSummaries;
1420 /**
1421 * 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.
1422 */
1423 nextToken?: PaginationToken;
1424 }
1425 export interface ListTagsForResourceRequest {
1426 /**
1427 * The AWS RoboMaker Amazon Resource Name (ARN) with tags to be listed.
1428 */
1429 resourceArn: Arn;
1430 }
1431 export interface ListTagsForResourceResponse {
1432 /**
1433 * The list of all tags added to the specified resource.
1434 */
1435 tags?: TagMap;
1436 }
1437 export type MaxResults = number;
1438 export type Name = string;
1439 export interface OutputLocation {
1440 /**
1441 * The S3 bucket for output.
1442 */
1443 s3Bucket?: S3Bucket;
1444 /**
1445 * The S3 folder in the s3Bucket where output files will be placed.
1446 */
1447 s3Prefix?: S3Key;
1448 }
1449 export type PaginationToken = string;
1450 export type Percentage = number;
1451 export interface ProgressDetail {
1452 /**
1453 * The current progress status.
1454 */
1455 currentProgress?: GenericString;
1456 /**
1457 * The Amazon Resource Name (ARN) of the deployment job.
1458 */
1459 targetResource?: GenericString;
1460 }
1461 export interface RegisterRobotRequest {
1462 /**
1463 * The Amazon Resource Name (ARN) of the fleet.
1464 */
1465 fleet: Arn;
1466 /**
1467 * The Amazon Resource Name (ARN) of the robot.
1468 */
1469 robot: Arn;
1470 }
1471 export interface RegisterRobotResponse {
1472 /**
1473 * The Amazon Resource Name (ARN) of the fleet that the robot will join.
1474 */
1475 fleet?: Arn;
1476 /**
1477 * Information about the robot registration.
1478 */
1479 robot?: Arn;
1480 }
1481 export interface RenderingEngine {
1482 /**
1483 * The name of the rendering engine.
1484 */
1485 name?: RenderingEngineType;
1486 /**
1487 * The version of the rendering engine.
1488 */
1489 version?: RenderingEngineVersionType;
1490 }
1491 export type RenderingEngineType = "OGRE"|string;
1492 export type RenderingEngineVersionType = string;
1493 export interface RestartSimulationJobRequest {
1494 /**
1495 * The Amazon Resource Name (ARN) of the simulation job.
1496 */
1497 job: Arn;
1498 }
1499 export interface RestartSimulationJobResponse {
1500 }
1501 export type RevisionId = string;
1502 export interface Robot {
1503 /**
1504 * The Amazon Resource Name (ARN) of the robot.
1505 */
1506 arn?: Arn;
1507 /**
1508 * The name of the robot.
1509 */
1510 name?: Name;
1511 /**
1512 * The Amazon Resource Name (ARN) of the fleet.
1513 */
1514 fleetArn?: Arn;
1515 /**
1516 * The status of the robot.
1517 */
1518 status?: RobotStatus;
1519 /**
1520 * The Greengrass group associated with the robot.
1521 */
1522 greenGrassGroupId?: Id;
1523 /**
1524 * The time, in milliseconds since the epoch, when the robot was created.
1525 */
1526 createdAt?: CreatedAt;
1527 /**
1528 * The architecture of the robot.
1529 */
1530 architecture?: Architecture;
1531 /**
1532 * The Amazon Resource Name (ARN) of the last deployment job.
1533 */
1534 lastDeploymentJob?: Arn;
1535 /**
1536 * The time of the last deployment.
1537 */
1538 lastDeploymentTime?: CreatedAt;
1539 }
1540 export interface RobotApplicationConfig {
1541 /**
1542 * The application information for the robot application.
1543 */
1544 application: Arn;
1545 /**
1546 * The version of the robot application.
1547 */
1548 applicationVersion?: Version;
1549 /**
1550 * The launch configuration for the robot application.
1551 */
1552 launchConfig: LaunchConfig;
1553 }
1554 export type RobotApplicationConfigs = RobotApplicationConfig[];
1555 export type RobotApplicationNames = Name[];
1556 export type RobotApplicationSummaries = RobotApplicationSummary[];
1557 export interface RobotApplicationSummary {
1558 /**
1559 * The name of the robot application.
1560 */
1561 name?: Name;
1562 /**
1563 * The Amazon Resource Name (ARN) of the robot.
1564 */
1565 arn?: Arn;
1566 /**
1567 * The version of the robot application.
1568 */
1569 version?: Version;
1570 /**
1571 * The time, in milliseconds since the epoch, when the robot application was last updated.
1572 */
1573 lastUpdatedAt?: LastUpdatedAt;
1574 }
1575 export interface RobotDeployment {
1576 /**
1577 * The robot deployment Amazon Resource Name (ARN).
1578 */
1579 arn?: Arn;
1580 /**
1581 * The time, in milliseconds since the epoch, when the deployment was started.
1582 */
1583 deploymentStartTime?: CreatedAt;
1584 /**
1585 * The time, in milliseconds since the epoch, when the deployment finished.
1586 */
1587 deploymentFinishTime?: CreatedAt;
1588 /**
1589 * The status of the robot deployment.
1590 */
1591 status?: RobotStatus;
1592 /**
1593 * Information about how the deployment is progressing.
1594 */
1595 progressDetail?: ProgressDetail;
1596 /**
1597 * A short description of the reason why the robot deployment failed.
1598 */
1599 failureReason?: GenericString;
1600 /**
1601 * The robot deployment failure code.
1602 */
1603 failureCode?: DeploymentJobErrorCode;
1604 }
1605 export type RobotDeploymentSummary = RobotDeployment[];
1606 export interface RobotSoftwareSuite {
1607 /**
1608 * The name of the robot software suite.
1609 */
1610 name?: RobotSoftwareSuiteType;
1611 /**
1612 * The version of the robot software suite.
1613 */
1614 version?: RobotSoftwareSuiteVersionType;
1615 }
1616 export type RobotSoftwareSuiteType = "ROS"|string;
1617 export type RobotSoftwareSuiteVersionType = "Kinetic"|string;
1618 export type RobotStatus = "Available"|"Registered"|"PendingNewDeployment"|"Deploying"|"Failed"|"InSync"|"NoResponse"|string;
1619 export type Robots = Robot[];
1620 export type S3Bucket = string;
1621 export type S3Etag = string;
1622 export type S3Key = string;
1623 export type SecurityGroups = GenericString[];
1624 export interface SimulationApplicationConfig {
1625 /**
1626 * The application information for the simulation application.
1627 */
1628 application: Arn;
1629 /**
1630 * The version of the simulation application.
1631 */
1632 applicationVersion?: Version;
1633 /**
1634 * The launch configuration for the simulation application.
1635 */
1636 launchConfig: LaunchConfig;
1637 }
1638 export type SimulationApplicationConfigs = SimulationApplicationConfig[];
1639 export type SimulationApplicationNames = Name[];
1640 export type SimulationApplicationSummaries = SimulationApplicationSummary[];
1641 export interface SimulationApplicationSummary {
1642 /**
1643 * The name of the simulation application.
1644 */
1645 name?: Name;
1646 /**
1647 * The Amazon Resource Name (ARN) of the simulation application.
1648 */
1649 arn?: Arn;
1650 /**
1651 * The version of the simulation application.
1652 */
1653 version?: Version;
1654 /**
1655 * The time, in milliseconds since the epoch, when the simulation application was last updated.
1656 */
1657 lastUpdatedAt?: LastUpdatedAt;
1658 }
1659 export interface SimulationJob {
1660 /**
1661 * The Amazon Resource Name (ARN) of the simulation job.
1662 */
1663 arn?: Arn;
1664 /**
1665 * The name of the simulation job.
1666 */
1667 name?: Name;
1668 /**
1669 * Status of the simulation job.
1670 */
1671 status?: SimulationJobStatus;
1672 /**
1673 * The time, in milliseconds since the epoch, when the simulation job was last updated.
1674 */
1675 lastUpdatedAt?: LastUpdatedAt;
1676 /**
1677 * 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.
1678 */
1679 failureBehavior?: FailureBehavior;
1680 /**
1681 * The failure code of the simulation job if it failed.
1682 */
1683 failureCode?: SimulationJobErrorCode;
1684 /**
1685 * The reason why the simulation job failed.
1686 */
1687 failureReason?: GenericString;
1688 /**
1689 * A unique identifier for this SimulationJob request.
1690 */
1691 clientRequestToken?: ClientRequestToken;
1692 /**
1693 * Location for output files generated by the simulation job.
1694 */
1695 outputLocation?: OutputLocation;
1696 /**
1697 * The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.
1698 */
1699 maxJobDurationInSeconds?: JobDuration;
1700 /**
1701 * The simulation job execution duration in milliseconds.
1702 */
1703 simulationTimeMillis?: SimulationTimeMillis;
1704 /**
1705 * 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. See how to specify AWS security credentials for your application.
1706 */
1707 iamRole?: IamRole;
1708 /**
1709 * A list of robot applications.
1710 */
1711 robotApplications?: RobotApplicationConfigs;
1712 /**
1713 * A list of simulation applications.
1714 */
1715 simulationApplications?: SimulationApplicationConfigs;
1716 /**
1717 * A map that contains tag keys and tag values that are attached to the simulation job.
1718 */
1719 tags?: TagMap;
1720 /**
1721 * VPC configuration information.
1722 */
1723 vpcConfig?: VPCConfigResponse;
1724 }
1725 export type SimulationJobErrorCode = "InternalServiceError"|"RobotApplicationCrash"|"SimulationApplicationCrash"|"BadPermissionsRobotApplication"|"BadPermissionsSimulationApplication"|"BadPermissionsS3Output"|"BadPermissionsCloudwatchLogs"|"SubnetIpLimitExceeded"|"ENILimitExceeded"|"BadPermissionsUserCredentials"|"InvalidBundleRobotApplication"|"InvalidBundleSimulationApplication"|"RobotApplicationVersionMismatchedEtag"|"SimulationApplicationVersionMismatchedEtag"|"WrongRegionS3Output"|"WrongRegionRobotApplication"|"WrongRegionSimulationApplication"|string;
1726 export type SimulationJobStatus = "Pending"|"Preparing"|"Running"|"Restarting"|"Completed"|"Failed"|"RunningFailed"|"Terminating"|"Terminated"|"Canceled"|string;
1727 export type SimulationJobSummaries = SimulationJobSummary[];
1728 export interface SimulationJobSummary {
1729 /**
1730 * The Amazon Resource Name (ARN) of the simulation job.
1731 */
1732 arn?: Arn;
1733 /**
1734 * The time, in milliseconds since the epoch, when the simulation job was last updated.
1735 */
1736 lastUpdatedAt?: LastUpdatedAt;
1737 /**
1738 * The name of the simulation job.
1739 */
1740 name?: Name;
1741 /**
1742 * The status of the simulation job.
1743 */
1744 status?: SimulationJobStatus;
1745 /**
1746 * A list of simulation job simulation application names.
1747 */
1748 simulationApplicationNames?: SimulationApplicationNames;
1749 /**
1750 * A list of simulation job robot application names.
1751 */
1752 robotApplicationNames?: RobotApplicationNames;
1753 }
1754 export type SimulationJobs = SimulationJob[];
1755 export interface SimulationSoftwareSuite {
1756 /**
1757 * The name of the simulation software suite.
1758 */
1759 name?: SimulationSoftwareSuiteType;
1760 /**
1761 * The version of the simulation software suite.
1762 */
1763 version?: SimulationSoftwareSuiteVersionType;
1764 }
1765 export type SimulationSoftwareSuiteType = "Gazebo"|string;
1766 export type SimulationSoftwareSuiteVersionType = string;
1767 export type SimulationTimeMillis = number;
1768 export interface Source {
1769 /**
1770 * The s3 bucket name.
1771 */
1772 s3Bucket?: S3Bucket;
1773 /**
1774 * The s3 object key.
1775 */
1776 s3Key?: S3Key;
1777 /**
1778 * A hash of the object specified by s3Bucket and s3Key.
1779 */
1780 etag?: S3Etag;
1781 /**
1782 * The taget processor architecture for the application.
1783 */
1784 architecture?: Architecture;
1785 }
1786 export interface SourceConfig {
1787 /**
1788 * The Amazon S3 bucket name.
1789 */
1790 s3Bucket?: S3Bucket;
1791 /**
1792 * The s3 object key.
1793 */
1794 s3Key?: S3Key;
1795 /**
1796 * The target processor architecture for the application.
1797 */
1798 architecture?: Architecture;
1799 }
1800 export type SourceConfigs = SourceConfig[];
1801 export type Sources = Source[];
1802 export type Subnets = GenericString[];
1803 export interface SyncDeploymentJobRequest {
1804 /**
1805 * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
1806 */
1807 clientRequestToken: ClientRequestToken;
1808 /**
1809 * The target fleet for the synchronization.
1810 */
1811 fleet: Arn;
1812 }
1813 export interface SyncDeploymentJobResponse {
1814 /**
1815 * The Amazon Resource Name (ARN) of the synchronization request.
1816 */
1817 arn?: Arn;
1818 /**
1819 * The Amazon Resource Name (ARN) of the fleet.
1820 */
1821 fleet?: Arn;
1822 /**
1823 * The status of the synchronization job.
1824 */
1825 status?: DeploymentStatus;
1826 /**
1827 * Information about the deployment configuration.
1828 */
1829 deploymentConfig?: DeploymentConfig;
1830 /**
1831 * Information about the deployment application configurations.
1832 */
1833 deploymentApplicationConfigs?: DeploymentApplicationConfigs;
1834 /**
1835 * The failure reason if the job fails.
1836 */
1837 failureReason?: GenericString;
1838 /**
1839 * 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.
1840 */
1841 failureCode?: DeploymentJobErrorCode;
1842 /**
1843 * The time, in milliseconds since the epoch, when the fleet was created.
1844 */
1845 createdAt?: CreatedAt;
1846 }
1847 export type TagKey = string;
1848 export type TagKeyList = TagKey[];
1849 export type TagMap = {[key: string]: TagValue};
1850 export interface TagResourceRequest {
1851 /**
1852 * The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are tagging.
1853 */
1854 resourceArn: Arn;
1855 /**
1856 * A map that contains tag keys and tag values that are attached to the resource.
1857 */
1858 tags: TagMap;
1859 }
1860 export interface TagResourceResponse {
1861 }
1862 export type TagValue = string;
1863 export interface UntagResourceRequest {
1864 /**
1865 * The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are removing tags.
1866 */
1867 resourceArn: Arn;
1868 /**
1869 * A map that contains tag keys and tag values that will be unattached from the resource.
1870 */
1871 tagKeys: TagKeyList;
1872 }
1873 export interface UntagResourceResponse {
1874 }
1875 export interface UpdateRobotApplicationRequest {
1876 /**
1877 * The application information for the robot application.
1878 */
1879 application: Arn;
1880 /**
1881 * The sources of the robot application.
1882 */
1883 sources: SourceConfigs;
1884 /**
1885 * The robot software suite used by the robot application.
1886 */
1887 robotSoftwareSuite: RobotSoftwareSuite;
1888 /**
1889 * The revision id for the robot application.
1890 */
1891 currentRevisionId?: RevisionId;
1892 }
1893 export interface UpdateRobotApplicationResponse {
1894 /**
1895 * The Amazon Resource Name (ARN) of the updated robot application.
1896 */
1897 arn?: Arn;
1898 /**
1899 * The name of the robot application.
1900 */
1901 name?: Name;
1902 /**
1903 * The version of the robot application.
1904 */
1905 version?: Version;
1906 /**
1907 * The sources of the robot application.
1908 */
1909 sources?: Sources;
1910 /**
1911 * The robot software suite used by the robot application.
1912 */
1913 robotSoftwareSuite?: RobotSoftwareSuite;
1914 /**
1915 * The time, in milliseconds since the epoch, when the robot application was last updated.
1916 */
1917 lastUpdatedAt?: LastUpdatedAt;
1918 /**
1919 * The revision id of the robot application.
1920 */
1921 revisionId?: RevisionId;
1922 }
1923 export interface UpdateSimulationApplicationRequest {
1924 /**
1925 * The application information for the simulation application.
1926 */
1927 application: Arn;
1928 /**
1929 * The sources of the simulation application.
1930 */
1931 sources: SourceConfigs;
1932 /**
1933 * The simulation software suite used by the simulation application.
1934 */
1935 simulationSoftwareSuite: SimulationSoftwareSuite;
1936 /**
1937 * Information about the robot software suite.
1938 */
1939 robotSoftwareSuite: RobotSoftwareSuite;
1940 /**
1941 * The rendering engine for the simulation application.
1942 */
1943 renderingEngine: RenderingEngine;
1944 /**
1945 * The revision id for the robot application.
1946 */
1947 currentRevisionId?: RevisionId;
1948 }
1949 export interface UpdateSimulationApplicationResponse {
1950 /**
1951 * The Amazon Resource Name (ARN) of the updated simulation application.
1952 */
1953 arn?: Arn;
1954 /**
1955 * The name of the simulation application.
1956 */
1957 name?: Name;
1958 /**
1959 * The version of the robot application.
1960 */
1961 version?: Version;
1962 /**
1963 * The sources of the simulation application.
1964 */
1965 sources?: Sources;
1966 /**
1967 * The simulation software suite used by the simulation application.
1968 */
1969 simulationSoftwareSuite?: SimulationSoftwareSuite;
1970 /**
1971 * Information about the robot software suite.
1972 */
1973 robotSoftwareSuite?: RobotSoftwareSuite;
1974 /**
1975 * The rendering engine for the simulation application.
1976 */
1977 renderingEngine?: RenderingEngine;
1978 /**
1979 * The time, in milliseconds since the epoch, when the simulation application was last updated.
1980 */
1981 lastUpdatedAt?: LastUpdatedAt;
1982 /**
1983 * The revision id of the simulation application.
1984 */
1985 revisionId?: RevisionId;
1986 }
1987 export interface VPCConfig {
1988 /**
1989 * A list of one or more subnet IDs in your VPC.
1990 */
1991 subnets: Subnets;
1992 /**
1993 * A list of one or more security groups IDs in your VPC.
1994 */
1995 securityGroups?: SecurityGroups;
1996 /**
1997 * A boolean indicating whether to assign a public IP address.
1998 */
1999 assignPublicIp?: Boolean;
2000 }
2001 export interface VPCConfigResponse {
2002 /**
2003 * A list of subnet IDs associated with the simulation job.
2004 */
2005 subnets?: Subnets;
2006 /**
2007 * A list of security group IDs associated with the simulation job.
2008 */
2009 securityGroups?: SecurityGroups;
2010 /**
2011 * The VPC ID associated with your simulation job.
2012 */
2013 vpcId?: GenericString;
2014 /**
2015 * A boolean indicating if a public IP was assigned.
2016 */
2017 assignPublicIp?: Boolean;
2018 }
2019 export type Version = string;
2020 export type VersionQualifier = string;
2021 /**
2022 * 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.
2023 */
2024 export type apiVersion = "2018-06-29"|"latest"|string;
2025 export interface ClientApiVersions {
2026 /**
2027 * 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.
2028 */
2029 apiVersion?: apiVersion;
2030 }
2031 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
2032 /**
2033 * Contains interfaces for use with the RoboMaker client.
2034 */
2035 export import Types = RoboMaker;
2036}
2037export = RoboMaker;