asset_bundle_export_jobs

Creates, updates, deletes, gets or lists an asset_bundle_export_jobs resource.

Overview

Name	asset_bundle_export_jobs
Type	Resource
Id	aws.quicksight.asset_bundle_export_jobs

Fields

The following fields are returned by SELECT queries:

describe_asset_bundle_export_job

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) for the export job.
asset_bundle_export_job_id	string	The ID of the job. The job ID is set when you start a new job with a StartAssetBundleExportJob API call. (pattern: <code>[\w-]+</code>)
aws_account_id	string	The ID of the Amazon Web Services account that the export job was executed in. (pattern: <code>^[0-9]{12}$</code>)
cloud_formation_override_property_configuration	object	The CloudFormation override property configuration for the export job.
created_time	string (date-time)	The time that the export job was created.
download_url	string	The URL to download the exported asset bundle data from. This URL is available only after the job has succeeded. This URL is valid for 5 minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if needed. The downloaded asset bundle is a zip file named assetbundle-{jobId}.qs. The file has a .qs extension. This URL can't be used in a StartAssetBundleImportJob API call and should only be used for download purposes. (pattern: <code>^(https|s3):​//([^/]+)/?(.*)$</code>)
errors	array	An array of error records that describes any failures that occurred during the export job processing. Error records accumulate while the job runs. The complete set of error records is available after the job has completed and failed.
export_format	string	The format of the exported asset bundle. A QUICKSIGHT_JSON formatted file can be used to make a StartAssetBundleImportJob API call. A CLOUDFORMATION_JSON formatted file can be used in the CloudFormation console and with the CloudFormation APIs. (CLOUDFORMATION_JSON, QUICKSIGHT_JSON)
include_all_dependencies	boolean	The include dependencies flag.
include_folder_members	string	A setting that determines whether folder members are included. (RECURSE, ONE_LEVEL, NONE)
include_folder_memberships	boolean	The include folder memberships flag.
include_permissions	boolean	The include permissions flag.
include_tags	boolean	The include tags flag.
job_status	string	Indicates the status of a job through its queuing and execution. Poll this DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or FAILED. (QUEUED_FOR_IMMEDIATE_EXECUTION, IN_PROGRESS, SUCCESSFUL, FAILED)
request_id	string	The Amazon Web Services request ID for this operation. (pattern: <code>.\S.</code>)
resource_arns	array	A list of resource ARNs that exported with the job.
status	integer	The HTTP status of the response.
validation_strategy	object	The validation strategy that is used to export the analysis or dashboard.
warnings	array	An array of warning records that describe the analysis or dashboard that is exported. This array includes UI errors that can be skipped during the validation process. This property only appears if StrictModeForAllResources in ValidationStrategy is set to FALSE.

list_asset_bundle_export_jobs

Name	Datatype	Description
arn	string	The ARN of the export job.
asset_bundle_export_job_id	string	The ID of the export job. (pattern: <code>[\w-]+</code>)
created_time	string (date-time)	The time that the export job was created.
export_format	string	The format for the export job. (CLOUDFORMATION_JSON, QUICKSIGHT_JSON)
include_all_dependencies	boolean	The flag that determines the inclusion of resource dependencies in the returned asset bundle.
include_permissions	boolean	The flag that determines the inclusion of permissions associated with each resource ARN.
include_tags	boolean	The flag that determines the inclusion of tags associated with each resource ARN.
job_status	string	The current status of the export job. (QUEUED_FOR_IMMEDIATE_EXECUTION, IN_PROGRESS, SUCCESSFUL, FAILED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_asset_bundle_export_job	select	aws_account_id, asset_bundle_export_job_id, region		Describes an existing export job. Poll job descriptions after a job starts to know the status of the job. When a job succeeds, a URL is provided to download the exported assets' data from. Download URLs are valid for five minutes after they are generated. You can call the DescribeAssetBundleExportJob API for a new download URL as needed. Job descriptions are available for 14 days after the job starts.
list_asset_bundle_export_jobs	select	aws_account_id, region	next-token, max-results	Lists all asset bundle export jobs that have been taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleExportJobs only returns the most recent job that uses the repeated job ID.
start_asset_bundle_export_job	exec	aws_account_id, region, AssetBundleExportJobId, ResourceArns, ExportFormat		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
asset_bundle_export_job_id	string	The ID of the job that you want described. The job ID is set when you start a new job with a StartAssetBundleExportJob API call.
aws_account_id	string	The ID of the Amazon Web Services account to export assets from.
region	string	AWS region (default: us-east-1)
max-results	integer	The maximum number of results to be returned per request.
next-token	string	The token for the next set of results, or null if there are no more results.

SELECT examples

describe_asset_bundle_export_job

Describes an existing export job. Poll job descriptions after a job starts to know the status of the job. When a job succeeds, a URL is provided to download the exported assets' data from. Download URLs are valid for five minutes after they are generated. You can call the DescribeAssetBundleExportJob API for a new download URL as needed. Job descriptions are available for 14 days after the job starts.

SELECT
arn,
asset_bundle_export_job_id,
aws_account_id,
cloud_formation_override_property_configuration,
created_time,
download_url,
errors,
export_format,
include_all_dependencies,
include_folder_members,
include_folder_memberships,
include_permissions,
include_tags,
job_status,
request_id,
resource_arns,
status,
validation_strategy,
warnings
FROM aws.quicksight.asset_bundle_export_jobs
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND asset_bundle_export_job_id = '{{ asset_bundle_export_job_id }}' -- required
AND region = '{{ region }}' -- required
;

list_asset_bundle_export_jobs

Lists all asset bundle export jobs that have been taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleExportJobs only returns the most recent job that uses the repeated job ID.

SELECT
arn,
asset_bundle_export_job_id,
created_time,
export_format,
include_all_dependencies,
include_permissions,
include_tags,
job_status
FROM aws.quicksight.asset_bundle_export_jobs
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND region = '{{ region }}' -- required
AND `next-token` = '{{ next-token }}'
AND `max-results` = '{{ max-results }}'
;

Lifecycle Methods

start_asset_bundle_export_job

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.

EXEC aws.quicksight.asset_bundle_export_jobs.start_asset_bundle_export_job 
@aws_account_id='{{ aws_account_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"AssetBundleExportJobId": "{{ AssetBundleExportJobId }}", 
"ResourceArns": "{{ ResourceArns }}", 
"IncludeAllDependencies": {{ IncludeAllDependencies }}, 
"ExportFormat": "{{ ExportFormat }}", 
"CloudFormationOverridePropertyConfiguration": "{{ CloudFormationOverridePropertyConfiguration }}", 
"IncludePermissions": {{ IncludePermissions }}, 
"IncludeTags": {{ IncludeTags }}, 
"ValidationStrategy": "{{ ValidationStrategy }}", 
"IncludeFolderMemberships": {{ IncludeFolderMemberships }}, 
"IncludeFolderMembers": "{{ IncludeFolderMembers }}"
}'
;