NetworkFlowMonitor / Paginator / ListMonitors

ListMonitors¶

class NetworkFlowMonitor.Paginator.ListMonitors¶

paginator = client.get_paginator('list_monitors')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from NetworkFlowMonitor.Client.list_monitors().

Request Syntax

response_iterator = paginator.paginate(
    monitorStatus='PENDING'|'ACTIVE'|'INACTIVE'|'ERROR'|'DELETING',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

monitorStatus (string) –
The status of a monitor. The status can be one of the following
- PENDING: The monitor is in the process of being created.
- ACTIVE: The monitor is active.
- INACTIVE: The monitor is inactive.
- ERROR: Monitor creation failed due to an error.
- DELETING: The monitor is in the process of being deleted.
PaginationConfig (dict) –
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.

Return type:

dict

Returns:

Response Syntax

{
    'monitors': [
        {
            'monitorArn': 'string',
            'monitorName': 'string',
            'monitorStatus': 'PENDING'|'ACTIVE'|'INACTIVE'|'ERROR'|'DELETING'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- monitors (list) –
  
  The monitors that are in an account.
  - (dict) –
    
    A summary of information about a monitor, includ the ARN, the name, and the status.
    - monitorArn (string) –
      
      The Amazon Resource Name (ARN) of the monitor.
    - monitorName (string) –
      
      The name of the monitor.
    - monitorStatus (string) –
      
      The status of a monitor. The status can be one of the following
      - PENDING: The monitor is in the process of being created.
      - ACTIVE: The monitor is active.
      - INACTIVE: The monitor is inactive.
      - ERROR: Monitor creation failed due to an error.
      - DELETING: The monitor is in the process of being deleted.
- NextToken (string) –
  
  A token to resume pagination.