/AWS1/CL_QSTDSCASTBUNDLEEXPJ01

DescribeAssetBundleExportJobResponse

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_jobstatus TYPE /AWS1/QSTASSETBUNDLEEXPJOBSTAT /AWS1/QSTASSETBUNDLEEXPJOBSTAT

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

Poll this DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or FAILED.

iv_downloadurl TYPE /AWS1/QSTSENSITIVES3URI /AWS1/QSTSENSITIVES3URI

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.

it_errors TYPE /AWS1/CL_QSTASTBUNDLEEXPJOBERR=>TT_ASSETBUNDLEEXPJOBERRORLIST TT_ASSETBUNDLEEXPJOBERRORLIST

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.

iv_arn TYPE /AWS1/QSTARN /AWS1/QSTARN

The Amazon Resource Name (ARN) for the export job.

iv_createdtime TYPE /AWS1/QSTTIMESTAMP /AWS1/QSTTIMESTAMP

The time that the export job was created.

iv_assetbundleexportjobid TYPE /AWS1/QSTSHORTRESTRICTIVERES00 /AWS1/QSTSHORTRESTRICTIVERES00

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

iv_awsaccountid TYPE /AWS1/QSTAWSACCOUNTID /AWS1/QSTAWSACCOUNTID

The ID of the Amazon Web Services account that the export job was executed in.

it_resourcearns TYPE /AWS1/CL_QSTASTBUNDLERESRCAR00=>TT_ASSETBUNDLERESOURCEARNS TT_ASSETBUNDLERESOURCEARNS

A list of resource ARNs that exported with the job.

iv_includealldependencies TYPE /AWS1/QSTBOOLEAN /AWS1/QSTBOOLEAN

The include dependencies flag.

iv_exportformat TYPE /AWS1/QSTASSETBUNDLEEXPFORMAT /AWS1/QSTASSETBUNDLEEXPFORMAT

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 CloudFormation console and with the CloudFormation APIs.

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

The CloudFormation override property configuration for the export job.

iv_requestid TYPE /AWS1/QSTNONEMPTYSTRING /AWS1/QSTNONEMPTYSTRING

The Amazon Web Services request ID for this operation.

iv_status TYPE /AWS1/QSTSTATUSCODE /AWS1/QSTSTATUSCODE

The HTTP status of the response.

iv_includepermissions TYPE /AWS1/QSTBOOLEAN /AWS1/QSTBOOLEAN

The include permissions flag.

iv_includetags TYPE /AWS1/QSTBOOLEAN /AWS1/QSTBOOLEAN

The include tags flag.

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

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

it_warnings TYPE /AWS1/CL_QSTASTBUNDLEEXPJOBW00=>TT_ASTBUNDLEEXPJOBWARNINGLIST TT_ASTBUNDLEEXPJOBWARNINGLIST

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.

iv_includefoldermemberships TYPE /AWS1/QSTBOOLEAN /AWS1/QSTBOOLEAN

The include folder memberships flag.

iv_includefoldermembers TYPE /AWS1/QSTINCLUDEFOLDERMEMBERS /AWS1/QSTINCLUDEFOLDERMEMBERS

A setting that determines whether folder members are included.

---

Queryable Attributes

JobStatus

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

Poll this DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or FAILED.

Accessible with the following methods

Method	Description
GET_JOBSTATUS()	Getter for JOBSTATUS, with configurable default
ASK_JOBSTATUS()	Getter for JOBSTATUS w/ exceptions if field has no value
HAS_JOBSTATUS()	Determine if JOBSTATUS has a value

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.

Accessible with the following methods

Method	Description
GET_DOWNLOADURL()	Getter for DOWNLOADURL, with configurable default
ASK_DOWNLOADURL()	Getter for DOWNLOADURL w/ exceptions if field has no value
HAS_DOWNLOADURL()	Determine if DOWNLOADURL has a value

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.

Accessible with the following methods

Method	Description
GET_ERRORS()	Getter for ERRORS, with configurable default
ASK_ERRORS()	Getter for ERRORS w/ exceptions if field has no value
HAS_ERRORS()	Determine if ERRORS has a value

Arn

The Amazon Resource Name (ARN) for the export job.

Accessible with the following methods

Method	Description
GET_ARN()	Getter for ARN, with configurable default
ASK_ARN()	Getter for ARN w/ exceptions if field has no value
HAS_ARN()	Determine if ARN has a value

CreatedTime

The time that the export job was created.

Accessible with the following methods

Method	Description
GET_CREATEDTIME()	Getter for CREATEDTIME, with configurable default
ASK_CREATEDTIME()	Getter for CREATEDTIME w/ exceptions if field has no value
HAS_CREATEDTIME()	Determine if CREATEDTIME has a value

AssetBundleExportJobId

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

Accessible with the following methods

Method	Description
GET_ASSETBUNDLEEXPORTJOBID()	Getter for ASSETBUNDLEEXPORTJOBID, with configurable default
ASK_ASSETBUNDLEEXPORTJOBID()	Getter for ASSETBUNDLEEXPORTJOBID w/ exceptions if field has
HAS_ASSETBUNDLEEXPORTJOBID()	Determine if ASSETBUNDLEEXPORTJOBID has a value

AwsAccountId

The ID of the Amazon Web Services account that the export job was executed in.

Accessible with the following methods

Method	Description
GET_AWSACCOUNTID()	Getter for AWSACCOUNTID, with configurable default
ASK_AWSACCOUNTID()	Getter for AWSACCOUNTID w/ exceptions if field has no value
HAS_AWSACCOUNTID()	Determine if AWSACCOUNTID has a value

ResourceArns

A list of resource ARNs that exported with the job.

Accessible with the following methods

Method	Description
GET_RESOURCEARNS()	Getter for RESOURCEARNS, with configurable default
ASK_RESOURCEARNS()	Getter for RESOURCEARNS w/ exceptions if field has no value
HAS_RESOURCEARNS()	Determine if RESOURCEARNS has a value

IncludeAllDependencies

The include dependencies flag.

Accessible with the following methods

Method	Description
GET_INCLUDEALLDEPENDENCIES()	Getter for INCLUDEALLDEPENDENCIES

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 CloudFormation console and with the CloudFormation APIs.

Accessible with the following methods

Method	Description
GET_EXPORTFORMAT()	Getter for EXPORTFORMAT, with configurable default
ASK_EXPORTFORMAT()	Getter for EXPORTFORMAT w/ exceptions if field has no value
HAS_EXPORTFORMAT()	Determine if EXPORTFORMAT has a value

CloudFormationOverridePropertyConfiguration

The CloudFormation override property configuration for the export job.

Accessible with the following methods

Method	Description
GET_CLOUDFMTIONOVERRIDEPRP00()	Getter for CLOUDFMTIONOVERRIDEPRPCONF

RequestId

The Amazon Web Services request ID for this operation.

Accessible with the following methods

Method	Description
GET_REQUESTID()	Getter for REQUESTID, with configurable default
ASK_REQUESTID()	Getter for REQUESTID w/ exceptions if field has no value
HAS_REQUESTID()	Determine if REQUESTID has a value

Status

The HTTP status of the response.

Accessible with the following methods

Method	Description
GET_STATUS()	Getter for STATUS

IncludePermissions

The include permissions flag.

Accessible with the following methods

Method	Description
GET_INCLUDEPERMISSIONS()	Getter for INCLUDEPERMISSIONS

IncludeTags

The include tags flag.

Accessible with the following methods

Method	Description
GET_INCLUDETAGS()	Getter for INCLUDETAGS

ValidationStrategy

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

Accessible with the following methods

Method	Description
GET_VALIDATIONSTRATEGY()	Getter for VALIDATIONSTRATEGY

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.

Accessible with the following methods

Method	Description
GET_WARNINGS()	Getter for WARNINGS, with configurable default
ASK_WARNINGS()	Getter for WARNINGS w/ exceptions if field has no value
HAS_WARNINGS()	Determine if WARNINGS has a value

IncludeFolderMemberships

The include folder memberships flag.

Accessible with the following methods

Method	Description
GET_INCLUDEFOLDERMEMBERSHIPS()	Getter for INCLUDEFOLDERMEMBERSHIPS

IncludeFolderMembers

A setting that determines whether folder members are included.

Accessible with the following methods

Method	Description
GET_INCLUDEFOLDERMEMBERS()	Getter for INCLUDEFOLDERMEMBERS, with configurable default
ASK_INCLUDEFOLDERMEMBERS()	Getter for INCLUDEFOLDERMEMBERS w/ exceptions if field has n
HAS_INCLUDEFOLDERMEMBERS()	Determine if INCLUDEFOLDERMEMBERS has a value