@aws-sdk/client-pi 3.325.0 → 3.326.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 (7) hide show
  1. package/dist-types/commands/DescribeDimensionKeysCommand.d.ts +29 -0
  2. package/dist-types/commands/GetDimensionKeyDetailsCommand.d.ts +12 -0
  3. package/dist-types/commands/GetResourceMetadataCommand.d.ts +11 -0
  4. package/dist-types/commands/GetResourceMetricsCommand.d.ts +25 -0
  5. package/dist-types/commands/ListAvailableResourceDimensionsCommand.d.ts +21 -0
  6. package/dist-types/commands/ListAvailableResourceMetricsCommand.d.ts +13 -0
  7. package/package.json +3 -3
package/dist-types/commands/DescribeDimensionKeysCommand.d.ts CHANGED
@@ -63,6 +63,33 @@ export interface DescribeDimensionKeysCommandOutput extends DescribeDimensionKey
63
63
  * };
64
64
  * const command = new DescribeDimensionKeysCommand(input);
65
65
  * const response = await client.send(command);
66
+ * // { // DescribeDimensionKeysResponse
67
+ * // AlignedStartTime: new Date("TIMESTAMP"),
68
+ * // AlignedEndTime: new Date("TIMESTAMP"),
69
+ * // PartitionKeys: [ // ResponsePartitionKeyList
70
+ * // { // ResponsePartitionKey
71
+ * // Dimensions: { // DimensionMap // required
72
+ * // "<keys>": "STRING_VALUE",
73
+ * // },
74
+ * // },
75
+ * // ],
76
+ * // Keys: [ // DimensionKeyDescriptionList
77
+ * // { // DimensionKeyDescription
78
+ * // Dimensions: {
79
+ * // "<keys>": "STRING_VALUE",
80
+ * // },
81
+ * // Total: Number("double"),
82
+ * // AdditionalMetrics: { // AdditionalMetricsMap
83
+ * // "<keys>": Number("double"),
84
+ * // },
85
+ * // Partitions: [ // MetricValuesList
86
+ * // Number("double"),
87
+ * // ],
88
+ * // },
89
+ * // ],
90
+ * // NextToken: "STRING_VALUE",
91
+ * // };
92
+ *
66
93
  * ```
67
94
  *
68
95
  * @param DescribeDimensionKeysCommandInput - {@link DescribeDimensionKeysCommandInput}
@@ -80,6 +107,8 @@ export interface DescribeDimensionKeysCommandOutput extends DescribeDimensionKey
80
107
  * @throws {@link NotAuthorizedException} (client fault)
81
108
  * <p>The user is not authorized to perform this request.</p>
82
109
  *
110
+ * @throws {@link PIServiceException}
111
+ * <p>Base exception class for all service exceptions from PI service.</p>
83
112
  *
84
113
  */
85
114
  export declare class DescribeDimensionKeysCommand extends $Command<DescribeDimensionKeysCommandInput, DescribeDimensionKeysCommandOutput, PIClientResolvedConfig> {
package/dist-types/commands/GetDimensionKeyDetailsCommand.d.ts CHANGED
@@ -40,6 +40,16 @@ export interface GetDimensionKeyDetailsCommandOutput extends GetDimensionKeyDeta
40
40
  * };
41
41
  * const command = new GetDimensionKeyDetailsCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // GetDimensionKeyDetailsResponse
44
+ * // Dimensions: [ // DimensionKeyDetailList
45
+ * // { // DimensionKeyDetail
46
+ * // Value: "STRING_VALUE",
47
+ * // Dimension: "STRING_VALUE",
48
+ * // Status: "AVAILABLE" || "PROCESSING" || "UNAVAILABLE",
49
+ * // },
50
+ * // ],
51
+ * // };
52
+ *
43
53
  * ```
44
54
  *
45
55
  * @param GetDimensionKeyDetailsCommandInput - {@link GetDimensionKeyDetailsCommandInput}
@@ -57,6 +67,8 @@ export interface GetDimensionKeyDetailsCommandOutput extends GetDimensionKeyDeta
57
67
  * @throws {@link NotAuthorizedException} (client fault)
58
68
  * <p>The user is not authorized to perform this request.</p>
59
69
  *
70
+ * @throws {@link PIServiceException}
71
+ * <p>Base exception class for all service exceptions from PI service.</p>
60
72
  *
61
73
  */
62
74
  export declare class GetDimensionKeyDetailsCommand extends $Command<GetDimensionKeyDetailsCommandInput, GetDimensionKeyDetailsCommandOutput, PIClientResolvedConfig> {
package/dist-types/commands/GetResourceMetadataCommand.d.ts CHANGED
@@ -34,6 +34,15 @@ export interface GetResourceMetadataCommandOutput extends GetResourceMetadataRes
34
34
  * };
35
35
  * const command = new GetResourceMetadataCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // GetResourceMetadataResponse
38
+ * // Identifier: "STRING_VALUE",
39
+ * // Features: { // FeatureMetadataMap
40
+ * // "<keys>": { // FeatureMetadata
41
+ * // Status: "ENABLED" || "DISABLED" || "UNSUPPORTED" || "ENABLED_PENDING_REBOOT" || "DISABLED_PENDING_REBOOT" || "UNKNOWN",
42
+ * // },
43
+ * // },
44
+ * // };
45
+ *
37
46
  * ```
38
47
  *
39
48
  * @param GetResourceMetadataCommandInput - {@link GetResourceMetadataCommandInput}
@@ -51,6 +60,8 @@ export interface GetResourceMetadataCommandOutput extends GetResourceMetadataRes
51
60
  * @throws {@link NotAuthorizedException} (client fault)
52
61
  * <p>The user is not authorized to perform this request.</p>
53
62
  *
63
+ * @throws {@link PIServiceException}
64
+ * <p>Base exception class for all service exceptions from PI service.</p>
54
65
  *
55
66
  */
56
67
  export declare class GetResourceMetadataCommand extends $Command<GetResourceMetadataCommandInput, GetResourceMetadataCommandOutput, PIClientResolvedConfig> {
package/dist-types/commands/GetResourceMetricsCommand.d.ts CHANGED
@@ -59,6 +59,29 @@ export interface GetResourceMetricsCommandOutput extends GetResourceMetricsRespo
59
59
  * };
60
60
  * const command = new GetResourceMetricsCommand(input);
61
61
  * const response = await client.send(command);
62
+ * // { // GetResourceMetricsResponse
63
+ * // AlignedStartTime: new Date("TIMESTAMP"),
64
+ * // AlignedEndTime: new Date("TIMESTAMP"),
65
+ * // Identifier: "STRING_VALUE",
66
+ * // MetricList: [ // MetricKeyDataPointsList
67
+ * // { // MetricKeyDataPoints
68
+ * // Key: { // ResponseResourceMetricKey
69
+ * // Metric: "STRING_VALUE", // required
70
+ * // Dimensions: { // DimensionMap
71
+ * // "<keys>": "STRING_VALUE",
72
+ * // },
73
+ * // },
74
+ * // DataPoints: [ // DataPointsList
75
+ * // { // DataPoint
76
+ * // Timestamp: new Date("TIMESTAMP"), // required
77
+ * // Value: Number("double"), // required
78
+ * // },
79
+ * // ],
80
+ * // },
81
+ * // ],
82
+ * // NextToken: "STRING_VALUE",
83
+ * // };
84
+ *
62
85
  * ```
63
86
  *
64
87
  * @param GetResourceMetricsCommandInput - {@link GetResourceMetricsCommandInput}
@@ -76,6 +99,8 @@ export interface GetResourceMetricsCommandOutput extends GetResourceMetricsRespo
76
99
  * @throws {@link NotAuthorizedException} (client fault)
77
100
  * <p>The user is not authorized to perform this request.</p>
78
101
  *
102
+ * @throws {@link PIServiceException}
103
+ * <p>Base exception class for all service exceptions from PI service.</p>
79
104
  *
80
105
  */
81
106
  export declare class GetResourceMetricsCommand extends $Command<GetResourceMetricsCommandInput, GetResourceMetricsCommandOutput, PIClientResolvedConfig> {
package/dist-types/commands/ListAvailableResourceDimensionsCommand.d.ts CHANGED
@@ -37,6 +37,25 @@ export interface ListAvailableResourceDimensionsCommandOutput extends ListAvaila
37
37
  * };
38
38
  * const command = new ListAvailableResourceDimensionsCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // { // ListAvailableResourceDimensionsResponse
41
+ * // MetricDimensions: [ // MetricDimensionsList
42
+ * // { // MetricDimensionGroups
43
+ * // Metric: "STRING_VALUE",
44
+ * // Groups: [ // DimensionGroupDetailList
45
+ * // { // DimensionGroupDetail
46
+ * // Group: "STRING_VALUE",
47
+ * // Dimensions: [ // DimensionDetailList
48
+ * // { // DimensionDetail
49
+ * // Identifier: "STRING_VALUE",
50
+ * // },
51
+ * // ],
52
+ * // },
53
+ * // ],
54
+ * // },
55
+ * // ],
56
+ * // NextToken: "STRING_VALUE",
57
+ * // };
58
+ *
40
59
  * ```
41
60
  *
42
61
  * @param ListAvailableResourceDimensionsCommandInput - {@link ListAvailableResourceDimensionsCommandInput}
@@ -54,6 +73,8 @@ export interface ListAvailableResourceDimensionsCommandOutput extends ListAvaila
54
73
  * @throws {@link NotAuthorizedException} (client fault)
55
74
  * <p>The user is not authorized to perform this request.</p>
56
75
  *
76
+ * @throws {@link PIServiceException}
77
+ * <p>Base exception class for all service exceptions from PI service.</p>
57
78
  *
58
79
  */
59
80
  export declare class ListAvailableResourceDimensionsCommand extends $Command<ListAvailableResourceDimensionsCommandInput, ListAvailableResourceDimensionsCommandOutput, PIClientResolvedConfig> {
package/dist-types/commands/ListAvailableResourceMetricsCommand.d.ts CHANGED
@@ -38,6 +38,17 @@ export interface ListAvailableResourceMetricsCommandOutput extends ListAvailable
38
38
  * };
39
39
  * const command = new ListAvailableResourceMetricsCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // ListAvailableResourceMetricsResponse
42
+ * // Metrics: [ // ResponseResourceMetricList
43
+ * // { // ResponseResourceMetric
44
+ * // Metric: "STRING_VALUE",
45
+ * // Description: "STRING_VALUE",
46
+ * // Unit: "STRING_VALUE",
47
+ * // },
48
+ * // ],
49
+ * // NextToken: "STRING_VALUE",
50
+ * // };
51
+ *
41
52
  * ```
42
53
  *
43
54
  * @param ListAvailableResourceMetricsCommandInput - {@link ListAvailableResourceMetricsCommandInput}
@@ -55,6 +66,8 @@ export interface ListAvailableResourceMetricsCommandOutput extends ListAvailable
55
66
  * @throws {@link NotAuthorizedException} (client fault)
56
67
  * <p>The user is not authorized to perform this request.</p>
57
68
  *
69
+ * @throws {@link PIServiceException}
70
+ * <p>Base exception class for all service exceptions from PI service.</p>
58
71
  *
59
72
  */
60
73
  export declare class ListAvailableResourceMetricsCommand extends $Command<ListAvailableResourceMetricsCommandInput, ListAvailableResourceMetricsCommandOutput, PIClientResolvedConfig> {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-pi",
3
3
  "description": "AWS SDK for JavaScript Pi Client for Node.js, Browser and React Native",
4
- "version": "3.325.0",
4
+ "version": "3.326.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.325.0",
24
+ "@aws-sdk/client-sts": "3.326.0",
25
25
  "@aws-sdk/config-resolver": "3.310.0",
26
- "@aws-sdk/credential-provider-node": "3.325.0",
26
+ "@aws-sdk/credential-provider-node": "3.326.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.310.0",
28
28
  "@aws-sdk/hash-node": "3.310.0",
29
29
  "@aws-sdk/invalid-dependency": "3.310.0",