:doc:`MediaConnect <../../mediaconnect>` / Client / list_flows

**********
list_flows
**********



.. py:method:: MediaConnect.Client.list_flows(**kwargs)

  

  Displays a list of flows that are associated with this account. This request returns a paginated result.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/mediaconnect-2018-11-14/ListFlows>`_  


  **Request Syntax**
  ::

    response = client.list_flows(
        MaxResults=123,
        NextToken='string'
    )
    
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return per API request.

     

    For example, you submit a ``ListFlows`` request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a ``NextToken`` value that you can use to fetch the next batch of results.)

     

    The service might return fewer results than the ``MaxResults`` value. If ``MaxResults`` is not included in the request, the service defaults to pagination with a maximum of 10 results per page.

    

  
  :type NextToken: string
  :param NextToken: 

    The token that identifies the batch of results that you want to see.

     

    For example, you submit a ``ListFlows`` request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a ``NextToken`` value. To see the next batch of results, you can submit the ``ListFlows`` request a second time and specify the ``NextToken`` value.

    

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

    
    ::

      {
          'Flows': [
              {
                  'AvailabilityZone': 'string',
                  'Description': 'string',
                  'FlowArn': 'string',
                  'Name': 'string',
                  'SourceType': 'OWNED'|'ENTITLED',
                  'Status': 'STANDBY'|'ACTIVE'|'UPDATING'|'DELETING'|'STARTING'|'STOPPING'|'ERROR',
                  'Maintenance': {
                      'MaintenanceDay': 'Monday'|'Tuesday'|'Wednesday'|'Thursday'|'Friday'|'Saturday'|'Sunday',
                      'MaintenanceDeadline': 'string',
                      'MaintenanceScheduledDate': 'string',
                      'MaintenanceStartHour': 'string'
                  }
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Flows** *(list) --* 

        A list of flow summaries.

        
        

        - *(dict) --* 

          A summary of a flow, including its ARN, Availability Zone, and source type.

          
          

          - **AvailabilityZone** *(string) --* 

            The Availability Zone that the flow was created in.

            
          

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

            A description of the flow.

            
          

          - **FlowArn** *(string) --* 

            The ARN of the flow.

            
          

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

            The name of the flow.

            
          

          - **SourceType** *(string) --* 

            The type of source. This value is either owned (originated somewhere other than an MediaConnect flow owned by another Amazon Web Services account) or entitled (originated at a MediaConnect flow owned by another Amazon Web Services account).

            
          

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

            The current status of the flow.

            
          

          - **Maintenance** *(dict) --* 

            The maintenance settings for the flow.

            
            

            - **MaintenanceDay** *(string) --* 

              A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday.

              
            

            - **MaintenanceDeadline** *(string) --* 

              The Maintenance has to be performed before this deadline in ISO UTC format. Example: 2021-01-30T08:30:00Z.

              
            

            - **MaintenanceScheduledDate** *(string) --* 

              A scheduled date in ISO UTC format when the maintenance will happen. Use YYYY-MM-DD format. Example: 2021-01-30.

              
            

            - **MaintenanceStartHour** *(string) --* 

              UTC time when the maintenance will happen. Use 24-hour HH:MM format. Minutes must be 00. Example: 13:00. The default value is 02:00.

              
        
      
    
      

      - **NextToken** *(string) --* 

        The token that identifies the batch of results that you want to see.

         

        For example, you submit a ``ListFlows`` request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a ``NextToken`` value. To see the next batch of results, you can submit the ``ListFlows`` request a second time and specify the ``NextToken`` value.

        
  
  **Exceptions**
  
  *   :py:class:`MediaConnect.Client.exceptions.BadRequestException`

  
  *   :py:class:`MediaConnect.Client.exceptions.TooManyRequestsException`

  
  *   :py:class:`MediaConnect.Client.exceptions.InternalServerErrorException`

  
  *   :py:class:`MediaConnect.Client.exceptions.ServiceUnavailableException`

  