@aws-sdk/client-iotsitewise 3.298.0 → 3.300.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 (74) hide show
  1. package/dist-types/commands/AssociateAssetsCommand.d.ts +6 -0
  2. package/dist-types/commands/AssociateTimeSeriesToAssetPropertyCommand.d.ts +6 -0
  3. package/dist-types/commands/BatchAssociateProjectAssetsCommand.d.ts +7 -0
  4. package/dist-types/commands/BatchDisassociateProjectAssetsCommand.d.ts +7 -0
  5. package/dist-types/commands/BatchGetAssetPropertyAggregatesCommand.d.ts +22 -0
  6. package/dist-types/commands/BatchGetAssetPropertyValueCommand.d.ts +11 -0
  7. package/dist-types/commands/BatchGetAssetPropertyValueHistoryCommand.d.ts +18 -0
  8. package/dist-types/commands/BatchPutAssetPropertyValueCommand.d.ts +25 -0
  9. package/dist-types/commands/CreateAccessPolicyCommand.d.ts +29 -0
  10. package/dist-types/commands/CreateAssetCommand.d.ts +9 -0
  11. package/dist-types/commands/CreateAssetModelCommand.d.ts +139 -0
  12. package/dist-types/commands/CreateBulkImportJobCommand.d.ts +24 -0
  13. package/dist-types/commands/CreateDashboardCommand.d.ts +10 -0
  14. package/dist-types/commands/CreateGatewayCommand.d.ts +14 -0
  15. package/dist-types/commands/CreatePortalCommand.d.ts +20 -0
  16. package/dist-types/commands/CreateProjectCommand.d.ts +9 -0
  17. package/dist-types/commands/DeleteAccessPolicyCommand.d.ts +4 -0
  18. package/dist-types/commands/DeleteAssetCommand.d.ts +4 -0
  19. package/dist-types/commands/DeleteAssetModelCommand.d.ts +4 -0
  20. package/dist-types/commands/DeleteDashboardCommand.d.ts +4 -0
  21. package/dist-types/commands/DeleteGatewayCommand.d.ts +3 -0
  22. package/dist-types/commands/DeletePortalCommand.d.ts +4 -0
  23. package/dist-types/commands/DeleteProjectCommand.d.ts +4 -0
  24. package/dist-types/commands/DeleteTimeSeriesCommand.d.ts +6 -0
  25. package/dist-types/commands/DescribeAccessPolicyCommand.d.ts +3 -0
  26. package/dist-types/commands/DescribeAssetCommand.d.ts +4 -0
  27. package/dist-types/commands/DescribeAssetModelCommand.d.ts +4 -0
  28. package/dist-types/commands/DescribeAssetPropertyCommand.d.ts +4 -0
  29. package/dist-types/commands/DescribeBulkImportJobCommand.d.ts +3 -0
  30. package/dist-types/commands/DescribeDashboardCommand.d.ts +3 -0
  31. package/dist-types/commands/DescribeDefaultEncryptionConfigurationCommand.d.ts +1 -0
  32. package/dist-types/commands/DescribeGatewayCapabilityConfigurationCommand.d.ts +4 -0
  33. package/dist-types/commands/DescribeGatewayCommand.d.ts +3 -0
  34. package/dist-types/commands/DescribeLoggingOptionsCommand.d.ts +1 -0
  35. package/dist-types/commands/DescribePortalCommand.d.ts +3 -0
  36. package/dist-types/commands/DescribeProjectCommand.d.ts +3 -0
  37. package/dist-types/commands/DescribeStorageConfigurationCommand.d.ts +1 -0
  38. package/dist-types/commands/DescribeTimeSeriesCommand.d.ts +5 -0
  39. package/dist-types/commands/DisassociateAssetsCommand.d.ts +6 -0
  40. package/dist-types/commands/DisassociateTimeSeriesFromAssetPropertyCommand.d.ts +6 -0
  41. package/dist-types/commands/GetAssetPropertyAggregatesCommand.d.ts +17 -0
  42. package/dist-types/commands/GetAssetPropertyValueCommand.d.ts +5 -0
  43. package/dist-types/commands/GetAssetPropertyValueHistoryCommand.d.ts +13 -0
  44. package/dist-types/commands/GetInterpolatedAssetPropertyValuesCommand.d.ts +15 -0
  45. package/dist-types/commands/ListAccessPoliciesCommand.d.ts +9 -0
  46. package/dist-types/commands/ListAssetModelPropertiesCommand.d.ts +6 -0
  47. package/dist-types/commands/ListAssetModelsCommand.d.ts +4 -0
  48. package/dist-types/commands/ListAssetPropertiesCommand.d.ts +6 -0
  49. package/dist-types/commands/ListAssetRelationshipsCommand.d.ts +6 -0
  50. package/dist-types/commands/ListAssetsCommand.d.ts +6 -0
  51. package/dist-types/commands/ListAssociatedAssetsCommand.d.ts +7 -0
  52. package/dist-types/commands/ListBulkImportJobsCommand.d.ts +5 -0
  53. package/dist-types/commands/ListDashboardsCommand.d.ts +5 -0
  54. package/dist-types/commands/ListGatewaysCommand.d.ts +4 -0
  55. package/dist-types/commands/ListPortalsCommand.d.ts +4 -0
  56. package/dist-types/commands/ListProjectAssetsCommand.d.ts +5 -0
  57. package/dist-types/commands/ListProjectsCommand.d.ts +5 -0
  58. package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -0
  59. package/dist-types/commands/ListTimeSeriesCommand.d.ts +7 -0
  60. package/dist-types/commands/PutDefaultEncryptionConfigurationCommand.d.ts +4 -0
  61. package/dist-types/commands/PutLoggingOptionsCommand.d.ts +5 -0
  62. package/dist-types/commands/PutStorageConfigurationCommand.d.ts +14 -0
  63. package/dist-types/commands/TagResourceCommand.d.ts +6 -0
  64. package/dist-types/commands/UntagResourceCommand.d.ts +6 -0
  65. package/dist-types/commands/UpdateAccessPolicyCommand.d.ts +27 -0
  66. package/dist-types/commands/UpdateAssetCommand.d.ts +6 -0
  67. package/dist-types/commands/UpdateAssetModelCommand.d.ts +141 -0
  68. package/dist-types/commands/UpdateAssetPropertyCommand.d.ts +8 -0
  69. package/dist-types/commands/UpdateDashboardCommand.d.ts +7 -0
  70. package/dist-types/commands/UpdateGatewayCapabilityConfigurationCommand.d.ts +5 -0
  71. package/dist-types/commands/UpdateGatewayCommand.d.ts +4 -0
  72. package/dist-types/commands/UpdatePortalCommand.d.ts +20 -0
  73. package/dist-types/commands/UpdateProjectCommand.d.ts +6 -0
  74. package/package.json +12 -12
@@ -28,6 +28,12 @@ export interface AssociateAssetsCommandOutput extends __MetadataBearer {
28
28
  * import { IoTSiteWiseClient, AssociateAssetsCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
29
29
  * // const { IoTSiteWiseClient, AssociateAssetsCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
30
30
  * const client = new IoTSiteWiseClient(config);
31
+ * const input = {
32
+ * assetId: "STRING_VALUE", // required
33
+ * hierarchyId: "STRING_VALUE", // required
34
+ * childAssetId: "STRING_VALUE", // required
35
+ * clientToken: "STRING_VALUE",
36
+ * };
31
37
  * const command = new AssociateAssetsCommand(input);
32
38
  * const response = await client.send(command);
33
39
  * ```
@@ -26,6 +26,12 @@ export interface AssociateTimeSeriesToAssetPropertyCommandOutput extends __Metad
26
26
  * import { IoTSiteWiseClient, AssociateTimeSeriesToAssetPropertyCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
27
27
  * // const { IoTSiteWiseClient, AssociateTimeSeriesToAssetPropertyCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
28
28
  * const client = new IoTSiteWiseClient(config);
29
+ * const input = {
30
+ * alias: "STRING_VALUE", // required
31
+ * assetId: "STRING_VALUE", // required
32
+ * propertyId: "STRING_VALUE", // required
33
+ * clientToken: "STRING_VALUE",
34
+ * };
29
35
  * const command = new AssociateTimeSeriesToAssetPropertyCommand(input);
30
36
  * const response = await client.send(command);
31
37
  * ```
@@ -26,6 +26,13 @@ export interface BatchAssociateProjectAssetsCommandOutput extends BatchAssociate
26
26
  * import { IoTSiteWiseClient, BatchAssociateProjectAssetsCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
27
27
  * // const { IoTSiteWiseClient, BatchAssociateProjectAssetsCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
28
28
  * const client = new IoTSiteWiseClient(config);
29
+ * const input = {
30
+ * projectId: "STRING_VALUE", // required
31
+ * assetIds: [ // required
32
+ * "STRING_VALUE",
33
+ * ],
34
+ * clientToken: "STRING_VALUE",
35
+ * };
29
36
  * const command = new BatchAssociateProjectAssetsCommand(input);
30
37
  * const response = await client.send(command);
31
38
  * ```
@@ -26,6 +26,13 @@ export interface BatchDisassociateProjectAssetsCommandOutput extends BatchDisass
26
26
  * import { IoTSiteWiseClient, BatchDisassociateProjectAssetsCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
27
27
  * // const { IoTSiteWiseClient, BatchDisassociateProjectAssetsCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
28
28
  * const client = new IoTSiteWiseClient(config);
29
+ * const input = {
30
+ * projectId: "STRING_VALUE", // required
31
+ * assetIds: [ // required
32
+ * "STRING_VALUE",
33
+ * ],
34
+ * clientToken: "STRING_VALUE",
35
+ * };
29
36
  * const command = new BatchDisassociateProjectAssetsCommand(input);
30
37
  * const response = await client.send(command);
31
38
  * ```
@@ -28,6 +28,28 @@ export interface BatchGetAssetPropertyAggregatesCommandOutput extends BatchGetAs
28
28
  * import { IoTSiteWiseClient, BatchGetAssetPropertyAggregatesCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
29
29
  * // const { IoTSiteWiseClient, BatchGetAssetPropertyAggregatesCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
30
30
  * const client = new IoTSiteWiseClient(config);
31
+ * const input = {
32
+ * entries: [ // required
33
+ * {
34
+ * entryId: "STRING_VALUE", // required
35
+ * assetId: "STRING_VALUE",
36
+ * propertyId: "STRING_VALUE",
37
+ * propertyAlias: "STRING_VALUE",
38
+ * aggregateTypes: [ // required
39
+ * "AVERAGE" || "COUNT" || "MAXIMUM" || "MINIMUM" || "SUM" || "STANDARD_DEVIATION",
40
+ * ],
41
+ * resolution: "STRING_VALUE", // required
42
+ * startDate: new Date("TIMESTAMP"), // required
43
+ * endDate: new Date("TIMESTAMP"), // required
44
+ * qualities: [
45
+ * "GOOD" || "BAD" || "UNCERTAIN",
46
+ * ],
47
+ * timeOrdering: "ASCENDING" || "DESCENDING",
48
+ * },
49
+ * ],
50
+ * nextToken: "STRING_VALUE",
51
+ * maxResults: Number("int"),
52
+ * };
31
53
  * const command = new BatchGetAssetPropertyAggregatesCommand(input);
32
54
  * const response = await client.send(command);
33
55
  * ```
@@ -27,6 +27,17 @@ export interface BatchGetAssetPropertyValueCommandOutput extends BatchGetAssetPr
27
27
  * import { IoTSiteWiseClient, BatchGetAssetPropertyValueCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
28
28
  * // const { IoTSiteWiseClient, BatchGetAssetPropertyValueCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
29
29
  * const client = new IoTSiteWiseClient(config);
30
+ * const input = {
31
+ * entries: [ // required
32
+ * {
33
+ * entryId: "STRING_VALUE", // required
34
+ * assetId: "STRING_VALUE",
35
+ * propertyId: "STRING_VALUE",
36
+ * propertyAlias: "STRING_VALUE",
37
+ * },
38
+ * ],
39
+ * nextToken: "STRING_VALUE",
40
+ * };
30
41
  * const command = new BatchGetAssetPropertyValueCommand(input);
31
42
  * const response = await client.send(command);
32
43
  * ```
@@ -27,6 +27,24 @@ export interface BatchGetAssetPropertyValueHistoryCommandOutput extends BatchGet
27
27
  * import { IoTSiteWiseClient, BatchGetAssetPropertyValueHistoryCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
28
28
  * // const { IoTSiteWiseClient, BatchGetAssetPropertyValueHistoryCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
29
29
  * const client = new IoTSiteWiseClient(config);
30
+ * const input = {
31
+ * entries: [ // required
32
+ * {
33
+ * entryId: "STRING_VALUE", // required
34
+ * assetId: "STRING_VALUE",
35
+ * propertyId: "STRING_VALUE",
36
+ * propertyAlias: "STRING_VALUE",
37
+ * startDate: new Date("TIMESTAMP"),
38
+ * endDate: new Date("TIMESTAMP"),
39
+ * qualities: [
40
+ * "GOOD" || "BAD" || "UNCERTAIN",
41
+ * ],
42
+ * timeOrdering: "ASCENDING" || "DESCENDING",
43
+ * },
44
+ * ],
45
+ * nextToken: "STRING_VALUE",
46
+ * maxResults: Number("int"),
47
+ * };
30
48
  * const command = new BatchGetAssetPropertyValueHistoryCommand(input);
31
49
  * const response = await client.send(command);
32
50
  * ```
@@ -50,6 +50,31 @@ export interface BatchPutAssetPropertyValueCommandOutput extends BatchPutAssetPr
50
50
  * import { IoTSiteWiseClient, BatchPutAssetPropertyValueCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
51
51
  * // const { IoTSiteWiseClient, BatchPutAssetPropertyValueCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
52
52
  * const client = new IoTSiteWiseClient(config);
53
+ * const input = {
54
+ * entries: [ // required
55
+ * {
56
+ * entryId: "STRING_VALUE", // required
57
+ * assetId: "STRING_VALUE",
58
+ * propertyId: "STRING_VALUE",
59
+ * propertyAlias: "STRING_VALUE",
60
+ * propertyValues: [ // required
61
+ * {
62
+ * value: {
63
+ * stringValue: "STRING_VALUE",
64
+ * integerValue: Number("int"),
65
+ * doubleValue: Number("double"),
66
+ * booleanValue: true || false,
67
+ * },
68
+ * timestamp: {
69
+ * timeInSeconds: Number("long"), // required
70
+ * offsetInNanos: Number("int"),
71
+ * },
72
+ * quality: "GOOD" || "BAD" || "UNCERTAIN",
73
+ * },
74
+ * ],
75
+ * },
76
+ * ],
77
+ * };
53
78
  * const command = new BatchPutAssetPropertyValueCommand(input);
54
79
  * const response = await client.send(command);
55
80
  * ```
@@ -27,6 +27,35 @@ export interface CreateAccessPolicyCommandOutput extends CreateAccessPolicyRespo
27
27
  * import { IoTSiteWiseClient, CreateAccessPolicyCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
28
28
  * // const { IoTSiteWiseClient, CreateAccessPolicyCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
29
29
  * const client = new IoTSiteWiseClient(config);
30
+ * const input = {
31
+ * accessPolicyIdentity: {
32
+ * user: {
33
+ * id: "STRING_VALUE", // required
34
+ * },
35
+ * group: {
36
+ * id: "STRING_VALUE", // required
37
+ * },
38
+ * iamUser: {
39
+ * arn: "STRING_VALUE", // required
40
+ * },
41
+ * iamRole: {
42
+ * arn: "STRING_VALUE", // required
43
+ * },
44
+ * },
45
+ * accessPolicyResource: {
46
+ * portal: {
47
+ * id: "STRING_VALUE", // required
48
+ * },
49
+ * project: {
50
+ * id: "STRING_VALUE", // required
51
+ * },
52
+ * },
53
+ * accessPolicyPermission: "ADMINISTRATOR" || "VIEWER", // required
54
+ * clientToken: "STRING_VALUE",
55
+ * tags: {
56
+ * "<keys>": "STRING_VALUE",
57
+ * },
58
+ * };
30
59
  * const command = new CreateAccessPolicyCommand(input);
31
60
  * const response = await client.send(command);
32
61
  * ```
@@ -27,6 +27,15 @@ export interface CreateAssetCommandOutput extends CreateAssetResponse, __Metadat
27
27
  * import { IoTSiteWiseClient, CreateAssetCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
28
28
  * // const { IoTSiteWiseClient, CreateAssetCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
29
29
  * const client = new IoTSiteWiseClient(config);
30
+ * const input = {
31
+ * assetName: "STRING_VALUE", // required
32
+ * assetModelId: "STRING_VALUE", // required
33
+ * clientToken: "STRING_VALUE",
34
+ * tags: {
35
+ * "<keys>": "STRING_VALUE",
36
+ * },
37
+ * assetDescription: "STRING_VALUE",
38
+ * };
30
39
  * const command = new CreateAssetCommand(input);
31
40
  * const response = await client.send(command);
32
41
  * ```
@@ -30,6 +30,145 @@ export interface CreateAssetModelCommandOutput extends CreateAssetModelResponse,
30
30
  * import { IoTSiteWiseClient, CreateAssetModelCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
31
31
  * // const { IoTSiteWiseClient, CreateAssetModelCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
32
32
  * const client = new IoTSiteWiseClient(config);
33
+ * const input = {
34
+ * assetModelName: "STRING_VALUE", // required
35
+ * assetModelDescription: "STRING_VALUE",
36
+ * assetModelProperties: [
37
+ * {
38
+ * name: "STRING_VALUE", // required
39
+ * dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT", // required
40
+ * dataTypeSpec: "STRING_VALUE",
41
+ * unit: "STRING_VALUE",
42
+ * type: {
43
+ * attribute: {
44
+ * defaultValue: "STRING_VALUE",
45
+ * },
46
+ * measurement: {
47
+ * processingConfig: {
48
+ * forwardingConfig: {
49
+ * state: "DISABLED" || "ENABLED", // required
50
+ * },
51
+ * },
52
+ * },
53
+ * transform: {
54
+ * expression: "STRING_VALUE", // required
55
+ * variables: [ // required
56
+ * {
57
+ * name: "STRING_VALUE", // required
58
+ * value: {
59
+ * propertyId: "STRING_VALUE", // required
60
+ * hierarchyId: "STRING_VALUE",
61
+ * },
62
+ * },
63
+ * ],
64
+ * processingConfig: {
65
+ * computeLocation: "EDGE" || "CLOUD", // required
66
+ * forwardingConfig: {
67
+ * state: "DISABLED" || "ENABLED", // required
68
+ * },
69
+ * },
70
+ * },
71
+ * metric: {
72
+ * expression: "STRING_VALUE", // required
73
+ * variables: [ // required
74
+ * {
75
+ * name: "STRING_VALUE", // required
76
+ * value: {
77
+ * propertyId: "STRING_VALUE", // required
78
+ * hierarchyId: "STRING_VALUE",
79
+ * },
80
+ * },
81
+ * ],
82
+ * window: {
83
+ * tumbling: {
84
+ * interval: "STRING_VALUE", // required
85
+ * offset: "STRING_VALUE",
86
+ * },
87
+ * },
88
+ * processingConfig: {
89
+ * computeLocation: "EDGE" || "CLOUD", // required
90
+ * },
91
+ * },
92
+ * },
93
+ * },
94
+ * ],
95
+ * assetModelHierarchies: [
96
+ * {
97
+ * name: "STRING_VALUE", // required
98
+ * childAssetModelId: "STRING_VALUE", // required
99
+ * },
100
+ * ],
101
+ * assetModelCompositeModels: [
102
+ * {
103
+ * name: "STRING_VALUE", // required
104
+ * description: "STRING_VALUE",
105
+ * type: "STRING_VALUE", // required
106
+ * properties: [
107
+ * {
108
+ * name: "STRING_VALUE", // required
109
+ * dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT", // required
110
+ * dataTypeSpec: "STRING_VALUE",
111
+ * unit: "STRING_VALUE",
112
+ * type: {
113
+ * attribute: {
114
+ * defaultValue: "STRING_VALUE",
115
+ * },
116
+ * measurement: {
117
+ * processingConfig: {
118
+ * forwardingConfig: {
119
+ * state: "DISABLED" || "ENABLED", // required
120
+ * },
121
+ * },
122
+ * },
123
+ * transform: {
124
+ * expression: "STRING_VALUE", // required
125
+ * variables: [ // required
126
+ * {
127
+ * name: "STRING_VALUE", // required
128
+ * value: {
129
+ * propertyId: "STRING_VALUE", // required
130
+ * hierarchyId: "STRING_VALUE",
131
+ * },
132
+ * },
133
+ * ],
134
+ * processingConfig: {
135
+ * computeLocation: "EDGE" || "CLOUD", // required
136
+ * forwardingConfig: {
137
+ * state: "DISABLED" || "ENABLED", // required
138
+ * },
139
+ * },
140
+ * },
141
+ * metric: {
142
+ * expression: "STRING_VALUE", // required
143
+ * variables: [ // required
144
+ * {
145
+ * name: "STRING_VALUE", // required
146
+ * value: {
147
+ * propertyId: "STRING_VALUE", // required
148
+ * hierarchyId: "STRING_VALUE",
149
+ * },
150
+ * },
151
+ * ],
152
+ * window: {
153
+ * tumbling: {
154
+ * interval: "STRING_VALUE", // required
155
+ * offset: "STRING_VALUE",
156
+ * },
157
+ * },
158
+ * processingConfig: {
159
+ * computeLocation: "EDGE" || "CLOUD", // required
160
+ * },
161
+ * },
162
+ * },
163
+ * },
164
+ * ],
165
+ * },
166
+ * ],
167
+ * clientToken: "STRING_VALUE",
168
+ * tags: {
169
+ * "<keys>": "STRING_VALUE",
170
+ * },
171
+ * };
33
172
  * const command = new CreateAssetModelCommand(input);
34
173
  * const response = await client.send(command);
35
174
  * ```
@@ -31,6 +31,30 @@ export interface CreateBulkImportJobCommandOutput extends CreateBulkImportJobRes
31
31
  * import { IoTSiteWiseClient, CreateBulkImportJobCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
32
32
  * // const { IoTSiteWiseClient, CreateBulkImportJobCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
33
33
  * const client = new IoTSiteWiseClient(config);
34
+ * const input = {
35
+ * jobName: "STRING_VALUE", // required
36
+ * jobRoleArn: "STRING_VALUE", // required
37
+ * files: [ // required
38
+ * {
39
+ * bucket: "STRING_VALUE", // required
40
+ * key: "STRING_VALUE", // required
41
+ * versionId: "STRING_VALUE",
42
+ * },
43
+ * ],
44
+ * errorReportLocation: {
45
+ * bucket: "STRING_VALUE", // required
46
+ * prefix: "STRING_VALUE", // required
47
+ * },
48
+ * jobConfiguration: {
49
+ * fileFormat: {
50
+ * csv: {
51
+ * columnNames: [
52
+ * "ALIAS" || "ASSET_ID" || "PROPERTY_ID" || "DATA_TYPE" || "TIMESTAMP_SECONDS" || "TIMESTAMP_NANO_OFFSET" || "QUALITY" || "VALUE",
53
+ * ],
54
+ * },
55
+ * },
56
+ * },
57
+ * };
34
58
  * const command = new CreateBulkImportJobCommand(input);
35
59
  * const response = await client.send(command);
36
60
  * ```
@@ -26,6 +26,16 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _
26
26
  * import { IoTSiteWiseClient, CreateDashboardCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
27
27
  * // const { IoTSiteWiseClient, CreateDashboardCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
28
28
  * const client = new IoTSiteWiseClient(config);
29
+ * const input = {
30
+ * projectId: "STRING_VALUE", // required
31
+ * dashboardName: "STRING_VALUE", // required
32
+ * dashboardDescription: "STRING_VALUE",
33
+ * dashboardDefinition: "STRING_VALUE", // required
34
+ * clientToken: "STRING_VALUE",
35
+ * tags: {
36
+ * "<keys>": "STRING_VALUE",
37
+ * },
38
+ * };
29
39
  * const command = new CreateDashboardCommand(input);
30
40
  * const response = await client.send(command);
31
41
  * ```
@@ -28,6 +28,20 @@ export interface CreateGatewayCommandOutput extends CreateGatewayResponse, __Met
28
28
  * import { IoTSiteWiseClient, CreateGatewayCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
29
29
  * // const { IoTSiteWiseClient, CreateGatewayCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
30
30
  * const client = new IoTSiteWiseClient(config);
31
+ * const input = {
32
+ * gatewayName: "STRING_VALUE", // required
33
+ * gatewayPlatform: {
34
+ * greengrass: {
35
+ * groupArn: "STRING_VALUE", // required
36
+ * },
37
+ * greengrassV2: {
38
+ * coreDeviceThingName: "STRING_VALUE", // required
39
+ * },
40
+ * },
41
+ * tags: {
42
+ * "<keys>": "STRING_VALUE",
43
+ * },
44
+ * };
31
45
  * const command = new CreateGatewayCommand(input);
32
46
  * const response = await client.send(command);
33
47
  * ```
@@ -32,6 +32,26 @@ export interface CreatePortalCommandOutput extends CreatePortalResponse, __Metad
32
32
  * import { IoTSiteWiseClient, CreatePortalCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
33
33
  * // const { IoTSiteWiseClient, CreatePortalCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
34
34
  * const client = new IoTSiteWiseClient(config);
35
+ * const input = {
36
+ * portalName: "STRING_VALUE", // required
37
+ * portalDescription: "STRING_VALUE",
38
+ * portalContactEmail: "STRING_VALUE", // required
39
+ * clientToken: "STRING_VALUE",
40
+ * portalLogoImageFile: {
41
+ * data: "BLOB_VALUE", // required
42
+ * type: "PNG", // required
43
+ * },
44
+ * roleArn: "STRING_VALUE", // required
45
+ * tags: {
46
+ * "<keys>": "STRING_VALUE",
47
+ * },
48
+ * portalAuthMode: "IAM" || "SSO",
49
+ * notificationSenderEmail: "STRING_VALUE",
50
+ * alarms: {
51
+ * alarmRoleArn: "STRING_VALUE", // required
52
+ * notificationLambdaArn: "STRING_VALUE",
53
+ * },
54
+ * };
35
55
  * const command = new CreatePortalCommand(input);
36
56
  * const response = await client.send(command);
37
57
  * ```
@@ -30,6 +30,15 @@ export interface CreateProjectCommandOutput extends CreateProjectResponse, __Met
30
30
  * import { IoTSiteWiseClient, CreateProjectCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
31
31
  * // const { IoTSiteWiseClient, CreateProjectCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
32
32
  * const client = new IoTSiteWiseClient(config);
33
+ * const input = {
34
+ * portalId: "STRING_VALUE", // required
35
+ * projectName: "STRING_VALUE", // required
36
+ * projectDescription: "STRING_VALUE",
37
+ * clientToken: "STRING_VALUE",
38
+ * tags: {
39
+ * "<keys>": "STRING_VALUE",
40
+ * },
41
+ * };
33
42
  * const command = new CreateProjectCommand(input);
34
43
  * const response = await client.send(command);
35
44
  * ```
@@ -28,6 +28,10 @@ export interface DeleteAccessPolicyCommandOutput extends DeleteAccessPolicyRespo
28
28
  * import { IoTSiteWiseClient, DeleteAccessPolicyCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
29
29
  * // const { IoTSiteWiseClient, DeleteAccessPolicyCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
30
30
  * const client = new IoTSiteWiseClient(config);
31
+ * const input = {
32
+ * accessPolicyId: "STRING_VALUE", // required
33
+ * clientToken: "STRING_VALUE",
34
+ * };
31
35
  * const command = new DeleteAccessPolicyCommand(input);
32
36
  * const response = await client.send(command);
33
37
  * ```
@@ -31,6 +31,10 @@ export interface DeleteAssetCommandOutput extends DeleteAssetResponse, __Metadat
31
31
  * import { IoTSiteWiseClient, DeleteAssetCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
32
32
  * // const { IoTSiteWiseClient, DeleteAssetCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
33
33
  * const client = new IoTSiteWiseClient(config);
34
+ * const input = {
35
+ * assetId: "STRING_VALUE", // required
36
+ * clientToken: "STRING_VALUE",
37
+ * };
34
38
  * const command = new DeleteAssetCommand(input);
35
39
  * const response = await client.send(command);
36
40
  * ```
@@ -30,6 +30,10 @@ export interface DeleteAssetModelCommandOutput extends DeleteAssetModelResponse,
30
30
  * import { IoTSiteWiseClient, DeleteAssetModelCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
31
31
  * // const { IoTSiteWiseClient, DeleteAssetModelCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
32
32
  * const client = new IoTSiteWiseClient(config);
33
+ * const input = {
34
+ * assetModelId: "STRING_VALUE", // required
35
+ * clientToken: "STRING_VALUE",
36
+ * };
33
37
  * const command = new DeleteAssetModelCommand(input);
34
38
  * const response = await client.send(command);
35
39
  * ```
@@ -26,6 +26,10 @@ export interface DeleteDashboardCommandOutput extends DeleteDashboardResponse, _
26
26
  * import { IoTSiteWiseClient, DeleteDashboardCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
27
27
  * // const { IoTSiteWiseClient, DeleteDashboardCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
28
28
  * const client = new IoTSiteWiseClient(config);
29
+ * const input = {
30
+ * dashboardId: "STRING_VALUE", // required
31
+ * clientToken: "STRING_VALUE",
32
+ * };
29
33
  * const command = new DeleteDashboardCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -27,6 +27,9 @@ export interface DeleteGatewayCommandOutput extends __MetadataBearer {
27
27
  * import { IoTSiteWiseClient, DeleteGatewayCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
28
28
  * // const { IoTSiteWiseClient, DeleteGatewayCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
29
29
  * const client = new IoTSiteWiseClient(config);
30
+ * const input = {
31
+ * gatewayId: "STRING_VALUE", // required
32
+ * };
30
33
  * const command = new DeleteGatewayCommand(input);
31
34
  * const response = await client.send(command);
32
35
  * ```
@@ -26,6 +26,10 @@ export interface DeletePortalCommandOutput extends DeletePortalResponse, __Metad
26
26
  * import { IoTSiteWiseClient, DeletePortalCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
27
27
  * // const { IoTSiteWiseClient, DeletePortalCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
28
28
  * const client = new IoTSiteWiseClient(config);
29
+ * const input = {
30
+ * portalId: "STRING_VALUE", // required
31
+ * clientToken: "STRING_VALUE",
32
+ * };
29
33
  * const command = new DeletePortalCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,10 @@ export interface DeleteProjectCommandOutput extends DeleteProjectResponse, __Met
26
26
  * import { IoTSiteWiseClient, DeleteProjectCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
27
27
  * // const { IoTSiteWiseClient, DeleteProjectCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
28
28
  * const client = new IoTSiteWiseClient(config);
29
+ * const input = {
30
+ * projectId: "STRING_VALUE", // required
31
+ * clientToken: "STRING_VALUE",
32
+ * };
29
33
  * const command = new DeleteProjectCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -47,6 +47,12 @@ export interface DeleteTimeSeriesCommandOutput extends __MetadataBearer {
47
47
  * import { IoTSiteWiseClient, DeleteTimeSeriesCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
48
48
  * // const { IoTSiteWiseClient, DeleteTimeSeriesCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
49
49
  * const client = new IoTSiteWiseClient(config);
50
+ * const input = {
51
+ * alias: "STRING_VALUE",
52
+ * assetId: "STRING_VALUE",
53
+ * propertyId: "STRING_VALUE",
54
+ * clientToken: "STRING_VALUE",
55
+ * };
50
56
  * const command = new DeleteTimeSeriesCommand(input);
51
57
  * const response = await client.send(command);
52
58
  * ```
@@ -27,6 +27,9 @@ export interface DescribeAccessPolicyCommandOutput extends DescribeAccessPolicyR
27
27
  * import { IoTSiteWiseClient, DescribeAccessPolicyCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
28
28
  * // const { IoTSiteWiseClient, DescribeAccessPolicyCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
29
29
  * const client = new IoTSiteWiseClient(config);
30
+ * const input = {
31
+ * accessPolicyId: "STRING_VALUE", // required
32
+ * };
30
33
  * const command = new DescribeAccessPolicyCommand(input);
31
34
  * const response = await client.send(command);
32
35
  * ```
@@ -26,6 +26,10 @@ export interface DescribeAssetCommandOutput extends DescribeAssetResponse, __Met
26
26
  * import { IoTSiteWiseClient, DescribeAssetCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
27
27
  * // const { IoTSiteWiseClient, DescribeAssetCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
28
28
  * const client = new IoTSiteWiseClient(config);
29
+ * const input = {
30
+ * assetId: "STRING_VALUE", // required
31
+ * excludeProperties: true || false,
32
+ * };
29
33
  * const command = new DescribeAssetCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,10 @@ export interface DescribeAssetModelCommandOutput extends DescribeAssetModelRespo
26
26
  * import { IoTSiteWiseClient, DescribeAssetModelCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
27
27
  * // const { IoTSiteWiseClient, DescribeAssetModelCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
28
28
  * const client = new IoTSiteWiseClient(config);
29
+ * const input = {
30
+ * assetModelId: "STRING_VALUE", // required
31
+ * excludeProperties: true || false,
32
+ * };
29
33
  * const command = new DescribeAssetModelCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -33,6 +33,10 @@ export interface DescribeAssetPropertyCommandOutput extends DescribeAssetPropert
33
33
  * import { IoTSiteWiseClient, DescribeAssetPropertyCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
34
34
  * // const { IoTSiteWiseClient, DescribeAssetPropertyCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
35
35
  * const client = new IoTSiteWiseClient(config);
36
+ * const input = {
37
+ * assetId: "STRING_VALUE", // required
38
+ * propertyId: "STRING_VALUE", // required
39
+ * };
36
40
  * const command = new DescribeAssetPropertyCommand(input);
37
41
  * const response = await client.send(command);
38
42
  * ```
@@ -27,6 +27,9 @@ export interface DescribeBulkImportJobCommandOutput extends DescribeBulkImportJo
27
27
  * import { IoTSiteWiseClient, DescribeBulkImportJobCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
28
28
  * // const { IoTSiteWiseClient, DescribeBulkImportJobCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
29
29
  * const client = new IoTSiteWiseClient(config);
30
+ * const input = {
31
+ * jobId: "STRING_VALUE", // required
32
+ * };
30
33
  * const command = new DescribeBulkImportJobCommand(input);
31
34
  * const response = await client.send(command);
32
35
  * ```
@@ -26,6 +26,9 @@ export interface DescribeDashboardCommandOutput extends DescribeDashboardRespons
26
26
  * import { IoTSiteWiseClient, DescribeDashboardCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
27
27
  * // const { IoTSiteWiseClient, DescribeDashboardCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
28
28
  * const client = new IoTSiteWiseClient(config);
29
+ * const input = {
30
+ * dashboardId: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new DescribeDashboardCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```