Network.AWS.XRay.GetTraceSummaries

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.

Creating a Request

getTraceSummaries

Arguments

:: UTCTime

gtsStartTime

-> UTCTime

gtsEndTime

-> GetTraceSummaries

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 to true 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

See: getTraceSummaries smart constructor.

Instances

Eq GetTraceSummaries

Defined in Network.AWS.XRay.GetTraceSummaries

Methods

(==) :: GetTraceSummaries -> GetTraceSummaries -> Bool

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

Data GetTraceSummaries

Defined in Network.AWS.XRay.GetTraceSummaries

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetTraceSummaries -> c GetTraceSummaries

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetTraceSummaries

toConstr :: GetTraceSummaries -> Constr

dataTypeOf :: GetTraceSummaries -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GetTraceSummaries)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetTraceSummaries)

gmapT :: (forall b. Data b => b -> b) -> GetTraceSummaries -> GetTraceSummaries

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetTraceSummaries -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetTraceSummaries -> r

gmapQ :: (forall d. Data d => d -> u) -> GetTraceSummaries -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetTraceSummaries -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetTraceSummaries -> m GetTraceSummaries

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetTraceSummaries -> m GetTraceSummaries

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetTraceSummaries -> m GetTraceSummaries

Read GetTraceSummaries

Defined in Network.AWS.XRay.GetTraceSummaries

Methods

readsPrec :: Int -> ReadS GetTraceSummaries

readList :: ReadS [GetTraceSummaries]

readPrec :: ReadPrec GetTraceSummaries

readListPrec :: ReadPrec [GetTraceSummaries]

Show GetTraceSummaries

Defined in Network.AWS.XRay.GetTraceSummaries

Methods

showsPrec :: Int -> GetTraceSummaries -> ShowS

show :: GetTraceSummaries -> String

showList :: [GetTraceSummaries] -> ShowS

Generic GetTraceSummaries

Defined in Network.AWS.XRay.GetTraceSummaries

Associated Types

type Rep GetTraceSummaries :: Type -> Type

Methods

from :: GetTraceSummaries -> Rep GetTraceSummaries x

to :: Rep GetTraceSummaries x -> GetTraceSummaries

Hashable GetTraceSummaries

Defined in Network.AWS.XRay.GetTraceSummaries

Methods

hashWithSalt :: Int -> GetTraceSummaries -> Int

hash :: GetTraceSummaries -> Int

ToJSON GetTraceSummaries

Defined in Network.AWS.XRay.GetTraceSummaries

Methods

toJSON :: GetTraceSummaries -> Value

toEncoding :: GetTraceSummaries -> Encoding

toJSONList :: [GetTraceSummaries] -> Value

toEncodingList :: [GetTraceSummaries] -> Encoding

AWSPager GetTraceSummaries

Defined in Network.AWS.XRay.GetTraceSummaries

Methods

page :: GetTraceSummaries -> Rs GetTraceSummaries -> Maybe GetTraceSummaries

AWSRequest GetTraceSummaries

Defined in Network.AWS.XRay.GetTraceSummaries

Associated Types

type Rs GetTraceSummaries :: Type

Methods

request :: GetTraceSummaries -> Request GetTraceSummaries

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy GetTraceSummaries -> ClientResponse -> m (Response GetTraceSummaries)

ToHeaders GetTraceSummaries

Defined in Network.AWS.XRay.GetTraceSummaries

Methods

toHeaders :: GetTraceSummaries -> [Header]

ToPath GetTraceSummaries

Defined in Network.AWS.XRay.GetTraceSummaries

Methods

toPath :: GetTraceSummaries -> ByteString

ToQuery GetTraceSummaries

Defined in Network.AWS.XRay.GetTraceSummaries

Methods

toQuery :: GetTraceSummaries -> QueryString

NFData GetTraceSummaries

Defined in Network.AWS.XRay.GetTraceSummaries

Methods

rnf :: GetTraceSummaries -> ()

type Rep GetTraceSummaries

Defined in Network.AWS.XRay.GetTraceSummaries

type Rep GetTraceSummaries = D1 (MetaData "GetTraceSummaries" "Network.AWS.XRay.GetTraceSummaries" "amazonka-xray-1.6.1-6uyA4HRXo0kJ9ryfmHEerX" False) (C1 (MetaCons "GetTraceSummaries'" PrefixI True) ((S1 (MetaSel (Just "_gtsFilterExpression") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_gtsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_gtsSampling") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 (MetaSel (Just "_gtsStartTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 POSIX) :*: S1 (MetaSel (Just "_gtsEndTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 POSIX)))))

type Rs GetTraceSummaries

Defined in Network.AWS.XRay.GetTraceSummaries

type Rs GetTraceSummaries = GetTraceSummariesResponse

Request Lenses

gtsFilterExpression :: Lens' GetTraceSummaries (Maybe Text)

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

gtsNextToken :: Lens' GetTraceSummaries (Maybe Text)

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

gtsSampling :: Lens' GetTraceSummaries (Maybe Bool)

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

gtsStartTime :: Lens' GetTraceSummaries UTCTime

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

gtsEndTime :: Lens' GetTraceSummaries UTCTime

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

Destructuring the Response

getTraceSummariesResponse

Arguments

:: Int

gtsrsResponseStatus

-> GetTraceSummariesResponse

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

See: getTraceSummariesResponse smart constructor.

Instances

Eq GetTraceSummariesResponse

Defined in Network.AWS.XRay.GetTraceSummaries

Methods

(==) :: GetTraceSummariesResponse -> GetTraceSummariesResponse -> Bool

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

Data GetTraceSummariesResponse

Defined in Network.AWS.XRay.GetTraceSummaries

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetTraceSummariesResponse -> c GetTraceSummariesResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetTraceSummariesResponse

toConstr :: GetTraceSummariesResponse -> Constr

dataTypeOf :: GetTraceSummariesResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GetTraceSummariesResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetTraceSummariesResponse)

gmapT :: (forall b. Data b => b -> b) -> GetTraceSummariesResponse -> GetTraceSummariesResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetTraceSummariesResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetTraceSummariesResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> GetTraceSummariesResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetTraceSummariesResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetTraceSummariesResponse -> m GetTraceSummariesResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetTraceSummariesResponse -> m GetTraceSummariesResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetTraceSummariesResponse -> m GetTraceSummariesResponse

Read GetTraceSummariesResponse

Defined in Network.AWS.XRay.GetTraceSummaries

Methods

readsPrec :: Int -> ReadS GetTraceSummariesResponse

readList :: ReadS [GetTraceSummariesResponse]

readPrec :: ReadPrec GetTraceSummariesResponse

readListPrec :: ReadPrec [GetTraceSummariesResponse]

Show GetTraceSummariesResponse

Defined in Network.AWS.XRay.GetTraceSummaries

Methods

showsPrec :: Int -> GetTraceSummariesResponse -> ShowS

show :: GetTraceSummariesResponse -> String

showList :: [GetTraceSummariesResponse] -> ShowS

Generic GetTraceSummariesResponse

Defined in Network.AWS.XRay.GetTraceSummaries

Associated Types

type Rep GetTraceSummariesResponse :: Type -> Type

Methods

from :: GetTraceSummariesResponse -> Rep GetTraceSummariesResponse x

to :: Rep GetTraceSummariesResponse x -> GetTraceSummariesResponse

NFData GetTraceSummariesResponse

Defined in Network.AWS.XRay.GetTraceSummaries

Methods

rnf :: GetTraceSummariesResponse -> ()

type Rep GetTraceSummariesResponse

Defined in Network.AWS.XRay.GetTraceSummaries

type Rep GetTraceSummariesResponse = D1 (MetaData "GetTraceSummariesResponse" "Network.AWS.XRay.GetTraceSummaries" "amazonka-xray-1.6.1-6uyA4HRXo0kJ9ryfmHEerX" False) (C1 (MetaCons "GetTraceSummariesResponse'" PrefixI True) ((S1 (MetaSel (Just "_gtsrsTracesProcessedCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 (MetaSel (Just "_gtsrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_gtsrsApproximateTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 (MetaSel (Just "_gtsrsTraceSummaries") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [TraceSummary])) :*: S1 (MetaSel (Just "_gtsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

gtsrsTracesProcessedCount :: Lens' GetTraceSummariesResponse (Maybe Integer)

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

gtsrsNextToken :: Lens' GetTraceSummariesResponse (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 most recent results, closest to the end of the time frame.

gtsrsApproximateTime :: Lens' GetTraceSummariesResponse (Maybe UTCTime)

The start time of this page of results.

gtsrsTraceSummaries :: Lens' GetTraceSummariesResponse [TraceSummary]

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

gtsrsResponseStatus :: Lens' GetTraceSummariesResponse Int

• - | The response status code.