@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,107 @@
|
|
|
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 { TagResourceRequest, TagResourceResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link TagResourceCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface TagResourceCommandInput extends TagResourceRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link TagResourceCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const TagResourceCommand_base: {
|
|
25
|
+
new (input: TagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<TagResourceCommandInput, TagResourceCommandOutput, BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: TagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<TagResourceCommandInput, TagResourceCommandOutput, BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Adds or updates tags for 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, TagResourceCommand } from "@aws-sdk/client-bcm-dashboards"; // ES Modules import
|
|
35
|
+
* // const { BCMDashboardsClient, TagResourceCommand } = require("@aws-sdk/client-bcm-dashboards"); // CommonJS import
|
|
36
|
+
* const client = new BCMDashboardsClient(config);
|
|
37
|
+
* const input = { // TagResourceRequest
|
|
38
|
+
* resourceArn: "STRING_VALUE", // required
|
|
39
|
+
* resourceTags: [ // ResourceTagList // required
|
|
40
|
+
* { // ResourceTag
|
|
41
|
+
* key: "STRING_VALUE", // required
|
|
42
|
+
* value: "STRING_VALUE", // required
|
|
43
|
+
* },
|
|
44
|
+
* ],
|
|
45
|
+
* };
|
|
46
|
+
* const command = new TagResourceCommand(input);
|
|
47
|
+
* const response = await client.send(command);
|
|
48
|
+
* // {};
|
|
49
|
+
*
|
|
50
|
+
* ```
|
|
51
|
+
*
|
|
52
|
+
* @param TagResourceCommandInput - {@link TagResourceCommandInput}
|
|
53
|
+
* @returns {@link TagResourceCommandOutput}
|
|
54
|
+
* @see {@link TagResourceCommandInput} for command's `input` shape.
|
|
55
|
+
* @see {@link TagResourceCommandOutput} for command's `response` shape.
|
|
56
|
+
* @see {@link BCMDashboardsClientResolvedConfig | config} for BCMDashboardsClient's `config` shape.
|
|
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 Adding tag(s) to a resource
|
|
75
|
+
* ```javascript
|
|
76
|
+
* //
|
|
77
|
+
* const input = {
|
|
78
|
+
* resourceArn: "arn:aws:bcm-dashboards::123456789012:dashboard/abcd1234-ab12-12ab-1ab2-abcd1234efgh",
|
|
79
|
+
* resourceTags: [
|
|
80
|
+
* {
|
|
81
|
+
* key: "keyOne",
|
|
82
|
+
* value: "valueOne"
|
|
83
|
+
* }
|
|
84
|
+
* ]
|
|
85
|
+
* };
|
|
86
|
+
* const command = new TagResourceCommand(input);
|
|
87
|
+
* const response = await client.send(command);
|
|
88
|
+
* /* response is
|
|
89
|
+
* { /* metadata only *\/ }
|
|
90
|
+
* *\/
|
|
91
|
+
* ```
|
|
92
|
+
*
|
|
93
|
+
* @public
|
|
94
|
+
*/
|
|
95
|
+
export declare class TagResourceCommand extends TagResourceCommand_base {
|
|
96
|
+
/** @internal type navigation helper, not in runtime. */
|
|
97
|
+
protected static __types: {
|
|
98
|
+
api: {
|
|
99
|
+
input: TagResourceRequest;
|
|
100
|
+
output: {};
|
|
101
|
+
};
|
|
102
|
+
sdk: {
|
|
103
|
+
input: TagResourceCommandInput;
|
|
104
|
+
output: TagResourceCommandOutput;
|
|
105
|
+
};
|
|
106
|
+
};
|
|
107
|
+
}
|
|
@@ -0,0 +1,101 @@
|
|
|
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 { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link UntagResourceCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UntagResourceCommandInput extends UntagResourceRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UntagResourceCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UntagResourceCommand_base: {
|
|
25
|
+
new (input: UntagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<UntagResourceCommandInput, UntagResourceCommandOutput, BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: UntagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<UntagResourceCommandInput, UntagResourceCommandOutput, BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Removes specified tags from a 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, UntagResourceCommand } from "@aws-sdk/client-bcm-dashboards"; // ES Modules import
|
|
35
|
+
* // const { BCMDashboardsClient, UntagResourceCommand } = require("@aws-sdk/client-bcm-dashboards"); // CommonJS import
|
|
36
|
+
* const client = new BCMDashboardsClient(config);
|
|
37
|
+
* const input = { // UntagResourceRequest
|
|
38
|
+
* resourceArn: "STRING_VALUE", // required
|
|
39
|
+
* resourceTagKeys: [ // ResourceTagKeyList // required
|
|
40
|
+
* "STRING_VALUE",
|
|
41
|
+
* ],
|
|
42
|
+
* };
|
|
43
|
+
* const command = new UntagResourceCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // {};
|
|
46
|
+
*
|
|
47
|
+
* ```
|
|
48
|
+
*
|
|
49
|
+
* @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
|
|
50
|
+
* @returns {@link UntagResourceCommandOutput}
|
|
51
|
+
* @see {@link UntagResourceCommandInput} for command's `input` shape.
|
|
52
|
+
* @see {@link UntagResourceCommandOutput} for command's `response` shape.
|
|
53
|
+
* @see {@link BCMDashboardsClientResolvedConfig | config} for BCMDashboardsClient's `config` shape.
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link InternalServerException} (server fault)
|
|
56
|
+
* <p>An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.</p>
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
59
|
+
* <p>The specified resource (dashboard, policy, or widget) was not found. Verify the ARN and try again.</p>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
62
|
+
* <p>The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.</p>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link ValidationException} (client fault)
|
|
65
|
+
* <p>The input parameters do not satisfy the requirements. Check the error message for specific validation details.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link BCMDashboardsServiceException}
|
|
68
|
+
* <p>Base exception class for all service exceptions from BCMDashboards service.</p>
|
|
69
|
+
*
|
|
70
|
+
*
|
|
71
|
+
* @example Removing tag(s) from a resource
|
|
72
|
+
* ```javascript
|
|
73
|
+
* //
|
|
74
|
+
* const input = {
|
|
75
|
+
* resourceArn: "arn:aws:bcm-dashboards::123456789012:dashboard/abcd1234-ab12-12ab-1ab2-abcd1234efgh",
|
|
76
|
+
* resourceTagKeys: [
|
|
77
|
+
* "keyOne"
|
|
78
|
+
* ]
|
|
79
|
+
* };
|
|
80
|
+
* const command = new UntagResourceCommand(input);
|
|
81
|
+
* const response = await client.send(command);
|
|
82
|
+
* /* response is
|
|
83
|
+
* { /* metadata only *\/ }
|
|
84
|
+
* *\/
|
|
85
|
+
* ```
|
|
86
|
+
*
|
|
87
|
+
* @public
|
|
88
|
+
*/
|
|
89
|
+
export declare class UntagResourceCommand extends UntagResourceCommand_base {
|
|
90
|
+
/** @internal type navigation helper, not in runtime. */
|
|
91
|
+
protected static __types: {
|
|
92
|
+
api: {
|
|
93
|
+
input: UntagResourceRequest;
|
|
94
|
+
output: {};
|
|
95
|
+
};
|
|
96
|
+
sdk: {
|
|
97
|
+
input: UntagResourceCommandInput;
|
|
98
|
+
output: UntagResourceCommandOutput;
|
|
99
|
+
};
|
|
100
|
+
};
|
|
101
|
+
}
|
|
@@ -0,0 +1,324 @@
|
|
|
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 { UpdateDashboardRequest, UpdateDashboardResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link UpdateDashboardCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdateDashboardCommandInput extends UpdateDashboardRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpdateDashboardCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UpdateDashboardCommand_base: {
|
|
25
|
+
new (input: UpdateDashboardCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateDashboardCommandInput, UpdateDashboardCommandOutput, BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: UpdateDashboardCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateDashboardCommandInput, UpdateDashboardCommandOutput, BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Updates an existing dashboard's properties, including its name, description, and widget configurations.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BCMDashboardsClient, UpdateDashboardCommand } from "@aws-sdk/client-bcm-dashboards"; // ES Modules import
|
|
35
|
+
* // const { BCMDashboardsClient, UpdateDashboardCommand } = require("@aws-sdk/client-bcm-dashboards"); // CommonJS import
|
|
36
|
+
* const client = new BCMDashboardsClient(config);
|
|
37
|
+
* const input = { // UpdateDashboardRequest
|
|
38
|
+
* arn: "STRING_VALUE", // required
|
|
39
|
+
* name: "STRING_VALUE",
|
|
40
|
+
* description: "STRING_VALUE",
|
|
41
|
+
* widgets: [ // WidgetList
|
|
42
|
+
* { // Widget
|
|
43
|
+
* title: "STRING_VALUE", // required
|
|
44
|
+
* description: "STRING_VALUE",
|
|
45
|
+
* width: Number("int"),
|
|
46
|
+
* height: Number("int"),
|
|
47
|
+
* horizontalOffset: Number("int"),
|
|
48
|
+
* configs: [ // WidgetConfigList // required
|
|
49
|
+
* { // WidgetConfig
|
|
50
|
+
* queryParameters: { // QueryParameters Union: only one key present
|
|
51
|
+
* costAndUsage: { // CostAndUsageQuery
|
|
52
|
+
* metrics: [ // MetricNames // required
|
|
53
|
+
* "AmortizedCost" || "BlendedCost" || "NetAmortizedCost" || "NetUnblendedCost" || "NormalizedUsageAmount" || "UnblendedCost" || "UsageQuantity" || "SpendCoveredBySavingsPlans" || "Hour" || "Unit" || "Cost",
|
|
54
|
+
* ],
|
|
55
|
+
* timeRange: { // DateTimeRange
|
|
56
|
+
* startTime: { // DateTimeValue
|
|
57
|
+
* type: "ABSOLUTE" || "RELATIVE", // required
|
|
58
|
+
* value: "STRING_VALUE", // required
|
|
59
|
+
* },
|
|
60
|
+
* endTime: {
|
|
61
|
+
* type: "ABSOLUTE" || "RELATIVE", // required
|
|
62
|
+
* value: "STRING_VALUE", // required
|
|
63
|
+
* },
|
|
64
|
+
* },
|
|
65
|
+
* granularity: "HOURLY" || "DAILY" || "MONTHLY", // required
|
|
66
|
+
* groupBy: [ // GroupDefinitions
|
|
67
|
+
* { // GroupDefinition
|
|
68
|
+
* key: "STRING_VALUE", // required
|
|
69
|
+
* type: "DIMENSION" || "TAG" || "COST_CATEGORY",
|
|
70
|
+
* },
|
|
71
|
+
* ],
|
|
72
|
+
* filter: { // Expression
|
|
73
|
+
* or: [ // Expressions
|
|
74
|
+
* {
|
|
75
|
+
* or: [
|
|
76
|
+
* "<Expression>",
|
|
77
|
+
* ],
|
|
78
|
+
* and: [
|
|
79
|
+
* "<Expression>",
|
|
80
|
+
* ],
|
|
81
|
+
* not: "<Expression>",
|
|
82
|
+
* dimensions: { // DimensionValues
|
|
83
|
+
* 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
|
|
84
|
+
* values: [ // StringList // required
|
|
85
|
+
* "STRING_VALUE",
|
|
86
|
+
* ],
|
|
87
|
+
* matchOptions: [ // MatchOptions
|
|
88
|
+
* "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "GREATER_THAN_OR_EQUAL" || "CASE_SENSITIVE" || "CASE_INSENSITIVE",
|
|
89
|
+
* ],
|
|
90
|
+
* },
|
|
91
|
+
* tags: { // TagValues
|
|
92
|
+
* key: "STRING_VALUE",
|
|
93
|
+
* values: [
|
|
94
|
+
* "STRING_VALUE",
|
|
95
|
+
* ],
|
|
96
|
+
* matchOptions: [
|
|
97
|
+
* "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "GREATER_THAN_OR_EQUAL" || "CASE_SENSITIVE" || "CASE_INSENSITIVE",
|
|
98
|
+
* ],
|
|
99
|
+
* },
|
|
100
|
+
* costCategories: { // CostCategoryValues
|
|
101
|
+
* key: "STRING_VALUE",
|
|
102
|
+
* values: [
|
|
103
|
+
* "STRING_VALUE",
|
|
104
|
+
* ],
|
|
105
|
+
* matchOptions: [
|
|
106
|
+
* "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "GREATER_THAN_OR_EQUAL" || "CASE_SENSITIVE" || "CASE_INSENSITIVE",
|
|
107
|
+
* ],
|
|
108
|
+
* },
|
|
109
|
+
* },
|
|
110
|
+
* ],
|
|
111
|
+
* and: [
|
|
112
|
+
* "<Expression>",
|
|
113
|
+
* ],
|
|
114
|
+
* not: "<Expression>",
|
|
115
|
+
* dimensions: {
|
|
116
|
+
* 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
|
|
117
|
+
* values: [ // required
|
|
118
|
+
* "STRING_VALUE",
|
|
119
|
+
* ],
|
|
120
|
+
* matchOptions: [
|
|
121
|
+
* "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "GREATER_THAN_OR_EQUAL" || "CASE_SENSITIVE" || "CASE_INSENSITIVE",
|
|
122
|
+
* ],
|
|
123
|
+
* },
|
|
124
|
+
* tags: {
|
|
125
|
+
* key: "STRING_VALUE",
|
|
126
|
+
* values: [
|
|
127
|
+
* "STRING_VALUE",
|
|
128
|
+
* ],
|
|
129
|
+
* matchOptions: [
|
|
130
|
+
* "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "GREATER_THAN_OR_EQUAL" || "CASE_SENSITIVE" || "CASE_INSENSITIVE",
|
|
131
|
+
* ],
|
|
132
|
+
* },
|
|
133
|
+
* costCategories: {
|
|
134
|
+
* key: "STRING_VALUE",
|
|
135
|
+
* values: "<StringList>",
|
|
136
|
+
* matchOptions: "<MatchOptions>",
|
|
137
|
+
* },
|
|
138
|
+
* },
|
|
139
|
+
* },
|
|
140
|
+
* savingsPlansCoverage: { // SavingsPlansCoverageQuery
|
|
141
|
+
* timeRange: {
|
|
142
|
+
* startTime: {
|
|
143
|
+
* type: "ABSOLUTE" || "RELATIVE", // required
|
|
144
|
+
* value: "STRING_VALUE", // required
|
|
145
|
+
* },
|
|
146
|
+
* endTime: {
|
|
147
|
+
* type: "ABSOLUTE" || "RELATIVE", // required
|
|
148
|
+
* value: "STRING_VALUE", // required
|
|
149
|
+
* },
|
|
150
|
+
* },
|
|
151
|
+
* metrics: [
|
|
152
|
+
* "AmortizedCost" || "BlendedCost" || "NetAmortizedCost" || "NetUnblendedCost" || "NormalizedUsageAmount" || "UnblendedCost" || "UsageQuantity" || "SpendCoveredBySavingsPlans" || "Hour" || "Unit" || "Cost",
|
|
153
|
+
* ],
|
|
154
|
+
* granularity: "HOURLY" || "DAILY" || "MONTHLY",
|
|
155
|
+
* groupBy: [
|
|
156
|
+
* {
|
|
157
|
+
* key: "STRING_VALUE", // required
|
|
158
|
+
* type: "DIMENSION" || "TAG" || "COST_CATEGORY",
|
|
159
|
+
* },
|
|
160
|
+
* ],
|
|
161
|
+
* filter: "<Expression>",
|
|
162
|
+
* },
|
|
163
|
+
* savingsPlansUtilization: { // SavingsPlansUtilizationQuery
|
|
164
|
+
* timeRange: {
|
|
165
|
+
* startTime: {
|
|
166
|
+
* type: "ABSOLUTE" || "RELATIVE", // required
|
|
167
|
+
* value: "STRING_VALUE", // required
|
|
168
|
+
* },
|
|
169
|
+
* endTime: "<DateTimeValue>", // required
|
|
170
|
+
* },
|
|
171
|
+
* granularity: "HOURLY" || "DAILY" || "MONTHLY",
|
|
172
|
+
* filter: "<Expression>",
|
|
173
|
+
* },
|
|
174
|
+
* reservationCoverage: { // ReservationCoverageQuery
|
|
175
|
+
* timeRange: {
|
|
176
|
+
* startTime: "<DateTimeValue>", // required
|
|
177
|
+
* endTime: "<DateTimeValue>", // required
|
|
178
|
+
* },
|
|
179
|
+
* groupBy: [
|
|
180
|
+
* {
|
|
181
|
+
* key: "STRING_VALUE", // required
|
|
182
|
+
* type: "DIMENSION" || "TAG" || "COST_CATEGORY",
|
|
183
|
+
* },
|
|
184
|
+
* ],
|
|
185
|
+
* granularity: "HOURLY" || "DAILY" || "MONTHLY",
|
|
186
|
+
* filter: "<Expression>",
|
|
187
|
+
* metrics: [
|
|
188
|
+
* "AmortizedCost" || "BlendedCost" || "NetAmortizedCost" || "NetUnblendedCost" || "NormalizedUsageAmount" || "UnblendedCost" || "UsageQuantity" || "SpendCoveredBySavingsPlans" || "Hour" || "Unit" || "Cost",
|
|
189
|
+
* ],
|
|
190
|
+
* },
|
|
191
|
+
* reservationUtilization: { // ReservationUtilizationQuery
|
|
192
|
+
* timeRange: {
|
|
193
|
+
* startTime: "<DateTimeValue>", // required
|
|
194
|
+
* endTime: "<DateTimeValue>", // required
|
|
195
|
+
* },
|
|
196
|
+
* groupBy: [
|
|
197
|
+
* {
|
|
198
|
+
* key: "STRING_VALUE", // required
|
|
199
|
+
* type: "DIMENSION" || "TAG" || "COST_CATEGORY",
|
|
200
|
+
* },
|
|
201
|
+
* ],
|
|
202
|
+
* granularity: "HOURLY" || "DAILY" || "MONTHLY",
|
|
203
|
+
* filter: "<Expression>",
|
|
204
|
+
* },
|
|
205
|
+
* },
|
|
206
|
+
* displayConfig: { // DisplayConfig Union: only one key present
|
|
207
|
+
* graph: { // GraphDisplayConfigMap
|
|
208
|
+
* "<keys>": { // GraphDisplayConfig
|
|
209
|
+
* visualType: "LINE" || "BAR" || "STACK", // required
|
|
210
|
+
* },
|
|
211
|
+
* },
|
|
212
|
+
* table: {},
|
|
213
|
+
* },
|
|
214
|
+
* },
|
|
215
|
+
* ],
|
|
216
|
+
* },
|
|
217
|
+
* ],
|
|
218
|
+
* };
|
|
219
|
+
* const command = new UpdateDashboardCommand(input);
|
|
220
|
+
* const response = await client.send(command);
|
|
221
|
+
* // { // UpdateDashboardResponse
|
|
222
|
+
* // arn: "STRING_VALUE", // required
|
|
223
|
+
* // };
|
|
224
|
+
*
|
|
225
|
+
* ```
|
|
226
|
+
*
|
|
227
|
+
* @param UpdateDashboardCommandInput - {@link UpdateDashboardCommandInput}
|
|
228
|
+
* @returns {@link UpdateDashboardCommandOutput}
|
|
229
|
+
* @see {@link UpdateDashboardCommandInput} for command's `input` shape.
|
|
230
|
+
* @see {@link UpdateDashboardCommandOutput} for command's `response` shape.
|
|
231
|
+
* @see {@link BCMDashboardsClientResolvedConfig | config} for BCMDashboardsClient's `config` shape.
|
|
232
|
+
*
|
|
233
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
234
|
+
* <p>You do not have sufficient permissions to perform this action. Verify your IAM permissions and any resource policies.</p>
|
|
235
|
+
*
|
|
236
|
+
* @throws {@link InternalServerException} (server fault)
|
|
237
|
+
* <p>An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.</p>
|
|
238
|
+
*
|
|
239
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
240
|
+
* <p>The specified resource (dashboard, policy, or widget) was not found. Verify the ARN and try again.</p>
|
|
241
|
+
*
|
|
242
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
243
|
+
* <p>The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.</p>
|
|
244
|
+
*
|
|
245
|
+
* @throws {@link ValidationException} (client fault)
|
|
246
|
+
* <p>The input parameters do not satisfy the requirements. Check the error message for specific validation details.</p>
|
|
247
|
+
*
|
|
248
|
+
* @throws {@link BCMDashboardsServiceException}
|
|
249
|
+
* <p>Base exception class for all service exceptions from BCMDashboards service.</p>
|
|
250
|
+
*
|
|
251
|
+
*
|
|
252
|
+
* @example Updating a dashboard
|
|
253
|
+
* ```javascript
|
|
254
|
+
* //
|
|
255
|
+
* const input = {
|
|
256
|
+
* arn: "arn:aws:bcm-dashboards::123456789012:dashboard/abcd1234-ab12-12ab-1ab2-abcd1234efgh",
|
|
257
|
+
* description: "Dashboard for tracking costs version 2",
|
|
258
|
+
* name: "cost-dashboards-updated",
|
|
259
|
+
* widgets: [
|
|
260
|
+
* {
|
|
261
|
+
* configs: [
|
|
262
|
+
* {
|
|
263
|
+
* displayConfig: {
|
|
264
|
+
* graph: {
|
|
265
|
+
* costTrend: {
|
|
266
|
+
* visualType: "LINE"
|
|
267
|
+
* }
|
|
268
|
+
* }
|
|
269
|
+
* },
|
|
270
|
+
* queryParameters: {
|
|
271
|
+
* costAndUsage: {
|
|
272
|
+
* granularity: "MONTHLY",
|
|
273
|
+
* groupBy: [
|
|
274
|
+
* {
|
|
275
|
+
* key: "SERVICE",
|
|
276
|
+
* type: "DIMENSION"
|
|
277
|
+
* }
|
|
278
|
+
* ],
|
|
279
|
+
* metrics: [
|
|
280
|
+
* "UnblendedCost"
|
|
281
|
+
* ],
|
|
282
|
+
* timeRange: {
|
|
283
|
+
* endTime: {
|
|
284
|
+
* type: "RELATIVE",
|
|
285
|
+
* value: "now"
|
|
286
|
+
* },
|
|
287
|
+
* startTime: {
|
|
288
|
+
* type: "RELATIVE",
|
|
289
|
+
* value: "-3M"
|
|
290
|
+
* }
|
|
291
|
+
* }
|
|
292
|
+
* }
|
|
293
|
+
* }
|
|
294
|
+
* }
|
|
295
|
+
* ],
|
|
296
|
+
* height: 7,
|
|
297
|
+
* horizontalOffset: 2,
|
|
298
|
+
* title: "Monthly Cost Trend",
|
|
299
|
+
* width: 4
|
|
300
|
+
* }
|
|
301
|
+
* ]
|
|
302
|
+
* };
|
|
303
|
+
* const command = new UpdateDashboardCommand(input);
|
|
304
|
+
* const response = await client.send(command);
|
|
305
|
+
* /* response is
|
|
306
|
+
* { /* metadata only *\/ }
|
|
307
|
+
* *\/
|
|
308
|
+
* ```
|
|
309
|
+
*
|
|
310
|
+
* @public
|
|
311
|
+
*/
|
|
312
|
+
export declare class UpdateDashboardCommand extends UpdateDashboardCommand_base {
|
|
313
|
+
/** @internal type navigation helper, not in runtime. */
|
|
314
|
+
protected static __types: {
|
|
315
|
+
api: {
|
|
316
|
+
input: UpdateDashboardRequest;
|
|
317
|
+
output: UpdateDashboardResponse;
|
|
318
|
+
};
|
|
319
|
+
sdk: {
|
|
320
|
+
input: UpdateDashboardCommandInput;
|
|
321
|
+
output: UpdateDashboardCommandOutput;
|
|
322
|
+
};
|
|
323
|
+
};
|
|
324
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
export * from "./CreateDashboardCommand";
|
|
2
|
+
export * from "./DeleteDashboardCommand";
|
|
3
|
+
export * from "./GetDashboardCommand";
|
|
4
|
+
export * from "./GetResourcePolicyCommand";
|
|
5
|
+
export * from "./ListDashboardsCommand";
|
|
6
|
+
export * from "./ListTagsForResourceCommand";
|
|
7
|
+
export * from "./TagResourceCommand";
|
|
8
|
+
export * from "./UntagResourceCommand";
|
|
9
|
+
export * from "./UpdateDashboardCommand";
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
|
|
2
|
+
/**
|
|
3
|
+
* @public
|
|
4
|
+
*/
|
|
5
|
+
export interface ClientInputEndpointParameters {
|
|
6
|
+
useFipsEndpoint?: boolean | undefined | Provider<boolean | undefined>;
|
|
7
|
+
endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
|
|
8
|
+
region?: string | undefined | Provider<string | undefined>;
|
|
9
|
+
}
|
|
10
|
+
export type ClientResolvedEndpointParameters = Omit<ClientInputEndpointParameters, "endpoint"> & {
|
|
11
|
+
defaultSigningName: string;
|
|
12
|
+
};
|
|
13
|
+
export declare const resolveClientEndpointParameters: <T>(options: T & ClientInputEndpointParameters) => T & ClientResolvedEndpointParameters;
|
|
14
|
+
export declare const commonParams: {
|
|
15
|
+
readonly UseFIPS: {
|
|
16
|
+
readonly type: "builtInParams";
|
|
17
|
+
readonly name: "useFipsEndpoint";
|
|
18
|
+
};
|
|
19
|
+
readonly Endpoint: {
|
|
20
|
+
readonly type: "builtInParams";
|
|
21
|
+
readonly name: "endpoint";
|
|
22
|
+
};
|
|
23
|
+
readonly Region: {
|
|
24
|
+
readonly type: "builtInParams";
|
|
25
|
+
readonly name: "region";
|
|
26
|
+
};
|
|
27
|
+
};
|
|
28
|
+
export interface EndpointParameters extends __EndpointParameters {
|
|
29
|
+
UseFIPS?: boolean | undefined;
|
|
30
|
+
Endpoint?: string | undefined;
|
|
31
|
+
Region?: string | undefined;
|
|
32
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { AwsRegionExtensionConfiguration } from "@aws-sdk/types";
|
|
2
|
+
import { HttpHandlerExtensionConfiguration } from "@smithy/protocol-http";
|
|
3
|
+
import { DefaultExtensionConfiguration } from "@smithy/types";
|
|
4
|
+
import { HttpAuthExtensionConfiguration } from "./auth/httpAuthExtensionConfiguration";
|
|
5
|
+
/**
|
|
6
|
+
* @internal
|
|
7
|
+
*/
|
|
8
|
+
export interface BCMDashboardsExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, AwsRegionExtensionConfiguration, HttpAuthExtensionConfiguration {
|
|
9
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* <p>Amazon Web Services Billing and Cost Management Dashboards is a service that enables you to create, manage, and share dashboards that combine multiple visualizations of your Amazon Web Services cost and usage data. You can combine multiple data sources including Cost Explorer, Savings Plans, and Reserved Instance metrics into unified dashboards, helping you analyze spending patterns and share cost insights across your organization.</p> <p>You can use the Amazon Web Services Billing and Cost Management Dashboards API to programmatically create, manage, and share dashboards. This includes creating custom dashboards, configuring widgets, managing dashboard permissions, and sharing dashboards across accounts in your organization.</p>
|
|
3
|
+
*
|
|
4
|
+
* @packageDocumentation
|
|
5
|
+
*/
|
|
6
|
+
export * from "./BCMDashboardsClient";
|
|
7
|
+
export * from "./BCMDashboards";
|
|
8
|
+
export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
|
|
9
|
+
export type { RuntimeExtension } from "./runtimeExtensions";
|
|
10
|
+
export type { BCMDashboardsExtensionConfiguration } from "./extensionConfiguration";
|
|
11
|
+
export * from "./commands";
|
|
12
|
+
export * from "./pagination";
|
|
13
|
+
export * from "./models";
|
|
14
|
+
export { BCMDashboardsServiceException } from "./models/BCMDashboardsServiceException";
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@smithy/smithy-client";
|
|
2
|
+
export type { __ServiceExceptionOptions };
|
|
3
|
+
export { __ServiceException };
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
*
|
|
7
|
+
* Base exception class for all service exceptions from BCMDashboards service.
|
|
8
|
+
*/
|
|
9
|
+
export declare class BCMDashboardsServiceException extends __ServiceException {
|
|
10
|
+
/**
|
|
11
|
+
* @internal
|
|
12
|
+
*/
|
|
13
|
+
constructor(options: __ServiceExceptionOptions);
|
|
14
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./models_0";
|