Start Asset Bundle Import Job
quicksight_start_asset_bundle_import_job | R Documentation |
Starts an Asset Bundle import job¶
Description¶
Starts an Asset Bundle import job.
An Asset Bundle import job imports specified Amazon QuickSight assets into an Amazon QuickSight 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 QuickSight account. Each Amazon QuickSight 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.
Usage¶
quicksight_start_asset_bundle_import_job(AwsAccountId,
AssetBundleImportJobId, AssetBundleImportSource, OverrideParameters,
FailureAction, OverridePermissions, OverrideTags,
OverrideValidationStrategy)
Arguments¶
AwsAccountId
[required] The ID of the Amazon Web Services account to import assets into.
AssetBundleImportJobId
[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.
AssetBundleImportSource
[required] The source of the asset bundle zip file that contains the data that you want to import. The file must be in
QUICKSIGHT_JSON
format.OverrideParameters
Optional overrides that are applied to the resource configuration before import.
FailureAction
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 QuickSight account in an inconsistent state.OverridePermissions
Optional permission overrides that are applied to the resource configuration before import.
OverrideTags
Optional tag overrides that are applied to the resource configuration before import.
OverrideValidationStrategy
An optional validation strategy override for all analyses and dashboards that is applied to the resource configuration before import.
Value¶
A list with the following syntax:
Request syntax¶
svc$start_asset_bundle_import_job(
AwsAccountId = "string",
AssetBundleImportJobId = "string",
AssetBundleImportSource = list(
Body = raw,
S3Uri = "string"
),
OverrideParameters = list(
ResourceIdOverrideConfiguration = list(
PrefixForAllResources = "string"
),
VPCConnections = list(
list(
VPCConnectionId = "string",
Name = "string",
SubnetIds = list(
"string"
),
SecurityGroupIds = list(
"string"
),
DnsResolvers = list(
"string"
),
RoleArn = "string"
)
),
RefreshSchedules = list(
list(
DataSetId = "string",
ScheduleId = "string",
StartAfterDateTime = as.POSIXct(
"2015-01-01"
)
)
),
DataSources = list(
list(
DataSourceId = "string",
Name = "string",
DataSourceParameters = list(
AmazonElasticsearchParameters = list(
Domain = "string"
),
AthenaParameters = list(
WorkGroup = "string",
RoleArn = "string"
),
AuroraParameters = list(
Host = "string",
Port = 123,
Database = "string"
),
AuroraPostgreSqlParameters = list(
Host = "string",
Port = 123,
Database = "string"
),
AwsIotAnalyticsParameters = list(
DataSetName = "string"
),
JiraParameters = list(
SiteBaseUrl = "string"
),
MariaDbParameters = list(
Host = "string",
Port = 123,
Database = "string"
),
MySqlParameters = list(
Host = "string",
Port = 123,
Database = "string"
),
OracleParameters = list(
Host = "string",
Port = 123,
Database = "string"
),
PostgreSqlParameters = list(
Host = "string",
Port = 123,
Database = "string"
),
PrestoParameters = list(
Host = "string",
Port = 123,
Catalog = "string"
),
RdsParameters = list(
InstanceId = "string",
Database = "string"
),
RedshiftParameters = list(
Host = "string",
Port = 123,
Database = "string",
ClusterId = "string",
IAMParameters = list(
RoleArn = "string",
DatabaseUser = "string",
DatabaseGroups = list(
"string"
),
AutoCreateDatabaseUser = TRUE|FALSE
),
IdentityCenterConfiguration = list(
EnableIdentityPropagation = TRUE|FALSE
)
),
S3Parameters = list(
ManifestFileLocation = list(
Bucket = "string",
Key = "string"
),
RoleArn = "string"
),
ServiceNowParameters = list(
SiteBaseUrl = "string"
),
SnowflakeParameters = list(
Host = "string",
Database = "string",
Warehouse = "string"
),
SparkParameters = list(
Host = "string",
Port = 123
),
SqlServerParameters = list(
Host = "string",
Port = 123,
Database = "string"
),
TeradataParameters = list(
Host = "string",
Port = 123,
Database = "string"
),
TwitterParameters = list(
Query = "string",
MaxRows = 123
),
AmazonOpenSearchParameters = list(
Domain = "string"
),
ExasolParameters = list(
Host = "string",
Port = 123
),
DatabricksParameters = list(
Host = "string",
Port = 123,
SqlEndpointPath = "string"
),
StarburstParameters = list(
Host = "string",
Port = 123,
Catalog = "string",
ProductType = "GALAXY"|"ENTERPRISE"
),
TrinoParameters = list(
Host = "string",
Port = 123,
Catalog = "string"
),
BigQueryParameters = list(
ProjectId = "string",
DataSetRegion = "string"
)
),
VpcConnectionProperties = list(
VpcConnectionArn = "string"
),
SslProperties = list(
DisableSsl = TRUE|FALSE
),
Credentials = list(
CredentialPair = list(
Username = "string",
Password = "string"
),
SecretArn = "string"
)
)
),
DataSets = list(
list(
DataSetId = "string",
Name = "string"
)
),
Themes = list(
list(
ThemeId = "string",
Name = "string"
)
),
Analyses = list(
list(
AnalysisId = "string",
Name = "string"
)
),
Dashboards = list(
list(
DashboardId = "string",
Name = "string"
)
)
),
FailureAction = "DO_NOTHING"|"ROLLBACK",
OverridePermissions = list(
DataSources = list(
list(
DataSourceIds = list(
"string"
),
Permissions = list(
Principals = list(
"string"
),
Actions = list(
"string"
)
)
)
),
DataSets = list(
list(
DataSetIds = list(
"string"
),
Permissions = list(
Principals = list(
"string"
),
Actions = list(
"string"
)
)
)
),
Themes = list(
list(
ThemeIds = list(
"string"
),
Permissions = list(
Principals = list(
"string"
),
Actions = list(
"string"
)
)
)
),
Analyses = list(
list(
AnalysisIds = list(
"string"
),
Permissions = list(
Principals = list(
"string"
),
Actions = list(
"string"
)
)
)
),
Dashboards = list(
list(
DashboardIds = list(
"string"
),
Permissions = list(
Principals = list(
"string"
),
Actions = list(
"string"
)
),
LinkSharingConfiguration = list(
Permissions = list(
Principals = list(
"string"
),
Actions = list(
"string"
)
)
)
)
)
),
OverrideTags = list(
VPCConnections = list(
list(
VPCConnectionIds = list(
"string"
),
Tags = list(
list(
Key = "string",
Value = "string"
)
)
)
),
DataSources = list(
list(
DataSourceIds = list(
"string"
),
Tags = list(
list(
Key = "string",
Value = "string"
)
)
)
),
DataSets = list(
list(
DataSetIds = list(
"string"
),
Tags = list(
list(
Key = "string",
Value = "string"
)
)
)
),
Themes = list(
list(
ThemeIds = list(
"string"
),
Tags = list(
list(
Key = "string",
Value = "string"
)
)
)
),
Analyses = list(
list(
AnalysisIds = list(
"string"
),
Tags = list(
list(
Key = "string",
Value = "string"
)
)
)
),
Dashboards = list(
list(
DashboardIds = list(
"string"
),
Tags = list(
list(
Key = "string",
Value = "string"
)
)
)
)
),
OverrideValidationStrategy = list(
StrictModeForAllResources = TRUE|FALSE
)
)