Start Asset Bundle Export Job
quicksight_start_asset_bundle_export_job | R Documentation |
Starts an Asset Bundle export job¶
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
describe_asset_bundle_export_job
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
describe_asset_bundle_export_job
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.
Usage¶
quicksight_start_asset_bundle_export_job(AwsAccountId,
AssetBundleExportJobId, ResourceArns, IncludeAllDependencies,
ExportFormat, CloudFormationOverridePropertyConfiguration,
IncludePermissions, IncludeTags, ValidationStrategy)
Arguments¶
AwsAccountId
[required] The ID of the Amazon Web Services account to export assets from.
AssetBundleExportJobId
[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
[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.
IncludeAllDependencies
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 setIncludeAllDependencies
toTRUE
, any theme, dataset, and data source resource that is a dependency of the dashboard is also exported.ExportFormat
[required] The export data format.
CloudFormationOverridePropertyConfiguration
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 aStartAssetBundleExportJobRequest
API call is set toCLOUDFORMATION_JSON
.IncludePermissions
A Boolean that determines whether all permissions for each resource ARN are exported with the job. If you set
IncludePermissions
toTRUE
, any permissions associated with each resource are exported.IncludeTags
A Boolean that determines whether all tags for each resource ARN are exported with the job. If you set
IncludeTags
toTRUE
, any tags associated with each resource are exported.ValidationStrategy
An optional parameter that determines which validation strategy to use for the export job. If
StrictModeForAllResources
is set toTRUE
, strict validation for every error is enforced. If it is set toFALSE
, validation is skipped for specific UI errors that are shown as warnings. The default value forStrictModeForAllResources
isFALSE
.
Value¶
A list with the following syntax:
Request syntax¶
svc$start_asset_bundle_export_job(
AwsAccountId = "string",
AssetBundleExportJobId = "string",
ResourceArns = list(
"string"
),
IncludeAllDependencies = TRUE|FALSE,
ExportFormat = "CLOUDFORMATION_JSON"|"QUICKSIGHT_JSON",
CloudFormationOverridePropertyConfiguration = list(
ResourceIdOverrideConfiguration = list(
PrefixForAllResources = TRUE|FALSE
),
VPCConnections = list(
list(
Arn = "string",
Properties = list(
"Name"|"DnsResolvers"|"RoleArn"
)
)
),
RefreshSchedules = list(
list(
Arn = "string",
Properties = list(
"StartAfterDateTime"
)
)
),
DataSources = list(
list(
Arn = "string",
Properties = list(
"Name"|"DisableSsl"|"SecretArn"|"Username"|"Password"|"Domain"|"WorkGroup"|"Host"|"Port"|"Database"|"DataSetName"|"Catalog"|"InstanceId"|"ClusterId"|"ManifestFileLocation"|"Warehouse"|"RoleArn"|"ProductType"
)
)
),
DataSets = list(
list(
Arn = "string",
Properties = list(
"Name"
)
)
),
Themes = list(
list(
Arn = "string",
Properties = list(
"Name"
)
)
),
Analyses = list(
list(
Arn = "string",
Properties = list(
"Name"
)
)
),
Dashboards = list(
list(
Arn = "string",
Properties = list(
"Name"
)
)
)
),
IncludePermissions = TRUE|FALSE,
IncludeTags = TRUE|FALSE,
ValidationStrategy = list(
StrictModeForAllResources = TRUE|FALSE
)
)