ListMonitors¶

class ForecastService.Paginator.ListMonitors¶

paginator = client.get_paginator('list_monitors')

paginate(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        {
            'Key': 'string',
            'Value': 'string',
            'Condition': 'IS'|'IS_NOT'
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

Filters (list) --
An array of filters. For each filter, provide a condition and a match statement. The condition is either IS or IS_NOT , which specifies whether to include or exclude the resources that match the statement from the list. The match statement consists of a key and a value.

Filter properties
- Condition - The condition to apply. Valid values are IS and IS_NOT .
- Key - The name of the parameter to filter on. The only valid value is Status .
- Value - The value to match.
For example, to list all monitors who's status is ACTIVE, you would specify:

"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]
- (dict) --
  Describes a filter for choosing a subset of objects. Each filter consists of a condition and a match statement. The condition is either IS or IS_NOT , which specifies whether to include or exclude the objects that match the statement, respectively. The match statement consists of a key and a value.
  - Key (string) -- [REQUIRED]
    The name of the parameter to filter on.
  - Value (string) -- [REQUIRED]
    The value to match.
  - Condition (string) -- [REQUIRED]
    The condition to apply. To include the objects that match the statement, specify IS . To exclude matching objects, specify IS_NOT .
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',
            'ResourceArn': 'string',
            'Status': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastModificationTime': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

(dict) --
- Monitors (list) --
  
  An array of objects that summarize each monitor's properties.
  - (dict) --
    
    Provides a summary of the monitor properties used in the ListMonitors operation. To get a complete set of properties, call the DescribeMonitor operation, and provide the listed MonitorArn .
    - MonitorArn (string) --
      
      The Amazon Resource Name (ARN) of the monitor resource.
    - MonitorName (string) --
      
      The name of the monitor resource.
    - ResourceArn (string) --
      
      The Amazon Resource Name (ARN) of the predictor being monitored.
    - Status (string) --
      
      The status of the monitor. States include:
      - ACTIVE
      - ACTIVE_STOPPING , ACTIVE_STOPPED
      - UPDATE_IN_PROGRESS
      - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED
      - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED
    - CreationTime (datetime) --
      
      When the monitor resource was created.
    - LastModificationTime (datetime) --
      
      The last time the monitor resource was modified. The timestamp depends on the status of the job:
      - CREATE_PENDING - The CreationTime .
      - CREATE_IN_PROGRESS - The current timestamp.
      - STOPPED - When the resource stopped.
      - ACTIVE or CREATE_FAILED - When the monitor creation finished or failed.

Table Of Contents

ListMonitors¶