@aws-sdk/client-sagemaker 3.231.0 → 3.232.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/commands/DescribeAppCommand.js +2 -1
- package/dist-cjs/commands/ListCodeRepositoriesCommand.js +1 -2
- package/dist-cjs/commands/UpdateImageCommand.js +2 -1
- package/dist-cjs/endpoint/ruleset.js +0 -9
- package/dist-cjs/models/models_1.js +10 -10
- package/dist-cjs/models/models_2.js +9 -9
- package/dist-cjs/models/models_3.js +10 -10
- package/dist-cjs/models/models_4.js +5 -1
- package/dist-cjs/protocols/Aws_json1_1.js +58 -0
- package/dist-es/commands/DescribeAppCommand.js +2 -1
- package/dist-es/commands/ListCodeRepositoriesCommand.js +1 -2
- package/dist-es/commands/UpdateImageCommand.js +2 -1
- package/dist-es/endpoint/ruleset.js +0 -9
- package/dist-es/models/models_1.js +3 -3
- package/dist-es/models/models_2.js +3 -3
- package/dist-es/models/models_3.js +3 -3
- package/dist-es/models/models_4.js +3 -0
- package/dist-es/protocols/Aws_json1_1.js +58 -0
- package/dist-types/SageMaker.d.ts +166 -181
- package/dist-types/SageMakerClient.d.ts +4 -4
- package/dist-types/commands/AddTagsCommand.d.ts +5 -5
- package/dist-types/commands/CreateCodeRepositoryCommand.d.ts +1 -1
- package/dist-types/commands/CreateCompilationJobCommand.d.ts +9 -9
- package/dist-types/commands/CreateDomainCommand.d.ts +0 -2
- package/dist-types/commands/CreateEndpointCommand.d.ts +22 -24
- package/dist-types/commands/CreateEndpointConfigCommand.d.ts +6 -6
- package/dist-types/commands/CreateHyperParameterTuningJobCommand.d.ts +3 -3
- package/dist-types/commands/CreateInferenceExperimentCommand.d.ts +2 -2
- package/dist-types/commands/CreateLabelingJobCommand.d.ts +9 -9
- package/dist-types/commands/CreateModelCommand.d.ts +5 -5
- package/dist-types/commands/CreateModelPackageCommand.d.ts +7 -7
- package/dist-types/commands/CreateNotebookInstanceCommand.d.ts +10 -12
- package/dist-types/commands/CreateNotebookInstanceLifecycleConfigCommand.d.ts +5 -5
- package/dist-types/commands/CreatePresignedNotebookInstanceUrlCommand.d.ts +4 -4
- package/dist-types/commands/CreateTrainingJobCommand.d.ts +20 -21
- package/dist-types/commands/CreateTransformJobCommand.d.ts +9 -9
- package/dist-types/commands/CreateWorkforceCommand.d.ts +1 -4
- package/dist-types/commands/CreateWorkteamCommand.d.ts +1 -1
- package/dist-types/commands/DeleteEndpointCommand.d.ts +2 -2
- package/dist-types/commands/DeleteEndpointConfigCommand.d.ts +1 -1
- package/dist-types/commands/DeleteInferenceExperimentCommand.d.ts +1 -1
- package/dist-types/commands/DeleteModelPackageCommand.d.ts +1 -1
- package/dist-types/commands/DeleteNotebookInstanceCommand.d.ts +2 -2
- package/dist-types/commands/DeleteTagsCommand.d.ts +5 -5
- package/dist-types/commands/DeleteWorkforceCommand.d.ts +1 -2
- package/dist-types/commands/DescribeAppCommand.d.ts +2 -1
- package/dist-types/commands/DescribeCompilationJobCommand.d.ts +1 -1
- package/dist-types/commands/DescribeModelPackageCommand.d.ts +1 -1
- package/dist-types/commands/DescribeNotebookInstanceLifecycleConfigCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTrainingJobCommand.d.ts +1 -1
- package/dist-types/commands/DescribeWorkforceCommand.d.ts +2 -2
- package/dist-types/commands/ListCodeRepositoriesCommand.d.ts +1 -2
- package/dist-types/commands/ListCompilationJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListTrainingJobsCommand.d.ts +2 -2
- package/dist-types/commands/StopCompilationJobCommand.d.ts +2 -2
- package/dist-types/commands/StopHyperParameterTuningJobCommand.d.ts +1 -1
- package/dist-types/commands/StopNotebookInstanceCommand.d.ts +1 -1
- package/dist-types/commands/StopPipelineExecutionCommand.d.ts +0 -2
- package/dist-types/commands/StopTrainingJobCommand.d.ts +1 -1
- package/dist-types/commands/StopTransformJobCommand.d.ts +1 -1
- package/dist-types/commands/UpdateEndpointCommand.d.ts +3 -3
- package/dist-types/commands/UpdateImageCommand.d.ts +2 -1
- package/dist-types/commands/UpdateProjectCommand.d.ts +2 -2
- package/dist-types/commands/UpdateWorkforceCommand.d.ts +10 -12
- package/dist-types/models/models_0.d.ts +698 -706
- package/dist-types/models/models_1.d.ts +1112 -1191
- package/dist-types/models/models_2.d.ts +377 -336
- package/dist-types/models/models_3.d.ts +151 -112
- package/dist-types/models/models_4.d.ts +26 -11
- package/dist-types/ts3.4/commands/DescribeAppCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/ListCodeRepositoriesCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/UpdateImageCommand.d.ts +2 -1
- package/dist-types/ts3.4/models/models_1.d.ts +8 -19
- package/dist-types/ts3.4/models/models_2.d.ts +19 -16
- package/dist-types/ts3.4/models/models_3.d.ts +16 -6
- package/dist-types/ts3.4/models/models_4.d.ts +6 -0
- package/package.json +1 -1
|
@@ -10,58 +10,57 @@ export interface CreateTrainingJobCommandOutput extends CreateTrainingJobRespons
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Starts a model training job. After training completes, SageMaker saves the resulting
|
|
12
12
|
* model artifacts to an Amazon S3 location that you specify. </p>
|
|
13
|
-
*
|
|
13
|
+
* <p>If you choose to host your model using SageMaker hosting services, you can use the
|
|
14
14
|
* resulting model artifacts as part of the model. You can also use the artifacts in a
|
|
15
15
|
* machine learning service other than SageMaker, provided that you know how to use them for
|
|
16
16
|
* inference.
|
|
17
17
|
* </p>
|
|
18
|
-
*
|
|
19
|
-
*
|
|
18
|
+
* <p>In the request body, you provide the following: </p>
|
|
19
|
+
* <ul>
|
|
20
20
|
* <li>
|
|
21
|
-
*
|
|
21
|
+
* <p>
|
|
22
22
|
* <code>AlgorithmSpecification</code> - Identifies the training algorithm to
|
|
23
23
|
* use.
|
|
24
24
|
* </p>
|
|
25
25
|
* </li>
|
|
26
26
|
* <li>
|
|
27
|
-
*
|
|
28
|
-
*
|
|
27
|
+
* <p>
|
|
28
|
+
* <code>HyperParameters</code> - Specify these algorithm-specific parameters to
|
|
29
29
|
* enable the estimation of model parameters during training. Hyperparameters can
|
|
30
30
|
* be tuned to optimize this learning process. For a list of hyperparameters for
|
|
31
31
|
* each training algorithm provided by SageMaker, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html">Algorithms</a>. </p>
|
|
32
|
-
*
|
|
33
|
-
*
|
|
32
|
+
* <important>
|
|
33
|
+
* <p>Do not include any security-sensitive information including account access
|
|
34
34
|
* IDs, secrets or tokens in any hyperparameter field. If the use of
|
|
35
35
|
* security-sensitive credentials are detected, SageMaker will reject your training
|
|
36
36
|
* job request and return an exception error.</p>
|
|
37
|
-
*
|
|
37
|
+
* </important>
|
|
38
38
|
* </li>
|
|
39
39
|
* <li>
|
|
40
|
-
*
|
|
41
|
-
* <code>InputDataConfig</code> - Describes the input required by the training
|
|
42
|
-
* EFS, or FSx location where it is stored.</p>
|
|
40
|
+
* <p>
|
|
41
|
+
* <code>InputDataConfig</code> - Describes the input required by the training
|
|
42
|
+
* job and the Amazon S3, EFS, or FSx location where it is stored.</p>
|
|
43
43
|
* </li>
|
|
44
44
|
* <li>
|
|
45
|
-
*
|
|
45
|
+
* <p>
|
|
46
46
|
* <code>OutputDataConfig</code> - Identifies the Amazon S3 bucket where you want
|
|
47
47
|
* SageMaker to save the results of model training. </p>
|
|
48
48
|
* </li>
|
|
49
49
|
* <li>
|
|
50
|
-
*
|
|
50
|
+
* <p>
|
|
51
51
|
* <code>ResourceConfig</code> - Identifies the resources, ML compute
|
|
52
52
|
* instances, and ML storage volumes to deploy for model training. In distributed
|
|
53
53
|
* training, you specify more than one instance. </p>
|
|
54
|
-
*
|
|
55
54
|
* </li>
|
|
56
55
|
* <li>
|
|
57
|
-
*
|
|
56
|
+
* <p>
|
|
58
57
|
* <code>EnableManagedSpotTraining</code> - Optimize the cost of training machine
|
|
59
58
|
* learning models by up to 80% by using Amazon EC2 Spot instances. For more
|
|
60
59
|
* information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-managed-spot-training.html">Managed Spot
|
|
61
60
|
* Training</a>. </p>
|
|
62
61
|
* </li>
|
|
63
62
|
* <li>
|
|
64
|
-
*
|
|
63
|
+
* <p>
|
|
65
64
|
* <code>RoleArn</code> - The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on
|
|
66
65
|
* your behalf during model training.
|
|
67
66
|
*
|
|
@@ -69,24 +68,24 @@ export interface CreateTrainingJobCommandOutput extends CreateTrainingJobRespons
|
|
|
69
68
|
* complete model training. </p>
|
|
70
69
|
* </li>
|
|
71
70
|
* <li>
|
|
72
|
-
*
|
|
71
|
+
* <p>
|
|
73
72
|
* <code>StoppingCondition</code> - To help cap training costs, use
|
|
74
73
|
* <code>MaxRuntimeInSeconds</code> to set a time limit for training. Use
|
|
75
74
|
* <code>MaxWaitTimeInSeconds</code> to specify how long a managed spot
|
|
76
75
|
* training job has to complete. </p>
|
|
77
76
|
* </li>
|
|
78
77
|
* <li>
|
|
79
|
-
*
|
|
78
|
+
* <p>
|
|
80
79
|
* <code>Environment</code> - The environment variables to set in the Docker
|
|
81
80
|
* container.</p>
|
|
82
81
|
* </li>
|
|
83
82
|
* <li>
|
|
84
|
-
*
|
|
83
|
+
* <p>
|
|
85
84
|
* <code>RetryStrategy</code> - The number of times to retry the job when the job
|
|
86
85
|
* fails due to an <code>InternalServerError</code>.</p>
|
|
87
86
|
* </li>
|
|
88
87
|
* </ul>
|
|
89
|
-
*
|
|
88
|
+
* <p> For more information about SageMaker, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/how-it-works.html">How It Works</a>. </p>
|
|
90
89
|
* @example
|
|
91
90
|
* Use a bare-bones client and the command you need to make an API call.
|
|
92
91
|
* ```javascript
|
|
@@ -10,38 +10,38 @@ export interface CreateTransformJobCommandOutput extends CreateTransformJobRespo
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Starts a transform job. A transform job uses a trained model to get inferences on a
|
|
12
12
|
* dataset and saves these results to an Amazon S3 location that you specify.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>To perform batch transformations, you create a transform job and use the data that you
|
|
14
14
|
* have readily available.</p>
|
|
15
|
-
*
|
|
16
|
-
*
|
|
15
|
+
* <p>In the request body, you provide the following:</p>
|
|
16
|
+
* <ul>
|
|
17
17
|
* <li>
|
|
18
|
-
*
|
|
18
|
+
* <p>
|
|
19
19
|
* <code>TransformJobName</code> - Identifies the transform job. The name must be
|
|
20
20
|
* unique within an Amazon Web Services Region in an Amazon Web Services account.</p>
|
|
21
21
|
* </li>
|
|
22
22
|
* <li>
|
|
23
|
-
*
|
|
23
|
+
* <p>
|
|
24
24
|
* <code>ModelName</code> - Identifies the model to use. <code>ModelName</code>
|
|
25
25
|
* must be the name of an existing Amazon SageMaker model in the same Amazon Web Services Region and Amazon Web Services
|
|
26
26
|
* account. For information on creating a model, see <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateModel.html">CreateModel</a>.</p>
|
|
27
27
|
* </li>
|
|
28
28
|
* <li>
|
|
29
|
-
*
|
|
29
|
+
* <p>
|
|
30
30
|
* <code>TransformInput</code> - Describes the dataset to be transformed and the
|
|
31
31
|
* Amazon S3 location where it is stored.</p>
|
|
32
32
|
* </li>
|
|
33
33
|
* <li>
|
|
34
|
-
*
|
|
34
|
+
* <p>
|
|
35
35
|
* <code>TransformOutput</code> - Identifies the Amazon S3 location where you want
|
|
36
36
|
* Amazon SageMaker to save the results from the transform job.</p>
|
|
37
37
|
* </li>
|
|
38
38
|
* <li>
|
|
39
|
-
*
|
|
39
|
+
* <p>
|
|
40
40
|
* <code>TransformResources</code> - Identifies the ML compute instances for the
|
|
41
41
|
* transform job.</p>
|
|
42
42
|
* </li>
|
|
43
43
|
* </ul>
|
|
44
|
-
*
|
|
44
|
+
* <p>For more information about how batch transformation works, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform.html">Batch
|
|
45
45
|
* Transform</a>.</p>
|
|
46
46
|
* @example
|
|
47
47
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -11,19 +11,16 @@ export interface CreateWorkforceCommandOutput extends CreateWorkforceResponse, _
|
|
|
11
11
|
* <p>Use this operation to create a workforce. This operation will return an error
|
|
12
12
|
* if a workforce already exists in the Amazon Web Services Region that you specify. You can only
|
|
13
13
|
* create one workforce in each Amazon Web Services Region per Amazon Web Services account.</p>
|
|
14
|
-
*
|
|
15
|
-
* <p>If you want to create a new workforce in an Amazon Web Services Region where
|
|
14
|
+
* <p>If you want to create a new workforce in an Amazon Web Services Region where
|
|
16
15
|
* a workforce already exists, use the API
|
|
17
16
|
* operation to delete the existing workforce and then use <code>CreateWorkforce</code>
|
|
18
17
|
* to create a new workforce.</p>
|
|
19
|
-
*
|
|
20
18
|
* <p>To create a private workforce using Amazon Cognito, you must specify a Cognito user pool
|
|
21
19
|
* in <code>CognitoConfig</code>.
|
|
22
20
|
* You can also create an Amazon Cognito workforce using the Amazon SageMaker console.
|
|
23
21
|
* For more information, see
|
|
24
22
|
* <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private.html">
|
|
25
23
|
* Create a Private Workforce (Amazon Cognito)</a>.</p>
|
|
26
|
-
*
|
|
27
24
|
* <p>To create a private workforce using your own OIDC Identity Provider (IdP), specify your IdP
|
|
28
25
|
* configuration in <code>OidcConfig</code>. Your OIDC IdP must support <i>groups</i>
|
|
29
26
|
* because groups are used by Ground Truth and Amazon A2I to create work teams.
|
|
@@ -11,7 +11,7 @@ export interface CreateWorkteamCommandOutput extends CreateWorkteamResponse, __M
|
|
|
11
11
|
* <p>Creates a new work team for labeling your data. A work team is defined by one or more
|
|
12
12
|
* Amazon Cognito user pools. You must first create the user pools before you can create a work
|
|
13
13
|
* team.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>You cannot create more than 25 work teams in an account and region.</p>
|
|
15
15
|
* @example
|
|
16
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
17
17
|
* ```javascript
|
|
@@ -10,9 +10,9 @@ export interface DeleteEndpointCommandOutput extends __MetadataBearer {
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes an endpoint. SageMaker frees up all of the resources that were deployed when the
|
|
12
12
|
* endpoint was created. </p>
|
|
13
|
-
*
|
|
13
|
+
* <p>SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't
|
|
14
14
|
* need to use the <a href="http://docs.aws.amazon.com/kms/latest/APIReference/API_RevokeGrant.html">RevokeGrant</a> API call.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>When you delete your endpoint, SageMaker asynchronously deletes associated endpoint
|
|
16
16
|
* resources such as KMS key grants. You might still see these resources in your account
|
|
17
17
|
* for a few minutes after deleting your endpoint. Do not delete or revoke the permissions
|
|
18
18
|
* for your <code>
|
|
@@ -11,7 +11,7 @@ export interface DeleteEndpointConfigCommandOutput extends __MetadataBearer {
|
|
|
11
11
|
* <p>Deletes an endpoint configuration. The <code>DeleteEndpointConfig</code> API
|
|
12
12
|
* deletes only the specified configuration. It does not delete endpoints created using the
|
|
13
13
|
* configuration. </p>
|
|
14
|
-
*
|
|
14
|
+
* <p>You must not delete an <code>EndpointConfig</code> in use by an endpoint that is
|
|
15
15
|
* live or while the <code>UpdateEndpoint</code> or <code>CreateEndpoint</code> operations
|
|
16
16
|
* are being performed on the endpoint. If you delete the <code>EndpointConfig</code> of an
|
|
17
17
|
* endpoint that is active or being created or updated you may lose visibility into the
|
|
@@ -10,7 +10,7 @@ export interface DeleteInferenceExperimentCommandOutput extends DeleteInferenceE
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes an inference experiment.</p>
|
|
12
12
|
* <note>
|
|
13
|
-
*
|
|
13
|
+
* <p>
|
|
14
14
|
* This operation does not delete your endpoint, variants, or any underlying resources. This operation only
|
|
15
15
|
* deletes the metadata of your experiment.
|
|
16
16
|
* </p>
|
|
@@ -9,7 +9,7 @@ export interface DeleteModelPackageCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes a model package.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>A model package is used to create SageMaker models or list on Amazon Web Services Marketplace. Buyers can
|
|
13
13
|
* subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.</p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -10,11 +10,11 @@ export interface DeleteNotebookInstanceCommandOutput extends __MetadataBearer {
|
|
|
10
10
|
/**
|
|
11
11
|
* <p> Deletes an SageMaker notebook instance. Before you can delete a notebook instance, you
|
|
12
12
|
* must call the <code>StopNotebookInstance</code> API. </p>
|
|
13
|
-
*
|
|
13
|
+
* <important>
|
|
14
14
|
* <p>When you delete a notebook instance, you lose all of your data. SageMaker removes
|
|
15
15
|
* the ML compute instance, and deletes the ML storage volume and the network interface
|
|
16
16
|
* associated with the notebook instance. </p>
|
|
17
|
-
*
|
|
17
|
+
* </important>
|
|
18
18
|
* @example
|
|
19
19
|
* Use a bare-bones client and the command you need to make an API call.
|
|
20
20
|
* ```javascript
|
|
@@ -9,17 +9,17 @@ export interface DeleteTagsCommandOutput extends DeleteTagsOutput, __MetadataBea
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes the specified tags from an SageMaker resource.</p>
|
|
12
|
-
*
|
|
13
|
-
*
|
|
12
|
+
* <p>To list a resource's tags, use the <code>ListTags</code> API. </p>
|
|
13
|
+
* <note>
|
|
14
14
|
* <p>When you call this API to delete tags from a hyperparameter tuning job, the
|
|
15
15
|
* deleted tags are not removed from training jobs that the hyperparameter tuning job
|
|
16
16
|
* launched before you called this API.</p>
|
|
17
|
-
*
|
|
18
|
-
*
|
|
17
|
+
* </note>
|
|
18
|
+
* <note>
|
|
19
19
|
* <p>When you call this API to delete tags from a SageMaker Studio Domain or User
|
|
20
20
|
* Profile, the deleted tags are not removed from Apps that the SageMaker Studio Domain
|
|
21
21
|
* or User Profile launched before you called this API.</p>
|
|
22
|
-
*
|
|
22
|
+
* </note>
|
|
23
23
|
* @example
|
|
24
24
|
* Use a bare-bones client and the command you need to make an API call.
|
|
25
25
|
* ```javascript
|
|
@@ -9,7 +9,6 @@ export interface DeleteWorkforceCommandOutput extends DeleteWorkforceResponse, _
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Use this operation to delete a workforce.</p>
|
|
12
|
-
*
|
|
13
12
|
* <p>If you want to create a new workforce in an Amazon Web Services Region where
|
|
14
13
|
* a workforce already exists, use this operation to delete the
|
|
15
14
|
* existing workforce and then use
|
|
@@ -20,7 +19,7 @@ export interface DeleteWorkforceCommandOutput extends DeleteWorkforceResponse, _
|
|
|
20
19
|
* operation to delete all work teams before you delete the workforce.
|
|
21
20
|
* If you try to delete a workforce that contains one or more work teams,
|
|
22
21
|
* you will recieve a <code>ResourceInUse</code> error.</p>
|
|
23
|
-
*
|
|
22
|
+
* </important>
|
|
24
23
|
* @example
|
|
25
24
|
* Use a bare-bones client and the command you need to make an API call.
|
|
26
25
|
* ```javascript
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
2
|
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
3
|
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
-
import { DescribeAppRequest
|
|
4
|
+
import { DescribeAppRequest } from "../models/models_1";
|
|
5
|
+
import { DescribeAppResponse } from "../models/models_2";
|
|
5
6
|
import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";
|
|
6
7
|
export interface DescribeAppCommandInput extends DescribeAppRequest {
|
|
7
8
|
}
|
|
@@ -9,7 +9,7 @@ export interface DescribeCompilationJobCommandOutput extends DescribeCompilation
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Returns information about a model compilation job.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>To create a model compilation job, use <a>CreateCompilationJob</a>. To get
|
|
13
13
|
* information about multiple model compilation jobs, use <a>ListCompilationJobs</a>.</p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -10,7 +10,7 @@ export interface DescribeModelPackageCommandOutput extends DescribeModelPackageO
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Returns a description of the specified model package, which is used to create SageMaker
|
|
12
12
|
* models or list them on Amazon Web Services Marketplace.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>To create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services
|
|
14
14
|
* Marketplace.</p>
|
|
15
15
|
* @example
|
|
16
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,7 +9,7 @@ export interface DescribeNotebookInstanceLifecycleConfigCommandOutput extends De
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Returns a description of a notebook instance lifecycle configuration.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>For information about notebook instance lifestyle configurations, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html">Step
|
|
13
13
|
* 2.1: (Optional) Customize a Notebook Instance</a>.</p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,7 +9,7 @@ export interface DescribeTrainingJobCommandOutput extends DescribeTrainingJobRes
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Returns information about a training job. </p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Some of the attributes below only appear if the training job successfully starts.
|
|
13
13
|
* If the training job fails, <code>TrainingJobStatus</code> is <code>Failed</code> and,
|
|
14
14
|
* depending on the <code>FailureReason</code>, attributes like
|
|
15
15
|
* <code>TrainingStartTime</code>, <code>TrainingTimeInSeconds</code>,
|
|
@@ -11,9 +11,9 @@ export interface DescribeWorkforceCommandOutput extends DescribeWorkforceRespons
|
|
|
11
11
|
* <p>Lists private workforce information, including workforce name, Amazon Resource Name
|
|
12
12
|
* (ARN), and, if applicable, allowed IP address ranges (<a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">CIDRs</a>). Allowable IP address
|
|
13
13
|
* ranges are the IP addresses that workers can use to access tasks. </p>
|
|
14
|
-
*
|
|
14
|
+
* <important>
|
|
15
15
|
* <p>This operation applies only to private workforces.</p>
|
|
16
|
-
*
|
|
16
|
+
* </important>
|
|
17
17
|
* @example
|
|
18
18
|
* Use a bare-bones client and the command you need to make an API call.
|
|
19
19
|
* ```javascript
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
2
|
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
3
|
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
-
import { ListCodeRepositoriesInput } from "../models/
|
|
5
|
-
import { ListCodeRepositoriesOutput } from "../models/models_3";
|
|
4
|
+
import { ListCodeRepositoriesInput, ListCodeRepositoriesOutput } from "../models/models_3";
|
|
6
5
|
import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";
|
|
7
6
|
export interface ListCodeRepositoriesCommandInput extends ListCodeRepositoriesInput {
|
|
8
7
|
}
|
|
@@ -9,7 +9,7 @@ export interface ListCompilationJobsCommandOutput extends ListCompilationJobsRes
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Lists model compilation jobs that satisfy various filters.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>To create a model compilation job, use <a>CreateCompilationJob</a>. To get
|
|
13
13
|
* information about a particular model compilation job you have created, use <a>DescribeCompilationJob</a>.</p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,7 +9,7 @@ export interface ListTrainingJobsCommandOutput extends ListTrainingJobsResponse,
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Lists training jobs.</p>
|
|
12
|
-
*
|
|
12
|
+
* <note>
|
|
13
13
|
* <p>When <code>StatusEquals</code> and <code>MaxResults</code> are set at the same
|
|
14
14
|
* time, the <code>MaxResults</code> number of training jobs are first retrieved
|
|
15
15
|
* ignoring the <code>StatusEquals</code> parameter and then they are filtered by the
|
|
@@ -29,7 +29,7 @@ export interface ListTrainingJobsCommandOutput extends ListTrainingJobsResponse,
|
|
|
29
29
|
* <code>aws sagemaker list-training-jobs --max-results 100 --status-equals
|
|
30
30
|
* InProgress</code>
|
|
31
31
|
* </p>
|
|
32
|
-
*
|
|
32
|
+
* </note>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
|
@@ -9,9 +9,9 @@ export interface StopCompilationJobCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Stops a model compilation job.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p> To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal. This gracefully shuts the
|
|
13
13
|
* job down. If the job hasn't stopped, it sends the SIGKILL signal.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>When it receives a <code>StopCompilationJob</code> request, Amazon SageMaker changes the <a>CompilationJobSummary$CompilationJobStatus</a> of the job to
|
|
15
15
|
* <code>Stopping</code>. After Amazon SageMaker stops the job, it sets the <a>CompilationJobSummary$CompilationJobStatus</a> to <code>Stopped</code>.
|
|
16
16
|
* </p>
|
|
17
17
|
* @example
|
|
@@ -10,7 +10,7 @@ export interface StopHyperParameterTuningJobCommandOutput extends __MetadataBear
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Stops a running hyperparameter tuning job and all running training jobs that the
|
|
12
12
|
* tuning job launched.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>All model artifacts output from the training jobs are stored in Amazon Simple Storage Service (Amazon S3). All
|
|
14
14
|
* data that the training jobs write to Amazon CloudWatch Logs are still available in CloudWatch. After the
|
|
15
15
|
* tuning job moves to the <code>Stopped</code> state, it releases all
|
|
16
16
|
* reserved
|
|
@@ -12,7 +12,7 @@ export interface StopNotebookInstanceCommandOutput extends __MetadataBearer {
|
|
|
12
12
|
* disconnects the ML storage volume from it. SageMaker preserves the ML storage volume. SageMaker
|
|
13
13
|
* stops charging you for the ML compute instance when you call
|
|
14
14
|
* <code>StopNotebookInstance</code>.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>To access data on the ML storage volume for a notebook instance that has been
|
|
16
16
|
* terminated, call the <code>StartNotebookInstance</code> API.
|
|
17
17
|
* <code>StartNotebookInstance</code> launches another ML compute instance, configures
|
|
18
18
|
* it, and attaches the preserved ML storage volume so you can continue your work.
|
|
@@ -9,7 +9,6 @@ export interface StopPipelineExecutionCommandOutput extends StopPipelineExecutio
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Stops a pipeline execution.</p>
|
|
12
|
-
*
|
|
13
12
|
* <p>
|
|
14
13
|
* <b>Callback Step</b>
|
|
15
14
|
* </p>
|
|
@@ -23,7 +22,6 @@ export interface StopPipelineExecutionCommandOutput extends StopPipelineExecutio
|
|
|
23
22
|
* <code>SendPipelineExecutionStepSuccess</code> or
|
|
24
23
|
* <code>SendPipelineExecutionStepFailure</code>.</p>
|
|
25
24
|
* <p>Only when SageMaker Pipelines receives one of these calls will it stop the pipeline execution.</p>
|
|
26
|
-
*
|
|
27
25
|
* <p>
|
|
28
26
|
* <b>Lambda Step</b>
|
|
29
27
|
* </p>
|
|
@@ -12,7 +12,7 @@ export interface StopTrainingJobCommandOutput extends __MetadataBearer {
|
|
|
12
12
|
* <code>SIGTERM</code> signal, which delays job termination for 120 seconds.
|
|
13
13
|
* Algorithms might use this 120-second window to save the model artifacts, so the results
|
|
14
14
|
* of the training is not lost. </p>
|
|
15
|
-
*
|
|
15
|
+
* <p>When it receives a <code>StopTrainingJob</code> request, SageMaker changes the status of
|
|
16
16
|
* the job to <code>Stopping</code>. After SageMaker stops the job, it sets the status to
|
|
17
17
|
* <code>Stopped</code>.</p>
|
|
18
18
|
* @example
|
|
@@ -9,7 +9,7 @@ export interface StopTransformJobCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Stops a batch transform job.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>When Amazon SageMaker receives a <code>StopTransformJob</code> request, the status of the job
|
|
13
13
|
* changes to <code>Stopping</code>. After Amazon SageMaker
|
|
14
14
|
* stops
|
|
15
15
|
* the job, the status is set to <code>Stopped</code>. When you stop a batch transform job before
|
|
@@ -11,12 +11,12 @@ export interface UpdateEndpointCommandOutput extends UpdateEndpointOutput, __Met
|
|
|
11
11
|
* <p>Deploys the new <code>EndpointConfig</code> specified in the request, switches to
|
|
12
12
|
* using newly created endpoint, and then deletes resources provisioned for the endpoint
|
|
13
13
|
* using the previous <code>EndpointConfig</code> (there is no availability loss). </p>
|
|
14
|
-
*
|
|
14
|
+
* <p>When SageMaker receives the request, it sets the endpoint status to
|
|
15
15
|
* <code>Updating</code>. After updating the endpoint, it sets the status to
|
|
16
16
|
* <code>InService</code>. To check the status of an endpoint, use the <a>DescribeEndpoint</a> API.
|
|
17
17
|
*
|
|
18
18
|
* </p>
|
|
19
|
-
*
|
|
19
|
+
* <note>
|
|
20
20
|
* <p>You must not delete an <code>EndpointConfig</code> in use by an endpoint that is
|
|
21
21
|
* live or while the <code>UpdateEndpoint</code> or <code>CreateEndpoint</code>
|
|
22
22
|
* operations are being performed on the endpoint. To update an endpoint, you must
|
|
@@ -24,7 +24,7 @@ export interface UpdateEndpointCommandOutput extends UpdateEndpointOutput, __Met
|
|
|
24
24
|
* <p>If you delete the <code>EndpointConfig</code> of an endpoint that is active or
|
|
25
25
|
* being created or updated you may lose visibility into the instance type the endpoint
|
|
26
26
|
* is using. The endpoint must be deleted in order to stop incurring charges.</p>
|
|
27
|
-
*
|
|
27
|
+
* </note>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
30
|
* ```javascript
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
2
|
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
3
|
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
-
import { UpdateImageRequest
|
|
4
|
+
import { UpdateImageRequest } from "../models/models_3";
|
|
5
|
+
import { UpdateImageResponse } from "../models/models_4";
|
|
5
6
|
import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";
|
|
6
7
|
export interface UpdateImageCommandInput extends UpdateImageRequest {
|
|
7
8
|
}
|
|
@@ -10,12 +10,12 @@ export interface UpdateProjectCommandOutput extends UpdateProjectOutput, __Metad
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Updates a machine learning (ML) project that is created from a template that
|
|
12
12
|
* sets up an ML pipeline from training to deploying an approved model.</p>
|
|
13
|
-
*
|
|
13
|
+
* <note>
|
|
14
14
|
* <p>You must not update a project that is in use. If you update the
|
|
15
15
|
* <code>ServiceCatalogProvisioningUpdateDetails</code> of a project that is active
|
|
16
16
|
* or being created, or updated, you may lose resources already created by the
|
|
17
17
|
* project.</p>
|
|
18
|
-
*
|
|
18
|
+
* </note>
|
|
19
19
|
* @example
|
|
20
20
|
* Use a bare-bones client and the command you need to make an API call.
|
|
21
21
|
* ```javascript
|
|
@@ -11,31 +11,29 @@ export interface UpdateWorkforceCommandOutput extends UpdateWorkforceResponse, _
|
|
|
11
11
|
* <p>Use this operation to update your workforce. You can use this operation to
|
|
12
12
|
* require that workers use specific IP addresses to work on tasks
|
|
13
13
|
* and to update your OpenID Connect (OIDC) Identity Provider (IdP) workforce configuration.</p>
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
* <p> Use <code>SourceIpConfig</code> to restrict worker access to tasks to a specific range of IP addresses.
|
|
14
|
+
* <p>The worker portal is now supported in VPC and public internet.</p>
|
|
15
|
+
* <p> Use <code>SourceIpConfig</code> to restrict worker access to tasks to a specific range of IP addresses.
|
|
18
16
|
* You specify allowed IP addresses by creating a list of up to ten <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">CIDRs</a>.
|
|
19
17
|
* By default, a workforce isn't restricted to specific IP addresses. If you specify a
|
|
20
18
|
* range of IP addresses, workers who attempt to access tasks using any IP address outside
|
|
21
19
|
* the specified range are denied and get a <code>Not Found</code> error message on
|
|
22
20
|
* the worker portal.</p>
|
|
23
21
|
* <p>To restrict access to all the workers in public internet, add the <code>SourceIpConfig</code> CIDR value as "0.0.0.0/0".</p>
|
|
24
|
-
*
|
|
22
|
+
* <important>
|
|
25
23
|
* <p>Amazon SageMaker does not support Source Ip restriction for worker portals in VPC.</p>
|
|
26
|
-
*
|
|
27
|
-
*
|
|
24
|
+
* </important>
|
|
25
|
+
* <p>Use <code>OidcConfig</code> to update the configuration of a workforce created using
|
|
28
26
|
* your own OIDC IdP. </p>
|
|
29
|
-
*
|
|
27
|
+
* <important>
|
|
30
28
|
* <p>You can only update your OIDC IdP configuration when there are no work teams
|
|
31
29
|
* associated with your workforce. You can delete work teams using the operation.</p>
|
|
32
|
-
*
|
|
33
|
-
*
|
|
30
|
+
* </important>
|
|
31
|
+
* <p>After restricting access to a range of IP addresses or updating your OIDC IdP configuration with this operation, you
|
|
34
32
|
* can view details about your update workforce using the
|
|
35
33
|
* operation.</p>
|
|
36
|
-
*
|
|
34
|
+
* <important>
|
|
37
35
|
* <p>This operation only applies to private workforces.</p>
|
|
38
|
-
*
|
|
36
|
+
* </important>
|
|
39
37
|
* @example
|
|
40
38
|
* Use a bare-bones client and the command you need to make an API call.
|
|
41
39
|
* ```javascript
|