Skip to content

Commit e06ca01

Browse files
author
awstools
committed
feat(client-sagemaker): No API changes from previous release. This release migrated the model to Smithy keeping all features unchanged.
1 parent d647fdf commit e06ca01

File tree

228 files changed

+4685
-19318
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

228 files changed

+4685
-19318
lines changed

clients/client-sagemaker/README.md

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,7 @@
66

77
AWS SDK for JavaScript SageMaker Client for Node.js, Browser and React Native.
88

9-
<p>Provides APIs for creating and managing SageMaker resources. </p>
10-
<p>Other Resources:</p>
11-
<ul>
12-
<li>
13-
<p>
14-
<a href="https://docs.aws.amazon.com/sagemaker/latest/dg/whatis.html#first-time-user">SageMaker Developer
15-
Guide</a>
16-
</p>
17-
</li>
18-
<li>
19-
<p>
20-
<a href="https://docs.aws.amazon.com/augmented-ai/2019-11-07/APIReference/Welcome.html">Amazon Augmented AI
21-
Runtime API Reference</a>
22-
</p>
23-
</li>
24-
</ul>
9+
<p>Provides APIs for creating and managing SageMaker resources. </p> <p>Other Resources:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/whatis.html#first-time-user">SageMaker Developer Guide</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/augmented-ai/2019-11-07/APIReference/Welcome.html">Amazon Augmented AI Runtime API Reference</a> </p> </li> </ul>
2510

2611
## Installing
2712

clients/client-sagemaker/src/SageMaker.ts

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7707,22 +7707,7 @@ export interface SageMaker {
77077707
}
77087708

77097709
/**
7710-
* <p>Provides APIs for creating and managing SageMaker resources. </p>
7711-
* <p>Other Resources:</p>
7712-
* <ul>
7713-
* <li>
7714-
* <p>
7715-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/whatis.html#first-time-user">SageMaker Developer
7716-
* Guide</a>
7717-
* </p>
7718-
* </li>
7719-
* <li>
7720-
* <p>
7721-
* <a href="https://docs.aws.amazon.com/augmented-ai/2019-11-07/APIReference/Welcome.html">Amazon Augmented AI
7722-
* Runtime API Reference</a>
7723-
* </p>
7724-
* </li>
7725-
* </ul>
7710+
* <p>Provides APIs for creating and managing SageMaker resources. </p> <p>Other Resources:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/whatis.html#first-time-user">SageMaker Developer Guide</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/augmented-ai/2019-11-07/APIReference/Welcome.html">Amazon Augmented AI Runtime API Reference</a> </p> </li> </ul>
77267711
* @public
77277712
*/
77287713
export class SageMaker extends SageMakerClient implements SageMaker {}

clients/client-sagemaker/src/SageMakerClient.ts

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1909,22 +1909,7 @@ export type SageMakerClientResolvedConfigType = __SmithyResolvedConfiguration<__
19091909
export interface SageMakerClientResolvedConfig extends SageMakerClientResolvedConfigType {}
19101910

19111911
/**
1912-
* <p>Provides APIs for creating and managing SageMaker resources. </p>
1913-
* <p>Other Resources:</p>
1914-
* <ul>
1915-
* <li>
1916-
* <p>
1917-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/whatis.html#first-time-user">SageMaker Developer
1918-
* Guide</a>
1919-
* </p>
1920-
* </li>
1921-
* <li>
1922-
* <p>
1923-
* <a href="https://docs.aws.amazon.com/augmented-ai/2019-11-07/APIReference/Welcome.html">Amazon Augmented AI
1924-
* Runtime API Reference</a>
1925-
* </p>
1926-
* </li>
1927-
* </ul>
1912+
* <p>Provides APIs for creating and managing SageMaker resources. </p> <p>Other Resources:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/whatis.html#first-time-user">SageMaker Developer Guide</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/augmented-ai/2019-11-07/APIReference/Welcome.html">Amazon Augmented AI Runtime API Reference</a> </p> </li> </ul>
19281913
* @public
19291914
*/
19301915
export class SageMakerClient extends __Client<

clients/client-sagemaker/src/commands/AddAssociationCommand.ts

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,7 @@ export interface AddAssociationCommandInput extends AddAssociationRequest {}
2828
export interface AddAssociationCommandOutput extends AddAssociationResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates an <i>association</i> between the source and the destination. A
32-
* source can be associated with multiple destinations, and a destination can be associated
33-
* with multiple sources. An association is a lineage tracking entity. For more information, see
34-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking.html">Amazon SageMaker
35-
* ML Lineage Tracking</a>.</p>
31+
* <p>Creates an <i>association</i> 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 <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking.html">Amazon SageMaker ML Lineage Tracking</a>.</p>
3632
* @example
3733
* Use a bare-bones client and the command you need to make an API call.
3834
* ```javascript
@@ -60,8 +56,7 @@ export interface AddAssociationCommandOutput extends AddAssociationResponse, __M
6056
* @see {@link SageMakerClientResolvedConfig | config} for SageMakerClient's `config` shape.
6157
*
6258
* @throws {@link ResourceLimitExceeded} (client fault)
63-
* <p> You have exceeded an SageMaker resource limit. For example, you might have too many
64-
* training jobs created. </p>
59+
* <p> You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. </p>
6560
*
6661
* @throws {@link ResourceNotFound} (client fault)
6762
* <p>Resource being access is not found.</p>

clients/client-sagemaker/src/commands/AddTagsCommand.ts

Lines changed: 1 addition & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -28,32 +28,7 @@ export interface AddTagsCommandInput extends AddTagsInput {}
2828
export interface AddTagsCommandOutput extends AddTagsOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Adds or overwrites one or more tags for the specified SageMaker resource. You can add
32-
* tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform
33-
* jobs, models, labeling jobs, work teams, endpoint configurations, and
34-
* endpoints.</p>
35-
* <p>Each tag consists of a key and an optional value. Tag keys must be unique per
36-
* resource. For more information about tags, see For more information, see <a href="https://aws.amazon.com/answers/account-management/aws-tagging-strategies/">Amazon Web Services Tagging Strategies</a>.</p>
37-
* <note>
38-
* <p>Tags that you add to a hyperparameter tuning job by calling this API are also
39-
* added to any training jobs that the hyperparameter tuning job launches after you
40-
* call this API, but not to training jobs that the hyperparameter tuning job launched
41-
* before you called this API. To make sure that the tags associated with a
42-
* hyperparameter tuning job are also added to all training jobs that the
43-
* hyperparameter tuning job launches, add the tags when you first create the tuning
44-
* job by specifying them in the <code>Tags</code> parameter of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateHyperParameterTuningJob.html">CreateHyperParameterTuningJob</a>
45-
* </p>
46-
* </note>
47-
* <note>
48-
* <p>Tags that you add to a SageMaker Domain or User Profile by calling this API are
49-
* also added to any Apps that the Domain or User Profile launches after you call this
50-
* API, but not to Apps that the Domain or User Profile launched before you called this
51-
* API. To make sure that the tags associated with a Domain or User Profile are also
52-
* added to all Apps that the Domain or User Profile launches, add the tags when you
53-
* first create the Domain or User Profile by specifying them in the <code>Tags</code>
54-
* parameter of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateDomain.html">CreateDomain</a>
55-
* or <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateUserProfile.html">CreateUserProfile</a>.</p>
56-
* </note>
31+
* <p>Adds or overwrites one or more tags for the specified 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.</p> <p>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 <a href="https://aws.amazon.com/answers/account-management/aws-tagging-strategies/">Amazon Web Services Tagging Strategies</a>.</p> <note> <p>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 <code>Tags</code> parameter of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateHyperParameterTuningJob.html">CreateHyperParameterTuningJob</a> </p> </note> <note> <p>Tags that you add to a SageMaker 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 <code>Tags</code> parameter of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateDomain.html">CreateDomain</a> or <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateUserProfile.html">CreateUserProfile</a>.</p> </note>
5732
* @example
5833
* Use a bare-bones client and the command you need to make an API call.
5934
* ```javascript

clients/client-sagemaker/src/commands/AssociateTrialComponentCommand.ts

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@ export interface AssociateTrialComponentCommandInput extends AssociateTrialCompo
2828
export interface AssociateTrialComponentCommandOutput extends AssociateTrialComponentResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Associates a trial component with a trial. A trial component can be associated with
32-
* multiple trials. To disassociate a trial component from a trial, call the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DisassociateTrialComponent.html">DisassociateTrialComponent</a> API.</p>
31+
* <p>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 <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DisassociateTrialComponent.html">DisassociateTrialComponent</a> API.</p>
3332
* @example
3433
* Use a bare-bones client and the command you need to make an API call.
3534
* ```javascript
@@ -56,8 +55,7 @@ export interface AssociateTrialComponentCommandOutput extends AssociateTrialComp
5655
* @see {@link SageMakerClientResolvedConfig | config} for SageMakerClient's `config` shape.
5756
*
5857
* @throws {@link ResourceLimitExceeded} (client fault)
59-
* <p> You have exceeded an SageMaker resource limit. For example, you might have too many
60-
* training jobs created. </p>
58+
* <p> You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. </p>
6159
*
6260
* @throws {@link ResourceNotFound} (client fault)
6361
* <p>Resource being access is not found.</p>

clients/client-sagemaker/src/commands/BatchDeleteClusterNodesCommand.ts

Lines changed: 1 addition & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -28,23 +28,7 @@ export interface BatchDeleteClusterNodesCommandInput extends BatchDeleteClusterN
2828
export interface BatchDeleteClusterNodesCommandOutput extends BatchDeleteClusterNodesResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Deletes specific nodes within a SageMaker HyperPod cluster. <code>BatchDeleteClusterNodes</code>
32-
* accepts a cluster name and a list of node IDs.</p>
33-
* <important>
34-
* <ul>
35-
* <li>
36-
* <p>To safeguard your work, back up your data to Amazon S3 or an FSx for
37-
* Lustre file system before invoking the API on a worker node group. This will help
38-
* prevent any potential data loss from the instance root volume. For more
39-
* information about backup, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod-operate-cli-command.html#sagemaker-hyperpod-operate-cli-command-update-cluster-software-backup">Use the backup script provided by SageMaker HyperPod</a>. </p>
40-
* </li>
41-
* <li>
42-
* <p>If you want to invoke this API on an existing cluster, you'll first need to
43-
* patch the cluster by running the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateClusterSoftware.html">UpdateClusterSoftware API</a>. For more information about patching a
44-
* cluster, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod-operate-cli-command.html#sagemaker-hyperpod-operate-cli-command-update-cluster-software">Update the SageMaker HyperPod platform software of a cluster</a>.</p>
45-
* </li>
46-
* </ul>
47-
* </important>
31+
* <p>Deletes specific nodes within a SageMaker HyperPod cluster. <code>BatchDeleteClusterNodes</code> accepts a cluster name and a list of node IDs.</p> <important> <ul> <li> <p>To safeguard your work, back up your data to Amazon S3 or an FSx for Lustre file system before invoking the API on a worker node group. This will help prevent any potential data loss from the instance root volume. For more information about backup, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod-operate-cli-command.html#sagemaker-hyperpod-operate-cli-command-update-cluster-software-backup">Use the backup script provided by SageMaker HyperPod</a>. </p> </li> <li> <p>If you want to invoke this API on an existing cluster, you'll first need to patch the cluster by running the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateClusterSoftware.html">UpdateClusterSoftware API</a>. For more information about patching a cluster, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod-operate-cli-command.html#sagemaker-hyperpod-operate-cli-command-update-cluster-software">Update the SageMaker HyperPod platform software of a cluster</a>.</p> </li> </ul> </important>
4832
* @example
4933
* Use a bare-bones client and the command you need to make an API call.
5034
* ```javascript

clients/client-sagemaker/src/commands/CreateActionCommand.ts

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,7 @@ export interface CreateActionCommandInput extends CreateActionRequest {}
2828
export interface CreateActionCommandOutput extends CreateActionResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates an <i>action</i>. An action is a lineage tracking entity that
32-
* represents an action or activity. For example, a model deployment or an HPO job.
33-
* Generally, an action involves at least one input or output artifact. For more information, see
34-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking.html">Amazon SageMaker
35-
* ML Lineage Tracking</a>.</p>
31+
* <p>Creates an <i>action</i>. 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 <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking.html">Amazon SageMaker ML Lineage Tracking</a>.</p>
3632
* @example
3733
* Use a bare-bones client and the command you need to make an API call.
3834
* ```javascript
@@ -80,8 +76,7 @@ export interface CreateActionCommandOutput extends CreateActionResponse, __Metad
8076
* @see {@link SageMakerClientResolvedConfig | config} for SageMakerClient's `config` shape.
8177
*
8278
* @throws {@link ResourceLimitExceeded} (client fault)
83-
* <p> You have exceeded an SageMaker resource limit. For example, you might have too many
84-
* training jobs created. </p>
79+
* <p> You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. </p>
8580
*
8681
* @throws {@link SageMakerServiceException}
8782
* <p>Base exception class for all service exceptions from SageMaker service.</p>

clients/client-sagemaker/src/commands/CreateAppCommand.ts

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,7 @@ export interface CreateAppCommandInput extends CreateAppRequest {}
2828
export interface CreateAppCommandOutput extends CreateAppResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates a running app for the specified UserProfile. This operation is automatically
32-
* invoked by Amazon SageMaker AI upon access to the associated Domain, and when new kernel
33-
* configurations are selected by the user. A user may have multiple Apps active
34-
* simultaneously.</p>
31+
* <p>Creates a running app for the specified UserProfile. This operation is automatically invoked by Amazon SageMaker AI upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously.</p>
3532
* @example
3633
* Use a bare-bones client and the command you need to make an API call.
3734
* ```javascript
@@ -77,8 +74,7 @@ export interface CreateAppCommandOutput extends CreateAppResponse, __MetadataBea
7774
* <p>Resource being accessed is in use.</p>
7875
*
7976
* @throws {@link ResourceLimitExceeded} (client fault)
80-
* <p> You have exceeded an SageMaker resource limit. For example, you might have too many
81-
* training jobs created. </p>
77+
* <p> You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. </p>
8278
*
8379
* @throws {@link SageMakerServiceException}
8480
* <p>Base exception class for all service exceptions from SageMaker service.</p>

clients/client-sagemaker/src/commands/CreateAppImageConfigCommand.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,7 @@ export interface CreateAppImageConfigCommandInput extends CreateAppImageConfigRe
2828
export interface CreateAppImageConfigCommandOutput extends CreateAppImageConfigResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates a configuration for running a SageMaker AI image as a KernelGateway app. The
32-
* configuration specifies the Amazon Elastic File System storage volume on the image, and a list of the
33-
* kernels in the image.</p>
31+
* <p>Creates a configuration for running a SageMaker AI image as a KernelGateway app. The configuration specifies the Amazon Elastic File System storage volume on the image, and a list of the kernels in the image.</p>
3432
* @example
3533
* Use a bare-bones client and the command you need to make an API call.
3634
* ```javascript

clients/client-sagemaker/src/commands/CreateArtifactCommand.ts

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,7 @@ export interface CreateArtifactCommandInput extends CreateArtifactRequest {}
2828
export interface CreateArtifactCommandOutput extends CreateArtifactResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates an <i>artifact</i>. An artifact is a lineage tracking entity that
32-
* represents a URI addressable object or data. Some examples are the S3 URI of a dataset and
33-
* the ECR registry path of an image. For more information, see
34-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking.html">Amazon SageMaker
35-
* ML Lineage Tracking</a>.</p>
31+
* <p>Creates an <i>artifact</i>. 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 <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking.html">Amazon SageMaker ML Lineage Tracking</a>.</p>
3632
* @example
3733
* Use a bare-bones client and the command you need to make an API call.
3834
* ```javascript
@@ -82,8 +78,7 @@ export interface CreateArtifactCommandOutput extends CreateArtifactResponse, __M
8278
* @see {@link SageMakerClientResolvedConfig | config} for SageMakerClient's `config` shape.
8379
*
8480
* @throws {@link ResourceLimitExceeded} (client fault)
85-
* <p> You have exceeded an SageMaker resource limit. For example, you might have too many
86-
* training jobs created. </p>
81+
* <p> You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. </p>
8782
*
8883
* @throws {@link SageMakerServiceException}
8984
* <p>Base exception class for all service exceptions from SageMaker service.</p>

0 commit comments

Comments
 (0)