Skip to content
AWS for Query.Farm

aws.quicksight.describe_asset_bundle_export_job

Example SQL Queries

SELECT * FROM
aws.quicksight.describe_asset_bundle_export_job
WHERE
"aws_account_id" = 'VALUE'
AND "asset_bundle_export_job_id" = 'VALUE';

Description

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.

Table Definition

Column NameColumn Data Type
asset_bundle_export_job_id Required Input Column

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

VARCHAR
aws_account_id Required Input Column

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

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
arn

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

VARCHAR
cloud_formation_override_property_configuration

The CloudFormation override property configuration for the export job.

STRUCT(
    "resource_id_override_configuration" STRUCT(
        "prefix_for_all_resources" BOOLEAN
    ),
    "vpc_connections" STRUCT(
        "arn" VARCHAR,
        "properties" VARCHAR[]
    )[],
    "refresh_schedules" STRUCT(
        "arn" VARCHAR,
        "properties" VARCHAR[]
    )[],
    "data_sources" STRUCT(
        "arn" VARCHAR,
        "properties" VARCHAR[]
    )[],
    "data_sets" STRUCT(
        "arn" VARCHAR,
        "properties" VARCHAR[]
    )[],
    "themes" STRUCT(
        "arn" VARCHAR,
        "properties" VARCHAR[]
    )[],
    "analyses" STRUCT(
        "arn" VARCHAR,
        "properties" VARCHAR[]
    )[],
    "dashboards" STRUCT(
        "arn" VARCHAR,
        "properties" VARCHAR[]
    )[]
)
Show child fields
cloud_formation_override_property_configuration.analyses[]
Show child fields
cloud_formation_override_property_configuration.analyses[].arn

The ARN of the specific Analysis resource whose override properties are configured in this structure.

cloud_formation_override_property_configuration.analyses[].properties[]
cloud_formation_override_property_configuration.dashboards[]
Show child fields
cloud_formation_override_property_configuration.dashboards[].arn

The ARN of the specific Dashboard resource whose override properties are configured in this structure.

cloud_formation_override_property_configuration.dashboards[].properties[]
cloud_formation_override_property_configuration.data_sets[]
Show child fields
cloud_formation_override_property_configuration.data_sets[].arn

The ARN of the specific DataSet resource whose override properties are configured in this structure.

cloud_formation_override_property_configuration.data_sets[].properties[]
cloud_formation_override_property_configuration.data_sources[]
Show child fields
cloud_formation_override_property_configuration.data_sources[].arn

The ARN of the specific DataSource resource whose override properties are configured in this structure.

cloud_formation_override_property_configuration.data_sources[].properties[]
cloud_formation_override_property_configuration.refresh_schedules[]
Show child fields
cloud_formation_override_property_configuration.refresh_schedules[].arn

The ARN of the specific RefreshSchedule resource whose override properties are configured in this structure.

cloud_formation_override_property_configuration.refresh_schedules[].properties[]
cloud_formation_override_property_configuration.resource_id_override_configuration

An optional list of structures that control how resource IDs are parameterized in the returned CloudFormation template.

Show child fields
cloud_formation_override_property_configuration.resource_id_override_configuration.prefix_for_all_resources

An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.

cloud_formation_override_property_configuration.themes[]
Show child fields
cloud_formation_override_property_configuration.themes[].arn

The ARN of the specific Theme resource whose override properties are configured in this structure.

cloud_formation_override_property_configuration.themes[].properties[]
cloud_formation_override_property_configuration.vpc_connections[]
Show child fields
cloud_formation_override_property_configuration.vpc_connections[].arn

The ARN of the specific VPCConnection resource whose override properties are configured in this structure.

cloud_formation_override_property_configuration.vpc_connections[].properties[]
created_time

The time that the export job was created.

TIMESTAMP_S
download_url

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.

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

STRUCT(
    "arn" VARCHAR,
    "type" VARCHAR,
    "message" VARCHAR
)[]
Show child fields
errors[]
Show child fields
errors[].arn

The ARN of the resource whose processing caused an error.

errors[].message

A description of the error.

errors[].type

The specific error type of the error that occurred.

export_format

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.

VARCHAR
include_all_dependencies

The include dependencies flag.

BOOLEAN
include_permissions

The include permissions flag.

BOOLEAN
include_tags

The include tags flag.

BOOLEAN
job_status

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

Poll this DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or FAILED.

VARCHAR
request_id

The Amazon Web Services request ID for this operation.

VARCHAR
resource_arns

A list of resource ARNs that exported with the job.

VARCHAR[]
Show child fields
resource_arns[]
status

The HTTP status of the response.

BIGINT
validation_strategy

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

STRUCT(
    "strict_mode_for_all_resources" BOOLEAN
)
Show child fields
validation_strategy.strict_mode_for_all_resources

A Boolean value that indicates whether to export resources under strict or lenient mode.

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.

STRUCT(
    "arn" VARCHAR,
    "message" VARCHAR
)[]
Show child fields
warnings[]
Show child fields
warnings[].arn

The ARN of the resource whose processing caused a warning.

warnings[].message

A description of the warning.