:doc:`CodeBuild <../../codebuild>` / Client / list_sandboxes

**************
list_sandboxes
**************



.. py:method:: CodeBuild.Client.list_sandboxes(**kwargs)

  

  Gets a list of sandboxes.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/codebuild-2016-10-06/ListSandboxes>`_  


  **Request Syntax**
  ::

    response = client.list_sandboxes(
        maxResults=123,
        sortOrder='ASCENDING'|'DESCENDING',
        nextToken='string'
    )
    
  :type maxResults: integer
  :param maxResults: 

    The maximum number of sandbox records to be retrieved.

    

  
  :type sortOrder: string
  :param sortOrder: 

    The order in which sandbox records should be retrieved.

    

  
  :type nextToken: string
  :param nextToken: 

    The next token, if any, to get paginated results. You will get this value from previous execution of list sandboxes.

    

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

    
    ::

      {
          'ids': [
              'string',
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ids** *(list) --* 

        Information about the requested sandbox IDs.

        
        

        - *(string) --* 
    
      

      - **nextToken** *(string) --* 

        Information about the next token to get paginated results.

        
  
  **Exceptions**
  
  *   :py:class:`CodeBuild.Client.exceptions.InvalidInputException`

  