:doc:`Outposts <../../outposts>` / Client / list_orders

***********
list_orders
***********



.. py:method:: Outposts.Client.list_orders(**kwargs)

  

  Lists the Outpost orders for your Amazon Web Services account.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/outposts-2019-12-03/ListOrders>`_  


  **Request Syntax**
  ::

    response = client.list_orders(
        OutpostIdentifierFilter='string',
        NextToken='string',
        MaxResults=123
    )
    
  :type OutpostIdentifierFilter: string
  :param OutpostIdentifierFilter: 

    The ID or the Amazon Resource Name (ARN) of the Outpost.

    

  
  :type NextToken: string
  :param NextToken: 

    The pagination token.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum page size.

    

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

    
    ::

      {
          'Orders': [
              {
                  'OutpostId': 'string',
                  'OrderId': 'string',
                  'OrderType': 'OUTPOST'|'REPLACEMENT',
                  'Status': 'RECEIVED'|'PENDING'|'PROCESSING'|'INSTALLING'|'FULFILLED'|'CANCELLED'|'PREPARING'|'IN_PROGRESS'|'DELIVERED'|'COMPLETED'|'ERROR',
                  'LineItemCountsByStatus': {
                      'string': 123
                  },
                  'OrderSubmissionDate': datetime(2015, 1, 1),
                  'OrderFulfilledDate': datetime(2015, 1, 1)
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Orders** *(list) --* 

        Information about the orders.

        
        

        - *(dict) --* 

          A summary of line items in your order.

          
          

          - **OutpostId** *(string) --* 

            The ID of the Outpost.

            
          

          - **OrderId** *(string) --* 

            The ID of the order.

            
          

          - **OrderType** *(string) --* 

            The type of order.

            
          

          - **Status** *(string) --* 

            The status of the order.

             

            
            * ``PREPARING`` - Order is received and is being prepared.
             
            * ``IN_PROGRESS`` - Order is either being built, shipped, or installed. For more information, see the ``LineItem`` status.
             
            * ``COMPLETED`` - Order is complete.
             
            * ``CANCELLED`` - Order is cancelled.
             
            * ``ERROR`` - Customer should contact support.
            

             

            .. note::

              

              The following statuses are deprecated: ``RECEIVED``, ``PENDING``, ``PROCESSING``, ``INSTALLING``, and ``FULFILLED``.

              

            
          

          - **LineItemCountsByStatus** *(dict) --* 

            The status of all line items in the order.

            
            

            - *(string) --* 
              

              - *(integer) --* 
        
      
          

          - **OrderSubmissionDate** *(datetime) --* 

            The submission date for the order.

            
          

          - **OrderFulfilledDate** *(datetime) --* 

            The fulfilment date for the order.

            
      
    
      

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

        The pagination token.

        
  
  **Exceptions**
  
  *   :py:class:`Outposts.Client.exceptions.ValidationException`

  
  *   :py:class:`Outposts.Client.exceptions.NotFoundException`

  
  *   :py:class:`Outposts.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`Outposts.Client.exceptions.InternalServerException`

  