Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.XRay.GetTraceSummaries

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves IDs and annotations for traces available for a specified time frame using an optional filter. To get the full traces, pass the trace IDs to BatchGetTraces.

A filter expression can target traced requests that hit specific service nodes or edges, have errors, or come from a known user. For example, the following filter expression targets traces that pass through api.example.com:

service("api.example.com")

This filter expression finds traces that have an annotation named account with the value 12345:

annotation.account = "12345"

For a full list of indexed fields and keywords that you can use in filter expressions, see Using Filter Expressions in the Amazon Web Services X-Ray Developer Guide.

This operation returns paginated results.

Synopsis

data GetTraceSummaries = GetTraceSummaries' {
- filterExpression :: Maybe Text
- nextToken :: Maybe Text
- sampling :: Maybe Bool
- samplingStrategy :: Maybe SamplingStrategy
- timeRangeType :: Maybe TimeRangeType
- startTime :: POSIX
- endTime :: POSIX
}
newGetTraceSummaries :: UTCTime -> UTCTime -> GetTraceSummaries
getTraceSummaries_filterExpression :: Lens' GetTraceSummaries (Maybe Text)
getTraceSummaries_nextToken :: Lens' GetTraceSummaries (Maybe Text)
getTraceSummaries_sampling :: Lens' GetTraceSummaries (Maybe Bool)
getTraceSummaries_samplingStrategy :: Lens' GetTraceSummaries (Maybe SamplingStrategy)
getTraceSummaries_timeRangeType :: Lens' GetTraceSummaries (Maybe TimeRangeType)
getTraceSummaries_startTime :: Lens' GetTraceSummaries UTCTime
getTraceSummaries_endTime :: Lens' GetTraceSummaries UTCTime
data GetTraceSummariesResponse = GetTraceSummariesResponse' {
- approximateTime :: Maybe POSIX
- nextToken :: Maybe Text
- traceSummaries :: Maybe [TraceSummary]
- tracesProcessedCount :: Maybe Integer
- httpStatus :: Int
}
newGetTraceSummariesResponse :: Int -> GetTraceSummariesResponse
getTraceSummariesResponse_approximateTime :: Lens' GetTraceSummariesResponse (Maybe UTCTime)
getTraceSummariesResponse_nextToken :: Lens' GetTraceSummariesResponse (Maybe Text)
getTraceSummariesResponse_traceSummaries :: Lens' GetTraceSummariesResponse (Maybe [TraceSummary])
getTraceSummariesResponse_tracesProcessedCount :: Lens' GetTraceSummariesResponse (Maybe Integer)
getTraceSummariesResponse_httpStatus :: Lens' GetTraceSummariesResponse Int

Creating a Request

data GetTraceSummaries Source #

See: newGetTraceSummaries smart constructor.

Constructors

GetTraceSummaries'

Fields

filterExpression :: Maybe Text
Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements.
nextToken :: Maybe Text
Specify the pagination token returned by a previous request to retrieve the next page of results.
sampling :: Maybe Bool
Set to true to get summaries for only a subset of available traces.
samplingStrategy :: Maybe SamplingStrategy
A parameter to indicate whether to enable sampling on trace summaries. Input parameters are Name and Value.
timeRangeType :: Maybe TimeRangeType
A parameter to indicate whether to query trace summaries by TraceId or Event time.
startTime :: POSIX
The start of the time frame for which to retrieve traces.
endTime :: POSIX
The end of the time frame for which to retrieve traces.

Instances

Instances details

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

newGetTraceSummaries Source #

Arguments

:: UTCTime	`GetTraceSummaries`
-> UTCTime	`GetTraceSummaries`
-> GetTraceSummaries

Create a value of GetTraceSummaries 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:

GetTraceSummaries, getTraceSummaries_filterExpression - Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements.

GetTraceSummaries, getTraceSummaries_nextToken - Specify the pagination token returned by a previous request to retrieve the next page of results.

$sel:sampling:GetTraceSummaries', getTraceSummaries_sampling - Set to true to get summaries for only a subset of available traces.

$sel:samplingStrategy:GetTraceSummaries', getTraceSummaries_samplingStrategy - A parameter to indicate whether to enable sampling on trace summaries. Input parameters are Name and Value.

$sel:timeRangeType:GetTraceSummaries', getTraceSummaries_timeRangeType - A parameter to indicate whether to query trace summaries by TraceId or Event time.

GetTraceSummaries, getTraceSummaries_startTime - The start of the time frame for which to retrieve traces.

GetTraceSummaries, getTraceSummaries_endTime - The end of the time frame for which to retrieve traces.

Request Lenses

getTraceSummaries_filterExpression :: Lens' GetTraceSummaries (Maybe Text) Source #

Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements.

getTraceSummaries_nextToken :: Lens' GetTraceSummaries (Maybe Text) Source #

Specify the pagination token returned by a previous request to retrieve the next page of results.

getTraceSummaries_sampling :: Lens' GetTraceSummaries (Maybe Bool) Source #

Set to true to get summaries for only a subset of available traces.

getTraceSummaries_samplingStrategy :: Lens' GetTraceSummaries (Maybe SamplingStrategy) Source #

A parameter to indicate whether to enable sampling on trace summaries. Input parameters are Name and Value.

getTraceSummaries_timeRangeType :: Lens' GetTraceSummaries (Maybe TimeRangeType) Source #

A parameter to indicate whether to query trace summaries by TraceId or Event time.

getTraceSummaries_startTime :: Lens' GetTraceSummaries UTCTime Source #

The start of the time frame for which to retrieve traces.

getTraceSummaries_endTime :: Lens' GetTraceSummaries UTCTime Source #

The end of the time frame for which to retrieve traces.

Destructuring the Response

data GetTraceSummariesResponse Source #

See: newGetTraceSummariesResponse smart constructor.

Constructors

GetTraceSummariesResponse'

Fields

approximateTime :: Maybe POSIX
The start time of this page of results.
nextToken :: Maybe Text
If the requested time frame contained more than one page of results, you can use this token to retrieve the next page. The first page contains the most recent results, closest to the end of the time frame.
traceSummaries :: Maybe [TraceSummary]
Trace IDs and annotations for traces that were found in the specified time frame.
tracesProcessedCount :: Maybe Integer
The total number of traces processed, including traces that did not match the specified filter expression.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetTraceSummariesResponse Source #
Instance details Defined in Amazonka.XRay.GetTraceSummaries Associated Types type Rep GetTraceSummariesResponse :: Type -> Type # Methods from :: GetTraceSummariesResponse -> Rep GetTraceSummariesResponse x # to :: Rep GetTraceSummariesResponse x -> GetTraceSummariesResponse #
Read GetTraceSummariesResponse Source #
Instance details Defined in Amazonka.XRay.GetTraceSummaries Methods readsPrec :: Int -> ReadS GetTraceSummariesResponse # readList :: ReadS [GetTraceSummariesResponse] # readPrec :: ReadPrec GetTraceSummariesResponse # readListPrec :: ReadPrec [GetTraceSummariesResponse] #
Show GetTraceSummariesResponse Source #
Instance details Defined in Amazonka.XRay.GetTraceSummaries Methods showsPrec :: Int -> GetTraceSummariesResponse -> ShowS # show :: GetTraceSummariesResponse -> String # showList :: [GetTraceSummariesResponse] -> ShowS #
NFData GetTraceSummariesResponse Source #
Instance details Defined in Amazonka.XRay.GetTraceSummaries Methods rnf :: GetTraceSummariesResponse -> () #
Eq GetTraceSummariesResponse Source #
Instance details Defined in Amazonka.XRay.GetTraceSummaries Methods (==) :: GetTraceSummariesResponse -> GetTraceSummariesResponse -> Bool # (/=) :: GetTraceSummariesResponse -> GetTraceSummariesResponse -> Bool #
type Rep GetTraceSummariesResponse Source #
Instance details Defined in Amazonka.XRay.GetTraceSummaries type Rep GetTraceSummariesResponse = D1 ('MetaData "GetTraceSummariesResponse" "Amazonka.XRay.GetTraceSummaries" "amazonka-xray-2.0-EVMSPoflqtHB9ZqvEIOE4Q" 'False) (C1 ('MetaCons "GetTraceSummariesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "approximateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "traceSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TraceSummary])) :: (S1 ('MetaSel ('Just "tracesProcessedCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetTraceSummariesResponse Source #

Arguments

:: Int	`GetTraceSummariesResponse`
-> GetTraceSummariesResponse

Create a value of GetTraceSummariesResponse 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:approximateTime:GetTraceSummariesResponse', getTraceSummariesResponse_approximateTime - The start time of this page of results.

GetTraceSummaries, getTraceSummariesResponse_nextToken - If the requested time frame contained more than one page of results, you can use this token to retrieve the next page. The first page contains the most recent results, closest to the end of the time frame.

$sel:traceSummaries:GetTraceSummariesResponse', getTraceSummariesResponse_traceSummaries - Trace IDs and annotations for traces that were found in the specified time frame.

$sel:tracesProcessedCount:GetTraceSummariesResponse', getTraceSummariesResponse_tracesProcessedCount - The total number of traces processed, including traces that did not match the specified filter expression.

GetTraceSummariesResponse, getTraceSummariesResponse_httpStatus - The response's http status code.

Response Lenses

getTraceSummariesResponse_approximateTime :: Lens' GetTraceSummariesResponse (Maybe UTCTime) Source #

The start time of this page of results.

getTraceSummariesResponse_nextToken :: Lens' GetTraceSummariesResponse (Maybe Text) Source #

If the requested time frame contained more than one page of results, you can use this token to retrieve the next page. The first page contains the most recent results, closest to the end of the time frame.

getTraceSummariesResponse_traceSummaries :: Lens' GetTraceSummariesResponse (Maybe [TraceSummary]) Source #

Trace IDs and annotations for traces that were found in the specified time frame.

getTraceSummariesResponse_tracesProcessedCount :: Lens' GetTraceSummariesResponse (Maybe Integer) Source #

The total number of traces processed, including traces that did not match the specified filter expression.

getTraceSummariesResponse_httpStatus :: Lens' GetTraceSummariesResponse Int Source #

The response's http status code.