@aws-sdk/client-bcm-dashboards 3.1027.0 → 3.1028.0

package/dist-types/commands/ListScheduledReportsCommand.d.ts

@@ -0,0 +1,107 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BCMDashboardsClient";
+import type { ListScheduledReportsRequest, ListScheduledReportsResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListScheduledReportsCommand}.
+ */
+export interface ListScheduledReportsCommandInput extends ListScheduledReportsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListScheduledReportsCommand}.
+ */
+export interface ListScheduledReportsCommandOutput extends ListScheduledReportsResponse, __MetadataBearer {
+}
+declare const ListScheduledReportsCommand_base: {
+    new (input: ListScheduledReportsCommandInput): import("@smithy/smithy-client").CommandImpl<ListScheduledReportsCommandInput, ListScheduledReportsCommandOutput, BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [ListScheduledReportsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListScheduledReportsCommandInput, ListScheduledReportsCommandOutput, BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Returns a list of scheduled reports in your account.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BCMDashboardsClient, ListScheduledReportsCommand } from "@aws-sdk/client-bcm-dashboards"; // ES Modules import
+ * // const { BCMDashboardsClient, ListScheduledReportsCommand } = require("@aws-sdk/client-bcm-dashboards"); // CommonJS import
+ * // import type { BCMDashboardsClientConfig } from "@aws-sdk/client-bcm-dashboards";
+ * const config = {}; // type is BCMDashboardsClientConfig
+ * const client = new BCMDashboardsClient(config);
+ * const input = { // ListScheduledReportsRequest
+ *   nextToken: "STRING_VALUE",
+ *   maxResults: Number("int"),
+ * };
+ * const command = new ListScheduledReportsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListScheduledReportsResponse
+ * //   scheduledReports: [ // ScheduledReportSummaryList // required
+ * //     { // ScheduledReportSummary
+ * //       arn: "STRING_VALUE", // required
+ * //       name: "STRING_VALUE", // required
+ * //       dashboardArn: "STRING_VALUE", // required
+ * //       scheduleExpression: "STRING_VALUE", // required
+ * //       state: "ENABLED" || "DISABLED", // required
+ * //       healthStatus: { // HealthStatus
+ * //         statusCode: "HEALTHY" || "UNHEALTHY", // required
+ * //         lastRefreshedAt: new Date("TIMESTAMP"),
+ * //         statusReasons: [ // StatusReasonList
+ * //           "DATA_SOURCE_ACCESS_DENIED" || "EXECUTION_ROLE_ASSUME_FAILED" || "EXECUTION_ROLE_INSUFFICIENT_PERMISSIONS" || "DASHBOARD_NOT_FOUND" || "DASHBOARD_ACCESS_DENIED" || "INTERNAL_FAILURE" || "WIDGET_ID_NOT_FOUND",
+ * //         ],
+ * //       },
+ * //       scheduleExpressionTimeZone: "STRING_VALUE",
+ * //       widgetIds: [ // WidgetIdList
+ * //         "STRING_VALUE",
+ * //       ],
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListScheduledReportsCommandInput - {@link ListScheduledReportsCommandInput}
+ * @returns {@link ListScheduledReportsCommandOutput}
+ * @see {@link ListScheduledReportsCommandInput} for command's `input` shape.
+ * @see {@link ListScheduledReportsCommandOutput} for command's `response` shape.
+ * @see {@link BCMDashboardsClientResolvedConfig | config} for BCMDashboardsClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient permissions to perform this action. Verify your IAM permissions and any resource policies.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input parameters do not satisfy the requirements. Check the error message for specific validation details.</p>
+ *
+ * @throws {@link BCMDashboardsServiceException}
+ * <p>Base exception class for all service exceptions from BCMDashboards service.</p>
+ *
+ *
+ * @public
+ */
+export declare class ListScheduledReportsCommand extends ListScheduledReportsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListScheduledReportsRequest;
+            output: ListScheduledReportsResponse;
+        };
+        sdk: {
+            input: ListScheduledReportsCommandInput;
+            output: ListScheduledReportsCommandOutput;
+        };
+    };
+}

package/dist-types/commands/UpdateDashboardCommand.d.ts

@@ -38,7 +38,7 @@ declare const UpdateDashboardCommand_base: {
  * const client = new BCMDashboardsClient(config);
  * const input = { // UpdateDashboardRequest
  *   arn: "STRING_VALUE", // required
- *   name: "STRING_VALUE",
+ *   name: "STRING_VALUE", // required
  *   description: "STRING_VALUE",
  *   widgets: [ // WidgetList
  *     { // Widget

package/dist-types/commands/UpdateScheduledReportCommand.d.ts

@@ -0,0 +1,120 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BCMDashboardsClient";
+import type { UpdateScheduledReportRequest, UpdateScheduledReportResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateScheduledReportCommand}.
+ */
+export interface UpdateScheduledReportCommandInput extends UpdateScheduledReportRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateScheduledReportCommand}.
+ */
+export interface UpdateScheduledReportCommandOutput extends UpdateScheduledReportResponse, __MetadataBearer {
+}
+declare const UpdateScheduledReportCommand_base: {
+    new (input: UpdateScheduledReportCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateScheduledReportCommandInput, UpdateScheduledReportCommandOutput, BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: UpdateScheduledReportCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateScheduledReportCommandInput, UpdateScheduledReportCommandOutput, BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Updates an existing scheduled report's properties, including its name, description, schedule configuration, and widget settings. Only the parameters included in the request are updated; all other properties remain unchanged.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BCMDashboardsClient, UpdateScheduledReportCommand } from "@aws-sdk/client-bcm-dashboards"; // ES Modules import
+ * // const { BCMDashboardsClient, UpdateScheduledReportCommand } = require("@aws-sdk/client-bcm-dashboards"); // CommonJS import
+ * // import type { BCMDashboardsClientConfig } from "@aws-sdk/client-bcm-dashboards";
+ * const config = {}; // type is BCMDashboardsClientConfig
+ * const client = new BCMDashboardsClient(config);
+ * const input = { // UpdateScheduledReportRequest
+ *   arn: "STRING_VALUE", // required
+ *   name: "STRING_VALUE",
+ *   description: "STRING_VALUE",
+ *   dashboardArn: "STRING_VALUE",
+ *   scheduledReportExecutionRoleArn: "STRING_VALUE",
+ *   scheduleConfig: { // ScheduleConfig
+ *     scheduleExpression: "STRING_VALUE",
+ *     scheduleExpressionTimeZone: "STRING_VALUE",
+ *     schedulePeriod: { // SchedulePeriod
+ *       startTime: new Date("TIMESTAMP"),
+ *       endTime: new Date("TIMESTAMP"),
+ *     },
+ *     state: "ENABLED" || "DISABLED",
+ *   },
+ *   widgetIds: [ // WidgetIdList
+ *     "STRING_VALUE",
+ *   ],
+ *   widgetDateRangeOverride: { // DateTimeRange
+ *     startTime: { // DateTimeValue
+ *       type: "ABSOLUTE" || "RELATIVE", // required
+ *       value: "STRING_VALUE", // required
+ *     },
+ *     endTime: {
+ *       type: "ABSOLUTE" || "RELATIVE", // required
+ *       value: "STRING_VALUE", // required
+ *     },
+ *   },
+ *   clearWidgetIds: true || false,
+ *   clearWidgetDateRangeOverride: true || false,
+ * };
+ * const command = new UpdateScheduledReportCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateScheduledReportResponse
+ * //   arn: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateScheduledReportCommandInput - {@link UpdateScheduledReportCommandInput}
+ * @returns {@link UpdateScheduledReportCommandOutput}
+ * @see {@link UpdateScheduledReportCommandInput} for command's `input` shape.
+ * @see {@link UpdateScheduledReportCommandOutput} for command's `response` shape.
+ * @see {@link BCMDashboardsClientResolvedConfig | config} for BCMDashboardsClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient permissions to perform this action. Verify your IAM permissions and any resource policies.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <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>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource (dashboard, policy, or widget) was not found. Verify the ARN and try again.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input parameters do not satisfy the requirements. Check the error message for specific validation details.</p>
+ *
+ * @throws {@link BCMDashboardsServiceException}
+ * <p>Base exception class for all service exceptions from BCMDashboards service.</p>
+ *
+ *
+ * @public
+ */
+export declare class UpdateScheduledReportCommand extends UpdateScheduledReportCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateScheduledReportRequest;
+            output: UpdateScheduledReportResponse;
+        };
+        sdk: {
+            input: UpdateScheduledReportCommandInput;
+            output: UpdateScheduledReportCommandOutput;
+        };
+    };
+}

package/dist-types/commands/index.d.ts

@@ -1,9 +1,15 @@
 export * from "./CreateDashboardCommand";
+export * from "./CreateScheduledReportCommand";
 export * from "./DeleteDashboardCommand";
+export * from "./DeleteScheduledReportCommand";
+export * from "./ExecuteScheduledReportCommand";
 export * from "./GetDashboardCommand";
 export * from "./GetResourcePolicyCommand";
+export * from "./GetScheduledReportCommand";
 export * from "./ListDashboardsCommand";
+export * from "./ListScheduledReportsCommand";
 export * from "./ListTagsForResourceCommand";
 export * from "./TagResourceCommand";
 export * from "./UntagResourceCommand";
 export * from "./UpdateDashboardCommand";
+export * from "./UpdateScheduledReportCommand";

package/dist-types/models/enums.d.ts

@@ -124,6 +124,47 @@ export declare const DateTimeType: {
  * @public
  */
 export type DateTimeType = (typeof DateTimeType)[keyof typeof DateTimeType];
+/**
+ * @public
+ * @enum
+ */
+export declare const ScheduleState: {
+    readonly DISABLED: "DISABLED";
+    readonly ENABLED: "ENABLED";
+};
+/**
+ * @public
+ */
+export type ScheduleState = (typeof ScheduleState)[keyof typeof ScheduleState];
+/**
+ * @public
+ * @enum
+ */
+export declare const HealthStatusCode: {
+    readonly HEALTHY: "HEALTHY";
+    readonly UNHEALTHY: "UNHEALTHY";
+};
+/**
+ * @public
+ */
+export type HealthStatusCode = (typeof HealthStatusCode)[keyof typeof HealthStatusCode];
+/**
+ * @public
+ * @enum
+ */
+export declare const StatusReason: {
+    readonly DASHBOARD_ACCESS_DENIED: "DASHBOARD_ACCESS_DENIED";
+    readonly DASHBOARD_NOT_FOUND: "DASHBOARD_NOT_FOUND";
+    readonly DATA_SOURCE_ACCESS_DENIED: "DATA_SOURCE_ACCESS_DENIED";
+    readonly EXECUTION_ROLE_ASSUME_FAILED: "EXECUTION_ROLE_ASSUME_FAILED";
+    readonly EXECUTION_ROLE_INSUFFICIENT_PERMISSIONS: "EXECUTION_ROLE_INSUFFICIENT_PERMISSIONS";
+    readonly INTERNAL_FAILURE: "INTERNAL_FAILURE";
+    readonly WIDGET_ID_NOT_FOUND: "WIDGET_ID_NOT_FOUND";
+};
+/**
+ * @public
+ */
+export type StatusReason = (typeof StatusReason)[keyof typeof StatusReason];
 /**
  * @public
  * @enum

package/dist-types/models/errors.d.ts

@@ -25,7 +25,7 @@ export declare class InternalServerException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
 }
 /**
- * <p>The request would exceed service quotas. For example, attempting to create more than 20 widgets in a dashboard or exceeding the maximum number of dashboards per account.</p>
+ * <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>
  * @public
  */
 export declare class ServiceQuotaExceededException extends __BaseException {
@@ -60,6 +60,18 @@ export declare class ValidationException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
 }
+/**
+ * <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>
+ * @public
+ */
+export declare class ConflictException extends __BaseException {
+    readonly name: "ConflictException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
+}
 /**
  * <p>The specified resource (dashboard, policy, or widget) was not found. Verify the ARN and try again.</p>
  * @public