@aws-sdk/client-greengrassv2 3.35.0 → 3.38.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (256) hide show
  1. package/CHANGELOG.md +47 -0
  2. package/dist-cjs/GreengrassV2.js +0 -14
  3. package/dist-cjs/GreengrassV2Client.js +0 -19
  4. package/dist-cjs/commands/BatchAssociateClientDeviceWithCoreDeviceCommand.js +0 -37
  5. package/dist-cjs/commands/BatchDisassociateClientDeviceFromCoreDeviceCommand.js +0 -27
  6. package/dist-cjs/commands/CancelDeploymentCommand.js +0 -27
  7. package/dist-cjs/commands/CreateComponentVersionCommand.js +0 -78
  8. package/dist-cjs/commands/CreateDeploymentCommand.js +0 -35
  9. package/dist-cjs/commands/DeleteComponentCommand.js +0 -31
  10. package/dist-cjs/commands/DeleteCoreDeviceCommand.js +0 -28
  11. package/dist-cjs/commands/DescribeComponentCommand.js +0 -25
  12. package/dist-cjs/commands/GetComponentCommand.js +0 -26
  13. package/dist-cjs/commands/GetComponentVersionArtifactCommand.js +0 -26
  14. package/dist-cjs/commands/GetCoreDeviceCommand.js +0 -25
  15. package/dist-cjs/commands/GetDeploymentCommand.js +0 -25
  16. package/dist-cjs/commands/ListClientDevicesAssociatedWithCoreDeviceCommand.js +0 -26
  17. package/dist-cjs/commands/ListComponentVersionsCommand.js +0 -25
  18. package/dist-cjs/commands/ListComponentsCommand.js +0 -26
  19. package/dist-cjs/commands/ListCoreDevicesCommand.js +0 -25
  20. package/dist-cjs/commands/ListDeploymentsCommand.js +0 -25
  21. package/dist-cjs/commands/ListEffectiveDeploymentsCommand.js +0 -26
  22. package/dist-cjs/commands/ListInstalledComponentsCommand.js +0 -25
  23. package/dist-cjs/commands/ListTagsForResourceCommand.js +0 -25
  24. package/dist-cjs/commands/ResolveComponentCandidatesCommand.js +0 -39
  25. package/dist-cjs/commands/TagResourceCommand.js +0 -26
  26. package/dist-cjs/commands/UntagResourceCommand.js +0 -25
  27. package/dist-cjs/commands/index.js +26 -0
  28. package/dist-cjs/endpoints.js +1 -2
  29. package/dist-cjs/index.js +4 -34
  30. package/dist-cjs/models/index.js +0 -1
  31. package/dist-cjs/models/models_0.js +0 -274
  32. package/dist-cjs/pagination/Interfaces.js +0 -1
  33. package/dist-cjs/pagination/ListClientDevicesAssociatedWithCoreDevicePaginator.js +0 -11
  34. package/dist-cjs/pagination/ListComponentVersionsPaginator.js +0 -11
  35. package/dist-cjs/pagination/ListComponentsPaginator.js +0 -11
  36. package/dist-cjs/pagination/ListCoreDevicesPaginator.js +0 -11
  37. package/dist-cjs/pagination/ListDeploymentsPaginator.js +0 -11
  38. package/dist-cjs/pagination/ListEffectiveDeploymentsPaginator.js +0 -11
  39. package/dist-cjs/pagination/ListInstalledComponentsPaginator.js +0 -11
  40. package/dist-cjs/pagination/index.js +11 -0
  41. package/dist-cjs/protocols/Aws_restJson1.js +0 -6
  42. package/dist-cjs/runtimeConfig.browser.js +1 -6
  43. package/dist-cjs/runtimeConfig.js +2 -7
  44. package/dist-cjs/runtimeConfig.native.js +0 -4
  45. package/dist-cjs/runtimeConfig.shared.js +0 -4
  46. package/dist-es/GreengrassV2.js +0 -1
  47. package/dist-es/GreengrassV2Client.js +0 -1
  48. package/dist-es/commands/BatchAssociateClientDeviceWithCoreDeviceCommand.js +0 -1
  49. package/dist-es/commands/BatchDisassociateClientDeviceFromCoreDeviceCommand.js +0 -1
  50. package/dist-es/commands/CancelDeploymentCommand.js +0 -1
  51. package/dist-es/commands/CreateComponentVersionCommand.js +0 -1
  52. package/dist-es/commands/CreateDeploymentCommand.js +0 -1
  53. package/dist-es/commands/DeleteComponentCommand.js +0 -1
  54. package/dist-es/commands/DeleteCoreDeviceCommand.js +0 -1
  55. package/dist-es/commands/DescribeComponentCommand.js +0 -1
  56. package/dist-es/commands/GetComponentCommand.js +0 -1
  57. package/dist-es/commands/GetComponentVersionArtifactCommand.js +0 -1
  58. package/dist-es/commands/GetCoreDeviceCommand.js +0 -1
  59. package/dist-es/commands/GetDeploymentCommand.js +0 -1
  60. package/dist-es/commands/ListClientDevicesAssociatedWithCoreDeviceCommand.js +0 -1
  61. package/dist-es/commands/ListComponentVersionsCommand.js +0 -1
  62. package/dist-es/commands/ListComponentsCommand.js +0 -1
  63. package/dist-es/commands/ListCoreDevicesCommand.js +0 -1
  64. package/dist-es/commands/ListDeploymentsCommand.js +0 -1
  65. package/dist-es/commands/ListEffectiveDeploymentsCommand.js +0 -1
  66. package/dist-es/commands/ListInstalledComponentsCommand.js +0 -1
  67. package/dist-es/commands/ListTagsForResourceCommand.js +0 -1
  68. package/dist-es/commands/ResolveComponentCandidatesCommand.js +0 -1
  69. package/dist-es/commands/TagResourceCommand.js +0 -1
  70. package/dist-es/commands/UntagResourceCommand.js +0 -1
  71. package/dist-es/commands/index.js +23 -0
  72. package/dist-es/endpoints.js +1 -2
  73. package/dist-es/index.js +4 -34
  74. package/dist-es/models/index.js +0 -1
  75. package/dist-es/models/models_0.js +0 -1
  76. package/dist-es/pagination/Interfaces.js +0 -1
  77. package/dist-es/pagination/ListClientDevicesAssociatedWithCoreDevicePaginator.js +0 -1
  78. package/dist-es/pagination/ListComponentVersionsPaginator.js +0 -1
  79. package/dist-es/pagination/ListComponentsPaginator.js +0 -1
  80. package/dist-es/pagination/ListCoreDevicesPaginator.js +0 -1
  81. package/dist-es/pagination/ListDeploymentsPaginator.js +0 -1
  82. package/dist-es/pagination/ListEffectiveDeploymentsPaginator.js +0 -1
  83. package/dist-es/pagination/ListInstalledComponentsPaginator.js +0 -1
  84. package/dist-es/pagination/index.js +8 -0
  85. package/dist-es/protocols/Aws_restJson1.js +0 -1
  86. package/dist-es/runtimeConfig.browser.js +1 -2
  87. package/dist-es/runtimeConfig.js +2 -3
  88. package/dist-es/runtimeConfig.native.js +0 -1
  89. package/dist-es/runtimeConfig.shared.js +0 -1
  90. package/dist-types/commands/index.d.ts +23 -0
  91. package/dist-types/index.d.ts +4 -33
  92. package/dist-types/pagination/index.d.ts +8 -0
  93. package/dist-types/ts3.4/GreengrassV2.d.ts +24 -190
  94. package/dist-types/ts3.4/GreengrassV2Client.d.ts +24 -99
  95. package/dist-types/ts3.4/commands/BatchAssociateClientDeviceWithCoreDeviceCommand.d.ts +2 -32
  96. package/dist-types/ts3.4/commands/BatchDisassociateClientDeviceFromCoreDeviceCommand.d.ts +2 -22
  97. package/dist-types/ts3.4/commands/CancelDeploymentCommand.d.ts +2 -22
  98. package/dist-types/ts3.4/commands/CreateComponentVersionCommand.d.ts +2 -73
  99. package/dist-types/ts3.4/commands/CreateDeploymentCommand.d.ts +2 -30
  100. package/dist-types/ts3.4/commands/DeleteComponentCommand.d.ts +2 -26
  101. package/dist-types/ts3.4/commands/DeleteCoreDeviceCommand.d.ts +2 -23
  102. package/dist-types/ts3.4/commands/DescribeComponentCommand.d.ts +2 -20
  103. package/dist-types/ts3.4/commands/GetComponentCommand.d.ts +2 -21
  104. package/dist-types/ts3.4/commands/GetComponentVersionArtifactCommand.d.ts +2 -21
  105. package/dist-types/ts3.4/commands/GetCoreDeviceCommand.d.ts +2 -20
  106. package/dist-types/ts3.4/commands/GetDeploymentCommand.d.ts +2 -20
  107. package/dist-types/ts3.4/commands/ListClientDevicesAssociatedWithCoreDeviceCommand.d.ts +2 -21
  108. package/dist-types/ts3.4/commands/ListComponentVersionsCommand.d.ts +2 -20
  109. package/dist-types/ts3.4/commands/ListComponentsCommand.d.ts +2 -21
  110. package/dist-types/ts3.4/commands/ListCoreDevicesCommand.d.ts +2 -20
  111. package/dist-types/ts3.4/commands/ListDeploymentsCommand.d.ts +2 -20
  112. package/dist-types/ts3.4/commands/ListEffectiveDeploymentsCommand.d.ts +2 -21
  113. package/dist-types/ts3.4/commands/ListInstalledComponentsCommand.d.ts +2 -20
  114. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +2 -20
  115. package/dist-types/ts3.4/commands/ResolveComponentCandidatesCommand.d.ts +2 -34
  116. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +2 -21
  117. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +2 -20
  118. package/dist-types/ts3.4/commands/index.d.ts +23 -0
  119. package/dist-types/ts3.4/index.d.ts +4 -33
  120. package/dist-types/ts3.4/models/models_0.d.ts +393 -1492
  121. package/dist-types/ts3.4/pagination/index.d.ts +8 -0
  122. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
  123. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
  124. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
  125. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
  126. package/package.json +33 -30
  127. package/dist-cjs/GreengrassV2.js.map +0 -1
  128. package/dist-cjs/GreengrassV2Client.js.map +0 -1
  129. package/dist-cjs/commands/BatchAssociateClientDeviceWithCoreDeviceCommand.js.map +0 -1
  130. package/dist-cjs/commands/BatchDisassociateClientDeviceFromCoreDeviceCommand.js.map +0 -1
  131. package/dist-cjs/commands/CancelDeploymentCommand.js.map +0 -1
  132. package/dist-cjs/commands/CreateComponentVersionCommand.js.map +0 -1
  133. package/dist-cjs/commands/CreateDeploymentCommand.js.map +0 -1
  134. package/dist-cjs/commands/DeleteComponentCommand.js.map +0 -1
  135. package/dist-cjs/commands/DeleteCoreDeviceCommand.js.map +0 -1
  136. package/dist-cjs/commands/DescribeComponentCommand.js.map +0 -1
  137. package/dist-cjs/commands/GetComponentCommand.js.map +0 -1
  138. package/dist-cjs/commands/GetComponentVersionArtifactCommand.js.map +0 -1
  139. package/dist-cjs/commands/GetCoreDeviceCommand.js.map +0 -1
  140. package/dist-cjs/commands/GetDeploymentCommand.js.map +0 -1
  141. package/dist-cjs/commands/ListClientDevicesAssociatedWithCoreDeviceCommand.js.map +0 -1
  142. package/dist-cjs/commands/ListComponentVersionsCommand.js.map +0 -1
  143. package/dist-cjs/commands/ListComponentsCommand.js.map +0 -1
  144. package/dist-cjs/commands/ListCoreDevicesCommand.js.map +0 -1
  145. package/dist-cjs/commands/ListDeploymentsCommand.js.map +0 -1
  146. package/dist-cjs/commands/ListEffectiveDeploymentsCommand.js.map +0 -1
  147. package/dist-cjs/commands/ListInstalledComponentsCommand.js.map +0 -1
  148. package/dist-cjs/commands/ListTagsForResourceCommand.js.map +0 -1
  149. package/dist-cjs/commands/ResolveComponentCandidatesCommand.js.map +0 -1
  150. package/dist-cjs/commands/TagResourceCommand.js.map +0 -1
  151. package/dist-cjs/commands/UntagResourceCommand.js.map +0 -1
  152. package/dist-cjs/endpoints.js.map +0 -1
  153. package/dist-cjs/index.js.map +0 -1
  154. package/dist-cjs/models/index.js.map +0 -1
  155. package/dist-cjs/models/models_0.js.map +0 -1
  156. package/dist-cjs/pagination/Interfaces.js.map +0 -1
  157. package/dist-cjs/pagination/ListClientDevicesAssociatedWithCoreDevicePaginator.js.map +0 -1
  158. package/dist-cjs/pagination/ListComponentVersionsPaginator.js.map +0 -1
  159. package/dist-cjs/pagination/ListComponentsPaginator.js.map +0 -1
  160. package/dist-cjs/pagination/ListCoreDevicesPaginator.js.map +0 -1
  161. package/dist-cjs/pagination/ListDeploymentsPaginator.js.map +0 -1
  162. package/dist-cjs/pagination/ListEffectiveDeploymentsPaginator.js.map +0 -1
  163. package/dist-cjs/pagination/ListInstalledComponentsPaginator.js.map +0 -1
  164. package/dist-cjs/protocols/Aws_restJson1.js.map +0 -1
  165. package/dist-cjs/runtimeConfig.browser.js.map +0 -1
  166. package/dist-cjs/runtimeConfig.js.map +0 -1
  167. package/dist-cjs/runtimeConfig.native.js.map +0 -1
  168. package/dist-cjs/runtimeConfig.shared.js.map +0 -1
  169. package/dist-es/GreengrassV2.js.map +0 -1
  170. package/dist-es/GreengrassV2Client.js.map +0 -1
  171. package/dist-es/commands/BatchAssociateClientDeviceWithCoreDeviceCommand.js.map +0 -1
  172. package/dist-es/commands/BatchDisassociateClientDeviceFromCoreDeviceCommand.js.map +0 -1
  173. package/dist-es/commands/CancelDeploymentCommand.js.map +0 -1
  174. package/dist-es/commands/CreateComponentVersionCommand.js.map +0 -1
  175. package/dist-es/commands/CreateDeploymentCommand.js.map +0 -1
  176. package/dist-es/commands/DeleteComponentCommand.js.map +0 -1
  177. package/dist-es/commands/DeleteCoreDeviceCommand.js.map +0 -1
  178. package/dist-es/commands/DescribeComponentCommand.js.map +0 -1
  179. package/dist-es/commands/GetComponentCommand.js.map +0 -1
  180. package/dist-es/commands/GetComponentVersionArtifactCommand.js.map +0 -1
  181. package/dist-es/commands/GetCoreDeviceCommand.js.map +0 -1
  182. package/dist-es/commands/GetDeploymentCommand.js.map +0 -1
  183. package/dist-es/commands/ListClientDevicesAssociatedWithCoreDeviceCommand.js.map +0 -1
  184. package/dist-es/commands/ListComponentVersionsCommand.js.map +0 -1
  185. package/dist-es/commands/ListComponentsCommand.js.map +0 -1
  186. package/dist-es/commands/ListCoreDevicesCommand.js.map +0 -1
  187. package/dist-es/commands/ListDeploymentsCommand.js.map +0 -1
  188. package/dist-es/commands/ListEffectiveDeploymentsCommand.js.map +0 -1
  189. package/dist-es/commands/ListInstalledComponentsCommand.js.map +0 -1
  190. package/dist-es/commands/ListTagsForResourceCommand.js.map +0 -1
  191. package/dist-es/commands/ResolveComponentCandidatesCommand.js.map +0 -1
  192. package/dist-es/commands/TagResourceCommand.js.map +0 -1
  193. package/dist-es/commands/UntagResourceCommand.js.map +0 -1
  194. package/dist-es/endpoints.js.map +0 -1
  195. package/dist-es/index.js.map +0 -1
  196. package/dist-es/models/index.js.map +0 -1
  197. package/dist-es/models/models_0.js.map +0 -1
  198. package/dist-es/pagination/Interfaces.js.map +0 -1
  199. package/dist-es/pagination/ListClientDevicesAssociatedWithCoreDevicePaginator.js.map +0 -1
  200. package/dist-es/pagination/ListComponentVersionsPaginator.js.map +0 -1
  201. package/dist-es/pagination/ListComponentsPaginator.js.map +0 -1
  202. package/dist-es/pagination/ListCoreDevicesPaginator.js.map +0 -1
  203. package/dist-es/pagination/ListDeploymentsPaginator.js.map +0 -1
  204. package/dist-es/pagination/ListEffectiveDeploymentsPaginator.js.map +0 -1
  205. package/dist-es/pagination/ListInstalledComponentsPaginator.js.map +0 -1
  206. package/dist-es/protocols/Aws_restJson1.js.map +0 -1
  207. package/dist-es/runtimeConfig.browser.js.map +0 -1
  208. package/dist-es/runtimeConfig.js.map +0 -1
  209. package/dist-es/runtimeConfig.native.js.map +0 -1
  210. package/dist-es/runtimeConfig.shared.js.map +0 -1
  211. package/jest.config.js +0 -4
  212. package/src/GreengrassV2.ts +0 -970
  213. package/src/GreengrassV2Client.ts +0 -345
  214. package/src/commands/BatchAssociateClientDeviceWithCoreDeviceCommand.ts +0 -122
  215. package/src/commands/BatchDisassociateClientDeviceFromCoreDeviceCommand.ts +0 -112
  216. package/src/commands/CancelDeploymentCommand.ts +0 -97
  217. package/src/commands/CreateComponentVersionCommand.ts +0 -148
  218. package/src/commands/CreateDeploymentCommand.ts +0 -105
  219. package/src/commands/DeleteComponentCommand.ts +0 -101
  220. package/src/commands/DeleteCoreDeviceCommand.ts +0 -98
  221. package/src/commands/DescribeComponentCommand.ts +0 -95
  222. package/src/commands/GetComponentCommand.ts +0 -96
  223. package/src/commands/GetComponentVersionArtifactCommand.ts +0 -101
  224. package/src/commands/GetCoreDeviceCommand.ts +0 -95
  225. package/src/commands/GetDeploymentCommand.ts +0 -95
  226. package/src/commands/ListClientDevicesAssociatedWithCoreDeviceCommand.ts +0 -111
  227. package/src/commands/ListComponentVersionsCommand.ts +0 -95
  228. package/src/commands/ListComponentsCommand.ts +0 -96
  229. package/src/commands/ListCoreDevicesCommand.ts +0 -95
  230. package/src/commands/ListDeploymentsCommand.ts +0 -95
  231. package/src/commands/ListEffectiveDeploymentsCommand.ts +0 -96
  232. package/src/commands/ListInstalledComponentsCommand.ts +0 -95
  233. package/src/commands/ListTagsForResourceCommand.ts +0 -95
  234. package/src/commands/ResolveComponentCandidatesCommand.ts +0 -112
  235. package/src/commands/TagResourceCommand.ts +0 -96
  236. package/src/commands/UntagResourceCommand.ts +0 -95
  237. package/src/endpoints.ts +0 -84
  238. package/src/index.ts +0 -34
  239. package/src/models/index.ts +0 -1
  240. package/src/models/models_0.ts +0 -2867
  241. package/src/pagination/Interfaces.ts +0 -8
  242. package/src/pagination/ListClientDevicesAssociatedWithCoreDevicePaginator.ts +0 -59
  243. package/src/pagination/ListComponentVersionsPaginator.ts +0 -59
  244. package/src/pagination/ListComponentsPaginator.ts +0 -59
  245. package/src/pagination/ListCoreDevicesPaginator.ts +0 -59
  246. package/src/pagination/ListDeploymentsPaginator.ts +0 -59
  247. package/src/pagination/ListEffectiveDeploymentsPaginator.ts +0 -59
  248. package/src/pagination/ListInstalledComponentsPaginator.ts +0 -59
  249. package/src/protocols/Aws_restJson1.ts +0 -4401
  250. package/src/runtimeConfig.browser.ts +0 -41
  251. package/src/runtimeConfig.native.ts +0 -17
  252. package/src/runtimeConfig.shared.ts +0 -17
  253. package/src/runtimeConfig.ts +0 -46
  254. package/tsconfig.es.json +0 -10
  255. package/tsconfig.json +0 -33
  256. package/tsconfig.types.json +0 -9
@@ -1,2867 +0,0 @@
1
- import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
2
-
3
- /**
4
- * <p>You don't have permission to perform the action.</p>
5
- */
6
- export interface AccessDeniedException extends __SmithyException, $MetadataBearer {
7
- name: "AccessDeniedException";
8
- $fault: "client";
9
- message: string | undefined;
10
- }
11
-
12
- export namespace AccessDeniedException {
13
- /**
14
- * @internal
15
- */
16
- export const filterSensitiveLog = (obj: AccessDeniedException): any => ({
17
- ...obj,
18
- });
19
- }
20
-
21
- /**
22
- * <p>Contains a request to associate a client device with a core device. The <a href="https://docs.aws.amazon.com/greengrass/v2/APIReference/API_BatchAssociateClientDeviceWithCoreDevice.html">BatchAssociateClientDeviceWithCoreDevice</a> operation consumes a list of these
23
- * requests.</p>
24
- */
25
- export interface AssociateClientDeviceWithCoreDeviceEntry {
26
- /**
27
- * <p>The name of the IoT thing that represents the client device to associate.</p>
28
- */
29
- thingName: string | undefined;
30
- }
31
-
32
- export namespace AssociateClientDeviceWithCoreDeviceEntry {
33
- /**
34
- * @internal
35
- */
36
- export const filterSensitiveLog = (obj: AssociateClientDeviceWithCoreDeviceEntry): any => ({
37
- ...obj,
38
- });
39
- }
40
-
41
- /**
42
- * <p>Contains an error that occurs from a request to associate a client device with a core
43
- * device. The <a href="https://docs.aws.amazon.com/greengrass/v2/APIReference/API_BatchAssociateClientDeviceWithCoreDevice.html">BatchAssociateClientDeviceWithCoreDevice</a> operation returns a list of these
44
- * errors.</p>
45
- */
46
- export interface AssociateClientDeviceWithCoreDeviceErrorEntry {
47
- /**
48
- * <p>The name of the IoT thing whose associate request failed.</p>
49
- */
50
- thingName?: string;
51
-
52
- /**
53
- * <p>The error code for the request.</p>
54
- */
55
- code?: string;
56
-
57
- /**
58
- * <p>A message that provides additional information about the error.</p>
59
- */
60
- message?: string;
61
- }
62
-
63
- export namespace AssociateClientDeviceWithCoreDeviceErrorEntry {
64
- /**
65
- * @internal
66
- */
67
- export const filterSensitiveLog = (obj: AssociateClientDeviceWithCoreDeviceErrorEntry): any => ({
68
- ...obj,
69
- });
70
- }
71
-
72
- /**
73
- * <p>Contains information about a client device that is associated to a core device for cloud
74
- * discovery.</p>
75
- */
76
- export interface AssociatedClientDevice {
77
- /**
78
- * <p>The name of the IoT thing that represents the associated client device.</p>
79
- */
80
- thingName?: string;
81
-
82
- /**
83
- * <p>The time that the client device was associated, expressed in ISO 8601 format.</p>
84
- */
85
- associationTimestamp?: Date;
86
- }
87
-
88
- export namespace AssociatedClientDevice {
89
- /**
90
- * @internal
91
- */
92
- export const filterSensitiveLog = (obj: AssociatedClientDevice): any => ({
93
- ...obj,
94
- });
95
- }
96
-
97
- export interface BatchAssociateClientDeviceWithCoreDeviceRequest {
98
- /**
99
- * <p>The list of client devices to associate.</p>
100
- */
101
- entries?: AssociateClientDeviceWithCoreDeviceEntry[];
102
-
103
- /**
104
- * <p>The name of the core device. This is also the name of the IoT thing.</p>
105
- */
106
- coreDeviceThingName: string | undefined;
107
- }
108
-
109
- export namespace BatchAssociateClientDeviceWithCoreDeviceRequest {
110
- /**
111
- * @internal
112
- */
113
- export const filterSensitiveLog = (obj: BatchAssociateClientDeviceWithCoreDeviceRequest): any => ({
114
- ...obj,
115
- });
116
- }
117
-
118
- export interface BatchAssociateClientDeviceWithCoreDeviceResponse {
119
- /**
120
- * <p>The list of any errors for the entries in the request. Each error entry contains the name
121
- * of the IoT thing that failed to associate.</p>
122
- */
123
- errorEntries?: AssociateClientDeviceWithCoreDeviceErrorEntry[];
124
- }
125
-
126
- export namespace BatchAssociateClientDeviceWithCoreDeviceResponse {
127
- /**
128
- * @internal
129
- */
130
- export const filterSensitiveLog = (obj: BatchAssociateClientDeviceWithCoreDeviceResponse): any => ({
131
- ...obj,
132
- });
133
- }
134
-
135
- /**
136
- * <p>IoT Greengrass can't process your request right now. Try again later.</p>
137
- */
138
- export interface InternalServerException extends __SmithyException, $MetadataBearer {
139
- name: "InternalServerException";
140
- $fault: "server";
141
- message: string | undefined;
142
- /**
143
- * <p>The amount of time to wait before you retry the request.</p>
144
- */
145
- retryAfterSeconds?: number;
146
- }
147
-
148
- export namespace InternalServerException {
149
- /**
150
- * @internal
151
- */
152
- export const filterSensitiveLog = (obj: InternalServerException): any => ({
153
- ...obj,
154
- });
155
- }
156
-
157
- /**
158
- * <p>The requested resource can't be found.</p>
159
- */
160
- export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
161
- name: "ResourceNotFoundException";
162
- $fault: "client";
163
- message: string | undefined;
164
- /**
165
- * <p>The ID of the resource that isn't found.</p>
166
- */
167
- resourceId: string | undefined;
168
-
169
- /**
170
- * <p>The type of the resource that isn't found.</p>
171
- */
172
- resourceType: string | undefined;
173
- }
174
-
175
- export namespace ResourceNotFoundException {
176
- /**
177
- * @internal
178
- */
179
- export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({
180
- ...obj,
181
- });
182
- }
183
-
184
- /**
185
- * <p>Your request exceeded a request rate quota. For example, you might have exceeded the
186
- * amount of times that you can retrieve device or deployment status per second.</p>
187
- */
188
- export interface ThrottlingException extends __SmithyException, $MetadataBearer {
189
- name: "ThrottlingException";
190
- $fault: "client";
191
- message: string | undefined;
192
- /**
193
- * <p>The code for the quota in <a href="https://docs.aws.amazon.com/servicequotas/latest/userguide/intro.html">Service Quotas</a>.</p>
194
- */
195
- quotaCode?: string;
196
-
197
- /**
198
- * <p>The code for the service in <a href="https://docs.aws.amazon.com/servicequotas/latest/userguide/intro.html">Service Quotas</a>.</p>
199
- */
200
- serviceCode?: string;
201
-
202
- /**
203
- * <p>The amount of time to wait before you retry the request.</p>
204
- */
205
- retryAfterSeconds?: number;
206
- }
207
-
208
- export namespace ThrottlingException {
209
- /**
210
- * @internal
211
- */
212
- export const filterSensitiveLog = (obj: ThrottlingException): any => ({
213
- ...obj,
214
- });
215
- }
216
-
217
- /**
218
- * <p>Contains information about a validation exception field.</p>
219
- */
220
- export interface ValidationExceptionField {
221
- /**
222
- * <p>The name of the exception field.</p>
223
- */
224
- name: string | undefined;
225
-
226
- /**
227
- * <p>The message of the exception field.</p>
228
- */
229
- message: string | undefined;
230
- }
231
-
232
- export namespace ValidationExceptionField {
233
- /**
234
- * @internal
235
- */
236
- export const filterSensitiveLog = (obj: ValidationExceptionField): any => ({
237
- ...obj,
238
- });
239
- }
240
-
241
- export enum ValidationExceptionReason {
242
- CANNOT_PARSE = "CANNOT_PARSE",
243
- FIELD_VALIDATION_FAILED = "FIELD_VALIDATION_FAILED",
244
- OTHER = "OTHER",
245
- UNKNOWN_OPERATION = "UNKNOWN_OPERATION",
246
- }
247
-
248
- /**
249
- * <p>The request isn't valid. This can occur if your request contains malformed JSON or
250
- * unsupported characters.</p>
251
- */
252
- export interface ValidationException extends __SmithyException, $MetadataBearer {
253
- name: "ValidationException";
254
- $fault: "client";
255
- message: string | undefined;
256
- /**
257
- * <p>The reason for the validation exception.</p>
258
- */
259
- reason?: ValidationExceptionReason | string;
260
-
261
- /**
262
- * <p>The list of fields that failed to validate.</p>
263
- */
264
- fields?: ValidationExceptionField[];
265
- }
266
-
267
- export namespace ValidationException {
268
- /**
269
- * @internal
270
- */
271
- export const filterSensitiveLog = (obj: ValidationException): any => ({
272
- ...obj,
273
- });
274
- }
275
-
276
- /**
277
- * <p>Contains a request to disassociate a client device from a core device. The <a href="https://docs.aws.amazon.com/greengrass/v2/APIReference/API_BatchDisassociateClientDeviceWithCoreDevice.html">BatchDisassociateClientDeviceWithCoreDevice</a> operation consumes a list of these
278
- * requests.</p>
279
- */
280
- export interface DisassociateClientDeviceFromCoreDeviceEntry {
281
- /**
282
- * <p>The name of the IoT thing that represents the client device to disassociate.</p>
283
- */
284
- thingName: string | undefined;
285
- }
286
-
287
- export namespace DisassociateClientDeviceFromCoreDeviceEntry {
288
- /**
289
- * @internal
290
- */
291
- export const filterSensitiveLog = (obj: DisassociateClientDeviceFromCoreDeviceEntry): any => ({
292
- ...obj,
293
- });
294
- }
295
-
296
- export interface BatchDisassociateClientDeviceFromCoreDeviceRequest {
297
- /**
298
- * <p>The list of client devices to disassociate.</p>
299
- */
300
- entries?: DisassociateClientDeviceFromCoreDeviceEntry[];
301
-
302
- /**
303
- * <p>The name of the core device. This is also the name of the IoT thing.</p>
304
- */
305
- coreDeviceThingName: string | undefined;
306
- }
307
-
308
- export namespace BatchDisassociateClientDeviceFromCoreDeviceRequest {
309
- /**
310
- * @internal
311
- */
312
- export const filterSensitiveLog = (obj: BatchDisassociateClientDeviceFromCoreDeviceRequest): any => ({
313
- ...obj,
314
- });
315
- }
316
-
317
- /**
318
- * <p>Contains an error that occurs from a request to disassociate a client device from a core
319
- * device. The <a href="https://docs.aws.amazon.com/greengrass/v2/APIReference/API_BatchDisassociateClientDeviceWithCoreDevice.html">BatchDisassociateClientDeviceWithCoreDevice</a> operation returns a list of these
320
- * errors.</p>
321
- */
322
- export interface DisassociateClientDeviceFromCoreDeviceErrorEntry {
323
- /**
324
- * <p>The name of the IoT thing whose disassociate request failed.</p>
325
- */
326
- thingName?: string;
327
-
328
- /**
329
- * <p>The error code for the request.</p>
330
- */
331
- code?: string;
332
-
333
- /**
334
- * <p>A message that provides additional information about the error.</p>
335
- */
336
- message?: string;
337
- }
338
-
339
- export namespace DisassociateClientDeviceFromCoreDeviceErrorEntry {
340
- /**
341
- * @internal
342
- */
343
- export const filterSensitiveLog = (obj: DisassociateClientDeviceFromCoreDeviceErrorEntry): any => ({
344
- ...obj,
345
- });
346
- }
347
-
348
- export interface BatchDisassociateClientDeviceFromCoreDeviceResponse {
349
- /**
350
- * <p>The list of errors (if any) for the entries in the request. Each error entry contains the
351
- * name of the IoT thing that failed to disassociate.</p>
352
- */
353
- errorEntries?: DisassociateClientDeviceFromCoreDeviceErrorEntry[];
354
- }
355
-
356
- export namespace BatchDisassociateClientDeviceFromCoreDeviceResponse {
357
- /**
358
- * @internal
359
- */
360
- export const filterSensitiveLog = (obj: BatchDisassociateClientDeviceFromCoreDeviceResponse): any => ({
361
- ...obj,
362
- });
363
- }
364
-
365
- export interface CancelDeploymentRequest {
366
- /**
367
- * <p>The ID of the deployment.</p>
368
- */
369
- deploymentId: string | undefined;
370
- }
371
-
372
- export namespace CancelDeploymentRequest {
373
- /**
374
- * @internal
375
- */
376
- export const filterSensitiveLog = (obj: CancelDeploymentRequest): any => ({
377
- ...obj,
378
- });
379
- }
380
-
381
- export interface CancelDeploymentResponse {
382
- /**
383
- * <p>A message that communicates if the cancel was successful.</p>
384
- */
385
- message?: string;
386
- }
387
-
388
- export namespace CancelDeploymentResponse {
389
- /**
390
- * @internal
391
- */
392
- export const filterSensitiveLog = (obj: CancelDeploymentResponse): any => ({
393
- ...obj,
394
- });
395
- }
396
-
397
- /**
398
- * <p>Your request has conflicting operations. This can occur if you're trying to perform more
399
- * than one operation on the same resource at the same time.</p>
400
- */
401
- export interface ConflictException extends __SmithyException, $MetadataBearer {
402
- name: "ConflictException";
403
- $fault: "client";
404
- message: string | undefined;
405
- /**
406
- * <p>The ID of the resource that conflicts with the request.</p>
407
- */
408
- resourceId: string | undefined;
409
-
410
- /**
411
- * <p>The type of the resource that conflicts with the request.</p>
412
- */
413
- resourceType: string | undefined;
414
- }
415
-
416
- export namespace ConflictException {
417
- /**
418
- * @internal
419
- */
420
- export const filterSensitiveLog = (obj: ConflictException): any => ({
421
- ...obj,
422
- });
423
- }
424
-
425
- export enum CloudComponentState {
426
- DEPLOYABLE = "DEPLOYABLE",
427
- DEPRECATED = "DEPRECATED",
428
- FAILED = "FAILED",
429
- INITIATED = "INITIATED",
430
- REQUESTED = "REQUESTED",
431
- }
432
-
433
- /**
434
- * <p>Contains the status of a component in the IoT Greengrass service.</p>
435
- */
436
- export interface CloudComponentStatus {
437
- /**
438
- * <p>The state of the component.</p>
439
- */
440
- componentState?: CloudComponentState | string;
441
-
442
- /**
443
- * <p>A message that communicates details, such as errors, about the status of the component.</p>
444
- */
445
- message?: string;
446
-
447
- /**
448
- * <p>A dictionary of errors that communicate why the component is in an error state. For
449
- * example, if IoT Greengrass can't access an artifact for the component, then <code>errors</code> contains
450
- * the artifact's URI as a key, and the error message as the value for that key.</p>
451
- */
452
- errors?: { [key: string]: string };
453
- }
454
-
455
- export namespace CloudComponentStatus {
456
- /**
457
- * @internal
458
- */
459
- export const filterSensitiveLog = (obj: CloudComponentStatus): any => ({
460
- ...obj,
461
- });
462
- }
463
-
464
- /**
465
- * <p>Contains information about a platform that a component supports.</p>
466
- */
467
- export interface ComponentPlatform {
468
- /**
469
- * <p>The friendly name of the platform. This name helps you identify the platform.</p>
470
- * <p>If you omit this parameter, IoT Greengrass creates a friendly name from the <code>os</code> and
471
- * <code>architecture</code> of the platform.</p>
472
- */
473
- name?: string;
474
-
475
- /**
476
- * <p>A dictionary of attributes for the platform. The IoT Greengrass Core software defines the
477
- * <code>os</code> and <code>platform</code> by default. You can specify additional platform
478
- * attributes for a core device when you deploy the Greengrass nucleus component. For more information,
479
- * see the <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html">Greengrass nucleus
480
- * component</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>
481
- */
482
- attributes?: { [key: string]: string };
483
- }
484
-
485
- export namespace ComponentPlatform {
486
- /**
487
- * @internal
488
- */
489
- export const filterSensitiveLog = (obj: ComponentPlatform): any => ({
490
- ...obj,
491
- });
492
- }
493
-
494
- /**
495
- * <p>Contains information about the latest version of a component.</p>
496
- */
497
- export interface ComponentLatestVersion {
498
- /**
499
- * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the component version.</p>
500
- */
501
- arn?: string;
502
-
503
- /**
504
- * <p>The version of the component.</p>
505
- */
506
- componentVersion?: string;
507
-
508
- /**
509
- * <p>The time at which the component was created, expressed in ISO 8601 format.</p>
510
- */
511
- creationTimestamp?: Date;
512
-
513
- /**
514
- * <p>The description of the component version.</p>
515
- */
516
- description?: string;
517
-
518
- /**
519
- * <p>The publisher of the component version.</p>
520
- */
521
- publisher?: string;
522
-
523
- /**
524
- * <p>The platforms that the component version supports.</p>
525
- */
526
- platforms?: ComponentPlatform[];
527
- }
528
-
529
- export namespace ComponentLatestVersion {
530
- /**
531
- * @internal
532
- */
533
- export const filterSensitiveLog = (obj: ComponentLatestVersion): any => ({
534
- ...obj,
535
- });
536
- }
537
-
538
- /**
539
- * <p>Contains information about a component.</p>
540
- */
541
- export interface Component {
542
- /**
543
- * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the component version.</p>
544
- */
545
- arn?: string;
546
-
547
- /**
548
- * <p>The name of the component.</p>
549
- */
550
- componentName?: string;
551
-
552
- /**
553
- * <p>The latest version of the component and its details.</p>
554
- */
555
- latestVersion?: ComponentLatestVersion;
556
- }
557
-
558
- export namespace Component {
559
- /**
560
- * @internal
561
- */
562
- export const filterSensitiveLog = (obj: Component): any => ({
563
- ...obj,
564
- });
565
- }
566
-
567
- /**
568
- * <p>Contains information about a component that is a candidate to deploy to a Greengrass core
569
- * device.</p>
570
- */
571
- export interface ComponentCandidate {
572
- /**
573
- * <p>The name of the component.</p>
574
- */
575
- componentName?: string;
576
-
577
- /**
578
- * <p>The version of the component.</p>
579
- */
580
- componentVersion?: string;
581
-
582
- /**
583
- * <p>The version requirements for the component's dependencies. Greengrass core devices get the
584
- * version requirements from component recipes.</p>
585
- * <p>IoT Greengrass V2 uses semantic version constraints. For more information, see <a href="https://semver.org/">Semantic Versioning</a>.</p>
586
- */
587
- versionRequirements?: { [key: string]: string };
588
- }
589
-
590
- export namespace ComponentCandidate {
591
- /**
592
- * @internal
593
- */
594
- export const filterSensitiveLog = (obj: ComponentCandidate): any => ({
595
- ...obj,
596
- });
597
- }
598
-
599
- /**
600
- * <p>Contains information about a deployment's update to a component's configuration on
601
- * Greengrass core devices. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html">Update component
602
- * configurations</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>
603
- */
604
- export interface ComponentConfigurationUpdate {
605
- /**
606
- * <p>A serialized JSON string that contains the configuration object to merge to target
607
- * devices. The core device merges this configuration with the component's existing
608
- * configuration. If this is the first time a component deploys on a device, the core device
609
- * merges this configuration with the component's default configuration. This means that the core
610
- * device keeps it's existing configuration for keys and values that you don't specify in this
611
- * object. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html#merge-configuration-update">Merge configuration updates</a> in the <i>IoT Greengrass V2 Developer
612
- * Guide</i>.</p>
613
- */
614
- merge?: string;
615
-
616
- /**
617
- * <p>The list of configuration nodes to reset to default values on target devices. Use JSON
618
- * pointers to specify each node to reset. JSON pointers start with a forward slash
619
- * (<code>/</code>) and use forward slashes to separate the key for each level in the object.
620
- * For more information, see the <a href="https://tools.ietf.org/html/rfc6901">JSON pointer
621
- * specification</a> and <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html#reset-configuration-update">Reset configuration updates</a> in the <i>IoT Greengrass V2 Developer
622
- * Guide</i>.</p>
623
- */
624
- reset?: string[];
625
- }
626
-
627
- export namespace ComponentConfigurationUpdate {
628
- /**
629
- * @internal
630
- */
631
- export const filterSensitiveLog = (obj: ComponentConfigurationUpdate): any => ({
632
- ...obj,
633
- });
634
- }
635
-
636
- export enum ComponentDependencyType {
637
- HARD = "HARD",
638
- SOFT = "SOFT",
639
- }
640
-
641
- /**
642
- * <p>Contains information about a component dependency for a Lambda function component.</p>
643
- */
644
- export interface ComponentDependencyRequirement {
645
- /**
646
- * <p>The component version requirement for the component dependency.</p>
647
- * <p>IoT Greengrass V2 uses semantic version constraints. For more information, see <a href="https://semver.org/">Semantic Versioning</a>.</p>
648
- */
649
- versionRequirement?: string;
650
-
651
- /**
652
- * <p>The type of this dependency. Choose from the following options:</p>
653
- * <ul>
654
- * <li>
655
- * <p>
656
- * <code>SOFT</code> – The component doesn't restart if the dependency changes
657
- * state.</p>
658
- * </li>
659
- * <li>
660
- * <p>
661
- * <code>HARD</code> – The component restarts if the dependency changes
662
- * state.</p>
663
- * </li>
664
- * </ul>
665
- * <p>Default: <code>HARD</code>
666
- * </p>
667
- */
668
- dependencyType?: ComponentDependencyType | string;
669
- }
670
-
671
- export namespace ComponentDependencyRequirement {
672
- /**
673
- * @internal
674
- */
675
- export const filterSensitiveLog = (obj: ComponentDependencyRequirement): any => ({
676
- ...obj,
677
- });
678
- }
679
-
680
- /**
681
- * <p>Contains information about system resource limits that the IoT Greengrass Core software applies to a
682
- * component's processes. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-system-resource-limits">Configure system resource limits for components</a>.</p>
683
- */
684
- export interface SystemResourceLimits {
685
- /**
686
- * <p>The maximum amount of RAM, expressed in kilobytes, that a component's processes can use on
687
- * the core device.</p>
688
- */
689
- memory?: number;
690
-
691
- /**
692
- * <p>The maximum amount of CPU time that a component's processes can use on the core device. A
693
- * core device's total CPU time is equivalent to the device's number of CPU cores. For example,
694
- * on a core device with 4 CPU cores, you can set this value to <code>2</code> to limit the
695
- * component's processes to 50 percent usage of each CPU core. On a device with 1 CPU core, you
696
- * can set this value to <code>0.25</code> to limit the component's processes to 25 percent usage
697
- * of the CPU. If you set this value to a number greater than the number of CPU cores, the IoT Greengrass Core
698
- * software doesn't limit the component's CPU usage.</p>
699
- */
700
- cpus?: number;
701
- }
702
-
703
- export namespace SystemResourceLimits {
704
- /**
705
- * @internal
706
- */
707
- export const filterSensitiveLog = (obj: SystemResourceLimits): any => ({
708
- ...obj,
709
- });
710
- }
711
-
712
- /**
713
- * <p>Contains information system user and group that the IoT Greengrass Core software uses to run component
714
- * processes on the core device. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user">Configure the user and group that run components</a> in the <i>IoT Greengrass V2 Developer
715
- * Guide</i>.</p>
716
- */
717
- export interface ComponentRunWith {
718
- /**
719
- * <p>The POSIX system user and (optional) group to use to run this component. Specify the user
720
- * and group separated by a colon (<code>:</code>) in the following format:
721
- * <code>user:group</code>. The group is optional. If you don't specify a group, the IoT Greengrass Core
722
- * software uses the primary user for the group.</p>
723
- * <p>If you omit this parameter, the IoT Greengrass Core software uses the default system user and group that
724
- * you configure on the Greengrass nucleus component. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user">Configure the user and group that run components</a>.</p>
725
- */
726
- posixUser?: string;
727
-
728
- /**
729
- * <p>The system resource limits to apply to this component's process on the core device.</p>
730
- * <p>If you omit this parameter, the IoT Greengrass Core software uses the default system resource limits
731
- * that you configure on the Greengrass nucleus component. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-system-resource-limits">Configure system resource limits for components</a>.</p>
732
- */
733
- systemResourceLimits?: SystemResourceLimits;
734
- }
735
-
736
- export namespace ComponentRunWith {
737
- /**
738
- * @internal
739
- */
740
- export const filterSensitiveLog = (obj: ComponentRunWith): any => ({
741
- ...obj,
742
- });
743
- }
744
-
745
- /**
746
- * <p>Contains information about a component to deploy.</p>
747
- */
748
- export interface ComponentDeploymentSpecification {
749
- /**
750
- * <p>The version of the component.</p>
751
- */
752
- componentVersion?: string;
753
-
754
- /**
755
- * <p>The configuration updates to deploy for the component. You can define
756
- * <i>reset</i> updates and <i>merge</i> updates. A reset updates
757
- * the keys that you specify to the default configuration for the component. A merge updates the
758
- * core device's component configuration with the keys and values that you specify. The IoT Greengrass Core
759
- * software applies reset updates before it applies merge updates. For more information, see
760
- * <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html">Update component
761
- * configurations</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>
762
- */
763
- configurationUpdate?: ComponentConfigurationUpdate;
764
-
765
- /**
766
- * <p>The system user and group that the IoT Greengrass Core software uses to run component processes on the
767
- * core device. If you omit this parameter, the IoT Greengrass Core software uses the system user and group
768
- * that you configure for the core device. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user">Configure the user and group that run components</a> in the <i>IoT Greengrass V2 Developer
769
- * Guide</i>.</p>
770
- */
771
- runWith?: ComponentRunWith;
772
- }
773
-
774
- export namespace ComponentDeploymentSpecification {
775
- /**
776
- * @internal
777
- */
778
- export const filterSensitiveLog = (obj: ComponentDeploymentSpecification): any => ({
779
- ...obj,
780
- });
781
- }
782
-
783
- /**
784
- * <p>Contains information about a component version in a list.</p>
785
- */
786
- export interface ComponentVersionListItem {
787
- /**
788
- * <p>The name of the component.</p>
789
- */
790
- componentName?: string;
791
-
792
- /**
793
- * <p>The version of the component.</p>
794
- */
795
- componentVersion?: string;
796
-
797
- /**
798
- * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the component version.</p>
799
- */
800
- arn?: string;
801
- }
802
-
803
- export namespace ComponentVersionListItem {
804
- /**
805
- * @internal
806
- */
807
- export const filterSensitiveLog = (obj: ComponentVersionListItem): any => ({
808
- ...obj,
809
- });
810
- }
811
-
812
- export enum ComponentVisibilityScope {
813
- PRIVATE = "PRIVATE",
814
- PUBLIC = "PUBLIC",
815
- }
816
-
817
- export enum CoreDeviceStatus {
818
- HEALTHY = "HEALTHY",
819
- UNHEALTHY = "UNHEALTHY",
820
- }
821
-
822
- /**
823
- * <p>Contains information about a Greengrass core device, which is an IoT thing that runs the IoT Greengrass
824
- * Core software.</p>
825
- */
826
- export interface CoreDevice {
827
- /**
828
- * <p>The name of the core device. This is also the name of the IoT thing.</p>
829
- */
830
- coreDeviceThingName?: string;
831
-
832
- /**
833
- * <p>The status of the core device. Core devices can have the following statuses:</p>
834
- * <ul>
835
- * <li>
836
- * <p>
837
- * <code>HEALTHY</code> – The IoT Greengrass Core software and all components run on the core device without issue.</p>
838
- * </li>
839
- * <li>
840
- * <p>
841
- * <code>UNHEALTHY</code> – The IoT Greengrass Core software or a component is in a failed state
842
- * on the core device.</p>
843
- * </li>
844
- * </ul>
845
- */
846
- status?: CoreDeviceStatus | string;
847
-
848
- /**
849
- * <p>The time at which the core device's status last updated, expressed in ISO 8601
850
- * format.</p>
851
- */
852
- lastStatusUpdateTimestamp?: Date;
853
- }
854
-
855
- export namespace CoreDevice {
856
- /**
857
- * @internal
858
- */
859
- export const filterSensitiveLog = (obj: CoreDevice): any => ({
860
- ...obj,
861
- });
862
- }
863
-
864
- export enum LambdaEventSourceType {
865
- IOT_CORE = "IOT_CORE",
866
- PUB_SUB = "PUB_SUB",
867
- }
868
-
869
- /**
870
- * <p>Contains information about an event source for an Lambda function. The event source
871
- * defines the topics on which this Lambda function subscribes to receive messages that run the
872
- * function.</p>
873
- */
874
- export interface LambdaEventSource {
875
- /**
876
- * <p>The topic to which to subscribe to receive event messages.</p>
877
- */
878
- topic: string | undefined;
879
-
880
- /**
881
- * <p>The type of event source. Choose from the following options:</p>
882
- * <ul>
883
- * <li>
884
- * <p>
885
- * <code>PUB_SUB</code> – Subscribe to local publish/subscribe messages. This event
886
- * source type doesn't support MQTT wildcards (<code>+</code> and <code>#</code>) in the
887
- * event source topic.</p>
888
- * </li>
889
- * <li>
890
- * <p>
891
- * <code>IOT_CORE</code> – Subscribe to Amazon Web Services IoT Core MQTT messages. This event source
892
- * type supports MQTT wildcards (<code>+</code> and <code>#</code>) in the event source
893
- * topic.</p>
894
- * </li>
895
- * </ul>
896
- */
897
- type: LambdaEventSourceType | string | undefined;
898
- }
899
-
900
- export namespace LambdaEventSource {
901
- /**
902
- * @internal
903
- */
904
- export const filterSensitiveLog = (obj: LambdaEventSource): any => ({
905
- ...obj,
906
- });
907
- }
908
-
909
- export enum LambdaInputPayloadEncodingType {
910
- BINARY = "binary",
911
- JSON = "json",
912
- }
913
-
914
- export enum LambdaFilesystemPermission {
915
- RO = "ro",
916
- RW = "rw",
917
- }
918
-
919
- /**
920
- * <p>Contains information about a device that Linux processes in a container can access.</p>
921
- */
922
- export interface LambdaDeviceMount {
923
- /**
924
- * <p>The mount path for the device in the file system.</p>
925
- */
926
- path: string | undefined;
927
-
928
- /**
929
- * <p>The permission to access the device: read/only (<code>ro</code>) or read/write
930
- * (<code>rw</code>).</p>
931
- * <p>Default: <code>ro</code>
932
- * </p>
933
- */
934
- permission?: LambdaFilesystemPermission | string;
935
-
936
- /**
937
- * <p>Whether or not to add the component's system user as an owner of the device.</p>
938
- * <p>Default: <code>false</code>
939
- * </p>
940
- */
941
- addGroupOwner?: boolean;
942
- }
943
-
944
- export namespace LambdaDeviceMount {
945
- /**
946
- * @internal
947
- */
948
- export const filterSensitiveLog = (obj: LambdaDeviceMount): any => ({
949
- ...obj,
950
- });
951
- }
952
-
953
- /**
954
- * <p>Contains information about a volume that Linux processes in a container can access. When
955
- * you define a volume, the IoT Greengrass Core software mounts the source files to the destination inside the
956
- * container.</p>
957
- */
958
- export interface LambdaVolumeMount {
959
- /**
960
- * <p>The path to the physical volume in the file system.</p>
961
- */
962
- sourcePath: string | undefined;
963
-
964
- /**
965
- * <p>The path to the logical volume in the file system.</p>
966
- */
967
- destinationPath: string | undefined;
968
-
969
- /**
970
- * <p>The permission to access the volume: read/only (<code>ro</code>) or read/write
971
- * (<code>rw</code>).</p>
972
- * <p>Default: <code>ro</code>
973
- * </p>
974
- */
975
- permission?: LambdaFilesystemPermission | string;
976
-
977
- /**
978
- * <p>Whether or not to add the IoT Greengrass user group as an owner of the volume.</p>
979
- * <p>Default: <code>false</code>
980
- * </p>
981
- */
982
- addGroupOwner?: boolean;
983
- }
984
-
985
- export namespace LambdaVolumeMount {
986
- /**
987
- * @internal
988
- */
989
- export const filterSensitiveLog = (obj: LambdaVolumeMount): any => ({
990
- ...obj,
991
- });
992
- }
993
-
994
- /**
995
- * <p>Contains information about a container in which Lambda functions run on Greengrass core
996
- * devices.</p>
997
- */
998
- export interface LambdaContainerParams {
999
- /**
1000
- * <p>The memory size of the container, expressed in kilobytes.</p>
1001
- * <p>Default: <code>16384</code> (16 MB)</p>
1002
- */
1003
- memorySizeInKB?: number;
1004
-
1005
- /**
1006
- * <p>Whether or not the container can read information from the device's <code>/sys</code>
1007
- * folder.</p>
1008
- * <p>Default: <code>false</code>
1009
- * </p>
1010
- */
1011
- mountROSysfs?: boolean;
1012
-
1013
- /**
1014
- * <p>The list of volumes that the container can access.</p>
1015
- */
1016
- volumes?: LambdaVolumeMount[];
1017
-
1018
- /**
1019
- * <p>The list of system devices that the container can access.</p>
1020
- */
1021
- devices?: LambdaDeviceMount[];
1022
- }
1023
-
1024
- export namespace LambdaContainerParams {
1025
- /**
1026
- * @internal
1027
- */
1028
- export const filterSensitiveLog = (obj: LambdaContainerParams): any => ({
1029
- ...obj,
1030
- });
1031
- }
1032
-
1033
- export enum LambdaIsolationMode {
1034
- GREENGRASS_CONTAINER = "GreengrassContainer",
1035
- NO_CONTAINER = "NoContainer",
1036
- }
1037
-
1038
- /**
1039
- * <p>Contains parameters for a Linux process that contains an Lambda function.</p>
1040
- */
1041
- export interface LambdaLinuxProcessParams {
1042
- /**
1043
- * <p>The isolation mode for the process that contains the Lambda function. The process can run
1044
- * in an isolated runtime environment inside the IoT Greengrass container, or as a regular process outside
1045
- * any container.</p>
1046
- * <p>Default: <code>GreengrassContainer</code>
1047
- * </p>
1048
- */
1049
- isolationMode?: LambdaIsolationMode | string;
1050
-
1051
- /**
1052
- * <p>The parameters for the container in which the Lambda function runs.</p>
1053
- */
1054
- containerParams?: LambdaContainerParams;
1055
- }
1056
-
1057
- export namespace LambdaLinuxProcessParams {
1058
- /**
1059
- * @internal
1060
- */
1061
- export const filterSensitiveLog = (obj: LambdaLinuxProcessParams): any => ({
1062
- ...obj,
1063
- });
1064
- }
1065
-
1066
- /**
1067
- * <p>Contains parameters for a Lambda function that runs on IoT Greengrass.</p>
1068
- */
1069
- export interface LambdaExecutionParameters {
1070
- /**
1071
- * <p>The list of event sources to which to subscribe to receive work messages. The Lambda
1072
- * function runs when it receives a message from an event source. You can subscribe this function
1073
- * to local publish/subscribe messages and Amazon Web Services IoT Core MQTT messages.</p>
1074
- */
1075
- eventSources?: LambdaEventSource[];
1076
-
1077
- /**
1078
- * <p>The maximum size of the message queue for the Lambda function component. The IoT Greengrass core
1079
- * stores messages in a FIFO (first-in-first-out) queue until it can run the Lambda function to
1080
- * consume each message.</p>
1081
- */
1082
- maxQueueSize?: number;
1083
-
1084
- /**
1085
- * <p>The maximum number of instances that a non-pinned Lambda function can run at the same
1086
- * time.</p>
1087
- */
1088
- maxInstancesCount?: number;
1089
-
1090
- /**
1091
- * <p>The maximum amount of time in seconds that a non-pinned Lambda function can idle before the
1092
- * IoT Greengrass Core software stops its process.</p>
1093
- */
1094
- maxIdleTimeInSeconds?: number;
1095
-
1096
- /**
1097
- * <p>The maximum amount of time in seconds that the Lambda function can process a work
1098
- * item.</p>
1099
- */
1100
- timeoutInSeconds?: number;
1101
-
1102
- /**
1103
- * <p>The interval in seconds at which a pinned (also known as long-lived) Lambda function
1104
- * component sends status updates to the Lambda manager component.</p>
1105
- */
1106
- statusTimeoutInSeconds?: number;
1107
-
1108
- /**
1109
- * <p>Whether or not the Lambda function is pinned, or long-lived.</p>
1110
- * <ul>
1111
- * <li>
1112
- * <p>A pinned Lambda function starts
1113
- * when IoT Greengrass starts and keeps running in its own container.</p>
1114
- * </li>
1115
- * <li>
1116
- * <p>A non-pinned Lambda function starts only when it receives a work item and exists after
1117
- * it idles for <code>maxIdleTimeInSeconds</code>. If the function has multiple work items,
1118
- * the IoT Greengrass Core software creates multiple instances of the function.</p>
1119
- * </li>
1120
- * </ul>
1121
- * <p>Default: <code>true</code>
1122
- * </p>
1123
- */
1124
- pinned?: boolean;
1125
-
1126
- /**
1127
- * <p>The encoding type that the Lambda function supports.</p>
1128
- * <p>Default: <code>json</code>
1129
- * </p>
1130
- */
1131
- inputPayloadEncodingType?: LambdaInputPayloadEncodingType | string;
1132
-
1133
- /**
1134
- * <p>The list of arguments to pass to the Lambda function when it runs.</p>
1135
- */
1136
- execArgs?: string[];
1137
-
1138
- /**
1139
- * <p>The map of environment variables that are available to the Lambda function when it runs.</p>
1140
- */
1141
- environmentVariables?: { [key: string]: string };
1142
-
1143
- /**
1144
- * <p>The parameters for the Linux process that contains the Lambda function.</p>
1145
- */
1146
- linuxProcessParams?: LambdaLinuxProcessParams;
1147
- }
1148
-
1149
- export namespace LambdaExecutionParameters {
1150
- /**
1151
- * @internal
1152
- */
1153
- export const filterSensitiveLog = (obj: LambdaExecutionParameters): any => ({
1154
- ...obj,
1155
- });
1156
- }
1157
-
1158
- /**
1159
- * <p>Contains information about an Lambda function to import to create a component.</p>
1160
- */
1161
- export interface LambdaFunctionRecipeSource {
1162
- /**
1163
- * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the Lambda function. The ARN must include the version of the function to
1164
- * import. You can't use version aliases like <code>$LATEST</code>.</p>
1165
- */
1166
- lambdaArn: string | undefined;
1167
-
1168
- /**
1169
- * <p>The name of the component.</p>
1170
- * <p>Defaults to the name of the Lambda function.</p>
1171
- */
1172
- componentName?: string;
1173
-
1174
- /**
1175
- * <p>The version of the component.</p>
1176
- * <p>Defaults to the version of the Lambda function as a semantic version. For example, if your
1177
- * function version is <code>3</code>, the component version becomes <code>3.0.0</code>.</p>
1178
- */
1179
- componentVersion?: string;
1180
-
1181
- /**
1182
- * <p>The platforms that the component version supports.</p>
1183
- */
1184
- componentPlatforms?: ComponentPlatform[];
1185
-
1186
- /**
1187
- * <p>The component versions on which this Lambda function component depends.</p>
1188
- */
1189
- componentDependencies?: { [key: string]: ComponentDependencyRequirement };
1190
-
1191
- /**
1192
- * <p>The system and runtime parameters for the Lambda function as it runs on the Greengrass core
1193
- * device.</p>
1194
- */
1195
- componentLambdaParameters?: LambdaExecutionParameters;
1196
- }
1197
-
1198
- export namespace LambdaFunctionRecipeSource {
1199
- /**
1200
- * @internal
1201
- */
1202
- export const filterSensitiveLog = (obj: LambdaFunctionRecipeSource): any => ({
1203
- ...obj,
1204
- });
1205
- }
1206
-
1207
- export interface CreateComponentVersionRequest {
1208
- /**
1209
- * <p>The recipe to use to create the component. The recipe defines the component's metadata,
1210
- * parameters, dependencies, lifecycle, artifacts, and platform compatibility.</p>
1211
- * <p>You must specify either <code>inlineRecipe</code> or <code>lambdaFunction</code>.</p>
1212
- */
1213
- inlineRecipe?: Uint8Array;
1214
-
1215
- /**
1216
- * <p>The parameters to create a component from a Lambda function.</p>
1217
- * <p>You must specify either <code>inlineRecipe</code> or <code>lambdaFunction</code>.</p>
1218
- */
1219
- lambdaFunction?: LambdaFunctionRecipeSource;
1220
-
1221
- /**
1222
- * <p>A list of key-value pairs that contain metadata for the resource. For more
1223
- * information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html">Tag your
1224
- * resources</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>
1225
- */
1226
- tags?: { [key: string]: string };
1227
-
1228
- /**
1229
- * <p>A unique, case-sensitive identifier that you can provide to ensure that the request is idempotent.
1230
- * Idempotency means that the request is successfully processed only once, even if you send the request multiple times.
1231
- * When a request succeeds, and you specify the same client token for subsequent successful requests, the IoT Greengrass V2 service
1232
- * returns the successful response that it caches from the previous request. IoT Greengrass V2 caches successful responses for
1233
- * idempotent requests for up to 8 hours.</p>
1234
- */
1235
- clientToken?: string;
1236
- }
1237
-
1238
- export namespace CreateComponentVersionRequest {
1239
- /**
1240
- * @internal
1241
- */
1242
- export const filterSensitiveLog = (obj: CreateComponentVersionRequest): any => ({
1243
- ...obj,
1244
- });
1245
- }
1246
-
1247
- export interface CreateComponentVersionResponse {
1248
- /**
1249
- * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the component version.</p>
1250
- */
1251
- arn?: string;
1252
-
1253
- /**
1254
- * <p>The name of the component.</p>
1255
- */
1256
- componentName: string | undefined;
1257
-
1258
- /**
1259
- * <p>The version of the component.</p>
1260
- */
1261
- componentVersion: string | undefined;
1262
-
1263
- /**
1264
- * <p>The time at which the component was created, expressed in ISO 8601 format.</p>
1265
- */
1266
- creationTimestamp: Date | undefined;
1267
-
1268
- /**
1269
- * <p>The status of the component version in IoT Greengrass V2. This status
1270
- * is different from the status of the component on a core device.</p>
1271
- */
1272
- status: CloudComponentStatus | undefined;
1273
- }
1274
-
1275
- export namespace CreateComponentVersionResponse {
1276
- /**
1277
- * @internal
1278
- */
1279
- export const filterSensitiveLog = (obj: CreateComponentVersionResponse): any => ({
1280
- ...obj,
1281
- });
1282
- }
1283
-
1284
- /**
1285
- * <p>The request is already in progress. This exception occurs when you use a client token for
1286
- * multiple requests while IoT Greengrass is still processing an earlier request that uses the same client
1287
- * token.</p>
1288
- */
1289
- export interface RequestAlreadyInProgressException extends __SmithyException, $MetadataBearer {
1290
- name: "RequestAlreadyInProgressException";
1291
- $fault: "client";
1292
- message: string | undefined;
1293
- }
1294
-
1295
- export namespace RequestAlreadyInProgressException {
1296
- /**
1297
- * @internal
1298
- */
1299
- export const filterSensitiveLog = (obj: RequestAlreadyInProgressException): any => ({
1300
- ...obj,
1301
- });
1302
- }
1303
-
1304
- /**
1305
- * <p>Your request exceeds a service quota. For example, you might have the maximum number of
1306
- * components that you can create.</p>
1307
- */
1308
- export interface ServiceQuotaExceededException extends __SmithyException, $MetadataBearer {
1309
- name: "ServiceQuotaExceededException";
1310
- $fault: "client";
1311
- message: string | undefined;
1312
- /**
1313
- * <p>The ID of the resource that exceeds the service quota.</p>
1314
- */
1315
- resourceId?: string;
1316
-
1317
- /**
1318
- * <p>The type of the resource that exceeds the service quota.</p>
1319
- */
1320
- resourceType?: string;
1321
-
1322
- /**
1323
- * <p>The code for the quota in <a href="https://docs.aws.amazon.com/servicequotas/latest/userguide/intro.html">Service Quotas</a>.</p>
1324
- */
1325
- quotaCode: string | undefined;
1326
-
1327
- /**
1328
- * <p>The code for the service in <a href="https://docs.aws.amazon.com/servicequotas/latest/userguide/intro.html">Service Quotas</a>.</p>
1329
- */
1330
- serviceCode: string | undefined;
1331
- }
1332
-
1333
- export namespace ServiceQuotaExceededException {
1334
- /**
1335
- * @internal
1336
- */
1337
- export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({
1338
- ...obj,
1339
- });
1340
- }
1341
-
1342
- export enum DeploymentComponentUpdatePolicyAction {
1343
- NOTIFY_COMPONENTS = "NOTIFY_COMPONENTS",
1344
- SKIP_NOTIFY_COMPONENTS = "SKIP_NOTIFY_COMPONENTS",
1345
- }
1346
-
1347
- /**
1348
- * <p>Contains information about a deployment's policy that defines when components are safe to
1349
- * update.</p>
1350
- * <p>Each component on a device can report whether or not it's ready to update. After a
1351
- * component and its dependencies are ready, they can apply the update in the deployment. You can
1352
- * configure whether or not the deployment notifies components of an update and waits for a
1353
- * response. You specify the amount of time each component has to respond to the update
1354
- * notification.</p>
1355
- */
1356
- export interface DeploymentComponentUpdatePolicy {
1357
- /**
1358
- * <p>The amount of time in seconds that each component on a device has to report that it's safe
1359
- * to update. If the component waits for longer than this timeout, then the deployment proceeds
1360
- * on the device.</p>
1361
- * <p>Default: <code>60</code>
1362
- * </p>
1363
- */
1364
- timeoutInSeconds?: number;
1365
-
1366
- /**
1367
- * <p>Whether or not to notify components and wait for components to become safe to update.
1368
- * Choose from the following options:</p>
1369
- * <ul>
1370
- * <li>
1371
- * <p>
1372
- * <code>NOTIFY_COMPONENTS</code> – The deployment notifies each component before
1373
- * it stops and updates that component. Components can use the <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-subscribetocomponentupdates">SubscribeToComponentUpdates</a> IPC operation to receive these notifications. Then,
1374
- * components can respond with the <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-defercomponentupdate">DeferComponentUpdate</a> IPC operation. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html">Create deployments</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>
1375
- * </li>
1376
- * <li>
1377
- * <p>
1378
- * <code>SKIP_NOTIFY_COMPONENTS</code> – The deployment doesn't notify components
1379
- * or wait for them to be safe to update.</p>
1380
- * </li>
1381
- * </ul>
1382
- * <p>Default: <code>NOTIFY_COMPONENTS</code>
1383
- * </p>
1384
- */
1385
- action?: DeploymentComponentUpdatePolicyAction | string;
1386
- }
1387
-
1388
- export namespace DeploymentComponentUpdatePolicy {
1389
- /**
1390
- * @internal
1391
- */
1392
- export const filterSensitiveLog = (obj: DeploymentComponentUpdatePolicy): any => ({
1393
- ...obj,
1394
- });
1395
- }
1396
-
1397
- /**
1398
- * <p>Contains information about how long a component on a core device can validate its
1399
- * configuration updates before it times out. Components can use the <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-subscribetovalidateconfigurationupdates">SubscribeToValidateConfigurationUpdates</a> IPC operation to receive notifications when
1400
- * a deployment specifies a configuration update. Then, components can respond with the <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-sendconfigurationvalidityreport">SendConfigurationValidityReport</a> IPC operation. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html">Create deployments</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>
1401
- */
1402
- export interface DeploymentConfigurationValidationPolicy {
1403
- /**
1404
- * <p>The amount of time in seconds that a component can validate its configuration updates. If
1405
- * the validation time exceeds this timeout, then the deployment proceeds for the device.</p>
1406
- * <p>Default: <code>30</code>
1407
- * </p>
1408
- */
1409
- timeoutInSeconds?: number;
1410
- }
1411
-
1412
- export namespace DeploymentConfigurationValidationPolicy {
1413
- /**
1414
- * @internal
1415
- */
1416
- export const filterSensitiveLog = (obj: DeploymentConfigurationValidationPolicy): any => ({
1417
- ...obj,
1418
- });
1419
- }
1420
-
1421
- export enum DeploymentFailureHandlingPolicy {
1422
- DO_NOTHING = "DO_NOTHING",
1423
- ROLLBACK = "ROLLBACK",
1424
- }
1425
-
1426
- /**
1427
- * <p>Contains information about policies that define how a deployment updates components and
1428
- * handles failure.</p>
1429
- */
1430
- export interface DeploymentPolicies {
1431
- /**
1432
- * <p>The failure handling policy for the configuration deployment. This policy defines what to
1433
- * do if the deployment fails.</p>
1434
- * <p>Default: <code>ROLLBACK</code>
1435
- * </p>
1436
- */
1437
- failureHandlingPolicy?: DeploymentFailureHandlingPolicy | string;
1438
-
1439
- /**
1440
- * <p>The component update policy for the configuration deployment. This policy defines when
1441
- * it's safe to deploy the configuration to devices.</p>
1442
- */
1443
- componentUpdatePolicy?: DeploymentComponentUpdatePolicy;
1444
-
1445
- /**
1446
- * <p>The configuration validation policy for the configuration deployment. This policy defines
1447
- * how long each component has to validate its configure updates.</p>
1448
- */
1449
- configurationValidationPolicy?: DeploymentConfigurationValidationPolicy;
1450
- }
1451
-
1452
- export namespace DeploymentPolicies {
1453
- /**
1454
- * @internal
1455
- */
1456
- export const filterSensitiveLog = (obj: DeploymentPolicies): any => ({
1457
- ...obj,
1458
- });
1459
- }
1460
-
1461
- export enum IoTJobAbortAction {
1462
- CANCEL = "CANCEL",
1463
- }
1464
-
1465
- export enum IoTJobExecutionFailureType {
1466
- ALL = "ALL",
1467
- FAILED = "FAILED",
1468
- REJECTED = "REJECTED",
1469
- TIMED_OUT = "TIMED_OUT",
1470
- }
1471
-
1472
- /**
1473
- * <p>Contains criteria that define when and how to cancel a job.</p>
1474
- * <p>The deployment stops if the following conditions are true:</p>
1475
- * <ol>
1476
- * <li>
1477
- * <p>The number of things that receive the deployment exceeds the
1478
- * <code>minNumberOfExecutedThings</code>.</p>
1479
- * </li>
1480
- * <li>
1481
- * <p>The percentage of failures with type <code>failureType</code> exceeds the
1482
- * <code>thresholdPercentage</code>.</p>
1483
- * </li>
1484
- * </ol>
1485
- */
1486
- export interface IoTJobAbortCriteria {
1487
- /**
1488
- * <p>The type of job deployment failure that can cancel a job.</p>
1489
- */
1490
- failureType: IoTJobExecutionFailureType | string | undefined;
1491
-
1492
- /**
1493
- * <p>The action to perform when the criteria are met.</p>
1494
- */
1495
- action: IoTJobAbortAction | string | undefined;
1496
-
1497
- /**
1498
- * <p>The minimum percentage of <code>failureType</code> failures that occur before the job can
1499
- * cancel.</p>
1500
- * <p>This parameter supports up to two digits after the decimal (for example, you can specify
1501
- * <code>10.9</code> or <code>10.99</code>, but not <code>10.999</code>).</p>
1502
- */
1503
- thresholdPercentage: number | undefined;
1504
-
1505
- /**
1506
- * <p>The minimum number of things that receive the configuration before the job can
1507
- * cancel.</p>
1508
- */
1509
- minNumberOfExecutedThings: number | undefined;
1510
- }
1511
-
1512
- export namespace IoTJobAbortCriteria {
1513
- /**
1514
- * @internal
1515
- */
1516
- export const filterSensitiveLog = (obj: IoTJobAbortCriteria): any => ({
1517
- ...obj,
1518
- });
1519
- }
1520
-
1521
- /**
1522
- * <p>Contains a list of criteria that define when and how to cancel a configuration
1523
- * deployment.</p>
1524
- */
1525
- export interface IoTJobAbortConfig {
1526
- /**
1527
- * <p>The list of criteria that define when and how to cancel the configuration deployment.</p>
1528
- */
1529
- criteriaList: IoTJobAbortCriteria[] | undefined;
1530
- }
1531
-
1532
- export namespace IoTJobAbortConfig {
1533
- /**
1534
- * @internal
1535
- */
1536
- export const filterSensitiveLog = (obj: IoTJobAbortConfig): any => ({
1537
- ...obj,
1538
- });
1539
- }
1540
-
1541
- /**
1542
- * <p>Contains information about criteria to meet before a job increases its rollout rate.
1543
- * Specify either <code>numberOfNotifiedThings</code> or
1544
- * <code>numberOfSucceededThings</code>.</p>
1545
- */
1546
- export interface IoTJobRateIncreaseCriteria {
1547
- /**
1548
- * <p>The number of devices to receive the job notification before the rollout rate
1549
- * increases.</p>
1550
- */
1551
- numberOfNotifiedThings?: number;
1552
-
1553
- /**
1554
- * <p>The number of devices to successfully run the configuration job before the rollout rate
1555
- * increases.</p>
1556
- */
1557
- numberOfSucceededThings?: number;
1558
- }
1559
-
1560
- export namespace IoTJobRateIncreaseCriteria {
1561
- /**
1562
- * @internal
1563
- */
1564
- export const filterSensitiveLog = (obj: IoTJobRateIncreaseCriteria): any => ({
1565
- ...obj,
1566
- });
1567
- }
1568
-
1569
- /**
1570
- * <p>Contains information about an exponential rollout rate for a configuration deployment
1571
- * job.</p>
1572
- */
1573
- export interface IoTJobExponentialRolloutRate {
1574
- /**
1575
- * <p>The minimum number of devices that receive a pending job notification, per minute, when
1576
- * the job starts. This parameter defines the initial rollout rate of the job.</p>
1577
- */
1578
- baseRatePerMinute: number | undefined;
1579
-
1580
- /**
1581
- * <p>The exponential factor to increase the rollout rate for the job.</p>
1582
- * <p>This parameter supports up to one digit after the decimal (for example, you can specify
1583
- * <code>1.5</code>, but not <code>1.55</code>).</p>
1584
- */
1585
- incrementFactor: number | undefined;
1586
-
1587
- /**
1588
- * <p>The criteria to increase the rollout rate for the job.</p>
1589
- */
1590
- rateIncreaseCriteria: IoTJobRateIncreaseCriteria | undefined;
1591
- }
1592
-
1593
- export namespace IoTJobExponentialRolloutRate {
1594
- /**
1595
- * @internal
1596
- */
1597
- export const filterSensitiveLog = (obj: IoTJobExponentialRolloutRate): any => ({
1598
- ...obj,
1599
- });
1600
- }
1601
-
1602
- /**
1603
- * <p>Contains information about the rollout configuration for a job. This configuration defines
1604
- * the rate at which the job deploys a configuration to a fleet of target devices.</p>
1605
- */
1606
- export interface IoTJobExecutionsRolloutConfig {
1607
- /**
1608
- * <p>The exponential rate to increase the job rollout rate.</p>
1609
- */
1610
- exponentialRate?: IoTJobExponentialRolloutRate;
1611
-
1612
- /**
1613
- * <p>The maximum number of devices that receive a pending job notification, per minute.</p>
1614
- */
1615
- maximumPerMinute?: number;
1616
- }
1617
-
1618
- export namespace IoTJobExecutionsRolloutConfig {
1619
- /**
1620
- * @internal
1621
- */
1622
- export const filterSensitiveLog = (obj: IoTJobExecutionsRolloutConfig): any => ({
1623
- ...obj,
1624
- });
1625
- }
1626
-
1627
- /**
1628
- * <p>Contains information about the timeout configuration for a job.</p>
1629
- */
1630
- export interface IoTJobTimeoutConfig {
1631
- /**
1632
- * <p>The amount of time, in minutes, that devices have to complete the job. The timer starts
1633
- * when the job status is set to <code>IN_PROGRESS</code>. If the job status doesn't change to a
1634
- * terminal state before the time expires, then the job status is set to
1635
- * <code>TIMED_OUT</code>.</p>
1636
- * <p>The timeout interval must be between 1 minute and 7 days (10080 minutes).</p>
1637
- */
1638
- inProgressTimeoutInMinutes?: number;
1639
- }
1640
-
1641
- export namespace IoTJobTimeoutConfig {
1642
- /**
1643
- * @internal
1644
- */
1645
- export const filterSensitiveLog = (obj: IoTJobTimeoutConfig): any => ({
1646
- ...obj,
1647
- });
1648
- }
1649
-
1650
- /**
1651
- * <p>Contains information about an IoT job configuration.</p>
1652
- */
1653
- export interface DeploymentIoTJobConfiguration {
1654
- /**
1655
- * <p>The rollout configuration for the job. This configuration defines the rate at which the
1656
- * job rolls out to the fleet of target devices.</p>
1657
- */
1658
- jobExecutionsRolloutConfig?: IoTJobExecutionsRolloutConfig;
1659
-
1660
- /**
1661
- * <p>The stop configuration for the job. This configuration defines when and how to stop a job
1662
- * rollout.</p>
1663
- */
1664
- abortConfig?: IoTJobAbortConfig;
1665
-
1666
- /**
1667
- * <p>The timeout configuration for the job. This configuration defines the amount of time each
1668
- * device has to complete the job.</p>
1669
- */
1670
- timeoutConfig?: IoTJobTimeoutConfig;
1671
- }
1672
-
1673
- export namespace DeploymentIoTJobConfiguration {
1674
- /**
1675
- * @internal
1676
- */
1677
- export const filterSensitiveLog = (obj: DeploymentIoTJobConfiguration): any => ({
1678
- ...obj,
1679
- });
1680
- }
1681
-
1682
- export interface CreateDeploymentRequest {
1683
- /**
1684
- * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the target IoT thing or thing group.</p>
1685
- */
1686
- targetArn: string | undefined;
1687
-
1688
- /**
1689
- * <p>The name of the deployment.</p>
1690
- */
1691
- deploymentName?: string;
1692
-
1693
- /**
1694
- * <p>The components to deploy. This is a dictionary, where each key is the name of a component,
1695
- * and each key's value is the version and configuration to deploy for that component.</p>
1696
- */
1697
- components?: { [key: string]: ComponentDeploymentSpecification };
1698
-
1699
- /**
1700
- * <p>The job configuration for the deployment configuration. The job configuration specifies
1701
- * the rollout, timeout, and stop configurations for the deployment configuration.</p>
1702
- */
1703
- iotJobConfiguration?: DeploymentIoTJobConfiguration;
1704
-
1705
- /**
1706
- * <p>The deployment policies for the deployment. These policies define how the deployment
1707
- * updates components and handles failure.</p>
1708
- */
1709
- deploymentPolicies?: DeploymentPolicies;
1710
-
1711
- /**
1712
- * <p>A list of key-value pairs that contain metadata for the resource. For more
1713
- * information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html">Tag your
1714
- * resources</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>
1715
- */
1716
- tags?: { [key: string]: string };
1717
-
1718
- /**
1719
- * <p>A unique, case-sensitive identifier that you can provide to ensure that the request is idempotent.
1720
- * Idempotency means that the request is successfully processed only once, even if you send the request multiple times.
1721
- * When a request succeeds, and you specify the same client token for subsequent successful requests, the IoT Greengrass V2 service
1722
- * returns the successful response that it caches from the previous request. IoT Greengrass V2 caches successful responses for
1723
- * idempotent requests for up to 8 hours.</p>
1724
- */
1725
- clientToken?: string;
1726
- }
1727
-
1728
- export namespace CreateDeploymentRequest {
1729
- /**
1730
- * @internal
1731
- */
1732
- export const filterSensitiveLog = (obj: CreateDeploymentRequest): any => ({
1733
- ...obj,
1734
- });
1735
- }
1736
-
1737
- export interface CreateDeploymentResponse {
1738
- /**
1739
- * <p>The ID of the deployment.</p>
1740
- */
1741
- deploymentId?: string;
1742
-
1743
- /**
1744
- * <p>The ID of the IoT job that applies the deployment to target devices.</p>
1745
- */
1746
- iotJobId?: string;
1747
-
1748
- /**
1749
- * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the IoT job that applies the deployment to target devices.</p>
1750
- */
1751
- iotJobArn?: string;
1752
- }
1753
-
1754
- export namespace CreateDeploymentResponse {
1755
- /**
1756
- * @internal
1757
- */
1758
- export const filterSensitiveLog = (obj: CreateDeploymentResponse): any => ({
1759
- ...obj,
1760
- });
1761
- }
1762
-
1763
- export interface DeleteComponentRequest {
1764
- /**
1765
- * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the component version.</p>
1766
- */
1767
- arn: string | undefined;
1768
- }
1769
-
1770
- export namespace DeleteComponentRequest {
1771
- /**
1772
- * @internal
1773
- */
1774
- export const filterSensitiveLog = (obj: DeleteComponentRequest): any => ({
1775
- ...obj,
1776
- });
1777
- }
1778
-
1779
- export interface DeleteCoreDeviceRequest {
1780
- /**
1781
- * <p>The name of the core device. This is also the name of the IoT thing.</p>
1782
- */
1783
- coreDeviceThingName: string | undefined;
1784
- }
1785
-
1786
- export namespace DeleteCoreDeviceRequest {
1787
- /**
1788
- * @internal
1789
- */
1790
- export const filterSensitiveLog = (obj: DeleteCoreDeviceRequest): any => ({
1791
- ...obj,
1792
- });
1793
- }
1794
-
1795
- export enum DeploymentStatus {
1796
- ACTIVE = "ACTIVE",
1797
- CANCELED = "CANCELED",
1798
- COMPLETED = "COMPLETED",
1799
- FAILED = "FAILED",
1800
- INACTIVE = "INACTIVE",
1801
- }
1802
-
1803
- /**
1804
- * <p>Contains information about a deployment.</p>
1805
- */
1806
- export interface Deployment {
1807
- /**
1808
- * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the target IoT thing or thing group.</p>
1809
- */
1810
- targetArn?: string;
1811
-
1812
- /**
1813
- * <p>The revision number of the deployment.</p>
1814
- */
1815
- revisionId?: string;
1816
-
1817
- /**
1818
- * <p>The ID of the deployment.</p>
1819
- */
1820
- deploymentId?: string;
1821
-
1822
- /**
1823
- * <p>The name of the deployment.</p>
1824
- */
1825
- deploymentName?: string;
1826
-
1827
- /**
1828
- * <p>The time at which the deployment was created, expressed in ISO 8601 format.</p>
1829
- */
1830
- creationTimestamp?: Date;
1831
-
1832
- /**
1833
- * <p>The status of the deployment.</p>
1834
- */
1835
- deploymentStatus?: DeploymentStatus | string;
1836
-
1837
- /**
1838
- * <p>Whether or not the deployment is the latest revision for its target.</p>
1839
- */
1840
- isLatestForTarget?: boolean;
1841
- }
1842
-
1843
- export namespace Deployment {
1844
- /**
1845
- * @internal
1846
- */
1847
- export const filterSensitiveLog = (obj: Deployment): any => ({
1848
- ...obj,
1849
- });
1850
- }
1851
-
1852
- export enum DeploymentHistoryFilter {
1853
- ALL = "ALL",
1854
- LATEST_ONLY = "LATEST_ONLY",
1855
- }
1856
-
1857
- export interface DescribeComponentRequest {
1858
- /**
1859
- * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the component version.</p>
1860
- */
1861
- arn: string | undefined;
1862
- }
1863
-
1864
- export namespace DescribeComponentRequest {
1865
- /**
1866
- * @internal
1867
- */
1868
- export const filterSensitiveLog = (obj: DescribeComponentRequest): any => ({
1869
- ...obj,
1870
- });
1871
- }
1872
-
1873
- export interface DescribeComponentResponse {
1874
- /**
1875
- * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the component version.</p>
1876
- */
1877
- arn?: string;
1878
-
1879
- /**
1880
- * <p>The name of the component.</p>
1881
- */
1882
- componentName?: string;
1883
-
1884
- /**
1885
- * <p>The version of the component.</p>
1886
- */
1887
- componentVersion?: string;
1888
-
1889
- /**
1890
- * <p>The time at which the component was created, expressed in ISO 8601 format.</p>
1891
- */
1892
- creationTimestamp?: Date;
1893
-
1894
- /**
1895
- * <p>The publisher of the component version.</p>
1896
- */
1897
- publisher?: string;
1898
-
1899
- /**
1900
- * <p>The description of the component version.</p>
1901
- */
1902
- description?: string;
1903
-
1904
- /**
1905
- * <p>The status of the component version in IoT Greengrass V2. This status
1906
- * is different from the status of the component on a core device.</p>
1907
- */
1908
- status?: CloudComponentStatus;
1909
-
1910
- /**
1911
- * <p>The platforms that the component version supports.</p>
1912
- */
1913
- platforms?: ComponentPlatform[];
1914
-
1915
- /**
1916
- * <p>A list of key-value pairs that contain metadata for the resource. For more
1917
- * information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html">Tag your
1918
- * resources</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>
1919
- */
1920
- tags?: { [key: string]: string };
1921
- }
1922
-
1923
- export namespace DescribeComponentResponse {
1924
- /**
1925
- * @internal
1926
- */
1927
- export const filterSensitiveLog = (obj: DescribeComponentResponse): any => ({
1928
- ...obj,
1929
- });
1930
- }
1931
-
1932
- export enum EffectiveDeploymentExecutionStatus {
1933
- CANCELED = "CANCELED",
1934
- COMPLETED = "COMPLETED",
1935
- FAILED = "FAILED",
1936
- IN_PROGRESS = "IN_PROGRESS",
1937
- QUEUED = "QUEUED",
1938
- REJECTED = "REJECTED",
1939
- TIMED_OUT = "TIMED_OUT",
1940
- }
1941
-
1942
- /**
1943
- * <p>Contains information about a deployment job that IoT Greengrass sends to a Greengrass core device.</p>
1944
- */
1945
- export interface EffectiveDeployment {
1946
- /**
1947
- * <p>The ID of the deployment.</p>
1948
- */
1949
- deploymentId: string | undefined;
1950
-
1951
- /**
1952
- * <p>The name of the deployment.</p>
1953
- */
1954
- deploymentName: string | undefined;
1955
-
1956
- /**
1957
- * <p>The ID of the IoT job that applies the deployment to target devices.</p>
1958
- */
1959
- iotJobId?: string;
1960
-
1961
- /**
1962
- * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the IoT job that applies the deployment to target devices.</p>
1963
- */
1964
- iotJobArn?: string;
1965
-
1966
- /**
1967
- * <p>The description of the deployment job.</p>
1968
- */
1969
- description?: string;
1970
-
1971
- /**
1972
- * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the target IoT thing or thing group.</p>
1973
- */
1974
- targetArn: string | undefined;
1975
-
1976
- /**
1977
- * <p>The status of the deployment job on the Greengrass core device.</p>
1978
- */
1979
- coreDeviceExecutionStatus: EffectiveDeploymentExecutionStatus | string | undefined;
1980
-
1981
- /**
1982
- * <p>The reason code for the update, if the job was updated.</p>
1983
- */
1984
- reason?: string;
1985
-
1986
- /**
1987
- * <p>The time at which the deployment was created, expressed in ISO 8601 format.</p>
1988
- */
1989
- creationTimestamp: Date | undefined;
1990
-
1991
- /**
1992
- * <p>The time at which the deployment job was last modified, expressed in ISO 8601
1993
- * format.</p>
1994
- */
1995
- modifiedTimestamp: Date | undefined;
1996
- }
1997
-
1998
- export namespace EffectiveDeployment {
1999
- /**
2000
- * @internal
2001
- */
2002
- export const filterSensitiveLog = (obj: EffectiveDeployment): any => ({
2003
- ...obj,
2004
- });
2005
- }
2006
-
2007
- export enum RecipeOutputFormat {
2008
- JSON = "JSON",
2009
- YAML = "YAML",
2010
- }
2011
-
2012
- export interface GetComponentRequest {
2013
- /**
2014
- * <p>The format of the recipe.</p>
2015
- */
2016
- recipeOutputFormat?: RecipeOutputFormat | string;
2017
-
2018
- /**
2019
- * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the component version.</p>
2020
- */
2021
- arn: string | undefined;
2022
- }
2023
-
2024
- export namespace GetComponentRequest {
2025
- /**
2026
- * @internal
2027
- */
2028
- export const filterSensitiveLog = (obj: GetComponentRequest): any => ({
2029
- ...obj,
2030
- });
2031
- }
2032
-
2033
- export interface GetComponentResponse {
2034
- /**
2035
- * <p>The format of the recipe.</p>
2036
- */
2037
- recipeOutputFormat: RecipeOutputFormat | string | undefined;
2038
-
2039
- /**
2040
- * <p>The recipe of the component version.</p>
2041
- */
2042
- recipe: Uint8Array | undefined;
2043
-
2044
- /**
2045
- * <p>A list of key-value pairs that contain metadata for the resource. For more
2046
- * information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html">Tag your
2047
- * resources</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>
2048
- */
2049
- tags?: { [key: string]: string };
2050
- }
2051
-
2052
- export namespace GetComponentResponse {
2053
- /**
2054
- * @internal
2055
- */
2056
- export const filterSensitiveLog = (obj: GetComponentResponse): any => ({
2057
- ...obj,
2058
- });
2059
- }
2060
-
2061
- export interface GetComponentVersionArtifactRequest {
2062
- /**
2063
- * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the component version. Specify the ARN of a public component version.</p>
2064
- */
2065
- arn: string | undefined;
2066
-
2067
- /**
2068
- * <p>The name of the artifact.</p>
2069
- * <p>You can use the <a href="https://docs.aws.amazon.com/greengrass/v2/APIReference/API_GetComponent.html">GetComponent</a> operation to
2070
- * download the component recipe, which includes the URI of the artifact. The artifact name is
2071
- * the section of the URI after the scheme. For example, in the artifact URI
2072
- * <code>greengrass:SomeArtifact.zip</code>, the artifact name is
2073
- * <code>SomeArtifact.zip</code>.</p>
2074
- */
2075
- artifactName: string | undefined;
2076
- }
2077
-
2078
- export namespace GetComponentVersionArtifactRequest {
2079
- /**
2080
- * @internal
2081
- */
2082
- export const filterSensitiveLog = (obj: GetComponentVersionArtifactRequest): any => ({
2083
- ...obj,
2084
- });
2085
- }
2086
-
2087
- export interface GetComponentVersionArtifactResponse {
2088
- /**
2089
- * <p>The URL of the artifact.</p>
2090
- */
2091
- preSignedUrl: string | undefined;
2092
- }
2093
-
2094
- export namespace GetComponentVersionArtifactResponse {
2095
- /**
2096
- * @internal
2097
- */
2098
- export const filterSensitiveLog = (obj: GetComponentVersionArtifactResponse): any => ({
2099
- ...obj,
2100
- });
2101
- }
2102
-
2103
- export interface GetCoreDeviceRequest {
2104
- /**
2105
- * <p>The name of the core device. This is also the name of the IoT thing.</p>
2106
- */
2107
- coreDeviceThingName: string | undefined;
2108
- }
2109
-
2110
- export namespace GetCoreDeviceRequest {
2111
- /**
2112
- * @internal
2113
- */
2114
- export const filterSensitiveLog = (obj: GetCoreDeviceRequest): any => ({
2115
- ...obj,
2116
- });
2117
- }
2118
-
2119
- export interface GetCoreDeviceResponse {
2120
- /**
2121
- * <p>The name of the core device. This is also the name of the IoT thing.</p>
2122
- */
2123
- coreDeviceThingName?: string;
2124
-
2125
- /**
2126
- * <p>The version of the IoT Greengrass Core software that the core device runs. This version is equivalent to
2127
- * the version of the Greengrass nucleus component that runs on the core device. For more information,
2128
- * see the <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html">Greengrass nucleus
2129
- * component</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>
2130
- */
2131
- coreVersion?: string;
2132
-
2133
- /**
2134
- * <p>The operating system platform that the core device runs.</p>
2135
- */
2136
- platform?: string;
2137
-
2138
- /**
2139
- * <p>The computer architecture of the core device.</p>
2140
- */
2141
- architecture?: string;
2142
-
2143
- /**
2144
- * <p>The status of the core device. The core device status can be:</p>
2145
- * <ul>
2146
- * <li>
2147
- * <p>
2148
- * <code>HEALTHY</code> – The IoT Greengrass Core software and all components run on the core device without issue.</p>
2149
- * </li>
2150
- * <li>
2151
- * <p>
2152
- * <code>UNHEALTHY</code> – The IoT Greengrass Core software or a component is in a failed state
2153
- * on the core device.</p>
2154
- * </li>
2155
- * </ul>
2156
- */
2157
- status?: CoreDeviceStatus | string;
2158
-
2159
- /**
2160
- * <p>The time at which the core device's status last updated, expressed in ISO 8601
2161
- * format.</p>
2162
- */
2163
- lastStatusUpdateTimestamp?: Date;
2164
-
2165
- /**
2166
- * <p>A list of key-value pairs that contain metadata for the resource. For more
2167
- * information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html">Tag your
2168
- * resources</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>
2169
- */
2170
- tags?: { [key: string]: string };
2171
- }
2172
-
2173
- export namespace GetCoreDeviceResponse {
2174
- /**
2175
- * @internal
2176
- */
2177
- export const filterSensitiveLog = (obj: GetCoreDeviceResponse): any => ({
2178
- ...obj,
2179
- });
2180
- }
2181
-
2182
- export interface GetDeploymentRequest {
2183
- /**
2184
- * <p>The ID of the deployment.</p>
2185
- */
2186
- deploymentId: string | undefined;
2187
- }
2188
-
2189
- export namespace GetDeploymentRequest {
2190
- /**
2191
- * @internal
2192
- */
2193
- export const filterSensitiveLog = (obj: GetDeploymentRequest): any => ({
2194
- ...obj,
2195
- });
2196
- }
2197
-
2198
- export interface GetDeploymentResponse {
2199
- /**
2200
- * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the target IoT thing or thing group.</p>
2201
- */
2202
- targetArn?: string;
2203
-
2204
- /**
2205
- * <p>The revision number of the deployment.</p>
2206
- */
2207
- revisionId?: string;
2208
-
2209
- /**
2210
- * <p>The ID of the deployment.</p>
2211
- */
2212
- deploymentId?: string;
2213
-
2214
- /**
2215
- * <p>The name of the deployment.</p>
2216
- */
2217
- deploymentName?: string;
2218
-
2219
- /**
2220
- * <p>The status of the deployment.</p>
2221
- */
2222
- deploymentStatus?: DeploymentStatus | string;
2223
-
2224
- /**
2225
- * <p>The ID of the IoT job that applies the deployment to target devices.</p>
2226
- */
2227
- iotJobId?: string;
2228
-
2229
- /**
2230
- * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the IoT job that applies the deployment to target devices.</p>
2231
- */
2232
- iotJobArn?: string;
2233
-
2234
- /**
2235
- * <p>The components to deploy. This is a dictionary, where each key is the name of a component,
2236
- * and each key's value is the version and configuration to deploy for that component.</p>
2237
- */
2238
- components?: { [key: string]: ComponentDeploymentSpecification };
2239
-
2240
- /**
2241
- * <p>The deployment policies for the deployment. These policies define how the deployment
2242
- * updates components and handles failure.</p>
2243
- */
2244
- deploymentPolicies?: DeploymentPolicies;
2245
-
2246
- /**
2247
- * <p>The job configuration for the deployment configuration. The job configuration specifies
2248
- * the rollout, timeout, and stop configurations for the deployment configuration.</p>
2249
- */
2250
- iotJobConfiguration?: DeploymentIoTJobConfiguration;
2251
-
2252
- /**
2253
- * <p>The time at which the deployment was created, expressed in ISO 8601 format.</p>
2254
- */
2255
- creationTimestamp?: Date;
2256
-
2257
- /**
2258
- * <p>Whether or not the deployment is the latest revision for its target.</p>
2259
- */
2260
- isLatestForTarget?: boolean;
2261
-
2262
- /**
2263
- * <p>A list of key-value pairs that contain metadata for the resource. For more
2264
- * information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html">Tag your
2265
- * resources</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>
2266
- */
2267
- tags?: { [key: string]: string };
2268
- }
2269
-
2270
- export namespace GetDeploymentResponse {
2271
- /**
2272
- * @internal
2273
- */
2274
- export const filterSensitiveLog = (obj: GetDeploymentResponse): any => ({
2275
- ...obj,
2276
- });
2277
- }
2278
-
2279
- export interface ListClientDevicesAssociatedWithCoreDeviceRequest {
2280
- /**
2281
- * <p>The name of the core device. This is also the name of the IoT thing.</p>
2282
- */
2283
- coreDeviceThingName: string | undefined;
2284
-
2285
- /**
2286
- * <p>The maximum number of results to be returned per paginated request.</p>
2287
- */
2288
- maxResults?: number;
2289
-
2290
- /**
2291
- * <p>The token to be used for the next set of paginated results.</p>
2292
- */
2293
- nextToken?: string;
2294
- }
2295
-
2296
- export namespace ListClientDevicesAssociatedWithCoreDeviceRequest {
2297
- /**
2298
- * @internal
2299
- */
2300
- export const filterSensitiveLog = (obj: ListClientDevicesAssociatedWithCoreDeviceRequest): any => ({
2301
- ...obj,
2302
- });
2303
- }
2304
-
2305
- export interface ListClientDevicesAssociatedWithCoreDeviceResponse {
2306
- /**
2307
- * <p>A list that describes the client devices that are associated with the core device.</p>
2308
- */
2309
- associatedClientDevices?: AssociatedClientDevice[];
2310
-
2311
- /**
2312
- * <p>The token for the next set of results, or null if there are no additional results.</p>
2313
- */
2314
- nextToken?: string;
2315
- }
2316
-
2317
- export namespace ListClientDevicesAssociatedWithCoreDeviceResponse {
2318
- /**
2319
- * @internal
2320
- */
2321
- export const filterSensitiveLog = (obj: ListClientDevicesAssociatedWithCoreDeviceResponse): any => ({
2322
- ...obj,
2323
- });
2324
- }
2325
-
2326
- export interface ListComponentsRequest {
2327
- /**
2328
- * <p>The scope of the components to list.</p>
2329
- * <p>Default: <code>PRIVATE</code>
2330
- * </p>
2331
- */
2332
- scope?: ComponentVisibilityScope | string;
2333
-
2334
- /**
2335
- * <p>The maximum number of results to be returned per paginated request.</p>
2336
- */
2337
- maxResults?: number;
2338
-
2339
- /**
2340
- * <p>The token to be used for the next set of paginated results.</p>
2341
- */
2342
- nextToken?: string;
2343
- }
2344
-
2345
- export namespace ListComponentsRequest {
2346
- /**
2347
- * @internal
2348
- */
2349
- export const filterSensitiveLog = (obj: ListComponentsRequest): any => ({
2350
- ...obj,
2351
- });
2352
- }
2353
-
2354
- export interface ListComponentsResponse {
2355
- /**
2356
- * <p>A list that summarizes each component.</p>
2357
- */
2358
- components?: Component[];
2359
-
2360
- /**
2361
- * <p>The token for the next set of results, or null if there are no additional results.</p>
2362
- */
2363
- nextToken?: string;
2364
- }
2365
-
2366
- export namespace ListComponentsResponse {
2367
- /**
2368
- * @internal
2369
- */
2370
- export const filterSensitiveLog = (obj: ListComponentsResponse): any => ({
2371
- ...obj,
2372
- });
2373
- }
2374
-
2375
- export interface ListComponentVersionsRequest {
2376
- /**
2377
- * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the component version.</p>
2378
- */
2379
- arn: string | undefined;
2380
-
2381
- /**
2382
- * <p>The maximum number of results to be returned per paginated request.</p>
2383
- */
2384
- maxResults?: number;
2385
-
2386
- /**
2387
- * <p>The token to be used for the next set of paginated results.</p>
2388
- */
2389
- nextToken?: string;
2390
- }
2391
-
2392
- export namespace ListComponentVersionsRequest {
2393
- /**
2394
- * @internal
2395
- */
2396
- export const filterSensitiveLog = (obj: ListComponentVersionsRequest): any => ({
2397
- ...obj,
2398
- });
2399
- }
2400
-
2401
- export interface ListComponentVersionsResponse {
2402
- /**
2403
- * <p>A list of versions that exist for the component.</p>
2404
- */
2405
- componentVersions?: ComponentVersionListItem[];
2406
-
2407
- /**
2408
- * <p>The token for the next set of results, or null if there are no additional results.</p>
2409
- */
2410
- nextToken?: string;
2411
- }
2412
-
2413
- export namespace ListComponentVersionsResponse {
2414
- /**
2415
- * @internal
2416
- */
2417
- export const filterSensitiveLog = (obj: ListComponentVersionsResponse): any => ({
2418
- ...obj,
2419
- });
2420
- }
2421
-
2422
- export interface ListCoreDevicesRequest {
2423
- /**
2424
- * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the IoT thing group by which to filter. If you specify this parameter, the
2425
- * list includes only core devices that are members of this thing group.</p>
2426
- */
2427
- thingGroupArn?: string;
2428
-
2429
- /**
2430
- * <p>The core device status by which to filter. If you specify this parameter, the list
2431
- * includes only core devices that have this status. Choose one of the following options:</p>
2432
- * <ul>
2433
- * <li>
2434
- * <p>
2435
- * <code>HEALTHY</code> – The IoT Greengrass Core software and all components run on the core device without issue.</p>
2436
- * </li>
2437
- * <li>
2438
- * <p>
2439
- * <code>UNHEALTHY</code> – The IoT Greengrass Core software or a component is in a failed state
2440
- * on the core device.</p>
2441
- * </li>
2442
- * </ul>
2443
- */
2444
- status?: CoreDeviceStatus | string;
2445
-
2446
- /**
2447
- * <p>The maximum number of results to be returned per paginated request.</p>
2448
- */
2449
- maxResults?: number;
2450
-
2451
- /**
2452
- * <p>The token to be used for the next set of paginated results.</p>
2453
- */
2454
- nextToken?: string;
2455
- }
2456
-
2457
- export namespace ListCoreDevicesRequest {
2458
- /**
2459
- * @internal
2460
- */
2461
- export const filterSensitiveLog = (obj: ListCoreDevicesRequest): any => ({
2462
- ...obj,
2463
- });
2464
- }
2465
-
2466
- export interface ListCoreDevicesResponse {
2467
- /**
2468
- * <p>A list that summarizes each core device.</p>
2469
- */
2470
- coreDevices?: CoreDevice[];
2471
-
2472
- /**
2473
- * <p>The token for the next set of results, or null if there are no additional results.</p>
2474
- */
2475
- nextToken?: string;
2476
- }
2477
-
2478
- export namespace ListCoreDevicesResponse {
2479
- /**
2480
- * @internal
2481
- */
2482
- export const filterSensitiveLog = (obj: ListCoreDevicesResponse): any => ({
2483
- ...obj,
2484
- });
2485
- }
2486
-
2487
- export interface ListDeploymentsRequest {
2488
- /**
2489
- * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the target IoT thing or thing group.</p>
2490
- */
2491
- targetArn?: string;
2492
-
2493
- /**
2494
- * <p>The filter for the list of deployments. Choose one of the following options:</p>
2495
- * <ul>
2496
- * <li>
2497
- * <p>
2498
- * <code>ALL</code> – The list includes all deployments.</p>
2499
- * </li>
2500
- * <li>
2501
- * <p>
2502
- * <code>LATEST_ONLY</code> – The list includes only the latest revision of each
2503
- * deployment.</p>
2504
- * </li>
2505
- * </ul>
2506
- * <p>Default: <code>LATEST_ONLY</code>
2507
- * </p>
2508
- */
2509
- historyFilter?: DeploymentHistoryFilter | string;
2510
-
2511
- /**
2512
- * <p>The maximum number of results to be returned per paginated request.</p>
2513
- */
2514
- maxResults?: number;
2515
-
2516
- /**
2517
- * <p>The token to be used for the next set of paginated results.</p>
2518
- */
2519
- nextToken?: string;
2520
- }
2521
-
2522
- export namespace ListDeploymentsRequest {
2523
- /**
2524
- * @internal
2525
- */
2526
- export const filterSensitiveLog = (obj: ListDeploymentsRequest): any => ({
2527
- ...obj,
2528
- });
2529
- }
2530
-
2531
- export interface ListDeploymentsResponse {
2532
- /**
2533
- * <p>A list that summarizes each deployment.</p>
2534
- */
2535
- deployments?: Deployment[];
2536
-
2537
- /**
2538
- * <p>The token for the next set of results, or null if there are no additional results.</p>
2539
- */
2540
- nextToken?: string;
2541
- }
2542
-
2543
- export namespace ListDeploymentsResponse {
2544
- /**
2545
- * @internal
2546
- */
2547
- export const filterSensitiveLog = (obj: ListDeploymentsResponse): any => ({
2548
- ...obj,
2549
- });
2550
- }
2551
-
2552
- export interface ListEffectiveDeploymentsRequest {
2553
- /**
2554
- * <p>The name of the core device. This is also the name of the IoT thing.</p>
2555
- */
2556
- coreDeviceThingName: string | undefined;
2557
-
2558
- /**
2559
- * <p>The maximum number of results to be returned per paginated request.</p>
2560
- */
2561
- maxResults?: number;
2562
-
2563
- /**
2564
- * <p>The token to be used for the next set of paginated results.</p>
2565
- */
2566
- nextToken?: string;
2567
- }
2568
-
2569
- export namespace ListEffectiveDeploymentsRequest {
2570
- /**
2571
- * @internal
2572
- */
2573
- export const filterSensitiveLog = (obj: ListEffectiveDeploymentsRequest): any => ({
2574
- ...obj,
2575
- });
2576
- }
2577
-
2578
- export interface ListEffectiveDeploymentsResponse {
2579
- /**
2580
- * <p>A list that summarizes each deployment on the core device.</p>
2581
- */
2582
- effectiveDeployments?: EffectiveDeployment[];
2583
-
2584
- /**
2585
- * <p>The token for the next set of results, or null if there are no additional results.</p>
2586
- */
2587
- nextToken?: string;
2588
- }
2589
-
2590
- export namespace ListEffectiveDeploymentsResponse {
2591
- /**
2592
- * @internal
2593
- */
2594
- export const filterSensitiveLog = (obj: ListEffectiveDeploymentsResponse): any => ({
2595
- ...obj,
2596
- });
2597
- }
2598
-
2599
- export interface ListInstalledComponentsRequest {
2600
- /**
2601
- * <p>The name of the core device. This is also the name of the IoT thing.</p>
2602
- */
2603
- coreDeviceThingName: string | undefined;
2604
-
2605
- /**
2606
- * <p>The maximum number of results to be returned per paginated request.</p>
2607
- */
2608
- maxResults?: number;
2609
-
2610
- /**
2611
- * <p>The token to be used for the next set of paginated results.</p>
2612
- */
2613
- nextToken?: string;
2614
- }
2615
-
2616
- export namespace ListInstalledComponentsRequest {
2617
- /**
2618
- * @internal
2619
- */
2620
- export const filterSensitiveLog = (obj: ListInstalledComponentsRequest): any => ({
2621
- ...obj,
2622
- });
2623
- }
2624
-
2625
- export enum InstalledComponentLifecycleState {
2626
- BROKEN = "BROKEN",
2627
- ERRORED = "ERRORED",
2628
- FINISHED = "FINISHED",
2629
- INSTALLED = "INSTALLED",
2630
- NEW = "NEW",
2631
- RUNNING = "RUNNING",
2632
- STARTING = "STARTING",
2633
- STOPPING = "STOPPING",
2634
- }
2635
-
2636
- /**
2637
- * <p>Contains information about a component on a Greengrass core device.</p>
2638
- */
2639
- export interface InstalledComponent {
2640
- /**
2641
- * <p>The name of the component.</p>
2642
- */
2643
- componentName?: string;
2644
-
2645
- /**
2646
- * <p>The version of the component.</p>
2647
- */
2648
- componentVersion?: string;
2649
-
2650
- /**
2651
- * <p>The lifecycle state of the component.</p>
2652
- */
2653
- lifecycleState?: InstalledComponentLifecycleState | string;
2654
-
2655
- /**
2656
- * <p>The details about the lifecycle state of the component.</p>
2657
- */
2658
- lifecycleStateDetails?: string;
2659
-
2660
- /**
2661
- * <p>Whether or not the component is a root component.</p>
2662
- */
2663
- isRoot?: boolean;
2664
- }
2665
-
2666
- export namespace InstalledComponent {
2667
- /**
2668
- * @internal
2669
- */
2670
- export const filterSensitiveLog = (obj: InstalledComponent): any => ({
2671
- ...obj,
2672
- });
2673
- }
2674
-
2675
- export interface ListInstalledComponentsResponse {
2676
- /**
2677
- * <p>A list that summarizes each component on the core device.</p>
2678
- */
2679
- installedComponents?: InstalledComponent[];
2680
-
2681
- /**
2682
- * <p>The token for the next set of results, or null if there are no additional results.</p>
2683
- */
2684
- nextToken?: string;
2685
- }
2686
-
2687
- export namespace ListInstalledComponentsResponse {
2688
- /**
2689
- * @internal
2690
- */
2691
- export const filterSensitiveLog = (obj: ListInstalledComponentsResponse): any => ({
2692
- ...obj,
2693
- });
2694
- }
2695
-
2696
- export interface ListTagsForResourceRequest {
2697
- /**
2698
- * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the resource.</p>
2699
- */
2700
- resourceArn: string | undefined;
2701
- }
2702
-
2703
- export namespace ListTagsForResourceRequest {
2704
- /**
2705
- * @internal
2706
- */
2707
- export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({
2708
- ...obj,
2709
- });
2710
- }
2711
-
2712
- export interface ListTagsForResourceResponse {
2713
- /**
2714
- * <p>A list of key-value pairs that contain metadata for the resource. For more
2715
- * information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html">Tag your
2716
- * resources</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>
2717
- */
2718
- tags?: { [key: string]: string };
2719
- }
2720
-
2721
- export namespace ListTagsForResourceResponse {
2722
- /**
2723
- * @internal
2724
- */
2725
- export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({
2726
- ...obj,
2727
- });
2728
- }
2729
-
2730
- export interface ResolveComponentCandidatesRequest {
2731
- /**
2732
- * <p>The platform to use to resolve compatible components.</p>
2733
- */
2734
- platform: ComponentPlatform | undefined;
2735
-
2736
- /**
2737
- * <p>The list of components to resolve.</p>
2738
- */
2739
- componentCandidates: ComponentCandidate[] | undefined;
2740
- }
2741
-
2742
- export namespace ResolveComponentCandidatesRequest {
2743
- /**
2744
- * @internal
2745
- */
2746
- export const filterSensitiveLog = (obj: ResolveComponentCandidatesRequest): any => ({
2747
- ...obj,
2748
- });
2749
- }
2750
-
2751
- /**
2752
- * <p>Contains information about a component version that is compatible to run on a Greengrass core
2753
- * device.</p>
2754
- */
2755
- export interface ResolvedComponentVersion {
2756
- /**
2757
- * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the component version.</p>
2758
- */
2759
- arn?: string;
2760
-
2761
- /**
2762
- * <p>The name of the component.</p>
2763
- */
2764
- componentName?: string;
2765
-
2766
- /**
2767
- * <p>The version of the component.</p>
2768
- */
2769
- componentVersion?: string;
2770
-
2771
- /**
2772
- * <p>The recipe of the component version.</p>
2773
- */
2774
- recipe?: Uint8Array;
2775
- }
2776
-
2777
- export namespace ResolvedComponentVersion {
2778
- /**
2779
- * @internal
2780
- */
2781
- export const filterSensitiveLog = (obj: ResolvedComponentVersion): any => ({
2782
- ...obj,
2783
- });
2784
- }
2785
-
2786
- export interface ResolveComponentCandidatesResponse {
2787
- /**
2788
- * <p>A list of components that meet the requirements that you specify in the request. This list
2789
- * includes each component's recipe that you can use to install the component.</p>
2790
- */
2791
- resolvedComponentVersions?: ResolvedComponentVersion[];
2792
- }
2793
-
2794
- export namespace ResolveComponentCandidatesResponse {
2795
- /**
2796
- * @internal
2797
- */
2798
- export const filterSensitiveLog = (obj: ResolveComponentCandidatesResponse): any => ({
2799
- ...obj,
2800
- });
2801
- }
2802
-
2803
- export interface TagResourceRequest {
2804
- /**
2805
- * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the resource to tag.</p>
2806
- */
2807
- resourceArn: string | undefined;
2808
-
2809
- /**
2810
- * <p>A list of key-value pairs that contain metadata for the resource. For more
2811
- * information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html">Tag your
2812
- * resources</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>
2813
- */
2814
- tags: { [key: string]: string } | undefined;
2815
- }
2816
-
2817
- export namespace TagResourceRequest {
2818
- /**
2819
- * @internal
2820
- */
2821
- export const filterSensitiveLog = (obj: TagResourceRequest): any => ({
2822
- ...obj,
2823
- });
2824
- }
2825
-
2826
- export interface TagResourceResponse {}
2827
-
2828
- export namespace TagResourceResponse {
2829
- /**
2830
- * @internal
2831
- */
2832
- export const filterSensitiveLog = (obj: TagResourceResponse): any => ({
2833
- ...obj,
2834
- });
2835
- }
2836
-
2837
- export interface UntagResourceRequest {
2838
- /**
2839
- * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the resource to untag.</p>
2840
- */
2841
- resourceArn: string | undefined;
2842
-
2843
- /**
2844
- * <p>A list of keys for tags to remove from the resource.</p>
2845
- */
2846
- tagKeys: string[] | undefined;
2847
- }
2848
-
2849
- export namespace UntagResourceRequest {
2850
- /**
2851
- * @internal
2852
- */
2853
- export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({
2854
- ...obj,
2855
- });
2856
- }
2857
-
2858
- export interface UntagResourceResponse {}
2859
-
2860
- export namespace UntagResourceResponse {
2861
- /**
2862
- * @internal
2863
- */
2864
- export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({
2865
- ...obj,
2866
- });
2867
- }