libZSservicesZSamazonka-lookoutmetricsZSamazonka-lookoutmetrics
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.LookoutMetrics.ListAlerts

Description

Lists the alerts attached to a detector.

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.

Synopsis

Creating a Request

data ListAlerts Source #

See: newListAlerts smart constructor.

Constructors

ListAlerts' 

Fields

  • anomalyDetectorArn :: Maybe Text

    The ARN of the alert's detector.

  • nextToken :: Maybe Text

    If the result of the previous request is 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.

  • maxResults :: Maybe Natural

    The maximum number of results that will be displayed by the request.

Instances

Instances details
Eq ListAlerts Source # 
Instance details

Defined in Amazonka.LookoutMetrics.ListAlerts

Read ListAlerts Source # 
Instance details

Defined in Amazonka.LookoutMetrics.ListAlerts

Show ListAlerts Source # 
Instance details

Defined in Amazonka.LookoutMetrics.ListAlerts

Generic ListAlerts Source # 
Instance details

Defined in Amazonka.LookoutMetrics.ListAlerts

Associated Types

type Rep ListAlerts :: Type -> Type #

NFData ListAlerts Source # 
Instance details

Defined in Amazonka.LookoutMetrics.ListAlerts

Methods

rnf :: ListAlerts -> () #

Hashable ListAlerts Source # 
Instance details

Defined in Amazonka.LookoutMetrics.ListAlerts

ToJSON ListAlerts Source # 
Instance details

Defined in Amazonka.LookoutMetrics.ListAlerts

AWSRequest ListAlerts Source # 
Instance details

Defined in Amazonka.LookoutMetrics.ListAlerts

Associated Types

type AWSResponse ListAlerts #

ToHeaders ListAlerts Source # 
Instance details

Defined in Amazonka.LookoutMetrics.ListAlerts

Methods

toHeaders :: ListAlerts -> [Header] #

ToPath ListAlerts Source # 
Instance details

Defined in Amazonka.LookoutMetrics.ListAlerts

ToQuery ListAlerts Source # 
Instance details

Defined in Amazonka.LookoutMetrics.ListAlerts

type Rep ListAlerts Source # 
Instance details

Defined in Amazonka.LookoutMetrics.ListAlerts

type Rep ListAlerts = D1 ('MetaData "ListAlerts" "Amazonka.LookoutMetrics.ListAlerts" "libZSservicesZSamazonka-lookoutmetricsZSamazonka-lookoutmetrics" 'False) (C1 ('MetaCons "ListAlerts'" 'PrefixI 'True) (S1 ('MetaSel ('Just "anomalyDetectorArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListAlerts Source # 
Instance details

Defined in Amazonka.LookoutMetrics.ListAlerts

newListAlerts :: ListAlerts Source #

Create a value of ListAlerts 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:anomalyDetectorArn:ListAlerts', listAlerts_anomalyDetectorArn - The ARN of the alert's detector.

$sel:nextToken:ListAlerts', listAlerts_nextToken - If the result of the previous request is 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.

$sel:maxResults:ListAlerts', listAlerts_maxResults - The maximum number of results that will be displayed by the request.

Request Lenses

listAlerts_anomalyDetectorArn :: Lens' ListAlerts (Maybe Text) Source #

The ARN of the alert's detector.

listAlerts_nextToken :: Lens' ListAlerts (Maybe Text) Source #

If the result of the previous request is 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.

listAlerts_maxResults :: Lens' ListAlerts (Maybe Natural) Source #

The maximum number of results that will be displayed by the request.

Destructuring the Response

data ListAlertsResponse Source #

See: newListAlertsResponse smart constructor.

Constructors

ListAlertsResponse' 

Fields

Instances

Instances details
Eq ListAlertsResponse Source # 
Instance details

Defined in Amazonka.LookoutMetrics.ListAlerts

Read ListAlertsResponse Source # 
Instance details

Defined in Amazonka.LookoutMetrics.ListAlerts

Show ListAlertsResponse Source # 
Instance details

Defined in Amazonka.LookoutMetrics.ListAlerts

Generic ListAlertsResponse Source # 
Instance details

Defined in Amazonka.LookoutMetrics.ListAlerts

Associated Types

type Rep ListAlertsResponse :: Type -> Type #

NFData ListAlertsResponse Source # 
Instance details

Defined in Amazonka.LookoutMetrics.ListAlerts

Methods

rnf :: ListAlertsResponse -> () #

type Rep ListAlertsResponse Source # 
Instance details

Defined in Amazonka.LookoutMetrics.ListAlerts

type Rep ListAlertsResponse = D1 ('MetaData "ListAlertsResponse" "Amazonka.LookoutMetrics.ListAlerts" "libZSservicesZSamazonka-lookoutmetricsZSamazonka-lookoutmetrics" 'False) (C1 ('MetaCons "ListAlertsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "alertSummaryList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AlertSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListAlertsResponse Source #

Create a value of ListAlertsResponse 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:nextToken:ListAlerts', listAlertsResponse_nextToken - If the response is truncated, the service returns this token. To retrieve the next set of results, use this token in the next request.

$sel:alertSummaryList:ListAlertsResponse', listAlertsResponse_alertSummaryList - Contains information about an alert.

$sel:httpStatus:ListAlertsResponse', listAlertsResponse_httpStatus - The response's http status code.

Response Lenses

listAlertsResponse_nextToken :: Lens' ListAlertsResponse (Maybe Text) Source #

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