@aws-sdk/client-bcm-dashboards 3.870.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.
- package/LICENSE +201 -0
- package/README.md +277 -0
- package/dist-cjs/BCMDashboards.js +29 -0
- package/dist-cjs/BCMDashboardsClient.js +52 -0
- package/dist-cjs/auth/httpAuthExtensionConfiguration.js +43 -0
- package/dist-cjs/auth/httpAuthSchemeProvider.js +47 -0
- package/dist-cjs/commands/CreateDashboardCommand.js +26 -0
- package/dist-cjs/commands/DeleteDashboardCommand.js +26 -0
- package/dist-cjs/commands/GetDashboardCommand.js +26 -0
- package/dist-cjs/commands/GetResourcePolicyCommand.js +26 -0
- package/dist-cjs/commands/ListDashboardsCommand.js +26 -0
- package/dist-cjs/commands/ListTagsForResourceCommand.js +26 -0
- package/dist-cjs/commands/TagResourceCommand.js +26 -0
- package/dist-cjs/commands/UntagResourceCommand.js +26 -0
- package/dist-cjs/commands/UpdateDashboardCommand.js +26 -0
- package/dist-cjs/commands/index.js +12 -0
- package/dist-cjs/endpoint/EndpointParameters.js +15 -0
- package/dist-cjs/endpoint/endpointResolver.js +18 -0
- package/dist-cjs/endpoint/ruleset.js +7 -0
- package/dist-cjs/extensionConfiguration.js +2 -0
- package/dist-cjs/index.js +11 -0
- package/dist-cjs/models/BCMDashboardsServiceException.js +12 -0
- package/dist-cjs/models/index.js +4 -0
- package/dist-cjs/models/models_0.js +181 -0
- package/dist-cjs/pagination/Interfaces.js +2 -0
- package/dist-cjs/pagination/ListDashboardsPaginator.js +7 -0
- package/dist-cjs/pagination/index.js +5 -0
- package/dist-cjs/protocols/Aws_json1_0.js +587 -0
- package/dist-cjs/runtimeConfig.browser.js +39 -0
- package/dist-cjs/runtimeConfig.js +56 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +34 -0
- package/dist-cjs/runtimeExtensions.js +13 -0
- package/dist-es/BCMDashboards.js +25 -0
- package/dist-es/BCMDashboardsClient.js +48 -0
- package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
- package/dist-es/auth/httpAuthSchemeProvider.js +41 -0
- package/dist-es/commands/CreateDashboardCommand.js +22 -0
- package/dist-es/commands/DeleteDashboardCommand.js +22 -0
- package/dist-es/commands/GetDashboardCommand.js +22 -0
- package/dist-es/commands/GetResourcePolicyCommand.js +22 -0
- package/dist-es/commands/ListDashboardsCommand.js +22 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +22 -0
- package/dist-es/commands/TagResourceCommand.js +22 -0
- package/dist-es/commands/UntagResourceCommand.js +22 -0
- package/dist-es/commands/UpdateDashboardCommand.js +22 -0
- package/dist-es/commands/index.js +9 -0
- package/dist-es/endpoint/EndpointParameters.js +11 -0
- package/dist-es/endpoint/endpointResolver.js +14 -0
- package/dist-es/endpoint/ruleset.js +4 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +6 -0
- package/dist-es/models/BCMDashboardsServiceException.js +8 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +172 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListDashboardsPaginator.js +4 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_json1_0.js +566 -0
- package/dist-es/runtimeConfig.browser.js +34 -0
- package/dist-es/runtimeConfig.js +51 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +30 -0
- package/dist-es/runtimeExtensions.js +9 -0
- package/dist-types/BCMDashboards.d.ts +74 -0
- package/dist-types/BCMDashboardsClient.d.ts +196 -0
- package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
- package/dist-types/auth/httpAuthSchemeProvider.d.ts +75 -0
- package/dist-types/commands/CreateDashboardCommand.d.ts +328 -0
- package/dist-types/commands/DeleteDashboardCommand.d.ts +99 -0
- package/dist-types/commands/GetDashboardCommand.d.ts +332 -0
- package/dist-types/commands/GetResourcePolicyCommand.d.ts +104 -0
- package/dist-types/commands/ListDashboardsCommand.d.ts +117 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +113 -0
- package/dist-types/commands/TagResourceCommand.d.ts +107 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +101 -0
- package/dist-types/commands/UpdateDashboardCommand.d.ts +324 -0
- package/dist-types/commands/index.d.ts +9 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +32 -0
- package/dist-types/endpoint/endpointResolver.d.ts +5 -0
- package/dist-types/endpoint/ruleset.d.ts +2 -0
- package/dist-types/extensionConfiguration.d.ts +9 -0
- package/dist-types/index.d.ts +14 -0
- package/dist-types/models/BCMDashboardsServiceException.d.ts +14 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +1006 -0
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListDashboardsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_json1_0.d.ts +83 -0
- package/dist-types/runtimeConfig.browser.d.ts +50 -0
- package/dist-types/runtimeConfig.d.ts +50 -0
- package/dist-types/runtimeConfig.native.d.ts +49 -0
- package/dist-types/runtimeConfig.shared.d.ts +21 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/ts3.4/BCMDashboards.d.ts +161 -0
- package/dist-types/ts3.4/BCMDashboardsClient.d.ts +174 -0
- package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
- package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +47 -0
- package/dist-types/ts3.4/commands/CreateDashboardCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/DeleteDashboardCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/GetDashboardCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetResourcePolicyCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListDashboardsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/UpdateDashboardCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/index.d.ts +9 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +45 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
- package/dist-types/ts3.4/extensionConfiguration.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +9 -0
- package/dist-types/ts3.4/models/BCMDashboardsServiceException.d.ts +9 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +381 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
- package/dist-types/ts3.4/pagination/ListDashboardsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +113 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +91 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +89 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +95 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +21 -0
- package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
- package/package.json +99 -0
|
@@ -0,0 +1,332 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BCMDashboardsClient";
|
|
4
|
+
import { GetDashboardRequest, GetDashboardResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetDashboardCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetDashboardCommandInput extends GetDashboardRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetDashboardCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetDashboardCommandOutput extends GetDashboardResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetDashboardCommand_base: {
|
|
25
|
+
new (input: GetDashboardCommandInput): import("@smithy/smithy-client").CommandImpl<GetDashboardCommandInput, GetDashboardCommandOutput, BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetDashboardCommandInput): import("@smithy/smithy-client").CommandImpl<GetDashboardCommandInput, GetDashboardCommandOutput, BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves the configuration and metadata of a specified dashboard, including its widgets and layout settings.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BCMDashboardsClient, GetDashboardCommand } from "@aws-sdk/client-bcm-dashboards"; // ES Modules import
|
|
35
|
+
* // const { BCMDashboardsClient, GetDashboardCommand } = require("@aws-sdk/client-bcm-dashboards"); // CommonJS import
|
|
36
|
+
* const client = new BCMDashboardsClient(config);
|
|
37
|
+
* const input = { // GetDashboardRequest
|
|
38
|
+
* arn: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new GetDashboardCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // GetDashboardResponse
|
|
43
|
+
* // arn: "STRING_VALUE", // required
|
|
44
|
+
* // name: "STRING_VALUE", // required
|
|
45
|
+
* // description: "STRING_VALUE",
|
|
46
|
+
* // type: "CUSTOM", // required
|
|
47
|
+
* // widgets: [ // WidgetList // required
|
|
48
|
+
* // { // Widget
|
|
49
|
+
* // title: "STRING_VALUE", // required
|
|
50
|
+
* // description: "STRING_VALUE",
|
|
51
|
+
* // width: Number("int"),
|
|
52
|
+
* // height: Number("int"),
|
|
53
|
+
* // horizontalOffset: Number("int"),
|
|
54
|
+
* // configs: [ // WidgetConfigList // required
|
|
55
|
+
* // { // WidgetConfig
|
|
56
|
+
* // queryParameters: { // QueryParameters Union: only one key present
|
|
57
|
+
* // costAndUsage: { // CostAndUsageQuery
|
|
58
|
+
* // metrics: [ // MetricNames // required
|
|
59
|
+
* // "AmortizedCost" || "BlendedCost" || "NetAmortizedCost" || "NetUnblendedCost" || "NormalizedUsageAmount" || "UnblendedCost" || "UsageQuantity" || "SpendCoveredBySavingsPlans" || "Hour" || "Unit" || "Cost",
|
|
60
|
+
* // ],
|
|
61
|
+
* // timeRange: { // DateTimeRange
|
|
62
|
+
* // startTime: { // DateTimeValue
|
|
63
|
+
* // type: "ABSOLUTE" || "RELATIVE", // required
|
|
64
|
+
* // value: "STRING_VALUE", // required
|
|
65
|
+
* // },
|
|
66
|
+
* // endTime: {
|
|
67
|
+
* // type: "ABSOLUTE" || "RELATIVE", // required
|
|
68
|
+
* // value: "STRING_VALUE", // required
|
|
69
|
+
* // },
|
|
70
|
+
* // },
|
|
71
|
+
* // granularity: "HOURLY" || "DAILY" || "MONTHLY", // required
|
|
72
|
+
* // groupBy: [ // GroupDefinitions
|
|
73
|
+
* // { // GroupDefinition
|
|
74
|
+
* // key: "STRING_VALUE", // required
|
|
75
|
+
* // type: "DIMENSION" || "TAG" || "COST_CATEGORY",
|
|
76
|
+
* // },
|
|
77
|
+
* // ],
|
|
78
|
+
* // filter: { // Expression
|
|
79
|
+
* // or: [ // Expressions
|
|
80
|
+
* // {
|
|
81
|
+
* // or: [
|
|
82
|
+
* // "<Expression>",
|
|
83
|
+
* // ],
|
|
84
|
+
* // and: [
|
|
85
|
+
* // "<Expression>",
|
|
86
|
+
* // ],
|
|
87
|
+
* // not: "<Expression>",
|
|
88
|
+
* // dimensions: { // DimensionValues
|
|
89
|
+
* // key: "AZ" || "INSTANCE_TYPE" || "LINKED_ACCOUNT" || "OPERATION" || "PURCHASE_TYPE" || "REGION" || "SERVICE" || "USAGE_TYPE" || "USAGE_TYPE_GROUP" || "RECORD_TYPE" || "RESOURCE_ID" || "SUBSCRIPTION_ID" || "TAG_KEY" || "OPERATING_SYSTEM" || "TENANCY" || "BILLING_ENTITY" || "RESERVATION_ID" || "COST_CATEGORY_NAME" || "DATABASE_ENGINE" || "LEGAL_ENTITY_NAME" || "SAVINGS_PLANS_TYPE" || "INSTANCE_TYPE_FAMILY" || "CACHE_ENGINE" || "DEPLOYMENT_OPTION" || "SCOPE" || "PLATFORM", // required
|
|
90
|
+
* // values: [ // StringList // required
|
|
91
|
+
* // "STRING_VALUE",
|
|
92
|
+
* // ],
|
|
93
|
+
* // matchOptions: [ // MatchOptions
|
|
94
|
+
* // "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "GREATER_THAN_OR_EQUAL" || "CASE_SENSITIVE" || "CASE_INSENSITIVE",
|
|
95
|
+
* // ],
|
|
96
|
+
* // },
|
|
97
|
+
* // tags: { // TagValues
|
|
98
|
+
* // key: "STRING_VALUE",
|
|
99
|
+
* // values: [
|
|
100
|
+
* // "STRING_VALUE",
|
|
101
|
+
* // ],
|
|
102
|
+
* // matchOptions: [
|
|
103
|
+
* // "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "GREATER_THAN_OR_EQUAL" || "CASE_SENSITIVE" || "CASE_INSENSITIVE",
|
|
104
|
+
* // ],
|
|
105
|
+
* // },
|
|
106
|
+
* // costCategories: { // CostCategoryValues
|
|
107
|
+
* // key: "STRING_VALUE",
|
|
108
|
+
* // values: [
|
|
109
|
+
* // "STRING_VALUE",
|
|
110
|
+
* // ],
|
|
111
|
+
* // matchOptions: [
|
|
112
|
+
* // "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "GREATER_THAN_OR_EQUAL" || "CASE_SENSITIVE" || "CASE_INSENSITIVE",
|
|
113
|
+
* // ],
|
|
114
|
+
* // },
|
|
115
|
+
* // },
|
|
116
|
+
* // ],
|
|
117
|
+
* // and: [
|
|
118
|
+
* // "<Expression>",
|
|
119
|
+
* // ],
|
|
120
|
+
* // not: "<Expression>",
|
|
121
|
+
* // dimensions: {
|
|
122
|
+
* // key: "AZ" || "INSTANCE_TYPE" || "LINKED_ACCOUNT" || "OPERATION" || "PURCHASE_TYPE" || "REGION" || "SERVICE" || "USAGE_TYPE" || "USAGE_TYPE_GROUP" || "RECORD_TYPE" || "RESOURCE_ID" || "SUBSCRIPTION_ID" || "TAG_KEY" || "OPERATING_SYSTEM" || "TENANCY" || "BILLING_ENTITY" || "RESERVATION_ID" || "COST_CATEGORY_NAME" || "DATABASE_ENGINE" || "LEGAL_ENTITY_NAME" || "SAVINGS_PLANS_TYPE" || "INSTANCE_TYPE_FAMILY" || "CACHE_ENGINE" || "DEPLOYMENT_OPTION" || "SCOPE" || "PLATFORM", // required
|
|
123
|
+
* // values: [ // required
|
|
124
|
+
* // "STRING_VALUE",
|
|
125
|
+
* // ],
|
|
126
|
+
* // matchOptions: [
|
|
127
|
+
* // "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "GREATER_THAN_OR_EQUAL" || "CASE_SENSITIVE" || "CASE_INSENSITIVE",
|
|
128
|
+
* // ],
|
|
129
|
+
* // },
|
|
130
|
+
* // tags: {
|
|
131
|
+
* // key: "STRING_VALUE",
|
|
132
|
+
* // values: [
|
|
133
|
+
* // "STRING_VALUE",
|
|
134
|
+
* // ],
|
|
135
|
+
* // matchOptions: [
|
|
136
|
+
* // "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "GREATER_THAN_OR_EQUAL" || "CASE_SENSITIVE" || "CASE_INSENSITIVE",
|
|
137
|
+
* // ],
|
|
138
|
+
* // },
|
|
139
|
+
* // costCategories: {
|
|
140
|
+
* // key: "STRING_VALUE",
|
|
141
|
+
* // values: "<StringList>",
|
|
142
|
+
* // matchOptions: "<MatchOptions>",
|
|
143
|
+
* // },
|
|
144
|
+
* // },
|
|
145
|
+
* // },
|
|
146
|
+
* // savingsPlansCoverage: { // SavingsPlansCoverageQuery
|
|
147
|
+
* // timeRange: {
|
|
148
|
+
* // startTime: {
|
|
149
|
+
* // type: "ABSOLUTE" || "RELATIVE", // required
|
|
150
|
+
* // value: "STRING_VALUE", // required
|
|
151
|
+
* // },
|
|
152
|
+
* // endTime: {
|
|
153
|
+
* // type: "ABSOLUTE" || "RELATIVE", // required
|
|
154
|
+
* // value: "STRING_VALUE", // required
|
|
155
|
+
* // },
|
|
156
|
+
* // },
|
|
157
|
+
* // metrics: [
|
|
158
|
+
* // "AmortizedCost" || "BlendedCost" || "NetAmortizedCost" || "NetUnblendedCost" || "NormalizedUsageAmount" || "UnblendedCost" || "UsageQuantity" || "SpendCoveredBySavingsPlans" || "Hour" || "Unit" || "Cost",
|
|
159
|
+
* // ],
|
|
160
|
+
* // granularity: "HOURLY" || "DAILY" || "MONTHLY",
|
|
161
|
+
* // groupBy: [
|
|
162
|
+
* // {
|
|
163
|
+
* // key: "STRING_VALUE", // required
|
|
164
|
+
* // type: "DIMENSION" || "TAG" || "COST_CATEGORY",
|
|
165
|
+
* // },
|
|
166
|
+
* // ],
|
|
167
|
+
* // filter: "<Expression>",
|
|
168
|
+
* // },
|
|
169
|
+
* // savingsPlansUtilization: { // SavingsPlansUtilizationQuery
|
|
170
|
+
* // timeRange: {
|
|
171
|
+
* // startTime: {
|
|
172
|
+
* // type: "ABSOLUTE" || "RELATIVE", // required
|
|
173
|
+
* // value: "STRING_VALUE", // required
|
|
174
|
+
* // },
|
|
175
|
+
* // endTime: "<DateTimeValue>", // required
|
|
176
|
+
* // },
|
|
177
|
+
* // granularity: "HOURLY" || "DAILY" || "MONTHLY",
|
|
178
|
+
* // filter: "<Expression>",
|
|
179
|
+
* // },
|
|
180
|
+
* // reservationCoverage: { // ReservationCoverageQuery
|
|
181
|
+
* // timeRange: {
|
|
182
|
+
* // startTime: "<DateTimeValue>", // required
|
|
183
|
+
* // endTime: "<DateTimeValue>", // required
|
|
184
|
+
* // },
|
|
185
|
+
* // groupBy: [
|
|
186
|
+
* // {
|
|
187
|
+
* // key: "STRING_VALUE", // required
|
|
188
|
+
* // type: "DIMENSION" || "TAG" || "COST_CATEGORY",
|
|
189
|
+
* // },
|
|
190
|
+
* // ],
|
|
191
|
+
* // granularity: "HOURLY" || "DAILY" || "MONTHLY",
|
|
192
|
+
* // filter: "<Expression>",
|
|
193
|
+
* // metrics: [
|
|
194
|
+
* // "AmortizedCost" || "BlendedCost" || "NetAmortizedCost" || "NetUnblendedCost" || "NormalizedUsageAmount" || "UnblendedCost" || "UsageQuantity" || "SpendCoveredBySavingsPlans" || "Hour" || "Unit" || "Cost",
|
|
195
|
+
* // ],
|
|
196
|
+
* // },
|
|
197
|
+
* // reservationUtilization: { // ReservationUtilizationQuery
|
|
198
|
+
* // timeRange: {
|
|
199
|
+
* // startTime: "<DateTimeValue>", // required
|
|
200
|
+
* // endTime: "<DateTimeValue>", // required
|
|
201
|
+
* // },
|
|
202
|
+
* // groupBy: [
|
|
203
|
+
* // {
|
|
204
|
+
* // key: "STRING_VALUE", // required
|
|
205
|
+
* // type: "DIMENSION" || "TAG" || "COST_CATEGORY",
|
|
206
|
+
* // },
|
|
207
|
+
* // ],
|
|
208
|
+
* // granularity: "HOURLY" || "DAILY" || "MONTHLY",
|
|
209
|
+
* // filter: "<Expression>",
|
|
210
|
+
* // },
|
|
211
|
+
* // },
|
|
212
|
+
* // displayConfig: { // DisplayConfig Union: only one key present
|
|
213
|
+
* // graph: { // GraphDisplayConfigMap
|
|
214
|
+
* // "<keys>": { // GraphDisplayConfig
|
|
215
|
+
* // visualType: "LINE" || "BAR" || "STACK", // required
|
|
216
|
+
* // },
|
|
217
|
+
* // },
|
|
218
|
+
* // table: {},
|
|
219
|
+
* // },
|
|
220
|
+
* // },
|
|
221
|
+
* // ],
|
|
222
|
+
* // },
|
|
223
|
+
* // ],
|
|
224
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
225
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
226
|
+
* // };
|
|
227
|
+
*
|
|
228
|
+
* ```
|
|
229
|
+
*
|
|
230
|
+
* @param GetDashboardCommandInput - {@link GetDashboardCommandInput}
|
|
231
|
+
* @returns {@link GetDashboardCommandOutput}
|
|
232
|
+
* @see {@link GetDashboardCommandInput} for command's `input` shape.
|
|
233
|
+
* @see {@link GetDashboardCommandOutput} for command's `response` shape.
|
|
234
|
+
* @see {@link BCMDashboardsClientResolvedConfig | config} for BCMDashboardsClient's `config` shape.
|
|
235
|
+
*
|
|
236
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
237
|
+
* <p>You do not have sufficient permissions to perform this action. Verify your IAM permissions and any resource policies.</p>
|
|
238
|
+
*
|
|
239
|
+
* @throws {@link InternalServerException} (server fault)
|
|
240
|
+
* <p>An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.</p>
|
|
241
|
+
*
|
|
242
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
243
|
+
* <p>The specified resource (dashboard, policy, or widget) was not found. Verify the ARN and try again.</p>
|
|
244
|
+
*
|
|
245
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
246
|
+
* <p>The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.</p>
|
|
247
|
+
*
|
|
248
|
+
* @throws {@link ValidationException} (client fault)
|
|
249
|
+
* <p>The input parameters do not satisfy the requirements. Check the error message for specific validation details.</p>
|
|
250
|
+
*
|
|
251
|
+
* @throws {@link BCMDashboardsServiceException}
|
|
252
|
+
* <p>Base exception class for all service exceptions from BCMDashboards service.</p>
|
|
253
|
+
*
|
|
254
|
+
*
|
|
255
|
+
* @example Getting information about a dashboard
|
|
256
|
+
* ```javascript
|
|
257
|
+
* //
|
|
258
|
+
* const input = {
|
|
259
|
+
* arn: "arn:aws:bcm-dashboards::123456789012:dashboard/abcd1234-ab12-12ab-1ab2-abcd1234efgh"
|
|
260
|
+
* };
|
|
261
|
+
* const command = new GetDashboardCommand(input);
|
|
262
|
+
* const response = await client.send(command);
|
|
263
|
+
* /* response is
|
|
264
|
+
* {
|
|
265
|
+
* arn: "arn:aws:bcm-dashboards::123456789012:dashboard/abcd1234-ab12-12ab-1ab2-abcd1234efgh",
|
|
266
|
+
* createdAt: 1.753741462721E9,
|
|
267
|
+
* description: "Dashboard for tracking costs",
|
|
268
|
+
* name: "cost-dashboards",
|
|
269
|
+
* type: "CUSTOM",
|
|
270
|
+
* updatedAt: 1.753741462721E9,
|
|
271
|
+
* widgets: [
|
|
272
|
+
* {
|
|
273
|
+
* configs: [
|
|
274
|
+
* {
|
|
275
|
+
* displayConfig: {
|
|
276
|
+
* graph: {
|
|
277
|
+
* costTrend: {
|
|
278
|
+
* visualType: "LINE"
|
|
279
|
+
* }
|
|
280
|
+
* }
|
|
281
|
+
* },
|
|
282
|
+
* queryParameters: {
|
|
283
|
+
* costAndUsage: {
|
|
284
|
+
* granularity: "MONTHLY",
|
|
285
|
+
* groupBy: [
|
|
286
|
+
* {
|
|
287
|
+
* key: "SERVICE",
|
|
288
|
+
* type: "DIMENSION"
|
|
289
|
+
* }
|
|
290
|
+
* ],
|
|
291
|
+
* metrics: [
|
|
292
|
+
* "UnblendedCost"
|
|
293
|
+
* ],
|
|
294
|
+
* timeRange: {
|
|
295
|
+
* endTime: {
|
|
296
|
+
* type: "RELATIVE",
|
|
297
|
+
* value: "now"
|
|
298
|
+
* },
|
|
299
|
+
* startTime: {
|
|
300
|
+
* type: "RELATIVE",
|
|
301
|
+
* value: "-6M"
|
|
302
|
+
* }
|
|
303
|
+
* }
|
|
304
|
+
* }
|
|
305
|
+
* }
|
|
306
|
+
* }
|
|
307
|
+
* ],
|
|
308
|
+
* height: 7,
|
|
309
|
+
* horizontalOffset: 0,
|
|
310
|
+
* title: "Monthly Cost Trend",
|
|
311
|
+
* width: 4
|
|
312
|
+
* }
|
|
313
|
+
* ]
|
|
314
|
+
* }
|
|
315
|
+
* *\/
|
|
316
|
+
* ```
|
|
317
|
+
*
|
|
318
|
+
* @public
|
|
319
|
+
*/
|
|
320
|
+
export declare class GetDashboardCommand extends GetDashboardCommand_base {
|
|
321
|
+
/** @internal type navigation helper, not in runtime. */
|
|
322
|
+
protected static __types: {
|
|
323
|
+
api: {
|
|
324
|
+
input: GetDashboardRequest;
|
|
325
|
+
output: GetDashboardResponse;
|
|
326
|
+
};
|
|
327
|
+
sdk: {
|
|
328
|
+
input: GetDashboardCommandInput;
|
|
329
|
+
output: GetDashboardCommandOutput;
|
|
330
|
+
};
|
|
331
|
+
};
|
|
332
|
+
}
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BCMDashboardsClient";
|
|
4
|
+
import { GetResourcePolicyRequest, GetResourcePolicyResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetResourcePolicyCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetResourcePolicyCommandInput extends GetResourcePolicyRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetResourcePolicyCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetResourcePolicyCommandOutput extends GetResourcePolicyResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetResourcePolicyCommand_base: {
|
|
25
|
+
new (input: GetResourcePolicyCommandInput): import("@smithy/smithy-client").CommandImpl<GetResourcePolicyCommandInput, GetResourcePolicyCommandOutput, BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetResourcePolicyCommandInput): import("@smithy/smithy-client").CommandImpl<GetResourcePolicyCommandInput, GetResourcePolicyCommandOutput, BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves the resource-based policy attached to a dashboard, showing sharing configurations and permissions.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BCMDashboardsClient, GetResourcePolicyCommand } from "@aws-sdk/client-bcm-dashboards"; // ES Modules import
|
|
35
|
+
* // const { BCMDashboardsClient, GetResourcePolicyCommand } = require("@aws-sdk/client-bcm-dashboards"); // CommonJS import
|
|
36
|
+
* const client = new BCMDashboardsClient(config);
|
|
37
|
+
* const input = { // GetResourcePolicyRequest
|
|
38
|
+
* resourceArn: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new GetResourcePolicyCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // GetResourcePolicyResponse
|
|
43
|
+
* // resourceArn: "STRING_VALUE", // required
|
|
44
|
+
* // policyDocument: "STRING_VALUE", // required
|
|
45
|
+
* // };
|
|
46
|
+
*
|
|
47
|
+
* ```
|
|
48
|
+
*
|
|
49
|
+
* @param GetResourcePolicyCommandInput - {@link GetResourcePolicyCommandInput}
|
|
50
|
+
* @returns {@link GetResourcePolicyCommandOutput}
|
|
51
|
+
* @see {@link GetResourcePolicyCommandInput} for command's `input` shape.
|
|
52
|
+
* @see {@link GetResourcePolicyCommandOutput} for command's `response` shape.
|
|
53
|
+
* @see {@link BCMDashboardsClientResolvedConfig | config} for BCMDashboardsClient's `config` shape.
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
56
|
+
* <p>You do not have sufficient permissions to perform this action. Verify your IAM permissions and any resource policies.</p>
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link InternalServerException} (server fault)
|
|
59
|
+
* <p>An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.</p>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
62
|
+
* <p>The specified resource (dashboard, policy, or widget) was not found. Verify the ARN and try again.</p>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
65
|
+
* <p>The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link ValidationException} (client fault)
|
|
68
|
+
* <p>The input parameters do not satisfy the requirements. Check the error message for specific validation details.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link BCMDashboardsServiceException}
|
|
71
|
+
* <p>Base exception class for all service exceptions from BCMDashboards service.</p>
|
|
72
|
+
*
|
|
73
|
+
*
|
|
74
|
+
* @example Getting resource policy for a resource
|
|
75
|
+
* ```javascript
|
|
76
|
+
* //
|
|
77
|
+
* const input = {
|
|
78
|
+
* resourceArn: "arn:aws:bcm-dashboards::123456789012:dashboard/abcd1234-ab12-12ab-1ab2-abcd1234efgh"
|
|
79
|
+
* };
|
|
80
|
+
* const command = new GetResourcePolicyCommand(input);
|
|
81
|
+
* const response = await client.send(command);
|
|
82
|
+
* /* response is
|
|
83
|
+
* {
|
|
84
|
+
* policyDocument: "{}",
|
|
85
|
+
* resourceArn: "arn:aws:bcm-dashboards::123456789012:dashboard/abcd1234-ab12-12ab-1ab2-abcd1234efgh"
|
|
86
|
+
* }
|
|
87
|
+
* *\/
|
|
88
|
+
* ```
|
|
89
|
+
*
|
|
90
|
+
* @public
|
|
91
|
+
*/
|
|
92
|
+
export declare class GetResourcePolicyCommand extends GetResourcePolicyCommand_base {
|
|
93
|
+
/** @internal type navigation helper, not in runtime. */
|
|
94
|
+
protected static __types: {
|
|
95
|
+
api: {
|
|
96
|
+
input: GetResourcePolicyRequest;
|
|
97
|
+
output: GetResourcePolicyResponse;
|
|
98
|
+
};
|
|
99
|
+
sdk: {
|
|
100
|
+
input: GetResourcePolicyCommandInput;
|
|
101
|
+
output: GetResourcePolicyCommandOutput;
|
|
102
|
+
};
|
|
103
|
+
};
|
|
104
|
+
}
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BCMDashboardsClient";
|
|
4
|
+
import { ListDashboardsRequest, ListDashboardsResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListDashboardsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListDashboardsCommandInput extends ListDashboardsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListDashboardsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListDashboardsCommandOutput extends ListDashboardsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListDashboardsCommand_base: {
|
|
25
|
+
new (input: ListDashboardsCommandInput): import("@smithy/smithy-client").CommandImpl<ListDashboardsCommandInput, ListDashboardsCommandOutput, BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [ListDashboardsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListDashboardsCommandInput, ListDashboardsCommandOutput, BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Returns a list of all dashboards in your account.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BCMDashboardsClient, ListDashboardsCommand } from "@aws-sdk/client-bcm-dashboards"; // ES Modules import
|
|
35
|
+
* // const { BCMDashboardsClient, ListDashboardsCommand } = require("@aws-sdk/client-bcm-dashboards"); // CommonJS import
|
|
36
|
+
* const client = new BCMDashboardsClient(config);
|
|
37
|
+
* const input = { // ListDashboardsRequest
|
|
38
|
+
* maxResults: Number("int"),
|
|
39
|
+
* nextToken: "STRING_VALUE",
|
|
40
|
+
* };
|
|
41
|
+
* const command = new ListDashboardsCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // ListDashboardsResponse
|
|
44
|
+
* // dashboards: [ // DashboardReferenceList // required
|
|
45
|
+
* // { // DashboardReference
|
|
46
|
+
* // arn: "STRING_VALUE", // required
|
|
47
|
+
* // name: "STRING_VALUE", // required
|
|
48
|
+
* // description: "STRING_VALUE",
|
|
49
|
+
* // type: "CUSTOM", // required
|
|
50
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
51
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
52
|
+
* // },
|
|
53
|
+
* // ],
|
|
54
|
+
* // nextToken: "STRING_VALUE",
|
|
55
|
+
* // };
|
|
56
|
+
*
|
|
57
|
+
* ```
|
|
58
|
+
*
|
|
59
|
+
* @param ListDashboardsCommandInput - {@link ListDashboardsCommandInput}
|
|
60
|
+
* @returns {@link ListDashboardsCommandOutput}
|
|
61
|
+
* @see {@link ListDashboardsCommandInput} for command's `input` shape.
|
|
62
|
+
* @see {@link ListDashboardsCommandOutput} for command's `response` shape.
|
|
63
|
+
* @see {@link BCMDashboardsClientResolvedConfig | config} for BCMDashboardsClient's `config` shape.
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
66
|
+
* <p>You do not have sufficient permissions to perform this action. Verify your IAM permissions and any resource policies.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link InternalServerException} (server fault)
|
|
69
|
+
* <p>An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
72
|
+
* <p>The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ValidationException} (client fault)
|
|
75
|
+
* <p>The input parameters do not satisfy the requirements. Check the error message for specific validation details.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link BCMDashboardsServiceException}
|
|
78
|
+
* <p>Base exception class for all service exceptions from BCMDashboards service.</p>
|
|
79
|
+
*
|
|
80
|
+
*
|
|
81
|
+
* @example Listing dashboards for a user
|
|
82
|
+
* ```javascript
|
|
83
|
+
* //
|
|
84
|
+
* const input = { /* empty *\/ };
|
|
85
|
+
* const command = new ListDashboardsCommand(input);
|
|
86
|
+
* const response = await client.send(command);
|
|
87
|
+
* /* response is
|
|
88
|
+
* {
|
|
89
|
+
* dashboards: [
|
|
90
|
+
* {
|
|
91
|
+
* arn: "arn:aws:bcm-dashboards::123456789012:dashboard/abcd1234-ab12-12ab-1ab2-abcd1234efgh",
|
|
92
|
+
* createdAt: 1.753741462721E9,
|
|
93
|
+
* description: "Dashboard for tracking monthly cost",
|
|
94
|
+
* name: "monthly-cost-dashboard",
|
|
95
|
+
* type: "CUSTOM",
|
|
96
|
+
* updatedAt: 1.753741462721E9
|
|
97
|
+
* }
|
|
98
|
+
* ]
|
|
99
|
+
* }
|
|
100
|
+
* *\/
|
|
101
|
+
* ```
|
|
102
|
+
*
|
|
103
|
+
* @public
|
|
104
|
+
*/
|
|
105
|
+
export declare class ListDashboardsCommand extends ListDashboardsCommand_base {
|
|
106
|
+
/** @internal type navigation helper, not in runtime. */
|
|
107
|
+
protected static __types: {
|
|
108
|
+
api: {
|
|
109
|
+
input: ListDashboardsRequest;
|
|
110
|
+
output: ListDashboardsResponse;
|
|
111
|
+
};
|
|
112
|
+
sdk: {
|
|
113
|
+
input: ListDashboardsCommandInput;
|
|
114
|
+
output: ListDashboardsCommandOutput;
|
|
115
|
+
};
|
|
116
|
+
};
|
|
117
|
+
}
|
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BCMDashboardsClient";
|
|
4
|
+
import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListTagsForResourceCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListTagsForResourceCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListTagsForResourceCommand_base: {
|
|
25
|
+
new (input: ListTagsForResourceCommandInput): import("@smithy/smithy-client").CommandImpl<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: ListTagsForResourceCommandInput): import("@smithy/smithy-client").CommandImpl<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Returns a list of all tags associated with a specified dashboard resource.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BCMDashboardsClient, ListTagsForResourceCommand } from "@aws-sdk/client-bcm-dashboards"; // ES Modules import
|
|
35
|
+
* // const { BCMDashboardsClient, ListTagsForResourceCommand } = require("@aws-sdk/client-bcm-dashboards"); // CommonJS import
|
|
36
|
+
* const client = new BCMDashboardsClient(config);
|
|
37
|
+
* const input = { // ListTagsForResourceRequest
|
|
38
|
+
* resourceArn: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new ListTagsForResourceCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // ListTagsForResourceResponse
|
|
43
|
+
* // resourceTags: [ // ResourceTagList
|
|
44
|
+
* // { // ResourceTag
|
|
45
|
+
* // key: "STRING_VALUE", // required
|
|
46
|
+
* // value: "STRING_VALUE", // required
|
|
47
|
+
* // },
|
|
48
|
+
* // ],
|
|
49
|
+
* // };
|
|
50
|
+
*
|
|
51
|
+
* ```
|
|
52
|
+
*
|
|
53
|
+
* @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
|
|
54
|
+
* @returns {@link ListTagsForResourceCommandOutput}
|
|
55
|
+
* @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
|
|
56
|
+
* @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
|
|
57
|
+
* @see {@link BCMDashboardsClientResolvedConfig | config} for BCMDashboardsClient's `config` shape.
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link InternalServerException} (server fault)
|
|
60
|
+
* <p>An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
63
|
+
* <p>The specified resource (dashboard, policy, or widget) was not found. Verify the ARN and try again.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
66
|
+
* <p>The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link ValidationException} (client fault)
|
|
69
|
+
* <p>The input parameters do not satisfy the requirements. Check the error message for specific validation details.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link BCMDashboardsServiceException}
|
|
72
|
+
* <p>Base exception class for all service exceptions from BCMDashboards service.</p>
|
|
73
|
+
*
|
|
74
|
+
*
|
|
75
|
+
* @example Listing tags for a resource
|
|
76
|
+
* ```javascript
|
|
77
|
+
* //
|
|
78
|
+
* const input = {
|
|
79
|
+
* resourceArn: "arn:aws:bcm-dashboards::123456789012:dashboard/abcd1234-ab12-12ab-1ab2-abcd1234efgh"
|
|
80
|
+
* };
|
|
81
|
+
* const command = new ListTagsForResourceCommand(input);
|
|
82
|
+
* const response = await client.send(command);
|
|
83
|
+
* /* response is
|
|
84
|
+
* {
|
|
85
|
+
* resourceTags: [
|
|
86
|
+
* {
|
|
87
|
+
* key: "keyOne",
|
|
88
|
+
* value: "valueOne"
|
|
89
|
+
* },
|
|
90
|
+
* {
|
|
91
|
+
* key: "keyTwo",
|
|
92
|
+
* value: "valueTwo"
|
|
93
|
+
* }
|
|
94
|
+
* ]
|
|
95
|
+
* }
|
|
96
|
+
* *\/
|
|
97
|
+
* ```
|
|
98
|
+
*
|
|
99
|
+
* @public
|
|
100
|
+
*/
|
|
101
|
+
export declare class ListTagsForResourceCommand extends ListTagsForResourceCommand_base {
|
|
102
|
+
/** @internal type navigation helper, not in runtime. */
|
|
103
|
+
protected static __types: {
|
|
104
|
+
api: {
|
|
105
|
+
input: ListTagsForResourceRequest;
|
|
106
|
+
output: ListTagsForResourceResponse;
|
|
107
|
+
};
|
|
108
|
+
sdk: {
|
|
109
|
+
input: ListTagsForResourceCommandInput;
|
|
110
|
+
output: ListTagsForResourceCommandOutput;
|
|
111
|
+
};
|
|
112
|
+
};
|
|
113
|
+
}
|