:doc:`FIS <../../fis>` / Client / list_experiments

****************
list_experiments
****************



.. py:method:: FIS.Client.list_experiments(**kwargs)

  

  Lists your experiments.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/fis-2020-12-01/ListExperiments>`_  


  **Request Syntax**
  ::

    response = client.list_experiments(
        maxResults=123,
        nextToken='string',
        experimentTemplateId='string'
    )
    
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned ``nextToken`` value.

    

  
  :type nextToken: string
  :param nextToken: 

    The token for the next page of results.

    

  
  :type experimentTemplateId: string
  :param experimentTemplateId: 

    The ID of the experiment template.

    

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

    
    ::

      {
          'experiments': [
              {
                  'id': 'string',
                  'arn': 'string',
                  'experimentTemplateId': 'string',
                  'state': {
                      'status': 'pending'|'initiating'|'running'|'completed'|'stopping'|'stopped'|'failed'|'cancelled',
                      'reason': 'string',
                      'error': {
                          'accountId': 'string',
                          'code': 'string',
                          'location': 'string'
                      }
                  },
                  'creationTime': datetime(2015, 1, 1),
                  'tags': {
                      'string': 'string'
                  },
                  'experimentOptions': {
                      'accountTargeting': 'single-account'|'multi-account',
                      'emptyTargetResolutionMode': 'fail'|'skip',
                      'actionsMode': 'skip-all'|'run-all'
                  }
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **experiments** *(list) --* 

        The experiments.

        
        

        - *(dict) --* 

          Provides a summary of an experiment.

          
          

          - **id** *(string) --* 

            The ID of the experiment.

            
          

          - **arn** *(string) --* 

            The Amazon Resource Name (ARN) of the experiment.

            
          

          - **experimentTemplateId** *(string) --* 

            The ID of the experiment template.

            
          

          - **state** *(dict) --* 

            The state of the experiment.

            
            

            - **status** *(string) --* 

              The state of the experiment.

              
            

            - **reason** *(string) --* 

              The reason for the state.

              
            

            - **error** *(dict) --* 

              The error information of the experiment when the action has ``failed``.

              
              

              - **accountId** *(string) --* 

                The Amazon Web Services Account ID where the experiment failure occurred.

                
              

              - **code** *(string) --* 

                The error code for the failed experiment.

                
              

              - **location** *(string) --* 

                Context for the section of the experiment template that failed.

                
          
        
          

          - **creationTime** *(datetime) --* 

            The time that the experiment was created.

            
          

          - **tags** *(dict) --* 

            The tags for the experiment.

            
            

            - *(string) --* 
              

              - *(string) --* 
        
      
          

          - **experimentOptions** *(dict) --* 

            The experiment options for the experiment.

            
            

            - **accountTargeting** *(string) --* 

              The account targeting setting for an experiment.

              
            

            - **emptyTargetResolutionMode** *(string) --* 

              The empty target resolution mode for an experiment.

              
            

            - **actionsMode** *(string) --* 

              The actions mode of the experiment that is set from the StartExperiment API command.

              
        
      
    
      

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

        The token to use to retrieve the next page of results. This value is ``null`` when there are no more results to return.

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

  