Skip to content

list_ingestions async

list_ingestions(
    data_set_id: String,
    aws_account_id: AwsAccountId,
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
    next_token: Optional[String] = None,
    max_results: Optional[IngestionMaxResults] = None,
) -> ListIngestionsResponse

Lists the history of SPICE ingestions for a dataset. Limited to 5 TPS per user and 25 TPS per account.

Parameters:

  • data_set_id (String) –

    The ID of the dataset used in the ingestion.

  • next_token (Optional[String], default: None ) –

    The token for the next set of results, or null if there are no more results.

  • aws_account_id (AwsAccountId) –

    The Amazon Web Services account ID.

  • max_results (Optional[IngestionMaxResults], default: None ) –

    The maximum number of results to be returned per request.

Raises:

Source code in docs_src/capo_quicksight/_services/async_quick_sight.py
async def list_ingestions(
    self,
    data_set_id: "capo_quicksight.types.string.String",
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
    next_token: Optional["capo_quicksight.types.string.String"] = None,
    max_results: Optional[
        "capo_quicksight.types.ingestion_max_results.IngestionMaxResults"
    ] = None,
) -> "capo_quicksight.types.list_ingestions_response.ListIngestionsResponse":
    """<p>Lists the history of SPICE ingestions for a dataset. Limited to 5 TPS per user and 25 TPS per account.</p>

    Args:
        data_set_id: <p>The ID of the dataset used in the ingestion.</p>
        next_token: <p>The token for the next set of results, or null if there are no more results.</p>
        aws_account_id: <p>The Amazon Web Services account ID.</p>
        max_results: <p>The maximum number of results to be returned per request.</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_next_token_exception.InvalidNextTokenException: <p>The <code>NextToken</code> value isn't valid.</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.list_ingestions_request.ListIngestionsRequest]",
    ) -> AsyncOperationResponse[
        "capo_quicksight.types.list_ingestions_response.ListIngestionsResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.list_ingestions

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListIngestions")
    )
    input_: capo_quicksight.types.list_ingestions_request.ListIngestionsRequest = {
        "data_set_id": data_set_id,
        "aws_account_id": aws_account_id,
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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