AWS.SageMaker (aws-elixir v0.8.0) View Source

Provides APIs for creating and managing Amazon SageMaker resources.

Other Resources:

Link to this section Summary

Functions

Creates an association between the source and the destination.

Adds or overwrites one or more tags for the specified Amazon SageMaker resource.

Associates a trial component with a trial.

Create a machine learning algorithm that you can use in Amazon SageMaker and list in the Amazon Web Services Marketplace.

Creates a running app for the specified UserProfile.

Creates a configuration for running a SageMaker image as a KernelGateway app.

Creates a Git repository as a resource in your Amazon SageMaker account.

Creates a definition for a job that monitors data quality and drift.

Creates a Domain used by Amazon SageMaker Studio.

Starts a SageMaker Edge Manager model packaging job.

Creates an endpoint using the endpoint configuration specified in the request.

Creates an endpoint configuration that Amazon SageMaker hosting services uses to deploy models.

Creates an SageMaker experiment.

Defines the settings you will use for the human review workflow user interface.

Creates a custom SageMaker image.

Creates a version of the SageMaker image specified by ImageName.

Creates a job that uses workers to label the data objects in your input dataset.

Creates a model in Amazon SageMaker.

Creates the definition for a model bias job.

Creates the definition for a model explainability job.

Creates a model package that you can use to create Amazon SageMaker models or list on Amazon Web Services Marketplace, or a versioned model that is part of a model group.

Creates a definition for a job that monitors model quality and drift.

Creates a schedule that regularly starts Amazon SageMaker Processing Jobs to monitor the data captured for an Amazon SageMaker Endoint.

Creates an Amazon SageMaker notebook instance.

Creates a lifecycle configuration that you can associate with a notebook instance.

Creates a pipeline using a JSON pipeline definition.

Creates a URL for a specified UserProfile in a Domain.

Returns a URL that you can use to connect to the Jupyter server from a notebook instance.

Creates a machine learning (ML) project that can contain one or more templates that set up an ML pipeline from training to deploying an approved model.

Creates an SageMaker trial.

Creates a trial component, which is a stage of a machine learning trial.

Use this operation to create a workforce.

Creates a new work team for labeling your data.

Removes the specified algorithm from your account.

Used to stop and delete an app.

Deletes the specified Git repository from your account.

Deletes a data quality monitoring job definition.

Deletes an endpoint configuration.

Deletes an SageMaker experiment.

Delete the FeatureGroup and any data that was written to the OnlineStore of the FeatureGroup.

Deletes the specified flow definition.

Use this operation to delete a human task user interface (worker task template).

Deletes a SageMaker image and all versions of the image.

Deletes a version of a SageMaker image.

Deletes an Amazon SageMaker model bias job definition.

Deletes an Amazon SageMaker model explainability job definition.

Deletes the secified model quality monitoring job definition.

Deletes an Amazon SageMaker notebook instance.

Deletes a notebook instance lifecycle configuration.

Deletes a pipeline if there are no running instances of the pipeline.

Delete the specified project.

Deletes the specified tags from an Amazon SageMaker resource.

Deletes the specified trial.

Deletes the specified trial component.

Use this operation to delete a workforce.

Deletes an existing work team.

Deregisters the specified devices.

Returns a description of the specified algorithm that is in your account.

Returns information about an Amazon SageMaker AutoML job.

Gets details about the specified Git repository.

Returns information about a model compilation job.

Gets the details of a data quality monitoring job definition.

A description of the fleet the device belongs to.

The description of the domain.

A description of edge packaging jobs.

Returns the description of an endpoint.

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

Provides a list of an experiment's properties.

Use this operation to describe a FeatureGroup.

Returns information about the specified flow definition.

Returns information about the requested human task user interface (worker task template).

Gets a description of a hyperparameter tuning job.

Describes a SageMaker image.

Describes a version of a SageMaker image.

Gets information about a labeling job.

Describes a model that you created using the CreateModel API.

Returns a description of a model bias job definition.

Returns a description of a model explainability job definition.

Returns a description of the specified model package, which is used to create Amazon SageMaker models or list them on Amazon Web Services Marketplace.

Gets a description for the specified model group.

Returns a description of a model quality job definition.

Describes the schedule for a monitoring job.

Returns information about a notebook instance.

Returns a description of a notebook instance lifecycle configuration.

Describes the details of a pipeline.

Describes the details of an execution's pipeline definition.

Describes the details of a pipeline execution.

Returns a description of a processing job.

Describes the details of a project.

Gets information about a work team provided by a vendor.

Returns information about a training job.

Returns information about a transform job.

Provides a list of a trial's properties.

Provides a list of a trials component's properties.

Lists private workforce information, including workforce name, Amazon Resource Name (ARN), and, if applicable, allowed IP address ranges (CIDRs).

Gets information about a specific work team.

Disassociates a trial component from a trial.

Gets a resource policy that manages access for a model group.

Gets the status of Service Catalog in SageMaker.

An auto-complete API for the search functionality in the Amazon SageMaker console.

Lists the actions in your account and their properties.

Lists the machine learning algorithms that have been created.

Lists the AppImageConfigs in your account and their properties.

Lists the artifacts in your account and their properties.

Lists the associations in your account and their properties.

List the candidates created for the job.

Gets a list of the Git repositories in your account.

Lists model compilation jobs that satisfy various filters.

Lists the contexts in your account and their properties.

Lists the data quality job definitions in your account.

Returns a list of devices in the fleet.

Returns a list of edge packaging jobs.

Lists all the experiments in your account.

List FeatureGroups based on given filter and order.

Returns information about the flow definitions in your account.

Returns information about the human task user interfaces in your account.

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

Lists the versions of a specified image and their properties.

Lists the images in your account and their properties.

Gets a list of labeling jobs.

Gets a list of labeling jobs assigned to a specified work team.

Lists model bias jobs definitions that satisfy various filters.

Lists model explainability job definitions that satisfy various filters.

Gets a list of the model groups in your Amazon Web Services account.

Lists the model packages that have been created.

Gets a list of model quality monitoring job definitions in your account.

Lists models created with the CreateModel API.

Returns list of all monitoring job executions.

Returns list of all monitoring schedules.

Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.

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

Gets a list of PipeLineExecutionStep objects.

Gets a list of the pipeline executions.

Gets a list of parameters for a pipeline execution.

Lists processing jobs that satisfy various filters.

Gets a list of the projects in an Amazon Web Services account.

Gets a list of the work teams that you are subscribed to in the Amazon Web Services Marketplace.

Returns the tags for the specified Amazon SageMaker resource.

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

Lists the trial components in your account.

Lists the trials in your account.

Use this operation to list all private and vendor workforces in an Amazon Web Services Region.

Gets a list of private work teams that you have defined in a region.

Adds a resouce policy to control access to a model group.

Renders the UI template so that you can preview the worker's experience.

Finds Amazon SageMaker resources that match a search query.

Notifies the pipeline that the execution of a callback step failed, along with a message describing why.

Notifies the pipeline that the execution of a callback step succeeded and provides a list of the step's output parameters.

Starts a previously stopped monitoring schedule.

Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume.

A method for forcing the termination of a running job.

Request to stop an edge packaging job.

Stops a running hyperparameter tuning job and all running training jobs that the tuning job launched.

Stops a running labeling job.

Stops a previously started monitoring schedule.

Terminates the ML compute instance.

Updates the properties of an AppImageConfig.

Updates the specified Git repository with the specified values.

Updates one or more devices in a fleet.

Updates the default settings for new user profiles in the domain.

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).

Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant associated with an existing endpoint.

Adds, updates, or removes the description of an experiment.

Updates the properties of a SageMaker image.

Updates a previously created schedule.

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

Update a model training job to request a new Debugger profiling configuration.

Updates the display name of a trial.

Updates one or more properties of a trial component.

Use this operation to update your workforce.

Updates an existing work team with new member definitions or description.

Link to this section Functions

Link to this function

add_association(client, input, options \\ [])

View Source

Creates an association between the source and the destination.

A source can be associated with multiple destinations, and a destination can be associated with multiple sources. An association is a lineage tracking entity. For more information, see Amazon SageMaker ML Lineage Tracking.

Link to this function

add_tags(client, input, options \\ [])

View Source

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 Amazon Web Services 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

Tags that you add to a SageMaker Studio Domain or User Profile by calling this API are also added to any Apps that the Domain or User Profile launches after you call this API, but not to Apps that the Domain or User Profile launched before you called this API. To make sure that the tags associated with a Domain or User Profile are also added to all Apps that the Domain or User Profile launches, add the tags when you first create the Domain or User Profile by specifying them in the Tags parameter of CreateDomain or CreateUserProfile.

Link to this function

associate_trial_component(client, input, options \\ [])

View Source

Associates a trial component with a trial.

A trial component can be associated with multiple trials. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.

Link to this function

create_action(client, input, options \\ [])

View Source

Creates an action.

An action is a lineage tracking entity that represents an action or activity. For example, a model deployment or an HPO job. Generally, an action involves at least one input or output artifact. For more information, see Amazon SageMaker ML Lineage Tracking.

CreateAction can only be invoked from within an SageMaker managed environment. This includes SageMaker training jobs, processing jobs, transform jobs, and SageMaker notebooks. A call to CreateAction from outside one of these environments results in an error.

Link to this function

create_algorithm(client, input, options \\ [])

View Source

Create a machine learning algorithm that you can use in Amazon SageMaker and list in the Amazon Web Services Marketplace.

Link to this function

create_app(client, input, options \\ [])

View Source

Creates a running app for the specified UserProfile.

Supported apps are JupyterServer and KernelGateway. This operation is automatically invoked by Amazon SageMaker Studio upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously.

Link to this function

create_app_image_config(client, input, options \\ [])

View Source

Creates a configuration for running a SageMaker image as a KernelGateway app.

The configuration specifies the Amazon Elastic File System (EFS) storage volume on the image, and a list of the kernels in the image.

Link to this function

create_artifact(client, input, options \\ [])

View Source

Creates an artifact.

An artifact is a lineage tracking entity that represents a URI addressable object or data. Some examples are the S3 URI of a dataset and the ECR registry path of an image. For more information, see Amazon SageMaker ML Lineage Tracking.

CreateArtifact can only be invoked from within an SageMaker managed environment. This includes SageMaker training jobs, processing jobs, transform jobs, and SageMaker notebooks. A call to CreateArtifact from outside one of these environments results in an error.

Link to this function

create_auto_ml_job(client, input, options \\ [])

View Source

Creates an Autopilot job.

Find the best performing model after you run an Autopilot job by calling .

For information about how to use Autopilot, see Automate Model Development with Amazon SageMaker Autopilot.

Link to this function

create_code_repository(client, input, options \\ [])

View Source

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 Amazon Web Services CodeCommit or in any other Git repository.

Link to this function

create_compilation_job(client, input, options \\ [])

View Source

Starts a model compilation job.

After the model has been compiled, Amazon SageMaker saves the resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify.

If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts with Amazon Web Services IoT Greengrass. In that case, deploy them as an ML resource.

In the request body, you provide the following:

  • A name for the compilation job

  • Information about the input model artifacts

  • The output location for the compiled model and the device (target) that the model runs on

  • The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform the model compilation job.

You can also provide a Tag to track the model compilation job's resource use and costs. The response body contains the CompilationJobArn for the compiled job.

To stop a model compilation job, use StopCompilationJob. To get information about a particular model compilation job, use DescribeCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.

Link to this function

create_context(client, input, options \\ [])

View Source

Creates a context.

A context is a lineage tracking entity that represents a logical grouping of other tracking or experiment entities. Some examples are an endpoint and a model package. For more information, see Amazon SageMaker ML Lineage Tracking.

CreateContext can only be invoked from within an SageMaker managed environment. This includes SageMaker training jobs, processing jobs, transform jobs, and SageMaker notebooks. A call to CreateContext from outside one of these environments results in an error.

Link to this function

create_data_quality_job_definition(client, input, options \\ [])

View Source

Creates a definition for a job that monitors data quality and drift.

For information about model monitor, see Amazon SageMaker Model Monitor.

Link to this function

create_device_fleet(client, input, options \\ [])

View Source

Creates a device fleet.

Link to this function

create_domain(client, input, options \\ [])

View Source

Creates a Domain used by Amazon SageMaker Studio.

A domain consists of an associated Amazon Elastic File System (EFS) volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. An Amazon Web Services account is limited to one domain per region. Users within a domain can share notebook files and other artifacts with each other.

EFS storage

When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files.

SageMaker uses the Amazon Web Services Key Management Service (Amazon Web Services KMS) to encrypt the EFS volume attached to the domain with an Amazon Web Services managed customer master key (CMK) by default. For more control, you can specify a customer managed CMK. For more information, see Protect Data at Rest Using Encryption.

VPC configuration

All SageMaker Studio traffic between the domain and the EFS volume is through the specified VPC and subnets. For other Studio traffic, you can specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the network access type that you choose when you onboard to Studio. The following options are available:

  • PublicInternetOnly - Non-EFS traffic goes through a VPC managed by Amazon SageMaker, which allows internet access. This is the default value.

  • VpcOnly - All Studio traffic is through the specified VPC and subnets. Internet access is disabled by default. To allow internet access, you must specify a NAT gateway.

When internet access is disabled, you won't be able to run a Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker API and runtime or a NAT gateway and your security groups allow outbound connections.

NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules in order to launch a SageMaker Studio app successfully.

For more information, see Connect SageMaker Studio Notebooks to Resources in a VPC.

Link to this function

create_edge_packaging_job(client, input, options \\ [])

View Source

Starts a SageMaker Edge Manager model packaging job.

Edge Manager will use the model artifacts from the Amazon Simple Storage Service bucket that you specify. After the model has been packaged, Amazon SageMaker saves the resulting artifacts to an S3 bucket that you specify.

Link to this function

create_endpoint(client, input, options \\ [])

View Source

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 to deploy models using Amazon SageMaker hosting services.

For an example that calls this method when deploying a model to Amazon SageMaker hosting services, see Deploy the Model to Amazon SageMaker Hosting Services (Amazon Web Services SDK for Python (Boto 3)).

You must not delete an EndpointConfig that is in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.

The endpoint name must be unique within an Amazon Web Services Region in your Amazon Web Services account.

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

When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

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

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

To add the IAM role policies for using this API operation, go to the IAM console, and choose Roles in the left navigation pane. Search the IAM role that you want to grant access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to the role.

Option 1: For a full Amazon SageMaker access, search and attach the AmazonSageMakerFullAccess policy.

Option 2: For granting a limited access to an IAM role, paste the following Action elements manually into the JSON file of the IAM role:

"Action": ["sagemaker:CreateEndpoint", "sagemaker:CreateEndpointConfig"] "Resource": [

"arn:aws:sagemaker:region:account-id:endpoint/endpointName"

"arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName"

]

For more information, see Amazon SageMaker API Permissions: Actions, Permissions, and Resources Reference.

Link to this function

create_endpoint_config(client, input, options \\ [])

View Source

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 if you want to use Amazon SageMaker hosting services to deploy models into production.

In the request, you define a ProductionVariant, for each model that you want to deploy. Each ProductionVariant parameter also describes the resources that you want 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.

For an example that calls this method when deploying a model to Amazon SageMaker hosting services, see Deploy the Model to Amazon SageMaker Hosting Services (Amazon Web Services SDK for Python (Boto 3)).

When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

Link to this function

create_experiment(client, input, options \\ [])

View Source

Creates an SageMaker experiment.

An experiment is a collection of trials that are observed, compared and evaluated as a group. A trial is a set of steps, called trial components, that produce a machine learning model.

The goal of an experiment is to determine the components that produce the best model. Multiple trials are performed, each one isolating and measuring the impact of a change to one or more inputs, while keeping the remaining inputs constant.

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

You can add tags to experiments, trials, trial components and then use the Search API to search for the tags.

To add a description to an experiment, specify the optional Description parameter. To add a description later, or to change the description, call the UpdateExperiment API.

To get a list of all your experiments, call the ListExperiments API. To view an experiment's properties, call the DescribeExperiment API. To get a list of all the trials associated with an experiment, call the ListTrials API. To create a trial call the CreateTrial API.

Link to this function

create_feature_group(client, input, options \\ [])

View Source

Create a new FeatureGroup.

A FeatureGroup is a group of Features defined in the FeatureStore to describe a Record.

The FeatureGroup defines the schema and features contained in the FeatureGroup. A FeatureGroup definition is composed of a list of Features, a RecordIdentifierFeatureName, an EventTimeFeatureName and configurations for its OnlineStore and OfflineStore. Check Amazon Web Services service quotas to see the FeatureGroups quota for your Amazon Web Services account.

You must include at least one of OnlineStoreConfig and OfflineStoreConfig to create a FeatureGroup.

Link to this function

create_flow_definition(client, input, options \\ [])

View Source

Creates a flow definition.

Link to this function

create_human_task_ui(client, input, options \\ [])

View Source

Defines the settings you will use for the human review workflow user interface.

Reviewers will see a three-panel interface with an instruction area, the item to review, and an input area.

Link to this function

create_hyper_parameter_tuning_job(client, input, options \\ [])

View Source

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.

Link to this function

create_image(client, input, options \\ [])

View Source

Creates a custom SageMaker image.

A SageMaker image is a set of image versions. Each image version represents a container image stored in Amazon Container Registry (ECR). For more information, see Bring your own SageMaker image.

Link to this function

create_image_version(client, input, options \\ [])

View Source

Creates a version of the SageMaker image specified by ImageName.

The version represents the Amazon Container Registry (ECR) container image specified by BaseImage.

Link to this function

create_labeling_job(client, input, options \\ [])

View Source

Creates a job that uses workers to label the data objects in your input dataset.

You can use the labeled data to train machine learning models.

You can select your workforce from one of three providers:

  • A private workforce that you create. It can include employees, contractors, and outside experts. Use a private workforce when want the data to stay within your organization or when a specific set of skills is required.

  • One or more vendors that you select from the Amazon Web Services Marketplace. Vendors provide expertise in specific areas.

  • The Amazon Mechanical Turk workforce. This is the largest workforce, but it should only be used for public data or data that has been stripped of any personally identifiable information.

You can also use automated data labeling to reduce the number of data objects that need to be labeled by a human. Automated data labeling uses active learning to determine if a data object can be labeled by machine or if it needs to be sent to a human worker. For more information, see Using Automated Data Labeling.

The data objects to be labeled are contained in an Amazon S3 bucket. You create a manifest file that describes the location of each object. For more information, see Using Input and Output Data.

The output can be used as the manifest file for another labeling job or as training data for your machine learning models.

You can use this operation to create a static labeling job or a streaming labeling job. A static labeling job stops if all data objects in the input manifest file identified in ManifestS3Uri have been labeled. A streaming labeling job runs perpetually until it is manually stopped, or remains idle for 10 days. You can send new data objects to an active (InProgress) streaming labeling job in real time. To learn how to create a static labeling job, see Create a Labeling Job (API) in the Amazon SageMaker Developer Guide. To learn how to create a streaming labeling job, see Create a Streaming Labeling Job.

Link to this function

create_model(client, input, options \\ [])

View Source

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 that contains inference code, artifacts (from prior training), and a custom environment map that the inference code uses when you deploy the model for predictions.

Use this API to create a model if you want to use 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.

For an example that calls this method when deploying a model to Amazon SageMaker hosting services, see Deploy the Model to Amazon SageMaker Hosting Services (Amazon Web Services SDK for Python (Boto 3)).

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 Amazon Web Services resources, you grant necessary permissions via this role.

Link to this function

create_model_bias_job_definition(client, input, options \\ [])

View Source

Creates the definition for a model bias job.

Link to this function

create_model_explainability_job_definition(client, input, options \\ [])

View Source

Creates the definition for a model explainability job.

Link to this function

create_model_package(client, input, options \\ [])

View Source

Creates a model package that you can use to create Amazon SageMaker models or list on Amazon Web Services Marketplace, or a versioned model that is part of a model group.

Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in 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 Amazon Web Services Marketplace, provide a value for SourceAlgorithmSpecification.

There are two types of model packages:

Versioned - a model that is part of a model group in the model registry.

Unversioned - a model package that is not part of a model group.

Link to this function

create_model_package_group(client, input, options \\ [])

View Source

Creates a model group.

A model group contains a group of model versions.

Link to this function

create_model_quality_job_definition(client, input, options \\ [])

View Source

Creates a definition for a job that monitors model quality and drift.

For information about model monitor, see Amazon SageMaker Model Monitor.

Link to this function

create_monitoring_schedule(client, input, options \\ [])

View Source

Creates a schedule that regularly starts Amazon SageMaker Processing Jobs to monitor the data captured for an Amazon SageMaker Endoint.

Link to this function

create_notebook_instance(client, input, options \\ [])

View Source

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). You can't change the name of a notebook instance after you create it.

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.

Link to this function

create_notebook_instance_lifecycle_config(client, input, options \\ [])

View Source

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.

Link to this function

create_pipeline(client, input, options \\ [])

View Source

Creates a pipeline using a JSON pipeline definition.

Link to this function

create_presigned_domain_url(client, input, options \\ [])

View Source

Creates a URL for a specified UserProfile in a Domain.

When accessed in a web browser, the user will be automatically signed in to Amazon SageMaker Studio, and granted access to all of the Apps and files associated with the Domain's Amazon Elastic File System (EFS) volume. This operation can only be called when the authentication mode equals IAM.

The IAM role or user used to call this API defines the permissions to access the app. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the app.

You can restrict access to this API and to the URL that it returns to a list of IP addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more information, see Connect to SageMaker Studio Through an Interface VPC Endpoint .

The URL that you get from a call to CreatePresignedDomainUrl has a default timeout of 5 minutes. You can configure this value using ExpiresInSeconds. If you try to use the URL after the timeout limit expires, you are directed to the Amazon Web Services console sign-in page.

Link to this function

create_presigned_notebook_instance_url(client, input, options \\ [])

View Source

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.

The IAM role or user used to call this API defines the permissions to access the notebook instance. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the notebook instance.

You can restrict access to this API and to the URL that it returns to a list of IP addresses that you specify. Use the NotIpAddress condition operator and the aws:SourceIP condition context key to specify the list of IP addresses that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.

The URL that you get from a call to CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If you try to use the URL after the 5-minute limit expires, you are directed to the Amazon Web Services console sign-in page.

Link to this function

create_processing_job(client, input, options \\ [])

View Source

Creates a processing job.

Link to this function

create_project(client, input, options \\ [])

View Source

Creates a machine learning (ML) project that can contain one or more templates that set up an ML pipeline from training to deploying an approved model.

Link to this function

create_training_job(client, input, options \\ [])

View Source

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 inference.

In the request body, you provide the following:

  • AlgorithmSpecification - Identifies the training algorithm to use.

  • HyperParameters - Specify these algorithm-specific parameters to enable the estimation of model parameters during training. Hyperparameters can be tuned to optimize this learning process. For a list of hyperparameters for each training algorithm provided by Amazon SageMaker, see Algorithms. * InputDataConfig - Describes the training dataset and the Amazon S3, EFS, or FSx location where it is stored.

  • OutputDataConfig - Identifies the Amazon S3 bucket 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.

  • EnableManagedSpotTraining - Optimize the cost of training machine learning models by up to 80% by using Amazon EC2 Spot instances. For more information, see Managed Spot Training.

  • RoleArn - The Amazon Resource Name (ARN) that 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 - To help cap training costs, use MaxRuntimeInSeconds to set a time limit for training. Use MaxWaitTimeInSeconds to specify how long a managed spot training job has to complete.

  • Environment - The environment variables to set in the Docker container.

  • RetryStrategy - The number of times to retry the job when the job fails due to an InternalServerError.

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

Link to this function

create_transform_job(client, input, options \\ [])

View Source

Starts a transform job.

A transform job uses a trained model to get inferences on a dataset and saves these results to an Amazon S3 location that you specify.

To perform batch transformations, you create a transform job and use the data that you have readily available.

In the request body, you provide the following:

  • TransformJobName - Identifies the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

  • ModelName - Identifies the model to use. ModelName must be the name of an existing Amazon SageMaker model in the same Amazon Web Services Region and Amazon Web Services account. For information on creating a model, see CreateModel.

  • TransformInput - Describes the dataset to be transformed and the Amazon S3 location where it is stored.

  • TransformOutput - Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

  • TransformResources - Identifies the ML compute instances for the transform job.

For more information about how batch transformation works, see Batch Transform.

Link to this function

create_trial(client, input, options \\ [])

View Source

Creates an SageMaker trial.

A trial is a set of steps called trial components that produce a machine learning model. A trial is part of a single SageMaker experiment.

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

You can add tags to a trial and then use the Search API to search for the tags.

To get a list of all your trials, call the ListTrials API. To view a trial's properties, call the DescribeTrial API. To create a trial component, call the CreateTrialComponent API.

Link to this function

create_trial_component(client, input, options \\ [])

View Source

Creates a trial component, which is a stage of a machine learning trial.

A trial is composed of one or more trial components. A trial component can be used in multiple trials.

Trial components include pre-processing jobs, training jobs, and batch transform jobs.

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

You can add tags to a trial component and then use the Search API to search for the tags.

Link to this function

create_user_profile(client, input, options \\ [])

View Source

Creates a user profile.

A user profile represents a single user within a domain, and is the main way to reference a "person" for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to Amazon SageMaker Studio. If an administrator invites a person by email or imports them from SSO, a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user's private Amazon Elastic File System (EFS) home directory.

Link to this function

create_workforce(client, input, options \\ [])

View Source

Use this operation to create a workforce.

This operation will return an error if a workforce already exists in the Amazon Web Services Region that you specify. You can only create one workforce in each Amazon Web Services Region per Amazon Web Services account.

If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use the API operation to delete the existing workforce and then use CreateWorkforce to create a new workforce.

To create a private workforce using Amazon Cognito, you must specify a Cognito user pool in CognitoConfig. You can also create an Amazon Cognito workforce using the Amazon SageMaker console. For more information, see Create a Private Workforce (Amazon Cognito).

To create a private workforce using your own OIDC Identity Provider (IdP), specify your IdP configuration in OidcConfig. Your OIDC IdP must support groups because groups are used by Ground Truth and Amazon A2I to create work teams. For more information, see Create a Private Workforce (OIDC IdP).

Link to this function

create_workteam(client, input, options \\ [])

View Source

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.

Link to this function

delete_action(client, input, options \\ [])

View Source

Deletes an action.

Link to this function

delete_algorithm(client, input, options \\ [])

View Source

Removes the specified algorithm from your account.

Link to this function

delete_app(client, input, options \\ [])

View Source

Used to stop and delete an app.

Link to this function

delete_app_image_config(client, input, options \\ [])

View Source

Deletes an AppImageConfig.

Link to this function

delete_artifact(client, input, options \\ [])

View Source

Deletes an artifact.

Either ArtifactArn or Source must be specified.

Link to this function

delete_association(client, input, options \\ [])

View Source

Deletes an association.

Link to this function

delete_code_repository(client, input, options \\ [])

View Source

Deletes the specified Git repository from your account.

Link to this function

delete_context(client, input, options \\ [])

View Source

Deletes an context.

Link to this function

delete_data_quality_job_definition(client, input, options \\ [])

View Source

Deletes a data quality monitoring job definition.

Link to this function

delete_device_fleet(client, input, options \\ [])

View Source

Deletes a fleet.

Link to this function

delete_domain(client, input, options \\ [])

View Source

Used to delete a domain.

If you onboarded with IAM mode, you will need to delete your domain to onboard again using SSO. Use with caution. All of the members of the domain will lose access to their EFS volume, including data, notebooks, and other artifacts.

Link to this function

delete_endpoint(client, input, options \\ [])

View Source

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.

Link to this function

delete_endpoint_config(client, input, options \\ [])

View Source

Deletes an endpoint configuration.

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

You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.

Link to this function

delete_experiment(client, input, options \\ [])

View Source

Deletes an SageMaker experiment.

All trials associated with the experiment must be deleted first. Use the ListTrials API to get a list of the trials associated with the experiment.

Link to this function

delete_feature_group(client, input, options \\ [])

View Source

Delete the FeatureGroup and any data that was written to the OnlineStore of the FeatureGroup.

Data cannot be accessed from the OnlineStore immediately after DeleteFeatureGroup is called.

Data written into the OfflineStore will not be deleted. The Amazon Web Services Glue database and tables that are automatically created for your OfflineStore are not deleted.

Link to this function

delete_flow_definition(client, input, options \\ [])

View Source

Deletes the specified flow definition.

Link to this function

delete_human_task_ui(client, input, options \\ [])

View Source

Use this operation to delete a human task user interface (worker task template).

To see a list of human task user interfaces (work task templates) in your account, use . When you delete a worker task template, it no longer appears when you call ListHumanTaskUis.

Link to this function

delete_image(client, input, options \\ [])

View Source

Deletes a SageMaker image and all versions of the image.

The container images aren't deleted.

Link to this function

delete_image_version(client, input, options \\ [])

View Source

Deletes a version of a SageMaker image.

The container image the version represents isn't deleted.

Link to this function

delete_model(client, input, options \\ [])

View Source

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.

Link to this function

delete_model_bias_job_definition(client, input, options \\ [])

View Source

Deletes an Amazon SageMaker model bias job definition.

Link to this function

delete_model_explainability_job_definition(client, input, options \\ [])

View Source

Deletes an Amazon SageMaker model explainability job definition.

Link to this function

delete_model_package(client, input, options \\ [])

View Source

Deletes a model package.

A model package is used to create Amazon SageMaker models or list on Amazon Web Services Marketplace. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in Amazon SageMaker.

Link to this function

delete_model_package_group(client, input, options \\ [])

View Source

Deletes the specified model group.

Link to this function

delete_model_package_group_policy(client, input, options \\ [])

View Source

Deletes a model group resource policy.

Link to this function

delete_model_quality_job_definition(client, input, options \\ [])

View Source

Deletes the secified model quality monitoring job definition.

Link to this function

delete_monitoring_schedule(client, input, options \\ [])

View Source

Deletes a monitoring schedule.

Also stops the schedule had not already been stopped. This does not delete the job execution history of the monitoring schedule.

Link to this function

delete_notebook_instance(client, input, options \\ [])

View Source

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.

Link to this function

delete_notebook_instance_lifecycle_config(client, input, options \\ [])

View Source

Deletes a notebook instance lifecycle configuration.

Link to this function

delete_pipeline(client, input, options \\ [])

View Source

Deletes a pipeline if there are no running instances of the pipeline.

To delete a pipeline, you must stop all running instances of the pipeline using the StopPipelineExecution API. When you delete a pipeline, all instances of the pipeline are deleted.

Link to this function

delete_project(client, input, options \\ [])

View Source

Delete the specified project.

Link to this function

delete_tags(client, input, options \\ [])

View Source

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.

When you call this API to delete tags from a SageMaker Studio Domain or User Profile, the deleted tags are not removed from Apps that the SageMaker Studio Domain or User Profile launched before you called this API.

Link to this function

delete_trial(client, input, options \\ [])

View Source

Deletes the specified trial.

All trial components that make up the trial must be deleted first. Use the DescribeTrialComponent API to get the list of trial components.

Link to this function

delete_trial_component(client, input, options \\ [])

View Source

Deletes the specified trial component.

A trial component must be disassociated from all trials before the trial component can be deleted. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.

Link to this function

delete_user_profile(client, input, options \\ [])

View Source

Deletes a user profile.

When a user profile is deleted, the user loses access to their EFS volume, including data, notebooks, and other artifacts.

Link to this function

delete_workforce(client, input, options \\ [])

View Source

Use this operation to delete a workforce.

If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use this operation to delete the existing workforce and then use to create a new workforce.

If a private workforce contains one or more work teams, you must use the operation to delete all work teams before you delete the workforce. If you try to delete a workforce that contains one or more work teams, you will recieve a ResourceInUse error.

Link to this function

delete_workteam(client, input, options \\ [])

View Source

Deletes an existing work team.

This operation can't be undone.

Link to this function

deregister_devices(client, input, options \\ [])

View Source

Deregisters the specified devices.

After you deregister a device, you will need to re-register the devices.

Link to this function

describe_action(client, input, options \\ [])

View Source

Describes an action.

Link to this function

describe_algorithm(client, input, options \\ [])

View Source

Returns a description of the specified algorithm that is in your account.

Link to this function

describe_app(client, input, options \\ [])

View Source

Describes the app.

Link to this function

describe_app_image_config(client, input, options \\ [])

View Source

Describes an AppImageConfig.

Link to this function

describe_artifact(client, input, options \\ [])

View Source

Describes an artifact.

Link to this function

describe_auto_ml_job(client, input, options \\ [])

View Source

Returns information about an Amazon SageMaker AutoML job.

Link to this function

describe_code_repository(client, input, options \\ [])

View Source

Gets details about the specified Git repository.

Link to this function

describe_compilation_job(client, input, options \\ [])

View Source

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.

Link to this function

describe_context(client, input, options \\ [])

View Source

Describes a context.

Link to this function

describe_data_quality_job_definition(client, input, options \\ [])

View Source

Gets the details of a data quality monitoring job definition.

Link to this function

describe_device(client, input, options \\ [])

View Source

Describes the device.

Link to this function

describe_device_fleet(client, input, options \\ [])

View Source

A description of the fleet the device belongs to.

Link to this function

describe_domain(client, input, options \\ [])

View Source

The description of the domain.

Link to this function

describe_edge_packaging_job(client, input, options \\ [])

View Source

A description of edge packaging jobs.

Link to this function

describe_endpoint(client, input, options \\ [])

View Source

Returns the description of an endpoint.

Link to this function

describe_endpoint_config(client, input, options \\ [])

View Source

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

Link to this function

describe_experiment(client, input, options \\ [])

View Source

Provides a list of an experiment's properties.

Link to this function

describe_feature_group(client, input, options \\ [])

View Source

Use this operation to describe a FeatureGroup.

The response includes information on the creation time, FeatureGroup name, the unique identifier for each FeatureGroup, and more.

Link to this function

describe_flow_definition(client, input, options \\ [])

View Source

Returns information about the specified flow definition.

Link to this function

describe_human_task_ui(client, input, options \\ [])

View Source

Returns information about the requested human task user interface (worker task template).

Link to this function

describe_hyper_parameter_tuning_job(client, input, options \\ [])

View Source

Gets a description of a hyperparameter tuning job.

Link to this function

describe_image(client, input, options \\ [])

View Source

Describes a SageMaker image.

Link to this function

describe_image_version(client, input, options \\ [])

View Source

Describes a version of a SageMaker image.

Link to this function

describe_labeling_job(client, input, options \\ [])

View Source

Gets information about a labeling job.

Link to this function

describe_model(client, input, options \\ [])

View Source

Describes a model that you created using the CreateModel API.

Link to this function

describe_model_bias_job_definition(client, input, options \\ [])

View Source

Returns a description of a model bias job definition.

Link to this function

describe_model_explainability_job_definition(client, input, options \\ [])

View Source

Returns a description of a model explainability job definition.

Link to this function

describe_model_package(client, input, options \\ [])

View Source

Returns a description of the specified model package, which is used to create Amazon SageMaker models or list them on Amazon Web Services Marketplace.

To create models in Amazon SageMaker, buyers can subscribe to model packages listed on Amazon Web Services Marketplace.

Link to this function

describe_model_package_group(client, input, options \\ [])

View Source

Gets a description for the specified model group.

Link to this function

describe_model_quality_job_definition(client, input, options \\ [])

View Source

Returns a description of a model quality job definition.

Link to this function

describe_monitoring_schedule(client, input, options \\ [])

View Source

Describes the schedule for a monitoring job.

Link to this function

describe_notebook_instance(client, input, options \\ [])

View Source

Returns information about a notebook instance.

Link to this function

describe_notebook_instance_lifecycle_config(client, input, options \\ [])

View Source

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.

Link to this function

describe_pipeline(client, input, options \\ [])

View Source

Describes the details of a pipeline.

Link to this function

describe_pipeline_definition_for_execution(client, input, options \\ [])

View Source

Describes the details of an execution's pipeline definition.

Link to this function

describe_pipeline_execution(client, input, options \\ [])

View Source

Describes the details of a pipeline execution.

Link to this function

describe_processing_job(client, input, options \\ [])

View Source

Returns a description of a processing job.

Link to this function

describe_project(client, input, options \\ [])

View Source

Describes the details of a project.

Link to this function

describe_subscribed_workteam(client, input, options \\ [])

View Source

Gets information about a work team provided by a vendor.

It returns details about the subscription with a vendor in the Amazon Web Services Marketplace.

Link to this function

describe_training_job(client, input, options \\ [])

View Source

Returns information about a training job.

Some of the attributes below only appear if the training job successfully starts. If the training job fails, TrainingJobStatus is Failed and, depending on the FailureReason, attributes like TrainingStartTime, TrainingTimeInSeconds, TrainingEndTime, and BillableTimeInSeconds may not be present in the response.

Link to this function

describe_transform_job(client, input, options \\ [])

View Source

Returns information about a transform job.

Link to this function

describe_trial(client, input, options \\ [])

View Source

Provides a list of a trial's properties.

Link to this function

describe_trial_component(client, input, options \\ [])

View Source

Provides a list of a trials component's properties.

Link to this function

describe_user_profile(client, input, options \\ [])

View Source

Describes a user profile.

For more information, see CreateUserProfile.

Link to this function

describe_workforce(client, input, options \\ [])

View Source

Lists private workforce information, including workforce name, Amazon Resource Name (ARN), and, if applicable, allowed IP address ranges (CIDRs).

Allowable IP address ranges are the IP addresses that workers can use to access tasks.

This operation applies only to private workforces.

Link to this function

describe_workteam(client, input, options \\ [])

View Source

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).

Link to this function

disable_sagemaker_servicecatalog_portfolio(client, input, options \\ [])

View Source

Disables using Service Catalog in SageMaker.

Service Catalog is used to create SageMaker projects.

Link to this function

disassociate_trial_component(client, input, options \\ [])

View Source

Disassociates a trial component from a trial.

This doesn't effect other trials the component is associated with. Before you can delete a component, you must disassociate the component from all trials it is associated with. To associate a trial component with a trial, call the AssociateTrialComponent API.

To get a list of the trials a component is associated with, use the Search API. Specify ExperimentTrialComponent for the Resource parameter. The list appears in the response under Results.TrialComponent.Parents.

Link to this function

enable_sagemaker_servicecatalog_portfolio(client, input, options \\ [])

View Source

Enables using Service Catalog in SageMaker.

Service Catalog is used to create SageMaker projects.

Link to this function

get_device_fleet_report(client, input, options \\ [])

View Source

Describes a fleet.

Link to this function

get_model_package_group_policy(client, input, options \\ [])

View Source

Gets a resource policy that manages access for a model group.

For information about resource policies, see Identity-based policies and resource-based policies in the Amazon Web Services Identity and Access Management User Guide..

Link to this function

get_sagemaker_servicecatalog_portfolio_status(client, input, options \\ [])

View Source

Gets the status of Service Catalog in SageMaker.

Service Catalog is used to create SageMaker projects.

Link to this function

get_search_suggestions(client, input, options \\ [])

View Source

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.

Link to this function

list_actions(client, input, options \\ [])

View Source

Lists the actions in your account and their properties.

Link to this function

list_algorithms(client, input, options \\ [])

View Source

Lists the machine learning algorithms that have been created.

Link to this function

list_app_image_configs(client, input, options \\ [])

View Source

Lists the AppImageConfigs in your account and their properties.

The list can be filtered by creation time or modified time, and whether the AppImageConfig name contains a specified string.

Link to this function

list_apps(client, input, options \\ [])

View Source

Lists apps.

Link to this function

list_artifacts(client, input, options \\ [])

View Source

Lists the artifacts in your account and their properties.

Link to this function

list_associations(client, input, options \\ [])

View Source

Lists the associations in your account and their properties.

Link to this function

list_auto_ml_jobs(client, input, options \\ [])

View Source

Request a list of jobs.

Link to this function

list_candidates_for_auto_ml_job(client, input, options \\ [])

View Source

List the candidates created for the job.

Link to this function

list_code_repositories(client, input, options \\ [])

View Source

Gets a list of the Git repositories in your account.

Link to this function

list_compilation_jobs(client, input, options \\ [])

View Source

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.

Link to this function

list_contexts(client, input, options \\ [])

View Source

Lists the contexts in your account and their properties.

Link to this function

list_data_quality_job_definitions(client, input, options \\ [])

View Source

Lists the data quality job definitions in your account.

Link to this function

list_device_fleets(client, input, options \\ [])

View Source

Returns a list of devices in the fleet.

Link to this function

list_devices(client, input, options \\ [])

View Source

A list of devices.

Link to this function

list_domains(client, input, options \\ [])

View Source

Lists the domains.

Link to this function

list_edge_packaging_jobs(client, input, options \\ [])

View Source

Returns a list of edge packaging jobs.

Link to this function

list_endpoint_configs(client, input, options \\ [])

View Source

Lists endpoint configurations.

Link to this function

list_endpoints(client, input, options \\ [])

View Source

Lists endpoints.

Link to this function

list_experiments(client, input, options \\ [])

View Source

Lists all the experiments in your account.

The list can be filtered to show only experiments that were created in a specific time range. The list can be sorted by experiment name or creation time.

Link to this function

list_feature_groups(client, input, options \\ [])

View Source

List FeatureGroups based on given filter and order.

Link to this function

list_flow_definitions(client, input, options \\ [])

View Source

Returns information about the flow definitions in your account.

Link to this function

list_human_task_uis(client, input, options \\ [])

View Source

Returns information about the human task user interfaces in your account.

Link to this function

list_hyper_parameter_tuning_jobs(client, input, options \\ [])

View Source

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

Link to this function

list_image_versions(client, input, options \\ [])

View Source

Lists the versions of a specified image and their properties.

The list can be filtered by creation time or modified time.

Link to this function

list_images(client, input, options \\ [])

View Source

Lists the images in your account and their properties.

The list can be filtered by creation time or modified time, and whether the image name contains a specified string.

Link to this function

list_labeling_jobs(client, input, options \\ [])

View Source

Gets a list of labeling jobs.

Link to this function

list_labeling_jobs_for_workteam(client, input, options \\ [])

View Source

Gets a list of labeling jobs assigned to a specified work team.

Link to this function

list_model_bias_job_definitions(client, input, options \\ [])

View Source

Lists model bias jobs definitions that satisfy various filters.

Link to this function

list_model_explainability_job_definitions(client, input, options \\ [])

View Source

Lists model explainability job definitions that satisfy various filters.

Link to this function

list_model_package_groups(client, input, options \\ [])

View Source

Gets a list of the model groups in your Amazon Web Services account.

Link to this function

list_model_packages(client, input, options \\ [])

View Source

Lists the model packages that have been created.

Link to this function

list_model_quality_job_definitions(client, input, options \\ [])

View Source

Gets a list of model quality monitoring job definitions in your account.

Link to this function

list_models(client, input, options \\ [])

View Source

Lists models created with the CreateModel API.

Link to this function

list_monitoring_executions(client, input, options \\ [])

View Source

Returns list of all monitoring job executions.

Link to this function

list_monitoring_schedules(client, input, options \\ [])

View Source

Returns list of all monitoring schedules.

Link to this function

list_notebook_instance_lifecycle_configs(client, input, options \\ [])

View Source

Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.

Link to this function

list_notebook_instances(client, input, options \\ [])

View Source

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

Link to this function

list_pipeline_execution_steps(client, input, options \\ [])

View Source

Gets a list of PipeLineExecutionStep objects.

Link to this function

list_pipeline_executions(client, input, options \\ [])

View Source

Gets a list of the pipeline executions.

Link to this function

list_pipeline_parameters_for_execution(client, input, options \\ [])

View Source

Gets a list of parameters for a pipeline execution.

Link to this function

list_pipelines(client, input, options \\ [])

View Source

Gets a list of pipelines.

Link to this function

list_processing_jobs(client, input, options \\ [])

View Source

Lists processing jobs that satisfy various filters.

Link to this function

list_projects(client, input, options \\ [])

View Source

Gets a list of the projects in an Amazon Web Services account.

Link to this function

list_subscribed_workteams(client, input, options \\ [])

View Source

Gets a list of the work teams that you are subscribed to in the Amazon Web Services Marketplace.

The list may be empty if no work team satisfies the filter specified in the NameContains parameter.

Link to this function

list_tags(client, input, options \\ [])

View Source

Returns the tags for the specified Amazon SageMaker resource.

Link to this function

list_training_jobs(client, input, options \\ [])

View Source

Lists training jobs.

When StatusEquals and MaxResults are set at the same time, the MaxResults number of training jobs are first retrieved ignoring the StatusEquals parameter and then they are filtered by the StatusEquals parameter, which is returned as a response.

For example, if ListTrainingJobs is invoked with the following parameters:

{ ... MaxResults: 100, StatusEquals: InProgress ... }

First, 100 trainings jobs with any status, including those other than InProgress, are selected (sorted according to the creation time, from the most current to the oldest). Next, those with a status of InProgress are returned.

You can quickly test the API using the following Amazon Web Services CLI code.

aws sagemaker list-training-jobs --max-results 100 --status-equals InProgress

Link to this function

list_training_jobs_for_hyper_parameter_tuning_job(client, input, options \\ [])

View Source

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

Link to this function

list_transform_jobs(client, input, options \\ [])

View Source

Lists transform jobs.

Link to this function

list_trial_components(client, input, options \\ [])

View Source

Lists the trial components in your account.

You can sort the list by trial component name or creation time. You can filter the list to show only components that were created in a specific time range. You can also filter on one of the following:

  • ExperimentName

  • SourceArn

  • TrialName

Link to this function

list_trials(client, input, options \\ [])

View Source

Lists the trials in your account.

Specify an experiment name to limit the list to the trials that are part of that experiment. Specify a trial component name to limit the list to the trials that associated with that trial component. The list can be filtered to show only trials that were created in a specific time range. The list can be sorted by trial name or creation time.

Link to this function

list_user_profiles(client, input, options \\ [])

View Source

Lists user profiles.

Link to this function

list_workforces(client, input, options \\ [])

View Source

Use this operation to list all private and vendor workforces in an Amazon Web Services Region.

Note that you can only have one private workforce per Amazon Web Services Region.

Link to this function

list_workteams(client, input, options \\ [])

View Source

Gets a list of private work teams that you have defined in a region.

The list may be empty if no work team satisfies the filter specified in the NameContains parameter.

Link to this function

put_model_package_group_policy(client, input, options \\ [])

View Source

Adds a resouce policy to control access to a model group.

For information about resoure policies, see Identity-based policies and resource-based policies in the Amazon Web Services Identity and Access Management User Guide..

Link to this function

register_devices(client, input, options \\ [])

View Source

Register devices.

Link to this function

render_ui_template(client, input, options \\ [])

View Source

Renders the UI template so that you can preview the worker's experience.

Link to this function

search(client, input, options \\ [])

View Source

Finds Amazon SageMaker resources that match a search query.

Matching resources are returned as a list of SearchRecord objects in the response. You can sort the search results by any resource property in a ascending or descending order.

You can query against the following value types: numeric, text, Boolean, and timestamp.

Link to this function

send_pipeline_execution_step_failure(client, input, options \\ [])

View Source

Notifies the pipeline that the execution of a callback step failed, along with a message describing why.

When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).

Link to this function

send_pipeline_execution_step_success(client, input, options \\ [])

View Source

Notifies the pipeline that the execution of a callback step succeeded and provides a list of the step's output parameters.

When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).

Link to this function

start_monitoring_schedule(client, input, options \\ [])

View Source

Starts a previously stopped monitoring schedule.

By default, when you successfully create a new schedule, the status of a monitoring schedule is scheduled.

Link to this function

start_notebook_instance(client, input, options \\ [])

View Source

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.

Link to this function

start_pipeline_execution(client, input, options \\ [])

View Source

Starts a pipeline execution.

Link to this function

stop_auto_ml_job(client, input, options \\ [])

View Source

A method for forcing the termination of a running job.

Link to this function

stop_compilation_job(client, input, options \\ [])

View Source

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.

Link to this function

stop_edge_packaging_job(client, input, options \\ [])

View Source

Request to stop an edge packaging job.

Link to this function

stop_hyper_parameter_tuning_job(client, input, options \\ [])

View Source

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.

Link to this function

stop_labeling_job(client, input, options \\ [])

View Source

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.

Link to this function

stop_monitoring_schedule(client, input, options \\ [])

View Source

Stops a previously started monitoring schedule.

Link to this function

stop_notebook_instance(client, input, options \\ [])

View Source

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.

Link to this function

stop_pipeline_execution(client, input, options \\ [])

View Source

Stops a pipeline execution.

A pipeline execution won't stop while a callback step is running. When you call StopPipelineExecution on a pipeline execution with a running callback step, SageMaker Pipelines sends an additional Amazon SQS message to the specified SQS queue. The body of the SQS message contains a "Status" field which is set to "Stopping".

You should add logic to your Amazon SQS message consumer to take any needed action (for example, resource cleanup) upon receipt of the message followed by a call to SendPipelineExecutionStepSuccess or SendPipelineExecutionStepFailure.

Only when SageMaker Pipelines receives one of these calls will it stop the pipeline execution.

Link to this function

stop_processing_job(client, input, options \\ [])

View Source

Stops a processing job.

Link to this function

stop_training_job(client, input, options \\ [])

View Source

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.

Link to this function

stop_transform_job(client, input, options \\ [])

View Source

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.

Link to this function

update_action(client, input, options \\ [])

View Source

Updates an action.

Link to this function

update_app_image_config(client, input, options \\ [])

View Source

Updates the properties of an AppImageConfig.

Link to this function

update_artifact(client, input, options \\ [])

View Source

Updates an artifact.

Link to this function

update_code_repository(client, input, options \\ [])

View Source

Updates the specified Git repository with the specified values.

Link to this function

update_context(client, input, options \\ [])

View Source

Updates a context.

Link to this function

update_device_fleet(client, input, options \\ [])

View Source

Updates a fleet of devices.

Link to this function

update_devices(client, input, options \\ [])

View Source

Updates one or more devices in a fleet.

Link to this function

update_domain(client, input, options \\ [])

View Source

Updates the default settings for new user profiles in the domain.

Link to this function

update_endpoint(client, input, options \\ [])

View Source

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.

If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.

Link to this function

update_endpoint_weights_and_capacities(client, input, options \\ [])

View Source

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.

Link to this function

update_experiment(client, input, options \\ [])

View Source

Adds, updates, or removes the description of an experiment.

Updates the display name of an experiment.

Link to this function

update_image(client, input, options \\ [])

View Source

Updates the properties of a SageMaker image.

To change the image's tags, use the AddTags and DeleteTags APIs.

Link to this function

update_model_package(client, input, options \\ [])

View Source

Updates a versioned model.

Link to this function

update_monitoring_schedule(client, input, options \\ [])

View Source

Updates a previously created schedule.

Link to this function

update_notebook_instance(client, input, options \\ [])

View Source

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.

Link to this function

update_notebook_instance_lifecycle_config(client, input, options \\ [])

View Source

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

Link to this function

update_pipeline(client, input, options \\ [])

View Source

Updates a pipeline.

Link to this function

update_pipeline_execution(client, input, options \\ [])

View Source

Updates a pipeline execution.

Link to this function

update_training_job(client, input, options \\ [])

View Source

Update a model training job to request a new Debugger profiling configuration.

Link to this function

update_trial(client, input, options \\ [])

View Source

Updates the display name of a trial.

Link to this function

update_trial_component(client, input, options \\ [])

View Source

Updates one or more properties of a trial component.

Link to this function

update_user_profile(client, input, options \\ [])

View Source

Updates a user profile.

Link to this function

update_workforce(client, input, options \\ [])

View Source

Use this operation to update your workforce.

You can use this operation to require that workers use specific IP addresses to work on tasks and to update your OpenID Connect (OIDC) Identity Provider (IdP) workforce configuration.

Use SourceIpConfig to restrict worker access to tasks to a specific range of IP addresses. You specify allowed IP addresses by creating a list of up to ten CIDRs. By default, a workforce isn't restricted to specific IP addresses. If you specify a range of IP addresses, workers who attempt to access tasks using any IP address outside the specified range are denied and get a Not Found error message on the worker portal.

Use OidcConfig to update the configuration of a workforce created using your own OIDC IdP.

You can only update your OIDC IdP configuration when there are no work teams associated with your workforce. You can delete work teams using the operation.

After restricting access to a range of IP addresses or updating your OIDC IdP configuration with this operation, you can view details about your update workforce using the operation.

This operation only applies to private workforces.

Link to this function

update_workteam(client, input, options \\ [])

View Source

Updates an existing work team with new member definitions or description.