mypy-boto3-sagemaker 1.21.36__py3-none-any.whl → 1.41.1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,796 @@
1
+ Metadata-Version: 2.4
2
+ Name: mypy-boto3-sagemaker
3
+ Version: 1.41.1
4
+ Summary: Type annotations for boto3 SageMaker 1.41.1 service generated with mypy-boto3-builder 8.12.0
5
+ Author-email: Vlad Emelianov <vlad.emelianov.nz@gmail.com>
6
+ License-Expression: MIT
7
+ Project-URL: Homepage, https://github.com/youtype/mypy_boto3_builder
8
+ Project-URL: Documentation, https://youtype.github.io/boto3_stubs_docs/mypy_boto3_sagemaker/
9
+ Project-URL: Source, https://github.com/youtype/mypy_boto3_builder
10
+ Project-URL: Tracker, https://github.com/youtype/mypy_boto3_builder/issues
11
+ Keywords: boto3,sagemaker,boto3-stubs,type-annotations,mypy,typeshed,autocomplete
12
+ Platform: any
13
+ Classifier: Development Status :: 5 - Production/Stable
14
+ Classifier: Intended Audience :: Developers
15
+ Classifier: Environment :: Console
16
+ Classifier: Natural Language :: English
17
+ Classifier: Operating System :: OS Independent
18
+ Classifier: Programming Language :: Python :: 3
19
+ Classifier: Programming Language :: Python :: 3.9
20
+ Classifier: Programming Language :: Python :: 3.10
21
+ Classifier: Programming Language :: Python :: 3.11
22
+ Classifier: Programming Language :: Python :: 3.12
23
+ Classifier: Programming Language :: Python :: 3.13
24
+ Classifier: Programming Language :: Python :: 3.14
25
+ Classifier: Programming Language :: Python :: 3 :: Only
26
+ Classifier: Programming Language :: Python :: Implementation :: CPython
27
+ Classifier: Typing :: Stubs Only
28
+ Requires-Python: >=3.9
29
+ Description-Content-Type: text/markdown
30
+ License-File: LICENSE
31
+ Requires-Dist: typing-extensions; python_version < "3.12"
32
+ Dynamic: license-file
33
+
34
+ <a id="mypy-boto3-sagemaker"></a>
35
+
36
+ # mypy-boto3-sagemaker
37
+
38
+ [![PyPI - mypy-boto3-sagemaker](https://img.shields.io/pypi/v/mypy-boto3-sagemaker.svg?color=blue)](https://pypi.org/project/mypy-boto3-sagemaker/)
39
+ [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-sagemaker.svg?color=blue)](https://pypi.org/project/mypy-boto3-sagemaker/)
40
+ [![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/boto3_stubs_docs/)
41
+ [![PyPI - Downloads](https://static.pepy.tech/badge/mypy-boto3-sagemaker)](https://pypistats.org/packages/mypy-boto3-sagemaker)
42
+
43
+ ![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)
44
+
45
+ Type annotations for [boto3 SageMaker 1.41.1](https://pypi.org/project/boto3/)
46
+ compatible with [VSCode](https://code.visualstudio.com/),
47
+ [PyCharm](https://www.jetbrains.com/pycharm/),
48
+ [Emacs](https://www.gnu.org/software/emacs/),
49
+ [Sublime Text](https://www.sublimetext.com/),
50
+ [mypy](https://github.com/python/mypy),
51
+ [pyright](https://github.com/microsoft/pyright) and other tools.
52
+
53
+ Generated with
54
+ [mypy-boto3-builder 8.12.0](https://github.com/youtype/mypy_boto3_builder).
55
+
56
+ More information can be found on
57
+ [boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
58
+ [mypy-boto3-sagemaker docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_sagemaker/).
59
+
60
+ See how it helps you find and fix potential bugs:
61
+
62
+ ![types-boto3 demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)
63
+
64
+ - [mypy-boto3-sagemaker](#mypy-boto3-sagemaker)
65
+ - [How to install](#how-to-install)
66
+ - [Generate locally (recommended)](<#generate-locally-(recommended)>)
67
+ - [VSCode extension](#vscode-extension)
68
+ - [From PyPI with pip](#from-pypi-with-pip)
69
+ - [How to uninstall](#how-to-uninstall)
70
+ - [Usage](#usage)
71
+ - [VSCode](#vscode)
72
+ - [PyCharm](#pycharm)
73
+ - [Emacs](#emacs)
74
+ - [Sublime Text](#sublime-text)
75
+ - [Other IDEs](#other-ides)
76
+ - [mypy](#mypy)
77
+ - [pyright](#pyright)
78
+ - [Pylint compatibility](#pylint-compatibility)
79
+ - [Explicit type annotations](#explicit-type-annotations)
80
+ - [Client annotations](#client-annotations)
81
+ - [Paginators annotations](#paginators-annotations)
82
+ - [Waiters annotations](#waiters-annotations)
83
+ - [Literals](#literals)
84
+ - [Type definitions](#type-definitions)
85
+ - [How it works](#how-it-works)
86
+ - [What's new](#what's-new)
87
+ - [Implemented features](#implemented-features)
88
+ - [Latest changes](#latest-changes)
89
+ - [Versioning](#versioning)
90
+ - [Thank you](#thank-you)
91
+ - [Documentation](#documentation)
92
+ - [Support and contributing](#support-and-contributing)
93
+
94
+ <a id="how-to-install"></a>
95
+
96
+ ## How to install
97
+
98
+ <a id="generate-locally-(recommended)"></a>
99
+
100
+ ### Generate locally (recommended)
101
+
102
+ You can generate type annotations for `boto3` package locally with
103
+ `mypy-boto3-builder`. Use
104
+ [uv](https://docs.astral.sh/uv/getting-started/installation/) for build
105
+ isolation.
106
+
107
+ 1. Run mypy-boto3-builder in your package root directory:
108
+ `uvx --with 'boto3==1.41.1' mypy-boto3-builder`
109
+ 2. Select `boto3-stubs` AWS SDK.
110
+ 3. Add `SageMaker` service.
111
+ 4. Use provided commands to install generated packages.
112
+
113
+ <a id="vscode-extension"></a>
114
+
115
+ ### VSCode extension
116
+
117
+ Add
118
+ [AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide)
119
+ extension to your VSCode and run `AWS boto3: Quick Start` command.
120
+
121
+ Click `Modify` and select `boto3 common` and `SageMaker`.
122
+
123
+ <a id="from-pypi-with-pip"></a>
124
+
125
+ ### From PyPI with pip
126
+
127
+ Install `boto3-stubs` for `SageMaker` service.
128
+
129
+ ```bash
130
+ # install with boto3 type annotations
131
+ python -m pip install 'boto3-stubs[sagemaker]'
132
+
133
+ # Lite version does not provide session.client/resource overloads
134
+ # it is more RAM-friendly, but requires explicit type annotations
135
+ python -m pip install 'boto3-stubs-lite[sagemaker]'
136
+
137
+ # standalone installation
138
+ python -m pip install mypy-boto3-sagemaker
139
+ ```
140
+
141
+ <a id="how-to-uninstall"></a>
142
+
143
+ ## How to uninstall
144
+
145
+ ```bash
146
+ python -m pip uninstall -y mypy-boto3-sagemaker
147
+ ```
148
+
149
+ <a id="usage"></a>
150
+
151
+ ## Usage
152
+
153
+ <a id="vscode"></a>
154
+
155
+ ### VSCode
156
+
157
+ - Install
158
+ [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
159
+ - Install
160
+ [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
161
+ - Set `Pylance` as your Python Language Server
162
+ - Install `boto3-stubs[sagemaker]` in your environment:
163
+
164
+ ```bash
165
+ python -m pip install 'boto3-stubs[sagemaker]'
166
+ ```
167
+
168
+ Both type checking and code completion should now work. No explicit type
169
+ annotations required, write your `boto3` code as usual.
170
+
171
+ <a id="pycharm"></a>
172
+
173
+ ### PyCharm
174
+
175
+ > ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
176
+ > [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
177
+ > to use [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/) until
178
+ > the issue is resolved.
179
+
180
+ > ⚠️ If you experience slow performance and high CPU usage, try to disable
181
+ > `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
182
+ > [pyright](https://github.com/microsoft/pyright) instead.
183
+
184
+ > ⚠️ To continue using `PyCharm` type checker, you can try to replace
185
+ > `boto3-stubs` with
186
+ > [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/):
187
+
188
+ ```bash
189
+ pip uninstall boto3-stubs
190
+ pip install boto3-stubs-lite
191
+ ```
192
+
193
+ Install `boto3-stubs[sagemaker]` in your environment:
194
+
195
+ ```bash
196
+ python -m pip install 'boto3-stubs[sagemaker]'
197
+ ```
198
+
199
+ Both type checking and code completion should now work.
200
+
201
+ <a id="emacs"></a>
202
+
203
+ ### Emacs
204
+
205
+ - Install `boto3-stubs` with services you use in your environment:
206
+
207
+ ```bash
208
+ python -m pip install 'boto3-stubs[sagemaker]'
209
+ ```
210
+
211
+ - Install [use-package](https://github.com/jwiegley/use-package),
212
+ [lsp](https://github.com/emacs-lsp/lsp-mode/),
213
+ [company](https://github.com/company-mode/company-mode) and
214
+ [flycheck](https://github.com/flycheck/flycheck) packages
215
+ - Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package
216
+
217
+ ```elisp
218
+ (use-package lsp-pyright
219
+ :ensure t
220
+ :hook (python-mode . (lambda ()
221
+ (require 'lsp-pyright)
222
+ (lsp))) ; or lsp-deferred
223
+ :init (when (executable-find "python3")
224
+ (setq lsp-pyright-python-executable-cmd "python3"))
225
+ )
226
+ ```
227
+
228
+ - Make sure emacs uses the environment where you have installed `boto3-stubs`
229
+
230
+ Type checking should now work. No explicit type annotations required, write
231
+ your `boto3` code as usual.
232
+
233
+ <a id="sublime-text"></a>
234
+
235
+ ### Sublime Text
236
+
237
+ - Install `boto3-stubs[sagemaker]` with services you use in your environment:
238
+
239
+ ```bash
240
+ python -m pip install 'boto3-stubs[sagemaker]'
241
+ ```
242
+
243
+ - Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package
244
+
245
+ Type checking should now work. No explicit type annotations required, write
246
+ your `boto3` code as usual.
247
+
248
+ <a id="other-ides"></a>
249
+
250
+ ### Other IDEs
251
+
252
+ Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
253
+ should work.
254
+
255
+ <a id="mypy"></a>
256
+
257
+ ### mypy
258
+
259
+ - Install `mypy`: `python -m pip install mypy`
260
+ - Install `boto3-stubs[sagemaker]` in your environment:
261
+
262
+ ```bash
263
+ python -m pip install 'boto3-stubs[sagemaker]'
264
+ ```
265
+
266
+ Type checking should now work. No explicit type annotations required, write
267
+ your `boto3` code as usual.
268
+
269
+ <a id="pyright"></a>
270
+
271
+ ### pyright
272
+
273
+ - Install `pyright`: `npm i -g pyright`
274
+ - Install `boto3-stubs[sagemaker]` in your environment:
275
+
276
+ ```bash
277
+ python -m pip install 'boto3-stubs[sagemaker]'
278
+ ```
279
+
280
+ Optionally, you can install `boto3-stubs` to `typings` directory.
281
+
282
+ Type checking should now work. No explicit type annotations required, write
283
+ your `boto3` code as usual.
284
+
285
+ <a id="pylint-compatibility"></a>
286
+
287
+ ### Pylint compatibility
288
+
289
+ It is totally safe to use `TYPE_CHECKING` flag in order to avoid
290
+ `mypy-boto3-sagemaker` dependency in production. However, there is an issue in
291
+ `pylint` that it complains about undefined variables. To fix it, set all types
292
+ to `object` in non-`TYPE_CHECKING` mode.
293
+
294
+ ```python
295
+ from typing import TYPE_CHECKING
296
+
297
+ if TYPE_CHECKING:
298
+ from mypy_boto3_ec2 import EC2Client, EC2ServiceResource
299
+ from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
300
+ from mypy_boto3_ec2.paginators import DescribeVolumesPaginator
301
+ else:
302
+ EC2Client = object
303
+ EC2ServiceResource = object
304
+ BundleTaskCompleteWaiter = object
305
+ DescribeVolumesPaginator = object
306
+
307
+ ...
308
+ ```
309
+
310
+ <a id="explicit-type-annotations"></a>
311
+
312
+ ## Explicit type annotations
313
+
314
+ <a id="client-annotations"></a>
315
+
316
+ ### Client annotations
317
+
318
+ `SageMakerClient` provides annotations for `boto3.client("sagemaker")`.
319
+
320
+ ```python
321
+ from boto3.session import Session
322
+
323
+ from mypy_boto3_sagemaker import SageMakerClient
324
+
325
+ client: SageMakerClient = Session().client("sagemaker")
326
+
327
+ # now client usage is checked by mypy and IDE should provide code completion
328
+ ```
329
+
330
+ <a id="paginators-annotations"></a>
331
+
332
+ ### Paginators annotations
333
+
334
+ `mypy_boto3_sagemaker.paginator` module contains type annotations for all
335
+ paginators.
336
+
337
+ ```python
338
+ from boto3.session import Session
339
+
340
+ from mypy_boto3_sagemaker import SageMakerClient
341
+ from mypy_boto3_sagemaker.paginator import (
342
+ CreateHubContentPresignedUrlsPaginator,
343
+ ListActionsPaginator,
344
+ ListAlgorithmsPaginator,
345
+ ListAliasesPaginator,
346
+ ListAppImageConfigsPaginator,
347
+ ListAppsPaginator,
348
+ ListArtifactsPaginator,
349
+ ListAssociationsPaginator,
350
+ ListAutoMLJobsPaginator,
351
+ ListCandidatesForAutoMLJobPaginator,
352
+ ListClusterEventsPaginator,
353
+ ListClusterNodesPaginator,
354
+ ListClusterSchedulerConfigsPaginator,
355
+ ListClustersPaginator,
356
+ ListCodeRepositoriesPaginator,
357
+ ListCompilationJobsPaginator,
358
+ ListComputeQuotasPaginator,
359
+ ListContextsPaginator,
360
+ ListDataQualityJobDefinitionsPaginator,
361
+ ListDeviceFleetsPaginator,
362
+ ListDevicesPaginator,
363
+ ListDomainsPaginator,
364
+ ListEdgeDeploymentPlansPaginator,
365
+ ListEdgePackagingJobsPaginator,
366
+ ListEndpointConfigsPaginator,
367
+ ListEndpointsPaginator,
368
+ ListExperimentsPaginator,
369
+ ListFeatureGroupsPaginator,
370
+ ListFlowDefinitionsPaginator,
371
+ ListHumanTaskUisPaginator,
372
+ ListHyperParameterTuningJobsPaginator,
373
+ ListImageVersionsPaginator,
374
+ ListImagesPaginator,
375
+ ListInferenceComponentsPaginator,
376
+ ListInferenceExperimentsPaginator,
377
+ ListInferenceRecommendationsJobStepsPaginator,
378
+ ListInferenceRecommendationsJobsPaginator,
379
+ ListLabelingJobsForWorkteamPaginator,
380
+ ListLabelingJobsPaginator,
381
+ ListLineageGroupsPaginator,
382
+ ListMlflowTrackingServersPaginator,
383
+ ListModelBiasJobDefinitionsPaginator,
384
+ ListModelCardExportJobsPaginator,
385
+ ListModelCardVersionsPaginator,
386
+ ListModelCardsPaginator,
387
+ ListModelExplainabilityJobDefinitionsPaginator,
388
+ ListModelMetadataPaginator,
389
+ ListModelPackageGroupsPaginator,
390
+ ListModelPackagesPaginator,
391
+ ListModelQualityJobDefinitionsPaginator,
392
+ ListModelsPaginator,
393
+ ListMonitoringAlertHistoryPaginator,
394
+ ListMonitoringAlertsPaginator,
395
+ ListMonitoringExecutionsPaginator,
396
+ ListMonitoringSchedulesPaginator,
397
+ ListNotebookInstanceLifecycleConfigsPaginator,
398
+ ListNotebookInstancesPaginator,
399
+ ListOptimizationJobsPaginator,
400
+ ListPartnerAppsPaginator,
401
+ ListPipelineExecutionStepsPaginator,
402
+ ListPipelineExecutionsPaginator,
403
+ ListPipelineParametersForExecutionPaginator,
404
+ ListPipelineVersionsPaginator,
405
+ ListPipelinesPaginator,
406
+ ListProcessingJobsPaginator,
407
+ ListResourceCatalogsPaginator,
408
+ ListSpacesPaginator,
409
+ ListStageDevicesPaginator,
410
+ ListStudioLifecycleConfigsPaginator,
411
+ ListSubscribedWorkteamsPaginator,
412
+ ListTagsPaginator,
413
+ ListTrainingJobsForHyperParameterTuningJobPaginator,
414
+ ListTrainingJobsPaginator,
415
+ ListTrainingPlansPaginator,
416
+ ListTransformJobsPaginator,
417
+ ListTrialComponentsPaginator,
418
+ ListTrialsPaginator,
419
+ ListUltraServersByReservedCapacityPaginator,
420
+ ListUserProfilesPaginator,
421
+ ListWorkforcesPaginator,
422
+ ListWorkteamsPaginator,
423
+ SearchPaginator,
424
+ )
425
+
426
+ client: SageMakerClient = Session().client("sagemaker")
427
+
428
+ # Explicit type annotations are optional here
429
+ # Types should be correctly discovered by mypy and IDEs
430
+ create_hub_content_presigned_urls_paginator: CreateHubContentPresignedUrlsPaginator = (
431
+ client.get_paginator("create_hub_content_presigned_urls")
432
+ )
433
+ list_actions_paginator: ListActionsPaginator = client.get_paginator("list_actions")
434
+ list_algorithms_paginator: ListAlgorithmsPaginator = client.get_paginator("list_algorithms")
435
+ list_aliases_paginator: ListAliasesPaginator = client.get_paginator("list_aliases")
436
+ list_app_image_configs_paginator: ListAppImageConfigsPaginator = client.get_paginator(
437
+ "list_app_image_configs"
438
+ )
439
+ list_apps_paginator: ListAppsPaginator = client.get_paginator("list_apps")
440
+ list_artifacts_paginator: ListArtifactsPaginator = client.get_paginator("list_artifacts")
441
+ list_associations_paginator: ListAssociationsPaginator = client.get_paginator("list_associations")
442
+ list_auto_ml_jobs_paginator: ListAutoMLJobsPaginator = client.get_paginator("list_auto_ml_jobs")
443
+ list_candidates_for_auto_ml_job_paginator: ListCandidatesForAutoMLJobPaginator = (
444
+ client.get_paginator("list_candidates_for_auto_ml_job")
445
+ )
446
+ list_cluster_events_paginator: ListClusterEventsPaginator = client.get_paginator(
447
+ "list_cluster_events"
448
+ )
449
+ list_cluster_nodes_paginator: ListClusterNodesPaginator = client.get_paginator("list_cluster_nodes")
450
+ list_cluster_scheduler_configs_paginator: ListClusterSchedulerConfigsPaginator = (
451
+ client.get_paginator("list_cluster_scheduler_configs")
452
+ )
453
+ list_clusters_paginator: ListClustersPaginator = client.get_paginator("list_clusters")
454
+ list_code_repositories_paginator: ListCodeRepositoriesPaginator = client.get_paginator(
455
+ "list_code_repositories"
456
+ )
457
+ list_compilation_jobs_paginator: ListCompilationJobsPaginator = client.get_paginator(
458
+ "list_compilation_jobs"
459
+ )
460
+ list_compute_quotas_paginator: ListComputeQuotasPaginator = client.get_paginator(
461
+ "list_compute_quotas"
462
+ )
463
+ list_contexts_paginator: ListContextsPaginator = client.get_paginator("list_contexts")
464
+ list_data_quality_job_definitions_paginator: ListDataQualityJobDefinitionsPaginator = (
465
+ client.get_paginator("list_data_quality_job_definitions")
466
+ )
467
+ list_device_fleets_paginator: ListDeviceFleetsPaginator = client.get_paginator("list_device_fleets")
468
+ list_devices_paginator: ListDevicesPaginator = client.get_paginator("list_devices")
469
+ list_domains_paginator: ListDomainsPaginator = client.get_paginator("list_domains")
470
+ list_edge_deployment_plans_paginator: ListEdgeDeploymentPlansPaginator = client.get_paginator(
471
+ "list_edge_deployment_plans"
472
+ )
473
+ list_edge_packaging_jobs_paginator: ListEdgePackagingJobsPaginator = client.get_paginator(
474
+ "list_edge_packaging_jobs"
475
+ )
476
+ list_endpoint_configs_paginator: ListEndpointConfigsPaginator = client.get_paginator(
477
+ "list_endpoint_configs"
478
+ )
479
+ list_endpoints_paginator: ListEndpointsPaginator = client.get_paginator("list_endpoints")
480
+ list_experiments_paginator: ListExperimentsPaginator = client.get_paginator("list_experiments")
481
+ list_feature_groups_paginator: ListFeatureGroupsPaginator = client.get_paginator(
482
+ "list_feature_groups"
483
+ )
484
+ list_flow_definitions_paginator: ListFlowDefinitionsPaginator = client.get_paginator(
485
+ "list_flow_definitions"
486
+ )
487
+ list_human_task_uis_paginator: ListHumanTaskUisPaginator = client.get_paginator(
488
+ "list_human_task_uis"
489
+ )
490
+ list_hyper_parameter_tuning_jobs_paginator: ListHyperParameterTuningJobsPaginator = (
491
+ client.get_paginator("list_hyper_parameter_tuning_jobs")
492
+ )
493
+ list_image_versions_paginator: ListImageVersionsPaginator = client.get_paginator(
494
+ "list_image_versions"
495
+ )
496
+ list_images_paginator: ListImagesPaginator = client.get_paginator("list_images")
497
+ list_inference_components_paginator: ListInferenceComponentsPaginator = client.get_paginator(
498
+ "list_inference_components"
499
+ )
500
+ list_inference_experiments_paginator: ListInferenceExperimentsPaginator = client.get_paginator(
501
+ "list_inference_experiments"
502
+ )
503
+ list_inference_recommendations_job_steps_paginator: ListInferenceRecommendationsJobStepsPaginator = client.get_paginator(
504
+ "list_inference_recommendations_job_steps"
505
+ )
506
+ list_inference_recommendations_jobs_paginator: ListInferenceRecommendationsJobsPaginator = (
507
+ client.get_paginator("list_inference_recommendations_jobs")
508
+ )
509
+ list_labeling_jobs_for_workteam_paginator: ListLabelingJobsForWorkteamPaginator = (
510
+ client.get_paginator("list_labeling_jobs_for_workteam")
511
+ )
512
+ list_labeling_jobs_paginator: ListLabelingJobsPaginator = client.get_paginator("list_labeling_jobs")
513
+ list_lineage_groups_paginator: ListLineageGroupsPaginator = client.get_paginator(
514
+ "list_lineage_groups"
515
+ )
516
+ list_mlflow_tracking_servers_paginator: ListMlflowTrackingServersPaginator = client.get_paginator(
517
+ "list_mlflow_tracking_servers"
518
+ )
519
+ list_model_bias_job_definitions_paginator: ListModelBiasJobDefinitionsPaginator = (
520
+ client.get_paginator("list_model_bias_job_definitions")
521
+ )
522
+ list_model_card_export_jobs_paginator: ListModelCardExportJobsPaginator = client.get_paginator(
523
+ "list_model_card_export_jobs"
524
+ )
525
+ list_model_card_versions_paginator: ListModelCardVersionsPaginator = client.get_paginator(
526
+ "list_model_card_versions"
527
+ )
528
+ list_model_cards_paginator: ListModelCardsPaginator = client.get_paginator("list_model_cards")
529
+ list_model_explainability_job_definitions_paginator: ListModelExplainabilityJobDefinitionsPaginator = client.get_paginator(
530
+ "list_model_explainability_job_definitions"
531
+ )
532
+ list_model_metadata_paginator: ListModelMetadataPaginator = client.get_paginator(
533
+ "list_model_metadata"
534
+ )
535
+ list_model_package_groups_paginator: ListModelPackageGroupsPaginator = client.get_paginator(
536
+ "list_model_package_groups"
537
+ )
538
+ list_model_packages_paginator: ListModelPackagesPaginator = client.get_paginator(
539
+ "list_model_packages"
540
+ )
541
+ list_model_quality_job_definitions_paginator: ListModelQualityJobDefinitionsPaginator = (
542
+ client.get_paginator("list_model_quality_job_definitions")
543
+ )
544
+ list_models_paginator: ListModelsPaginator = client.get_paginator("list_models")
545
+ list_monitoring_alert_history_paginator: ListMonitoringAlertHistoryPaginator = client.get_paginator(
546
+ "list_monitoring_alert_history"
547
+ )
548
+ list_monitoring_alerts_paginator: ListMonitoringAlertsPaginator = client.get_paginator(
549
+ "list_monitoring_alerts"
550
+ )
551
+ list_monitoring_executions_paginator: ListMonitoringExecutionsPaginator = client.get_paginator(
552
+ "list_monitoring_executions"
553
+ )
554
+ list_monitoring_schedules_paginator: ListMonitoringSchedulesPaginator = client.get_paginator(
555
+ "list_monitoring_schedules"
556
+ )
557
+ list_notebook_instance_lifecycle_configs_paginator: ListNotebookInstanceLifecycleConfigsPaginator = client.get_paginator(
558
+ "list_notebook_instance_lifecycle_configs"
559
+ )
560
+ list_notebook_instances_paginator: ListNotebookInstancesPaginator = client.get_paginator(
561
+ "list_notebook_instances"
562
+ )
563
+ list_optimization_jobs_paginator: ListOptimizationJobsPaginator = client.get_paginator(
564
+ "list_optimization_jobs"
565
+ )
566
+ list_partner_apps_paginator: ListPartnerAppsPaginator = client.get_paginator("list_partner_apps")
567
+ list_pipeline_execution_steps_paginator: ListPipelineExecutionStepsPaginator = client.get_paginator(
568
+ "list_pipeline_execution_steps"
569
+ )
570
+ list_pipeline_executions_paginator: ListPipelineExecutionsPaginator = client.get_paginator(
571
+ "list_pipeline_executions"
572
+ )
573
+ list_pipeline_parameters_for_execution_paginator: ListPipelineParametersForExecutionPaginator = (
574
+ client.get_paginator("list_pipeline_parameters_for_execution")
575
+ )
576
+ list_pipeline_versions_paginator: ListPipelineVersionsPaginator = client.get_paginator(
577
+ "list_pipeline_versions"
578
+ )
579
+ list_pipelines_paginator: ListPipelinesPaginator = client.get_paginator("list_pipelines")
580
+ list_processing_jobs_paginator: ListProcessingJobsPaginator = client.get_paginator(
581
+ "list_processing_jobs"
582
+ )
583
+ list_resource_catalogs_paginator: ListResourceCatalogsPaginator = client.get_paginator(
584
+ "list_resource_catalogs"
585
+ )
586
+ list_spaces_paginator: ListSpacesPaginator = client.get_paginator("list_spaces")
587
+ list_stage_devices_paginator: ListStageDevicesPaginator = client.get_paginator("list_stage_devices")
588
+ list_studio_lifecycle_configs_paginator: ListStudioLifecycleConfigsPaginator = client.get_paginator(
589
+ "list_studio_lifecycle_configs"
590
+ )
591
+ list_subscribed_workteams_paginator: ListSubscribedWorkteamsPaginator = client.get_paginator(
592
+ "list_subscribed_workteams"
593
+ )
594
+ list_tags_paginator: ListTagsPaginator = client.get_paginator("list_tags")
595
+ list_training_jobs_for_hyper_parameter_tuning_job_paginator: ListTrainingJobsForHyperParameterTuningJobPaginator = client.get_paginator(
596
+ "list_training_jobs_for_hyper_parameter_tuning_job"
597
+ )
598
+ list_training_jobs_paginator: ListTrainingJobsPaginator = client.get_paginator("list_training_jobs")
599
+ list_training_plans_paginator: ListTrainingPlansPaginator = client.get_paginator(
600
+ "list_training_plans"
601
+ )
602
+ list_transform_jobs_paginator: ListTransformJobsPaginator = client.get_paginator(
603
+ "list_transform_jobs"
604
+ )
605
+ list_trial_components_paginator: ListTrialComponentsPaginator = client.get_paginator(
606
+ "list_trial_components"
607
+ )
608
+ list_trials_paginator: ListTrialsPaginator = client.get_paginator("list_trials")
609
+ list_ultra_servers_by_reserved_capacity_paginator: ListUltraServersByReservedCapacityPaginator = (
610
+ client.get_paginator("list_ultra_servers_by_reserved_capacity")
611
+ )
612
+ list_user_profiles_paginator: ListUserProfilesPaginator = client.get_paginator("list_user_profiles")
613
+ list_workforces_paginator: ListWorkforcesPaginator = client.get_paginator("list_workforces")
614
+ list_workteams_paginator: ListWorkteamsPaginator = client.get_paginator("list_workteams")
615
+ search_paginator: SearchPaginator = client.get_paginator("search")
616
+ ```
617
+
618
+ <a id="waiters-annotations"></a>
619
+
620
+ ### Waiters annotations
621
+
622
+ `mypy_boto3_sagemaker.waiter` module contains type annotations for all waiters.
623
+
624
+ ```python
625
+ from boto3.session import Session
626
+
627
+ from mypy_boto3_sagemaker import SageMakerClient
628
+ from mypy_boto3_sagemaker.waiter import (
629
+ EndpointDeletedWaiter,
630
+ EndpointInServiceWaiter,
631
+ ImageCreatedWaiter,
632
+ ImageDeletedWaiter,
633
+ ImageUpdatedWaiter,
634
+ ImageVersionCreatedWaiter,
635
+ ImageVersionDeletedWaiter,
636
+ NotebookInstanceDeletedWaiter,
637
+ NotebookInstanceInServiceWaiter,
638
+ NotebookInstanceStoppedWaiter,
639
+ ProcessingJobCompletedOrStoppedWaiter,
640
+ TrainingJobCompletedOrStoppedWaiter,
641
+ TransformJobCompletedOrStoppedWaiter,
642
+ )
643
+
644
+ client: SageMakerClient = Session().client("sagemaker")
645
+
646
+ # Explicit type annotations are optional here
647
+ # Types should be correctly discovered by mypy and IDEs
648
+ endpoint_deleted_waiter: EndpointDeletedWaiter = client.get_waiter("endpoint_deleted")
649
+ endpoint_in_service_waiter: EndpointInServiceWaiter = client.get_waiter("endpoint_in_service")
650
+ image_created_waiter: ImageCreatedWaiter = client.get_waiter("image_created")
651
+ image_deleted_waiter: ImageDeletedWaiter = client.get_waiter("image_deleted")
652
+ image_updated_waiter: ImageUpdatedWaiter = client.get_waiter("image_updated")
653
+ image_version_created_waiter: ImageVersionCreatedWaiter = client.get_waiter("image_version_created")
654
+ image_version_deleted_waiter: ImageVersionDeletedWaiter = client.get_waiter("image_version_deleted")
655
+ notebook_instance_deleted_waiter: NotebookInstanceDeletedWaiter = client.get_waiter(
656
+ "notebook_instance_deleted"
657
+ )
658
+ notebook_instance_in_service_waiter: NotebookInstanceInServiceWaiter = client.get_waiter(
659
+ "notebook_instance_in_service"
660
+ )
661
+ notebook_instance_stopped_waiter: NotebookInstanceStoppedWaiter = client.get_waiter(
662
+ "notebook_instance_stopped"
663
+ )
664
+ processing_job_completed_or_stopped_waiter: ProcessingJobCompletedOrStoppedWaiter = (
665
+ client.get_waiter("processing_job_completed_or_stopped")
666
+ )
667
+ training_job_completed_or_stopped_waiter: TrainingJobCompletedOrStoppedWaiter = client.get_waiter(
668
+ "training_job_completed_or_stopped"
669
+ )
670
+ transform_job_completed_or_stopped_waiter: TransformJobCompletedOrStoppedWaiter = client.get_waiter(
671
+ "transform_job_completed_or_stopped"
672
+ )
673
+ ```
674
+
675
+ <a id="literals"></a>
676
+
677
+ ### Literals
678
+
679
+ `mypy_boto3_sagemaker.literals` module contains literals extracted from shapes
680
+ that can be used in user code for type checking.
681
+
682
+ Full list of `SageMaker` Literals can be found in
683
+ [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_sagemaker/literals/).
684
+
685
+ ```python
686
+ from mypy_boto3_sagemaker.literals import ActionStatusType
687
+
688
+
689
+ def check_value(value: ActionStatusType) -> bool: ...
690
+ ```
691
+
692
+ <a id="type-definitions"></a>
693
+
694
+ ### Type definitions
695
+
696
+ `mypy_boto3_sagemaker.type_defs` module contains structures and shapes
697
+ assembled to typed dictionaries and unions for additional type checking.
698
+
699
+ Full list of `SageMaker` TypeDefs can be found in
700
+ [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_sagemaker/type_defs/).
701
+
702
+ ```python
703
+ # TypedDict usage example
704
+ from mypy_boto3_sagemaker.type_defs import AcceleratorPartitionConfigTypeDef
705
+
706
+
707
+ def get_value() -> AcceleratorPartitionConfigTypeDef:
708
+ return {
709
+ "Type": ...,
710
+ }
711
+ ```
712
+
713
+ <a id="how-it-works"></a>
714
+
715
+ ## How it works
716
+
717
+ Fully automated
718
+ [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully
719
+ generates type annotations for each service, patiently waiting for `boto3`
720
+ updates. It delivers drop-in type annotations for you and makes sure that:
721
+
722
+ - All available `boto3` services are covered.
723
+ - Each public class and method of every `boto3` service gets valid type
724
+ annotations extracted from `botocore` schemas.
725
+ - Type annotations include up-to-date documentation.
726
+ - Link to documentation is provided for every method.
727
+ - Code is processed by [ruff](https://docs.astral.sh/ruff/) for readability.
728
+
729
+ <a id="what's-new"></a>
730
+
731
+ ## What's new
732
+
733
+ <a id="implemented-features"></a>
734
+
735
+ ### Implemented features
736
+
737
+ - Fully type annotated `boto3`, `botocore`, `aiobotocore` and `aioboto3`
738
+ libraries
739
+ - `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs`
740
+ compatibility
741
+ - `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type
742
+ annotations for each service
743
+ - Generated `TypeDefs` for each service
744
+ - Generated `Literals` for each service
745
+ - Auto discovery of types for `boto3.client` and `boto3.resource` calls
746
+ - Auto discovery of types for `session.client` and `session.resource` calls
747
+ - Auto discovery of types for `client.get_waiter` and `client.get_paginator`
748
+ calls
749
+ - Auto discovery of types for `ServiceResource` and `Resource` collections
750
+ - Auto discovery of types for `aiobotocore.Session.create_client` calls
751
+
752
+ <a id="latest-changes"></a>
753
+
754
+ ### Latest changes
755
+
756
+ Builder changelog can be found in
757
+ [Releases](https://github.com/youtype/mypy_boto3_builder/releases).
758
+
759
+ <a id="versioning"></a>
760
+
761
+ ## Versioning
762
+
763
+ `mypy-boto3-sagemaker` version is the same as related `boto3` version and
764
+ follows
765
+ [Python Packaging version specifiers](https://packaging.python.org/en/latest/specifications/version-specifiers/).
766
+
767
+ <a id="thank-you"></a>
768
+
769
+ ## Thank you
770
+
771
+ - [Allie Fitter](https://github.com/alliefitter) for
772
+ [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),
773
+ this package is based on top of his work
774
+ - [black](https://github.com/psf/black) developers for an awesome formatting
775
+ tool
776
+ - [Timothy Edmund Crosley](https://github.com/timothycrosley) for
777
+ [isort](https://github.com/PyCQA/isort) and how flexible it is
778
+ - [mypy](https://github.com/python/mypy) developers for doing all dirty work
779
+ for us
780
+ - [pyright](https://github.com/microsoft/pyright) team for the new era of typed
781
+ Python
782
+
783
+ <a id="documentation"></a>
784
+
785
+ ## Documentation
786
+
787
+ All services type annotations can be found in
788
+ [boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_sagemaker/)
789
+
790
+ <a id="support-and-contributing"></a>
791
+
792
+ ## Support and contributing
793
+
794
+ This package is auto-generated. Please reports any bugs or request new features
795
+ in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/)
796
+ repository.