Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.XRay.GetTimeSeriesServiceStatistics

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

This operation returns paginated results.

Synopsis

Creating a Request

data GetTimeSeriesServiceStatistics Source #

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.
period :: Maybe Int
Aggregation period in seconds.
forecastStatistics :: Maybe Bool
The forecasted high and low fault count values. Forecast enabled requests require the EntitySelectorExpression ID be provided.
nextToken :: Maybe Text
Pagination token.
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.
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

Instances details

Eq GetTimeSeriesServiceStatistics Source #
Instance details Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics Methods (==) :: GetTimeSeriesServiceStatistics -> GetTimeSeriesServiceStatistics -> Bool # (/=) :: GetTimeSeriesServiceStatistics -> GetTimeSeriesServiceStatistics -> Bool #
Read GetTimeSeriesServiceStatistics Source #
Instance details Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics Methods readsPrec :: Int -> ReadS GetTimeSeriesServiceStatistics # readList :: ReadS [GetTimeSeriesServiceStatistics] # readPrec :: ReadPrec GetTimeSeriesServiceStatistics # readListPrec :: ReadPrec [GetTimeSeriesServiceStatistics] #
Show GetTimeSeriesServiceStatistics Source #
Instance details Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics Methods showsPrec :: Int -> GetTimeSeriesServiceStatistics -> ShowS # show :: GetTimeSeriesServiceStatistics -> String # showList :: [GetTimeSeriesServiceStatistics] -> ShowS #
Generic GetTimeSeriesServiceStatistics Source #
Instance details Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics Associated Types type Rep GetTimeSeriesServiceStatistics :: Type -> Type # Methods from :: GetTimeSeriesServiceStatistics -> Rep GetTimeSeriesServiceStatistics x # to :: Rep GetTimeSeriesServiceStatistics x -> GetTimeSeriesServiceStatistics #
NFData GetTimeSeriesServiceStatistics Source #
Instance details Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics Methods rnf :: GetTimeSeriesServiceStatistics -> () #
Hashable GetTimeSeriesServiceStatistics Source #
Instance details Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics Methods hashWithSalt :: Int -> GetTimeSeriesServiceStatistics -> Int # hash :: GetTimeSeriesServiceStatistics -> Int #
ToJSON GetTimeSeriesServiceStatistics Source #
Instance details Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics Methods toJSON :: GetTimeSeriesServiceStatistics -> Value # toEncoding :: GetTimeSeriesServiceStatistics -> Encoding # toJSONList :: [GetTimeSeriesServiceStatistics] -> Value # toEncodingList :: [GetTimeSeriesServiceStatistics] -> Encoding #
AWSPager GetTimeSeriesServiceStatistics Source #
Instance details Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics Methods page :: GetTimeSeriesServiceStatistics -> AWSResponse GetTimeSeriesServiceStatistics -> Maybe GetTimeSeriesServiceStatistics #
AWSRequest GetTimeSeriesServiceStatistics Source #
Instance details Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics Associated Types type AWSResponse GetTimeSeriesServiceStatistics # Methods request :: GetTimeSeriesServiceStatistics -> Request GetTimeSeriesServiceStatistics # response :: MonadResource m => Logger -> Service -> Proxy GetTimeSeriesServiceStatistics -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetTimeSeriesServiceStatistics))) #
ToHeaders GetTimeSeriesServiceStatistics Source #
Instance details Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics Methods toHeaders :: GetTimeSeriesServiceStatistics -> [Header] #
ToPath GetTimeSeriesServiceStatistics Source #
Instance details Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics Methods toPath :: GetTimeSeriesServiceStatistics -> ByteString #
ToQuery GetTimeSeriesServiceStatistics Source #
Instance details Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics Methods toQuery :: GetTimeSeriesServiceStatistics -> QueryString #
type Rep GetTimeSeriesServiceStatistics Source #
Instance details Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics type Rep GetTimeSeriesServiceStatistics = D1 ('MetaData "GetTimeSeriesServiceStatistics" "Amazonka.XRay.GetTimeSeriesServiceStatistics" "libZSservicesZSamazonka-xrayZSamazonka-xray" 'False) (C1 ('MetaCons "GetTimeSeriesServiceStatistics'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "entitySelectorExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "period") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "forecastStatistics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "groupARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "groupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)))))
type AWSResponse GetTimeSeriesServiceStatistics Source #
Instance details Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics type AWSResponse GetTimeSeriesServiceStatistics = GetTimeSeriesServiceStatisticsResponse

newGetTimeSeriesServiceStatistics Source #

Arguments

:: UTCTime	`$sel:startTime:GetTimeSeriesServiceStatistics'`
-> UTCTime	`$sel:endTime: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:period:GetTimeSeriesServiceStatistics', getTimeSeriesServiceStatistics_period - Aggregation period in seconds.

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

$sel:nextToken:GetTimeSeriesServiceStatistics', getTimeSeriesServiceStatistics_nextToken - Pagination token.

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

$sel:groupName:GetTimeSeriesServiceStatistics', getTimeSeriesServiceStatistics_groupName - The case-sensitive name of the group for which to pull statistics from.

$sel:startTime:GetTimeSeriesServiceStatistics', getTimeSeriesServiceStatistics_startTime - The start of the time frame for which to aggregate statistics.

$sel:endTime:GetTimeSeriesServiceStatistics', getTimeSeriesServiceStatistics_endTime - The end of the time frame for which to aggregate statistics.

Request Lenses

getTimeSeriesServiceStatistics_entitySelectorExpression :: Lens' GetTimeSeriesServiceStatistics (Maybe Text) Source #

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_period :: Lens' GetTimeSeriesServiceStatistics (Maybe Int) Source #

Aggregation period in seconds.

getTimeSeriesServiceStatistics_forecastStatistics :: Lens' GetTimeSeriesServiceStatistics (Maybe Bool) Source #

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

getTimeSeriesServiceStatistics_nextToken :: Lens' GetTimeSeriesServiceStatistics (Maybe Text) Source #

Pagination token.

getTimeSeriesServiceStatistics_groupARN :: Lens' GetTimeSeriesServiceStatistics (Maybe Text) Source #

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

getTimeSeriesServiceStatistics_groupName :: Lens' GetTimeSeriesServiceStatistics (Maybe Text) Source #

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

getTimeSeriesServiceStatistics_startTime :: Lens' GetTimeSeriesServiceStatistics UTCTime Source #

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

getTimeSeriesServiceStatistics_endTime :: Lens' GetTimeSeriesServiceStatistics UTCTime Source #

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

Destructuring the Response

data GetTimeSeriesServiceStatisticsResponse Source #

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.
timeSeriesServiceStatistics :: Maybe [TimeSeriesServiceStatistics]
The collection of statistics.
nextToken :: Maybe Text
Pagination token.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq GetTimeSeriesServiceStatisticsResponse Source #
Instance details Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics Methods (==) :: GetTimeSeriesServiceStatisticsResponse -> GetTimeSeriesServiceStatisticsResponse -> Bool # (/=) :: GetTimeSeriesServiceStatisticsResponse -> GetTimeSeriesServiceStatisticsResponse -> Bool #
Read GetTimeSeriesServiceStatisticsResponse Source #
Instance details Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics Methods readsPrec :: Int -> ReadS GetTimeSeriesServiceStatisticsResponse # readList :: ReadS [GetTimeSeriesServiceStatisticsResponse] # readPrec :: ReadPrec GetTimeSeriesServiceStatisticsResponse # readListPrec :: ReadPrec [GetTimeSeriesServiceStatisticsResponse] #
Show GetTimeSeriesServiceStatisticsResponse Source #
Instance details Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics Methods showsPrec :: Int -> GetTimeSeriesServiceStatisticsResponse -> ShowS # show :: GetTimeSeriesServiceStatisticsResponse -> String # showList :: [GetTimeSeriesServiceStatisticsResponse] -> ShowS #
Generic GetTimeSeriesServiceStatisticsResponse Source #
Instance details Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics Associated Types type Rep GetTimeSeriesServiceStatisticsResponse :: Type -> Type # Methods from :: GetTimeSeriesServiceStatisticsResponse -> Rep GetTimeSeriesServiceStatisticsResponse x # to :: Rep GetTimeSeriesServiceStatisticsResponse x -> GetTimeSeriesServiceStatisticsResponse #
NFData GetTimeSeriesServiceStatisticsResponse Source #
Instance details Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics Methods rnf :: GetTimeSeriesServiceStatisticsResponse -> () #
type Rep GetTimeSeriesServiceStatisticsResponse Source #
Instance details Defined in Amazonka.XRay.GetTimeSeriesServiceStatistics type Rep GetTimeSeriesServiceStatisticsResponse = D1 ('MetaData "GetTimeSeriesServiceStatisticsResponse" "Amazonka.XRay.GetTimeSeriesServiceStatistics" "libZSservicesZSamazonka-xrayZSamazonka-xray" 'False) (C1 ('MetaCons "GetTimeSeriesServiceStatisticsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "containsOldGroupVersions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "timeSeriesServiceStatistics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TimeSeriesServiceStatistics]))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetTimeSeriesServiceStatisticsResponse Source #

Arguments

:: Int	`$sel:httpStatus: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.

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

$sel:nextToken:GetTimeSeriesServiceStatistics', getTimeSeriesServiceStatisticsResponse_nextToken - Pagination token.

$sel:httpStatus:GetTimeSeriesServiceStatisticsResponse', getTimeSeriesServiceStatisticsResponse_httpStatus - The response's http status code.

Response Lenses

getTimeSeriesServiceStatisticsResponse_containsOldGroupVersions :: Lens' GetTimeSeriesServiceStatisticsResponse (Maybe Bool) Source #

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_timeSeriesServiceStatistics :: Lens' GetTimeSeriesServiceStatisticsResponse (Maybe [TimeSeriesServiceStatistics]) Source #

The collection of statistics.

getTimeSeriesServiceStatisticsResponse_nextToken :: Lens' GetTimeSeriesServiceStatisticsResponse (Maybe Text) Source #

Pagination token.

getTimeSeriesServiceStatisticsResponse_httpStatus :: Lens' GetTimeSeriesServiceStatisticsResponse Int Source #

The response's http status code.