@aws-sdk/client-bcm-dashboards 3.870.0

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

@@ -0,0 +1,328 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BCMDashboardsClient";
+import { CreateDashboardRequest, CreateDashboardResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link CreateDashboardCommand}.
+ */
+export interface CreateDashboardCommandInput extends CreateDashboardRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link CreateDashboardCommand}.
+ */
+export interface CreateDashboardCommandOutput extends CreateDashboardResponse, __MetadataBearer {
+}
+declare const CreateDashboardCommand_base: {
+    new (input: CreateDashboardCommandInput): import("@smithy/smithy-client").CommandImpl<CreateDashboardCommandInput, CreateDashboardCommandOutput, BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: CreateDashboardCommandInput): import("@smithy/smithy-client").CommandImpl<CreateDashboardCommandInput, CreateDashboardCommandOutput, BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Creates a new dashboard that can contain multiple widgets displaying cost and usage data. You can add custom widgets or use predefined widgets, arranging them in your preferred layout.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BCMDashboardsClient, CreateDashboardCommand } from "@aws-sdk/client-bcm-dashboards"; // ES Modules import
+ * // const { BCMDashboardsClient, CreateDashboardCommand } = require("@aws-sdk/client-bcm-dashboards"); // CommonJS import
+ * const client = new BCMDashboardsClient(config);
+ * const input = { // CreateDashboardRequest
+ *   name: "STRING_VALUE", // required
+ *   description: "STRING_VALUE",
+ *   widgets: [ // WidgetList // required
+ *     { // Widget
+ *       title: "STRING_VALUE", // required
+ *       description: "STRING_VALUE",
+ *       width: Number("int"),
+ *       height: Number("int"),
+ *       horizontalOffset: Number("int"),
+ *       configs: [ // WidgetConfigList // required
+ *         { // WidgetConfig
+ *           queryParameters: { // QueryParameters Union: only one key present
+ *             costAndUsage: { // CostAndUsageQuery
+ *               metrics: [ // MetricNames // required
+ *                 "AmortizedCost" || "BlendedCost" || "NetAmortizedCost" || "NetUnblendedCost" || "NormalizedUsageAmount" || "UnblendedCost" || "UsageQuantity" || "SpendCoveredBySavingsPlans" || "Hour" || "Unit" || "Cost",
+ *               ],
+ *               timeRange: { // DateTimeRange
+ *                 startTime: { // DateTimeValue
+ *                   type: "ABSOLUTE" || "RELATIVE", // required
+ *                   value: "STRING_VALUE", // required
+ *                 },
+ *                 endTime: {
+ *                   type: "ABSOLUTE" || "RELATIVE", // required
+ *                   value: "STRING_VALUE", // required
+ *                 },
+ *               },
+ *               granularity: "HOURLY" || "DAILY" || "MONTHLY", // required
+ *               groupBy: [ // GroupDefinitions
+ *                 { // GroupDefinition
+ *                   key: "STRING_VALUE", // required
+ *                   type: "DIMENSION" || "TAG" || "COST_CATEGORY",
+ *                 },
+ *               ],
+ *               filter: { // Expression
+ *                 or: [ // Expressions
+ *                   {
+ *                     or: [
+ *                       "<Expression>",
+ *                     ],
+ *                     and: [
+ *                       "<Expression>",
+ *                     ],
+ *                     not: "<Expression>",
+ *                     dimensions: { // DimensionValues
+ *                       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
+ *                       values: [ // StringList // required
+ *                         "STRING_VALUE",
+ *                       ],
+ *                       matchOptions: [ // MatchOptions
+ *                         "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "GREATER_THAN_OR_EQUAL" || "CASE_SENSITIVE" || "CASE_INSENSITIVE",
+ *                       ],
+ *                     },
+ *                     tags: { // TagValues
+ *                       key: "STRING_VALUE",
+ *                       values: [
+ *                         "STRING_VALUE",
+ *                       ],
+ *                       matchOptions: [
+ *                         "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "GREATER_THAN_OR_EQUAL" || "CASE_SENSITIVE" || "CASE_INSENSITIVE",
+ *                       ],
+ *                     },
+ *                     costCategories: { // CostCategoryValues
+ *                       key: "STRING_VALUE",
+ *                       values: [
+ *                         "STRING_VALUE",
+ *                       ],
+ *                       matchOptions: [
+ *                         "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "GREATER_THAN_OR_EQUAL" || "CASE_SENSITIVE" || "CASE_INSENSITIVE",
+ *                       ],
+ *                     },
+ *                   },
+ *                 ],
+ *                 and: [
+ *                   "<Expression>",
+ *                 ],
+ *                 not: "<Expression>",
+ *                 dimensions: {
+ *                   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
+ *                   values: [ // required
+ *                     "STRING_VALUE",
+ *                   ],
+ *                   matchOptions: [
+ *                     "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "GREATER_THAN_OR_EQUAL" || "CASE_SENSITIVE" || "CASE_INSENSITIVE",
+ *                   ],
+ *                 },
+ *                 tags: {
+ *                   key: "STRING_VALUE",
+ *                   values: [
+ *                     "STRING_VALUE",
+ *                   ],
+ *                   matchOptions: [
+ *                     "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "GREATER_THAN_OR_EQUAL" || "CASE_SENSITIVE" || "CASE_INSENSITIVE",
+ *                   ],
+ *                 },
+ *                 costCategories: {
+ *                   key: "STRING_VALUE",
+ *                   values: "<StringList>",
+ *                   matchOptions: "<MatchOptions>",
+ *                 },
+ *               },
+ *             },
+ *             savingsPlansCoverage: { // SavingsPlansCoverageQuery
+ *               timeRange: {
+ *                 startTime: {
+ *                   type: "ABSOLUTE" || "RELATIVE", // required
+ *                   value: "STRING_VALUE", // required
+ *                 },
+ *                 endTime: {
+ *                   type: "ABSOLUTE" || "RELATIVE", // required
+ *                   value: "STRING_VALUE", // required
+ *                 },
+ *               },
+ *               metrics: [
+ *                 "AmortizedCost" || "BlendedCost" || "NetAmortizedCost" || "NetUnblendedCost" || "NormalizedUsageAmount" || "UnblendedCost" || "UsageQuantity" || "SpendCoveredBySavingsPlans" || "Hour" || "Unit" || "Cost",
+ *               ],
+ *               granularity: "HOURLY" || "DAILY" || "MONTHLY",
+ *               groupBy: [
+ *                 {
+ *                   key: "STRING_VALUE", // required
+ *                   type: "DIMENSION" || "TAG" || "COST_CATEGORY",
+ *                 },
+ *               ],
+ *               filter: "<Expression>",
+ *             },
+ *             savingsPlansUtilization: { // SavingsPlansUtilizationQuery
+ *               timeRange: {
+ *                 startTime: {
+ *                   type: "ABSOLUTE" || "RELATIVE", // required
+ *                   value: "STRING_VALUE", // required
+ *                 },
+ *                 endTime: "<DateTimeValue>", // required
+ *               },
+ *               granularity: "HOURLY" || "DAILY" || "MONTHLY",
+ *               filter: "<Expression>",
+ *             },
+ *             reservationCoverage: { // ReservationCoverageQuery
+ *               timeRange: {
+ *                 startTime: "<DateTimeValue>", // required
+ *                 endTime: "<DateTimeValue>", // required
+ *               },
+ *               groupBy: [
+ *                 {
+ *                   key: "STRING_VALUE", // required
+ *                   type: "DIMENSION" || "TAG" || "COST_CATEGORY",
+ *                 },
+ *               ],
+ *               granularity: "HOURLY" || "DAILY" || "MONTHLY",
+ *               filter: "<Expression>",
+ *               metrics: [
+ *                 "AmortizedCost" || "BlendedCost" || "NetAmortizedCost" || "NetUnblendedCost" || "NormalizedUsageAmount" || "UnblendedCost" || "UsageQuantity" || "SpendCoveredBySavingsPlans" || "Hour" || "Unit" || "Cost",
+ *               ],
+ *             },
+ *             reservationUtilization: { // ReservationUtilizationQuery
+ *               timeRange: {
+ *                 startTime: "<DateTimeValue>", // required
+ *                 endTime: "<DateTimeValue>", // required
+ *               },
+ *               groupBy: [
+ *                 {
+ *                   key: "STRING_VALUE", // required
+ *                   type: "DIMENSION" || "TAG" || "COST_CATEGORY",
+ *                 },
+ *               ],
+ *               granularity: "HOURLY" || "DAILY" || "MONTHLY",
+ *               filter: "<Expression>",
+ *             },
+ *           },
+ *           displayConfig: { // DisplayConfig Union: only one key present
+ *             graph: { // GraphDisplayConfigMap
+ *               "<keys>": { // GraphDisplayConfig
+ *                 visualType: "LINE" || "BAR" || "STACK", // required
+ *               },
+ *             },
+ *             table: {},
+ *           },
+ *         },
+ *       ],
+ *     },
+ *   ],
+ *   resourceTags: [ // ResourceTagList
+ *     { // ResourceTag
+ *       key: "STRING_VALUE", // required
+ *       value: "STRING_VALUE", // required
+ *     },
+ *   ],
+ * };
+ * const command = new CreateDashboardCommand(input);
+ * const response = await client.send(command);
+ * // { // CreateDashboardResponse
+ * //   arn: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param CreateDashboardCommandInput - {@link CreateDashboardCommandInput}
+ * @returns {@link CreateDashboardCommandOutput}
+ * @see {@link CreateDashboardCommandInput} for command's `input` shape.
+ * @see {@link CreateDashboardCommandOutput} 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 ServiceQuotaExceededException} (client fault)
+ *  <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>
+ *
+ * @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>
+ *
+ *
+ * @example Creating a dashboard
+ * ```javascript
+ * //
+ * const input = {
+ *   description: "Dashboard for tracking costs",
+ *   name: "cost-dashboards",
+ *   widgets: [
+ *     {
+ *       configs: [
+ *         {
+ *           displayConfig: {
+ *             graph: {
+ *               costTrend: {
+ *                 visualType: "LINE"
+ *               }
+ *             }
+ *           },
+ *           queryParameters: {
+ *             costAndUsage: {
+ *               granularity: "MONTHLY",
+ *               groupBy: [
+ *                 {
+ *                   key: "SERVICE",
+ *                   type: "DIMENSION"
+ *                 }
+ *               ],
+ *               metrics: [
+ *                 "UnblendedCost"
+ *               ],
+ *               timeRange: {
+ *                 endTime: {
+ *                   type: "RELATIVE",
+ *                   value: "now"
+ *                 },
+ *                 startTime: {
+ *                   type: "RELATIVE",
+ *                   value: "-9M"
+ *                 }
+ *               }
+ *             }
+ *           }
+ *         }
+ *       ],
+ *       height: 7,
+ *       horizontalOffset: 0,
+ *       title: "Monthly Cost Trend",
+ *       width: 4
+ *     }
+ *   ]
+ * };
+ * const command = new CreateDashboardCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class CreateDashboardCommand extends CreateDashboardCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: CreateDashboardRequest;
+            output: CreateDashboardResponse;
+        };
+        sdk: {
+            input: CreateDashboardCommandInput;
+            output: CreateDashboardCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,99 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BCMDashboardsClient";
+import { DeleteDashboardRequest, DeleteDashboardResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link DeleteDashboardCommand}.
+ */
+export interface DeleteDashboardCommandInput extends DeleteDashboardRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link DeleteDashboardCommand}.
+ */
+export interface DeleteDashboardCommandOutput extends DeleteDashboardResponse, __MetadataBearer {
+}
+declare const DeleteDashboardCommand_base: {
+    new (input: DeleteDashboardCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteDashboardCommandInput, DeleteDashboardCommandOutput, BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: DeleteDashboardCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteDashboardCommandInput, DeleteDashboardCommandOutput, BCMDashboardsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Deletes a specified dashboard. This action cannot be undone.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BCMDashboardsClient, DeleteDashboardCommand } from "@aws-sdk/client-bcm-dashboards"; // ES Modules import
+ * // const { BCMDashboardsClient, DeleteDashboardCommand } = require("@aws-sdk/client-bcm-dashboards"); // CommonJS import
+ * const client = new BCMDashboardsClient(config);
+ * const input = { // DeleteDashboardRequest
+ *   arn: "STRING_VALUE", // required
+ * };
+ * const command = new DeleteDashboardCommand(input);
+ * const response = await client.send(command);
+ * // { // DeleteDashboardResponse
+ * //   arn: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param DeleteDashboardCommandInput - {@link DeleteDashboardCommandInput}
+ * @returns {@link DeleteDashboardCommandOutput}
+ * @see {@link DeleteDashboardCommandInput} for command's `input` shape.
+ * @see {@link DeleteDashboardCommandOutput} 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>
+ *
+ *
+ * @example Deleting a dashboard
+ * ```javascript
+ * //
+ * const input = {
+ *   arn: "arn:aws:bcm-dashboards::123456789012:dashboard/abcd1234-ab12-12ab-1ab2-abcd1234efgh"
+ * };
+ * const command = new DeleteDashboardCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   arn: "arn:aws:bcm-dashboards::123456789012:dashboard/abcd1234-ab12-12ab-1ab2-abcd1234efgh"
+ * }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class DeleteDashboardCommand extends DeleteDashboardCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: DeleteDashboardRequest;
+            output: DeleteDashboardResponse;
+        };
+        sdk: {
+            input: DeleteDashboardCommandInput;
+            output: DeleteDashboardCommandOutput;
+        };
+    };
+}