DescribeAssetBundleImportJob
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.
Request Syntax
GET /accounts/AwsAccountId/asset-bundle-import-jobs/AssetBundleImportJobId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- AssetBundleImportJobId
-
The ID of the job. The job ID is set when you start a new job with a
StartAssetBundleImportJobAPI call.Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
[\w\-]+Required: Yes
- AwsAccountId
-
The ID of the AWS account the import job was executed in.
Length Constraints: Fixed length of 12.
Pattern:
^[0-9]{12}$Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 Status
Content-type: application/json
{
"Arn": "string",
"AssetBundleImportJobId": "string",
"AssetBundleImportSource": {
"Body": "string",
"S3Uri": "string"
},
"AwsAccountId": "string",
"CreatedTime": number,
"Errors": [
{
"Arn": "string",
"Message": "string",
"Type": "string"
}
],
"FailureAction": "string",
"JobStatus": "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": {
"Database": "string",
"Host": "string",
"Warehouse": "string"
},
"SparkParameters": {
"Host": "string",
"Port": number
},
"SqlServerParameters": {
"Database": "string",
"Host": "string",
"Port": number
},
"StarburstParameters": {
"Catalog": "string",
"Host": "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"
}
}
],
"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" ]
}
}
],
"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"
}
]
}
],
"Themes": [
{
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"ThemeIds": [ "string" ]
}
],
"VPCConnections": [
{
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"VPCConnectionIds": [ "string" ]
}
]
},
"OverrideValidationStrategy": {
"StrictModeForAllResources": boolean
},
"RequestId": "string",
"RollbackErrors": [
{
"Arn": "string",
"Message": "string",
"Type": "string"
}
],
"Warnings": [
{
"Arn": "string",
"Message": "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. The job ID is set when you start a new job with a
StartAssetBundleImportJobAPI call.Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
[\w\-]+ - AssetBundleImportSource
-
The source of the asset bundle zip file that contains the data that is imported by the job.
Type: AssetBundleImportSourceDescription object
- AwsAccountId
-
The ID of the AWS account the import job was executed in.
Type: String
Length Constraints: Fixed length of 12.
Pattern:
^[0-9]{12}$ - CreatedTime
-
The time that the import job was created.
Type: Timestamp
- Errors
-
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.
Type: Array of AssetBundleImportJobError objects
- FailureAction
-
The failure action for the import job.
Type: String
Valid Values:
DO_NOTHING | ROLLBACK - JobStatus
-
Indicates the status of a job through its queuing and execution.
Poll the
DescribeAssetBundleImportAPI untilJobStatusreturns one of the following values:-
SUCCESSFUL -
FAILED -
FAILED_ROLLBACK_COMPLETED -
FAILED_ROLLBACK_ERROR
Type: String
Valid Values:
QUEUED_FOR_IMMEDIATE_EXECUTION | IN_PROGRESS | SUCCESSFUL | FAILED | FAILED_ROLLBACK_IN_PROGRESS | FAILED_ROLLBACK_COMPLETED | FAILED_ROLLBACK_ERROR -
- OverrideParameters
-
Optional overrides that are applied to the resource configuration before import.
Type: AssetBundleImportJobOverrideParameters object
- OverridePermissions
-
Optional permission overrides that are applied to the resource configuration before import.
Type: AssetBundleImportJobOverridePermissions object
- OverrideTags
-
Optional tag overrides that are applied to the resource configuration before import.
Type: AssetBundleImportJobOverrideTags object
- OverrideValidationStrategy
-
An optional validation strategy override for all analyses and dashboards to be applied to the resource configuration before import.
Type: AssetBundleImportJobOverrideValidationStrategy object
- RequestId
-
The AWS request ID for this operation.
Type: String
Pattern:
.*\S.* - RollbackErrors
-
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.
Type: Array of AssetBundleImportJobError objects
- Warnings
-
An array of warning records that describe all permitted errors that are encountered during the import job.
Type: Array of AssetBundleImportJobWarning objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- 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:
