Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeAssetBundleExportJob

Describes an existing export job.

Poll job descriptions after a job starts to know the status of the job. When a job succeeds, a URL is provided to download the exported assets' data from. Download URLs are valid for five minutes after they are generated. You can call the DescribeAssetBundleExportJob API for a new download URL as needed.

Job descriptions are available for 14 days after the job starts.

Request Syntax


GET /accounts/AwsAccountId/asset-bundle-export-jobs/AssetBundleExportJobId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AssetBundleExportJobId

The ID of the job that you want described. The job ID is set when you start a new job with a StartAssetBundleExportJob API call.

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: [\w\-]+

Required: Yes

AwsAccountId

The ID of the AWS account the export job is 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",
   "AssetBundleExportJobId": "string",
   "AwsAccountId": "string",
   "CloudFormationOverridePropertyConfiguration": { 
      "Analyses": [ 
         { 
            "Arn": "string",
            "Properties": [ "string" ]
         }
      ],
      "Dashboards": [ 
         { 
            "Arn": "string",
            "Properties": [ "string" ]
         }
      ],
      "DataSets": [ 
         { 
            "Arn": "string",
            "Properties": [ "string" ]
         }
      ],
      "DataSources": [ 
         { 
            "Arn": "string",
            "Properties": [ "string" ]
         }
      ],
      "RefreshSchedules": [ 
         { 
            "Arn": "string",
            "Properties": [ "string" ]
         }
      ],
      "ResourceIdOverrideConfiguration": { 
         "PrefixForAllResources": boolean
      },
      "Themes": [ 
         { 
            "Arn": "string",
            "Properties": [ "string" ]
         }
      ],
      "VPCConnections": [ 
         { 
            "Arn": "string",
            "Properties": [ "string" ]
         }
      ]
   },
   "CreatedTime": number,
   "DownloadUrl": "string",
   "Errors": [ 
      { 
         "Arn": "string",
         "Message": "string",
         "Type": "string"
      }
   ],
   "ExportFormat": "string",
   "IncludeAllDependencies": boolean,
   "IncludePermissions": boolean,
   "IncludeTags": boolean,
   "JobStatus": "string",
   "RequestId": "string",
   "ResourceArns": [ "string" ],
   "ValidationStrategy": { 
      "StrictModeForAllResources": boolean
   },
   "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 export job.

Type: String

AssetBundleExportJobId

The ID of the job. The job ID is set when you start a new job with a StartAssetBundleExportJob API call.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: [\w\-]+

AwsAccountId

The ID of the AWS account that the export job was executed in.

Type: String

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$

CloudFormationOverridePropertyConfiguration

The AWS CloudFormation override property configuration for the export job.

Type: AssetBundleCloudFormationOverridePropertyConfiguration object

CreatedTime

The time that the export job was created.

Type: Timestamp

DownloadUrl

The URL to download the exported asset bundle data from.

This URL is available only after the job has succeeded. This URL is valid for 5 minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if needed.

The downloaded asset bundle is a zip file named assetbundle-{jobId}.qs. The file has a .qs extension.

This URL can't be used in a StartAssetBundleImportJob API call and should only be used for download purposes.

Type: String

Pattern: ^(https|s3)://([^/]+)/?(.*)$

Errors

An array of error records that describes any failures that occurred during the export job processing.

Error records accumulate while the job runs. The complete set of error records is available after the job has completed and failed.

Type: Array of AssetBundleExportJobError objects

ExportFormat

The format of the exported asset bundle. A QUICKSIGHT_JSON formatted file can be used to make a StartAssetBundleImportJob API call. A CLOUDFORMATION_JSON formatted file can be used in the AWS CloudFormation console and with the AWS CloudFormation APIs.

Type: String

Valid Values: CLOUDFORMATION_JSON | QUICKSIGHT_JSON

IncludeAllDependencies

The include dependencies flag.

Type: Boolean

IncludePermissions

The include permissions flag.

Type: Boolean

IncludeTags

The include tags flag.

Type: Boolean

JobStatus

Indicates the status of a job through its queuing and execution.

Poll this DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or FAILED.

Type: String

Valid Values: QUEUED_FOR_IMMEDIATE_EXECUTION | IN_PROGRESS | SUCCESSFUL | FAILED

RequestId

The AWS request ID for this operation.

Type: String

Pattern: .*\S.*

ResourceArns

A list of resource ARNs that exported with the job.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

ValidationStrategy

The validation strategy that is used to export the analysis or dashboard.

Type: AssetBundleExportJobValidationStrategy object

Warnings

An array of warning records that describe the analysis or dashboard that is exported. This array includes UI errors that can be skipped during the validation process.

This property only appears if StrictModeForAllResources in ValidationStrategy is set to FALSE.

Type: Array of AssetBundleExportJobWarning 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