Class: Aws::QuickSight::Types::DescribeAssetBundleExportJobResponse

Inherits:

Struct

• Object
• Struct
• Aws::QuickSight::Types::DescribeAssetBundleExportJobResponse

Includes:

Structure

Defined in:

lib/aws-sdk-quicksight/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:download_url]

Instance Attribute Summary

• #arn ⇒ String

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

• #asset_bundle_export_job_id ⇒ String

  The ID of the job.

• #aws_account_id ⇒ String

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

• #cloud_formation_override_property_configuration ⇒ Types::AssetBundleCloudFormationOverridePropertyConfiguration

  The CloudFormation override property configuration for the export job.

• #created_time ⇒ Time

  The time that the export job was created.

• #download_url ⇒ String

  The URL to download the exported asset bundle data from.

• #errors ⇒ Array<Types::AssetBundleExportJobError>

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

• #export_format ⇒ String

  The format of the exported asset bundle.

• #include_all_dependencies ⇒ Boolean

  The include dependencies flag.

• #include_folder_members ⇒ String

  A setting that determines whether folder members are included.

• #include_folder_memberships ⇒ Boolean

  The include folder memberships flag.

• #include_permissions ⇒ Boolean

  The include permissions flag.

• #include_tags ⇒ Boolean

  The include tags flag.

• #job_status ⇒ String

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

• #request_id ⇒ String

  The Amazon Web Services request ID for this operation.

• #resource_arns ⇒ Array<String>

  A list of resource ARNs that exported with the job.

• #status ⇒ Integer

  The HTTP status of the response.

• #validation_strategy ⇒ Types::AssetBundleExportJobValidationStrategy

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

• #warnings ⇒ Array<Types::AssetBundleExportJobWarning>

  An array of warning records that describe the analysis or dashboard that is exported.

Instance Attribute Details

#arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-quicksight/types.rb', line 17065

class DescribeAssetBundleExportJobResponse < Struct.new(
  :job_status,
  :download_url,
  :errors,
  :arn,
  :created_time,
  :asset_bundle_export_job_id,
  :aws_account_id,
  :resource_arns,
  :include_all_dependencies,
  :export_format,
  :cloud_formation_override_property_configuration,
  :request_id,
  :status,
  :include_permissions,
  :include_tags,
  :validation_strategy,
  :warnings,
  :include_folder_memberships,
  :include_folder_members)
  SENSITIVE = [:download_url]
  include Aws::Structure
end

#asset_bundle_export_job_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-quicksight/types.rb', line 17065

class DescribeAssetBundleExportJobResponse < Struct.new(
  :job_status,
  :download_url,
  :errors,
  :arn,
  :created_time,
  :asset_bundle_export_job_id,
  :aws_account_id,
  :resource_arns,
  :include_all_dependencies,
  :export_format,
  :cloud_formation_override_property_configuration,
  :request_id,
  :status,
  :include_permissions,
  :include_tags,
  :validation_strategy,
  :warnings,
  :include_folder_memberships,
  :include_folder_members)
  SENSITIVE = [:download_url]
  include Aws::Structure
end

#aws_account_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-quicksight/types.rb', line 17065

class DescribeAssetBundleExportJobResponse < Struct.new(
  :job_status,
  :download_url,
  :errors,
  :arn,
  :created_time,
  :asset_bundle_export_job_id,
  :aws_account_id,
  :resource_arns,
  :include_all_dependencies,
  :export_format,
  :cloud_formation_override_property_configuration,
  :request_id,
  :status,
  :include_permissions,
  :include_tags,
  :validation_strategy,
  :warnings,
  :include_folder_memberships,
  :include_folder_members)
  SENSITIVE = [:download_url]
  include Aws::Structure
end

#cloud_formation_override_property_configuration ⇒ Types::AssetBundleCloudFormationOverridePropertyConfiguration

The CloudFormation override property configuration for the export job.

Returns:

• (Types::AssetBundleCloudFormationOverridePropertyConfiguration)

# File 'lib/aws-sdk-quicksight/types.rb', line 17065

class DescribeAssetBundleExportJobResponse < Struct.new(
  :job_status,
  :download_url,
  :errors,
  :arn,
  :created_time,
  :asset_bundle_export_job_id,
  :aws_account_id,
  :resource_arns,
  :include_all_dependencies,
  :export_format,
  :cloud_formation_override_property_configuration,
  :request_id,
  :status,
  :include_permissions,
  :include_tags,
  :validation_strategy,
  :warnings,
  :include_folder_memberships,
  :include_folder_members)
  SENSITIVE = [:download_url]
  include Aws::Structure
end

#created_time ⇒ Time

The time that the export job was created.

Returns:

• (Time)

# File 'lib/aws-sdk-quicksight/types.rb', line 17065

class DescribeAssetBundleExportJobResponse < Struct.new(
  :job_status,
  :download_url,
  :errors,
  :arn,
  :created_time,
  :asset_bundle_export_job_id,
  :aws_account_id,
  :resource_arns,
  :include_all_dependencies,
  :export_format,
  :cloud_formation_override_property_configuration,
  :request_id,
  :status,
  :include_permissions,
  :include_tags,
  :validation_strategy,
  :warnings,
  :include_folder_memberships,
  :include_folder_members)
  SENSITIVE = [:download_url]
  include Aws::Structure
end

#download_url ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-quicksight/types.rb', line 17065

class DescribeAssetBundleExportJobResponse < Struct.new(
  :job_status,
  :download_url,
  :errors,
  :arn,
  :created_time,
  :asset_bundle_export_job_id,
  :aws_account_id,
  :resource_arns,
  :include_all_dependencies,
  :export_format,
  :cloud_formation_override_property_configuration,
  :request_id,
  :status,
  :include_permissions,
  :include_tags,
  :validation_strategy,
  :warnings,
  :include_folder_memberships,
  :include_folder_members)
  SENSITIVE = [:download_url]
  include Aws::Structure
end

#errors ⇒ Array<Types::AssetBundleExportJobError>

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.

Returns:

• (Array<Types::AssetBundleExportJobError>)

# File 'lib/aws-sdk-quicksight/types.rb', line 17065

class DescribeAssetBundleExportJobResponse < Struct.new(
  :job_status,
  :download_url,
  :errors,
  :arn,
  :created_time,
  :asset_bundle_export_job_id,
  :aws_account_id,
  :resource_arns,
  :include_all_dependencies,
  :export_format,
  :cloud_formation_override_property_configuration,
  :request_id,
  :status,
  :include_permissions,
  :include_tags,
  :validation_strategy,
  :warnings,
  :include_folder_memberships,
  :include_folder_members)
  SENSITIVE = [:download_url]
  include Aws::Structure
end

#export_format ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-quicksight/types.rb', line 17065

class DescribeAssetBundleExportJobResponse < Struct.new(
  :job_status,
  :download_url,
  :errors,
  :arn,
  :created_time,
  :asset_bundle_export_job_id,
  :aws_account_id,
  :resource_arns,
  :include_all_dependencies,
  :export_format,
  :cloud_formation_override_property_configuration,
  :request_id,
  :status,
  :include_permissions,
  :include_tags,
  :validation_strategy,
  :warnings,
  :include_folder_memberships,
  :include_folder_members)
  SENSITIVE = [:download_url]
  include Aws::Structure
end

#include_all_dependencies ⇒ Boolean

The include dependencies flag.

Returns:

• (Boolean)

# File 'lib/aws-sdk-quicksight/types.rb', line 17065

class DescribeAssetBundleExportJobResponse < Struct.new(
  :job_status,
  :download_url,
  :errors,
  :arn,
  :created_time,
  :asset_bundle_export_job_id,
  :aws_account_id,
  :resource_arns,
  :include_all_dependencies,
  :export_format,
  :cloud_formation_override_property_configuration,
  :request_id,
  :status,
  :include_permissions,
  :include_tags,
  :validation_strategy,
  :warnings,
  :include_folder_memberships,
  :include_folder_members)
  SENSITIVE = [:download_url]
  include Aws::Structure
end

#include_folder_members ⇒ String

A setting that determines whether folder members are included.

Returns:

• (String)

# File 'lib/aws-sdk-quicksight/types.rb', line 17065

class DescribeAssetBundleExportJobResponse < Struct.new(
  :job_status,
  :download_url,
  :errors,
  :arn,
  :created_time,
  :asset_bundle_export_job_id,
  :aws_account_id,
  :resource_arns,
  :include_all_dependencies,
  :export_format,
  :cloud_formation_override_property_configuration,
  :request_id,
  :status,
  :include_permissions,
  :include_tags,
  :validation_strategy,
  :warnings,
  :include_folder_memberships,
  :include_folder_members)
  SENSITIVE = [:download_url]
  include Aws::Structure
end

#include_folder_memberships ⇒ Boolean

The include folder memberships flag.

Returns:

• (Boolean)

# File 'lib/aws-sdk-quicksight/types.rb', line 17065

class DescribeAssetBundleExportJobResponse < Struct.new(
  :job_status,
  :download_url,
  :errors,
  :arn,
  :created_time,
  :asset_bundle_export_job_id,
  :aws_account_id,
  :resource_arns,
  :include_all_dependencies,
  :export_format,
  :cloud_formation_override_property_configuration,
  :request_id,
  :status,
  :include_permissions,
  :include_tags,
  :validation_strategy,
  :warnings,
  :include_folder_memberships,
  :include_folder_members)
  SENSITIVE = [:download_url]
  include Aws::Structure
end

#include_permissions ⇒ Boolean

The include permissions flag.

Returns:

• (Boolean)

# File 'lib/aws-sdk-quicksight/types.rb', line 17065

class DescribeAssetBundleExportJobResponse < Struct.new(
  :job_status,
  :download_url,
  :errors,
  :arn,
  :created_time,
  :asset_bundle_export_job_id,
  :aws_account_id,
  :resource_arns,
  :include_all_dependencies,
  :export_format,
  :cloud_formation_override_property_configuration,
  :request_id,
  :status,
  :include_permissions,
  :include_tags,
  :validation_strategy,
  :warnings,
  :include_folder_memberships,
  :include_folder_members)
  SENSITIVE = [:download_url]
  include Aws::Structure
end

#include_tags ⇒ Boolean

The include tags flag.

Returns:

• (Boolean)

# File 'lib/aws-sdk-quicksight/types.rb', line 17065

class DescribeAssetBundleExportJobResponse < Struct.new(
  :job_status,
  :download_url,
  :errors,
  :arn,
  :created_time,
  :asset_bundle_export_job_id,
  :aws_account_id,
  :resource_arns,
  :include_all_dependencies,
  :export_format,
  :cloud_formation_override_property_configuration,
  :request_id,
  :status,
  :include_permissions,
  :include_tags,
  :validation_strategy,
  :warnings,
  :include_folder_memberships,
  :include_folder_members)
  SENSITIVE = [:download_url]
  include Aws::Structure
end

#job_status ⇒ String

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

Poll this DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or FAILED.

Returns:

• (String)

# File 'lib/aws-sdk-quicksight/types.rb', line 17065

class DescribeAssetBundleExportJobResponse < Struct.new(
  :job_status,
  :download_url,
  :errors,
  :arn,
  :created_time,
  :asset_bundle_export_job_id,
  :aws_account_id,
  :resource_arns,
  :include_all_dependencies,
  :export_format,
  :cloud_formation_override_property_configuration,
  :request_id,
  :status,
  :include_permissions,
  :include_tags,
  :validation_strategy,
  :warnings,
  :include_folder_memberships,
  :include_folder_members)
  SENSITIVE = [:download_url]
  include Aws::Structure
end

#request_id ⇒ String

The Amazon Web Services request ID for this operation.

Returns:

• (String)

# File 'lib/aws-sdk-quicksight/types.rb', line 17065

class DescribeAssetBundleExportJobResponse < Struct.new(
  :job_status,
  :download_url,
  :errors,
  :arn,
  :created_time,
  :asset_bundle_export_job_id,
  :aws_account_id,
  :resource_arns,
  :include_all_dependencies,
  :export_format,
  :cloud_formation_override_property_configuration,
  :request_id,
  :status,
  :include_permissions,
  :include_tags,
  :validation_strategy,
  :warnings,
  :include_folder_memberships,
  :include_folder_members)
  SENSITIVE = [:download_url]
  include Aws::Structure
end

#resource_arns ⇒ Array<String>

A list of resource ARNs that exported with the job.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-quicksight/types.rb', line 17065

class DescribeAssetBundleExportJobResponse < Struct.new(
  :job_status,
  :download_url,
  :errors,
  :arn,
  :created_time,
  :asset_bundle_export_job_id,
  :aws_account_id,
  :resource_arns,
  :include_all_dependencies,
  :export_format,
  :cloud_formation_override_property_configuration,
  :request_id,
  :status,
  :include_permissions,
  :include_tags,
  :validation_strategy,
  :warnings,
  :include_folder_memberships,
  :include_folder_members)
  SENSITIVE = [:download_url]
  include Aws::Structure
end

#status ⇒ Integer

The HTTP status of the response.

Returns:

• (Integer)

# File 'lib/aws-sdk-quicksight/types.rb', line 17065

class DescribeAssetBundleExportJobResponse < Struct.new(
  :job_status,
  :download_url,
  :errors,
  :arn,
  :created_time,
  :asset_bundle_export_job_id,
  :aws_account_id,
  :resource_arns,
  :include_all_dependencies,
  :export_format,
  :cloud_formation_override_property_configuration,
  :request_id,
  :status,
  :include_permissions,
  :include_tags,
  :validation_strategy,
  :warnings,
  :include_folder_memberships,
  :include_folder_members)
  SENSITIVE = [:download_url]
  include Aws::Structure
end

#validation_strategy ⇒ Types::AssetBundleExportJobValidationStrategy

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

Returns:

• (Types::AssetBundleExportJobValidationStrategy)

# File 'lib/aws-sdk-quicksight/types.rb', line 17065

class DescribeAssetBundleExportJobResponse < Struct.new(
  :job_status,
  :download_url,
  :errors,
  :arn,
  :created_time,
  :asset_bundle_export_job_id,
  :aws_account_id,
  :resource_arns,
  :include_all_dependencies,
  :export_format,
  :cloud_formation_override_property_configuration,
  :request_id,
  :status,
  :include_permissions,
  :include_tags,
  :validation_strategy,
  :warnings,
  :include_folder_memberships,
  :include_folder_members)
  SENSITIVE = [:download_url]
  include Aws::Structure
end

#warnings ⇒ Array<Types::AssetBundleExportJobWarning>

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.

Returns:

• (Array<Types::AssetBundleExportJobWarning>)

# File 'lib/aws-sdk-quicksight/types.rb', line 17065

class DescribeAssetBundleExportJobResponse < Struct.new(
  :job_status,
  :download_url,
  :errors,
  :arn,
  :created_time,
  :asset_bundle_export_job_id,
  :aws_account_id,
  :resource_arns,
  :include_all_dependencies,
  :export_format,
  :cloud_formation_override_property_configuration,
  :request_id,
  :status,
  :include_permissions,
  :include_tags,
  :validation_strategy,
  :warnings,
  :include_folder_memberships,
  :include_folder_members)
  SENSITIVE = [:download_url]
  include Aws::Structure
end