AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Interface for accessing SageMaker Definition of the public APIs exposed by SageMaker

Inheritance Hierarchy

Amazon.SageMaker.IAmazonSageMaker

Namespace: Amazon.SageMaker
Assembly: AWSSDK.SageMaker.dll
Version: 3.x.y.z

Syntax

C#
public interface IAmazonSageMaker
         IAmazonService, IDisposable

The IAmazonSageMaker type exposes the following members

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AddTags(AddTagsRequest)

Adds or overwrites one or more tags for the specified Amazon SageMaker resource. You can add tags to notebook instances, training jobs, models, 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 Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

Public Method AddTagsAsync(AddTagsRequest, CancellationToken)

Initiates the asynchronous execution of the AddTags operation.

Public Method CreateEndpoint(CreateEndpointRequest)

Creates an endpoint using the endpoint configuration specified in the request. Amazon SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API.

Use this API only for hosting models using Amazon SageMaker hosting services.

The endpoint name must be unique within an AWS Region in your AWS account.

When it receives the request, Amazon SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them.

When Amazon SageMaker receives the request, it sets the endpoint status to Creating. After it creates the endpoint, it sets the status to InService. Amazon SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API.

For an example, see Exercise 1: Using the K-Means Algorithm Provided by Amazon SageMaker.

If any of the models hosted at this endpoint get model data from an Amazon S3 location, Amazon SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provided. AWS STS is activated in your IAM user account by default. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region. For more information, see Activating and Deactivating AWS STS i an AWS Region in the AWS Identity and Access Management User Guide.

Public Method CreateEndpointAsync(CreateEndpointRequest, CancellationToken)

Initiates the asynchronous execution of the CreateEndpoint operation.

Public Method CreateEndpointConfig(CreateEndpointConfigRequest)

Creates an endpoint configuration that Amazon 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 Amazon SageMaker to provision. Then you call the CreateEndpoint API.

Use this API only if you want to use Amazon SageMaker hosting services to deploy models into production.

In the request, you define one or more ProductionVariants, each of which identifies a model. Each ProductionVariant parameter also describes the resources that you want Amazon 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. Amazon SageMaker distributes two-thirds of the traffic to Model A, and one-third to model B.

Public Method CreateEndpointConfigAsync(CreateEndpointConfigRequest, CancellationToken)

Initiates the asynchronous execution of the CreateEndpointConfig operation.

Public Method CreateHyperParameterTuningJob(CreateHyperParameterTuningJobRequest)

Starts a hyperparameter tuning job.

Public Method CreateHyperParameterTuningJobAsync(CreateHyperParameterTuningJobRequest, CancellationToken)

Initiates the asynchronous execution of the CreateHyperParameterTuningJob operation.

Public Method CreateModel(CreateModelRequest)

Creates a model in Amazon SageMaker. In the request, you name the model and describe one or more containers. For each container, you specify the docker image containing inference code, artifacts (from prior training), and custom environment map that the inference code uses when you deploy the model into production.

Use this API to create a model only if you want to use Amazon SageMaker hosting services. To host your model, you create an endpoint configuration with the CreateEndpointConfig API, and then create an endpoint with the CreateEndpoint API.

Amazon SageMaker then deploys all of the containers that you defined for the model in the hosting environment.

In the CreateModel request, you must define a container with the PrimaryContainer parameter.

In the request, you also provide an IAM role that Amazon SageMaker can assume to access model artifacts and docker image for deployment on ML compute hosting instances. In addition, you also use the IAM role to manage permissions the inference code needs. For example, if the inference code access any other AWS resources, you grant necessary permissions via this role.

Public Method CreateModelAsync(CreateModelRequest, CancellationToken)

Initiates the asynchronous execution of the CreateModel operation.

Public Method CreateNotebookInstance(CreateNotebookInstanceRequest)

Creates an Amazon 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. Amazon 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.

Amazon SageMaker also provides a set of example notebooks. Each notebook demonstrates how to use Amazon SageMaker with a specific algorithm or with a machine learning framework.

After receiving the request, Amazon SageMaker does the following:

  1. Creates a network interface in the Amazon SageMaker VPC.

  2. (Option) If you specified SubnetId, Amazon 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, Amazon SageMaker attaches the security group that you specified in the request to the network interface that it creates in your VPC.

  3. Launches an EC2 instance of the type specified in the request in the Amazon SageMaker VPC. If you specified SubnetId of your VPC, Amazon 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, Amazon SageMaker returns its Amazon Resource Name (ARN).

After Amazon 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 Amazon SageMaker endpoints, and validate hosted models.

For more information, see How It Works.

Public Method CreateNotebookInstanceAsync(CreateNotebookInstanceRequest, CancellationToken)

Initiates the asynchronous execution of the CreateNotebookInstance operation.

Public Method CreateNotebookInstanceLifecycleConfig(CreateNotebookInstanceLifecycleConfigRequest)

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 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 notebook-lifecycle-config.

Public Method CreateNotebookInstanceLifecycleConfigAsync(CreateNotebookInstanceLifecycleConfigRequest, CancellationToken)

Initiates the asynchronous execution of the CreateNotebookInstanceLifecycleConfig operation.

Public Method CreatePresignedNotebookInstanceUrl(CreatePresignedNotebookInstanceUrlRequest)

Returns a URL that you can use to connect to the Jupyter server from a notebook instance. In the Amazon SageMaker console, when you choose Open next to a notebook instance, Amazon 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.

Public Method CreatePresignedNotebookInstanceUrlAsync(CreatePresignedNotebookInstanceUrlRequest, CancellationToken)

Initiates the asynchronous execution of the CreatePresignedNotebookInstanceUrl operation.

Public Method CreateTrainingJob(CreateTrainingJobRequest)

Starts a model training job. After training completes, Amazon SageMaker saves the resulting model artifacts to an Amazon S3 location 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 in a deep learning service other than Amazon SageMaker, provided that you know how to use them for inferences.

In the request body, you provide the following:

  • AlgorithmSpecification - Identifies the training algorithm to use.

  • HyperParameters - Specify these algorithm-specific parameters to influence the quality of the final model. For a list of hyperparameters for each training algorithm provided by Amazon SageMaker, see Algorithms.

  • InputDataConfig - Describes the training dataset and the Amazon S3 location where it is stored.

  • OutputDataConfig - Identifies the Amazon S3 location where you want Amazon 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.

  • RoleARN - The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during model training. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete model training.

  • StoppingCondition - Sets a duration for training. Use this parameter to cap model training costs.

For more information about Amazon SageMaker, see How It Works.

Public Method CreateTrainingJobAsync(CreateTrainingJobRequest, CancellationToken)

Initiates the asynchronous execution of the CreateTrainingJob operation.

Public Method CreateTransformJob(CreateTransformJobRequest)

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 AWS Region in an AWS account.

  • ModelName - Identifies the model to use. ModelName must be the name of an existing Amazon SageMaker model within an AWS Region in an AWS account.

  • 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 Amazon SageMaker, see How It Works.

Public Method CreateTransformJobAsync(CreateTransformJobRequest, CancellationToken)

Initiates the asynchronous execution of the CreateTransformJob operation.

Public Method DeleteEndpoint(DeleteEndpointRequest)

Deletes an endpoint. Amazon SageMaker frees up all of the resources that were deployed when the endpoint was created.

Amazon SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't need to use the RevokeGrant API call.

Public Method DeleteEndpointAsync(DeleteEndpointRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteEndpoint operation.

Public Method DeleteEndpointConfig(DeleteEndpointConfigRequest)

Deletes an endpoint configuration. The DeleteEndpointConfig API deletes only the specified configuration. It does not delete endpoints created using the configuration.

Public Method DeleteEndpointConfigAsync(DeleteEndpointConfigRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteEndpointConfig operation.

Public Method DeleteModel(DeleteModelRequest)

Deletes a model. The DeleteModel API deletes only the model entry that was created in Amazon 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.

Public Method DeleteModelAsync(DeleteModelRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteModel operation.

Public Method DeleteNotebookInstance(DeleteNotebookInstanceRequest)

Deletes an Amazon 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. Amazon SageMaker removes the ML compute instance, and deletes the ML storage volume and the network interface associated with the notebook instance.

Public Method DeleteNotebookInstanceAsync(DeleteNotebookInstanceRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteNotebookInstance operation.

Public Method DeleteNotebookInstanceLifecycleConfig(DeleteNotebookInstanceLifecycleConfigRequest)

Deletes a notebook instance lifecycle configuration.

Public Method DeleteNotebookInstanceLifecycleConfigAsync(DeleteNotebookInstanceLifecycleConfigRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteNotebookInstanceLifecycleConfig operation.

Public Method DeleteTags(DeleteTagsRequest)

Deletes the specified tags from an Amazon SageMaker resource.

To list a resource's tags, use the ListTags API.

Public Method DeleteTagsAsync(DeleteTagsRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteTags operation.

Public Method DescribeEndpoint(DescribeEndpointRequest)

Returns the description of an endpoint.

Public Method DescribeEndpointAsync(DescribeEndpointRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeEndpoint operation.

Public Method DescribeEndpointConfig(DescribeEndpointConfigRequest)

Returns the description of an endpoint configuration created using the CreateEndpointConfig API.

Public Method DescribeEndpointConfigAsync(DescribeEndpointConfigRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeEndpointConfig operation.

Public Method DescribeHyperParameterTuningJob(DescribeHyperParameterTuningJobRequest)

Gets a description of a hyperparameter tuning job.

Public Method DescribeHyperParameterTuningJobAsync(DescribeHyperParameterTuningJobRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeHyperParameterTuningJob operation.

Public Method DescribeModel(DescribeModelRequest)

Describes a model that you created using the CreateModel API.

Public Method DescribeModelAsync(DescribeModelRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeModel operation.

Public Method DescribeNotebookInstance(DescribeNotebookInstanceRequest)

Returns information about a notebook instance.

Public Method DescribeNotebookInstanceAsync(DescribeNotebookInstanceRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeNotebookInstance operation.

Public Method DescribeNotebookInstanceLifecycleConfig(DescribeNotebookInstanceLifecycleConfigRequest)

Returns a description of a notebook instance lifecycle configuration.

For information about notebook instance lifestyle configurations, see notebook-lifecycle-config.

Public Method DescribeNotebookInstanceLifecycleConfigAsync(DescribeNotebookInstanceLifecycleConfigRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeNotebookInstanceLifecycleConfig operation.

Public Method DescribeTrainingJob(DescribeTrainingJobRequest)

Returns information about a training job.

Public Method DescribeTrainingJobAsync(DescribeTrainingJobRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeTrainingJob operation.

Public Method DescribeTransformJob(DescribeTransformJobRequest)

Returns information about a transform job.

Public Method DescribeTransformJobAsync(DescribeTransformJobRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeTransformJob operation.

Public Method ListEndpointConfigs(ListEndpointConfigsRequest)

Lists endpoint configurations.

Public Method ListEndpointConfigsAsync(ListEndpointConfigsRequest, CancellationToken)

Initiates the asynchronous execution of the ListEndpointConfigs operation.

Public Method ListEndpoints(ListEndpointsRequest)

Lists endpoints.

Public Method ListEndpointsAsync(ListEndpointsRequest, CancellationToken)

Initiates the asynchronous execution of the ListEndpoints operation.

Public Method ListHyperParameterTuningJobs(ListHyperParameterTuningJobsRequest)

Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.

Public Method ListHyperParameterTuningJobsAsync(ListHyperParameterTuningJobsRequest, CancellationToken)

Initiates the asynchronous execution of the ListHyperParameterTuningJobs operation.

Public Method ListModels(ListModelsRequest)

Lists models created with the CreateModel API.

Public Method ListModelsAsync(ListModelsRequest, CancellationToken)

Initiates the asynchronous execution of the ListModels operation.

Public Method ListNotebookInstanceLifecycleConfigs(ListNotebookInstanceLifecycleConfigsRequest)

Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.

Public Method ListNotebookInstanceLifecycleConfigsAsync(ListNotebookInstanceLifecycleConfigsRequest, CancellationToken)

Initiates the asynchronous execution of the ListNotebookInstanceLifecycleConfigs operation.

Public Method ListNotebookInstances(ListNotebookInstancesRequest)

Returns a list of the Amazon SageMaker notebook instances in the requester's account in an AWS Region.

Public Method ListNotebookInstancesAsync(ListNotebookInstancesRequest, CancellationToken)

Initiates the asynchronous execution of the ListNotebookInstances operation.

Public Method ListTags(ListTagsRequest)

Returns the tags for the specified Amazon SageMaker resource.

Public Method ListTagsAsync(ListTagsRequest, CancellationToken)

Initiates the asynchronous execution of the ListTags operation.

Public Method ListTrainingJobs(ListTrainingJobsRequest)

Lists training jobs.

Public Method ListTrainingJobsAsync(ListTrainingJobsRequest, CancellationToken)

Initiates the asynchronous execution of the ListTrainingJobs operation.

Public Method ListTrainingJobsForHyperParameterTuningJob(ListTrainingJobsForHyperParameterTuningJobRequest)

Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched.

Public Method ListTrainingJobsForHyperParameterTuningJobAsync(ListTrainingJobsForHyperParameterTuningJobRequest, CancellationToken)

Initiates the asynchronous execution of the ListTrainingJobsForHyperParameterTuningJob operation.

Public Method ListTransformJobs(ListTransformJobsRequest)

Lists transform jobs.

Public Method ListTransformJobsAsync(ListTransformJobsRequest, CancellationToken)

Initiates the asynchronous execution of the ListTransformJobs operation.

Public Method StartNotebookInstance(StartNotebookInstanceRequest)

Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume. After configuring the notebook instance, Amazon SageMaker sets the notebook instance status to InService. A notebook instance's status must be InService before you can connect to your Jupyter notebook.

Public Method StartNotebookInstanceAsync(StartNotebookInstanceRequest, CancellationToken)

Initiates the asynchronous execution of the StartNotebookInstance operation.

Public Method StopHyperParameterTuningJob(StopHyperParameterTuningJobRequest)

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.

Public Method StopHyperParameterTuningJobAsync(StopHyperParameterTuningJobRequest, CancellationToken)

Initiates the asynchronous execution of the StopHyperParameterTuningJob operation.

Public Method StopNotebookInstance(StopNotebookInstanceRequest)

Terminates the ML compute instance. Before terminating the instance, Amazon SageMaker disconnects the ML storage volume from it. Amazon SageMaker preserves the ML storage volume.

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.

Public Method StopNotebookInstanceAsync(StopNotebookInstanceRequest, CancellationToken)

Initiates the asynchronous execution of the StopNotebookInstance operation.

Public Method StopTrainingJob(StopTrainingJobRequest)

Stops a training job. To stop a job, Amazon 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.

Training algorithms provided by Amazon SageMaker save the intermediate results of a model training job. This intermediate data is a valid model artifact. You can use the model artifacts that are saved when Amazon SageMaker stops a training job to create a model.

When it receives a StopTrainingJob request, Amazon SageMaker changes the status of the job to Stopping. After Amazon SageMaker stops the job, it sets the status to Stopped.

Public Method StopTrainingJobAsync(StopTrainingJobRequest, CancellationToken)

Initiates the asynchronous execution of the StopTrainingJob operation.

Public Method StopTransformJob(StopTransformJobRequest)

Stops a 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 transform job before it is completed, Amazon SageMaker doesn't store the job's output in Amazon S3.

Public Method StopTransformJobAsync(StopTransformJobRequest, CancellationToken)

Initiates the asynchronous execution of the StopTransformJob operation.

Public Method UpdateEndpoint(UpdateEndpointRequest)

Deploys the new EndpointConfig specified in the request, switches to using newly created endpoint, and then deletes resources provisioned for the endpoint using the previous EndpointConfig (there is no availability loss).

When Amazon 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.

You cannot update an endpoint with the current EndpointConfig. To update an endpoint, you must create a new EndpointConfig.

Public Method UpdateEndpointAsync(UpdateEndpointRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateEndpoint operation.

Public Method UpdateEndpointWeightsAndCapacities(UpdateEndpointWeightsAndCapacitiesRequest)

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, Amazon 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.

Public Method UpdateEndpointWeightsAndCapacitiesAsync(UpdateEndpointWeightsAndCapacitiesRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateEndpointWeightsAndCapacities operation.

Public Method UpdateNotebookInstance(UpdateNotebookInstanceRequest)

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. You can also update the VPC security groups.

Public Method UpdateNotebookInstanceAsync(UpdateNotebookInstanceRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateNotebookInstance operation.

Public Method UpdateNotebookInstanceLifecycleConfig(UpdateNotebookInstanceLifecycleConfigRequest)

Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API.

Public Method UpdateNotebookInstanceLifecycleConfigAsync(UpdateNotebookInstanceLifecycleConfigRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateNotebookInstanceLifecycleConfig operation.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms