@aws-sdk/client-bcm-dashboards 3.1027.0 → 3.1029.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
|
@@ -4,8 +4,11 @@ import {
|
|
|
4
4
|
Dimension,
|
|
5
5
|
Granularity,
|
|
6
6
|
GroupDefinitionType,
|
|
7
|
+
HealthStatusCode,
|
|
7
8
|
MatchOption,
|
|
8
9
|
MetricName,
|
|
10
|
+
ScheduleState,
|
|
11
|
+
StatusReason,
|
|
9
12
|
VisualType,
|
|
10
13
|
} from "./enums";
|
|
11
14
|
export interface ResourceTag {
|
|
@@ -72,12 +75,59 @@ export interface DateTimeRange {
|
|
|
72
75
|
export interface CreateDashboardResponse {
|
|
73
76
|
arn: string | undefined;
|
|
74
77
|
}
|
|
78
|
+
export interface SchedulePeriod {
|
|
79
|
+
startTime?: Date | undefined;
|
|
80
|
+
endTime?: Date | undefined;
|
|
81
|
+
}
|
|
82
|
+
export interface ScheduleConfig {
|
|
83
|
+
scheduleExpression?: string | undefined;
|
|
84
|
+
scheduleExpressionTimeZone?: string | undefined;
|
|
85
|
+
schedulePeriod?: SchedulePeriod | undefined;
|
|
86
|
+
state?: ScheduleState | undefined;
|
|
87
|
+
}
|
|
88
|
+
export interface ScheduledReportInput {
|
|
89
|
+
name: string | undefined;
|
|
90
|
+
dashboardArn: string | undefined;
|
|
91
|
+
scheduledReportExecutionRoleArn: string | undefined;
|
|
92
|
+
scheduleConfig: ScheduleConfig | undefined;
|
|
93
|
+
description?: string | undefined;
|
|
94
|
+
widgetIds?: string[] | undefined;
|
|
95
|
+
widgetDateRangeOverride?: DateTimeRange | undefined;
|
|
96
|
+
}
|
|
97
|
+
export interface CreateScheduledReportRequest {
|
|
98
|
+
scheduledReport: ScheduledReportInput | undefined;
|
|
99
|
+
resourceTags?: ResourceTag[] | undefined;
|
|
100
|
+
clientToken?: string | undefined;
|
|
101
|
+
}
|
|
102
|
+
export interface CreateScheduledReportResponse {
|
|
103
|
+
arn: string | undefined;
|
|
104
|
+
}
|
|
75
105
|
export interface DeleteDashboardRequest {
|
|
76
106
|
arn: string | undefined;
|
|
77
107
|
}
|
|
78
108
|
export interface DeleteDashboardResponse {
|
|
79
109
|
arn: string | undefined;
|
|
80
110
|
}
|
|
111
|
+
export interface DeleteScheduledReportRequest {
|
|
112
|
+
arn: string | undefined;
|
|
113
|
+
}
|
|
114
|
+
export interface DeleteScheduledReportResponse {
|
|
115
|
+
arn: string | undefined;
|
|
116
|
+
}
|
|
117
|
+
export interface ExecuteScheduledReportRequest {
|
|
118
|
+
arn: string | undefined;
|
|
119
|
+
clientToken?: string | undefined;
|
|
120
|
+
dryRun?: boolean | undefined;
|
|
121
|
+
}
|
|
122
|
+
export interface HealthStatus {
|
|
123
|
+
statusCode: HealthStatusCode | undefined;
|
|
124
|
+
lastRefreshedAt?: Date | undefined;
|
|
125
|
+
statusReasons?: StatusReason[] | undefined;
|
|
126
|
+
}
|
|
127
|
+
export interface ExecuteScheduledReportResponse {
|
|
128
|
+
healthStatus?: HealthStatus | undefined;
|
|
129
|
+
executionTriggered?: boolean | undefined;
|
|
130
|
+
}
|
|
81
131
|
export interface GetDashboardRequest {
|
|
82
132
|
arn: string | undefined;
|
|
83
133
|
}
|
|
@@ -88,6 +138,26 @@ export interface GetResourcePolicyResponse {
|
|
|
88
138
|
resourceArn: string | undefined;
|
|
89
139
|
policyDocument: string | undefined;
|
|
90
140
|
}
|
|
141
|
+
export interface GetScheduledReportRequest {
|
|
142
|
+
arn: string | undefined;
|
|
143
|
+
}
|
|
144
|
+
export interface ScheduledReport {
|
|
145
|
+
arn?: string | undefined;
|
|
146
|
+
name: string | undefined;
|
|
147
|
+
dashboardArn: string | undefined;
|
|
148
|
+
scheduledReportExecutionRoleArn: string | undefined;
|
|
149
|
+
scheduleConfig: ScheduleConfig | undefined;
|
|
150
|
+
description?: string | undefined;
|
|
151
|
+
widgetIds?: string[] | undefined;
|
|
152
|
+
widgetDateRangeOverride?: DateTimeRange | undefined;
|
|
153
|
+
createdAt?: Date | undefined;
|
|
154
|
+
updatedAt?: Date | undefined;
|
|
155
|
+
lastExecutionAt?: Date | undefined;
|
|
156
|
+
healthStatus?: HealthStatus | undefined;
|
|
157
|
+
}
|
|
158
|
+
export interface GetScheduledReportResponse {
|
|
159
|
+
scheduledReport: ScheduledReport | undefined;
|
|
160
|
+
}
|
|
91
161
|
export interface ListDashboardsRequest {
|
|
92
162
|
maxResults?: number | undefined;
|
|
93
163
|
nextToken?: string | undefined;
|
|
@@ -104,6 +174,24 @@ export interface ListDashboardsResponse {
|
|
|
104
174
|
dashboards: DashboardReference[] | undefined;
|
|
105
175
|
nextToken?: string | undefined;
|
|
106
176
|
}
|
|
177
|
+
export interface ListScheduledReportsRequest {
|
|
178
|
+
nextToken?: string | undefined;
|
|
179
|
+
maxResults?: number | undefined;
|
|
180
|
+
}
|
|
181
|
+
export interface ScheduledReportSummary {
|
|
182
|
+
arn: string | undefined;
|
|
183
|
+
name: string | undefined;
|
|
184
|
+
dashboardArn: string | undefined;
|
|
185
|
+
scheduleExpression: string | undefined;
|
|
186
|
+
state: ScheduleState | undefined;
|
|
187
|
+
healthStatus: HealthStatus | undefined;
|
|
188
|
+
scheduleExpressionTimeZone?: string | undefined;
|
|
189
|
+
widgetIds?: string[] | undefined;
|
|
190
|
+
}
|
|
191
|
+
export interface ListScheduledReportsResponse {
|
|
192
|
+
scheduledReports: ScheduledReportSummary[] | undefined;
|
|
193
|
+
nextToken?: string | undefined;
|
|
194
|
+
}
|
|
107
195
|
export interface ListTagsForResourceRequest {
|
|
108
196
|
resourceArn: string | undefined;
|
|
109
197
|
}
|
|
@@ -123,6 +211,21 @@ export interface UntagResourceResponse {}
|
|
|
123
211
|
export interface UpdateDashboardResponse {
|
|
124
212
|
arn: string | undefined;
|
|
125
213
|
}
|
|
214
|
+
export interface UpdateScheduledReportRequest {
|
|
215
|
+
arn: string | undefined;
|
|
216
|
+
name?: string | undefined;
|
|
217
|
+
description?: string | undefined;
|
|
218
|
+
dashboardArn?: string | undefined;
|
|
219
|
+
scheduledReportExecutionRoleArn?: string | undefined;
|
|
220
|
+
scheduleConfig?: ScheduleConfig | undefined;
|
|
221
|
+
widgetIds?: string[] | undefined;
|
|
222
|
+
widgetDateRangeOverride?: DateTimeRange | undefined;
|
|
223
|
+
clearWidgetIds?: boolean | undefined;
|
|
224
|
+
clearWidgetDateRangeOverride?: boolean | undefined;
|
|
225
|
+
}
|
|
226
|
+
export interface UpdateScheduledReportResponse {
|
|
227
|
+
arn: string | undefined;
|
|
228
|
+
}
|
|
126
229
|
export interface Expression {
|
|
127
230
|
or?: Expression[] | undefined;
|
|
128
231
|
and?: Expression[] | undefined;
|
|
@@ -258,7 +361,7 @@ export interface GetDashboardResponse {
|
|
|
258
361
|
}
|
|
259
362
|
export interface UpdateDashboardRequest {
|
|
260
363
|
arn: string | undefined;
|
|
261
|
-
name
|
|
364
|
+
name: string | undefined;
|
|
262
365
|
description?: string | undefined;
|
|
263
366
|
widgets?: Widget[] | undefined;
|
|
264
367
|
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { Paginator } from "@smithy/types";
|
|
2
|
+
import {
|
|
3
|
+
ListScheduledReportsCommandInput,
|
|
4
|
+
ListScheduledReportsCommandOutput,
|
|
5
|
+
} from "../commands/ListScheduledReportsCommand";
|
|
6
|
+
import { BCMDashboardsPaginationConfiguration } from "./Interfaces";
|
|
7
|
+
export declare const paginateListScheduledReports: (
|
|
8
|
+
config: BCMDashboardsPaginationConfiguration,
|
|
9
|
+
input: ListScheduledReportsCommandInput,
|
|
10
|
+
...rest: any[]
|
|
11
|
+
) => Paginator<ListScheduledReportsCommandOutput>;
|
|
@@ -7,6 +7,7 @@ import {
|
|
|
7
7
|
} from "@smithy/types";
|
|
8
8
|
export declare var BCMDashboardsServiceException$: StaticErrorSchema;
|
|
9
9
|
export declare var AccessDeniedException$: StaticErrorSchema;
|
|
10
|
+
export declare var ConflictException$: StaticErrorSchema;
|
|
10
11
|
export declare var InternalServerException$: StaticErrorSchema;
|
|
11
12
|
export declare var ResourceNotFoundException$: StaticErrorSchema;
|
|
12
13
|
export declare var ServiceQuotaExceededException$: StaticErrorSchema;
|
|
@@ -17,21 +18,32 @@ export declare var CostAndUsageQuery$: StaticStructureSchema;
|
|
|
17
18
|
export declare var CostCategoryValues$: StaticStructureSchema;
|
|
18
19
|
export declare var CreateDashboardRequest$: StaticStructureSchema;
|
|
19
20
|
export declare var CreateDashboardResponse$: StaticStructureSchema;
|
|
21
|
+
export declare var CreateScheduledReportRequest$: StaticStructureSchema;
|
|
22
|
+
export declare var CreateScheduledReportResponse$: StaticStructureSchema;
|
|
20
23
|
export declare var DashboardReference$: StaticStructureSchema;
|
|
21
24
|
export declare var DateTimeRange$: StaticStructureSchema;
|
|
22
25
|
export declare var DateTimeValue$: StaticStructureSchema;
|
|
23
26
|
export declare var DeleteDashboardRequest$: StaticStructureSchema;
|
|
24
27
|
export declare var DeleteDashboardResponse$: StaticStructureSchema;
|
|
28
|
+
export declare var DeleteScheduledReportRequest$: StaticStructureSchema;
|
|
29
|
+
export declare var DeleteScheduledReportResponse$: StaticStructureSchema;
|
|
25
30
|
export declare var DimensionValues$: StaticStructureSchema;
|
|
31
|
+
export declare var ExecuteScheduledReportRequest$: StaticStructureSchema;
|
|
32
|
+
export declare var ExecuteScheduledReportResponse$: StaticStructureSchema;
|
|
26
33
|
export declare var Expression$: StaticStructureSchema;
|
|
27
34
|
export declare var GetDashboardRequest$: StaticStructureSchema;
|
|
28
35
|
export declare var GetDashboardResponse$: StaticStructureSchema;
|
|
29
36
|
export declare var GetResourcePolicyRequest$: StaticStructureSchema;
|
|
30
37
|
export declare var GetResourcePolicyResponse$: StaticStructureSchema;
|
|
38
|
+
export declare var GetScheduledReportRequest$: StaticStructureSchema;
|
|
39
|
+
export declare var GetScheduledReportResponse$: StaticStructureSchema;
|
|
31
40
|
export declare var GraphDisplayConfig$: StaticStructureSchema;
|
|
32
41
|
export declare var GroupDefinition$: StaticStructureSchema;
|
|
42
|
+
export declare var HealthStatus$: StaticStructureSchema;
|
|
33
43
|
export declare var ListDashboardsRequest$: StaticStructureSchema;
|
|
34
44
|
export declare var ListDashboardsResponse$: StaticStructureSchema;
|
|
45
|
+
export declare var ListScheduledReportsRequest$: StaticStructureSchema;
|
|
46
|
+
export declare var ListScheduledReportsResponse$: StaticStructureSchema;
|
|
35
47
|
export declare var ListTagsForResourceRequest$: StaticStructureSchema;
|
|
36
48
|
export declare var ListTagsForResourceResponse$: StaticStructureSchema;
|
|
37
49
|
export declare var ReservationCoverageQuery$: StaticStructureSchema;
|
|
@@ -39,6 +51,11 @@ export declare var ReservationUtilizationQuery$: StaticStructureSchema;
|
|
|
39
51
|
export declare var ResourceTag$: StaticStructureSchema;
|
|
40
52
|
export declare var SavingsPlansCoverageQuery$: StaticStructureSchema;
|
|
41
53
|
export declare var SavingsPlansUtilizationQuery$: StaticStructureSchema;
|
|
54
|
+
export declare var ScheduleConfig$: StaticStructureSchema;
|
|
55
|
+
export declare var ScheduledReport$: StaticStructureSchema;
|
|
56
|
+
export declare var ScheduledReportInput$: StaticStructureSchema;
|
|
57
|
+
export declare var ScheduledReportSummary$: StaticStructureSchema;
|
|
58
|
+
export declare var SchedulePeriod$: StaticStructureSchema;
|
|
42
59
|
export declare var TableDisplayConfigStruct$: StaticStructureSchema;
|
|
43
60
|
export declare var TagResourceRequest$: StaticStructureSchema;
|
|
44
61
|
export declare var TagResourceResponse$: StaticStructureSchema;
|
|
@@ -47,16 +64,24 @@ export declare var UntagResourceRequest$: StaticStructureSchema;
|
|
|
47
64
|
export declare var UntagResourceResponse$: StaticStructureSchema;
|
|
48
65
|
export declare var UpdateDashboardRequest$: StaticStructureSchema;
|
|
49
66
|
export declare var UpdateDashboardResponse$: StaticStructureSchema;
|
|
67
|
+
export declare var UpdateScheduledReportRequest$: StaticStructureSchema;
|
|
68
|
+
export declare var UpdateScheduledReportResponse$: StaticStructureSchema;
|
|
50
69
|
export declare var Widget$: StaticStructureSchema;
|
|
51
70
|
export declare var WidgetConfig$: StaticStructureSchema;
|
|
52
71
|
export declare var DisplayConfig$: StaticUnionSchema;
|
|
53
72
|
export declare var QueryParameters$: StaticUnionSchema;
|
|
54
73
|
export declare var CreateDashboard$: StaticOperationSchema;
|
|
74
|
+
export declare var CreateScheduledReport$: StaticOperationSchema;
|
|
55
75
|
export declare var DeleteDashboard$: StaticOperationSchema;
|
|
76
|
+
export declare var DeleteScheduledReport$: StaticOperationSchema;
|
|
77
|
+
export declare var ExecuteScheduledReport$: StaticOperationSchema;
|
|
56
78
|
export declare var GetDashboard$: StaticOperationSchema;
|
|
57
79
|
export declare var GetResourcePolicy$: StaticOperationSchema;
|
|
80
|
+
export declare var GetScheduledReport$: StaticOperationSchema;
|
|
58
81
|
export declare var ListDashboards$: StaticOperationSchema;
|
|
82
|
+
export declare var ListScheduledReports$: StaticOperationSchema;
|
|
59
83
|
export declare var ListTagsForResource$: StaticOperationSchema;
|
|
60
84
|
export declare var TagResource$: StaticOperationSchema;
|
|
61
85
|
export declare var UntagResource$: StaticOperationSchema;
|
|
62
86
|
export declare var UpdateDashboard$: StaticOperationSchema;
|
|
87
|
+
export declare var UpdateScheduledReport$: StaticOperationSchema;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-bcm-dashboards",
|
|
3
3
|
"description": "AWS SDK for JavaScript Bcm Dashboards Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.1029.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:types' 'yarn:build:es' && yarn build:cjs",
|
|
7
7
|
"build:cjs": "node ../../scripts/compilation/inline client-bcm-dashboards",
|