@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonSageMaker extends Object implements AmazonSageMaker
AmazonSageMaker. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier | Constructor and Description |
|---|---|
protected |
AbstractAmazonSageMaker() |
| Modifier and Type | Method and Description |
|---|---|
AddTagsResult |
addTags(AddTagsRequest request)
Adds or overwrites one or more tags for the specified Amazon SageMaker resource.
|
CreateEndpointResult |
createEndpoint(CreateEndpointRequest request)
Creates an endpoint using the endpoint configuration specified in the request.
|
CreateEndpointConfigResult |
createEndpointConfig(CreateEndpointConfigRequest request)
Creates an endpoint configuration that Amazon SageMaker hosting services uses to deploy models.
|
CreateModelResult |
createModel(CreateModelRequest request)
Creates a model in Amazon SageMaker.
|
CreateNotebookInstanceResult |
createNotebookInstance(CreateNotebookInstanceRequest request)
Creates an Amazon SageMaker notebook instance.
|
CreateNotebookInstanceLifecycleConfigResult |
createNotebookInstanceLifecycleConfig(CreateNotebookInstanceLifecycleConfigRequest request)
Creates a lifecycle configuration that you can associate with a notebook instance.
|
CreatePresignedNotebookInstanceUrlResult |
createPresignedNotebookInstanceUrl(CreatePresignedNotebookInstanceUrlRequest request)
Returns a URL that you can use to connect to the Juypter server from a notebook instance.
|
CreateTrainingJobResult |
createTrainingJob(CreateTrainingJobRequest request)
Starts a model training job.
|
DeleteEndpointResult |
deleteEndpoint(DeleteEndpointRequest request)
Deletes an endpoint.
|
DeleteEndpointConfigResult |
deleteEndpointConfig(DeleteEndpointConfigRequest request)
Deletes an endpoint configuration.
|
DeleteModelResult |
deleteModel(DeleteModelRequest request)
Deletes a model.
|
DeleteNotebookInstanceResult |
deleteNotebookInstance(DeleteNotebookInstanceRequest request)
Deletes an Amazon SageMaker notebook instance.
|
DeleteNotebookInstanceLifecycleConfigResult |
deleteNotebookInstanceLifecycleConfig(DeleteNotebookInstanceLifecycleConfigRequest request)
Deletes a notebook instance lifecycle configuration.
|
DeleteTagsResult |
deleteTags(DeleteTagsRequest request)
Deletes the specified tags from an Amazon SageMaker resource.
|
DescribeEndpointResult |
describeEndpoint(DescribeEndpointRequest request)
Returns the description of an endpoint.
|
DescribeEndpointConfigResult |
describeEndpointConfig(DescribeEndpointConfigRequest request)
Returns the description of an endpoint configuration created using the
CreateEndpointConfig API. |
DescribeModelResult |
describeModel(DescribeModelRequest request)
Describes a model that you created using the
CreateModel API. |
DescribeNotebookInstanceResult |
describeNotebookInstance(DescribeNotebookInstanceRequest request)
Returns information about a notebook instance.
|
DescribeNotebookInstanceLifecycleConfigResult |
describeNotebookInstanceLifecycleConfig(DescribeNotebookInstanceLifecycleConfigRequest request)
Returns a description of a notebook instance lifecycle configuration.
|
DescribeTrainingJobResult |
describeTrainingJob(DescribeTrainingJobRequest request)
Returns information about a training job.
|
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.
|
ListEndpointConfigsResult |
listEndpointConfigs(ListEndpointConfigsRequest request)
Lists endpoint configurations.
|
ListEndpointsResult |
listEndpoints(ListEndpointsRequest request)
Lists endpoints.
|
ListModelsResult |
listModels(ListModelsRequest request)
Lists models created with the CreateModel API.
|
ListNotebookInstanceLifecycleConfigsResult |
listNotebookInstanceLifecycleConfigs(ListNotebookInstanceLifecycleConfigsRequest request)
Lists notebook instance lifestyle configurations created with the API.
|
ListNotebookInstancesResult |
listNotebookInstances(ListNotebookInstancesRequest request)
Returns a list of the Amazon SageMaker notebook instances in the requester's account in an AWS Region.
|
ListTagsResult |
listTags(ListTagsRequest request)
Returns the tags for the specified Amazon SageMaker resource.
|
ListTrainingJobsResult |
listTrainingJobs(ListTrainingJobsRequest request)
Lists training jobs.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartNotebookInstanceResult |
startNotebookInstance(StartNotebookInstanceRequest request)
Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume.
|
StopNotebookInstanceResult |
stopNotebookInstance(StopNotebookInstanceRequest request)
Terminates the ML compute instance.
|
StopTrainingJobResult |
stopTrainingJob(StopTrainingJobRequest request)
Stops a training job.
|
UpdateEndpointResult |
updateEndpoint(UpdateEndpointRequest request)
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 request)
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 request)
Updates a notebook instance.
|
UpdateNotebookInstanceLifecycleConfigResult |
updateNotebookInstanceLifecycleConfig(UpdateNotebookInstanceLifecycleConfigRequest request)
Updates a notebook instance lifecycle configuration created with the API.
|
AmazonSageMakerWaiters |
waiters() |
public AddTagsResult addTags(AddTagsRequest request)
AmazonSageMakerAdds 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.
addTags in interface AmazonSageMakerpublic CreateEndpointResult createEndpoint(CreateEndpointRequest request)
AmazonSageMakerCreates 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.
createEndpoint in interface AmazonSageMakerpublic CreateEndpointConfigResult createEndpointConfig(CreateEndpointConfigRequest request)
AmazonSageMaker
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.
createEndpointConfig in interface AmazonSageMakerpublic CreateModelResult createModel(CreateModelRequest request)
AmazonSageMakerCreates 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.
createModel in interface AmazonSageMakerpublic CreateNotebookInstanceResult createNotebookInstance(CreateNotebookInstanceRequest request)
AmazonSageMakerCreates 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:
Creates a network interface in the Amazon SageMaker VPC.
(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.
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.
createNotebookInstance in interface AmazonSageMakerpublic CreateNotebookInstanceLifecycleConfigResult createNotebookInstanceLifecycleConfig(CreateNotebookInstanceLifecycleConfigRequest request)
AmazonSageMakerCreates 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.
createNotebookInstanceLifecycleConfig in interface AmazonSageMakerpublic CreatePresignedNotebookInstanceUrlResult createPresignedNotebookInstanceUrl(CreatePresignedNotebookInstanceUrlRequest request)
AmazonSageMaker
Returns a URL that you can use to connect to the Juypter 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.
createPresignedNotebookInstanceUrl in interface AmazonSageMakerpublic CreateTrainingJobResult createTrainingJob(CreateTrainingJobRequest request)
AmazonSageMakerStarts 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.
createTrainingJob in interface AmazonSageMakerpublic DeleteEndpointResult deleteEndpoint(DeleteEndpointRequest request)
AmazonSageMakerDeletes an endpoint. Amazon SageMaker frees up all of the resources that were deployed when the endpoint was created.
deleteEndpoint in interface AmazonSageMakerpublic DeleteEndpointConfigResult deleteEndpointConfig(DeleteEndpointConfigRequest request)
AmazonSageMaker
Deletes an endpoint configuration. The DeleteEndpoingConfig API deletes only the specified
configuration. It does not delete endpoints created using the configuration.
deleteEndpointConfig in interface AmazonSageMakerpublic DeleteModelResult deleteModel(DeleteModelRequest request)
AmazonSageMaker
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.
deleteModel in interface AmazonSageMakerpublic DeleteNotebookInstanceResult deleteNotebookInstance(DeleteNotebookInstanceRequest request)
AmazonSageMaker
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.
deleteNotebookInstance in interface AmazonSageMakerpublic DeleteNotebookInstanceLifecycleConfigResult deleteNotebookInstanceLifecycleConfig(DeleteNotebookInstanceLifecycleConfigRequest request)
AmazonSageMakerDeletes a notebook instance lifecycle configuration.
deleteNotebookInstanceLifecycleConfig in interface AmazonSageMakerpublic DeleteTagsResult deleteTags(DeleteTagsRequest request)
AmazonSageMakerDeletes the specified tags from an Amazon SageMaker resource.
To list a resource's tags, use the ListTags API.
deleteTags in interface AmazonSageMakerpublic DescribeEndpointResult describeEndpoint(DescribeEndpointRequest request)
AmazonSageMakerReturns the description of an endpoint.
describeEndpoint in interface AmazonSageMakerpublic DescribeEndpointConfigResult describeEndpointConfig(DescribeEndpointConfigRequest request)
AmazonSageMaker
Returns the description of an endpoint configuration created using the CreateEndpointConfig API.
describeEndpointConfig in interface AmazonSageMakerpublic DescribeModelResult describeModel(DescribeModelRequest request)
AmazonSageMaker
Describes a model that you created using the CreateModel API.
describeModel in interface AmazonSageMakerpublic DescribeNotebookInstanceResult describeNotebookInstance(DescribeNotebookInstanceRequest request)
AmazonSageMakerReturns information about a notebook instance.
describeNotebookInstance in interface AmazonSageMakerpublic DescribeNotebookInstanceLifecycleConfigResult describeNotebookInstanceLifecycleConfig(DescribeNotebookInstanceLifecycleConfigRequest request)
AmazonSageMakerReturns a description of a notebook instance lifecycle configuration.
For information about notebook instance lifestyle configurations, see notebook-lifecycle-config.
describeNotebookInstanceLifecycleConfig in interface AmazonSageMakerpublic DescribeTrainingJobResult describeTrainingJob(DescribeTrainingJobRequest request)
AmazonSageMakerReturns information about a training job.
describeTrainingJob in interface AmazonSageMakerpublic ListEndpointConfigsResult listEndpointConfigs(ListEndpointConfigsRequest request)
AmazonSageMakerLists endpoint configurations.
listEndpointConfigs in interface AmazonSageMakerpublic ListEndpointsResult listEndpoints(ListEndpointsRequest request)
AmazonSageMakerLists endpoints.
listEndpoints in interface AmazonSageMakerpublic ListModelsResult listModels(ListModelsRequest request)
AmazonSageMakerLists models created with the CreateModel API.
listModels in interface AmazonSageMakerpublic ListNotebookInstanceLifecycleConfigsResult listNotebookInstanceLifecycleConfigs(ListNotebookInstanceLifecycleConfigsRequest request)
AmazonSageMakerLists notebook instance lifestyle configurations created with the API.
listNotebookInstanceLifecycleConfigs in interface AmazonSageMakerpublic ListNotebookInstancesResult listNotebookInstances(ListNotebookInstancesRequest request)
AmazonSageMakerReturns a list of the Amazon SageMaker notebook instances in the requester's account in an AWS Region.
listNotebookInstances in interface AmazonSageMakerpublic ListTagsResult listTags(ListTagsRequest request)
AmazonSageMakerReturns the tags for the specified Amazon SageMaker resource.
listTags in interface AmazonSageMakerpublic ListTrainingJobsResult listTrainingJobs(ListTrainingJobsRequest request)
AmazonSageMakerLists training jobs.
listTrainingJobs in interface AmazonSageMakerpublic StartNotebookInstanceResult startNotebookInstance(StartNotebookInstanceRequest request)
AmazonSageMaker
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.
startNotebookInstance in interface AmazonSageMakerpublic StopNotebookInstanceResult stopNotebookInstance(StopNotebookInstanceRequest request)
AmazonSageMakerTerminates 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.
stopNotebookInstance in interface AmazonSageMakerpublic StopTrainingJobResult stopTrainingJob(StopTrainingJobRequest request)
AmazonSageMaker
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.
stopTrainingJob in interface AmazonSageMakerpublic UpdateEndpointResult updateEndpoint(UpdateEndpointRequest request)
AmazonSageMaker
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.
updateEndpoint in interface AmazonSageMakerpublic UpdateEndpointWeightsAndCapacitiesResult updateEndpointWeightsAndCapacities(UpdateEndpointWeightsAndCapacitiesRequest request)
AmazonSageMaker
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.
updateEndpointWeightsAndCapacities in interface AmazonSageMakerpublic UpdateNotebookInstanceResult updateNotebookInstance(UpdateNotebookInstanceRequest request)
AmazonSageMakerUpdates 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.
updateNotebookInstance in interface AmazonSageMakerpublic UpdateNotebookInstanceLifecycleConfigResult updateNotebookInstanceLifecycleConfig(UpdateNotebookInstanceLifecycleConfigRequest request)
AmazonSageMakerUpdates a notebook instance lifecycle configuration created with the API.
updateNotebookInstanceLifecycleConfig in interface AmazonSageMakerpublic void shutdown()
AmazonSageMakershutdown in interface AmazonSageMakerpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonSageMakerResponse 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.
getCachedResponseMetadata in interface AmazonSageMakerrequest - The originally executed request.public AmazonSageMakerWaiters waiters()
waiters in interface AmazonSageMakerCopyright © 2018. All rights reserved.