QuickSight / Client / start_asset_bundle_export_job

start_asset_bundle_export_job#

QuickSight.Client.start_asset_bundle_export_job(**kwargs)#

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.

Request Syntax

response = client.start_asset_bundle_export_job(
    AwsAccountId='string',
    AssetBundleExportJobId='string',
    ResourceArns=[
        'string',
    ],
    IncludeAllDependencies=True|False,
    ExportFormat='CLOUDFORMATION_JSON'|'QUICKSIGHT_JSON',
    CloudFormationOverridePropertyConfiguration={
        'ResourceIdOverrideConfiguration': {
            'PrefixForAllResources': True|False
        },
        'VPCConnections': [
            {
                'Arn': 'string',
                'Properties': [
                    'Name'|'DnsResolvers'|'RoleArn',
                ]
            },
        ],
        'RefreshSchedules': [
            {
                'Arn': 'string',
                'Properties': [
                    'StartAfterDateTime',
                ]
            },
        ],
        'DataSources': [
            {
                'Arn': 'string',
                'Properties': [
                    'Name'|'DisableSsl'|'SecretArn'|'Username'|'Password'|'Domain'|'WorkGroup'|'Host'|'Port'|'Database'|'DataSetName'|'Catalog'|'InstanceId'|'ClusterId'|'ManifestFileLocation'|'Warehouse'|'RoleArn'|'ProductType',
                ]
            },
        ],
        'DataSets': [
            {
                'Arn': 'string',
                'Properties': [
                    'Name',
                ]
            },
        ],
        'Themes': [
            {
                'Arn': 'string',
                'Properties': [
                    'Name',
                ]
            },
        ],
        'Analyses': [
            {
                'Arn': 'string',
                'Properties': [
                    'Name',
                ]
            },
        ],
        'Dashboards': [
            {
                'Arn': 'string',
                'Properties': [
                    'Name',
                ]
            },
        ],
        'Folders': [
            {
                'Arn': 'string',
                'Properties': [
                    'Name'|'ParentFolderArn',
                ]
            },
        ]
    },
    IncludePermissions=True|False,
    IncludeTags=True|False,
    ValidationStrategy={
        'StrictModeForAllResources': True|False
    },
    IncludeFolderMemberships=True|False,
    IncludeFolderMembers='RECURSE'|'ONE_LEVEL'|'NONE'
)

Parameters:

AwsAccountId (string) –
[REQUIRED]

The ID of the Amazon Web Services account to export assets from.
AssetBundleExportJobId (string) –
[REQUIRED]

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.
ResourceArns (list) –
[REQUIRED]

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.
- (string) –
IncludeAllDependencies (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.
ExportFormat (string) –
[REQUIRED]

The export data format.
CloudFormationOverridePropertyConfiguration (dict) –
An optional collection of structures that generate CloudFormation parameters to override the existing resource property values when the resource is exported to a new CloudFormation template.

Use this field if the ExportFormat field of a StartAssetBundleExportJobRequest API call is set to CLOUDFORMATION_JSON.
- ResourceIdOverrideConfiguration (dict) –
  
  An optional list of structures that control how resource IDs are parameterized in the returned CloudFormation template.
  - PrefixForAllResources (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.
- VPCConnections (list) –
  
  An optional list of structures that control how VPCConnection resources are parameterized in the returned CloudFormation template.
  - (dict) –
    
    Controls how a specific VPCConnection resource is parameterized in the outputted CloudFormation template.
    - Arn (string) – [REQUIRED]
      
      The ARN of the specific VPCConnection resource whose override properties are configured in this structure.
    - Properties (list) – [REQUIRED]
      
      A list of VPCConnection resource properties to generate variables for in the returned CloudFormation template.
      - (string) –
- RefreshSchedules (list) –
  
  An optional list of structures that control how RefreshSchedule resources are parameterized in the returned CloudFormation template.
  - (dict) –
    
    Controls how a specific RefreshSchedule resource is parameterized in the returned CloudFormation template.
    - Arn (string) – [REQUIRED]
      
      The ARN of the specific RefreshSchedule resource whose override properties are configured in this structure.
    - Properties (list) – [REQUIRED]
      
      A list of RefreshSchedule resource properties to generate variables for in the returned CloudFormation template.
      - (string) –
- DataSources (list) –
  
  An optional list of structures that control how DataSource resources are parameterized in the returned CloudFormation template.
  - (dict) –
    
    Controls how a specific DataSource resource is parameterized in the returned CloudFormation template.
    - Arn (string) – [REQUIRED]
      
      The ARN of the specific DataSource resource whose override properties are configured in this structure.
    - Properties (list) – [REQUIRED]
      
      A list of DataSource resource properties to generate variables for in the returned CloudFormation template.
      - (string) –
- DataSets (list) –
  
  An optional list of structures that control how DataSet resources are parameterized in the returned CloudFormation template.
  - (dict) –
    
    Controls how a specific DataSet resource is parameterized in the returned CloudFormation template.
    - Arn (string) – [REQUIRED]
      
      The ARN of the specific DataSet resource whose override properties are configured in this structure.
    - Properties (list) – [REQUIRED]
      
      A list of DataSet resource properties to generate variables for in the returned CloudFormation template.
      - (string) –
- Themes (list) –
  
  An optional list of structures that control how Theme resources are parameterized in the returned CloudFormation template.
  - (dict) –
    
    Controls how a specific Theme resource is parameterized in the returned CloudFormation template.
    - Arn (string) – [REQUIRED]
      
      The ARN of the specific Theme resource whose override properties are configured in this structure.
    - Properties (list) – [REQUIRED]
      
      A list of Theme resource properties to generate variables for in the returned CloudFormation template.
      - (string) –
- Analyses (list) –
  
  An optional list of structures that control how Analysis resources are parameterized in the returned CloudFormation template.
  - (dict) –
    
    Controls how a specific Analysis resource is parameterized in the returned CloudFormation template.
    - Arn (string) – [REQUIRED]
      
      The ARN of the specific Analysis resource whose override properties are configured in this structure.
    - Properties (list) – [REQUIRED]
      
      A list of Analysis resource properties to generate variables for in the returned CloudFormation template.
      - (string) –
- Dashboards (list) –
  
  An optional list of structures that control how Dashboard resources are parameterized in the returned CloudFormation template.
  - (dict) –
    
    Controls how a specific Dashboard resource is parameterized in the returned CloudFormation template.
    - Arn (string) – [REQUIRED]
      
      The ARN of the specific Dashboard resource whose override properties are configured in this structure.
    - Properties (list) – [REQUIRED]
      
      A list of Dashboard resource properties to generate variables for in the returned CloudFormation template.
      - (string) –
- Folders (list) –
  
  An optional list of structures that controls how Folder resources are parameterized in the returned CloudFormation template.
  - (dict) –
    
    Controls how a specific Folder resource is parameterized in the returned CloudFormation template.
    - Arn (string) – [REQUIRED]
      
      The ARN of the specific Folder resource whose override properties are configured in this structure.
    - Properties (list) – [REQUIRED]
      
      A list of Folder resource properties to generate variables for in the returned CloudFormation template.
      - (string) –
IncludePermissions (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.
IncludeTags (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.
ValidationStrategy (dict) –
An optional parameter that determines which validation strategy to use for the export job. If StrictModeForAllResources is set to TRUE, strict validation for every error is enforced. If it is set to FALSE, validation is skipped for specific UI errors that are shown as warnings. The default value for StrictModeForAllResources is FALSE.
- StrictModeForAllResources (boolean) –
  
  A Boolean value that indicates whether to export resources under strict or lenient mode.
IncludeFolderMemberships (boolean) – A Boolean that determines if the exported asset carries over information about the folders that the asset is a member of.
IncludeFolderMembers (string) – A setting that indicates whether you want to include folder assets. You can also use this setting to recusrsively include all subfolders of an exported folder.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'AssetBundleExportJobId': 'string',
    'RequestId': 'string',
    'Status': 123
}

Response Structure

(dict) –
- Arn (string) –
  
  The Amazon Resource Name (ARN) for the export job.
- 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.
- RequestId (string) –
  
  The Amazon Web Services response ID for this operation.
- Status (integer) –
  
  The HTTP status of the response.

Exceptions

QuickSight.Client.exceptions.UnsupportedUserEditionException
QuickSight.Client.exceptions.ThrottlingException
QuickSight.Client.exceptions.InvalidParameterValueException
QuickSight.Client.exceptions.AccessDeniedException
QuickSight.Client.exceptions.LimitExceededException
QuickSight.Client.exceptions.ConflictException
QuickSight.Client.exceptions.ResourceNotFoundException