Skip to content

/AWS1/IF_QST=>STARTASSETBUNDLEEXPORTJOB()

About 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.

Method Signature

METHODS /AWS1/IF_QST~STARTASSETBUNDLEEXPORTJOB
  IMPORTING
    !IV_AWSACCOUNTID TYPE /AWS1/QSTAWSACCOUNTID OPTIONAL
    !IV_ASSETBUNDLEEXPORTJOBID TYPE /AWS1/QSTSHORTRESTRICTIVERES00 OPTIONAL
    !IT_RESOURCEARNS TYPE /AWS1/CL_QSTASTBUNDLERESRCAR00=>TT_ASSETBUNDLERESOURCEARNS OPTIONAL
    !IV_INCLUDEALLDEPENDENCIES TYPE /AWS1/QSTBOOLEAN OPTIONAL
    !IV_EXPORTFORMAT TYPE /AWS1/QSTASSETBUNDLEEXPFORMAT OPTIONAL
    !IO_CLOUDFMTIONOVERRIDEPRPC00 TYPE REF TO /AWS1/CL_QSTASTBUNDLECLOUDFM00 OPTIONAL
    !IV_INCLUDEPERMISSIONS TYPE /AWS1/QSTBOOLEAN OPTIONAL
    !IV_INCLUDETAGS TYPE /AWS1/QSTBOOLEAN OPTIONAL
    !IO_VALIDATIONSTRATEGY TYPE REF TO /AWS1/CL_QSTASTBUNDLEEXPJOBV02 OPTIONAL
    !IV_INCLUDEFOLDERMEMBERSHIPS TYPE /AWS1/QSTBOOLEAN OPTIONAL
    !IV_INCLUDEFOLDERMEMBERS TYPE /AWS1/QSTINCLUDEFOLDERMEMBERS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qststrtastbundleexp01
  RAISING
    /AWS1/CX_QSTACCESSDENIEDEX
    /AWS1/CX_QSTCONFLICTEXCEPTION
    /AWS1/CX_QSTINVPARAMVALUEEX
    /AWS1/CX_QSTLIMITEXCEEDEDEX
    /AWS1/CX_QSTRESOURCENOTFOUNDEX
    /AWS1/CX_QSTTHROTTLINGEX
    /AWS1/CX_QSTUNSUPPEDUSEREDIT00
    /AWS1/CX_QSTCLIENTEXC
    /AWS1/CX_QSTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_awsaccountid TYPE /AWS1/QSTAWSACCOUNTID /AWS1/QSTAWSACCOUNTID

The ID of the Amazon Web Services account to export assets from.

iv_assetbundleexportjobid TYPE /AWS1/QSTSHORTRESTRICTIVERES00 /AWS1/QSTSHORTRESTRICTIVERES00

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.

it_resourcearns TYPE /AWS1/CL_QSTASTBUNDLERESRCAR00=>TT_ASSETBUNDLERESOURCEARNS TT_ASSETBUNDLERESOURCEARNS

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.

iv_exportformat TYPE /AWS1/QSTASSETBUNDLEEXPFORMAT /AWS1/QSTASSETBUNDLEEXPFORMAT

The export data format.

Optional arguments:

iv_includealldependencies TYPE /AWS1/QSTBOOLEAN /AWS1/QSTBOOLEAN

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.

io_cloudfmtionoverrideprpc00 TYPE REF TO /AWS1/CL_QSTASTBUNDLECLOUDFM00 /AWS1/CL_QSTASTBUNDLECLOUDFM00

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

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

iv_includepermissions TYPE /AWS1/QSTBOOLEAN /AWS1/QSTBOOLEAN

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.

iv_includetags TYPE /AWS1/QSTBOOLEAN /AWS1/QSTBOOLEAN

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.

io_validationstrategy TYPE REF TO /AWS1/CL_QSTASTBUNDLEEXPJOBV02 /AWS1/CL_QSTASTBUNDLEEXPJOBV02

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.

iv_includefoldermemberships TYPE /AWS1/QSTBOOLEAN /AWS1/QSTBOOLEAN

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

iv_includefoldermembers TYPE /AWS1/QSTINCLUDEFOLDERMEMBERS /AWS1/QSTINCLUDEFOLDERMEMBERS

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.

RETURNING

oo_output TYPE REF TO /aws1/cl_qststrtastbundleexp01 /AWS1/CL_QSTSTRTASTBUNDLEEXP01

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->startassetbundleexportjob(
  io_cloudfmtionoverrideprpc00 = new /aws1/cl_qstastbundlecloudfm00(
    io_resourceidoverrideconf = new /aws1/cl_qstastbundleexpjobr00( ABAP_TRUE )
    it_analyses = VALUE /aws1/cl_qstastbundleexpjoba00=>tt_astbundleexpjobalyoverrid00(
      (
        new /aws1/cl_qstastbundleexpjoba00(
          it_properties = VALUE /aws1/cl_qstastbundleexpjoba01=>tt_astbundleexpjobalyprptoov00(
            ( new /aws1/cl_qstastbundleexpjoba01( |string| ) )
          )
          iv_arn = |string|
        )
      )
    )
    it_dashboards = VALUE /aws1/cl_qstastbundleexpjobd04=>tt_astbundleexpjobdashboardo00(
      (
        new /aws1/cl_qstastbundleexpjobd04(
          it_properties = VALUE /aws1/cl_qstastbundleexpjobd05=>tt_astbundleexpjobdashboardp00(
            ( new /aws1/cl_qstastbundleexpjobd05( |string| ) )
          )
          iv_arn = |string|
        )
      )
    )
    it_datasets = VALUE /aws1/cl_qstastbundleexpjobd02=>tt_astbundleexpjobdsoverride00(
      (
        new /aws1/cl_qstastbundleexpjobd02(
          it_properties = VALUE /aws1/cl_qstastbundleexpjobd03=>tt_astbundleexpjobdsprptoove00(
            ( new /aws1/cl_qstastbundleexpjobd03( |string| ) )
          )
          iv_arn = |string|
        )
      )
    )
    it_datasources = VALUE /aws1/cl_qstastbundleexpjobd00=>tt_astbundleexpjobdatasrcove00(
      (
        new /aws1/cl_qstastbundleexpjobd00(
          it_properties = VALUE /aws1/cl_qstastbundleexpjobd01=>tt_astbundleexpjobdatasrcprp00(
            ( new /aws1/cl_qstastbundleexpjobd01( |string| ) )
          )
          iv_arn = |string|
        )
      )
    )
    it_folders = VALUE /aws1/cl_qstastbundleexpjobf00=>tt_astbundleexpjobfolderover00(
      (
        new /aws1/cl_qstastbundleexpjobf00(
          it_properties = VALUE /aws1/cl_qstastbundleexpjobf01=>tt_astbundleexpjobfolderprpt00(
            ( new /aws1/cl_qstastbundleexpjobf01( |string| ) )
          )
          iv_arn = |string|
        )
      )
    )
    it_refreshschedules = VALUE /aws1/cl_qstastbundleexpjobr01=>tt_astbundleexpjobrefreshsch00(
      (
        new /aws1/cl_qstastbundleexpjobr01(
          it_properties = VALUE /aws1/cl_qstastbundleexpjobr02=>tt_astbundleexpjobrefreshsch01(
            ( new /aws1/cl_qstastbundleexpjobr02( |string| ) )
          )
          iv_arn = |string|
        )
      )
    )
    it_themes = VALUE /aws1/cl_qstastbundleexpjobt00=>tt_astbundleexpjobthemeoverr00(
      (
        new /aws1/cl_qstastbundleexpjobt00(
          it_properties = VALUE /aws1/cl_qstastbundleexpjobt01=>tt_astbundleexpjobthemeprpto00(
            ( new /aws1/cl_qstastbundleexpjobt01( |string| ) )
          )
          iv_arn = |string|
        )
      )
    )
    it_vpcconnections = VALUE /aws1/cl_qstastbundleexpjobv00=>tt_astbundleexpjobvpccxnover00(
      (
        new /aws1/cl_qstastbundleexpjobv00(
          it_properties = VALUE /aws1/cl_qstastbundleexpjobv01=>tt_astbundleexpjobvpccxnprpt00(
            ( new /aws1/cl_qstastbundleexpjobv01( |string| ) )
          )
          iv_arn = |string|
        )
      )
    )
  )
  io_validationstrategy = new /aws1/cl_qstastbundleexpjobv02( ABAP_TRUE )
  it_resourcearns = VALUE /aws1/cl_qstastbundleresrcar00=>tt_assetbundleresourcearns(
    ( new /aws1/cl_qstastbundleresrcar00( |string| ) )
  )
  iv_assetbundleexportjobid = |string|
  iv_awsaccountid = |string|
  iv_exportformat = |string|
  iv_includealldependencies = ABAP_TRUE
  iv_includefoldermembers = |string|
  iv_includefoldermemberships = ABAP_TRUE
  iv_includepermissions = ABAP_TRUE
  iv_includetags = ABAP_TRUE
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_arn = lo_result->get_arn( ).
  lv_shortrestrictiveresourc = lo_result->get_assetbundleexportjobid( ).
  lv_nonemptystring = lo_result->get_requestid( ).
  lv_statuscode = lo_result->get_status( ).
ENDIF.