AWS SDK for JavaScript Sagemaker Client for Node.js, Browser and React Native
npm install @aws-sdk/client-sagemakerAWS SDK for JavaScript SageMaker Client for Node.js, Browser and React Native.
Provides APIs for creating and managing SageMaker resources.
Other Resources:
npm install @aws-sdk/client-sagemakeryarn add @aws-sdk/client-sagemakerpnpm add @aws-sdk/client-sagemakerThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the SageMakerClient and
the commands you need, for example ListActionsCommand:
``js`
// ES5 example
const { SageMakerClient, ListActionsCommand } = require("@aws-sdk/client-sagemaker");
`ts`
// ES6+ example
import { SageMakerClient, ListActionsCommand } from "@aws-sdk/client-sagemaker";
To send a request, you:
- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.destroy()
- If you are using a custom http handler, you may call to close open connections.
`js
// a client can be shared by different commands.
const client = new SageMakerClient({ region: "REGION" });
const params = { /* input parameters / };
const command = new ListActionsCommand(params);
`
#### Async/await
We recommend using await
operator to wait for the promise returned by send operation as follows:
`js`
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.
#### Promises
You can also use Promise chaining
to execute send operation.
`js`
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
Promises can also be called using .catch() and .finally() as follows:
`js`
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
#### Callbacks
We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.
`js`
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
#### v2 compatible style
The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript
`ts
import * as AWS from "@aws-sdk/client-sagemaker";
const client = new AWS.SageMaker({ region: "REGION" });
// async/await.
try {
const data = await client.listActions(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listActions(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listActions(params, (err, data) => {
// process err and data.
});
`
When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).
`js`
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.
To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-sagemaker` package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.
AddAssociation
Command API Reference / Input / Output
AddTags
Command API Reference / Input / Output
AssociateTrialComponent
Command API Reference / Input / Output
AttachClusterNodeVolume
Command API Reference / Input / Output
BatchAddClusterNodes
Command API Reference / Input / Output
BatchDeleteClusterNodes
Command API Reference / Input / Output
BatchDescribeModelPackage
Command API Reference / Input / Output
BatchRebootClusterNodes
Command API Reference / Input / Output
BatchReplaceClusterNodes
Command API Reference / Input / Output
CreateAction
Command API Reference / Input / Output
CreateAlgorithm
Command API Reference / Input / Output
CreateApp
Command API Reference / Input / Output
CreateAppImageConfig
Command API Reference / Input / Output
CreateArtifact
Command API Reference / Input / Output
CreateAutoMLJob
Command API Reference / Input / Output
CreateAutoMLJobV2
Command API Reference / Input / Output
CreateCluster
Command API Reference / Input / Output
CreateClusterSchedulerConfig
Command API Reference / Input / Output
CreateCodeRepository
Command API Reference / Input / Output
CreateCompilationJob
Command API Reference / Input / Output
CreateComputeQuota
Command API Reference / Input / Output
CreateContext
Command API Reference / Input / Output
CreateDataQualityJobDefinition
Command API Reference / Input / Output
CreateDeviceFleet
Command API Reference / Input / Output
CreateDomain
Command API Reference / Input / Output
CreateEdgeDeploymentPlan
Command API Reference / Input / Output
CreateEdgeDeploymentStage
Command API Reference / Input / Output
CreateEdgePackagingJob
Command API Reference / Input / Output
CreateEndpoint
Command API Reference / Input / Output
CreateEndpointConfig
Command API Reference / Input / Output
CreateExperiment
Command API Reference / Input / Output
CreateFeatureGroup
Command API Reference / Input / Output
CreateFlowDefinition
Command API Reference / Input / Output
CreateHub
Command API Reference / Input / Output
CreateHubContentPresignedUrls
Command API Reference / Input / Output
CreateHubContentReference
Command API Reference / Input / Output
CreateHumanTaskUi
Command API Reference / Input / Output
CreateHyperParameterTuningJob
Command API Reference / Input / Output
CreateImage
Command API Reference / Input / Output
CreateImageVersion
Command API Reference / Input / Output
CreateInferenceComponent
Command API Reference / Input / Output
CreateInferenceExperiment
Command API Reference / Input / Output
CreateInferenceRecommendationsJob
Command API Reference / Input / Output
CreateLabelingJob
Command API Reference / Input / Output
CreateMlflowApp
Command API Reference / Input / Output
CreateMlflowTrackingServer
Command API Reference / Input / Output
CreateModel
Command API Reference / Input / Output
CreateModelBiasJobDefinition
Command API Reference / Input / Output
CreateModelCard
Command API Reference / Input / Output
CreateModelCardExportJob
Command API Reference / Input / Output
CreateModelExplainabilityJobDefinition
Command API Reference / Input / Output
CreateModelPackage
Command API Reference / Input / Output
CreateModelPackageGroup
Command API Reference / Input / Output
CreateModelQualityJobDefinition
Command API Reference / Input / Output
CreateMonitoringSchedule
Command API Reference / Input / Output
CreateNotebookInstance
Command API Reference / Input / Output
CreateNotebookInstanceLifecycleConfig
Command API Reference / Input / Output
CreateOptimizationJob
Command API Reference / Input / Output
CreatePartnerApp
Command API Reference / Input / Output
CreatePartnerAppPresignedUrl
Command API Reference / Input / Output
CreatePipeline
Command API Reference / Input / Output
CreatePresignedDomainUrl
Command API Reference / Input / Output
CreatePresignedMlflowAppUrl
Command API Reference / Input / Output
CreatePresignedMlflowTrackingServerUrl
Command API Reference / Input / Output
CreatePresignedNotebookInstanceUrl
Command API Reference / Input / Output
CreateProcessingJob
Command API Reference / Input / Output
CreateProject
Command API Reference / Input / Output
CreateSpace
Command API Reference / Input / Output
CreateStudioLifecycleConfig
Command API Reference / Input / Output
CreateTrainingJob
Command API Reference / Input / Output
CreateTrainingPlan
Command API Reference / Input / Output
CreateTransformJob
Command API Reference / Input / Output
CreateTrial
Command API Reference / Input / Output
CreateTrialComponent
Command API Reference / Input / Output
CreateUserProfile
Command API Reference / Input / Output
CreateWorkforce
Command API Reference / Input / Output
CreateWorkteam
Command API Reference / Input / Output
DeleteAction
Command API Reference / Input / Output
DeleteAlgorithm
Command API Reference / Input / Output
DeleteApp
Command API Reference / Input / Output
DeleteAppImageConfig
Command API Reference / Input / Output
DeleteArtifact
Command API Reference / Input / Output
DeleteAssociation
Command API Reference / Input / Output
DeleteCluster
Command API Reference / Input / Output
DeleteClusterSchedulerConfig
Command API Reference / Input / Output
DeleteCodeRepository
Command API Reference / Input / Output
DeleteCompilationJob
Command API Reference / Input / Output
DeleteComputeQuota
Command API Reference / Input / Output
DeleteContext
Command API Reference / Input / Output
DeleteDataQualityJobDefinition
Command API Reference / Input / Output
DeleteDeviceFleet
Command API Reference / Input / Output
DeleteDomain
Command API Reference / Input / Output
DeleteEdgeDeploymentPlan
Command API Reference / Input / Output
DeleteEdgeDeploymentStage
Command API Reference / Input / Output
DeleteEndpoint
Command API Reference / Input / Output
DeleteEndpointConfig
Command API Reference / Input / Output
DeleteExperiment
Command API Reference / Input / Output
DeleteFeatureGroup
Command API Reference / Input / Output
DeleteFlowDefinition
Command API Reference / Input / Output
DeleteHub
Command API Reference / Input / Output
DeleteHubContent
Command API Reference / Input / Output
DeleteHubContentReference
Command API Reference / Input / Output
DeleteHumanTaskUi
Command API Reference / Input / Output
DeleteHyperParameterTuningJob
Command API Reference / Input / Output
DeleteImage
Command API Reference / Input / Output
DeleteImageVersion
Command API Reference / Input / Output
DeleteInferenceComponent
Command API Reference / Input / Output
DeleteInferenceExperiment
Command API Reference / Input / Output
DeleteMlflowApp
Command API Reference / Input / Output
DeleteMlflowTrackingServer
Command API Reference / Input / Output
DeleteModel
Command API Reference / Input / Output
DeleteModelBiasJobDefinition
Command API Reference / Input / Output
DeleteModelCard
Command API Reference / Input / Output
DeleteModelExplainabilityJobDefinition
Command API Reference / Input / Output
DeleteModelPackage
Command API Reference / Input / Output
DeleteModelPackageGroup
Command API Reference / Input / Output
DeleteModelPackageGroupPolicy
Command API Reference / Input / Output
DeleteModelQualityJobDefinition
Command API Reference / Input / Output
DeleteMonitoringSchedule
Command API Reference / Input / Output
DeleteNotebookInstance
Command API Reference / Input / Output
DeleteNotebookInstanceLifecycleConfig
Command API Reference / Input / Output
DeleteOptimizationJob
Command API Reference / Input / [Output](https://docs.aws.amazon.com/AWSJ