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

*********
ListFlows
*********



.. py:class:: QuickSight.Paginator.ListFlows

  ::

    
    paginator = client.get_paginator('list_flows')

  
  

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

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

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


    **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 flow list that you are getting.

      

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

      
      ::

        {
            'FlowSummaryList': [
                {
                    'Arn': 'string',
                    'FlowId': 'string',
                    'Name': 'string',
                    'Description': 'string',
                    'CreatedTime': datetime(2015, 1, 1),
                    'CreatedBy': 'string',
                    'LastUpdatedTime': datetime(2015, 1, 1),
                    'LastUpdatedBy': 'string',
                    'PublishState': 'PUBLISHED'|'DRAFT'|'PENDING_APPROVAL',
                    'RunCount': 123,
                    'UserCount': 123,
                    'LastPublishedBy': 'string',
                    'LastPublishedAt': datetime(2015, 1, 1)
                },
            ],
            'RequestId': 'string',
            'Status': 123
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **FlowSummaryList** *(list) --* 

          A structure that contains all of the flows in your Amazon Web Services account. This structure provides basic information about the flows.

          
          

          - *(dict) --* 

            The basic information of the flow exluding its definition specifying the steps.

            
            

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

              The Amazon Resource Name (ARN) of the flow.

              
            

            - **FlowId** *(string) --* 

              The unique identifier of the flow.

              
            

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

              The display name of the flow.

              
            

            - **Description** *(string) --* 

              The description of the flow.

              
            

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

              The time this flow was created.

              
            

            - **CreatedBy** *(string) --* 

              The identifier of the principal who created the flow.

              
            

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

              The last time this flow was modified.

              
            

            - **LastUpdatedBy** *(string) --* 

              The identifier of the last principal who updated the flow.

              
            

            - **PublishState** *(string) --* 

              The publish state for the flow. The valid values are ``DRAFT``, ``PUBLISHED``, or ``PENDING_APPROVAL``.

              
            

            - **RunCount** *(integer) --* 

              The number of runs done for the flow.

              
            

            - **UserCount** *(integer) --* 

              The number of users who have used the flow.

              
            

            - **LastPublishedBy** *(string) --* 

              The identifier of the last principal who published the flow.

              
            

            - **LastPublishedAt** *(datetime) --* 

              The last time this flow was published.

              
        
      
        

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

          The Amazon Web Services request ID for this operation.

          
        

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

          The HTTP status of the request.

          
    