Examples

Index > XRay > Examples

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

Client

Implicit type annotations

Can be used with boto3-stubs[xray] package installed.

Write your XRay code as usual, type checking and code completion should work out of the box.

# XRayClient usage example

from boto3.session import Session


session = Session()

client = session.client("xray")  # (1)
result = client.batch_get_traces()  # (2)

1. client: XRayClient
2. result: BatchGetTracesResultTypeDef

# BatchGetTracesPaginator usage example

from boto3.session import Session


session = Session()
client = session.client("xray")  # (1)

paginator = client.get_paginator("batch_get_traces")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: XRayClient
2. paginator: BatchGetTracesPaginator
3. item: BatchGetTracesResultTypeDef

Explicit type annotations

With boto3-stubs-lite[xray] or a standalone mypy_boto3_xray package, you have to explicitly specify client: XRayClient type annotation.

All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.

# XRayClient usage example with type annotations

from boto3.session import Session

from mypy_boto3_xray.client import XRayClient
from mypy_boto3_xray.type_defs import BatchGetTracesResultTypeDef
from mypy_boto3_xray.type_defs import BatchGetTracesRequestRequestTypeDef


session = Session()

client: XRayClient = session.client("xray")

kwargs: BatchGetTracesRequestRequestTypeDef = {...}
result: BatchGetTracesResultTypeDef = client.batch_get_traces(**kwargs)

# BatchGetTracesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_xray.client import XRayClient
from mypy_boto3_xray.paginator import BatchGetTracesPaginator
from mypy_boto3_xray.type_defs import BatchGetTracesResultTypeDef


session = Session()
client: XRayClient = session.client("xray")

paginator: BatchGetTracesPaginator = client.get_paginator("batch_get_traces")
for item in paginator.paginate(...):
    item: BatchGetTracesResultTypeDef
    print(item)