Skip to content

SageMaker module#

Index > SageMaker

Auto-generated documentation for SageMaker type annotations stubs module mypy-boto3-sagemaker.

How to install#

VSCode extension#

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

Click Modify and select boto3 common and SageMaker.

From PyPI with pip#

Install boto3-stubs for SageMaker service.

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


# 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[sagemaker]'


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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

SageMakerClient#

Type annotations and code completion for boto3.client("sagemaker") as SageMakerClient boto3 documentation

# SageMakerClient usage example

from boto3.session import Session

from mypy_boto3_sagemaker.client import SageMakerClient

def get_client() -> SageMakerClient:
    return Session().client("sagemaker")

Paginators#

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

# ListActionsPaginator usage example

from boto3.session import Session

from mypy_boto3_sagemaker.paginator import ListActionsPaginator

def get_list_actions_paginator() -> ListActionsPaginator:
    return Session().client("sagemaker").get_paginator("list_actions"))

Waiters#

Type annotations and code completion for waiters from boto3.client("sagemaker").get_waiter("...").

# EndpointDeletedWaiter usage example

from boto3.session import Session

from mypy_boto3_sagemaker.waiter import EndpointDeletedWaiter

def get_endpoint_deleted_waiter() -> EndpointDeletedWaiter:
    return Session().client("sagemaker").get_waiter("endpoint_deleted")

Literals#

Type annotations for literals used in methods and schemas.

# ActionStatusType usage example

from mypy_boto3_sagemaker.literals import ActionStatusType

def get_value() -> ActionStatusType:
    return "Completed"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# ActionSourceTypeDef usage example

from mypy_boto3_sagemaker.type_defs import ActionSourceTypeDef

def get_value() -> ActionSourceTypeDef:
    return {
        "SourceUri": ...,
    }