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.GetServiceGraph

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result. Root services process incoming requests and make calls to downstream services. Root services are applications that use the Amazon Web Services X-Ray SDK. Downstream services can be other applications, Amazon Web Services resources, HTTP web APIs, or SQL databases.

This operation returns paginated results.

Synopsis

data GetServiceGraph = GetServiceGraph' {
- groupARN :: Maybe Text
- groupName :: Maybe Text
- nextToken :: Maybe Text
- startTime :: POSIX
- endTime :: POSIX
}
newGetServiceGraph :: UTCTime -> UTCTime -> GetServiceGraph
getServiceGraph_groupARN :: Lens' GetServiceGraph (Maybe Text)
getServiceGraph_groupName :: Lens' GetServiceGraph (Maybe Text)
getServiceGraph_nextToken :: Lens' GetServiceGraph (Maybe Text)
getServiceGraph_startTime :: Lens' GetServiceGraph UTCTime
getServiceGraph_endTime :: Lens' GetServiceGraph UTCTime
data GetServiceGraphResponse = GetServiceGraphResponse' {
- containsOldGroupVersions :: Maybe Bool
- endTime :: Maybe POSIX
- nextToken :: Maybe Text
- services :: Maybe [ServiceInfo]
- startTime :: Maybe POSIX
- httpStatus :: Int
}
newGetServiceGraphResponse :: Int -> GetServiceGraphResponse
getServiceGraphResponse_containsOldGroupVersions :: Lens' GetServiceGraphResponse (Maybe Bool)
getServiceGraphResponse_endTime :: Lens' GetServiceGraphResponse (Maybe UTCTime)
getServiceGraphResponse_nextToken :: Lens' GetServiceGraphResponse (Maybe Text)
getServiceGraphResponse_services :: Lens' GetServiceGraphResponse (Maybe [ServiceInfo])
getServiceGraphResponse_startTime :: Lens' GetServiceGraphResponse (Maybe UTCTime)
getServiceGraphResponse_httpStatus :: Lens' GetServiceGraphResponse Int

Creating a Request

data GetServiceGraph Source #

See: newGetServiceGraph smart constructor.

Constructors

GetServiceGraph'
Fields groupARN :: Maybe Text The Amazon Resource Name (ARN) of a group based on which you want to generate a graph. groupName :: Maybe Text The name of a group based on which you want to generate a graph. nextToken :: Maybe Text Pagination token. startTime :: POSIX The start of the time frame for which to generate a graph. endTime :: POSIX The end of the timeframe for which to generate a graph.

Instances

Instances details

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

newGetServiceGraph Source #

Arguments

:: UTCTime	`GetServiceGraph`
-> UTCTime	`GetServiceGraph`
-> GetServiceGraph

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

GetServiceGraph, getServiceGraph_groupARN - The Amazon Resource Name (ARN) of a group based on which you want to generate a graph.

GetServiceGraph, getServiceGraph_groupName - The name of a group based on which you want to generate a graph.

GetServiceGraph, getServiceGraph_nextToken - Pagination token.

GetServiceGraph, getServiceGraph_startTime - The start of the time frame for which to generate a graph.

GetServiceGraph, getServiceGraph_endTime - The end of the timeframe for which to generate a graph.

Request Lenses

getServiceGraph_groupARN :: Lens' GetServiceGraph (Maybe Text) Source #

The Amazon Resource Name (ARN) of a group based on which you want to generate a graph.

getServiceGraph_groupName :: Lens' GetServiceGraph (Maybe Text) Source #

The name of a group based on which you want to generate a graph.

getServiceGraph_nextToken :: Lens' GetServiceGraph (Maybe Text) Source #

Pagination token.

getServiceGraph_startTime :: Lens' GetServiceGraph UTCTime Source #

The start of the time frame for which to generate a graph.

getServiceGraph_endTime :: Lens' GetServiceGraph UTCTime Source #

The end of the timeframe for which to generate a graph.

Destructuring the Response

data GetServiceGraphResponse Source #

See: newGetServiceGraphResponse smart constructor.

Constructors

GetServiceGraphResponse'

Fields

containsOldGroupVersions :: Maybe Bool
A flag indicating whether the group's filter expression has been consistent, or if the returned service graph may show traces from an older version of the group's filter expression.
endTime :: Maybe POSIX
The end of the time frame for which the graph was generated.
nextToken :: Maybe Text
Pagination token.
services :: Maybe [ServiceInfo]
The services that have processed a traced request during the specified time frame.
startTime :: Maybe POSIX
The start of the time frame for which the graph was generated.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newGetServiceGraphResponse Source #

Arguments

:: Int	`GetServiceGraphResponse`
-> GetServiceGraphResponse

Create a value of GetServiceGraphResponse 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:GetServiceGraphResponse', getServiceGraphResponse_containsOldGroupVersions - A flag indicating whether the group's filter expression has been consistent, or if the returned service graph may show traces from an older version of the group's filter expression.

GetServiceGraph, getServiceGraphResponse_endTime - The end of the time frame for which the graph was generated.

GetServiceGraph, getServiceGraphResponse_nextToken - Pagination token.

GetServiceGraphResponse, getServiceGraphResponse_services - The services that have processed a traced request during the specified time frame.

GetServiceGraph, getServiceGraphResponse_startTime - The start of the time frame for which the graph was generated.

GetServiceGraphResponse, getServiceGraphResponse_httpStatus - The response's http status code.

Response Lenses

getServiceGraphResponse_containsOldGroupVersions :: Lens' GetServiceGraphResponse (Maybe Bool) Source #

A flag indicating whether the group's filter expression has been consistent, or if the returned service graph may show traces from an older version of the group's filter expression.

getServiceGraphResponse_endTime :: Lens' GetServiceGraphResponse (Maybe UTCTime) Source #

The end of the time frame for which the graph was generated.

getServiceGraphResponse_nextToken :: Lens' GetServiceGraphResponse (Maybe Text) Source #

Pagination token.

getServiceGraphResponse_services :: Lens' GetServiceGraphResponse (Maybe [ServiceInfo]) Source #

The services that have processed a traced request during the specified time frame.

getServiceGraphResponse_startTime :: Lens' GetServiceGraphResponse (Maybe UTCTime) Source #

The start of the time frame for which the graph was generated.

getServiceGraphResponse_httpStatus :: Lens' GetServiceGraphResponse Int Source #

The response's http status code.