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 StartAssetBundleExportJob API operation.

Syntax

Start-QSAssetBundleExportJob
-AssetBundleExportJobId <String>
-CloudFormationOverridePropertyConfiguration_Analyses <AssetBundleExportJobAnalysisOverrideProperties[]>
-AwsAccountId <String>
-CloudFormationOverridePropertyConfiguration_Dashboard <AssetBundleExportJobDashboardOverrideProperties[]>
-CloudFormationOverridePropertyConfiguration_DataSet <AssetBundleExportJobDataSetOverrideProperties[]>
-CloudFormationOverridePropertyConfiguration_DataSource <AssetBundleExportJobDataSourceOverrideProperties[]>
-ExportFormat <AssetBundleExportFormat>
-IncludeAllDependency <Boolean>
-IncludePermission <Boolean>
-IncludeTag <Boolean>
-ResourceIdOverrideConfiguration_PrefixForAllResource <Boolean>
-CloudFormationOverridePropertyConfiguration_RefreshSchedule <AssetBundleExportJobRefreshScheduleOverrideProperties[]>
-ResourceArn <String[]>
-ValidationStrategy_StrictModeForAllResource <Boolean>
-CloudFormationOverridePropertyConfiguration_Theme <AssetBundleExportJobThemeOverrideProperties[]>
-CloudFormationOverridePropertyConfiguration_VPCConnection <AssetBundleExportJobVPCConnectionOverrideProperties[]>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonQuickSightConfig>

Description

Starts an Asset Bundle export job. An Asset Bundle export job exports specified Amazon QuickSight 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 QuickSight 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.

Parameters

-AssetBundleExportJobId <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)
-AwsAccountId <String>
The ID of the Amazon Web Services account to export assets from.
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)
-CloudFormationOverridePropertyConfiguration_Analyses <AssetBundleExportJobAnalysisOverrideProperties[]>
An optional list of structures that control how Analysis resources are parameterized in the returned CloudFormation template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CloudFormationOverridePropertyConfiguration_Dashboard <AssetBundleExportJobDashboardOverrideProperties[]>
An optional list of structures that control how Dashboard resources are parameterized in the returned CloudFormation template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCloudFormationOverridePropertyConfiguration_Dashboards
-CloudFormationOverridePropertyConfiguration_DataSet <AssetBundleExportJobDataSetOverrideProperties[]>
An optional list of structures that control how DataSet resources are parameterized in the returned CloudFormation template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCloudFormationOverridePropertyConfiguration_DataSets
-CloudFormationOverridePropertyConfiguration_DataSource <AssetBundleExportJobDataSourceOverrideProperties[]>
An optional list of structures that control how DataSource resources are parameterized in the returned CloudFormation template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCloudFormationOverridePropertyConfiguration_DataSources
-CloudFormationOverridePropertyConfiguration_RefreshSchedule <AssetBundleExportJobRefreshScheduleOverrideProperties[]>
An optional list of structures that control how RefreshSchedule resources are parameterized in the returned CloudFormation template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCloudFormationOverridePropertyConfiguration_RefreshSchedules
-CloudFormationOverridePropertyConfiguration_Theme <AssetBundleExportJobThemeOverrideProperties[]>
An optional list of structures that control how Theme resources are parameterized in the returned CloudFormation template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCloudFormationOverridePropertyConfiguration_Themes
-CloudFormationOverridePropertyConfiguration_VPCConnection <AssetBundleExportJobVPCConnectionOverrideProperties[]>
An optional list of structures that control how VPCConnection resources are parameterized in the returned CloudFormation template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCloudFormationOverridePropertyConfiguration_VPCConnections
-ExportFormat <AssetBundleExportFormat>
The export data format.
Required?True
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)
-IncludeAllDependency <Boolean>
A Boolean that determines whether all dependencies of each resource ARN are recursively exported with the job. For example, say you provided a Dashboard ARN to the ResourceArns parameter. If you set IncludeAllDependencies to TRUE, any theme, dataset, and data source resource that is a dependency of the dashboard is also exported.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesIncludeAllDependencies
-IncludePermission <Boolean>
A Boolean that determines whether all permissions for each resource ARN are exported with the job. If you set IncludePermissions to TRUE, any permissions associated with each resource are exported.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesIncludePermissions
-IncludeTag <Boolean>
A Boolean that determines whether all tags for each resource ARN are exported with the job. If you set IncludeTags to TRUE, any tags associated with each resource are exported.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesIncludeTags
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the AssetBundleExportJobId parameter. The -PassThru parameter is deprecated, use -Select '^AssetBundleExportJobId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ResourceArn <String[]>
An array of resource ARNs to export. The following resources are supported.
  • Analysis
  • Dashboard
  • DataSet
  • DataSource
  • RefreshSchedule
  • Theme
  • VPCConnection
The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceArns
-ResourceIdOverrideConfiguration_PrefixForAllResource <Boolean>
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)
AliasesCloudFormationOverridePropertyConfiguration_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.StartAssetBundleExportJobResponse). Specifying the name of a property of type Amazon.QuickSight.Model.StartAssetBundleExportJobResponse 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)
-ValidationStrategy_StrictModeForAllResource <Boolean>
A Boolean value that indicates whether to export resources under strict or lenient mode.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesValidationStrategy_StrictModeForAllResources

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.StartAssetBundleExportJobResponse
This cmdlet returns an Amazon.QuickSight.Model.StartAssetBundleExportJobResponse 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