SageMaker#
Client#
- class SageMaker.Client#
A low-level client representing Amazon SageMaker Service
Provides APIs for creating and managing SageMaker resources.
Other Resources:
import boto3 client = boto3.client('sagemaker')
These are the available methods:
- add_association
- add_tags
- associate_trial_component
- batch_delete_cluster_nodes
- batch_describe_model_package
- can_paginate
- close
- create_action
- create_algorithm
- create_app
- create_app_image_config
- create_artifact
- create_auto_ml_job
- create_auto_ml_job_v2
- create_cluster
- create_code_repository
- create_compilation_job
- create_context
- create_data_quality_job_definition
- create_device_fleet
- create_domain
- create_edge_deployment_plan
- create_edge_deployment_stage
- create_edge_packaging_job
- create_endpoint
- create_endpoint_config
- create_experiment
- create_feature_group
- create_flow_definition
- create_hub
- create_hub_content_reference
- create_human_task_ui
- create_hyper_parameter_tuning_job
- create_image
- create_image_version
- create_inference_component
- create_inference_experiment
- create_inference_recommendations_job
- create_labeling_job
- create_mlflow_tracking_server
- create_model
- create_model_bias_job_definition
- create_model_card
- create_model_card_export_job
- create_model_explainability_job_definition
- create_model_package
- create_model_package_group
- create_model_quality_job_definition
- create_monitoring_schedule
- create_notebook_instance
- create_notebook_instance_lifecycle_config
- create_optimization_job
- create_pipeline
- create_presigned_domain_url
- create_presigned_mlflow_tracking_server_url
- create_presigned_notebook_instance_url
- create_processing_job
- create_project
- create_space
- create_studio_lifecycle_config
- create_training_job
- create_transform_job
- create_trial
- create_trial_component
- create_user_profile
- create_workforce
- create_workteam
- delete_action
- delete_algorithm
- delete_app
- delete_app_image_config
- delete_artifact
- delete_association
- delete_cluster
- delete_code_repository
- delete_compilation_job
- delete_context
- delete_data_quality_job_definition
- delete_device_fleet
- delete_domain
- delete_edge_deployment_plan
- delete_edge_deployment_stage
- delete_endpoint
- delete_endpoint_config
- delete_experiment
- delete_feature_group
- delete_flow_definition
- delete_hub
- delete_hub_content
- delete_hub_content_reference
- delete_human_task_ui
- delete_hyper_parameter_tuning_job
- delete_image
- delete_image_version
- delete_inference_component
- delete_inference_experiment
- delete_mlflow_tracking_server
- delete_model
- delete_model_bias_job_definition
- delete_model_card
- delete_model_explainability_job_definition
- delete_model_package
- delete_model_package_group
- delete_model_package_group_policy
- delete_model_quality_job_definition
- delete_monitoring_schedule
- delete_notebook_instance
- delete_notebook_instance_lifecycle_config
- delete_optimization_job
- delete_pipeline
- delete_project
- delete_space
- delete_studio_lifecycle_config
- delete_tags
- delete_trial
- delete_trial_component
- delete_user_profile
- delete_workforce
- delete_workteam
- deregister_devices
- describe_action
- describe_algorithm
- describe_app
- describe_app_image_config
- describe_artifact
- describe_auto_ml_job
- describe_auto_ml_job_v2
- describe_cluster
- describe_cluster_node
- describe_code_repository
- describe_compilation_job
- describe_context
- describe_data_quality_job_definition
- describe_device
- describe_device_fleet
- describe_domain
- describe_edge_deployment_plan
- describe_edge_packaging_job
- describe_endpoint
- describe_endpoint_config
- describe_experiment
- describe_feature_group
- describe_feature_metadata
- describe_flow_definition
- describe_hub
- describe_hub_content
- describe_human_task_ui
- describe_hyper_parameter_tuning_job
- describe_image
- describe_image_version
- describe_inference_component
- describe_inference_experiment
- describe_inference_recommendations_job
- describe_labeling_job
- describe_lineage_group
- describe_mlflow_tracking_server
- describe_model
- describe_model_bias_job_definition
- describe_model_card
- describe_model_card_export_job
- describe_model_explainability_job_definition
- describe_model_package
- describe_model_package_group
- describe_model_quality_job_definition
- describe_monitoring_schedule
- describe_notebook_instance
- describe_notebook_instance_lifecycle_config
- describe_optimization_job
- describe_pipeline
- describe_pipeline_definition_for_execution
- describe_pipeline_execution
- describe_processing_job
- describe_project
- describe_space
- describe_studio_lifecycle_config
- describe_subscribed_workteam
- describe_training_job
- describe_transform_job
- describe_trial
- describe_trial_component
- describe_user_profile
- describe_workforce
- describe_workteam
- disable_sagemaker_servicecatalog_portfolio
- disassociate_trial_component
- enable_sagemaker_servicecatalog_portfolio
- get_device_fleet_report
- get_lineage_group_policy
- get_model_package_group_policy
- get_paginator
- get_sagemaker_servicecatalog_portfolio_status
- get_scaling_configuration_recommendation
- get_search_suggestions
- get_waiter
- import_hub_content
- list_actions
- list_algorithms
- list_aliases
- list_app_image_configs
- list_apps
- list_artifacts
- list_associations
- list_auto_ml_jobs
- list_candidates_for_auto_ml_job
- list_cluster_nodes
- list_clusters
- list_code_repositories
- list_compilation_jobs
- list_contexts
- list_data_quality_job_definitions
- list_device_fleets
- list_devices
- list_domains
- list_edge_deployment_plans
- list_edge_packaging_jobs
- list_endpoint_configs
- list_endpoints
- list_experiments
- list_feature_groups
- list_flow_definitions
- list_hub_content_versions
- list_hub_contents
- list_hubs
- list_human_task_uis
- list_hyper_parameter_tuning_jobs
- list_image_versions
- list_images
- list_inference_components
- list_inference_experiments
- list_inference_recommendations_job_steps
- list_inference_recommendations_jobs
- list_labeling_jobs
- list_labeling_jobs_for_workteam
- list_lineage_groups
- list_mlflow_tracking_servers
- list_model_bias_job_definitions
- list_model_card_export_jobs
- list_model_card_versions
- list_model_cards
- list_model_explainability_job_definitions
- list_model_metadata
- list_model_package_groups
- list_model_packages
- list_model_quality_job_definitions
- list_models
- list_monitoring_alert_history
- list_monitoring_alerts
- list_monitoring_executions
- list_monitoring_schedules
- list_notebook_instance_lifecycle_configs
- list_notebook_instances
- list_optimization_jobs
- list_pipeline_execution_steps
- list_pipeline_executions
- list_pipeline_parameters_for_execution
- list_pipelines
- list_processing_jobs
- list_projects
- list_resource_catalogs
- list_spaces
- list_stage_devices
- list_studio_lifecycle_configs
- list_subscribed_workteams
- list_tags
- list_training_jobs
- list_training_jobs_for_hyper_parameter_tuning_job
- list_transform_jobs
- list_trial_components
- list_trials
- list_user_profiles
- list_workforces
- list_workteams
- put_model_package_group_policy
- query_lineage
- register_devices
- render_ui_template
- retry_pipeline_execution
- search
- send_pipeline_execution_step_failure
- send_pipeline_execution_step_success
- start_edge_deployment_stage
- start_inference_experiment
- start_mlflow_tracking_server
- start_monitoring_schedule
- start_notebook_instance
- start_pipeline_execution
- stop_auto_ml_job
- stop_compilation_job
- stop_edge_deployment_stage
- stop_edge_packaging_job
- stop_hyper_parameter_tuning_job
- stop_inference_experiment
- stop_inference_recommendations_job
- stop_labeling_job
- stop_mlflow_tracking_server
- stop_monitoring_schedule
- stop_notebook_instance
- stop_optimization_job
- stop_pipeline_execution
- stop_processing_job
- stop_training_job
- stop_transform_job
- update_action
- update_app_image_config
- update_artifact
- update_cluster
- update_cluster_software
- update_code_repository
- update_context
- update_device_fleet
- update_devices
- update_domain
- update_endpoint
- update_endpoint_weights_and_capacities
- update_experiment
- update_feature_group
- update_feature_metadata
- update_hub
- update_image
- update_image_version
- update_inference_component
- update_inference_component_runtime_config
- update_inference_experiment
- update_mlflow_tracking_server
- update_model_card
- update_model_package
- update_monitoring_alert
- update_monitoring_schedule
- update_notebook_instance
- update_notebook_instance_lifecycle_config
- update_pipeline
- update_pipeline_execution
- update_project
- update_space
- update_training_job
- update_trial
- update_trial_component
- update_user_profile
- update_workforce
- update_workteam
Client Exceptions#
Client exceptions are available on a client instance via the exceptions
property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
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.
The available paginators are:
- ListActions
- ListAlgorithms
- ListAliases
- ListAppImageConfigs
- ListApps
- ListArtifacts
- ListAssociations
- ListAutoMLJobs
- ListCandidatesForAutoMLJob
- ListClusterNodes
- ListClusters
- ListCodeRepositories
- ListCompilationJobs
- ListContexts
- ListDataQualityJobDefinitions
- ListDeviceFleets
- ListDevices
- ListDomains
- ListEdgeDeploymentPlans
- ListEdgePackagingJobs
- ListEndpointConfigs
- ListEndpoints
- ListExperiments
- ListFeatureGroups
- ListFlowDefinitions
- ListHumanTaskUis
- ListHyperParameterTuningJobs
- ListImageVersions
- ListImages
- ListInferenceComponents
- ListInferenceExperiments
- ListInferenceRecommendationsJobSteps
- ListInferenceRecommendationsJobs
- ListLabelingJobs
- ListLabelingJobsForWorkteam
- ListLineageGroups
- ListMlflowTrackingServers
- ListModelBiasJobDefinitions
- ListModelCardExportJobs
- ListModelCardVersions
- ListModelCards
- ListModelExplainabilityJobDefinitions
- ListModelMetadata
- ListModelPackageGroups
- ListModelPackages
- ListModelQualityJobDefinitions
- ListModels
- ListMonitoringAlertHistory
- ListMonitoringAlerts
- ListMonitoringExecutions
- ListMonitoringSchedules
- ListNotebookInstanceLifecycleConfigs
- ListNotebookInstances
- ListOptimizationJobs
- ListPipelineExecutionSteps
- ListPipelineExecutions
- ListPipelineParametersForExecution
- ListPipelines
- ListProcessingJobs
- ListResourceCatalogs
- ListSpaces
- ListStageDevices
- ListStudioLifecycleConfigs
- ListSubscribedWorkteams
- ListTags
- ListTrainingJobs
- ListTrainingJobsForHyperParameterTuningJob
- ListTransformJobs
- ListTrialComponents
- ListTrials
- ListUserProfiles
- ListWorkforces
- ListWorkteams
- 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.
The available waiters are: