Struct aws_sdk_quicksight::operation::describe_asset_bundle_export_job::DescribeAssetBundleExportJobOutput

#[non_exhaustive]
pub struct DescribeAssetBundleExportJobOutput {

    pub job_status: Option<AssetBundleExportJobStatus>,
    pub download_url: Option<String>,
    pub errors: Option<Vec<AssetBundleExportJobError>>,
    pub arn: Option<String>,
    pub created_time: Option<DateTime>,
    pub asset_bundle_export_job_id: Option<String>,
    pub aws_account_id: Option<String>,
    pub resource_arns: Option<Vec<String>>,
    pub include_all_dependencies: bool,
    pub export_format: Option<AssetBundleExportFormat>,
    pub cloud_formation_override_property_configuration: Option<AssetBundleCloudFormationOverridePropertyConfiguration>,
    pub request_id: Option<String>,
    pub status: i32,
    pub include_permissions: bool,
    pub include_tags: bool,
    pub validation_strategy: Option<AssetBundleExportJobValidationStrategy>,
    pub warnings: Option<Vec<AssetBundleExportJobWarning>>,
    /* private fields */
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

job_status: Option<AssetBundleExportJobStatus>

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

Poll this DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or FAILED.

download_url: Option<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.

errors: Option<Vec<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.

arn: Option<String>

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

created_time: Option<DateTime>

The time that the export job was created.

asset_bundle_export_job_id: Option<String>

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

aws_account_id: Option<String>

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

resource_arns: Option<Vec<String>>

A list of resource ARNs that exported with the job.

include_all_dependencies: bool

The include dependencies flag.

export_format: Option<AssetBundleExportFormat>

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.

cloud_formation_override_property_configuration: Option<AssetBundleCloudFormationOverridePropertyConfiguration>

The CloudFormation override property configuration for the export job.

request_id: Option<String>

The Amazon Web Services request ID for this operation.

status: i32

The HTTP status of the response.

include_permissions: bool

The include permissions flag.

include_tags: bool

The include tags flag.

validation_strategy: Option<AssetBundleExportJobValidationStrategy>

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

warnings: Option<Vec<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.

Implementations

impl DescribeAssetBundleExportJobOutput

pub fn job_status(&self) -> Option<&AssetBundleExportJobStatus>

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

Poll this DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or FAILED.

pub fn download_url(&self) -> Option<&str>

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.

pub fn errors(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .errors.is_none().

pub fn arn(&self) -> Option<&str>

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

pub fn created_time(&self) -> Option<&DateTime>

The time that the export job was created.

pub fn asset_bundle_export_job_id(&self) -> Option<&str>

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

pub fn aws_account_id(&self) -> Option<&str>

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

pub fn resource_arns(&self) -> &[String]

A list of resource ARNs that exported with the job.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .resource_arns.is_none().

pub fn include_all_dependencies(&self) -> bool

The include dependencies flag.

pub fn export_format(&self) -> Option<&AssetBundleExportFormat>

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.

pub fn cloud_formation_override_property_configuration( &self, ) -> Option<&AssetBundleCloudFormationOverridePropertyConfiguration>

The CloudFormation override property configuration for the export job.

pub fn request_id(&self) -> Option<&str>

The Amazon Web Services request ID for this operation.

pub fn status(&self) -> i32

The HTTP status of the response.

pub fn include_permissions(&self) -> bool

The include permissions flag.

pub fn include_tags(&self) -> bool

The include tags flag.

pub fn validation_strategy( &self, ) -> Option<&AssetBundleExportJobValidationStrategy>

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

pub fn warnings(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .warnings.is_none().

impl DescribeAssetBundleExportJobOutput

pub fn builder() -> DescribeAssetBundleExportJobOutputBuilder

Creates a new builder-style object to manufacture DescribeAssetBundleExportJobOutput.

Trait Implementations

impl Clone for DescribeAssetBundleExportJobOutput

fn clone(&self) -> DescribeAssetBundleExportJobOutput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeAssetBundleExportJobOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for DescribeAssetBundleExportJobOutput

fn eq(&self, other: &DescribeAssetBundleExportJobOutput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for DescribeAssetBundleExportJobOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for DescribeAssetBundleExportJobOutput