@aws-sdk/client-sagemaker 3.316.0 → 3.319.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-types/commands/AddTagsCommand.d.ts +2 -2
- package/dist-types/commands/AssociateTrialComponentCommand.d.ts +1 -1
- package/dist-types/commands/CreateCompilationJobCommand.d.ts +3 -3
- package/dist-types/commands/CreateDomainCommand.d.ts +4 -0
- package/dist-types/commands/CreateEdgePackagingJobCommand.d.ts +1 -1
- package/dist-types/commands/CreateEndpointCommand.d.ts +5 -5
- package/dist-types/commands/CreateEndpointConfigCommand.d.ts +3 -3
- package/dist-types/commands/CreateExperimentCommand.d.ts +5 -6
- package/dist-types/commands/CreatePresignedNotebookInstanceUrlCommand.d.ts +1 -1
- package/dist-types/commands/CreateTrialCommand.d.ts +4 -4
- package/dist-types/commands/CreateTrialComponentCommand.d.ts +1 -1
- package/dist-types/commands/CreateUserProfileCommand.d.ts +4 -0
- package/dist-types/commands/CreateWorkforceCommand.d.ts +1 -1
- package/dist-types/commands/DeleteExperimentCommand.d.ts +1 -1
- package/dist-types/commands/DeleteHumanTaskUiCommand.d.ts +1 -1
- package/dist-types/commands/DeleteTagsCommand.d.ts +1 -2
- package/dist-types/commands/DeleteTrialCommand.d.ts +1 -1
- package/dist-types/commands/DeleteTrialComponentCommand.d.ts +1 -1
- package/dist-types/commands/DeleteWorkforceCommand.d.ts +2 -2
- package/dist-types/commands/DescribeCompilationJobCommand.d.ts +2 -2
- package/dist-types/commands/DisassociateTrialComponentCommand.d.ts +2 -2
- package/dist-types/commands/ListCompilationJobsCommand.d.ts +2 -2
- package/dist-types/commands/ListHyperParameterTuningJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListNotebookInstanceLifecycleConfigsCommand.d.ts +1 -1
- package/dist-types/commands/ListTrainingJobsForHyperParameterTuningJobCommand.d.ts +1 -1
- package/dist-types/commands/StopCompilationJobCommand.d.ts +2 -2
- package/dist-types/commands/UpdateActionCommand.d.ts +2 -1
- package/dist-types/commands/UpdateDomainCommand.d.ts +4 -0
- package/dist-types/commands/UpdateEndpointCommand.d.ts +1 -1
- package/dist-types/commands/UpdateEndpointWeightsAndCapacitiesCommand.d.ts +1 -1
- package/dist-types/commands/UpdateImageCommand.d.ts +1 -1
- package/dist-types/commands/UpdateInferenceExperimentCommand.d.ts +1 -1
- package/dist-types/commands/UpdateNotebookInstanceLifecycleConfigCommand.d.ts +1 -1
- package/dist-types/commands/UpdateUserProfileCommand.d.ts +4 -0
- package/dist-types/commands/UpdateWorkforceCommand.d.ts +2 -2
- package/dist-types/models/models_0.d.ts +52 -65
- package/dist-types/models/models_1.d.ts +88 -58
- package/dist-types/models/models_2.d.ts +76 -100
- package/dist-types/models/models_3.d.ts +63 -40
- package/dist-types/models/models_4.d.ts +20 -9
- package/dist-types/ts3.4/commands/CreateEdgePackagingJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteTagsCommand.d.ts +1 -2
- package/dist-types/ts3.4/commands/UpdateActionCommand.d.ts +2 -1
- package/dist-types/ts3.4/models/models_0.d.ts +5 -10
- package/dist-types/ts3.4/models/models_1.d.ts +11 -4
- package/dist-types/ts3.4/models/models_2.d.ts +4 -8
- package/dist-types/ts3.4/models/models_3.d.ts +9 -4
- package/dist-types/ts3.4/models/models_4.d.ts +3 -0
- package/package.json +5 -5
|
@@ -32,7 +32,7 @@ export interface AddTagsCommandOutput extends AddTagsOutput, __MetadataBearer {
|
|
|
32
32
|
* before you called this API. To make sure that the tags associated with a
|
|
33
33
|
* hyperparameter tuning job are also added to all training jobs that the
|
|
34
34
|
* hyperparameter tuning job launches, add the tags when you first create the tuning
|
|
35
|
-
* job by specifying them in the <code>Tags</code> parameter of <a>CreateHyperParameterTuningJob</a>
|
|
35
|
+
* 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>
|
|
36
36
|
* </p>
|
|
37
37
|
* </note>
|
|
38
38
|
* <note>
|
|
@@ -42,7 +42,7 @@ export interface AddTagsCommandOutput extends AddTagsOutput, __MetadataBearer {
|
|
|
42
42
|
* this API. To make sure that the tags associated with a Domain or User Profile are
|
|
43
43
|
* also added to all Apps that the Domain or User Profile launches, add the tags when
|
|
44
44
|
* you first create the Domain or User Profile by specifying them in the
|
|
45
|
-
*
|
|
45
|
+
* <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>
|
|
46
46
|
* </note>
|
|
47
47
|
* @example
|
|
48
48
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -20,7 +20,7 @@ export interface AssociateTrialComponentCommandOutput extends AssociateTrialComp
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Associates a trial component with a trial. A trial component can be associated with
|
|
23
|
-
* multiple trials. To disassociate a trial component from a trial, call the <a>DisassociateTrialComponent</a> API.</p>
|
|
23
|
+
* 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>
|
|
24
24
|
* @example
|
|
25
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
26
26
|
* ```javascript
|
|
@@ -48,9 +48,9 @@ export interface CreateCompilationJobCommandOutput extends CreateCompilationJobR
|
|
|
48
48
|
* use and costs. The response body contains the
|
|
49
49
|
* <code>CompilationJobArn</code>
|
|
50
50
|
* for the compiled job.</p>
|
|
51
|
-
* <p>To stop a model compilation job, use <a>StopCompilationJob</a>. To get
|
|
52
|
-
* information about a particular model compilation job, use <a>DescribeCompilationJob</a>. To get information about multiple model
|
|
53
|
-
* compilation jobs, use <a>ListCompilationJobs</a>.</p>
|
|
51
|
+
* <p>To stop a model compilation job, use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopCompilationJob.html">StopCompilationJob</a>. To get
|
|
52
|
+
* information about a particular model compilation job, use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeCompilationJob.html">DescribeCompilationJob</a>. To get information about multiple model
|
|
53
|
+
* compilation jobs, use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListCompilationJobs.html">ListCompilationJobs</a>.</p>
|
|
54
54
|
* @example
|
|
55
55
|
* Use a bare-bones client and the command you need to make an API call.
|
|
56
56
|
* ```javascript
|
|
@@ -149,6 +149,10 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad
|
|
|
149
149
|
* Status: "ENABLED" || "DISABLED",
|
|
150
150
|
* AmazonForecastRoleArn: "STRING_VALUE",
|
|
151
151
|
* },
|
|
152
|
+
* ModelRegisterSettings: { // ModelRegisterSettings
|
|
153
|
+
* Status: "ENABLED" || "DISABLED",
|
|
154
|
+
* CrossAccountModelRegisterRoleArn: "STRING_VALUE",
|
|
155
|
+
* },
|
|
152
156
|
* },
|
|
153
157
|
* },
|
|
154
158
|
* SubnetIds: [ // Subnets // required
|
|
@@ -1,7 +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 { CreateEdgePackagingJobRequest } from "../models/
|
|
4
|
+
import { CreateEdgePackagingJobRequest } from "../models/models_1";
|
|
5
5
|
import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";
|
|
6
6
|
/**
|
|
7
7
|
* @public
|
|
@@ -21,7 +21,7 @@ export interface CreateEndpointCommandOutput extends CreateEndpointOutput, __Met
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Creates an endpoint using the endpoint configuration specified in the request. SageMaker
|
|
23
23
|
* uses the endpoint to provision resources and deploy models. You create the endpoint
|
|
24
|
-
* configuration with the <a>CreateEndpointConfig</a> API. </p>
|
|
24
|
+
* configuration with the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html">CreateEndpointConfig</a> API. </p>
|
|
25
25
|
* <p> Use this API to deploy models using SageMaker hosting services. </p>
|
|
26
26
|
* <p>For an example that calls this method when deploying a model to SageMaker hosting services,
|
|
27
27
|
* see the <a href="https://github.com/aws/amazon-sagemaker-examples/blob/master/sagemaker-fundamentals/create-endpoint/create_endpoint.ipynb">Create Endpoint example notebook.</a>
|
|
@@ -37,7 +37,7 @@ export interface CreateEndpointCommandOutput extends CreateEndpointOutput, __Met
|
|
|
37
37
|
* <p>When it receives the request, SageMaker creates the endpoint, launches the resources (ML
|
|
38
38
|
* compute instances), and deploys the model(s) on them. </p>
|
|
39
39
|
* <note>
|
|
40
|
-
* <p>When you call <a>CreateEndpoint</a>, a load call is made to DynamoDB to
|
|
40
|
+
* <p>When you call <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html">CreateEndpoint</a>, a load call is made to DynamoDB to
|
|
41
41
|
* verify that your endpoint configuration exists. When you read data from a DynamoDB
|
|
42
42
|
* table supporting <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html">
|
|
43
43
|
* <code>Eventually Consistent Reads</code>
|
|
@@ -46,12 +46,12 @@ export interface CreateEndpointCommandOutput extends CreateEndpointOutput, __Met
|
|
|
46
46
|
* include some stale data. If the dependent entities are not yet in DynamoDB, this
|
|
47
47
|
* causes a validation error. If you repeat your read request after a short time, the
|
|
48
48
|
* response should return the latest data. So retry logic is recommended to handle
|
|
49
|
-
* these possible issues. We also recommend that customers call <a>DescribeEndpointConfig</a> before calling <a>CreateEndpoint</a> to minimize the potential impact of a DynamoDB eventually consistent read.</p>
|
|
49
|
+
* these possible issues. We also recommend that customers call <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpointConfig.html">DescribeEndpointConfig</a> before calling <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html">CreateEndpoint</a> to minimize the potential impact of a DynamoDB eventually consistent read.</p>
|
|
50
50
|
* </note>
|
|
51
51
|
* <p>When SageMaker receives the request, it sets the endpoint status to
|
|
52
52
|
* <code>Creating</code>. After it creates the endpoint, it sets the status to
|
|
53
53
|
* <code>InService</code>. SageMaker can then process incoming requests for inferences. To
|
|
54
|
-
* check the status of an endpoint, use the <a>DescribeEndpoint</a>
|
|
54
|
+
* check the status of an endpoint, use the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html">DescribeEndpoint</a>
|
|
55
55
|
* API.</p>
|
|
56
56
|
* <p>If any of the models hosted at this endpoint get model data from an Amazon S3 location,
|
|
57
57
|
* SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the
|
|
@@ -65,7 +65,7 @@ export interface CreateEndpointCommandOutput extends CreateEndpointOutput, __Met
|
|
|
65
65
|
* <note>
|
|
66
66
|
* <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
|
|
67
67
|
* Roles in the left navigation pane. Search the IAM role that you want to grant
|
|
68
|
-
* access to use the <a>CreateEndpoint</a> and <a>CreateEndpointConfig</a> API operations, add the following policies to
|
|
68
|
+
* access to use the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html">CreateEndpoint</a> and <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html">CreateEndpointConfig</a> API operations, add the following policies to
|
|
69
69
|
* the role. </p>
|
|
70
70
|
* <ul>
|
|
71
71
|
* <li>
|
|
@@ -22,7 +22,7 @@ export interface CreateEndpointConfigCommandOutput extends CreateEndpointConfigO
|
|
|
22
22
|
* <p>Creates an endpoint configuration that SageMaker hosting services uses to deploy models. In
|
|
23
23
|
* the configuration, you identify one or more models, created using the
|
|
24
24
|
* <code>CreateModel</code> API, to deploy and the resources that you want SageMaker to
|
|
25
|
-
* provision. Then you call the <a>CreateEndpoint</a> API.</p>
|
|
25
|
+
* provision. Then you call the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html">CreateEndpoint</a> API.</p>
|
|
26
26
|
* <note>
|
|
27
27
|
* <p> Use this API if you want to use SageMaker hosting services to deploy models into
|
|
28
28
|
* production. </p>
|
|
@@ -37,7 +37,7 @@ export interface CreateEndpointConfigCommandOutput extends CreateEndpointConfigO
|
|
|
37
37
|
* for model B. SageMaker distributes two-thirds of the traffic to Model A, and one-third to
|
|
38
38
|
* model B. </p>
|
|
39
39
|
* <note>
|
|
40
|
-
* <p>When you call <a>CreateEndpoint</a>, a load call is made to DynamoDB to
|
|
40
|
+
* <p>When you call <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html">CreateEndpoint</a>, a load call is made to DynamoDB to
|
|
41
41
|
* verify that your endpoint configuration exists. When you read data from a DynamoDB
|
|
42
42
|
* table supporting <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html">
|
|
43
43
|
* <code>Eventually Consistent Reads</code>
|
|
@@ -46,7 +46,7 @@ export interface CreateEndpointConfigCommandOutput extends CreateEndpointConfigO
|
|
|
46
46
|
* include some stale data. If the dependent entities are not yet in DynamoDB, this
|
|
47
47
|
* causes a validation error. If you repeat your read request after a short time, the
|
|
48
48
|
* response should return the latest data. So retry logic is recommended to handle
|
|
49
|
-
* these possible issues. We also recommend that customers call <a>DescribeEndpointConfig</a> before calling <a>CreateEndpoint</a> to minimize the potential impact of a DynamoDB eventually consistent read.</p>
|
|
49
|
+
* these possible issues. We also recommend that customers call <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpointConfig.html">DescribeEndpointConfig</a> before calling <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html">CreateEndpoint</a> to minimize the potential impact of a DynamoDB eventually consistent read.</p>
|
|
50
50
|
* </note>
|
|
51
51
|
* @example
|
|
52
52
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -33,13 +33,12 @@ export interface CreateExperimentCommandOutput extends CreateExperimentResponse,
|
|
|
33
33
|
* <p>When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial
|
|
34
34
|
* components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you
|
|
35
35
|
* must use the logging APIs provided by the SDK.</p>
|
|
36
|
-
* <p>You can add tags to experiments, trials, trial components and then use the <a>Search</a> API to search for the tags.</p>
|
|
36
|
+
* <p>You can add tags to experiments, trials, trial components and then use the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a> API to search for the tags.</p>
|
|
37
37
|
* <p>To add a description to an experiment, specify the optional <code>Description</code>
|
|
38
|
-
* parameter. To add a description later, or to change the description, call the <a>UpdateExperiment</a> API.</p>
|
|
39
|
-
* <p>To get a list of all your experiments, call the <a>ListExperiments</a> API. To
|
|
40
|
-
* view an experiment's properties, call the <a>DescribeExperiment</a> API. To get a
|
|
41
|
-
* list of all the trials associated with an experiment, call the <a>ListTrials</a>
|
|
42
|
-
* API. To create a trial call the <a>CreateTrial</a> API.</p>
|
|
38
|
+
* parameter. To add a description later, or to change the description, call the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateExperiment.html">UpdateExperiment</a> API.</p>
|
|
39
|
+
* <p>To get a list of all your experiments, call the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListExperiments.html">ListExperiments</a> API. To
|
|
40
|
+
* view an experiment's properties, call the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeExperiment.html">DescribeExperiment</a> API. To get a
|
|
41
|
+
* list of all the trials associated with an experiment, call the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListTrials.html">ListTrials</a> API. To create a trial call the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrial.html">CreateTrial</a> API.</p>
|
|
43
42
|
* @example
|
|
44
43
|
* Use a bare-bones client and the command you need to make an API call.
|
|
45
44
|
* ```javascript
|
|
@@ -33,7 +33,7 @@ export interface CreatePresignedNotebookInstanceUrlCommandOutput extends CreateP
|
|
|
33
33
|
* <code>aws:SourceIP</code> condition context key to specify the list of IP addresses
|
|
34
34
|
* that you want to have access to the notebook instance. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/security_iam_id-based-policy-examples.html#nbi-ip-filter">Limit Access to a Notebook Instance by IP Address</a>.</p>
|
|
35
35
|
* <note>
|
|
36
|
-
* <p>The URL that you get from a call to <a>CreatePresignedNotebookInstanceUrl</a> is valid only for 5 minutes. If
|
|
36
|
+
* <p>The URL that you get from a call to <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreatePresignedNotebookInstanceUrl.html">CreatePresignedNotebookInstanceUrl</a> is valid only for 5 minutes. If
|
|
37
37
|
* you try to use the URL after the 5-minute limit expires, you are directed to the
|
|
38
38
|
* Amazon Web Services console sign-in page.</p>
|
|
39
39
|
* </note>
|
|
@@ -25,11 +25,11 @@ export interface CreateTrialCommandOutput extends CreateTrialResponse, __Metadat
|
|
|
25
25
|
* <p>When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial
|
|
26
26
|
* components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you
|
|
27
27
|
* must use the logging APIs provided by the SDK.</p>
|
|
28
|
-
* <p>You can add tags to a trial and then use the <a>Search</a> API to search for
|
|
28
|
+
* <p>You can add tags to a trial and then use the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a> API to search for
|
|
29
29
|
* the tags.</p>
|
|
30
|
-
* <p>To get a list of all your trials, call the <a>ListTrials</a> API. To view a
|
|
31
|
-
* trial's properties, call the <a>DescribeTrial</a> API. To create a trial component,
|
|
32
|
-
* call the <a>CreateTrialComponent</a> API.</p>
|
|
30
|
+
* <p>To get a list of all your trials, call the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListTrials.html">ListTrials</a> API. To view a
|
|
31
|
+
* trial's properties, call the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrial.html">DescribeTrial</a> API. To create a trial component,
|
|
32
|
+
* call the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrialComponent.html">CreateTrialComponent</a> API.</p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ export interface CreateTrialComponentCommandOutput extends CreateTrialComponentR
|
|
|
27
27
|
* <p>When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial
|
|
28
28
|
* components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you
|
|
29
29
|
* must use the logging APIs provided by the SDK.</p>
|
|
30
|
-
* <p>You can add tags to a trial component and then use the <a>Search</a> API to
|
|
30
|
+
* <p>You can add tags to a trial component and then use the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a> API to
|
|
31
31
|
* search for the tags.</p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -119,6 +119,10 @@ export interface CreateUserProfileCommandOutput extends CreateUserProfileRespons
|
|
|
119
119
|
* Status: "ENABLED" || "DISABLED",
|
|
120
120
|
* AmazonForecastRoleArn: "STRING_VALUE",
|
|
121
121
|
* },
|
|
122
|
+
* ModelRegisterSettings: { // ModelRegisterSettings
|
|
123
|
+
* Status: "ENABLED" || "DISABLED",
|
|
124
|
+
* CrossAccountModelRegisterRoleArn: "STRING_VALUE",
|
|
125
|
+
* },
|
|
122
126
|
* },
|
|
123
127
|
* },
|
|
124
128
|
* };
|
|
@@ -23,7 +23,7 @@ export interface CreateWorkforceCommandOutput extends CreateWorkforceResponse, _
|
|
|
23
23
|
* if a workforce already exists in the Amazon Web Services Region that you specify. You can only
|
|
24
24
|
* create one workforce in each Amazon Web Services Region per Amazon Web Services account.</p>
|
|
25
25
|
* <p>If you want to create a new workforce in an Amazon Web Services Region where
|
|
26
|
-
*
|
|
26
|
+
* a workforce already exists, use the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteWorkforce.html">DeleteWorkforce</a> API
|
|
27
27
|
* operation to delete the existing workforce and then use <code>CreateWorkforce</code>
|
|
28
28
|
* to create a new workforce.</p>
|
|
29
29
|
* <p>To create a private workforce using Amazon Cognito, you must specify a Cognito user pool
|
|
@@ -20,7 +20,7 @@ export interface DeleteExperimentCommandOutput extends DeleteExperimentResponse,
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Deletes an SageMaker experiment. All trials associated with the experiment must be deleted
|
|
23
|
-
* first. Use the <a>ListTrials</a> API to get a list of the trials associated with
|
|
23
|
+
* first. Use the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListTrials.html">ListTrials</a> API to get a list of the trials associated with
|
|
24
24
|
* the experiment.</p>
|
|
25
25
|
* @example
|
|
26
26
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -22,7 +22,7 @@ export interface DeleteHumanTaskUiCommandOutput extends DeleteHumanTaskUiRespons
|
|
|
22
22
|
* <p>Use this operation to delete a human task user interface (worker task template).</p>
|
|
23
23
|
* <p>
|
|
24
24
|
* To see a list of human task user interfaces
|
|
25
|
-
* (work task templates) in your account, use .
|
|
25
|
+
* (work task templates) in your account, use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListHumanTaskUis.html">ListHumanTaskUis</a>.
|
|
26
26
|
* When you delete a worker task template, it no longer appears when you call <code>ListHumanTaskUis</code>.</p>
|
|
27
27
|
* @example
|
|
28
28
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -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 { DeleteTagsInput } from "../models/
|
|
5
|
-
import { DeleteTagsOutput } from "../models/models_2";
|
|
4
|
+
import { DeleteTagsInput, DeleteTagsOutput } from "../models/models_2";
|
|
6
5
|
import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";
|
|
7
6
|
/**
|
|
8
7
|
* @public
|
|
@@ -20,7 +20,7 @@ export interface DeleteTrialCommandOutput extends DeleteTrialResponse, __Metadat
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Deletes the specified trial. All trial components that make up the trial must be deleted
|
|
23
|
-
* first. Use the <a>DescribeTrialComponent</a> API to get the list of trial
|
|
23
|
+
* first. Use the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrialComponent.html">DescribeTrialComponent</a> API to get the list of trial
|
|
24
24
|
* components.</p>
|
|
25
25
|
* @example
|
|
26
26
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -21,7 +21,7 @@ export interface DeleteTrialComponentCommandOutput extends DeleteTrialComponentR
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Deletes the specified trial component. A trial component must be disassociated from all
|
|
23
23
|
* trials before the trial component can be deleted. To disassociate a trial component from a
|
|
24
|
-
* trial, call the <a>DisassociateTrialComponent</a> API.</p>
|
|
24
|
+
* trial, call the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DisassociateTrialComponent.html">DisassociateTrialComponent</a> API.</p>
|
|
25
25
|
* @example
|
|
26
26
|
* Use a bare-bones client and the command you need to make an API call.
|
|
27
27
|
* ```javascript
|
|
@@ -22,11 +22,11 @@ export interface DeleteWorkforceCommandOutput extends DeleteWorkforceResponse, _
|
|
|
22
22
|
* <p>Use this operation to delete a workforce.</p>
|
|
23
23
|
* <p>If you want to create a new workforce in an Amazon Web Services Region where
|
|
24
24
|
* a workforce already exists, use this operation to delete the
|
|
25
|
-
* existing workforce and then use
|
|
25
|
+
* existing workforce and then use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateWorkforce.html">CreateWorkforce</a>
|
|
26
26
|
* to create a new workforce.</p>
|
|
27
27
|
* <important>
|
|
28
28
|
* <p>If a private workforce contains one or more work teams, you must use
|
|
29
|
-
*
|
|
29
|
+
* the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteWorkteam.html">DeleteWorkteam</a>
|
|
30
30
|
* operation to delete all work teams before you delete the workforce.
|
|
31
31
|
* If you try to delete a workforce that contains one or more work teams,
|
|
32
32
|
* you will recieve a <code>ResourceInUse</code> error.</p>
|
|
@@ -20,8 +20,8 @@ export interface DescribeCompilationJobCommandOutput extends DescribeCompilation
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Returns information about a model compilation job.</p>
|
|
23
|
-
* <p>To create a model compilation job, use <a>CreateCompilationJob</a>. To get
|
|
24
|
-
* information about multiple model compilation jobs, use <a>ListCompilationJobs</a>.</p>
|
|
23
|
+
* <p>To create a model compilation job, use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateCompilationJob.html">CreateCompilationJob</a>. To get
|
|
24
|
+
* information about multiple model compilation jobs, use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListCompilationJobs.html">ListCompilationJobs</a>.</p>
|
|
25
25
|
* @example
|
|
26
26
|
* Use a bare-bones client and the command you need to make an API call.
|
|
27
27
|
* ```javascript
|
|
@@ -22,8 +22,8 @@ export interface DisassociateTrialComponentCommandOutput extends DisassociateTri
|
|
|
22
22
|
* <p>Disassociates a trial component from a trial. This doesn't effect other trials the
|
|
23
23
|
* component is associated with. Before you can delete a component, you must disassociate the
|
|
24
24
|
* component from all trials it is associated with. To associate a trial component with a trial,
|
|
25
|
-
* call the <a>AssociateTrialComponent</a> API.</p>
|
|
26
|
-
* <p>To get a list of the trials a component is associated with, use the <a>Search</a> API. Specify <code>ExperimentTrialComponent</code> for the <code>Resource</code> parameter.
|
|
25
|
+
* call the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AssociateTrialComponent.html">AssociateTrialComponent</a> API.</p>
|
|
26
|
+
* <p>To get a list of the trials a component is associated with, use the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a> API. Specify <code>ExperimentTrialComponent</code> for the <code>Resource</code> parameter.
|
|
27
27
|
* The list appears in the response under <code>Results.TrialComponent.Parents</code>.</p>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -20,8 +20,8 @@ export interface ListCompilationJobsCommandOutput extends ListCompilationJobsRes
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Lists model compilation jobs that satisfy various filters.</p>
|
|
23
|
-
* <p>To create a model compilation job, use <a>CreateCompilationJob</a>. To get
|
|
24
|
-
* information about a particular model compilation job you have created, use <a>DescribeCompilationJob</a>.</p>
|
|
23
|
+
* <p>To create a model compilation job, use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateCompilationJob.html">CreateCompilationJob</a>. To get
|
|
24
|
+
* information about a particular model compilation job you have created, use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeCompilationJob.html">DescribeCompilationJob</a>.</p>
|
|
25
25
|
* @example
|
|
26
26
|
* Use a bare-bones client and the command you need to make an API call.
|
|
27
27
|
* ```javascript
|
|
@@ -19,7 +19,7 @@ export interface ListHyperParameterTuningJobsCommandOutput extends ListHyperPara
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Gets a list of <a>HyperParameterTuningJobSummary</a> objects that
|
|
22
|
+
* <p>Gets a list of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobSummary.html">HyperParameterTuningJobSummary</a> objects that
|
|
23
23
|
* describe
|
|
24
24
|
* the hyperparameter tuning jobs launched in your account.</p>
|
|
25
25
|
* @example
|
|
@@ -19,7 +19,7 @@ export interface ListNotebookInstanceLifecycleConfigsCommandOutput extends ListN
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Lists notebook instance lifestyle configurations created with the <a>CreateNotebookInstanceLifecycleConfig</a> API.</p>
|
|
22
|
+
* <p>Lists notebook instance lifestyle configurations created with the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateNotebookInstanceLifecycleConfig.html">CreateNotebookInstanceLifecycleConfig</a> API.</p>
|
|
23
23
|
* @example
|
|
24
24
|
* Use a bare-bones client and the command you need to make an API call.
|
|
25
25
|
* ```javascript
|
|
@@ -19,7 +19,7 @@ export interface ListTrainingJobsForHyperParameterTuningJobCommandOutput extends
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Gets a list of <a>TrainingJobSummary</a> objects that describe the training
|
|
22
|
+
* <p>Gets a list of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html">TrainingJobSummary</a> objects that describe the training
|
|
23
23
|
* jobs that a hyperparameter tuning job launched.</p>
|
|
24
24
|
* @example
|
|
25
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -22,8 +22,8 @@ export interface StopCompilationJobCommandOutput extends __MetadataBearer {
|
|
|
22
22
|
* <p>Stops a model compilation job.</p>
|
|
23
23
|
* <p> To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal. This gracefully shuts the
|
|
24
24
|
* job down. If the job hasn't stopped, it sends the SIGKILL signal.</p>
|
|
25
|
-
* <p>When it receives a <code>StopCompilationJob</code> request, Amazon SageMaker changes the <
|
|
26
|
-
* <code>Stopping</code>. After Amazon SageMaker stops the job, it sets the <
|
|
25
|
+
* <p>When it receives a <code>StopCompilationJob</code> request, Amazon SageMaker changes the <code>CompilationJobStatus</code> of the job to
|
|
26
|
+
* <code>Stopping</code>. After Amazon SageMaker stops the job, it sets the <code>CompilationJobStatus</code> to <code>Stopped</code>.
|
|
27
27
|
* </p>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -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 { UpdateActionRequest
|
|
4
|
+
import { UpdateActionRequest } from "../models/models_3";
|
|
5
|
+
import { UpdateActionResponse } from "../models/models_4";
|
|
5
6
|
import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";
|
|
6
7
|
/**
|
|
7
8
|
* @public
|
|
@@ -104,6 +104,10 @@ export interface UpdateDomainCommandOutput extends UpdateDomainResponse, __Metad
|
|
|
104
104
|
* Status: "ENABLED" || "DISABLED",
|
|
105
105
|
* AmazonForecastRoleArn: "STRING_VALUE",
|
|
106
106
|
* },
|
|
107
|
+
* ModelRegisterSettings: { // ModelRegisterSettings
|
|
108
|
+
* Status: "ENABLED" || "DISABLED",
|
|
109
|
+
* CrossAccountModelRegisterRoleArn: "STRING_VALUE",
|
|
110
|
+
* },
|
|
107
111
|
* },
|
|
108
112
|
* },
|
|
109
113
|
* DomainSettingsForUpdate: { // DomainSettingsForUpdate
|
|
@@ -24,7 +24,7 @@ export interface UpdateEndpointCommandOutput extends UpdateEndpointOutput, __Met
|
|
|
24
24
|
* using the previous <code>EndpointConfig</code> (there is no availability loss). </p>
|
|
25
25
|
* <p>When SageMaker receives the request, it sets the endpoint status to
|
|
26
26
|
* <code>Updating</code>. After updating the endpoint, it sets the status to
|
|
27
|
-
*
|
|
27
|
+
* <code>InService</code>. To check the status of an endpoint, use the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html">DescribeEndpoint</a> API.
|
|
28
28
|
*
|
|
29
29
|
* </p>
|
|
30
30
|
* <note>
|
|
@@ -23,7 +23,7 @@ export interface UpdateEndpointWeightsAndCapacitiesCommandOutput extends UpdateE
|
|
|
23
23
|
* endpoint, or capacity of one variant associated with an existing endpoint. When it
|
|
24
24
|
* receives the request, SageMaker sets the endpoint status to <code>Updating</code>. After
|
|
25
25
|
* updating the endpoint, it sets the status to <code>InService</code>. To check the status
|
|
26
|
-
* of an endpoint, use the <a>DescribeEndpoint</a> API. </p>
|
|
26
|
+
* of an endpoint, use the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html">DescribeEndpoint</a> API. </p>
|
|
27
27
|
* @example
|
|
28
28
|
* Use a bare-bones client and the command you need to make an API call.
|
|
29
29
|
* ```javascript
|
|
@@ -20,7 +20,7 @@ export interface UpdateImageCommandOutput extends UpdateImageResponse, __Metadat
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Updates the properties of a SageMaker image. To change the image's tags, use the
|
|
23
|
-
*
|
|
23
|
+
* <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html">AddTags</a> and <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteTags.html">DeleteTags</a> APIs.</p>
|
|
24
24
|
* @example
|
|
25
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
26
26
|
* ```javascript
|
|
@@ -22,7 +22,7 @@ export interface UpdateInferenceExperimentCommandOutput extends UpdateInferenceE
|
|
|
22
22
|
* <p>
|
|
23
23
|
* Updates an inference experiment that you created. The status of the inference experiment has to be either
|
|
24
24
|
* <code>Created</code>, <code>Running</code>. For more information on the status of an inference experiment,
|
|
25
|
-
* see <a>
|
|
25
|
+
* see <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeInferenceExperiment.html">DescribeInferenceExperiment</a>.
|
|
26
26
|
* </p>
|
|
27
27
|
* @example
|
|
28
28
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -19,7 +19,7 @@ export interface UpdateNotebookInstanceLifecycleConfigCommandOutput extends Upda
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Updates a notebook instance lifecycle configuration created with the <a>CreateNotebookInstanceLifecycleConfig</a> API.</p>
|
|
22
|
+
* <p>Updates a notebook instance lifecycle configuration created with the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateNotebookInstanceLifecycleConfig.html">CreateNotebookInstanceLifecycleConfig</a> API.</p>
|
|
23
23
|
* @example
|
|
24
24
|
* Use a bare-bones client and the command you need to make an API call.
|
|
25
25
|
* ```javascript
|
|
@@ -105,6 +105,10 @@ export interface UpdateUserProfileCommandOutput extends UpdateUserProfileRespons
|
|
|
105
105
|
* Status: "ENABLED" || "DISABLED",
|
|
106
106
|
* AmazonForecastRoleArn: "STRING_VALUE",
|
|
107
107
|
* },
|
|
108
|
+
* ModelRegisterSettings: { // ModelRegisterSettings
|
|
109
|
+
* Status: "ENABLED" || "DISABLED",
|
|
110
|
+
* CrossAccountModelRegisterRoleArn: "STRING_VALUE",
|
|
111
|
+
* },
|
|
108
112
|
* },
|
|
109
113
|
* },
|
|
110
114
|
* };
|
|
@@ -37,10 +37,10 @@ export interface UpdateWorkforceCommandOutput extends UpdateWorkforceResponse, _
|
|
|
37
37
|
* your own OIDC IdP. </p>
|
|
38
38
|
* <important>
|
|
39
39
|
* <p>You can only update your OIDC IdP configuration when there are no work teams
|
|
40
|
-
* associated with your workforce. You can delete work teams using the
|
|
40
|
+
* associated with your workforce. You can delete work teams using the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteWorkteam.html">DeleteWorkteam</a> operation.</p>
|
|
41
41
|
* </important>
|
|
42
42
|
* <p>After restricting access to a range of IP addresses or updating your OIDC IdP configuration with this operation, you
|
|
43
|
-
*
|
|
43
|
+
* can view details about your update workforce using the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeWorkforce.html">DescribeWorkforce</a>
|
|
44
44
|
* operation.</p>
|
|
45
45
|
* <important>
|
|
46
46
|
* <p>This operation only applies to private workforces.</p>
|