Skip to content

describe_asset_bundle_import_job

describe_asset_bundle_import_job(
    aws_account_id: AwsAccountId,
    asset_bundle_import_job_id: ShortRestrictiveResourceId,
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
) -> DescribeAssetBundleImportJobResponse

Describes an existing import job.

Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts.

Parameters:

  • aws_account_id (AwsAccountId) –

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

  • asset_bundle_import_job_id (ShortRestrictiveResourceId) –

    The ID of the job. The job ID is set when you start a new job with a StartAssetBundleImportJob 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_import_job(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    asset_bundle_import_job_id: "capo_quicksight.types.short_restrictive_resource_id.ShortRestrictiveResourceId",
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
) -> "capo_quicksight.types.describe_asset_bundle_import_job_response.DescribeAssetBundleImportJobResponse":
    """<p>Describes an existing import job.</p> <p>Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts.</p>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account the import job was executed in. </p>
        asset_bundle_import_job_id: <p>The ID of the job. The job ID is set when you start a new job with a <code>StartAssetBundleImportJob</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_import_job_request.DescribeAssetBundleImportJobRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.describe_asset_bundle_import_job_response.DescribeAssetBundleImportJobResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.describe_asset_bundle_import_job

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

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

        return capo_quicksight.types.describe_asset_bundle_import_job_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "DescribeAssetBundleImportJob", redact_output=_redact_output
        ),
    )
    input_: capo_quicksight.types.describe_asset_bundle_import_job_request.DescribeAssetBundleImportJobRequest = {
        "aws_account_id": aws_account_id,
        "asset_bundle_import_job_id": asset_bundle_import_job_id,
    }

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