AmazonSageMaker (AWS SDK for Java

All Known Subinterfaces:

AmazonSageMakerAsync

All Known Implementing Classes:

AbstractAmazonSageMaker, AbstractAmazonSageMakerAsync, AmazonSageMakerAsyncClient, AmazonSageMakerClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonSageMaker
```
Interface for accessing SageMaker.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonSageMaker instead.

Provides APIs for creating and managing Amazon SageMaker resources.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AddTagsResult`	`addTags(AddTagsRequest addTagsRequest)` Adds or overwrites one or more tags for the specified Amazon SageMaker resource.
`CreateAlgorithmResult`	`createAlgorithm(CreateAlgorithmRequest createAlgorithmRequest)` Create a machine learning algorithm that you can use in Amazon SageMaker and list in the AWS Marketplace.
`CreateCodeRepositoryResult`	`createCodeRepository(CreateCodeRepositoryRequest createCodeRepositoryRequest)` Creates a Git repository as a resource in your Amazon SageMaker account.
`CreateCompilationJobResult`	`createCompilationJob(CreateCompilationJobRequest createCompilationJobRequest)` Starts a model compilation job.
`CreateEndpointResult`	`createEndpoint(CreateEndpointRequest createEndpointRequest)` Creates an endpoint using the endpoint configuration specified in the request.
`CreateEndpointConfigResult`	`createEndpointConfig(CreateEndpointConfigRequest createEndpointConfigRequest)` Creates an endpoint configuration that Amazon SageMaker hosting services uses to deploy models.
`CreateHyperParameterTuningJobResult`	`createHyperParameterTuningJob(CreateHyperParameterTuningJobRequest createHyperParameterTuningJobRequest)` Starts a hyperparameter tuning job.
`CreateLabelingJobResult`	`createLabelingJob(CreateLabelingJobRequest createLabelingJobRequest)` Creates a job that uses workers to label the data objects in your input dataset.
`CreateModelResult`	`createModel(CreateModelRequest createModelRequest)` Creates a model in Amazon SageMaker.
`CreateModelPackageResult`	`createModelPackage(CreateModelPackageRequest createModelPackageRequest)` Creates a model package that you can use to create Amazon SageMaker models or list on AWS Marketplace.
`CreateNotebookInstanceResult`	`createNotebookInstance(CreateNotebookInstanceRequest createNotebookInstanceRequest)` Creates an Amazon SageMaker notebook instance.
`CreateNotebookInstanceLifecycleConfigResult`	`createNotebookInstanceLifecycleConfig(CreateNotebookInstanceLifecycleConfigRequest createNotebookInstanceLifecycleConfigRequest)` Creates a lifecycle configuration that you can associate with a notebook instance.
`CreatePresignedNotebookInstanceUrlResult`	`createPresignedNotebookInstanceUrl(CreatePresignedNotebookInstanceUrlRequest createPresignedNotebookInstanceUrlRequest)` Returns a URL that you can use to connect to the Jupyter server from a notebook instance.
`CreateTrainingJobResult`	`createTrainingJob(CreateTrainingJobRequest createTrainingJobRequest)` Starts a model training job.
`CreateTransformJobResult`	`createTransformJob(CreateTransformJobRequest createTransformJobRequest)` Starts a transform job.
`CreateWorkteamResult`	`createWorkteam(CreateWorkteamRequest createWorkteamRequest)` Creates a new work team for labeling your data.
`DeleteAlgorithmResult`	`deleteAlgorithm(DeleteAlgorithmRequest deleteAlgorithmRequest)` Removes the specified algorithm from your account.
`DeleteCodeRepositoryResult`	`deleteCodeRepository(DeleteCodeRepositoryRequest deleteCodeRepositoryRequest)` Deletes the specified Git repository from your account.
`DeleteEndpointResult`	`deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)` Deletes an endpoint.
`DeleteEndpointConfigResult`	`deleteEndpointConfig(DeleteEndpointConfigRequest deleteEndpointConfigRequest)` Deletes an endpoint configuration.
`DeleteModelResult`	`deleteModel(DeleteModelRequest deleteModelRequest)` Deletes a model.
`DeleteModelPackageResult`	`deleteModelPackage(DeleteModelPackageRequest deleteModelPackageRequest)` Deletes a model package.
`DeleteNotebookInstanceResult`	`deleteNotebookInstance(DeleteNotebookInstanceRequest deleteNotebookInstanceRequest)` Deletes an Amazon SageMaker notebook instance.
`DeleteNotebookInstanceLifecycleConfigResult`	`deleteNotebookInstanceLifecycleConfig(DeleteNotebookInstanceLifecycleConfigRequest deleteNotebookInstanceLifecycleConfigRequest)` Deletes a notebook instance lifecycle configuration.
`DeleteTagsResult`	`deleteTags(DeleteTagsRequest deleteTagsRequest)` Deletes the specified tags from an Amazon SageMaker resource.
`DeleteWorkteamResult`	`deleteWorkteam(DeleteWorkteamRequest deleteWorkteamRequest)` Deletes an existing work team.
`DescribeAlgorithmResult`	`describeAlgorithm(DescribeAlgorithmRequest describeAlgorithmRequest)` Returns a description of the specified algorithm that is in your account.
`DescribeCodeRepositoryResult`	`describeCodeRepository(DescribeCodeRepositoryRequest describeCodeRepositoryRequest)` Gets details about the specified Git repository.
`DescribeCompilationJobResult`	`describeCompilationJob(DescribeCompilationJobRequest describeCompilationJobRequest)` Returns information about a model compilation job.
`DescribeEndpointResult`	`describeEndpoint(DescribeEndpointRequest describeEndpointRequest)` Returns the description of an endpoint.
`DescribeEndpointConfigResult`	`describeEndpointConfig(DescribeEndpointConfigRequest describeEndpointConfigRequest)` Returns the description of an endpoint configuration created using the `CreateEndpointConfig` API.
`DescribeHyperParameterTuningJobResult`	`describeHyperParameterTuningJob(DescribeHyperParameterTuningJobRequest describeHyperParameterTuningJobRequest)` Gets a description of a hyperparameter tuning job.
`DescribeLabelingJobResult`	`describeLabelingJob(DescribeLabelingJobRequest describeLabelingJobRequest)` Gets information about a labeling job.
`DescribeModelResult`	`describeModel(DescribeModelRequest describeModelRequest)` Describes a model that you created using the `CreateModel` API.
`DescribeModelPackageResult`	`describeModelPackage(DescribeModelPackageRequest describeModelPackageRequest)` Returns a description of the specified model package, which is used to create Amazon SageMaker models or list them on AWS Marketplace.
`DescribeNotebookInstanceResult`	`describeNotebookInstance(DescribeNotebookInstanceRequest describeNotebookInstanceRequest)` Returns information about a notebook instance.
`DescribeNotebookInstanceLifecycleConfigResult`	`describeNotebookInstanceLifecycleConfig(DescribeNotebookInstanceLifecycleConfigRequest describeNotebookInstanceLifecycleConfigRequest)` Returns a description of a notebook instance lifecycle configuration.
`DescribeSubscribedWorkteamResult`	`describeSubscribedWorkteam(DescribeSubscribedWorkteamRequest describeSubscribedWorkteamRequest)` Gets information about a work team provided by a vendor.
`DescribeTrainingJobResult`	`describeTrainingJob(DescribeTrainingJobRequest describeTrainingJobRequest)` Returns information about a training job.
`DescribeTransformJobResult`	`describeTransformJob(DescribeTransformJobRequest describeTransformJobRequest)` Returns information about a transform job.
`DescribeWorkteamResult`	`describeWorkteam(DescribeWorkteamRequest describeWorkteamRequest)` Gets information about a specific work team.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetSearchSuggestionsResult`	`getSearchSuggestions(GetSearchSuggestionsRequest getSearchSuggestionsRequest)` An auto-complete API for the search functionality in the Amazon SageMaker console.
`ListAlgorithmsResult`	`listAlgorithms(ListAlgorithmsRequest listAlgorithmsRequest)` Lists the machine learning algorithms that have been created.
`ListCodeRepositoriesResult`	`listCodeRepositories(ListCodeRepositoriesRequest listCodeRepositoriesRequest)` Gets a list of the Git repositories in your account.
`ListCompilationJobsResult`	`listCompilationJobs(ListCompilationJobsRequest listCompilationJobsRequest)` Lists model compilation jobs that satisfy various filters.
`ListEndpointConfigsResult`	`listEndpointConfigs(ListEndpointConfigsRequest listEndpointConfigsRequest)` Lists endpoint configurations.
`ListEndpointsResult`	`listEndpoints(ListEndpointsRequest listEndpointsRequest)` Lists endpoints.
`ListHyperParameterTuningJobsResult`	`listHyperParameterTuningJobs(ListHyperParameterTuningJobsRequest listHyperParameterTuningJobsRequest)` Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.
`ListLabelingJobsResult`	`listLabelingJobs(ListLabelingJobsRequest listLabelingJobsRequest)` Gets a list of labeling jobs.
`ListLabelingJobsForWorkteamResult`	`listLabelingJobsForWorkteam(ListLabelingJobsForWorkteamRequest listLabelingJobsForWorkteamRequest)` Gets a list of labeling jobs assigned to a specified work team.
`ListModelPackagesResult`	`listModelPackages(ListModelPackagesRequest listModelPackagesRequest)` Lists the model packages that have been created.
`ListModelsResult`	`listModels(ListModelsRequest listModelsRequest)` Lists models created with the CreateModel API.
`ListNotebookInstanceLifecycleConfigsResult`	`listNotebookInstanceLifecycleConfigs(ListNotebookInstanceLifecycleConfigsRequest listNotebookInstanceLifecycleConfigsRequest)` Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.
`ListNotebookInstancesResult`	`listNotebookInstances(ListNotebookInstancesRequest listNotebookInstancesRequest)` Returns a list of the Amazon SageMaker notebook instances in the requester's account in an AWS Region.
`ListSubscribedWorkteamsResult`	`listSubscribedWorkteams(ListSubscribedWorkteamsRequest listSubscribedWorkteamsRequest)` Gets a list of the work teams that you are subscribed to in the AWS Marketplace.
`ListTagsResult`	`listTags(ListTagsRequest listTagsRequest)` Returns the tags for the specified Amazon SageMaker resource.
`ListTrainingJobsResult`	`listTrainingJobs(ListTrainingJobsRequest listTrainingJobsRequest)` Lists training jobs.
`ListTrainingJobsForHyperParameterTuningJobResult`	`listTrainingJobsForHyperParameterTuningJob(ListTrainingJobsForHyperParameterTuningJobRequest listTrainingJobsForHyperParameterTuningJobRequest)` Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched.
`ListTransformJobsResult`	`listTransformJobs(ListTransformJobsRequest listTransformJobsRequest)` Lists transform jobs.
`ListWorkteamsResult`	`listWorkteams(ListWorkteamsRequest listWorkteamsRequest)` Gets a list of work teams that you have defined in a region.
`RenderUiTemplateResult`	`renderUiTemplate(RenderUiTemplateRequest renderUiTemplateRequest)` Renders the UI template so that you can preview the worker's experience.
`SearchResult`	`search(SearchRequest searchRequest)` Finds Amazon SageMaker resources that match a search query.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartNotebookInstanceResult`	`startNotebookInstance(StartNotebookInstanceRequest startNotebookInstanceRequest)` Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume.
`StopCompilationJobResult`	`stopCompilationJob(StopCompilationJobRequest stopCompilationJobRequest)` Stops a model compilation job.
`StopHyperParameterTuningJobResult`	`stopHyperParameterTuningJob(StopHyperParameterTuningJobRequest stopHyperParameterTuningJobRequest)` Stops a running hyperparameter tuning job and all running training jobs that the tuning job launched.
`StopLabelingJobResult`	`stopLabelingJob(StopLabelingJobRequest stopLabelingJobRequest)` Stops a running labeling job.
`StopNotebookInstanceResult`	`stopNotebookInstance(StopNotebookInstanceRequest stopNotebookInstanceRequest)` Terminates the ML compute instance.
`StopTrainingJobResult`	`stopTrainingJob(StopTrainingJobRequest stopTrainingJobRequest)` Stops a training job.
`StopTransformJobResult`	`stopTransformJob(StopTransformJobRequest stopTransformJobRequest)` Stops a transform job.
`UpdateCodeRepositoryResult`	`updateCodeRepository(UpdateCodeRepositoryRequest updateCodeRepositoryRequest)` Updates the specified Git repository with the specified values.
`UpdateEndpointResult`	`updateEndpoint(UpdateEndpointRequest 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).
`UpdateEndpointWeightsAndCapacitiesResult`	`updateEndpointWeightsAndCapacities(UpdateEndpointWeightsAndCapacitiesRequest updateEndpointWeightsAndCapacitiesRequest)` Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant associated with an existing endpoint.
`UpdateNotebookInstanceResult`	`updateNotebookInstance(UpdateNotebookInstanceRequest updateNotebookInstanceRequest)` Updates a notebook instance.
`UpdateNotebookInstanceLifecycleConfigResult`	`updateNotebookInstanceLifecycleConfig(UpdateNotebookInstanceLifecycleConfigRequest updateNotebookInstanceLifecycleConfigRequest)` Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API.
`UpdateWorkteamResult`	`updateWorkteam(UpdateWorkteamRequest updateWorkteamRequest)` Updates an existing work team with new member definitions or description.
`AmazonSageMakerWaiters`	`waiters()`

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - addTags
```
AddTagsResult addTags(AddTagsRequest addTagsRequest)
```
    Adds or overwrites one or more tags for the specified Amazon 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 AWS Tagging Strategies.
    
    Tags that you add to a hyperparameter tuning job by calling this API are also added to any training jobs that the hyperparameter tuning job launches after you call this API, but not to training jobs that the hyperparameter tuning job launched before you called this API. To make sure that the tags associated with a hyperparameter tuning job are also added to all training jobs that the hyperparameter tuning job launches, add the tags when you first create the tuning job by specifying them in the Tags parameter of CreateHyperParameterTuningJob
    
    Parameters:
    
    addTagsRequest -
    
    Returns:
    
    Result of the AddTags operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createAlgorithm
```
CreateAlgorithmResult createAlgorithm(CreateAlgorithmRequest createAlgorithmRequest)
```
    Create a machine learning algorithm that you can use in Amazon SageMaker and list in the AWS Marketplace.
    
    Parameters:
    
    createAlgorithmRequest -
    
    Returns:
    
    Result of the CreateAlgorithm operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createCodeRepository
```
CreateCodeRepositoryResult createCodeRepository(CreateCodeRepositoryRequest createCodeRepositoryRequest)
```
    Creates a Git repository as a resource in your Amazon 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 Amazon 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 AWS CodeCommit or in any other Git repository.
    
    Parameters:
    
    createCodeRepositoryRequest -
    
    Returns:
    
    Result of the CreateCodeRepository operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createCompilationJob
```
CreateCompilationJobResult createCompilationJob(CreateCompilationJobRequest createCompilationJobRequest)
```
    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 AWS 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.
    Parameters:
    
    createCompilationJobRequest -
    
    Returns:
    
    Result of the CreateCompilationJob operation returned by the service.
    
    Throws:
    
    ResourceInUseException - Resource being accessed is in use.
    
    ResourceLimitExceededException - You have exceeded an Amazon SageMaker resource limit. For example, you might have too many training jobs created.
    
    See Also:
    
    AWS API Documentation
  - createEndpoint
```
CreateEndpointResult createEndpoint(CreateEndpointRequest 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.
    
    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. To update an endpoint, you must create a new EndpointConfig.
    
    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.
    
    Parameters:
    
    createEndpointRequest -
    
    Returns:
    
    Result of the CreateEndpoint operation returned by the service.
    
    Throws:
    
    ResourceLimitExceededException - You have exceeded an Amazon SageMaker resource limit. For example, you might have too many training jobs created.
    
    See Also:
    
    AWS API Documentation
  - createEndpointConfig
```
CreateEndpointConfigResult createEndpointConfig(CreateEndpointConfigRequest 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.
    
    Parameters:
    
    createEndpointConfigRequest -
    
    Returns:
    
    Result of the CreateEndpointConfig operation returned by the service.
    
    Throws:
    
    ResourceLimitExceededException - You have exceeded an Amazon SageMaker resource limit. For example, you might have too many training jobs created.
    
    See Also:
    
    AWS API Documentation
  - createHyperParameterTuningJob
```
CreateHyperParameterTuningJobResult createHyperParameterTuningJob(CreateHyperParameterTuningJobRequest createHyperParameterTuningJobRequest)
```
    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.
    
    Parameters:
    
    createHyperParameterTuningJobRequest -
    
    Returns:
    
    Result of the CreateHyperParameterTuningJob operation returned by the service.
    
    Throws:
    
    ResourceInUseException - Resource being accessed is in use.
    
    ResourceLimitExceededException - You have exceeded an Amazon SageMaker resource limit. For example, you might have too many training jobs created.
    
    See Also:
    
    AWS API Documentation
  - createLabelingJob
```
CreateLabelingJobResult createLabelingJob(CreateLabelingJobRequest createLabelingJobRequest)
```
    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 AWS 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.
    Parameters:
    
    createLabelingJobRequest -
    
    Returns:
    
    Result of the CreateLabelingJob operation returned by the service.
    
    Throws:
    
    ResourceInUseException - Resource being accessed is in use.
    
    ResourceLimitExceededException - You have exceeded an Amazon SageMaker resource limit. For example, you might have too many training jobs created.
    
    See Also:
    
    AWS API Documentation
  - createModel
```
CreateModelResult createModel(CreateModelRequest createModelRequest)
```
    Creates a model in Amazon SageMaker. In the request, you name the model and describe a primary container. For the primary 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 for predictions.
    
    Use this API to create a model if you want to use Amazon 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. Amazon 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. Amazon SageMaker uses your model and your dataset to get inferences which are then saved to a specified S3 location.
    
    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 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 AWS resources, you grant necessary permissions via this role.
    
    Parameters:
    
    createModelRequest -
    
    Returns:
    
    Result of the CreateModel operation returned by the service.
    
    Throws:
    
    ResourceLimitExceededException - You have exceeded an Amazon SageMaker resource limit. For example, you might have too many training jobs created.
    
    See Also:
    
    AWS API Documentation
  - createModelPackage
```
CreateModelPackageResult createModelPackage(CreateModelPackageRequest createModelPackageRequest)
```
    Creates a model package that you can use to create Amazon SageMaker models or list on AWS Marketplace. Buyers can subscribe to model packages listed on AWS Marketplace to create models in Amazon 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 AWS Marketplace, provide a value for SourceAlgorithmSpecification.
    
    Parameters:
    
    createModelPackageRequest -
    
    Returns:
    
    Result of the CreateModelPackage operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createNotebookInstance
```
CreateNotebookInstanceResult createNotebookInstance(CreateNotebookInstanceRequest 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.
    Parameters:
    
    createNotebookInstanceRequest -
    
    Returns:
    
    Result of the CreateNotebookInstance operation returned by the service.
    
    Throws:
    
    ResourceLimitExceededException - You have exceeded an Amazon SageMaker resource limit. For example, you might have too many training jobs created.
    
    See Also:
    
    AWS API Documentation
  - createNotebookInstanceLifecycleConfig
```
CreateNotebookInstanceLifecycleConfigResult createNotebookInstanceLifecycleConfig(CreateNotebookInstanceLifecycleConfigRequest 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 Step 2.1: (Optional) Customize a Notebook Instance.
    
    Parameters:
    
    createNotebookInstanceLifecycleConfigRequest -
    
    Returns:
    
    Result of the CreateNotebookInstanceLifecycleConfig operation returned by the service.
    
    Throws:
    
    ResourceLimitExceededException - You have exceeded an Amazon SageMaker resource limit. For example, you might have too many training jobs created.
    
    See Also:
    
    AWS API Documentation
  - createPresignedNotebookInstanceUrl
```
CreatePresignedNotebookInstanceUrlResult createPresignedNotebookInstanceUrl(CreatePresignedNotebookInstanceUrlRequest 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.
    
    IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the notebook instance.For example, 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.
    
    The URL that you get from a call to is valid only for 5 minutes. If you try to use the URL after the 5-minute limit expires, you are directed to the AWS console sign-in page.
    
    Parameters:
    
    createPresignedNotebookInstanceUrlRequest -
    
    Returns:
    
    Result of the CreatePresignedNotebookInstanceUrl operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createTrainingJob
```
CreateTrainingJobResult createTrainingJob(CreateTrainingJobRequest 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 machine 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 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 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 time limit for training. Use this parameter to cap model training costs.
    For more information about Amazon SageMaker, see How It Works.
    Parameters:
    
    createTrainingJobRequest -
    
    Returns:
    
    Result of the CreateTrainingJob operation returned by the service.
    
    Throws:
    
    ResourceInUseException - Resource being accessed is in use.
    
    ResourceLimitExceededException - You have exceeded an Amazon SageMaker resource limit. For example, you might have too many training jobs created.
    
    See Also:
    
    AWS API Documentation
  - createTransformJob
```
CreateTransformJobResult createTransformJob(CreateTransformJobRequest 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 in the same AWS Region and AWS 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 Amazon SageMaker, see How It Works.
    Parameters:
    
    createTransformJobRequest -
    
    Returns:
    
    Result of the CreateTransformJob operation returned by the service.
    
    Throws:
    
    ResourceInUseException - Resource being accessed is in use.
    
    ResourceLimitExceededException - You have exceeded an Amazon SageMaker resource limit. For example, you might have too many training jobs created.
    
    See Also:
    
    AWS API Documentation
  - createWorkteam
```
CreateWorkteamResult createWorkteam(CreateWorkteamRequest createWorkteamRequest)
```
    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.
    
    Parameters:
    
    createWorkteamRequest -
    
    Returns:
    
    Result of the CreateWorkteam operation returned by the service.
    
    Throws:
    
    ResourceInUseException - Resource being accessed is in use.
    
    ResourceLimitExceededException - You have exceeded an Amazon SageMaker resource limit. For example, you might have too many training jobs created.
    
    See Also:
    
    AWS API Documentation
  - deleteAlgorithm
```
DeleteAlgorithmResult deleteAlgorithm(DeleteAlgorithmRequest deleteAlgorithmRequest)
```
    Removes the specified algorithm from your account.
    
    Parameters:
    
    deleteAlgorithmRequest -
    
    Returns:
    
    Result of the DeleteAlgorithm operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteCodeRepository
```
DeleteCodeRepositoryResult deleteCodeRepository(DeleteCodeRepositoryRequest deleteCodeRepositoryRequest)
```
    Deletes the specified Git repository from your account.
    
    Parameters:
    
    deleteCodeRepositoryRequest -
    
    Returns:
    
    Result of the DeleteCodeRepository operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteEndpoint
```
DeleteEndpointResult deleteEndpoint(DeleteEndpointRequest 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.
    
    Parameters:
    
    deleteEndpointRequest -
    
    Returns:
    
    Result of the DeleteEndpoint operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteEndpointConfig
```
DeleteEndpointConfigResult deleteEndpointConfig(DeleteEndpointConfigRequest deleteEndpointConfigRequest)
```
    Deletes an endpoint configuration. The DeleteEndpointConfig API deletes only the specified configuration. It does not delete endpoints created using the configuration.
    
    Parameters:
    
    deleteEndpointConfigRequest -
    
    Returns:
    
    Result of the DeleteEndpointConfig operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteModel
```
DeleteModelResult deleteModel(DeleteModelRequest 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.
    
    Parameters:
    
    deleteModelRequest -
    
    Returns:
    
    Result of the DeleteModel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteModelPackage
```
DeleteModelPackageResult deleteModelPackage(DeleteModelPackageRequest deleteModelPackageRequest)
```
    Deletes a model package.
    
    A model package is used to create Amazon SageMaker models or list on AWS Marketplace. Buyers can subscribe to model packages listed on AWS Marketplace to create models in Amazon SageMaker.
    
    Parameters:
    
    deleteModelPackageRequest -
    
    Returns:
    
    Result of the DeleteModelPackage operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteNotebookInstance
```
DeleteNotebookInstanceResult deleteNotebookInstance(DeleteNotebookInstanceRequest 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.
    
    Parameters:
    
    deleteNotebookInstanceRequest -
    
    Returns:
    
    Result of the DeleteNotebookInstance operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteNotebookInstanceLifecycleConfig
```
DeleteNotebookInstanceLifecycleConfigResult deleteNotebookInstanceLifecycleConfig(DeleteNotebookInstanceLifecycleConfigRequest deleteNotebookInstanceLifecycleConfigRequest)
```
    Deletes a notebook instance lifecycle configuration.
    
    Parameters:
    
    deleteNotebookInstanceLifecycleConfigRequest -
    
    Returns:
    
    Result of the DeleteNotebookInstanceLifecycleConfig operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteTags
```
DeleteTagsResult deleteTags(DeleteTagsRequest deleteTagsRequest)
```
    Deletes the specified tags from an Amazon SageMaker resource.
    
    To list a resource's tags, use the ListTags API.
    
    When you call this API to delete tags from a hyperparameter tuning job, the deleted tags are not removed from training jobs that the hyperparameter tuning job launched before you called this API.
    
    Parameters:
    
    deleteTagsRequest -
    
    Returns:
    
    Result of the DeleteTags operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteWorkteam
```
DeleteWorkteamResult deleteWorkteam(DeleteWorkteamRequest deleteWorkteamRequest)
```
    Deletes an existing work team. This operation can't be undone.
    
    Parameters:
    
    deleteWorkteamRequest -
    
    Returns:
    
    Result of the DeleteWorkteam operation returned by the service.
    
    Throws:
    
    ResourceLimitExceededException - You have exceeded an Amazon SageMaker resource limit. For example, you might have too many training jobs created.
    
    See Also:
    
    AWS API Documentation
  - describeAlgorithm
```
DescribeAlgorithmResult describeAlgorithm(DescribeAlgorithmRequest describeAlgorithmRequest)
```
    Returns a description of the specified algorithm that is in your account.
    
    Parameters:
    
    describeAlgorithmRequest -
    
    Returns:
    
    Result of the DescribeAlgorithm operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeCodeRepository
```
DescribeCodeRepositoryResult describeCodeRepository(DescribeCodeRepositoryRequest describeCodeRepositoryRequest)
```
    Gets details about the specified Git repository.
    
    Parameters:
    
    describeCodeRepositoryRequest -
    
    Returns:
    
    Result of the DescribeCodeRepository operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeCompilationJob
```
DescribeCompilationJobResult describeCompilationJob(DescribeCompilationJobRequest describeCompilationJobRequest)
```
    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.
    
    Parameters:
    
    describeCompilationJobRequest -
    
    Returns:
    
    Result of the DescribeCompilationJob operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - Resource being access is not found.
    
    See Also:
    
    AWS API Documentation
  - describeEndpoint
```
DescribeEndpointResult describeEndpoint(DescribeEndpointRequest describeEndpointRequest)
```
    Returns the description of an endpoint.
    
    Parameters:
    
    describeEndpointRequest -
    
    Returns:
    
    Result of the DescribeEndpoint operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeEndpointConfig
```
DescribeEndpointConfigResult describeEndpointConfig(DescribeEndpointConfigRequest describeEndpointConfigRequest)
```
    Returns the description of an endpoint configuration created using the CreateEndpointConfig API.
    
    Parameters:
    
    describeEndpointConfigRequest -
    
    Returns:
    
    Result of the DescribeEndpointConfig operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeHyperParameterTuningJob
```
DescribeHyperParameterTuningJobResult describeHyperParameterTuningJob(DescribeHyperParameterTuningJobRequest describeHyperParameterTuningJobRequest)
```
    Gets a description of a hyperparameter tuning job.
    
    Parameters:
    
    describeHyperParameterTuningJobRequest -
    
    Returns:
    
    Result of the DescribeHyperParameterTuningJob operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - Resource being access is not found.
    
    See Also:
    
    AWS API Documentation
  - describeLabelingJob
```
DescribeLabelingJobResult describeLabelingJob(DescribeLabelingJobRequest describeLabelingJobRequest)
```
    Gets information about a labeling job.
    
    Parameters:
    
    describeLabelingJobRequest -
    
    Returns:
    
    Result of the DescribeLabelingJob operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - Resource being access is not found.
    
    See Also:
    
    AWS API Documentation
  - describeModel
```
DescribeModelResult describeModel(DescribeModelRequest describeModelRequest)
```
    Describes a model that you created using the CreateModel API.
    
    Parameters:
    
    describeModelRequest -
    
    Returns:
    
    Result of the DescribeModel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeModelPackage
```
DescribeModelPackageResult describeModelPackage(DescribeModelPackageRequest describeModelPackageRequest)
```
    Returns a description of the specified model package, which is used to create Amazon SageMaker models or list them on AWS Marketplace.
    
    To create models in Amazon SageMaker, buyers can subscribe to model packages listed on AWS Marketplace.
    
    Parameters:
    
    describeModelPackageRequest -
    
    Returns:
    
    Result of the DescribeModelPackage operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeNotebookInstance
```
DescribeNotebookInstanceResult describeNotebookInstance(DescribeNotebookInstanceRequest describeNotebookInstanceRequest)
```
    Returns information about a notebook instance.
    
    Parameters:
    
    describeNotebookInstanceRequest -
    
    Returns:
    
    Result of the DescribeNotebookInstance operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeNotebookInstanceLifecycleConfig
```
DescribeNotebookInstanceLifecycleConfigResult describeNotebookInstanceLifecycleConfig(DescribeNotebookInstanceLifecycleConfigRequest describeNotebookInstanceLifecycleConfigRequest)
```
    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.
    
    Parameters:
    
    describeNotebookInstanceLifecycleConfigRequest -
    
    Returns:
    
    Result of the DescribeNotebookInstanceLifecycleConfig operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeSubscribedWorkteam
```
DescribeSubscribedWorkteamResult describeSubscribedWorkteam(DescribeSubscribedWorkteamRequest describeSubscribedWorkteamRequest)
```
    Gets information about a work team provided by a vendor. It returns details about the subscription with a vendor in the AWS Marketplace.
    
    Parameters:
    
    describeSubscribedWorkteamRequest -
    
    Returns:
    
    Result of the DescribeSubscribedWorkteam operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeTrainingJob
```
DescribeTrainingJobResult describeTrainingJob(DescribeTrainingJobRequest describeTrainingJobRequest)
```
    Returns information about a training job.
    
    Parameters:
    
    describeTrainingJobRequest -
    
    Returns:
    
    Result of the DescribeTrainingJob operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - Resource being access is not found.
    
    See Also:
    
    AWS API Documentation
  - describeTransformJob
```
DescribeTransformJobResult describeTransformJob(DescribeTransformJobRequest describeTransformJobRequest)
```
    Returns information about a transform job.
    
    Parameters:
    
    describeTransformJobRequest -
    
    Returns:
    
    Result of the DescribeTransformJob operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - Resource being access is not found.
    
    See Also:
    
    AWS API Documentation
  - describeWorkteam
```
DescribeWorkteamResult describeWorkteam(DescribeWorkteamRequest describeWorkteamRequest)
```
    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).
    
    Parameters:
    
    describeWorkteamRequest -
    
    Returns:
    
    Result of the DescribeWorkteam operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getSearchSuggestions
```
GetSearchSuggestionsResult getSearchSuggestions(GetSearchSuggestionsRequest getSearchSuggestionsRequest)
```
    An auto-complete API for the search functionality in the Amazon SageMaker console. It returns suggestions of possible matches for the property name to use in Search queries. Provides suggestions for HyperParameters, Tags, and Metrics.
    
    Parameters:
    
    getSearchSuggestionsRequest -
    
    Returns:
    
    Result of the GetSearchSuggestions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAlgorithms
```
ListAlgorithmsResult listAlgorithms(ListAlgorithmsRequest listAlgorithmsRequest)
```
    Lists the machine learning algorithms that have been created.
    
    Parameters:
    
    listAlgorithmsRequest -
    
    Returns:
    
    Result of the ListAlgorithms operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listCodeRepositories
```
ListCodeRepositoriesResult listCodeRepositories(ListCodeRepositoriesRequest listCodeRepositoriesRequest)
```
    Gets a list of the Git repositories in your account.
    
    Parameters:
    
    listCodeRepositoriesRequest -
    
    Returns:
    
    Result of the ListCodeRepositories operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listCompilationJobs
```
ListCompilationJobsResult listCompilationJobs(ListCompilationJobsRequest listCompilationJobsRequest)
```
    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.
    
    Parameters:
    
    listCompilationJobsRequest -
    
    Returns:
    
    Result of the ListCompilationJobs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listEndpointConfigs
```
ListEndpointConfigsResult listEndpointConfigs(ListEndpointConfigsRequest listEndpointConfigsRequest)
```
    Lists endpoint configurations.
    
    Parameters:
    
    listEndpointConfigsRequest -
    
    Returns:
    
    Result of the ListEndpointConfigs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listEndpoints
```
ListEndpointsResult listEndpoints(ListEndpointsRequest listEndpointsRequest)
```
    Lists endpoints.
    
    Parameters:
    
    listEndpointsRequest -
    
    Returns:
    
    Result of the ListEndpoints operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listHyperParameterTuningJobs
```
ListHyperParameterTuningJobsResult listHyperParameterTuningJobs(ListHyperParameterTuningJobsRequest listHyperParameterTuningJobsRequest)
```
    Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.
    
    Parameters:
    
    listHyperParameterTuningJobsRequest -
    
    Returns:
    
    Result of the ListHyperParameterTuningJobs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listLabelingJobs
```
ListLabelingJobsResult listLabelingJobs(ListLabelingJobsRequest listLabelingJobsRequest)
```
    Gets a list of labeling jobs.
    
    Parameters:
    
    listLabelingJobsRequest -
    
    Returns:
    
    Result of the ListLabelingJobs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listLabelingJobsForWorkteam
```
ListLabelingJobsForWorkteamResult listLabelingJobsForWorkteam(ListLabelingJobsForWorkteamRequest listLabelingJobsForWorkteamRequest)
```
    Gets a list of labeling jobs assigned to a specified work team.
    
    Parameters:
    
    listLabelingJobsForWorkteamRequest -
    
    Returns:
    
    Result of the ListLabelingJobsForWorkteam operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - Resource being access is not found.
    
    See Also:
    
    AWS API Documentation
  - listModelPackages
```
ListModelPackagesResult listModelPackages(ListModelPackagesRequest listModelPackagesRequest)
```
    Lists the model packages that have been created.
    
    Parameters:
    
    listModelPackagesRequest -
    
    Returns:
    
    Result of the ListModelPackages operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listModels
```
ListModelsResult listModels(ListModelsRequest listModelsRequest)
```
    Lists models created with the CreateModel API.
    
    Parameters:
    
    listModelsRequest -
    
    Returns:
    
    Result of the ListModels operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listNotebookInstanceLifecycleConfigs
```
ListNotebookInstanceLifecycleConfigsResult listNotebookInstanceLifecycleConfigs(ListNotebookInstanceLifecycleConfigsRequest listNotebookInstanceLifecycleConfigsRequest)
```
    Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.
    
    Parameters:
    
    listNotebookInstanceLifecycleConfigsRequest -
    
    Returns:
    
    Result of the ListNotebookInstanceLifecycleConfigs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listNotebookInstances
```
ListNotebookInstancesResult listNotebookInstances(ListNotebookInstancesRequest listNotebookInstancesRequest)
```
    Returns a list of the Amazon SageMaker notebook instances in the requester's account in an AWS Region.
    
    Parameters:
    
    listNotebookInstancesRequest -
    
    Returns:
    
    Result of the ListNotebookInstances operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listSubscribedWorkteams
```
ListSubscribedWorkteamsResult listSubscribedWorkteams(ListSubscribedWorkteamsRequest listSubscribedWorkteamsRequest)
```
    Gets a list of the work teams that you are subscribed to in the AWS Marketplace. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.
    
    Parameters:
    
    listSubscribedWorkteamsRequest -
    
    Returns:
    
    Result of the ListSubscribedWorkteams operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTags
```
ListTagsResult listTags(ListTagsRequest listTagsRequest)
```
    Returns the tags for the specified Amazon SageMaker resource.
    
    Parameters:
    
    listTagsRequest -
    
    Returns:
    
    Result of the ListTags operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTrainingJobs
```
ListTrainingJobsResult listTrainingJobs(ListTrainingJobsRequest listTrainingJobsRequest)
```
    Lists training jobs.
    
    Parameters:
    
    listTrainingJobsRequest -
    
    Returns:
    
    Result of the ListTrainingJobs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTrainingJobsForHyperParameterTuningJob
```
ListTrainingJobsForHyperParameterTuningJobResult listTrainingJobsForHyperParameterTuningJob(ListTrainingJobsForHyperParameterTuningJobRequest listTrainingJobsForHyperParameterTuningJobRequest)
```
    Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched.
    
    Parameters:
    
    listTrainingJobsForHyperParameterTuningJobRequest -
    
    Returns:
    
    Result of the ListTrainingJobsForHyperParameterTuningJob operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - Resource being access is not found.
    
    See Also:
    
    AWS API Documentation
  - listTransformJobs
```
ListTransformJobsResult listTransformJobs(ListTransformJobsRequest listTransformJobsRequest)
```
    Lists transform jobs.
    
    Parameters:
    
    listTransformJobsRequest -
    
    Returns:
    
    Result of the ListTransformJobs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listWorkteams
```
ListWorkteamsResult listWorkteams(ListWorkteamsRequest listWorkteamsRequest)
```
    Gets a list of 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.
    
    Parameters:
    
    listWorkteamsRequest -
    
    Returns:
    
    Result of the ListWorkteams operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - renderUiTemplate
```
RenderUiTemplateResult renderUiTemplate(RenderUiTemplateRequest renderUiTemplateRequest)
```
    Renders the UI template so that you can preview the worker's experience.
    
    Parameters:
    
    renderUiTemplateRequest -
    
    Returns:
    
    Result of the RenderUiTemplate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - search
```
SearchResult search(SearchRequest searchRequest)
```
    Finds Amazon SageMaker resources that match a search query. Matching resource objects are returned as a list of SearchResult 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: numerical, text, Booleans, and timestamps.
    
    Parameters:
    
    searchRequest -
    
    Returns:
    
    Result of the Search operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startNotebookInstance
```
StartNotebookInstanceResult startNotebookInstance(StartNotebookInstanceRequest 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.
    
    Parameters:
    
    startNotebookInstanceRequest -
    
    Returns:
    
    Result of the StartNotebookInstance operation returned by the service.
    
    Throws:
    
    ResourceLimitExceededException - You have exceeded an Amazon SageMaker resource limit. For example, you might have too many training jobs created.
    
    See Also:
    
    AWS API Documentation
  - stopCompilationJob
```
StopCompilationJobResult stopCompilationJob(StopCompilationJobRequest stopCompilationJobRequest)
```
    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 CompilationJobSummary$CompilationJobStatus of the job to Stopping. After Amazon SageMaker stops the job, it sets the CompilationJobSummary$CompilationJobStatus to Stopped.
    
    Parameters:
    
    stopCompilationJobRequest -
    
    Returns:
    
    Result of the StopCompilationJob operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - Resource being access is not found.
    
    See Also:
    
    AWS API Documentation
  - stopHyperParameterTuningJob
```
StopHyperParameterTuningJobResult stopHyperParameterTuningJob(StopHyperParameterTuningJobRequest 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.
    
    Parameters:
    
    stopHyperParameterTuningJobRequest -
    
    Returns:
    
    Result of the StopHyperParameterTuningJob operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - Resource being access is not found.
    
    See Also:
    
    AWS API Documentation
  - stopLabelingJob
```
StopLabelingJobResult stopLabelingJob(StopLabelingJobRequest stopLabelingJobRequest)
```
    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.
    
    Parameters:
    
    stopLabelingJobRequest -
    
    Returns:
    
    Result of the StopLabelingJob operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - Resource being access is not found.
    
    See Also:
    
    AWS API Documentation
  - stopNotebookInstance
```
StopNotebookInstanceResult stopNotebookInstance(StopNotebookInstanceRequest 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. Amazon 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.
    
    Parameters:
    
    stopNotebookInstanceRequest -
    
    Returns:
    
    Result of the StopNotebookInstance operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopTrainingJob
```
StopTrainingJobResult stopTrainingJob(StopTrainingJobRequest 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.
    
    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.
    
    Parameters:
    
    stopTrainingJobRequest -
    
    Returns:
    
    Result of the StopTrainingJob operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - Resource being access is not found.
    
    See Also:
    
    AWS API Documentation
  - stopTransformJob
```
StopTransformJobResult stopTransformJob(StopTransformJobRequest 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.
    
    Parameters:
    
    stopTransformJobRequest -
    
    Returns:
    
    Result of the StopTransformJob operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - Resource being access is not found.
    
    See Also:
    
    AWS API Documentation
  - updateCodeRepository
```
UpdateCodeRepositoryResult updateCodeRepository(UpdateCodeRepositoryRequest updateCodeRepositoryRequest)
```
    Updates the specified Git repository with the specified values.
    
    Parameters:
    
    updateCodeRepositoryRequest -
    
    Returns:
    
    Result of the UpdateCodeRepository operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateEndpoint
```
UpdateEndpointResult updateEndpoint(UpdateEndpointRequest 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 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. To update an endpoint, you must create a new EndpointConfig.
    
    Parameters:
    
    updateEndpointRequest -
    
    Returns:
    
    Result of the UpdateEndpoint operation returned by the service.
    
    Throws:
    
    ResourceLimitExceededException - You have exceeded an Amazon SageMaker resource limit. For example, you might have too many training jobs created.
    
    See Also:
    
    AWS API Documentation
  - updateEndpointWeightsAndCapacities
```
UpdateEndpointWeightsAndCapacitiesResult updateEndpointWeightsAndCapacities(UpdateEndpointWeightsAndCapacitiesRequest 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.
    
    Parameters:
    
    updateEndpointWeightsAndCapacitiesRequest -
    
    Returns:
    
    Result of the UpdateEndpointWeightsAndCapacities operation returned by the service.
    
    Throws:
    
    ResourceLimitExceededException - You have exceeded an Amazon SageMaker resource limit. For example, you might have too many training jobs created.
    
    See Also:
    
    AWS API Documentation
  - updateNotebookInstance
```
UpdateNotebookInstanceResult updateNotebookInstance(UpdateNotebookInstanceRequest 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.
    
    Parameters:
    
    updateNotebookInstanceRequest -
    
    Returns:
    
    Result of the UpdateNotebookInstance operation returned by the service.
    
    Throws:
    
    ResourceLimitExceededException - You have exceeded an Amazon SageMaker resource limit. For example, you might have too many training jobs created.
    
    See Also:
    
    AWS API Documentation
  - updateNotebookInstanceLifecycleConfig
```
UpdateNotebookInstanceLifecycleConfigResult updateNotebookInstanceLifecycleConfig(UpdateNotebookInstanceLifecycleConfigRequest updateNotebookInstanceLifecycleConfigRequest)
```
    Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API.
    
    Parameters:
    
    updateNotebookInstanceLifecycleConfigRequest -
    
    Returns:
    
    Result of the UpdateNotebookInstanceLifecycleConfig operation returned by the service.
    
    Throws:
    
    ResourceLimitExceededException - You have exceeded an Amazon SageMaker resource limit. For example, you might have too many training jobs created.
    
    See Also:
    
    AWS API Documentation
  - updateWorkteam
```
UpdateWorkteamResult updateWorkteam(UpdateWorkteamRequest updateWorkteamRequest)
```
    Updates an existing work team with new member definitions or description.
    
    Parameters:
    
    updateWorkteamRequest -
    
    Returns:
    
    Result of the UpdateWorkteam operation returned by the service.
    
    Throws:
    
    ResourceLimitExceededException - You have exceeded an Amazon SageMaker resource limit. For example, you might have too many training jobs created.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - waiters
```
AmazonSageMakerWaiters waiters()
```

Did this page help you?

Interface AmazonSageMaker

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

addTags

createAlgorithm

createCodeRepository

createCompilationJob

createEndpoint

createEndpointConfig

createHyperParameterTuningJob

createLabelingJob

createModel

createModelPackage

createNotebookInstance

createNotebookInstanceLifecycleConfig

createPresignedNotebookInstanceUrl

createTrainingJob

createTransformJob

createWorkteam

deleteAlgorithm

deleteCodeRepository

deleteEndpoint

deleteEndpointConfig

deleteModel

deleteModelPackage

deleteNotebookInstance

deleteNotebookInstanceLifecycleConfig

deleteTags

deleteWorkteam

describeAlgorithm

describeCodeRepository

describeCompilationJob

describeEndpoint

describeEndpointConfig

describeHyperParameterTuningJob

describeLabelingJob

describeModel

describeModelPackage

describeNotebookInstance

describeNotebookInstanceLifecycleConfig

describeSubscribedWorkteam

describeTrainingJob

describeTransformJob

describeWorkteam

getSearchSuggestions

listAlgorithms

listCodeRepositories

listCompilationJobs

listEndpointConfigs

listEndpoints

listHyperParameterTuningJobs

listLabelingJobs

listLabelingJobsForWorkteam

listModelPackages

listModels

listNotebookInstanceLifecycleConfigs

listNotebookInstances

listSubscribedWorkteams

listTags

listTrainingJobs

listTrainingJobsForHyperParameterTuningJob

listTransformJobs

listWorkteams

renderUiTemplate

search

startNotebookInstance

stopCompilationJob

stopHyperParameterTuningJob

stopLabelingJob

stopNotebookInstance

stopTrainingJob

stopTransformJob

updateCodeRepository

updateEndpoint

updateEndpointWeightsAndCapacities

updateNotebookInstance