Examples

Index > XRay > Examples

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

Client

Implicit type annotations

Can be used with types-aioboto3[xray] package installed.

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

ClientPaginators

Client usage example

from aioboto3.session import Session


session = Session()

async with session.client("xray") as client:  # (1)
    result = await client.batch_get_traces()  # (2)

1. client: XRayClient
2. result: BatchGetTracesResultTypeDef

Paginator usage example

from aioboto3.session import Session


session = Session()

async with session.client("xray") as client:  # (1)
    paginator = client.get_paginator("batch_get_traces")  # (2)
    async for item in paginator.paginate(...):
        print(item)  # (3)

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

Explicit type annotations

With types-aioboto3-lite[xray] or a standalone types_aiobotocore_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.

ClientPaginators

Client usage example

from aioboto3.session import Session

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


session = Session()

client: XRayClient
async with session.client("xray") as client:  # (1)
    kwargs: BatchGetTracesRequestRequestTypeDef = {...}  # (2)
    result: BatchGetTracesResultTypeDef = await client.batch_get_traces(**kwargs)  # (3)

1. client: XRayClient
2. kwargs: BatchGetTracesRequestRequestTypeDef
3. result: BatchGetTracesResultTypeDef

Paginator usage example

from aioboto3.session import Session

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


session = Session()

client: XRayClient
async with session.client("xray") as client:  # (1)
    paginator: BatchGetTracesPaginator = client.get_paginator("batch_get_traces")  # (2)
    async for item in paginator.paginate(...):
        item: BatchGetTracesResultTypeDef
        print(item)  # (3)

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