Amazonka.XRay.GetTimeSeriesServiceStatistics

Get an aggregation of service statistics defined by a specific time range.

This operation returns paginated results.

Creating a Request

data GetTimeSeriesServiceStatistics

See: newGetTimeSeriesServiceStatistics smart constructor.

Constructors

GetTimeSeriesServiceStatistics'

Fields

• entitySelectorExpression :: Maybe Text

  A filter expression defining entities that will be aggregated for statistics. Supports ID, service, and edge functions. If no selector expression is specified, edge statistics are returned.

• forecastStatistics :: Maybe Bool

  The forecasted high and low fault count values. Forecast enabled requests require the EntitySelectorExpression ID be provided.

• groupARN :: Maybe Text

  The Amazon Resource Name (ARN) of the group for which to pull statistics from.

• groupName :: Maybe Text

  The case-sensitive name of the group for which to pull statistics from.

• nextToken :: Maybe Text

  Pagination token.

• period :: Maybe Int

  Aggregation period in seconds.

• startTime :: POSIX

  The start of the time frame for which to aggregate statistics.

• endTime :: POSIX

  The end of the time frame for which to aggregate statistics.

Instances

ToJSON GetTimeSeriesServiceStatistics

Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics

Methods

toJSON :: GetTimeSeriesServiceStatistics -> Value

toEncoding :: GetTimeSeriesServiceStatistics -> Encoding

toJSONList :: [GetTimeSeriesServiceStatistics] -> Value

toEncodingList :: [GetTimeSeriesServiceStatistics] -> Encoding

ToHeaders GetTimeSeriesServiceStatistics

Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics

Methods

toHeaders :: GetTimeSeriesServiceStatistics -> [Header]

ToPath GetTimeSeriesServiceStatistics

Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics

Methods

toPath :: GetTimeSeriesServiceStatistics -> ByteString

ToQuery GetTimeSeriesServiceStatistics

Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics

Methods

toQuery :: GetTimeSeriesServiceStatistics -> QueryString

AWSPager GetTimeSeriesServiceStatistics

Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics

Methods

page :: GetTimeSeriesServiceStatistics -> AWSResponse GetTimeSeriesServiceStatistics -> Maybe GetTimeSeriesServiceStatistics

AWSRequest GetTimeSeriesServiceStatistics

Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics

Associated Types

type AWSResponse GetTimeSeriesServiceStatistics

Methods

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

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

Generic GetTimeSeriesServiceStatistics

Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics

Associated Types

type Rep GetTimeSeriesServiceStatistics :: Type -> Type

Methods

from :: GetTimeSeriesServiceStatistics -> Rep GetTimeSeriesServiceStatistics x

to :: Rep GetTimeSeriesServiceStatistics x -> GetTimeSeriesServiceStatistics

Read GetTimeSeriesServiceStatistics

Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics

Methods

readsPrec :: Int -> ReadS GetTimeSeriesServiceStatistics

readList :: ReadS [GetTimeSeriesServiceStatistics]

readPrec :: ReadPrec GetTimeSeriesServiceStatistics

readListPrec :: ReadPrec [GetTimeSeriesServiceStatistics]

Show GetTimeSeriesServiceStatistics

Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics

Methods

showsPrec :: Int -> GetTimeSeriesServiceStatistics -> ShowS

show :: GetTimeSeriesServiceStatistics -> String

showList :: [GetTimeSeriesServiceStatistics] -> ShowS

NFData GetTimeSeriesServiceStatistics

Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics

Methods

rnf :: GetTimeSeriesServiceStatistics -> ()

Eq GetTimeSeriesServiceStatistics

Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics

Methods

(==) :: GetTimeSeriesServiceStatistics -> GetTimeSeriesServiceStatistics -> Bool

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

Hashable GetTimeSeriesServiceStatistics

Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics

Methods

hashWithSalt :: Int -> GetTimeSeriesServiceStatistics -> Int

hash :: GetTimeSeriesServiceStatistics -> Int

type AWSResponse GetTimeSeriesServiceStatistics

Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics

type AWSResponse GetTimeSeriesServiceStatistics = GetTimeSeriesServiceStatisticsResponse

type Rep GetTimeSeriesServiceStatistics

Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics

type Rep GetTimeSeriesServiceStatistics = D1 ('MetaData "GetTimeSeriesServiceStatistics" "Amazonka.XRay.GetTimeSeriesServiceStatistics" "amazonka-xray-2.0-EVMSPoflqtHB9ZqvEIOE4Q" 'False) (C1 ('MetaCons "GetTimeSeriesServiceStatistics'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "entitySelectorExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "forecastStatistics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "groupARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "groupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "period") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)))))

newGetTimeSeriesServiceStatistics

Arguments

:: UTCTime

GetTimeSeriesServiceStatistics

-> UTCTime

GetTimeSeriesServiceStatistics

-> GetTimeSeriesServiceStatistics

Create a value of GetTimeSeriesServiceStatistics 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:entitySelectorExpression:GetTimeSeriesServiceStatistics', getTimeSeriesServiceStatistics_entitySelectorExpression - A filter expression defining entities that will be aggregated for statistics. Supports ID, service, and edge functions. If no selector expression is specified, edge statistics are returned.

$sel:forecastStatistics:GetTimeSeriesServiceStatistics', getTimeSeriesServiceStatistics_forecastStatistics - The forecasted high and low fault count values. Forecast enabled requests require the EntitySelectorExpression ID be provided.

GetTimeSeriesServiceStatistics, getTimeSeriesServiceStatistics_groupARN - The Amazon Resource Name (ARN) of the group for which to pull statistics from.

GetTimeSeriesServiceStatistics, getTimeSeriesServiceStatistics_groupName - The case-sensitive name of the group for which to pull statistics from.

GetTimeSeriesServiceStatistics, getTimeSeriesServiceStatistics_nextToken - Pagination token.

$sel:period:GetTimeSeriesServiceStatistics', getTimeSeriesServiceStatistics_period - Aggregation period in seconds.

GetTimeSeriesServiceStatistics, getTimeSeriesServiceStatistics_startTime - The start of the time frame for which to aggregate statistics.

GetTimeSeriesServiceStatistics, getTimeSeriesServiceStatistics_endTime - The end of the time frame for which to aggregate statistics.

Request Lenses

getTimeSeriesServiceStatistics_entitySelectorExpression :: Lens' GetTimeSeriesServiceStatistics (Maybe Text)

A filter expression defining entities that will be aggregated for statistics. Supports ID, service, and edge functions. If no selector expression is specified, edge statistics are returned.

getTimeSeriesServiceStatistics_forecastStatistics :: Lens' GetTimeSeriesServiceStatistics (Maybe Bool)

The forecasted high and low fault count values. Forecast enabled requests require the EntitySelectorExpression ID be provided.

getTimeSeriesServiceStatistics_groupARN :: Lens' GetTimeSeriesServiceStatistics (Maybe Text)

The Amazon Resource Name (ARN) of the group for which to pull statistics from.

getTimeSeriesServiceStatistics_groupName :: Lens' GetTimeSeriesServiceStatistics (Maybe Text)

The case-sensitive name of the group for which to pull statistics from.

getTimeSeriesServiceStatistics_nextToken :: Lens' GetTimeSeriesServiceStatistics (Maybe Text)

Pagination token.

getTimeSeriesServiceStatistics_period :: Lens' GetTimeSeriesServiceStatistics (Maybe Int)

Aggregation period in seconds.

getTimeSeriesServiceStatistics_startTime :: Lens' GetTimeSeriesServiceStatistics UTCTime

The start of the time frame for which to aggregate statistics.

getTimeSeriesServiceStatistics_endTime :: Lens' GetTimeSeriesServiceStatistics UTCTime

The end of the time frame for which to aggregate statistics.

Destructuring the Response

data GetTimeSeriesServiceStatisticsResponse

See: newGetTimeSeriesServiceStatisticsResponse smart constructor.

Constructors

GetTimeSeriesServiceStatisticsResponse'

Fields

• containsOldGroupVersions :: Maybe Bool

  A flag indicating whether or not a group's filter expression has been consistent, or if a returned aggregation might show statistics from an older version of the group's filter expression.

• nextToken :: Maybe Text

  Pagination token.

• timeSeriesServiceStatistics :: Maybe [TimeSeriesServiceStatistics]

  The collection of statistics.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetTimeSeriesServiceStatisticsResponse

Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics

Associated Types

type Rep GetTimeSeriesServiceStatisticsResponse :: Type -> Type

Methods

from :: GetTimeSeriesServiceStatisticsResponse -> Rep GetTimeSeriesServiceStatisticsResponse x

to :: Rep GetTimeSeriesServiceStatisticsResponse x -> GetTimeSeriesServiceStatisticsResponse

Read GetTimeSeriesServiceStatisticsResponse

Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics

Methods

readsPrec :: Int -> ReadS GetTimeSeriesServiceStatisticsResponse

readList :: ReadS [GetTimeSeriesServiceStatisticsResponse]

readPrec :: ReadPrec GetTimeSeriesServiceStatisticsResponse

readListPrec :: ReadPrec [GetTimeSeriesServiceStatisticsResponse]

Show GetTimeSeriesServiceStatisticsResponse

Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics

Methods

showsPrec :: Int -> GetTimeSeriesServiceStatisticsResponse -> ShowS

show :: GetTimeSeriesServiceStatisticsResponse -> String

showList :: [GetTimeSeriesServiceStatisticsResponse] -> ShowS

NFData GetTimeSeriesServiceStatisticsResponse

Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics

Methods

rnf :: GetTimeSeriesServiceStatisticsResponse -> ()

Eq GetTimeSeriesServiceStatisticsResponse

Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics

Methods

(==) :: GetTimeSeriesServiceStatisticsResponse -> GetTimeSeriesServiceStatisticsResponse -> Bool

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

type Rep GetTimeSeriesServiceStatisticsResponse

Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics

type Rep GetTimeSeriesServiceStatisticsResponse = D1 ('MetaData "GetTimeSeriesServiceStatisticsResponse" "Amazonka.XRay.GetTimeSeriesServiceStatistics" "amazonka-xray-2.0-EVMSPoflqtHB9ZqvEIOE4Q" 'False) (C1 ('MetaCons "GetTimeSeriesServiceStatisticsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "containsOldGroupVersions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "timeSeriesServiceStatistics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TimeSeriesServiceStatistics])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetTimeSeriesServiceStatisticsResponse

Arguments

:: Int

GetTimeSeriesServiceStatisticsResponse

-> GetTimeSeriesServiceStatisticsResponse

Create a value of GetTimeSeriesServiceStatisticsResponse 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:containsOldGroupVersions:GetTimeSeriesServiceStatisticsResponse', getTimeSeriesServiceStatisticsResponse_containsOldGroupVersions - A flag indicating whether or not a group's filter expression has been consistent, or if a returned aggregation might show statistics from an older version of the group's filter expression.

GetTimeSeriesServiceStatistics, getTimeSeriesServiceStatisticsResponse_nextToken - Pagination token.

$sel:timeSeriesServiceStatistics:GetTimeSeriesServiceStatisticsResponse', getTimeSeriesServiceStatisticsResponse_timeSeriesServiceStatistics - The collection of statistics.

GetTimeSeriesServiceStatisticsResponse, getTimeSeriesServiceStatisticsResponse_httpStatus - The response's http status code.

Response Lenses

getTimeSeriesServiceStatisticsResponse_containsOldGroupVersions :: Lens' GetTimeSeriesServiceStatisticsResponse (Maybe Bool)

A flag indicating whether or not a group's filter expression has been consistent, or if a returned aggregation might show statistics from an older version of the group's filter expression.

getTimeSeriesServiceStatisticsResponse_nextToken :: Lens' GetTimeSeriesServiceStatisticsResponse (Maybe Text)

Pagination token.

getTimeSeriesServiceStatisticsResponse_timeSeriesServiceStatistics :: Lens' GetTimeSeriesServiceStatisticsResponse (Maybe [TimeSeriesServiceStatistics])

The collection of statistics.

getTimeSeriesServiceStatisticsResponse_httpStatus :: Lens' GetTimeSeriesServiceStatisticsResponse Int

The response's http status code.