@aws-sdk/client-iotsitewise 3.296.0 → 3.297.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 (99) hide show
  1. package/dist-types/IoTSiteWise.d.ts +76 -2
  2. package/dist-types/IoTSiteWiseClient.d.ts +24 -4
  3. package/dist-types/commands/AssociateAssetsCommand.d.ts +16 -0
  4. package/dist-types/commands/AssociateTimeSeriesToAssetPropertyCommand.d.ts +16 -0
  5. package/dist-types/commands/BatchAssociateProjectAssetsCommand.d.ts +16 -0
  6. package/dist-types/commands/BatchDisassociateProjectAssetsCommand.d.ts +16 -0
  7. package/dist-types/commands/BatchGetAssetPropertyAggregatesCommand.d.ts +16 -0
  8. package/dist-types/commands/BatchGetAssetPropertyValueCommand.d.ts +16 -0
  9. package/dist-types/commands/BatchGetAssetPropertyValueHistoryCommand.d.ts +16 -0
  10. package/dist-types/commands/BatchPutAssetPropertyValueCommand.d.ts +18 -2
  11. package/dist-types/commands/CreateAccessPolicyCommand.d.ts +16 -0
  12. package/dist-types/commands/CreateAssetCommand.d.ts +16 -0
  13. package/dist-types/commands/CreateAssetModelCommand.d.ts +16 -0
  14. package/dist-types/commands/CreateBulkImportJobCommand.d.ts +16 -0
  15. package/dist-types/commands/CreateDashboardCommand.d.ts +16 -0
  16. package/dist-types/commands/CreateGatewayCommand.d.ts +16 -0
  17. package/dist-types/commands/CreatePortalCommand.d.ts +16 -0
  18. package/dist-types/commands/CreateProjectCommand.d.ts +16 -0
  19. package/dist-types/commands/DeleteAccessPolicyCommand.d.ts +16 -0
  20. package/dist-types/commands/DeleteAssetCommand.d.ts +16 -0
  21. package/dist-types/commands/DeleteAssetModelCommand.d.ts +16 -0
  22. package/dist-types/commands/DeleteDashboardCommand.d.ts +16 -0
  23. package/dist-types/commands/DeleteGatewayCommand.d.ts +16 -0
  24. package/dist-types/commands/DeletePortalCommand.d.ts +16 -0
  25. package/dist-types/commands/DeleteProjectCommand.d.ts +16 -0
  26. package/dist-types/commands/DeleteTimeSeriesCommand.d.ts +16 -0
  27. package/dist-types/commands/DescribeAccessPolicyCommand.d.ts +16 -0
  28. package/dist-types/commands/DescribeAssetCommand.d.ts +16 -0
  29. package/dist-types/commands/DescribeAssetModelCommand.d.ts +16 -0
  30. package/dist-types/commands/DescribeAssetPropertyCommand.d.ts +16 -0
  31. package/dist-types/commands/DescribeBulkImportJobCommand.d.ts +16 -0
  32. package/dist-types/commands/DescribeDashboardCommand.d.ts +16 -0
  33. package/dist-types/commands/DescribeDefaultEncryptionConfigurationCommand.d.ts +16 -0
  34. package/dist-types/commands/DescribeGatewayCapabilityConfigurationCommand.d.ts +16 -0
  35. package/dist-types/commands/DescribeGatewayCommand.d.ts +16 -0
  36. package/dist-types/commands/DescribeLoggingOptionsCommand.d.ts +16 -0
  37. package/dist-types/commands/DescribePortalCommand.d.ts +16 -0
  38. package/dist-types/commands/DescribeProjectCommand.d.ts +16 -0
  39. package/dist-types/commands/DescribeStorageConfigurationCommand.d.ts +16 -0
  40. package/dist-types/commands/DescribeTimeSeriesCommand.d.ts +16 -0
  41. package/dist-types/commands/DisassociateAssetsCommand.d.ts +16 -0
  42. package/dist-types/commands/DisassociateTimeSeriesFromAssetPropertyCommand.d.ts +16 -0
  43. package/dist-types/commands/GetAssetPropertyAggregatesCommand.d.ts +16 -0
  44. package/dist-types/commands/GetAssetPropertyValueCommand.d.ts +16 -0
  45. package/dist-types/commands/GetAssetPropertyValueHistoryCommand.d.ts +16 -0
  46. package/dist-types/commands/GetInterpolatedAssetPropertyValuesCommand.d.ts +16 -0
  47. package/dist-types/commands/ListAccessPoliciesCommand.d.ts +16 -0
  48. package/dist-types/commands/ListAssetModelPropertiesCommand.d.ts +16 -0
  49. package/dist-types/commands/ListAssetModelsCommand.d.ts +16 -0
  50. package/dist-types/commands/ListAssetPropertiesCommand.d.ts +16 -0
  51. package/dist-types/commands/ListAssetRelationshipsCommand.d.ts +16 -0
  52. package/dist-types/commands/ListAssetsCommand.d.ts +16 -0
  53. package/dist-types/commands/ListAssociatedAssetsCommand.d.ts +16 -0
  54. package/dist-types/commands/ListBulkImportJobsCommand.d.ts +16 -0
  55. package/dist-types/commands/ListDashboardsCommand.d.ts +16 -0
  56. package/dist-types/commands/ListGatewaysCommand.d.ts +16 -0
  57. package/dist-types/commands/ListPortalsCommand.d.ts +16 -0
  58. package/dist-types/commands/ListProjectAssetsCommand.d.ts +16 -0
  59. package/dist-types/commands/ListProjectsCommand.d.ts +16 -0
  60. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  61. package/dist-types/commands/ListTimeSeriesCommand.d.ts +16 -0
  62. package/dist-types/commands/PutDefaultEncryptionConfigurationCommand.d.ts +16 -0
  63. package/dist-types/commands/PutLoggingOptionsCommand.d.ts +16 -0
  64. package/dist-types/commands/PutStorageConfigurationCommand.d.ts +16 -0
  65. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  66. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  67. package/dist-types/commands/UpdateAccessPolicyCommand.d.ts +16 -0
  68. package/dist-types/commands/UpdateAssetCommand.d.ts +16 -0
  69. package/dist-types/commands/UpdateAssetModelCommand.d.ts +16 -0
  70. package/dist-types/commands/UpdateAssetPropertyCommand.d.ts +16 -0
  71. package/dist-types/commands/UpdateDashboardCommand.d.ts +16 -0
  72. package/dist-types/commands/UpdateGatewayCapabilityConfigurationCommand.d.ts +16 -0
  73. package/dist-types/commands/UpdateGatewayCommand.d.ts +16 -0
  74. package/dist-types/commands/UpdatePortalCommand.d.ts +16 -0
  75. package/dist-types/commands/UpdateProjectCommand.d.ts +16 -0
  76. package/dist-types/models/IoTSiteWiseServiceException.d.ts +2 -0
  77. package/dist-types/models/models_0.d.ts +660 -19
  78. package/dist-types/pagination/BatchGetAssetPropertyAggregatesPaginator.d.ts +3 -0
  79. package/dist-types/pagination/BatchGetAssetPropertyValueHistoryPaginator.d.ts +3 -0
  80. package/dist-types/pagination/BatchGetAssetPropertyValuePaginator.d.ts +3 -0
  81. package/dist-types/pagination/GetAssetPropertyAggregatesPaginator.d.ts +3 -0
  82. package/dist-types/pagination/GetAssetPropertyValueHistoryPaginator.d.ts +3 -0
  83. package/dist-types/pagination/GetInterpolatedAssetPropertyValuesPaginator.d.ts +3 -0
  84. package/dist-types/pagination/Interfaces.d.ts +3 -0
  85. package/dist-types/pagination/ListAccessPoliciesPaginator.d.ts +3 -0
  86. package/dist-types/pagination/ListAssetModelPropertiesPaginator.d.ts +3 -0
  87. package/dist-types/pagination/ListAssetModelsPaginator.d.ts +3 -0
  88. package/dist-types/pagination/ListAssetPropertiesPaginator.d.ts +3 -0
  89. package/dist-types/pagination/ListAssetRelationshipsPaginator.d.ts +3 -0
  90. package/dist-types/pagination/ListAssetsPaginator.d.ts +3 -0
  91. package/dist-types/pagination/ListAssociatedAssetsPaginator.d.ts +3 -0
  92. package/dist-types/pagination/ListBulkImportJobsPaginator.d.ts +3 -0
  93. package/dist-types/pagination/ListDashboardsPaginator.d.ts +3 -0
  94. package/dist-types/pagination/ListGatewaysPaginator.d.ts +3 -0
  95. package/dist-types/pagination/ListPortalsPaginator.d.ts +3 -0
  96. package/dist-types/pagination/ListProjectAssetsPaginator.d.ts +3 -0
  97. package/dist-types/pagination/ListProjectsPaginator.d.ts +3 -0
  98. package/dist-types/pagination/ListTimeSeriesPaginator.d.ts +3 -0
  99. package/package.json +3 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
5
5
  import { PutStorageConfigurationRequest, PutStorageConfigurationResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutStorageConfigurationCommand}.
8
10
  */
9
11
  export interface PutStorageConfigurationCommandInput extends PutStorageConfigurationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutStorageConfigurationCommand}.
13
17
  */
14
18
  export interface PutStorageConfigurationCommandOutput extends PutStorageConfigurationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Configures storage settings for IoT SiteWise.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface PutStorageConfigurationCommandOutput extends PutStorageConfigur
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param PutStorageConfigurationCommandInput - {@link PutStorageConfigurationCommandInput}
34
+ * @returns {@link PutStorageConfigurationCommandOutput}
28
35
  * @see {@link PutStorageConfigurationCommandInput} for command's `input` shape.
29
36
  * @see {@link PutStorageConfigurationCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
@@ -63,11 +70,20 @@ export interface PutStorageConfigurationCommandOutput extends PutStorageConfigur
63
70
  export declare class PutStorageConfigurationCommand extends $Command<PutStorageConfigurationCommandInput, PutStorageConfigurationCommandOutput, IoTSiteWiseClientResolvedConfig> {
64
71
  readonly input: PutStorageConfigurationCommandInput;
65
72
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
73
+ /**
74
+ * @public
75
+ */
66
76
  constructor(input: PutStorageConfigurationCommandInput);
67
77
  /**
68
78
  * @internal
69
79
  */
70
80
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutStorageConfigurationCommandInput, PutStorageConfigurationCommandOutput>;
81
+ /**
82
+ * @internal
83
+ */
71
84
  private serialize;
85
+ /**
86
+ * @internal
87
+ */
72
88
  private deserialize;
73
89
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
5
5
  import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link TagResourceCommand}.
8
10
  */
9
11
  export interface TagResourceCommandInput extends TagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link TagResourceCommand}.
13
17
  */
14
18
  export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Adds tags to an IoT SiteWise resource. If a tag already exists for the resource, this operation
18
23
  * updates the tag's value.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
35
+ * @returns {@link TagResourceCommandOutput}
29
36
  * @see {@link TagResourceCommandInput} for command's `input` shape.
30
37
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
31
38
  * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
@@ -69,11 +76,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
69
76
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, IoTSiteWiseClientResolvedConfig> {
70
77
  readonly input: TagResourceCommandInput;
71
78
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
79
+ /**
80
+ * @public
81
+ */
72
82
  constructor(input: TagResourceCommandInput);
73
83
  /**
74
84
  * @internal
75
85
  */
76
86
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
87
+ /**
88
+ * @internal
89
+ */
77
90
  private serialize;
91
+ /**
92
+ * @internal
93
+ */
78
94
  private deserialize;
79
95
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
5
5
  import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UntagResourceCommand}.
8
10
  */
9
11
  export interface UntagResourceCommandInput extends UntagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UntagResourceCommand}.
13
17
  */
14
18
  export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes a tag from an IoT SiteWise resource.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
34
+ * @returns {@link UntagResourceCommandOutput}
28
35
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
@@ -63,11 +70,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
63
70
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, IoTSiteWiseClientResolvedConfig> {
64
71
  readonly input: UntagResourceCommandInput;
65
72
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
73
+ /**
74
+ * @public
75
+ */
66
76
  constructor(input: UntagResourceCommandInput);
67
77
  /**
68
78
  * @internal
69
79
  */
70
80
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
81
+ /**
82
+ * @internal
83
+ */
71
84
  private serialize;
85
+ /**
86
+ * @internal
87
+ */
72
88
  private deserialize;
73
89
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
5
5
  import { UpdateAccessPolicyRequest, UpdateAccessPolicyResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateAccessPolicyCommand}.
8
10
  */
9
11
  export interface UpdateAccessPolicyCommandInput extends UpdateAccessPolicyRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateAccessPolicyCommand}.
13
17
  */
14
18
  export interface UpdateAccessPolicyCommandOutput extends UpdateAccessPolicyResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor
18
23
  * portal or project resource.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface UpdateAccessPolicyCommandOutput extends UpdateAccessPolicyRespo
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param UpdateAccessPolicyCommandInput - {@link UpdateAccessPolicyCommandInput}
35
+ * @returns {@link UpdateAccessPolicyCommandOutput}
29
36
  * @see {@link UpdateAccessPolicyCommandInput} for command's `input` shape.
30
37
  * @see {@link UpdateAccessPolicyCommandOutput} for command's `response` shape.
31
38
  * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
@@ -51,11 +58,20 @@ export interface UpdateAccessPolicyCommandOutput extends UpdateAccessPolicyRespo
51
58
  export declare class UpdateAccessPolicyCommand extends $Command<UpdateAccessPolicyCommandInput, UpdateAccessPolicyCommandOutput, IoTSiteWiseClientResolvedConfig> {
52
59
  readonly input: UpdateAccessPolicyCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: UpdateAccessPolicyCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateAccessPolicyCommandInput, UpdateAccessPolicyCommandOutput>;
69
+ /**
70
+ * @internal
71
+ */
59
72
  private serialize;
73
+ /**
74
+ * @internal
75
+ */
60
76
  private deserialize;
61
77
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
5
5
  import { UpdateAssetRequest, UpdateAssetResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateAssetCommand}.
8
10
  */
9
11
  export interface UpdateAssetCommandInput extends UpdateAssetRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateAssetCommand}.
13
17
  */
14
18
  export interface UpdateAssetCommandOutput extends UpdateAssetResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates an asset's name. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html">Updating assets and models</a> in the
18
23
  * <i>IoT SiteWise User Guide</i>.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface UpdateAssetCommandOutput extends UpdateAssetResponse, __Metadat
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param UpdateAssetCommandInput - {@link UpdateAssetCommandInput}
35
+ * @returns {@link UpdateAssetCommandOutput}
29
36
  * @see {@link UpdateAssetCommandInput} for command's `input` shape.
30
37
  * @see {@link UpdateAssetCommandOutput} for command's `response` shape.
31
38
  * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
@@ -58,11 +65,20 @@ export interface UpdateAssetCommandOutput extends UpdateAssetResponse, __Metadat
58
65
  export declare class UpdateAssetCommand extends $Command<UpdateAssetCommandInput, UpdateAssetCommandOutput, IoTSiteWiseClientResolvedConfig> {
59
66
  readonly input: UpdateAssetCommandInput;
60
67
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
68
+ /**
69
+ * @public
70
+ */
61
71
  constructor(input: UpdateAssetCommandInput);
62
72
  /**
63
73
  * @internal
64
74
  */
65
75
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateAssetCommandInput, UpdateAssetCommandOutput>;
76
+ /**
77
+ * @internal
78
+ */
66
79
  private serialize;
80
+ /**
81
+ * @internal
82
+ */
67
83
  private deserialize;
68
84
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
5
5
  import { UpdateAssetModelRequest, UpdateAssetModelResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateAssetModelCommand}.
8
10
  */
9
11
  export interface UpdateAssetModelCommandInput extends UpdateAssetModelRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateAssetModelCommand}.
13
17
  */
14
18
  export interface UpdateAssetModelCommandOutput extends UpdateAssetModelResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates an asset model and all of the assets that were created from the model. Each asset
18
23
  * created from the model inherits the updated asset model's property and hierarchy definitions.
19
24
  * For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html">Updating assets and models</a> in the
@@ -37,6 +42,8 @@ export interface UpdateAssetModelCommandOutput extends UpdateAssetModelResponse,
37
42
  * const response = await client.send(command);
38
43
  * ```
39
44
  *
45
+ * @param UpdateAssetModelCommandInput - {@link UpdateAssetModelCommandInput}
46
+ * @returns {@link UpdateAssetModelCommandOutput}
40
47
  * @see {@link UpdateAssetModelCommandInput} for command's `input` shape.
41
48
  * @see {@link UpdateAssetModelCommandOutput} for command's `response` shape.
42
49
  * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
@@ -75,11 +82,20 @@ export interface UpdateAssetModelCommandOutput extends UpdateAssetModelResponse,
75
82
  export declare class UpdateAssetModelCommand extends $Command<UpdateAssetModelCommandInput, UpdateAssetModelCommandOutput, IoTSiteWiseClientResolvedConfig> {
76
83
  readonly input: UpdateAssetModelCommandInput;
77
84
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
85
+ /**
86
+ * @public
87
+ */
78
88
  constructor(input: UpdateAssetModelCommandInput);
79
89
  /**
80
90
  * @internal
81
91
  */
82
92
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateAssetModelCommandInput, UpdateAssetModelCommandOutput>;
93
+ /**
94
+ * @internal
95
+ */
83
96
  private serialize;
97
+ /**
98
+ * @internal
99
+ */
84
100
  private deserialize;
85
101
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
5
5
  import { UpdateAssetPropertyRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateAssetPropertyCommand}.
8
10
  */
9
11
  export interface UpdateAssetPropertyCommandInput extends UpdateAssetPropertyRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateAssetPropertyCommand}.
13
17
  */
14
18
  export interface UpdateAssetPropertyCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates an asset property's alias and notification state.</p>
18
23
  * <important>
19
24
  * <p>This operation overwrites the property's existing alias and notification state. To keep
@@ -30,6 +35,8 @@ export interface UpdateAssetPropertyCommandOutput extends __MetadataBearer {
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param UpdateAssetPropertyCommandInput - {@link UpdateAssetPropertyCommandInput}
39
+ * @returns {@link UpdateAssetPropertyCommandOutput}
33
40
  * @see {@link UpdateAssetPropertyCommandInput} for command's `input` shape.
34
41
  * @see {@link UpdateAssetPropertyCommandOutput} for command's `response` shape.
35
42
  * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
@@ -59,11 +66,20 @@ export interface UpdateAssetPropertyCommandOutput extends __MetadataBearer {
59
66
  export declare class UpdateAssetPropertyCommand extends $Command<UpdateAssetPropertyCommandInput, UpdateAssetPropertyCommandOutput, IoTSiteWiseClientResolvedConfig> {
60
67
  readonly input: UpdateAssetPropertyCommandInput;
61
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
62
72
  constructor(input: UpdateAssetPropertyCommandInput);
63
73
  /**
64
74
  * @internal
65
75
  */
66
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateAssetPropertyCommandInput, UpdateAssetPropertyCommandOutput>;
77
+ /**
78
+ * @internal
79
+ */
67
80
  private serialize;
81
+ /**
82
+ * @internal
83
+ */
68
84
  private deserialize;
69
85
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
5
5
  import { UpdateDashboardRequest, UpdateDashboardResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateDashboardCommand}.
8
10
  */
9
11
  export interface UpdateDashboardCommandInput extends UpdateDashboardRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateDashboardCommand}.
13
17
  */
14
18
  export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates an IoT SiteWise Monitor dashboard.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UpdateDashboardCommandInput - {@link UpdateDashboardCommandInput}
34
+ * @returns {@link UpdateDashboardCommandOutput}
28
35
  * @see {@link UpdateDashboardCommandInput} for command's `input` shape.
29
36
  * @see {@link UpdateDashboardCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
@@ -50,11 +57,20 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _
50
57
  export declare class UpdateDashboardCommand extends $Command<UpdateDashboardCommandInput, UpdateDashboardCommandOutput, IoTSiteWiseClientResolvedConfig> {
51
58
  readonly input: UpdateDashboardCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: UpdateDashboardCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateDashboardCommandInput, UpdateDashboardCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
5
5
  import { UpdateGatewayCapabilityConfigurationRequest, UpdateGatewayCapabilityConfigurationResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateGatewayCapabilityConfigurationCommand}.
8
10
  */
9
11
  export interface UpdateGatewayCapabilityConfigurationCommandInput extends UpdateGatewayCapabilityConfigurationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateGatewayCapabilityConfigurationCommand}.
13
17
  */
14
18
  export interface UpdateGatewayCapabilityConfigurationCommandOutput extends UpdateGatewayCapabilityConfigurationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates a gateway capability configuration or defines a new capability configuration.
18
23
  * Each gateway capability defines data sources for a gateway. A capability configuration
19
24
  * can contain multiple data source configurations. If you define OPC-UA sources for a gateway in
@@ -29,6 +34,8 @@ export interface UpdateGatewayCapabilityConfigurationCommandOutput extends Updat
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param UpdateGatewayCapabilityConfigurationCommandInput - {@link UpdateGatewayCapabilityConfigurationCommandInput}
38
+ * @returns {@link UpdateGatewayCapabilityConfigurationCommandOutput}
32
39
  * @see {@link UpdateGatewayCapabilityConfigurationCommandInput} for command's `input` shape.
33
40
  * @see {@link UpdateGatewayCapabilityConfigurationCommandOutput} for command's `response` shape.
34
41
  * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
@@ -64,11 +71,20 @@ export interface UpdateGatewayCapabilityConfigurationCommandOutput extends Updat
64
71
  export declare class UpdateGatewayCapabilityConfigurationCommand extends $Command<UpdateGatewayCapabilityConfigurationCommandInput, UpdateGatewayCapabilityConfigurationCommandOutput, IoTSiteWiseClientResolvedConfig> {
65
72
  readonly input: UpdateGatewayCapabilityConfigurationCommandInput;
66
73
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
74
+ /**
75
+ * @public
76
+ */
67
77
  constructor(input: UpdateGatewayCapabilityConfigurationCommandInput);
68
78
  /**
69
79
  * @internal
70
80
  */
71
81
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateGatewayCapabilityConfigurationCommandInput, UpdateGatewayCapabilityConfigurationCommandOutput>;
82
+ /**
83
+ * @internal
84
+ */
72
85
  private serialize;
86
+ /**
87
+ * @internal
88
+ */
73
89
  private deserialize;
74
90
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
5
5
  import { UpdateGatewayRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateGatewayCommand}.
8
10
  */
9
11
  export interface UpdateGatewayCommandInput extends UpdateGatewayRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateGatewayCommand}.
13
17
  */
14
18
  export interface UpdateGatewayCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates a gateway's name.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateGatewayCommandOutput extends __MetadataBearer {
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UpdateGatewayCommandInput - {@link UpdateGatewayCommandInput}
34
+ * @returns {@link UpdateGatewayCommandOutput}
28
35
  * @see {@link UpdateGatewayCommandInput} for command's `input` shape.
29
36
  * @see {@link UpdateGatewayCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
@@ -54,11 +61,20 @@ export interface UpdateGatewayCommandOutput extends __MetadataBearer {
54
61
  export declare class UpdateGatewayCommand extends $Command<UpdateGatewayCommandInput, UpdateGatewayCommandOutput, IoTSiteWiseClientResolvedConfig> {
55
62
  readonly input: UpdateGatewayCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: UpdateGatewayCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateGatewayCommandInput, UpdateGatewayCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
5
5
  import { UpdatePortalRequest, UpdatePortalResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdatePortalCommand}.
8
10
  */
9
11
  export interface UpdatePortalCommandInput extends UpdatePortalRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdatePortalCommand}.
13
17
  */
14
18
  export interface UpdatePortalCommandOutput extends UpdatePortalResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates an IoT SiteWise Monitor portal.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdatePortalCommandOutput extends UpdatePortalResponse, __Metad
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UpdatePortalCommandInput - {@link UpdatePortalCommandInput}
34
+ * @returns {@link UpdatePortalCommandOutput}
28
35
  * @see {@link UpdatePortalCommandInput} for command's `input` shape.
29
36
  * @see {@link UpdatePortalCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
@@ -54,11 +61,20 @@ export interface UpdatePortalCommandOutput extends UpdatePortalResponse, __Metad
54
61
  export declare class UpdatePortalCommand extends $Command<UpdatePortalCommandInput, UpdatePortalCommandOutput, IoTSiteWiseClientResolvedConfig> {
55
62
  readonly input: UpdatePortalCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: UpdatePortalCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdatePortalCommandInput, UpdatePortalCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
5
5
  import { UpdateProjectRequest, UpdateProjectResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateProjectCommand}.
8
10
  */
9
11
  export interface UpdateProjectCommandInput extends UpdateProjectRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateProjectCommand}.
13
17
  */
14
18
  export interface UpdateProjectCommandOutput extends UpdateProjectResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates an IoT SiteWise Monitor project.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateProjectCommandOutput extends UpdateProjectResponse, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UpdateProjectCommandInput - {@link UpdateProjectCommandInput}
34
+ * @returns {@link UpdateProjectCommandOutput}
28
35
  * @see {@link UpdateProjectCommandInput} for command's `input` shape.
29
36
  * @see {@link UpdateProjectCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
@@ -50,11 +57,20 @@ export interface UpdateProjectCommandOutput extends UpdateProjectResponse, __Met
50
57
  export declare class UpdateProjectCommand extends $Command<UpdateProjectCommandInput, UpdateProjectCommandOutput, IoTSiteWiseClientResolvedConfig> {
51
58
  readonly input: UpdateProjectCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: UpdateProjectCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateProjectCommandInput, UpdateProjectCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from IoTSiteWise service.
4
6
  */
5
7
  export declare class IoTSiteWiseServiceException extends __ServiceException {