Class: Aws::SageMaker::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::SageMaker::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb
Overview
An API client for SageMaker. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::SageMaker::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#add_association(params = {}) ⇒ Types::AddAssociationResponse
Creates an association between the source and the destination.
-
#add_tags(params = {}) ⇒ Types::AddTagsOutput
Adds or overwrites one or more tags for the specified SageMaker resource.
-
#associate_trial_component(params = {}) ⇒ Types::AssociateTrialComponentResponse
Associates a trial component with a trial.
-
#batch_describe_model_package(params = {}) ⇒ Types::BatchDescribeModelPackageOutput
This action batch describes a list of versioned model packages.
-
#create_action(params = {}) ⇒ Types::CreateActionResponse
Creates an action.
-
#create_algorithm(params = {}) ⇒ Types::CreateAlgorithmOutput
Create a machine learning algorithm that you can use in SageMaker and list in the Amazon Web Services Marketplace.
-
#create_app(params = {}) ⇒ Types::CreateAppResponse
Creates a running app for the specified UserProfile.
-
#create_app_image_config(params = {}) ⇒ Types::CreateAppImageConfigResponse
Creates a configuration for running a SageMaker image as a KernelGateway app.
-
#create_artifact(params = {}) ⇒ Types::CreateArtifactResponse
Creates an artifact.
-
#create_auto_ml_job(params = {}) ⇒ Types::CreateAutoMLJobResponse
Creates an Autopilot job also referred to as Autopilot experiment or AutoML job.
-
#create_auto_ml_job_v2(params = {}) ⇒ Types::CreateAutoMLJobV2Response
Creates an Autopilot job also referred to as Autopilot experiment or AutoML job V2.
-
#create_cluster(params = {}) ⇒ Types::CreateClusterResponse
Creates a SageMaker HyperPod cluster.
-
#create_code_repository(params = {}) ⇒ Types::CreateCodeRepositoryOutput
Creates a Git repository as a resource in your SageMaker account.
-
#create_compilation_job(params = {}) ⇒ Types::CreateCompilationJobResponse
Starts a model compilation job.
-
#create_context(params = {}) ⇒ Types::CreateContextResponse
Creates a context.
-
#create_data_quality_job_definition(params = {}) ⇒ Types::CreateDataQualityJobDefinitionResponse
Creates a definition for a job that monitors data quality and drift.
-
#create_device_fleet(params = {}) ⇒ Struct
Creates a device fleet.
-
#create_domain(params = {}) ⇒ Types::CreateDomainResponse
Creates a
Domain
. -
#create_edge_deployment_plan(params = {}) ⇒ Types::CreateEdgeDeploymentPlanResponse
Creates an edge deployment plan, consisting of multiple stages.
-
#create_edge_deployment_stage(params = {}) ⇒ Struct
Creates a new stage in an existing edge deployment plan.
-
#create_edge_packaging_job(params = {}) ⇒ Struct
Starts a SageMaker Edge Manager model packaging job.
-
#create_endpoint(params = {}) ⇒ Types::CreateEndpointOutput
Creates an endpoint using the endpoint configuration specified in the request.
-
#create_endpoint_config(params = {}) ⇒ Types::CreateEndpointConfigOutput
Creates an endpoint configuration that SageMaker hosting services uses to deploy models.
-
#create_experiment(params = {}) ⇒ Types::CreateExperimentResponse
Creates a SageMaker experiment.
-
#create_feature_group(params = {}) ⇒ Types::CreateFeatureGroupResponse
Create a new
FeatureGroup
. -
#create_flow_definition(params = {}) ⇒ Types::CreateFlowDefinitionResponse
Creates a flow definition.
-
#create_hub(params = {}) ⇒ Types::CreateHubResponse
Create a hub.
-
#create_human_task_ui(params = {}) ⇒ Types::CreateHumanTaskUiResponse
Defines the settings you will use for the human review workflow user interface.
-
#create_hyper_parameter_tuning_job(params = {}) ⇒ Types::CreateHyperParameterTuningJobResponse
Starts a hyperparameter tuning job.
-
#create_image(params = {}) ⇒ Types::CreateImageResponse
Creates a custom SageMaker image.
-
#create_image_version(params = {}) ⇒ Types::CreateImageVersionResponse
Creates a version of the SageMaker image specified by
ImageName
. -
#create_inference_component(params = {}) ⇒ Types::CreateInferenceComponentOutput
Creates an inference component, which is a SageMaker hosting object that you can use to deploy a model to an endpoint.
-
#create_inference_experiment(params = {}) ⇒ Types::CreateInferenceExperimentResponse
Creates an inference experiment using the configurations specified in the request.
-
#create_inference_recommendations_job(params = {}) ⇒ Types::CreateInferenceRecommendationsJobResponse
Starts a recommendation job.
-
#create_labeling_job(params = {}) ⇒ Types::CreateLabelingJobResponse
Creates a job that uses workers to label the data objects in your input dataset.
-
#create_model(params = {}) ⇒ Types::CreateModelOutput
Creates a model in SageMaker.
-
#create_model_bias_job_definition(params = {}) ⇒ Types::CreateModelBiasJobDefinitionResponse
Creates the definition for a model bias job.
-
#create_model_card(params = {}) ⇒ Types::CreateModelCardResponse
Creates an Amazon SageMaker Model Card.
-
#create_model_card_export_job(params = {}) ⇒ Types::CreateModelCardExportJobResponse
Creates an Amazon SageMaker Model Card export job.
-
#create_model_explainability_job_definition(params = {}) ⇒ Types::CreateModelExplainabilityJobDefinitionResponse
Creates the definition for a model explainability job.
-
#create_model_package(params = {}) ⇒ Types::CreateModelPackageOutput
Creates a model package that you can use to create SageMaker models or list on Amazon Web Services Marketplace, or a versioned model that is part of a model group.
-
#create_model_package_group(params = {}) ⇒ Types::CreateModelPackageGroupOutput
Creates a model group.
-
#create_model_quality_job_definition(params = {}) ⇒ Types::CreateModelQualityJobDefinitionResponse
Creates a definition for a job that monitors model quality and drift.
-
#create_monitoring_schedule(params = {}) ⇒ Types::CreateMonitoringScheduleResponse
Creates a schedule that regularly starts Amazon SageMaker Processing Jobs to monitor the data captured for an Amazon SageMaker Endpoint.
-
#create_notebook_instance(params = {}) ⇒ Types::CreateNotebookInstanceOutput
Creates an SageMaker notebook instance.
-
#create_notebook_instance_lifecycle_config(params = {}) ⇒ Types::CreateNotebookInstanceLifecycleConfigOutput
Creates a lifecycle configuration that you can associate with a notebook instance.
-
#create_pipeline(params = {}) ⇒ Types::CreatePipelineResponse
Creates a pipeline using a JSON pipeline definition.
-
#create_presigned_domain_url(params = {}) ⇒ Types::CreatePresignedDomainUrlResponse
Creates a URL for a specified UserProfile in a Domain.
-
#create_presigned_notebook_instance_url(params = {}) ⇒ Types::CreatePresignedNotebookInstanceUrlOutput
Returns a URL that you can use to connect to the Jupyter server from a notebook instance.
-
#create_processing_job(params = {}) ⇒ Types::CreateProcessingJobResponse
Creates a processing job.
-
#create_project(params = {}) ⇒ Types::CreateProjectOutput
Creates a machine learning (ML) project that can contain one or more templates that set up an ML pipeline from training to deploying an approved model.
-
#create_space(params = {}) ⇒ Types::CreateSpaceResponse
Creates a private space or a space used for real time collaboration in a domain.
-
#create_studio_lifecycle_config(params = {}) ⇒ Types::CreateStudioLifecycleConfigResponse
Creates a new Amazon SageMaker Studio Lifecycle Configuration.
-
#create_training_job(params = {}) ⇒ Types::CreateTrainingJobResponse
Starts a model training job.
-
#create_transform_job(params = {}) ⇒ Types::CreateTransformJobResponse
Starts a transform job.
-
#create_trial(params = {}) ⇒ Types::CreateTrialResponse
Creates an SageMaker trial.
-
#create_trial_component(params = {}) ⇒ Types::CreateTrialComponentResponse
Creates a trial component, which is a stage of a machine learning trial.
-
#create_user_profile(params = {}) ⇒ Types::CreateUserProfileResponse
Creates a user profile.
-
#create_workforce(params = {}) ⇒ Types::CreateWorkforceResponse
Use this operation to create a workforce.
-
#create_workteam(params = {}) ⇒ Types::CreateWorkteamResponse
Creates a new work team for labeling your data.
-
#delete_action(params = {}) ⇒ Types::DeleteActionResponse
Deletes an action.
-
#delete_algorithm(params = {}) ⇒ Struct
Removes the specified algorithm from your account.
-
#delete_app(params = {}) ⇒ Struct
Used to stop and delete an app.
-
#delete_app_image_config(params = {}) ⇒ Struct
Deletes an AppImageConfig.
-
#delete_artifact(params = {}) ⇒ Types::DeleteArtifactResponse
Deletes an artifact.
-
#delete_association(params = {}) ⇒ Types::DeleteAssociationResponse
Deletes an association.
-
#delete_cluster(params = {}) ⇒ Types::DeleteClusterResponse
Delete a SageMaker HyperPod cluster.
-
#delete_code_repository(params = {}) ⇒ Struct
Deletes the specified Git repository from your account.
-
#delete_compilation_job(params = {}) ⇒ Struct
Deletes the specified compilation job.
-
#delete_context(params = {}) ⇒ Types::DeleteContextResponse
Deletes an context.
-
#delete_data_quality_job_definition(params = {}) ⇒ Struct
Deletes a data quality monitoring job definition.
-
#delete_device_fleet(params = {}) ⇒ Struct
Deletes a fleet.
-
#delete_domain(params = {}) ⇒ Struct
Used to delete a domain.
-
#delete_edge_deployment_plan(params = {}) ⇒ Struct
Deletes an edge deployment plan if (and only if) all the stages in the plan are inactive or there are no stages in the plan.
-
#delete_edge_deployment_stage(params = {}) ⇒ Struct
Delete a stage in an edge deployment plan if (and only if) the stage is inactive.
-
#delete_endpoint(params = {}) ⇒ Struct
Deletes an endpoint.
-
#delete_endpoint_config(params = {}) ⇒ Struct
Deletes an endpoint configuration.
-
#delete_experiment(params = {}) ⇒ Types::DeleteExperimentResponse
Deletes an SageMaker experiment.
-
#delete_feature_group(params = {}) ⇒ Struct
Delete the
FeatureGroup
and any data that was written to theOnlineStore
of theFeatureGroup
. -
#delete_flow_definition(params = {}) ⇒ Struct
Deletes the specified flow definition.
-
#delete_hub(params = {}) ⇒ Struct
Delete a hub.
-
#delete_hub_content(params = {}) ⇒ Struct
Delete the contents of a hub.
-
#delete_human_task_ui(params = {}) ⇒ Struct
Use this operation to delete a human task user interface (worker task template).
-
#delete_hyper_parameter_tuning_job(params = {}) ⇒ Struct
Deletes a hyperparameter tuning job.
-
#delete_image(params = {}) ⇒ Struct
Deletes a SageMaker image and all versions of the image.
-
#delete_image_version(params = {}) ⇒ Struct
Deletes a version of a SageMaker image.
-
#delete_inference_component(params = {}) ⇒ Struct
Deletes an inference component.
-
#delete_inference_experiment(params = {}) ⇒ Types::DeleteInferenceExperimentResponse
Deletes an inference experiment.
-
#delete_model(params = {}) ⇒ Struct
Deletes a model.
-
#delete_model_bias_job_definition(params = {}) ⇒ Struct
Deletes an Amazon SageMaker model bias job definition.
-
#delete_model_card(params = {}) ⇒ Struct
Deletes an Amazon SageMaker Model Card.
-
#delete_model_explainability_job_definition(params = {}) ⇒ Struct
Deletes an Amazon SageMaker model explainability job definition.
-
#delete_model_package(params = {}) ⇒ Struct
Deletes a model package.
-
#delete_model_package_group(params = {}) ⇒ Struct
Deletes the specified model group.
-
#delete_model_package_group_policy(params = {}) ⇒ Struct
Deletes a model group resource policy.
-
#delete_model_quality_job_definition(params = {}) ⇒ Struct
Deletes the secified model quality monitoring job definition.
-
#delete_monitoring_schedule(params = {}) ⇒ Struct
Deletes a monitoring schedule.
-
#delete_notebook_instance(params = {}) ⇒ Struct
Deletes an SageMaker notebook instance.
-
#delete_notebook_instance_lifecycle_config(params = {}) ⇒ Struct
Deletes a notebook instance lifecycle configuration.
-
#delete_pipeline(params = {}) ⇒ Types::DeletePipelineResponse
Deletes a pipeline if there are no running instances of the pipeline.
-
#delete_project(params = {}) ⇒ Struct
Delete the specified project.
-
#delete_space(params = {}) ⇒ Struct
Used to delete a space.
-
#delete_studio_lifecycle_config(params = {}) ⇒ Struct
Deletes the Amazon SageMaker Studio Lifecycle Configuration.
-
#delete_tags(params = {}) ⇒ Struct
Deletes the specified tags from an SageMaker resource.
-
#delete_trial(params = {}) ⇒ Types::DeleteTrialResponse
Deletes the specified trial.
-
#delete_trial_component(params = {}) ⇒ Types::DeleteTrialComponentResponse
Deletes the specified trial component.
-
#delete_user_profile(params = {}) ⇒ Struct
Deletes a user profile.
-
#delete_workforce(params = {}) ⇒ Struct
Use this operation to delete a workforce.
-
#delete_workteam(params = {}) ⇒ Types::DeleteWorkteamResponse
Deletes an existing work team.
-
#deregister_devices(params = {}) ⇒ Struct
Deregisters the specified devices.
-
#describe_action(params = {}) ⇒ Types::DescribeActionResponse
Describes an action.
-
#describe_algorithm(params = {}) ⇒ Types::DescribeAlgorithmOutput
Returns a description of the specified algorithm that is in your account.
-
#describe_app(params = {}) ⇒ Types::DescribeAppResponse
Describes the app.
-
#describe_app_image_config(params = {}) ⇒ Types::DescribeAppImageConfigResponse
Describes an AppImageConfig.
-
#describe_artifact(params = {}) ⇒ Types::DescribeArtifactResponse
Describes an artifact.
-
#describe_auto_ml_job(params = {}) ⇒ Types::DescribeAutoMLJobResponse
Returns information about an AutoML job created by calling [CreateAutoMLJob][1].
-
#describe_auto_ml_job_v2(params = {}) ⇒ Types::DescribeAutoMLJobV2Response
Returns information about an AutoML job created by calling [CreateAutoMLJobV2][1] or [CreateAutoMLJob][2].
-
#describe_cluster(params = {}) ⇒ Types::DescribeClusterResponse
Retrieves information of a SageMaker HyperPod cluster.
-
#describe_cluster_node(params = {}) ⇒ Types::DescribeClusterNodeResponse
Retrieves information of an instance (also called a node interchangeably) of a SageMaker HyperPod cluster.
-
#describe_code_repository(params = {}) ⇒ Types::DescribeCodeRepositoryOutput
Gets details about the specified Git repository.
-
#describe_compilation_job(params = {}) ⇒ Types::DescribeCompilationJobResponse
Returns information about a model compilation job.
-
#describe_context(params = {}) ⇒ Types::DescribeContextResponse
Describes a context.
-
#describe_data_quality_job_definition(params = {}) ⇒ Types::DescribeDataQualityJobDefinitionResponse
Gets the details of a data quality monitoring job definition.
-
#describe_device(params = {}) ⇒ Types::DescribeDeviceResponse
Describes the device.
-
#describe_device_fleet(params = {}) ⇒ Types::DescribeDeviceFleetResponse
A description of the fleet the device belongs to.
-
#describe_domain(params = {}) ⇒ Types::DescribeDomainResponse
The description of the domain.
-
#describe_edge_deployment_plan(params = {}) ⇒ Types::DescribeEdgeDeploymentPlanResponse
Describes an edge deployment plan with deployment status per stage.
-
#describe_edge_packaging_job(params = {}) ⇒ Types::DescribeEdgePackagingJobResponse
A description of edge packaging jobs.
-
#describe_endpoint(params = {}) ⇒ Types::DescribeEndpointOutput
Returns the description of an endpoint.
-
#describe_endpoint_config(params = {}) ⇒ Types::DescribeEndpointConfigOutput
Returns the description of an endpoint configuration created using the
CreateEndpointConfig
API. -
#describe_experiment(params = {}) ⇒ Types::DescribeExperimentResponse
Provides a list of an experiment's properties.
-
#describe_feature_group(params = {}) ⇒ Types::DescribeFeatureGroupResponse
Use this operation to describe a
FeatureGroup
. -
#describe_feature_metadata(params = {}) ⇒ Types::DescribeFeatureMetadataResponse
Shows the metadata for a feature within a feature group.
-
#describe_flow_definition(params = {}) ⇒ Types::DescribeFlowDefinitionResponse
Returns information about the specified flow definition.
-
#describe_hub(params = {}) ⇒ Types::DescribeHubResponse
Describe a hub.
-
#describe_hub_content(params = {}) ⇒ Types::DescribeHubContentResponse
Describe the content of a hub.
-
#describe_human_task_ui(params = {}) ⇒ Types::DescribeHumanTaskUiResponse
Returns information about the requested human task user interface (worker task template).
-
#describe_hyper_parameter_tuning_job(params = {}) ⇒ Types::DescribeHyperParameterTuningJobResponse
Returns a description of a hyperparameter tuning job, depending on the fields selected.
-
#describe_image(params = {}) ⇒ Types::DescribeImageResponse
Describes a SageMaker image.
-
#describe_image_version(params = {}) ⇒ Types::DescribeImageVersionResponse
Describes a version of a SageMaker image.
-
#describe_inference_component(params = {}) ⇒ Types::DescribeInferenceComponentOutput
Returns information about an inference component.
-
#describe_inference_experiment(params = {}) ⇒ Types::DescribeInferenceExperimentResponse
Returns details about an inference experiment.
-
#describe_inference_recommendations_job(params = {}) ⇒ Types::DescribeInferenceRecommendationsJobResponse
Provides the results of the Inference Recommender job.
-
#describe_labeling_job(params = {}) ⇒ Types::DescribeLabelingJobResponse
Gets information about a labeling job.
-
#describe_lineage_group(params = {}) ⇒ Types::DescribeLineageGroupResponse
Provides a list of properties for the requested lineage group.
-
#describe_model(params = {}) ⇒ Types::DescribeModelOutput
Describes a model that you created using the
CreateModel
API. -
#describe_model_bias_job_definition(params = {}) ⇒ Types::DescribeModelBiasJobDefinitionResponse
Returns a description of a model bias job definition.
-
#describe_model_card(params = {}) ⇒ Types::DescribeModelCardResponse
Describes the content, creation time, and security configuration of an Amazon SageMaker Model Card.
-
#describe_model_card_export_job(params = {}) ⇒ Types::DescribeModelCardExportJobResponse
Describes an Amazon SageMaker Model Card export job.
-
#describe_model_explainability_job_definition(params = {}) ⇒ Types::DescribeModelExplainabilityJobDefinitionResponse
Returns a description of a model explainability job definition.
-
#describe_model_package(params = {}) ⇒ Types::DescribeModelPackageOutput
Returns a description of the specified model package, which is used to create SageMaker models or list them on Amazon Web Services Marketplace.
-
#describe_model_package_group(params = {}) ⇒ Types::DescribeModelPackageGroupOutput
Gets a description for the specified model group.
-
#describe_model_quality_job_definition(params = {}) ⇒ Types::DescribeModelQualityJobDefinitionResponse
Returns a description of a model quality job definition.
-
#describe_monitoring_schedule(params = {}) ⇒ Types::DescribeMonitoringScheduleResponse
Describes the schedule for a monitoring job.
-
#describe_notebook_instance(params = {}) ⇒ Types::DescribeNotebookInstanceOutput
Returns information about a notebook instance.
-
#describe_notebook_instance_lifecycle_config(params = {}) ⇒ Types::DescribeNotebookInstanceLifecycleConfigOutput
Returns a description of a notebook instance lifecycle configuration.
-
#describe_pipeline(params = {}) ⇒ Types::DescribePipelineResponse
Describes the details of a pipeline.
-
#describe_pipeline_definition_for_execution(params = {}) ⇒ Types::DescribePipelineDefinitionForExecutionResponse
Describes the details of an execution's pipeline definition.
-
#describe_pipeline_execution(params = {}) ⇒ Types::DescribePipelineExecutionResponse
Describes the details of a pipeline execution.
-
#describe_processing_job(params = {}) ⇒ Types::DescribeProcessingJobResponse
Returns a description of a processing job.
-
#describe_project(params = {}) ⇒ Types::DescribeProjectOutput
Describes the details of a project.
-
#describe_space(params = {}) ⇒ Types::DescribeSpaceResponse
Describes the space.
-
#describe_studio_lifecycle_config(params = {}) ⇒ Types::DescribeStudioLifecycleConfigResponse
Describes the Amazon SageMaker Studio Lifecycle Configuration.
-
#describe_subscribed_workteam(params = {}) ⇒ Types::DescribeSubscribedWorkteamResponse
Gets information about a work team provided by a vendor.
-
#describe_training_job(params = {}) ⇒ Types::DescribeTrainingJobResponse
Returns information about a training job.
-
#describe_transform_job(params = {}) ⇒ Types::DescribeTransformJobResponse
Returns information about a transform job.
-
#describe_trial(params = {}) ⇒ Types::DescribeTrialResponse
Provides a list of a trial's properties.
-
#describe_trial_component(params = {}) ⇒ Types::DescribeTrialComponentResponse
Provides a list of a trials component's properties.
-
#describe_user_profile(params = {}) ⇒ Types::DescribeUserProfileResponse
Describes a user profile.
-
#describe_workforce(params = {}) ⇒ Types::DescribeWorkforceResponse
Lists private workforce information, including workforce name, Amazon Resource Name (ARN), and, if applicable, allowed IP address ranges ([CIDRs][1]).
-
#describe_workteam(params = {}) ⇒ Types::DescribeWorkteamResponse
Gets information about a specific work team.
-
#disable_sagemaker_servicecatalog_portfolio(params = {}) ⇒ Struct
Disables using Service Catalog in SageMaker.
-
#disassociate_trial_component(params = {}) ⇒ Types::DisassociateTrialComponentResponse
Disassociates a trial component from a trial.
-
#enable_sagemaker_servicecatalog_portfolio(params = {}) ⇒ Struct
Enables using Service Catalog in SageMaker.
-
#get_device_fleet_report(params = {}) ⇒ Types::GetDeviceFleetReportResponse
Describes a fleet.
-
#get_lineage_group_policy(params = {}) ⇒ Types::GetLineageGroupPolicyResponse
The resource policy for the lineage group.
-
#get_model_package_group_policy(params = {}) ⇒ Types::GetModelPackageGroupPolicyOutput
Gets a resource policy that manages access for a model group.
-
#get_sagemaker_servicecatalog_portfolio_status(params = {}) ⇒ Types::GetSagemakerServicecatalogPortfolioStatusOutput
Gets the status of Service Catalog in SageMaker.
-
#get_scaling_configuration_recommendation(params = {}) ⇒ Types::GetScalingConfigurationRecommendationResponse
Starts an Amazon SageMaker Inference Recommender autoscaling recommendation job.
-
#get_search_suggestions(params = {}) ⇒ Types::GetSearchSuggestionsResponse
An auto-complete API for the search functionality in the SageMaker console.
-
#import_hub_content(params = {}) ⇒ Types::ImportHubContentResponse
Import hub content.
-
#list_actions(params = {}) ⇒ Types::ListActionsResponse
Lists the actions in your account and their properties.
-
#list_algorithms(params = {}) ⇒ Types::ListAlgorithmsOutput
Lists the machine learning algorithms that have been created.
-
#list_aliases(params = {}) ⇒ Types::ListAliasesResponse
Lists the aliases of a specified image or image version.
-
#list_app_image_configs(params = {}) ⇒ Types::ListAppImageConfigsResponse
Lists the AppImageConfigs in your account and their properties.
-
#list_apps(params = {}) ⇒ Types::ListAppsResponse
Lists apps.
-
#list_artifacts(params = {}) ⇒ Types::ListArtifactsResponse
Lists the artifacts in your account and their properties.
-
#list_associations(params = {}) ⇒ Types::ListAssociationsResponse
Lists the associations in your account and their properties.
-
#list_auto_ml_jobs(params = {}) ⇒ Types::ListAutoMLJobsResponse
Request a list of jobs.
-
#list_candidates_for_auto_ml_job(params = {}) ⇒ Types::ListCandidatesForAutoMLJobResponse
List the candidates created for the job.
-
#list_cluster_nodes(params = {}) ⇒ Types::ListClusterNodesResponse
Retrieves the list of instances (also called nodes interchangeably) in a SageMaker HyperPod cluster.
-
#list_clusters(params = {}) ⇒ Types::ListClustersResponse
Retrieves the list of SageMaker HyperPod clusters.
-
#list_code_repositories(params = {}) ⇒ Types::ListCodeRepositoriesOutput
Gets a list of the Git repositories in your account.
-
#list_compilation_jobs(params = {}) ⇒ Types::ListCompilationJobsResponse
Lists model compilation jobs that satisfy various filters.
-
#list_contexts(params = {}) ⇒ Types::ListContextsResponse
Lists the contexts in your account and their properties.
-
#list_data_quality_job_definitions(params = {}) ⇒ Types::ListDataQualityJobDefinitionsResponse
Lists the data quality job definitions in your account.
-
#list_device_fleets(params = {}) ⇒ Types::ListDeviceFleetsResponse
Returns a list of devices in the fleet.
-
#list_devices(params = {}) ⇒ Types::ListDevicesResponse
A list of devices.
-
#list_domains(params = {}) ⇒ Types::ListDomainsResponse
Lists the domains.
-
#list_edge_deployment_plans(params = {}) ⇒ Types::ListEdgeDeploymentPlansResponse
Lists all edge deployment plans.
-
#list_edge_packaging_jobs(params = {}) ⇒ Types::ListEdgePackagingJobsResponse
Returns a list of edge packaging jobs.
-
#list_endpoint_configs(params = {}) ⇒ Types::ListEndpointConfigsOutput
Lists endpoint configurations.
-
#list_endpoints(params = {}) ⇒ Types::ListEndpointsOutput
Lists endpoints.
-
#list_experiments(params = {}) ⇒ Types::ListExperimentsResponse
Lists all the experiments in your account.
-
#list_feature_groups(params = {}) ⇒ Types::ListFeatureGroupsResponse
List
FeatureGroup
s based on given filter and order. -
#list_flow_definitions(params = {}) ⇒ Types::ListFlowDefinitionsResponse
Returns information about the flow definitions in your account.
-
#list_hub_content_versions(params = {}) ⇒ Types::ListHubContentVersionsResponse
List hub content versions.
-
#list_hub_contents(params = {}) ⇒ Types::ListHubContentsResponse
List the contents of a hub.
-
#list_hubs(params = {}) ⇒ Types::ListHubsResponse
List all existing hubs.
-
#list_human_task_uis(params = {}) ⇒ Types::ListHumanTaskUisResponse
Returns information about the human task user interfaces in your account.
-
#list_hyper_parameter_tuning_jobs(params = {}) ⇒ Types::ListHyperParameterTuningJobsResponse
Gets a list of [HyperParameterTuningJobSummary][1] objects that describe the hyperparameter tuning jobs launched in your account.
-
#list_image_versions(params = {}) ⇒ Types::ListImageVersionsResponse
Lists the versions of a specified image and their properties.
-
#list_images(params = {}) ⇒ Types::ListImagesResponse
Lists the images in your account and their properties.
-
#list_inference_components(params = {}) ⇒ Types::ListInferenceComponentsOutput
Lists the inference components in your account and their properties.
-
#list_inference_experiments(params = {}) ⇒ Types::ListInferenceExperimentsResponse
Returns the list of all inference experiments.
-
#list_inference_recommendations_job_steps(params = {}) ⇒ Types::ListInferenceRecommendationsJobStepsResponse
Returns a list of the subtasks for an Inference Recommender job.
-
#list_inference_recommendations_jobs(params = {}) ⇒ Types::ListInferenceRecommendationsJobsResponse
Lists recommendation jobs that satisfy various filters.
-
#list_labeling_jobs(params = {}) ⇒ Types::ListLabelingJobsResponse
Gets a list of labeling jobs.
-
#list_labeling_jobs_for_workteam(params = {}) ⇒ Types::ListLabelingJobsForWorkteamResponse
Gets a list of labeling jobs assigned to a specified work team.
-
#list_lineage_groups(params = {}) ⇒ Types::ListLineageGroupsResponse
A list of lineage groups shared with your Amazon Web Services account.
-
#list_model_bias_job_definitions(params = {}) ⇒ Types::ListModelBiasJobDefinitionsResponse
Lists model bias jobs definitions that satisfy various filters.
-
#list_model_card_export_jobs(params = {}) ⇒ Types::ListModelCardExportJobsResponse
List the export jobs for the Amazon SageMaker Model Card.
-
#list_model_card_versions(params = {}) ⇒ Types::ListModelCardVersionsResponse
List existing versions of an Amazon SageMaker Model Card.
-
#list_model_cards(params = {}) ⇒ Types::ListModelCardsResponse
List existing model cards.
-
#list_model_explainability_job_definitions(params = {}) ⇒ Types::ListModelExplainabilityJobDefinitionsResponse
Lists model explainability job definitions that satisfy various filters.
-
#list_model_metadata(params = {}) ⇒ Types::ListModelMetadataResponse
Lists the domain, framework, task, and model name of standard machine learning models found in common model zoos.
-
#list_model_package_groups(params = {}) ⇒ Types::ListModelPackageGroupsOutput
Gets a list of the model groups in your Amazon Web Services account.
-
#list_model_packages(params = {}) ⇒ Types::ListModelPackagesOutput
Lists the model packages that have been created.
-
#list_model_quality_job_definitions(params = {}) ⇒ Types::ListModelQualityJobDefinitionsResponse
Gets a list of model quality monitoring job definitions in your account.
-
#list_models(params = {}) ⇒ Types::ListModelsOutput
Lists models created with the
CreateModel
API. -
#list_monitoring_alert_history(params = {}) ⇒ Types::ListMonitoringAlertHistoryResponse
Gets a list of past alerts in a model monitoring schedule.
-
#list_monitoring_alerts(params = {}) ⇒ Types::ListMonitoringAlertsResponse
Gets the alerts for a single monitoring schedule.
-
#list_monitoring_executions(params = {}) ⇒ Types::ListMonitoringExecutionsResponse
Returns list of all monitoring job executions.
-
#list_monitoring_schedules(params = {}) ⇒ Types::ListMonitoringSchedulesResponse
Returns list of all monitoring schedules.
-
#list_notebook_instance_lifecycle_configs(params = {}) ⇒ Types::ListNotebookInstanceLifecycleConfigsOutput
Lists notebook instance lifestyle configurations created with the [CreateNotebookInstanceLifecycleConfig][1] API.
-
#list_notebook_instances(params = {}) ⇒ Types::ListNotebookInstancesOutput
Returns a list of the SageMaker notebook instances in the requester's account in an Amazon Web Services Region.
-
#list_pipeline_execution_steps(params = {}) ⇒ Types::ListPipelineExecutionStepsResponse
Gets a list of
PipeLineExecutionStep
objects. -
#list_pipeline_executions(params = {}) ⇒ Types::ListPipelineExecutionsResponse
Gets a list of the pipeline executions.
-
#list_pipeline_parameters_for_execution(params = {}) ⇒ Types::ListPipelineParametersForExecutionResponse
Gets a list of parameters for a pipeline execution.
-
#list_pipelines(params = {}) ⇒ Types::ListPipelinesResponse
Gets a list of pipelines.
-
#list_processing_jobs(params = {}) ⇒ Types::ListProcessingJobsResponse
Lists processing jobs that satisfy various filters.
-
#list_projects(params = {}) ⇒ Types::ListProjectsOutput
Gets a list of the projects in an Amazon Web Services account.
-
#list_resource_catalogs(params = {}) ⇒ Types::ListResourceCatalogsResponse
Lists Amazon SageMaker Catalogs based on given filters and orders.
-
#list_spaces(params = {}) ⇒ Types::ListSpacesResponse
Lists spaces.
-
#list_stage_devices(params = {}) ⇒ Types::ListStageDevicesResponse
Lists devices allocated to the stage, containing detailed device information and deployment status.
-
#list_studio_lifecycle_configs(params = {}) ⇒ Types::ListStudioLifecycleConfigsResponse
Lists the Amazon SageMaker Studio Lifecycle Configurations in your Amazon Web Services Account.
-
#list_subscribed_workteams(params = {}) ⇒ Types::ListSubscribedWorkteamsResponse
Gets a list of the work teams that you are subscribed to in the Amazon Web Services Marketplace.
-
#list_tags(params = {}) ⇒ Types::ListTagsOutput
Returns the tags for the specified SageMaker resource.
-
#list_training_jobs(params = {}) ⇒ Types::ListTrainingJobsResponse
Lists training jobs.
-
#list_training_jobs_for_hyper_parameter_tuning_job(params = {}) ⇒ Types::ListTrainingJobsForHyperParameterTuningJobResponse
Gets a list of [TrainingJobSummary][1] objects that describe the training jobs that a hyperparameter tuning job launched.
-
#list_transform_jobs(params = {}) ⇒ Types::ListTransformJobsResponse
Lists transform jobs.
-
#list_trial_components(params = {}) ⇒ Types::ListTrialComponentsResponse
Lists the trial components in your account.
-
#list_trials(params = {}) ⇒ Types::ListTrialsResponse
Lists the trials in your account.
-
#list_user_profiles(params = {}) ⇒ Types::ListUserProfilesResponse
Lists user profiles.
-
#list_workforces(params = {}) ⇒ Types::ListWorkforcesResponse
Use this operation to list all private and vendor workforces in an Amazon Web Services Region.
-
#list_workteams(params = {}) ⇒ Types::ListWorkteamsResponse
Gets a list of private work teams that you have defined in a region.
-
#put_model_package_group_policy(params = {}) ⇒ Types::PutModelPackageGroupPolicyOutput
Adds a resouce policy to control access to a model group.
-
#query_lineage(params = {}) ⇒ Types::QueryLineageResponse
Use this action to inspect your lineage and discover relationships between entities.
-
#register_devices(params = {}) ⇒ Struct
Register devices.
-
#render_ui_template(params = {}) ⇒ Types::RenderUiTemplateResponse
Renders the UI template so that you can preview the worker's experience.
-
#retry_pipeline_execution(params = {}) ⇒ Types::RetryPipelineExecutionResponse
Retry the execution of the pipeline.
-
#search(params = {}) ⇒ Types::SearchResponse
Finds SageMaker resources that match a search query.
-
#send_pipeline_execution_step_failure(params = {}) ⇒ Types::SendPipelineExecutionStepFailureResponse
Notifies the pipeline that the execution of a callback step failed, along with a message describing why.
-
#send_pipeline_execution_step_success(params = {}) ⇒ Types::SendPipelineExecutionStepSuccessResponse
Notifies the pipeline that the execution of a callback step succeeded and provides a list of the step's output parameters.
-
#start_edge_deployment_stage(params = {}) ⇒ Struct
Starts a stage in an edge deployment plan.
-
#start_inference_experiment(params = {}) ⇒ Types::StartInferenceExperimentResponse
Starts an inference experiment.
-
#start_monitoring_schedule(params = {}) ⇒ Struct
Starts a previously stopped monitoring schedule.
-
#start_notebook_instance(params = {}) ⇒ Struct
Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume.
-
#start_pipeline_execution(params = {}) ⇒ Types::StartPipelineExecutionResponse
Starts a pipeline execution.
-
#stop_auto_ml_job(params = {}) ⇒ Struct
A method for forcing a running job to shut down.
-
#stop_compilation_job(params = {}) ⇒ Struct
Stops a model compilation job.
-
#stop_edge_deployment_stage(params = {}) ⇒ Struct
Stops a stage in an edge deployment plan.
-
#stop_edge_packaging_job(params = {}) ⇒ Struct
Request to stop an edge packaging job.
-
#stop_hyper_parameter_tuning_job(params = {}) ⇒ Struct
Stops a running hyperparameter tuning job and all running training jobs that the tuning job launched.
-
#stop_inference_experiment(params = {}) ⇒ Types::StopInferenceExperimentResponse
Stops an inference experiment.
-
#stop_inference_recommendations_job(params = {}) ⇒ Struct
Stops an Inference Recommender job.
-
#stop_labeling_job(params = {}) ⇒ Struct
Stops a running labeling job.
-
#stop_monitoring_schedule(params = {}) ⇒ Struct
Stops a previously started monitoring schedule.
-
#stop_notebook_instance(params = {}) ⇒ Struct
Terminates the ML compute instance.
-
#stop_pipeline_execution(params = {}) ⇒ Types::StopPipelineExecutionResponse
Stops a pipeline execution.
-
#stop_processing_job(params = {}) ⇒ Struct
Stops a processing job.
-
#stop_training_job(params = {}) ⇒ Struct
Stops a training job.
-
#stop_transform_job(params = {}) ⇒ Struct
Stops a batch transform job.
-
#update_action(params = {}) ⇒ Types::UpdateActionResponse
Updates an action.
-
#update_app_image_config(params = {}) ⇒ Types::UpdateAppImageConfigResponse
Updates the properties of an AppImageConfig.
-
#update_artifact(params = {}) ⇒ Types::UpdateArtifactResponse
Updates an artifact.
-
#update_cluster(params = {}) ⇒ Types::UpdateClusterResponse
Updates a SageMaker HyperPod cluster.
-
#update_cluster_software(params = {}) ⇒ Types::UpdateClusterSoftwareResponse
Updates the platform software of a SageMaker HyperPod cluster for security patching.
-
#update_code_repository(params = {}) ⇒ Types::UpdateCodeRepositoryOutput
Updates the specified Git repository with the specified values.
-
#update_context(params = {}) ⇒ Types::UpdateContextResponse
Updates a context.
-
#update_device_fleet(params = {}) ⇒ Struct
Updates a fleet of devices.
-
#update_devices(params = {}) ⇒ Struct
Updates one or more devices in a fleet.
-
#update_domain(params = {}) ⇒ Types::UpdateDomainResponse
Updates the default settings for new user profiles in the domain.
-
#update_endpoint(params = {}) ⇒ Types::UpdateEndpointOutput
Deploys the
EndpointConfig
specified in the request to a new fleet of instances. -
#update_endpoint_weights_and_capacities(params = {}) ⇒ Types::UpdateEndpointWeightsAndCapacitiesOutput
Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant associated with an existing endpoint.
-
#update_experiment(params = {}) ⇒ Types::UpdateExperimentResponse
Adds, updates, or removes the description of an experiment.
-
#update_feature_group(params = {}) ⇒ Types::UpdateFeatureGroupResponse
Updates the feature group by either adding features or updating the online store configuration.
-
#update_feature_metadata(params = {}) ⇒ Struct
Updates the description and parameters of the feature group.
-
#update_hub(params = {}) ⇒ Types::UpdateHubResponse
Update a hub.
-
#update_image(params = {}) ⇒ Types::UpdateImageResponse
Updates the properties of a SageMaker image.
-
#update_image_version(params = {}) ⇒ Types::UpdateImageVersionResponse
Updates the properties of a SageMaker image version.
-
#update_inference_component(params = {}) ⇒ Types::UpdateInferenceComponentOutput
Updates an inference component.
-
#update_inference_component_runtime_config(params = {}) ⇒ Types::UpdateInferenceComponentRuntimeConfigOutput
Runtime settings for a model that is deployed with an inference component.
-
#update_inference_experiment(params = {}) ⇒ Types::UpdateInferenceExperimentResponse
Updates an inference experiment that you created.
-
#update_model_card(params = {}) ⇒ Types::UpdateModelCardResponse
Update an Amazon SageMaker Model Card.
-
#update_model_package(params = {}) ⇒ Types::UpdateModelPackageOutput
Updates a versioned model.
-
#update_monitoring_alert(params = {}) ⇒ Types::UpdateMonitoringAlertResponse
Update the parameters of a model monitor alert.
-
#update_monitoring_schedule(params = {}) ⇒ Types::UpdateMonitoringScheduleResponse
Updates a previously created schedule.
-
#update_notebook_instance(params = {}) ⇒ Struct
Updates a notebook instance.
-
#update_notebook_instance_lifecycle_config(params = {}) ⇒ Struct
Updates a notebook instance lifecycle configuration created with the [CreateNotebookInstanceLifecycleConfig][1] API.
-
#update_pipeline(params = {}) ⇒ Types::UpdatePipelineResponse
Updates a pipeline.
-
#update_pipeline_execution(params = {}) ⇒ Types::UpdatePipelineExecutionResponse
Updates a pipeline execution.
-
#update_project(params = {}) ⇒ Types::UpdateProjectOutput
Updates a machine learning (ML) project that is created from a template that sets up an ML pipeline from training to deploying an approved model.
-
#update_space(params = {}) ⇒ Types::UpdateSpaceResponse
Updates the settings of a space.
-
#update_training_job(params = {}) ⇒ Types::UpdateTrainingJobResponse
Update a model training job to request a new Debugger profiling configuration or to change warm pool retention length.
-
#update_trial(params = {}) ⇒ Types::UpdateTrialResponse
Updates the display name of a trial.
-
#update_trial_component(params = {}) ⇒ Types::UpdateTrialComponentResponse
Updates one or more properties of a trial component.
-
#update_user_profile(params = {}) ⇒ Types::UpdateUserProfileResponse
Updates a user profile.
-
#update_workforce(params = {}) ⇒ Types::UpdateWorkforceResponse
Use this operation to update your workforce.
-
#update_workteam(params = {}) ⇒ Types::UpdateWorkteamResponse
Updates an existing work team with new member definitions or description.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
420 421 422 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 420 def initialize(*args) super end |
Instance Method Details
#add_association(params = {}) ⇒ Types::AddAssociationResponse
Creates an association between the source and the destination. A source can be associated with multiple destinations, and a destination can be associated with multiple sources. An association is a lineage tracking entity. For more information, see Amazon SageMaker ML Lineage Tracking.
482 483 484 485 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 482 def add_association(params = {}, = {}) req = build_request(:add_association, params) req.send_request() end |
#add_tags(params = {}) ⇒ Types::AddTagsOutput
Adds or overwrites one or more tags for the specified SageMaker resource. You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints.
Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies.
Tags
parameter of
CreateHyperParameterTuningJob
Tags
parameter of CreateDomain or CreateUserProfile.
565 566 567 568 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 565 def (params = {}, = {}) req = build_request(:add_tags, params) req.send_request() end |
#associate_trial_component(params = {}) ⇒ Types::AssociateTrialComponentResponse
Associates a trial component with a trial. A trial component can be associated with multiple trials. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.
605 606 607 608 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 605 def associate_trial_component(params = {}, = {}) req = build_request(:associate_trial_component, params) req.send_request() end |
#batch_describe_model_package(params = {}) ⇒ Types::BatchDescribeModelPackageOutput
This action batch describes a list of versioned model packages
671 672 673 674 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 671 def batch_describe_model_package(params = {}, = {}) req = build_request(:batch_describe_model_package, params) req.send_request() end |
#create_action(params = {}) ⇒ Types::CreateActionResponse
Creates an action. An action is a lineage tracking entity that represents an action or activity. For example, a model deployment or an HPO job. Generally, an action involves at least one input or output artifact. For more information, see Amazon SageMaker ML Lineage Tracking.
752 753 754 755 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 752 def create_action(params = {}, = {}) req = build_request(:create_action, params) req.send_request() end |
#create_algorithm(params = {}) ⇒ Types::CreateAlgorithmOutput
Create a machine learning algorithm that you can use in SageMaker and list in the Amazon Web Services Marketplace.
1037 1038 1039 1040 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 1037 def create_algorithm(params = {}, = {}) req = build_request(:create_algorithm, params) req.send_request() end |
#create_app(params = {}) ⇒ Types::CreateAppResponse
Creates a running app for the specified UserProfile. This operation is automatically invoked by Amazon SageMaker upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously.
1116 1117 1118 1119 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 1116 def create_app(params = {}, = {}) req = build_request(:create_app, params) req.send_request() end |
#create_app_image_config(params = {}) ⇒ Types::CreateAppImageConfigResponse
Creates a configuration for running a SageMaker image as a KernelGateway app. The configuration specifies the Amazon Elastic File System storage volume on the image, and a list of the kernels in the image.
1215 1216 1217 1218 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 1215 def create_app_image_config(params = {}, = {}) req = build_request(:create_app_image_config, params) req.send_request() end |
#create_artifact(params = {}) ⇒ Types::CreateArtifactResponse
Creates an artifact. An artifact is a lineage tracking entity that represents a URI addressable object or data. Some examples are the S3 URI of a dataset and the ECR registry path of an image. For more information, see Amazon SageMaker ML Lineage Tracking.
1291 1292 1293 1294 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 1291 def create_artifact(params = {}, = {}) req = build_request(:create_artifact, params) req.send_request() end |
#create_auto_ml_job(params = {}) ⇒ Types::CreateAutoMLJobResponse
Creates an Autopilot job also referred to as Autopilot experiment or AutoML job.
CreateAutoMLJobV2
can manage tabular problem types identical to
those of its previous version CreateAutoMLJob
, as well as
time-series forecasting, non-tabular problem types such as image or
text classification, and text generation (LLMs fine-tuning).
Find guidelines about how to migrate a CreateAutoMLJob
to
CreateAutoMLJobV2
in Migrate a CreateAutoMLJob to
CreateAutoMLJobV2.
You can find the best-performing model after you run an AutoML job by calling DescribeAutoMLJobV2 (recommended) or DescribeAutoMLJob.
1470 1471 1472 1473 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 1470 def create_auto_ml_job(params = {}, = {}) req = build_request(:create_auto_ml_job, params) req.send_request() end |
#create_auto_ml_job_v2(params = {}) ⇒ Types::CreateAutoMLJobV2Response
Creates an Autopilot job also referred to as Autopilot experiment or AutoML job V2.
CreateAutoMLJobV2
can manage tabular problem types identical to
those of its previous version CreateAutoMLJob
, as well as
time-series forecasting, non-tabular problem types such as image or
text classification, and text generation (LLMs fine-tuning).
Find guidelines about how to migrate a CreateAutoMLJob
to
CreateAutoMLJobV2
in Migrate a CreateAutoMLJob to
CreateAutoMLJobV2.
For the list of available problem types supported by
CreateAutoMLJobV2
, see AutoMLProblemTypeConfig.
You can find the best-performing model after you run an AutoML job V2 by calling DescribeAutoMLJobV2.
1755 1756 1757 1758 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 1755 def create_auto_ml_job_v2(params = {}, = {}) req = build_request(:create_auto_ml_job_v2, params) req.send_request() end |
#create_cluster(params = {}) ⇒ Types::CreateClusterResponse
Creates a SageMaker HyperPod cluster. SageMaker HyperPod is a capability of SageMaker for creating and managing persistent clusters for developing large machine learning models, such as large language models (LLMs) and diffusion models. To learn more, see Amazon SageMaker HyperPod in the Amazon SageMaker Developer Guide.
1839 1840 1841 1842 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 1839 def create_cluster(params = {}, = {}) req = build_request(:create_cluster, params) req.send_request() end |
#create_code_repository(params = {}) ⇒ Types::CreateCodeRepositoryOutput
Creates a Git repository as a resource in your SageMaker account. You can associate the repository with notebook instances so that you can use Git source control for the notebooks you create. The Git repository is a resource in your SageMaker account, so it can be associated with more than one notebook instance, and it persists independently from the lifecycle of any notebook instances it is associated with.
The repository can be hosted either in Amazon Web Services CodeCommit or in any other Git repository.
1907 1908 1909 1910 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 1907 def create_code_repository(params = {}, = {}) req = build_request(:create_code_repository, params) req.send_request() end |
#create_compilation_job(params = {}) ⇒ Types::CreateCompilationJobResponse
Starts a model compilation job. After the model has been compiled, Amazon SageMaker saves the resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify.
If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts with Amazon Web Services IoT Greengrass. In that case, deploy them as an ML resource.
In the request body, you provide the following:
A name for the compilation job
Information about the input model artifacts
The output location for the compiled model and the device (target) that the model runs on
The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform the model compilation job.
You can also provide a Tag
to track the model compilation job's
resource use and costs. The response body contains the
CompilationJobArn
for the compiled job.
To stop a model compilation job, use StopCompilationJob. To get information about a particular model compilation job, use DescribeCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.
2069 2070 2071 2072 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 2069 def create_compilation_job(params = {}, = {}) req = build_request(:create_compilation_job, params) req.send_request() end |
#create_context(params = {}) ⇒ Types::CreateContextResponse
Creates a context. A context is a lineage tracking entity that represents a logical grouping of other tracking or experiment entities. Some examples are an endpoint and a model package. For more information, see Amazon SageMaker ML Lineage Tracking.
2136 2137 2138 2139 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 2136 def create_context(params = {}, = {}) req = build_request(:create_context, params) req.send_request() end |
#create_data_quality_job_definition(params = {}) ⇒ Types::CreateDataQualityJobDefinitionResponse
Creates a definition for a job that monitors data quality and drift. For information about model monitor, see Amazon SageMaker Model Monitor.
2301 2302 2303 2304 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 2301 def create_data_quality_job_definition(params = {}, = {}) req = build_request(:create_data_quality_job_definition, params) req.send_request() end |
#create_device_fleet(params = {}) ⇒ Struct
Creates a device fleet.
2360 2361 2362 2363 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 2360 def create_device_fleet(params = {}, = {}) req = build_request(:create_device_fleet, params) req.send_request() end |
#create_domain(params = {}) ⇒ Types::CreateDomainResponse
Creates a Domain
. A domain consists of an associated Amazon Elastic
File System volume, a list of authorized users, and a variety of
security, application, policy, and Amazon Virtual Private Cloud (VPC)
configurations. Users within a domain can share notebook files and
other artifacts with each other.
EFS storage
When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files.
SageMaker uses the Amazon Web Services Key Management Service (Amazon Web Services KMS) to encrypt the EFS volume attached to the domain with an Amazon Web Services managed key by default. For more control, you can specify a customer managed key. For more information, see Protect Data at Rest Using Encryption.
VPC configuration
All traffic between the domain and the Amazon EFS volume is through
the specified VPC and subnets. For other traffic, you can specify the
AppNetworkAccessType
parameter. AppNetworkAccessType
corresponds
to the network access type that you choose when you onboard to the
domain. The following options are available:
PublicInternetOnly
- Non-EFS traffic goes through a VPC managed by Amazon SageMaker, which allows internet access. This is the default value.VpcOnly
- All traffic is through the specified VPC and subnets. Internet access is disabled by default. To allow internet access, you must specify a NAT gateway.When internet access is disabled, you won't be able to run a Amazon SageMaker Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker API and runtime or a NAT gateway and your security groups allow outbound connections.
NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules in order to launch a Amazon SageMaker Studio app successfully.
For more information, see Connect Amazon SageMaker Studio Notebooks to Resources in a VPC.
2767 2768 2769 2770 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 2767 def create_domain(params = {}, = {}) req = build_request(:create_domain, params) req.send_request() end |
#create_edge_deployment_plan(params = {}) ⇒ Types::CreateEdgeDeploymentPlanResponse
Creates an edge deployment plan, consisting of multiple stages. Each stage may have a different deployment configuration and devices.
2836 2837 2838 2839 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 2836 def create_edge_deployment_plan(params = {}, = {}) req = build_request(:create_edge_deployment_plan, params) req.send_request() end |
#create_edge_deployment_stage(params = {}) ⇒ Struct
Creates a new stage in an existing edge deployment plan.
2875 2876 2877 2878 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 2875 def create_edge_deployment_stage(params = {}, = {}) req = build_request(:create_edge_deployment_stage, params) req.send_request() end |
#create_edge_packaging_job(params = {}) ⇒ Struct
Starts a SageMaker Edge Manager model packaging job. Edge Manager will use the model artifacts from the Amazon Simple Storage Service bucket that you specify. After the model has been packaged, Amazon SageMaker saves the resulting artifacts to an S3 bucket that you specify.
2942 2943 2944 2945 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 2942 def create_edge_packaging_job(params = {}, = {}) req = build_request(:create_edge_packaging_job, params) req.send_request() end |
#create_endpoint(params = {}) ⇒ Types::CreateEndpointOutput
Creates an endpoint using the endpoint configuration specified in the request. SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API.
Use this API to deploy models using SageMaker hosting services.
EndpointConfig
that is in use by an endpoint
that is live or while the UpdateEndpoint
or CreateEndpoint
operations are being performed on the endpoint. To update an endpoint,
you must create a new EndpointConfig
.
The endpoint name must be unique within an Amazon Web Services Region in your Amazon Web Services account.
When it receives the request, SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them.
Eventually Consistent Reads
,
the response might not reflect the results of a recently completed
write operation. The response might include some stale data. If the
dependent entities are not yet in DynamoDB, this causes a validation
error. If you repeat your read request after a short time, the
response should return the latest data. So retry logic is recommended
to handle these possible issues. We also recommend that customers call
DescribeEndpointConfig before calling CreateEndpoint to
minimize the potential impact of a DynamoDB eventually consistent
read.
When SageMaker receives the request, it sets the endpoint status to
Creating
. After it creates the endpoint, it sets the status to
InService
. SageMaker can then process incoming requests for
inferences. To check the status of an endpoint, use the
DescribeEndpoint API.
If any of the models hosted at this endpoint get model data from an Amazon S3 location, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provided. Amazon Web Services STS is activated in your Amazon Web Services account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide.
Option 1: For a full SageMaker access, search and attach the
AmazonSageMakerFullAccess
policy.Option 2: For granting a limited access to an IAM role, paste the following Action elements manually into the JSON file of the IAM role:
"Action": ["sagemaker:CreateEndpoint", "sagemaker:CreateEndpointConfig"]
"Resource": [
"arn:aws:sagemaker:region:account-id:endpoint/endpointName"
"arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName"
]
For more information, see SageMaker API Permissions: Actions, Permissions, and Resources Reference.
3133 3134 3135 3136 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 3133 def create_endpoint(params = {}, = {}) req = build_request(:create_endpoint, params) req.send_request() end |
#create_endpoint_config(params = {}) ⇒ Types::CreateEndpointConfigOutput
Creates an endpoint configuration that SageMaker hosting services uses
to deploy models. In the configuration, you identify one or more
models, created using the CreateModel
API, to deploy and the
resources that you want SageMaker to provision. Then you call the
CreateEndpoint API.
In the request, you define a ProductionVariant
, for each model that
you want to deploy. Each ProductionVariant
parameter also describes
the resources that you want SageMaker to provision. This includes the
number and type of ML compute instances to deploy.
If you are hosting multiple models, you also assign a VariantWeight
to specify how much traffic you want to allocate to each model. For
example, suppose that you want to host two models, A and B, and you
assign traffic weight 2 for model A and 1 for model B. SageMaker
distributes two-thirds of the traffic to Model A, and one-third to
model B.
Eventually Consistent Reads
,
the response might not reflect the results of a recently completed
write operation. The response might include some stale data. If the
dependent entities are not yet in DynamoDB, this causes a validation
error. If you repeat your read request after a short time, the
response should return the latest data. So retry logic is recommended
to handle these possible issues. We also recommend that customers call
DescribeEndpointConfig before calling CreateEndpoint to
minimize the potential impact of a DynamoDB eventually consistent
read.
3457 3458 3459 3460 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 3457 def create_endpoint_config(params = {}, = {}) req = build_request(:create_endpoint_config, params) req.send_request() end |
#create_experiment(params = {}) ⇒ Types::CreateExperimentResponse
Creates a SageMaker experiment. An experiment is a collection of trials that are observed, compared and evaluated as a group. A trial is a set of steps, called trial components, that produce a machine learning model.
The goal of an experiment is to determine the components that produce the best model. Multiple trials are performed, each one isolating and measuring the impact of a change to one or more inputs, while keeping the remaining inputs constant.
When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.
You can add tags to experiments, trials, trial components and then use the Search API to search for the tags.
To add a description to an experiment, specify the optional
Description
parameter. To add a description later, or to change the
description, call the UpdateExperiment API.
To get a list of all your experiments, call the ListExperiments API. To view an experiment's properties, call the DescribeExperiment API. To get a list of all the trials associated with an experiment, call the ListTrials API. To create a trial call the CreateTrial API.
3550 3551 3552 3553 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 3550 def create_experiment(params = {}, = {}) req = build_request(:create_experiment, params) req.send_request() end |
#create_feature_group(params = {}) ⇒ Types::CreateFeatureGroupResponse
Create a new FeatureGroup
. A FeatureGroup
is a group of Features
defined in the FeatureStore
to describe a Record
.
The FeatureGroup
defines the schema and features contained in the
FeatureGroup
. A FeatureGroup
definition is composed of a list of
Features
, a RecordIdentifierFeatureName
, an EventTimeFeatureName
and configurations for its OnlineStore
and OfflineStore
. Check
Amazon Web Services service quotas to see the FeatureGroup
s
quota for your Amazon Web Services account.
Note that it can take approximately 10-15 minutes to provision an
OnlineStore
FeatureGroup
with the InMemory
StorageType
.
You must include at least one of OnlineStoreConfig
and
OfflineStoreConfig
to create a FeatureGroup
.
3775 3776 3777 3778 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 3775 def create_feature_group(params = {}, = {}) req = build_request(:create_feature_group, params) req.send_request() end |
#create_flow_definition(params = {}) ⇒ Types::CreateFlowDefinitionResponse
Creates a flow definition.
3866 3867 3868 3869 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 3866 def create_flow_definition(params = {}, = {}) req = build_request(:create_flow_definition, params) req.send_request() end |
#create_hub(params = {}) ⇒ Types::CreateHubResponse
Create a hub.
3925 3926 3927 3928 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 3925 def create_hub(params = {}, = {}) req = build_request(:create_hub, params) req.send_request() end |
#create_human_task_ui(params = {}) ⇒ Types::CreateHumanTaskUiResponse
Defines the settings you will use for the human review workflow user interface. Reviewers will see a three-panel interface with an instruction area, the item to review, and an input area.
3972 3973 3974 3975 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 3972 def create_human_task_ui(params = {}, = {}) req = build_request(:create_human_task_ui, params) req.send_request() end |
#create_hyper_parameter_tuning_job(params = {}) ⇒ Types::CreateHyperParameterTuningJobResponse
Starts a hyperparameter tuning job. A hyperparameter tuning job finds the best version of a model by running many training jobs on your dataset using the algorithm you choose and values for hyperparameters within ranges that you specify. It then chooses the hyperparameter values that result in a model that performs the best, as measured by an objective metric that you choose.
A hyperparameter tuning job automatically creates Amazon SageMaker experiments, trials, and trial components for each training job that it runs. You can view these entities in Amazon SageMaker Studio. For more information, see View Experiments, Trials, and Trial Components.
Do not include any security-sensitive information including account access IDs, secrets or tokens in any hyperparameter field. If the use of security-sensitive credentials are detected, SageMaker will reject your training job request and return an exception error.
4469 4470 4471 4472 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 4469 def create_hyper_parameter_tuning_job(params = {}, = {}) req = build_request(:create_hyper_parameter_tuning_job, params) req.send_request() end |
#create_image(params = {}) ⇒ Types::CreateImageResponse
Creates a custom SageMaker image. A SageMaker image is a set of image versions. Each image version represents a container image stored in Amazon ECR. For more information, see Bring your own SageMaker image.
4527 4528 4529 4530 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 4527 def create_image(params = {}, = {}) req = build_request(:create_image, params) req.send_request() end |
#create_image_version(params = {}) ⇒ Types::CreateImageVersionResponse
Creates a version of the SageMaker image specified by ImageName
. The
version represents the Amazon ECR container image specified by
BaseImage
.
4632 4633 4634 4635 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 4632 def create_image_version(params = {}, = {}) req = build_request(:create_image_version, params) req.send_request() end |
#create_inference_component(params = {}) ⇒ Types::CreateInferenceComponentOutput
Creates an inference component, which is a SageMaker hosting object that you can use to deploy a model to an endpoint. In the inference component settings, you specify the model, the endpoint, and how the model utilizes the resources that the endpoint hosts. You can optimize resource utilization by tailoring how the required CPU cores, accelerators, and memory are allocated. You can deploy multiple inference components to an endpoint, where each inference component contains one model and the resource utilization needs for that individual model. After you deploy an inference component, you can directly invoke the associated model when you use the InvokeEndpoint API action.
4726 4727 4728 4729 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 4726 def create_inference_component(params = {}, = {}) req = build_request(:create_inference_component, params) req.send_request() end |
#create_inference_experiment(params = {}) ⇒ Types::CreateInferenceExperimentResponse
Creates an inference experiment using the configurations specified in the request.
Use this API to setup and schedule an experiment to compare model variants on a Amazon SageMaker inference endpoint. For more information about inference experiments, see Shadow tests.
Amazon SageMaker begins your experiment at the scheduled time and routes traffic to your endpoint's model variants based on your specified configuration.
While the experiment is in progress or after it has concluded, you can view metrics that compare your model variants. For more information, see View, monitor, and edit shadow tests.
4925 4926 4927 4928 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 4925 def create_inference_experiment(params = {}, = {}) req = build_request(:create_inference_experiment, params) req.send_request() end |
#create_inference_recommendations_job(params = {}) ⇒ Types::CreateInferenceRecommendationsJobResponse
Starts a recommendation job. You can create either an instance recommendation or load test job.
5088 5089 5090 5091 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 5088 def create_inference_recommendations_job(params = {}, = {}) req = build_request(:create_inference_recommendations_job, params) req.send_request() end |
#create_labeling_job(params = {}) ⇒ Types::CreateLabelingJobResponse
Creates a job that uses workers to label the data objects in your input dataset. You can use the labeled data to train machine learning models.
You can select your workforce from one of three providers:
A private workforce that you create. It can include employees, contractors, and outside experts. Use a private workforce when want the data to stay within your organization or when a specific set of skills is required.
One or more vendors that you select from the Amazon Web Services Marketplace. Vendors provide expertise in specific areas.
The Amazon Mechanical Turk workforce. This is the largest workforce, but it should only be used for public data or data that has been stripped of any personally identifiable information.
You can also use automated data labeling to reduce the number of data objects that need to be labeled by a human. Automated data labeling uses active learning to determine if a data object can be labeled by machine or if it needs to be sent to a human worker. For more information, see Using Automated Data Labeling.
The data objects to be labeled are contained in an Amazon S3 bucket. You create a manifest file that describes the location of each object. For more information, see Using Input and Output Data.
The output can be used as the manifest file for another labeling job or as training data for your machine learning models.
You can use this operation to create a static labeling job or a
streaming labeling job. A static labeling job stops if all data
objects in the input manifest file identified in ManifestS3Uri
have
been labeled. A streaming labeling job runs perpetually until it is
manually stopped, or remains idle for 10 days. You can send new data
objects to an active (InProgress
) streaming labeling job in real
time. To learn how to create a static labeling job, see Create a
Labeling Job (API) in the Amazon SageMaker Developer Guide. To
learn how to create a streaming labeling job, see Create a Streaming
Labeling Job.
5397 5398 5399 5400 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 5397 def create_labeling_job(params = {}, = {}) req = build_request(:create_labeling_job, params) req.send_request() end |
#create_model(params = {}) ⇒ Types::CreateModelOutput
Creates a model in SageMaker. In the request, you name the model and describe a primary container. For the primary container, you specify the Docker image that contains inference code, artifacts (from prior training), and a custom environment map that the inference code uses when you deploy the model for predictions.
Use this API to create a model if you want to use SageMaker hosting services or run a batch transform job.
To host your model, you create an endpoint configuration with the
CreateEndpointConfig
API, and then create an endpoint with the
CreateEndpoint
API. SageMaker then deploys all of the containers
that you defined for the model in the hosting environment.
To run a batch transform using your model, you start a job with the
CreateTransformJob
API. SageMaker uses your model and your dataset
to get inferences which are then saved to a specified S3 location.
In the request, you also provide an IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute hosting instances or for batch transform jobs. In addition, you also use the IAM role to manage permissions the inference code needs. For example, if the inference code access any other Amazon Web Services resources, you grant necessary permissions via this role.
5581 5582 5583 5584 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 5581 def create_model(params = {}, = {}) req = build_request(:create_model, params) req.send_request() end |
#create_model_bias_job_definition(params = {}) ⇒ Types::CreateModelBiasJobDefinitionResponse
Creates the definition for a model bias job.
5738 5739 5740 5741 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 5738 def create_model_bias_job_definition(params = {}, = {}) req = build_request(:create_model_bias_job_definition, params) req.send_request() end |
#create_model_card(params = {}) ⇒ Types::CreateModelCardResponse
Creates an Amazon SageMaker Model Card.
For information about how to use model cards, see Amazon SageMaker Model Card.
5814 5815 5816 5817 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 5814 def create_model_card(params = {}, = {}) req = build_request(:create_model_card, params) req.send_request() end |
#create_model_card_export_job(params = {}) ⇒ Types::CreateModelCardExportJobResponse
Creates an Amazon SageMaker Model Card export job.
5858 5859 5860 5861 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 5858 def create_model_card_export_job(params = {}, = {}) req = build_request(:create_model_card_export_job, params) req.send_request() end |
#create_model_explainability_job_definition(params = {}) ⇒ Types::CreateModelExplainabilityJobDefinitionResponse
Creates the definition for a model explainability job.
6013 6014 6015 6016 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 6013 def create_model_explainability_job_definition(params = {}, = {}) req = build_request(:create_model_explainability_job_definition, params) req.send_request() end |
#create_model_package(params = {}) ⇒ Types::CreateModelPackageOutput
Creates a model package that you can use to create SageMaker models or list on Amazon Web Services Marketplace, or a versioned model that is part of a model group. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.
To create a model package by specifying a Docker container that
contains your inference code and the Amazon S3 location of your model
artifacts, provide values for InferenceSpecification
. To create a
model from an algorithm resource that you created or subscribed to in
Amazon Web Services Marketplace, provide a value for
SourceAlgorithmSpecification
.
Versioned - a model that is part of a model group in the model registry.
Unversioned - a model package that is not part of a model group.
6482 6483 6484 6485 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 6482 def create_model_package(params = {}, = {}) req = build_request(:create_model_package, params) req.send_request() end |
#create_model_package_group(params = {}) ⇒ Types::CreateModelPackageGroupOutput
Creates a model group. A model group contains a group of model versions.
6530 6531 6532 6533 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 6530 def create_model_package_group(params = {}, = {}) req = build_request(:create_model_package_group, params) req.send_request() end |
#create_model_quality_job_definition(params = {}) ⇒ Types::CreateModelQualityJobDefinitionResponse
Creates a definition for a job that monitors model quality and drift. For information about model monitor, see Amazon SageMaker Model Monitor.
6696 6697 6698 6699 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 6696 def create_model_quality_job_definition(params = {}, = {}) req = build_request(:create_model_quality_job_definition, params) req.send_request() end |
#create_monitoring_schedule(params = {}) ⇒ Types::CreateMonitoringScheduleResponse
Creates a schedule that regularly starts Amazon SageMaker Processing Jobs to monitor the data captured for an Amazon SageMaker Endpoint.
6844 6845 6846 6847 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 6844 def create_monitoring_schedule(params = {}, = {}) req = build_request(:create_monitoring_schedule, params) req.send_request() end |
#create_notebook_instance(params = {}) ⇒ Types::CreateNotebookInstanceOutput
Creates an SageMaker notebook instance. A notebook instance is a machine learning (ML) compute instance running on a Jupyter notebook.
In a CreateNotebookInstance
request, specify the type of ML compute
instance that you want to run. SageMaker launches the instance,
installs common libraries that you can use to explore datasets for
model training, and attaches an ML storage volume to the notebook
instance.
SageMaker also provides a set of example notebooks. Each notebook demonstrates how to use SageMaker with a specific algorithm or with a machine learning framework.
After receiving the request, SageMaker does the following:
Creates a network interface in the SageMaker VPC.
(Option) If you specified
SubnetId
, SageMaker creates a network interface in your own VPC, which is inferred from the subnet ID that you provide in the input. When creating this network interface, SageMaker attaches the security group that you specified in the request to the network interface that it creates in your VPC.Launches an EC2 instance of the type specified in the request in the SageMaker VPC. If you specified
SubnetId
of your VPC, SageMaker specifies both network interfaces when launching this instance. This enables inbound traffic from your own VPC to the notebook instance, assuming that the security groups allow it.
After creating the notebook instance, SageMaker returns its Amazon Resource Name (ARN). You can't change the name of a notebook instance after you create it.
After SageMaker creates the notebook instance, you can connect to the Jupyter server and work in Jupyter notebooks. For example, you can write code to explore a dataset that you can use for model training, train a model, host models by creating SageMaker endpoints, and validate hosted models.
For more information, see How It Works.
7070 7071 7072 7073 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 7070 def create_notebook_instance(params = {}, = {}) req = build_request(:create_notebook_instance, params) req.send_request() end |
#create_notebook_instance_lifecycle_config(params = {}) ⇒ Types::CreateNotebookInstanceLifecycleConfigOutput
Creates a lifecycle configuration that you can associate with a notebook instance. A lifecycle configuration is a collection of shell scripts that run when you create or start a notebook instance.
Each lifecycle configuration script has a limit of 16384 characters.
The value of the $PATH
environment variable that is available to
both scripts is /sbin:bin:/usr/sbin:/usr/bin
.
View Amazon CloudWatch Logs for notebook instance lifecycle
configurations in log group /aws/sagemaker/NotebookInstances
in log
stream [notebook-instance-name]/[LifecycleConfigHook]
.
Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started.
For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.
7139 7140 7141 7142 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 7139 def create_notebook_instance_lifecycle_config(params = {}, = {}) req = build_request(:create_notebook_instance_lifecycle_config, params) req.send_request() end |
#create_pipeline(params = {}) ⇒ Types::CreatePipelineResponse
Creates a pipeline using a JSON pipeline definition.
7224 7225 7226 7227 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 7224 def create_pipeline(params = {}, = {}) req = build_request(:create_pipeline, params) req.send_request() end |
#create_presigned_domain_url(params = {}) ⇒ Types::CreatePresignedDomainUrlResponse
Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the user will be automatically signed in to the domain, and granted access to all of the Apps and files associated with the Domain's Amazon Elastic File System volume. This operation can only be called when the authentication mode equals IAM.
The IAM role or user passed to this API defines the permissions to access the app. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the app.
You can restrict access to this API and to the URL that it returns to a list of IP addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more information, see Connect to Amazon SageMaker Studio Through an Interface VPC Endpoint .
CreatePresignedDomainUrl
has a
default timeout of 5 minutes. You can configure this value using
ExpiresInSeconds
. If you try to use the URL after the timeout limit
expires, you are directed to the Amazon Web Services console sign-in
page.
7323 7324 7325 7326 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 7323 def create_presigned_domain_url(params = {}, = {}) req = build_request(:create_presigned_domain_url, params) req.send_request() end |
#create_presigned_notebook_instance_url(params = {}) ⇒ Types::CreatePresignedNotebookInstanceUrlOutput
Returns a URL that you can use to connect to the Jupyter server from a
notebook instance. In the SageMaker console, when you choose Open
next to a notebook instance, SageMaker opens a new tab showing the
Jupyter server home page from the notebook instance. The console uses
this API to get the URL and show the page.
The IAM role or user used to call this API defines the permissions to access the notebook instance. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the notebook instance.
You can restrict access to this API and to the URL that it returns to
a list of IP addresses that you specify. Use the NotIpAddress
condition operator and the aws:SourceIP
condition context key to
specify the list of IP addresses that you want to have access to the
notebook instance. For more information, see Limit Access to a
Notebook Instance by IP Address.
7385 7386 7387 7388 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 7385 def create_presigned_notebook_instance_url(params = {}, = {}) req = build_request(:create_presigned_notebook_instance_url, params) req.send_request() end |
#create_processing_job(params = {}) ⇒ Types::CreateProcessingJobResponse
Creates a processing job.
7569 7570 7571 7572 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 7569 def create_processing_job(params = {}, = {}) req = build_request(:create_processing_job, params) req.send_request() end |
#create_project(params = {}) ⇒ Types::CreateProjectOutput
Creates a machine learning (ML) project that can contain one or more templates that set up an ML pipeline from training to deploying an approved model.
7643 7644 7645 7646 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 7643 def create_project(params = {}, = {}) req = build_request(:create_project, params) req.send_request() end |
#create_space(params = {}) ⇒ Types::CreateSpaceResponse
Creates a private space or a space used for real time collaboration in a domain.
7776 7777 7778 7779 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 7776 def create_space(params = {}, = {}) req = build_request(:create_space, params) req.send_request() end |
#create_studio_lifecycle_config(params = {}) ⇒ Types::CreateStudioLifecycleConfigResponse
Creates a new Amazon SageMaker Studio Lifecycle Configuration.
7825 7826 7827 7828 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 7825 def create_studio_lifecycle_config(params = {}, = {}) req = build_request(:create_studio_lifecycle_config, params) req.send_request() end |
#create_training_job(params = {}) ⇒ Types::CreateTrainingJobResponse
Starts a model training job. After training completes, SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify.
If you choose to host your model using SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a machine learning service other than SageMaker, provided that you know how to use them for inference.
In the request body, you provide the following:
AlgorithmSpecification
- Identifies the training algorithm to use.HyperParameters
- Specify these algorithm-specific parameters to enable the estimation of model parameters during training. Hyperparameters can be tuned to optimize this learning process. For a list of hyperparameters for each training algorithm provided by SageMaker, see Algorithms.Do not include any security-sensitive information including account access IDs, secrets or tokens in any hyperparameter field. If the use of security-sensitive credentials are detected, SageMaker will reject your training job request and return an exception error.
InputDataConfig
- Describes the input required by the training job and the Amazon S3, EFS, or FSx location where it is stored.OutputDataConfig
- Identifies the Amazon S3 bucket where you want SageMaker to save the results of model training.ResourceConfig
- Identifies the resources, ML compute instances, and ML storage volumes to deploy for model training. In distributed training, you specify more than one instance.EnableManagedSpotTraining
- Optimize the cost of training machine learning models by up to 80% by using Amazon EC2 Spot instances. For more information, see Managed Spot Training.RoleArn
- The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during model training. You must grant this role the necessary permissions so that SageMaker can successfully complete model training.StoppingCondition
- To help cap training costs, useMaxRuntimeInSeconds
to set a time limit for training. UseMaxWaitTimeInSeconds
to specify how long a managed spot training job has to complete.Environment
- The environment variables to set in the Docker container.RetryStrategy
- The number of times to retry the job when the job fails due to anInternalServerError
.
For more information about SageMaker, see How It Works.
8306 8307 8308 8309 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 8306 def create_training_job(params = {}, = {}) req = build_request(:create_training_job, params) req.send_request() end |
#create_transform_job(params = {}) ⇒ Types::CreateTransformJobResponse
Starts a transform job. A transform job uses a trained model to get inferences on a dataset and saves these results to an Amazon S3 location that you specify.
To perform batch transformations, you create a transform job and use the data that you have readily available.
In the request body, you provide the following:
TransformJobName
- Identifies the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.ModelName
- Identifies the model to use.ModelName
must be the name of an existing Amazon SageMaker model in the same Amazon Web Services Region and Amazon Web Services account. For information on creating a model, see CreateModel.TransformInput
- Describes the dataset to be transformed and the Amazon S3 location where it is stored.TransformOutput
- Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.TransformResources
- Identifies the ML compute instances for the transform job.
For more information about how batch transformation works, see Batch Transform.
8539 8540 8541 8542 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 8539 def create_transform_job(params = {}, = {}) req = build_request(:create_transform_job, params) req.send_request() end |
#create_trial(params = {}) ⇒ Types::CreateTrialResponse
Creates an SageMaker trial. A trial is a set of steps called trial components that produce a machine learning model. A trial is part of a single SageMaker experiment.
When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.
You can add tags to a trial and then use the Search API to search for the tags.
To get a list of all your trials, call the ListTrials API. To view a trial's properties, call the DescribeTrial API. To create a trial component, call the CreateTrialComponent API.
8621 8622 8623 8624 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 8621 def create_trial(params = {}, = {}) req = build_request(:create_trial, params) req.send_request() end |
#create_trial_component(params = {}) ⇒ Types::CreateTrialComponentResponse
Creates a trial component, which is a stage of a machine learning trial. A trial is composed of one or more trial components. A trial component can be used in multiple trials.
Trial components include pre-processing jobs, training jobs, and batch transform jobs.
When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.
You can add tags to a trial component and then use the Search API to search for the tags.
8747 8748 8749 8750 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 8747 def create_trial_component(params = {}, = {}) req = build_request(:create_trial_component, params) req.send_request() end |
#create_user_profile(params = {}) ⇒ Types::CreateUserProfileResponse
Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a "person" for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to a domain. If an administrator invites a person by email or imports them from IAM Identity Center, a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user's private Amazon Elastic File System home directory.
8978 8979 8980 8981 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 8978 def create_user_profile(params = {}, = {}) req = build_request(:create_user_profile, params) req.send_request() end |
#create_workforce(params = {}) ⇒ Types::CreateWorkforceResponse
Use this operation to create a workforce. This operation will return an error if a workforce already exists in the Amazon Web Services Region that you specify. You can only create one workforce in each Amazon Web Services Region per Amazon Web Services account.
If you want to create a new workforce in an Amazon Web Services Region
where a workforce already exists, use the DeleteWorkforce API
operation to delete the existing workforce and then use
CreateWorkforce
to create a new workforce.
To create a private workforce using Amazon Cognito, you must specify a
Cognito user pool in CognitoConfig
. You can also create an Amazon
Cognito workforce using the Amazon SageMaker console. For more
information, see Create a Private Workforce (Amazon Cognito).
To create a private workforce using your own OIDC Identity Provider
(IdP), specify your IdP configuration in OidcConfig
. Your OIDC IdP
must support groups because groups are used by Ground Truth and
Amazon A2I to create work teams. For more information, see Create a
Private Workforce (OIDC IdP).
9094 9095 9096 9097 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 9094 def create_workforce(params = {}, = {}) req = build_request(:create_workforce, params) req.send_request() end |
#create_workteam(params = {}) ⇒ Types::CreateWorkteamResponse
Creates a new work team for labeling your data. A work team is defined by one or more Amazon Cognito user pools. You must first create the user pools before you can create a work team.
You cannot create more than 25 work teams in an account and region.
9211 9212 9213 9214 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 9211 def create_workteam(params = {}, = {}) req = build_request(:create_workteam, params) req.send_request() end |
#delete_action(params = {}) ⇒ Types::DeleteActionResponse
Deletes an action.
9239 9240 9241 9242 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 9239 def delete_action(params = {}, = {}) req = build_request(:delete_action, params) req.send_request() end |
#delete_algorithm(params = {}) ⇒ Struct
Removes the specified algorithm from your account.
9261 9262 9263 9264 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 9261 def delete_algorithm(params = {}, = {}) req = build_request(:delete_algorithm, params) req.send_request() end |
#delete_app(params = {}) ⇒ Struct
Used to stop and delete an app.
9301 9302 9303 9304 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 9301 def delete_app(params = {}, = {}) req = build_request(:delete_app, params) req.send_request() end |
#delete_app_image_config(params = {}) ⇒ Struct
Deletes an AppImageConfig.
9323 9324 9325 9326 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 9323 def delete_app_image_config(params = {}, = {}) req = build_request(:delete_app_image_config, params) req.send_request() end |
#delete_artifact(params = {}) ⇒ Types::DeleteArtifactResponse
Deletes an artifact. Either ArtifactArn
or Source
must be
specified.
9364 9365 9366 9367 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 9364 def delete_artifact(params = {}, = {}) req = build_request(:delete_artifact, params) req.send_request() end |
#delete_association(params = {}) ⇒ Types::DeleteAssociationResponse
Deletes an association.
9398 9399 9400 9401 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 9398 def delete_association(params = {}, = {}) req = build_request(:delete_association, params) req.send_request() end |
#delete_cluster(params = {}) ⇒ Types::DeleteClusterResponse
Delete a SageMaker HyperPod cluster.
9427 9428 9429 9430 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 9427 def delete_cluster(params = {}, = {}) req = build_request(:delete_cluster, params) req.send_request() end |
#delete_code_repository(params = {}) ⇒ Struct
Deletes the specified Git repository from your account.
9449 9450 9451 9452 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 9449 def delete_code_repository(params = {}, = {}) req = build_request(:delete_code_repository, params) req.send_request() end |
#delete_compilation_job(params = {}) ⇒ Struct
Deletes the specified compilation job. This action deletes only the compilation job resource in Amazon SageMaker. It doesn't delete other resources that are related to that job, such as the model artifacts that the job creates, the compilation logs in CloudWatch, the compiled model, or the IAM role.
You can delete a compilation job only if its current status is
COMPLETED
, FAILED
, or STOPPED
. If the job status is STARTING
or INPROGRESS
, stop the job, and then delete it after its status
becomes STOPPED
.
9480 9481 9482 9483 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 9480 def delete_compilation_job(params = {}, = {}) req = build_request(:delete_compilation_job, params) req.send_request() end |
#delete_context(params = {}) ⇒ Types::DeleteContextResponse
Deletes an context.
9508 9509 9510 9511 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 9508 def delete_context(params = {}, = {}) req = build_request(:delete_context, params) req.send_request() end |
#delete_data_quality_job_definition(params = {}) ⇒ Struct
Deletes a data quality monitoring job definition.
9530 9531 9532 9533 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 9530 def delete_data_quality_job_definition(params = {}, = {}) req = build_request(:delete_data_quality_job_definition, params) req.send_request() end |
#delete_device_fleet(params = {}) ⇒ Struct
Deletes a fleet.
9552 9553 9554 9555 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 9552 def delete_device_fleet(params = {}, = {}) req = build_request(:delete_device_fleet, params) req.send_request() end |
#delete_domain(params = {}) ⇒ Struct
Used to delete a domain. If you onboarded with IAM mode, you will need to delete your domain to onboard again using IAM Identity Center. Use with caution. All of the members of the domain will lose access to their EFS volume, including data, notebooks, and other artifacts.
9585 9586 9587 9588 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 9585 def delete_domain(params = {}, = {}) req = build_request(:delete_domain, params) req.send_request() end |
#delete_edge_deployment_plan(params = {}) ⇒ Struct
Deletes an edge deployment plan if (and only if) all the stages in the plan are inactive or there are no stages in the plan.
9608 9609 9610 9611 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 9608 def delete_edge_deployment_plan(params = {}, = {}) req = build_request(:delete_edge_deployment_plan, params) req.send_request() end |
#delete_edge_deployment_stage(params = {}) ⇒ Struct
Delete a stage in an edge deployment plan if (and only if) the stage is inactive.
9636 9637 9638 9639 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 9636 def delete_edge_deployment_stage(params = {}, = {}) req = build_request(:delete_edge_deployment_stage, params) req.send_request() end |
#delete_endpoint(params = {}) ⇒ Struct
Deletes an endpoint. SageMaker frees up all of the resources that were deployed when the endpoint was created.
SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't need to use the RevokeGrant API call.
When you delete your endpoint, SageMaker asynchronously deletes
associated endpoint resources such as KMS key grants. You might still
see these resources in your account for a few minutes after deleting
your endpoint. Do not delete or revoke the permissions for your
ExecutionRoleArn
, otherwise SageMaker cannot delete these resources.
9673 9674 9675 9676 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 9673 def delete_endpoint(params = {}, = {}) req = build_request(:delete_endpoint, params) req.send_request() end |
#delete_endpoint_config(params = {}) ⇒ Struct
Deletes an endpoint configuration. The DeleteEndpointConfig
API
deletes only the specified configuration. It does not delete endpoints
created using the configuration.
You must not delete an EndpointConfig
in use by an endpoint that is
live or while the UpdateEndpoint
or CreateEndpoint
operations are
being performed on the endpoint. If you delete the EndpointConfig
of
an endpoint that is active or being created or updated you may lose
visibility into the instance type the endpoint is using. The endpoint
must be deleted in order to stop incurring charges.
9704 9705 9706 9707 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 9704 def delete_endpoint_config(params = {}, = {}) req = build_request(:delete_endpoint_config, params) req.send_request() end |
#delete_experiment(params = {}) ⇒ Types::DeleteExperimentResponse
Deletes an SageMaker experiment. All trials associated with the experiment must be deleted first. Use the ListTrials API to get a list of the trials associated with the experiment.
9738 9739 9740 9741 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 9738 def delete_experiment(params = {}, = {}) req = build_request(:delete_experiment, params) req.send_request() end |
#delete_feature_group(params = {}) ⇒ Struct
Delete the FeatureGroup
and any data that was written to the
OnlineStore
of the FeatureGroup
. Data cannot be accessed from the
OnlineStore
immediately after DeleteFeatureGroup
is called.
Data written into the OfflineStore
will not be deleted. The Amazon
Web Services Glue database and tables that are automatically created
for your OfflineStore
are not deleted.
Note that it can take approximately 10-15 minutes to delete an
OnlineStore
FeatureGroup
with the InMemory
StorageType
.
9771 9772 9773 9774 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 9771 def delete_feature_group(params = {}, = {}) req = build_request(:delete_feature_group, params) req.send_request() end |
#delete_flow_definition(params = {}) ⇒ Struct
Deletes the specified flow definition.
9793 9794 9795 9796 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 9793 def delete_flow_definition(params = {}, = {}) req = build_request(:delete_flow_definition, params) req.send_request() end |
#delete_hub(params = {}) ⇒ Struct
Delete a hub.
9819 9820 9821 9822 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 9819 def delete_hub(params = {}, = {}) req = build_request(:delete_hub, params) req.send_request() end |
#delete_hub_content(params = {}) ⇒ Struct
Delete the contents of a hub.
9857 9858 9859 9860 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 9857 def delete_hub_content(params = {}, = {}) req = build_request(:delete_hub_content, params) req.send_request() end |
#delete_human_task_ui(params = {}) ⇒ Struct
Use this operation to delete a human task user interface (worker task template).
To see a list of human task user interfaces (work task templates) in
your account, use ListHumanTaskUis. When you delete a worker task
template, it no longer appears when you call ListHumanTaskUis
.
9889 9890 9891 9892 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 9889 def delete_human_task_ui(params = {}, = {}) req = build_request(:delete_human_task_ui, params) req.send_request() end |
#delete_hyper_parameter_tuning_job(params = {}) ⇒ Struct
Deletes a hyperparameter tuning job. The
DeleteHyperParameterTuningJob
API deletes only the tuning job entry
that was created in SageMaker when you called the
CreateHyperParameterTuningJob
API. It does not delete training jobs,
artifacts, or the IAM role that you specified when creating the model.
9915 9916 9917 9918 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 9915 def delete_hyper_parameter_tuning_job(params = {}, = {}) req = build_request(:delete_hyper_parameter_tuning_job, params) req.send_request() end |
#delete_image(params = {}) ⇒ Struct
Deletes a SageMaker image and all versions of the image. The container images aren't deleted.
9938 9939 9940 9941 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 9938 def delete_image(params = {}, = {}) req = build_request(:delete_image, params) req.send_request() end |
#delete_image_version(params = {}) ⇒ Struct
Deletes a version of a SageMaker image. The container image the version represents isn't deleted.
9969 9970 9971 9972 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 9969 def delete_image_version(params = {}, = {}) req = build_request(:delete_image_version, params) req.send_request() end |
#delete_inference_component(params = {}) ⇒ Struct
Deletes an inference component.
9991 9992 9993 9994 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 9991 def delete_inference_component(params = {}, = {}) req = build_request(:delete_inference_component, params) req.send_request() end |
#delete_inference_experiment(params = {}) ⇒ Types::DeleteInferenceExperimentResponse
Deletes an inference experiment.
10025 10026 10027 10028 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 10025 def delete_inference_experiment(params = {}, = {}) req = build_request(:delete_inference_experiment, params) req.send_request() end |
#delete_model(params = {}) ⇒ Struct
Deletes a model. The DeleteModel
API deletes only the model entry
that was created in SageMaker when you called the CreateModel
API.
It does not delete model artifacts, inference code, or the IAM role
that you specified when creating the model.
10050 10051 10052 10053 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 10050 def delete_model(params = {}, = {}) req = build_request(:delete_model, params) req.send_request() end |
#delete_model_bias_job_definition(params = {}) ⇒ Struct
Deletes an Amazon SageMaker model bias job definition.
10072 10073 10074 10075 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 10072 def delete_model_bias_job_definition(params = {}, = {}) req = build_request(:delete_model_bias_job_definition, params) req.send_request() end |
#delete_model_card(params = {}) ⇒ Struct
Deletes an Amazon SageMaker Model Card.
10094 10095 10096 10097 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 10094 def delete_model_card(params = {}, = {}) req = build_request(:delete_model_card, params) req.send_request() end |
#delete_model_explainability_job_definition(params = {}) ⇒ Struct
Deletes an Amazon SageMaker model explainability job definition.
10116 10117 10118 10119 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 10116 def delete_model_explainability_job_definition(params = {}, = {}) req = build_request(:delete_model_explainability_job_definition, params) req.send_request() end |
#delete_model_package(params = {}) ⇒ Struct
Deletes a model package.
A model package is used to create SageMaker models or list on Amazon Web Services Marketplace. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.
10146 10147 10148 10149 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 10146 def delete_model_package(params = {}, = {}) req = build_request(:delete_model_package, params) req.send_request() end |
#delete_model_package_group(params = {}) ⇒ Struct
Deletes the specified model group.
10168 10169 10170 10171 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 10168 def delete_model_package_group(params = {}, = {}) req = build_request(:delete_model_package_group, params) req.send_request() end |
#delete_model_package_group_policy(params = {}) ⇒ Struct
Deletes a model group resource policy.
10190 10191 10192 10193 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 10190 def delete_model_package_group_policy(params = {}, = {}) req = build_request(:delete_model_package_group_policy, params) req.send_request() end |
#delete_model_quality_job_definition(params = {}) ⇒ Struct
Deletes the secified model quality monitoring job definition.
10212 10213 10214 10215 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 10212 def delete_model_quality_job_definition(params = {}, = {}) req = build_request(:delete_model_quality_job_definition, params) req.send_request() end |
#delete_monitoring_schedule(params = {}) ⇒ Struct
Deletes a monitoring schedule. Also stops the schedule had not already been stopped. This does not delete the job execution history of the monitoring schedule.
10236 10237 10238 10239 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 10236 def delete_monitoring_schedule(params = {}, = {}) req = build_request(:delete_monitoring_schedule, params) req.send_request() end |
#delete_notebook_instance(params = {}) ⇒ Struct
Deletes an SageMaker notebook instance. Before you can delete a
notebook instance, you must call the StopNotebookInstance
API.
When you delete a notebook instance, you lose all of your data. SageMaker removes the ML compute instance, and deletes the ML storage volume and the network interface associated with the notebook instance.
10264 10265 10266 10267 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 10264 def delete_notebook_instance(params = {}, = {}) req = build_request(:delete_notebook_instance, params) req.send_request() end |
#delete_notebook_instance_lifecycle_config(params = {}) ⇒ Struct
Deletes a notebook instance lifecycle configuration.
10286 10287 10288 10289 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 10286 def delete_notebook_instance_lifecycle_config(params = {}, = {}) req = build_request(:delete_notebook_instance_lifecycle_config, params) req.send_request() end |
#delete_pipeline(params = {}) ⇒ Types::DeletePipelineResponse
Deletes a pipeline if there are no running instances of the pipeline.
To delete a pipeline, you must stop all running instances of the
pipeline using the StopPipelineExecution
API. When you delete a
pipeline, all instances of the pipeline are deleted.
10326 10327 10328 10329 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 10326 def delete_pipeline(params = {}, = {}) req = build_request(:delete_pipeline, params) req.send_request() end |
#delete_project(params = {}) ⇒ Struct
Delete the specified project.
10348 10349 10350 10351 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 10348 def delete_project(params = {}, = {}) req = build_request(:delete_project, params) req.send_request() end |
#delete_space(params = {}) ⇒ Struct
Used to delete a space.
10374 10375 10376 10377 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 10374 def delete_space(params = {}, = {}) req = build_request(:delete_space, params) req.send_request() end |
#delete_studio_lifecycle_config(params = {}) ⇒ Struct
Deletes the Amazon SageMaker Studio Lifecycle Configuration. In order to delete the Lifecycle Configuration, there must be no running apps using the Lifecycle Configuration. You must also remove the Lifecycle Configuration from UserSettings in all Domains and UserProfiles.
10400 10401 10402 10403 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 10400 def delete_studio_lifecycle_config(params = {}, = {}) req = build_request(:delete_studio_lifecycle_config, params) req.send_request() end |
#delete_tags(params = {}) ⇒ Struct
Deletes the specified tags from an SageMaker resource.
To list a resource's tags, use the ListTags
API.
10441 10442 10443 10444 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 10441 def (params = {}, = {}) req = build_request(:delete_tags, params) req.send_request() end |
#delete_trial(params = {}) ⇒ Types::DeleteTrialResponse
Deletes the specified trial. All trial components that make up the trial must be deleted first. Use the DescribeTrialComponent API to get the list of trial components.
10475 10476 10477 10478 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 10475 def delete_trial(params = {}, = {}) req = build_request(:delete_trial, params) req.send_request() end |
#delete_trial_component(params = {}) ⇒ Types::DeleteTrialComponentResponse
Deletes the specified trial component. A trial component must be disassociated from all trials before the trial component can be deleted. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.
10510 10511 10512 10513 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 10510 def delete_trial_component(params = {}, = {}) req = build_request(:delete_trial_component, params) req.send_request() end |
#delete_user_profile(params = {}) ⇒ Struct
Deletes a user profile. When a user profile is deleted, the user loses access to their EFS volume, including data, notebooks, and other artifacts.
10538 10539 10540 10541 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 10538 def delete_user_profile(params = {}, = {}) req = build_request(:delete_user_profile, params) req.send_request() end |
#delete_workforce(params = {}) ⇒ Struct
Use this operation to delete a workforce.
If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use this operation to delete the existing workforce and then use CreateWorkforce to create a new workforce.
If a private workforce contains one or more work teams, you must use
the DeleteWorkteam operation to delete all work teams before you
delete the workforce. If you try to delete a workforce that contains
one or more work teams, you will recieve a ResourceInUse
error.
10575 10576 10577 10578 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 10575 def delete_workforce(params = {}, = {}) req = build_request(:delete_workforce, params) req.send_request() end |
#delete_workteam(params = {}) ⇒ Types::DeleteWorkteamResponse
Deletes an existing work team. This operation can't be undone.
10603 10604 10605 10606 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 10603 def delete_workteam(params = {}, = {}) req = build_request(:delete_workteam, params) req.send_request() end |
#deregister_devices(params = {}) ⇒ Struct
Deregisters the specified devices. After you deregister a device, you will need to re-register the devices.
10630 10631 10632 10633 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 10630 def deregister_devices(params = {}, = {}) req = build_request(:deregister_devices, params) req.send_request() end |
#describe_action(params = {}) ⇒ Types::DescribeActionResponse
Describes an action.
10698 10699 10700 10701 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 10698 def describe_action(params = {}, = {}) req = build_request(:describe_action, params) req.send_request() end |
#describe_algorithm(params = {}) ⇒ Types::DescribeAlgorithmOutput
Returns a description of the specified algorithm that is in your account.
10871 10872 10873 10874 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 10871 def describe_algorithm(params = {}, = {}) req = build_request(:describe_algorithm, params) req.send_request() end |
#describe_app(params = {}) ⇒ Types::DescribeAppResponse
Describes the app.
10942 10943 10944 10945 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 10942 def describe_app(params = {}, = {}) req = build_request(:describe_app, params) req.send_request() end |
#describe_app_image_config(params = {}) ⇒ Types::DescribeAppImageConfigResponse
Describes an AppImageConfig.
11003 11004 11005 11006 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 11003 def describe_app_image_config(params = {}, = {}) req = build_request(:describe_app_image_config, params) req.send_request() end |
#describe_artifact(params = {}) ⇒ Types::DescribeArtifactResponse
Describes an artifact.
11068 11069 11070 11071 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 11068 def describe_artifact(params = {}, = {}) req = build_request(:describe_artifact, params) req.send_request() end |
#describe_auto_ml_job(params = {}) ⇒ Types::DescribeAutoMLJobResponse
Returns information about an AutoML job created by calling CreateAutoMLJob.
DescribeAutoMLJob
.
11209 11210 11211 11212 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 11209 def describe_auto_ml_job(params = {}, = {}) req = build_request(:describe_auto_ml_job, params) req.send_request() end |
#describe_auto_ml_job_v2(params = {}) ⇒ Types::DescribeAutoMLJobV2Response
Returns information about an AutoML job created by calling CreateAutoMLJobV2 or CreateAutoMLJob.
11386 11387 11388 11389 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 11386 def describe_auto_ml_job_v2(params = {}, = {}) req = build_request(:describe_auto_ml_job_v2, params) req.send_request() end |
#describe_cluster(params = {}) ⇒ Types::DescribeClusterResponse
Retrieves information of a SageMaker HyperPod cluster.
11438 11439 11440 11441 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 11438 def describe_cluster(params = {}, = {}) req = build_request(:describe_cluster, params) req.send_request() end |
#describe_cluster_node(params = {}) ⇒ Types::DescribeClusterNodeResponse
Retrieves information of an instance (also called a node interchangeably) of a SageMaker HyperPod cluster.
11480 11481 11482 11483 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 11480 def describe_cluster_node(params = {}, = {}) req = build_request(:describe_cluster_node, params) req.send_request() end |
#describe_code_repository(params = {}) ⇒ Types::DescribeCodeRepositoryOutput
Gets details about the specified Git repository.
11518 11519 11520 11521 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 11518 def describe_code_repository(params = {}, = {}) req = build_request(:describe_code_repository, params) req.send_request() end |
#describe_compilation_job(params = {}) ⇒ Types::DescribeCompilationJobResponse
Returns information about a model compilation job.
To create a model compilation job, use CreateCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.
11603 11604 11605 11606 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 11603 def describe_compilation_job(params = {}, = {}) req = build_request(:describe_compilation_job, params) req.send_request() end |
#describe_context(params = {}) ⇒ Types::DescribeContextResponse
Describes a context.
11664 11665 11666 11667 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 11664 def describe_context(params = {}, = {}) req = build_request(:describe_context, params) req.send_request() end |
#describe_data_quality_job_definition(params = {}) ⇒ Types::DescribeDataQualityJobDefinitionResponse
Gets the details of a data quality monitoring job definition.
11757 11758 11759 11760 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 11757 def describe_data_quality_job_definition(params = {}, = {}) req = build_request(:describe_data_quality_job_definition, params) req.send_request() end |
#describe_device(params = {}) ⇒ Types::DescribeDeviceResponse
Describes the device.
11817 11818 11819 11820 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 11817 def describe_device(params = {}, = {}) req = build_request(:describe_device, params) req.send_request() end |
#describe_device_fleet(params = {}) ⇒ Types::DescribeDeviceFleetResponse
A description of the fleet the device belongs to.
11862 11863 11864 11865 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 11862 def describe_device_fleet(params = {}, = {}) req = build_request(:describe_device_fleet, params) req.send_request() end |
#describe_domain(params = {}) ⇒ Types::DescribeDomainResponse
The description of the domain.
12075 12076 12077 12078 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 12075 def describe_domain(params = {}, = {}) req = build_request(:describe_domain, params) req.send_request() end |
#describe_edge_deployment_plan(params = {}) ⇒ Types::DescribeEdgeDeploymentPlanResponse
Describes an edge deployment plan with deployment status per stage.
12147 12148 12149 12150 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 12147 def describe_edge_deployment_plan(params = {}, = {}) req = build_request(:describe_edge_deployment_plan, params) req.send_request() end |
#describe_edge_packaging_job(params = {}) ⇒ Types::DescribeEdgePackagingJobResponse
A description of edge packaging jobs.
12209 12210 12211 12212 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 12209 def describe_edge_packaging_job(params = {}, = {}) req = build_request(:describe_edge_packaging_job, params) req.send_request() end |
#describe_endpoint(params = {}) ⇒ Types::DescribeEndpointOutput
Returns the description of an endpoint.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- endpoint_deleted
- endpoint_in_service
12416 12417 12418 12419 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 12416 def describe_endpoint(params = {}, = {}) req = build_request(:describe_endpoint, params) req.send_request() end |
#describe_endpoint_config(params = {}) ⇒ Types::DescribeEndpointConfigOutput
Returns the description of an endpoint configuration created using the
CreateEndpointConfig
API.
12546 12547 12548 12549 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 12546 def describe_endpoint_config(params = {}, = {}) req = build_request(:describe_endpoint_config, params) req.send_request() end |
#describe_experiment(params = {}) ⇒ Types::DescribeExperimentResponse
Provides a list of an experiment's properties.
12601 12602 12603 12604 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 12601 def describe_experiment(params = {}, = {}) req = build_request(:describe_experiment, params) req.send_request() end |
#describe_feature_group(params = {}) ⇒ Types::DescribeFeatureGroupResponse
Use this operation to describe a FeatureGroup
. The response includes
information on the creation time, FeatureGroup
name, the unique
identifier for each FeatureGroup
, and more.
12690 12691 12692 12693 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 12690 def describe_feature_group(params = {}, = {}) req = build_request(:describe_feature_group, params) req.send_request() end |
#describe_feature_metadata(params = {}) ⇒ Types::DescribeFeatureMetadataResponse
Shows the metadata for a feature within a feature group.
12739 12740 12741 12742 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 12739 def (params = {}, = {}) req = build_request(:describe_feature_metadata, params) req.send_request() end |
#describe_flow_definition(params = {}) ⇒ Types::DescribeFlowDefinitionResponse
Returns information about the specified flow definition.
12797 12798 12799 12800 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 12797 def describe_flow_definition(params = {}, = {}) req = build_request(:describe_flow_definition, params) req.send_request() end |
#describe_hub(params = {}) ⇒ Types::DescribeHubResponse
Describe a hub.
12848 12849 12850 12851 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 12848 def describe_hub(params = {}, = {}) req = build_request(:describe_hub, params) req.send_request() end |
#describe_hub_content(params = {}) ⇒ Types::DescribeHubContentResponse
Describe the content of a hub.
12925 12926 12927 12928 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 12925 def describe_hub_content(params = {}, = {}) req = build_request(:describe_hub_content, params) req.send_request() end |
#describe_human_task_ui(params = {}) ⇒ Types::DescribeHumanTaskUiResponse
Returns information about the requested human task user interface (worker task template).
12964 12965 12966 12967 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 12964 def describe_human_task_ui(params = {}, = {}) req = build_request(:describe_human_task_ui, params) req.send_request() end |
#describe_hyper_parameter_tuning_job(params = {}) ⇒ Types::DescribeHyperParameterTuningJobResponse
Returns a description of a hyperparameter tuning job, depending on the fields selected. These fields can include the name, Amazon Resource Name (ARN), job status of your tuning job and more.
13259 13260 13261 13262 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 13259 def describe_hyper_parameter_tuning_job(params = {}, = {}) req = build_request(:describe_hyper_parameter_tuning_job, params) req.send_request() end |
#describe_image(params = {}) ⇒ Types::DescribeImageResponse
Describes a SageMaker image.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- image_created
- image_deleted
- image_updated
13310 13311 13312 13313 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 13310 def describe_image(params = {}, = {}) req = build_request(:describe_image, params) req.send_request() end |
#describe_image_version(params = {}) ⇒ Types::DescribeImageVersionResponse
Describes a version of a SageMaker image.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- image_version_created
- image_version_deleted
13383 13384 13385 13386 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 13383 def describe_image_version(params = {}, = {}) req = build_request(:describe_image_version, params) req.send_request() end |
#describe_inference_component(params = {}) ⇒ Types::DescribeInferenceComponentOutput
Returns information about an inference component.
13444 13445 13446 13447 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 13444 def describe_inference_component(params = {}, = {}) req = build_request(:describe_inference_component, params) req.send_request() end |
#describe_inference_experiment(params = {}) ⇒ Types::DescribeInferenceExperimentResponse
Returns details about an inference experiment.
13520 13521 13522 13523 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 13520 def describe_inference_experiment(params = {}, = {}) req = build_request(:describe_inference_experiment, params) req.send_request() end |
#describe_inference_recommendations_job(params = {}) ⇒ Types::DescribeInferenceRecommendationsJobResponse
Provides the results of the Inference Recommender job. One or more recommendation jobs are returned.
13649 13650 13651 13652 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 13649 def describe_inference_recommendations_job(params = {}, = {}) req = build_request(:describe_inference_recommendations_job, params) req.send_request() end |
#describe_labeling_job(params = {}) ⇒ Types::DescribeLabelingJobResponse
Gets information about a labeling job.
13745 13746 13747 13748 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 13745 def describe_labeling_job(params = {}, = {}) req = build_request(:describe_labeling_job, params) req.send_request() end |
#describe_lineage_group(params = {}) ⇒ Types::DescribeLineageGroupResponse
Provides a list of properties for the requested lineage group. For more information, see Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.
13803 13804 13805 13806 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 13803 def describe_lineage_group(params = {}, = {}) req = build_request(:describe_lineage_group, params) req.send_request() end |
#describe_model(params = {}) ⇒ Types::DescribeModelOutput
Describes a model that you created using the CreateModel
API.
13886 13887 13888 13889 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 13886 def describe_model(params = {}, = {}) req = build_request(:describe_model, params) req.send_request() end |
#describe_model_bias_job_definition(params = {}) ⇒ Types::DescribeModelBiasJobDefinitionResponse
Returns a description of a model bias job definition.
13976 13977 13978 13979 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 13976 def describe_model_bias_job_definition(params = {}, = {}) req = build_request(:describe_model_bias_job_definition, params) req.send_request() end |
#describe_model_card(params = {}) ⇒ Types::DescribeModelCardResponse
Describes the content, creation time, and security configuration of an Amazon SageMaker Model Card.
14040 14041 14042 14043 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 14040 def describe_model_card(params = {}, = {}) req = build_request(:describe_model_card, params) req.send_request() end |
#describe_model_card_export_job(params = {}) ⇒ Types::DescribeModelCardExportJobResponse
Describes an Amazon SageMaker Model Card export job.
14087 14088 14089 14090 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 14087 def describe_model_card_export_job(params = {}, = {}) req = build_request(:describe_model_card_export_job, params) req.send_request() end |
#describe_model_explainability_job_definition(params = {}) ⇒ Types::DescribeModelExplainabilityJobDefinitionResponse
Returns a description of a model explainability job definition.
14176 14177 14178 14179 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 14176 def describe_model_explainability_job_definition(params = {}, = {}) req = build_request(:describe_model_explainability_job_definition, params) req.send_request() end |
#describe_model_package(params = {}) ⇒ Types::DescribeModelPackageOutput
Returns a description of the specified model package, which is used to create SageMaker models or list them on Amazon Web Services Marketplace.
If you provided a KMS Key ID when you created your model package, you will see the KMS Decrypt API call in your CloudTrail logs when you use this API.
To create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services Marketplace.
14428 14429 14430 14431 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 14428 def describe_model_package(params = {}, = {}) req = build_request(:describe_model_package, params) req.send_request() end |
#describe_model_package_group(params = {}) ⇒ Types::DescribeModelPackageGroupOutput
Gets a description for the specified model group.
14471 14472 14473 14474 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 14471 def describe_model_package_group(params = {}, = {}) req = build_request(:describe_model_package_group, params) req.send_request() end |
#describe_model_quality_job_definition(params = {}) ⇒ Types::DescribeModelQualityJobDefinitionResponse
Returns a description of a model quality job definition.
14566 14567 14568 14569 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 14566 def describe_model_quality_job_definition(params = {}, = {}) req = build_request(:describe_model_quality_job_definition, params) req.send_request() end |
#describe_monitoring_schedule(params = {}) ⇒ Types::DescribeMonitoringScheduleResponse
Describes the schedule for a monitoring job.
14679 14680 14681 14682 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 14679 def describe_monitoring_schedule(params = {}, = {}) req = build_request(:describe_monitoring_schedule, params) req.send_request() end |
#describe_notebook_instance(params = {}) ⇒ Types::DescribeNotebookInstanceOutput
Returns information about a notebook instance.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- notebook_instance_deleted
- notebook_instance_in_service
- notebook_instance_stopped
14759 14760 14761 14762 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 14759 def describe_notebook_instance(params = {}, = {}) req = build_request(:describe_notebook_instance, params) req.send_request() end |
#describe_notebook_instance_lifecycle_config(params = {}) ⇒ Types::DescribeNotebookInstanceLifecycleConfigOutput
Returns a description of a notebook instance lifecycle configuration.
For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.
14806 14807 14808 14809 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 14806 def describe_notebook_instance_lifecycle_config(params = {}, = {}) req = build_request(:describe_notebook_instance_lifecycle_config, params) req.send_request() end |
#describe_pipeline(params = {}) ⇒ Types::DescribePipelineResponse
Describes the details of a pipeline.
14868 14869 14870 14871 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 14868 def describe_pipeline(params = {}, = {}) req = build_request(:describe_pipeline, params) req.send_request() end |
#describe_pipeline_definition_for_execution(params = {}) ⇒ Types::DescribePipelineDefinitionForExecutionResponse
Describes the details of an execution's pipeline definition.
14898 14899 14900 14901 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 14898 def describe_pipeline_definition_for_execution(params = {}, = {}) req = build_request(:describe_pipeline_definition_for_execution, params) req.send_request() end |
#describe_pipeline_execution(params = {}) ⇒ Types::DescribePipelineExecutionResponse
Describes the details of a pipeline execution.
14963 14964 14965 14966 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 14963 def describe_pipeline_execution(params = {}, = {}) req = build_request(:describe_pipeline_execution, params) req.send_request() end |
#describe_processing_job(params = {}) ⇒ Types::DescribeProcessingJobResponse
Returns a description of a processing job.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- processing_job_completed_or_stopped
15088 15089 15090 15091 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 15088 def describe_processing_job(params = {}, = {}) req = build_request(:describe_processing_job, params) req.send_request() end |
#describe_project(params = {}) ⇒ Types::DescribeProjectOutput
Describes the details of a project.
15152 15153 15154 15155 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 15152 def describe_project(params = {}, = {}) req = build_request(:describe_project, params) req.send_request() end |
#describe_space(params = {}) ⇒ Types::DescribeSpaceResponse
Describes the space.
15243 15244 15245 15246 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 15243 def describe_space(params = {}, = {}) req = build_request(:describe_space, params) req.send_request() end |
#describe_studio_lifecycle_config(params = {}) ⇒ Types::DescribeStudioLifecycleConfigResponse
Describes the Amazon SageMaker Studio Lifecycle Configuration.
15282 15283 15284 15285 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 15282 def describe_studio_lifecycle_config(params = {}, = {}) req = build_request(:describe_studio_lifecycle_config, params) req.send_request() end |
#describe_subscribed_workteam(params = {}) ⇒ Types::DescribeSubscribedWorkteamResponse
Gets information about a work team provided by a vendor. It returns details about the subscription with a vendor in the Amazon Web Services Marketplace.
15317 15318 15319 15320 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 15317 def describe_subscribed_workteam(params = {}, = {}) req = build_request(:describe_subscribed_workteam, params) req.send_request() end |
#describe_training_job(params = {}) ⇒ Types::DescribeTrainingJobResponse
Returns information about a training job.
Some of the attributes below only appear if the training job
successfully starts. If the training job fails, TrainingJobStatus
is
Failed
and, depending on the FailureReason
, attributes like
TrainingStartTime
, TrainingTimeInSeconds
, TrainingEndTime
, and
BillableTimeInSeconds
may not be present in the response.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- training_job_completed_or_stopped
15537 15538 15539 15540 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 15537 def describe_training_job(params = {}, = {}) req = build_request(:describe_training_job, params) req.send_request() end |
#describe_transform_job(params = {}) ⇒ Types::DescribeTransformJobResponse
Returns information about a transform job.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- transform_job_completed_or_stopped
15628 15629 15630 15631 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 15628 def describe_transform_job(params = {}, = {}) req = build_request(:describe_transform_job, params) req.send_request() end |
#describe_trial(params = {}) ⇒ Types::DescribeTrialResponse
Provides a list of a trial's properties.
15688 15689 15690 15691 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 15688 def describe_trial(params = {}, = {}) req = build_request(:describe_trial, params) req.send_request() end |
#describe_trial_component(params = {}) ⇒ Types::DescribeTrialComponentResponse
Provides a list of a trials component's properties.
15782 15783 15784 15785 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 15782 def describe_trial_component(params = {}, = {}) req = build_request(:describe_trial_component, params) req.send_request() end |
#describe_user_profile(params = {}) ⇒ Types::DescribeUserProfileResponse
Describes a user profile. For more information, see
CreateUserProfile
.
15922 15923 15924 15925 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 15922 def describe_user_profile(params = {}, = {}) req = build_request(:describe_user_profile, params) req.send_request() end |
#describe_workforce(params = {}) ⇒ Types::DescribeWorkforceResponse
Lists private workforce information, including workforce name, Amazon Resource Name (ARN), and, if applicable, allowed IP address ranges (CIDRs). Allowable IP address ranges are the IP addresses that workers can use to access tasks.
This operation applies only to private workforces.
15984 15985 15986 15987 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 15984 def describe_workforce(params = {}, = {}) req = build_request(:describe_workforce, params) req.send_request() end |
#describe_workteam(params = {}) ⇒ Types::DescribeWorkteamResponse
Gets information about a specific work team. You can see information such as the create date, the last updated date, membership information, and the work team's Amazon Resource Name (ARN).
16031 16032 16033 16034 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 16031 def describe_workteam(params = {}, = {}) req = build_request(:describe_workteam, params) req.send_request() end |
#disable_sagemaker_servicecatalog_portfolio(params = {}) ⇒ Struct
Disables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.
16045 16046 16047 16048 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 16045 def disable_sagemaker_servicecatalog_portfolio(params = {}, = {}) req = build_request(:disable_sagemaker_servicecatalog_portfolio, params) req.send_request() end |
#disassociate_trial_component(params = {}) ⇒ Types::DisassociateTrialComponentResponse
Disassociates a trial component from a trial. This doesn't effect other trials the component is associated with. Before you can delete a component, you must disassociate the component from all trials it is associated with. To associate a trial component with a trial, call the AssociateTrialComponent API.
To get a list of the trials a component is associated with, use the
Search API. Specify ExperimentTrialComponent
for the Resource
parameter. The list appears in the response under
Results.TrialComponent.Parents
.
16093 16094 16095 16096 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 16093 def disassociate_trial_component(params = {}, = {}) req = build_request(:disassociate_trial_component, params) req.send_request() end |
#enable_sagemaker_servicecatalog_portfolio(params = {}) ⇒ Struct
Enables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.
16107 16108 16109 16110 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 16107 def enable_sagemaker_servicecatalog_portfolio(params = {}, = {}) req = build_request(:enable_sagemaker_servicecatalog_portfolio, params) req.send_request() end |
#get_device_fleet_report(params = {}) ⇒ Types::GetDeviceFleetReportResponse
Describes a fleet.
16161 16162 16163 16164 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 16161 def get_device_fleet_report(params = {}, = {}) req = build_request(:get_device_fleet_report, params) req.send_request() end |
#get_lineage_group_policy(params = {}) ⇒ Types::GetLineageGroupPolicyResponse
The resource policy for the lineage group.
16191 16192 16193 16194 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 16191 def get_lineage_group_policy(params = {}, = {}) req = build_request(:get_lineage_group_policy, params) req.send_request() end |
#get_model_package_group_policy(params = {}) ⇒ Types::GetModelPackageGroupPolicyOutput
Gets a resource policy that manages access for a model group. For information about resource policies, see Identity-based policies and resource-based policies in the Amazon Web Services Identity and Access Management User Guide..
16226 16227 16228 16229 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 16226 def get_model_package_group_policy(params = {}, = {}) req = build_request(:get_model_package_group_policy, params) req.send_request() end |
#get_sagemaker_servicecatalog_portfolio_status(params = {}) ⇒ Types::GetSagemakerServicecatalogPortfolioStatusOutput
Gets the status of Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.
16246 16247 16248 16249 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 16246 def get_sagemaker_servicecatalog_portfolio_status(params = {}, = {}) req = build_request(:get_sagemaker_servicecatalog_portfolio_status, params) req.send_request() end |
#get_scaling_configuration_recommendation(params = {}) ⇒ Types::GetScalingConfigurationRecommendationResponse
Starts an Amazon SageMaker Inference Recommender autoscaling recommendation job. Returns recommendations for autoscaling policies that you can apply to your SageMaker endpoint.
16330 16331 16332 16333 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 16330 def get_scaling_configuration_recommendation(params = {}, = {}) req = build_request(:get_scaling_configuration_recommendation, params) req.send_request() end |
#get_search_suggestions(params = {}) ⇒ Types::GetSearchSuggestionsResponse
An auto-complete API for the search functionality in the SageMaker
console. It returns suggestions of possible matches for the property
name to use in Search
queries. Provides suggestions for
HyperParameters
, Tags
, and Metrics
.
16370 16371 16372 16373 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 16370 def get_search_suggestions(params = {}, = {}) req = build_request(:get_search_suggestions, params) req.send_request() end |
#import_hub_content(params = {}) ⇒ Types::ImportHubContentResponse
Import hub content.
16451 16452 16453 16454 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 16451 def import_hub_content(params = {}, = {}) req = build_request(:import_hub_content, params) req.send_request() end |
#list_actions(params = {}) ⇒ Types::ListActionsResponse
Lists the actions in your account and their properties.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
16525 16526 16527 16528 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 16525 def list_actions(params = {}, = {}) req = build_request(:list_actions, params) req.send_request() end |
#list_algorithms(params = {}) ⇒ Types::ListAlgorithmsOutput
Lists the machine learning algorithms that have been created.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
16592 16593 16594 16595 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 16592 def list_algorithms(params = {}, = {}) req = build_request(:list_algorithms, params) req.send_request() end |
#list_aliases(params = {}) ⇒ Types::ListAliasesResponse
Lists the aliases of a specified image or image version.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
16644 16645 16646 16647 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 16644 def list_aliases(params = {}, = {}) req = build_request(:list_aliases, params) req.send_request() end |
#list_app_image_configs(params = {}) ⇒ Types::ListAppImageConfigsResponse
Lists the AppImageConfigs in your account and their properties. The list can be filtered by creation time or modified time, and whether the AppImageConfig name contains a specified string.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
16750 16751 16752 16753 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 16750 def list_app_image_configs(params = {}, = {}) req = build_request(:list_app_image_configs, params) req.send_request() end |
#list_apps(params = {}) ⇒ Types::ListAppsResponse
Lists apps.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
16828 16829 16830 16831 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 16828 def list_apps(params = {}, = {}) req = build_request(:list_apps, params) req.send_request() end |
#list_artifacts(params = {}) ⇒ Types::ListArtifactsResponse
Lists the artifacts in your account and their properties.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
16903 16904 16905 16906 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 16903 def list_artifacts(params = {}, = {}) req = build_request(:list_artifacts, params) req.send_request() end |
#list_associations(params = {}) ⇒ Types::ListAssociationsResponse
Lists the associations in your account and their properties.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
16998 16999 17000 17001 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 16998 def list_associations(params = {}, = {}) req = build_request(:list_associations, params) req.send_request() end |
#list_auto_ml_jobs(params = {}) ⇒ Types::ListAutoMLJobsResponse
Request a list of jobs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
17077 17078 17079 17080 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 17077 def list_auto_ml_jobs(params = {}, = {}) req = build_request(:list_auto_ml_jobs, params) req.send_request() end |
#list_candidates_for_auto_ml_job(params = {}) ⇒ Types::ListCandidatesForAutoMLJobResponse
List the candidates created for the job.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
17169 17170 17171 17172 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 17169 def list_candidates_for_auto_ml_job(params = {}, = {}) req = build_request(:list_candidates_for_auto_ml_job, params) req.send_request() end |
#list_cluster_nodes(params = {}) ⇒ Types::ListClusterNodesResponse
Retrieves the list of instances (also called nodes interchangeably) in a SageMaker HyperPod cluster.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
17272 17273 17274 17275 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 17272 def list_cluster_nodes(params = {}, = {}) req = build_request(:list_cluster_nodes, params) req.send_request() end |
#list_clusters(params = {}) ⇒ Types::ListClustersResponse
Retrieves the list of SageMaker HyperPod clusters.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
17367 17368 17369 17370 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 17367 def list_clusters(params = {}, = {}) req = build_request(:list_clusters, params) req.send_request() end |
#list_code_repositories(params = {}) ⇒ Types::ListCodeRepositoriesOutput
Gets a list of the Git repositories in your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
17445 17446 17447 17448 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 17445 def list_code_repositories(params = {}, = {}) req = build_request(:list_code_repositories, params) req.send_request() end |
#list_compilation_jobs(params = {}) ⇒ Types::ListCompilationJobsResponse
Lists model compilation jobs that satisfy various filters.
To create a model compilation job, use CreateCompilationJob. To get information about a particular model compilation job you have created, use DescribeCompilationJob.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
17542 17543 17544 17545 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 17542 def list_compilation_jobs(params = {}, = {}) req = build_request(:list_compilation_jobs, params) req.send_request() end |
#list_contexts(params = {}) ⇒ Types::ListContextsResponse
Lists the contexts in your account and their properties.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
17616 17617 17618 17619 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 17616 def list_contexts(params = {}, = {}) req = build_request(:list_contexts, params) req.send_request() end |
#list_data_quality_job_definitions(params = {}) ⇒ Types::ListDataQualityJobDefinitionsResponse
Lists the data quality job definitions in your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
17689 17690 17691 17692 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 17689 def list_data_quality_job_definitions(params = {}, = {}) req = build_request(:list_data_quality_job_definitions, params) req.send_request() end |
#list_device_fleets(params = {}) ⇒ Types::ListDeviceFleetsResponse
Returns a list of devices in the fleet.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
17759 17760 17761 17762 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 17759 def list_device_fleets(params = {}, = {}) req = build_request(:list_device_fleets, params) req.send_request() end |
#list_devices(params = {}) ⇒ Types::ListDevicesResponse
A list of devices.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
17820 17821 17822 17823 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 17820 def list_devices(params = {}, = {}) req = build_request(:list_devices, params) req.send_request() end |
#list_domains(params = {}) ⇒ Types::ListDomainsResponse
Lists the domains.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
17870 17871 17872 17873 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 17870 def list_domains(params = {}, = {}) req = build_request(:list_domains, params) req.send_request() end |
#list_edge_deployment_plans(params = {}) ⇒ Types::ListEdgeDeploymentPlansResponse
Lists all edge deployment plans.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
17949 17950 17951 17952 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 17949 def list_edge_deployment_plans(params = {}, = {}) req = build_request(:list_edge_deployment_plans, params) req.send_request() end |
#list_edge_packaging_jobs(params = {}) ⇒ Types::ListEdgePackagingJobsResponse
Returns a list of edge packaging jobs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
18030 18031 18032 18033 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 18030 def list_edge_packaging_jobs(params = {}, = {}) req = build_request(:list_edge_packaging_jobs, params) req.send_request() end |
#list_endpoint_configs(params = {}) ⇒ Types::ListEndpointConfigsOutput
Lists endpoint configurations.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
18094 18095 18096 18097 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 18094 def list_endpoint_configs(params = {}, = {}) req = build_request(:list_endpoint_configs, params) req.send_request() end |
#list_endpoints(params = {}) ⇒ Types::ListEndpointsOutput
Lists endpoints.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
18175 18176 18177 18178 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 18175 def list_endpoints(params = {}, = {}) req = build_request(:list_endpoints, params) req.send_request() end |
#list_experiments(params = {}) ⇒ Types::ListExperimentsResponse
Lists all the experiments in your account. The list can be filtered to show only experiments that were created in a specific time range. The list can be sorted by experiment name or creation time.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
18242 18243 18244 18245 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 18242 def list_experiments(params = {}, = {}) req = build_request(:list_experiments, params) req.send_request() end |
#list_feature_groups(params = {}) ⇒ Types::ListFeatureGroupsResponse
List FeatureGroup
s based on given filter and order.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
18315 18316 18317 18318 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 18315 def list_feature_groups(params = {}, = {}) req = build_request(:list_feature_groups, params) req.send_request() end |
#list_flow_definitions(params = {}) ⇒ Types::ListFlowDefinitionsResponse
Returns information about the flow definitions in your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
18374 18375 18376 18377 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 18374 def list_flow_definitions(params = {}, = {}) req = build_request(:list_flow_definitions, params) req.send_request() end |
#list_hub_content_versions(params = {}) ⇒ Types::ListHubContentVersionsResponse
List hub content versions.
18463 18464 18465 18466 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 18463 def list_hub_content_versions(params = {}, = {}) req = build_request(:list_hub_content_versions, params) req.send_request() end |
#list_hub_contents(params = {}) ⇒ Types::ListHubContentsResponse
List the contents of a hub.
18546 18547 18548 18549 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 18546 def list_hub_contents(params = {}, = {}) req = build_request(:list_hub_contents, params) req.send_request() end |
#list_hubs(params = {}) ⇒ Types::ListHubsResponse
List all existing hubs.
18623 18624 18625 18626 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 18623 def list_hubs(params = {}, = {}) req = build_request(:list_hubs, params) req.send_request() end |
#list_human_task_uis(params = {}) ⇒ Types::ListHumanTaskUisResponse
Returns information about the human task user interfaces in your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
18681 18682 18683 18684 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 18681 def list_human_task_uis(params = {}, = {}) req = build_request(:list_human_task_uis, params) req.send_request() end |
#list_hyper_parameter_tuning_jobs(params = {}) ⇒ Types::ListHyperParameterTuningJobsResponse
Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
18779 18780 18781 18782 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 18779 def list_hyper_parameter_tuning_jobs(params = {}, = {}) req = build_request(:list_hyper_parameter_tuning_jobs, params) req.send_request() end |
#list_image_versions(params = {}) ⇒ Types::ListImageVersionsResponse
Lists the versions of a specified image and their properties. The list can be filtered by creation time or modified time.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
18859 18860 18861 18862 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 18859 def list_image_versions(params = {}, = {}) req = build_request(:list_image_versions, params) req.send_request() end |
#list_images(params = {}) ⇒ Types::ListImagesResponse
Lists the images in your account and their properties. The list can be filtered by creation time or modified time, and whether the image name contains a specified string.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
18941 18942 18943 18944 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 18941 def list_images(params = {}, = {}) req = build_request(:list_images, params) req.send_request() end |
#list_inference_components(params = {}) ⇒ Types::ListInferenceComponentsOutput
Lists the inference components in your account and their properties.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
19039 19040 19041 19042 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 19039 def list_inference_components(params = {}, = {}) req = build_request(:list_inference_components, params) req.send_request() end |
#list_inference_experiments(params = {}) ⇒ Types::ListInferenceExperimentsResponse
Returns the list of all inference experiments.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
19136 19137 19138 19139 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 19136 def list_inference_experiments(params = {}, = {}) req = build_request(:list_inference_experiments, params) req.send_request() end |
#list_inference_recommendations_job_steps(params = {}) ⇒ Types::ListInferenceRecommendationsJobStepsResponse
Returns a list of the subtasks for an Inference Recommender job.
The supported subtasks are benchmarks, which evaluate the performance of your model on different instance types.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
19221 19222 19223 19224 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 19221 def list_inference_recommendations_job_steps(params = {}, = {}) req = build_request(:list_inference_recommendations_job_steps, params) req.send_request() end |
#list_inference_recommendations_jobs(params = {}) ⇒ Types::ListInferenceRecommendationsJobsResponse
Lists recommendation jobs that satisfy various filters.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
19320 19321 19322 19323 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 19320 def list_inference_recommendations_jobs(params = {}, = {}) req = build_request(:list_inference_recommendations_jobs, params) req.send_request() end |
#list_labeling_jobs(params = {}) ⇒ Types::ListLabelingJobsResponse
Gets a list of labeling jobs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
19416 19417 19418 19419 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 19416 def list_labeling_jobs(params = {}, = {}) req = build_request(:list_labeling_jobs, params) req.send_request() end |
#list_labeling_jobs_for_workteam(params = {}) ⇒ Types::ListLabelingJobsForWorkteamResponse
Gets a list of labeling jobs assigned to a specified work team.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
19491 19492 19493 19494 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 19491 def list_labeling_jobs_for_workteam(params = {}, = {}) req = build_request(:list_labeling_jobs_for_workteam, params) req.send_request() end |
#list_lineage_groups(params = {}) ⇒ Types::ListLineageGroupsResponse
A list of lineage groups shared with your Amazon Web Services account. For more information, see Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
19559 19560 19561 19562 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 19559 def list_lineage_groups(params = {}, = {}) req = build_request(:list_lineage_groups, params) req.send_request() end |
#list_model_bias_job_definitions(params = {}) ⇒ Types::ListModelBiasJobDefinitionsResponse
Lists model bias jobs definitions that satisfy various filters.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
19629 19630 19631 19632 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 19629 def list_model_bias_job_definitions(params = {}, = {}) req = build_request(:list_model_bias_job_definitions, params) req.send_request() end |
#list_model_card_export_jobs(params = {}) ⇒ Types::ListModelCardExportJobsResponse
List the export jobs for the Amazon SageMaker Model Card.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
19710 19711 19712 19713 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 19710 def list_model_card_export_jobs(params = {}, = {}) req = build_request(:list_model_card_export_jobs, params) req.send_request() end |
#list_model_card_versions(params = {}) ⇒ Types::ListModelCardVersionsResponse
List existing versions of an Amazon SageMaker Model Card.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
19782 19783 19784 19785 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 19782 def list_model_card_versions(params = {}, = {}) req = build_request(:list_model_card_versions, params) req.send_request() end |
#list_model_cards(params = {}) ⇒ Types::ListModelCardsResponse
List existing model cards.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
19850 19851 19852 19853 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 19850 def list_model_cards(params = {}, = {}) req = build_request(:list_model_cards, params) req.send_request() end |
#list_model_explainability_job_definitions(params = {}) ⇒ Types::ListModelExplainabilityJobDefinitionsResponse
Lists model explainability job definitions that satisfy various filters.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
19922 19923 19924 19925 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 19922 def list_model_explainability_job_definitions(params = {}, = {}) req = build_request(:list_model_explainability_job_definitions, params) req.send_request() end |
#list_model_metadata(params = {}) ⇒ Types::ListModelMetadataResponse
Lists the domain, framework, task, and model name of standard machine learning models found in common model zoos.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
19981 19982 19983 19984 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 19981 def (params = {}, = {}) req = build_request(:list_model_metadata, params) req.send_request() end |
#list_model_package_groups(params = {}) ⇒ Types::ListModelPackageGroupsOutput
Gets a list of the model groups in your Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
20047 20048 20049 20050 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 20047 def list_model_package_groups(params = {}, = {}) req = build_request(:list_model_package_groups, params) req.send_request() end |
#list_model_packages(params = {}) ⇒ Types::ListModelPackagesOutput
Lists the model packages that have been created.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
20139 20140 20141 20142 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 20139 def list_model_packages(params = {}, = {}) req = build_request(:list_model_packages, params) req.send_request() end |
#list_model_quality_job_definitions(params = {}) ⇒ Types::ListModelQualityJobDefinitionsResponse
Gets a list of model quality monitoring job definitions in your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
20214 20215 20216 20217 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 20214 def list_model_quality_job_definitions(params = {}, = {}) req = build_request(:list_model_quality_job_definitions, params) req.send_request() end |
#list_models(params = {}) ⇒ Types::ListModelsOutput
Lists models created with the CreateModel
API.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
20278 20279 20280 20281 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 20278 def list_models(params = {}, = {}) req = build_request(:list_models, params) req.send_request() end |
#list_monitoring_alert_history(params = {}) ⇒ Types::ListMonitoringAlertHistoryResponse
Gets a list of past alerts in a model monitoring schedule.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
20351 20352 20353 20354 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 20351 def list_monitoring_alert_history(params = {}, = {}) req = build_request(:list_monitoring_alert_history, params) req.send_request() end |
#list_monitoring_alerts(params = {}) ⇒ Types::ListMonitoringAlertsResponse
Gets the alerts for a single monitoring schedule.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
20400 20401 20402 20403 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 20400 def list_monitoring_alerts(params = {}, = {}) req = build_request(:list_monitoring_alerts, params) req.send_request() end |
#list_monitoring_executions(params = {}) ⇒ Types::ListMonitoringExecutionsResponse
Returns list of all monitoring job executions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
20504 20505 20506 20507 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 20504 def list_monitoring_executions(params = {}, = {}) req = build_request(:list_monitoring_executions, params) req.send_request() end |
#list_monitoring_schedules(params = {}) ⇒ Types::ListMonitoringSchedulesResponse
Returns list of all monitoring schedules.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
20604 20605 20606 20607 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 20604 def list_monitoring_schedules(params = {}, = {}) req = build_request(:list_monitoring_schedules, params) req.send_request() end |
#list_notebook_instance_lifecycle_configs(params = {}) ⇒ Types::ListNotebookInstanceLifecycleConfigsOutput
Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
20685 20686 20687 20688 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 20685 def list_notebook_instance_lifecycle_configs(params = {}, = {}) req = build_request(:list_notebook_instance_lifecycle_configs, params) req.send_request() end |
#list_notebook_instances(params = {}) ⇒ Types::ListNotebookInstancesOutput
Returns a list of the SageMaker notebook instances in the requester's account in an Amazon Web Services Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
20799 20800 20801 20802 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 20799 def list_notebook_instances(params = {}, = {}) req = build_request(:list_notebook_instances, params) req.send_request() end |
#list_pipeline_execution_steps(params = {}) ⇒ Types::ListPipelineExecutionStepsResponse
Gets a list of PipeLineExecutionStep
objects.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
20896 20897 20898 20899 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 20896 def list_pipeline_execution_steps(params = {}, = {}) req = build_request(:list_pipeline_execution_steps, params) req.send_request() end |
#list_pipeline_executions(params = {}) ⇒ Types::ListPipelineExecutionsResponse
Gets a list of the pipeline executions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
20962 20963 20964 20965 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 20962 def list_pipeline_executions(params = {}, = {}) req = build_request(:list_pipeline_executions, params) req.send_request() end |
#list_pipeline_parameters_for_execution(params = {}) ⇒ Types::ListPipelineParametersForExecutionResponse
Gets a list of parameters for a pipeline execution.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
21007 21008 21009 21010 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 21007 def list_pipeline_parameters_for_execution(params = {}, = {}) req = build_request(:list_pipeline_parameters_for_execution, params) req.send_request() end |
#list_pipelines(params = {}) ⇒ Types::ListPipelinesResponse
Gets a list of pipelines.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
21075 21076 21077 21078 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 21075 def list_pipelines(params = {}, = {}) req = build_request(:list_pipelines, params) req.send_request() end |
#list_processing_jobs(params = {}) ⇒ Types::ListProcessingJobsResponse
Lists processing jobs that satisfy various filters.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
21158 21159 21160 21161 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 21158 def list_processing_jobs(params = {}, = {}) req = build_request(:list_processing_jobs, params) req.send_request() end |
#list_projects(params = {}) ⇒ Types::ListProjectsOutput
Gets a list of the projects in an Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
21225 21226 21227 21228 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 21225 def list_projects(params = {}, = {}) req = build_request(:list_projects, params) req.send_request() end |
#list_resource_catalogs(params = {}) ⇒ Types::ListResourceCatalogsResponse
Lists Amazon SageMaker Catalogs based on given filters and orders. The
maximum number of ResourceCatalog
s viewable is 1000.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
21289 21290 21291 21292 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 21289 def list_resource_catalogs(params = {}, = {}) req = build_request(:list_resource_catalogs, params) req.send_request() end |
#list_spaces(params = {}) ⇒ Types::ListSpacesResponse
Lists spaces.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
21359 21360 21361 21362 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 21359 def list_spaces(params = {}, = {}) req = build_request(:list_spaces, params) req.send_request() end |
#list_stage_devices(params = {}) ⇒ Types::ListStageDevicesResponse
Lists devices allocated to the stage, containing detailed device information and deployment status.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
21420 21421 21422 21423 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 21420 def list_stage_devices(params = {}, = {}) req = build_request(:list_stage_devices, params) req.send_request() end |
#list_studio_lifecycle_configs(params = {}) ⇒ Types::ListStudioLifecycleConfigsResponse
Lists the Amazon SageMaker Studio Lifecycle Configurations in your Amazon Web Services Account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
21506 21507 21508 21509 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 21506 def list_studio_lifecycle_configs(params = {}, = {}) req = build_request(:list_studio_lifecycle_configs, params) req.send_request() end |
#list_subscribed_workteams(params = {}) ⇒ Types::ListSubscribedWorkteamsResponse
Gets a list of the work teams that you are subscribed to in the Amazon
Web Services Marketplace. The list may be empty if no work team
satisfies the filter specified in the NameContains
parameter.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
21557 21558 21559 21560 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 21557 def list_subscribed_workteams(params = {}, = {}) req = build_request(:list_subscribed_workteams, params) req.send_request() end |
#list_tags(params = {}) ⇒ Types::ListTagsOutput
Returns the tags for the specified SageMaker resource.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
21602 21603 21604 21605 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 21602 def (params = {}, = {}) req = build_request(:list_tags, params) req.send_request() end |
#list_training_jobs(params = {}) ⇒ Types::ListTrainingJobsResponse
Lists training jobs.
StatusEquals
and MaxResults
are set at the same time, the
MaxResults
number of training jobs are first retrieved ignoring the
StatusEquals
parameter and then they are filtered by the
StatusEquals
parameter, which is returned as a response.
For example, if ListTrainingJobs
is invoked with the following
parameters:
\{ ... MaxResults: 100, StatusEquals: InProgress ... \}
First, 100 trainings jobs with any status, including those other than
InProgress
, are selected (sorted according to the creation time,
from the most current to the oldest). Next, those with a status of
InProgress
are returned.
You can quickly test the API using the following Amazon Web Services CLI code.
aws sagemaker list-training-jobs --max-results 100 --status-equals
InProgress
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
21714 21715 21716 21717 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 21714 def list_training_jobs(params = {}, = {}) req = build_request(:list_training_jobs, params) req.send_request() end |
#list_training_jobs_for_hyper_parameter_tuning_job(params = {}) ⇒ Types::ListTrainingJobsForHyperParameterTuningJobResponse
Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
21793 21794 21795 21796 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 21793 def list_training_jobs_for_hyper_parameter_tuning_job(params = {}, = {}) req = build_request(:list_training_jobs_for_hyper_parameter_tuning_job, params) req.send_request() end |
#list_transform_jobs(params = {}) ⇒ Types::ListTransformJobsResponse
Lists transform jobs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
21876 21877 21878 21879 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 21876 def list_transform_jobs(params = {}, = {}) req = build_request(:list_transform_jobs, params) req.send_request() end |
#list_trial_components(params = {}) ⇒ Types::ListTrialComponentsResponse
Lists the trial components in your account. You can sort the list by trial component name or creation time. You can filter the list to show only components that were created in a specific time range. You can also filter on one of the following:
ExperimentName
SourceArn
TrialName
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
21984 21985 21986 21987 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 21984 def list_trial_components(params = {}, = {}) req = build_request(:list_trial_components, params) req.send_request() end |
#list_trials(params = {}) ⇒ Types::ListTrialsResponse
Lists the trials in your account. Specify an experiment name to limit the list to the trials that are part of that experiment. Specify a trial component name to limit the list to the trials that associated with that trial component. The list can be filtered to show only trials that were created in a specific time range. The list can be sorted by trial name or creation time.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
22061 22062 22063 22064 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 22061 def list_trials(params = {}, = {}) req = build_request(:list_trials, params) req.send_request() end |
#list_user_profiles(params = {}) ⇒ Types::ListUserProfilesResponse
Lists user profiles.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
22126 22127 22128 22129 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 22126 def list_user_profiles(params = {}, = {}) req = build_request(:list_user_profiles, params) req.send_request() end |
#list_workforces(params = {}) ⇒ Types::ListWorkforcesResponse
Use this operation to list all private and vendor workforces in an Amazon Web Services Region. Note that you can only have one private workforce per Amazon Web Services Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
22201 22202 22203 22204 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 22201 def list_workforces(params = {}, = {}) req = build_request(:list_workforces, params) req.send_request() end |
#list_workteams(params = {}) ⇒ Types::ListWorkteamsResponse
Gets a list of private work teams that you have defined in a region.
The list may be empty if no work team satisfies the filter specified
in the NameContains
parameter.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
22273 22274 22275 22276 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 22273 def list_workteams(params = {}, = {}) req = build_request(:list_workteams, params) req.send_request() end |
#put_model_package_group_policy(params = {}) ⇒ Types::PutModelPackageGroupPolicyOutput
Adds a resouce policy to control access to a model group. For information about resoure policies, see Identity-based policies and resource-based policies in the Amazon Web Services Identity and Access Management User Guide..
22312 22313 22314 22315 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 22312 def put_model_package_group_policy(params = {}, = {}) req = build_request(:put_model_package_group_policy, params) req.send_request() end |
#query_lineage(params = {}) ⇒ Types::QueryLineageResponse
Use this action to inspect your lineage and discover relationships between entities. For more information, see Querying Lineage Entities in the Amazon SageMaker Developer Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
22419 22420 22421 22422 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 22419 def query_lineage(params = {}, = {}) req = build_request(:query_lineage, params) req.send_request() end |
#register_devices(params = {}) ⇒ Struct
Register devices.
22460 22461 22462 22463 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 22460 def register_devices(params = {}, = {}) req = build_request(:register_devices, params) req.send_request() end |
#render_ui_template(params = {}) ⇒ Types::RenderUiTemplateResponse
Renders the UI template so that you can preview the worker's experience.
22518 22519 22520 22521 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 22518 def render_ui_template(params = {}, = {}) req = build_request(:render_ui_template, params) req.send_request() end |
#retry_pipeline_execution(params = {}) ⇒ Types::RetryPipelineExecutionResponse
Retry the execution of the pipeline.
22562 22563 22564 22565 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 22562 def retry_pipeline_execution(params = {}, = {}) req = build_request(:retry_pipeline_execution, params) req.send_request() end |
#search(params = {}) ⇒ Types::SearchResponse
Finds SageMaker resources that match a search query. Matching
resources are returned as a list of SearchRecord
objects in the
response. You can sort the search results by any resource property in
a ascending or descending order.
You can query against the following value types: numeric, text, Boolean, and timestamp.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
22685 22686 22687 22688 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 22685 def search(params = {}, = {}) req = build_request(:search, params) req.send_request() end |
#send_pipeline_execution_step_failure(params = {}) ⇒ Types::SendPipelineExecutionStepFailureResponse
Notifies the pipeline that the execution of a callback step failed, along with a message describing why. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).
22729 22730 22731 22732 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 22729 def send_pipeline_execution_step_failure(params = {}, = {}) req = build_request(:send_pipeline_execution_step_failure, params) req.send_request() end |
#send_pipeline_execution_step_success(params = {}) ⇒ Types::SendPipelineExecutionStepSuccessResponse
Notifies the pipeline that the execution of a callback step succeeded and provides a list of the step's output parameters. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).
22778 22779 22780 22781 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 22778 def send_pipeline_execution_step_success(params = {}, = {}) req = build_request(:send_pipeline_execution_step_success, params) req.send_request() end |
#start_edge_deployment_stage(params = {}) ⇒ Struct
Starts a stage in an edge deployment plan.
22804 22805 22806 22807 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 22804 def start_edge_deployment_stage(params = {}, = {}) req = build_request(:start_edge_deployment_stage, params) req.send_request() end |
#start_inference_experiment(params = {}) ⇒ Types::StartInferenceExperimentResponse
Starts an inference experiment.
22832 22833 22834 22835 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 22832 def start_inference_experiment(params = {}, = {}) req = build_request(:start_inference_experiment, params) req.send_request() end |
#start_monitoring_schedule(params = {}) ⇒ Struct
Starts a previously stopped monitoring schedule.
scheduled
.
22859 22860 22861 22862 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 22859 def start_monitoring_schedule(params = {}, = {}) req = build_request(:start_monitoring_schedule, params) req.send_request() end |
#start_notebook_instance(params = {}) ⇒ Struct
Launches an ML compute instance with the latest version of the
libraries and attaches your ML storage volume. After configuring the
notebook instance, SageMaker sets the notebook instance status to
InService
. A notebook instance's status must be InService
before
you can connect to your Jupyter notebook.
22885 22886 22887 22888 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 22885 def start_notebook_instance(params = {}, = {}) req = build_request(:start_notebook_instance, params) req.send_request() end |
#start_pipeline_execution(params = {}) ⇒ Types::StartPipelineExecutionResponse
Starts a pipeline execution.
22957 22958 22959 22960 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 22957 def start_pipeline_execution(params = {}, = {}) req = build_request(:start_pipeline_execution, params) req.send_request() end |
#stop_auto_ml_job(params = {}) ⇒ Struct
A method for forcing a running job to shut down.
22979 22980 22981 22982 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 22979 def stop_auto_ml_job(params = {}, = {}) req = build_request(:stop_auto_ml_job, params) req.send_request() end |
#stop_compilation_job(params = {}) ⇒ Struct
Stops a model compilation job.
To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal. This gracefully shuts the job down. If the job hasn't stopped, it sends the SIGKILL signal.
When it receives a StopCompilationJob
request, Amazon SageMaker
changes the CompilationJobStatus
of the job to Stopping
. After
Amazon SageMaker stops the job, it sets the CompilationJobStatus
to
Stopped
.
23010 23011 23012 23013 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 23010 def stop_compilation_job(params = {}, = {}) req = build_request(:stop_compilation_job, params) req.send_request() end |
#stop_edge_deployment_stage(params = {}) ⇒ Struct
Stops a stage in an edge deployment plan.
23036 23037 23038 23039 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 23036 def stop_edge_deployment_stage(params = {}, = {}) req = build_request(:stop_edge_deployment_stage, params) req.send_request() end |
#stop_edge_packaging_job(params = {}) ⇒ Struct
Request to stop an edge packaging job.
23058 23059 23060 23061 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 23058 def stop_edge_packaging_job(params = {}, = {}) req = build_request(:stop_edge_packaging_job, params) req.send_request() end |
#stop_hyper_parameter_tuning_job(params = {}) ⇒ Struct
Stops a running hyperparameter tuning job and all running training jobs that the tuning job launched.
All model artifacts output from the training jobs are stored in Amazon
Simple Storage Service (Amazon S3). All data that the training jobs
write to Amazon CloudWatch Logs are still available in CloudWatch.
After the tuning job moves to the Stopped
state, it releases all
reserved resources for the tuning job.
23087 23088 23089 23090 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 23087 def stop_hyper_parameter_tuning_job(params = {}, = {}) req = build_request(:stop_hyper_parameter_tuning_job, params) req.send_request() end |
#stop_inference_experiment(params = {}) ⇒ Types::StopInferenceExperimentResponse
Stops an inference experiment.
23160 23161 23162 23163 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 23160 def stop_inference_experiment(params = {}, = {}) req = build_request(:stop_inference_experiment, params) req.send_request() end |
#stop_inference_recommendations_job(params = {}) ⇒ Struct
Stops an Inference Recommender job.
23182 23183 23184 23185 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 23182 def stop_inference_recommendations_job(params = {}, = {}) req = build_request(:stop_inference_recommendations_job, params) req.send_request() end |
#stop_labeling_job(params = {}) ⇒ Struct
Stops a running labeling job. A job that is stopped cannot be restarted. Any results obtained before the job is stopped are placed in the Amazon S3 output bucket.
23206 23207 23208 23209 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 23206 def stop_labeling_job(params = {}, = {}) req = build_request(:stop_labeling_job, params) req.send_request() end |
#stop_monitoring_schedule(params = {}) ⇒ Struct
Stops a previously started monitoring schedule.
23228 23229 23230 23231 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 23228 def stop_monitoring_schedule(params = {}, = {}) req = build_request(:stop_monitoring_schedule, params) req.send_request() end |
#stop_notebook_instance(params = {}) ⇒ Struct
Terminates the ML compute instance. Before terminating the instance,
SageMaker disconnects the ML storage volume from it. SageMaker
preserves the ML storage volume. SageMaker stops charging you for the
ML compute instance when you call StopNotebookInstance
.
To access data on the ML storage volume for a notebook instance that
has been terminated, call the StartNotebookInstance
API.
StartNotebookInstance
launches another ML compute instance,
configures it, and attaches the preserved ML storage volume so you can
continue your work.
23259 23260 23261 23262 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 23259 def stop_notebook_instance(params = {}, = {}) req = build_request(:stop_notebook_instance, params) req.send_request() end |
#stop_pipeline_execution(params = {}) ⇒ Types::StopPipelineExecutionResponse
Stops a pipeline execution.
Callback Step
A pipeline execution won't stop while a callback step is running.
When you call StopPipelineExecution
on a pipeline execution with a
running callback step, SageMaker Pipelines sends an additional Amazon
SQS message to the specified SQS queue. The body of the SQS message
contains a "Status" field which is set to "Stopping".
You should add logic to your Amazon SQS message consumer to take any
needed action (for example, resource cleanup) upon receipt of the
message followed by a call to SendPipelineExecutionStepSuccess
or
SendPipelineExecutionStepFailure
.
Only when SageMaker Pipelines receives one of these calls will it stop the pipeline execution.
Lambda Step
A pipeline execution can't be stopped while a lambda step is running
because the Lambda function invoked by the lambda step can't be
stopped. If you attempt to stop the execution while the Lambda
function is running, the pipeline waits for the Lambda function to
finish or until the timeout is hit, whichever occurs first, and then
stops. If the Lambda function finishes, the pipeline execution status
is Stopped
. If the timeout is hit the pipeline execution status is
Failed
.
23323 23324 23325 23326 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 23323 def stop_pipeline_execution(params = {}, = {}) req = build_request(:stop_pipeline_execution, params) req.send_request() end |
#stop_processing_job(params = {}) ⇒ Struct
Stops a processing job.
23345 23346 23347 23348 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 23345 def stop_processing_job(params = {}, = {}) req = build_request(:stop_processing_job, params) req.send_request() end |
#stop_training_job(params = {}) ⇒ Struct
Stops a training job. To stop a job, SageMaker sends the algorithm the
SIGTERM
signal, which delays job termination for 120 seconds.
Algorithms might use this 120-second window to save the model
artifacts, so the results of the training is not lost.
When it receives a StopTrainingJob
request, SageMaker changes the
status of the job to Stopping
. After SageMaker stops the job, it
sets the status to Stopped
.
23374 23375 23376 23377 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 23374 def stop_training_job(params = {}, = {}) req = build_request(:stop_training_job, params) req.send_request() end |
#stop_transform_job(params = {}) ⇒ Struct
Stops a batch transform job.
When Amazon SageMaker receives a StopTransformJob
request, the
status of the job changes to Stopping
. After Amazon SageMaker stops
the job, the status is set to Stopped
. When you stop a batch
transform job before it is completed, Amazon SageMaker doesn't store
the job's output in Amazon S3.
23402 23403 23404 23405 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 23402 def stop_transform_job(params = {}, = {}) req = build_request(:stop_transform_job, params) req.send_request() end |
#update_action(params = {}) ⇒ Types::UpdateActionResponse
Updates an action.
23448 23449 23450 23451 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 23448 def update_action(params = {}, = {}) req = build_request(:update_action, params) req.send_request() end |
#update_app_image_config(params = {}) ⇒ Types::UpdateAppImageConfigResponse
Updates the properties of an AppImageConfig.
23526 23527 23528 23529 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 23526 def update_app_image_config(params = {}, = {}) req = build_request(:update_app_image_config, params) req.send_request() end |
#update_artifact(params = {}) ⇒ Types::UpdateArtifactResponse
Updates an artifact.
23568 23569 23570 23571 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 23568 def update_artifact(params = {}, = {}) req = build_request(:update_artifact, params) req.send_request() end |
#update_cluster(params = {}) ⇒ Types::UpdateClusterResponse
Updates a SageMaker HyperPod cluster.
23612 23613 23614 23615 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 23612 def update_cluster(params = {}, = {}) req = build_request(:update_cluster, params) req.send_request() end |
#update_cluster_software(params = {}) ⇒ Types::UpdateClusterSoftwareResponse
Updates the platform software of a SageMaker HyperPod cluster for security patching. To learn how to use this API, see Update the SageMaker HyperPod platform software of a cluster.
23647 23648 23649 23650 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 23647 def update_cluster_software(params = {}, = {}) req = build_request(:update_cluster_software, params) req.send_request() end |
#update_code_repository(params = {}) ⇒ Types::UpdateCodeRepositoryOutput
Updates the specified Git repository with the specified values.
23687 23688 23689 23690 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 23687 def update_code_repository(params = {}, = {}) req = build_request(:update_code_repository, params) req.send_request() end |
#update_context(params = {}) ⇒ Types::UpdateContextResponse
Updates a context.
23729 23730 23731 23732 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 23729 def update_context(params = {}, = {}) req = build_request(:update_context, params) req.send_request() end |
#update_device_fleet(params = {}) ⇒ Struct
Updates a fleet of devices.
23777 23778 23779 23780 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 23777 def update_device_fleet(params = {}, = {}) req = build_request(:update_device_fleet, params) req.send_request() end |
#update_devices(params = {}) ⇒ Struct
Updates one or more devices in a fleet.
23809 23810 23811 23812 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 23809 def update_devices(params = {}, = {}) req = build_request(:update_devices, params) req.send_request() end |
#update_domain(params = {}) ⇒ Types::UpdateDomainResponse
Updates the default settings for new user profiles in the domain.
24135 24136 24137 24138 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 24135 def update_domain(params = {}, = {}) req = build_request(:update_domain, params) req.send_request() end |
#update_endpoint(params = {}) ⇒ Types::UpdateEndpointOutput
Deploys the EndpointConfig
specified in the request to a new fleet
of instances. SageMaker shifts endpoint traffic to the new instances
with the updated endpoint configuration and then deletes the old
instances using the previous EndpointConfig
(there is no
availability loss). For more information about how to control the
update and traffic shifting process, see Update models in
production.
When SageMaker receives the request, it sets the endpoint status to
Updating
. After updating the endpoint, it sets the status to
InService
. To check the status of an endpoint, use the
DescribeEndpoint API.
EndpointConfig
in use by an endpoint that is
live or while the UpdateEndpoint
or CreateEndpoint
operations are
being performed on the endpoint. To update an endpoint, you must
create a new EndpointConfig
.
If you delete the EndpointConfig
of an endpoint that is active or
being created or updated you may lose visibility into the instance
type the endpoint is using. The endpoint must be deleted in order to
stop incurring charges.
24273 24274 24275 24276 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 24273 def update_endpoint(params = {}, = {}) req = build_request(:update_endpoint, params) req.send_request() end |
#update_endpoint_weights_and_capacities(params = {}) ⇒ Types::UpdateEndpointWeightsAndCapacitiesOutput
Updates variant weight of one or more variants associated with an
existing endpoint, or capacity of one variant associated with an
existing endpoint. When it receives the request, SageMaker sets the
endpoint status to Updating
. After updating the endpoint, it sets
the status to InService
. To check the status of an endpoint, use the
DescribeEndpoint API.
24324 24325 24326 24327 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 24324 def update_endpoint_weights_and_capacities(params = {}, = {}) req = build_request(:update_endpoint_weights_and_capacities, params) req.send_request() end |
#update_experiment(params = {}) ⇒ Types::UpdateExperimentResponse
Adds, updates, or removes the description of an experiment. Updates the display name of an experiment.
24363 24364 24365 24366 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 24363 def update_experiment(params = {}, = {}) req = build_request(:update_experiment, params) req.send_request() end |
#update_feature_group(params = {}) ⇒ Types::UpdateFeatureGroupResponse
Updates the feature group by either adding features or updating the
online store configuration. Use one of the following request
parameters at a time while using the UpdateFeatureGroup
API.
You can add features for your feature group using the
FeatureAdditions
request parameter. Features cannot be removed from
a feature group.
You can update the online store configuration by using the
OnlineStoreConfig
request parameter. If a TtlDuration
is
specified, the default TtlDuration
applies for all records added to
the feature group after the feature group is updated. If a record
level TtlDuration
exists from using the PutRecord
API, the record
level TtlDuration
applies to that record instead of the default
TtlDuration
. To remove the default TtlDuration
from an existing
feature group, use the UpdateFeatureGroup
API and set the
TtlDuration
Unit
and Value
to null
.
24446 24447 24448 24449 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 24446 def update_feature_group(params = {}, = {}) req = build_request(:update_feature_group, params) req.send_request() end |
#update_feature_metadata(params = {}) ⇒ Struct
Updates the description and parameters of the feature group.
24492 24493 24494 24495 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 24492 def (params = {}, = {}) req = build_request(:update_feature_metadata, params) req.send_request() end |
#update_hub(params = {}) ⇒ Types::UpdateHubResponse
Update a hub.
24536 24537 24538 24539 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 24536 def update_hub(params = {}, = {}) req = build_request(:update_hub, params) req.send_request() end |
#update_image(params = {}) ⇒ Types::UpdateImageResponse
Updates the properties of a SageMaker image. To change the image's tags, use the AddTags and DeleteTags APIs.
24588 24589 24590 24591 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 24588 def update_image(params = {}, = {}) req = build_request(:update_image, params) req.send_request() end |
#update_image_version(params = {}) ⇒ Types::UpdateImageVersionResponse
Updates the properties of a SageMaker image version.
24685 24686 24687 24688 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 24685 def update_image_version(params = {}, = {}) req = build_request(:update_image_version, params) req.send_request() end |
#update_inference_component(params = {}) ⇒ Types::UpdateInferenceComponentOutput
Updates an inference component.
24744 24745 24746 24747 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 24744 def update_inference_component(params = {}, = {}) req = build_request(:update_inference_component, params) req.send_request() end |
#update_inference_component_runtime_config(params = {}) ⇒ Types::UpdateInferenceComponentRuntimeConfigOutput
Runtime settings for a model that is deployed with an inference component.
24780 24781 24782 24783 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 24780 def update_inference_component_runtime_config(params = {}, = {}) req = build_request(:update_inference_component_runtime_config, params) req.send_request() end |
#update_inference_experiment(params = {}) ⇒ Types::UpdateInferenceExperimentResponse
Updates an inference experiment that you created. The status of the
inference experiment has to be either Created
, Running
. For more
information on the status of an inference experiment, see
DescribeInferenceExperiment.
24874 24875 24876 24877 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 24874 def update_inference_experiment(params = {}, = {}) req = build_request(:update_inference_experiment, params) req.send_request() end |
#update_model_card(params = {}) ⇒ Types::UpdateModelCardResponse
Update an Amazon SageMaker Model Card.
You cannot update both model card content and model card status in a single call.
24932 24933 24934 24935 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 24932 def update_model_card(params = {}, = {}) req = build_request(:update_model_card, params) req.send_request() end |
#update_model_package(params = {}) ⇒ Types::UpdateModelPackageOutput
Updates a versioned model.
25104 25105 25106 25107 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 25104 def update_model_package(params = {}, = {}) req = build_request(:update_model_package, params) req.send_request() end |
#update_monitoring_alert(params = {}) ⇒ Types::UpdateMonitoringAlertResponse
Update the parameters of a model monitor alert.
25148 25149 25150 25151 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 25148 def update_monitoring_alert(params = {}, = {}) req = build_request(:update_monitoring_alert, params) req.send_request() end |
#update_monitoring_schedule(params = {}) ⇒ Types::UpdateMonitoringScheduleResponse
Updates a previously created schedule.
25283 25284 25285 25286 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 25283 def update_monitoring_schedule(params = {}, = {}) req = build_request(:update_monitoring_schedule, params) req.send_request() end |
#update_notebook_instance(params = {}) ⇒ Struct
Updates a notebook instance. NotebookInstance updates include upgrading or downgrading the ML compute instance used for your notebook instance to accommodate changes in your workload requirements.
25434 25435 25436 25437 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 25434 def update_notebook_instance(params = {}, = {}) req = build_request(:update_notebook_instance, params) req.send_request() end |
#update_notebook_instance_lifecycle_config(params = {}) ⇒ Struct
Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API.
25480 25481 25482 25483 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 25480 def update_notebook_instance_lifecycle_config(params = {}, = {}) req = build_request(:update_notebook_instance_lifecycle_config, params) req.send_request() end |
#update_pipeline(params = {}) ⇒ Types::UpdatePipelineResponse
Updates a pipeline.
25541 25542 25543 25544 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 25541 def update_pipeline(params = {}, = {}) req = build_request(:update_pipeline, params) req.send_request() end |
#update_pipeline_execution(params = {}) ⇒ Types::UpdatePipelineExecutionResponse
Updates a pipeline execution.
25584 25585 25586 25587 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 25584 def update_pipeline_execution(params = {}, = {}) req = build_request(:update_pipeline_execution, params) req.send_request() end |
#update_project(params = {}) ⇒ Types::UpdateProjectOutput
Updates a machine learning (ML) project that is created from a template that sets up an ML pipeline from training to deploying an approved model.
ServiceCatalogProvisioningUpdateDetails
of a project that is active
or being created, or updated, you may lose resources already created
by the project.
25665 25666 25667 25668 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 25665 def update_project(params = {}, = {}) req = build_request(:update_project, params) req.send_request() end |
#update_space(params = {}) ⇒ Types::UpdateSpaceResponse
Updates the settings of a space.
25774 25775 25776 25777 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 25774 def update_space(params = {}, = {}) req = build_request(:update_space, params) req.send_request() end |
#update_training_job(params = {}) ⇒ Types::UpdateTrainingJobResponse
Update a model training job to request a new Debugger profiling configuration or to change warm pool retention length.
25855 25856 25857 25858 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 25855 def update_training_job(params = {}, = {}) req = build_request(:update_training_job, params) req.send_request() end |
#update_trial(params = {}) ⇒ Types::UpdateTrialResponse
Updates the display name of a trial.
25888 25889 25890 25891 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 25888 def update_trial(params = {}, = {}) req = build_request(:update_trial, params) req.send_request() end |
#update_trial_component(params = {}) ⇒ Types::UpdateTrialComponentResponse
Updates one or more properties of a trial component.
25985 25986 25987 25988 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 25985 def update_trial_component(params = {}, = {}) req = build_request(:update_trial_component, params) req.send_request() end |
#update_user_profile(params = {}) ⇒ Types::UpdateUserProfileResponse
Updates a user profile.
26179 26180 26181 26182 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 26179 def update_user_profile(params = {}, = {}) req = build_request(:update_user_profile, params) req.send_request() end |
#update_workforce(params = {}) ⇒ Types::UpdateWorkforceResponse
Use this operation to update your workforce. You can use this operation to require that workers use specific IP addresses to work on tasks and to update your OpenID Connect (OIDC) Identity Provider (IdP) workforce configuration.
The worker portal is now supported in VPC and public internet.
Use SourceIpConfig
to restrict worker access to tasks to a specific
range of IP addresses. You specify allowed IP addresses by creating a
list of up to ten CIDRs. By default, a workforce isn't
restricted to specific IP addresses. If you specify a range of IP
addresses, workers who attempt to access tasks using any IP address
outside the specified range are denied and get a Not Found
error
message on the worker portal.
To restrict access to all the workers in public internet, add the
SourceIpConfig
CIDR value as "10.0.0.0/16".
Amazon SageMaker does not support Source Ip restriction for worker portals in VPC.
Use OidcConfig
to update the configuration of a workforce created
using your own OIDC IdP.
You can only update your OIDC IdP configuration when there are no work teams associated with your workforce. You can delete work teams using the DeleteWorkteam operation.
After restricting access to a range of IP addresses or updating your OIDC IdP configuration with this operation, you can view details about your update workforce using the DescribeWorkforce operation.
This operation only applies to private workforces.
26308 26309 26310 26311 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 26308 def update_workforce(params = {}, = {}) req = build_request(:update_workforce, params) req.send_request() end |
#update_workteam(params = {}) ⇒ Types::UpdateWorkteamResponse
Updates an existing work team with new member definitions or description.
26422 26423 26424 26425 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 26422 def update_workteam(params = {}, = {}) req = build_request(:update_workteam, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Basic Usage
A waiter will call an API operation until:
- It is successful
- It enters a terminal state
- It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)
Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
Callbacks
You can be notified before each polling attempt and before each
delay. If you throw :success
or :failure
from these callbacks,
it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
Valid Waiters
The following table lists the valid waiter names, the operations they call,
and the default :delay
and :max_attempts
values.
waiter_name | params | :delay | :max_attempts |
---|---|---|---|
endpoint_deleted | #describe_endpoint | 30 | 60 |
endpoint_in_service | #describe_endpoint | 30 | 120 |
image_created | #describe_image | 60 | 60 |
image_deleted | #describe_image | 60 | 60 |
image_updated | #describe_image | 60 | 60 |
image_version_created | #describe_image_version | 60 | 60 |
image_version_deleted | #describe_image_version | 60 | 60 |
notebook_instance_deleted | #describe_notebook_instance | 30 | 60 |
notebook_instance_in_service | #describe_notebook_instance | 30 | 60 |
notebook_instance_stopped | #describe_notebook_instance | 30 | 60 |
processing_job_completed_or_stopped | #describe_processing_job | 60 | 60 |
training_job_completed_or_stopped | #describe_training_job | 120 | 180 |
transform_job_completed_or_stopped | #describe_transform_job | 60 | 60 |
26544 26545 26546 26547 26548 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb', line 26544 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |