:doc:`QuickSight <../../quicksight>` / Client / list_ingestions

***************
list_ingestions
***************



.. py:method:: QuickSight.Client.list_ingestions(**kwargs)

  

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

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListIngestions>`_  


  **Request Syntax**
  ::

    response = client.list_ingestions(
        DataSetId='string',
        NextToken='string',
        AwsAccountId='string',
        MaxResults=123
    )
    
  :type DataSetId: string
  :param DataSetId: **[REQUIRED]** 

    The ID of the dataset used in the ingestion.

    

  
  :type NextToken: string
  :param NextToken: 

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

    

  
  :type AwsAccountId: string
  :param AwsAccountId: **[REQUIRED]** 

    The Amazon Web Services account ID.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to be returned per request.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'Ingestions': [
              {
                  'Arn': 'string',
                  'IngestionId': 'string',
                  'IngestionStatus': 'INITIALIZED'|'QUEUED'|'RUNNING'|'FAILED'|'COMPLETED'|'CANCELLED',
                  'ErrorInfo': {
                      'Type': 'FAILURE_TO_ASSUME_ROLE'|'INGESTION_SUPERSEDED'|'INGESTION_CANCELED'|'DATA_SET_DELETED'|'DATA_SET_NOT_SPICE'|'S3_UPLOADED_FILE_DELETED'|'S3_MANIFEST_ERROR'|'DATA_TOLERANCE_EXCEPTION'|'SPICE_TABLE_NOT_FOUND'|'DATA_SET_SIZE_LIMIT_EXCEEDED'|'ROW_SIZE_LIMIT_EXCEEDED'|'ACCOUNT_CAPACITY_LIMIT_EXCEEDED'|'CUSTOMER_ERROR'|'DATA_SOURCE_NOT_FOUND'|'IAM_ROLE_NOT_AVAILABLE'|'CONNECTION_FAILURE'|'SQL_TABLE_NOT_FOUND'|'PERMISSION_DENIED'|'SSL_CERTIFICATE_VALIDATION_FAILURE'|'OAUTH_TOKEN_FAILURE'|'SOURCE_API_LIMIT_EXCEEDED_FAILURE'|'PASSWORD_AUTHENTICATION_FAILURE'|'SQL_SCHEMA_MISMATCH_ERROR'|'INVALID_DATE_FORMAT'|'INVALID_DATAPREP_SYNTAX'|'SOURCE_RESOURCE_LIMIT_EXCEEDED'|'SQL_INVALID_PARAMETER_VALUE'|'QUERY_TIMEOUT'|'SQL_NUMERIC_OVERFLOW'|'UNRESOLVABLE_HOST'|'UNROUTABLE_HOST'|'SQL_EXCEPTION'|'S3_FILE_INACCESSIBLE'|'IOT_FILE_NOT_FOUND'|'IOT_DATA_SET_FILE_EMPTY'|'INVALID_DATA_SOURCE_CONFIG'|'DATA_SOURCE_AUTH_FAILED'|'DATA_SOURCE_CONNECTION_FAILED'|'FAILURE_TO_PROCESS_JSON_FILE'|'INTERNAL_SERVICE_ERROR'|'REFRESH_SUPPRESSED_BY_EDIT'|'PERMISSION_NOT_FOUND'|'ELASTICSEARCH_CURSOR_NOT_ENABLED'|'CURSOR_NOT_ENABLED'|'DUPLICATE_COLUMN_NAMES_FOUND',
                      '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',
                  'RequestType': 'INITIAL_INGESTION'|'EDIT'|'INCREMENTAL_REFRESH'|'FULL_REFRESH'
              },
          ],
          'NextToken': 'string',
          '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.

            
      
    
      

      - **NextToken** *(string) --* 

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

        
      

      - **RequestId** *(string) --* 

        The Amazon Web Services request ID for this operation.

        
      

      - **Status** *(integer) --* 

        The HTTP status of the request.

        
  
  **Exceptions**
  
  *   :py:class:`QuickSight.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`QuickSight.Client.exceptions.InvalidParameterValueException`

  
  *   :py:class:`QuickSight.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`QuickSight.Client.exceptions.ThrottlingException`

  
  *   :py:class:`QuickSight.Client.exceptions.ResourceExistsException`

  
  *   :py:class:`QuickSight.Client.exceptions.InvalidNextTokenException`

  
  *   :py:class:`QuickSight.Client.exceptions.InternalFailureException`

  