@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 { ListAssetRelationshipsRequest, ListAssetRelationshipsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListAssetRelationshipsCommand}.
8
10
  */
9
11
  export interface ListAssetRelationshipsCommandInput extends ListAssetRelationshipsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListAssetRelationshipsCommand}.
13
17
  */
14
18
  export interface ListAssetRelationshipsCommandOutput extends ListAssetRelationshipsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves a paginated list of asset relationships for an asset. You can use this operation
18
23
  * to identify an asset's root asset and all associated assets between that asset and its
19
24
  * root.</p>
@@ -27,6 +32,8 @@ export interface ListAssetRelationshipsCommandOutput extends ListAssetRelationsh
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param ListAssetRelationshipsCommandInput - {@link ListAssetRelationshipsCommandInput}
36
+ * @returns {@link ListAssetRelationshipsCommandOutput}
30
37
  * @see {@link ListAssetRelationshipsCommandInput} for command's `input` shape.
31
38
  * @see {@link ListAssetRelationshipsCommandOutput} for command's `response` shape.
32
39
  * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
@@ -52,11 +59,20 @@ export interface ListAssetRelationshipsCommandOutput extends ListAssetRelationsh
52
59
  export declare class ListAssetRelationshipsCommand extends $Command<ListAssetRelationshipsCommandInput, ListAssetRelationshipsCommandOutput, IoTSiteWiseClientResolvedConfig> {
53
60
  readonly input: ListAssetRelationshipsCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: ListAssetRelationshipsCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListAssetRelationshipsCommandInput, ListAssetRelationshipsCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
5
5
  import { ListAssetsRequest, ListAssetsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListAssetsCommand}.
8
10
  */
9
11
  export interface ListAssetsCommandInput extends ListAssetsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListAssetsCommand}.
13
17
  */
14
18
  export interface ListAssetsCommandOutput extends ListAssetsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves a paginated list of asset summaries.</p>
18
23
  * <p>You can use this operation to do the following:</p>
19
24
  * <ul>
@@ -37,6 +42,8 @@ export interface ListAssetsCommandOutput extends ListAssetsResponse, __MetadataB
37
42
  * const response = await client.send(command);
38
43
  * ```
39
44
  *
45
+ * @param ListAssetsCommandInput - {@link ListAssetsCommandInput}
46
+ * @returns {@link ListAssetsCommandOutput}
40
47
  * @see {@link ListAssetsCommandInput} for command's `input` shape.
41
48
  * @see {@link ListAssetsCommandOutput} for command's `response` shape.
42
49
  * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
@@ -62,11 +69,20 @@ export interface ListAssetsCommandOutput extends ListAssetsResponse, __MetadataB
62
69
  export declare class ListAssetsCommand extends $Command<ListAssetsCommandInput, ListAssetsCommandOutput, IoTSiteWiseClientResolvedConfig> {
63
70
  readonly input: ListAssetsCommandInput;
64
71
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
72
+ /**
73
+ * @public
74
+ */
65
75
  constructor(input: ListAssetsCommandInput);
66
76
  /**
67
77
  * @internal
68
78
  */
69
79
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListAssetsCommandInput, ListAssetsCommandOutput>;
80
+ /**
81
+ * @internal
82
+ */
70
83
  private serialize;
84
+ /**
85
+ * @internal
86
+ */
71
87
  private deserialize;
72
88
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
5
5
  import { ListAssociatedAssetsRequest, ListAssociatedAssetsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListAssociatedAssetsCommand}.
8
10
  */
9
11
  export interface ListAssociatedAssetsCommandInput extends ListAssociatedAssetsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListAssociatedAssetsCommand}.
13
17
  */
14
18
  export interface ListAssociatedAssetsCommandOutput extends ListAssociatedAssetsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves a paginated list of associated assets.</p>
18
23
  * <p>You can use this operation to do the following:</p>
19
24
  * <ul>
@@ -34,6 +39,8 @@ export interface ListAssociatedAssetsCommandOutput extends ListAssociatedAssetsR
34
39
  * const response = await client.send(command);
35
40
  * ```
36
41
  *
42
+ * @param ListAssociatedAssetsCommandInput - {@link ListAssociatedAssetsCommandInput}
43
+ * @returns {@link ListAssociatedAssetsCommandOutput}
37
44
  * @see {@link ListAssociatedAssetsCommandInput} for command's `input` shape.
38
45
  * @see {@link ListAssociatedAssetsCommandOutput} for command's `response` shape.
39
46
  * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
@@ -59,11 +66,20 @@ export interface ListAssociatedAssetsCommandOutput extends ListAssociatedAssetsR
59
66
  export declare class ListAssociatedAssetsCommand extends $Command<ListAssociatedAssetsCommandInput, ListAssociatedAssetsCommandOutput, IoTSiteWiseClientResolvedConfig> {
60
67
  readonly input: ListAssociatedAssetsCommandInput;
61
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
62
72
  constructor(input: ListAssociatedAssetsCommandInput);
63
73
  /**
64
74
  * @internal
65
75
  */
66
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListAssociatedAssetsCommandInput, ListAssociatedAssetsCommandOutput>;
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 { ListBulkImportJobsRequest, ListBulkImportJobsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListBulkImportJobsCommand}.
8
10
  */
9
11
  export interface ListBulkImportJobsCommandInput extends ListBulkImportJobsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListBulkImportJobsCommand}.
13
17
  */
14
18
  export interface ListBulkImportJobsCommandOutput extends ListBulkImportJobsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves a paginated list of bulk import job requests. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ListBulkImportJobs.html">List bulk
18
23
  * import jobs (CLI)</a> in the <i>IoT SiteWise User Guide</i>.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface ListBulkImportJobsCommandOutput extends ListBulkImportJobsRespo
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param ListBulkImportJobsCommandInput - {@link ListBulkImportJobsCommandInput}
35
+ * @returns {@link ListBulkImportJobsCommandOutput}
29
36
  * @see {@link ListBulkImportJobsCommandInput} for command's `input` shape.
30
37
  * @see {@link ListBulkImportJobsCommandOutput} for command's `response` shape.
31
38
  * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
@@ -51,11 +58,20 @@ export interface ListBulkImportJobsCommandOutput extends ListBulkImportJobsRespo
51
58
  export declare class ListBulkImportJobsCommand extends $Command<ListBulkImportJobsCommandInput, ListBulkImportJobsCommandOutput, IoTSiteWiseClientResolvedConfig> {
52
59
  readonly input: ListBulkImportJobsCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: ListBulkImportJobsCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListBulkImportJobsCommandInput, ListBulkImportJobsCommandOutput>;
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 { ListDashboardsRequest, ListDashboardsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListDashboardsCommand}.
8
10
  */
9
11
  export interface ListDashboardsCommandInput extends ListDashboardsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListDashboardsCommand}.
13
17
  */
14
18
  export interface ListDashboardsCommandOutput extends ListDashboardsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves a paginated list of dashboards for 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 ListDashboardsCommandOutput extends ListDashboardsResponse, __M
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListDashboardsCommandInput - {@link ListDashboardsCommandInput}
34
+ * @returns {@link ListDashboardsCommandOutput}
28
35
  * @see {@link ListDashboardsCommandInput} for command's `input` shape.
29
36
  * @see {@link ListDashboardsCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
@@ -47,11 +54,20 @@ export interface ListDashboardsCommandOutput extends ListDashboardsResponse, __M
47
54
  export declare class ListDashboardsCommand extends $Command<ListDashboardsCommandInput, ListDashboardsCommandOutput, IoTSiteWiseClientResolvedConfig> {
48
55
  readonly input: ListDashboardsCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: ListDashboardsCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListDashboardsCommandInput, ListDashboardsCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
5
5
  import { ListGatewaysRequest, ListGatewaysResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListGatewaysCommand}.
8
10
  */
9
11
  export interface ListGatewaysCommandInput extends ListGatewaysRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListGatewaysCommand}.
13
17
  */
14
18
  export interface ListGatewaysCommandOutput extends ListGatewaysResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves a paginated list of gateways.</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 ListGatewaysCommandOutput extends ListGatewaysResponse, __Metad
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListGatewaysCommandInput - {@link ListGatewaysCommandInput}
34
+ * @returns {@link ListGatewaysCommandOutput}
28
35
  * @see {@link ListGatewaysCommandInput} for command's `input` shape.
29
36
  * @see {@link ListGatewaysCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
@@ -47,11 +54,20 @@ export interface ListGatewaysCommandOutput extends ListGatewaysResponse, __Metad
47
54
  export declare class ListGatewaysCommand extends $Command<ListGatewaysCommandInput, ListGatewaysCommandOutput, IoTSiteWiseClientResolvedConfig> {
48
55
  readonly input: ListGatewaysCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: ListGatewaysCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListGatewaysCommandInput, ListGatewaysCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
5
5
  import { ListPortalsRequest, ListPortalsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListPortalsCommand}.
8
10
  */
9
11
  export interface ListPortalsCommandInput extends ListPortalsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListPortalsCommand}.
13
17
  */
14
18
  export interface ListPortalsCommandOutput extends ListPortalsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves a paginated list of IoT SiteWise Monitor portals.</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 ListPortalsCommandOutput extends ListPortalsResponse, __Metadat
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListPortalsCommandInput - {@link ListPortalsCommandInput}
34
+ * @returns {@link ListPortalsCommandOutput}
28
35
  * @see {@link ListPortalsCommandInput} for command's `input` shape.
29
36
  * @see {@link ListPortalsCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
@@ -47,11 +54,20 @@ export interface ListPortalsCommandOutput extends ListPortalsResponse, __Metadat
47
54
  export declare class ListPortalsCommand extends $Command<ListPortalsCommandInput, ListPortalsCommandOutput, IoTSiteWiseClientResolvedConfig> {
48
55
  readonly input: ListPortalsCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: ListPortalsCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListPortalsCommandInput, ListPortalsCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
5
5
  import { ListProjectAssetsRequest, ListProjectAssetsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListProjectAssetsCommand}.
8
10
  */
9
11
  export interface ListProjectAssetsCommandInput extends ListProjectAssetsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListProjectAssetsCommand}.
13
17
  */
14
18
  export interface ListProjectAssetsCommandOutput extends ListProjectAssetsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves a paginated list of assets associated with 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 ListProjectAssetsCommandOutput extends ListProjectAssetsRespons
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListProjectAssetsCommandInput - {@link ListProjectAssetsCommandInput}
34
+ * @returns {@link ListProjectAssetsCommandOutput}
28
35
  * @see {@link ListProjectAssetsCommandInput} for command's `input` shape.
29
36
  * @see {@link ListProjectAssetsCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
@@ -47,11 +54,20 @@ export interface ListProjectAssetsCommandOutput extends ListProjectAssetsRespons
47
54
  export declare class ListProjectAssetsCommand extends $Command<ListProjectAssetsCommandInput, ListProjectAssetsCommandOutput, IoTSiteWiseClientResolvedConfig> {
48
55
  readonly input: ListProjectAssetsCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: ListProjectAssetsCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListProjectAssetsCommandInput, ListProjectAssetsCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
5
5
  import { ListProjectsRequest, ListProjectsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListProjectsCommand}.
8
10
  */
9
11
  export interface ListProjectsCommandInput extends ListProjectsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListProjectsCommand}.
13
17
  */
14
18
  export interface ListProjectsCommandOutput extends ListProjectsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves a paginated list of projects for 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 ListProjectsCommandOutput extends ListProjectsResponse, __Metad
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListProjectsCommandInput - {@link ListProjectsCommandInput}
34
+ * @returns {@link ListProjectsCommandOutput}
28
35
  * @see {@link ListProjectsCommandInput} for command's `input` shape.
29
36
  * @see {@link ListProjectsCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
@@ -47,11 +54,20 @@ export interface ListProjectsCommandOutput extends ListProjectsResponse, __Metad
47
54
  export declare class ListProjectsCommand extends $Command<ListProjectsCommandInput, ListProjectsCommandOutput, IoTSiteWiseClientResolvedConfig> {
48
55
  readonly input: ListProjectsCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: ListProjectsCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListProjectsCommandInput, ListProjectsCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
5
5
  import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListTagsForResourceCommand}.
8
10
  */
9
11
  export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListTagsForResourceCommand}.
13
17
  */
14
18
  export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the list of tags for 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 ListTagsForResourceCommandOutput extends ListTagsForResourceRes
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
34
+ * @returns {@link ListTagsForResourceCommandOutput}
28
35
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
@@ -63,11 +70,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
63
70
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, IoTSiteWiseClientResolvedConfig> {
64
71
  readonly input: ListTagsForResourceCommandInput;
65
72
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
73
+ /**
74
+ * @public
75
+ */
66
76
  constructor(input: ListTagsForResourceCommandInput);
67
77
  /**
68
78
  * @internal
69
79
  */
70
80
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
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 { ListTimeSeriesRequest, ListTimeSeriesResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListTimeSeriesCommand}.
8
10
  */
9
11
  export interface ListTimeSeriesCommandInput extends ListTimeSeriesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListTimeSeriesCommand}.
13
17
  */
14
18
  export interface ListTimeSeriesCommandOutput extends ListTimeSeriesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves a paginated list of time series (data streams).</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 ListTimeSeriesCommandOutput extends ListTimeSeriesResponse, __M
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListTimeSeriesCommandInput - {@link ListTimeSeriesCommandInput}
34
+ * @returns {@link ListTimeSeriesCommandOutput}
28
35
  * @see {@link ListTimeSeriesCommandInput} for command's `input` shape.
29
36
  * @see {@link ListTimeSeriesCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
@@ -50,11 +57,20 @@ export interface ListTimeSeriesCommandOutput extends ListTimeSeriesResponse, __M
50
57
  export declare class ListTimeSeriesCommand extends $Command<ListTimeSeriesCommandInput, ListTimeSeriesCommandOutput, IoTSiteWiseClientResolvedConfig> {
51
58
  readonly input: ListTimeSeriesCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: ListTimeSeriesCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTimeSeriesCommandInput, ListTimeSeriesCommandOutput>;
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 { PutDefaultEncryptionConfigurationRequest, PutDefaultEncryptionConfigurationResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutDefaultEncryptionConfigurationCommand}.
8
10
  */
9
11
  export interface PutDefaultEncryptionConfigurationCommandInput extends PutDefaultEncryptionConfigurationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutDefaultEncryptionConfigurationCommand}.
13
17
  */
14
18
  export interface PutDefaultEncryptionConfigurationCommandOutput extends PutDefaultEncryptionConfigurationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Sets the default encryption configuration for the Amazon Web Services account. For more information, see
18
23
  * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html">Key management</a> in
19
24
  * the <i>IoT SiteWise User Guide</i>.</p>
@@ -27,6 +32,8 @@ export interface PutDefaultEncryptionConfigurationCommandOutput extends PutDefau
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param PutDefaultEncryptionConfigurationCommandInput - {@link PutDefaultEncryptionConfigurationCommandInput}
36
+ * @returns {@link PutDefaultEncryptionConfigurationCommandOutput}
30
37
  * @see {@link PutDefaultEncryptionConfigurationCommandInput} for command's `input` shape.
31
38
  * @see {@link PutDefaultEncryptionConfigurationCommandOutput} for command's `response` shape.
32
39
  * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
@@ -59,11 +66,20 @@ export interface PutDefaultEncryptionConfigurationCommandOutput extends PutDefau
59
66
  export declare class PutDefaultEncryptionConfigurationCommand extends $Command<PutDefaultEncryptionConfigurationCommandInput, PutDefaultEncryptionConfigurationCommandOutput, IoTSiteWiseClientResolvedConfig> {
60
67
  readonly input: PutDefaultEncryptionConfigurationCommandInput;
61
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
62
72
  constructor(input: PutDefaultEncryptionConfigurationCommandInput);
63
73
  /**
64
74
  * @internal
65
75
  */
66
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutDefaultEncryptionConfigurationCommandInput, PutDefaultEncryptionConfigurationCommandOutput>;
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 { PutLoggingOptionsRequest, PutLoggingOptionsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutLoggingOptionsCommand}.
8
10
  */
9
11
  export interface PutLoggingOptionsCommandInput extends PutLoggingOptionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutLoggingOptionsCommand}.
13
17
  */
14
18
  export interface PutLoggingOptionsCommandOutput extends PutLoggingOptionsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Sets logging options 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 PutLoggingOptionsCommandOutput extends PutLoggingOptionsRespons
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param PutLoggingOptionsCommandInput - {@link PutLoggingOptionsCommandInput}
34
+ * @returns {@link PutLoggingOptionsCommandOutput}
28
35
  * @see {@link PutLoggingOptionsCommandInput} for command's `input` shape.
29
36
  * @see {@link PutLoggingOptionsCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
@@ -54,11 +61,20 @@ export interface PutLoggingOptionsCommandOutput extends PutLoggingOptionsRespons
54
61
  export declare class PutLoggingOptionsCommand extends $Command<PutLoggingOptionsCommandInput, PutLoggingOptionsCommandOutput, IoTSiteWiseClientResolvedConfig> {
55
62
  readonly input: PutLoggingOptionsCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: PutLoggingOptionsCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutLoggingOptionsCommandInput, PutLoggingOptionsCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }