AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon QuickSight StartAssetBundleImportJob API operation.

Syntax

Start-QSAssetBundleImportJob
-AssetBundleImportJobId <String>
-OverrideParameters_Analyses <AssetBundleImportJobAnalysisOverrideParameters[]>
-AwsAccountId <String>
-AssetBundleImportSource_Body <Byte[]>
-OverrideParameters_Dashboard <AssetBundleImportJobDashboardOverrideParameters[]>
-OverrideParameters_DataSet <AssetBundleImportJobDataSetOverrideParameters[]>
-OverrideParameters_DataSource <AssetBundleImportJobDataSourceOverrideParameters[]>
-FailureAction <AssetBundleImportFailureAction>
-ResourceIdOverrideConfiguration_PrefixForAllResource <String>
-OverrideParameters_RefreshSchedule <AssetBundleImportJobRefreshScheduleOverrideParameters[]>
-AssetBundleImportSource_S3Uri <String>
-OverrideParameters_Theme <AssetBundleImportJobThemeOverrideParameters[]>
-OverrideParameters_VPCConnection <AssetBundleImportJobVPCConnectionOverrideParameters[]>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonQuickSightConfig>

Description

Starts an Asset Bundle import job. An Asset Bundle import job imports specified Amazon QuickSight assets into an Amazon QuickSight 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 QuickSight account. Each Amazon QuickSight 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.

Parameters

-AssetBundleImportJobId <String>
The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-AssetBundleImportSource_Body <Byte[]>
The bytes of the base64 encoded asset bundle import zip file. This file can't exceed 20 MB.If you are calling the API operations from the Amazon Web Services SDK for Java, JavaScript, Python, or PHP, the SDK encodes base64 automatically to allow the direct setting of the zip file's bytes. If you are using an SDK for a different language or receiving related errors, try to base64 encode your data.The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AssetBundleImportSource_S3Uri <String>
The Amazon S3 URI for an asset bundle import file that exists in an Amazon S3 bucket that the caller has read access to. The file must be a zip format file and can't exceed 20 MB.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AwsAccountId <String>
The ID of the Amazon Web Services account to import assets into.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonQuickSightConfig>
Amazon.PowerShell.Cmdlets.QS.AmazonQuickSightClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FailureAction <AssetBundleImportFailureAction>
The failure action for the import job.If you choose ROLLBACK, failed import jobs will attempt to undo any asset changes caused by the failed job.If you choose DO_NOTHING, failed import jobs will not attempt to roll back any asset changes caused by the failed job, possibly keeping the Amazon QuickSight account in an inconsistent state.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OverrideParameters_Analyses <AssetBundleImportJobAnalysisOverrideParameters[]>
A list of overrides for any Analysis resources that are present in the asset bundle that is imported.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OverrideParameters_Dashboard <AssetBundleImportJobDashboardOverrideParameters[]>
A list of overrides for any Dashboard resources that are present in the asset bundle that is imported.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOverrideParameters_Dashboards
-OverrideParameters_DataSet <AssetBundleImportJobDataSetOverrideParameters[]>
A list of overrides for any DataSet resources that are present in the asset bundle that is imported.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOverrideParameters_DataSets
-OverrideParameters_DataSource <AssetBundleImportJobDataSourceOverrideParameters[]>
A list of overrides for any DataSource resources that are present in the asset bundle that is imported.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOverrideParameters_DataSources
-OverrideParameters_RefreshSchedule <AssetBundleImportJobRefreshScheduleOverrideParameters[]>
A list of overrides for any RefreshSchedule resources that are present in the asset bundle that is imported.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOverrideParameters_RefreshSchedules
-OverrideParameters_Theme <AssetBundleImportJobThemeOverrideParameters[]>
A list of overrides for any Theme resources that are present in the asset bundle that is imported.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOverrideParameters_Themes
-OverrideParameters_VPCConnection <AssetBundleImportJobVPCConnectionOverrideParameters[]>
A list of overrides for any VPCConnection resources that are present in the asset bundle that is imported.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOverrideParameters_VPCConnections
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the AssetBundleImportJobId parameter. The -PassThru parameter is deprecated, use -Select '^AssetBundleImportJobId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ResourceIdOverrideConfiguration_PrefixForAllResource <String>
An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOverrideParameters_ResourceIdOverrideConfiguration_PrefixForAllResources
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.StartAssetBundleImportJobResponse). Specifying the name of a property of type Amazon.QuickSight.Model.StartAssetBundleImportJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.QuickSight.Model.StartAssetBundleImportJobResponse
This cmdlet returns an Amazon.QuickSight.Model.StartAssetBundleImportJobResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z