| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Forecast.ListMonitors
Description
Returns a list of monitors created with the CreateMonitor operation and CreateAutoPredictor operation. For each monitor resource, this operation returns of a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve a complete set of properties of a monitor resource by specify the monitor's ARN in the DescribeMonitor operation.
This operation returns paginated results.
Synopsis
- data ListMonitors = ListMonitors' {}
- newListMonitors :: ListMonitors
- listMonitors_filters :: Lens' ListMonitors (Maybe [Filter])
- listMonitors_maxResults :: Lens' ListMonitors (Maybe Natural)
- listMonitors_nextToken :: Lens' ListMonitors (Maybe Text)
- data ListMonitorsResponse = ListMonitorsResponse' {
- monitors :: Maybe [MonitorSummary]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListMonitorsResponse :: Int -> ListMonitorsResponse
- listMonitorsResponse_monitors :: Lens' ListMonitorsResponse (Maybe [MonitorSummary])
- listMonitorsResponse_nextToken :: Lens' ListMonitorsResponse (Maybe Text)
- listMonitorsResponse_httpStatus :: Lens' ListMonitorsResponse Int
Creating a Request
data ListMonitors Source #
See: newListMonitors smart constructor.
Constructors
| ListMonitors' | |
Fields
| |
Instances
newListMonitors :: ListMonitors Source #
Create a value of ListMonitors with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListMonitors', listMonitors_filters - 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 areISandIS_NOT.Key- The name of the parameter to filter on. The only valid value isStatus.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" } ]$sel:maxResults:ListMonitors', listMonitors_maxResults - The maximum number of monitors to include in the response.
ListMonitors, listMonitors_nextToken - If the result of the previous request was truncated, the response
includes a NextToken. To retrieve the next set of results, use the
token in the next request. Tokens expire after 24 hours.
Request Lenses
listMonitors_filters :: Lens' ListMonitors (Maybe [Filter]) Source #
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 areISandIS_NOT.Key- The name of the parameter to filter on. The only valid value isStatus.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" } ]listMonitors_maxResults :: Lens' ListMonitors (Maybe Natural) Source #
The maximum number of monitors to include in the response.
listMonitors_nextToken :: Lens' ListMonitors (Maybe Text) Source #
If the result of the previous request was truncated, the response
includes a NextToken. To retrieve the next set of results, use the
token in the next request. Tokens expire after 24 hours.
Destructuring the Response
data ListMonitorsResponse Source #
See: newListMonitorsResponse smart constructor.
Constructors
| ListMonitorsResponse' | |
Fields
| |
Instances
newListMonitorsResponse Source #
Arguments
| :: Int | |
| -> ListMonitorsResponse |
Create a value of ListMonitorsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:monitors:ListMonitorsResponse', listMonitorsResponse_monitors - An array of objects that summarize each monitor's properties.
ListMonitors, listMonitorsResponse_nextToken - If the response is truncated, Amazon Forecast returns this token. To
retrieve the next set of results, use the token in the next request.
$sel:httpStatus:ListMonitorsResponse', listMonitorsResponse_httpStatus - The response's http status code.
Response Lenses
listMonitorsResponse_monitors :: Lens' ListMonitorsResponse (Maybe [MonitorSummary]) Source #
An array of objects that summarize each monitor's properties.
listMonitorsResponse_nextToken :: Lens' ListMonitorsResponse (Maybe Text) Source #
If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.
listMonitorsResponse_httpStatus :: Lens' ListMonitorsResponse Int Source #
The response's http status code.