@aws-sdk/client-iotsitewise 3.295.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 (104) hide show
  1. package/dist-cjs/endpoint/ruleset.js +3 -3
  2. package/dist-cjs/protocols/Aws_restJson1.js +4 -0
  3. package/dist-es/endpoint/ruleset.js +3 -3
  4. package/dist-es/protocols/Aws_restJson1.js +4 -0
  5. package/dist-types/IoTSiteWise.d.ts +76 -2
  6. package/dist-types/IoTSiteWiseClient.d.ts +24 -4
  7. package/dist-types/commands/AssociateAssetsCommand.d.ts +16 -0
  8. package/dist-types/commands/AssociateTimeSeriesToAssetPropertyCommand.d.ts +16 -0
  9. package/dist-types/commands/BatchAssociateProjectAssetsCommand.d.ts +16 -0
  10. package/dist-types/commands/BatchDisassociateProjectAssetsCommand.d.ts +16 -0
  11. package/dist-types/commands/BatchGetAssetPropertyAggregatesCommand.d.ts +16 -0
  12. package/dist-types/commands/BatchGetAssetPropertyValueCommand.d.ts +16 -0
  13. package/dist-types/commands/BatchGetAssetPropertyValueHistoryCommand.d.ts +16 -0
  14. package/dist-types/commands/BatchPutAssetPropertyValueCommand.d.ts +18 -2
  15. package/dist-types/commands/CreateAccessPolicyCommand.d.ts +16 -0
  16. package/dist-types/commands/CreateAssetCommand.d.ts +16 -0
  17. package/dist-types/commands/CreateAssetModelCommand.d.ts +16 -0
  18. package/dist-types/commands/CreateBulkImportJobCommand.d.ts +16 -0
  19. package/dist-types/commands/CreateDashboardCommand.d.ts +16 -0
  20. package/dist-types/commands/CreateGatewayCommand.d.ts +16 -0
  21. package/dist-types/commands/CreatePortalCommand.d.ts +16 -0
  22. package/dist-types/commands/CreateProjectCommand.d.ts +16 -0
  23. package/dist-types/commands/DeleteAccessPolicyCommand.d.ts +16 -0
  24. package/dist-types/commands/DeleteAssetCommand.d.ts +16 -0
  25. package/dist-types/commands/DeleteAssetModelCommand.d.ts +16 -0
  26. package/dist-types/commands/DeleteDashboardCommand.d.ts +16 -0
  27. package/dist-types/commands/DeleteGatewayCommand.d.ts +16 -0
  28. package/dist-types/commands/DeletePortalCommand.d.ts +16 -0
  29. package/dist-types/commands/DeleteProjectCommand.d.ts +16 -0
  30. package/dist-types/commands/DeleteTimeSeriesCommand.d.ts +16 -0
  31. package/dist-types/commands/DescribeAccessPolicyCommand.d.ts +16 -0
  32. package/dist-types/commands/DescribeAssetCommand.d.ts +16 -0
  33. package/dist-types/commands/DescribeAssetModelCommand.d.ts +16 -0
  34. package/dist-types/commands/DescribeAssetPropertyCommand.d.ts +16 -0
  35. package/dist-types/commands/DescribeBulkImportJobCommand.d.ts +16 -0
  36. package/dist-types/commands/DescribeDashboardCommand.d.ts +16 -0
  37. package/dist-types/commands/DescribeDefaultEncryptionConfigurationCommand.d.ts +16 -0
  38. package/dist-types/commands/DescribeGatewayCapabilityConfigurationCommand.d.ts +16 -0
  39. package/dist-types/commands/DescribeGatewayCommand.d.ts +16 -0
  40. package/dist-types/commands/DescribeLoggingOptionsCommand.d.ts +16 -0
  41. package/dist-types/commands/DescribePortalCommand.d.ts +16 -0
  42. package/dist-types/commands/DescribeProjectCommand.d.ts +16 -0
  43. package/dist-types/commands/DescribeStorageConfigurationCommand.d.ts +16 -0
  44. package/dist-types/commands/DescribeTimeSeriesCommand.d.ts +16 -0
  45. package/dist-types/commands/DisassociateAssetsCommand.d.ts +16 -0
  46. package/dist-types/commands/DisassociateTimeSeriesFromAssetPropertyCommand.d.ts +16 -0
  47. package/dist-types/commands/GetAssetPropertyAggregatesCommand.d.ts +16 -0
  48. package/dist-types/commands/GetAssetPropertyValueCommand.d.ts +16 -0
  49. package/dist-types/commands/GetAssetPropertyValueHistoryCommand.d.ts +16 -0
  50. package/dist-types/commands/GetInterpolatedAssetPropertyValuesCommand.d.ts +16 -0
  51. package/dist-types/commands/ListAccessPoliciesCommand.d.ts +16 -0
  52. package/dist-types/commands/ListAssetModelPropertiesCommand.d.ts +16 -0
  53. package/dist-types/commands/ListAssetModelsCommand.d.ts +16 -0
  54. package/dist-types/commands/ListAssetPropertiesCommand.d.ts +16 -0
  55. package/dist-types/commands/ListAssetRelationshipsCommand.d.ts +16 -0
  56. package/dist-types/commands/ListAssetsCommand.d.ts +16 -0
  57. package/dist-types/commands/ListAssociatedAssetsCommand.d.ts +16 -0
  58. package/dist-types/commands/ListBulkImportJobsCommand.d.ts +16 -0
  59. package/dist-types/commands/ListDashboardsCommand.d.ts +16 -0
  60. package/dist-types/commands/ListGatewaysCommand.d.ts +16 -0
  61. package/dist-types/commands/ListPortalsCommand.d.ts +16 -0
  62. package/dist-types/commands/ListProjectAssetsCommand.d.ts +16 -0
  63. package/dist-types/commands/ListProjectsCommand.d.ts +16 -0
  64. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  65. package/dist-types/commands/ListTimeSeriesCommand.d.ts +16 -0
  66. package/dist-types/commands/PutDefaultEncryptionConfigurationCommand.d.ts +16 -0
  67. package/dist-types/commands/PutLoggingOptionsCommand.d.ts +16 -0
  68. package/dist-types/commands/PutStorageConfigurationCommand.d.ts +16 -0
  69. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  70. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  71. package/dist-types/commands/UpdateAccessPolicyCommand.d.ts +16 -0
  72. package/dist-types/commands/UpdateAssetCommand.d.ts +16 -0
  73. package/dist-types/commands/UpdateAssetModelCommand.d.ts +16 -0
  74. package/dist-types/commands/UpdateAssetPropertyCommand.d.ts +16 -0
  75. package/dist-types/commands/UpdateDashboardCommand.d.ts +16 -0
  76. package/dist-types/commands/UpdateGatewayCapabilityConfigurationCommand.d.ts +16 -0
  77. package/dist-types/commands/UpdateGatewayCommand.d.ts +16 -0
  78. package/dist-types/commands/UpdatePortalCommand.d.ts +16 -0
  79. package/dist-types/commands/UpdateProjectCommand.d.ts +16 -0
  80. package/dist-types/models/IoTSiteWiseServiceException.d.ts +2 -0
  81. package/dist-types/models/models_0.d.ts +690 -35
  82. package/dist-types/pagination/BatchGetAssetPropertyAggregatesPaginator.d.ts +3 -0
  83. package/dist-types/pagination/BatchGetAssetPropertyValueHistoryPaginator.d.ts +3 -0
  84. package/dist-types/pagination/BatchGetAssetPropertyValuePaginator.d.ts +3 -0
  85. package/dist-types/pagination/GetAssetPropertyAggregatesPaginator.d.ts +3 -0
  86. package/dist-types/pagination/GetAssetPropertyValueHistoryPaginator.d.ts +3 -0
  87. package/dist-types/pagination/GetInterpolatedAssetPropertyValuesPaginator.d.ts +3 -0
  88. package/dist-types/pagination/Interfaces.d.ts +3 -0
  89. package/dist-types/pagination/ListAccessPoliciesPaginator.d.ts +3 -0
  90. package/dist-types/pagination/ListAssetModelPropertiesPaginator.d.ts +3 -0
  91. package/dist-types/pagination/ListAssetModelsPaginator.d.ts +3 -0
  92. package/dist-types/pagination/ListAssetPropertiesPaginator.d.ts +3 -0
  93. package/dist-types/pagination/ListAssetRelationshipsPaginator.d.ts +3 -0
  94. package/dist-types/pagination/ListAssetsPaginator.d.ts +3 -0
  95. package/dist-types/pagination/ListAssociatedAssetsPaginator.d.ts +3 -0
  96. package/dist-types/pagination/ListBulkImportJobsPaginator.d.ts +3 -0
  97. package/dist-types/pagination/ListDashboardsPaginator.d.ts +3 -0
  98. package/dist-types/pagination/ListGatewaysPaginator.d.ts +3 -0
  99. package/dist-types/pagination/ListPortalsPaginator.d.ts +3 -0
  100. package/dist-types/pagination/ListProjectAssetsPaginator.d.ts +3 -0
  101. package/dist-types/pagination/ListProjectsPaginator.d.ts +3 -0
  102. package/dist-types/pagination/ListTimeSeriesPaginator.d.ts +3 -0
  103. package/dist-types/ts3.4/models/models_0.d.ts +2 -0
  104. package/package.json +30 -30
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
5
5
  import { DescribeAccessPolicyRequest, DescribeAccessPolicyResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeAccessPolicyCommand}.
8
10
  */
9
11
  export interface DescribeAccessPolicyCommandInput extends DescribeAccessPolicyRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeAccessPolicyCommand}.
13
17
  */
14
18
  export interface DescribeAccessPolicyCommandOutput extends DescribeAccessPolicyResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or
18
23
  * project.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DescribeAccessPolicyCommandOutput extends DescribeAccessPolicyR
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DescribeAccessPolicyCommandInput - {@link DescribeAccessPolicyCommandInput}
35
+ * @returns {@link DescribeAccessPolicyCommandOutput}
29
36
  * @see {@link DescribeAccessPolicyCommandInput} for command's `input` shape.
30
37
  * @see {@link DescribeAccessPolicyCommandOutput} for command's `response` shape.
31
38
  * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
@@ -51,11 +58,20 @@ export interface DescribeAccessPolicyCommandOutput extends DescribeAccessPolicyR
51
58
  export declare class DescribeAccessPolicyCommand extends $Command<DescribeAccessPolicyCommandInput, DescribeAccessPolicyCommandOutput, IoTSiteWiseClientResolvedConfig> {
52
59
  readonly input: DescribeAccessPolicyCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: DescribeAccessPolicyCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeAccessPolicyCommandInput, DescribeAccessPolicyCommandOutput>;
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 { DescribeAssetRequest, DescribeAssetResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeAssetCommand}.
8
10
  */
9
11
  export interface DescribeAssetCommandInput extends DescribeAssetRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeAssetCommand}.
13
17
  */
14
18
  export interface DescribeAssetCommandOutput extends DescribeAssetResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves information about an asset.</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 DescribeAssetCommandOutput extends DescribeAssetResponse, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeAssetCommandInput - {@link DescribeAssetCommandInput}
34
+ * @returns {@link DescribeAssetCommandOutput}
28
35
  * @see {@link DescribeAssetCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeAssetCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
@@ -50,11 +57,20 @@ export interface DescribeAssetCommandOutput extends DescribeAssetResponse, __Met
50
57
  export declare class DescribeAssetCommand extends $Command<DescribeAssetCommandInput, DescribeAssetCommandOutput, IoTSiteWiseClientResolvedConfig> {
51
58
  readonly input: DescribeAssetCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: DescribeAssetCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeAssetCommandInput, DescribeAssetCommandOutput>;
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 { DescribeAssetModelRequest, DescribeAssetModelResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeAssetModelCommand}.
8
10
  */
9
11
  export interface DescribeAssetModelCommandInput extends DescribeAssetModelRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeAssetModelCommand}.
13
17
  */
14
18
  export interface DescribeAssetModelCommandOutput extends DescribeAssetModelResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves information about an asset model.</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 DescribeAssetModelCommandOutput extends DescribeAssetModelRespo
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeAssetModelCommandInput - {@link DescribeAssetModelCommandInput}
34
+ * @returns {@link DescribeAssetModelCommandOutput}
28
35
  * @see {@link DescribeAssetModelCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeAssetModelCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
@@ -50,11 +57,20 @@ export interface DescribeAssetModelCommandOutput extends DescribeAssetModelRespo
50
57
  export declare class DescribeAssetModelCommand extends $Command<DescribeAssetModelCommandInput, DescribeAssetModelCommandOutput, IoTSiteWiseClientResolvedConfig> {
51
58
  readonly input: DescribeAssetModelCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: DescribeAssetModelCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeAssetModelCommandInput, DescribeAssetModelCommandOutput>;
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 { DescribeAssetPropertyRequest, DescribeAssetPropertyResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeAssetPropertyCommand}.
8
10
  */
9
11
  export interface DescribeAssetPropertyCommandInput extends DescribeAssetPropertyRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeAssetPropertyCommand}.
13
17
  */
14
18
  export interface DescribeAssetPropertyCommandOutput extends DescribeAssetPropertyResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves information about an asset property.</p>
18
23
  * <note>
19
24
  * <p>When you call this operation for an attribute property, this response includes the
@@ -32,6 +37,8 @@ export interface DescribeAssetPropertyCommandOutput extends DescribeAssetPropert
32
37
  * const response = await client.send(command);
33
38
  * ```
34
39
  *
40
+ * @param DescribeAssetPropertyCommandInput - {@link DescribeAssetPropertyCommandInput}
41
+ * @returns {@link DescribeAssetPropertyCommandOutput}
35
42
  * @see {@link DescribeAssetPropertyCommandInput} for command's `input` shape.
36
43
  * @see {@link DescribeAssetPropertyCommandOutput} for command's `response` shape.
37
44
  * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
@@ -57,11 +64,20 @@ export interface DescribeAssetPropertyCommandOutput extends DescribeAssetPropert
57
64
  export declare class DescribeAssetPropertyCommand extends $Command<DescribeAssetPropertyCommandInput, DescribeAssetPropertyCommandOutput, IoTSiteWiseClientResolvedConfig> {
58
65
  readonly input: DescribeAssetPropertyCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: DescribeAssetPropertyCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeAssetPropertyCommandInput, DescribeAssetPropertyCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
65
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
66
82
  private deserialize;
67
83
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
5
5
  import { DescribeBulkImportJobRequest, DescribeBulkImportJobResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeBulkImportJobCommand}.
8
10
  */
9
11
  export interface DescribeBulkImportJobCommandInput extends DescribeBulkImportJobRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeBulkImportJobCommand}.
13
17
  */
14
18
  export interface DescribeBulkImportJobCommandOutput extends DescribeBulkImportJobResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves information about a bulk import job request. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/DescribeBulkImportJob.html">Describe
18
23
  * a bulk import job (CLI)</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DescribeBulkImportJobCommandOutput extends DescribeBulkImportJo
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DescribeBulkImportJobCommandInput - {@link DescribeBulkImportJobCommandInput}
35
+ * @returns {@link DescribeBulkImportJobCommandOutput}
29
36
  * @see {@link DescribeBulkImportJobCommandInput} for command's `input` shape.
30
37
  * @see {@link DescribeBulkImportJobCommandOutput} for command's `response` shape.
31
38
  * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
@@ -51,11 +58,20 @@ export interface DescribeBulkImportJobCommandOutput extends DescribeBulkImportJo
51
58
  export declare class DescribeBulkImportJobCommand extends $Command<DescribeBulkImportJobCommandInput, DescribeBulkImportJobCommandOutput, IoTSiteWiseClientResolvedConfig> {
52
59
  readonly input: DescribeBulkImportJobCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: DescribeBulkImportJobCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeBulkImportJobCommandInput, DescribeBulkImportJobCommandOutput>;
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 { DescribeDashboardRequest, DescribeDashboardResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeDashboardCommand}.
8
10
  */
9
11
  export interface DescribeDashboardCommandInput extends DescribeDashboardRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeDashboardCommand}.
13
17
  */
14
18
  export interface DescribeDashboardCommandOutput extends DescribeDashboardResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves information about a 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 DescribeDashboardCommandOutput extends DescribeDashboardRespons
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeDashboardCommandInput - {@link DescribeDashboardCommandInput}
34
+ * @returns {@link DescribeDashboardCommandOutput}
28
35
  * @see {@link DescribeDashboardCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeDashboardCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
@@ -50,11 +57,20 @@ export interface DescribeDashboardCommandOutput extends DescribeDashboardRespons
50
57
  export declare class DescribeDashboardCommand extends $Command<DescribeDashboardCommandInput, DescribeDashboardCommandOutput, IoTSiteWiseClientResolvedConfig> {
51
58
  readonly input: DescribeDashboardCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: DescribeDashboardCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeDashboardCommandInput, DescribeDashboardCommandOutput>;
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 { DescribeDefaultEncryptionConfigurationRequest, DescribeDefaultEncryptionConfigurationResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeDefaultEncryptionConfigurationCommand}.
8
10
  */
9
11
  export interface DescribeDefaultEncryptionConfigurationCommandInput extends DescribeDefaultEncryptionConfigurationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeDefaultEncryptionConfigurationCommand}.
13
17
  */
14
18
  export interface DescribeDefaultEncryptionConfigurationCommandOutput extends DescribeDefaultEncryptionConfigurationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves information about the default encryption configuration for the Amazon Web Services account in
18
23
  * the default or specified Region. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html">Key management</a> in the
19
24
  * <i>IoT SiteWise User Guide</i>.</p>
@@ -27,6 +32,8 @@ export interface DescribeDefaultEncryptionConfigurationCommandOutput extends Des
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param DescribeDefaultEncryptionConfigurationCommandInput - {@link DescribeDefaultEncryptionConfigurationCommandInput}
36
+ * @returns {@link DescribeDefaultEncryptionConfigurationCommandOutput}
30
37
  * @see {@link DescribeDefaultEncryptionConfigurationCommandInput} for command's `input` shape.
31
38
  * @see {@link DescribeDefaultEncryptionConfigurationCommandOutput} for command's `response` shape.
32
39
  * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
@@ -49,11 +56,20 @@ export interface DescribeDefaultEncryptionConfigurationCommandOutput extends Des
49
56
  export declare class DescribeDefaultEncryptionConfigurationCommand extends $Command<DescribeDefaultEncryptionConfigurationCommandInput, DescribeDefaultEncryptionConfigurationCommandOutput, IoTSiteWiseClientResolvedConfig> {
50
57
  readonly input: DescribeDefaultEncryptionConfigurationCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: DescribeDefaultEncryptionConfigurationCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeDefaultEncryptionConfigurationCommandInput, DescribeDefaultEncryptionConfigurationCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
5
5
  import { DescribeGatewayCapabilityConfigurationRequest, DescribeGatewayCapabilityConfigurationResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeGatewayCapabilityConfigurationCommand}.
8
10
  */
9
11
  export interface DescribeGatewayCapabilityConfigurationCommandInput extends DescribeGatewayCapabilityConfigurationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeGatewayCapabilityConfigurationCommand}.
13
17
  */
14
18
  export interface DescribeGatewayCapabilityConfigurationCommandOutput extends DescribeGatewayCapabilityConfigurationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves information about a gateway 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 DescribeGatewayCapabilityConfigurationCommandOutput extends Des
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param DescribeGatewayCapabilityConfigurationCommandInput - {@link DescribeGatewayCapabilityConfigurationCommandInput}
38
+ * @returns {@link DescribeGatewayCapabilityConfigurationCommandOutput}
32
39
  * @see {@link DescribeGatewayCapabilityConfigurationCommandInput} for command's `input` shape.
33
40
  * @see {@link DescribeGatewayCapabilityConfigurationCommandOutput} for command's `response` shape.
34
41
  * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
@@ -54,11 +61,20 @@ export interface DescribeGatewayCapabilityConfigurationCommandOutput extends Des
54
61
  export declare class DescribeGatewayCapabilityConfigurationCommand extends $Command<DescribeGatewayCapabilityConfigurationCommandInput, DescribeGatewayCapabilityConfigurationCommandOutput, IoTSiteWiseClientResolvedConfig> {
55
62
  readonly input: DescribeGatewayCapabilityConfigurationCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: DescribeGatewayCapabilityConfigurationCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeGatewayCapabilityConfigurationCommandInput, DescribeGatewayCapabilityConfigurationCommandOutput>;
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 { DescribeGatewayRequest, DescribeGatewayResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeGatewayCommand}.
8
10
  */
9
11
  export interface DescribeGatewayCommandInput extends DescribeGatewayRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeGatewayCommand}.
13
17
  */
14
18
  export interface DescribeGatewayCommandOutput extends DescribeGatewayResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves information about a gateway.</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 DescribeGatewayCommandOutput extends DescribeGatewayResponse, _
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeGatewayCommandInput - {@link DescribeGatewayCommandInput}
34
+ * @returns {@link DescribeGatewayCommandOutput}
28
35
  * @see {@link DescribeGatewayCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeGatewayCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
@@ -50,11 +57,20 @@ export interface DescribeGatewayCommandOutput extends DescribeGatewayResponse, _
50
57
  export declare class DescribeGatewayCommand extends $Command<DescribeGatewayCommandInput, DescribeGatewayCommandOutput, IoTSiteWiseClientResolvedConfig> {
51
58
  readonly input: DescribeGatewayCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: DescribeGatewayCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeGatewayCommandInput, DescribeGatewayCommandOutput>;
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 { DescribeLoggingOptionsRequest, DescribeLoggingOptionsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeLoggingOptionsCommand}.
8
10
  */
9
11
  export interface DescribeLoggingOptionsCommandInput extends DescribeLoggingOptionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeLoggingOptionsCommand}.
13
17
  */
14
18
  export interface DescribeLoggingOptionsCommandOutput extends DescribeLoggingOptionsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the current IoT SiteWise logging options.</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 DescribeLoggingOptionsCommandOutput extends DescribeLoggingOpti
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeLoggingOptionsCommandInput - {@link DescribeLoggingOptionsCommandInput}
34
+ * @returns {@link DescribeLoggingOptionsCommandOutput}
28
35
  * @see {@link DescribeLoggingOptionsCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeLoggingOptionsCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
@@ -50,11 +57,20 @@ export interface DescribeLoggingOptionsCommandOutput extends DescribeLoggingOpti
50
57
  export declare class DescribeLoggingOptionsCommand extends $Command<DescribeLoggingOptionsCommandInput, DescribeLoggingOptionsCommandOutput, IoTSiteWiseClientResolvedConfig> {
51
58
  readonly input: DescribeLoggingOptionsCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: DescribeLoggingOptionsCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeLoggingOptionsCommandInput, DescribeLoggingOptionsCommandOutput>;
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 { DescribePortalRequest, DescribePortalResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribePortalCommand}.
8
10
  */
9
11
  export interface DescribePortalCommandInput extends DescribePortalRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribePortalCommand}.
13
17
  */
14
18
  export interface DescribePortalCommandOutput extends DescribePortalResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves information about a 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 DescribePortalCommandOutput extends DescribePortalResponse, __M
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribePortalCommandInput - {@link DescribePortalCommandInput}
34
+ * @returns {@link DescribePortalCommandOutput}
28
35
  * @see {@link DescribePortalCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribePortalCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
@@ -50,11 +57,20 @@ export interface DescribePortalCommandOutput extends DescribePortalResponse, __M
50
57
  export declare class DescribePortalCommand extends $Command<DescribePortalCommandInput, DescribePortalCommandOutput, IoTSiteWiseClientResolvedConfig> {
51
58
  readonly input: DescribePortalCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: DescribePortalCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribePortalCommandInput, DescribePortalCommandOutput>;
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 { DescribeProjectRequest, DescribeProjectResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeProjectCommand}.
8
10
  */
9
11
  export interface DescribeProjectCommandInput extends DescribeProjectRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeProjectCommand}.
13
17
  */
14
18
  export interface DescribeProjectCommandOutput extends DescribeProjectResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves information about a 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 DescribeProjectCommandOutput extends DescribeProjectResponse, _
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeProjectCommandInput - {@link DescribeProjectCommandInput}
34
+ * @returns {@link DescribeProjectCommandOutput}
28
35
  * @see {@link DescribeProjectCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeProjectCommandOutput} for command's `response` shape.
30
37
  * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
@@ -50,11 +57,20 @@ export interface DescribeProjectCommandOutput extends DescribeProjectResponse, _
50
57
  export declare class DescribeProjectCommand extends $Command<DescribeProjectCommandInput, DescribeProjectCommandOutput, IoTSiteWiseClientResolvedConfig> {
51
58
  readonly input: DescribeProjectCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: DescribeProjectCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeProjectCommandInput, DescribeProjectCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }