Menu
AWS X-Ray
API Reference (API Version 2016-04-12)

Service

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

Contents

AccountId

Identifier of the AWS account in which the service runs.

Type: String

Required: No

DurationHistogram

A histogram that maps the spread of service durations.

Type: Array of HistogramEntry objects

Required: No

Edges

Connections to downstream services.

Type: Array of Edge objects

Required: No

EndTime

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

Type: Timestamp

Required: No

Name

The canonical name of the service.

Type: String

Required: No

Names

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

Type: Array of strings

Required: No

ReferenceId

Identifier for the service. Unique within the service map.

Type: Integer

Required: No

ResponseTimeHistogram

A histogram that maps the spread of service response times.

Type: Array of HistogramEntry objects

Required: No

Root

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

Type: Boolean

Required: No

StartTime

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

Type: Timestamp

Required: No

State

The service's state.

Type: String

Required: No

SummaryStatistics

Aggregated statistics for the service.

Type: ServiceStatistics object

Required: No

Type

The type of service.

  • AWS Resource - The type of an AWS resource. For example, AWS::EC2::Instance for a application running on Amazon EC2 or AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used.

  • AWS Service - The type of an AWS 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.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: