import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribeDashboardSnapshotJobRequest, DescribeDashboardSnapshotJobResponse } from "../models/models_3"; import type { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link DescribeDashboardSnapshotJobCommand}. */ export interface DescribeDashboardSnapshotJobCommandInput extends DescribeDashboardSnapshotJobRequest { } /** * @public * * The output of {@link DescribeDashboardSnapshotJobCommand}. */ export interface DescribeDashboardSnapshotJobCommandOutput extends DescribeDashboardSnapshotJobResponse, __MetadataBearer { } declare const DescribeDashboardSnapshotJobCommand_base: { new (input: DescribeDashboardSnapshotJobCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: DescribeDashboardSnapshotJobCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Describes an existing snapshot job.

*

Poll job descriptions after a job starts to know the status of the job. For information on available status codes, see JobStatus.

*

* Registered user support *

*

This API can be called as before to get status of a job started by the same Quick Sight user.

*

* Possible error scenarios *

*

Request will fail with an Access Denied error in the following scenarios:

* * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { QuickSightClient, DescribeDashboardSnapshotJobCommand } from "@aws-sdk/client-quicksight"; // ES Modules import * // const { QuickSightClient, DescribeDashboardSnapshotJobCommand } = 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 = { // DescribeDashboardSnapshotJobRequest * AwsAccountId: "STRING_VALUE", // required * DashboardId: "STRING_VALUE", // required * SnapshotJobId: "STRING_VALUE", // required * }; * const command = new DescribeDashboardSnapshotJobCommand(input); * const response = await client.send(command); * // { // DescribeDashboardSnapshotJobResponse * // AwsAccountId: "STRING_VALUE", * // DashboardId: "STRING_VALUE", * // SnapshotJobId: "STRING_VALUE", * // UserConfiguration: { // SnapshotUserConfigurationRedacted * // AnonymousUsers: [ // SnapshotAnonymousUserRedactedList * // { // SnapshotAnonymousUserRedacted * // RowLevelPermissionTagKeys: [ // SessionTagKeyList * // "STRING_VALUE", * // ], * // }, * // ], * // }, * // SnapshotConfiguration: { // SnapshotConfiguration * // FileGroups: [ // SnapshotFileGroupList // required * // { // SnapshotFileGroup * // Files: [ // SnapshotFileList * // { // SnapshotFile * // SheetSelections: [ // SnapshotFileSheetSelectionList // required * // { // SnapshotFileSheetSelection * // SheetId: "STRING_VALUE", // required * // SelectionScope: "ALL_VISUALS" || "SELECTED_VISUALS", // required * // VisualIds: [ // SnapshotFileSheetSelectionVisualIdList * // "STRING_VALUE", * // ], * // }, * // ], * // FormatType: "CSV" || "PDF" || "EXCEL", // required * // }, * // ], * // }, * // ], * // DestinationConfiguration: { // SnapshotDestinationConfiguration * // S3Destinations: [ // SnapshotS3DestinationConfigurationList * // { // SnapshotS3DestinationConfiguration * // BucketConfiguration: { // S3BucketConfiguration * // BucketName: "STRING_VALUE", // required * // BucketPrefix: "STRING_VALUE", // required * // BucketRegion: "STRING_VALUE", // required * // }, * // }, * // ], * // }, * // Parameters: { // Parameters * // StringParameters: [ // StringParameterList * // { // StringParameter * // Name: "STRING_VALUE", // required * // Values: [ // SensitiveStringList // required * // "STRING_VALUE", * // ], * // }, * // ], * // IntegerParameters: [ // IntegerParameterList * // { // IntegerParameter * // Name: "STRING_VALUE", // required * // Values: [ // SensitiveLongList // required * // Number("long"), * // ], * // }, * // ], * // DecimalParameters: [ // DecimalParameterList * // { // DecimalParameter * // Name: "STRING_VALUE", // required * // Values: [ // SensitiveDoubleList // required * // Number("double"), * // ], * // }, * // ], * // DateTimeParameters: [ // DateTimeParameterList * // { // DateTimeParameter * // Name: "STRING_VALUE", // required * // Values: [ // SensitiveTimestampList // required * // new Date("TIMESTAMP"), * // ], * // }, * // ], * // }, * // }, * // Arn: "STRING_VALUE", * // JobStatus: "QUEUED" || "RUNNING" || "COMPLETED" || "FAILED", * // CreatedTime: new Date("TIMESTAMP"), * // LastUpdatedTime: new Date("TIMESTAMP"), * // RequestId: "STRING_VALUE", * // Status: Number("int"), * // }; * * ``` * * @param DescribeDashboardSnapshotJobCommandInput - {@link DescribeDashboardSnapshotJobCommandInput} * @returns {@link DescribeDashboardSnapshotJobCommandOutput} * @see {@link DescribeDashboardSnapshotJobCommandInput} for command's `input` shape. * @see {@link DescribeDashboardSnapshotJobCommandOutput} 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 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 DescribeDashboardSnapshotJobCommand extends DescribeDashboardSnapshotJobCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeDashboardSnapshotJobRequest; output: DescribeDashboardSnapshotJobResponse; }; sdk: { input: DescribeDashboardSnapshotJobCommandInput; output: DescribeDashboardSnapshotJobCommandOutput; }; }; }