start_asset_bundle_import_job
async
¶
start_asset_bundle_import_job(
aws_account_id: AwsAccountId,
asset_bundle_import_job_id: ShortRestrictiveResourceId,
asset_bundle_import_source: AssetBundleImportSource,
*,
config_overrides: Optional[AsyncQuickSightClientConfig] = None,
override_parameters: Optional[AssetBundleImportJobOverrideParameters] = None,
failure_action: Optional[AssetBundleImportFailureAction] = None,
override_permissions: Optional[AssetBundleImportJobOverridePermissions] = None,
override_tags: Optional[AssetBundleImportJobOverrideTags] = None,
override_validation_strategy: Optional[
AssetBundleImportJobOverrideValidationStrategy
] = None,
) -> StartAssetBundleImportJobResponse
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:
-
aws_account_id(AwsAccountId) –The ID of the Amazon Web Services account to import assets into.
-
asset_bundle_import_job_id(ShortRestrictiveResourceId) –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.
-
asset_bundle_import_source(AssetBundleImportSource) –The source of the asset bundle zip file that contains the data that you want to import. The file must be in
QUICKSIGHT_JSONformat. -
override_parameters(Optional[AssetBundleImportJobOverrideParameters], default:None) –Optional overrides that are applied to the resource configuration before import.
-
failure_action(Optional[AssetBundleImportFailureAction], default:None) –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 Quick Sight account in an inconsistent state. -
override_permissions(Optional[AssetBundleImportJobOverridePermissions], default:None) –Optional permission overrides that are applied to the resource configuration before import.
-
override_tags(Optional[AssetBundleImportJobOverrideTags], default:None) –Optional tag overrides that are applied to the resource configuration before import.
-
override_validation_strategy(Optional[AssetBundleImportJobOverrideValidationStrategy], default:None) –An optional validation strategy override for all analyses and dashboards that is applied to the resource configuration before import.
Raises:
-
AccessDeniedException–You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
-
ConflictException–Updating or deleting a resource can cause an inconsistent state.
-
InvalidParameterValueException–One or more parameters has a value that isn't valid.
-
LimitExceededException–A limit is exceeded.
-
ResourceNotFoundException–One or more resources can't be found.
-
ThrottlingException–Access is throttled.
-
UnsupportedUserEditionException–This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_quicksight/_services/async_quick_sight.py
17001 17002 17003 17004 17005 17006 17007 17008 17009 17010 17011 17012 17013 17014 17015 17016 17017 17018 17019 17020 17021 17022 17023 17024 17025 17026 17027 17028 17029 17030 17031 17032 17033 17034 17035 17036 17037 17038 17039 17040 17041 17042 17043 17044 17045 17046 17047 17048 17049 17050 17051 17052 17053 17054 17055 17056 17057 17058 17059 17060 17061 17062 17063 17064 17065 17066 17067 17068 17069 17070 17071 17072 17073 17074 17075 17076 17077 17078 17079 17080 17081 17082 17083 17084 17085 17086 17087 17088 17089 17090 17091 17092 17093 17094 17095 17096 17097 | |