Skip to content

Service

Source code in docs_src/capo_xray/types/service.py
class Service(TypedDict, closed=True):
    reference_id: NotRequired["capo_xray.types.nullable_integer.NullableInteger"]
    """<p>Identifier for the service. Unique within the service map.</p>"""
    name: NotRequired["capo_xray.types.string.String"]
    """<p>The canonical name of the service.</p>"""
    names: NotRequired["capo_xray.types.service_names.ServiceNames"]
    """<p>A list of names for the service, including the canonical name.</p>"""
    root: NotRequired["capo_xray.types.nullable_boolean.NullableBoolean"]
    """<p>Indicates that the service was the first service to process a request.</p>"""
    account_id: NotRequired["capo_xray.types.string.String"]
    """<p>Identifier of the Amazon Web Services account in which the service runs.</p>"""
    type: NotRequired["capo_xray.types.string.String"]
    """<p>The type of service.</p> <ul> <li> <p>Amazon Web Services Resource - The type of an Amazon Web Services resource. For example, <code>AWS::EC2::Instance</code> for an application running on Amazon EC2 or <code>AWS::DynamoDB::Table</code> for an Amazon DynamoDB table that the application used.</p> </li> <li> <p>Amazon Web Services Service - The type of an Amazon Web Services service. For example, <code>AWS::DynamoDB</code> for downstream calls to Amazon DynamoDB that didn't target a specific table.</p> </li> <li> <p> <code>client</code> - Represents the clients that sent requests to a root service.</p> </li> <li> <p> <code>remote</code> - A downstream service of indeterminate type.</p> </li> </ul>"""
    state: NotRequired["capo_xray.types.string.String"]
    """<p>The service's state.</p>"""
    start_time: NotRequired["capo_xray.types.timestamp.Timestamp"]
    """<p>The start time of the first segment that the service generated.</p>"""
    end_time: NotRequired["capo_xray.types.timestamp.Timestamp"]
    """<p>The end time of the last segment that the service generated.</p>"""
    edges: NotRequired["capo_xray.types.edge_list.EdgeList"]
    """<p>Connections to downstream services.</p>"""
    summary_statistics: NotRequired[
        "capo_xray.types.service_statistics.ServiceStatistics"
    ]
    """<p>Aggregated statistics for the service.</p>"""
    duration_histogram: NotRequired["capo_xray.types.histogram.Histogram"]
    """<p>A histogram that maps the spread of service durations.</p>"""
    response_time_histogram: NotRequired["capo_xray.types.histogram.Histogram"]
    """<p>A histogram that maps the spread of service response times.</p>"""

account_id instance-attribute

account_id: NotRequired[String]

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

duration_histogram instance-attribute

duration_histogram: NotRequired[Histogram]

A histogram that maps the spread of service durations.

edges instance-attribute

edges: NotRequired[EdgeList]

Connections to downstream services.

end_time instance-attribute

end_time: NotRequired[Timestamp]

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

name instance-attribute

name: NotRequired[String]

The canonical name of the service.

names instance-attribute

names: NotRequired[ServiceNames]

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

reference_id instance-attribute

reference_id: NotRequired[NullableInteger]

Identifier for the service. Unique within the service map.

response_time_histogram instance-attribute

response_time_histogram: NotRequired[Histogram]

A histogram that maps the spread of service response times.

root instance-attribute

root: NotRequired[NullableBoolean]

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

start_time instance-attribute

start_time: NotRequired[Timestamp]

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

state instance-attribute

state: NotRequired[String]

The service's state.

summary_statistics instance-attribute

summary_statistics: NotRequired[ServiceStatistics]

Aggregated statistics for the service.

type instance-attribute

type: NotRequired[String]

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.