UNPKG

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