StartAssetBundleImportJob
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.
Request Syntax
POST /accounts/AwsAccountId/asset-bundle-import-jobs/import HTTP/1.1
Content-type: application/json
{
"AssetBundleImportJobId": "string",
"AssetBundleImportSource": {
"Body": blob,
"S3Uri": "string"
},
"FailureAction": "string",
"OverrideParameters": {
"Analyses": [
{
"AnalysisId": "string",
"Name": "string"
}
],
"Dashboards": [
{
"DashboardId": "string",
"Name": "string"
}
],
"DataSets": [
{
"DataSetId": "string",
"Name": "string"
}
],
"DataSources": [
{
"Credentials": {
"CredentialPair": {
"Password": "string",
"Username": "string"
},
"SecretArn": "string"
},
"DataSourceId": "string",
"DataSourceParameters": {
"AmazonElasticsearchParameters": {
"Domain": "string"
},
"AmazonOpenSearchParameters": {
"Domain": "string"
},
"AthenaParameters": {
"RoleArn": "string",
"WorkGroup": "string"
},
"AuroraParameters": {
"Database": "string",
"Host": "string",
"Port": number
},
"AuroraPostgreSqlParameters": {
"Database": "string",
"Host": "string",
"Port": number
},
"AwsIotAnalyticsParameters": {
"DataSetName": "string"
},
"BigQueryParameters": {
"DataSetRegion": "string",
"ProjectId": "string"
},
"DatabricksParameters": {
"Host": "string",
"Port": number,
"SqlEndpointPath": "string"
},
"ExasolParameters": {
"Host": "string",
"Port": number
},
"JiraParameters": {
"SiteBaseUrl": "string"
},
"MariaDbParameters": {
"Database": "string",
"Host": "string",
"Port": number
},
"MySqlParameters": {
"Database": "string",
"Host": "string",
"Port": number
},
"OracleParameters": {
"Database": "string",
"Host": "string",
"Port": number
},
"PostgreSqlParameters": {
"Database": "string",
"Host": "string",
"Port": number
},
"PrestoParameters": {
"Catalog": "string",
"Host": "string",
"Port": number
},
"RdsParameters": {
"Database": "string",
"InstanceId": "string"
},
"RedshiftParameters": {
"ClusterId": "string",
"Database": "string",
"Host": "string",
"IAMParameters": {
"AutoCreateDatabaseUser": boolean,
"DatabaseGroups": [ "string" ],
"DatabaseUser": "string",
"RoleArn": "string"
},
"IdentityCenterConfiguration": {
"EnableIdentityPropagation": boolean
},
"Port": number
},
"S3Parameters": {
"ManifestFileLocation": {
"Bucket": "string",
"Key": "string"
},
"RoleArn": "string"
},
"ServiceNowParameters": {
"SiteBaseUrl": "string"
},
"SnowflakeParameters": {
"AuthenticationType": "string",
"Database": "string",
"DatabaseAccessControlRole": "string",
"Host": "string",
"OAuthParameters": {
"IdentityProviderResourceUri": "string",
"IdentityProviderVpcConnectionProperties": {
"VpcConnectionArn": "string"
},
"OAuthScope": "string",
"TokenProviderUrl": "string"
},
"Warehouse": "string"
},
"SparkParameters": {
"Host": "string",
"Port": number
},
"SqlServerParameters": {
"Database": "string",
"Host": "string",
"Port": number
},
"StarburstParameters": {
"AuthenticationType": "string",
"Catalog": "string",
"DatabaseAccessControlRole": "string",
"Host": "string",
"OAuthParameters": {
"IdentityProviderResourceUri": "string",
"IdentityProviderVpcConnectionProperties": {
"VpcConnectionArn": "string"
},
"OAuthScope": "string",
"TokenProviderUrl": "string"
},
"Port": number,
"ProductType": "string"
},
"TeradataParameters": {
"Database": "string",
"Host": "string",
"Port": number
},
"TrinoParameters": {
"Catalog": "string",
"Host": "string",
"Port": number
},
"TwitterParameters": {
"MaxRows": number,
"Query": "string"
}
},
"Name": "string",
"SslProperties": {
"DisableSsl": boolean
},
"VpcConnectionProperties": {
"VpcConnectionArn": "string"
}
}
],
"Folders": [
{
"FolderId": "string",
"Name": "string",
"ParentFolderArn": "string"
}
],
"RefreshSchedules": [
{
"DataSetId": "string",
"ScheduleId": "string",
"StartAfterDateTime": number
}
],
"ResourceIdOverrideConfiguration": {
"PrefixForAllResources": "string"
},
"Themes": [
{
"Name": "string",
"ThemeId": "string"
}
],
"VPCConnections": [
{
"DnsResolvers": [ "string" ],
"Name": "string",
"RoleArn": "string",
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ],
"VPCConnectionId": "string"
}
]
},
"OverridePermissions": {
"Analyses": [
{
"AnalysisIds": [ "string" ],
"Permissions": {
"Actions": [ "string" ],
"Principals": [ "string" ]
}
}
],
"Dashboards": [
{
"DashboardIds": [ "string" ],
"LinkSharingConfiguration": {
"Permissions": {
"Actions": [ "string" ],
"Principals": [ "string" ]
}
},
"Permissions": {
"Actions": [ "string" ],
"Principals": [ "string" ]
}
}
],
"DataSets": [
{
"DataSetIds": [ "string" ],
"Permissions": {
"Actions": [ "string" ],
"Principals": [ "string" ]
}
}
],
"DataSources": [
{
"DataSourceIds": [ "string" ],
"Permissions": {
"Actions": [ "string" ],
"Principals": [ "string" ]
}
}
],
"Folders": [
{
"FolderIds": [ "string" ],
"Permissions": {
"Actions": [ "string" ],
"Principals": [ "string" ]
}
}
],
"Themes": [
{
"Permissions": {
"Actions": [ "string" ],
"Principals": [ "string" ]
},
"ThemeIds": [ "string" ]
}
]
},
"OverrideTags": {
"Analyses": [
{
"AnalysisIds": [ "string" ],
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
],
"Dashboards": [
{
"DashboardIds": [ "string" ],
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
],
"DataSets": [
{
"DataSetIds": [ "string" ],
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
],
"DataSources": [
{
"DataSourceIds": [ "string" ],
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
],
"Folders": [
{
"FolderIds": [ "string" ],
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
],
"Themes": [
{
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"ThemeIds": [ "string" ]
}
],
"VPCConnections": [
{
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"VPCConnectionIds": [ "string" ]
}
]
},
"OverrideValidationStrategy": {
"StrictModeForAllResources": boolean
}
}URI Request Parameters
The request uses the following URI parameters.
- AwsAccountId
-
The ID of the AWS account to import assets into.
Length Constraints: Fixed length of 12.
Pattern:
^[0-9]{12}$Required: Yes
Request Body
The request accepts the following data in JSON format.
- AssetBundleImportJobId
-
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
[\w\-]+Required: Yes
- 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.Type: AssetBundleImportSource object
Required: Yes
- 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.Type: String
Valid Values:
DO_NOTHING | ROLLBACKRequired: No
- OverrideParameters
-
Optional overrides that are applied to the resource configuration before import.
Type: AssetBundleImportJobOverrideParameters object
Required: No
- OverridePermissions
-
Optional permission overrides that are applied to the resource configuration before import.
Type: AssetBundleImportJobOverridePermissions object
Required: No
- OverrideTags
-
Optional tag overrides that are applied to the resource configuration before import.
Type: AssetBundleImportJobOverrideTags object
Required: No
- OverrideValidationStrategy
-
An optional validation strategy override for all analyses and dashboards that is applied to the resource configuration before import.
Type: AssetBundleImportJobOverrideValidationStrategy object
Required: No
Response Syntax
HTTP/1.1 Status
Content-type: application/json
{
"Arn": "string",
"AssetBundleImportJobId": "string",
"RequestId": "string"
}Response Elements
If the action is successful, the service sends back the following HTTP response.
- Status
-
The HTTP status of the response.
The following data is returned in JSON format by the service.
- Arn
-
The Amazon Resource Name (ARN) for the import job.
Type: String
- AssetBundleImportJobId
-
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
[\w\-]+ - RequestId
-
The AWS response ID for this operation.
Type: String
Pattern:
.*\S.*
Errors
For information about the errors that are common to all actions, see Common Errors.
- 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 QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
HTTP Status Code: 401
- ConflictException
-
Updating or deleting a resource can cause an inconsistent state.
HTTP Status Code: 409
- InvalidParameterValueException
-
One or more parameters has a value that isn't valid.
HTTP Status Code: 400
- LimitExceededException
-
A limit is exceeded.
HTTP Status Code: 409
- ResourceNotFoundException
-
One or more resources can't be found.
HTTP Status Code: 404
- ThrottlingException
-
Access is throttled.
HTTP Status Code: 429
- UnsupportedUserEditionException
-
This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
HTTP Status Code: 403
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
