:doc:`QuickSight <../../quicksight>` / Paginator / ListAnalyses

************
ListAnalyses
************



.. py:class:: QuickSight.Paginator.ListAnalyses

  ::

    
    paginator = client.get_paginator('list_analyses')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`QuickSight.Client.list_analyses`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListAnalyses>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          AwsAccountId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type AwsAccountId: string
    :param AwsAccountId: **[REQUIRED]** 

      The ID of the Amazon Web Services account that contains the analyses.

      

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

      
      ::

        {
            'AnalysisSummaryList': [
                {
                    'Arn': 'string',
                    'AnalysisId': 'string',
                    'Name': 'string',
                    'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
                    'CreatedTime': datetime(2015, 1, 1),
                    'LastUpdatedTime': datetime(2015, 1, 1)
                },
            ],
            'Status': 123,
            'RequestId': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **AnalysisSummaryList** *(list) --* 

          Metadata describing each of the analyses that are listed.

          
          

          - *(dict) --* 

            The summary metadata that describes an analysis.

            
            

            - **Arn** *(string) --* 

              The Amazon Resource Name (ARN) for the analysis.

              
            

            - **AnalysisId** *(string) --* 

              The ID of the analysis. This ID displays in the URL.

              
            

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

              The name of the analysis. This name is displayed in the Quick Sight console.

              
            

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

              The last known status for the analysis.

              
            

            - **CreatedTime** *(datetime) --* 

              The time that the analysis was created.

              
            

            - **LastUpdatedTime** *(datetime) --* 

              The time that the analysis was last updated.

              
        
      
        

        - **Status** *(integer) --* 

          The HTTP status of the request.

          
        

        - **RequestId** *(string) --* 

          The Amazon Web Services request ID for this operation.

          
    