Amazonka.Forecast.ListMonitors

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.

Creating a Request

data ListMonitors

See: newListMonitors smart constructor.

Constructors

ListMonitors'

Fields

• filters :: Maybe [Filter]

  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" } ]

• maxResults :: Maybe Natural

  The maximum number of monitors to include in the response.

• nextToken :: Maybe Text

  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.

Instances

ToJSON ListMonitors

Defined in Amazonka.Forecast.ListMonitors

Methods

toJSON :: ListMonitors -> Value

toEncoding :: ListMonitors -> Encoding

toJSONList :: [ListMonitors] -> Value

toEncodingList :: [ListMonitors] -> Encoding

ToHeaders ListMonitors

Defined in Amazonka.Forecast.ListMonitors

Methods

toHeaders :: ListMonitors -> [Header]

ToPath ListMonitors

Defined in Amazonka.Forecast.ListMonitors

Methods

toPath :: ListMonitors -> ByteString

ToQuery ListMonitors

Defined in Amazonka.Forecast.ListMonitors

Methods

toQuery :: ListMonitors -> QueryString

AWSPager ListMonitors

Defined in Amazonka.Forecast.ListMonitors

Methods

page :: ListMonitors -> AWSResponse ListMonitors -> Maybe ListMonitors

AWSRequest ListMonitors

Defined in Amazonka.Forecast.ListMonitors

Associated Types

type AWSResponse ListMonitors

Methods

request :: (Service -> Service) -> ListMonitors -> Request ListMonitors

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListMonitors -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListMonitors)))

Generic ListMonitors

Defined in Amazonka.Forecast.ListMonitors

Associated Types

type Rep ListMonitors :: Type -> Type

Methods

from :: ListMonitors -> Rep ListMonitors x

to :: Rep ListMonitors x -> ListMonitors

Read ListMonitors

Defined in Amazonka.Forecast.ListMonitors

Methods

readsPrec :: Int -> ReadS ListMonitors

readList :: ReadS [ListMonitors]

readPrec :: ReadPrec ListMonitors

readListPrec :: ReadPrec [ListMonitors]

Show ListMonitors

Defined in Amazonka.Forecast.ListMonitors

Methods

showsPrec :: Int -> ListMonitors -> ShowS

show :: ListMonitors -> String

showList :: [ListMonitors] -> ShowS

NFData ListMonitors

Defined in Amazonka.Forecast.ListMonitors

Methods

rnf :: ListMonitors -> ()

Eq ListMonitors

Defined in Amazonka.Forecast.ListMonitors

Methods

(==) :: ListMonitors -> ListMonitors -> Bool

(/=) :: ListMonitors -> ListMonitors -> Bool

Hashable ListMonitors

Defined in Amazonka.Forecast.ListMonitors

Methods

hashWithSalt :: Int -> ListMonitors -> Int

hash :: ListMonitors -> Int

type AWSResponse ListMonitors

Defined in Amazonka.Forecast.ListMonitors

type AWSResponse ListMonitors = ListMonitorsResponse

type Rep ListMonitors

Defined in Amazonka.Forecast.ListMonitors

type Rep ListMonitors = D1 ('MetaData "ListMonitors" "Amazonka.Forecast.ListMonitors" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "ListMonitors'" 'PrefixI 'True) (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListMonitors :: ListMonitors

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 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" } ]

$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])

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" } ]

listMonitors_maxResults :: Lens' ListMonitors (Maybe Natural)

The maximum number of monitors to include in the response.

listMonitors_nextToken :: Lens' ListMonitors (Maybe Text)

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

See: newListMonitorsResponse smart constructor.

Constructors

ListMonitorsResponse'

Fields

• monitors :: Maybe [MonitorSummary]

  An array of objects that summarize each monitor's properties.

• nextToken :: Maybe Text

  If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListMonitorsResponse

Defined in Amazonka.Forecast.ListMonitors

Associated Types

type Rep ListMonitorsResponse :: Type -> Type

Methods

from :: ListMonitorsResponse -> Rep ListMonitorsResponse x

to :: Rep ListMonitorsResponse x -> ListMonitorsResponse

Read ListMonitorsResponse

Defined in Amazonka.Forecast.ListMonitors

Methods

readsPrec :: Int -> ReadS ListMonitorsResponse

readList :: ReadS [ListMonitorsResponse]

readPrec :: ReadPrec ListMonitorsResponse

readListPrec :: ReadPrec [ListMonitorsResponse]

Show ListMonitorsResponse

Defined in Amazonka.Forecast.ListMonitors

Methods

showsPrec :: Int -> ListMonitorsResponse -> ShowS

show :: ListMonitorsResponse -> String

showList :: [ListMonitorsResponse] -> ShowS

NFData ListMonitorsResponse

Defined in Amazonka.Forecast.ListMonitors

Methods

rnf :: ListMonitorsResponse -> ()

Eq ListMonitorsResponse

Defined in Amazonka.Forecast.ListMonitors

Methods

(==) :: ListMonitorsResponse -> ListMonitorsResponse -> Bool

(/=) :: ListMonitorsResponse -> ListMonitorsResponse -> Bool

type Rep ListMonitorsResponse

Defined in Amazonka.Forecast.ListMonitors

type Rep ListMonitorsResponse = D1 ('MetaData "ListMonitorsResponse" "Amazonka.Forecast.ListMonitors" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "ListMonitorsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "monitors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MonitorSummary])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListMonitorsResponse

Arguments

:: Int

$sel:httpStatus:ListMonitorsResponse'

-> 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])

An array of objects that summarize each monitor's properties.

listMonitorsResponse_nextToken :: Lens' ListMonitorsResponse (Maybe Text)

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

The response's http status code.