QuickSight / Paginator / ListIngestions


class QuickSight.Paginator.ListIngestions#
paginator = client.get_paginator('list_ingestions')

Creates an iterator that will paginate through responses from QuickSight.Client.list_ingestions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • DataSetId (string) –


    The ID of the dataset used in the ingestion.

  • AwsAccountId (string) –


    The Amazon Web Services account ID.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:



Response Syntax

    'Ingestions': [
            'Arn': 'string',
            'IngestionId': 'string',
            'ErrorInfo': {
                'Message': 'string'
            'RowInfo': {
                'RowsIngested': 123,
                'RowsDropped': 123,
                'TotalRowsInDataset': 123
            'QueueInfo': {
                'WaitingOnIngestion': 'string',
                'QueuedIngestion': 'string'
            'CreatedTime': datetime(2015, 1, 1),
            'IngestionTimeInSeconds': 123,
            'IngestionSizeInBytes': 123,
            'RequestSource': 'MANUAL'|'SCHEDULED',
    'RequestId': 'string',
    'Status': 123

Response Structure

  • (dict) –

    • Ingestions (list) –

      A list of the ingestions.

      • (dict) –

        Information about the SPICE ingestion for a dataset.

        • Arn (string) –

          The Amazon Resource Name (ARN) of the resource.

        • IngestionId (string) –

          Ingestion ID.

        • IngestionStatus (string) –

          Ingestion status.

        • ErrorInfo (dict) –

          Error information for this ingestion.

          • Type (string) –

            Error type.

          • Message (string) –

            Error message.

        • RowInfo (dict) –

          Information about rows for a data set SPICE ingestion.

          • RowsIngested (integer) –

            The number of rows that were ingested.

          • RowsDropped (integer) –

            The number of rows that were not ingested.

          • TotalRowsInDataset (integer) –

            The total number of rows in the dataset.

        • QueueInfo (dict) –

          Information about a queued dataset SPICE ingestion.

          • WaitingOnIngestion (string) –

            The ID of the queued ingestion.

          • QueuedIngestion (string) –

            The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing ingestion to complete.

        • CreatedTime (datetime) –

          The time that this ingestion started.

        • IngestionTimeInSeconds (integer) –

          The time that this ingestion took, measured in seconds.

        • IngestionSizeInBytes (integer) –

          The size of the data ingested, in bytes.

        • RequestSource (string) –

          Event source for this ingestion.

        • RequestType (string) –

          Type of this ingestion.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

    • Status (integer) –

      The HTTP status of the request.