Skip to content

describe_asset_bundle_export_job

describe_asset_bundle_export_job(
    aws_account_id: AwsAccountId,
    asset_bundle_export_job_id: ShortRestrictiveResourceId,
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
) -> DescribeAssetBundleExportJobResponse

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.

Parameters:

  • aws_account_id (AwsAccountId) –

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

  • asset_bundle_export_job_id (ShortRestrictiveResourceId) –

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

Raises:

  • ResourceNotFoundException –

    One or more resources can't be found.

  • ThrottlingException –

    Access is throttled.

  • UnsupportedUserEditionException –

    This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_quicksight/_services/quick_sight.py
def describe_asset_bundle_export_job(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    asset_bundle_export_job_id: "capo_quicksight.types.short_restrictive_resource_id.ShortRestrictiveResourceId",
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
) -> "capo_quicksight.types.describe_asset_bundle_export_job_response.DescribeAssetBundleExportJobResponse":
    """<p>Describes an existing export job.</p> <p>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 <code>DescribeAssetBundleExportJob</code> API for a new download URL as needed.</p> <p>Job descriptions are available for 14 days after the job starts.</p>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account the export job is executed in. </p>
        asset_bundle_export_job_id: <p>The ID of the job that you want described. The job ID is set when you start a new job with a <code>StartAssetBundleExportJob</code> API call.</p>

    Raises:
        capo_quicksight.errors.resource_not_found_exception.ResourceNotFoundException: <p>One or more resources can't be found.</p>
        capo_quicksight.errors.throttling_exception.ThrottlingException: <p>Access is throttled.</p>
        capo_quicksight.errors.unsupported_user_edition_exception.UnsupportedUserEditionException: <p>This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.</p>
        capo_quicksight.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_quicksight.types.describe_asset_bundle_export_job_request.DescribeAssetBundleExportJobRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.describe_asset_bundle_export_job_response.DescribeAssetBundleExportJobResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.describe_asset_bundle_export_job

        output, http_response = (
            capo_quicksight._operations.quick_sight_20180401.describe_asset_bundle_export_job.describe_asset_bundle_export_job(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_quicksight.types.describe_asset_bundle_export_job_response.DescribeAssetBundleExportJobResponse",
    ) -> dict[str, Any]:
        import capo_quicksight.types.describe_asset_bundle_export_job_response

        return capo_quicksight.types.describe_asset_bundle_export_job_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "DescribeAssetBundleExportJob", redact_output=_redact_output
        ),
    )
    input_: capo_quicksight.types.describe_asset_bundle_export_job_request.DescribeAssetBundleExportJobRequest = {
        "aws_account_id": aws_account_id,
        "asset_bundle_export_job_id": asset_bundle_export_job_id,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output