:doc:`MediaStoreData <../../mediastore-data>` / Client / list_items

**********
list_items
**********



.. py:method:: MediaStoreData.Client.list_items(**kwargs)

  

  Provides a list of metadata entries about folders and objects in the specified folder.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/mediastore-data-2017-09-01/ListItems>`_  


  **Request Syntax**
  ::

    response = client.list_items(
        Path='string',
        MaxResults=123,
        NextToken='string'
    )
    
  :type Path: string
  :param Path: 

    The path in the container from which to retrieve items. Format: <folder name>/<folder name>/<file name>

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return per API request. For example, you submit a ``ListItems`` request with ``MaxResults`` set at 500. Although 2,000 items match your request, the service returns no more than the first 500 items. (The service also returns a ``NextToken`` value that you can use to fetch the next batch of results.) The service might return fewer results than the ``MaxResults`` value.

     

    If ``MaxResults`` is not included in the request, the service defaults to pagination with a maximum of 1,000 results per page.

    

  
  :type NextToken: string
  :param NextToken: 

    The token that identifies which batch of results that you want to see. For example, you submit a ``ListItems`` request with ``MaxResults`` set at 500. The service returns the first batch of results (up to 500) and a ``NextToken`` value. To see the next batch of results, you can submit the ``ListItems`` request a second time and specify the ``NextToken`` value.

     

    Tokens expire after 15 minutes.

    

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

    
    ::

      {
          'Items': [
              {
                  'Name': 'string',
                  'Type': 'OBJECT'|'FOLDER',
                  'ETag': 'string',
                  'LastModified': datetime(2015, 1, 1),
                  'ContentType': 'string',
                  'ContentLength': 123
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Items** *(list) --* 

        The metadata entries for the folders and objects at the requested path.

        
        

        - *(dict) --* 

          A metadata entry for a folder or object.

          
          

          - **Name** *(string) --* 

            The name of the item.

            
          

          - **Type** *(string) --* 

            The item type (folder or object).

            
          

          - **ETag** *(string) --* 

            The ETag that represents a unique instance of the item.

            
          

          - **LastModified** *(datetime) --* 

            The date and time that the item was last modified.

            
          

          - **ContentType** *(string) --* 

            The content type of the item.

            
          

          - **ContentLength** *(integer) --* 

            The length of the item in bytes.

            
      
    
      

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

        The token that can be used in a request to view the next set of results. For example, you submit a ``ListItems`` request that matches 2,000 items with ``MaxResults`` set at 500. The service returns the first batch of results (up to 500) and a ``NextToken`` value that can be used to fetch the next batch of results.

        
  
  **Exceptions**
  
  *   :py:class:`MediaStoreData.Client.exceptions.ContainerNotFoundException`

  
  *   :py:class:`MediaStoreData.Client.exceptions.InternalServerError`

  