Skip to content

Commit 928a5b6

Browse files
author
awstools
committed
feat(client-sagemaker): Amazon SageMaker Automatic Model Tuning now supports specifying multiple alternate EC2 instance types to make tuning jobs more robust when the preferred instance type is not available due to insufficient capacity.
1 parent e4f6fb5 commit 928a5b6

19 files changed

+1083
-718
lines changed

clients/client-sagemaker/src/SageMaker.ts

Lines changed: 28 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1291,8 +1291,7 @@ export class SageMaker extends SageMakerClient {
12911291
* jobs, models, labeling jobs, work teams, endpoint configurations, and
12921292
* endpoints.</p>
12931293
* <p>Each tag consists of a key and an optional value. Tag keys must be unique per
1294-
* 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
1295-
* Tagging Strategies</a>.</p>
1294+
* 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>
12961295
* <note>
12971296
* <p>Tags that you add to a hyperparameter tuning job by calling this API are also
12981297
* added to any training jobs that the hyperparameter tuning job launches after you
@@ -1435,8 +1434,7 @@ export class SageMaker extends SageMakerClient {
14351434
}
14361435

14371436
/**
1438-
* <p>Create a machine learning algorithm that you can use in SageMaker and list in the Amazon Web Services
1439-
* Marketplace.</p>
1437+
* <p>Create a machine learning algorithm that you can use in SageMaker and list in the Amazon Web Services Marketplace.</p>
14401438
*/
14411439
public createAlgorithm(
14421440
args: CreateAlgorithmCommandInput,
@@ -1607,8 +1605,8 @@ export class SageMaker extends SageMakerClient {
16071605
* notebooks you create. The Git repository is a resource in your SageMaker account, so it can
16081606
* be associated with more than one notebook instance, and it persists independently from
16091607
* the lifecycle of any notebook instances it is associated with.</p>
1610-
* <p>The repository can be hosted either in <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a> or in any
1611-
* other Git repository.</p>
1608+
* <p>The repository can be hosted either in <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a>
1609+
* or in any other Git repository.</p>
16121610
*/
16131611
public createCodeRepository(
16141612
args: CreateCodeRepositoryCommandInput,
@@ -1988,7 +1986,8 @@ export class SageMaker extends SageMakerClient {
19881986
* operations are being performed on the endpoint. To update an endpoint, you must
19891987
* create a new <code>EndpointConfig</code>.</p>
19901988
* </note>
1991-
* <p>The endpoint name must be unique within an Amazon Web Services Region in your Amazon Web Services account. </p>
1989+
* <p>The endpoint name must be unique within an Amazon Web Services Region in your
1990+
* Amazon Web Services account. </p>
19921991
* <p>When it receives the request, SageMaker creates the endpoint, launches the resources (ML
19931992
* compute instances), and deploys the model(s) on them. </p>
19941993
*
@@ -2010,11 +2009,12 @@ export class SageMaker extends SageMakerClient {
20102009
* check the status of an endpoint, use the <a>DescribeEndpoint</a>
20112010
* API.</p>
20122011
* <p>If any of the models hosted at this endpoint get model data from an Amazon S3 location,
2013-
* SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you
2014-
* provided. Amazon Web Services STS is activated in your IAM user account by default. If you previously
2015-
* deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For
2016-
* more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and
2017-
* Deactivating Amazon Web Services STS in an Amazon Web Services Region</a> in the <i>Amazon Web Services Identity and Access Management User
2012+
* SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the
2013+
* S3 path you provided. Amazon Web Services STS is activated in your IAM user account by
2014+
* default. If you previously deactivated Amazon Web Services STS for a region, you need to
2015+
* reactivate Amazon Web Services STS for that region. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and
2016+
* Deactivating Amazon Web Services STS in an Amazon Web Services Region</a> in the
2017+
* <i>Amazon Web Services Identity and Access Management User
20182018
* Guide</i>.</p>
20192019
* <note>
20202020
* <p> To add the IAM role policies for using this API operation, go to the <a href="https://console.aws.amazon.com/iam/">IAM console</a>, and choose
@@ -2509,17 +2509,15 @@ export class SageMaker extends SageMakerClient {
25092509
* <code>CreateEndpoint</code> API. SageMaker then deploys all of the containers that you
25102510
* defined for the model in the hosting environment. </p>
25112511
* <p>For an example that calls this method when deploying a model to SageMaker hosting services,
2512-
* see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/realtime-endpoints-deployment.html#realtime-endpoints-deployment-create-model">Create a Model (Amazon Web Services SDK for Python (Boto
2513-
* 3)).</a>
2512+
* see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/realtime-endpoints-deployment.html#realtime-endpoints-deployment-create-model">Create a Model (Amazon Web Services SDK for Python (Boto 3)).</a>
25142513
* </p>
25152514
* <p>To run a batch transform using your model, you start a job with the
25162515
* <code>CreateTransformJob</code> API. SageMaker uses your model and your dataset to get
25172516
* inferences which are then saved to a specified S3 location.</p>
25182517
* <p>In the request, you also provide an IAM role that SageMaker can assume to access model
25192518
* artifacts and docker image for deployment on ML compute hosting instances or for batch
25202519
* transform jobs. In addition, you also use the IAM role to manage permissions the
2521-
* inference code needs. For example, if the inference code access any other Amazon Web Services resources,
2522-
* you grant necessary permissions via this role.</p>
2520+
* inference code needs. For example, if the inference code access any other Amazon Web Services resources, you grant necessary permissions via this role.</p>
25232521
*/
25242522
public createModel(args: CreateModelCommandInput, options?: __HttpHandlerOptions): Promise<CreateModelCommandOutput>;
25252523
public createModel(args: CreateModelCommandInput, cb: (err: any, data?: CreateModelCommandOutput) => void): void;
@@ -2971,7 +2969,7 @@ export class SageMaker extends SageMakerClient {
29712969
* <note>
29722970
* <p>The URL that you get from a call to <a>CreatePresignedNotebookInstanceUrl</a> is valid only for 5 minutes. If
29732971
* you try to use the URL after the 5-minute limit expires, you are directed to the
2974-
* Amazon Web Services console sign-in page.</p>
2972+
* Amazon Web Services console sign-in page.</p>
29752973
* </note>
29762974
*/
29772975
public createPresignedNotebookInstanceUrl(
@@ -3886,13 +3884,13 @@ export class SageMaker extends SageMakerClient {
38863884
* endpoint was created. </p>
38873885
* <p>SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't
38883886
* need to use the <a href="http://docs.aws.amazon.com/kms/latest/APIReference/API_RevokeGrant.html">RevokeGrant</a> API call.</p>
3889-
* <p>When you delete your endpoint, SageMaker asynchronously deletes associated endpoint resources such as KMS key grants.
3890-
* You might still see these resources in your account for a few minutes after deleting your endpoint.
3891-
* Do not delete or revoke the permissions for your
3892-
* <code>
3887+
* <p>When you delete your endpoint, SageMaker asynchronously deletes associated endpoint
3888+
* resources such as KMS key grants. You might still see these resources in your account
3889+
* for a few minutes after deleting your endpoint. Do not delete or revoke the permissions
3890+
* for your <code>
38933891
* <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateModel.html#sagemaker-CreateModel-request-ExecutionRoleArn">ExecutionRoleArn</a>
3894-
* </code>,
3895-
* otherwise SageMaker cannot delete these resources.</p>
3892+
* </code>, otherwise SageMaker cannot delete these
3893+
* resources.</p>
38963894
*/
38973895
public deleteEndpoint(
38983896
args: DeleteEndpointCommandInput,
@@ -4164,9 +4162,9 @@ export class SageMaker extends SageMakerClient {
41644162

41654163
/**
41664164
* <p>Deletes a model. The <code>DeleteModel</code> API deletes only the model entry that
4167-
* was created in SageMaker when you called the <code>CreateModel</code> API. It does not
4168-
* delete model artifacts, inference code, or the IAM role that you specified when
4169-
* creating the model. </p>
4165+
* was created in SageMaker when you called the <code>CreateModel</code> API. It does not delete
4166+
* model artifacts, inference code, or the IAM role that you specified when creating the
4167+
* model. </p>
41704168
*/
41714169
public deleteModel(args: DeleteModelCommandInput, options?: __HttpHandlerOptions): Promise<DeleteModelCommandOutput>;
41724170
public deleteModel(args: DeleteModelCommandInput, cb: (err: any, data?: DeleteModelCommandOutput) => void): void;
@@ -8025,8 +8023,8 @@ export class SageMaker extends SageMakerClient {
80258023
}
80268024

80278025
/**
8028-
* <p>Returns a list of the SageMaker notebook instances in the requester's account in an Amazon Web Services
8029-
* Region. </p>
8026+
* <p>Returns a list of the SageMaker notebook instances in the requester's account in an
8027+
* Amazon Web Services Region. </p>
80308028
*/
80318029
public listNotebookInstances(
80328030
args: ListNotebookInstancesCommandInput,
@@ -8386,7 +8384,8 @@ export class SageMaker extends SageMakerClient {
83868384
* <code>InProgress</code>, are selected (sorted according to the creation time,
83878385
* from the most current to the oldest). Next, those with a status of
83888386
* <code>InProgress</code> are returned.</p>
8389-
* <p>You can quickly test the API using the following Amazon Web Services CLI code.</p>
8387+
* <p>You can quickly test the API using the following Amazon Web Services CLI
8388+
* code.</p>
83908389
* <p>
83918390
* <code>aws sagemaker list-training-jobs --max-results 100 --status-equals
83928391
* InProgress</code>

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,7 @@ export interface AddTagsCommandOutput extends AddTagsOutput, __MetadataBearer {}
3030
* jobs, models, labeling jobs, work teams, endpoint configurations, and
3131
* endpoints.</p>
3232
* <p>Each tag consists of a key and an optional value. Tag keys must be unique per
33-
* 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
34-
* Tagging Strategies</a>.</p>
33+
* 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>
3534
* <note>
3635
* <p>Tags that you add to a hyperparameter tuning job by calling this API are also
3736
* added to any training jobs that the hyperparameter tuning job launches after you

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@ export interface CreateAlgorithmCommandInput extends CreateAlgorithmInput {}
2828
export interface CreateAlgorithmCommandOutput extends CreateAlgorithmOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Create a machine learning algorithm that you can use in SageMaker and list in the Amazon Web Services
32-
* Marketplace.</p>
31+
* <p>Create a machine learning algorithm that you can use in SageMaker and list in the Amazon Web Services Marketplace.</p>
3332
* @example
3433
* Use a bare-bones client and the command you need to make an API call.
3534
* ```javascript

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ export interface CreateCodeRepositoryCommandOutput extends CreateCodeRepositoryO
3333
* notebooks you create. The Git repository is a resource in your SageMaker account, so it can
3434
* be associated with more than one notebook instance, and it persists independently from
3535
* the lifecycle of any notebook instances it is associated with.</p>
36-
* <p>The repository can be hosted either in <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a> or in any
37-
* other Git repository.</p>
36+
* <p>The repository can be hosted either in <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a>
37+
* or in any other Git repository.</p>
3838
* @example
3939
* Use a bare-bones client and the command you need to make an API call.
4040
* ```javascript

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

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,8 @@ export interface CreateEndpointCommandOutput extends CreateEndpointOutput, __Met
4141
* operations are being performed on the endpoint. To update an endpoint, you must
4242
* create a new <code>EndpointConfig</code>.</p>
4343
* </note>
44-
* <p>The endpoint name must be unique within an Amazon Web Services Region in your Amazon Web Services account. </p>
44+
* <p>The endpoint name must be unique within an Amazon Web Services Region in your
45+
* Amazon Web Services account. </p>
4546
* <p>When it receives the request, SageMaker creates the endpoint, launches the resources (ML
4647
* compute instances), and deploys the model(s) on them. </p>
4748
*
@@ -63,11 +64,12 @@ export interface CreateEndpointCommandOutput extends CreateEndpointOutput, __Met
6364
* check the status of an endpoint, use the <a>DescribeEndpoint</a>
6465
* API.</p>
6566
* <p>If any of the models hosted at this endpoint get model data from an Amazon S3 location,
66-
* SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you
67-
* provided. Amazon Web Services STS is activated in your IAM user account by default. If you previously
68-
* deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For
69-
* more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and
70-
* Deactivating Amazon Web Services STS in an Amazon Web Services Region</a> in the <i>Amazon Web Services Identity and Access Management User
67+
* SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the
68+
* S3 path you provided. Amazon Web Services STS is activated in your IAM user account by
69+
* default. If you previously deactivated Amazon Web Services STS for a region, you need to
70+
* reactivate Amazon Web Services STS for that region. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and
71+
* Deactivating Amazon Web Services STS in an Amazon Web Services Region</a> in the
72+
* <i>Amazon Web Services Identity and Access Management User
7173
* Guide</i>.</p>
7274
* <note>
7375
* <p> To add the IAM role policies for using this API operation, go to the <a href="https://console.aws.amazon.com/iam/">IAM console</a>, and choose

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

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,17 +39,15 @@ export interface CreateModelCommandOutput extends CreateModelOutput, __MetadataB
3939
* <code>CreateEndpoint</code> API. SageMaker then deploys all of the containers that you
4040
* defined for the model in the hosting environment. </p>
4141
* <p>For an example that calls this method when deploying a model to SageMaker hosting services,
42-
* see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/realtime-endpoints-deployment.html#realtime-endpoints-deployment-create-model">Create a Model (Amazon Web Services SDK for Python (Boto
43-
* 3)).</a>
42+
* see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/realtime-endpoints-deployment.html#realtime-endpoints-deployment-create-model">Create a Model (Amazon Web Services SDK for Python (Boto 3)).</a>
4443
* </p>
4544
* <p>To run a batch transform using your model, you start a job with the
4645
* <code>CreateTransformJob</code> API. SageMaker uses your model and your dataset to get
4746
* inferences which are then saved to a specified S3 location.</p>
4847
* <p>In the request, you also provide an IAM role that SageMaker can assume to access model
4948
* artifacts and docker image for deployment on ML compute hosting instances or for batch
5049
* transform jobs. In addition, you also use the IAM role to manage permissions the
51-
* inference code needs. For example, if the inference code access any other Amazon Web Services resources,
52-
* you grant necessary permissions via this role.</p>
50+
* inference code needs. For example, if the inference code access any other Amazon Web Services resources, you grant necessary permissions via this role.</p>
5351
* @example
5452
* Use a bare-bones client and the command you need to make an API call.
5553
* ```javascript

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ export interface CreatePresignedNotebookInstanceUrlCommandOutput
4646
* <note>
4747
* <p>The URL that you get from a call to <a>CreatePresignedNotebookInstanceUrl</a> is valid only for 5 minutes. If
4848
* you try to use the URL after the 5-minute limit expires, you are directed to the
49-
* Amazon Web Services console sign-in page.</p>
49+
* Amazon Web Services console sign-in page.</p>
5050
* </note>
5151
* @example
5252
* Use a bare-bones client and the command you need to make an API call.

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,13 @@ export interface DeleteEndpointCommandOutput extends __MetadataBearer {}
2727
* endpoint was created. </p>
2828
* <p>SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't
2929
* need to use the <a href="http://docs.aws.amazon.com/kms/latest/APIReference/API_RevokeGrant.html">RevokeGrant</a> API call.</p>
30-
* <p>When you delete your endpoint, SageMaker asynchronously deletes associated endpoint resources such as KMS key grants.
31-
* You might still see these resources in your account for a few minutes after deleting your endpoint.
32-
* Do not delete or revoke the permissions for your
33-
* <code>
30+
* <p>When you delete your endpoint, SageMaker asynchronously deletes associated endpoint
31+
* resources such as KMS key grants. You might still see these resources in your account
32+
* for a few minutes after deleting your endpoint. Do not delete or revoke the permissions
33+
* for your <code>
3434
* <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateModel.html#sagemaker-CreateModel-request-ExecutionRoleArn">ExecutionRoleArn</a>
35-
* </code>,
36-
* otherwise SageMaker cannot delete these resources.</p>
35+
* </code>, otherwise SageMaker cannot delete these
36+
* resources.</p>
3737
* @example
3838
* Use a bare-bones client and the command you need to make an API call.
3939
* ```javascript

0 commit comments

Comments
 (0)