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

Starts an Asset Bundle import job.

*

An Asset Bundle import job imports specified Amazon Quick Sight assets into an Amazon Quick * Sight account. You can also choose to import a naming prefix and specified configuration * overrides. The assets that are contained in the bundle file that you provide are used to * create or update a new or existing asset in your Amazon Quick Sight account. Each Amazon * Quick Sight account can run up to 5 import jobs concurrently.

*

The API caller must have the necessary "create", "describe", * and "update" permissions in their IAM role to access each * resource type that is contained in the bundle file before the resources can be * imported.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { QuickSightClient, StartAssetBundleImportJobCommand } from "@aws-sdk/client-quicksight"; // ES Modules import * // const { QuickSightClient, StartAssetBundleImportJobCommand } = 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 = { // StartAssetBundleImportJobRequest * AwsAccountId: "STRING_VALUE", // required * AssetBundleImportJobId: "STRING_VALUE", // required * AssetBundleImportSource: { // AssetBundleImportSource * Body: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("") * S3Uri: "STRING_VALUE", * }, * OverrideParameters: { // AssetBundleImportJobOverrideParameters * ResourceIdOverrideConfiguration: { // AssetBundleImportJobResourceIdOverrideConfiguration * PrefixForAllResources: "STRING_VALUE", * }, * VPCConnections: [ // AssetBundleImportJobVPCConnectionOverrideParametersList * { // AssetBundleImportJobVPCConnectionOverrideParameters * VPCConnectionId: "STRING_VALUE", // required * Name: "STRING_VALUE", * SubnetIds: [ // SubnetIdList * "STRING_VALUE", * ], * SecurityGroupIds: [ // SecurityGroupIdList * "STRING_VALUE", * ], * DnsResolvers: [ // DnsResolverList * "STRING_VALUE", * ], * RoleArn: "STRING_VALUE", * }, * ], * RefreshSchedules: [ // AssetBundleImportJobRefreshScheduleOverrideParametersList * { // AssetBundleImportJobRefreshScheduleOverrideParameters * DataSetId: "STRING_VALUE", // required * ScheduleId: "STRING_VALUE", // required * StartAfterDateTime: new Date("TIMESTAMP"), * }, * ], * DataSources: [ // AssetBundleImportJobDataSourceOverrideParametersList * { // AssetBundleImportJobDataSourceOverrideParameters * DataSourceId: "STRING_VALUE", // required * Name: "STRING_VALUE", * DataSourceParameters: { // DataSourceParameters Union: only one key present * AmazonElasticsearchParameters: { // AmazonElasticsearchParameters * Domain: "STRING_VALUE", // required * }, * AthenaParameters: { // AthenaParameters * WorkGroup: "STRING_VALUE", * RoleArn: "STRING_VALUE", * IdentityCenterConfiguration: { // IdentityCenterConfiguration * EnableIdentityPropagation: true || false, * }, * }, * AuroraParameters: { // AuroraParameters * Host: "STRING_VALUE", // required * Port: Number("int"), // required * Database: "STRING_VALUE", // required * }, * AuroraPostgreSqlParameters: { // AuroraPostgreSqlParameters * Host: "STRING_VALUE", // required * Port: Number("int"), // required * Database: "STRING_VALUE", // required * }, * AwsIotAnalyticsParameters: { // AwsIotAnalyticsParameters * DataSetName: "STRING_VALUE", // required * }, * JiraParameters: { // JiraParameters * SiteBaseUrl: "STRING_VALUE", // required * }, * MariaDbParameters: { // MariaDbParameters * Host: "STRING_VALUE", // required * Port: Number("int"), // required * Database: "STRING_VALUE", // required * }, * MySqlParameters: { // MySqlParameters * Host: "STRING_VALUE", // required * Port: Number("int"), // required * Database: "STRING_VALUE", // required * }, * OracleParameters: { // OracleParameters * Host: "STRING_VALUE", // required * Port: Number("int"), // required * Database: "STRING_VALUE", // required * UseServiceName: true || false, * }, * PostgreSqlParameters: { // PostgreSqlParameters * Host: "STRING_VALUE", // required * Port: Number("int"), // required * Database: "STRING_VALUE", // required * }, * PrestoParameters: { // PrestoParameters * Host: "STRING_VALUE", // required * Port: Number("int"), // required * Catalog: "STRING_VALUE", // required * }, * RdsParameters: { // RdsParameters * InstanceId: "STRING_VALUE", // required * Database: "STRING_VALUE", // required * }, * RedshiftParameters: { // RedshiftParameters * Host: "STRING_VALUE", * Port: Number("int"), * Database: "STRING_VALUE", // required * ClusterId: "STRING_VALUE", * IAMParameters: { // RedshiftIAMParameters * RoleArn: "STRING_VALUE", // required * DatabaseUser: "STRING_VALUE", * DatabaseGroups: [ // DatabaseGroupList * "STRING_VALUE", * ], * AutoCreateDatabaseUser: true || false, * }, * IdentityCenterConfiguration: { * EnableIdentityPropagation: true || false, * }, * }, * S3Parameters: { // S3Parameters * ManifestFileLocation: { // ManifestFileLocation * Bucket: "STRING_VALUE", // required * Key: "STRING_VALUE", // required * }, * RoleArn: "STRING_VALUE", * }, * S3KnowledgeBaseParameters: { // S3KnowledgeBaseParameters * RoleArn: "STRING_VALUE", * BucketUrl: "STRING_VALUE", // required * MetadataFilesLocation: "STRING_VALUE", * }, * ServiceNowParameters: { // ServiceNowParameters * SiteBaseUrl: "STRING_VALUE", // required * }, * SnowflakeParameters: { // SnowflakeParameters * Host: "STRING_VALUE", // required * Database: "STRING_VALUE", // required * Warehouse: "STRING_VALUE", // required * AuthenticationType: "PASSWORD" || "KEYPAIR" || "TOKEN" || "X509", * DatabaseAccessControlRole: "STRING_VALUE", * OAuthParameters: { // OAuthParameters * TokenProviderUrl: "STRING_VALUE", // required * OAuthScope: "STRING_VALUE", * IdentityProviderVpcConnectionProperties: { // VpcConnectionProperties * VpcConnectionArn: "STRING_VALUE", // required * }, * IdentityProviderResourceUri: "STRING_VALUE", * }, * }, * SparkParameters: { // SparkParameters * Host: "STRING_VALUE", // required * Port: Number("int"), // required * }, * SqlServerParameters: { // SqlServerParameters * Host: "STRING_VALUE", // required * Port: Number("int"), // required * Database: "STRING_VALUE", // required * }, * TeradataParameters: { // TeradataParameters * Host: "STRING_VALUE", // required * Port: Number("int"), // required * Database: "STRING_VALUE", // required * }, * TwitterParameters: { // TwitterParameters * Query: "STRING_VALUE", // required * MaxRows: Number("int"), // required * }, * AmazonOpenSearchParameters: { // AmazonOpenSearchParameters * Domain: "STRING_VALUE", // required * }, * ExasolParameters: { // ExasolParameters * Host: "STRING_VALUE", // required * Port: Number("int"), // required * }, * DatabricksParameters: { // DatabricksParameters * Host: "STRING_VALUE", // required * Port: Number("int"), // required * SqlEndpointPath: "STRING_VALUE", // required * }, * StarburstParameters: { // StarburstParameters * Host: "STRING_VALUE", // required * Port: Number("int"), // required * Catalog: "STRING_VALUE", // required * ProductType: "GALAXY" || "ENTERPRISE", * DatabaseAccessControlRole: "STRING_VALUE", * AuthenticationType: "PASSWORD" || "KEYPAIR" || "TOKEN" || "X509", * OAuthParameters: { * TokenProviderUrl: "STRING_VALUE", // required * OAuthScope: "STRING_VALUE", * IdentityProviderVpcConnectionProperties: { * VpcConnectionArn: "STRING_VALUE", // required * }, * IdentityProviderResourceUri: "STRING_VALUE", * }, * }, * TrinoParameters: { // TrinoParameters * Host: "STRING_VALUE", // required * Port: Number("int"), // required * Catalog: "STRING_VALUE", // required * }, * BigQueryParameters: { // BigQueryParameters * ProjectId: "STRING_VALUE", // required * DataSetRegion: "STRING_VALUE", * }, * ImpalaParameters: { // ImpalaParameters * Host: "STRING_VALUE", // required * Port: Number("int"), // required * Database: "STRING_VALUE", * SqlEndpointPath: "STRING_VALUE", // required * }, * CustomConnectionParameters: { // CustomConnectionParameters * ConnectionType: "STRING_VALUE", * }, * WebCrawlerParameters: { // WebCrawlerParameters * WebCrawlerAuthType: "NO_AUTH" || "BASIC_AUTH" || "FORM" || "SAML", // required * UsernameFieldXpath: "STRING_VALUE", * PasswordFieldXpath: "STRING_VALUE", * UsernameButtonXpath: "STRING_VALUE", * PasswordButtonXpath: "STRING_VALUE", * LoginPageUrl: "STRING_VALUE", * WebProxyHostName: "STRING_VALUE", * WebProxyPortNumber: Number("int"), * }, * ConfluenceParameters: { // ConfluenceParameters * ConfluenceUrl: "STRING_VALUE", // required * }, * QBusinessParameters: { // QBusinessParameters * ApplicationArn: "STRING_VALUE", // required * }, * }, * VpcConnectionProperties: { * VpcConnectionArn: "STRING_VALUE", // required * }, * SslProperties: { // SslProperties * DisableSsl: true || false, * }, * Credentials: { // AssetBundleImportJobDataSourceCredentials * CredentialPair: { // AssetBundleImportJobDataSourceCredentialPair * Username: "STRING_VALUE", // required * Password: "STRING_VALUE", // required * }, * SecretArn: "STRING_VALUE", * }, * }, * ], * DataSets: [ // AssetBundleImportJobDataSetOverrideParametersList * { // AssetBundleImportJobDataSetOverrideParameters * DataSetId: "STRING_VALUE", // required * Name: "STRING_VALUE", * DataSetRefreshProperties: { // DataSetRefreshProperties * RefreshConfiguration: { // RefreshConfiguration * IncrementalRefresh: { // IncrementalRefresh * LookbackWindow: { // LookbackWindow * ColumnName: "STRING_VALUE", // required * Size: Number("long"), // required * SizeUnit: "HOUR" || "DAY" || "WEEK", // required * }, * }, * }, * FailureConfiguration: { // RefreshFailureConfiguration * EmailAlert: { // RefreshFailureEmailAlert * AlertStatus: "ENABLED" || "DISABLED", * }, * }, * }, * }, * ], * Themes: [ // AssetBundleImportJobThemeOverrideParametersList * { // AssetBundleImportJobThemeOverrideParameters * ThemeId: "STRING_VALUE", // required * Name: "STRING_VALUE", * }, * ], * Analyses: [ // AssetBundleImportJobAnalysisOverrideParametersList * { // AssetBundleImportJobAnalysisOverrideParameters * AnalysisId: "STRING_VALUE", // required * Name: "STRING_VALUE", * }, * ], * Dashboards: [ // AssetBundleImportJobDashboardOverrideParametersList * { // AssetBundleImportJobDashboardOverrideParameters * DashboardId: "STRING_VALUE", // required * Name: "STRING_VALUE", * }, * ], * Folders: [ // AssetBundleImportJobFolderOverrideParametersList * { // AssetBundleImportJobFolderOverrideParameters * FolderId: "STRING_VALUE", // required * Name: "STRING_VALUE", * ParentFolderArn: "STRING_VALUE", * }, * ], * }, * FailureAction: "DO_NOTHING" || "ROLLBACK", * OverridePermissions: { // AssetBundleImportJobOverridePermissions * DataSources: [ // AssetBundleImportJobDataSourceOverridePermissionsList * { // AssetBundleImportJobDataSourceOverridePermissions * DataSourceIds: [ // AssetBundleRestrictiveResourceIdList // required * "STRING_VALUE", * ], * Permissions: { // AssetBundleResourcePermissions * Principals: [ // AssetBundlePrincipalList // required * "STRING_VALUE", * ], * Actions: [ // ActionList // required * "STRING_VALUE", * ], * }, * }, * ], * DataSets: [ // AssetBundleImportJobDataSetOverridePermissionsList * { // AssetBundleImportJobDataSetOverridePermissions * DataSetIds: [ // required * "STRING_VALUE", * ], * Permissions: { * Principals: [ // required * "STRING_VALUE", * ], * Actions: [ // required * "STRING_VALUE", * ], * }, * }, * ], * Themes: [ // AssetBundleImportJobThemeOverridePermissionsList * { // AssetBundleImportJobThemeOverridePermissions * ThemeIds: [ // required * "STRING_VALUE", * ], * Permissions: { * Principals: [ // required * "STRING_VALUE", * ], * Actions: [ // required * "STRING_VALUE", * ], * }, * }, * ], * Analyses: [ // AssetBundleImportJobAnalysisOverridePermissionsList * { // AssetBundleImportJobAnalysisOverridePermissions * AnalysisIds: [ // required * "STRING_VALUE", * ], * Permissions: { * Principals: [ // required * "STRING_VALUE", * ], * Actions: [ // required * "STRING_VALUE", * ], * }, * }, * ], * Dashboards: [ // AssetBundleImportJobDashboardOverridePermissionsList * { // AssetBundleImportJobDashboardOverridePermissions * DashboardIds: [ // required * "STRING_VALUE", * ], * Permissions: { * Principals: [ // required * "STRING_VALUE", * ], * Actions: [ // required * "STRING_VALUE", * ], * }, * LinkSharingConfiguration: { // AssetBundleResourceLinkSharingConfiguration * Permissions: "", * }, * }, * ], * Folders: [ // AssetBundleImportJobFolderOverridePermissionsList * { // AssetBundleImportJobFolderOverridePermissions * FolderIds: "", // required * Permissions: "", * }, * ], * }, * OverrideTags: { // AssetBundleImportJobOverrideTags * VPCConnections: [ // AssetBundleImportJobVPCConnectionOverrideTagsList * { // AssetBundleImportJobVPCConnectionOverrideTags * VPCConnectionIds: "", // required * Tags: [ // TagList // required * { // Tag * Key: "STRING_VALUE", // required * Value: "STRING_VALUE", // required * }, * ], * }, * ], * DataSources: [ // AssetBundleImportJobDataSourceOverrideTagsList * { // AssetBundleImportJobDataSourceOverrideTags * DataSourceIds: "", // required * Tags: [ // required * { * Key: "STRING_VALUE", // required * Value: "STRING_VALUE", // required * }, * ], * }, * ], * DataSets: [ // AssetBundleImportJobDataSetOverrideTagsList * { // AssetBundleImportJobDataSetOverrideTags * DataSetIds: "", // required * Tags: [ // required * { * Key: "STRING_VALUE", // required * Value: "STRING_VALUE", // required * }, * ], * }, * ], * Themes: [ // AssetBundleImportJobThemeOverrideTagsList * { // AssetBundleImportJobThemeOverrideTags * ThemeIds: "", // required * Tags: [ // required * { * Key: "STRING_VALUE", // required * Value: "STRING_VALUE", // required * }, * ], * }, * ], * Analyses: [ // AssetBundleImportJobAnalysisOverrideTagsList * { // AssetBundleImportJobAnalysisOverrideTags * AnalysisIds: "", // required * Tags: [ // required * { * Key: "STRING_VALUE", // required * Value: "STRING_VALUE", // required * }, * ], * }, * ], * Dashboards: [ // AssetBundleImportJobDashboardOverrideTagsList * { // AssetBundleImportJobDashboardOverrideTags * DashboardIds: "", // required * Tags: "", // required * }, * ], * Folders: [ // AssetBundleImportJobFolderOverrideTagsList * { // AssetBundleImportJobFolderOverrideTags * FolderIds: "", // required * Tags: "", // required * }, * ], * }, * OverrideValidationStrategy: { // AssetBundleImportJobOverrideValidationStrategy * StrictModeForAllResources: true || false, * }, * }; * const command = new StartAssetBundleImportJobCommand(input); * const response = await client.send(command); * // { // StartAssetBundleImportJobResponse * // Arn: "STRING_VALUE", * // AssetBundleImportJobId: "STRING_VALUE", * // RequestId: "STRING_VALUE", * // Status: Number("int"), * // }; * * ``` * * @param StartAssetBundleImportJobCommandInput - {@link StartAssetBundleImportJobCommandInput} * @returns {@link StartAssetBundleImportJobCommandOutput} * @see {@link StartAssetBundleImportJobCommandInput} for command's `input` shape. * @see {@link StartAssetBundleImportJobCommandOutput} 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 StartAssetBundleImportJobCommand extends StartAssetBundleImportJobCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: StartAssetBundleImportJobRequest; output: StartAssetBundleImportJobResponse; }; sdk: { input: StartAssetBundleImportJobCommandInput; output: StartAssetBundleImportJobCommandOutput; }; }; }