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

StartAssetBundleExportJob

Starts an Asset Bundle export job.

An Asset Bundle export job exports specified Amazon Quick Sight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a DescribeAssetBundleExportJob 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 DescribeAssetBundleExportJob API call. Each Amazon Quick Sight 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.

Request Syntax


POST /accounts/AwsAccountId/asset-bundle-export-jobs/export HTTP/1.1
Content-type: application/json

{
   "AssetBundleExportJobId": "string",
   "CloudFormationOverridePropertyConfiguration": { 
      "Analyses": [ 
         { 
            "Arn": "string",
            "Properties": [ "string" ]
         }
      ],
      "Dashboards": [ 
         { 
            "Arn": "string",
            "Properties": [ "string" ]
         }
      ],
      "DataSets": [ 
         { 
            "Arn": "string",
            "Properties": [ "string" ]
         }
      ],
      "DataSources": [ 
         { 
            "Arn": "string",
            "Properties": [ "string" ]
         }
      ],
      "Folders": [ 
         { 
            "Arn": "string",
            "Properties": [ "string" ]
         }
      ],
      "RefreshSchedules": [ 
         { 
            "Arn": "string",
            "Properties": [ "string" ]
         }
      ],
      "ResourceIdOverrideConfiguration": { 
         "PrefixForAllResources": boolean
      },
      "Themes": [ 
         { 
            "Arn": "string",
            "Properties": [ "string" ]
         }
      ],
      "VPCConnections": [ 
         { 
            "Arn": "string",
            "Properties": [ "string" ]
         }
      ]
   },
   "ExportFormat": "string",
   "IncludeAllDependencies": boolean,
   "IncludeFolderMembers": "string",
   "IncludeFolderMemberships": boolean,
   "IncludePermissions": boolean,
   "IncludeTags": boolean,
   "ResourceArns": [ "string" ],
   "ValidationStrategy": { 
      "StrictModeForAllResources": boolean
   }
}

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

The ID of the Amazon account to export assets from.

Length Constraints: Fixed length of 12.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

AssetBundleExportJobId

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

ExportFormat

The export data format.

Type: String

Valid Values: CLOUDFORMATION_JSON | QUICKSIGHT_JSON

Required: Yes

ResourceArns

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.

Type: Array of strings

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

Required: Yes

CloudFormationOverridePropertyConfiguration

An optional collection of structures that generate Amazon CloudFormation parameters to override the existing resource property values when the resource is exported to a new Amazon CloudFormation template.

Use this field if the ExportFormat field of a StartAssetBundleExportJobRequest API call is set to CLOUDFORMATION_JSON.

Type: AssetBundleCloudFormationOverridePropertyConfiguration object

Required: No

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 set IncludeAllDependencies to TRUE, any theme, dataset, and data source resource that is a dependency of the dashboard is also exported.

Type: Boolean

Required: No

IncludeFolderMembers

A setting that indicates whether you want to include folder assets. You can also use this setting to recusrsively include all subfolders of an exported folder.

Type: String

Valid Values: RECURSE | ONE_LEVEL | NONE

Required: No

IncludeFolderMemberships

A Boolean that determines if the exported asset carries over information about the folders that the asset is a member of.

Type: Boolean

Required: No

IncludePermissions

A Boolean that determines whether all permissions for each resource ARN are exported with the job. If you set IncludePermissions to TRUE, any permissions associated with each resource are exported.

Type: Boolean

Required: No

IncludeTags

A Boolean that determines whether all tags for each resource ARN are exported with the job. If you set IncludeTags to TRUE, any tags associated with each resource are exported.

Type: Boolean

Required: No

ValidationStrategy

An optional parameter that determines which validation strategy to use for the export job. If StrictModeForAllResources is set to TRUE, strict validation for every error is enforced. If it is set to FALSE, validation is skipped for specific UI errors that are shown as warnings. The default value for StrictModeForAllResources is FALSE.

Type: AssetBundleExportJobValidationStrategy object

Required: No

Response Syntax


HTTP/1.1 Status
Content-type: application/json

{
   "Arn": "string",
   "AssetBundleExportJobId": "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 export job.

Type: String

AssetBundleExportJobId

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 Amazon 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 Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.

RequestId: The Amazon request ID for this request.

HTTP Status Code: 401

ConflictException

Updating or deleting a resource can cause an inconsistent state.

RequestId: The Amazon request ID for this request.

HTTP Status Code: 409

InvalidParameterValueException

One or more parameters has a value that isn't valid.

RequestId: The Amazon request ID for this request.

HTTP Status Code: 400

LimitExceededException

A limit is exceeded.

RequestId: The Amazon request ID for this request.
ResourceType: Limit exceeded.

HTTP Status Code: 409

ResourceNotFoundException

One or more resources can't be found.

RequestId: The Amazon request ID for this request.
ResourceType: The resource type for this request.

HTTP Status Code: 404

ThrottlingException

Access is throttled.

RequestId: The Amazon request ID for this request.

HTTP Status Code: 429

UnsupportedUserEditionException

This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.

RequestId: The Amazon request ID for this request.

HTTP Status Code: 403