Skip to content

XRay module#

Index > XRay

Auto-generated documentation for XRay type annotations stubs module types-aiobotocore-xray.

How to install#

From PyPI with pip#

Install types-aiobotocore for XRay service.

# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[xray]'


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


# standalone installation
python -m pip install types-aiobotocore-xray

How to uninstall#

python -m pip uninstall -y types-aiobotocore-xray

Usage#

Code samples can be found in Examples.

XRayClient#

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

# XRayClient usage example

from aiobotocore.session import get_session

from types_aiobotocore_xray.client import XRayClient


session = get_session()
async with session.create_client("xray") as client:
    client: XRayClient

Paginators#

Type annotations and code completion for paginators from session.create_client("xray").get_paginator("...").

# BatchGetTracesPaginator usage example

from types_aiobotocore_xray.paginator import BatchGetTracesPaginator

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

Literals#

Type annotations for literals used in methods and schema.

# BatchGetTracesPaginatorName usage example

from types_aiobotocore_xray.literals import BatchGetTracesPaginatorName

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

Type definitions#

Type annotations for type definitions used in methods and schema.