

*********
SageMaker
*********



======
Client
======



.. py:class:: SageMaker.Client

  A low-level client representing Amazon SageMaker Service
  

  Provides APIs for creating and managing SageMaker resources.

   

  Other Resources:

   

  
  * `SageMaker Developer Guide <https://docs.aws.amazon.com/sagemaker/latest/dg/whatis.html#first-time-user>`__
   
  * `Amazon Augmented AI Runtime API Reference <https://docs.aws.amazon.com/augmented-ai/2019-11-07/APIReference/Welcome.html>`__
  

  ::

    
    import boto3
    
    client = boto3.client('sagemaker')

  

These are the available methods:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  sagemaker/client/add_association
  sagemaker/client/add_tags
  sagemaker/client/associate_trial_component
  sagemaker/client/attach_cluster_node_volume
  sagemaker/client/batch_add_cluster_nodes
  sagemaker/client/batch_delete_cluster_nodes
  sagemaker/client/batch_describe_model_package
  sagemaker/client/batch_reboot_cluster_nodes
  sagemaker/client/batch_replace_cluster_nodes
  sagemaker/client/can_paginate
  sagemaker/client/close
  sagemaker/client/create_action
  sagemaker/client/create_algorithm
  sagemaker/client/create_app
  sagemaker/client/create_app_image_config
  sagemaker/client/create_artifact
  sagemaker/client/create_auto_ml_job
  sagemaker/client/create_auto_ml_job_v2
  sagemaker/client/create_cluster
  sagemaker/client/create_cluster_scheduler_config
  sagemaker/client/create_code_repository
  sagemaker/client/create_compilation_job
  sagemaker/client/create_compute_quota
  sagemaker/client/create_context
  sagemaker/client/create_data_quality_job_definition
  sagemaker/client/create_device_fleet
  sagemaker/client/create_domain
  sagemaker/client/create_edge_deployment_plan
  sagemaker/client/create_edge_deployment_stage
  sagemaker/client/create_edge_packaging_job
  sagemaker/client/create_endpoint
  sagemaker/client/create_endpoint_config
  sagemaker/client/create_experiment
  sagemaker/client/create_feature_group
  sagemaker/client/create_flow_definition
  sagemaker/client/create_hub
  sagemaker/client/create_hub_content_presigned_urls
  sagemaker/client/create_hub_content_reference
  sagemaker/client/create_human_task_ui
  sagemaker/client/create_hyper_parameter_tuning_job
  sagemaker/client/create_image
  sagemaker/client/create_image_version
  sagemaker/client/create_inference_component
  sagemaker/client/create_inference_experiment
  sagemaker/client/create_inference_recommendations_job
  sagemaker/client/create_labeling_job
  sagemaker/client/create_mlflow_app
  sagemaker/client/create_mlflow_tracking_server
  sagemaker/client/create_model
  sagemaker/client/create_model_bias_job_definition
  sagemaker/client/create_model_card
  sagemaker/client/create_model_card_export_job
  sagemaker/client/create_model_explainability_job_definition
  sagemaker/client/create_model_package
  sagemaker/client/create_model_package_group
  sagemaker/client/create_model_quality_job_definition
  sagemaker/client/create_monitoring_schedule
  sagemaker/client/create_notebook_instance
  sagemaker/client/create_notebook_instance_lifecycle_config
  sagemaker/client/create_optimization_job
  sagemaker/client/create_partner_app
  sagemaker/client/create_partner_app_presigned_url
  sagemaker/client/create_pipeline
  sagemaker/client/create_presigned_domain_url
  sagemaker/client/create_presigned_mlflow_app_url
  sagemaker/client/create_presigned_mlflow_tracking_server_url
  sagemaker/client/create_presigned_notebook_instance_url
  sagemaker/client/create_processing_job
  sagemaker/client/create_project
  sagemaker/client/create_space
  sagemaker/client/create_studio_lifecycle_config
  sagemaker/client/create_training_job
  sagemaker/client/create_training_plan
  sagemaker/client/create_transform_job
  sagemaker/client/create_trial
  sagemaker/client/create_trial_component
  sagemaker/client/create_user_profile
  sagemaker/client/create_workforce
  sagemaker/client/create_workteam
  sagemaker/client/delete_action
  sagemaker/client/delete_algorithm
  sagemaker/client/delete_app
  sagemaker/client/delete_app_image_config
  sagemaker/client/delete_artifact
  sagemaker/client/delete_association
  sagemaker/client/delete_cluster
  sagemaker/client/delete_cluster_scheduler_config
  sagemaker/client/delete_code_repository
  sagemaker/client/delete_compilation_job
  sagemaker/client/delete_compute_quota
  sagemaker/client/delete_context
  sagemaker/client/delete_data_quality_job_definition
  sagemaker/client/delete_device_fleet
  sagemaker/client/delete_domain
  sagemaker/client/delete_edge_deployment_plan
  sagemaker/client/delete_edge_deployment_stage
  sagemaker/client/delete_endpoint
  sagemaker/client/delete_endpoint_config
  sagemaker/client/delete_experiment
  sagemaker/client/delete_feature_group
  sagemaker/client/delete_flow_definition
  sagemaker/client/delete_hub
  sagemaker/client/delete_hub_content
  sagemaker/client/delete_hub_content_reference
  sagemaker/client/delete_human_task_ui
  sagemaker/client/delete_hyper_parameter_tuning_job
  sagemaker/client/delete_image
  sagemaker/client/delete_image_version
  sagemaker/client/delete_inference_component
  sagemaker/client/delete_inference_experiment
  sagemaker/client/delete_mlflow_app
  sagemaker/client/delete_mlflow_tracking_server
  sagemaker/client/delete_model
  sagemaker/client/delete_model_bias_job_definition
  sagemaker/client/delete_model_card
  sagemaker/client/delete_model_explainability_job_definition
  sagemaker/client/delete_model_package
  sagemaker/client/delete_model_package_group
  sagemaker/client/delete_model_package_group_policy
  sagemaker/client/delete_model_quality_job_definition
  sagemaker/client/delete_monitoring_schedule
  sagemaker/client/delete_notebook_instance
  sagemaker/client/delete_notebook_instance_lifecycle_config
  sagemaker/client/delete_optimization_job
  sagemaker/client/delete_partner_app
  sagemaker/client/delete_pipeline
  sagemaker/client/delete_processing_job
  sagemaker/client/delete_project
  sagemaker/client/delete_space
  sagemaker/client/delete_studio_lifecycle_config
  sagemaker/client/delete_tags
  sagemaker/client/delete_training_job
  sagemaker/client/delete_trial
  sagemaker/client/delete_trial_component
  sagemaker/client/delete_user_profile
  sagemaker/client/delete_workforce
  sagemaker/client/delete_workteam
  sagemaker/client/deregister_devices
  sagemaker/client/describe_action
  sagemaker/client/describe_algorithm
  sagemaker/client/describe_app
  sagemaker/client/describe_app_image_config
  sagemaker/client/describe_artifact
  sagemaker/client/describe_auto_ml_job
  sagemaker/client/describe_auto_ml_job_v2
  sagemaker/client/describe_cluster
  sagemaker/client/describe_cluster_event
  sagemaker/client/describe_cluster_node
  sagemaker/client/describe_cluster_scheduler_config
  sagemaker/client/describe_code_repository
  sagemaker/client/describe_compilation_job
  sagemaker/client/describe_compute_quota
  sagemaker/client/describe_context
  sagemaker/client/describe_data_quality_job_definition
  sagemaker/client/describe_device
  sagemaker/client/describe_device_fleet
  sagemaker/client/describe_domain
  sagemaker/client/describe_edge_deployment_plan
  sagemaker/client/describe_edge_packaging_job
  sagemaker/client/describe_endpoint
  sagemaker/client/describe_endpoint_config
  sagemaker/client/describe_experiment
  sagemaker/client/describe_feature_group
  sagemaker/client/describe_feature_metadata
  sagemaker/client/describe_flow_definition
  sagemaker/client/describe_hub
  sagemaker/client/describe_hub_content
  sagemaker/client/describe_human_task_ui
  sagemaker/client/describe_hyper_parameter_tuning_job
  sagemaker/client/describe_image
  sagemaker/client/describe_image_version
  sagemaker/client/describe_inference_component
  sagemaker/client/describe_inference_experiment
  sagemaker/client/describe_inference_recommendations_job
  sagemaker/client/describe_labeling_job
  sagemaker/client/describe_lineage_group
  sagemaker/client/describe_mlflow_app
  sagemaker/client/describe_mlflow_tracking_server
  sagemaker/client/describe_model
  sagemaker/client/describe_model_bias_job_definition
  sagemaker/client/describe_model_card
  sagemaker/client/describe_model_card_export_job
  sagemaker/client/describe_model_explainability_job_definition
  sagemaker/client/describe_model_package
  sagemaker/client/describe_model_package_group
  sagemaker/client/describe_model_quality_job_definition
  sagemaker/client/describe_monitoring_schedule
  sagemaker/client/describe_notebook_instance
  sagemaker/client/describe_notebook_instance_lifecycle_config
  sagemaker/client/describe_optimization_job
  sagemaker/client/describe_partner_app
  sagemaker/client/describe_pipeline
  sagemaker/client/describe_pipeline_definition_for_execution
  sagemaker/client/describe_pipeline_execution
  sagemaker/client/describe_processing_job
  sagemaker/client/describe_project
  sagemaker/client/describe_reserved_capacity
  sagemaker/client/describe_space
  sagemaker/client/describe_studio_lifecycle_config
  sagemaker/client/describe_subscribed_workteam
  sagemaker/client/describe_training_job
  sagemaker/client/describe_training_plan
  sagemaker/client/describe_transform_job
  sagemaker/client/describe_trial
  sagemaker/client/describe_trial_component
  sagemaker/client/describe_user_profile
  sagemaker/client/describe_workforce
  sagemaker/client/describe_workteam
  sagemaker/client/detach_cluster_node_volume
  sagemaker/client/disable_sagemaker_servicecatalog_portfolio
  sagemaker/client/disassociate_trial_component
  sagemaker/client/enable_sagemaker_servicecatalog_portfolio
  sagemaker/client/get_device_fleet_report
  sagemaker/client/get_lineage_group_policy
  sagemaker/client/get_model_package_group_policy
  sagemaker/client/get_paginator
  sagemaker/client/get_sagemaker_servicecatalog_portfolio_status
  sagemaker/client/get_scaling_configuration_recommendation
  sagemaker/client/get_search_suggestions
  sagemaker/client/get_waiter
  sagemaker/client/import_hub_content
  sagemaker/client/list_actions
  sagemaker/client/list_algorithms
  sagemaker/client/list_aliases
  sagemaker/client/list_app_image_configs
  sagemaker/client/list_apps
  sagemaker/client/list_artifacts
  sagemaker/client/list_associations
  sagemaker/client/list_auto_ml_jobs
  sagemaker/client/list_candidates_for_auto_ml_job
  sagemaker/client/list_cluster_events
  sagemaker/client/list_cluster_nodes
  sagemaker/client/list_cluster_scheduler_configs
  sagemaker/client/list_clusters
  sagemaker/client/list_code_repositories
  sagemaker/client/list_compilation_jobs
  sagemaker/client/list_compute_quotas
  sagemaker/client/list_contexts
  sagemaker/client/list_data_quality_job_definitions
  sagemaker/client/list_device_fleets
  sagemaker/client/list_devices
  sagemaker/client/list_domains
  sagemaker/client/list_edge_deployment_plans
  sagemaker/client/list_edge_packaging_jobs
  sagemaker/client/list_endpoint_configs
  sagemaker/client/list_endpoints
  sagemaker/client/list_experiments
  sagemaker/client/list_feature_groups
  sagemaker/client/list_flow_definitions
  sagemaker/client/list_hub_content_versions
  sagemaker/client/list_hub_contents
  sagemaker/client/list_hubs
  sagemaker/client/list_human_task_uis
  sagemaker/client/list_hyper_parameter_tuning_jobs
  sagemaker/client/list_image_versions
  sagemaker/client/list_images
  sagemaker/client/list_inference_components
  sagemaker/client/list_inference_experiments
  sagemaker/client/list_inference_recommendations_job_steps
  sagemaker/client/list_inference_recommendations_jobs
  sagemaker/client/list_labeling_jobs
  sagemaker/client/list_labeling_jobs_for_workteam
  sagemaker/client/list_lineage_groups
  sagemaker/client/list_mlflow_apps
  sagemaker/client/list_mlflow_tracking_servers
  sagemaker/client/list_model_bias_job_definitions
  sagemaker/client/list_model_card_export_jobs
  sagemaker/client/list_model_card_versions
  sagemaker/client/list_model_cards
  sagemaker/client/list_model_explainability_job_definitions
  sagemaker/client/list_model_metadata
  sagemaker/client/list_model_package_groups
  sagemaker/client/list_model_packages
  sagemaker/client/list_model_quality_job_definitions
  sagemaker/client/list_models
  sagemaker/client/list_monitoring_alert_history
  sagemaker/client/list_monitoring_alerts
  sagemaker/client/list_monitoring_executions
  sagemaker/client/list_monitoring_schedules
  sagemaker/client/list_notebook_instance_lifecycle_configs
  sagemaker/client/list_notebook_instances
  sagemaker/client/list_optimization_jobs
  sagemaker/client/list_partner_apps
  sagemaker/client/list_pipeline_execution_steps
  sagemaker/client/list_pipeline_executions
  sagemaker/client/list_pipeline_parameters_for_execution
  sagemaker/client/list_pipeline_versions
  sagemaker/client/list_pipelines
  sagemaker/client/list_processing_jobs
  sagemaker/client/list_projects
  sagemaker/client/list_resource_catalogs
  sagemaker/client/list_spaces
  sagemaker/client/list_stage_devices
  sagemaker/client/list_studio_lifecycle_configs
  sagemaker/client/list_subscribed_workteams
  sagemaker/client/list_tags
  sagemaker/client/list_training_jobs
  sagemaker/client/list_training_jobs_for_hyper_parameter_tuning_job
  sagemaker/client/list_training_plans
  sagemaker/client/list_transform_jobs
  sagemaker/client/list_trial_components
  sagemaker/client/list_trials
  sagemaker/client/list_ultra_servers_by_reserved_capacity
  sagemaker/client/list_user_profiles
  sagemaker/client/list_workforces
  sagemaker/client/list_workteams
  sagemaker/client/put_model_package_group_policy
  sagemaker/client/query_lineage
  sagemaker/client/register_devices
  sagemaker/client/render_ui_template
  sagemaker/client/retry_pipeline_execution
  sagemaker/client/search
  sagemaker/client/search_training_plan_offerings
  sagemaker/client/send_pipeline_execution_step_failure
  sagemaker/client/send_pipeline_execution_step_success
  sagemaker/client/start_edge_deployment_stage
  sagemaker/client/start_inference_experiment
  sagemaker/client/start_mlflow_tracking_server
  sagemaker/client/start_monitoring_schedule
  sagemaker/client/start_notebook_instance
  sagemaker/client/start_pipeline_execution
  sagemaker/client/start_session
  sagemaker/client/stop_auto_ml_job
  sagemaker/client/stop_compilation_job
  sagemaker/client/stop_edge_deployment_stage
  sagemaker/client/stop_edge_packaging_job
  sagemaker/client/stop_hyper_parameter_tuning_job
  sagemaker/client/stop_inference_experiment
  sagemaker/client/stop_inference_recommendations_job
  sagemaker/client/stop_labeling_job
  sagemaker/client/stop_mlflow_tracking_server
  sagemaker/client/stop_monitoring_schedule
  sagemaker/client/stop_notebook_instance
  sagemaker/client/stop_optimization_job
  sagemaker/client/stop_pipeline_execution
  sagemaker/client/stop_processing_job
  sagemaker/client/stop_training_job
  sagemaker/client/stop_transform_job
  sagemaker/client/update_action
  sagemaker/client/update_app_image_config
  sagemaker/client/update_artifact
  sagemaker/client/update_cluster
  sagemaker/client/update_cluster_scheduler_config
  sagemaker/client/update_cluster_software
  sagemaker/client/update_code_repository
  sagemaker/client/update_compute_quota
  sagemaker/client/update_context
  sagemaker/client/update_device_fleet
  sagemaker/client/update_devices
  sagemaker/client/update_domain
  sagemaker/client/update_endpoint
  sagemaker/client/update_endpoint_weights_and_capacities
  sagemaker/client/update_experiment
  sagemaker/client/update_feature_group
  sagemaker/client/update_feature_metadata
  sagemaker/client/update_hub
  sagemaker/client/update_hub_content
  sagemaker/client/update_hub_content_reference
  sagemaker/client/update_image
  sagemaker/client/update_image_version
  sagemaker/client/update_inference_component
  sagemaker/client/update_inference_component_runtime_config
  sagemaker/client/update_inference_experiment
  sagemaker/client/update_mlflow_app
  sagemaker/client/update_mlflow_tracking_server
  sagemaker/client/update_model_card
  sagemaker/client/update_model_package
  sagemaker/client/update_monitoring_alert
  sagemaker/client/update_monitoring_schedule
  sagemaker/client/update_notebook_instance
  sagemaker/client/update_notebook_instance_lifecycle_config
  sagemaker/client/update_partner_app
  sagemaker/client/update_pipeline
  sagemaker/client/update_pipeline_execution
  sagemaker/client/update_pipeline_version
  sagemaker/client/update_project
  sagemaker/client/update_space
  sagemaker/client/update_training_job
  sagemaker/client/update_trial
  sagemaker/client/update_trial_component
  sagemaker/client/update_user_profile
  sagemaker/client/update_workforce
  sagemaker/client/update_workteam


==========
Paginators
==========


Paginators are available on a client instance via the ``get_paginator`` method. For more detailed instructions and examples on the usage of paginators, see the paginators `user guide <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/paginators.html>`_.

The available paginators are:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  sagemaker/paginator/CreateHubContentPresignedUrls
  sagemaker/paginator/ListActions
  sagemaker/paginator/ListAlgorithms
  sagemaker/paginator/ListAliases
  sagemaker/paginator/ListAppImageConfigs
  sagemaker/paginator/ListApps
  sagemaker/paginator/ListArtifacts
  sagemaker/paginator/ListAssociations
  sagemaker/paginator/ListAutoMLJobs
  sagemaker/paginator/ListCandidatesForAutoMLJob
  sagemaker/paginator/ListClusterEvents
  sagemaker/paginator/ListClusterNodes
  sagemaker/paginator/ListClusterSchedulerConfigs
  sagemaker/paginator/ListClusters
  sagemaker/paginator/ListCodeRepositories
  sagemaker/paginator/ListCompilationJobs
  sagemaker/paginator/ListComputeQuotas
  sagemaker/paginator/ListContexts
  sagemaker/paginator/ListDataQualityJobDefinitions
  sagemaker/paginator/ListDeviceFleets
  sagemaker/paginator/ListDevices
  sagemaker/paginator/ListDomains
  sagemaker/paginator/ListEdgeDeploymentPlans
  sagemaker/paginator/ListEdgePackagingJobs
  sagemaker/paginator/ListEndpointConfigs
  sagemaker/paginator/ListEndpoints
  sagemaker/paginator/ListExperiments
  sagemaker/paginator/ListFeatureGroups
  sagemaker/paginator/ListFlowDefinitions
  sagemaker/paginator/ListHumanTaskUis
  sagemaker/paginator/ListHyperParameterTuningJobs
  sagemaker/paginator/ListImageVersions
  sagemaker/paginator/ListImages
  sagemaker/paginator/ListInferenceComponents
  sagemaker/paginator/ListInferenceExperiments
  sagemaker/paginator/ListInferenceRecommendationsJobSteps
  sagemaker/paginator/ListInferenceRecommendationsJobs
  sagemaker/paginator/ListLabelingJobs
  sagemaker/paginator/ListLabelingJobsForWorkteam
  sagemaker/paginator/ListLineageGroups
  sagemaker/paginator/ListMlflowApps
  sagemaker/paginator/ListMlflowTrackingServers
  sagemaker/paginator/ListModelBiasJobDefinitions
  sagemaker/paginator/ListModelCardExportJobs
  sagemaker/paginator/ListModelCardVersions
  sagemaker/paginator/ListModelCards
  sagemaker/paginator/ListModelExplainabilityJobDefinitions
  sagemaker/paginator/ListModelMetadata
  sagemaker/paginator/ListModelPackageGroups
  sagemaker/paginator/ListModelPackages
  sagemaker/paginator/ListModelQualityJobDefinitions
  sagemaker/paginator/ListModels
  sagemaker/paginator/ListMonitoringAlertHistory
  sagemaker/paginator/ListMonitoringAlerts
  sagemaker/paginator/ListMonitoringExecutions
  sagemaker/paginator/ListMonitoringSchedules
  sagemaker/paginator/ListNotebookInstanceLifecycleConfigs
  sagemaker/paginator/ListNotebookInstances
  sagemaker/paginator/ListOptimizationJobs
  sagemaker/paginator/ListPartnerApps
  sagemaker/paginator/ListPipelineExecutionSteps
  sagemaker/paginator/ListPipelineExecutions
  sagemaker/paginator/ListPipelineParametersForExecution
  sagemaker/paginator/ListPipelineVersions
  sagemaker/paginator/ListPipelines
  sagemaker/paginator/ListProcessingJobs
  sagemaker/paginator/ListResourceCatalogs
  sagemaker/paginator/ListSpaces
  sagemaker/paginator/ListStageDevices
  sagemaker/paginator/ListStudioLifecycleConfigs
  sagemaker/paginator/ListSubscribedWorkteams
  sagemaker/paginator/ListTags
  sagemaker/paginator/ListTrainingJobs
  sagemaker/paginator/ListTrainingJobsForHyperParameterTuningJob
  sagemaker/paginator/ListTrainingPlans
  sagemaker/paginator/ListTransformJobs
  sagemaker/paginator/ListTrialComponents
  sagemaker/paginator/ListTrials
  sagemaker/paginator/ListUltraServersByReservedCapacity
  sagemaker/paginator/ListUserProfiles
  sagemaker/paginator/ListWorkforces
  sagemaker/paginator/ListWorkteams
  sagemaker/paginator/Search


=======
Waiters
=======


Waiters are available on a client instance via the ``get_waiter`` method. For more detailed instructions and examples on the usage or waiters, see the waiters `user guide <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/clients.html#waiters>`_.

The available waiters are:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  sagemaker/waiter/EndpointDeleted
  sagemaker/waiter/EndpointInService
  sagemaker/waiter/ImageCreated
  sagemaker/waiter/ImageDeleted
  sagemaker/waiter/ImageUpdated
  sagemaker/waiter/ImageVersionCreated
  sagemaker/waiter/ImageVersionDeleted
  sagemaker/waiter/NotebookInstanceDeleted
  sagemaker/waiter/NotebookInstanceInService
  sagemaker/waiter/NotebookInstanceStopped
  sagemaker/waiter/ProcessingJobCompletedOrStopped
  sagemaker/waiter/TrainingJobCompletedOrStopped
  sagemaker/waiter/TransformJobCompletedOrStopped
