amazonka-rum-2.0: Amazon CloudWatch RUM SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Rum.GetAppMonitorData

Description

Retrieves the raw performance events that RUM has collected from your web application, so that you can do your own processing or analysis of this data.

This operation returns paginated results.

Synopsis

Creating a Request

data GetAppMonitorData Source #

See: newGetAppMonitorData smart constructor.

Constructors

GetAppMonitorData' 

Fields

  • filters :: Maybe [QueryFilter]

    An array of structures that you can use to filter the results to those that match one or more sets of key-value pairs that you specify.

  • maxResults :: Maybe Natural

    The maximum number of results to return in one operation.

  • nextToken :: Maybe Text

    Use the token returned by the previous operation to request the next page of results.

  • name :: Text

    The name of the app monitor that collected the data that you want to retrieve.

  • timeRange :: TimeRange

    A structure that defines the time range that you want to retrieve results from.

Instances

Instances details
ToJSON GetAppMonitorData Source # 
Instance details

Defined in Amazonka.Rum.GetAppMonitorData

ToHeaders GetAppMonitorData Source # 
Instance details

Defined in Amazonka.Rum.GetAppMonitorData

ToPath GetAppMonitorData Source # 
Instance details

Defined in Amazonka.Rum.GetAppMonitorData

ToQuery GetAppMonitorData Source # 
Instance details

Defined in Amazonka.Rum.GetAppMonitorData

AWSPager GetAppMonitorData Source # 
Instance details

Defined in Amazonka.Rum.GetAppMonitorData

AWSRequest GetAppMonitorData Source # 
Instance details

Defined in Amazonka.Rum.GetAppMonitorData

Associated Types

type AWSResponse GetAppMonitorData #

Generic GetAppMonitorData Source # 
Instance details

Defined in Amazonka.Rum.GetAppMonitorData

Associated Types

type Rep GetAppMonitorData :: Type -> Type #

Read GetAppMonitorData Source # 
Instance details

Defined in Amazonka.Rum.GetAppMonitorData

Show GetAppMonitorData Source # 
Instance details

Defined in Amazonka.Rum.GetAppMonitorData

NFData GetAppMonitorData Source # 
Instance details

Defined in Amazonka.Rum.GetAppMonitorData

Methods

rnf :: GetAppMonitorData -> () #

Eq GetAppMonitorData Source # 
Instance details

Defined in Amazonka.Rum.GetAppMonitorData

Hashable GetAppMonitorData Source # 
Instance details

Defined in Amazonka.Rum.GetAppMonitorData

type AWSResponse GetAppMonitorData Source # 
Instance details

Defined in Amazonka.Rum.GetAppMonitorData

type Rep GetAppMonitorData Source # 
Instance details

Defined in Amazonka.Rum.GetAppMonitorData

type Rep GetAppMonitorData = D1 ('MetaData "GetAppMonitorData" "Amazonka.Rum.GetAppMonitorData" "amazonka-rum-2.0-2UnkV4TSIBwJW5RXOw3bOY" 'False) (C1 ('MetaCons "GetAppMonitorData'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [QueryFilter])) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "timeRange") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TimeRange)))))

newGetAppMonitorData Source #

Create a value of GetAppMonitorData 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:GetAppMonitorData', getAppMonitorData_filters - An array of structures that you can use to filter the results to those that match one or more sets of key-value pairs that you specify.

$sel:maxResults:GetAppMonitorData', getAppMonitorData_maxResults - The maximum number of results to return in one operation.

GetAppMonitorData, getAppMonitorData_nextToken - Use the token returned by the previous operation to request the next page of results.

GetAppMonitorData, getAppMonitorData_name - The name of the app monitor that collected the data that you want to retrieve.

$sel:timeRange:GetAppMonitorData', getAppMonitorData_timeRange - A structure that defines the time range that you want to retrieve results from.

Request Lenses

getAppMonitorData_filters :: Lens' GetAppMonitorData (Maybe [QueryFilter]) Source #

An array of structures that you can use to filter the results to those that match one or more sets of key-value pairs that you specify.

getAppMonitorData_maxResults :: Lens' GetAppMonitorData (Maybe Natural) Source #

The maximum number of results to return in one operation.

getAppMonitorData_nextToken :: Lens' GetAppMonitorData (Maybe Text) Source #

Use the token returned by the previous operation to request the next page of results.

getAppMonitorData_name :: Lens' GetAppMonitorData Text Source #

The name of the app monitor that collected the data that you want to retrieve.

getAppMonitorData_timeRange :: Lens' GetAppMonitorData TimeRange Source #

A structure that defines the time range that you want to retrieve results from.

Destructuring the Response

data GetAppMonitorDataResponse Source #

See: newGetAppMonitorDataResponse smart constructor.

Constructors

GetAppMonitorDataResponse' 

Fields

  • events :: Maybe [Text]

    The events that RUM collected that match your request.

  • nextToken :: Maybe Text

    A token that you can use in a subsequent operation to retrieve the next set of results.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic GetAppMonitorDataResponse Source # 
Instance details

Defined in Amazonka.Rum.GetAppMonitorData

Associated Types

type Rep GetAppMonitorDataResponse :: Type -> Type #

Read GetAppMonitorDataResponse Source # 
Instance details

Defined in Amazonka.Rum.GetAppMonitorData

Show GetAppMonitorDataResponse Source # 
Instance details

Defined in Amazonka.Rum.GetAppMonitorData

NFData GetAppMonitorDataResponse Source # 
Instance details

Defined in Amazonka.Rum.GetAppMonitorData

Eq GetAppMonitorDataResponse Source # 
Instance details

Defined in Amazonka.Rum.GetAppMonitorData

type Rep GetAppMonitorDataResponse Source # 
Instance details

Defined in Amazonka.Rum.GetAppMonitorData

type Rep GetAppMonitorDataResponse = D1 ('MetaData "GetAppMonitorDataResponse" "Amazonka.Rum.GetAppMonitorData" "amazonka-rum-2.0-2UnkV4TSIBwJW5RXOw3bOY" 'False) (C1 ('MetaCons "GetAppMonitorDataResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "events") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetAppMonitorDataResponse Source #

Create a value of GetAppMonitorDataResponse 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:events:GetAppMonitorDataResponse', getAppMonitorDataResponse_events - The events that RUM collected that match your request.

GetAppMonitorData, getAppMonitorDataResponse_nextToken - A token that you can use in a subsequent operation to retrieve the next set of results.

$sel:httpStatus:GetAppMonitorDataResponse', getAppMonitorDataResponse_httpStatus - The response's http status code.

Response Lenses

getAppMonitorDataResponse_events :: Lens' GetAppMonitorDataResponse (Maybe [Text]) Source #

The events that RUM collected that match your request.

getAppMonitorDataResponse_nextToken :: Lens' GetAppMonitorDataResponse (Maybe Text) Source #

A token that you can use in a subsequent operation to retrieve the next set of results.