import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { StartDashboardSnapshotJobScheduleRequest, StartDashboardSnapshotJobScheduleResponse } from "../models/models_4"; import type { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link StartDashboardSnapshotJobScheduleCommand}. */ export interface StartDashboardSnapshotJobScheduleCommandInput extends StartDashboardSnapshotJobScheduleRequest { } /** * @public * * The output of {@link StartDashboardSnapshotJobScheduleCommand}. */ export interface StartDashboardSnapshotJobScheduleCommandOutput extends StartDashboardSnapshotJobScheduleResponse, __MetadataBearer { } declare const StartDashboardSnapshotJobScheduleCommand_base: { new (input: StartDashboardSnapshotJobScheduleCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: StartDashboardSnapshotJobScheduleCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Starts an asynchronous job that runs an existing dashboard schedule and sends the dashboard snapshot through email.

*

Only one job can run simultaneously in a given schedule. Repeated requests are skipped with a 202 HTTP status code.

*

For more information, see Scheduling and sending Amazon Quick Sight reports by email and Configuring email report settings for a Amazon Quick Sight dashboard in the Amazon Quick Sight User Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { QuickSightClient, StartDashboardSnapshotJobScheduleCommand } from "@aws-sdk/client-quicksight"; // ES Modules import * // const { QuickSightClient, StartDashboardSnapshotJobScheduleCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import * // import type { QuickSightClientConfig } from "@aws-sdk/client-quicksight"; * const config = {}; // type is QuickSightClientConfig * const client = new QuickSightClient(config); * const input = { // StartDashboardSnapshotJobScheduleRequest * AwsAccountId: "STRING_VALUE", // required * DashboardId: "STRING_VALUE", // required * ScheduleId: "STRING_VALUE", // required * }; * const command = new StartDashboardSnapshotJobScheduleCommand(input); * const response = await client.send(command); * // { // StartDashboardSnapshotJobScheduleResponse * // RequestId: "STRING_VALUE", * // Status: Number("int"), * // }; * * ``` * * @param StartDashboardSnapshotJobScheduleCommandInput - {@link StartDashboardSnapshotJobScheduleCommandInput} * @returns {@link StartDashboardSnapshotJobScheduleCommandOutput} * @see {@link StartDashboardSnapshotJobScheduleCommandInput} for command's `input` shape. * @see {@link StartDashboardSnapshotJobScheduleCommandOutput} for command's `response` shape. * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

You don't have access to this item. The provided credentials couldn't be * validated. You might not be authorized to carry out the request. Make sure that your * account is authorized to use the Amazon Quick Sight service, that your policies have the * correct permissions, and that you are using the correct credentials.

* * @throws {@link InternalFailureException} (server fault) *

An internal failure occurred.

* * @throws {@link InvalidParameterValueException} (client fault) *

One or more parameters has a value that isn't valid.

* * @throws {@link LimitExceededException} (client fault) *

A limit is exceeded.

* * @throws {@link ResourceNotFoundException} (client fault) *

One or more resources can't be found.

* * @throws {@link ThrottlingException} (client fault) *

Access is throttled.

* * @throws {@link UnsupportedUserEditionException} (client fault) *

This error indicates that you are calling an operation on an Amazon Quick Suite * subscription where the edition doesn't include support for that operation. Amazon * Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and * capability is available in every edition.

* * @throws {@link QuickSightServiceException} *

Base exception class for all service exceptions from QuickSight service.

* * * @public */ export declare class StartDashboardSnapshotJobScheduleCommand extends StartDashboardSnapshotJobScheduleCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: StartDashboardSnapshotJobScheduleRequest; output: StartDashboardSnapshotJobScheduleResponse; }; sdk: { input: StartDashboardSnapshotJobScheduleCommandInput; output: StartDashboardSnapshotJobScheduleCommandOutput; }; }; }