Skip to content

XRay module#

Index > XRay

Auto-generated documentation for XRay type annotations stubs module mypy-boto3-xray.

How to install#

You can generate type annotations for boto3 package locally with mypy-boto3-builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.36.26' mypy-boto3-builder
  2. Select boto3-stubs AWS SDK.
  3. Add XRay service.
  4. Use provided commands to install generated packages.

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and XRay.

From PyPI with pip#

Install boto3-stubs for XRay service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[xray]'

# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[xray]'

# standalone installation
python -m pip install mypy-boto3-xray

How to uninstall#

python -m pip uninstall -y mypy-boto3-xray

Usage#

Code samples can be found in Examples.

XRayClient#

Type annotations and code completion for boto3.client("xray") as XRayClient boto3 documentation

# XRayClient usage example

from boto3.session import Session

from mypy_boto3_xray.client import XRayClient

def get_client() -> XRayClient:
    return Session().client("xray")

Paginators#

Type annotations and code completion for paginators from boto3.client("xray").get_paginator("...").

# BatchGetTracesPaginator usage example

from boto3.session import Session

from mypy_boto3_xray.paginator import BatchGetTracesPaginator

def get_batch_get_traces_paginator() -> BatchGetTracesPaginator:
    return Session().client("xray").get_paginator("batch_get_traces"))

Literals#

Type annotations for literals used in methods and schema.

# BatchGetTracesPaginatorName usage example

from mypy_boto3_xray.literals import BatchGetTracesPaginatorName

def get_value() -> BatchGetTracesPaginatorName:
    return "batch_get_traces"

Type definitions#

Type annotations for type definitions used in methods and schema.