cancel_ingestion `async` ¶

cancel_ingestion(
    aws_account_id: AwsAccountId,
    data_set_id: String,
    ingestion_id: IngestionId,
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
) -> CancelIngestionResponse

Cancels an ongoing ingestion of data into SPICE.

Parameters:

aws_account_id (AwsAccountId) –

The Amazon Web Services account ID.
data_set_id (String) –

The ID of the dataset used in the ingestion.
ingestion_id (IngestionId) –

An ID for the ingestion.

Raises:

AccessDeniedException –

You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
InternalFailureException –

An internal failure occurred.
InvalidParameterValueException –

One or more parameters has a value that isn't valid.
ResourceExistsException –

The resource specified already exists.
ResourceNotFoundException –

One or more resources can't be found.
ThrottlingException –

Access is throttled.
UnknownServiceError –

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

Source code in docs_src/capo_quicksight/_services/async_quick_sight.py

async def cancel_ingestion(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    data_set_id: "capo_quicksight.types.string.String",
    ingestion_id: "capo_quicksight.types.ingestion_id.IngestionId",
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
) -> "capo_quicksight.types.cancel_ingestion_response.CancelIngestionResponse":
    """<p>Cancels an ongoing ingestion of data into SPICE.</p>

    Args:
        aws_account_id: <p>The Amazon Web Services account ID.</p>
        data_set_id: <p>The ID of the dataset used in the ingestion.</p>
        ingestion_id: <p>An ID for the ingestion.</p>

    Raises:
        capo_quicksight.errors.access_denied_exception.AccessDeniedException: <p>You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.</p>
        capo_quicksight.errors.internal_failure_exception.InternalFailureException: <p>An internal failure occurred.</p>
        capo_quicksight.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>One or more parameters has a value that isn't valid.</p>
        capo_quicksight.errors.resource_exists_exception.ResourceExistsException: <p>The resource specified already exists. </p>
        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.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_quicksight.types.cancel_ingestion_request.CancelIngestionRequest]",
    ) -> AsyncOperationResponse[
        "capo_quicksight.types.cancel_ingestion_response.CancelIngestionResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.cancel_ingestion

        (
            output,
            http_response,
        ) = await capo_quicksight._operations.quick_sight_20180401.cancel_ingestion.async_cancel_ingestion(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CancelIngestion")
    )
    input_: capo_quicksight.types.cancel_ingestion_request.CancelIngestionRequest = {
        "aws_account_id": aws_account_id,
        "data_set_id": data_set_id,
        "ingestion_id": ingestion_id,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

cancel_ingestion async ¶

cancel_ingestion `async` ¶