@aws-sdk/client-bcm-dashboards 3.1027.0 → 3.1028.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/README.md +42 -0
- package/dist-cjs/index.js +108 -0
- package/dist-cjs/models/errors.js +14 -1
- package/dist-cjs/schemas/schemas_0.js +172 -3
- package/dist-es/BCMDashboards.js +14 -0
- package/dist-es/commands/CreateScheduledReportCommand.js +16 -0
- package/dist-es/commands/DeleteScheduledReportCommand.js +16 -0
- package/dist-es/commands/ExecuteScheduledReportCommand.js +16 -0
- package/dist-es/commands/GetScheduledReportCommand.js +16 -0
- package/dist-es/commands/ListScheduledReportsCommand.js +16 -0
- package/dist-es/commands/UpdateScheduledReportCommand.js +16 -0
- package/dist-es/commands/index.js +6 -0
- package/dist-es/models/enums.js +17 -0
- package/dist-es/models/errors.js +12 -0
- package/dist-es/pagination/ListScheduledReportsPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/schemas/schemas_0.js +171 -2
- package/dist-types/BCMDashboards.d.ts +50 -0
- package/dist-types/BCMDashboardsClient.d.ts +8 -2
- package/dist-types/commands/CreateDashboardCommand.d.ts +1 -1
- package/dist-types/commands/CreateScheduledReportCommand.d.ts +126 -0
- package/dist-types/commands/DeleteScheduledReportCommand.d.ts +89 -0
- package/dist-types/commands/ExecuteScheduledReportCommand.d.ts +101 -0
- package/dist-types/commands/GetScheduledReportCommand.d.ts +127 -0
- package/dist-types/commands/ListScheduledReportsCommand.d.ts +107 -0
- package/dist-types/commands/UpdateDashboardCommand.d.ts +1 -1
- package/dist-types/commands/UpdateScheduledReportCommand.d.ts +120 -0
- package/dist-types/commands/index.d.ts +6 -0
- package/dist-types/models/enums.d.ts +41 -0
- package/dist-types/models/errors.d.ts +13 -1
- package/dist-types/models/models_0.d.ts +422 -6
- package/dist-types/pagination/ListScheduledReportsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/schemas/schemas_0.d.ts +25 -0
- package/dist-types/ts3.4/BCMDashboards.d.ts +110 -0
- package/dist-types/ts3.4/BCMDashboardsClient.d.ts +38 -2
- package/dist-types/ts3.4/commands/CreateScheduledReportCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteScheduledReportCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ExecuteScheduledReportCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetScheduledReportCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListScheduledReportsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateScheduledReportCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +6 -0
- package/dist-types/ts3.4/models/enums.d.ts +21 -0
- package/dist-types/ts3.4/models/errors.d.ts +5 -0
- package/dist-types/ts3.4/models/models_0.d.ts +104 -1
- package/dist-types/ts3.4/pagination/ListScheduledReportsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +25 -0
- package/package.json +1 -1
|
@@ -1,14 +1,20 @@
|
|
|
1
1
|
import type { HttpHandlerOptions as __HttpHandlerOptions, PaginationConfiguration, Paginator } from "@smithy/types";
|
|
2
2
|
import { BCMDashboardsClient } from "./BCMDashboardsClient";
|
|
3
3
|
import { type CreateDashboardCommandInput, type CreateDashboardCommandOutput } from "./commands/CreateDashboardCommand";
|
|
4
|
+
import { type CreateScheduledReportCommandInput, type CreateScheduledReportCommandOutput } from "./commands/CreateScheduledReportCommand";
|
|
4
5
|
import { type DeleteDashboardCommandInput, type DeleteDashboardCommandOutput } from "./commands/DeleteDashboardCommand";
|
|
6
|
+
import { type DeleteScheduledReportCommandInput, type DeleteScheduledReportCommandOutput } from "./commands/DeleteScheduledReportCommand";
|
|
7
|
+
import { type ExecuteScheduledReportCommandInput, type ExecuteScheduledReportCommandOutput } from "./commands/ExecuteScheduledReportCommand";
|
|
5
8
|
import { type GetDashboardCommandInput, type GetDashboardCommandOutput } from "./commands/GetDashboardCommand";
|
|
6
9
|
import { type GetResourcePolicyCommandInput, type GetResourcePolicyCommandOutput } from "./commands/GetResourcePolicyCommand";
|
|
10
|
+
import { type GetScheduledReportCommandInput, type GetScheduledReportCommandOutput } from "./commands/GetScheduledReportCommand";
|
|
7
11
|
import { type ListDashboardsCommandInput, type ListDashboardsCommandOutput } from "./commands/ListDashboardsCommand";
|
|
12
|
+
import { type ListScheduledReportsCommandInput, type ListScheduledReportsCommandOutput } from "./commands/ListScheduledReportsCommand";
|
|
8
13
|
import { type ListTagsForResourceCommandInput, type ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
9
14
|
import { type TagResourceCommandInput, type TagResourceCommandOutput } from "./commands/TagResourceCommand";
|
|
10
15
|
import { type UntagResourceCommandInput, type UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
|
|
11
16
|
import { type UpdateDashboardCommandInput, type UpdateDashboardCommandOutput } from "./commands/UpdateDashboardCommand";
|
|
17
|
+
import { type UpdateScheduledReportCommandInput, type UpdateScheduledReportCommandOutput } from "./commands/UpdateScheduledReportCommand";
|
|
12
18
|
export interface BCMDashboards {
|
|
13
19
|
/**
|
|
14
20
|
* @see {@link CreateDashboardCommand}
|
|
@@ -16,12 +22,30 @@ export interface BCMDashboards {
|
|
|
16
22
|
createDashboard(args: CreateDashboardCommandInput, options?: __HttpHandlerOptions): Promise<CreateDashboardCommandOutput>;
|
|
17
23
|
createDashboard(args: CreateDashboardCommandInput, cb: (err: any, data?: CreateDashboardCommandOutput) => void): void;
|
|
18
24
|
createDashboard(args: CreateDashboardCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDashboardCommandOutput) => void): void;
|
|
25
|
+
/**
|
|
26
|
+
* @see {@link CreateScheduledReportCommand}
|
|
27
|
+
*/
|
|
28
|
+
createScheduledReport(args: CreateScheduledReportCommandInput, options?: __HttpHandlerOptions): Promise<CreateScheduledReportCommandOutput>;
|
|
29
|
+
createScheduledReport(args: CreateScheduledReportCommandInput, cb: (err: any, data?: CreateScheduledReportCommandOutput) => void): void;
|
|
30
|
+
createScheduledReport(args: CreateScheduledReportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateScheduledReportCommandOutput) => void): void;
|
|
19
31
|
/**
|
|
20
32
|
* @see {@link DeleteDashboardCommand}
|
|
21
33
|
*/
|
|
22
34
|
deleteDashboard(args: DeleteDashboardCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDashboardCommandOutput>;
|
|
23
35
|
deleteDashboard(args: DeleteDashboardCommandInput, cb: (err: any, data?: DeleteDashboardCommandOutput) => void): void;
|
|
24
36
|
deleteDashboard(args: DeleteDashboardCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDashboardCommandOutput) => void): void;
|
|
37
|
+
/**
|
|
38
|
+
* @see {@link DeleteScheduledReportCommand}
|
|
39
|
+
*/
|
|
40
|
+
deleteScheduledReport(args: DeleteScheduledReportCommandInput, options?: __HttpHandlerOptions): Promise<DeleteScheduledReportCommandOutput>;
|
|
41
|
+
deleteScheduledReport(args: DeleteScheduledReportCommandInput, cb: (err: any, data?: DeleteScheduledReportCommandOutput) => void): void;
|
|
42
|
+
deleteScheduledReport(args: DeleteScheduledReportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteScheduledReportCommandOutput) => void): void;
|
|
43
|
+
/**
|
|
44
|
+
* @see {@link ExecuteScheduledReportCommand}
|
|
45
|
+
*/
|
|
46
|
+
executeScheduledReport(args: ExecuteScheduledReportCommandInput, options?: __HttpHandlerOptions): Promise<ExecuteScheduledReportCommandOutput>;
|
|
47
|
+
executeScheduledReport(args: ExecuteScheduledReportCommandInput, cb: (err: any, data?: ExecuteScheduledReportCommandOutput) => void): void;
|
|
48
|
+
executeScheduledReport(args: ExecuteScheduledReportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExecuteScheduledReportCommandOutput) => void): void;
|
|
25
49
|
/**
|
|
26
50
|
* @see {@link GetDashboardCommand}
|
|
27
51
|
*/
|
|
@@ -34,6 +58,12 @@ export interface BCMDashboards {
|
|
|
34
58
|
getResourcePolicy(args: GetResourcePolicyCommandInput, options?: __HttpHandlerOptions): Promise<GetResourcePolicyCommandOutput>;
|
|
35
59
|
getResourcePolicy(args: GetResourcePolicyCommandInput, cb: (err: any, data?: GetResourcePolicyCommandOutput) => void): void;
|
|
36
60
|
getResourcePolicy(args: GetResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourcePolicyCommandOutput) => void): void;
|
|
61
|
+
/**
|
|
62
|
+
* @see {@link GetScheduledReportCommand}
|
|
63
|
+
*/
|
|
64
|
+
getScheduledReport(args: GetScheduledReportCommandInput, options?: __HttpHandlerOptions): Promise<GetScheduledReportCommandOutput>;
|
|
65
|
+
getScheduledReport(args: GetScheduledReportCommandInput, cb: (err: any, data?: GetScheduledReportCommandOutput) => void): void;
|
|
66
|
+
getScheduledReport(args: GetScheduledReportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetScheduledReportCommandOutput) => void): void;
|
|
37
67
|
/**
|
|
38
68
|
* @see {@link ListDashboardsCommand}
|
|
39
69
|
*/
|
|
@@ -41,6 +71,13 @@ export interface BCMDashboards {
|
|
|
41
71
|
listDashboards(args: ListDashboardsCommandInput, options?: __HttpHandlerOptions): Promise<ListDashboardsCommandOutput>;
|
|
42
72
|
listDashboards(args: ListDashboardsCommandInput, cb: (err: any, data?: ListDashboardsCommandOutput) => void): void;
|
|
43
73
|
listDashboards(args: ListDashboardsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDashboardsCommandOutput) => void): void;
|
|
74
|
+
/**
|
|
75
|
+
* @see {@link ListScheduledReportsCommand}
|
|
76
|
+
*/
|
|
77
|
+
listScheduledReports(): Promise<ListScheduledReportsCommandOutput>;
|
|
78
|
+
listScheduledReports(args: ListScheduledReportsCommandInput, options?: __HttpHandlerOptions): Promise<ListScheduledReportsCommandOutput>;
|
|
79
|
+
listScheduledReports(args: ListScheduledReportsCommandInput, cb: (err: any, data?: ListScheduledReportsCommandOutput) => void): void;
|
|
80
|
+
listScheduledReports(args: ListScheduledReportsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListScheduledReportsCommandOutput) => void): void;
|
|
44
81
|
/**
|
|
45
82
|
* @see {@link ListTagsForResourceCommand}
|
|
46
83
|
*/
|
|
@@ -65,6 +102,12 @@ export interface BCMDashboards {
|
|
|
65
102
|
updateDashboard(args: UpdateDashboardCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDashboardCommandOutput>;
|
|
66
103
|
updateDashboard(args: UpdateDashboardCommandInput, cb: (err: any, data?: UpdateDashboardCommandOutput) => void): void;
|
|
67
104
|
updateDashboard(args: UpdateDashboardCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDashboardCommandOutput) => void): void;
|
|
105
|
+
/**
|
|
106
|
+
* @see {@link UpdateScheduledReportCommand}
|
|
107
|
+
*/
|
|
108
|
+
updateScheduledReport(args: UpdateScheduledReportCommandInput, options?: __HttpHandlerOptions): Promise<UpdateScheduledReportCommandOutput>;
|
|
109
|
+
updateScheduledReport(args: UpdateScheduledReportCommandInput, cb: (err: any, data?: UpdateScheduledReportCommandOutput) => void): void;
|
|
110
|
+
updateScheduledReport(args: UpdateScheduledReportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateScheduledReportCommandOutput) => void): void;
|
|
68
111
|
/**
|
|
69
112
|
* @see {@link ListDashboardsCommand}
|
|
70
113
|
* @param args - command input.
|
|
@@ -72,6 +115,13 @@ export interface BCMDashboards {
|
|
|
72
115
|
* @returns AsyncIterable of {@link ListDashboardsCommandOutput}.
|
|
73
116
|
*/
|
|
74
117
|
paginateListDashboards(args?: ListDashboardsCommandInput, paginationConfig?: Omit<PaginationConfiguration, "client">): Paginator<ListDashboardsCommandOutput>;
|
|
118
|
+
/**
|
|
119
|
+
* @see {@link ListScheduledReportsCommand}
|
|
120
|
+
* @param args - command input.
|
|
121
|
+
* @param paginationConfig - optional pagination config.
|
|
122
|
+
* @returns AsyncIterable of {@link ListScheduledReportsCommandOutput}.
|
|
123
|
+
*/
|
|
124
|
+
paginateListScheduledReports(args?: ListScheduledReportsCommandInput, paginationConfig?: Omit<PaginationConfiguration, "client">): Paginator<ListScheduledReportsCommandOutput>;
|
|
75
125
|
}
|
|
76
126
|
/**
|
|
77
127
|
* <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>
|
|
@@ -8,25 +8,31 @@ import { type DefaultsMode as __DefaultsMode, type SmithyConfiguration as __Smit
|
|
|
8
8
|
import type { AwsCredentialIdentityProvider, BodyLengthCalculator as __BodyLengthCalculator, CheckOptionalClientConfig as __CheckOptionalClientConfig, ChecksumConstructor as __ChecksumConstructor, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@smithy/types";
|
|
9
9
|
import { type HttpAuthSchemeInputConfig, type HttpAuthSchemeResolvedConfig } from "./auth/httpAuthSchemeProvider";
|
|
10
10
|
import type { CreateDashboardCommandInput, CreateDashboardCommandOutput } from "./commands/CreateDashboardCommand";
|
|
11
|
+
import type { CreateScheduledReportCommandInput, CreateScheduledReportCommandOutput } from "./commands/CreateScheduledReportCommand";
|
|
11
12
|
import type { DeleteDashboardCommandInput, DeleteDashboardCommandOutput } from "./commands/DeleteDashboardCommand";
|
|
13
|
+
import type { DeleteScheduledReportCommandInput, DeleteScheduledReportCommandOutput } from "./commands/DeleteScheduledReportCommand";
|
|
14
|
+
import type { ExecuteScheduledReportCommandInput, ExecuteScheduledReportCommandOutput } from "./commands/ExecuteScheduledReportCommand";
|
|
12
15
|
import type { GetDashboardCommandInput, GetDashboardCommandOutput } from "./commands/GetDashboardCommand";
|
|
13
16
|
import type { GetResourcePolicyCommandInput, GetResourcePolicyCommandOutput } from "./commands/GetResourcePolicyCommand";
|
|
17
|
+
import type { GetScheduledReportCommandInput, GetScheduledReportCommandOutput } from "./commands/GetScheduledReportCommand";
|
|
14
18
|
import type { ListDashboardsCommandInput, ListDashboardsCommandOutput } from "./commands/ListDashboardsCommand";
|
|
19
|
+
import type { ListScheduledReportsCommandInput, ListScheduledReportsCommandOutput } from "./commands/ListScheduledReportsCommand";
|
|
15
20
|
import type { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
16
21
|
import type { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
|
|
17
22
|
import type { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
|
|
18
23
|
import type { UpdateDashboardCommandInput, UpdateDashboardCommandOutput } from "./commands/UpdateDashboardCommand";
|
|
24
|
+
import type { UpdateScheduledReportCommandInput, UpdateScheduledReportCommandOutput } from "./commands/UpdateScheduledReportCommand";
|
|
19
25
|
import { type ClientInputEndpointParameters, type ClientResolvedEndpointParameters, type EndpointParameters } from "./endpoint/EndpointParameters";
|
|
20
26
|
import { type RuntimeExtension, type RuntimeExtensionsConfig } from "./runtimeExtensions";
|
|
21
27
|
export { __Client };
|
|
22
28
|
/**
|
|
23
29
|
* @public
|
|
24
30
|
*/
|
|
25
|
-
export type ServiceInputTypes = CreateDashboardCommandInput | DeleteDashboardCommandInput | GetDashboardCommandInput | GetResourcePolicyCommandInput | ListDashboardsCommandInput | ListTagsForResourceCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateDashboardCommandInput;
|
|
31
|
+
export type ServiceInputTypes = CreateDashboardCommandInput | CreateScheduledReportCommandInput | DeleteDashboardCommandInput | DeleteScheduledReportCommandInput | ExecuteScheduledReportCommandInput | GetDashboardCommandInput | GetResourcePolicyCommandInput | GetScheduledReportCommandInput | ListDashboardsCommandInput | ListScheduledReportsCommandInput | ListTagsForResourceCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateDashboardCommandInput | UpdateScheduledReportCommandInput;
|
|
26
32
|
/**
|
|
27
33
|
* @public
|
|
28
34
|
*/
|
|
29
|
-
export type ServiceOutputTypes = CreateDashboardCommandOutput | DeleteDashboardCommandOutput | GetDashboardCommandOutput | GetResourcePolicyCommandOutput | ListDashboardsCommandOutput | ListTagsForResourceCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateDashboardCommandOutput;
|
|
35
|
+
export type ServiceOutputTypes = CreateDashboardCommandOutput | CreateScheduledReportCommandOutput | DeleteDashboardCommandOutput | DeleteScheduledReportCommandOutput | ExecuteScheduledReportCommandOutput | GetDashboardCommandOutput | GetResourcePolicyCommandOutput | GetScheduledReportCommandOutput | ListDashboardsCommandOutput | ListScheduledReportsCommandOutput | ListTagsForResourceCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateDashboardCommandOutput | UpdateScheduledReportCommandOutput;
|
|
30
36
|
/**
|
|
31
37
|
* @public
|
|
32
38
|
*/
|
|
@@ -245,7 +245,7 @@ declare const CreateDashboardCommand_base: {
|
|
|
245
245
|
* <p>An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.</p>
|
|
246
246
|
*
|
|
247
247
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
248
|
-
* <p>The request would exceed service
|
|
248
|
+
* <p>The request would exceed a service quota. Review the service quotas for Amazon Web Services Billing and Cost Management Dashboards and retry your request.</p>
|
|
249
249
|
*
|
|
250
250
|
* @throws {@link ThrottlingException} (client fault)
|
|
251
251
|
* <p>The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.</p>
|
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BCMDashboardsClient";
|
|
4
|
+
import type { CreateScheduledReportRequest, CreateScheduledReportResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link CreateScheduledReportCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface CreateScheduledReportCommandInput extends CreateScheduledReportRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link CreateScheduledReportCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface CreateScheduledReportCommandOutput extends CreateScheduledReportResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const CreateScheduledReportCommand_base: {
|
|
25
|
+
new (input: CreateScheduledReportCommandInput): import("@smithy/smithy-client").CommandImpl<CreateScheduledReportCommandInput, CreateScheduledReportCommandOutput, BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: CreateScheduledReportCommandInput): import("@smithy/smithy-client").CommandImpl<CreateScheduledReportCommandInput, CreateScheduledReportCommandOutput, BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Creates a new scheduled report for a dashboard. A scheduled report automatically generates and delivers dashboard snapshots on a recurring schedule. Reports are delivered within 15 minutes of the scheduled delivery time.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BCMDashboardsClient, CreateScheduledReportCommand } from "@aws-sdk/client-bcm-dashboards"; // ES Modules import
|
|
35
|
+
* // const { BCMDashboardsClient, CreateScheduledReportCommand } = require("@aws-sdk/client-bcm-dashboards"); // CommonJS import
|
|
36
|
+
* // import type { BCMDashboardsClientConfig } from "@aws-sdk/client-bcm-dashboards";
|
|
37
|
+
* const config = {}; // type is BCMDashboardsClientConfig
|
|
38
|
+
* const client = new BCMDashboardsClient(config);
|
|
39
|
+
* const input = { // CreateScheduledReportRequest
|
|
40
|
+
* scheduledReport: { // ScheduledReportInput
|
|
41
|
+
* name: "STRING_VALUE", // required
|
|
42
|
+
* dashboardArn: "STRING_VALUE", // required
|
|
43
|
+
* scheduledReportExecutionRoleArn: "STRING_VALUE", // required
|
|
44
|
+
* scheduleConfig: { // ScheduleConfig
|
|
45
|
+
* scheduleExpression: "STRING_VALUE",
|
|
46
|
+
* scheduleExpressionTimeZone: "STRING_VALUE",
|
|
47
|
+
* schedulePeriod: { // SchedulePeriod
|
|
48
|
+
* startTime: new Date("TIMESTAMP"),
|
|
49
|
+
* endTime: new Date("TIMESTAMP"),
|
|
50
|
+
* },
|
|
51
|
+
* state: "ENABLED" || "DISABLED",
|
|
52
|
+
* },
|
|
53
|
+
* description: "STRING_VALUE",
|
|
54
|
+
* widgetIds: [ // WidgetIdList
|
|
55
|
+
* "STRING_VALUE",
|
|
56
|
+
* ],
|
|
57
|
+
* widgetDateRangeOverride: { // DateTimeRange
|
|
58
|
+
* startTime: { // DateTimeValue
|
|
59
|
+
* type: "ABSOLUTE" || "RELATIVE", // required
|
|
60
|
+
* value: "STRING_VALUE", // required
|
|
61
|
+
* },
|
|
62
|
+
* endTime: {
|
|
63
|
+
* type: "ABSOLUTE" || "RELATIVE", // required
|
|
64
|
+
* value: "STRING_VALUE", // required
|
|
65
|
+
* },
|
|
66
|
+
* },
|
|
67
|
+
* },
|
|
68
|
+
* resourceTags: [ // ResourceTagList
|
|
69
|
+
* { // ResourceTag
|
|
70
|
+
* key: "STRING_VALUE", // required
|
|
71
|
+
* value: "STRING_VALUE", // required
|
|
72
|
+
* },
|
|
73
|
+
* ],
|
|
74
|
+
* clientToken: "STRING_VALUE",
|
|
75
|
+
* };
|
|
76
|
+
* const command = new CreateScheduledReportCommand(input);
|
|
77
|
+
* const response = await client.send(command);
|
|
78
|
+
* // { // CreateScheduledReportResponse
|
|
79
|
+
* // arn: "STRING_VALUE", // required
|
|
80
|
+
* // };
|
|
81
|
+
*
|
|
82
|
+
* ```
|
|
83
|
+
*
|
|
84
|
+
* @param CreateScheduledReportCommandInput - {@link CreateScheduledReportCommandInput}
|
|
85
|
+
* @returns {@link CreateScheduledReportCommandOutput}
|
|
86
|
+
* @see {@link CreateScheduledReportCommandInput} for command's `input` shape.
|
|
87
|
+
* @see {@link CreateScheduledReportCommandOutput} for command's `response` shape.
|
|
88
|
+
* @see {@link BCMDashboardsClientResolvedConfig | config} for BCMDashboardsClient's `config` shape.
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
91
|
+
* <p>You do not have sufficient permissions to perform this action. Verify your IAM permissions and any resource policies.</p>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link ConflictException} (client fault)
|
|
94
|
+
* <p>The request could not be completed due to a conflict with the current state of the resource. For example, attempting to create a resource that already exists or is being created.</p>
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link InternalServerException} (server fault)
|
|
97
|
+
* <p>An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.</p>
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
100
|
+
* <p>The request would exceed a service quota. Review the service quotas for Amazon Web Services Billing and Cost Management Dashboards and retry your request.</p>
|
|
101
|
+
*
|
|
102
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
103
|
+
* <p>The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.</p>
|
|
104
|
+
*
|
|
105
|
+
* @throws {@link ValidationException} (client fault)
|
|
106
|
+
* <p>The input parameters do not satisfy the requirements. Check the error message for specific validation details.</p>
|
|
107
|
+
*
|
|
108
|
+
* @throws {@link BCMDashboardsServiceException}
|
|
109
|
+
* <p>Base exception class for all service exceptions from BCMDashboards service.</p>
|
|
110
|
+
*
|
|
111
|
+
*
|
|
112
|
+
* @public
|
|
113
|
+
*/
|
|
114
|
+
export declare class CreateScheduledReportCommand extends CreateScheduledReportCommand_base {
|
|
115
|
+
/** @internal type navigation helper, not in runtime. */
|
|
116
|
+
protected static __types: {
|
|
117
|
+
api: {
|
|
118
|
+
input: CreateScheduledReportRequest;
|
|
119
|
+
output: CreateScheduledReportResponse;
|
|
120
|
+
};
|
|
121
|
+
sdk: {
|
|
122
|
+
input: CreateScheduledReportCommandInput;
|
|
123
|
+
output: CreateScheduledReportCommandOutput;
|
|
124
|
+
};
|
|
125
|
+
};
|
|
126
|
+
}
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BCMDashboardsClient";
|
|
4
|
+
import type { DeleteScheduledReportRequest, DeleteScheduledReportResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DeleteScheduledReportCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteScheduledReportCommandInput extends DeleteScheduledReportRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteScheduledReportCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteScheduledReportCommandOutput extends DeleteScheduledReportResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeleteScheduledReportCommand_base: {
|
|
25
|
+
new (input: DeleteScheduledReportCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteScheduledReportCommandInput, DeleteScheduledReportCommandOutput, BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: DeleteScheduledReportCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteScheduledReportCommandInput, DeleteScheduledReportCommandOutput, BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Deletes a specified scheduled report. This is an irreversible operation.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BCMDashboardsClient, DeleteScheduledReportCommand } from "@aws-sdk/client-bcm-dashboards"; // ES Modules import
|
|
35
|
+
* // const { BCMDashboardsClient, DeleteScheduledReportCommand } = require("@aws-sdk/client-bcm-dashboards"); // CommonJS import
|
|
36
|
+
* // import type { BCMDashboardsClientConfig } from "@aws-sdk/client-bcm-dashboards";
|
|
37
|
+
* const config = {}; // type is BCMDashboardsClientConfig
|
|
38
|
+
* const client = new BCMDashboardsClient(config);
|
|
39
|
+
* const input = { // DeleteScheduledReportRequest
|
|
40
|
+
* arn: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new DeleteScheduledReportCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // DeleteScheduledReportResponse
|
|
45
|
+
* // arn: "STRING_VALUE", // required
|
|
46
|
+
* // };
|
|
47
|
+
*
|
|
48
|
+
* ```
|
|
49
|
+
*
|
|
50
|
+
* @param DeleteScheduledReportCommandInput - {@link DeleteScheduledReportCommandInput}
|
|
51
|
+
* @returns {@link DeleteScheduledReportCommandOutput}
|
|
52
|
+
* @see {@link DeleteScheduledReportCommandInput} for command's `input` shape.
|
|
53
|
+
* @see {@link DeleteScheduledReportCommandOutput} for command's `response` shape.
|
|
54
|
+
* @see {@link BCMDashboardsClientResolvedConfig | config} for BCMDashboardsClient's `config` shape.
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
57
|
+
* <p>You do not have sufficient permissions to perform this action. Verify your IAM permissions and any resource policies.</p>
|
|
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
|
+
* @public
|
|
76
|
+
*/
|
|
77
|
+
export declare class DeleteScheduledReportCommand extends DeleteScheduledReportCommand_base {
|
|
78
|
+
/** @internal type navigation helper, not in runtime. */
|
|
79
|
+
protected static __types: {
|
|
80
|
+
api: {
|
|
81
|
+
input: DeleteScheduledReportRequest;
|
|
82
|
+
output: DeleteScheduledReportResponse;
|
|
83
|
+
};
|
|
84
|
+
sdk: {
|
|
85
|
+
input: DeleteScheduledReportCommandInput;
|
|
86
|
+
output: DeleteScheduledReportCommandOutput;
|
|
87
|
+
};
|
|
88
|
+
};
|
|
89
|
+
}
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BCMDashboardsClient";
|
|
4
|
+
import type { ExecuteScheduledReportRequest, ExecuteScheduledReportResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ExecuteScheduledReportCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ExecuteScheduledReportCommandInput extends ExecuteScheduledReportRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ExecuteScheduledReportCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ExecuteScheduledReportCommandOutput extends ExecuteScheduledReportResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ExecuteScheduledReportCommand_base: {
|
|
25
|
+
new (input: ExecuteScheduledReportCommandInput): import("@smithy/smithy-client").CommandImpl<ExecuteScheduledReportCommandInput, ExecuteScheduledReportCommandOutput, BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: ExecuteScheduledReportCommandInput): import("@smithy/smithy-client").CommandImpl<ExecuteScheduledReportCommandInput, ExecuteScheduledReportCommandOutput, BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Triggers an immediate execution of a scheduled report, outside of its regular schedule. The scheduled report must be in <code>ENABLED</code> state. Calling this operation on a <code>DISABLED</code> scheduled report returns a <code>ValidationException</code>.</p> <note> <p>If a <code>clientToken</code> is provided, the service uses it for idempotency. Requests with the same client token will not trigger a new execution within the same minute.</p> </note>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BCMDashboardsClient, ExecuteScheduledReportCommand } from "@aws-sdk/client-bcm-dashboards"; // ES Modules import
|
|
35
|
+
* // const { BCMDashboardsClient, ExecuteScheduledReportCommand } = require("@aws-sdk/client-bcm-dashboards"); // CommonJS import
|
|
36
|
+
* // import type { BCMDashboardsClientConfig } from "@aws-sdk/client-bcm-dashboards";
|
|
37
|
+
* const config = {}; // type is BCMDashboardsClientConfig
|
|
38
|
+
* const client = new BCMDashboardsClient(config);
|
|
39
|
+
* const input = { // ExecuteScheduledReportRequest
|
|
40
|
+
* arn: "STRING_VALUE", // required
|
|
41
|
+
* clientToken: "STRING_VALUE",
|
|
42
|
+
* dryRun: true || false,
|
|
43
|
+
* };
|
|
44
|
+
* const command = new ExecuteScheduledReportCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // { // ExecuteScheduledReportResponse
|
|
47
|
+
* // healthStatus: { // HealthStatus
|
|
48
|
+
* // statusCode: "HEALTHY" || "UNHEALTHY", // required
|
|
49
|
+
* // lastRefreshedAt: new Date("TIMESTAMP"),
|
|
50
|
+
* // statusReasons: [ // StatusReasonList
|
|
51
|
+
* // "DATA_SOURCE_ACCESS_DENIED" || "EXECUTION_ROLE_ASSUME_FAILED" || "EXECUTION_ROLE_INSUFFICIENT_PERMISSIONS" || "DASHBOARD_NOT_FOUND" || "DASHBOARD_ACCESS_DENIED" || "INTERNAL_FAILURE" || "WIDGET_ID_NOT_FOUND",
|
|
52
|
+
* // ],
|
|
53
|
+
* // },
|
|
54
|
+
* // executionTriggered: true || false,
|
|
55
|
+
* // };
|
|
56
|
+
*
|
|
57
|
+
* ```
|
|
58
|
+
*
|
|
59
|
+
* @param ExecuteScheduledReportCommandInput - {@link ExecuteScheduledReportCommandInput}
|
|
60
|
+
* @returns {@link ExecuteScheduledReportCommandOutput}
|
|
61
|
+
* @see {@link ExecuteScheduledReportCommandInput} for command's `input` shape.
|
|
62
|
+
* @see {@link ExecuteScheduledReportCommandOutput} 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 ConflictException} (client fault)
|
|
69
|
+
* <p>The request could not be completed due to a conflict with the current state of the resource. For example, attempting to create a resource that already exists or is being created.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link InternalServerException} (server fault)
|
|
72
|
+
* <p>An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
75
|
+
* <p>The specified resource (dashboard, policy, or widget) was not found. Verify the ARN and try again.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
78
|
+
* <p>The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link ValidationException} (client fault)
|
|
81
|
+
* <p>The input parameters do not satisfy the requirements. Check the error message for specific validation details.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link BCMDashboardsServiceException}
|
|
84
|
+
* <p>Base exception class for all service exceptions from BCMDashboards service.</p>
|
|
85
|
+
*
|
|
86
|
+
*
|
|
87
|
+
* @public
|
|
88
|
+
*/
|
|
89
|
+
export declare class ExecuteScheduledReportCommand extends ExecuteScheduledReportCommand_base {
|
|
90
|
+
/** @internal type navigation helper, not in runtime. */
|
|
91
|
+
protected static __types: {
|
|
92
|
+
api: {
|
|
93
|
+
input: ExecuteScheduledReportRequest;
|
|
94
|
+
output: ExecuteScheduledReportResponse;
|
|
95
|
+
};
|
|
96
|
+
sdk: {
|
|
97
|
+
input: ExecuteScheduledReportCommandInput;
|
|
98
|
+
output: ExecuteScheduledReportCommandOutput;
|
|
99
|
+
};
|
|
100
|
+
};
|
|
101
|
+
}
|
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BCMDashboardsClient";
|
|
4
|
+
import type { GetScheduledReportRequest, GetScheduledReportResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetScheduledReportCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetScheduledReportCommandInput extends GetScheduledReportRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetScheduledReportCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetScheduledReportCommandOutput extends GetScheduledReportResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetScheduledReportCommand_base: {
|
|
25
|
+
new (input: GetScheduledReportCommandInput): import("@smithy/smithy-client").CommandImpl<GetScheduledReportCommandInput, GetScheduledReportCommandOutput, BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetScheduledReportCommandInput): import("@smithy/smithy-client").CommandImpl<GetScheduledReportCommandInput, GetScheduledReportCommandOutput, BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves the configuration and metadata of a specified scheduled report.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BCMDashboardsClient, GetScheduledReportCommand } from "@aws-sdk/client-bcm-dashboards"; // ES Modules import
|
|
35
|
+
* // const { BCMDashboardsClient, GetScheduledReportCommand } = require("@aws-sdk/client-bcm-dashboards"); // CommonJS import
|
|
36
|
+
* // import type { BCMDashboardsClientConfig } from "@aws-sdk/client-bcm-dashboards";
|
|
37
|
+
* const config = {}; // type is BCMDashboardsClientConfig
|
|
38
|
+
* const client = new BCMDashboardsClient(config);
|
|
39
|
+
* const input = { // GetScheduledReportRequest
|
|
40
|
+
* arn: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new GetScheduledReportCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // GetScheduledReportResponse
|
|
45
|
+
* // scheduledReport: { // ScheduledReport
|
|
46
|
+
* // arn: "STRING_VALUE",
|
|
47
|
+
* // name: "STRING_VALUE", // required
|
|
48
|
+
* // dashboardArn: "STRING_VALUE", // required
|
|
49
|
+
* // scheduledReportExecutionRoleArn: "STRING_VALUE", // required
|
|
50
|
+
* // scheduleConfig: { // ScheduleConfig
|
|
51
|
+
* // scheduleExpression: "STRING_VALUE",
|
|
52
|
+
* // scheduleExpressionTimeZone: "STRING_VALUE",
|
|
53
|
+
* // schedulePeriod: { // SchedulePeriod
|
|
54
|
+
* // startTime: new Date("TIMESTAMP"),
|
|
55
|
+
* // endTime: new Date("TIMESTAMP"),
|
|
56
|
+
* // },
|
|
57
|
+
* // state: "ENABLED" || "DISABLED",
|
|
58
|
+
* // },
|
|
59
|
+
* // description: "STRING_VALUE",
|
|
60
|
+
* // widgetIds: [ // WidgetIdList
|
|
61
|
+
* // "STRING_VALUE",
|
|
62
|
+
* // ],
|
|
63
|
+
* // widgetDateRangeOverride: { // DateTimeRange
|
|
64
|
+
* // startTime: { // DateTimeValue
|
|
65
|
+
* // type: "ABSOLUTE" || "RELATIVE", // required
|
|
66
|
+
* // value: "STRING_VALUE", // required
|
|
67
|
+
* // },
|
|
68
|
+
* // endTime: {
|
|
69
|
+
* // type: "ABSOLUTE" || "RELATIVE", // required
|
|
70
|
+
* // value: "STRING_VALUE", // required
|
|
71
|
+
* // },
|
|
72
|
+
* // },
|
|
73
|
+
* // createdAt: new Date("TIMESTAMP"),
|
|
74
|
+
* // updatedAt: new Date("TIMESTAMP"),
|
|
75
|
+
* // lastExecutionAt: new Date("TIMESTAMP"),
|
|
76
|
+
* // healthStatus: { // HealthStatus
|
|
77
|
+
* // statusCode: "HEALTHY" || "UNHEALTHY", // required
|
|
78
|
+
* // lastRefreshedAt: new Date("TIMESTAMP"),
|
|
79
|
+
* // statusReasons: [ // StatusReasonList
|
|
80
|
+
* // "DATA_SOURCE_ACCESS_DENIED" || "EXECUTION_ROLE_ASSUME_FAILED" || "EXECUTION_ROLE_INSUFFICIENT_PERMISSIONS" || "DASHBOARD_NOT_FOUND" || "DASHBOARD_ACCESS_DENIED" || "INTERNAL_FAILURE" || "WIDGET_ID_NOT_FOUND",
|
|
81
|
+
* // ],
|
|
82
|
+
* // },
|
|
83
|
+
* // },
|
|
84
|
+
* // };
|
|
85
|
+
*
|
|
86
|
+
* ```
|
|
87
|
+
*
|
|
88
|
+
* @param GetScheduledReportCommandInput - {@link GetScheduledReportCommandInput}
|
|
89
|
+
* @returns {@link GetScheduledReportCommandOutput}
|
|
90
|
+
* @see {@link GetScheduledReportCommandInput} for command's `input` shape.
|
|
91
|
+
* @see {@link GetScheduledReportCommandOutput} for command's `response` shape.
|
|
92
|
+
* @see {@link BCMDashboardsClientResolvedConfig | config} for BCMDashboardsClient's `config` shape.
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
95
|
+
* <p>You do not have sufficient permissions to perform this action. Verify your IAM permissions and any resource policies.</p>
|
|
96
|
+
*
|
|
97
|
+
* @throws {@link InternalServerException} (server fault)
|
|
98
|
+
* <p>An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.</p>
|
|
99
|
+
*
|
|
100
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
101
|
+
* <p>The specified resource (dashboard, policy, or widget) was not found. Verify the ARN and try again.</p>
|
|
102
|
+
*
|
|
103
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
104
|
+
* <p>The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.</p>
|
|
105
|
+
*
|
|
106
|
+
* @throws {@link ValidationException} (client fault)
|
|
107
|
+
* <p>The input parameters do not satisfy the requirements. Check the error message for specific validation details.</p>
|
|
108
|
+
*
|
|
109
|
+
* @throws {@link BCMDashboardsServiceException}
|
|
110
|
+
* <p>Base exception class for all service exceptions from BCMDashboards service.</p>
|
|
111
|
+
*
|
|
112
|
+
*
|
|
113
|
+
* @public
|
|
114
|
+
*/
|
|
115
|
+
export declare class GetScheduledReportCommand extends GetScheduledReportCommand_base {
|
|
116
|
+
/** @internal type navigation helper, not in runtime. */
|
|
117
|
+
protected static __types: {
|
|
118
|
+
api: {
|
|
119
|
+
input: GetScheduledReportRequest;
|
|
120
|
+
output: GetScheduledReportResponse;
|
|
121
|
+
};
|
|
122
|
+
sdk: {
|
|
123
|
+
input: GetScheduledReportCommandInput;
|
|
124
|
+
output: GetScheduledReportCommandOutput;
|
|
125
|
+
};
|
|
126
|
+
};
|
|
127
|
+
}
|