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

Starts an Asset Bundle export job.

*

An Asset Bundle export job exports specified Amazon Quick Sight assets. You can also choose to * export any asset dependencies in the same job. Export jobs run asynchronously and can be * polled with a DescribeAssetBundleExportJob API call. When a job is * successfully completed, a download URL that contains the exported assets is returned. The * URL is valid for 5 minutes and can be refreshed with a * DescribeAssetBundleExportJob API call. Each Amazon Quick Sight account can * run up to 5 export jobs concurrently.

*

The API caller must have the necessary permissions in their IAM role to * access each resource before the resources can be exported.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { QuickSightClient, StartAssetBundleExportJobCommand } from "@aws-sdk/client-quicksight"; // ES Modules import * // const { QuickSightClient, StartAssetBundleExportJobCommand } = 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 = { // StartAssetBundleExportJobRequest * AwsAccountId: "STRING_VALUE", // required * AssetBundleExportJobId: "STRING_VALUE", // required * ResourceArns: [ // AssetBundleResourceArns // required * "STRING_VALUE", * ], * IncludeAllDependencies: true || false, * ExportFormat: "CLOUDFORMATION_JSON" || "QUICKSIGHT_JSON", // required * CloudFormationOverridePropertyConfiguration: { // AssetBundleCloudFormationOverridePropertyConfiguration * ResourceIdOverrideConfiguration: { // AssetBundleExportJobResourceIdOverrideConfiguration * PrefixForAllResources: true || false, * }, * VPCConnections: [ // AssetBundleExportJobVPCConnectionOverridePropertiesList * { // AssetBundleExportJobVPCConnectionOverrideProperties * Arn: "STRING_VALUE", // required * Properties: [ // AssetBundleExportJobVPCConnectionPropertyToOverrideList // required * "Name" || "DnsResolvers" || "RoleArn", * ], * }, * ], * RefreshSchedules: [ // AssetBundleExportJobRefreshScheduleOverridePropertiesList * { // AssetBundleExportJobRefreshScheduleOverrideProperties * Arn: "STRING_VALUE", // required * Properties: [ // AssetBundleExportJobRefreshSchedulePropertyToOverrideList // required * "StartAfterDateTime", * ], * }, * ], * DataSources: [ // AssetBundleExportJobDataSourceOverridePropertiesList * { // AssetBundleExportJobDataSourceOverrideProperties * Arn: "STRING_VALUE", // required * Properties: [ // AssetBundleExportJobDataSourcePropertyToOverrideList // required * "Name" || "DisableSsl" || "SecretArn" || "Username" || "Password" || "Domain" || "WorkGroup" || "Host" || "Port" || "Database" || "DataSetName" || "Catalog" || "InstanceId" || "ClusterId" || "ManifestFileLocation" || "Warehouse" || "RoleArn" || "ProductType", * ], * }, * ], * DataSets: [ // AssetBundleExportJobDataSetOverridePropertiesList * { // AssetBundleExportJobDataSetOverrideProperties * Arn: "STRING_VALUE", // required * Properties: [ // AssetBundleExportJobDataSetPropertyToOverrideList // required * "Name" || "RefreshFailureEmailAlertStatus", * ], * }, * ], * Themes: [ // AssetBundleExportJobThemeOverridePropertiesList * { // AssetBundleExportJobThemeOverrideProperties * Arn: "STRING_VALUE", // required * Properties: [ // AssetBundleExportJobThemePropertyToOverrideList // required * "Name", * ], * }, * ], * Analyses: [ // AssetBundleExportJobAnalysisOverridePropertiesList * { // AssetBundleExportJobAnalysisOverrideProperties * Arn: "STRING_VALUE", // required * Properties: [ // AssetBundleExportJobAnalysisPropertyToOverrideList // required * "Name", * ], * }, * ], * Dashboards: [ // AssetBundleExportJobDashboardOverridePropertiesList * { // AssetBundleExportJobDashboardOverrideProperties * Arn: "STRING_VALUE", // required * Properties: [ // AssetBundleExportJobDashboardPropertyToOverrideList // required * "Name", * ], * }, * ], * Folders: [ // AssetBundleExportJobFolderOverridePropertiesList * { // AssetBundleExportJobFolderOverrideProperties * Arn: "STRING_VALUE", // required * Properties: [ // AssetBundleExportJobFolderPropertyToOverrideList // required * "Name" || "ParentFolderArn", * ], * }, * ], * }, * IncludePermissions: true || false, * IncludeTags: true || false, * ValidationStrategy: { // AssetBundleExportJobValidationStrategy * StrictModeForAllResources: true || false, * }, * IncludeFolderMemberships: true || false, * IncludeFolderMembers: "RECURSE" || "ONE_LEVEL" || "NONE", * }; * const command = new StartAssetBundleExportJobCommand(input); * const response = await client.send(command); * // { // StartAssetBundleExportJobResponse * // Arn: "STRING_VALUE", * // AssetBundleExportJobId: "STRING_VALUE", * // RequestId: "STRING_VALUE", * // Status: Number("int"), * // }; * * ``` * * @param StartAssetBundleExportJobCommandInput - {@link StartAssetBundleExportJobCommandInput} * @returns {@link StartAssetBundleExportJobCommandOutput} * @see {@link StartAssetBundleExportJobCommandInput} for command's `input` shape. * @see {@link StartAssetBundleExportJobCommandOutput} 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 ConflictException} (client fault) *

Updating or deleting a resource can cause an inconsistent state.

* * @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 StartAssetBundleExportJobCommand extends StartAssetBundleExportJobCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: StartAssetBundleExportJobRequest; output: StartAssetBundleExportJobResponse; }; sdk: { input: StartAssetBundleExportJobCommandInput; output: StartAssetBundleExportJobCommandOutput; }; }; }