feat(client-sagemaker): Sagemaker Neo now supports compilation for in…

…ferentia2 (ML_INF2) and Trainium1 (ML_TRN1) as available targets. With these devices, you can run your workloads at highest performance with lowest cost. inferentia2 (ML_INF2) is available in CMH and Trainium1 (ML_TRN1) is available in IAD currently
aws · Jun 12, 2023 · c84177f · c84177f
1 parent be0249f
commit c84177f
Show file tree

Hide file tree

Showing 15 changed files with 357 additions and 321 deletions.
diff --git a/clients/client-sagemaker/src/commands/AddTagsCommand.ts b/clients/client-sagemaker/src/commands/AddTagsCommand.ts
@@ -59,7 +59,8 @@ export interface AddTagsCommandOutput extends AddTagsOutput, __MetadataBearer {}
  *                 this API. To make sure that the tags associated with a Domain or User Profile are
  *                 also added to all Apps that the Domain or User Profile launches, add the tags when
  *                 you first create the Domain or User Profile by specifying them in the
- *                 <code>Tags</code> parameter of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateDomain.html">CreateDomain</a> or <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateUserProfile.html">CreateUserProfile</a>.</p>
+ *                     <code>Tags</code> parameter of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateDomain.html">CreateDomain</a>
+ *                 or <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateUserProfile.html">CreateUserProfile</a>.</p>
  *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-sagemaker/src/commands/CreateCompilationJobCommand.ts b/clients/client-sagemaker/src/commands/CreateCompilationJobCommand.ts
@@ -86,7 +86,7 @@ export interface CreateCompilationJobCommandOutput extends CreateCompilationJobR
  *   },
  *   OutputConfig: { // OutputConfig
  *     S3OutputLocation: "STRING_VALUE", // required
- *     TargetDevice: "lambda" || "ml_m4" || "ml_m5" || "ml_c4" || "ml_c5" || "ml_p2" || "ml_p3" || "ml_g4dn" || "ml_inf1" || "ml_eia2" || "jetson_tx1" || "jetson_tx2" || "jetson_nano" || "jetson_xavier" || "rasp3b" || "imx8qm" || "deeplens" || "rk3399" || "rk3288" || "aisage" || "sbe_c" || "qcs605" || "qcs603" || "sitara_am57x" || "amba_cv2" || "amba_cv22" || "amba_cv25" || "x86_win32" || "x86_win64" || "coreml" || "jacinto_tda4vm" || "imx8mplus",
+ *     TargetDevice: "lambda" || "ml_m4" || "ml_m5" || "ml_c4" || "ml_c5" || "ml_p2" || "ml_p3" || "ml_g4dn" || "ml_inf1" || "ml_inf2" || "ml_trn1" || "ml_eia2" || "jetson_tx1" || "jetson_tx2" || "jetson_nano" || "jetson_xavier" || "rasp3b" || "imx8qm" || "deeplens" || "rk3399" || "rk3288" || "aisage" || "sbe_c" || "qcs605" || "qcs603" || "sitara_am57x" || "amba_cv2" || "amba_cv22" || "amba_cv25" || "x86_win32" || "x86_win64" || "coreml" || "jacinto_tda4vm" || "imx8mplus",
  *     TargetPlatform: { // TargetPlatform
  *       Os: "ANDROID" || "LINUX", // required
  *       Arch: "X86_64" || "X86" || "ARM64" || "ARM_EABI" || "ARM_EABIHF", // required

diff --git a/clients/client-sagemaker/src/commands/CreateEndpointCommand.ts b/clients/client-sagemaker/src/commands/CreateEndpointCommand.ts
@@ -54,22 +54,22 @@ export interface CreateEndpointCommandOutput extends CreateEndpointOutput, __Met
  *          <p>When it receives the request, SageMaker creates the endpoint, launches the resources (ML
  *             compute instances), and deploys the model(s) on them. </p>
  *          <note>
- *             <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
- *                 verify that your endpoint configuration exists. When you read data from a DynamoDB
- *                 table supporting <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html">
+ *             <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 verify that your
+ *                 endpoint configuration exists. When you read data from a DynamoDB table supporting
+ *                     <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html">
  *                   <code>Eventually Consistent Reads</code>
  *                </a>, the response might not
  *                 reflect the results of a recently completed write operation. The response might
  *                 include some stale data. If the dependent entities are not yet in DynamoDB, this
  *                 causes a validation error. If you repeat your read request after a short time, the
  *                 response should return the latest data. So retry logic is recommended to handle
- *                 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>
+ *                 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>
  *          </note>
  *          <p>When SageMaker receives the request, it sets the endpoint status to
  *                 <code>Creating</code>. After it creates the endpoint, it sets the status to
  *                 <code>InService</code>. SageMaker can then process incoming requests for inferences. 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.</p>
+ *             check the status of an endpoint, use the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html">DescribeEndpoint</a> API.</p>
  *          <p>If any of the models hosted at this endpoint get model data from an Amazon S3 location,
  *             SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the
  *             S3 path you provided. Amazon Web Services STS is activated in your Amazon Web Services
@@ -82,8 +82,8 @@ export interface CreateEndpointCommandOutput extends CreateEndpointOutput, __Met
  *          <note>
  *             <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
  *                 Roles in the left navigation pane. Search the IAM role that you want to grant
- *                 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
- *                 the role. </p>
+ *                 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 the
+ *                 role. </p>
  *             <ul>
  *                <li>
  *                   <p>Option 1: For a full SageMaker access, search and attach the

diff --git a/clients/client-sagemaker/src/commands/CreateEndpointConfigCommand.ts b/clients/client-sagemaker/src/commands/CreateEndpointConfigCommand.ts
@@ -39,7 +39,8 @@ export interface CreateEndpointConfigCommandOutput extends CreateEndpointConfigO
  * <p>Creates an endpoint configuration that SageMaker hosting services uses to deploy models. In
  *             the configuration, you identify one or more models, created using the
  *                 <code>CreateModel</code> API, to deploy and the resources that you want SageMaker to
- *             provision. Then you call the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html">CreateEndpoint</a> API.</p>
+ *             provision. Then you call the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html">CreateEndpoint</a>
+ *             API.</p>
  *          <note>
  *             <p> Use this API if you want to use SageMaker hosting services to deploy models into
  *                 production. </p>
@@ -54,16 +55,17 @@ export interface CreateEndpointConfigCommandOutput extends CreateEndpointConfigO
  *             for model B. SageMaker distributes two-thirds of the traffic to Model A, and one-third to
  *             model B. </p>
  *          <note>
- *             <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
- *                 verify that your endpoint configuration exists. When you read data from a DynamoDB
- *                 table supporting <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html">
+ *             <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 verify that your
+ *                 endpoint configuration exists. When you read data from a DynamoDB table supporting
+ *                     <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html">
  *                   <code>Eventually Consistent Reads</code>
  *                </a>, the response might not
  *                 reflect the results of a recently completed write operation. The response might
  *                 include some stale data. If the dependent entities are not yet in DynamoDB, this
  *                 causes a validation error. If you repeat your read request after a short time, the
  *                 response should return the latest data. So retry logic is recommended to handle
- *                 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>
+ *                 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>
  *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-sagemaker/src/commands/CreatePresignedNotebookInstanceUrlCommand.ts b/clients/client-sagemaker/src/commands/CreatePresignedNotebookInstanceUrlCommand.ts
@@ -55,9 +55,8 @@ export interface CreatePresignedNotebookInstanceUrlCommandOutput
  *                 <code>aws:SourceIP</code> condition context key to specify the list of IP addresses
  *             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>
  *          <note>
- *             <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
- *                 you try to use the URL after the 5-minute limit expires, you are directed to the
- *                     Amazon Web Services console sign-in page.</p>
+ *             <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 you
+ *                 try to use the URL after the 5-minute limit expires, you are directed to the Amazon Web Services console sign-in page.</p>
  *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-sagemaker/src/commands/DescribeCompilationJobCommand.ts b/clients/client-sagemaker/src/commands/DescribeCompilationJobCommand.ts
@@ -80,7 +80,7 @@ export interface DescribeCompilationJobCommandOutput extends DescribeCompilation
  * //   },
  * //   OutputConfig: { // OutputConfig
  * //     S3OutputLocation: "STRING_VALUE", // required
- * //     TargetDevice: "lambda" || "ml_m4" || "ml_m5" || "ml_c4" || "ml_c5" || "ml_p2" || "ml_p3" || "ml_g4dn" || "ml_inf1" || "ml_eia2" || "jetson_tx1" || "jetson_tx2" || "jetson_nano" || "jetson_xavier" || "rasp3b" || "imx8qm" || "deeplens" || "rk3399" || "rk3288" || "aisage" || "sbe_c" || "qcs605" || "qcs603" || "sitara_am57x" || "amba_cv2" || "amba_cv22" || "amba_cv25" || "x86_win32" || "x86_win64" || "coreml" || "jacinto_tda4vm" || "imx8mplus",
+ * //     TargetDevice: "lambda" || "ml_m4" || "ml_m5" || "ml_c4" || "ml_c5" || "ml_p2" || "ml_p3" || "ml_g4dn" || "ml_inf1" || "ml_inf2" || "ml_trn1" || "ml_eia2" || "jetson_tx1" || "jetson_tx2" || "jetson_nano" || "jetson_xavier" || "rasp3b" || "imx8qm" || "deeplens" || "rk3399" || "rk3288" || "aisage" || "sbe_c" || "qcs605" || "qcs603" || "sitara_am57x" || "amba_cv2" || "amba_cv22" || "amba_cv25" || "x86_win32" || "x86_win64" || "coreml" || "jacinto_tda4vm" || "imx8mplus",
  * //     TargetPlatform: { // TargetPlatform
  * //       Os: "ANDROID" || "LINUX", // required
  * //       Arch: "X86_64" || "X86" || "ARM64" || "ARM_EABI" || "ARM_EABIHF", // required

diff --git a/clients/client-sagemaker/src/commands/ListCompilationJobsCommand.ts b/clients/client-sagemaker/src/commands/ListCompilationJobsCommand.ts
@@ -67,7 +67,7 @@ export interface ListCompilationJobsCommandOutput extends ListCompilationJobsRes
  * //       CreationTime: new Date("TIMESTAMP"), // required
  * //       CompilationStartTime: new Date("TIMESTAMP"),
  * //       CompilationEndTime: new Date("TIMESTAMP"),
- * //       CompilationTargetDevice: "lambda" || "ml_m4" || "ml_m5" || "ml_c4" || "ml_c5" || "ml_p2" || "ml_p3" || "ml_g4dn" || "ml_inf1" || "ml_eia2" || "jetson_tx1" || "jetson_tx2" || "jetson_nano" || "jetson_xavier" || "rasp3b" || "imx8qm" || "deeplens" || "rk3399" || "rk3288" || "aisage" || "sbe_c" || "qcs605" || "qcs603" || "sitara_am57x" || "amba_cv2" || "amba_cv22" || "amba_cv25" || "x86_win32" || "x86_win64" || "coreml" || "jacinto_tda4vm" || "imx8mplus",
+ * //       CompilationTargetDevice: "lambda" || "ml_m4" || "ml_m5" || "ml_c4" || "ml_c5" || "ml_p2" || "ml_p3" || "ml_g4dn" || "ml_inf1" || "ml_inf2" || "ml_trn1" || "ml_eia2" || "jetson_tx1" || "jetson_tx2" || "jetson_nano" || "jetson_xavier" || "rasp3b" || "imx8qm" || "deeplens" || "rk3399" || "rk3288" || "aisage" || "sbe_c" || "qcs605" || "qcs603" || "sitara_am57x" || "amba_cv2" || "amba_cv22" || "amba_cv25" || "x86_win32" || "x86_win64" || "coreml" || "jacinto_tda4vm" || "imx8mplus",
  * //       CompilationTargetPlatformOs: "ANDROID" || "LINUX",
  * //       CompilationTargetPlatformArch: "X86_64" || "X86" || "ARM64" || "ARM_EABI" || "ARM_EABIHF",
  * //       CompilationTargetPlatformAccelerator: "INTEL_GRAPHICS" || "MALI" || "NVIDIA" || "NNA",

diff --git a/clients/client-sagemaker/src/commands/ListTrainingJobsForHyperParameterTuningJobCommand.ts b/clients/client-sagemaker/src/commands/ListTrainingJobsForHyperParameterTuningJobCommand.ts
@@ -45,8 +45,8 @@ export interface ListTrainingJobsForHyperParameterTuningJobCommandOutput
 
 /**
  * @public
- * <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
- *             jobs that a hyperparameter tuning job launched.</p>
+ * <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 jobs that a
+ *             hyperparameter tuning job launched.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-sagemaker/src/commands/UpdateEndpointCommand.ts b/clients/client-sagemaker/src/commands/UpdateEndpointCommand.ts
@@ -41,7 +41,7 @@ export interface UpdateEndpointCommandOutput extends UpdateEndpointOutput, __Met
  *             using the previous <code>EndpointConfig</code> (there is no availability loss). </p>
  *          <p>When SageMaker receives the request, it sets the endpoint status to
  *                 <code>Updating</code>. After updating the endpoint, it sets the status to
- *             <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.
+ *                 <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.
  *
  *         </p>
  *          <note>