Skip to content

Examples

Index > SageMaker > Examples

Auto-generated documentation for SageMaker type annotations stubs module types-aiobotocore-sagemaker.

Client

Implicit type annotations

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

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

Client usage example
from aioboto3.session import Session


session = Session()

async with session.client("sagemaker") as client:  # (1)
    result = await client.add_association()  # (2)
  1. client: SageMakerClient
  2. result: AddAssociationResponseTypeDef
Paginator usage example
from aioboto3.session import Session


session = Session()

async with session.client("sagemaker") as client:  # (1)
    paginator = client.get_paginator("list_actions")  # (2)
    async for item in paginator.paginate(...):
        print(item)  # (3)
  1. client: SageMakerClient
  2. paginator: ListActionsPaginator
  3. item: ListActionsResponseTypeDef
Waiter usage example
from aioboto3.session import Session


session = Session()

async with session.client("sagemaker") as client:  # (1)
    waiter = client.get_waiter("endpoint_deleted")  # (2)
    await waiter.wait()
  1. client: SageMakerClient
  2. waiter: EndpointDeletedWaiter

Explicit type annotations

With types-aioboto3-lite[sagemaker] or a standalone types_aiobotocore_sagemaker package, you have to explicitly specify client: SageMakerClient 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.

Client usage example
from aioboto3.session import Session

from types_aiobotocore_sagemaker.client import SageMakerClient
from types_aiobotocore_sagemaker.type_defs import AddAssociationResponseTypeDef
from types_aiobotocore_sagemaker.type_defs import AddAssociationRequestRequestTypeDef


session = Session()

client: SageMakerClient
async with session.client("sagemaker") as client:  # (1)
    kwargs: AddAssociationRequestRequestTypeDef = {...}  # (2)
    result: AddAssociationResponseTypeDef = await client.add_association(**kwargs)  # (3)
  1. client: SageMakerClient
  2. kwargs: AddAssociationRequestRequestTypeDef
  3. result: AddAssociationResponseTypeDef
Paginator usage example
from aioboto3.session import Session

from types_aiobotocore_sagemaker.client import SageMakerClient
from types_aiobotocore_sagemaker.paginator import ListActionsPaginator
from types_aiobotocore_sagemaker.type_defs import ListActionsResponseTypeDef


session = Session()

client: SageMakerClient
async with session.client("sagemaker") as client:  # (1)
    paginator: ListActionsPaginator = client.get_paginator("list_actions")  # (2)
    async for item in paginator.paginate(...):
        item: ListActionsResponseTypeDef
        print(item)  # (3)
  1. client: SageMakerClient
  2. paginator: ListActionsPaginator
  3. item: ListActionsResponseTypeDef
Waiter usage example
from aioboto3.session import Session

from types_aiobotocore_sagemaker.client import SageMakerClient
from types_aiobotocore_sagemaker.waiter import EndpointDeletedWaiter


session = Session()

async with session.client("sagemaker") as client:  # (1)
    waiter = client.get_waiter("endpoint_deleted")  # (2)
    await waiter.wait()
  1. client: SageMakerClient
  2. waiter: EndpointDeletedWaiter