Amazonka.XRay.Types.ServiceInfo

Documentation

data ServiceInfo

Information about an application that processed requests, users that made requests, or downstream services, resources, and applications that an application used.

See: newServiceInfo smart constructor.

Constructors

ServiceInfo'

Fields

• accountId :: Maybe Text

  Identifier of the Amazon Web Services account in which the service runs.

• durationHistogram :: Maybe [HistogramEntry]

  A histogram that maps the spread of service durations.

• edges :: Maybe [Edge]

  Connections to downstream services.

• endTime :: Maybe POSIX

  The end time of the last segment that the service generated.

• name :: Maybe Text

  The canonical name of the service.

• names :: Maybe [Text]

  A list of names for the service, including the canonical name.

• referenceId :: Maybe Int

  Identifier for the service. Unique within the service map.

• responseTimeHistogram :: Maybe [HistogramEntry]

  A histogram that maps the spread of service response times.

• root :: Maybe Bool

  Indicates that the service was the first service to process a request.

• startTime :: Maybe POSIX

  The start time of the first segment that the service generated.

• state :: Maybe Text

  The service's state.

• summaryStatistics :: Maybe ServiceStatistics

  Aggregated statistics for the service.

• type' :: Maybe Text

  The type of service.

  • Amazon Web Services Resource - The type of an Amazon Web Services resource. For example, AWS::EC2::Instance for an application running on Amazon EC2 or AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used.
  • Amazon Web Services Service - The type of an Amazon Web Services service. For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn't target a specific table.
  • client - Represents the clients that sent requests to a root service.
  • remote - A downstream service of indeterminate type.

Instances

FromJSON ServiceInfo

Defined in Amazonka.XRay.Types.ServiceInfo

Methods

parseJSON :: Value -> Parser ServiceInfo

parseJSONList :: Value -> Parser [ServiceInfo]

Generic ServiceInfo

Defined in Amazonka.XRay.Types.ServiceInfo

Associated Types

type Rep ServiceInfo :: Type -> Type

Methods

from :: ServiceInfo -> Rep ServiceInfo x

to :: Rep ServiceInfo x -> ServiceInfo

Read ServiceInfo

Defined in Amazonka.XRay.Types.ServiceInfo

Methods

readsPrec :: Int -> ReadS ServiceInfo

readList :: ReadS [ServiceInfo]

readPrec :: ReadPrec ServiceInfo

readListPrec :: ReadPrec [ServiceInfo]

Show ServiceInfo

Defined in Amazonka.XRay.Types.ServiceInfo

Methods

showsPrec :: Int -> ServiceInfo -> ShowS

show :: ServiceInfo -> String

showList :: [ServiceInfo] -> ShowS

NFData ServiceInfo

Defined in Amazonka.XRay.Types.ServiceInfo

Methods

rnf :: ServiceInfo -> ()

Eq ServiceInfo

Defined in Amazonka.XRay.Types.ServiceInfo

Methods

(==) :: ServiceInfo -> ServiceInfo -> Bool

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

Hashable ServiceInfo

Defined in Amazonka.XRay.Types.ServiceInfo

Methods

hashWithSalt :: Int -> ServiceInfo -> Int

hash :: ServiceInfo -> Int

type Rep ServiceInfo

Defined in Amazonka.XRay.Types.ServiceInfo

type Rep ServiceInfo = D1 ('MetaData "ServiceInfo" "Amazonka.XRay.Types.ServiceInfo" "amazonka-xray-2.0-EVMSPoflqtHB9ZqvEIOE4Q" 'False) (C1 ('MetaCons "ServiceInfo'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "durationHistogram") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [HistogramEntry])) :*: S1 ('MetaSel ('Just "edges") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Edge])))) :*: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "names") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :*: ((S1 ('MetaSel ('Just "referenceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "responseTimeHistogram") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [HistogramEntry])) :*: S1 ('MetaSel ('Just "root") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "summaryStatistics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceStatistics)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newServiceInfo :: ServiceInfo

Create a value of ServiceInfo 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:accountId:ServiceInfo', serviceInfo_accountId - Identifier of the Amazon Web Services account in which the service runs.

$sel:durationHistogram:ServiceInfo', serviceInfo_durationHistogram - A histogram that maps the spread of service durations.

$sel:edges:ServiceInfo', serviceInfo_edges - Connections to downstream services.

ServiceInfo, serviceInfo_endTime - The end time of the last segment that the service generated.

$sel:name:ServiceInfo', serviceInfo_name - The canonical name of the service.

$sel:names:ServiceInfo', serviceInfo_names - A list of names for the service, including the canonical name.

ServiceInfo, serviceInfo_referenceId - Identifier for the service. Unique within the service map.

ServiceInfo, serviceInfo_responseTimeHistogram - A histogram that maps the spread of service response times.

$sel:root:ServiceInfo', serviceInfo_root - Indicates that the service was the first service to process a request.

ServiceInfo, serviceInfo_startTime - The start time of the first segment that the service generated.

$sel:state:ServiceInfo', serviceInfo_state - The service's state.

ServiceInfo, serviceInfo_summaryStatistics - Aggregated statistics for the service.

$sel:type':ServiceInfo', serviceInfo_type - The type of service.

• Amazon Web Services Resource - The type of an Amazon Web Services resource. For example, AWS::EC2::Instance for an application running on Amazon EC2 or AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used.
• Amazon Web Services Service - The type of an Amazon Web Services service. For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn't target a specific table.
• client - Represents the clients that sent requests to a root service.
• remote - A downstream service of indeterminate type.

serviceInfo_accountId :: Lens' ServiceInfo (Maybe Text)

Identifier of the Amazon Web Services account in which the service runs.

serviceInfo_durationHistogram :: Lens' ServiceInfo (Maybe [HistogramEntry])

A histogram that maps the spread of service durations.

serviceInfo_edges :: Lens' ServiceInfo (Maybe [Edge])

Connections to downstream services.

serviceInfo_endTime :: Lens' ServiceInfo (Maybe UTCTime)

The end time of the last segment that the service generated.

serviceInfo_name :: Lens' ServiceInfo (Maybe Text)

The canonical name of the service.

serviceInfo_names :: Lens' ServiceInfo (Maybe [Text])

A list of names for the service, including the canonical name.

serviceInfo_referenceId :: Lens' ServiceInfo (Maybe Int)

Identifier for the service. Unique within the service map.

serviceInfo_responseTimeHistogram :: Lens' ServiceInfo (Maybe [HistogramEntry])

A histogram that maps the spread of service response times.

serviceInfo_root :: Lens' ServiceInfo (Maybe Bool)

Indicates that the service was the first service to process a request.

serviceInfo_startTime :: Lens' ServiceInfo (Maybe UTCTime)

The start time of the first segment that the service generated.

serviceInfo_state :: Lens' ServiceInfo (Maybe Text)

The service's state.

serviceInfo_summaryStatistics :: Lens' ServiceInfo (Maybe ServiceStatistics)

Aggregated statistics for the service.

serviceInfo_type :: Lens' ServiceInfo (Maybe Text)

The type of service.

• Amazon Web Services Resource - The type of an Amazon Web Services resource. For example, AWS::EC2::Instance for an application running on Amazon EC2 or AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used.
• Amazon Web Services Service - The type of an Amazon Web Services service. For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn't target a specific table.
• client - Represents the clients that sent requests to a root service.
• remote - A downstream service of indeterminate type.