asset_bundle_import_jobs

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

Overview

Name	asset_bundle_import_jobs
Type	Resource
Id	aws.quicksight.asset_bundle_import_jobs

Fields

The following fields are returned by SELECT queries:

describe_asset_bundle_import_job

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) for the import job.
asset_bundle_import_job_id	string	The ID of the job. The job ID is set when you start a new job with a StartAssetBundleImportJob API call. (pattern: <code>[\w-]+</code>)
asset_bundle_import_source	object	The source of the asset bundle zip file that contains the data that is imported by the job.
aws_account_id	string	The ID of the Amazon Web Services account the import job was executed in. (pattern: <code>^[0-9]{12}$</code>)
created_time	string (date-time)	The time that the import job was created.
errors	array	An array of error records that describes any failures that occurred during the export job processing. Error records accumulate while the job is still running. The complete set of error records is available after the job has completed and failed.
failure_action	string	The failure action for the import job. (DO_NOTHING, ROLLBACK)
job_status	string	Indicates the status of a job through its queuing and execution. Poll the DescribeAssetBundleImport API until JobStatus returns one of the following values: SUCCESSFUL FAILED FAILED_ROLLBACK_COMPLETED FAILED_ROLLBACK_ERROR (QUEUED_FOR_IMMEDIATE_EXECUTION, IN_PROGRESS, SUCCESSFUL, FAILED, FAILED_ROLLBACK_IN_PROGRESS, FAILED_ROLLBACK_COMPLETED, FAILED_ROLLBACK_ERROR)
override_parameters	object	Optional overrides that are applied to the resource configuration before import.
override_permissions	object	Optional permission overrides that are applied to the resource configuration before import.
override_tags	object	Optional tag overrides that are applied to the resource configuration before import.
override_validation_strategy	object	An optional validation strategy override for all analyses and dashboards to be applied to the resource configuration before import.
request_id	string	The Amazon Web Services request ID for this operation. (pattern: <code>.\S.</code>)
rollback_errors	array	An array of error records that describes any failures that occurred while an import job was attempting a rollback. Error records accumulate while the job is still running. The complete set of error records is available after the job has completed and failed.
status	integer	The HTTP status of the response.
warnings	array	An array of warning records that describe all permitted errors that are encountered during the import job.

list_asset_bundle_import_jobs

Name	Datatype	Description
arn	string	The ARN of the import job.
asset_bundle_import_job_id	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. (pattern: <code>[\w-]+</code>)
created_time	string (date-time)	The time that the import job was created.
failure_action	string	The failure action for the import job. (DO_NOTHING, ROLLBACK)
job_status	string	The current status of the import job. (QUEUED_FOR_IMMEDIATE_EXECUTION, IN_PROGRESS, SUCCESSFUL, FAILED, FAILED_ROLLBACK_IN_PROGRESS, FAILED_ROLLBACK_COMPLETED, FAILED_ROLLBACK_ERROR)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_asset_bundle_import_job	select	aws_account_id, asset_bundle_import_job_id, region		Describes an existing import job. Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts.
list_asset_bundle_import_jobs	select	aws_account_id, region	next-token, max-results	Lists all asset bundle import jobs that have 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, ListAssetBundleImportJobs only returns the most recent job that uses the repeated job ID.
start_asset_bundle_import_job	exec	aws_account_id, region, AssetBundleImportJobId, AssetBundleImportSource		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.

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_import_job_id	string	The ID of the job. The job ID is set when you start a new job with a StartAssetBundleImportJob API call.
aws_account_id	string	The ID of the Amazon Web Services account to import assets into.
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_import_job

Describes an existing import job. Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts.

SELECT
arn,
asset_bundle_import_job_id,
asset_bundle_import_source,
aws_account_id,
created_time,
errors,
failure_action,
job_status,
override_parameters,
override_permissions,
override_tags,
override_validation_strategy,
request_id,
rollback_errors,
status,
warnings
FROM aws.quicksight.asset_bundle_import_jobs
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND asset_bundle_import_job_id = '{{ asset_bundle_import_job_id }}' -- required
AND region = '{{ region }}' -- required
;

list_asset_bundle_import_jobs

Lists all asset bundle import jobs that have 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, ListAssetBundleImportJobs only returns the most recent job that uses the repeated job ID.

SELECT
arn,
asset_bundle_import_job_id,
created_time,
failure_action,
job_status
FROM aws.quicksight.asset_bundle_import_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_import_job

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.

EXEC aws.quicksight.asset_bundle_import_jobs.start_asset_bundle_import_job 
@aws_account_id='{{ aws_account_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"AssetBundleImportJobId": "{{ AssetBundleImportJobId }}", 
"AssetBundleImportSource": "{{ AssetBundleImportSource }}", 
"OverrideParameters": "{{ OverrideParameters }}", 
"FailureAction": "{{ FailureAction }}", 
"OverridePermissions": "{{ OverridePermissions }}", 
"OverrideTags": "{{ OverrideTags }}", 
"OverrideValidationStrategy": "{{ OverrideValidationStrategy }}"
}'
;