UNPKG

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