:doc:`FIS <../../fis>` / Paginator / ListExperiments

***************
ListExperiments
***************



.. py:class:: FIS.Paginator.ListExperiments

  ::

    
    paginator = client.get_paginator('list_experiments')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`FIS.Client.list_experiments`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          experimentTemplateId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type experimentTemplateId: string
    :param experimentTemplateId: 

      The ID of the experiment template.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :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) --* 

          A token to resume pagination.

          
    