1 | import {Request} from '../lib/request';
|
2 | import {Response} from '../lib/response';
|
3 | import {AWSError} from '../lib/error';
|
4 | import {Service} from '../lib/service';
|
5 | import {ServiceConfigurationOptions} from '../lib/service';
|
6 | import {ConfigBase as Config} from '../lib/config';
|
7 | interface Blob {}
|
8 | declare class IoT1ClickProjects extends Service {
|
9 | |
10 |
|
11 |
|
12 | constructor(options?: IoT1ClickProjects.Types.ClientConfiguration)
|
13 | config: Config & IoT1ClickProjects.Types.ClientConfiguration;
|
14 | /**
|
15 | * Associates a physical device with a placement.
|
16 | */
|
17 | associateDeviceWithPlacement(params: IoT1ClickProjects.Types.AssociateDeviceWithPlacementRequest, callback?: (err: AWSError, data: IoT1ClickProjects.Types.AssociateDeviceWithPlacementResponse) => void): Request<IoT1ClickProjects.Types.AssociateDeviceWithPlacementResponse, AWSError>;
|
18 | /**
|
19 | * Associates a physical device with a placement.
|
20 | */
|
21 | associateDeviceWithPlacement(callback?: (err: AWSError, data: IoT1ClickProjects.Types.AssociateDeviceWithPlacementResponse) => void): Request<IoT1ClickProjects.Types.AssociateDeviceWithPlacementResponse, AWSError>;
|
22 | /**
|
23 | * Creates an empty placement.
|
24 | */
|
25 | createPlacement(params: IoT1ClickProjects.Types.CreatePlacementRequest, callback?: (err: AWSError, data: IoT1ClickProjects.Types.CreatePlacementResponse) => void): Request<IoT1ClickProjects.Types.CreatePlacementResponse, AWSError>;
|
26 | /**
|
27 | * Creates an empty placement.
|
28 | */
|
29 | createPlacement(callback?: (err: AWSError, data: IoT1ClickProjects.Types.CreatePlacementResponse) => void): Request<IoT1ClickProjects.Types.CreatePlacementResponse, AWSError>;
|
30 | /**
|
31 | * Creates an empty project with a placement template. A project contains zero or more placements that adhere to the placement template defined in the project.
|
32 | */
|
33 | createProject(params: IoT1ClickProjects.Types.CreateProjectRequest, callback?: (err: AWSError, data: IoT1ClickProjects.Types.CreateProjectResponse) => void): Request<IoT1ClickProjects.Types.CreateProjectResponse, AWSError>;
|
34 | /**
|
35 | * Creates an empty project with a placement template. A project contains zero or more placements that adhere to the placement template defined in the project.
|
36 | */
|
37 | createProject(callback?: (err: AWSError, data: IoT1ClickProjects.Types.CreateProjectResponse) => void): Request<IoT1ClickProjects.Types.CreateProjectResponse, AWSError>;
|
38 | /**
|
39 | * Deletes a placement. To delete a placement, it must not have any devices associated with it. When you delete a placement, all associated data becomes irretrievable.
|
40 | */
|
41 | deletePlacement(params: IoT1ClickProjects.Types.DeletePlacementRequest, callback?: (err: AWSError, data: IoT1ClickProjects.Types.DeletePlacementResponse) => void): Request<IoT1ClickProjects.Types.DeletePlacementResponse, AWSError>;
|
42 | /**
|
43 | * Deletes a placement. To delete a placement, it must not have any devices associated with it. When you delete a placement, all associated data becomes irretrievable.
|
44 | */
|
45 | deletePlacement(callback?: (err: AWSError, data: IoT1ClickProjects.Types.DeletePlacementResponse) => void): Request<IoT1ClickProjects.Types.DeletePlacementResponse, AWSError>;
|
46 | /**
|
47 | * Deletes a project. To delete a project, it must not have any placements associated with it. When you delete a project, all associated data becomes irretrievable.
|
48 | */
|
49 | deleteProject(params: IoT1ClickProjects.Types.DeleteProjectRequest, callback?: (err: AWSError, data: IoT1ClickProjects.Types.DeleteProjectResponse) => void): Request<IoT1ClickProjects.Types.DeleteProjectResponse, AWSError>;
|
50 | /**
|
51 | * Deletes a project. To delete a project, it must not have any placements associated with it. When you delete a project, all associated data becomes irretrievable.
|
52 | */
|
53 | deleteProject(callback?: (err: AWSError, data: IoT1ClickProjects.Types.DeleteProjectResponse) => void): Request<IoT1ClickProjects.Types.DeleteProjectResponse, AWSError>;
|
54 | /**
|
55 | * Describes a placement in a project.
|
56 | */
|
57 | describePlacement(params: IoT1ClickProjects.Types.DescribePlacementRequest, callback?: (err: AWSError, data: IoT1ClickProjects.Types.DescribePlacementResponse) => void): Request<IoT1ClickProjects.Types.DescribePlacementResponse, AWSError>;
|
58 | /**
|
59 | * Describes a placement in a project.
|
60 | */
|
61 | describePlacement(callback?: (err: AWSError, data: IoT1ClickProjects.Types.DescribePlacementResponse) => void): Request<IoT1ClickProjects.Types.DescribePlacementResponse, AWSError>;
|
62 | /**
|
63 | * Returns an object describing a project.
|
64 | */
|
65 | describeProject(params: IoT1ClickProjects.Types.DescribeProjectRequest, callback?: (err: AWSError, data: IoT1ClickProjects.Types.DescribeProjectResponse) => void): Request<IoT1ClickProjects.Types.DescribeProjectResponse, AWSError>;
|
66 | /**
|
67 | * Returns an object describing a project.
|
68 | */
|
69 | describeProject(callback?: (err: AWSError, data: IoT1ClickProjects.Types.DescribeProjectResponse) => void): Request<IoT1ClickProjects.Types.DescribeProjectResponse, AWSError>;
|
70 | /**
|
71 | * Removes a physical device from a placement.
|
72 | */
|
73 | disassociateDeviceFromPlacement(params: IoT1ClickProjects.Types.DisassociateDeviceFromPlacementRequest, callback?: (err: AWSError, data: IoT1ClickProjects.Types.DisassociateDeviceFromPlacementResponse) => void): Request<IoT1ClickProjects.Types.DisassociateDeviceFromPlacementResponse, AWSError>;
|
74 | /**
|
75 | * Removes a physical device from a placement.
|
76 | */
|
77 | disassociateDeviceFromPlacement(callback?: (err: AWSError, data: IoT1ClickProjects.Types.DisassociateDeviceFromPlacementResponse) => void): Request<IoT1ClickProjects.Types.DisassociateDeviceFromPlacementResponse, AWSError>;
|
78 | /**
|
79 | * Returns an object enumerating the devices in a placement.
|
80 | */
|
81 | getDevicesInPlacement(params: IoT1ClickProjects.Types.GetDevicesInPlacementRequest, callback?: (err: AWSError, data: IoT1ClickProjects.Types.GetDevicesInPlacementResponse) => void): Request<IoT1ClickProjects.Types.GetDevicesInPlacementResponse, AWSError>;
|
82 | /**
|
83 | * Returns an object enumerating the devices in a placement.
|
84 | */
|
85 | getDevicesInPlacement(callback?: (err: AWSError, data: IoT1ClickProjects.Types.GetDevicesInPlacementResponse) => void): Request<IoT1ClickProjects.Types.GetDevicesInPlacementResponse, AWSError>;
|
86 | /**
|
87 | * Lists the placement(s) of a project.
|
88 | */
|
89 | listPlacements(params: IoT1ClickProjects.Types.ListPlacementsRequest, callback?: (err: AWSError, data: IoT1ClickProjects.Types.ListPlacementsResponse) => void): Request<IoT1ClickProjects.Types.ListPlacementsResponse, AWSError>;
|
90 | /**
|
91 | * Lists the placement(s) of a project.
|
92 | */
|
93 | listPlacements(callback?: (err: AWSError, data: IoT1ClickProjects.Types.ListPlacementsResponse) => void): Request<IoT1ClickProjects.Types.ListPlacementsResponse, AWSError>;
|
94 | /**
|
95 | * Lists the AWS IoT 1-Click project(s) associated with your AWS account and region.
|
96 | */
|
97 | listProjects(params: IoT1ClickProjects.Types.ListProjectsRequest, callback?: (err: AWSError, data: IoT1ClickProjects.Types.ListProjectsResponse) => void): Request<IoT1ClickProjects.Types.ListProjectsResponse, AWSError>;
|
98 | /**
|
99 | * Lists the AWS IoT 1-Click project(s) associated with your AWS account and region.
|
100 | */
|
101 | listProjects(callback?: (err: AWSError, data: IoT1ClickProjects.Types.ListProjectsResponse) => void): Request<IoT1ClickProjects.Types.ListProjectsResponse, AWSError>;
|
102 | /**
|
103 | * Lists the tags (metadata key/value pairs) which you have assigned to the resource.
|
104 | */
|
105 | listTagsForResource(params: IoT1ClickProjects.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: IoT1ClickProjects.Types.ListTagsForResourceResponse) => void): Request<IoT1ClickProjects.Types.ListTagsForResourceResponse, AWSError>;
|
106 | /**
|
107 | * Lists the tags (metadata key/value pairs) which you have assigned to the resource.
|
108 | */
|
109 | listTagsForResource(callback?: (err: AWSError, data: IoT1ClickProjects.Types.ListTagsForResourceResponse) => void): Request<IoT1ClickProjects.Types.ListTagsForResourceResponse, AWSError>;
|
110 | /**
|
111 | * Creates or modifies tags for a resource. Tags are key/value pairs (metadata) that can be used to manage a resource. For more information, see AWS Tagging Strategies.
|
112 | */
|
113 | tagResource(params: IoT1ClickProjects.Types.TagResourceRequest, callback?: (err: AWSError, data: IoT1ClickProjects.Types.TagResourceResponse) => void): Request<IoT1ClickProjects.Types.TagResourceResponse, AWSError>;
|
114 | /**
|
115 | * Creates or modifies tags for a resource. Tags are key/value pairs (metadata) that can be used to manage a resource. For more information, see AWS Tagging Strategies.
|
116 | */
|
117 | tagResource(callback?: (err: AWSError, data: IoT1ClickProjects.Types.TagResourceResponse) => void): Request<IoT1ClickProjects.Types.TagResourceResponse, AWSError>;
|
118 | /**
|
119 | * Removes one or more tags (metadata key/value pairs) from a resource.
|
120 | */
|
121 | untagResource(params: IoT1ClickProjects.Types.UntagResourceRequest, callback?: (err: AWSError, data: IoT1ClickProjects.Types.UntagResourceResponse) => void): Request<IoT1ClickProjects.Types.UntagResourceResponse, AWSError>;
|
122 | /**
|
123 | * Removes one or more tags (metadata key/value pairs) from a resource.
|
124 | */
|
125 | untagResource(callback?: (err: AWSError, data: IoT1ClickProjects.Types.UntagResourceResponse) => void): Request<IoT1ClickProjects.Types.UntagResourceResponse, AWSError>;
|
126 | /**
|
127 | * Updates a placement with the given attributes. To clear an attribute, pass an empty value (i.e., "").
|
128 | */
|
129 | updatePlacement(params: IoT1ClickProjects.Types.UpdatePlacementRequest, callback?: (err: AWSError, data: IoT1ClickProjects.Types.UpdatePlacementResponse) => void): Request<IoT1ClickProjects.Types.UpdatePlacementResponse, AWSError>;
|
130 | /**
|
131 | * Updates a placement with the given attributes. To clear an attribute, pass an empty value (i.e., "").
|
132 | */
|
133 | updatePlacement(callback?: (err: AWSError, data: IoT1ClickProjects.Types.UpdatePlacementResponse) => void): Request<IoT1ClickProjects.Types.UpdatePlacementResponse, AWSError>;
|
134 | /**
|
135 | * Updates a project associated with your AWS account and region. With the exception of device template names, you can pass just the values that need to be updated because the update request will change only the values that are provided. To clear a value, pass the empty string (i.e., "").
|
136 | */
|
137 | updateProject(params: IoT1ClickProjects.Types.UpdateProjectRequest, callback?: (err: AWSError, data: IoT1ClickProjects.Types.UpdateProjectResponse) => void): Request<IoT1ClickProjects.Types.UpdateProjectResponse, AWSError>;
|
138 | /**
|
139 | * Updates a project associated with your AWS account and region. With the exception of device template names, you can pass just the values that need to be updated because the update request will change only the values that are provided. To clear a value, pass the empty string (i.e., "").
|
140 | */
|
141 | updateProject(callback?: (err: AWSError, data: IoT1ClickProjects.Types.UpdateProjectResponse) => void): Request<IoT1ClickProjects.Types.UpdateProjectResponse, AWSError>;
|
142 | }
|
143 | declare namespace IoT1ClickProjects {
|
144 | export interface AssociateDeviceWithPlacementRequest {
|
145 | |
146 |
|
147 |
|
148 | projectName: ProjectName;
|
149 | |
150 |
|
151 |
|
152 | placementName: PlacementName;
|
153 | |
154 |
|
155 |
|
156 | deviceId: DeviceId;
|
157 | |
158 |
|
159 |
|
160 | deviceTemplateName: DeviceTemplateName;
|
161 | }
|
162 | export interface AssociateDeviceWithPlacementResponse {
|
163 | }
|
164 | export type AttributeDefaultValue = string;
|
165 | export type AttributeName = string;
|
166 | export type AttributeValue = string;
|
167 | export interface CreatePlacementRequest {
|
168 | |
169 |
|
170 |
|
171 | placementName: PlacementName;
|
172 | |
173 |
|
174 |
|
175 | projectName: ProjectName;
|
176 | |
177 |
|
178 |
|
179 | attributes?: PlacementAttributeMap;
|
180 | }
|
181 | export interface CreatePlacementResponse {
|
182 | }
|
183 | export interface CreateProjectRequest {
|
184 | |
185 |
|
186 |
|
187 | projectName: ProjectName;
|
188 | |
189 |
|
190 |
|
191 | description?: Description;
|
192 | |
193 |
|
194 |
|
195 | placementTemplate?: PlacementTemplate;
|
196 | |
197 |
|
198 |
|
199 | tags?: TagMap;
|
200 | }
|
201 | export interface CreateProjectResponse {
|
202 | }
|
203 | export type DefaultPlacementAttributeMap = {[key: string]: AttributeDefaultValue};
|
204 | export interface DeletePlacementRequest {
|
205 | |
206 |
|
207 |
|
208 | placementName: PlacementName;
|
209 | |
210 |
|
211 |
|
212 | projectName: ProjectName;
|
213 | }
|
214 | export interface DeletePlacementResponse {
|
215 | }
|
216 | export interface DeleteProjectRequest {
|
217 | |
218 |
|
219 |
|
220 | projectName: ProjectName;
|
221 | }
|
222 | export interface DeleteProjectResponse {
|
223 | }
|
224 | export interface DescribePlacementRequest {
|
225 | |
226 |
|
227 |
|
228 | placementName: PlacementName;
|
229 | |
230 |
|
231 |
|
232 | projectName: ProjectName;
|
233 | }
|
234 | export interface DescribePlacementResponse {
|
235 | |
236 |
|
237 |
|
238 | placement: PlacementDescription;
|
239 | }
|
240 | export interface DescribeProjectRequest {
|
241 | |
242 |
|
243 |
|
244 | projectName: ProjectName;
|
245 | }
|
246 | export interface DescribeProjectResponse {
|
247 | |
248 |
|
249 |
|
250 | project: ProjectDescription;
|
251 | }
|
252 | export type Description = string;
|
253 | export type DeviceCallbackKey = string;
|
254 | export type DeviceCallbackOverrideMap = {[key: string]: DeviceCallbackValue};
|
255 | export type DeviceCallbackValue = string;
|
256 | export type DeviceId = string;
|
257 | export type DeviceMap = {[key: string]: DeviceId};
|
258 | export interface DeviceTemplate {
|
259 | |
260 |
|
261 |
|
262 | deviceType?: DeviceType;
|
263 | |
264 |
|
265 |
|
266 | callbackOverrides?: DeviceCallbackOverrideMap;
|
267 | }
|
268 | export type DeviceTemplateMap = {[key: string]: DeviceTemplate};
|
269 | export type DeviceTemplateName = string;
|
270 | export type DeviceType = string;
|
271 | export interface DisassociateDeviceFromPlacementRequest {
|
272 | |
273 |
|
274 |
|
275 | projectName: ProjectName;
|
276 | |
277 |
|
278 |
|
279 | placementName: PlacementName;
|
280 | |
281 |
|
282 |
|
283 | deviceTemplateName: DeviceTemplateName;
|
284 | }
|
285 | export interface DisassociateDeviceFromPlacementResponse {
|
286 | }
|
287 | export interface GetDevicesInPlacementRequest {
|
288 | |
289 |
|
290 |
|
291 | projectName: ProjectName;
|
292 | |
293 |
|
294 |
|
295 | placementName: PlacementName;
|
296 | }
|
297 | export interface GetDevicesInPlacementResponse {
|
298 | |
299 |
|
300 |
|
301 | devices: DeviceMap;
|
302 | }
|
303 | export interface ListPlacementsRequest {
|
304 | |
305 |
|
306 |
|
307 | projectName: ProjectName;
|
308 | |
309 |
|
310 |
|
311 | nextToken?: NextToken;
|
312 | |
313 |
|
314 |
|
315 | maxResults?: MaxResults;
|
316 | }
|
317 | export interface ListPlacementsResponse {
|
318 | |
319 |
|
320 |
|
321 | placements: PlacementSummaryList;
|
322 | |
323 |
|
324 |
|
325 | nextToken?: NextToken;
|
326 | }
|
327 | export interface ListProjectsRequest {
|
328 | |
329 |
|
330 |
|
331 | nextToken?: NextToken;
|
332 | |
333 |
|
334 |
|
335 | maxResults?: MaxResults;
|
336 | }
|
337 | export interface ListProjectsResponse {
|
338 | |
339 |
|
340 |
|
341 | projects: ProjectSummaryList;
|
342 | |
343 |
|
344 |
|
345 | nextToken?: NextToken;
|
346 | }
|
347 | export interface ListTagsForResourceRequest {
|
348 | |
349 |
|
350 |
|
351 | resourceArn: ProjectArn;
|
352 | }
|
353 | export interface ListTagsForResourceResponse {
|
354 | |
355 |
|
356 |
|
357 | tags?: TagMap;
|
358 | }
|
359 | export type MaxResults = number;
|
360 | export type NextToken = string;
|
361 | export type PlacementAttributeMap = {[key: string]: AttributeValue};
|
362 | export interface PlacementDescription {
|
363 | |
364 |
|
365 |
|
366 | projectName: ProjectName;
|
367 | |
368 |
|
369 |
|
370 | placementName: PlacementName;
|
371 | |
372 |
|
373 |
|
374 | attributes: PlacementAttributeMap;
|
375 | |
376 |
|
377 |
|
378 | createdDate: Time;
|
379 | |
380 |
|
381 |
|
382 | updatedDate: Time;
|
383 | }
|
384 | export type PlacementName = string;
|
385 | export interface PlacementSummary {
|
386 | |
387 |
|
388 |
|
389 | projectName: ProjectName;
|
390 | |
391 |
|
392 |
|
393 | placementName: PlacementName;
|
394 | |
395 |
|
396 |
|
397 | createdDate: Time;
|
398 | |
399 |
|
400 |
|
401 | updatedDate: Time;
|
402 | }
|
403 | export type PlacementSummaryList = PlacementSummary[];
|
404 | export interface PlacementTemplate {
|
405 | |
406 |
|
407 |
|
408 | defaultAttributes?: DefaultPlacementAttributeMap;
|
409 | |
410 |
|
411 |
|
412 | deviceTemplates?: DeviceTemplateMap;
|
413 | }
|
414 | export type ProjectArn = string;
|
415 | export interface ProjectDescription {
|
416 | |
417 |
|
418 |
|
419 | arn?: ProjectArn;
|
420 | |
421 |
|
422 |
|
423 | projectName: ProjectName;
|
424 | |
425 |
|
426 |
|
427 | description?: Description;
|
428 | |
429 |
|
430 |
|
431 | createdDate: Time;
|
432 | |
433 |
|
434 |
|
435 | updatedDate: Time;
|
436 | |
437 |
|
438 |
|
439 | placementTemplate?: PlacementTemplate;
|
440 | |
441 |
|
442 |
|
443 | tags?: TagMap;
|
444 | }
|
445 | export type ProjectName = string;
|
446 | export interface ProjectSummary {
|
447 | |
448 |
|
449 |
|
450 | arn?: ProjectArn;
|
451 | |
452 |
|
453 |
|
454 | projectName: ProjectName;
|
455 | |
456 |
|
457 |
|
458 | createdDate: Time;
|
459 | |
460 |
|
461 |
|
462 | updatedDate: Time;
|
463 | |
464 |
|
465 |
|
466 | tags?: TagMap;
|
467 | }
|
468 | export type ProjectSummaryList = ProjectSummary[];
|
469 | export type TagKey = string;
|
470 | export type TagKeyList = TagKey[];
|
471 | export type TagMap = {[key: string]: TagValue};
|
472 | export interface TagResourceRequest {
|
473 | |
474 |
|
475 |
|
476 | resourceArn: ProjectArn;
|
477 | |
478 |
|
479 |
|
480 | tags: TagMap;
|
481 | }
|
482 | export interface TagResourceResponse {
|
483 | }
|
484 | export type TagValue = string;
|
485 | export type Time = Date;
|
486 | export interface UntagResourceRequest {
|
487 | |
488 |
|
489 |
|
490 | resourceArn: ProjectArn;
|
491 | |
492 |
|
493 |
|
494 | tagKeys: TagKeyList;
|
495 | }
|
496 | export interface UntagResourceResponse {
|
497 | }
|
498 | export interface UpdatePlacementRequest {
|
499 | |
500 |
|
501 |
|
502 | placementName: PlacementName;
|
503 | |
504 |
|
505 |
|
506 | projectName: ProjectName;
|
507 | |
508 |
|
509 |
|
510 | attributes?: PlacementAttributeMap;
|
511 | }
|
512 | export interface UpdatePlacementResponse {
|
513 | }
|
514 | export interface UpdateProjectRequest {
|
515 | |
516 |
|
517 |
|
518 | projectName: ProjectName;
|
519 | |
520 |
|
521 |
|
522 | description?: Description;
|
523 | |
524 |
|
525 |
|
526 | placementTemplate?: PlacementTemplate;
|
527 | }
|
528 | export interface UpdateProjectResponse {
|
529 | }
|
530 | |
531 |
|
532 |
|
533 | export type apiVersion = "2018-05-14"|"latest"|string;
|
534 | export interface ClientApiVersions {
|
535 | |
536 |
|
537 |
|
538 | apiVersion?: apiVersion;
|
539 | }
|
540 | export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
|
541 | |
542 |
|
543 |
|
544 | export import Types = IoT1ClickProjects;
|
545 | }
|
546 | export = IoT1ClickProjects;
|