<a id="types-boto3-sagemaker"></a>
# types-boto3-sagemaker
[](https://pypi.org/project/types-boto3-sagemaker/)
[](https://pypi.org/project/types-boto3-sagemaker/)
[](https://youtype.github.io/types_boto3_docs/)
[](https://pypistats.org/packages/types-boto3-sagemaker)
Type annotations for [boto3 SageMaker 1.35.75](https://pypi.org/project/boto3/)
compatible with [VSCode](https://code.visualstudio.com/),
[PyCharm](https://www.jetbrains.com/pycharm/),
[Emacs](https://www.gnu.org/software/emacs/),
[Sublime Text](https://www.sublimetext.com/),
[mypy](https://github.com/python/mypy),
[pyright](https://github.com/microsoft/pyright) and other tools.
Generated by
[mypy-boto3-builder 8.5.0](https://github.com/youtype/mypy_boto3_builder).
More information can be found on
[types-boto3](https://pypi.org/project/types-boto3/) page and in
[types-boto3-sagemaker docs](https://youtype.github.io/types_boto3_docs/types_boto3_sagemaker/).
See how it helps you find and fix potential bugs:
- [types-boto3-sagemaker](#types-boto3-sagemaker)
- [How to install](#how-to-install)
- [VSCode extension](#vscode-extension)
- [From PyPI with pip](#from-pypi-with-pip)
- [How to uninstall](#how-to-uninstall)
- [Usage](#usage)
- [VSCode](#vscode)
- [PyCharm](#pycharm)
- [Emacs](#emacs)
- [Sublime Text](#sublime-text)
- [Other IDEs](#other-ides)
- [mypy](#mypy)
- [pyright](#pyright)
- [Pylint compatibility](#pylint-compatibility)
- [Explicit type annotations](#explicit-type-annotations)
- [Client annotations](#client-annotations)
- [Paginators annotations](#paginators-annotations)
- [Waiters annotations](#waiters-annotations)
- [Literals](#literals)
- [Type definitions](#type-definitions)
- [How it works](#how-it-works)
- [What's new](#what's-new)
- [Implemented features](#implemented-features)
- [Latest changes](#latest-changes)
- [Versioning](#versioning)
- [Thank you](#thank-you)
- [Documentation](#documentation)
- [Support and contributing](#support-and-contributing)
<a id="how-to-install"></a>
## How to install
<a id="vscode-extension"></a>
### VSCode extension
Add
[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide)
extension to your VSCode and run `AWS boto3: Quick Start` command.
Click `Modify` and select `boto3 common` and `SageMaker`.
<a id="from-pypi-with-pip"></a>
### From PyPI with pip
Install `types-boto3` for `SageMaker` service.
```bash
# install with boto3 type annotations
python -m pip install 'types-boto3[sagemaker]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[sagemaker]'
# standalone installation
python -m pip install types-boto3-sagemaker
```
<a id="how-to-uninstall"></a>
## How to uninstall
```bash
python -m pip uninstall -y types-boto3-sagemaker
```
<a id="usage"></a>
## Usage
<a id="vscode"></a>
### VSCode
- Install
[Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
- Install
[Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
- Set `Pylance` as your Python Language Server
- Install `types-boto3[sagemaker]` in your environment:
```bash
python -m pip install 'types-boto3[sagemaker]'
```
Both type checking and code completion should now work. No explicit type
annotations required, write your `boto3` code as usual.
<a id="pycharm"></a>
### PyCharm
> ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
> [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
> to use [types-boto3-lite](https://pypi.org/project/types-boto3-lite/) until
> the issue is resolved.
> ⚠️ If you experience slow performance and high CPU usage, try to disable
> `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
> [pyright](https://github.com/microsoft/pyright) instead.
> ⚠️ To continue using `PyCharm` type checker, you can try to replace
> `types-boto3` with
> [types-boto3-lite](https://pypi.org/project/types-boto3-lite/):
```bash
pip uninstall types-boto3
pip install types-boto3-lite
```
Install `types-boto3[sagemaker]` in your environment:
```bash
python -m pip install 'types-boto3[sagemaker]'
```
Both type checking and code completion should now work.
<a id="emacs"></a>
### Emacs
- Install `types-boto3` with services you use in your environment:
```bash
python -m pip install 'types-boto3[sagemaker]'
```
- Install [use-package](https://github.com/jwiegley/use-package),
[lsp](https://github.com/emacs-lsp/lsp-mode/),
[company](https://github.com/company-mode/company-mode) and
[flycheck](https://github.com/flycheck/flycheck) packages
- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package
```elisp
(use-package lsp-pyright
:ensure t
:hook (python-mode . (lambda ()
(require 'lsp-pyright)
(lsp))) ; or lsp-deferred
:init (when (executable-find "python3")
(setq lsp-pyright-python-executable-cmd "python3"))
)
```
- Make sure emacs uses the environment where you have installed `types-boto3`
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
<a id="sublime-text"></a>
### Sublime Text
- Install `types-boto3[sagemaker]` with services you use in your environment:
```bash
python -m pip install 'types-boto3[sagemaker]'
```
- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
<a id="other-ides"></a>
### Other IDEs
Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
should work.
<a id="mypy"></a>
### mypy
- Install `mypy`: `python -m pip install mypy`
- Install `types-boto3[sagemaker]` in your environment:
```bash
python -m pip install 'types-boto3[sagemaker]'
```
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
<a id="pyright"></a>
### pyright
- Install `pyright`: `npm i -g pyright`
- Install `types-boto3[sagemaker]` in your environment:
```bash
python -m pip install 'types-boto3[sagemaker]'
```
Optionally, you can install `types-boto3` to `typings` directory.
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
<a id="pylint-compatibility"></a>
### Pylint compatibility
It is totally safe to use `TYPE_CHECKING` flag in order to avoid
`types-boto3-sagemaker` dependency in production. However, there is an issue in
`pylint` that it complains about undefined variables. To fix it, set all types
to `object` in non-`TYPE_CHECKING` mode.
```python
from typing import TYPE_CHECKING
if TYPE_CHECKING:
from types_boto3_ec2 import EC2Client, EC2ServiceResource
from types_boto3_ec2.waiters import BundleTaskCompleteWaiter
from types_boto3_ec2.paginators import DescribeVolumesPaginator
else:
EC2Client = object
EC2ServiceResource = object
BundleTaskCompleteWaiter = object
DescribeVolumesPaginator = object
...
```
<a id="explicit-type-annotations"></a>
## Explicit type annotations
<a id="client-annotations"></a>
### Client annotations
`SageMakerClient` provides annotations for `boto3.client("sagemaker")`.
```python
from boto3.session import Session
from types_boto3_sagemaker import SageMakerClient
client: SageMakerClient = Session().client("sagemaker")
# now client usage is checked by mypy and IDE should provide code completion
```
<a id="paginators-annotations"></a>
### Paginators annotations
`types_boto3_sagemaker.paginator` module contains type annotations for all
paginators.
```python
from boto3.session import Session
from types_boto3_sagemaker import SageMakerClient
from types_boto3_sagemaker.paginator import (
ListActionsPaginator,
ListAlgorithmsPaginator,
ListAliasesPaginator,
ListAppImageConfigsPaginator,
ListAppsPaginator,
ListArtifactsPaginator,
ListAssociationsPaginator,
ListAutoMLJobsPaginator,
ListCandidatesForAutoMLJobPaginator,
ListClusterNodesPaginator,
ListClusterSchedulerConfigsPaginator,
ListClustersPaginator,
ListCodeRepositoriesPaginator,
ListCompilationJobsPaginator,
ListComputeQuotasPaginator,
ListContextsPaginator,
ListDataQualityJobDefinitionsPaginator,
ListDeviceFleetsPaginator,
ListDevicesPaginator,
ListDomainsPaginator,
ListEdgeDeploymentPlansPaginator,
ListEdgePackagingJobsPaginator,
ListEndpointConfigsPaginator,
ListEndpointsPaginator,
ListExperimentsPaginator,
ListFeatureGroupsPaginator,
ListFlowDefinitionsPaginator,
ListHumanTaskUisPaginator,
ListHyperParameterTuningJobsPaginator,
ListImageVersionsPaginator,
ListImagesPaginator,
ListInferenceComponentsPaginator,
ListInferenceExperimentsPaginator,
ListInferenceRecommendationsJobStepsPaginator,
ListInferenceRecommendationsJobsPaginator,
ListLabelingJobsForWorkteamPaginator,
ListLabelingJobsPaginator,
ListLineageGroupsPaginator,
ListMlflowTrackingServersPaginator,
ListModelBiasJobDefinitionsPaginator,
ListModelCardExportJobsPaginator,
ListModelCardVersionsPaginator,
ListModelCardsPaginator,
ListModelExplainabilityJobDefinitionsPaginator,
ListModelMetadataPaginator,
ListModelPackageGroupsPaginator,
ListModelPackagesPaginator,
ListModelQualityJobDefinitionsPaginator,
ListModelsPaginator,
ListMonitoringAlertHistoryPaginator,
ListMonitoringAlertsPaginator,
ListMonitoringExecutionsPaginator,
ListMonitoringSchedulesPaginator,
ListNotebookInstanceLifecycleConfigsPaginator,
ListNotebookInstancesPaginator,
ListOptimizationJobsPaginator,
ListPartnerAppsPaginator,
ListPipelineExecutionStepsPaginator,
ListPipelineExecutionsPaginator,
ListPipelineParametersForExecutionPaginator,
ListPipelinesPaginator,
ListProcessingJobsPaginator,
ListResourceCatalogsPaginator,
ListSpacesPaginator,
ListStageDevicesPaginator,
ListStudioLifecycleConfigsPaginator,
ListSubscribedWorkteamsPaginator,
ListTagsPaginator,
ListTrainingJobsForHyperParameterTuningJobPaginator,
ListTrainingJobsPaginator,
ListTrainingPlansPaginator,
ListTransformJobsPaginator,
ListTrialComponentsPaginator,
ListTrialsPaginator,
ListUserProfilesPaginator,
ListWorkforcesPaginator,
ListWorkteamsPaginator,
SearchPaginator,
)
client: SageMakerClient = Session().client("sagemaker")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
list_actions_paginator: ListActionsPaginator = client.get_paginator("list_actions")
list_algorithms_paginator: ListAlgorithmsPaginator = client.get_paginator("list_algorithms")
list_aliases_paginator: ListAliasesPaginator = client.get_paginator("list_aliases")
list_app_image_configs_paginator: ListAppImageConfigsPaginator = client.get_paginator(
"list_app_image_configs"
)
list_apps_paginator: ListAppsPaginator = client.get_paginator("list_apps")
list_artifacts_paginator: ListArtifactsPaginator = client.get_paginator("list_artifacts")
list_associations_paginator: ListAssociationsPaginator = client.get_paginator("list_associations")
list_auto_ml_jobs_paginator: ListAutoMLJobsPaginator = client.get_paginator("list_auto_ml_jobs")
list_candidates_for_auto_ml_job_paginator: ListCandidatesForAutoMLJobPaginator = (
client.get_paginator("list_candidates_for_auto_ml_job")
)
list_cluster_nodes_paginator: ListClusterNodesPaginator = client.get_paginator("list_cluster_nodes")
list_cluster_scheduler_configs_paginator: ListClusterSchedulerConfigsPaginator = (
client.get_paginator("list_cluster_scheduler_configs")
)
list_clusters_paginator: ListClustersPaginator = client.get_paginator("list_clusters")
list_code_repositories_paginator: ListCodeRepositoriesPaginator = client.get_paginator(
"list_code_repositories"
)
list_compilation_jobs_paginator: ListCompilationJobsPaginator = client.get_paginator(
"list_compilation_jobs"
)
list_compute_quotas_paginator: ListComputeQuotasPaginator = client.get_paginator(
"list_compute_quotas"
)
list_contexts_paginator: ListContextsPaginator = client.get_paginator("list_contexts")
list_data_quality_job_definitions_paginator: ListDataQualityJobDefinitionsPaginator = (
client.get_paginator("list_data_quality_job_definitions")
)
list_device_fleets_paginator: ListDeviceFleetsPaginator = client.get_paginator("list_device_fleets")
list_devices_paginator: ListDevicesPaginator = client.get_paginator("list_devices")
list_domains_paginator: ListDomainsPaginator = client.get_paginator("list_domains")
list_edge_deployment_plans_paginator: ListEdgeDeploymentPlansPaginator = client.get_paginator(
"list_edge_deployment_plans"
)
list_edge_packaging_jobs_paginator: ListEdgePackagingJobsPaginator = client.get_paginator(
"list_edge_packaging_jobs"
)
list_endpoint_configs_paginator: ListEndpointConfigsPaginator = client.get_paginator(
"list_endpoint_configs"
)
list_endpoints_paginator: ListEndpointsPaginator = client.get_paginator("list_endpoints")
list_experiments_paginator: ListExperimentsPaginator = client.get_paginator("list_experiments")
list_feature_groups_paginator: ListFeatureGroupsPaginator = client.get_paginator(
"list_feature_groups"
)
list_flow_definitions_paginator: ListFlowDefinitionsPaginator = client.get_paginator(
"list_flow_definitions"
)
list_human_task_uis_paginator: ListHumanTaskUisPaginator = client.get_paginator(
"list_human_task_uis"
)
list_hyper_parameter_tuning_jobs_paginator: ListHyperParameterTuningJobsPaginator = (
client.get_paginator("list_hyper_parameter_tuning_jobs")
)
list_image_versions_paginator: ListImageVersionsPaginator = client.get_paginator(
"list_image_versions"
)
list_images_paginator: ListImagesPaginator = client.get_paginator("list_images")
list_inference_components_paginator: ListInferenceComponentsPaginator = client.get_paginator(
"list_inference_components"
)
list_inference_experiments_paginator: ListInferenceExperimentsPaginator = client.get_paginator(
"list_inference_experiments"
)
list_inference_recommendations_job_steps_paginator: ListInferenceRecommendationsJobStepsPaginator = client.get_paginator(
"list_inference_recommendations_job_steps"
)
list_inference_recommendations_jobs_paginator: ListInferenceRecommendationsJobsPaginator = (
client.get_paginator("list_inference_recommendations_jobs")
)
list_labeling_jobs_for_workteam_paginator: ListLabelingJobsForWorkteamPaginator = (
client.get_paginator("list_labeling_jobs_for_workteam")
)
list_labeling_jobs_paginator: ListLabelingJobsPaginator = client.get_paginator("list_labeling_jobs")
list_lineage_groups_paginator: ListLineageGroupsPaginator = client.get_paginator(
"list_lineage_groups"
)
list_mlflow_tracking_servers_paginator: ListMlflowTrackingServersPaginator = client.get_paginator(
"list_mlflow_tracking_servers"
)
list_model_bias_job_definitions_paginator: ListModelBiasJobDefinitionsPaginator = (
client.get_paginator("list_model_bias_job_definitions")
)
list_model_card_export_jobs_paginator: ListModelCardExportJobsPaginator = client.get_paginator(
"list_model_card_export_jobs"
)
list_model_card_versions_paginator: ListModelCardVersionsPaginator = client.get_paginator(
"list_model_card_versions"
)
list_model_cards_paginator: ListModelCardsPaginator = client.get_paginator("list_model_cards")
list_model_explainability_job_definitions_paginator: ListModelExplainabilityJobDefinitionsPaginator = client.get_paginator(
"list_model_explainability_job_definitions"
)
list_model_metadata_paginator: ListModelMetadataPaginator = client.get_paginator(
"list_model_metadata"
)
list_model_package_groups_paginator: ListModelPackageGroupsPaginator = client.get_paginator(
"list_model_package_groups"
)
list_model_packages_paginator: ListModelPackagesPaginator = client.get_paginator(
"list_model_packages"
)
list_model_quality_job_definitions_paginator: ListModelQualityJobDefinitionsPaginator = (
client.get_paginator("list_model_quality_job_definitions")
)
list_models_paginator: ListModelsPaginator = client.get_paginator("list_models")
list_monitoring_alert_history_paginator: ListMonitoringAlertHistoryPaginator = client.get_paginator(
"list_monitoring_alert_history"
)
list_monitoring_alerts_paginator: ListMonitoringAlertsPaginator = client.get_paginator(
"list_monitoring_alerts"
)
list_monitoring_executions_paginator: ListMonitoringExecutionsPaginator = client.get_paginator(
"list_monitoring_executions"
)
list_monitoring_schedules_paginator: ListMonitoringSchedulesPaginator = client.get_paginator(
"list_monitoring_schedules"
)
list_notebook_instance_lifecycle_configs_paginator: ListNotebookInstanceLifecycleConfigsPaginator = client.get_paginator(
"list_notebook_instance_lifecycle_configs"
)
list_notebook_instances_paginator: ListNotebookInstancesPaginator = client.get_paginator(
"list_notebook_instances"
)
list_optimization_jobs_paginator: ListOptimizationJobsPaginator = client.get_paginator(
"list_optimization_jobs"
)
list_partner_apps_paginator: ListPartnerAppsPaginator = client.get_paginator("list_partner_apps")
list_pipeline_execution_steps_paginator: ListPipelineExecutionStepsPaginator = client.get_paginator(
"list_pipeline_execution_steps"
)
list_pipeline_executions_paginator: ListPipelineExecutionsPaginator = client.get_paginator(
"list_pipeline_executions"
)
list_pipeline_parameters_for_execution_paginator: ListPipelineParametersForExecutionPaginator = (
client.get_paginator("list_pipeline_parameters_for_execution")
)
list_pipelines_paginator: ListPipelinesPaginator = client.get_paginator("list_pipelines")
list_processing_jobs_paginator: ListProcessingJobsPaginator = client.get_paginator(
"list_processing_jobs"
)
list_resource_catalogs_paginator: ListResourceCatalogsPaginator = client.get_paginator(
"list_resource_catalogs"
)
list_spaces_paginator: ListSpacesPaginator = client.get_paginator("list_spaces")
list_stage_devices_paginator: ListStageDevicesPaginator = client.get_paginator("list_stage_devices")
list_studio_lifecycle_configs_paginator: ListStudioLifecycleConfigsPaginator = client.get_paginator(
"list_studio_lifecycle_configs"
)
list_subscribed_workteams_paginator: ListSubscribedWorkteamsPaginator = client.get_paginator(
"list_subscribed_workteams"
)
list_tags_paginator: ListTagsPaginator = client.get_paginator("list_tags")
list_training_jobs_for_hyper_parameter_tuning_job_paginator: ListTrainingJobsForHyperParameterTuningJobPaginator = client.get_paginator(
"list_training_jobs_for_hyper_parameter_tuning_job"
)
list_training_jobs_paginator: ListTrainingJobsPaginator = client.get_paginator("list_training_jobs")
list_training_plans_paginator: ListTrainingPlansPaginator = client.get_paginator(
"list_training_plans"
)
list_transform_jobs_paginator: ListTransformJobsPaginator = client.get_paginator(
"list_transform_jobs"
)
list_trial_components_paginator: ListTrialComponentsPaginator = client.get_paginator(
"list_trial_components"
)
list_trials_paginator: ListTrialsPaginator = client.get_paginator("list_trials")
list_user_profiles_paginator: ListUserProfilesPaginator = client.get_paginator("list_user_profiles")
list_workforces_paginator: ListWorkforcesPaginator = client.get_paginator("list_workforces")
list_workteams_paginator: ListWorkteamsPaginator = client.get_paginator("list_workteams")
search_paginator: SearchPaginator = client.get_paginator("search")
```
<a id="waiters-annotations"></a>
### Waiters annotations
`types_boto3_sagemaker.waiter` module contains type annotations for all
waiters.
```python
from boto3.session import Session
from types_boto3_sagemaker import SageMakerClient
from types_boto3_sagemaker.waiter import (
EndpointDeletedWaiter,
EndpointInServiceWaiter,
ImageCreatedWaiter,
ImageDeletedWaiter,
ImageUpdatedWaiter,
ImageVersionCreatedWaiter,
ImageVersionDeletedWaiter,
NotebookInstanceDeletedWaiter,
NotebookInstanceInServiceWaiter,
NotebookInstanceStoppedWaiter,
ProcessingJobCompletedOrStoppedWaiter,
TrainingJobCompletedOrStoppedWaiter,
TransformJobCompletedOrStoppedWaiter,
)
client: SageMakerClient = Session().client("sagemaker")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
endpoint_deleted_waiter: EndpointDeletedWaiter = client.get_waiter("endpoint_deleted")
endpoint_in_service_waiter: EndpointInServiceWaiter = client.get_waiter("endpoint_in_service")
image_created_waiter: ImageCreatedWaiter = client.get_waiter("image_created")
image_deleted_waiter: ImageDeletedWaiter = client.get_waiter("image_deleted")
image_updated_waiter: ImageUpdatedWaiter = client.get_waiter("image_updated")
image_version_created_waiter: ImageVersionCreatedWaiter = client.get_waiter("image_version_created")
image_version_deleted_waiter: ImageVersionDeletedWaiter = client.get_waiter("image_version_deleted")
notebook_instance_deleted_waiter: NotebookInstanceDeletedWaiter = client.get_waiter(
"notebook_instance_deleted"
)
notebook_instance_in_service_waiter: NotebookInstanceInServiceWaiter = client.get_waiter(
"notebook_instance_in_service"
)
notebook_instance_stopped_waiter: NotebookInstanceStoppedWaiter = client.get_waiter(
"notebook_instance_stopped"
)
processing_job_completed_or_stopped_waiter: ProcessingJobCompletedOrStoppedWaiter = (
client.get_waiter("processing_job_completed_or_stopped")
)
training_job_completed_or_stopped_waiter: TrainingJobCompletedOrStoppedWaiter = client.get_waiter(
"training_job_completed_or_stopped"
)
transform_job_completed_or_stopped_waiter: TransformJobCompletedOrStoppedWaiter = client.get_waiter(
"transform_job_completed_or_stopped"
)
```
<a id="literals"></a>
### Literals
`types_boto3_sagemaker.literals` module contains literals extracted from shapes
that can be used in user code for type checking.
Full list of `SageMaker` Literals can be found in
[docs](https://youtype.github.io/types_boto3_docs/types_boto3_sagemaker/literals/).
```python
from types_boto3_sagemaker.literals import ActionStatusType
def check_value(value: ActionStatusType) -> bool: ...
```
<a id="type-definitions"></a>
### Type definitions
`types_boto3_sagemaker.type_defs` module contains structures and shapes
assembled to typed dictionaries and unions for additional type checking.
Full list of `SageMaker` TypeDefs can be found in
[docs](https://youtype.github.io/types_boto3_docs/types_boto3_sagemaker/type_defs/).
```python
from types_boto3_sagemaker.type_defs import ActionSourceTypeDef
def get_value() -> ActionSourceTypeDef:
return {...}
```
<a id="how-it-works"></a>
## How it works
Fully automated
[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully
generates type annotations for each service, patiently waiting for `boto3`
updates. It delivers drop-in type annotations for you and makes sure that:
- All available `boto3` services are covered.
- Each public class and method of every `boto3` service gets valid type
annotations extracted from `botocore` schemas.
- Type annotations include up-to-date documentation.
- Link to documentation is provided for every method.
- Code is processed by [ruff](https://docs.astral.sh/ruff/) for readability.
<a id="what's-new"></a>
## What's new
<a id="implemented-features"></a>
### Implemented features
- Fully type annotated `boto3`, `botocore`, `aiobotocore` and `aioboto3`
libraries
- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs`
compatibility
- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type
annotations for each service
- Generated `TypeDefs` for each service
- Generated `Literals` for each service
- Auto discovery of types for `boto3.client` and `boto3.resource` calls
- Auto discovery of types for `session.client` and `session.resource` calls
- Auto discovery of types for `client.get_waiter` and `client.get_paginator`
calls
- Auto discovery of types for `ServiceResource` and `Resource` collections
- Auto discovery of types for `aiobotocore.Session.create_client` calls
<a id="latest-changes"></a>
### Latest changes
Builder changelog can be found in
[Releases](https://github.com/youtype/mypy_boto3_builder/releases).
<a id="versioning"></a>
## Versioning
`types-boto3-sagemaker` version is the same as related `boto3` version and
follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format.
<a id="thank-you"></a>
## Thank you
- [Allie Fitter](https://github.com/alliefitter) for
[boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),
this package is based on top of his work
- [black](https://github.com/psf/black) developers for an awesome formatting
tool
- [Timothy Edmund Crosley](https://github.com/timothycrosley) for
[isort](https://github.com/PyCQA/isort) and how flexible it is
- [mypy](https://github.com/python/mypy) developers for doing all dirty work
for us
- [pyright](https://github.com/microsoft/pyright) team for the new era of typed
Python
<a id="documentation"></a>
## Documentation
All services type annotations can be found in
[boto3 docs](https://youtype.github.io/types_boto3_docs/types_boto3_sagemaker/)
<a id="support-and-contributing"></a>
## Support and contributing
This package is auto-generated. Please reports any bugs or request new features
in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/)
repository.
Raw data
{
"_id": null,
"home_page": "https://github.com/youtype/mypy_boto3_builder",
"name": "types-boto3-sagemaker",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "boto3 sagemaker boto3-stubs type-annotations mypy typeshed autocomplete",
"author": "Vlad Emelianov",
"author_email": "vlad.emelianov.nz@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/e7/a2/8d4324243b437279cc0c84d07e2b310315c99b53664ab3c7a0a0d9d491be/types_boto3_sagemaker-1.35.75.tar.gz",
"platform": null,
"description": "<a id=\"types-boto3-sagemaker\"></a>\n\n# types-boto3-sagemaker\n\n[](https://pypi.org/project/types-boto3-sagemaker/)\n[](https://pypi.org/project/types-boto3-sagemaker/)\n[](https://youtype.github.io/types_boto3_docs/)\n[](https://pypistats.org/packages/types-boto3-sagemaker)\n\n\n\nType annotations for [boto3 SageMaker 1.35.75](https://pypi.org/project/boto3/)\ncompatible with [VSCode](https://code.visualstudio.com/),\n[PyCharm](https://www.jetbrains.com/pycharm/),\n[Emacs](https://www.gnu.org/software/emacs/),\n[Sublime Text](https://www.sublimetext.com/),\n[mypy](https://github.com/python/mypy),\n[pyright](https://github.com/microsoft/pyright) and other tools.\n\nGenerated by\n[mypy-boto3-builder 8.5.0](https://github.com/youtype/mypy_boto3_builder).\n\nMore information can be found on\n[types-boto3](https://pypi.org/project/types-boto3/) page and in\n[types-boto3-sagemaker docs](https://youtype.github.io/types_boto3_docs/types_boto3_sagemaker/).\n\nSee how it helps you find and fix potential bugs:\n\n\n\n- [types-boto3-sagemaker](#types-boto3-sagemaker)\n - [How to install](#how-to-install)\n - [VSCode extension](#vscode-extension)\n - [From PyPI with pip](#from-pypi-with-pip)\n - [How to uninstall](#how-to-uninstall)\n - [Usage](#usage)\n - [VSCode](#vscode)\n - [PyCharm](#pycharm)\n - [Emacs](#emacs)\n - [Sublime Text](#sublime-text)\n - [Other IDEs](#other-ides)\n - [mypy](#mypy)\n - [pyright](#pyright)\n - [Pylint compatibility](#pylint-compatibility)\n - [Explicit type annotations](#explicit-type-annotations)\n - [Client annotations](#client-annotations)\n - [Paginators annotations](#paginators-annotations)\n - [Waiters annotations](#waiters-annotations)\n - [Literals](#literals)\n - [Type definitions](#type-definitions)\n - [How it works](#how-it-works)\n - [What's new](#what's-new)\n - [Implemented features](#implemented-features)\n - [Latest changes](#latest-changes)\n - [Versioning](#versioning)\n - [Thank you](#thank-you)\n - [Documentation](#documentation)\n - [Support and contributing](#support-and-contributing)\n\n<a id=\"how-to-install\"></a>\n\n## How to install\n\n<a id=\"vscode-extension\"></a>\n\n### VSCode extension\n\nAdd\n[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide)\nextension to your VSCode and run `AWS boto3: Quick Start` command.\n\nClick `Modify` and select `boto3 common` and `SageMaker`.\n\n<a id=\"from-pypi-with-pip\"></a>\n\n### From PyPI with pip\n\nInstall `types-boto3` for `SageMaker` service.\n\n```bash\n# install with boto3 type annotations\npython -m pip install 'types-boto3[sagemaker]'\n\n\n# Lite version does not provide session.client/resource overloads\n# it is more RAM-friendly, but requires explicit type annotations\npython -m pip install 'types-boto3-lite[sagemaker]'\n\n\n# standalone installation\npython -m pip install types-boto3-sagemaker\n```\n\n<a id=\"how-to-uninstall\"></a>\n\n## How to uninstall\n\n```bash\npython -m pip uninstall -y types-boto3-sagemaker\n```\n\n<a id=\"usage\"></a>\n\n## Usage\n\n<a id=\"vscode\"></a>\n\n### VSCode\n\n- Install\n [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)\n- Install\n [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)\n- Set `Pylance` as your Python Language Server\n- Install `types-boto3[sagemaker]` in your environment:\n\n```bash\npython -m pip install 'types-boto3[sagemaker]'\n```\n\nBoth type checking and code completion should now work. No explicit type\nannotations required, write your `boto3` code as usual.\n\n<a id=\"pycharm\"></a>\n\n### PyCharm\n\n> \u26a0\ufe0f Due to slow PyCharm performance on `Literal` overloads (issue\n> [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended\n> to use [types-boto3-lite](https://pypi.org/project/types-boto3-lite/) until\n> the issue is resolved.\n\n> \u26a0\ufe0f If you experience slow performance and high CPU usage, try to disable\n> `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or\n> [pyright](https://github.com/microsoft/pyright) instead.\n\n> \u26a0\ufe0f To continue using `PyCharm` type checker, you can try to replace\n> `types-boto3` with\n> [types-boto3-lite](https://pypi.org/project/types-boto3-lite/):\n\n```bash\npip uninstall types-boto3\npip install types-boto3-lite\n```\n\nInstall `types-boto3[sagemaker]` in your environment:\n\n```bash\npython -m pip install 'types-boto3[sagemaker]'\n```\n\nBoth type checking and code completion should now work.\n\n<a id=\"emacs\"></a>\n\n### Emacs\n\n- Install `types-boto3` with services you use in your environment:\n\n```bash\npython -m pip install 'types-boto3[sagemaker]'\n```\n\n- Install [use-package](https://github.com/jwiegley/use-package),\n [lsp](https://github.com/emacs-lsp/lsp-mode/),\n [company](https://github.com/company-mode/company-mode) and\n [flycheck](https://github.com/flycheck/flycheck) packages\n- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package\n\n```elisp\n(use-package lsp-pyright\n :ensure t\n :hook (python-mode . (lambda ()\n (require 'lsp-pyright)\n (lsp))) ; or lsp-deferred\n :init (when (executable-find \"python3\")\n (setq lsp-pyright-python-executable-cmd \"python3\"))\n )\n```\n\n- Make sure emacs uses the environment where you have installed `types-boto3`\n\nType checking should now work. No explicit type annotations required, write\nyour `boto3` code as usual.\n\n<a id=\"sublime-text\"></a>\n\n### Sublime Text\n\n- Install `types-boto3[sagemaker]` with services you use in your environment:\n\n```bash\npython -m pip install 'types-boto3[sagemaker]'\n```\n\n- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package\n\nType checking should now work. No explicit type annotations required, write\nyour `boto3` code as usual.\n\n<a id=\"other-ides\"></a>\n\n### Other IDEs\n\nNot tested, but as long as your IDE supports `mypy` or `pyright`, everything\nshould work.\n\n<a id=\"mypy\"></a>\n\n### mypy\n\n- Install `mypy`: `python -m pip install mypy`\n- Install `types-boto3[sagemaker]` in your environment:\n\n```bash\npython -m pip install 'types-boto3[sagemaker]'\n```\n\nType checking should now work. No explicit type annotations required, write\nyour `boto3` code as usual.\n\n<a id=\"pyright\"></a>\n\n### pyright\n\n- Install `pyright`: `npm i -g pyright`\n- Install `types-boto3[sagemaker]` in your environment:\n\n```bash\npython -m pip install 'types-boto3[sagemaker]'\n```\n\nOptionally, you can install `types-boto3` to `typings` directory.\n\nType checking should now work. No explicit type annotations required, write\nyour `boto3` code as usual.\n\n<a id=\"pylint-compatibility\"></a>\n\n### Pylint compatibility\n\nIt is totally safe to use `TYPE_CHECKING` flag in order to avoid\n`types-boto3-sagemaker` dependency in production. However, there is an issue in\n`pylint` that it complains about undefined variables. To fix it, set all types\nto `object` in non-`TYPE_CHECKING` mode.\n\n```python\nfrom typing import TYPE_CHECKING\n\nif TYPE_CHECKING:\n from types_boto3_ec2 import EC2Client, EC2ServiceResource\n from types_boto3_ec2.waiters import BundleTaskCompleteWaiter\n from types_boto3_ec2.paginators import DescribeVolumesPaginator\nelse:\n EC2Client = object\n EC2ServiceResource = object\n BundleTaskCompleteWaiter = object\n DescribeVolumesPaginator = object\n\n...\n```\n\n<a id=\"explicit-type-annotations\"></a>\n\n## Explicit type annotations\n\n<a id=\"client-annotations\"></a>\n\n### Client annotations\n\n`SageMakerClient` provides annotations for `boto3.client(\"sagemaker\")`.\n\n```python\nfrom boto3.session import Session\n\nfrom types_boto3_sagemaker import SageMakerClient\n\nclient: SageMakerClient = Session().client(\"sagemaker\")\n\n# now client usage is checked by mypy and IDE should provide code completion\n```\n\n<a id=\"paginators-annotations\"></a>\n\n### Paginators annotations\n\n`types_boto3_sagemaker.paginator` module contains type annotations for all\npaginators.\n\n```python\nfrom boto3.session import Session\n\nfrom types_boto3_sagemaker import SageMakerClient\nfrom types_boto3_sagemaker.paginator import (\n ListActionsPaginator,\n ListAlgorithmsPaginator,\n ListAliasesPaginator,\n ListAppImageConfigsPaginator,\n ListAppsPaginator,\n ListArtifactsPaginator,\n ListAssociationsPaginator,\n ListAutoMLJobsPaginator,\n ListCandidatesForAutoMLJobPaginator,\n ListClusterNodesPaginator,\n ListClusterSchedulerConfigsPaginator,\n ListClustersPaginator,\n ListCodeRepositoriesPaginator,\n ListCompilationJobsPaginator,\n ListComputeQuotasPaginator,\n ListContextsPaginator,\n ListDataQualityJobDefinitionsPaginator,\n ListDeviceFleetsPaginator,\n ListDevicesPaginator,\n ListDomainsPaginator,\n ListEdgeDeploymentPlansPaginator,\n ListEdgePackagingJobsPaginator,\n ListEndpointConfigsPaginator,\n ListEndpointsPaginator,\n ListExperimentsPaginator,\n ListFeatureGroupsPaginator,\n ListFlowDefinitionsPaginator,\n ListHumanTaskUisPaginator,\n ListHyperParameterTuningJobsPaginator,\n ListImageVersionsPaginator,\n ListImagesPaginator,\n ListInferenceComponentsPaginator,\n ListInferenceExperimentsPaginator,\n ListInferenceRecommendationsJobStepsPaginator,\n ListInferenceRecommendationsJobsPaginator,\n ListLabelingJobsForWorkteamPaginator,\n ListLabelingJobsPaginator,\n ListLineageGroupsPaginator,\n ListMlflowTrackingServersPaginator,\n ListModelBiasJobDefinitionsPaginator,\n ListModelCardExportJobsPaginator,\n ListModelCardVersionsPaginator,\n ListModelCardsPaginator,\n ListModelExplainabilityJobDefinitionsPaginator,\n ListModelMetadataPaginator,\n ListModelPackageGroupsPaginator,\n ListModelPackagesPaginator,\n ListModelQualityJobDefinitionsPaginator,\n ListModelsPaginator,\n ListMonitoringAlertHistoryPaginator,\n ListMonitoringAlertsPaginator,\n ListMonitoringExecutionsPaginator,\n ListMonitoringSchedulesPaginator,\n ListNotebookInstanceLifecycleConfigsPaginator,\n ListNotebookInstancesPaginator,\n ListOptimizationJobsPaginator,\n ListPartnerAppsPaginator,\n ListPipelineExecutionStepsPaginator,\n ListPipelineExecutionsPaginator,\n ListPipelineParametersForExecutionPaginator,\n ListPipelinesPaginator,\n ListProcessingJobsPaginator,\n ListResourceCatalogsPaginator,\n ListSpacesPaginator,\n ListStageDevicesPaginator,\n ListStudioLifecycleConfigsPaginator,\n ListSubscribedWorkteamsPaginator,\n ListTagsPaginator,\n ListTrainingJobsForHyperParameterTuningJobPaginator,\n ListTrainingJobsPaginator,\n ListTrainingPlansPaginator,\n ListTransformJobsPaginator,\n ListTrialComponentsPaginator,\n ListTrialsPaginator,\n ListUserProfilesPaginator,\n ListWorkforcesPaginator,\n ListWorkteamsPaginator,\n SearchPaginator,\n)\n\nclient: SageMakerClient = Session().client(\"sagemaker\")\n\n# Explicit type annotations are optional here\n# Types should be correctly discovered by mypy and IDEs\nlist_actions_paginator: ListActionsPaginator = client.get_paginator(\"list_actions\")\nlist_algorithms_paginator: ListAlgorithmsPaginator = client.get_paginator(\"list_algorithms\")\nlist_aliases_paginator: ListAliasesPaginator = client.get_paginator(\"list_aliases\")\nlist_app_image_configs_paginator: ListAppImageConfigsPaginator = client.get_paginator(\n \"list_app_image_configs\"\n)\nlist_apps_paginator: ListAppsPaginator = client.get_paginator(\"list_apps\")\nlist_artifacts_paginator: ListArtifactsPaginator = client.get_paginator(\"list_artifacts\")\nlist_associations_paginator: ListAssociationsPaginator = client.get_paginator(\"list_associations\")\nlist_auto_ml_jobs_paginator: ListAutoMLJobsPaginator = client.get_paginator(\"list_auto_ml_jobs\")\nlist_candidates_for_auto_ml_job_paginator: ListCandidatesForAutoMLJobPaginator = (\n client.get_paginator(\"list_candidates_for_auto_ml_job\")\n)\nlist_cluster_nodes_paginator: ListClusterNodesPaginator = client.get_paginator(\"list_cluster_nodes\")\nlist_cluster_scheduler_configs_paginator: ListClusterSchedulerConfigsPaginator = (\n client.get_paginator(\"list_cluster_scheduler_configs\")\n)\nlist_clusters_paginator: ListClustersPaginator = client.get_paginator(\"list_clusters\")\nlist_code_repositories_paginator: ListCodeRepositoriesPaginator = client.get_paginator(\n \"list_code_repositories\"\n)\nlist_compilation_jobs_paginator: ListCompilationJobsPaginator = client.get_paginator(\n \"list_compilation_jobs\"\n)\nlist_compute_quotas_paginator: ListComputeQuotasPaginator = client.get_paginator(\n \"list_compute_quotas\"\n)\nlist_contexts_paginator: ListContextsPaginator = client.get_paginator(\"list_contexts\")\nlist_data_quality_job_definitions_paginator: ListDataQualityJobDefinitionsPaginator = (\n client.get_paginator(\"list_data_quality_job_definitions\")\n)\nlist_device_fleets_paginator: ListDeviceFleetsPaginator = client.get_paginator(\"list_device_fleets\")\nlist_devices_paginator: ListDevicesPaginator = client.get_paginator(\"list_devices\")\nlist_domains_paginator: ListDomainsPaginator = client.get_paginator(\"list_domains\")\nlist_edge_deployment_plans_paginator: ListEdgeDeploymentPlansPaginator = client.get_paginator(\n \"list_edge_deployment_plans\"\n)\nlist_edge_packaging_jobs_paginator: ListEdgePackagingJobsPaginator = client.get_paginator(\n \"list_edge_packaging_jobs\"\n)\nlist_endpoint_configs_paginator: ListEndpointConfigsPaginator = client.get_paginator(\n \"list_endpoint_configs\"\n)\nlist_endpoints_paginator: ListEndpointsPaginator = client.get_paginator(\"list_endpoints\")\nlist_experiments_paginator: ListExperimentsPaginator = client.get_paginator(\"list_experiments\")\nlist_feature_groups_paginator: ListFeatureGroupsPaginator = client.get_paginator(\n \"list_feature_groups\"\n)\nlist_flow_definitions_paginator: ListFlowDefinitionsPaginator = client.get_paginator(\n \"list_flow_definitions\"\n)\nlist_human_task_uis_paginator: ListHumanTaskUisPaginator = client.get_paginator(\n \"list_human_task_uis\"\n)\nlist_hyper_parameter_tuning_jobs_paginator: ListHyperParameterTuningJobsPaginator = (\n client.get_paginator(\"list_hyper_parameter_tuning_jobs\")\n)\nlist_image_versions_paginator: ListImageVersionsPaginator = client.get_paginator(\n \"list_image_versions\"\n)\nlist_images_paginator: ListImagesPaginator = client.get_paginator(\"list_images\")\nlist_inference_components_paginator: ListInferenceComponentsPaginator = client.get_paginator(\n \"list_inference_components\"\n)\nlist_inference_experiments_paginator: ListInferenceExperimentsPaginator = client.get_paginator(\n \"list_inference_experiments\"\n)\nlist_inference_recommendations_job_steps_paginator: ListInferenceRecommendationsJobStepsPaginator = client.get_paginator(\n \"list_inference_recommendations_job_steps\"\n)\nlist_inference_recommendations_jobs_paginator: ListInferenceRecommendationsJobsPaginator = (\n client.get_paginator(\"list_inference_recommendations_jobs\")\n)\nlist_labeling_jobs_for_workteam_paginator: ListLabelingJobsForWorkteamPaginator = (\n client.get_paginator(\"list_labeling_jobs_for_workteam\")\n)\nlist_labeling_jobs_paginator: ListLabelingJobsPaginator = client.get_paginator(\"list_labeling_jobs\")\nlist_lineage_groups_paginator: ListLineageGroupsPaginator = client.get_paginator(\n \"list_lineage_groups\"\n)\nlist_mlflow_tracking_servers_paginator: ListMlflowTrackingServersPaginator = client.get_paginator(\n \"list_mlflow_tracking_servers\"\n)\nlist_model_bias_job_definitions_paginator: ListModelBiasJobDefinitionsPaginator = (\n client.get_paginator(\"list_model_bias_job_definitions\")\n)\nlist_model_card_export_jobs_paginator: ListModelCardExportJobsPaginator = client.get_paginator(\n \"list_model_card_export_jobs\"\n)\nlist_model_card_versions_paginator: ListModelCardVersionsPaginator = client.get_paginator(\n \"list_model_card_versions\"\n)\nlist_model_cards_paginator: ListModelCardsPaginator = client.get_paginator(\"list_model_cards\")\nlist_model_explainability_job_definitions_paginator: ListModelExplainabilityJobDefinitionsPaginator = client.get_paginator(\n \"list_model_explainability_job_definitions\"\n)\nlist_model_metadata_paginator: ListModelMetadataPaginator = client.get_paginator(\n \"list_model_metadata\"\n)\nlist_model_package_groups_paginator: ListModelPackageGroupsPaginator = client.get_paginator(\n \"list_model_package_groups\"\n)\nlist_model_packages_paginator: ListModelPackagesPaginator = client.get_paginator(\n \"list_model_packages\"\n)\nlist_model_quality_job_definitions_paginator: ListModelQualityJobDefinitionsPaginator = (\n client.get_paginator(\"list_model_quality_job_definitions\")\n)\nlist_models_paginator: ListModelsPaginator = client.get_paginator(\"list_models\")\nlist_monitoring_alert_history_paginator: ListMonitoringAlertHistoryPaginator = client.get_paginator(\n \"list_monitoring_alert_history\"\n)\nlist_monitoring_alerts_paginator: ListMonitoringAlertsPaginator = client.get_paginator(\n \"list_monitoring_alerts\"\n)\nlist_monitoring_executions_paginator: ListMonitoringExecutionsPaginator = client.get_paginator(\n \"list_monitoring_executions\"\n)\nlist_monitoring_schedules_paginator: ListMonitoringSchedulesPaginator = client.get_paginator(\n \"list_monitoring_schedules\"\n)\nlist_notebook_instance_lifecycle_configs_paginator: ListNotebookInstanceLifecycleConfigsPaginator = client.get_paginator(\n \"list_notebook_instance_lifecycle_configs\"\n)\nlist_notebook_instances_paginator: ListNotebookInstancesPaginator = client.get_paginator(\n \"list_notebook_instances\"\n)\nlist_optimization_jobs_paginator: ListOptimizationJobsPaginator = client.get_paginator(\n \"list_optimization_jobs\"\n)\nlist_partner_apps_paginator: ListPartnerAppsPaginator = client.get_paginator(\"list_partner_apps\")\nlist_pipeline_execution_steps_paginator: ListPipelineExecutionStepsPaginator = client.get_paginator(\n \"list_pipeline_execution_steps\"\n)\nlist_pipeline_executions_paginator: ListPipelineExecutionsPaginator = client.get_paginator(\n \"list_pipeline_executions\"\n)\nlist_pipeline_parameters_for_execution_paginator: ListPipelineParametersForExecutionPaginator = (\n client.get_paginator(\"list_pipeline_parameters_for_execution\")\n)\nlist_pipelines_paginator: ListPipelinesPaginator = client.get_paginator(\"list_pipelines\")\nlist_processing_jobs_paginator: ListProcessingJobsPaginator = client.get_paginator(\n \"list_processing_jobs\"\n)\nlist_resource_catalogs_paginator: ListResourceCatalogsPaginator = client.get_paginator(\n \"list_resource_catalogs\"\n)\nlist_spaces_paginator: ListSpacesPaginator = client.get_paginator(\"list_spaces\")\nlist_stage_devices_paginator: ListStageDevicesPaginator = client.get_paginator(\"list_stage_devices\")\nlist_studio_lifecycle_configs_paginator: ListStudioLifecycleConfigsPaginator = client.get_paginator(\n \"list_studio_lifecycle_configs\"\n)\nlist_subscribed_workteams_paginator: ListSubscribedWorkteamsPaginator = client.get_paginator(\n \"list_subscribed_workteams\"\n)\nlist_tags_paginator: ListTagsPaginator = client.get_paginator(\"list_tags\")\nlist_training_jobs_for_hyper_parameter_tuning_job_paginator: ListTrainingJobsForHyperParameterTuningJobPaginator = client.get_paginator(\n \"list_training_jobs_for_hyper_parameter_tuning_job\"\n)\nlist_training_jobs_paginator: ListTrainingJobsPaginator = client.get_paginator(\"list_training_jobs\")\nlist_training_plans_paginator: ListTrainingPlansPaginator = client.get_paginator(\n \"list_training_plans\"\n)\nlist_transform_jobs_paginator: ListTransformJobsPaginator = client.get_paginator(\n \"list_transform_jobs\"\n)\nlist_trial_components_paginator: ListTrialComponentsPaginator = client.get_paginator(\n \"list_trial_components\"\n)\nlist_trials_paginator: ListTrialsPaginator = client.get_paginator(\"list_trials\")\nlist_user_profiles_paginator: ListUserProfilesPaginator = client.get_paginator(\"list_user_profiles\")\nlist_workforces_paginator: ListWorkforcesPaginator = client.get_paginator(\"list_workforces\")\nlist_workteams_paginator: ListWorkteamsPaginator = client.get_paginator(\"list_workteams\")\nsearch_paginator: SearchPaginator = client.get_paginator(\"search\")\n```\n\n<a id=\"waiters-annotations\"></a>\n\n### Waiters annotations\n\n`types_boto3_sagemaker.waiter` module contains type annotations for all\nwaiters.\n\n```python\nfrom boto3.session import Session\n\nfrom types_boto3_sagemaker import SageMakerClient\nfrom types_boto3_sagemaker.waiter import (\n EndpointDeletedWaiter,\n EndpointInServiceWaiter,\n ImageCreatedWaiter,\n ImageDeletedWaiter,\n ImageUpdatedWaiter,\n ImageVersionCreatedWaiter,\n ImageVersionDeletedWaiter,\n NotebookInstanceDeletedWaiter,\n NotebookInstanceInServiceWaiter,\n NotebookInstanceStoppedWaiter,\n ProcessingJobCompletedOrStoppedWaiter,\n TrainingJobCompletedOrStoppedWaiter,\n TransformJobCompletedOrStoppedWaiter,\n)\n\nclient: SageMakerClient = Session().client(\"sagemaker\")\n\n# Explicit type annotations are optional here\n# Types should be correctly discovered by mypy and IDEs\nendpoint_deleted_waiter: EndpointDeletedWaiter = client.get_waiter(\"endpoint_deleted\")\nendpoint_in_service_waiter: EndpointInServiceWaiter = client.get_waiter(\"endpoint_in_service\")\nimage_created_waiter: ImageCreatedWaiter = client.get_waiter(\"image_created\")\nimage_deleted_waiter: ImageDeletedWaiter = client.get_waiter(\"image_deleted\")\nimage_updated_waiter: ImageUpdatedWaiter = client.get_waiter(\"image_updated\")\nimage_version_created_waiter: ImageVersionCreatedWaiter = client.get_waiter(\"image_version_created\")\nimage_version_deleted_waiter: ImageVersionDeletedWaiter = client.get_waiter(\"image_version_deleted\")\nnotebook_instance_deleted_waiter: NotebookInstanceDeletedWaiter = client.get_waiter(\n \"notebook_instance_deleted\"\n)\nnotebook_instance_in_service_waiter: NotebookInstanceInServiceWaiter = client.get_waiter(\n \"notebook_instance_in_service\"\n)\nnotebook_instance_stopped_waiter: NotebookInstanceStoppedWaiter = client.get_waiter(\n \"notebook_instance_stopped\"\n)\nprocessing_job_completed_or_stopped_waiter: ProcessingJobCompletedOrStoppedWaiter = (\n client.get_waiter(\"processing_job_completed_or_stopped\")\n)\ntraining_job_completed_or_stopped_waiter: TrainingJobCompletedOrStoppedWaiter = client.get_waiter(\n \"training_job_completed_or_stopped\"\n)\ntransform_job_completed_or_stopped_waiter: TransformJobCompletedOrStoppedWaiter = client.get_waiter(\n \"transform_job_completed_or_stopped\"\n)\n```\n\n<a id=\"literals\"></a>\n\n### Literals\n\n`types_boto3_sagemaker.literals` module contains literals extracted from shapes\nthat can be used in user code for type checking.\n\nFull list of `SageMaker` Literals can be found in\n[docs](https://youtype.github.io/types_boto3_docs/types_boto3_sagemaker/literals/).\n\n```python\nfrom types_boto3_sagemaker.literals import ActionStatusType\n\n\ndef check_value(value: ActionStatusType) -> bool: ...\n```\n\n<a id=\"type-definitions\"></a>\n\n### Type definitions\n\n`types_boto3_sagemaker.type_defs` module contains structures and shapes\nassembled to typed dictionaries and unions for additional type checking.\n\nFull list of `SageMaker` TypeDefs can be found in\n[docs](https://youtype.github.io/types_boto3_docs/types_boto3_sagemaker/type_defs/).\n\n```python\nfrom types_boto3_sagemaker.type_defs import ActionSourceTypeDef\n\n\ndef get_value() -> ActionSourceTypeDef:\n return {...}\n```\n\n<a id=\"how-it-works\"></a>\n\n## How it works\n\nFully automated\n[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully\ngenerates type annotations for each service, patiently waiting for `boto3`\nupdates. It delivers drop-in type annotations for you and makes sure that:\n\n- All available `boto3` services are covered.\n- Each public class and method of every `boto3` service gets valid type\n annotations extracted from `botocore` schemas.\n- Type annotations include up-to-date documentation.\n- Link to documentation is provided for every method.\n- Code is processed by [ruff](https://docs.astral.sh/ruff/) for readability.\n\n<a id=\"what's-new\"></a>\n\n## What's new\n\n<a id=\"implemented-features\"></a>\n\n### Implemented features\n\n- Fully type annotated `boto3`, `botocore`, `aiobotocore` and `aioboto3`\n libraries\n- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs`\n compatibility\n- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type\n annotations for each service\n- Generated `TypeDefs` for each service\n- Generated `Literals` for each service\n- Auto discovery of types for `boto3.client` and `boto3.resource` calls\n- Auto discovery of types for `session.client` and `session.resource` calls\n- Auto discovery of types for `client.get_waiter` and `client.get_paginator`\n calls\n- Auto discovery of types for `ServiceResource` and `Resource` collections\n- Auto discovery of types for `aiobotocore.Session.create_client` calls\n\n<a id=\"latest-changes\"></a>\n\n### Latest changes\n\nBuilder changelog can be found in\n[Releases](https://github.com/youtype/mypy_boto3_builder/releases).\n\n<a id=\"versioning\"></a>\n\n## Versioning\n\n`types-boto3-sagemaker` version is the same as related `boto3` version and\nfollows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format.\n\n<a id=\"thank-you\"></a>\n\n## Thank you\n\n- [Allie Fitter](https://github.com/alliefitter) for\n [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),\n this package is based on top of his work\n- [black](https://github.com/psf/black) developers for an awesome formatting\n tool\n- [Timothy Edmund Crosley](https://github.com/timothycrosley) for\n [isort](https://github.com/PyCQA/isort) and how flexible it is\n- [mypy](https://github.com/python/mypy) developers for doing all dirty work\n for us\n- [pyright](https://github.com/microsoft/pyright) team for the new era of typed\n Python\n\n<a id=\"documentation\"></a>\n\n## Documentation\n\nAll services type annotations can be found in\n[boto3 docs](https://youtype.github.io/types_boto3_docs/types_boto3_sagemaker/)\n\n<a id=\"support-and-contributing\"></a>\n\n## Support and contributing\n\nThis package is auto-generated. Please reports any bugs or request new features\nin [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/)\nrepository.\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Type annotations for boto3 SageMaker 1.35.75 service generated with mypy-boto3-builder 8.5.0",
"version": "1.35.75",
"project_urls": {
"Documentation": "https://youtype.github.io/types_boto3_docs/types_boto3_sagemaker/",
"Homepage": "https://github.com/youtype/mypy_boto3_builder",
"Source": "https://github.com/youtype/mypy_boto3_builder",
"Tracker": "https://github.com/youtype/mypy_boto3_builder/issues"
},
"split_keywords": [
"boto3",
"sagemaker",
"boto3-stubs",
"type-annotations",
"mypy",
"typeshed",
"autocomplete"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1a24cbe0ad0d571be4b2fe4dc36f950ee0e947eb5025f26241be6243d4e133ca",
"md5": "57fa4761eae17f9735fa6772b078d823",
"sha256": "e9f4f3311701f40d1cb3f67f76ce396b0e20ac3593ba2faf4d6d85ef499221c3"
},
"downloads": -1,
"filename": "types_boto3_sagemaker-1.35.75-py3-none-any.whl",
"has_sig": false,
"md5_digest": "57fa4761eae17f9735fa6772b078d823",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 213462,
"upload_time": "2024-12-04T20:33:48",
"upload_time_iso_8601": "2024-12-04T20:33:48.360002Z",
"url": "https://files.pythonhosted.org/packages/1a/24/cbe0ad0d571be4b2fe4dc36f950ee0e947eb5025f26241be6243d4e133ca/types_boto3_sagemaker-1.35.75-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e7a28d4324243b437279cc0c84d07e2b310315c99b53664ab3c7a0a0d9d491be",
"md5": "44d5c6fa71237486a4b49a8592cb9b8f",
"sha256": "989060148b2363b22a542ed390d6b7d53e87c2a5fe3f0e93ba0e1e5d0b9d9e7f"
},
"downloads": -1,
"filename": "types_boto3_sagemaker-1.35.75.tar.gz",
"has_sig": false,
"md5_digest": "44d5c6fa71237486a4b49a8592cb9b8f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 209567,
"upload_time": "2024-12-04T20:33:49",
"upload_time_iso_8601": "2024-12-04T20:33:49.676862Z",
"url": "https://files.pythonhosted.org/packages/e7/a2/8d4324243b437279cc0c84d07e2b310315c99b53664ab3c7a0a0d9d491be/types_boto3_sagemaker-1.35.75.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-04 20:33:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "youtype",
"github_project": "mypy_boto3_builder",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "types-boto3-sagemaker"
}
JSON
