@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
|
@@ -422,16 +422,16 @@ export interface SageMakerClientResolvedConfig extends SageMakerClientResolvedCo
|
|
|
422
422
|
}
|
|
423
423
|
/**
|
|
424
424
|
* <p>Provides APIs for creating and managing SageMaker resources. </p>
|
|
425
|
-
*
|
|
426
|
-
*
|
|
425
|
+
* <p>Other Resources:</p>
|
|
426
|
+
* <ul>
|
|
427
427
|
* <li>
|
|
428
|
-
*
|
|
428
|
+
* <p>
|
|
429
429
|
* <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/whatis.html#first-time-user">SageMaker Developer
|
|
430
430
|
* Guide</a>
|
|
431
431
|
* </p>
|
|
432
432
|
* </li>
|
|
433
433
|
* <li>
|
|
434
|
-
*
|
|
434
|
+
* <p>
|
|
435
435
|
* <a href="https://docs.aws.amazon.com/augmented-ai/2019-11-07/APIReference/Welcome.html">Amazon Augmented AI
|
|
436
436
|
* Runtime API Reference</a>
|
|
437
437
|
* </p>
|
|
@@ -12,9 +12,9 @@ export interface AddTagsCommandOutput extends AddTagsOutput, __MetadataBearer {
|
|
|
12
12
|
* tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform
|
|
13
13
|
* jobs, models, labeling jobs, work teams, endpoint configurations, and
|
|
14
14
|
* endpoints.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>Each tag consists of a key and an optional value. Tag keys must be unique per
|
|
16
16
|
* 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>
|
|
17
|
-
*
|
|
17
|
+
* <note>
|
|
18
18
|
* <p>Tags that you add to a hyperparameter tuning job by calling this API are also
|
|
19
19
|
* added to any training jobs that the hyperparameter tuning job launches after you
|
|
20
20
|
* call this API, but not to training jobs that the hyperparameter tuning job launched
|
|
@@ -23,8 +23,8 @@ export interface AddTagsCommandOutput extends AddTagsOutput, __MetadataBearer {
|
|
|
23
23
|
* hyperparameter tuning job launches, add the tags when you first create the tuning
|
|
24
24
|
* job by specifying them in the <code>Tags</code> parameter of <a>CreateHyperParameterTuningJob</a>
|
|
25
25
|
* </p>
|
|
26
|
-
*
|
|
27
|
-
*
|
|
26
|
+
* </note>
|
|
27
|
+
* <note>
|
|
28
28
|
* <p>Tags that you add to a SageMaker Studio Domain or User Profile by calling this API
|
|
29
29
|
* are also added to any Apps that the Domain or User Profile launches after you call
|
|
30
30
|
* this API, but not to Apps that the Domain or User Profile launched before you called
|
|
@@ -32,7 +32,7 @@ export interface AddTagsCommandOutput extends AddTagsOutput, __MetadataBearer {
|
|
|
32
32
|
* also added to all Apps that the Domain or User Profile launches, add the tags when
|
|
33
33
|
* you first create the Domain or User Profile by specifying them in the
|
|
34
34
|
* <code>Tags</code> parameter of <a>CreateDomain</a> or <a>CreateUserProfile</a>.</p>
|
|
35
|
-
*
|
|
35
|
+
* </note>
|
|
36
36
|
* @example
|
|
37
37
|
* Use a bare-bones client and the command you need to make an API call.
|
|
38
38
|
* ```javascript
|
|
@@ -13,7 +13,7 @@ export interface CreateCodeRepositoryCommandOutput extends CreateCodeRepositoryO
|
|
|
13
13
|
* notebooks you create. The Git repository is a resource in your SageMaker account, so it can
|
|
14
14
|
* be associated with more than one notebook instance, and it persists independently from
|
|
15
15
|
* the lifecycle of any notebook instances it is associated with.</p>
|
|
16
|
-
*
|
|
16
|
+
* <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>
|
|
17
17
|
* or in any other Git repository.</p>
|
|
18
18
|
* @example
|
|
19
19
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -10,34 +10,34 @@ export interface CreateCompilationJobCommandOutput extends CreateCompilationJobR
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Starts a model compilation job. After the model has been compiled, Amazon SageMaker saves the
|
|
12
12
|
* resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify. </p>
|
|
13
|
-
*
|
|
13
|
+
* <p>If
|
|
14
14
|
* you choose to host your model using Amazon SageMaker hosting services, you can use the resulting
|
|
15
15
|
* model artifacts as part of the model. You can also use the artifacts with
|
|
16
16
|
* Amazon Web Services
|
|
17
17
|
* IoT Greengrass. In that case, deploy them as an ML
|
|
18
18
|
* resource.</p>
|
|
19
|
-
*
|
|
20
|
-
*
|
|
19
|
+
* <p>In the request body, you provide the following:</p>
|
|
20
|
+
* <ul>
|
|
21
21
|
* <li>
|
|
22
|
-
*
|
|
22
|
+
* <p>A name for the compilation job</p>
|
|
23
23
|
* </li>
|
|
24
24
|
* <li>
|
|
25
|
-
*
|
|
25
|
+
* <p> Information about the input model artifacts </p>
|
|
26
26
|
* </li>
|
|
27
27
|
* <li>
|
|
28
|
-
*
|
|
28
|
+
* <p>The output location for the compiled model and the device (target) that the
|
|
29
29
|
* model runs on </p>
|
|
30
30
|
* </li>
|
|
31
31
|
* <li>
|
|
32
|
-
*
|
|
32
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform
|
|
33
33
|
* the model compilation job. </p>
|
|
34
34
|
* </li>
|
|
35
35
|
* </ul>
|
|
36
|
-
*
|
|
36
|
+
* <p>You can also provide a <code>Tag</code> to track the model compilation job's resource
|
|
37
37
|
* use and costs. The response body contains the
|
|
38
38
|
* <code>CompilationJobArn</code>
|
|
39
39
|
* for the compiled job.</p>
|
|
40
|
-
*
|
|
40
|
+
* <p>To stop a model compilation job, use <a>StopCompilationJob</a>. To get
|
|
41
41
|
* information about a particular model compilation job, use <a>DescribeCompilationJob</a>. To get information about multiple model
|
|
42
42
|
* compilation jobs, use <a>ListCompilationJobs</a>.</p>
|
|
43
43
|
* @example
|
|
@@ -12,7 +12,6 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad
|
|
|
12
12
|
* Amazon Elastic File System (EFS) volume, a list of authorized users, and a variety of security, application,
|
|
13
13
|
* policy, and Amazon Virtual Private Cloud (VPC) configurations. An Amazon Web Services account is limited to one domain per region.
|
|
14
14
|
* Users within a domain can share notebook files and other artifacts with each other.</p>
|
|
15
|
-
*
|
|
16
15
|
* <p>
|
|
17
16
|
* <b>EFS storage</b>
|
|
18
17
|
* </p>
|
|
@@ -24,7 +23,6 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad
|
|
|
24
23
|
* customer managed key. For more information, see
|
|
25
24
|
* <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/encryption-at-rest.html">Protect Data at
|
|
26
25
|
* Rest Using Encryption</a>.</p>
|
|
27
|
-
*
|
|
28
26
|
* <p>
|
|
29
27
|
* <b>VPC configuration</b>
|
|
30
28
|
* </p>
|
|
@@ -11,22 +11,21 @@ export interface CreateEndpointCommandOutput extends CreateEndpointOutput, __Met
|
|
|
11
11
|
* <p>Creates an endpoint using the endpoint configuration specified in the request. SageMaker
|
|
12
12
|
* uses the endpoint to provision resources and deploy models. You create the endpoint
|
|
13
13
|
* configuration with the <a>CreateEndpointConfig</a> API. </p>
|
|
14
|
-
*
|
|
15
|
-
*
|
|
14
|
+
* <p> Use this API to deploy models using SageMaker hosting services. </p>
|
|
15
|
+
* <p>For an example that calls this method when deploying a model to SageMaker hosting services,
|
|
16
16
|
* 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>
|
|
17
17
|
* </p>
|
|
18
|
-
*
|
|
18
|
+
* <note>
|
|
19
19
|
* <p> You must not delete an <code>EndpointConfig</code> that is in use by an endpoint
|
|
20
20
|
* that is live or while the <code>UpdateEndpoint</code> or <code>CreateEndpoint</code>
|
|
21
21
|
* operations are being performed on the endpoint. To update an endpoint, you must
|
|
22
22
|
* create a new <code>EndpointConfig</code>.</p>
|
|
23
|
-
*
|
|
24
|
-
*
|
|
23
|
+
* </note>
|
|
24
|
+
* <p>The endpoint name must be unique within an Amazon Web Services Region in your
|
|
25
25
|
* Amazon Web Services account. </p>
|
|
26
|
-
*
|
|
26
|
+
* <p>When it receives the request, SageMaker creates the endpoint, launches the resources (ML
|
|
27
27
|
* compute instances), and deploys the model(s) on them. </p>
|
|
28
|
-
*
|
|
29
|
-
* <note>
|
|
28
|
+
* <note>
|
|
30
29
|
* <p>When you call <a>CreateEndpoint</a>, a load call is made to DynamoDB to
|
|
31
30
|
* verify that your endpoint configuration exists. When you read data from a DynamoDB
|
|
32
31
|
* table supporting <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html">
|
|
@@ -37,13 +36,13 @@ export interface CreateEndpointCommandOutput extends CreateEndpointOutput, __Met
|
|
|
37
36
|
* causes a validation error. If you repeat your read request after a short time, the
|
|
38
37
|
* response should return the latest data. So retry logic is recommended to handle
|
|
39
38
|
* 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>
|
|
40
|
-
*
|
|
41
|
-
*
|
|
39
|
+
* </note>
|
|
40
|
+
* <p>When SageMaker receives the request, it sets the endpoint status to
|
|
42
41
|
* <code>Creating</code>. After it creates the endpoint, it sets the status to
|
|
43
42
|
* <code>InService</code>. SageMaker can then process incoming requests for inferences. To
|
|
44
43
|
* check the status of an endpoint, use the <a>DescribeEndpoint</a>
|
|
45
44
|
* API.</p>
|
|
46
|
-
*
|
|
45
|
+
* <p>If any of the models hosted at this endpoint get model data from an Amazon S3 location,
|
|
47
46
|
* SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the
|
|
48
47
|
* S3 path you provided. Amazon Web Services STS is activated in your IAM user account by
|
|
49
48
|
* default. If you previously deactivated Amazon Web Services STS for a region, you need to
|
|
@@ -51,42 +50,41 @@ export interface CreateEndpointCommandOutput extends CreateEndpointOutput, __Met
|
|
|
51
50
|
* Deactivating Amazon Web Services STS in an Amazon Web Services Region</a> in the
|
|
52
51
|
* <i>Amazon Web Services Identity and Access Management User
|
|
53
52
|
* Guide</i>.</p>
|
|
54
|
-
*
|
|
53
|
+
* <note>
|
|
55
54
|
* <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
|
|
56
55
|
* Roles in the left navigation pane. Search the IAM role that you want to grant
|
|
57
56
|
* access to use the <a>CreateEndpoint</a> and <a>CreateEndpointConfig</a> API operations, add the following policies to
|
|
58
57
|
* the role. </p>
|
|
59
58
|
* <ul>
|
|
60
59
|
* <li>
|
|
61
|
-
*
|
|
60
|
+
* <p>Option 1: For a full SageMaker access, search and attach the
|
|
62
61
|
* <code>AmazonSageMakerFullAccess</code> policy.</p>
|
|
63
|
-
*
|
|
62
|
+
* </li>
|
|
64
63
|
* <li>
|
|
65
|
-
*
|
|
64
|
+
* <p>Option 2: For granting a limited access to an IAM role, paste the
|
|
66
65
|
* following Action elements manually into the JSON file of the IAM role: </p>
|
|
67
|
-
*
|
|
66
|
+
* <p>
|
|
68
67
|
* <code>"Action": ["sagemaker:CreateEndpoint",
|
|
69
68
|
* "sagemaker:CreateEndpointConfig"]</code>
|
|
70
69
|
* </p>
|
|
71
|
-
*
|
|
70
|
+
* <p>
|
|
72
71
|
* <code>"Resource": [</code>
|
|
73
72
|
* </p>
|
|
74
|
-
*
|
|
73
|
+
* <p>
|
|
75
74
|
* <code>"arn:aws:sagemaker:region:account-id:endpoint/endpointName"</code>
|
|
76
75
|
* </p>
|
|
77
|
-
*
|
|
76
|
+
* <p>
|
|
78
77
|
* <code>"arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName"</code>
|
|
79
78
|
* </p>
|
|
80
|
-
*
|
|
79
|
+
* <p>
|
|
81
80
|
* <code>]</code>
|
|
82
81
|
* </p>
|
|
83
|
-
*
|
|
82
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/api-permissions-reference.html">SageMaker API
|
|
84
83
|
* Permissions: Actions, Permissions, and Resources
|
|
85
84
|
* Reference</a>.</p>
|
|
86
|
-
*
|
|
85
|
+
* </li>
|
|
87
86
|
* </ul>
|
|
88
|
-
*
|
|
89
|
-
* </note>
|
|
87
|
+
* </note>
|
|
90
88
|
* @example
|
|
91
89
|
* Use a bare-bones client and the command you need to make an API call.
|
|
92
90
|
* ```javascript
|
|
@@ -12,20 +12,20 @@ export interface CreateEndpointConfigCommandOutput extends CreateEndpointConfigO
|
|
|
12
12
|
* the configuration, you identify one or more models, created using the
|
|
13
13
|
* <code>CreateModel</code> API, to deploy and the resources that you want SageMaker to
|
|
14
14
|
* provision. Then you call the <a>CreateEndpoint</a> API.</p>
|
|
15
|
-
*
|
|
15
|
+
* <note>
|
|
16
16
|
* <p> Use this API if you want to use SageMaker hosting services to deploy models into
|
|
17
17
|
* production. </p>
|
|
18
|
-
*
|
|
19
|
-
*
|
|
18
|
+
* </note>
|
|
19
|
+
* <p>In the request, you define a <code>ProductionVariant</code>, for each model that you
|
|
20
20
|
* want to deploy. Each <code>ProductionVariant</code> parameter also describes the
|
|
21
21
|
* resources that you want SageMaker to provision. This includes the number and type of ML
|
|
22
22
|
* compute instances to deploy. </p>
|
|
23
|
-
*
|
|
23
|
+
* <p>If you are hosting multiple models, you also assign a <code>VariantWeight</code> to
|
|
24
24
|
* specify how much traffic you want to allocate to each model. For example, suppose that
|
|
25
25
|
* you want to host two models, A and B, and you assign traffic weight 2 for model A and 1
|
|
26
26
|
* for model B. SageMaker distributes two-thirds of the traffic to Model A, and one-third to
|
|
27
27
|
* model B. </p>
|
|
28
|
-
*
|
|
28
|
+
* <note>
|
|
29
29
|
* <p>When you call <a>CreateEndpoint</a>, a load call is made to DynamoDB to
|
|
30
30
|
* verify that your endpoint configuration exists. When you read data from a DynamoDB
|
|
31
31
|
* table supporting <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html">
|
|
@@ -36,7 +36,7 @@ export interface CreateEndpointConfigCommandOutput extends CreateEndpointConfigO
|
|
|
36
36
|
* causes a validation error. If you repeat your read request after a short time, the
|
|
37
37
|
* response should return the latest data. So retry logic is recommended to handle
|
|
38
38
|
* 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>
|
|
39
|
-
*
|
|
39
|
+
* </note>
|
|
40
40
|
* @example
|
|
41
41
|
* Use a bare-bones client and the command you need to make an API call.
|
|
42
42
|
* ```javascript
|
|
@@ -13,16 +13,16 @@ export interface CreateHyperParameterTuningJobCommandOutput extends CreateHyperP
|
|
|
13
13
|
* and values for hyperparameters within ranges that you specify. It then chooses the
|
|
14
14
|
* hyperparameter values that result in a model that performs the best, as measured by an
|
|
15
15
|
* objective metric that you choose.</p>
|
|
16
|
-
*
|
|
16
|
+
* <p>A hyperparameter tuning job automatically creates Amazon SageMaker experiments, trials, and
|
|
17
17
|
* trial components for each training job that it runs. You can view these entities in
|
|
18
18
|
* Amazon SageMaker Studio. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/experiments-view-compare.html#experiments-view">View
|
|
19
19
|
* Experiments, Trials, and Trial Components</a>.</p>
|
|
20
|
-
*
|
|
20
|
+
* <important>
|
|
21
21
|
* <p>Do not include any security-sensitive information including account access IDs,
|
|
22
22
|
* secrets or tokens in any hyperparameter field. If the use of security-sensitive
|
|
23
23
|
* credentials are detected, SageMaker will reject your training job request and return an
|
|
24
24
|
* exception error.</p>
|
|
25
|
-
*
|
|
25
|
+
* </important>
|
|
26
26
|
* @example
|
|
27
27
|
* Use a bare-bones client and the command you need to make an API call.
|
|
28
28
|
* ```javascript
|
|
@@ -12,8 +12,8 @@ export interface CreateInferenceExperimentCommandOutput extends CreateInferenceE
|
|
|
12
12
|
* Creates an inference experiment using the configurations specified in the request.
|
|
13
13
|
* </p>
|
|
14
14
|
* <p>
|
|
15
|
-
* Use this API to schedule an experiment to compare model variants on a Amazon SageMaker inference endpoint. For
|
|
16
|
-
* information about inference experiments, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/shadow-tests.html">Shadow tests</a>.
|
|
15
|
+
* Use this API to setup and schedule an experiment to compare model variants on a Amazon SageMaker inference endpoint. For
|
|
16
|
+
* more information about inference experiments, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/shadow-tests.html">Shadow tests</a>.
|
|
17
17
|
* </p>
|
|
18
18
|
* <p>
|
|
19
19
|
* Amazon SageMaker begins your experiment at the scheduled time and routes traffic to your endpoint's model variants based
|
|
@@ -10,34 +10,34 @@ export interface CreateLabelingJobCommandOutput extends CreateLabelingJobRespons
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates a job that uses workers to label the data objects in your input dataset. You
|
|
12
12
|
* can use the labeled data to train machine learning models. </p>
|
|
13
|
-
*
|
|
14
|
-
*
|
|
13
|
+
* <p>You can select your workforce from one of three providers:</p>
|
|
14
|
+
* <ul>
|
|
15
15
|
* <li>
|
|
16
|
-
*
|
|
16
|
+
* <p>A private workforce that you create. It can include employees, contractors,
|
|
17
17
|
* and outside experts. Use a private workforce when want the data to stay within
|
|
18
18
|
* your organization or when a specific set of skills is required.</p>
|
|
19
19
|
* </li>
|
|
20
20
|
* <li>
|
|
21
|
-
*
|
|
21
|
+
* <p>One or more vendors that you select from the Amazon Web Services Marketplace. Vendors provide
|
|
22
22
|
* expertise in specific areas. </p>
|
|
23
23
|
* </li>
|
|
24
24
|
* <li>
|
|
25
|
-
*
|
|
25
|
+
* <p>The Amazon Mechanical Turk workforce. This is the largest workforce, but it
|
|
26
26
|
* should only be used for public data or data that has been stripped of any
|
|
27
27
|
* personally identifiable information.</p>
|
|
28
28
|
* </li>
|
|
29
29
|
* </ul>
|
|
30
|
-
*
|
|
30
|
+
* <p>You can also use <i>automated data labeling</i> to reduce the number of
|
|
31
31
|
* data objects that need to be labeled by a human. Automated data labeling uses
|
|
32
32
|
* <i>active learning</i> to determine if a data object can be labeled by
|
|
33
33
|
* machine or if it needs to be sent to a human worker. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-automated-labeling.html">Using
|
|
34
34
|
* Automated Data Labeling</a>.</p>
|
|
35
|
-
*
|
|
35
|
+
* <p>The data objects to be labeled are contained in an Amazon S3 bucket. You create a
|
|
36
36
|
* <i>manifest file</i> that describes the location of each object. For
|
|
37
37
|
* more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-data.html">Using Input and Output Data</a>.</p>
|
|
38
|
-
*
|
|
38
|
+
* <p>The output can be used as the manifest file for another labeling job or as training
|
|
39
39
|
* data for your machine learning models.</p>
|
|
40
|
-
*
|
|
40
|
+
* <p>You can use this operation to create a static labeling job or a streaming labeling
|
|
41
41
|
* job. A static labeling job stops if all data objects in the input manifest file
|
|
42
42
|
* identified in <code>ManifestS3Uri</code> have been labeled. A streaming labeling job
|
|
43
43
|
* runs perpetually until it is manually stopped, or remains idle for 10 days. You can send
|
|
@@ -12,19 +12,19 @@ export interface CreateModelCommandOutput extends CreateModelOutput, __MetadataB
|
|
|
12
12
|
* container. For the primary container, you specify the Docker image that
|
|
13
13
|
* contains inference code, artifacts (from prior training), and a custom environment map
|
|
14
14
|
* that the inference code uses when you deploy the model for predictions.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>Use this API to create a model if you want to use SageMaker hosting services or run a batch
|
|
16
16
|
* transform job.</p>
|
|
17
|
-
*
|
|
17
|
+
* <p>To host your model, you create an endpoint configuration with the
|
|
18
18
|
* <code>CreateEndpointConfig</code> API, and then create an endpoint with the
|
|
19
19
|
* <code>CreateEndpoint</code> API. SageMaker then deploys all of the containers that you
|
|
20
20
|
* defined for the model in the hosting environment. </p>
|
|
21
|
-
*
|
|
21
|
+
* <p>For an example that calls this method when deploying a model to SageMaker hosting services,
|
|
22
22
|
* 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>
|
|
23
23
|
* </p>
|
|
24
|
-
*
|
|
24
|
+
* <p>To run a batch transform using your model, you start a job with the
|
|
25
25
|
* <code>CreateTransformJob</code> API. SageMaker uses your model and your dataset to get
|
|
26
26
|
* inferences which are then saved to a specified S3 location.</p>
|
|
27
|
-
*
|
|
27
|
+
* <p>In the request, you also provide an IAM role that SageMaker can assume to access model
|
|
28
28
|
* artifacts and docker image for deployment on ML compute hosting instances or for batch
|
|
29
29
|
* transform jobs. In addition, you also use the IAM role to manage permissions the
|
|
30
30
|
* inference code needs. For example, if the inference code access any other Amazon Web Services resources, you grant necessary permissions via this role.</p>
|
|
@@ -11,23 +11,23 @@ export interface CreateModelPackageCommandOutput extends CreateModelPackageOutpu
|
|
|
11
11
|
* <p>Creates a model package that you can use to create SageMaker models or list on Amazon Web Services
|
|
12
12
|
* Marketplace, or a versioned model that is part of a model group. Buyers can subscribe to
|
|
13
13
|
* model packages listed on Amazon Web Services Marketplace to create models in SageMaker.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>To create a model package by specifying a Docker container that contains your
|
|
15
15
|
* inference code and the Amazon S3 location of your model artifacts, provide values for
|
|
16
16
|
* <code>InferenceSpecification</code>. To create a model from an algorithm resource
|
|
17
17
|
* that you created or subscribed to in Amazon Web Services Marketplace, provide a value for
|
|
18
18
|
* <code>SourceAlgorithmSpecification</code>.</p>
|
|
19
|
-
*
|
|
19
|
+
* <note>
|
|
20
20
|
* <p>There are two types of model packages:</p>
|
|
21
21
|
* <ul>
|
|
22
22
|
* <li>
|
|
23
|
-
*
|
|
23
|
+
* <p>Versioned - a model that is part of a model group in the model
|
|
24
24
|
* registry.</p>
|
|
25
|
-
*
|
|
25
|
+
* </li>
|
|
26
26
|
* <li>
|
|
27
|
-
*
|
|
28
|
-
*
|
|
27
|
+
* <p>Unversioned - a model package that is not part of a model group.</p>
|
|
28
|
+
* </li>
|
|
29
29
|
* </ul>
|
|
30
|
-
*
|
|
30
|
+
* </note>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -10,41 +10,39 @@ export interface CreateNotebookInstanceCommandOutput extends CreateNotebookInsta
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates an SageMaker notebook instance. A notebook instance is a machine learning (ML)
|
|
12
12
|
* compute instance running on a Jupyter notebook. </p>
|
|
13
|
-
*
|
|
13
|
+
* <p>In a <code>CreateNotebookInstance</code> request, specify the type of ML compute
|
|
14
14
|
* instance that you want to run. SageMaker launches the instance, installs common libraries
|
|
15
15
|
* that you can use to explore datasets for model training, and attaches an ML storage
|
|
16
16
|
* volume to the notebook instance. </p>
|
|
17
|
-
*
|
|
17
|
+
* <p>SageMaker also provides a set of example notebooks. Each notebook demonstrates how to
|
|
18
18
|
* use SageMaker with a specific algorithm or with a machine learning framework. </p>
|
|
19
|
-
*
|
|
20
|
-
*
|
|
19
|
+
* <p>After receiving the request, SageMaker does the following:</p>
|
|
20
|
+
* <ol>
|
|
21
21
|
* <li>
|
|
22
|
-
*
|
|
22
|
+
* <p>Creates a network interface in the SageMaker VPC.</p>
|
|
23
23
|
* </li>
|
|
24
24
|
* <li>
|
|
25
|
-
*
|
|
25
|
+
* <p>(Option) If you specified <code>SubnetId</code>, SageMaker creates a network
|
|
26
26
|
* interface in your own VPC, which is inferred from the subnet ID that you provide
|
|
27
27
|
* in the input. When creating this network interface, SageMaker attaches the security
|
|
28
28
|
* group that you specified in the request to the network interface that it creates
|
|
29
29
|
* in your VPC.</p>
|
|
30
|
-
*
|
|
31
30
|
* </li>
|
|
32
31
|
* <li>
|
|
33
|
-
*
|
|
32
|
+
* <p>Launches an EC2 instance of the type specified in the request in the SageMaker
|
|
34
33
|
* VPC. If you specified <code>SubnetId</code> of your VPC, SageMaker specifies both
|
|
35
34
|
* network interfaces when launching this instance. This enables inbound traffic
|
|
36
35
|
* from your own VPC to the notebook instance, assuming that the security groups
|
|
37
36
|
* allow it.</p>
|
|
38
37
|
* </li>
|
|
39
38
|
* </ol>
|
|
40
|
-
*
|
|
41
|
-
* <p>After creating the notebook instance, SageMaker returns its Amazon Resource Name (ARN).
|
|
39
|
+
* <p>After creating the notebook instance, SageMaker returns its Amazon Resource Name (ARN).
|
|
42
40
|
* You can't change the name of a notebook instance after you create it.</p>
|
|
43
|
-
*
|
|
41
|
+
* <p>After SageMaker creates the notebook instance, you can connect to the Jupyter server and
|
|
44
42
|
* work in Jupyter notebooks. For example, you can write code to explore a dataset that you
|
|
45
43
|
* can use for model training, train a model, host models by creating SageMaker endpoints, and
|
|
46
44
|
* validate hosted models. </p>
|
|
47
|
-
*
|
|
45
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/how-it-works.html">How It Works</a>. </p>
|
|
48
46
|
* @example
|
|
49
47
|
* Use a bare-bones client and the command you need to make an API call.
|
|
50
48
|
* ```javascript
|
|
@@ -11,16 +11,16 @@ export interface CreateNotebookInstanceLifecycleConfigCommandOutput extends Crea
|
|
|
11
11
|
* <p>Creates a lifecycle configuration that you can associate with a notebook instance. A
|
|
12
12
|
* <i>lifecycle configuration</i> is a collection of shell scripts that
|
|
13
13
|
* run when you create or start a notebook instance.</p>
|
|
14
|
-
*
|
|
15
|
-
*
|
|
14
|
+
* <p>Each lifecycle configuration script has a limit of 16384 characters.</p>
|
|
15
|
+
* <p>The value of the <code>$PATH</code> environment variable that is available to both
|
|
16
16
|
* scripts is <code>/sbin:bin:/usr/sbin:/usr/bin</code>.</p>
|
|
17
|
-
*
|
|
17
|
+
* <p>View CloudWatch Logs for notebook instance lifecycle configurations in log group
|
|
18
18
|
* <code>/aws/sagemaker/NotebookInstances</code> in log stream
|
|
19
19
|
* <code>[notebook-instance-name]/[LifecycleConfigHook]</code>.</p>
|
|
20
|
-
*
|
|
20
|
+
* <p>Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs
|
|
21
21
|
* for longer than 5 minutes, it fails and the notebook instance is not created or
|
|
22
22
|
* started.</p>
|
|
23
|
-
*
|
|
23
|
+
* <p>For information about notebook instance lifestyle configurations, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html">Step
|
|
24
24
|
* 2.1: (Optional) Customize a Notebook Instance</a>.</p>
|
|
25
25
|
* @example
|
|
26
26
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -12,20 +12,20 @@ export interface CreatePresignedNotebookInstanceUrlCommandOutput extends CreateP
|
|
|
12
12
|
* instance. In the SageMaker console, when you choose <code>Open</code> next to a notebook
|
|
13
13
|
* instance, SageMaker opens a new tab showing the Jupyter server home page from the notebook
|
|
14
14
|
* instance. The console uses this API to get the URL and show the page.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p> The IAM role or user used to call this API defines the permissions to access the
|
|
16
16
|
* notebook instance. Once the presigned URL is created, no additional permission is
|
|
17
17
|
* required to access this URL. IAM authorization policies for this API are also enforced
|
|
18
18
|
* for every HTTP request and WebSocket frame that attempts to connect to the notebook
|
|
19
19
|
* instance.</p>
|
|
20
|
-
*
|
|
20
|
+
* <p>You can restrict access to this API and to the URL that it returns to a list of IP
|
|
21
21
|
* addresses that you specify. Use the <code>NotIpAddress</code> condition operator and the
|
|
22
22
|
* <code>aws:SourceIP</code> condition context key to specify the list of IP addresses
|
|
23
23
|
* 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>
|
|
24
|
-
*
|
|
24
|
+
* <note>
|
|
25
25
|
* <p>The URL that you get from a call to <a>CreatePresignedNotebookInstanceUrl</a> is valid only for 5 minutes. If
|
|
26
26
|
* you try to use the URL after the 5-minute limit expires, you are directed to the
|
|
27
27
|
* Amazon Web Services console sign-in page.</p>
|
|
28
|
-
*
|
|
28
|
+
* </note>
|
|
29
29
|
* @example
|
|
30
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
31
|
* ```javascript
|