Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
Retrieves IDs and metadata 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 AWS X-Ray Developer Guide .
This operation returns paginated results.
- getTraceSummaries :: UTCTime -> UTCTime -> GetTraceSummaries
- data GetTraceSummaries
- gtsFilterExpression :: Lens' GetTraceSummaries (Maybe Text)
- gtsNextToken :: Lens' GetTraceSummaries (Maybe Text)
- gtsSampling :: Lens' GetTraceSummaries (Maybe Bool)
- gtsStartTime :: Lens' GetTraceSummaries UTCTime
- gtsEndTime :: Lens' GetTraceSummaries UTCTime
- getTraceSummariesResponse :: Int -> GetTraceSummariesResponse
- data GetTraceSummariesResponse
- gtsrsTracesProcessedCount :: Lens' GetTraceSummariesResponse (Maybe Integer)
- gtsrsNextToken :: Lens' GetTraceSummariesResponse (Maybe Text)
- gtsrsApproximateTime :: Lens' GetTraceSummariesResponse (Maybe UTCTime)
- gtsrsTraceSummaries :: Lens' GetTraceSummariesResponse [TraceSummary]
- gtsrsResponseStatus :: Lens' GetTraceSummariesResponse Int
Creating a Request
Creates a value of GetTraceSummaries
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gtsFilterExpression
- Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements.gtsNextToken
- Specify the pagination token returned by a previous request to retrieve the next page of results.gtsSampling
- Set totrue
to get summaries for only a subset of available traces.gtsStartTime
- The start of the time frame for which to retrieve traces.gtsEndTime
- The end of the time frame for which to retrieve traces.
data GetTraceSummaries Source #
See: getTraceSummaries
smart constructor.
Request Lenses
gtsFilterExpression :: Lens' GetTraceSummaries (Maybe Text) Source #
Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements.
gtsNextToken :: Lens' GetTraceSummaries (Maybe Text) Source #
Specify the pagination token returned by a previous request to retrieve the next page of results.
gtsSampling :: Lens' GetTraceSummaries (Maybe Bool) Source #
Set to true
to get summaries for only a subset of available traces.
gtsStartTime :: Lens' GetTraceSummaries UTCTime Source #
The start of the time frame for which to retrieve traces.
gtsEndTime :: Lens' GetTraceSummaries UTCTime Source #
The end of the time frame for which to retrieve traces.
Destructuring the Response
getTraceSummariesResponse Source #
Creates a value of GetTraceSummariesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gtsrsTracesProcessedCount
- The total number of traces processed, including traces that did not match the specified filter expression.gtsrsNextToken
- 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 most recent results, closest to the end of the time frame.gtsrsApproximateTime
- The start time of this page of results.gtsrsTraceSummaries
- Trace IDs and metadata for traces that were found in the specified time frame.gtsrsResponseStatus
- -- | The response status code.
data GetTraceSummariesResponse Source #
See: getTraceSummariesResponse
smart constructor.
Response Lenses
gtsrsTracesProcessedCount :: Lens' GetTraceSummariesResponse (Maybe Integer) Source #
The total number of traces processed, including traces that did not match the specified filter expression.
gtsrsNextToken :: 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 most recent results, closest to the end of the time frame.
gtsrsApproximateTime :: Lens' GetTraceSummariesResponse (Maybe UTCTime) Source #
The start time of this page of results.
gtsrsTraceSummaries :: Lens' GetTraceSummariesResponse [TraceSummary] Source #
Trace IDs and metadata for traces that were found in the specified time frame.
gtsrsResponseStatus :: Lens' GetTraceSummariesResponse Int Source #
- - | The response status code.