From a8ae1e9c82109185904580eca01132e8d6eff2b5 Mon Sep 17 00:00:00 2001 From: awstools Date: Wed, 29 Nov 2023 18:56:26 +0000 Subject: [PATCH] feat(client-sagemaker): This release adds following support 1/ Improved SDK tooling for model deployment. 2/ New Inference Component based features to lower inference costs and latency 3/ SageMaker HyperPod management. 4/ Additional parameters for FM Fine Tuning in Autopilot --- clients/client-sagemaker/README.md | 104 + clients/client-sagemaker/src/SageMaker.ts | 272 + .../client-sagemaker/src/SageMakerClient.ts | 60 + .../src/commands/AddTagsCommand.ts | 2 +- .../src/commands/CreateAppCommand.ts | 3 +- .../src/commands/CreateAutoMLJobV2Command.ts | 3 + .../src/commands/CreateClusterCommand.ts | 173 + .../src/commands/CreateDomainCommand.ts | 23 +- .../commands/CreateEndpointConfigCommand.ts | 30 +- .../CreateInferenceComponentCommand.ts | 181 + .../src/commands/CreateModelCommand.ts | 2 +- .../CreatePresignedDomainUrlCommand.ts | 5 +- .../src/commands/CreateSpaceCommand.ts | 2 + .../CreateStudioLifecycleConfigCommand.ts | 2 +- .../src/commands/CreateTrainingJobCommand.ts | 3 + .../src/commands/CreateUserProfileCommand.ts | 11 +- .../src/commands/CreateWorkforceCommand.ts | 2 +- .../src/commands/CreateWorkteamCommand.ts | 2 +- .../src/commands/DeleteActionCommand.ts | 2 +- .../src/commands/DeleteAlgorithmCommand.ts | 2 +- .../src/commands/DeleteAppCommand.ts | 2 +- .../commands/DeleteAppImageConfigCommand.ts | 2 +- .../src/commands/DeleteArtifactCommand.ts | 2 +- .../src/commands/DeleteAssociationCommand.ts | 2 +- .../src/commands/DeleteClusterCommand.ts | 144 + .../DeleteInferenceComponentCommand.ts | 137 + .../DeleteStudioLifecycleConfigCommand.ts | 2 +- .../src/commands/DeleteTagsCommand.ts | 4 +- .../src/commands/DescribeAppCommand.ts | 1 + .../commands/DescribeAutoMLJobV2Command.ts | 3 + .../src/commands/DescribeClusterCommand.ts | 168 + .../commands/DescribeClusterNodeCommand.ts | 158 + .../src/commands/DescribeDomainCommand.ts | 7 + .../src/commands/DescribeEndpointCommand.ts | 32 + .../commands/DescribeEndpointConfigCommand.ts | 30 +- .../DescribeInferenceComponentCommand.ts | 178 + .../src/commands/DescribeModelCommand.ts | 2 +- .../src/commands/DescribeSpaceCommand.ts | 3 + .../DescribeStudioLifecycleConfigCommand.ts | 2 +- .../commands/DescribeTrainingJobCommand.ts | 3 + .../commands/DescribeUserProfileCommand.ts | 9 +- .../src/commands/DescribeWorkforceCommand.ts | 2 +- .../src/commands/DescribeWorkteamCommand.ts | 2 +- ...SagemakerServicecatalogPortfolioCommand.ts | 2 +- .../DisassociateTrialComponentCommand.ts | 2 +- ...SagemakerServicecatalogPortfolioCommand.ts | 2 +- .../src/commands/ListClusterNodesCommand.ts | 162 + .../src/commands/ListClustersCommand.ts | 151 + .../ListInferenceComponentsCommand.ts | 162 + .../commands/ListResourceCatalogsCommand.ts | 2 +- .../src/commands/ListSpacesCommand.ts | 2 +- .../src/commands/ListStageDevicesCommand.ts | 2 +- .../ListStudioLifecycleConfigsCommand.ts | 4 +- .../ListSubscribedWorkteamsCommand.ts | 2 +- .../src/commands/ListTagsCommand.ts | 2 +- .../src/commands/ListTrainingJobsCommand.ts | 2 +- ...ngJobsForHyperParameterTuningJobCommand.ts | 2 +- .../src/commands/ListTransformJobsCommand.ts | 2 +- .../commands/ListTrialComponentsCommand.ts | 2 +- .../src/commands/ListTrialsCommand.ts | 2 +- .../src/commands/ListUserProfilesCommand.ts | 2 +- .../src/commands/ListWorkforcesCommand.ts | 2 +- .../src/commands/ListWorkteamsCommand.ts | 2 +- .../src/commands/SearchCommand.ts | 16 + .../src/commands/UpdateClusterCommand.ts | 161 + .../src/commands/UpdateDomainCommand.ts | 11 + .../UpdateInferenceComponentCommand.ts | 166 + ...eInferenceComponentRuntimeConfigCommand.ts | 160 + .../src/commands/UpdateSpaceCommand.ts | 2 + .../src/commands/UpdateUserProfileCommand.ts | 6 + .../client-sagemaker/src/commands/index.ts | 13 + .../client-sagemaker/src/models/models_0.ts | 1651 +-- .../client-sagemaker/src/models/models_1.ts | 8937 +++++++-------- .../client-sagemaker/src/models/models_2.ts | 8803 ++++++++------- .../client-sagemaker/src/models/models_3.ts | 9764 +++++++++-------- .../client-sagemaker/src/models/models_4.ts | 1707 ++- .../ListInferenceComponentsPaginator.ts | 50 + .../client-sagemaker/src/pagination/index.ts | 1 + .../src/protocols/Aws_json1_1.ts | 1590 ++- codegen/sdk-codegen/aws-models/sagemaker.json | 2548 ++++- 80 files changed, 23089 insertions(+), 14787 deletions(-) create mode 100644 clients/client-sagemaker/src/commands/CreateClusterCommand.ts create mode 100644 clients/client-sagemaker/src/commands/CreateInferenceComponentCommand.ts create mode 100644 clients/client-sagemaker/src/commands/DeleteClusterCommand.ts create mode 100644 clients/client-sagemaker/src/commands/DeleteInferenceComponentCommand.ts create mode 100644 clients/client-sagemaker/src/commands/DescribeClusterCommand.ts create mode 100644 clients/client-sagemaker/src/commands/DescribeClusterNodeCommand.ts create mode 100644 clients/client-sagemaker/src/commands/DescribeInferenceComponentCommand.ts create mode 100644 clients/client-sagemaker/src/commands/ListClusterNodesCommand.ts create mode 100644 clients/client-sagemaker/src/commands/ListClustersCommand.ts create mode 100644 clients/client-sagemaker/src/commands/ListInferenceComponentsCommand.ts create mode 100644 clients/client-sagemaker/src/commands/UpdateClusterCommand.ts create mode 100644 clients/client-sagemaker/src/commands/UpdateInferenceComponentCommand.ts create mode 100644 clients/client-sagemaker/src/commands/UpdateInferenceComponentRuntimeConfigCommand.ts create mode 100644 clients/client-sagemaker/src/pagination/ListInferenceComponentsPaginator.ts diff --git a/clients/client-sagemaker/README.md b/clients/client-sagemaker/README.md index 097331bb8ddd..53ba6e9baefc 100644 --- a/clients/client-sagemaker/README.md +++ b/clients/client-sagemaker/README.md @@ -305,6 +305,14 @@ CreateAutoMLJobV2 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sagemaker/command/CreateAutoMLJobV2Command/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/CreateAutoMLJobV2CommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/CreateAutoMLJobV2CommandOutput/) + +
+ +CreateCluster + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sagemaker/command/CreateClusterCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/CreateClusterCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/CreateClusterCommandOutput/) +
@@ -457,6 +465,14 @@ CreateImageVersion [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sagemaker/command/CreateImageVersionCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/CreateImageVersionCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/CreateImageVersionCommandOutput/) +
+
+ +CreateInferenceComponent + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sagemaker/command/CreateInferenceComponentCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/CreateInferenceComponentCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/CreateInferenceComponentCommandOutput/) +
@@ -729,6 +745,14 @@ DeleteAssociation [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sagemaker/command/DeleteAssociationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/DeleteAssociationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/DeleteAssociationCommandOutput/) +
+
+ +DeleteCluster + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sagemaker/command/DeleteClusterCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/DeleteClusterCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/DeleteClusterCommandOutput/) +
@@ -865,6 +889,14 @@ DeleteImageVersion [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sagemaker/command/DeleteImageVersionCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/DeleteImageVersionCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/DeleteImageVersionCommandOutput/) +
+
+ +DeleteInferenceComponent + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sagemaker/command/DeleteInferenceComponentCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/DeleteInferenceComponentCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/DeleteInferenceComponentCommandOutput/) +
@@ -1105,6 +1137,22 @@ DescribeAutoMLJobV2 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sagemaker/command/DescribeAutoMLJobV2Command/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/DescribeAutoMLJobV2CommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/DescribeAutoMLJobV2CommandOutput/) +
+
+ +DescribeCluster + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sagemaker/command/DescribeClusterCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/DescribeClusterCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/DescribeClusterCommandOutput/) + +
+
+ +DescribeClusterNode + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sagemaker/command/DescribeClusterNodeCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/DescribeClusterNodeCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/DescribeClusterNodeCommandOutput/) +
@@ -1273,6 +1321,14 @@ DescribeImageVersion [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sagemaker/command/DescribeImageVersionCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/DescribeImageVersionCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/DescribeImageVersionCommandOutput/) +
+
+ +DescribeInferenceComponent + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sagemaker/command/DescribeInferenceComponentCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/DescribeInferenceComponentCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/DescribeInferenceComponentCommandOutput/) +
@@ -1665,6 +1721,22 @@ ListCandidatesForAutoMLJob [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sagemaker/command/ListCandidatesForAutoMLJobCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/ListCandidatesForAutoMLJobCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/ListCandidatesForAutoMLJobCommandOutput/) +
+
+ +ListClusterNodes + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sagemaker/command/ListClusterNodesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/ListClusterNodesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/ListClusterNodesCommandOutput/) + +
+
+ +ListClusters + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sagemaker/command/ListClustersCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/ListClustersCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/ListClustersCommandOutput/) +
@@ -1833,6 +1905,14 @@ ListImageVersions [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sagemaker/command/ListImageVersionsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/ListImageVersionsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/ListImageVersionsCommandOutput/) +
+
+ +ListInferenceComponents + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sagemaker/command/ListInferenceComponentsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/ListInferenceComponentsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/ListInferenceComponentsCommandOutput/) +
@@ -2409,6 +2489,14 @@ UpdateArtifact [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sagemaker/command/UpdateArtifactCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/UpdateArtifactCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/UpdateArtifactCommandOutput/) +
+
+ +UpdateCluster + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sagemaker/command/UpdateClusterCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/UpdateClusterCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/UpdateClusterCommandOutput/) +
@@ -2513,6 +2601,22 @@ UpdateImageVersion [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sagemaker/command/UpdateImageVersionCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/UpdateImageVersionCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/UpdateImageVersionCommandOutput/) +
+
+ +UpdateInferenceComponent + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sagemaker/command/UpdateInferenceComponentCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/UpdateInferenceComponentCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/UpdateInferenceComponentCommandOutput/) + +
+
+ +UpdateInferenceComponentRuntimeConfig + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sagemaker/command/UpdateInferenceComponentRuntimeConfigCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/UpdateInferenceComponentRuntimeConfigCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker/Interface/UpdateInferenceComponentRuntimeConfigCommandOutput/) +
diff --git a/clients/client-sagemaker/src/SageMaker.ts b/clients/client-sagemaker/src/SageMaker.ts index 6a856cc42733..68517b92249d 100644 --- a/clients/client-sagemaker/src/SageMaker.ts +++ b/clients/client-sagemaker/src/SageMaker.ts @@ -49,6 +49,11 @@ import { CreateAutoMLJobV2CommandInput, CreateAutoMLJobV2CommandOutput, } from "./commands/CreateAutoMLJobV2Command"; +import { + CreateClusterCommand, + CreateClusterCommandInput, + CreateClusterCommandOutput, +} from "./commands/CreateClusterCommand"; import { CreateCodeRepositoryCommand, CreateCodeRepositoryCommandInput, @@ -136,6 +141,11 @@ import { CreateImageVersionCommandInput, CreateImageVersionCommandOutput, } from "./commands/CreateImageVersionCommand"; +import { + CreateInferenceComponentCommand, + CreateInferenceComponentCommandInput, + CreateInferenceComponentCommandOutput, +} from "./commands/CreateInferenceComponentCommand"; import { CreateInferenceExperimentCommand, CreateInferenceExperimentCommandInput, @@ -290,6 +300,11 @@ import { DeleteAssociationCommandInput, DeleteAssociationCommandOutput, } from "./commands/DeleteAssociationCommand"; +import { + DeleteClusterCommand, + DeleteClusterCommandInput, + DeleteClusterCommandOutput, +} from "./commands/DeleteClusterCommand"; import { DeleteCodeRepositoryCommand, DeleteCodeRepositoryCommandInput, @@ -367,6 +382,11 @@ import { DeleteImageVersionCommandInput, DeleteImageVersionCommandOutput, } from "./commands/DeleteImageVersionCommand"; +import { + DeleteInferenceComponentCommand, + DeleteInferenceComponentCommandInput, + DeleteInferenceComponentCommandOutput, +} from "./commands/DeleteInferenceComponentCommand"; import { DeleteInferenceExperimentCommand, DeleteInferenceExperimentCommandInput, @@ -497,6 +517,16 @@ import { DescribeAutoMLJobV2CommandInput, DescribeAutoMLJobV2CommandOutput, } from "./commands/DescribeAutoMLJobV2Command"; +import { + DescribeClusterCommand, + DescribeClusterCommandInput, + DescribeClusterCommandOutput, +} from "./commands/DescribeClusterCommand"; +import { + DescribeClusterNodeCommand, + DescribeClusterNodeCommandInput, + DescribeClusterNodeCommandOutput, +} from "./commands/DescribeClusterNodeCommand"; import { DescribeCodeRepositoryCommand, DescribeCodeRepositoryCommandInput, @@ -598,6 +628,11 @@ import { DescribeImageVersionCommandInput, DescribeImageVersionCommandOutput, } from "./commands/DescribeImageVersionCommand"; +import { + DescribeInferenceComponentCommand, + DescribeInferenceComponentCommandInput, + DescribeInferenceComponentCommandOutput, +} from "./commands/DescribeInferenceComponentCommand"; import { DescribeInferenceExperimentCommand, DescribeInferenceExperimentCommandInput, @@ -831,6 +866,16 @@ import { ListCandidatesForAutoMLJobCommandInput, ListCandidatesForAutoMLJobCommandOutput, } from "./commands/ListCandidatesForAutoMLJobCommand"; +import { + ListClusterNodesCommand, + ListClusterNodesCommandInput, + ListClusterNodesCommandOutput, +} from "./commands/ListClusterNodesCommand"; +import { + ListClustersCommand, + ListClustersCommandInput, + ListClustersCommandOutput, +} from "./commands/ListClustersCommand"; import { ListCodeRepositoriesCommand, ListCodeRepositoriesCommandInput, @@ -920,6 +965,11 @@ import { ListImageVersionsCommandInput, ListImageVersionsCommandOutput, } from "./commands/ListImageVersionsCommand"; +import { + ListInferenceComponentsCommand, + ListInferenceComponentsCommandInput, + ListInferenceComponentsCommandOutput, +} from "./commands/ListInferenceComponentsCommand"; import { ListInferenceExperimentsCommand, ListInferenceExperimentsCommandInput, @@ -1260,6 +1310,11 @@ import { UpdateArtifactCommandInput, UpdateArtifactCommandOutput, } from "./commands/UpdateArtifactCommand"; +import { + UpdateClusterCommand, + UpdateClusterCommandInput, + UpdateClusterCommandOutput, +} from "./commands/UpdateClusterCommand"; import { UpdateCodeRepositoryCommand, UpdateCodeRepositoryCommandInput, @@ -1317,6 +1372,16 @@ import { UpdateImageVersionCommandInput, UpdateImageVersionCommandOutput, } from "./commands/UpdateImageVersionCommand"; +import { + UpdateInferenceComponentCommand, + UpdateInferenceComponentCommandInput, + UpdateInferenceComponentCommandOutput, +} from "./commands/UpdateInferenceComponentCommand"; +import { + UpdateInferenceComponentRuntimeConfigCommand, + UpdateInferenceComponentRuntimeConfigCommandInput, + UpdateInferenceComponentRuntimeConfigCommandOutput, +} from "./commands/UpdateInferenceComponentRuntimeConfigCommand"; import { UpdateInferenceExperimentCommand, UpdateInferenceExperimentCommandInput, @@ -1408,6 +1473,7 @@ const commands = { CreateArtifactCommand, CreateAutoMLJobCommand, CreateAutoMLJobV2Command, + CreateClusterCommand, CreateCodeRepositoryCommand, CreateCompilationJobCommand, CreateContextCommand, @@ -1427,6 +1493,7 @@ const commands = { CreateHyperParameterTuningJobCommand, CreateImageCommand, CreateImageVersionCommand, + CreateInferenceComponentCommand, CreateInferenceExperimentCommand, CreateInferenceRecommendationsJobCommand, CreateLabelingJobCommand, @@ -1461,6 +1528,7 @@ const commands = { DeleteAppImageConfigCommand, DeleteArtifactCommand, DeleteAssociationCommand, + DeleteClusterCommand, DeleteCodeRepositoryCommand, DeleteContextCommand, DeleteDataQualityJobDefinitionCommand, @@ -1478,6 +1546,7 @@ const commands = { DeleteHumanTaskUiCommand, DeleteImageCommand, DeleteImageVersionCommand, + DeleteInferenceComponentCommand, DeleteInferenceExperimentCommand, DeleteModelCommand, DeleteModelBiasJobDefinitionCommand, @@ -1508,6 +1577,8 @@ const commands = { DescribeArtifactCommand, DescribeAutoMLJobCommand, DescribeAutoMLJobV2Command, + DescribeClusterCommand, + DescribeClusterNodeCommand, DescribeCodeRepositoryCommand, DescribeCompilationJobCommand, DescribeContextCommand, @@ -1529,6 +1600,7 @@ const commands = { DescribeHyperParameterTuningJobCommand, DescribeImageCommand, DescribeImageVersionCommand, + DescribeInferenceComponentCommand, DescribeInferenceExperimentCommand, DescribeInferenceRecommendationsJobCommand, DescribeLabelingJobCommand, @@ -1578,6 +1650,8 @@ const commands = { ListAssociationsCommand, ListAutoMLJobsCommand, ListCandidatesForAutoMLJobCommand, + ListClusterNodesCommand, + ListClustersCommand, ListCodeRepositoriesCommand, ListCompilationJobsCommand, ListContextsCommand, @@ -1599,6 +1673,7 @@ const commands = { ListHyperParameterTuningJobsCommand, ListImagesCommand, ListImageVersionsCommand, + ListInferenceComponentsCommand, ListInferenceExperimentsCommand, ListInferenceRecommendationsJobsCommand, ListInferenceRecommendationsJobStepsCommand, @@ -1671,6 +1746,7 @@ const commands = { UpdateActionCommand, UpdateAppImageConfigCommand, UpdateArtifactCommand, + UpdateClusterCommand, UpdateCodeRepositoryCommand, UpdateContextCommand, UpdateDeviceFleetCommand, @@ -1684,6 +1760,8 @@ const commands = { UpdateHubCommand, UpdateImageCommand, UpdateImageVersionCommand, + UpdateInferenceComponentCommand, + UpdateInferenceComponentRuntimeConfigCommand, UpdateInferenceExperimentCommand, UpdateModelCardCommand, UpdateModelPackageCommand, @@ -1861,6 +1939,17 @@ export interface SageMaker { cb: (err: any, data?: CreateAutoMLJobV2CommandOutput) => void ): void; + /** + * @see {@link CreateClusterCommand} + */ + createCluster(args: CreateClusterCommandInput, options?: __HttpHandlerOptions): Promise; + createCluster(args: CreateClusterCommandInput, cb: (err: any, data?: CreateClusterCommandOutput) => void): void; + createCluster( + args: CreateClusterCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: CreateClusterCommandOutput) => void + ): void; + /** * @see {@link CreateCodeRepositoryCommand} */ @@ -2157,6 +2246,23 @@ export interface SageMaker { cb: (err: any, data?: CreateImageVersionCommandOutput) => void ): void; + /** + * @see {@link CreateInferenceComponentCommand} + */ + createInferenceComponent( + args: CreateInferenceComponentCommandInput, + options?: __HttpHandlerOptions + ): Promise; + createInferenceComponent( + args: CreateInferenceComponentCommandInput, + cb: (err: any, data?: CreateInferenceComponentCommandOutput) => void + ): void; + createInferenceComponent( + args: CreateInferenceComponentCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: CreateInferenceComponentCommandOutput) => void + ): void; + /** * @see {@link CreateInferenceExperimentCommand} */ @@ -2681,6 +2787,17 @@ export interface SageMaker { cb: (err: any, data?: DeleteAssociationCommandOutput) => void ): void; + /** + * @see {@link DeleteClusterCommand} + */ + deleteCluster(args: DeleteClusterCommandInput, options?: __HttpHandlerOptions): Promise; + deleteCluster(args: DeleteClusterCommandInput, cb: (err: any, data?: DeleteClusterCommandOutput) => void): void; + deleteCluster( + args: DeleteClusterCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: DeleteClusterCommandOutput) => void + ): void; + /** * @see {@link DeleteCodeRepositoryCommand} */ @@ -2943,6 +3060,23 @@ export interface SageMaker { cb: (err: any, data?: DeleteImageVersionCommandOutput) => void ): void; + /** + * @see {@link DeleteInferenceComponentCommand} + */ + deleteInferenceComponent( + args: DeleteInferenceComponentCommandInput, + options?: __HttpHandlerOptions + ): Promise; + deleteInferenceComponent( + args: DeleteInferenceComponentCommandInput, + cb: (err: any, data?: DeleteInferenceComponentCommandOutput) => void + ): void; + deleteInferenceComponent( + args: DeleteInferenceComponentCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: DeleteInferenceComponentCommandOutput) => void + ): void; + /** * @see {@link DeleteInferenceExperimentCommand} */ @@ -3402,6 +3536,37 @@ export interface SageMaker { cb: (err: any, data?: DescribeAutoMLJobV2CommandOutput) => void ): void; + /** + * @see {@link DescribeClusterCommand} + */ + describeCluster( + args: DescribeClusterCommandInput, + options?: __HttpHandlerOptions + ): Promise; + describeCluster(args: DescribeClusterCommandInput, cb: (err: any, data?: DescribeClusterCommandOutput) => void): void; + describeCluster( + args: DescribeClusterCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: DescribeClusterCommandOutput) => void + ): void; + + /** + * @see {@link DescribeClusterNodeCommand} + */ + describeClusterNode( + args: DescribeClusterNodeCommandInput, + options?: __HttpHandlerOptions + ): Promise; + describeClusterNode( + args: DescribeClusterNodeCommandInput, + cb: (err: any, data?: DescribeClusterNodeCommandOutput) => void + ): void; + describeClusterNode( + args: DescribeClusterNodeCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: DescribeClusterNodeCommandOutput) => void + ): void; + /** * @see {@link DescribeCodeRepositoryCommand} */ @@ -3738,6 +3903,23 @@ export interface SageMaker { cb: (err: any, data?: DescribeImageVersionCommandOutput) => void ): void; + /** + * @see {@link DescribeInferenceComponentCommand} + */ + describeInferenceComponent( + args: DescribeInferenceComponentCommandInput, + options?: __HttpHandlerOptions + ): Promise; + describeInferenceComponent( + args: DescribeInferenceComponentCommandInput, + cb: (err: any, data?: DescribeInferenceComponentCommandOutput) => void + ): void; + describeInferenceComponent( + args: DescribeInferenceComponentCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: DescribeInferenceComponentCommandOutput) => void + ): void; + /** * @see {@link DescribeInferenceExperimentCommand} */ @@ -4520,6 +4702,34 @@ export interface SageMaker { cb: (err: any, data?: ListCandidatesForAutoMLJobCommandOutput) => void ): void; + /** + * @see {@link ListClusterNodesCommand} + */ + listClusterNodes( + args: ListClusterNodesCommandInput, + options?: __HttpHandlerOptions + ): Promise; + listClusterNodes( + args: ListClusterNodesCommandInput, + cb: (err: any, data?: ListClusterNodesCommandOutput) => void + ): void; + listClusterNodes( + args: ListClusterNodesCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: ListClusterNodesCommandOutput) => void + ): void; + + /** + * @see {@link ListClustersCommand} + */ + listClusters(args: ListClustersCommandInput, options?: __HttpHandlerOptions): Promise; + listClusters(args: ListClustersCommandInput, cb: (err: any, data?: ListClustersCommandOutput) => void): void; + listClusters( + args: ListClustersCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: ListClustersCommandOutput) => void + ): void; + /** * @see {@link ListCodeRepositoriesCommand} */ @@ -4835,6 +5045,23 @@ export interface SageMaker { cb: (err: any, data?: ListImageVersionsCommandOutput) => void ): void; + /** + * @see {@link ListInferenceComponentsCommand} + */ + listInferenceComponents( + args: ListInferenceComponentsCommandInput, + options?: __HttpHandlerOptions + ): Promise; + listInferenceComponents( + args: ListInferenceComponentsCommandInput, + cb: (err: any, data?: ListInferenceComponentsCommandOutput) => void + ): void; + listInferenceComponents( + args: ListInferenceComponentsCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: ListInferenceComponentsCommandOutput) => void + ): void; + /** * @see {@link ListInferenceExperimentsCommand} */ @@ -5975,6 +6202,17 @@ export interface SageMaker { cb: (err: any, data?: UpdateArtifactCommandOutput) => void ): void; + /** + * @see {@link UpdateClusterCommand} + */ + updateCluster(args: UpdateClusterCommandInput, options?: __HttpHandlerOptions): Promise; + updateCluster(args: UpdateClusterCommandInput, cb: (err: any, data?: UpdateClusterCommandOutput) => void): void; + updateCluster( + args: UpdateClusterCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: UpdateClusterCommandOutput) => void + ): void; + /** * @see {@link UpdateCodeRepositoryCommand} */ @@ -6163,6 +6401,40 @@ export interface SageMaker { cb: (err: any, data?: UpdateImageVersionCommandOutput) => void ): void; + /** + * @see {@link UpdateInferenceComponentCommand} + */ + updateInferenceComponent( + args: UpdateInferenceComponentCommandInput, + options?: __HttpHandlerOptions + ): Promise; + updateInferenceComponent( + args: UpdateInferenceComponentCommandInput, + cb: (err: any, data?: UpdateInferenceComponentCommandOutput) => void + ): void; + updateInferenceComponent( + args: UpdateInferenceComponentCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: UpdateInferenceComponentCommandOutput) => void + ): void; + + /** + * @see {@link UpdateInferenceComponentRuntimeConfigCommand} + */ + updateInferenceComponentRuntimeConfig( + args: UpdateInferenceComponentRuntimeConfigCommandInput, + options?: __HttpHandlerOptions + ): Promise; + updateInferenceComponentRuntimeConfig( + args: UpdateInferenceComponentRuntimeConfigCommandInput, + cb: (err: any, data?: UpdateInferenceComponentRuntimeConfigCommandOutput) => void + ): void; + updateInferenceComponentRuntimeConfig( + args: UpdateInferenceComponentRuntimeConfigCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: UpdateInferenceComponentRuntimeConfigCommandOutput) => void + ): void; + /** * @see {@link UpdateInferenceExperimentCommand} */ diff --git a/clients/client-sagemaker/src/SageMakerClient.ts b/clients/client-sagemaker/src/SageMakerClient.ts index 08431462f2ba..63fbd68977c6 100644 --- a/clients/client-sagemaker/src/SageMakerClient.ts +++ b/clients/client-sagemaker/src/SageMakerClient.ts @@ -70,6 +70,7 @@ import { import { CreateArtifactCommandInput, CreateArtifactCommandOutput } from "./commands/CreateArtifactCommand"; import { CreateAutoMLJobCommandInput, CreateAutoMLJobCommandOutput } from "./commands/CreateAutoMLJobCommand"; import { CreateAutoMLJobV2CommandInput, CreateAutoMLJobV2CommandOutput } from "./commands/CreateAutoMLJobV2Command"; +import { CreateClusterCommandInput, CreateClusterCommandOutput } from "./commands/CreateClusterCommand"; import { CreateCodeRepositoryCommandInput, CreateCodeRepositoryCommandOutput, @@ -116,6 +117,10 @@ import { } from "./commands/CreateHyperParameterTuningJobCommand"; import { CreateImageCommandInput, CreateImageCommandOutput } from "./commands/CreateImageCommand"; import { CreateImageVersionCommandInput, CreateImageVersionCommandOutput } from "./commands/CreateImageVersionCommand"; +import { + CreateInferenceComponentCommandInput, + CreateInferenceComponentCommandOutput, +} from "./commands/CreateInferenceComponentCommand"; import { CreateInferenceExperimentCommandInput, CreateInferenceExperimentCommandOutput, @@ -198,6 +203,7 @@ import { } from "./commands/DeleteAppImageConfigCommand"; import { DeleteArtifactCommandInput, DeleteArtifactCommandOutput } from "./commands/DeleteArtifactCommand"; import { DeleteAssociationCommandInput, DeleteAssociationCommandOutput } from "./commands/DeleteAssociationCommand"; +import { DeleteClusterCommandInput, DeleteClusterCommandOutput } from "./commands/DeleteClusterCommand"; import { DeleteCodeRepositoryCommandInput, DeleteCodeRepositoryCommandOutput, @@ -233,6 +239,10 @@ import { DeleteHubContentCommandInput, DeleteHubContentCommandOutput } from "./c import { DeleteHumanTaskUiCommandInput, DeleteHumanTaskUiCommandOutput } from "./commands/DeleteHumanTaskUiCommand"; import { DeleteImageCommandInput, DeleteImageCommandOutput } from "./commands/DeleteImageCommand"; import { DeleteImageVersionCommandInput, DeleteImageVersionCommandOutput } from "./commands/DeleteImageVersionCommand"; +import { + DeleteInferenceComponentCommandInput, + DeleteInferenceComponentCommandOutput, +} from "./commands/DeleteInferenceComponentCommand"; import { DeleteInferenceExperimentCommandInput, DeleteInferenceExperimentCommandOutput, @@ -302,6 +312,11 @@ import { DescribeAutoMLJobV2CommandInput, DescribeAutoMLJobV2CommandOutput, } from "./commands/DescribeAutoMLJobV2Command"; +import { DescribeClusterCommandInput, DescribeClusterCommandOutput } from "./commands/DescribeClusterCommand"; +import { + DescribeClusterNodeCommandInput, + DescribeClusterNodeCommandOutput, +} from "./commands/DescribeClusterNodeCommand"; import { DescribeCodeRepositoryCommandInput, DescribeCodeRepositoryCommandOutput, @@ -362,6 +377,10 @@ import { DescribeImageVersionCommandInput, DescribeImageVersionCommandOutput, } from "./commands/DescribeImageVersionCommand"; +import { + DescribeInferenceComponentCommandInput, + DescribeInferenceComponentCommandOutput, +} from "./commands/DescribeInferenceComponentCommand"; import { DescribeInferenceExperimentCommandInput, DescribeInferenceExperimentCommandOutput, @@ -510,6 +529,8 @@ import { ListCandidatesForAutoMLJobCommandInput, ListCandidatesForAutoMLJobCommandOutput, } from "./commands/ListCandidatesForAutoMLJobCommand"; +import { ListClusterNodesCommandInput, ListClusterNodesCommandOutput } from "./commands/ListClusterNodesCommand"; +import { ListClustersCommandInput, ListClustersCommandOutput } from "./commands/ListClustersCommand"; import { ListCodeRepositoriesCommandInput, ListCodeRepositoriesCommandOutput, @@ -558,6 +579,10 @@ import { } from "./commands/ListHyperParameterTuningJobsCommand"; import { ListImagesCommandInput, ListImagesCommandOutput } from "./commands/ListImagesCommand"; import { ListImageVersionsCommandInput, ListImageVersionsCommandOutput } from "./commands/ListImageVersionsCommand"; +import { + ListInferenceComponentsCommandInput, + ListInferenceComponentsCommandOutput, +} from "./commands/ListInferenceComponentsCommand"; import { ListInferenceExperimentsCommandInput, ListInferenceExperimentsCommandOutput, @@ -756,6 +781,7 @@ import { UpdateAppImageConfigCommandOutput, } from "./commands/UpdateAppImageConfigCommand"; import { UpdateArtifactCommandInput, UpdateArtifactCommandOutput } from "./commands/UpdateArtifactCommand"; +import { UpdateClusterCommandInput, UpdateClusterCommandOutput } from "./commands/UpdateClusterCommand"; import { UpdateCodeRepositoryCommandInput, UpdateCodeRepositoryCommandOutput, @@ -778,6 +804,14 @@ import { import { UpdateHubCommandInput, UpdateHubCommandOutput } from "./commands/UpdateHubCommand"; import { UpdateImageCommandInput, UpdateImageCommandOutput } from "./commands/UpdateImageCommand"; import { UpdateImageVersionCommandInput, UpdateImageVersionCommandOutput } from "./commands/UpdateImageVersionCommand"; +import { + UpdateInferenceComponentCommandInput, + UpdateInferenceComponentCommandOutput, +} from "./commands/UpdateInferenceComponentCommand"; +import { + UpdateInferenceComponentRuntimeConfigCommandInput, + UpdateInferenceComponentRuntimeConfigCommandOutput, +} from "./commands/UpdateInferenceComponentRuntimeConfigCommand"; import { UpdateInferenceExperimentCommandInput, UpdateInferenceExperimentCommandOutput, @@ -842,6 +876,7 @@ export type ServiceInputTypes = | CreateArtifactCommandInput | CreateAutoMLJobCommandInput | CreateAutoMLJobV2CommandInput + | CreateClusterCommandInput | CreateCodeRepositoryCommandInput | CreateCompilationJobCommandInput | CreateContextCommandInput @@ -861,6 +896,7 @@ export type ServiceInputTypes = | CreateHyperParameterTuningJobCommandInput | CreateImageCommandInput | CreateImageVersionCommandInput + | CreateInferenceComponentCommandInput | CreateInferenceExperimentCommandInput | CreateInferenceRecommendationsJobCommandInput | CreateLabelingJobCommandInput @@ -895,6 +931,7 @@ export type ServiceInputTypes = | DeleteAppImageConfigCommandInput | DeleteArtifactCommandInput | DeleteAssociationCommandInput + | DeleteClusterCommandInput | DeleteCodeRepositoryCommandInput | DeleteContextCommandInput | DeleteDataQualityJobDefinitionCommandInput @@ -912,6 +949,7 @@ export type ServiceInputTypes = | DeleteHumanTaskUiCommandInput | DeleteImageCommandInput | DeleteImageVersionCommandInput + | DeleteInferenceComponentCommandInput | DeleteInferenceExperimentCommandInput | DeleteModelBiasJobDefinitionCommandInput | DeleteModelCardCommandInput @@ -942,6 +980,8 @@ export type ServiceInputTypes = | DescribeArtifactCommandInput | DescribeAutoMLJobCommandInput | DescribeAutoMLJobV2CommandInput + | DescribeClusterCommandInput + | DescribeClusterNodeCommandInput | DescribeCodeRepositoryCommandInput | DescribeCompilationJobCommandInput | DescribeContextCommandInput @@ -963,6 +1003,7 @@ export type ServiceInputTypes = | DescribeHyperParameterTuningJobCommandInput | DescribeImageCommandInput | DescribeImageVersionCommandInput + | DescribeInferenceComponentCommandInput | DescribeInferenceExperimentCommandInput | DescribeInferenceRecommendationsJobCommandInput | DescribeLabelingJobCommandInput @@ -1012,6 +1053,8 @@ export type ServiceInputTypes = | ListAssociationsCommandInput | ListAutoMLJobsCommandInput | ListCandidatesForAutoMLJobCommandInput + | ListClusterNodesCommandInput + | ListClustersCommandInput | ListCodeRepositoriesCommandInput | ListCompilationJobsCommandInput | ListContextsCommandInput @@ -1033,6 +1076,7 @@ export type ServiceInputTypes = | ListHyperParameterTuningJobsCommandInput | ListImageVersionsCommandInput | ListImagesCommandInput + | ListInferenceComponentsCommandInput | ListInferenceExperimentsCommandInput | ListInferenceRecommendationsJobStepsCommandInput | ListInferenceRecommendationsJobsCommandInput @@ -1105,6 +1149,7 @@ export type ServiceInputTypes = | UpdateActionCommandInput | UpdateAppImageConfigCommandInput | UpdateArtifactCommandInput + | UpdateClusterCommandInput | UpdateCodeRepositoryCommandInput | UpdateContextCommandInput | UpdateDeviceFleetCommandInput @@ -1118,6 +1163,8 @@ export type ServiceInputTypes = | UpdateHubCommandInput | UpdateImageCommandInput | UpdateImageVersionCommandInput + | UpdateInferenceComponentCommandInput + | UpdateInferenceComponentRuntimeConfigCommandInput | UpdateInferenceExperimentCommandInput | UpdateModelCardCommandInput | UpdateModelPackageCommandInput @@ -1151,6 +1198,7 @@ export type ServiceOutputTypes = | CreateArtifactCommandOutput | CreateAutoMLJobCommandOutput | CreateAutoMLJobV2CommandOutput + | CreateClusterCommandOutput | CreateCodeRepositoryCommandOutput | CreateCompilationJobCommandOutput | CreateContextCommandOutput @@ -1170,6 +1218,7 @@ export type ServiceOutputTypes = | CreateHyperParameterTuningJobCommandOutput | CreateImageCommandOutput | CreateImageVersionCommandOutput + | CreateInferenceComponentCommandOutput | CreateInferenceExperimentCommandOutput | CreateInferenceRecommendationsJobCommandOutput | CreateLabelingJobCommandOutput @@ -1204,6 +1253,7 @@ export type ServiceOutputTypes = | DeleteAppImageConfigCommandOutput | DeleteArtifactCommandOutput | DeleteAssociationCommandOutput + | DeleteClusterCommandOutput | DeleteCodeRepositoryCommandOutput | DeleteContextCommandOutput | DeleteDataQualityJobDefinitionCommandOutput @@ -1221,6 +1271,7 @@ export type ServiceOutputTypes = | DeleteHumanTaskUiCommandOutput | DeleteImageCommandOutput | DeleteImageVersionCommandOutput + | DeleteInferenceComponentCommandOutput | DeleteInferenceExperimentCommandOutput | DeleteModelBiasJobDefinitionCommandOutput | DeleteModelCardCommandOutput @@ -1251,6 +1302,8 @@ export type ServiceOutputTypes = | DescribeArtifactCommandOutput | DescribeAutoMLJobCommandOutput | DescribeAutoMLJobV2CommandOutput + | DescribeClusterCommandOutput + | DescribeClusterNodeCommandOutput | DescribeCodeRepositoryCommandOutput | DescribeCompilationJobCommandOutput | DescribeContextCommandOutput @@ -1272,6 +1325,7 @@ export type ServiceOutputTypes = | DescribeHyperParameterTuningJobCommandOutput | DescribeImageCommandOutput | DescribeImageVersionCommandOutput + | DescribeInferenceComponentCommandOutput | DescribeInferenceExperimentCommandOutput | DescribeInferenceRecommendationsJobCommandOutput | DescribeLabelingJobCommandOutput @@ -1321,6 +1375,8 @@ export type ServiceOutputTypes = | ListAssociationsCommandOutput | ListAutoMLJobsCommandOutput | ListCandidatesForAutoMLJobCommandOutput + | ListClusterNodesCommandOutput + | ListClustersCommandOutput | ListCodeRepositoriesCommandOutput | ListCompilationJobsCommandOutput | ListContextsCommandOutput @@ -1342,6 +1398,7 @@ export type ServiceOutputTypes = | ListHyperParameterTuningJobsCommandOutput | ListImageVersionsCommandOutput | ListImagesCommandOutput + | ListInferenceComponentsCommandOutput | ListInferenceExperimentsCommandOutput | ListInferenceRecommendationsJobStepsCommandOutput | ListInferenceRecommendationsJobsCommandOutput @@ -1414,6 +1471,7 @@ export type ServiceOutputTypes = | UpdateActionCommandOutput | UpdateAppImageConfigCommandOutput | UpdateArtifactCommandOutput + | UpdateClusterCommandOutput | UpdateCodeRepositoryCommandOutput | UpdateContextCommandOutput | UpdateDeviceFleetCommandOutput @@ -1427,6 +1485,8 @@ export type ServiceOutputTypes = | UpdateHubCommandOutput | UpdateImageCommandOutput | UpdateImageVersionCommandOutput + | UpdateInferenceComponentCommandOutput + | UpdateInferenceComponentRuntimeConfigCommandOutput | UpdateInferenceExperimentCommandOutput | UpdateModelCardCommandOutput | UpdateModelPackageCommandOutput diff --git a/clients/client-sagemaker/src/commands/AddTagsCommand.ts b/clients/client-sagemaker/src/commands/AddTagsCommand.ts index 1b8e60222186..5890c2de3cc5 100644 --- a/clients/client-sagemaker/src/commands/AddTagsCommand.ts +++ b/clients/client-sagemaker/src/commands/AddTagsCommand.ts @@ -54,7 +54,7 @@ export interface AddTagsCommandOutput extends AddTagsOutput, __MetadataBearer {} *

* * - *

Tags that you add to a SageMaker Studio Domain or User Profile by calling this API + *

Tags that you add to a SageMaker Domain or User Profile by calling this API * are also added to any Apps that the Domain or User Profile launches after you call * this API, but not to Apps that the Domain or User Profile launched before you called * this API. To make sure that the tags associated with a Domain or User Profile are diff --git a/clients/client-sagemaker/src/commands/CreateAppCommand.ts b/clients/client-sagemaker/src/commands/CreateAppCommand.ts index 472337993811..06a18162e673 100644 --- a/clients/client-sagemaker/src/commands/CreateAppCommand.ts +++ b/clients/client-sagemaker/src/commands/CreateAppCommand.ts @@ -38,7 +38,7 @@ export interface CreateAppCommandOutput extends CreateAppResponse, __MetadataBea /** * @public *

Creates a running app for the specified UserProfile. This operation is automatically - * invoked by Amazon SageMaker Studio upon access to the associated Domain, and when new kernel + * invoked by Amazon SageMaker upon access to the associated Domain, and when new kernel * configurations are selected by the user. A user may have multiple Apps active simultaneously.

* @example * Use a bare-bones client and the command you need to make an API call. @@ -60,6 +60,7 @@ export interface CreateAppCommandOutput extends CreateAppResponse, __MetadataBea * ResourceSpec: { // ResourceSpec * SageMakerImageArn: "STRING_VALUE", * SageMakerImageVersionArn: "STRING_VALUE", + * SageMakerImageVersionAlias: "STRING_VALUE", * InstanceType: "system" || "ml.t3.micro" || "ml.t3.small" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.8xlarge" || "ml.m5d.12xlarge" || "ml.m5d.16xlarge" || "ml.m5d.24xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.geospatial.interactive" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge", * LifecycleConfigArn: "STRING_VALUE", * }, diff --git a/clients/client-sagemaker/src/commands/CreateAutoMLJobV2Command.ts b/clients/client-sagemaker/src/commands/CreateAutoMLJobV2Command.ts index 6b1de0e9d3f5..7f90e4ce6502 100644 --- a/clients/client-sagemaker/src/commands/CreateAutoMLJobV2Command.ts +++ b/clients/client-sagemaker/src/commands/CreateAutoMLJobV2Command.ts @@ -160,6 +160,9 @@ export interface CreateAutoMLJobV2CommandOutput extends CreateAutoMLJobV2Respons * MaxAutoMLJobRuntimeInSeconds: Number("int"), * }, * BaseModelName: "STRING_VALUE", + * TextGenerationHyperParameters: { // TextGenerationHyperParameters + * "": "STRING_VALUE", + * }, * }, * }, * RoleArn: "STRING_VALUE", // required diff --git a/clients/client-sagemaker/src/commands/CreateClusterCommand.ts b/clients/client-sagemaker/src/commands/CreateClusterCommand.ts new file mode 100644 index 000000000000..820a17a53569 --- /dev/null +++ b/clients/client-sagemaker/src/commands/CreateClusterCommand.ts @@ -0,0 +1,173 @@ +// smithy-typescript generated code +import { EndpointParameterInstructions, getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http"; +import { Command as $Command } from "@smithy/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, + SMITHY_CONTEXT_KEY, +} from "@smithy/types"; + +import { CreateClusterRequest, CreateClusterResponse } from "../models/models_0"; +import { de_CreateClusterCommand, se_CreateClusterCommand } from "../protocols/Aws_json1_1"; +import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link CreateClusterCommand}. + */ +export interface CreateClusterCommandInput extends CreateClusterRequest {} +/** + * @public + * + * The output of {@link CreateClusterCommand}. + */ +export interface CreateClusterCommandOutput extends CreateClusterResponse, __MetadataBearer {} + +/** + * @public + *

Creates a SageMaker HyperPod cluster. SageMaker HyperPod is a capability of SageMaker for creating and managing + * persistent clusters for developing large machine learning models, such as large language + * models (LLMs) and diffusion models. To learn more, see Amazon SageMaker HyperPod in the Amazon SageMaker Developer Guide.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateClusterCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateClusterCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // CreateClusterRequest + * ClusterName: "STRING_VALUE", // required + * InstanceGroups: [ // ClusterInstanceGroupSpecifications // required + * { // ClusterInstanceGroupSpecification + * InstanceCount: Number("int"), // required + * InstanceGroupName: "STRING_VALUE", // required + * InstanceType: "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.12xlarge" || "ml.g5.16xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.c5n.large" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge", // required + * LifeCycleConfig: { // ClusterLifeCycleConfig + * SourceS3Uri: "STRING_VALUE", // required + * OnCreate: "STRING_VALUE", // required + * }, + * ExecutionRole: "STRING_VALUE", // required + * ThreadsPerCore: Number("int"), + * }, + * ], + * VpcConfig: { // VpcConfig + * SecurityGroupIds: [ // VpcSecurityGroupIds // required + * "STRING_VALUE", + * ], + * Subnets: [ // Subnets // required + * "STRING_VALUE", + * ], + * }, + * Tags: [ // TagList + * { // Tag + * Key: "STRING_VALUE", // required + * Value: "STRING_VALUE", // required + * }, + * ], + * }; + * const command = new CreateClusterCommand(input); + * const response = await client.send(command); + * // { // CreateClusterResponse + * // ClusterArn: "STRING_VALUE", // required + * // }; + * + * ``` + * + * @param CreateClusterCommandInput - {@link CreateClusterCommandInput} + * @returns {@link CreateClusterCommandOutput} + * @see {@link CreateClusterCommandInput} for command's `input` shape. + * @see {@link CreateClusterCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for SageMakerClient's `config` shape. + * + * @throws {@link ResourceInUse} (client fault) + *

Resource being accessed is in use.

+ * + * @throws {@link ResourceLimitExceeded} (client fault) + *

You have exceeded an SageMaker resource limit. For example, you might have too many + * training jobs created.

+ * + * @throws {@link SageMakerServiceException} + *

Base exception class for all service exceptions from SageMaker service.

+ * + */ +export class CreateClusterCommand extends $Command< + CreateClusterCommandInput, + CreateClusterCommandOutput, + SageMakerClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: CreateClusterCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack, + configuration: SageMakerClientResolvedConfig, + options?: __HttpHandlerOptions + ): Handler { + this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); + this.middlewareStack.use(getEndpointPlugin(configuration, CreateClusterCommand.getEndpointParameterInstructions())); + + const stack = clientStack.concat(this.middlewareStack); + + const { logger } = configuration; + const clientName = "SageMakerClient"; + const commandName = "CreateClusterCommand"; + const handlerExecutionContext: HandlerExecutionContext = { + logger, + clientName, + commandName, + inputFilterSensitiveLog: (_: any) => _, + outputFilterSensitiveLog: (_: any) => _, + [SMITHY_CONTEXT_KEY]: { + service: "SageMaker", + operation: "CreateCluster", + }, + }; + const { requestHandler } = configuration; + return stack.resolve( + (request: FinalizeHandlerArguments) => + requestHandler.handle(request.request as __HttpRequest, options || {}), + handlerExecutionContext + ); + } + + /** + * @internal + */ + private serialize(input: CreateClusterCommandInput, context: __SerdeContext): Promise<__HttpRequest> { + return se_CreateClusterCommand(input, context); + } + + /** + * @internal + */ + private deserialize(output: __HttpResponse, context: __SerdeContext): Promise { + return de_CreateClusterCommand(output, context); + } +} diff --git a/clients/client-sagemaker/src/commands/CreateDomainCommand.ts b/clients/client-sagemaker/src/commands/CreateDomainCommand.ts index 34eea91e23b2..39f7122e240b 100644 --- a/clients/client-sagemaker/src/commands/CreateDomainCommand.ts +++ b/clients/client-sagemaker/src/commands/CreateDomainCommand.ts @@ -37,7 +37,7 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad /** * @public - *

Creates a Domain used by Amazon SageMaker Studio. A domain consists of an associated + *

Creates a Domain. A domain consists of an associated * Amazon Elastic File System (EFS) volume, a list of authorized users, and a variety of security, application, * policy, and Amazon Virtual Private Cloud (VPC) configurations. * Users within a domain can share notebook files and other artifacts with each other.

@@ -55,10 +55,10 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad *

* VPC configuration *

- *

All SageMaker Studio traffic between the domain and the EFS volume is through the specified - * VPC and subnets. For other Studio traffic, you can specify the AppNetworkAccessType + *

All traffic between the domain and the EFS volume is through the specified + * VPC and subnets. For other traffic, you can specify the AppNetworkAccessType * parameter. AppNetworkAccessType corresponds to the network access type that you - * choose when you onboard to Studio. The following options are available:

+ * choose when you onboard to the domain. The following options are available:

*
    *
  • *

    @@ -67,21 +67,21 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad *

    • *
  • *

    - * VpcOnly - All Studio traffic is through the specified VPC and subnets. + * VpcOnly - All traffic is through the specified VPC and subnets. * Internet access is disabled by default. To allow internet access, you must specify a * NAT gateway.

    - *

    When internet access is disabled, you won't be able to run a Studio notebook or to + *

    When internet access is disabled, you won't be able to run a Amazon SageMaker Studio notebook or to * train or host models unless your VPC has an interface endpoint to the SageMaker API and runtime * or a NAT gateway and your security groups allow outbound connections.

    *
    • *
* *

NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules - * in order to launch a SageMaker Studio app successfully.

+ * in order to launch a Amazon SageMaker Studio app successfully.

* *

For more information, see * Connect - * SageMaker Studio Notebooks to Resources in a VPC.

+ * Amazon SageMaker Studio Notebooks to Resources in a VPC.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -105,6 +105,7 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad * DefaultResourceSpec: { // ResourceSpec * SageMakerImageArn: "STRING_VALUE", * SageMakerImageVersionArn: "STRING_VALUE", + * SageMakerImageVersionAlias: "STRING_VALUE", * InstanceType: "system" || "ml.t3.micro" || "ml.t3.small" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.8xlarge" || "ml.m5d.12xlarge" || "ml.m5d.16xlarge" || "ml.m5d.24xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.geospatial.interactive" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge", * LifecycleConfigArn: "STRING_VALUE", * }, @@ -121,6 +122,7 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad * DefaultResourceSpec: { * SageMakerImageArn: "STRING_VALUE", * SageMakerImageVersionArn: "STRING_VALUE", + * SageMakerImageVersionAlias: "STRING_VALUE", * InstanceType: "system" || "ml.t3.micro" || "ml.t3.small" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.8xlarge" || "ml.m5d.12xlarge" || "ml.m5d.16xlarge" || "ml.m5d.24xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.geospatial.interactive" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge", * LifecycleConfigArn: "STRING_VALUE", * }, @@ -139,6 +141,7 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad * DefaultResourceSpec: { * SageMakerImageArn: "STRING_VALUE", * SageMakerImageVersionArn: "STRING_VALUE", + * SageMakerImageVersionAlias: "STRING_VALUE", * InstanceType: "system" || "ml.t3.micro" || "ml.t3.small" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.8xlarge" || "ml.m5d.12xlarge" || "ml.m5d.16xlarge" || "ml.m5d.24xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.geospatial.interactive" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge", * LifecycleConfigArn: "STRING_VALUE", * }, @@ -151,6 +154,7 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad * DefaultResourceSpec: { * SageMakerImageArn: "STRING_VALUE", * SageMakerImageVersionArn: "STRING_VALUE", + * SageMakerImageVersionAlias: "STRING_VALUE", * InstanceType: "system" || "ml.t3.micro" || "ml.t3.small" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.8xlarge" || "ml.m5d.12xlarge" || "ml.m5d.16xlarge" || "ml.m5d.24xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.geospatial.interactive" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge", * LifecycleConfigArn: "STRING_VALUE", * }, @@ -189,6 +193,8 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad * Status: "ENABLED" || "DISABLED", * }, * }, + * DefaultLandingUri: "STRING_VALUE", + * StudioWebPortal: "ENABLED" || "DISABLED", * }, * SubnetIds: [ // Subnets // required * "STRING_VALUE", @@ -215,6 +221,7 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad * DefaultResourceSpec: { * SageMakerImageArn: "STRING_VALUE", * SageMakerImageVersionArn: "STRING_VALUE", + * SageMakerImageVersionAlias: "STRING_VALUE", * InstanceType: "system" || "ml.t3.micro" || "ml.t3.small" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.8xlarge" || "ml.m5d.12xlarge" || "ml.m5d.16xlarge" || "ml.m5d.24xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.geospatial.interactive" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge", * LifecycleConfigArn: "STRING_VALUE", * }, diff --git a/clients/client-sagemaker/src/commands/CreateEndpointConfigCommand.ts b/clients/client-sagemaker/src/commands/CreateEndpointConfigCommand.ts index 037eab436302..8ed6c14749cf 100644 --- a/clients/client-sagemaker/src/commands/CreateEndpointConfigCommand.ts +++ b/clients/client-sagemaker/src/commands/CreateEndpointConfigCommand.ts @@ -79,7 +79,7 @@ export interface CreateEndpointConfigCommandOutput extends CreateEndpointConfigO * ProductionVariants: [ // ProductionVariantList // required * { // ProductionVariant * VariantName: "STRING_VALUE", // required - * ModelName: "STRING_VALUE", // required + * ModelName: "STRING_VALUE", * InitialInstanceCount: Number("int"), * InstanceType: "ml.t2.medium" || "ml.t2.large" || "ml.t2.xlarge" || "ml.t2.2xlarge" || "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.12xlarge" || "ml.m5d.24xlarge" || "ml.c4.large" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5d.large" || "ml.c5d.xlarge" || "ml.c5d.2xlarge" || "ml.c5d.4xlarge" || "ml.c5d.9xlarge" || "ml.c5d.18xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.12xlarge" || "ml.r5.24xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.12xlarge" || "ml.r5d.24xlarge" || "ml.inf1.xlarge" || "ml.inf1.2xlarge" || "ml.inf1.6xlarge" || "ml.inf1.24xlarge" || "ml.c6i.large" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.4xlarge" || "ml.c6i.8xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.12xlarge" || "ml.g5.16xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.p4d.24xlarge" || "ml.c7g.large" || "ml.c7g.xlarge" || "ml.c7g.2xlarge" || "ml.c7g.4xlarge" || "ml.c7g.8xlarge" || "ml.c7g.12xlarge" || "ml.c7g.16xlarge" || "ml.m6g.large" || "ml.m6g.xlarge" || "ml.m6g.2xlarge" || "ml.m6g.4xlarge" || "ml.m6g.8xlarge" || "ml.m6g.12xlarge" || "ml.m6g.16xlarge" || "ml.m6gd.large" || "ml.m6gd.xlarge" || "ml.m6gd.2xlarge" || "ml.m6gd.4xlarge" || "ml.m6gd.8xlarge" || "ml.m6gd.12xlarge" || "ml.m6gd.16xlarge" || "ml.c6g.large" || "ml.c6g.xlarge" || "ml.c6g.2xlarge" || "ml.c6g.4xlarge" || "ml.c6g.8xlarge" || "ml.c6g.12xlarge" || "ml.c6g.16xlarge" || "ml.c6gd.large" || "ml.c6gd.xlarge" || "ml.c6gd.2xlarge" || "ml.c6gd.4xlarge" || "ml.c6gd.8xlarge" || "ml.c6gd.12xlarge" || "ml.c6gd.16xlarge" || "ml.c6gn.large" || "ml.c6gn.xlarge" || "ml.c6gn.2xlarge" || "ml.c6gn.4xlarge" || "ml.c6gn.8xlarge" || "ml.c6gn.12xlarge" || "ml.c6gn.16xlarge" || "ml.r6g.large" || "ml.r6g.xlarge" || "ml.r6g.2xlarge" || "ml.r6g.4xlarge" || "ml.r6g.8xlarge" || "ml.r6g.12xlarge" || "ml.r6g.16xlarge" || "ml.r6gd.large" || "ml.r6gd.xlarge" || "ml.r6gd.2xlarge" || "ml.r6gd.4xlarge" || "ml.r6gd.8xlarge" || "ml.r6gd.12xlarge" || "ml.r6gd.16xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.inf2.xlarge" || "ml.inf2.8xlarge" || "ml.inf2.24xlarge" || "ml.inf2.48xlarge" || "ml.p5.48xlarge", * InitialVariantWeight: Number("float"), @@ -97,6 +97,14 @@ export interface CreateEndpointConfigCommandOutput extends CreateEndpointConfigO * ModelDataDownloadTimeoutInSeconds: Number("int"), * ContainerStartupHealthCheckTimeoutInSeconds: Number("int"), * EnableSSMAccess: true || false, + * ManagedInstanceScaling: { // ProductionVariantManagedInstanceScaling + * Status: "ENABLED" || "DISABLED", + * MinInstanceCount: Number("int"), + * MaxInstanceCount: Number("int"), + * }, + * RoutingConfig: { // ProductionVariantRoutingConfig + * RoutingStrategy: "LEAST_OUTSTANDING_REQUESTS" || "RANDOM", // required + * }, * }, * ], * DataCaptureConfig: { // DataCaptureConfig @@ -183,7 +191,7 @@ export interface CreateEndpointConfigCommandOutput extends CreateEndpointConfigO * ShadowProductionVariants: [ * { * VariantName: "STRING_VALUE", // required - * ModelName: "STRING_VALUE", // required + * ModelName: "STRING_VALUE", * InitialInstanceCount: Number("int"), * InstanceType: "ml.t2.medium" || "ml.t2.large" || "ml.t2.xlarge" || "ml.t2.2xlarge" || "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.12xlarge" || "ml.m5d.24xlarge" || "ml.c4.large" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5d.large" || "ml.c5d.xlarge" || "ml.c5d.2xlarge" || "ml.c5d.4xlarge" || "ml.c5d.9xlarge" || "ml.c5d.18xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.12xlarge" || "ml.r5.24xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.12xlarge" || "ml.r5d.24xlarge" || "ml.inf1.xlarge" || "ml.inf1.2xlarge" || "ml.inf1.6xlarge" || "ml.inf1.24xlarge" || "ml.c6i.large" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.4xlarge" || "ml.c6i.8xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.12xlarge" || "ml.g5.16xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.p4d.24xlarge" || "ml.c7g.large" || "ml.c7g.xlarge" || "ml.c7g.2xlarge" || "ml.c7g.4xlarge" || "ml.c7g.8xlarge" || "ml.c7g.12xlarge" || "ml.c7g.16xlarge" || "ml.m6g.large" || "ml.m6g.xlarge" || "ml.m6g.2xlarge" || "ml.m6g.4xlarge" || "ml.m6g.8xlarge" || "ml.m6g.12xlarge" || "ml.m6g.16xlarge" || "ml.m6gd.large" || "ml.m6gd.xlarge" || "ml.m6gd.2xlarge" || "ml.m6gd.4xlarge" || "ml.m6gd.8xlarge" || "ml.m6gd.12xlarge" || "ml.m6gd.16xlarge" || "ml.c6g.large" || "ml.c6g.xlarge" || "ml.c6g.2xlarge" || "ml.c6g.4xlarge" || "ml.c6g.8xlarge" || "ml.c6g.12xlarge" || "ml.c6g.16xlarge" || "ml.c6gd.large" || "ml.c6gd.xlarge" || "ml.c6gd.2xlarge" || "ml.c6gd.4xlarge" || "ml.c6gd.8xlarge" || "ml.c6gd.12xlarge" || "ml.c6gd.16xlarge" || "ml.c6gn.large" || "ml.c6gn.xlarge" || "ml.c6gn.2xlarge" || "ml.c6gn.4xlarge" || "ml.c6gn.8xlarge" || "ml.c6gn.12xlarge" || "ml.c6gn.16xlarge" || "ml.r6g.large" || "ml.r6g.xlarge" || "ml.r6g.2xlarge" || "ml.r6g.4xlarge" || "ml.r6g.8xlarge" || "ml.r6g.12xlarge" || "ml.r6g.16xlarge" || "ml.r6gd.large" || "ml.r6gd.xlarge" || "ml.r6gd.2xlarge" || "ml.r6gd.4xlarge" || "ml.r6gd.8xlarge" || "ml.r6gd.12xlarge" || "ml.r6gd.16xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.inf2.xlarge" || "ml.inf2.8xlarge" || "ml.inf2.24xlarge" || "ml.inf2.48xlarge" || "ml.p5.48xlarge", * InitialVariantWeight: Number("float"), @@ -201,8 +209,26 @@ export interface CreateEndpointConfigCommandOutput extends CreateEndpointConfigO * ModelDataDownloadTimeoutInSeconds: Number("int"), * ContainerStartupHealthCheckTimeoutInSeconds: Number("int"), * EnableSSMAccess: true || false, + * ManagedInstanceScaling: { + * Status: "ENABLED" || "DISABLED", + * MinInstanceCount: Number("int"), + * MaxInstanceCount: Number("int"), + * }, + * RoutingConfig: { + * RoutingStrategy: "LEAST_OUTSTANDING_REQUESTS" || "RANDOM", // required + * }, * }, * ], + * ExecutionRoleArn: "STRING_VALUE", + * VpcConfig: { // VpcConfig + * SecurityGroupIds: [ // VpcSecurityGroupIds // required + * "STRING_VALUE", + * ], + * Subnets: [ // Subnets // required + * "STRING_VALUE", + * ], + * }, + * EnableNetworkIsolation: true || false, * }; * const command = new CreateEndpointConfigCommand(input); * const response = await client.send(command); diff --git a/clients/client-sagemaker/src/commands/CreateInferenceComponentCommand.ts b/clients/client-sagemaker/src/commands/CreateInferenceComponentCommand.ts new file mode 100644 index 000000000000..2ac6cdab6f95 --- /dev/null +++ b/clients/client-sagemaker/src/commands/CreateInferenceComponentCommand.ts @@ -0,0 +1,181 @@ +// smithy-typescript generated code +import { EndpointParameterInstructions, getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http"; +import { Command as $Command } from "@smithy/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, + SMITHY_CONTEXT_KEY, +} from "@smithy/types"; + +import { CreateInferenceComponentInput, CreateInferenceComponentOutput } from "../models/models_1"; +import { de_CreateInferenceComponentCommand, se_CreateInferenceComponentCommand } from "../protocols/Aws_json1_1"; +import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link CreateInferenceComponentCommand}. + */ +export interface CreateInferenceComponentCommandInput extends CreateInferenceComponentInput {} +/** + * @public + * + * The output of {@link CreateInferenceComponentCommand}. + */ +export interface CreateInferenceComponentCommandOutput extends CreateInferenceComponentOutput, __MetadataBearer {} + +/** + * @public + *

Creates an inference component, which is a SageMaker hosting object that you can + * use to deploy a model to an endpoint. In the inference component settings, you specify the + * model, the endpoint, and how the model utilizes the resources that the endpoint hosts. You + * can optimize resource utilization by tailoring how the required CPU cores, accelerators, + * and memory are allocated. You can deploy multiple inference components to an endpoint, + * where each inference component contains one model and the resource utilization needs for + * that individual model. After you deploy an inference component, you can directly invoke the + * associated model when you use the InvokeEndpoint API action.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateInferenceComponentCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateInferenceComponentCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // CreateInferenceComponentInput + * InferenceComponentName: "STRING_VALUE", // required + * EndpointName: "STRING_VALUE", // required + * VariantName: "STRING_VALUE", // required + * Specification: { // InferenceComponentSpecification + * ModelName: "STRING_VALUE", + * Container: { // InferenceComponentContainerSpecification + * Image: "STRING_VALUE", + * ArtifactUrl: "STRING_VALUE", + * Environment: { // EnvironmentMap + * "": "STRING_VALUE", + * }, + * }, + * StartupParameters: { // InferenceComponentStartupParameters + * ModelDataDownloadTimeoutInSeconds: Number("int"), + * ContainerStartupHealthCheckTimeoutInSeconds: Number("int"), + * }, + * ComputeResourceRequirements: { // InferenceComponentComputeResourceRequirements + * NumberOfCpuCoresRequired: Number("float"), + * NumberOfAcceleratorDevicesRequired: Number("float"), + * MinMemoryRequiredInMb: Number("int"), // required + * MaxMemoryRequiredInMb: Number("int"), + * }, + * }, + * RuntimeConfig: { // InferenceComponentRuntimeConfig + * CopyCount: Number("int"), // required + * }, + * Tags: [ // TagList + * { // Tag + * Key: "STRING_VALUE", // required + * Value: "STRING_VALUE", // required + * }, + * ], + * }; + * const command = new CreateInferenceComponentCommand(input); + * const response = await client.send(command); + * // { // CreateInferenceComponentOutput + * // InferenceComponentArn: "STRING_VALUE", // required + * // }; + * + * ``` + * + * @param CreateInferenceComponentCommandInput - {@link CreateInferenceComponentCommandInput} + * @returns {@link CreateInferenceComponentCommandOutput} + * @see {@link CreateInferenceComponentCommandInput} for command's `input` shape. + * @see {@link CreateInferenceComponentCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for SageMakerClient's `config` shape. + * + * @throws {@link ResourceLimitExceeded} (client fault) + *

You have exceeded an SageMaker resource limit. For example, you might have too many + * training jobs created.

+ * + * @throws {@link SageMakerServiceException} + *

Base exception class for all service exceptions from SageMaker service.

+ * + */ +export class CreateInferenceComponentCommand extends $Command< + CreateInferenceComponentCommandInput, + CreateInferenceComponentCommandOutput, + SageMakerClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: CreateInferenceComponentCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack, + configuration: SageMakerClientResolvedConfig, + options?: __HttpHandlerOptions + ): Handler { + this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); + this.middlewareStack.use( + getEndpointPlugin(configuration, CreateInferenceComponentCommand.getEndpointParameterInstructions()) + ); + + const stack = clientStack.concat(this.middlewareStack); + + const { logger } = configuration; + const clientName = "SageMakerClient"; + const commandName = "CreateInferenceComponentCommand"; + const handlerExecutionContext: HandlerExecutionContext = { + logger, + clientName, + commandName, + inputFilterSensitiveLog: (_: any) => _, + outputFilterSensitiveLog: (_: any) => _, + [SMITHY_CONTEXT_KEY]: { + service: "SageMaker", + operation: "CreateInferenceComponent", + }, + }; + const { requestHandler } = configuration; + return stack.resolve( + (request: FinalizeHandlerArguments) => + requestHandler.handle(request.request as __HttpRequest, options || {}), + handlerExecutionContext + ); + } + + /** + * @internal + */ + private serialize(input: CreateInferenceComponentCommandInput, context: __SerdeContext): Promise<__HttpRequest> { + return se_CreateInferenceComponentCommand(input, context); + } + + /** + * @internal + */ + private deserialize(output: __HttpResponse, context: __SerdeContext): Promise { + return de_CreateInferenceComponentCommand(output, context); + } +} diff --git a/clients/client-sagemaker/src/commands/CreateModelCommand.ts b/clients/client-sagemaker/src/commands/CreateModelCommand.ts index c7a0809dbb54..8acf901300fd 100644 --- a/clients/client-sagemaker/src/commands/CreateModelCommand.ts +++ b/clients/client-sagemaker/src/commands/CreateModelCommand.ts @@ -130,7 +130,7 @@ export interface CreateModelCommandOutput extends CreateModelOutput, __MetadataB * InferenceExecutionConfig: { // InferenceExecutionConfig * Mode: "Serial" || "Direct", // required * }, - * ExecutionRoleArn: "STRING_VALUE", // required + * ExecutionRoleArn: "STRING_VALUE", * Tags: [ // TagList * { // Tag * Key: "STRING_VALUE", // required diff --git a/clients/client-sagemaker/src/commands/CreatePresignedDomainUrlCommand.ts b/clients/client-sagemaker/src/commands/CreatePresignedDomainUrlCommand.ts index 6d01773fc12b..edefa4924771 100644 --- a/clients/client-sagemaker/src/commands/CreatePresignedDomainUrlCommand.ts +++ b/clients/client-sagemaker/src/commands/CreatePresignedDomainUrlCommand.ts @@ -38,7 +38,7 @@ export interface CreatePresignedDomainUrlCommandOutput extends CreatePresignedDo /** * @public *

Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, - * the user will be automatically signed in to Amazon SageMaker Studio, and granted access to all of + * the user will be automatically signed in to the domain, and granted access to all of * the Apps and files associated with the Domain's Amazon Elastic File System (EFS) volume. * This operation can only be called when the authentication mode equals IAM. *

@@ -48,7 +48,7 @@ export interface CreatePresignedDomainUrlCommandOutput extends CreatePresignedDo * frame that attempts to connect to the app.

*

You can restrict access to this API and to the * URL that it returns to a list of IP addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more - * information, see Connect to SageMaker Studio Through an Interface VPC Endpoint + * information, see Connect to Amazon SageMaker Studio Through an Interface VPC Endpoint * .

* *

The URL that you get from a call to CreatePresignedDomainUrl has a default timeout of 5 minutes. You can configure this value using ExpiresInSeconds. If you try to use the URL after the timeout limit expires, you @@ -66,6 +66,7 @@ export interface CreatePresignedDomainUrlCommandOutput extends CreatePresignedDo * SessionExpirationDurationInSeconds: Number("int"), * ExpiresInSeconds: Number("int"), * SpaceName: "STRING_VALUE", + * LandingUri: "STRING_VALUE", * }; * const command = new CreatePresignedDomainUrlCommand(input); * const response = await client.send(command); diff --git a/clients/client-sagemaker/src/commands/CreateSpaceCommand.ts b/clients/client-sagemaker/src/commands/CreateSpaceCommand.ts index eceaccb03224..d45f1623b127 100644 --- a/clients/client-sagemaker/src/commands/CreateSpaceCommand.ts +++ b/clients/client-sagemaker/src/commands/CreateSpaceCommand.ts @@ -58,6 +58,7 @@ export interface CreateSpaceCommandOutput extends CreateSpaceResponse, __Metadat * DefaultResourceSpec: { // ResourceSpec * SageMakerImageArn: "STRING_VALUE", * SageMakerImageVersionArn: "STRING_VALUE", + * SageMakerImageVersionAlias: "STRING_VALUE", * InstanceType: "system" || "ml.t3.micro" || "ml.t3.small" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.8xlarge" || "ml.m5d.12xlarge" || "ml.m5d.16xlarge" || "ml.m5d.24xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.geospatial.interactive" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge", * LifecycleConfigArn: "STRING_VALUE", * }, @@ -74,6 +75,7 @@ export interface CreateSpaceCommandOutput extends CreateSpaceResponse, __Metadat * DefaultResourceSpec: { * SageMakerImageArn: "STRING_VALUE", * SageMakerImageVersionArn: "STRING_VALUE", + * SageMakerImageVersionAlias: "STRING_VALUE", * InstanceType: "system" || "ml.t3.micro" || "ml.t3.small" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.8xlarge" || "ml.m5d.12xlarge" || "ml.m5d.16xlarge" || "ml.m5d.24xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.geospatial.interactive" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge", * LifecycleConfigArn: "STRING_VALUE", * }, diff --git a/clients/client-sagemaker/src/commands/CreateStudioLifecycleConfigCommand.ts b/clients/client-sagemaker/src/commands/CreateStudioLifecycleConfigCommand.ts index 600754093e3a..59fafecc6c63 100644 --- a/clients/client-sagemaker/src/commands/CreateStudioLifecycleConfigCommand.ts +++ b/clients/client-sagemaker/src/commands/CreateStudioLifecycleConfigCommand.ts @@ -39,7 +39,7 @@ export interface CreateStudioLifecycleConfigCommandOutput /** * @public - *

Creates a new Studio Lifecycle Configuration.

+ *

Creates a new Amazon SageMaker Studio Lifecycle Configuration.

* @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/CreateTrainingJobCommand.ts b/clients/client-sagemaker/src/commands/CreateTrainingJobCommand.ts index 81ec6762d64b..b853e4e0eabf 100644 --- a/clients/client-sagemaker/src/commands/CreateTrainingJobCommand.ts +++ b/clients/client-sagemaker/src/commands/CreateTrainingJobCommand.ts @@ -292,6 +292,9 @@ export interface CreateTrainingJobCommandOutput extends CreateTrainingJobRespons * RetryStrategy: { // RetryStrategy * MaximumRetryAttempts: Number("int"), // required * }, + * InfraCheckConfig: { // InfraCheckConfig + * EnableInfraCheck: true || false, + * }, * }; * const command = new CreateTrainingJobCommand(input); * const response = await client.send(command); diff --git a/clients/client-sagemaker/src/commands/CreateUserProfileCommand.ts b/clients/client-sagemaker/src/commands/CreateUserProfileCommand.ts index 8b2e556205fa..bf139b4f4984 100644 --- a/clients/client-sagemaker/src/commands/CreateUserProfileCommand.ts +++ b/clients/client-sagemaker/src/commands/CreateUserProfileCommand.ts @@ -14,7 +14,8 @@ import { SMITHY_CONTEXT_KEY, } from "@smithy/types"; -import { CreateUserProfileRequest, CreateUserProfileResponse } from "../models/models_1"; +import { CreateUserProfileRequest } from "../models/models_1"; +import { CreateUserProfileResponse } from "../models/models_2"; import { de_CreateUserProfileCommand, se_CreateUserProfileCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; @@ -39,7 +40,7 @@ export interface CreateUserProfileCommandOutput extends CreateUserProfileRespons * @public *

Creates a user profile. A user profile represents a single user within a domain, and is * the main way to reference a "person" for the purposes of sharing, reporting, and other - * user-oriented features. This entity is created when a user onboards to Amazon SageMaker Studio. If an + * user-oriented features. This entity is created when a user onboards to a domain. If an * administrator invites a person by email or imports them from IAM Identity Center, a user profile is * automatically created. A user profile is the primary holder of settings for an individual * user and has a reference to the user's private Amazon Elastic File System (EFS) home directory. @@ -75,6 +76,7 @@ export interface CreateUserProfileCommandOutput extends CreateUserProfileRespons * DefaultResourceSpec: { // ResourceSpec * SageMakerImageArn: "STRING_VALUE", * SageMakerImageVersionArn: "STRING_VALUE", + * SageMakerImageVersionAlias: "STRING_VALUE", * InstanceType: "system" || "ml.t3.micro" || "ml.t3.small" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.8xlarge" || "ml.m5d.12xlarge" || "ml.m5d.16xlarge" || "ml.m5d.24xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.geospatial.interactive" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge", * LifecycleConfigArn: "STRING_VALUE", * }, @@ -91,6 +93,7 @@ export interface CreateUserProfileCommandOutput extends CreateUserProfileRespons * DefaultResourceSpec: { * SageMakerImageArn: "STRING_VALUE", * SageMakerImageVersionArn: "STRING_VALUE", + * SageMakerImageVersionAlias: "STRING_VALUE", * InstanceType: "system" || "ml.t3.micro" || "ml.t3.small" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.8xlarge" || "ml.m5d.12xlarge" || "ml.m5d.16xlarge" || "ml.m5d.24xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.geospatial.interactive" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge", * LifecycleConfigArn: "STRING_VALUE", * }, @@ -109,6 +112,7 @@ export interface CreateUserProfileCommandOutput extends CreateUserProfileRespons * DefaultResourceSpec: { * SageMakerImageArn: "STRING_VALUE", * SageMakerImageVersionArn: "STRING_VALUE", + * SageMakerImageVersionAlias: "STRING_VALUE", * InstanceType: "system" || "ml.t3.micro" || "ml.t3.small" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.8xlarge" || "ml.m5d.12xlarge" || "ml.m5d.16xlarge" || "ml.m5d.24xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.geospatial.interactive" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge", * LifecycleConfigArn: "STRING_VALUE", * }, @@ -121,6 +125,7 @@ export interface CreateUserProfileCommandOutput extends CreateUserProfileRespons * DefaultResourceSpec: { * SageMakerImageArn: "STRING_VALUE", * SageMakerImageVersionArn: "STRING_VALUE", + * SageMakerImageVersionAlias: "STRING_VALUE", * InstanceType: "system" || "ml.t3.micro" || "ml.t3.small" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.8xlarge" || "ml.m5d.12xlarge" || "ml.m5d.16xlarge" || "ml.m5d.24xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.geospatial.interactive" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge", * LifecycleConfigArn: "STRING_VALUE", * }, @@ -159,6 +164,8 @@ export interface CreateUserProfileCommandOutput extends CreateUserProfileRespons * Status: "ENABLED" || "DISABLED", * }, * }, + * DefaultLandingUri: "STRING_VALUE", + * StudioWebPortal: "ENABLED" || "DISABLED", * }, * }; * const command = new CreateUserProfileCommand(input); diff --git a/clients/client-sagemaker/src/commands/CreateWorkforceCommand.ts b/clients/client-sagemaker/src/commands/CreateWorkforceCommand.ts index 1e08395162d4..25e892a7a0b8 100644 --- a/clients/client-sagemaker/src/commands/CreateWorkforceCommand.ts +++ b/clients/client-sagemaker/src/commands/CreateWorkforceCommand.ts @@ -18,7 +18,7 @@ import { CreateWorkforceRequest, CreateWorkforceRequestFilterSensitiveLog, CreateWorkforceResponse, -} from "../models/models_1"; +} from "../models/models_2"; import { de_CreateWorkforceCommand, se_CreateWorkforceCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/CreateWorkteamCommand.ts b/clients/client-sagemaker/src/commands/CreateWorkteamCommand.ts index aa212774dee5..7f11fd48ef58 100644 --- a/clients/client-sagemaker/src/commands/CreateWorkteamCommand.ts +++ b/clients/client-sagemaker/src/commands/CreateWorkteamCommand.ts @@ -14,7 +14,7 @@ import { SMITHY_CONTEXT_KEY, } from "@smithy/types"; -import { CreateWorkteamRequest, CreateWorkteamResponse } from "../models/models_1"; +import { CreateWorkteamRequest, CreateWorkteamResponse } from "../models/models_2"; import { de_CreateWorkteamCommand, se_CreateWorkteamCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/DeleteActionCommand.ts b/clients/client-sagemaker/src/commands/DeleteActionCommand.ts index 45d91ef50a42..70dcf0057901 100644 --- a/clients/client-sagemaker/src/commands/DeleteActionCommand.ts +++ b/clients/client-sagemaker/src/commands/DeleteActionCommand.ts @@ -14,7 +14,7 @@ import { SMITHY_CONTEXT_KEY, } from "@smithy/types"; -import { DeleteActionRequest, DeleteActionResponse } from "../models/models_1"; +import { DeleteActionRequest, DeleteActionResponse } from "../models/models_2"; import { de_DeleteActionCommand, se_DeleteActionCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/DeleteAlgorithmCommand.ts b/clients/client-sagemaker/src/commands/DeleteAlgorithmCommand.ts index 77a2d9e8eb4c..d0de597d411c 100644 --- a/clients/client-sagemaker/src/commands/DeleteAlgorithmCommand.ts +++ b/clients/client-sagemaker/src/commands/DeleteAlgorithmCommand.ts @@ -14,7 +14,7 @@ import { SMITHY_CONTEXT_KEY, } from "@smithy/types"; -import { DeleteAlgorithmInput } from "../models/models_1"; +import { DeleteAlgorithmInput } from "../models/models_2"; import { de_DeleteAlgorithmCommand, se_DeleteAlgorithmCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/DeleteAppCommand.ts b/clients/client-sagemaker/src/commands/DeleteAppCommand.ts index 2517c3a9f07c..614f535df8fa 100644 --- a/clients/client-sagemaker/src/commands/DeleteAppCommand.ts +++ b/clients/client-sagemaker/src/commands/DeleteAppCommand.ts @@ -14,7 +14,7 @@ import { SMITHY_CONTEXT_KEY, } from "@smithy/types"; -import { DeleteAppRequest } from "../models/models_1"; +import { DeleteAppRequest } from "../models/models_2"; import { de_DeleteAppCommand, se_DeleteAppCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/DeleteAppImageConfigCommand.ts b/clients/client-sagemaker/src/commands/DeleteAppImageConfigCommand.ts index f7fc5a839796..27c2a37cc3dc 100644 --- a/clients/client-sagemaker/src/commands/DeleteAppImageConfigCommand.ts +++ b/clients/client-sagemaker/src/commands/DeleteAppImageConfigCommand.ts @@ -14,7 +14,7 @@ import { SMITHY_CONTEXT_KEY, } from "@smithy/types"; -import { DeleteAppImageConfigRequest } from "../models/models_1"; +import { DeleteAppImageConfigRequest } from "../models/models_2"; import { de_DeleteAppImageConfigCommand, se_DeleteAppImageConfigCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/DeleteArtifactCommand.ts b/clients/client-sagemaker/src/commands/DeleteArtifactCommand.ts index 5431c3102ac6..e1c82c9671a7 100644 --- a/clients/client-sagemaker/src/commands/DeleteArtifactCommand.ts +++ b/clients/client-sagemaker/src/commands/DeleteArtifactCommand.ts @@ -14,7 +14,7 @@ import { SMITHY_CONTEXT_KEY, } from "@smithy/types"; -import { DeleteArtifactRequest, DeleteArtifactResponse } from "../models/models_1"; +import { DeleteArtifactRequest, DeleteArtifactResponse } from "../models/models_2"; import { de_DeleteArtifactCommand, se_DeleteArtifactCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/DeleteAssociationCommand.ts b/clients/client-sagemaker/src/commands/DeleteAssociationCommand.ts index 5afec77e22d7..398c6b9b96cd 100644 --- a/clients/client-sagemaker/src/commands/DeleteAssociationCommand.ts +++ b/clients/client-sagemaker/src/commands/DeleteAssociationCommand.ts @@ -14,7 +14,7 @@ import { SMITHY_CONTEXT_KEY, } from "@smithy/types"; -import { DeleteAssociationRequest, DeleteAssociationResponse } from "../models/models_1"; +import { DeleteAssociationRequest, DeleteAssociationResponse } from "../models/models_2"; import { de_DeleteAssociationCommand, se_DeleteAssociationCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/DeleteClusterCommand.ts b/clients/client-sagemaker/src/commands/DeleteClusterCommand.ts new file mode 100644 index 000000000000..bba4067b5d63 --- /dev/null +++ b/clients/client-sagemaker/src/commands/DeleteClusterCommand.ts @@ -0,0 +1,144 @@ +// smithy-typescript generated code +import { EndpointParameterInstructions, getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http"; +import { Command as $Command } from "@smithy/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, + SMITHY_CONTEXT_KEY, +} from "@smithy/types"; + +import { DeleteClusterRequest, DeleteClusterResponse } from "../models/models_2"; +import { de_DeleteClusterCommand, se_DeleteClusterCommand } from "../protocols/Aws_json1_1"; +import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link DeleteClusterCommand}. + */ +export interface DeleteClusterCommandInput extends DeleteClusterRequest {} +/** + * @public + * + * The output of {@link DeleteClusterCommand}. + */ +export interface DeleteClusterCommandOutput extends DeleteClusterResponse, __MetadataBearer {} + +/** + * @public + *

Delete a SageMaker HyperPod cluster.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteClusterCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteClusterCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // DeleteClusterRequest + * ClusterName: "STRING_VALUE", // required + * }; + * const command = new DeleteClusterCommand(input); + * const response = await client.send(command); + * // { // DeleteClusterResponse + * // ClusterArn: "STRING_VALUE", // required + * // }; + * + * ``` + * + * @param DeleteClusterCommandInput - {@link DeleteClusterCommandInput} + * @returns {@link DeleteClusterCommandOutput} + * @see {@link DeleteClusterCommandInput} for command's `input` shape. + * @see {@link DeleteClusterCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for SageMakerClient's `config` shape. + * + * @throws {@link ConflictException} (client fault) + *

There was a conflict when you attempted to modify a SageMaker entity such as an + * Experiment or Artifact.

+ * + * @throws {@link ResourceNotFound} (client fault) + *

Resource being access is not found.

+ * + * @throws {@link SageMakerServiceException} + *

Base exception class for all service exceptions from SageMaker service.

+ * + */ +export class DeleteClusterCommand extends $Command< + DeleteClusterCommandInput, + DeleteClusterCommandOutput, + SageMakerClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DeleteClusterCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack, + configuration: SageMakerClientResolvedConfig, + options?: __HttpHandlerOptions + ): Handler { + this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); + this.middlewareStack.use(getEndpointPlugin(configuration, DeleteClusterCommand.getEndpointParameterInstructions())); + + const stack = clientStack.concat(this.middlewareStack); + + const { logger } = configuration; + const clientName = "SageMakerClient"; + const commandName = "DeleteClusterCommand"; + const handlerExecutionContext: HandlerExecutionContext = { + logger, + clientName, + commandName, + inputFilterSensitiveLog: (_: any) => _, + outputFilterSensitiveLog: (_: any) => _, + [SMITHY_CONTEXT_KEY]: { + service: "SageMaker", + operation: "DeleteCluster", + }, + }; + const { requestHandler } = configuration; + return stack.resolve( + (request: FinalizeHandlerArguments) => + requestHandler.handle(request.request as __HttpRequest, options || {}), + handlerExecutionContext + ); + } + + /** + * @internal + */ + private serialize(input: DeleteClusterCommandInput, context: __SerdeContext): Promise<__HttpRequest> { + return se_DeleteClusterCommand(input, context); + } + + /** + * @internal + */ + private deserialize(output: __HttpResponse, context: __SerdeContext): Promise { + return de_DeleteClusterCommand(output, context); + } +} diff --git a/clients/client-sagemaker/src/commands/DeleteInferenceComponentCommand.ts b/clients/client-sagemaker/src/commands/DeleteInferenceComponentCommand.ts new file mode 100644 index 000000000000..4ebcd760ce03 --- /dev/null +++ b/clients/client-sagemaker/src/commands/DeleteInferenceComponentCommand.ts @@ -0,0 +1,137 @@ +// smithy-typescript generated code +import { EndpointParameterInstructions, getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http"; +import { Command as $Command } from "@smithy/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, + SMITHY_CONTEXT_KEY, +} from "@smithy/types"; + +import { DeleteInferenceComponentInput } from "../models/models_2"; +import { de_DeleteInferenceComponentCommand, se_DeleteInferenceComponentCommand } from "../protocols/Aws_json1_1"; +import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link DeleteInferenceComponentCommand}. + */ +export interface DeleteInferenceComponentCommandInput extends DeleteInferenceComponentInput {} +/** + * @public + * + * The output of {@link DeleteInferenceComponentCommand}. + */ +export interface DeleteInferenceComponentCommandOutput extends __MetadataBearer {} + +/** + * @public + *

Deletes an inference component.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteInferenceComponentCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteInferenceComponentCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // DeleteInferenceComponentInput + * InferenceComponentName: "STRING_VALUE", // required + * }; + * const command = new DeleteInferenceComponentCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param DeleteInferenceComponentCommandInput - {@link DeleteInferenceComponentCommandInput} + * @returns {@link DeleteInferenceComponentCommandOutput} + * @see {@link DeleteInferenceComponentCommandInput} for command's `input` shape. + * @see {@link DeleteInferenceComponentCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for SageMakerClient's `config` shape. + * + * @throws {@link SageMakerServiceException} + *

Base exception class for all service exceptions from SageMaker service.

+ * + */ +export class DeleteInferenceComponentCommand extends $Command< + DeleteInferenceComponentCommandInput, + DeleteInferenceComponentCommandOutput, + SageMakerClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DeleteInferenceComponentCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack, + configuration: SageMakerClientResolvedConfig, + options?: __HttpHandlerOptions + ): Handler { + this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); + this.middlewareStack.use( + getEndpointPlugin(configuration, DeleteInferenceComponentCommand.getEndpointParameterInstructions()) + ); + + const stack = clientStack.concat(this.middlewareStack); + + const { logger } = configuration; + const clientName = "SageMakerClient"; + const commandName = "DeleteInferenceComponentCommand"; + const handlerExecutionContext: HandlerExecutionContext = { + logger, + clientName, + commandName, + inputFilterSensitiveLog: (_: any) => _, + outputFilterSensitiveLog: (_: any) => _, + [SMITHY_CONTEXT_KEY]: { + service: "SageMaker", + operation: "DeleteInferenceComponent", + }, + }; + const { requestHandler } = configuration; + return stack.resolve( + (request: FinalizeHandlerArguments) => + requestHandler.handle(request.request as __HttpRequest, options || {}), + handlerExecutionContext + ); + } + + /** + * @internal + */ + private serialize(input: DeleteInferenceComponentCommandInput, context: __SerdeContext): Promise<__HttpRequest> { + return se_DeleteInferenceComponentCommand(input, context); + } + + /** + * @internal + */ + private deserialize(output: __HttpResponse, context: __SerdeContext): Promise { + return de_DeleteInferenceComponentCommand(output, context); + } +} diff --git a/clients/client-sagemaker/src/commands/DeleteStudioLifecycleConfigCommand.ts b/clients/client-sagemaker/src/commands/DeleteStudioLifecycleConfigCommand.ts index 4c5fa9f8218c..d83032ac6f09 100644 --- a/clients/client-sagemaker/src/commands/DeleteStudioLifecycleConfigCommand.ts +++ b/clients/client-sagemaker/src/commands/DeleteStudioLifecycleConfigCommand.ts @@ -37,7 +37,7 @@ export interface DeleteStudioLifecycleConfigCommandOutput extends __MetadataBear /** * @public - *

Deletes the Studio Lifecycle Configuration. In order to delete the Lifecycle Configuration, there must be no running apps using the Lifecycle Configuration. You must also remove the Lifecycle Configuration from UserSettings in all Domains and UserProfiles.

+ *

Deletes the Amazon SageMaker Studio Lifecycle Configuration. In order to delete the Lifecycle Configuration, there must be no running apps using the Lifecycle Configuration. You must also remove the Lifecycle Configuration from UserSettings in all Domains and UserProfiles.

* @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/DeleteTagsCommand.ts b/clients/client-sagemaker/src/commands/DeleteTagsCommand.ts index 51195e10d790..6d010368d43a 100644 --- a/clients/client-sagemaker/src/commands/DeleteTagsCommand.ts +++ b/clients/client-sagemaker/src/commands/DeleteTagsCommand.ts @@ -45,8 +45,8 @@ export interface DeleteTagsCommandOutput extends DeleteTagsOutput, __MetadataBea * launched before you called this API.

* * - *

When you call this API to delete tags from a SageMaker Studio Domain or User - * Profile, the deleted tags are not removed from Apps that the SageMaker Studio Domain + *

When you call this API to delete tags from a SageMaker Domain or User + * Profile, the deleted tags are not removed from Apps that the SageMaker Domain * or User Profile launched before you called this API.

* * @example diff --git a/clients/client-sagemaker/src/commands/DescribeAppCommand.ts b/clients/client-sagemaker/src/commands/DescribeAppCommand.ts index 8b4df868b4b0..419f14df1404 100644 --- a/clients/client-sagemaker/src/commands/DescribeAppCommand.ts +++ b/clients/client-sagemaker/src/commands/DescribeAppCommand.ts @@ -67,6 +67,7 @@ export interface DescribeAppCommandOutput extends DescribeAppResponse, __Metadat * // ResourceSpec: { // ResourceSpec * // SageMakerImageArn: "STRING_VALUE", * // SageMakerImageVersionArn: "STRING_VALUE", + * // SageMakerImageVersionAlias: "STRING_VALUE", * // InstanceType: "system" || "ml.t3.micro" || "ml.t3.small" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.8xlarge" || "ml.m5d.12xlarge" || "ml.m5d.16xlarge" || "ml.m5d.24xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.geospatial.interactive" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge", * // LifecycleConfigArn: "STRING_VALUE", * // }, diff --git a/clients/client-sagemaker/src/commands/DescribeAutoMLJobV2Command.ts b/clients/client-sagemaker/src/commands/DescribeAutoMLJobV2Command.ts index 37eb6b7d56b7..d93e0281a38c 100644 --- a/clients/client-sagemaker/src/commands/DescribeAutoMLJobV2Command.ts +++ b/clients/client-sagemaker/src/commands/DescribeAutoMLJobV2Command.ts @@ -156,6 +156,9 @@ export interface DescribeAutoMLJobV2CommandOutput extends DescribeAutoMLJobV2Res * // MaxAutoMLJobRuntimeInSeconds: Number("int"), * // }, * // BaseModelName: "STRING_VALUE", + * // TextGenerationHyperParameters: { // TextGenerationHyperParameters + * // "": "STRING_VALUE", + * // }, * // }, * // }, * // CreationTime: new Date("TIMESTAMP"), // required diff --git a/clients/client-sagemaker/src/commands/DescribeClusterCommand.ts b/clients/client-sagemaker/src/commands/DescribeClusterCommand.ts new file mode 100644 index 000000000000..a180cc0f9f41 --- /dev/null +++ b/clients/client-sagemaker/src/commands/DescribeClusterCommand.ts @@ -0,0 +1,168 @@ +// smithy-typescript generated code +import { EndpointParameterInstructions, getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http"; +import { Command as $Command } from "@smithy/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, + SMITHY_CONTEXT_KEY, +} from "@smithy/types"; + +import { DescribeClusterRequest, DescribeClusterResponse } from "../models/models_2"; +import { de_DescribeClusterCommand, se_DescribeClusterCommand } from "../protocols/Aws_json1_1"; +import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link DescribeClusterCommand}. + */ +export interface DescribeClusterCommandInput extends DescribeClusterRequest {} +/** + * @public + * + * The output of {@link DescribeClusterCommand}. + */ +export interface DescribeClusterCommandOutput extends DescribeClusterResponse, __MetadataBearer {} + +/** + * @public + *

Retrieves information of a SageMaker HyperPod cluster.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeClusterCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeClusterCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // DescribeClusterRequest + * ClusterName: "STRING_VALUE", // required + * }; + * const command = new DescribeClusterCommand(input); + * const response = await client.send(command); + * // { // DescribeClusterResponse + * // ClusterArn: "STRING_VALUE", // required + * // ClusterName: "STRING_VALUE", + * // ClusterStatus: "Creating" || "Deleting" || "Failed" || "InService" || "RollingBack" || "SystemUpdating" || "Updating", // required + * // CreationTime: new Date("TIMESTAMP"), + * // FailureMessage: "STRING_VALUE", + * // InstanceGroups: [ // ClusterInstanceGroupDetailsList // required + * // { // ClusterInstanceGroupDetails + * // CurrentCount: Number("int"), + * // TargetCount: Number("int"), + * // InstanceGroupName: "STRING_VALUE", + * // InstanceType: "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.12xlarge" || "ml.g5.16xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.c5n.large" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge", + * // LifeCycleConfig: { // ClusterLifeCycleConfig + * // SourceS3Uri: "STRING_VALUE", // required + * // OnCreate: "STRING_VALUE", // required + * // }, + * // ExecutionRole: "STRING_VALUE", + * // ThreadsPerCore: Number("int"), + * // }, + * // ], + * // VpcConfig: { // VpcConfig + * // SecurityGroupIds: [ // VpcSecurityGroupIds // required + * // "STRING_VALUE", + * // ], + * // Subnets: [ // Subnets // required + * // "STRING_VALUE", + * // ], + * // }, + * // }; + * + * ``` + * + * @param DescribeClusterCommandInput - {@link DescribeClusterCommandInput} + * @returns {@link DescribeClusterCommandOutput} + * @see {@link DescribeClusterCommandInput} for command's `input` shape. + * @see {@link DescribeClusterCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for SageMakerClient's `config` shape. + * + * @throws {@link ResourceNotFound} (client fault) + *

Resource being access is not found.

+ * + * @throws {@link SageMakerServiceException} + *

Base exception class for all service exceptions from SageMaker service.

+ * + */ +export class DescribeClusterCommand extends $Command< + DescribeClusterCommandInput, + DescribeClusterCommandOutput, + SageMakerClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DescribeClusterCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack, + configuration: SageMakerClientResolvedConfig, + options?: __HttpHandlerOptions + ): Handler { + this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); + this.middlewareStack.use( + getEndpointPlugin(configuration, DescribeClusterCommand.getEndpointParameterInstructions()) + ); + + const stack = clientStack.concat(this.middlewareStack); + + const { logger } = configuration; + const clientName = "SageMakerClient"; + const commandName = "DescribeClusterCommand"; + const handlerExecutionContext: HandlerExecutionContext = { + logger, + clientName, + commandName, + inputFilterSensitiveLog: (_: any) => _, + outputFilterSensitiveLog: (_: any) => _, + [SMITHY_CONTEXT_KEY]: { + service: "SageMaker", + operation: "DescribeCluster", + }, + }; + const { requestHandler } = configuration; + return stack.resolve( + (request: FinalizeHandlerArguments) => + requestHandler.handle(request.request as __HttpRequest, options || {}), + handlerExecutionContext + ); + } + + /** + * @internal + */ + private serialize(input: DescribeClusterCommandInput, context: __SerdeContext): Promise<__HttpRequest> { + return se_DescribeClusterCommand(input, context); + } + + /** + * @internal + */ + private deserialize(output: __HttpResponse, context: __SerdeContext): Promise { + return de_DescribeClusterCommand(output, context); + } +} diff --git a/clients/client-sagemaker/src/commands/DescribeClusterNodeCommand.ts b/clients/client-sagemaker/src/commands/DescribeClusterNodeCommand.ts new file mode 100644 index 000000000000..f97a7b6e28ac --- /dev/null +++ b/clients/client-sagemaker/src/commands/DescribeClusterNodeCommand.ts @@ -0,0 +1,158 @@ +// smithy-typescript generated code +import { EndpointParameterInstructions, getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http"; +import { Command as $Command } from "@smithy/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, + SMITHY_CONTEXT_KEY, +} from "@smithy/types"; + +import { DescribeClusterNodeRequest, DescribeClusterNodeResponse } from "../models/models_2"; +import { de_DescribeClusterNodeCommand, se_DescribeClusterNodeCommand } from "../protocols/Aws_json1_1"; +import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link DescribeClusterNodeCommand}. + */ +export interface DescribeClusterNodeCommandInput extends DescribeClusterNodeRequest {} +/** + * @public + * + * The output of {@link DescribeClusterNodeCommand}. + */ +export interface DescribeClusterNodeCommandOutput extends DescribeClusterNodeResponse, __MetadataBearer {} + +/** + * @public + *

Retrieves information of an instance (also called a node + * interchangeably) of a SageMaker HyperPod cluster.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeClusterNodeCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeClusterNodeCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // DescribeClusterNodeRequest + * ClusterName: "STRING_VALUE", // required + * NodeId: "STRING_VALUE", // required + * }; + * const command = new DescribeClusterNodeCommand(input); + * const response = await client.send(command); + * // { // DescribeClusterNodeResponse + * // NodeDetails: { // ClusterNodeDetails + * // InstanceGroupName: "STRING_VALUE", + * // InstanceId: "STRING_VALUE", + * // InstanceStatus: { // ClusterInstanceStatusDetails + * // Status: "Running" || "Failure" || "Pending" || "ShuttingDown" || "SystemUpdating", // required + * // Message: "STRING_VALUE", + * // }, + * // InstanceType: "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.12xlarge" || "ml.g5.16xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.c5n.large" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge", + * // LaunchTime: new Date("TIMESTAMP"), + * // LifeCycleConfig: { // ClusterLifeCycleConfig + * // SourceS3Uri: "STRING_VALUE", // required + * // OnCreate: "STRING_VALUE", // required + * // }, + * // ThreadsPerCore: Number("int"), + * // }, + * // }; + * + * ``` + * + * @param DescribeClusterNodeCommandInput - {@link DescribeClusterNodeCommandInput} + * @returns {@link DescribeClusterNodeCommandOutput} + * @see {@link DescribeClusterNodeCommandInput} for command's `input` shape. + * @see {@link DescribeClusterNodeCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for SageMakerClient's `config` shape. + * + * @throws {@link ResourceNotFound} (client fault) + *

Resource being access is not found.

+ * + * @throws {@link SageMakerServiceException} + *

Base exception class for all service exceptions from SageMaker service.

+ * + */ +export class DescribeClusterNodeCommand extends $Command< + DescribeClusterNodeCommandInput, + DescribeClusterNodeCommandOutput, + SageMakerClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DescribeClusterNodeCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack, + configuration: SageMakerClientResolvedConfig, + options?: __HttpHandlerOptions + ): Handler { + this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); + this.middlewareStack.use( + getEndpointPlugin(configuration, DescribeClusterNodeCommand.getEndpointParameterInstructions()) + ); + + const stack = clientStack.concat(this.middlewareStack); + + const { logger } = configuration; + const clientName = "SageMakerClient"; + const commandName = "DescribeClusterNodeCommand"; + const handlerExecutionContext: HandlerExecutionContext = { + logger, + clientName, + commandName, + inputFilterSensitiveLog: (_: any) => _, + outputFilterSensitiveLog: (_: any) => _, + [SMITHY_CONTEXT_KEY]: { + service: "SageMaker", + operation: "DescribeClusterNode", + }, + }; + const { requestHandler } = configuration; + return stack.resolve( + (request: FinalizeHandlerArguments) => + requestHandler.handle(request.request as __HttpRequest, options || {}), + handlerExecutionContext + ); + } + + /** + * @internal + */ + private serialize(input: DescribeClusterNodeCommandInput, context: __SerdeContext): Promise<__HttpRequest> { + return se_DescribeClusterNodeCommand(input, context); + } + + /** + * @internal + */ + private deserialize(output: __HttpResponse, context: __SerdeContext): Promise { + return de_DescribeClusterNodeCommand(output, context); + } +} diff --git a/clients/client-sagemaker/src/commands/DescribeDomainCommand.ts b/clients/client-sagemaker/src/commands/DescribeDomainCommand.ts index 63759987d497..d7119d445ad6 100644 --- a/clients/client-sagemaker/src/commands/DescribeDomainCommand.ts +++ b/clients/client-sagemaker/src/commands/DescribeDomainCommand.ts @@ -75,6 +75,7 @@ export interface DescribeDomainCommandOutput extends DescribeDomainResponse, __M * // DefaultResourceSpec: { // ResourceSpec * // SageMakerImageArn: "STRING_VALUE", * // SageMakerImageVersionArn: "STRING_VALUE", + * // SageMakerImageVersionAlias: "STRING_VALUE", * // InstanceType: "system" || "ml.t3.micro" || "ml.t3.small" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.8xlarge" || "ml.m5d.12xlarge" || "ml.m5d.16xlarge" || "ml.m5d.24xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.geospatial.interactive" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge", * // LifecycleConfigArn: "STRING_VALUE", * // }, @@ -91,6 +92,7 @@ export interface DescribeDomainCommandOutput extends DescribeDomainResponse, __M * // DefaultResourceSpec: { * // SageMakerImageArn: "STRING_VALUE", * // SageMakerImageVersionArn: "STRING_VALUE", + * // SageMakerImageVersionAlias: "STRING_VALUE", * // InstanceType: "system" || "ml.t3.micro" || "ml.t3.small" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.8xlarge" || "ml.m5d.12xlarge" || "ml.m5d.16xlarge" || "ml.m5d.24xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.geospatial.interactive" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge", * // LifecycleConfigArn: "STRING_VALUE", * // }, @@ -109,6 +111,7 @@ export interface DescribeDomainCommandOutput extends DescribeDomainResponse, __M * // DefaultResourceSpec: { * // SageMakerImageArn: "STRING_VALUE", * // SageMakerImageVersionArn: "STRING_VALUE", + * // SageMakerImageVersionAlias: "STRING_VALUE", * // InstanceType: "system" || "ml.t3.micro" || "ml.t3.small" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.8xlarge" || "ml.m5d.12xlarge" || "ml.m5d.16xlarge" || "ml.m5d.24xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.geospatial.interactive" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge", * // LifecycleConfigArn: "STRING_VALUE", * // }, @@ -121,6 +124,7 @@ export interface DescribeDomainCommandOutput extends DescribeDomainResponse, __M * // DefaultResourceSpec: { * // SageMakerImageArn: "STRING_VALUE", * // SageMakerImageVersionArn: "STRING_VALUE", + * // SageMakerImageVersionAlias: "STRING_VALUE", * // InstanceType: "system" || "ml.t3.micro" || "ml.t3.small" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.8xlarge" || "ml.m5d.12xlarge" || "ml.m5d.16xlarge" || "ml.m5d.24xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.geospatial.interactive" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge", * // LifecycleConfigArn: "STRING_VALUE", * // }, @@ -159,6 +163,8 @@ export interface DescribeDomainCommandOutput extends DescribeDomainResponse, __M * // Status: "ENABLED" || "DISABLED", * // }, * // }, + * // DefaultLandingUri: "STRING_VALUE", + * // StudioWebPortal: "ENABLED" || "DISABLED", * // }, * // AppNetworkAccessType: "PublicInternetOnly" || "VpcOnly", * // HomeEfsFileSystemKmsKeyId: "STRING_VALUE", @@ -179,6 +185,7 @@ export interface DescribeDomainCommandOutput extends DescribeDomainResponse, __M * // DefaultResourceSpec: { * // SageMakerImageArn: "STRING_VALUE", * // SageMakerImageVersionArn: "STRING_VALUE", + * // SageMakerImageVersionAlias: "STRING_VALUE", * // InstanceType: "system" || "ml.t3.micro" || "ml.t3.small" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.8xlarge" || "ml.m5d.12xlarge" || "ml.m5d.16xlarge" || "ml.m5d.24xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.geospatial.interactive" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge", * // LifecycleConfigArn: "STRING_VALUE", * // }, diff --git a/clients/client-sagemaker/src/commands/DescribeEndpointCommand.ts b/clients/client-sagemaker/src/commands/DescribeEndpointCommand.ts index bea5e443a3ea..31e8fe370edb 100644 --- a/clients/client-sagemaker/src/commands/DescribeEndpointCommand.ts +++ b/clients/client-sagemaker/src/commands/DescribeEndpointCommand.ts @@ -84,6 +84,14 @@ export interface DescribeEndpointCommandOutput extends DescribeEndpointOutput, _ * // MaxConcurrency: Number("int"), // required * // ProvisionedConcurrency: Number("int"), * // }, + * // ManagedInstanceScaling: { // ProductionVariantManagedInstanceScaling + * // Status: "ENABLED" || "DISABLED", + * // MinInstanceCount: Number("int"), + * // MaxInstanceCount: Number("int"), + * // }, + * // RoutingConfig: { // ProductionVariantRoutingConfig + * // RoutingStrategy: "LEAST_OUTSTANDING_REQUESTS" || "RANDOM", // required + * // }, * // }, * // ], * // DataCaptureConfig: { // DataCaptureConfigSummary @@ -186,6 +194,14 @@ export interface DescribeEndpointCommandOutput extends DescribeEndpointOutput, _ * // MaxConcurrency: Number("int"), // required * // ProvisionedConcurrency: Number("int"), * // }, + * // ManagedInstanceScaling: { + * // Status: "ENABLED" || "DISABLED", + * // MinInstanceCount: Number("int"), + * // MaxInstanceCount: Number("int"), + * // }, + * // RoutingConfig: { + * // RoutingStrategy: "LEAST_OUTSTANDING_REQUESTS" || "RANDOM", // required + * // }, * // }, * // ], * // StartTime: new Date("TIMESTAMP"), @@ -218,6 +234,14 @@ export interface DescribeEndpointCommandOutput extends DescribeEndpointOutput, _ * // ProvisionedConcurrency: Number("int"), * // }, * // DesiredServerlessConfig: "", + * // ManagedInstanceScaling: { + * // Status: "ENABLED" || "DISABLED", + * // MinInstanceCount: Number("int"), + * // MaxInstanceCount: Number("int"), + * // }, + * // RoutingConfig: { + * // RoutingStrategy: "LEAST_OUTSTANDING_REQUESTS" || "RANDOM", // required + * // }, * // }, * // ], * // }, @@ -282,6 +306,14 @@ export interface DescribeEndpointCommandOutput extends DescribeEndpointOutput, _ * // ], * // CurrentServerlessConfig: "", * // DesiredServerlessConfig: "", + * // ManagedInstanceScaling: { + * // Status: "ENABLED" || "DISABLED", + * // MinInstanceCount: Number("int"), + * // MaxInstanceCount: Number("int"), + * // }, + * // RoutingConfig: { + * // RoutingStrategy: "LEAST_OUTSTANDING_REQUESTS" || "RANDOM", // required + * // }, * // }, * // ], * // }; diff --git a/clients/client-sagemaker/src/commands/DescribeEndpointConfigCommand.ts b/clients/client-sagemaker/src/commands/DescribeEndpointConfigCommand.ts index c840905e71e9..5844cd3b22d6 100644 --- a/clients/client-sagemaker/src/commands/DescribeEndpointConfigCommand.ts +++ b/clients/client-sagemaker/src/commands/DescribeEndpointConfigCommand.ts @@ -56,7 +56,7 @@ export interface DescribeEndpointConfigCommandOutput extends DescribeEndpointCon * // ProductionVariants: [ // ProductionVariantList // required * // { // ProductionVariant * // VariantName: "STRING_VALUE", // required - * // ModelName: "STRING_VALUE", // required + * // ModelName: "STRING_VALUE", * // InitialInstanceCount: Number("int"), * // InstanceType: "ml.t2.medium" || "ml.t2.large" || "ml.t2.xlarge" || "ml.t2.2xlarge" || "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.12xlarge" || "ml.m5d.24xlarge" || "ml.c4.large" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5d.large" || "ml.c5d.xlarge" || "ml.c5d.2xlarge" || "ml.c5d.4xlarge" || "ml.c5d.9xlarge" || "ml.c5d.18xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.12xlarge" || "ml.r5.24xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.12xlarge" || "ml.r5d.24xlarge" || "ml.inf1.xlarge" || "ml.inf1.2xlarge" || "ml.inf1.6xlarge" || "ml.inf1.24xlarge" || "ml.c6i.large" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.4xlarge" || "ml.c6i.8xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.12xlarge" || "ml.g5.16xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.p4d.24xlarge" || "ml.c7g.large" || "ml.c7g.xlarge" || "ml.c7g.2xlarge" || "ml.c7g.4xlarge" || "ml.c7g.8xlarge" || "ml.c7g.12xlarge" || "ml.c7g.16xlarge" || "ml.m6g.large" || "ml.m6g.xlarge" || "ml.m6g.2xlarge" || "ml.m6g.4xlarge" || "ml.m6g.8xlarge" || "ml.m6g.12xlarge" || "ml.m6g.16xlarge" || "ml.m6gd.large" || "ml.m6gd.xlarge" || "ml.m6gd.2xlarge" || "ml.m6gd.4xlarge" || "ml.m6gd.8xlarge" || "ml.m6gd.12xlarge" || "ml.m6gd.16xlarge" || "ml.c6g.large" || "ml.c6g.xlarge" || "ml.c6g.2xlarge" || "ml.c6g.4xlarge" || "ml.c6g.8xlarge" || "ml.c6g.12xlarge" || "ml.c6g.16xlarge" || "ml.c6gd.large" || "ml.c6gd.xlarge" || "ml.c6gd.2xlarge" || "ml.c6gd.4xlarge" || "ml.c6gd.8xlarge" || "ml.c6gd.12xlarge" || "ml.c6gd.16xlarge" || "ml.c6gn.large" || "ml.c6gn.xlarge" || "ml.c6gn.2xlarge" || "ml.c6gn.4xlarge" || "ml.c6gn.8xlarge" || "ml.c6gn.12xlarge" || "ml.c6gn.16xlarge" || "ml.r6g.large" || "ml.r6g.xlarge" || "ml.r6g.2xlarge" || "ml.r6g.4xlarge" || "ml.r6g.8xlarge" || "ml.r6g.12xlarge" || "ml.r6g.16xlarge" || "ml.r6gd.large" || "ml.r6gd.xlarge" || "ml.r6gd.2xlarge" || "ml.r6gd.4xlarge" || "ml.r6gd.8xlarge" || "ml.r6gd.12xlarge" || "ml.r6gd.16xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.inf2.xlarge" || "ml.inf2.8xlarge" || "ml.inf2.24xlarge" || "ml.inf2.48xlarge" || "ml.p5.48xlarge", * // InitialVariantWeight: Number("float"), @@ -74,6 +74,14 @@ export interface DescribeEndpointConfigCommandOutput extends DescribeEndpointCon * // ModelDataDownloadTimeoutInSeconds: Number("int"), * // ContainerStartupHealthCheckTimeoutInSeconds: Number("int"), * // EnableSSMAccess: true || false, + * // ManagedInstanceScaling: { // ProductionVariantManagedInstanceScaling + * // Status: "ENABLED" || "DISABLED", + * // MinInstanceCount: Number("int"), + * // MaxInstanceCount: Number("int"), + * // }, + * // RoutingConfig: { // ProductionVariantRoutingConfig + * // RoutingStrategy: "LEAST_OUTSTANDING_REQUESTS" || "RANDOM", // required + * // }, * // }, * // ], * // DataCaptureConfig: { // DataCaptureConfig @@ -155,7 +163,7 @@ export interface DescribeEndpointConfigCommandOutput extends DescribeEndpointCon * // ShadowProductionVariants: [ * // { * // VariantName: "STRING_VALUE", // required - * // ModelName: "STRING_VALUE", // required + * // ModelName: "STRING_VALUE", * // InitialInstanceCount: Number("int"), * // InstanceType: "ml.t2.medium" || "ml.t2.large" || "ml.t2.xlarge" || "ml.t2.2xlarge" || "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.12xlarge" || "ml.m5d.24xlarge" || "ml.c4.large" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5d.large" || "ml.c5d.xlarge" || "ml.c5d.2xlarge" || "ml.c5d.4xlarge" || "ml.c5d.9xlarge" || "ml.c5d.18xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.12xlarge" || "ml.r5.24xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.12xlarge" || "ml.r5d.24xlarge" || "ml.inf1.xlarge" || "ml.inf1.2xlarge" || "ml.inf1.6xlarge" || "ml.inf1.24xlarge" || "ml.c6i.large" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.4xlarge" || "ml.c6i.8xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.12xlarge" || "ml.g5.16xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.p4d.24xlarge" || "ml.c7g.large" || "ml.c7g.xlarge" || "ml.c7g.2xlarge" || "ml.c7g.4xlarge" || "ml.c7g.8xlarge" || "ml.c7g.12xlarge" || "ml.c7g.16xlarge" || "ml.m6g.large" || "ml.m6g.xlarge" || "ml.m6g.2xlarge" || "ml.m6g.4xlarge" || "ml.m6g.8xlarge" || "ml.m6g.12xlarge" || "ml.m6g.16xlarge" || "ml.m6gd.large" || "ml.m6gd.xlarge" || "ml.m6gd.2xlarge" || "ml.m6gd.4xlarge" || "ml.m6gd.8xlarge" || "ml.m6gd.12xlarge" || "ml.m6gd.16xlarge" || "ml.c6g.large" || "ml.c6g.xlarge" || "ml.c6g.2xlarge" || "ml.c6g.4xlarge" || "ml.c6g.8xlarge" || "ml.c6g.12xlarge" || "ml.c6g.16xlarge" || "ml.c6gd.large" || "ml.c6gd.xlarge" || "ml.c6gd.2xlarge" || "ml.c6gd.4xlarge" || "ml.c6gd.8xlarge" || "ml.c6gd.12xlarge" || "ml.c6gd.16xlarge" || "ml.c6gn.large" || "ml.c6gn.xlarge" || "ml.c6gn.2xlarge" || "ml.c6gn.4xlarge" || "ml.c6gn.8xlarge" || "ml.c6gn.12xlarge" || "ml.c6gn.16xlarge" || "ml.r6g.large" || "ml.r6g.xlarge" || "ml.r6g.2xlarge" || "ml.r6g.4xlarge" || "ml.r6g.8xlarge" || "ml.r6g.12xlarge" || "ml.r6g.16xlarge" || "ml.r6gd.large" || "ml.r6gd.xlarge" || "ml.r6gd.2xlarge" || "ml.r6gd.4xlarge" || "ml.r6gd.8xlarge" || "ml.r6gd.12xlarge" || "ml.r6gd.16xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.inf2.xlarge" || "ml.inf2.8xlarge" || "ml.inf2.24xlarge" || "ml.inf2.48xlarge" || "ml.p5.48xlarge", * // InitialVariantWeight: Number("float"), @@ -173,8 +181,26 @@ export interface DescribeEndpointConfigCommandOutput extends DescribeEndpointCon * // ModelDataDownloadTimeoutInSeconds: Number("int"), * // ContainerStartupHealthCheckTimeoutInSeconds: Number("int"), * // EnableSSMAccess: true || false, + * // ManagedInstanceScaling: { + * // Status: "ENABLED" || "DISABLED", + * // MinInstanceCount: Number("int"), + * // MaxInstanceCount: Number("int"), + * // }, + * // RoutingConfig: { + * // RoutingStrategy: "LEAST_OUTSTANDING_REQUESTS" || "RANDOM", // required + * // }, * // }, * // ], + * // ExecutionRoleArn: "STRING_VALUE", + * // VpcConfig: { // VpcConfig + * // SecurityGroupIds: [ // VpcSecurityGroupIds // required + * // "STRING_VALUE", + * // ], + * // Subnets: [ // Subnets // required + * // "STRING_VALUE", + * // ], + * // }, + * // EnableNetworkIsolation: true || false, * // }; * * ``` diff --git a/clients/client-sagemaker/src/commands/DescribeInferenceComponentCommand.ts b/clients/client-sagemaker/src/commands/DescribeInferenceComponentCommand.ts new file mode 100644 index 000000000000..f4ad2bea957d --- /dev/null +++ b/clients/client-sagemaker/src/commands/DescribeInferenceComponentCommand.ts @@ -0,0 +1,178 @@ +// smithy-typescript generated code +import { EndpointParameterInstructions, getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http"; +import { Command as $Command } from "@smithy/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, + SMITHY_CONTEXT_KEY, +} from "@smithy/types"; + +import { DescribeInferenceComponentInput, DescribeInferenceComponentOutput } from "../models/models_2"; +import { de_DescribeInferenceComponentCommand, se_DescribeInferenceComponentCommand } from "../protocols/Aws_json1_1"; +import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link DescribeInferenceComponentCommand}. + */ +export interface DescribeInferenceComponentCommandInput extends DescribeInferenceComponentInput {} +/** + * @public + * + * The output of {@link DescribeInferenceComponentCommand}. + */ +export interface DescribeInferenceComponentCommandOutput extends DescribeInferenceComponentOutput, __MetadataBearer {} + +/** + * @public + *

Returns information about an inference component.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeInferenceComponentCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeInferenceComponentCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // DescribeInferenceComponentInput + * InferenceComponentName: "STRING_VALUE", // required + * }; + * const command = new DescribeInferenceComponentCommand(input); + * const response = await client.send(command); + * // { // DescribeInferenceComponentOutput + * // InferenceComponentName: "STRING_VALUE", // required + * // InferenceComponentArn: "STRING_VALUE", // required + * // EndpointName: "STRING_VALUE", // required + * // EndpointArn: "STRING_VALUE", // required + * // VariantName: "STRING_VALUE", + * // FailureReason: "STRING_VALUE", + * // Specification: { // InferenceComponentSpecificationSummary + * // ModelName: "STRING_VALUE", + * // Container: { // InferenceComponentContainerSpecificationSummary + * // DeployedImage: { // DeployedImage + * // SpecifiedImage: "STRING_VALUE", + * // ResolvedImage: "STRING_VALUE", + * // ResolutionTime: new Date("TIMESTAMP"), + * // }, + * // ArtifactUrl: "STRING_VALUE", + * // Environment: { // EnvironmentMap + * // "": "STRING_VALUE", + * // }, + * // }, + * // StartupParameters: { // InferenceComponentStartupParameters + * // ModelDataDownloadTimeoutInSeconds: Number("int"), + * // ContainerStartupHealthCheckTimeoutInSeconds: Number("int"), + * // }, + * // ComputeResourceRequirements: { // InferenceComponentComputeResourceRequirements + * // NumberOfCpuCoresRequired: Number("float"), + * // NumberOfAcceleratorDevicesRequired: Number("float"), + * // MinMemoryRequiredInMb: Number("int"), // required + * // MaxMemoryRequiredInMb: Number("int"), + * // }, + * // }, + * // RuntimeConfig: { // InferenceComponentRuntimeConfigSummary + * // DesiredCopyCount: Number("int"), + * // CurrentCopyCount: Number("int"), + * // }, + * // CreationTime: new Date("TIMESTAMP"), // required + * // LastModifiedTime: new Date("TIMESTAMP"), // required + * // InferenceComponentStatus: "InService" || "Creating" || "Updating" || "Failed" || "Deleting", + * // }; + * + * ``` + * + * @param DescribeInferenceComponentCommandInput - {@link DescribeInferenceComponentCommandInput} + * @returns {@link DescribeInferenceComponentCommandOutput} + * @see {@link DescribeInferenceComponentCommandInput} for command's `input` shape. + * @see {@link DescribeInferenceComponentCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for SageMakerClient's `config` shape. + * + * @throws {@link SageMakerServiceException} + *

Base exception class for all service exceptions from SageMaker service.

+ * + */ +export class DescribeInferenceComponentCommand extends $Command< + DescribeInferenceComponentCommandInput, + DescribeInferenceComponentCommandOutput, + SageMakerClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DescribeInferenceComponentCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack, + configuration: SageMakerClientResolvedConfig, + options?: __HttpHandlerOptions + ): Handler { + this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); + this.middlewareStack.use( + getEndpointPlugin(configuration, DescribeInferenceComponentCommand.getEndpointParameterInstructions()) + ); + + const stack = clientStack.concat(this.middlewareStack); + + const { logger } = configuration; + const clientName = "SageMakerClient"; + const commandName = "DescribeInferenceComponentCommand"; + const handlerExecutionContext: HandlerExecutionContext = { + logger, + clientName, + commandName, + inputFilterSensitiveLog: (_: any) => _, + outputFilterSensitiveLog: (_: any) => _, + [SMITHY_CONTEXT_KEY]: { + service: "SageMaker", + operation: "DescribeInferenceComponent", + }, + }; + const { requestHandler } = configuration; + return stack.resolve( + (request: FinalizeHandlerArguments) => + requestHandler.handle(request.request as __HttpRequest, options || {}), + handlerExecutionContext + ); + } + + /** + * @internal + */ + private serialize(input: DescribeInferenceComponentCommandInput, context: __SerdeContext): Promise<__HttpRequest> { + return se_DescribeInferenceComponentCommand(input, context); + } + + /** + * @internal + */ + private deserialize( + output: __HttpResponse, + context: __SerdeContext + ): Promise { + return de_DescribeInferenceComponentCommand(output, context); + } +} diff --git a/clients/client-sagemaker/src/commands/DescribeModelCommand.ts b/clients/client-sagemaker/src/commands/DescribeModelCommand.ts index 747c14dff462..56408810829c 100644 --- a/clients/client-sagemaker/src/commands/DescribeModelCommand.ts +++ b/clients/client-sagemaker/src/commands/DescribeModelCommand.ts @@ -117,7 +117,7 @@ export interface DescribeModelCommandOutput extends DescribeModelOutput, __Metad * // InferenceExecutionConfig: { // InferenceExecutionConfig * // Mode: "Serial" || "Direct", // required * // }, - * // ExecutionRoleArn: "STRING_VALUE", // required + * // ExecutionRoleArn: "STRING_VALUE", * // VpcConfig: { // VpcConfig * // SecurityGroupIds: [ // VpcSecurityGroupIds // required * // "STRING_VALUE", diff --git a/clients/client-sagemaker/src/commands/DescribeSpaceCommand.ts b/clients/client-sagemaker/src/commands/DescribeSpaceCommand.ts index 3c8fe14db50d..00d9ee9ba26c 100644 --- a/clients/client-sagemaker/src/commands/DescribeSpaceCommand.ts +++ b/clients/client-sagemaker/src/commands/DescribeSpaceCommand.ts @@ -64,6 +64,7 @@ export interface DescribeSpaceCommandOutput extends DescribeSpaceResponse, __Met * // DefaultResourceSpec: { // ResourceSpec * // SageMakerImageArn: "STRING_VALUE", * // SageMakerImageVersionArn: "STRING_VALUE", + * // SageMakerImageVersionAlias: "STRING_VALUE", * // InstanceType: "system" || "ml.t3.micro" || "ml.t3.small" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.8xlarge" || "ml.m5d.12xlarge" || "ml.m5d.16xlarge" || "ml.m5d.24xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.geospatial.interactive" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge", * // LifecycleConfigArn: "STRING_VALUE", * // }, @@ -80,6 +81,7 @@ export interface DescribeSpaceCommandOutput extends DescribeSpaceResponse, __Met * // DefaultResourceSpec: { * // SageMakerImageArn: "STRING_VALUE", * // SageMakerImageVersionArn: "STRING_VALUE", + * // SageMakerImageVersionAlias: "STRING_VALUE", * // InstanceType: "system" || "ml.t3.micro" || "ml.t3.small" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.8xlarge" || "ml.m5d.12xlarge" || "ml.m5d.16xlarge" || "ml.m5d.24xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.geospatial.interactive" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge", * // LifecycleConfigArn: "STRING_VALUE", * // }, @@ -95,6 +97,7 @@ export interface DescribeSpaceCommandOutput extends DescribeSpaceResponse, __Met * // ], * // }, * // }, + * // Url: "STRING_VALUE", * // }; * * ``` diff --git a/clients/client-sagemaker/src/commands/DescribeStudioLifecycleConfigCommand.ts b/clients/client-sagemaker/src/commands/DescribeStudioLifecycleConfigCommand.ts index 92afb1ab19c9..4f2d59f78fd8 100644 --- a/clients/client-sagemaker/src/commands/DescribeStudioLifecycleConfigCommand.ts +++ b/clients/client-sagemaker/src/commands/DescribeStudioLifecycleConfigCommand.ts @@ -42,7 +42,7 @@ export interface DescribeStudioLifecycleConfigCommandOutput /** * @public - *

Describes the Studio Lifecycle Configuration.

+ *

Describes the Amazon SageMaker Studio Lifecycle Configuration.

* @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/DescribeTrainingJobCommand.ts b/clients/client-sagemaker/src/commands/DescribeTrainingJobCommand.ts index 78282ae709e2..24ff4287790c 100644 --- a/clients/client-sagemaker/src/commands/DescribeTrainingJobCommand.ts +++ b/clients/client-sagemaker/src/commands/DescribeTrainingJobCommand.ts @@ -275,6 +275,9 @@ export interface DescribeTrainingJobCommandOutput extends DescribeTrainingJobRes * // ResourceRetainedBillableTimeInSeconds: Number("int"), * // ReusedByJob: "STRING_VALUE", * // }, + * // InfraCheckConfig: { // InfraCheckConfig + * // EnableInfraCheck: true || false, + * // }, * // }; * * ``` diff --git a/clients/client-sagemaker/src/commands/DescribeUserProfileCommand.ts b/clients/client-sagemaker/src/commands/DescribeUserProfileCommand.ts index ee6bf2521b62..4d3b2c2248e4 100644 --- a/clients/client-sagemaker/src/commands/DescribeUserProfileCommand.ts +++ b/clients/client-sagemaker/src/commands/DescribeUserProfileCommand.ts @@ -14,7 +14,8 @@ import { SMITHY_CONTEXT_KEY, } from "@smithy/types"; -import { DescribeUserProfileRequest, DescribeUserProfileResponse } from "../models/models_2"; +import { DescribeUserProfileRequest } from "../models/models_2"; +import { DescribeUserProfileResponse } from "../models/models_3"; import { de_DescribeUserProfileCommand, se_DescribeUserProfileCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; @@ -75,6 +76,7 @@ export interface DescribeUserProfileCommandOutput extends DescribeUserProfileRes * // DefaultResourceSpec: { // ResourceSpec * // SageMakerImageArn: "STRING_VALUE", * // SageMakerImageVersionArn: "STRING_VALUE", + * // SageMakerImageVersionAlias: "STRING_VALUE", * // InstanceType: "system" || "ml.t3.micro" || "ml.t3.small" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.8xlarge" || "ml.m5d.12xlarge" || "ml.m5d.16xlarge" || "ml.m5d.24xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.geospatial.interactive" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge", * // LifecycleConfigArn: "STRING_VALUE", * // }, @@ -91,6 +93,7 @@ export interface DescribeUserProfileCommandOutput extends DescribeUserProfileRes * // DefaultResourceSpec: { * // SageMakerImageArn: "STRING_VALUE", * // SageMakerImageVersionArn: "STRING_VALUE", + * // SageMakerImageVersionAlias: "STRING_VALUE", * // InstanceType: "system" || "ml.t3.micro" || "ml.t3.small" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.8xlarge" || "ml.m5d.12xlarge" || "ml.m5d.16xlarge" || "ml.m5d.24xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.geospatial.interactive" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge", * // LifecycleConfigArn: "STRING_VALUE", * // }, @@ -109,6 +112,7 @@ export interface DescribeUserProfileCommandOutput extends DescribeUserProfileRes * // DefaultResourceSpec: { * // SageMakerImageArn: "STRING_VALUE", * // SageMakerImageVersionArn: "STRING_VALUE", + * // SageMakerImageVersionAlias: "STRING_VALUE", * // InstanceType: "system" || "ml.t3.micro" || "ml.t3.small" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.8xlarge" || "ml.m5d.12xlarge" || "ml.m5d.16xlarge" || "ml.m5d.24xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.geospatial.interactive" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge", * // LifecycleConfigArn: "STRING_VALUE", * // }, @@ -121,6 +125,7 @@ export interface DescribeUserProfileCommandOutput extends DescribeUserProfileRes * // DefaultResourceSpec: { * // SageMakerImageArn: "STRING_VALUE", * // SageMakerImageVersionArn: "STRING_VALUE", + * // SageMakerImageVersionAlias: "STRING_VALUE", * // InstanceType: "system" || "ml.t3.micro" || "ml.t3.small" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.8xlarge" || "ml.m5d.12xlarge" || "ml.m5d.16xlarge" || "ml.m5d.24xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.geospatial.interactive" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge", * // LifecycleConfigArn: "STRING_VALUE", * // }, @@ -159,6 +164,8 @@ export interface DescribeUserProfileCommandOutput extends DescribeUserProfileRes * // Status: "ENABLED" || "DISABLED", * // }, * // }, + * // DefaultLandingUri: "STRING_VALUE", + * // StudioWebPortal: "ENABLED" || "DISABLED", * // }, * // }; * diff --git a/clients/client-sagemaker/src/commands/DescribeWorkforceCommand.ts b/clients/client-sagemaker/src/commands/DescribeWorkforceCommand.ts index f73e5e98a86d..4f33a353041a 100644 --- a/clients/client-sagemaker/src/commands/DescribeWorkforceCommand.ts +++ b/clients/client-sagemaker/src/commands/DescribeWorkforceCommand.ts @@ -14,7 +14,7 @@ import { SMITHY_CONTEXT_KEY, } from "@smithy/types"; -import { DescribeWorkforceRequest, DescribeWorkforceResponse } from "../models/models_2"; +import { DescribeWorkforceRequest, DescribeWorkforceResponse } from "../models/models_3"; import { de_DescribeWorkforceCommand, se_DescribeWorkforceCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/DescribeWorkteamCommand.ts b/clients/client-sagemaker/src/commands/DescribeWorkteamCommand.ts index 9b0989242305..14f3e0a6decb 100644 --- a/clients/client-sagemaker/src/commands/DescribeWorkteamCommand.ts +++ b/clients/client-sagemaker/src/commands/DescribeWorkteamCommand.ts @@ -14,7 +14,7 @@ import { SMITHY_CONTEXT_KEY, } from "@smithy/types"; -import { DescribeWorkteamRequest, DescribeWorkteamResponse } from "../models/models_2"; +import { DescribeWorkteamRequest, DescribeWorkteamResponse } from "../models/models_3"; import { de_DescribeWorkteamCommand, se_DescribeWorkteamCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/DisableSagemakerServicecatalogPortfolioCommand.ts b/clients/client-sagemaker/src/commands/DisableSagemakerServicecatalogPortfolioCommand.ts index 30567db5f0a7..33eca58c932c 100644 --- a/clients/client-sagemaker/src/commands/DisableSagemakerServicecatalogPortfolioCommand.ts +++ b/clients/client-sagemaker/src/commands/DisableSagemakerServicecatalogPortfolioCommand.ts @@ -17,7 +17,7 @@ import { import { DisableSagemakerServicecatalogPortfolioInput, DisableSagemakerServicecatalogPortfolioOutput, -} from "../models/models_2"; +} from "../models/models_3"; import { de_DisableSagemakerServicecatalogPortfolioCommand, se_DisableSagemakerServicecatalogPortfolioCommand, diff --git a/clients/client-sagemaker/src/commands/DisassociateTrialComponentCommand.ts b/clients/client-sagemaker/src/commands/DisassociateTrialComponentCommand.ts index 7efe68b4f5cc..21730cfa714e 100644 --- a/clients/client-sagemaker/src/commands/DisassociateTrialComponentCommand.ts +++ b/clients/client-sagemaker/src/commands/DisassociateTrialComponentCommand.ts @@ -14,7 +14,7 @@ import { SMITHY_CONTEXT_KEY, } from "@smithy/types"; -import { DisassociateTrialComponentRequest, DisassociateTrialComponentResponse } from "../models/models_2"; +import { DisassociateTrialComponentRequest, DisassociateTrialComponentResponse } from "../models/models_3"; import { de_DisassociateTrialComponentCommand, se_DisassociateTrialComponentCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/EnableSagemakerServicecatalogPortfolioCommand.ts b/clients/client-sagemaker/src/commands/EnableSagemakerServicecatalogPortfolioCommand.ts index 8904d7a4f2c8..0accdde300a4 100644 --- a/clients/client-sagemaker/src/commands/EnableSagemakerServicecatalogPortfolioCommand.ts +++ b/clients/client-sagemaker/src/commands/EnableSagemakerServicecatalogPortfolioCommand.ts @@ -17,7 +17,7 @@ import { import { EnableSagemakerServicecatalogPortfolioInput, EnableSagemakerServicecatalogPortfolioOutput, -} from "../models/models_2"; +} from "../models/models_3"; import { de_EnableSagemakerServicecatalogPortfolioCommand, se_EnableSagemakerServicecatalogPortfolioCommand, diff --git a/clients/client-sagemaker/src/commands/ListClusterNodesCommand.ts b/clients/client-sagemaker/src/commands/ListClusterNodesCommand.ts new file mode 100644 index 000000000000..0b940d2ea67b --- /dev/null +++ b/clients/client-sagemaker/src/commands/ListClusterNodesCommand.ts @@ -0,0 +1,162 @@ +// smithy-typescript generated code +import { EndpointParameterInstructions, getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http"; +import { Command as $Command } from "@smithy/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, + SMITHY_CONTEXT_KEY, +} from "@smithy/types"; + +import { ListClusterNodesRequest, ListClusterNodesResponse } from "../models/models_3"; +import { de_ListClusterNodesCommand, se_ListClusterNodesCommand } from "../protocols/Aws_json1_1"; +import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link ListClusterNodesCommand}. + */ +export interface ListClusterNodesCommandInput extends ListClusterNodesRequest {} +/** + * @public + * + * The output of {@link ListClusterNodesCommand}. + */ +export interface ListClusterNodesCommandOutput extends ListClusterNodesResponse, __MetadataBearer {} + +/** + * @public + *

Retrieves the list of instances (also called nodes interchangeably) + * in a SageMaker HyperPod cluster.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListClusterNodesCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListClusterNodesCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // ListClusterNodesRequest + * ClusterName: "STRING_VALUE", // required + * CreationTimeAfter: new Date("TIMESTAMP"), + * CreationTimeBefore: new Date("TIMESTAMP"), + * InstanceGroupNameContains: "STRING_VALUE", + * MaxResults: Number("int"), + * NextToken: "STRING_VALUE", + * SortBy: "CREATION_TIME" || "NAME", + * SortOrder: "Ascending" || "Descending", + * }; + * const command = new ListClusterNodesCommand(input); + * const response = await client.send(command); + * // { // ListClusterNodesResponse + * // NextToken: "STRING_VALUE", // required + * // ClusterNodeSummaries: [ // ClusterNodeSummaries // required + * // { // ClusterNodeSummary + * // InstanceGroupName: "STRING_VALUE", // required + * // InstanceId: "STRING_VALUE", // required + * // InstanceType: "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.12xlarge" || "ml.g5.16xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.c5n.large" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge", // required + * // LaunchTime: new Date("TIMESTAMP"), // required + * // InstanceStatus: { // ClusterInstanceStatusDetails + * // Status: "Running" || "Failure" || "Pending" || "ShuttingDown" || "SystemUpdating", // required + * // Message: "STRING_VALUE", + * // }, + * // }, + * // ], + * // }; + * + * ``` + * + * @param ListClusterNodesCommandInput - {@link ListClusterNodesCommandInput} + * @returns {@link ListClusterNodesCommandOutput} + * @see {@link ListClusterNodesCommandInput} for command's `input` shape. + * @see {@link ListClusterNodesCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for SageMakerClient's `config` shape. + * + * @throws {@link ResourceNotFound} (client fault) + *

Resource being access is not found.

+ * + * @throws {@link SageMakerServiceException} + *

Base exception class for all service exceptions from SageMaker service.

+ * + */ +export class ListClusterNodesCommand extends $Command< + ListClusterNodesCommandInput, + ListClusterNodesCommandOutput, + SageMakerClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListClusterNodesCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack, + configuration: SageMakerClientResolvedConfig, + options?: __HttpHandlerOptions + ): Handler { + this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); + this.middlewareStack.use( + getEndpointPlugin(configuration, ListClusterNodesCommand.getEndpointParameterInstructions()) + ); + + const stack = clientStack.concat(this.middlewareStack); + + const { logger } = configuration; + const clientName = "SageMakerClient"; + const commandName = "ListClusterNodesCommand"; + const handlerExecutionContext: HandlerExecutionContext = { + logger, + clientName, + commandName, + inputFilterSensitiveLog: (_: any) => _, + outputFilterSensitiveLog: (_: any) => _, + [SMITHY_CONTEXT_KEY]: { + service: "SageMaker", + operation: "ListClusterNodes", + }, + }; + const { requestHandler } = configuration; + return stack.resolve( + (request: FinalizeHandlerArguments) => + requestHandler.handle(request.request as __HttpRequest, options || {}), + handlerExecutionContext + ); + } + + /** + * @internal + */ + private serialize(input: ListClusterNodesCommandInput, context: __SerdeContext): Promise<__HttpRequest> { + return se_ListClusterNodesCommand(input, context); + } + + /** + * @internal + */ + private deserialize(output: __HttpResponse, context: __SerdeContext): Promise { + return de_ListClusterNodesCommand(output, context); + } +} diff --git a/clients/client-sagemaker/src/commands/ListClustersCommand.ts b/clients/client-sagemaker/src/commands/ListClustersCommand.ts new file mode 100644 index 000000000000..9c5beb6fef50 --- /dev/null +++ b/clients/client-sagemaker/src/commands/ListClustersCommand.ts @@ -0,0 +1,151 @@ +// smithy-typescript generated code +import { EndpointParameterInstructions, getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http"; +import { Command as $Command } from "@smithy/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, + SMITHY_CONTEXT_KEY, +} from "@smithy/types"; + +import { ListClustersRequest, ListClustersResponse } from "../models/models_3"; +import { de_ListClustersCommand, se_ListClustersCommand } from "../protocols/Aws_json1_1"; +import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link ListClustersCommand}. + */ +export interface ListClustersCommandInput extends ListClustersRequest {} +/** + * @public + * + * The output of {@link ListClustersCommand}. + */ +export interface ListClustersCommandOutput extends ListClustersResponse, __MetadataBearer {} + +/** + * @public + *

Retrieves the list of SageMaker HyperPod clusters.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListClustersCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListClustersCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // ListClustersRequest + * CreationTimeAfter: new Date("TIMESTAMP"), + * CreationTimeBefore: new Date("TIMESTAMP"), + * MaxResults: Number("int"), + * NameContains: "STRING_VALUE", + * NextToken: "STRING_VALUE", + * SortBy: "CREATION_TIME" || "NAME", + * SortOrder: "Ascending" || "Descending", + * }; + * const command = new ListClustersCommand(input); + * const response = await client.send(command); + * // { // ListClustersResponse + * // NextToken: "STRING_VALUE", // required + * // ClusterSummaries: [ // ClusterSummaries // required + * // { // ClusterSummary + * // ClusterArn: "STRING_VALUE", // required + * // ClusterName: "STRING_VALUE", // required + * // CreationTime: new Date("TIMESTAMP"), // required + * // ClusterStatus: "Creating" || "Deleting" || "Failed" || "InService" || "RollingBack" || "SystemUpdating" || "Updating", // required + * // }, + * // ], + * // }; + * + * ``` + * + * @param ListClustersCommandInput - {@link ListClustersCommandInput} + * @returns {@link ListClustersCommandOutput} + * @see {@link ListClustersCommandInput} for command's `input` shape. + * @see {@link ListClustersCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for SageMakerClient's `config` shape. + * + * @throws {@link SageMakerServiceException} + *

Base exception class for all service exceptions from SageMaker service.

+ * + */ +export class ListClustersCommand extends $Command< + ListClustersCommandInput, + ListClustersCommandOutput, + SageMakerClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListClustersCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack, + configuration: SageMakerClientResolvedConfig, + options?: __HttpHandlerOptions + ): Handler { + this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); + this.middlewareStack.use(getEndpointPlugin(configuration, ListClustersCommand.getEndpointParameterInstructions())); + + const stack = clientStack.concat(this.middlewareStack); + + const { logger } = configuration; + const clientName = "SageMakerClient"; + const commandName = "ListClustersCommand"; + const handlerExecutionContext: HandlerExecutionContext = { + logger, + clientName, + commandName, + inputFilterSensitiveLog: (_: any) => _, + outputFilterSensitiveLog: (_: any) => _, + [SMITHY_CONTEXT_KEY]: { + service: "SageMaker", + operation: "ListClusters", + }, + }; + const { requestHandler } = configuration; + return stack.resolve( + (request: FinalizeHandlerArguments) => + requestHandler.handle(request.request as __HttpRequest, options || {}), + handlerExecutionContext + ); + } + + /** + * @internal + */ + private serialize(input: ListClustersCommandInput, context: __SerdeContext): Promise<__HttpRequest> { + return se_ListClustersCommand(input, context); + } + + /** + * @internal + */ + private deserialize(output: __HttpResponse, context: __SerdeContext): Promise { + return de_ListClustersCommand(output, context); + } +} diff --git a/clients/client-sagemaker/src/commands/ListInferenceComponentsCommand.ts b/clients/client-sagemaker/src/commands/ListInferenceComponentsCommand.ts new file mode 100644 index 000000000000..c8b2bcc65e99 --- /dev/null +++ b/clients/client-sagemaker/src/commands/ListInferenceComponentsCommand.ts @@ -0,0 +1,162 @@ +// smithy-typescript generated code +import { EndpointParameterInstructions, getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http"; +import { Command as $Command } from "@smithy/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, + SMITHY_CONTEXT_KEY, +} from "@smithy/types"; + +import { ListInferenceComponentsInput, ListInferenceComponentsOutput } from "../models/models_3"; +import { de_ListInferenceComponentsCommand, se_ListInferenceComponentsCommand } from "../protocols/Aws_json1_1"; +import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link ListInferenceComponentsCommand}. + */ +export interface ListInferenceComponentsCommandInput extends ListInferenceComponentsInput {} +/** + * @public + * + * The output of {@link ListInferenceComponentsCommand}. + */ +export interface ListInferenceComponentsCommandOutput extends ListInferenceComponentsOutput, __MetadataBearer {} + +/** + * @public + *

Lists the inference components in your account and their properties.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListInferenceComponentsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListInferenceComponentsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // ListInferenceComponentsInput + * SortBy: "Name" || "CreationTime" || "Status", + * SortOrder: "Ascending" || "Descending", + * NextToken: "STRING_VALUE", + * MaxResults: Number("int"), + * NameContains: "STRING_VALUE", + * CreationTimeBefore: new Date("TIMESTAMP"), + * CreationTimeAfter: new Date("TIMESTAMP"), + * LastModifiedTimeBefore: new Date("TIMESTAMP"), + * LastModifiedTimeAfter: new Date("TIMESTAMP"), + * StatusEquals: "InService" || "Creating" || "Updating" || "Failed" || "Deleting", + * EndpointNameEquals: "STRING_VALUE", + * VariantNameEquals: "STRING_VALUE", + * }; + * const command = new ListInferenceComponentsCommand(input); + * const response = await client.send(command); + * // { // ListInferenceComponentsOutput + * // InferenceComponents: [ // InferenceComponentSummaryList // required + * // { // InferenceComponentSummary + * // CreationTime: new Date("TIMESTAMP"), // required + * // InferenceComponentArn: "STRING_VALUE", // required + * // InferenceComponentName: "STRING_VALUE", // required + * // EndpointArn: "STRING_VALUE", // required + * // EndpointName: "STRING_VALUE", // required + * // VariantName: "STRING_VALUE", // required + * // InferenceComponentStatus: "InService" || "Creating" || "Updating" || "Failed" || "Deleting", + * // LastModifiedTime: new Date("TIMESTAMP"), // required + * // }, + * // ], + * // NextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListInferenceComponentsCommandInput - {@link ListInferenceComponentsCommandInput} + * @returns {@link ListInferenceComponentsCommandOutput} + * @see {@link ListInferenceComponentsCommandInput} for command's `input` shape. + * @see {@link ListInferenceComponentsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for SageMakerClient's `config` shape. + * + * @throws {@link SageMakerServiceException} + *

Base exception class for all service exceptions from SageMaker service.

+ * + */ +export class ListInferenceComponentsCommand extends $Command< + ListInferenceComponentsCommandInput, + ListInferenceComponentsCommandOutput, + SageMakerClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListInferenceComponentsCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack, + configuration: SageMakerClientResolvedConfig, + options?: __HttpHandlerOptions + ): Handler { + this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); + this.middlewareStack.use( + getEndpointPlugin(configuration, ListInferenceComponentsCommand.getEndpointParameterInstructions()) + ); + + const stack = clientStack.concat(this.middlewareStack); + + const { logger } = configuration; + const clientName = "SageMakerClient"; + const commandName = "ListInferenceComponentsCommand"; + const handlerExecutionContext: HandlerExecutionContext = { + logger, + clientName, + commandName, + inputFilterSensitiveLog: (_: any) => _, + outputFilterSensitiveLog: (_: any) => _, + [SMITHY_CONTEXT_KEY]: { + service: "SageMaker", + operation: "ListInferenceComponents", + }, + }; + const { requestHandler } = configuration; + return stack.resolve( + (request: FinalizeHandlerArguments) => + requestHandler.handle(request.request as __HttpRequest, options || {}), + handlerExecutionContext + ); + } + + /** + * @internal + */ + private serialize(input: ListInferenceComponentsCommandInput, context: __SerdeContext): Promise<__HttpRequest> { + return se_ListInferenceComponentsCommand(input, context); + } + + /** + * @internal + */ + private deserialize(output: __HttpResponse, context: __SerdeContext): Promise { + return de_ListInferenceComponentsCommand(output, context); + } +} diff --git a/clients/client-sagemaker/src/commands/ListResourceCatalogsCommand.ts b/clients/client-sagemaker/src/commands/ListResourceCatalogsCommand.ts index 1f5434e205ce..e4a625da03a5 100644 --- a/clients/client-sagemaker/src/commands/ListResourceCatalogsCommand.ts +++ b/clients/client-sagemaker/src/commands/ListResourceCatalogsCommand.ts @@ -14,7 +14,7 @@ import { SMITHY_CONTEXT_KEY, } from "@smithy/types"; -import { ListResourceCatalogsRequest, ListResourceCatalogsResponse } from "../models/models_3"; +import { ListResourceCatalogsRequest, ListResourceCatalogsResponse } from "../models/models_4"; import { de_ListResourceCatalogsCommand, se_ListResourceCatalogsCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/ListSpacesCommand.ts b/clients/client-sagemaker/src/commands/ListSpacesCommand.ts index d847e56c2224..5a2492e7e8af 100644 --- a/clients/client-sagemaker/src/commands/ListSpacesCommand.ts +++ b/clients/client-sagemaker/src/commands/ListSpacesCommand.ts @@ -14,7 +14,7 @@ import { SMITHY_CONTEXT_KEY, } from "@smithy/types"; -import { ListSpacesRequest, ListSpacesResponse } from "../models/models_3"; +import { ListSpacesRequest, ListSpacesResponse } from "../models/models_4"; import { de_ListSpacesCommand, se_ListSpacesCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/ListStageDevicesCommand.ts b/clients/client-sagemaker/src/commands/ListStageDevicesCommand.ts index e7b30ab66ea8..1df93ecc13ce 100644 --- a/clients/client-sagemaker/src/commands/ListStageDevicesCommand.ts +++ b/clients/client-sagemaker/src/commands/ListStageDevicesCommand.ts @@ -14,7 +14,7 @@ import { SMITHY_CONTEXT_KEY, } from "@smithy/types"; -import { ListStageDevicesRequest, ListStageDevicesResponse } from "../models/models_3"; +import { ListStageDevicesRequest, ListStageDevicesResponse } from "../models/models_4"; import { de_ListStageDevicesCommand, se_ListStageDevicesCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/ListStudioLifecycleConfigsCommand.ts b/clients/client-sagemaker/src/commands/ListStudioLifecycleConfigsCommand.ts index 5728df05d507..e9c015c4495f 100644 --- a/clients/client-sagemaker/src/commands/ListStudioLifecycleConfigsCommand.ts +++ b/clients/client-sagemaker/src/commands/ListStudioLifecycleConfigsCommand.ts @@ -14,7 +14,7 @@ import { SMITHY_CONTEXT_KEY, } from "@smithy/types"; -import { ListStudioLifecycleConfigsRequest, ListStudioLifecycleConfigsResponse } from "../models/models_3"; +import { ListStudioLifecycleConfigsRequest, ListStudioLifecycleConfigsResponse } from "../models/models_4"; import { de_ListStudioLifecycleConfigsCommand, se_ListStudioLifecycleConfigsCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; @@ -37,7 +37,7 @@ export interface ListStudioLifecycleConfigsCommandOutput extends ListStudioLifec /** * @public - *

Lists the Studio Lifecycle Configurations in your Amazon Web Services Account.

+ *

Lists the Amazon SageMaker Studio Lifecycle Configurations in your Amazon Web Services Account.

* @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/ListSubscribedWorkteamsCommand.ts b/clients/client-sagemaker/src/commands/ListSubscribedWorkteamsCommand.ts index 64d477dc0933..1f2a9349ec2f 100644 --- a/clients/client-sagemaker/src/commands/ListSubscribedWorkteamsCommand.ts +++ b/clients/client-sagemaker/src/commands/ListSubscribedWorkteamsCommand.ts @@ -14,7 +14,7 @@ import { SMITHY_CONTEXT_KEY, } from "@smithy/types"; -import { ListSubscribedWorkteamsRequest, ListSubscribedWorkteamsResponse } from "../models/models_3"; +import { ListSubscribedWorkteamsRequest, ListSubscribedWorkteamsResponse } from "../models/models_4"; import { de_ListSubscribedWorkteamsCommand, se_ListSubscribedWorkteamsCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/ListTagsCommand.ts b/clients/client-sagemaker/src/commands/ListTagsCommand.ts index 9555123d74e6..e8c7e46d9ae1 100644 --- a/clients/client-sagemaker/src/commands/ListTagsCommand.ts +++ b/clients/client-sagemaker/src/commands/ListTagsCommand.ts @@ -14,7 +14,7 @@ import { SMITHY_CONTEXT_KEY, } from "@smithy/types"; -import { ListTagsInput, ListTagsOutput } from "../models/models_3"; +import { ListTagsInput, ListTagsOutput } from "../models/models_4"; import { de_ListTagsCommand, se_ListTagsCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/ListTrainingJobsCommand.ts b/clients/client-sagemaker/src/commands/ListTrainingJobsCommand.ts index 693421541d50..7cae7ef92282 100644 --- a/clients/client-sagemaker/src/commands/ListTrainingJobsCommand.ts +++ b/clients/client-sagemaker/src/commands/ListTrainingJobsCommand.ts @@ -14,7 +14,7 @@ import { SMITHY_CONTEXT_KEY, } from "@smithy/types"; -import { ListTrainingJobsRequest, ListTrainingJobsResponse } from "../models/models_3"; +import { ListTrainingJobsRequest, ListTrainingJobsResponse } from "../models/models_4"; import { de_ListTrainingJobsCommand, se_ListTrainingJobsCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/ListTrainingJobsForHyperParameterTuningJobCommand.ts b/clients/client-sagemaker/src/commands/ListTrainingJobsForHyperParameterTuningJobCommand.ts index eef381744245..378b911c59b4 100644 --- a/clients/client-sagemaker/src/commands/ListTrainingJobsForHyperParameterTuningJobCommand.ts +++ b/clients/client-sagemaker/src/commands/ListTrainingJobsForHyperParameterTuningJobCommand.ts @@ -17,7 +17,7 @@ import { import { ListTrainingJobsForHyperParameterTuningJobRequest, ListTrainingJobsForHyperParameterTuningJobResponse, -} from "../models/models_3"; +} from "../models/models_4"; import { de_ListTrainingJobsForHyperParameterTuningJobCommand, se_ListTrainingJobsForHyperParameterTuningJobCommand, diff --git a/clients/client-sagemaker/src/commands/ListTransformJobsCommand.ts b/clients/client-sagemaker/src/commands/ListTransformJobsCommand.ts index 15468c631767..63d07df48628 100644 --- a/clients/client-sagemaker/src/commands/ListTransformJobsCommand.ts +++ b/clients/client-sagemaker/src/commands/ListTransformJobsCommand.ts @@ -14,7 +14,7 @@ import { SMITHY_CONTEXT_KEY, } from "@smithy/types"; -import { ListTransformJobsRequest, ListTransformJobsResponse } from "../models/models_3"; +import { ListTransformJobsRequest, ListTransformJobsResponse } from "../models/models_4"; import { de_ListTransformJobsCommand, se_ListTransformJobsCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/ListTrialComponentsCommand.ts b/clients/client-sagemaker/src/commands/ListTrialComponentsCommand.ts index 5b293bdfb7f2..823130436bb1 100644 --- a/clients/client-sagemaker/src/commands/ListTrialComponentsCommand.ts +++ b/clients/client-sagemaker/src/commands/ListTrialComponentsCommand.ts @@ -14,7 +14,7 @@ import { SMITHY_CONTEXT_KEY, } from "@smithy/types"; -import { ListTrialComponentsRequest, ListTrialComponentsResponse } from "../models/models_3"; +import { ListTrialComponentsRequest, ListTrialComponentsResponse } from "../models/models_4"; import { de_ListTrialComponentsCommand, se_ListTrialComponentsCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/ListTrialsCommand.ts b/clients/client-sagemaker/src/commands/ListTrialsCommand.ts index c1d9f9afeb81..d4fdb314acd6 100644 --- a/clients/client-sagemaker/src/commands/ListTrialsCommand.ts +++ b/clients/client-sagemaker/src/commands/ListTrialsCommand.ts @@ -14,7 +14,7 @@ import { SMITHY_CONTEXT_KEY, } from "@smithy/types"; -import { ListTrialsRequest, ListTrialsResponse } from "../models/models_3"; +import { ListTrialsRequest, ListTrialsResponse } from "../models/models_4"; import { de_ListTrialsCommand, se_ListTrialsCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/ListUserProfilesCommand.ts b/clients/client-sagemaker/src/commands/ListUserProfilesCommand.ts index 8b51148ae790..2bb52a41cdb7 100644 --- a/clients/client-sagemaker/src/commands/ListUserProfilesCommand.ts +++ b/clients/client-sagemaker/src/commands/ListUserProfilesCommand.ts @@ -14,7 +14,7 @@ import { SMITHY_CONTEXT_KEY, } from "@smithy/types"; -import { ListUserProfilesRequest, ListUserProfilesResponse } from "../models/models_3"; +import { ListUserProfilesRequest, ListUserProfilesResponse } from "../models/models_4"; import { de_ListUserProfilesCommand, se_ListUserProfilesCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/ListWorkforcesCommand.ts b/clients/client-sagemaker/src/commands/ListWorkforcesCommand.ts index 9a7a33a5cd54..26271a4a5c37 100644 --- a/clients/client-sagemaker/src/commands/ListWorkforcesCommand.ts +++ b/clients/client-sagemaker/src/commands/ListWorkforcesCommand.ts @@ -14,7 +14,7 @@ import { SMITHY_CONTEXT_KEY, } from "@smithy/types"; -import { ListWorkforcesRequest, ListWorkforcesResponse } from "../models/models_3"; +import { ListWorkforcesRequest, ListWorkforcesResponse } from "../models/models_4"; import { de_ListWorkforcesCommand, se_ListWorkforcesCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/ListWorkteamsCommand.ts b/clients/client-sagemaker/src/commands/ListWorkteamsCommand.ts index 0375ac9ddef9..8af9191ec75a 100644 --- a/clients/client-sagemaker/src/commands/ListWorkteamsCommand.ts +++ b/clients/client-sagemaker/src/commands/ListWorkteamsCommand.ts @@ -14,7 +14,7 @@ import { SMITHY_CONTEXT_KEY, } from "@smithy/types"; -import { ListWorkteamsRequest, ListWorkteamsResponse } from "../models/models_3"; +import { ListWorkteamsRequest, ListWorkteamsResponse } from "../models/models_4"; import { de_ListWorkteamsCommand, se_ListWorkteamsCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/SearchCommand.ts b/clients/client-sagemaker/src/commands/SearchCommand.ts index c0f6f7387523..ab28eeed98c9 100644 --- a/clients/client-sagemaker/src/commands/SearchCommand.ts +++ b/clients/client-sagemaker/src/commands/SearchCommand.ts @@ -886,6 +886,14 @@ export interface SearchCommandOutput extends SearchResponse, __MetadataBearer {} * // MaxConcurrency: Number("int"), // required * // ProvisionedConcurrency: Number("int"), * // }, + * // ManagedInstanceScaling: { // ProductionVariantManagedInstanceScaling + * // Status: "ENABLED" || "DISABLED", + * // MinInstanceCount: Number("int"), + * // MaxInstanceCount: Number("int"), + * // }, + * // RoutingConfig: { // ProductionVariantRoutingConfig + * // RoutingStrategy: "LEAST_OUTSTANDING_REQUESTS" || "RANDOM", // required + * // }, * // }, * // ], * // DataCaptureConfig: { // DataCaptureConfigSummary @@ -1058,6 +1066,14 @@ export interface SearchCommandOutput extends SearchResponse, __MetadataBearer {} * // MaxConcurrency: Number("int"), // required * // ProvisionedConcurrency: Number("int"), * // }, + * // ManagedInstanceScaling: { + * // Status: "ENABLED" || "DISABLED", + * // MinInstanceCount: Number("int"), + * // MaxInstanceCount: Number("int"), + * // }, + * // RoutingConfig: { + * // RoutingStrategy: "LEAST_OUTSTANDING_REQUESTS" || "RANDOM", // required + * // }, * // }, * // ], * // }, diff --git a/clients/client-sagemaker/src/commands/UpdateClusterCommand.ts b/clients/client-sagemaker/src/commands/UpdateClusterCommand.ts new file mode 100644 index 000000000000..ce3edc6ae64e --- /dev/null +++ b/clients/client-sagemaker/src/commands/UpdateClusterCommand.ts @@ -0,0 +1,161 @@ +// smithy-typescript generated code +import { EndpointParameterInstructions, getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http"; +import { Command as $Command } from "@smithy/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, + SMITHY_CONTEXT_KEY, +} from "@smithy/types"; + +import { UpdateClusterRequest, UpdateClusterResponse } from "../models/models_4"; +import { de_UpdateClusterCommand, se_UpdateClusterCommand } from "../protocols/Aws_json1_1"; +import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link UpdateClusterCommand}. + */ +export interface UpdateClusterCommandInput extends UpdateClusterRequest {} +/** + * @public + * + * The output of {@link UpdateClusterCommand}. + */ +export interface UpdateClusterCommandOutput extends UpdateClusterResponse, __MetadataBearer {} + +/** + * @public + *

Update a SageMaker HyperPod cluster.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, UpdateClusterCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, UpdateClusterCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // UpdateClusterRequest + * ClusterName: "STRING_VALUE", // required + * InstanceGroups: [ // ClusterInstanceGroupSpecifications // required + * { // ClusterInstanceGroupSpecification + * InstanceCount: Number("int"), // required + * InstanceGroupName: "STRING_VALUE", // required + * InstanceType: "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.12xlarge" || "ml.g5.16xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.c5n.large" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge", // required + * LifeCycleConfig: { // ClusterLifeCycleConfig + * SourceS3Uri: "STRING_VALUE", // required + * OnCreate: "STRING_VALUE", // required + * }, + * ExecutionRole: "STRING_VALUE", // required + * ThreadsPerCore: Number("int"), + * }, + * ], + * }; + * const command = new UpdateClusterCommand(input); + * const response = await client.send(command); + * // { // UpdateClusterResponse + * // ClusterArn: "STRING_VALUE", // required + * // }; + * + * ``` + * + * @param UpdateClusterCommandInput - {@link UpdateClusterCommandInput} + * @returns {@link UpdateClusterCommandOutput} + * @see {@link UpdateClusterCommandInput} for command's `input` shape. + * @see {@link UpdateClusterCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for SageMakerClient's `config` shape. + * + * @throws {@link ConflictException} (client fault) + *

There was a conflict when you attempted to modify a SageMaker entity such as an + * Experiment or Artifact.

+ * + * @throws {@link ResourceLimitExceeded} (client fault) + *

You have exceeded an SageMaker resource limit. For example, you might have too many + * training jobs created.

+ * + * @throws {@link ResourceNotFound} (client fault) + *

Resource being access is not found.

+ * + * @throws {@link SageMakerServiceException} + *

Base exception class for all service exceptions from SageMaker service.

+ * + */ +export class UpdateClusterCommand extends $Command< + UpdateClusterCommandInput, + UpdateClusterCommandOutput, + SageMakerClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: UpdateClusterCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack, + configuration: SageMakerClientResolvedConfig, + options?: __HttpHandlerOptions + ): Handler { + this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); + this.middlewareStack.use(getEndpointPlugin(configuration, UpdateClusterCommand.getEndpointParameterInstructions())); + + const stack = clientStack.concat(this.middlewareStack); + + const { logger } = configuration; + const clientName = "SageMakerClient"; + const commandName = "UpdateClusterCommand"; + const handlerExecutionContext: HandlerExecutionContext = { + logger, + clientName, + commandName, + inputFilterSensitiveLog: (_: any) => _, + outputFilterSensitiveLog: (_: any) => _, + [SMITHY_CONTEXT_KEY]: { + service: "SageMaker", + operation: "UpdateCluster", + }, + }; + const { requestHandler } = configuration; + return stack.resolve( + (request: FinalizeHandlerArguments) => + requestHandler.handle(request.request as __HttpRequest, options || {}), + handlerExecutionContext + ); + } + + /** + * @internal + */ + private serialize(input: UpdateClusterCommandInput, context: __SerdeContext): Promise<__HttpRequest> { + return se_UpdateClusterCommand(input, context); + } + + /** + * @internal + */ + private deserialize(output: __HttpResponse, context: __SerdeContext): Promise { + return de_UpdateClusterCommand(output, context); + } +} diff --git a/clients/client-sagemaker/src/commands/UpdateDomainCommand.ts b/clients/client-sagemaker/src/commands/UpdateDomainCommand.ts index f3da07436868..ff60d680f943 100644 --- a/clients/client-sagemaker/src/commands/UpdateDomainCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateDomainCommand.ts @@ -60,6 +60,7 @@ export interface UpdateDomainCommandOutput extends UpdateDomainResponse, __Metad * DefaultResourceSpec: { // ResourceSpec * SageMakerImageArn: "STRING_VALUE", * SageMakerImageVersionArn: "STRING_VALUE", + * SageMakerImageVersionAlias: "STRING_VALUE", * InstanceType: "system" || "ml.t3.micro" || "ml.t3.small" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.8xlarge" || "ml.m5d.12xlarge" || "ml.m5d.16xlarge" || "ml.m5d.24xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.geospatial.interactive" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge", * LifecycleConfigArn: "STRING_VALUE", * }, @@ -76,6 +77,7 @@ export interface UpdateDomainCommandOutput extends UpdateDomainResponse, __Metad * DefaultResourceSpec: { * SageMakerImageArn: "STRING_VALUE", * SageMakerImageVersionArn: "STRING_VALUE", + * SageMakerImageVersionAlias: "STRING_VALUE", * InstanceType: "system" || "ml.t3.micro" || "ml.t3.small" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.8xlarge" || "ml.m5d.12xlarge" || "ml.m5d.16xlarge" || "ml.m5d.24xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.geospatial.interactive" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge", * LifecycleConfigArn: "STRING_VALUE", * }, @@ -94,6 +96,7 @@ export interface UpdateDomainCommandOutput extends UpdateDomainResponse, __Metad * DefaultResourceSpec: { * SageMakerImageArn: "STRING_VALUE", * SageMakerImageVersionArn: "STRING_VALUE", + * SageMakerImageVersionAlias: "STRING_VALUE", * InstanceType: "system" || "ml.t3.micro" || "ml.t3.small" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.8xlarge" || "ml.m5d.12xlarge" || "ml.m5d.16xlarge" || "ml.m5d.24xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.geospatial.interactive" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge", * LifecycleConfigArn: "STRING_VALUE", * }, @@ -106,6 +109,7 @@ export interface UpdateDomainCommandOutput extends UpdateDomainResponse, __Metad * DefaultResourceSpec: { * SageMakerImageArn: "STRING_VALUE", * SageMakerImageVersionArn: "STRING_VALUE", + * SageMakerImageVersionAlias: "STRING_VALUE", * InstanceType: "system" || "ml.t3.micro" || "ml.t3.small" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.8xlarge" || "ml.m5d.12xlarge" || "ml.m5d.16xlarge" || "ml.m5d.24xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.geospatial.interactive" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge", * LifecycleConfigArn: "STRING_VALUE", * }, @@ -144,6 +148,8 @@ export interface UpdateDomainCommandOutput extends UpdateDomainResponse, __Metad * Status: "ENABLED" || "DISABLED", * }, * }, + * DefaultLandingUri: "STRING_VALUE", + * StudioWebPortal: "ENABLED" || "DISABLED", * }, * DomainSettingsForUpdate: { // DomainSettingsForUpdate * RStudioServerProDomainSettingsForUpdate: { // RStudioServerProDomainSettingsForUpdate @@ -151,6 +157,7 @@ export interface UpdateDomainCommandOutput extends UpdateDomainResponse, __Metad * DefaultResourceSpec: { * SageMakerImageArn: "STRING_VALUE", * SageMakerImageVersionArn: "STRING_VALUE", + * SageMakerImageVersionAlias: "STRING_VALUE", * InstanceType: "system" || "ml.t3.micro" || "ml.t3.small" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.8xlarge" || "ml.m5d.12xlarge" || "ml.m5d.16xlarge" || "ml.m5d.24xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.geospatial.interactive" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge", * LifecycleConfigArn: "STRING_VALUE", * }, @@ -193,6 +200,10 @@ export interface UpdateDomainCommandOutput extends UpdateDomainResponse, __Metad * }, * }, * AppSecurityGroupManagement: "Service" || "Customer", + * SubnetIds: [ // Subnets + * "STRING_VALUE", + * ], + * AppNetworkAccessType: "PublicInternetOnly" || "VpcOnly", * }; * const command = new UpdateDomainCommand(input); * const response = await client.send(command); diff --git a/clients/client-sagemaker/src/commands/UpdateInferenceComponentCommand.ts b/clients/client-sagemaker/src/commands/UpdateInferenceComponentCommand.ts new file mode 100644 index 000000000000..a326ccf04470 --- /dev/null +++ b/clients/client-sagemaker/src/commands/UpdateInferenceComponentCommand.ts @@ -0,0 +1,166 @@ +// smithy-typescript generated code +import { EndpointParameterInstructions, getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http"; +import { Command as $Command } from "@smithy/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, + SMITHY_CONTEXT_KEY, +} from "@smithy/types"; + +import { UpdateInferenceComponentInput, UpdateInferenceComponentOutput } from "../models/models_4"; +import { de_UpdateInferenceComponentCommand, se_UpdateInferenceComponentCommand } from "../protocols/Aws_json1_1"; +import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link UpdateInferenceComponentCommand}. + */ +export interface UpdateInferenceComponentCommandInput extends UpdateInferenceComponentInput {} +/** + * @public + * + * The output of {@link UpdateInferenceComponentCommand}. + */ +export interface UpdateInferenceComponentCommandOutput extends UpdateInferenceComponentOutput, __MetadataBearer {} + +/** + * @public + *

Updates an inference component.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, UpdateInferenceComponentCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, UpdateInferenceComponentCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // UpdateInferenceComponentInput + * InferenceComponentName: "STRING_VALUE", // required + * Specification: { // InferenceComponentSpecification + * ModelName: "STRING_VALUE", + * Container: { // InferenceComponentContainerSpecification + * Image: "STRING_VALUE", + * ArtifactUrl: "STRING_VALUE", + * Environment: { // EnvironmentMap + * "": "STRING_VALUE", + * }, + * }, + * StartupParameters: { // InferenceComponentStartupParameters + * ModelDataDownloadTimeoutInSeconds: Number("int"), + * ContainerStartupHealthCheckTimeoutInSeconds: Number("int"), + * }, + * ComputeResourceRequirements: { // InferenceComponentComputeResourceRequirements + * NumberOfCpuCoresRequired: Number("float"), + * NumberOfAcceleratorDevicesRequired: Number("float"), + * MinMemoryRequiredInMb: Number("int"), // required + * MaxMemoryRequiredInMb: Number("int"), + * }, + * }, + * RuntimeConfig: { // InferenceComponentRuntimeConfig + * CopyCount: Number("int"), // required + * }, + * }; + * const command = new UpdateInferenceComponentCommand(input); + * const response = await client.send(command); + * // { // UpdateInferenceComponentOutput + * // InferenceComponentArn: "STRING_VALUE", // required + * // }; + * + * ``` + * + * @param UpdateInferenceComponentCommandInput - {@link UpdateInferenceComponentCommandInput} + * @returns {@link UpdateInferenceComponentCommandOutput} + * @see {@link UpdateInferenceComponentCommandInput} for command's `input` shape. + * @see {@link UpdateInferenceComponentCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for SageMakerClient's `config` shape. + * + * @throws {@link ResourceLimitExceeded} (client fault) + *

You have exceeded an SageMaker resource limit. For example, you might have too many + * training jobs created.

+ * + * @throws {@link SageMakerServiceException} + *

Base exception class for all service exceptions from SageMaker service.

+ * + */ +export class UpdateInferenceComponentCommand extends $Command< + UpdateInferenceComponentCommandInput, + UpdateInferenceComponentCommandOutput, + SageMakerClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: UpdateInferenceComponentCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack, + configuration: SageMakerClientResolvedConfig, + options?: __HttpHandlerOptions + ): Handler { + this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); + this.middlewareStack.use( + getEndpointPlugin(configuration, UpdateInferenceComponentCommand.getEndpointParameterInstructions()) + ); + + const stack = clientStack.concat(this.middlewareStack); + + const { logger } = configuration; + const clientName = "SageMakerClient"; + const commandName = "UpdateInferenceComponentCommand"; + const handlerExecutionContext: HandlerExecutionContext = { + logger, + clientName, + commandName, + inputFilterSensitiveLog: (_: any) => _, + outputFilterSensitiveLog: (_: any) => _, + [SMITHY_CONTEXT_KEY]: { + service: "SageMaker", + operation: "UpdateInferenceComponent", + }, + }; + const { requestHandler } = configuration; + return stack.resolve( + (request: FinalizeHandlerArguments) => + requestHandler.handle(request.request as __HttpRequest, options || {}), + handlerExecutionContext + ); + } + + /** + * @internal + */ + private serialize(input: UpdateInferenceComponentCommandInput, context: __SerdeContext): Promise<__HttpRequest> { + return se_UpdateInferenceComponentCommand(input, context); + } + + /** + * @internal + */ + private deserialize(output: __HttpResponse, context: __SerdeContext): Promise { + return de_UpdateInferenceComponentCommand(output, context); + } +} diff --git a/clients/client-sagemaker/src/commands/UpdateInferenceComponentRuntimeConfigCommand.ts b/clients/client-sagemaker/src/commands/UpdateInferenceComponentRuntimeConfigCommand.ts new file mode 100644 index 000000000000..9d313055b8ea --- /dev/null +++ b/clients/client-sagemaker/src/commands/UpdateInferenceComponentRuntimeConfigCommand.ts @@ -0,0 +1,160 @@ +// smithy-typescript generated code +import { EndpointParameterInstructions, getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http"; +import { Command as $Command } from "@smithy/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, + SMITHY_CONTEXT_KEY, +} from "@smithy/types"; + +import { + UpdateInferenceComponentRuntimeConfigInput, + UpdateInferenceComponentRuntimeConfigOutput, +} from "../models/models_4"; +import { + de_UpdateInferenceComponentRuntimeConfigCommand, + se_UpdateInferenceComponentRuntimeConfigCommand, +} from "../protocols/Aws_json1_1"; +import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link UpdateInferenceComponentRuntimeConfigCommand}. + */ +export interface UpdateInferenceComponentRuntimeConfigCommandInput extends UpdateInferenceComponentRuntimeConfigInput {} +/** + * @public + * + * The output of {@link UpdateInferenceComponentRuntimeConfigCommand}. + */ +export interface UpdateInferenceComponentRuntimeConfigCommandOutput + extends UpdateInferenceComponentRuntimeConfigOutput, + __MetadataBearer {} + +/** + * @public + *

Runtime settings for a model that is deployed with an inference component.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, UpdateInferenceComponentRuntimeConfigCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, UpdateInferenceComponentRuntimeConfigCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const input = { // UpdateInferenceComponentRuntimeConfigInput + * InferenceComponentName: "STRING_VALUE", // required + * DesiredRuntimeConfig: { // InferenceComponentRuntimeConfig + * CopyCount: Number("int"), // required + * }, + * }; + * const command = new UpdateInferenceComponentRuntimeConfigCommand(input); + * const response = await client.send(command); + * // { // UpdateInferenceComponentRuntimeConfigOutput + * // InferenceComponentArn: "STRING_VALUE", // required + * // }; + * + * ``` + * + * @param UpdateInferenceComponentRuntimeConfigCommandInput - {@link UpdateInferenceComponentRuntimeConfigCommandInput} + * @returns {@link UpdateInferenceComponentRuntimeConfigCommandOutput} + * @see {@link UpdateInferenceComponentRuntimeConfigCommandInput} for command's `input` shape. + * @see {@link UpdateInferenceComponentRuntimeConfigCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for SageMakerClient's `config` shape. + * + * @throws {@link ResourceLimitExceeded} (client fault) + *

You have exceeded an SageMaker resource limit. For example, you might have too many + * training jobs created.

+ * + * @throws {@link SageMakerServiceException} + *

Base exception class for all service exceptions from SageMaker service.

+ * + */ +export class UpdateInferenceComponentRuntimeConfigCommand extends $Command< + UpdateInferenceComponentRuntimeConfigCommandInput, + UpdateInferenceComponentRuntimeConfigCommandOutput, + SageMakerClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: UpdateInferenceComponentRuntimeConfigCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack, + configuration: SageMakerClientResolvedConfig, + options?: __HttpHandlerOptions + ): Handler { + this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); + this.middlewareStack.use( + getEndpointPlugin(configuration, UpdateInferenceComponentRuntimeConfigCommand.getEndpointParameterInstructions()) + ); + + const stack = clientStack.concat(this.middlewareStack); + + const { logger } = configuration; + const clientName = "SageMakerClient"; + const commandName = "UpdateInferenceComponentRuntimeConfigCommand"; + const handlerExecutionContext: HandlerExecutionContext = { + logger, + clientName, + commandName, + inputFilterSensitiveLog: (_: any) => _, + outputFilterSensitiveLog: (_: any) => _, + [SMITHY_CONTEXT_KEY]: { + service: "SageMaker", + operation: "UpdateInferenceComponentRuntimeConfig", + }, + }; + const { requestHandler } = configuration; + return stack.resolve( + (request: FinalizeHandlerArguments) => + requestHandler.handle(request.request as __HttpRequest, options || {}), + handlerExecutionContext + ); + } + + /** + * @internal + */ + private serialize( + input: UpdateInferenceComponentRuntimeConfigCommandInput, + context: __SerdeContext + ): Promise<__HttpRequest> { + return se_UpdateInferenceComponentRuntimeConfigCommand(input, context); + } + + /** + * @internal + */ + private deserialize( + output: __HttpResponse, + context: __SerdeContext + ): Promise { + return de_UpdateInferenceComponentRuntimeConfigCommand(output, context); + } +} diff --git a/clients/client-sagemaker/src/commands/UpdateSpaceCommand.ts b/clients/client-sagemaker/src/commands/UpdateSpaceCommand.ts index 20de273a09fc..b380f1c3b054 100644 --- a/clients/client-sagemaker/src/commands/UpdateSpaceCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateSpaceCommand.ts @@ -52,6 +52,7 @@ export interface UpdateSpaceCommandOutput extends UpdateSpaceResponse, __Metadat * DefaultResourceSpec: { // ResourceSpec * SageMakerImageArn: "STRING_VALUE", * SageMakerImageVersionArn: "STRING_VALUE", + * SageMakerImageVersionAlias: "STRING_VALUE", * InstanceType: "system" || "ml.t3.micro" || "ml.t3.small" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.8xlarge" || "ml.m5d.12xlarge" || "ml.m5d.16xlarge" || "ml.m5d.24xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.geospatial.interactive" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge", * LifecycleConfigArn: "STRING_VALUE", * }, @@ -68,6 +69,7 @@ export interface UpdateSpaceCommandOutput extends UpdateSpaceResponse, __Metadat * DefaultResourceSpec: { * SageMakerImageArn: "STRING_VALUE", * SageMakerImageVersionArn: "STRING_VALUE", + * SageMakerImageVersionAlias: "STRING_VALUE", * InstanceType: "system" || "ml.t3.micro" || "ml.t3.small" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.8xlarge" || "ml.m5d.12xlarge" || "ml.m5d.16xlarge" || "ml.m5d.24xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.geospatial.interactive" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge", * LifecycleConfigArn: "STRING_VALUE", * }, diff --git a/clients/client-sagemaker/src/commands/UpdateUserProfileCommand.ts b/clients/client-sagemaker/src/commands/UpdateUserProfileCommand.ts index e71570e06a43..a3dd22b68611 100644 --- a/clients/client-sagemaker/src/commands/UpdateUserProfileCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateUserProfileCommand.ts @@ -61,6 +61,7 @@ export interface UpdateUserProfileCommandOutput extends UpdateUserProfileRespons * DefaultResourceSpec: { // ResourceSpec * SageMakerImageArn: "STRING_VALUE", * SageMakerImageVersionArn: "STRING_VALUE", + * SageMakerImageVersionAlias: "STRING_VALUE", * InstanceType: "system" || "ml.t3.micro" || "ml.t3.small" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.8xlarge" || "ml.m5d.12xlarge" || "ml.m5d.16xlarge" || "ml.m5d.24xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.geospatial.interactive" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge", * LifecycleConfigArn: "STRING_VALUE", * }, @@ -77,6 +78,7 @@ export interface UpdateUserProfileCommandOutput extends UpdateUserProfileRespons * DefaultResourceSpec: { * SageMakerImageArn: "STRING_VALUE", * SageMakerImageVersionArn: "STRING_VALUE", + * SageMakerImageVersionAlias: "STRING_VALUE", * InstanceType: "system" || "ml.t3.micro" || "ml.t3.small" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.8xlarge" || "ml.m5d.12xlarge" || "ml.m5d.16xlarge" || "ml.m5d.24xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.geospatial.interactive" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge", * LifecycleConfigArn: "STRING_VALUE", * }, @@ -95,6 +97,7 @@ export interface UpdateUserProfileCommandOutput extends UpdateUserProfileRespons * DefaultResourceSpec: { * SageMakerImageArn: "STRING_VALUE", * SageMakerImageVersionArn: "STRING_VALUE", + * SageMakerImageVersionAlias: "STRING_VALUE", * InstanceType: "system" || "ml.t3.micro" || "ml.t3.small" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.8xlarge" || "ml.m5d.12xlarge" || "ml.m5d.16xlarge" || "ml.m5d.24xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.geospatial.interactive" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge", * LifecycleConfigArn: "STRING_VALUE", * }, @@ -107,6 +110,7 @@ export interface UpdateUserProfileCommandOutput extends UpdateUserProfileRespons * DefaultResourceSpec: { * SageMakerImageArn: "STRING_VALUE", * SageMakerImageVersionArn: "STRING_VALUE", + * SageMakerImageVersionAlias: "STRING_VALUE", * InstanceType: "system" || "ml.t3.micro" || "ml.t3.small" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.8xlarge" || "ml.m5.12xlarge" || "ml.m5.16xlarge" || "ml.m5.24xlarge" || "ml.m5d.large" || "ml.m5d.xlarge" || "ml.m5d.2xlarge" || "ml.m5d.4xlarge" || "ml.m5d.8xlarge" || "ml.m5d.12xlarge" || "ml.m5d.16xlarge" || "ml.m5d.24xlarge" || "ml.c5.large" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.12xlarge" || "ml.c5.18xlarge" || "ml.c5.24xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.geospatial.interactive" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge", * LifecycleConfigArn: "STRING_VALUE", * }, @@ -145,6 +149,8 @@ export interface UpdateUserProfileCommandOutput extends UpdateUserProfileRespons * Status: "ENABLED" || "DISABLED", * }, * }, + * DefaultLandingUri: "STRING_VALUE", + * StudioWebPortal: "ENABLED" || "DISABLED", * }, * }; * const command = new UpdateUserProfileCommand(input); diff --git a/clients/client-sagemaker/src/commands/index.ts b/clients/client-sagemaker/src/commands/index.ts index 5edff1c45f4b..db2d7219912b 100644 --- a/clients/client-sagemaker/src/commands/index.ts +++ b/clients/client-sagemaker/src/commands/index.ts @@ -10,6 +10,7 @@ export * from "./CreateAppImageConfigCommand"; export * from "./CreateArtifactCommand"; export * from "./CreateAutoMLJobCommand"; export * from "./CreateAutoMLJobV2Command"; +export * from "./CreateClusterCommand"; export * from "./CreateCodeRepositoryCommand"; export * from "./CreateCompilationJobCommand"; export * from "./CreateContextCommand"; @@ -29,6 +30,7 @@ export * from "./CreateHumanTaskUiCommand"; export * from "./CreateHyperParameterTuningJobCommand"; export * from "./CreateImageCommand"; export * from "./CreateImageVersionCommand"; +export * from "./CreateInferenceComponentCommand"; export * from "./CreateInferenceExperimentCommand"; export * from "./CreateInferenceRecommendationsJobCommand"; export * from "./CreateLabelingJobCommand"; @@ -63,6 +65,7 @@ export * from "./DeleteAppCommand"; export * from "./DeleteAppImageConfigCommand"; export * from "./DeleteArtifactCommand"; export * from "./DeleteAssociationCommand"; +export * from "./DeleteClusterCommand"; export * from "./DeleteCodeRepositoryCommand"; export * from "./DeleteContextCommand"; export * from "./DeleteDataQualityJobDefinitionCommand"; @@ -80,6 +83,7 @@ export * from "./DeleteHubContentCommand"; export * from "./DeleteHumanTaskUiCommand"; export * from "./DeleteImageCommand"; export * from "./DeleteImageVersionCommand"; +export * from "./DeleteInferenceComponentCommand"; export * from "./DeleteInferenceExperimentCommand"; export * from "./DeleteModelBiasJobDefinitionCommand"; export * from "./DeleteModelCardCommand"; @@ -110,6 +114,8 @@ export * from "./DescribeAppImageConfigCommand"; export * from "./DescribeArtifactCommand"; export * from "./DescribeAutoMLJobCommand"; export * from "./DescribeAutoMLJobV2Command"; +export * from "./DescribeClusterCommand"; +export * from "./DescribeClusterNodeCommand"; export * from "./DescribeCodeRepositoryCommand"; export * from "./DescribeCompilationJobCommand"; export * from "./DescribeContextCommand"; @@ -131,6 +137,7 @@ export * from "./DescribeHumanTaskUiCommand"; export * from "./DescribeHyperParameterTuningJobCommand"; export * from "./DescribeImageCommand"; export * from "./DescribeImageVersionCommand"; +export * from "./DescribeInferenceComponentCommand"; export * from "./DescribeInferenceExperimentCommand"; export * from "./DescribeInferenceRecommendationsJobCommand"; export * from "./DescribeLabelingJobCommand"; @@ -180,6 +187,8 @@ export * from "./ListArtifactsCommand"; export * from "./ListAssociationsCommand"; export * from "./ListAutoMLJobsCommand"; export * from "./ListCandidatesForAutoMLJobCommand"; +export * from "./ListClusterNodesCommand"; +export * from "./ListClustersCommand"; export * from "./ListCodeRepositoriesCommand"; export * from "./ListCompilationJobsCommand"; export * from "./ListContextsCommand"; @@ -201,6 +210,7 @@ export * from "./ListHumanTaskUisCommand"; export * from "./ListHyperParameterTuningJobsCommand"; export * from "./ListImageVersionsCommand"; export * from "./ListImagesCommand"; +export * from "./ListInferenceComponentsCommand"; export * from "./ListInferenceExperimentsCommand"; export * from "./ListInferenceRecommendationsJobStepsCommand"; export * from "./ListInferenceRecommendationsJobsCommand"; @@ -273,6 +283,7 @@ export * from "./StopTransformJobCommand"; export * from "./UpdateActionCommand"; export * from "./UpdateAppImageConfigCommand"; export * from "./UpdateArtifactCommand"; +export * from "./UpdateClusterCommand"; export * from "./UpdateCodeRepositoryCommand"; export * from "./UpdateContextCommand"; export * from "./UpdateDeviceFleetCommand"; @@ -286,6 +297,8 @@ export * from "./UpdateFeatureMetadataCommand"; export * from "./UpdateHubCommand"; export * from "./UpdateImageCommand"; export * from "./UpdateImageVersionCommand"; +export * from "./UpdateInferenceComponentCommand"; +export * from "./UpdateInferenceComponentRuntimeConfigCommand"; export * from "./UpdateInferenceExperimentCommand"; export * from "./UpdateModelCardCommand"; export * from "./UpdateModelPackageCommand"; diff --git a/clients/client-sagemaker/src/models/models_0.ts b/clients/client-sagemaker/src/models/models_0.ts index 3b188dba8096..42798fcd1c6e 100644 --- a/clients/client-sagemaker/src/models/models_0.ts +++ b/clients/client-sagemaker/src/models/models_0.ts @@ -5463,6 +5463,8 @@ export interface AutoMLJobCompletionCriteria { * used by the CreateHyperParameterTuningJob action.

*

For job V2s (jobs created by calling CreateAutoMLJobV2), this field * controls the runtime of the job candidate.

+ *

For TextGenerationJobConfig problem types, the maximum time defaults to 72 hours + * (259200 seconds).

*/ MaxRuntimePerTrainingJobInSeconds?: number; @@ -5494,16 +5496,15 @@ export type AutoMLMode = (typeof AutoMLMode)[keyof typeof AutoMLMode]; /** * @public - *

Specifies a VPC that your training jobs and hosted models have access to. Control - * access to and from your training and model containers by configuring the VPC. For more - * information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Training Jobs - * by Using an Amazon Virtual Private Cloud.

+ *

Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources + * have access to. You can control access to and from your resources by configuring a VPC. + * For more information, see Give SageMaker Access to Resources in your Amazon VPC.

*/ export interface VpcConfig { /** * @public - *

The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for - * the VPC that is specified in the Subnets field.

+ *

The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security + * groups for the VPC that is specified in the Subnets field.

*/ SecurityGroupIds: string[] | undefined; @@ -6070,8 +6071,9 @@ export interface TextClassificationJobConfig { export interface TextGenerationJobConfig { /** * @public - *

How long a job is allowed to run, or how many candidates a job is allowed to - * generate.

+ *

How long a fine-tuning job is allowed to run. For TextGenerationJobConfig + * problem types, the MaxRuntimePerTrainingJobInSeconds attribute of AutoMLJobCompletionCriteria defaults to 72h + * (259200s).

*/ CompletionCriteria?: AutoMLJobCompletionCriteria; @@ -6079,10 +6081,50 @@ export interface TextGenerationJobConfig { * @public *

The name of the base model to fine-tune. Autopilot supports fine-tuning a variety of large * language models. For information on the list of supported models, see Text generation models supporting fine-tuning in Autopilot. If no - * BaseModelName is provided, the default model used is Falcon-7B-Instruct. - *

+ * BaseModelName is provided, the default model used is Falcon7BInstruct.

*/ BaseModelName?: string; + + /** + * @public + *

The hyperparameters used to configure and optimize the learning process of the base + * model. You can set any combination of the following hyperparameters for all base models. + * For more information on each supported hyperparameter, see Optimize + * the learning process of your text generation models with hyperparameters.

+ *
    + *
  • + *

    + * "epochCount": The number of times the model goes through the entire + * training dataset. Its value should be a string containing an integer value within the + * range of "1" to "10".

    + *
    • + *
  • + *

    + * "batchSize": The number of data samples used in each iteration of + * training. Its value should be a string containing an integer value within the range + * of "1" to "64".

    + *
    • + *
  • + *

    + * "learningRate": The step size at which a model's parameters are + * updated during training. Its value should be a string containing a floating-point + * value within the range of "0" to "1".

    + *
    • + *
  • + *

    + * "learningRateWarmupSteps": The number of training steps during which + * the learning rate gradually increases before reaching its target or maximum value. + * Its value should be a string containing an integer value within the range of "0" to + * "250".

    + *
    • + *
+ *

Here is an example where all four hyperparameters are configured.

+ *

+ * \{ "epochCount":"5", "learningRate":"0.5", "batchSize": "32", + * "learningRateWarmupSteps": "10" \} + *

+ */ + TextGenerationHyperParameters?: Record; } /** @@ -8235,515 +8277,869 @@ export interface ClarifyExplainerConfig { ShapConfig: ClarifyShapConfig | undefined; } -/** - * @public - *

A Git repository that SageMaker automatically displays to users for cloning in the JupyterServer application.

- */ -export interface CodeRepository { - /** - * @public - *

The URL of the Git repository.

- */ - RepositoryUrl: string | undefined; -} - /** * @public * @enum */ -export const CodeRepositorySortBy = { - CREATION_TIME: "CreationTime", - LAST_MODIFIED_TIME: "LastModifiedTime", - NAME: "Name", +export const ClusterInstanceType = { + ML_C5N_18XLARGE: "ml.c5n.18xlarge", + ML_C5N_2XLARGE: "ml.c5n.2xlarge", + ML_C5N_4XLARGE: "ml.c5n.4xlarge", + ML_C5N_9XLARGE: "ml.c5n.9xlarge", + ML_C5N_LARGE: "ml.c5n.large", + ML_C5_12XLARGE: "ml.c5.12xlarge", + ML_C5_18XLARGE: "ml.c5.18xlarge", + ML_C5_24XLARGE: "ml.c5.24xlarge", + ML_C5_2XLARGE: "ml.c5.2xlarge", + ML_C5_4XLARGE: "ml.c5.4xlarge", + ML_C5_9XLARGE: "ml.c5.9xlarge", + ML_C5_LARGE: "ml.c5.large", + ML_C5_XLARGE: "ml.c5.xlarge", + ML_G5_12XLARGE: "ml.g5.12xlarge", + ML_G5_16XLARGE: "ml.g5.16xlarge", + ML_G5_24XLARGE: "ml.g5.24xlarge", + ML_G5_2XLARGE: "ml.g5.2xlarge", + ML_G5_48XLARGE: "ml.g5.48xlarge", + ML_G5_4XLARGE: "ml.g5.4xlarge", + ML_G5_8XLARGE: "ml.g5.8xlarge", + ML_G5_XLARGE: "ml.g5.xlarge", + ML_M5_12XLARGE: "ml.m5.12xlarge", + ML_M5_16XLARGE: "ml.m5.16xlarge", + ML_M5_24XLARGE: "ml.m5.24xlarge", + ML_M5_2XLARGE: "ml.m5.2xlarge", + ML_M5_4XLARGE: "ml.m5.4xlarge", + ML_M5_8XLARGE: "ml.m5.8xlarge", + ML_M5_LARGE: "ml.m5.large", + ML_M5_XLARGE: "ml.m5.xlarge", + ML_P4DE_24XLARGE: "ml.p4de.24xlarge", + ML_P4D_24XLARGE: "ml.p4d.24xlarge", + ML_P5_48XLARGE: "ml.p5.48xlarge", + ML_T3_2XLARGE: "ml.t3.2xlarge", + ML_T3_LARGE: "ml.t3.large", + ML_T3_MEDIUM: "ml.t3.medium", + ML_T3_XLARGE: "ml.t3.xlarge", + ML_TRN1N_32XLARGE: "ml.trn1n.32xlarge", + ML_TRN1_32XLARGE: "ml.trn1.32xlarge", } as const; /** * @public */ -export type CodeRepositorySortBy = (typeof CodeRepositorySortBy)[keyof typeof CodeRepositorySortBy]; +export type ClusterInstanceType = (typeof ClusterInstanceType)[keyof typeof ClusterInstanceType]; /** * @public - * @enum + *

The LifeCycle configuration for a SageMaker HyperPod cluster.

*/ -export const CodeRepositorySortOrder = { - ASCENDING: "Ascending", - DESCENDING: "Descending", -} as const; +export interface ClusterLifeCycleConfig { + /** + * @public + *

An Amazon S3 bucket path where your LifeCycle scripts are stored.

+ */ + SourceS3Uri: string | undefined; -/** - * @public - */ -export type CodeRepositorySortOrder = (typeof CodeRepositorySortOrder)[keyof typeof CodeRepositorySortOrder]; + /** + * @public + *

The directory of the LifeCycle script under SourceS3Uri. This LifeCycle + * script runs during cluster creation.

+ */ + OnCreate: string | undefined; +} /** * @public - *

Specifies configuration details for a Git repository in your Amazon Web Services - * account.

+ *

Details of an instance group in a SageMaker HyperPod cluster.

*/ -export interface GitConfig { +export interface ClusterInstanceGroupDetails { /** * @public - *

The URL where the Git repository is located.

+ *

The number of instances that are currently in the instance group of a + * SageMaker HyperPod cluster.

*/ - RepositoryUrl: string | undefined; + CurrentCount?: number; /** * @public - *

The default branch for the Git repository.

+ *

The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.

*/ - Branch?: string; + TargetCount?: number; /** * @public - *

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that - * contains the credentials used to access the git repository. The secret must have a - * staging label of AWSCURRENT and must be in the following format:

- *

- * \{"username": UserName, "password": - * Password\} - *

+ *

The name of the instance group of a SageMaker HyperPod cluster.

*/ - SecretArn?: string; + InstanceGroupName?: string; + + /** + * @public + *

The instance type of the instance group of a SageMaker HyperPod cluster.

+ */ + InstanceType?: ClusterInstanceType; + + /** + * @public + *

Details of LifeCycle configuration for the instance group.

+ */ + LifeCycleConfig?: ClusterLifeCycleConfig; + + /** + * @public + *

The execution role for the instance group to assume.

+ */ + ExecutionRole?: string; + + /** + * @public + *

The number you specified to TreadsPerCore in CreateCluster for + * enabling or disabling multithreading. For instance types that support multithreading, you + * can specify 1 for disabling multithreading and 2 for enabling multithreading. For more + * information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud + * User Guide.

+ */ + ThreadsPerCore?: number; } /** * @public - *

Specifies summary information about a Git repository.

+ *

The specifications of an instance group that you need to define.

*/ -export interface CodeRepositorySummary { +export interface ClusterInstanceGroupSpecification { /** * @public - *

The name of the Git repository.

+ *

Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.

*/ - CodeRepositoryName: string | undefined; + InstanceCount: number | undefined; /** * @public - *

The Amazon Resource Name (ARN) of the Git repository.

+ *

Specifies the name of the instance group.

*/ - CodeRepositoryArn: string | undefined; + InstanceGroupName: string | undefined; /** * @public - *

The date and time that the Git repository was created.

+ *

Specifies the instance type of the instance group.

*/ - CreationTime: Date | undefined; + InstanceType: ClusterInstanceType | undefined; /** * @public - *

The date and time that the Git repository was last modified.

+ *

Specifies the LifeCycle configuration for the instance group.

*/ - LastModifiedTime: Date | undefined; + LifeCycleConfig: ClusterLifeCycleConfig | undefined; /** * @public - *

Configuration details for the Git repository, including the URL where it is located - * and the ARN of the Amazon Web Services Secrets Manager secret that contains the - * credentials used to access the repository.

+ *

Specifies an IAM execution role to be assumed by the instance group.

*/ - GitConfig?: GitConfig; + ExecutionRole: string | undefined; + + /** + * @public + *

Specifies the value for Threads per core. For instance types that + * support multithreading, you can specify 1 for disabling multithreading and + * 2 for enabling multithreading. For instance types that doesn't support + * multithreading, specify 1. For more information, see the reference table of + * CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud + * User Guide.

+ */ + ThreadsPerCore?: number; } /** * @public - *

Use this parameter to configure your Amazon Cognito workforce. - * A single Cognito workforce is created using and corresponds to a single - * - * Amazon Cognito user pool.

+ * @enum */ -export interface CognitoConfig { +export const ClusterInstanceStatus = { + FAILURE: "Failure", + PENDING: "Pending", + RUNNING: "Running", + SHUTTING_DOWN: "ShuttingDown", + SYSTEM_UPDATING: "SystemUpdating", +} as const; + +/** + * @public + */ +export type ClusterInstanceStatus = (typeof ClusterInstanceStatus)[keyof typeof ClusterInstanceStatus]; + +/** + * @public + *

Details of an instance in a SageMaker HyperPod cluster.

+ */ +export interface ClusterInstanceStatusDetails { /** * @public - *

A - * user pool is a user directory in Amazon Cognito. - * With a user pool, your users can sign in to your web or mobile app through Amazon Cognito. - * Your users can also sign in through social identity providers like - * Google, Facebook, Amazon, or Apple, and through SAML identity providers.

+ *

The status of an instance in a SageMaker HyperPod cluster.

*/ - UserPool: string | undefined; + Status: ClusterInstanceStatus | undefined; /** * @public - *

The client ID for your Amazon Cognito user pool.

+ *

The message from an instance in a SageMaker HyperPod cluster.

*/ - ClientId: string | undefined; + Message?: string; } /** * @public - *

Identifies a Amazon Cognito user group. A user group can be used in on or more work - * teams.

+ *

Details of an instance (also called a node interchangeably) in a + * SageMaker HyperPod cluster.

*/ -export interface CognitoMemberDefinition { +export interface ClusterNodeDetails { /** * @public - *

An identifier for a user pool. The user pool must be in the same region as the service - * that you are calling.

+ *

The instance group name in which the instance is.

*/ - UserPool: string | undefined; + InstanceGroupName?: string; /** * @public - *

An identifier for a user group.

+ *

The ID of the instance.

*/ - UserGroup: string | undefined; + InstanceId?: string; /** * @public - *

An identifier for an application client. You must create the app client ID using - * Amazon Cognito.

+ *

The status of the instance.

*/ - ClientId: string | undefined; -} + InstanceStatus?: ClusterInstanceStatusDetails; -/** - * @public - *

Configuration for your vector collection type.

- */ -export interface VectorConfig { /** * @public - *

The number of elements in your vector.

+ *

The type of the instance.

*/ - Dimension: number | undefined; -} - -/** - * @public - *

Configuration for your collection.

- */ -export type CollectionConfig = CollectionConfig.VectorConfigMember | CollectionConfig.$UnknownMember; + InstanceType?: ClusterInstanceType; -/** - * @public - */ -export namespace CollectionConfig { /** * @public - *

Configuration for your vector collection type.

- *
    - *
  • - *

    - * Dimension: The number of elements in your vector.

    - *
    • - *
+ *

The time when the instance is launched.

*/ - export interface VectorConfigMember { - VectorConfig: VectorConfig; - $unknown?: never; - } + LaunchTime?: Date; /** * @public + *

The LifeCycle configuration applied to the instance.

*/ - export interface $UnknownMember { - VectorConfig?: never; - $unknown: [string, any]; - } - - export interface Visitor { - VectorConfig: (value: VectorConfig) => T; - _: (name: string, value: any) => T; - } + LifeCycleConfig?: ClusterLifeCycleConfig; - export const visit = (value: CollectionConfig, visitor: Visitor): T => { - if (value.VectorConfig !== undefined) return visitor.VectorConfig(value.VectorConfig); - return visitor._(value.$unknown[0], value.$unknown[1]); - }; + /** + * @public + *

The number of threads per CPU core you specified under + * CreateCluster.

+ */ + ThreadsPerCore?: number; } /** * @public - *

Configuration information for the Amazon SageMaker Debugger output tensor collections.

+ *

Lists a summary of the properties of an instance (also called a + * node interchangeably) of a SageMaker HyperPod cluster.

*/ -export interface CollectionConfiguration { +export interface ClusterNodeSummary { /** * @public - *

The name of the tensor collection. The name must be unique relative to other rule configuration names.

+ *

The name of the instance group in which the instance is.

*/ - CollectionName?: string; + InstanceGroupName: string | undefined; /** * @public - *

Parameter values for the tensor collection. The allowed parameters are - * "name", "include_regex", "reduction_config", - * "save_config", "tensor_names", and - * "save_histogram".

+ *

The ID of the instance.

*/ - CollectionParameters?: Record; + InstanceId: string | undefined; + + /** + * @public + *

The type of the instance.

+ */ + InstanceType: ClusterInstanceType | undefined; + + /** + * @public + *

The time when the instance is launched.

+ */ + LaunchTime: Date | undefined; + + /** + * @public + *

The status of the instance.

+ */ + InstanceStatus: ClusterInstanceStatusDetails | undefined; } /** * @public * @enum */ -export const CollectionType = { - LIST: "List", - SET: "Set", - VECTOR: "Vector", +export const ClusterSortBy = { + CREATION_TIME: "CREATION_TIME", + NAME: "NAME", } as const; /** * @public */ -export type CollectionType = (typeof CollectionType)[keyof typeof CollectionType]; +export type ClusterSortBy = (typeof ClusterSortBy)[keyof typeof ClusterSortBy]; /** * @public * @enum */ -export const CompilationJobStatus = { - COMPLETED: "COMPLETED", - FAILED: "FAILED", - INPROGRESS: "INPROGRESS", - STARTING: "STARTING", - STOPPED: "STOPPED", - STOPPING: "STOPPING", +export const ClusterStatus = { + CREATING: "Creating", + DELETING: "Deleting", + FAILED: "Failed", + INSERVICE: "InService", + ROLLINGBACK: "RollingBack", + SYSTEMUPDATING: "SystemUpdating", + UPDATING: "Updating", } as const; /** * @public */ -export type CompilationJobStatus = (typeof CompilationJobStatus)[keyof typeof CompilationJobStatus]; +export type ClusterStatus = (typeof ClusterStatus)[keyof typeof ClusterStatus]; /** * @public - * @enum + *

Lists a summary of the properties of a SageMaker HyperPod cluster.

*/ -export const TargetDevice = { - AISAGE: "aisage", - AMBA_CV2: "amba_cv2", - AMBA_CV22: "amba_cv22", - AMBA_CV25: "amba_cv25", - COREML: "coreml", - DEEPLENS: "deeplens", - IMX8MPLUS: "imx8mplus", - IMX8QM: "imx8qm", - JACINTO_TDA4VM: "jacinto_tda4vm", - JETSON_NANO: "jetson_nano", - JETSON_TX1: "jetson_tx1", - JETSON_TX2: "jetson_tx2", - JETSON_XAVIER: "jetson_xavier", - LAMBDA: "lambda", - ML_C4: "ml_c4", - ML_C5: "ml_c5", - ML_EIA2: "ml_eia2", - ML_G4DN: "ml_g4dn", - ML_INF1: "ml_inf1", - ML_INF2: "ml_inf2", - ML_M4: "ml_m4", - ML_M5: "ml_m5", - ML_P2: "ml_p2", - ML_P3: "ml_p3", - ML_TRN1: "ml_trn1", - QCS603: "qcs603", - QCS605: "qcs605", - RASP3B: "rasp3b", - RK3288: "rk3288", - RK3399: "rk3399", - SBE_C: "sbe_c", - SITARA_AM57X: "sitara_am57x", - X86_WIN32: "x86_win32", - X86_WIN64: "x86_win64", -} as const; +export interface ClusterSummary { + /** + * @public + *

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

+ */ + ClusterArn: string | undefined; -/** - * @public - */ -export type TargetDevice = (typeof TargetDevice)[keyof typeof TargetDevice]; + /** + * @public + *

The name of the SageMaker HyperPod cluster.

+ */ + ClusterName: string | undefined; -/** - * @public - * @enum - */ -export const TargetPlatformAccelerator = { - INTEL_GRAPHICS: "INTEL_GRAPHICS", - MALI: "MALI", - NNA: "NNA", - NVIDIA: "NVIDIA", -} as const; + /** + * @public + *

The time when the SageMaker HyperPod cluster is created.

+ */ + CreationTime: Date | undefined; + + /** + * @public + *

The status of the SageMaker HyperPod cluster.

+ */ + ClusterStatus: ClusterStatus | undefined; +} /** * @public + *

A Git repository that SageMaker automatically displays to users for cloning in the JupyterServer application.

*/ -export type TargetPlatformAccelerator = (typeof TargetPlatformAccelerator)[keyof typeof TargetPlatformAccelerator]; +export interface CodeRepository { + /** + * @public + *

The URL of the Git repository.

+ */ + RepositoryUrl: string | undefined; +} /** * @public * @enum */ -export const TargetPlatformArch = { - ARM64: "ARM64", - ARM_EABI: "ARM_EABI", - ARM_EABIHF: "ARM_EABIHF", - X86: "X86", - X86_64: "X86_64", +export const CodeRepositorySortBy = { + CREATION_TIME: "CreationTime", + LAST_MODIFIED_TIME: "LastModifiedTime", + NAME: "Name", } as const; /** * @public */ -export type TargetPlatformArch = (typeof TargetPlatformArch)[keyof typeof TargetPlatformArch]; +export type CodeRepositorySortBy = (typeof CodeRepositorySortBy)[keyof typeof CodeRepositorySortBy]; /** * @public * @enum */ -export const TargetPlatformOs = { - ANDROID: "ANDROID", - LINUX: "LINUX", +export const CodeRepositorySortOrder = { + ASCENDING: "Ascending", + DESCENDING: "Descending", } as const; /** * @public */ -export type TargetPlatformOs = (typeof TargetPlatformOs)[keyof typeof TargetPlatformOs]; +export type CodeRepositorySortOrder = (typeof CodeRepositorySortOrder)[keyof typeof CodeRepositorySortOrder]; /** * @public - *

A summary of a model compilation job.

+ *

Specifies configuration details for a Git repository in your Amazon Web Services + * account.

*/ -export interface CompilationJobSummary { - /** - * @public - *

The name of the model compilation job that you want a summary for.

- */ - CompilationJobName: string | undefined; - +export interface GitConfig { /** * @public - *

The Amazon Resource Name (ARN) of the model compilation job.

+ *

The URL where the Git repository is located.

*/ - CompilationJobArn: string | undefined; + RepositoryUrl: string | undefined; /** * @public - *

The time when the model compilation job was created.

+ *

The default branch for the Git repository.

*/ - CreationTime: Date | undefined; + Branch?: string; /** * @public - *

The time when the model compilation job started.

+ *

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that + * contains the credentials used to access the git repository. The secret must have a + * staging label of AWSCURRENT and must be in the following format:

+ *

+ * \{"username": UserName, "password": + * Password\} + *

*/ - CompilationStartTime?: Date; + SecretArn?: string; +} +/** + * @public + *

Specifies summary information about a Git repository.

+ */ +export interface CodeRepositorySummary { /** * @public - *

The time when the model compilation job completed.

+ *

The name of the Git repository.

*/ - CompilationEndTime?: Date; + CodeRepositoryName: string | undefined; /** * @public - *

The type of device that the model will run on after the compilation job has - * completed.

+ *

The Amazon Resource Name (ARN) of the Git repository.

*/ - CompilationTargetDevice?: TargetDevice; + CodeRepositoryArn: string | undefined; /** * @public - *

The type of OS that the model will run on after the compilation job has - * completed.

+ *

The date and time that the Git repository was created.

*/ - CompilationTargetPlatformOs?: TargetPlatformOs; + CreationTime: Date | undefined; /** * @public - *

The type of architecture that the model will run on after the compilation job has - * completed.

+ *

The date and time that the Git repository was last modified.

*/ - CompilationTargetPlatformArch?: TargetPlatformArch; + LastModifiedTime: Date | undefined; /** * @public - *

The type of accelerator that the model will run on after the compilation job has - * completed.

+ *

Configuration details for the Git repository, including the URL where it is located + * and the ARN of the Amazon Web Services Secrets Manager secret that contains the + * credentials used to access the repository.

*/ - CompilationTargetPlatformAccelerator?: TargetPlatformAccelerator; + GitConfig?: GitConfig; +} +/** + * @public + *

Use this parameter to configure your Amazon Cognito workforce. + * A single Cognito workforce is created using and corresponds to a single + * + * Amazon Cognito user pool.

+ */ +export interface CognitoConfig { /** * @public - *

The time when the model compilation job was last modified.

+ *

A + * user pool is a user directory in Amazon Cognito. + * With a user pool, your users can sign in to your web or mobile app through Amazon Cognito. + * Your users can also sign in through social identity providers like + * Google, Facebook, Amazon, or Apple, and through SAML identity providers.

*/ - LastModifiedTime?: Date; + UserPool: string | undefined; /** * @public - *

The status of the model compilation job.

+ *

The client ID for your Amazon Cognito user pool.

*/ - CompilationJobStatus: CompilationJobStatus | undefined; + ClientId: string | undefined; } /** * @public - * @enum - */ -export const CompleteOnConvergence = { - DISABLED: "Disabled", - ENABLED: "Enabled", -} as const; - -/** - * @public - */ -export type CompleteOnConvergence = (typeof CompleteOnConvergence)[keyof typeof CompleteOnConvergence]; - -/** - * @public - * @enum + *

Identifies a Amazon Cognito user group. A user group can be used in on or more work + * teams.

*/ -export const ConditionOutcome = { - FALSE: "False", - TRUE: "True", -} as const; +export interface CognitoMemberDefinition { + /** + * @public + *

An identifier for a user pool. The user pool must be in the same region as the service + * that you are calling.

+ */ + UserPool: string | undefined; -/** - * @public - */ -export type ConditionOutcome = (typeof ConditionOutcome)[keyof typeof ConditionOutcome]; + /** + * @public + *

An identifier for a user group.

+ */ + UserGroup: string | undefined; -/** - * @public - *

Metadata for a Condition step.

- */ -export interface ConditionStepMetadata { /** * @public - *

The outcome of the Condition step evaluation.

+ *

An identifier for an application client. You must create the app client ID using + * Amazon Cognito.

*/ - Outcome?: ConditionOutcome; + ClientId: string | undefined; } /** * @public - *

There was a conflict when you attempted to modify a SageMaker entity such as an - * Experiment or Artifact.

+ *

Configuration for your vector collection type.

*/ -export class ConflictException extends __BaseException { - readonly name: "ConflictException" = "ConflictException"; - readonly $fault: "client" = "client"; - Message?: string; +export interface VectorConfig { /** - * @internal + * @public + *

The number of elements in your vector.

*/ - constructor(opts: __ExceptionOptionType) { - super({ - name: "ConflictException", - $fault: "client", - ...opts, - }); - Object.setPrototypeOf(this, ConflictException.prototype); - this.Message = opts.Message; - } + Dimension: number | undefined; } /** * @public - * @enum + *

Configuration for your collection.

*/ -export const RepositoryAccessMode = { +export type CollectionConfig = CollectionConfig.VectorConfigMember | CollectionConfig.$UnknownMember; + +/** + * @public + */ +export namespace CollectionConfig { + /** + * @public + *

Configuration for your vector collection type.

+ *
    + *
  • + *

    + * Dimension: The number of elements in your vector.

    + *
    • + *
+ */ + export interface VectorConfigMember { + VectorConfig: VectorConfig; + $unknown?: never; + } + + /** + * @public + */ + export interface $UnknownMember { + VectorConfig?: never; + $unknown: [string, any]; + } + + export interface Visitor { + VectorConfig: (value: VectorConfig) => T; + _: (name: string, value: any) => T; + } + + export const visit = (value: CollectionConfig, visitor: Visitor): T => { + if (value.VectorConfig !== undefined) return visitor.VectorConfig(value.VectorConfig); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; +} + +/** + * @public + *

Configuration information for the Amazon SageMaker Debugger output tensor collections.

+ */ +export interface CollectionConfiguration { + /** + * @public + *

The name of the tensor collection. The name must be unique relative to other rule configuration names.

+ */ + CollectionName?: string; + + /** + * @public + *

Parameter values for the tensor collection. The allowed parameters are + * "name", "include_regex", "reduction_config", + * "save_config", "tensor_names", and + * "save_histogram".

+ */ + CollectionParameters?: Record; +} + +/** + * @public + * @enum + */ +export const CollectionType = { + LIST: "List", + SET: "Set", + VECTOR: "Vector", +} as const; + +/** + * @public + */ +export type CollectionType = (typeof CollectionType)[keyof typeof CollectionType]; + +/** + * @public + * @enum + */ +export const CompilationJobStatus = { + COMPLETED: "COMPLETED", + FAILED: "FAILED", + INPROGRESS: "INPROGRESS", + STARTING: "STARTING", + STOPPED: "STOPPED", + STOPPING: "STOPPING", +} as const; + +/** + * @public + */ +export type CompilationJobStatus = (typeof CompilationJobStatus)[keyof typeof CompilationJobStatus]; + +/** + * @public + * @enum + */ +export const TargetDevice = { + AISAGE: "aisage", + AMBA_CV2: "amba_cv2", + AMBA_CV22: "amba_cv22", + AMBA_CV25: "amba_cv25", + COREML: "coreml", + DEEPLENS: "deeplens", + IMX8MPLUS: "imx8mplus", + IMX8QM: "imx8qm", + JACINTO_TDA4VM: "jacinto_tda4vm", + JETSON_NANO: "jetson_nano", + JETSON_TX1: "jetson_tx1", + JETSON_TX2: "jetson_tx2", + JETSON_XAVIER: "jetson_xavier", + LAMBDA: "lambda", + ML_C4: "ml_c4", + ML_C5: "ml_c5", + ML_EIA2: "ml_eia2", + ML_G4DN: "ml_g4dn", + ML_INF1: "ml_inf1", + ML_INF2: "ml_inf2", + ML_M4: "ml_m4", + ML_M5: "ml_m5", + ML_P2: "ml_p2", + ML_P3: "ml_p3", + ML_TRN1: "ml_trn1", + QCS603: "qcs603", + QCS605: "qcs605", + RASP3B: "rasp3b", + RK3288: "rk3288", + RK3399: "rk3399", + SBE_C: "sbe_c", + SITARA_AM57X: "sitara_am57x", + X86_WIN32: "x86_win32", + X86_WIN64: "x86_win64", +} as const; + +/** + * @public + */ +export type TargetDevice = (typeof TargetDevice)[keyof typeof TargetDevice]; + +/** + * @public + * @enum + */ +export const TargetPlatformAccelerator = { + INTEL_GRAPHICS: "INTEL_GRAPHICS", + MALI: "MALI", + NNA: "NNA", + NVIDIA: "NVIDIA", +} as const; + +/** + * @public + */ +export type TargetPlatformAccelerator = (typeof TargetPlatformAccelerator)[keyof typeof TargetPlatformAccelerator]; + +/** + * @public + * @enum + */ +export const TargetPlatformArch = { + ARM64: "ARM64", + ARM_EABI: "ARM_EABI", + ARM_EABIHF: "ARM_EABIHF", + X86: "X86", + X86_64: "X86_64", +} as const; + +/** + * @public + */ +export type TargetPlatformArch = (typeof TargetPlatformArch)[keyof typeof TargetPlatformArch]; + +/** + * @public + * @enum + */ +export const TargetPlatformOs = { + ANDROID: "ANDROID", + LINUX: "LINUX", +} as const; + +/** + * @public + */ +export type TargetPlatformOs = (typeof TargetPlatformOs)[keyof typeof TargetPlatformOs]; + +/** + * @public + *

A summary of a model compilation job.

+ */ +export interface CompilationJobSummary { + /** + * @public + *

The name of the model compilation job that you want a summary for.

+ */ + CompilationJobName: string | undefined; + + /** + * @public + *

The Amazon Resource Name (ARN) of the model compilation job.

+ */ + CompilationJobArn: string | undefined; + + /** + * @public + *

The time when the model compilation job was created.

+ */ + CreationTime: Date | undefined; + + /** + * @public + *

The time when the model compilation job started.

+ */ + CompilationStartTime?: Date; + + /** + * @public + *

The time when the model compilation job completed.

+ */ + CompilationEndTime?: Date; + + /** + * @public + *

The type of device that the model will run on after the compilation job has + * completed.

+ */ + CompilationTargetDevice?: TargetDevice; + + /** + * @public + *

The type of OS that the model will run on after the compilation job has + * completed.

+ */ + CompilationTargetPlatformOs?: TargetPlatformOs; + + /** + * @public + *

The type of architecture that the model will run on after the compilation job has + * completed.

+ */ + CompilationTargetPlatformArch?: TargetPlatformArch; + + /** + * @public + *

The type of accelerator that the model will run on after the compilation job has + * completed.

+ */ + CompilationTargetPlatformAccelerator?: TargetPlatformAccelerator; + + /** + * @public + *

The time when the model compilation job was last modified.

+ */ + LastModifiedTime?: Date; + + /** + * @public + *

The status of the model compilation job.

+ */ + CompilationJobStatus: CompilationJobStatus | undefined; +} + +/** + * @public + * @enum + */ +export const CompleteOnConvergence = { + DISABLED: "Disabled", + ENABLED: "Enabled", +} as const; + +/** + * @public + */ +export type CompleteOnConvergence = (typeof CompleteOnConvergence)[keyof typeof CompleteOnConvergence]; + +/** + * @public + * @enum + */ +export const ConditionOutcome = { + FALSE: "False", + TRUE: "True", +} as const; + +/** + * @public + */ +export type ConditionOutcome = (typeof ConditionOutcome)[keyof typeof ConditionOutcome]; + +/** + * @public + *

Metadata for a Condition step.

+ */ +export interface ConditionStepMetadata { + /** + * @public + *

The outcome of the Condition step evaluation.

+ */ + Outcome?: ConditionOutcome; +} + +/** + * @public + *

There was a conflict when you attempted to modify a SageMaker entity such as an + * Experiment or Artifact.

+ */ +export class ConflictException extends __BaseException { + readonly name: "ConflictException" = "ConflictException"; + readonly $fault: "client" = "client"; + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionType) { + super({ + name: "ConflictException", + $fault: "client", + ...opts, + }); + Object.setPrototypeOf(this, ConflictException.prototype); + this.Message = opts.Message; + } +} + +/** + * @public + * @enum + */ +export const RepositoryAccessMode = { PLATFORM: "Platform", VPC: "Vpc", } as const; @@ -9770,6 +10166,12 @@ export interface ResourceSpec { */ SageMakerImageVersionArn?: string; + /** + * @public + *

The SageMakerImageVersionAlias.

+ */ + SageMakerImageVersionAlias?: string; + /** * @public *

The instance type that the image version runs on.

@@ -10213,9 +10615,54 @@ export interface CreateAutoMLJobV2Request { export interface CreateAutoMLJobV2Response { /** * @public - *

The unique ARN assigned to the AutoMLJob when it is created.

+ *

The unique ARN assigned to the AutoMLJob when it is created.

+ */ + AutoMLJobArn: string | undefined; +} + +/** + * @public + */ +export interface CreateClusterRequest { + /** + * @public + *

The name for the new SageMaker HyperPod cluster.

+ */ + ClusterName: string | undefined; + + /** + * @public + *

The instance groups to be created in the SageMaker HyperPod cluster.

+ */ + InstanceGroups: ClusterInstanceGroupSpecification[] | undefined; + + /** + * @public + *

Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources + * have access to. You can control access to and from your resources by configuring a VPC. + * For more information, see Give SageMaker Access to Resources in your Amazon VPC.

+ */ + VpcConfig?: VpcConfig; + + /** + * @public + *

Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can + * add tags to your cluster in the same way you add them in other Amazon Web Services services + * that support tagging. To learn more about tagging Amazon Web Services resources in general, + * see Tagging Amazon Web Services Resources User Guide.

+ */ + Tags?: Tag[]; +} + +/** + * @public + */ +export interface CreateClusterResponse { + /** + * @public + *

The Amazon Resource Name (ARN) of the cluster.

*/ - AutoMLJobArn: string | undefined; + ClusterArn: string | undefined; } /** @@ -10985,591 +11432,217 @@ export interface OutputConfig { * * */ - CompilerOptions?: string; - - /** - * @public - *

The Amazon Web Services Key Management Service key (Amazon Web Services KMS) that Amazon SageMaker - * uses to encrypt your output models with Amazon S3 server-side encryption after compilation - * job. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your - * role's account. For more information, see KMS-Managed Encryption - * Keys in the Amazon Simple Storage Service Developer - * Guide. - *

- *

The KmsKeyId can be any of the following formats:

- *
    - *
  • - *

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab - *

    - *
    • - *
  • - *

    Key ARN: - * arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - *

    - *
    • - *
  • - *

    Alias name: alias/ExampleAlias - *

    - *
    • - *
  • - *

    Alias name ARN: - * arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias - *

    - *
    • - *
- */ - KmsKeyId?: string; -} - -/** - * @public - *

The VpcConfig configuration object that specifies the VPC that you want the - * compilation jobs to connect to. For more information on controlling access to your Amazon S3 - * buckets used for compilation job, see Give Amazon SageMaker Compilation Jobs Access to - * Resources in Your Amazon VPC.

- */ -export interface NeoVpcConfig { - /** - * @public - *

The VPC security group IDs. IDs have the form of sg-xxxxxxxx. Specify the - * security groups for the VPC that is specified in the Subnets field.

- */ - SecurityGroupIds: string[] | undefined; - - /** - * @public - *

The ID of the subnets in the VPC that you want to connect the compilation job to for - * accessing the model in Amazon S3.

- */ - Subnets: string[] | undefined; -} - -/** - * @public - */ -export interface CreateCompilationJobRequest { - /** - * @public - *

A name for the model compilation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account.

- */ - CompilationJobName: string | undefined; - - /** - * @public - *

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on - * your behalf.

- *

During model compilation, Amazon SageMaker needs your permission to:

- *
    - *
  • - *

    Read input data from an S3 bucket

    - *
    • - *
  • - *

    Write model artifacts to an S3 bucket

    - *
    • - *
  • - *

    Write logs to Amazon CloudWatch Logs

    - *
    • - *
  • - *

    Publish metrics to Amazon CloudWatch

    - *
    • - *
- *

You grant permissions for all of these tasks to an IAM role. To pass this role to - * Amazon SageMaker, the caller of this API must have the iam:PassRole permission. For - * more information, see Amazon SageMaker - * Roles. - *

- */ - RoleArn: string | undefined; - - /** - * @public - *

The Amazon Resource Name (ARN) of a versioned model package. Provide either a - * ModelPackageVersionArn or an InputConfig object in the - * request syntax. The presence of both objects in the CreateCompilationJob - * request will return an exception.

- */ - ModelPackageVersionArn?: string; - - /** - * @public - *

Provides information about the location of input model artifacts, the name and shape - * of the expected data inputs, and the framework in which the model was trained.

- */ - InputConfig?: InputConfig; - - /** - * @public - *

Provides information about the output location for the compiled model and the target - * device the model runs on.

- */ - OutputConfig: OutputConfig | undefined; - - /** - * @public - *

A VpcConfig object that specifies the VPC that you want your compilation job - * to connect to. Control access to your models by configuring the VPC. For more - * information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.

- */ - VpcConfig?: NeoVpcConfig; - - /** - * @public - *

Specifies a limit to how long a model compilation job can run. When the job reaches - * the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training - * costs.

- */ - StoppingCondition: StoppingCondition | undefined; - - /** - * @public - *

An array of key-value pairs. You can use tags to categorize your Amazon Web Services - * resources in different ways, for example, by purpose, owner, or environment. For more - * information, see Tagging Amazon Web Services Resources.

- */ - Tags?: Tag[]; -} - -/** - * @public - */ -export interface CreateCompilationJobResponse { - /** - * @public - *

If the action is successful, the service sends back an HTTP 200 response. Amazon SageMaker returns - * the following data in JSON format:

- *
    - *
  • - *

    - * CompilationJobArn: The Amazon Resource Name (ARN) of the compiled - * job.

    - *
    • - *
- */ - CompilationJobArn: string | undefined; -} - -/** - * @public - */ -export interface CreateContextRequest { - /** - * @public - *

The name of the context. Must be unique to your account in an Amazon Web Services Region.

- */ - ContextName: string | undefined; - - /** - * @public - *

The source type, ID, and URI.

- */ - Source: ContextSource | undefined; - - /** - * @public - *

The context type.

- */ - ContextType: string | undefined; - - /** - * @public - *

The description of the context.

- */ - Description?: string; - - /** - * @public - *

A list of properties to add to the context.

- */ - Properties?: Record; - - /** - * @public - *

A list of tags to apply to the context.

- */ - Tags?: Tag[]; -} - -/** - * @public - */ -export interface CreateContextResponse { - /** - * @public - *

The Amazon Resource Name (ARN) of the context.

- */ - ContextArn?: string; -} - -/** - * @public - *

Information about the container that a data quality monitoring job runs.

- */ -export interface DataQualityAppSpecification { - /** - * @public - *

The container image that the data quality monitoring job runs.

- */ - ImageUri: string | undefined; - - /** - * @public - *

The entrypoint for a container used to run a monitoring job.

- */ - ContainerEntrypoint?: string[]; - - /** - * @public - *

The arguments to send to the container that the monitoring job runs.

- */ - ContainerArguments?: string[]; - - /** - * @public - *

An Amazon S3 URI to a script that is called per row prior to running analysis. It can - * base64 decode the payload and convert it into a flattened JSON so that the built-in container can use - * the converted data. Applicable only for the built-in (first party) containers.

- */ - RecordPreprocessorSourceUri?: string; - - /** - * @public - *

An Amazon S3 URI to a script that is called after analysis has been performed. Applicable - * only for the built-in (first party) containers.

- */ - PostAnalyticsProcessorSourceUri?: string; - - /** - * @public - *

Sets the environment variables in the container that the monitoring job runs.

- */ - Environment?: Record; -} - -/** - * @public - *

The constraints resource for a monitoring job.

- */ -export interface MonitoringConstraintsResource { - /** - * @public - *

The Amazon S3 URI for the constraints resource.

- */ - S3Uri?: string; -} + CompilerOptions?: string; -/** - * @public - *

The statistics resource for a monitoring job.

- */ -export interface MonitoringStatisticsResource { /** * @public - *

The Amazon S3 URI for the statistics resource.

+ *

The Amazon Web Services Key Management Service key (Amazon Web Services KMS) that Amazon SageMaker + * uses to encrypt your output models with Amazon S3 server-side encryption after compilation + * job. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your + * role's account. For more information, see KMS-Managed Encryption + * Keys in the Amazon Simple Storage Service Developer + * Guide. + *

+ *

The KmsKeyId can be any of the following formats:

+ *
    + *
  • + *

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + *

    + *
    • + *
  • + *

    Key ARN: + * arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + *

    + *
    • + *
  • + *

    Alias name: alias/ExampleAlias + *

    + *
    • + *
  • + *

    Alias name ARN: + * arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias + *

    + *
    • + *
*/ - S3Uri?: string; + KmsKeyId?: string; } /** * @public - *

Configuration for monitoring constraints and monitoring statistics. These baseline resources are - * compared against the results of the current job from the series of jobs scheduled to collect data - * periodically.

+ *

The VpcConfig configuration object that specifies the VPC that you want the + * compilation jobs to connect to. For more information on controlling access to your Amazon S3 + * buckets used for compilation job, see Give Amazon SageMaker Compilation Jobs Access to + * Resources in Your Amazon VPC.

*/ -export interface DataQualityBaselineConfig { - /** - * @public - *

The name of the job that performs baselining for the data quality monitoring job.

- */ - BaseliningJobName?: string; - +export interface NeoVpcConfig { /** * @public - *

The constraints resource for a monitoring job.

+ *

The VPC security group IDs. IDs have the form of sg-xxxxxxxx. Specify the + * security groups for the VPC that is specified in the Subnets field.

*/ - ConstraintsResource?: MonitoringConstraintsResource; + SecurityGroupIds: string[] | undefined; /** * @public - *

The statistics resource for a monitoring job.

+ *

The ID of the subnets in the VPC that you want to connect the compilation job to for + * accessing the model in Amazon S3.

*/ - StatisticsResource?: MonitoringStatisticsResource; + Subnets: string[] | undefined; } /** * @public - *

Input object for the endpoint

*/ -export interface EndpointInput { - /** - * @public - *

An endpoint in customer's account which has enabled DataCaptureConfig - * enabled.

- */ - EndpointName: string | undefined; - - /** - * @public - *

Path to the filesystem where the endpoint data is available to the container.

- */ - LocalPath: string | undefined; - +export interface CreateCompilationJobRequest { /** * @public - *

Whether the Pipe or File is used as the input mode for - * transferring data for the monitoring job. Pipe mode is recommended for large - * datasets. File mode is useful for small files that fit in memory. Defaults to - * File.

+ *

A name for the model compilation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account.

*/ - S3InputMode?: ProcessingS3InputMode; + CompilationJobName: string | undefined; /** * @public - *

Whether input data distributed in Amazon S3 is fully replicated or sharded by an - * Amazon S3 key. Defaults to FullyReplicated + *

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on + * your behalf.

+ *

During model compilation, Amazon SageMaker needs your permission to:

+ *
    + *
  • + *

    Read input data from an S3 bucket

    + *
    • + *
  • + *

    Write model artifacts to an S3 bucket

    + *
    • + *
  • + *

    Write logs to Amazon CloudWatch Logs

    + *
    • + *
  • + *

    Publish metrics to Amazon CloudWatch

    + *
    • + *
+ *

You grant permissions for all of these tasks to an IAM role. To pass this role to + * Amazon SageMaker, the caller of this API must have the iam:PassRole permission. For + * more information, see Amazon SageMaker + * Roles. *

*/ - S3DataDistributionType?: ProcessingS3DataDistributionType; - - /** - * @public - *

The attributes of the input data that are the input features.

- */ - FeaturesAttribute?: string; - - /** - * @public - *

The attribute of the input data that represents the ground truth label.

- */ - InferenceAttribute?: string; - - /** - * @public - *

In a classification problem, the attribute that represents the class probability.

- */ - ProbabilityAttribute?: string; - - /** - * @public - *

The threshold for the class probability to be evaluated as a positive result.

- */ - ProbabilityThresholdAttribute?: number; - - /** - * @public - *

If specified, monitoring jobs substract this time from the start time. For information - * about using offsets for scheduling monitoring jobs, see Schedule Model - * Quality Monitoring Jobs.

- */ - StartTimeOffset?: string; - - /** - * @public - *

If specified, monitoring jobs substract this time from the end time. For information - * about using offsets for scheduling monitoring jobs, see Schedule Model - * Quality Monitoring Jobs.

- */ - EndTimeOffset?: string; + RoleArn: string | undefined; /** * @public - *

The attributes of the input data to exclude from the analysis.

+ *

The Amazon Resource Name (ARN) of a versioned model package. Provide either a + * ModelPackageVersionArn or an InputConfig object in the + * request syntax. The presence of both objects in the CreateCompilationJob + * request will return an exception.

*/ - ExcludeFeaturesAttribute?: string; -} + ModelPackageVersionArn?: string; -/** - * @public - *

The input for the data quality monitoring job. Currently endpoints are supported for - * input.

- */ -export interface DataQualityJobInput { /** * @public - *

Input object for the endpoint

+ *

Provides information about the location of input model artifacts, the name and shape + * of the expected data inputs, and the framework in which the model was trained.

*/ - EndpointInput?: EndpointInput; + InputConfig?: InputConfig; /** * @public - *

Input object for the batch transform job.

+ *

Provides information about the output location for the compiled model and the target + * device the model runs on.

*/ - BatchTransformInput?: BatchTransformInput; -} - -/** - * @public - * @enum - */ -export const ProcessingS3UploadMode = { - CONTINUOUS: "Continuous", - END_OF_JOB: "EndOfJob", -} as const; - -/** - * @public - */ -export type ProcessingS3UploadMode = (typeof ProcessingS3UploadMode)[keyof typeof ProcessingS3UploadMode]; + OutputConfig: OutputConfig | undefined; -/** - * @public - *

Information about where and how you want to store the results of a monitoring - * job.

- */ -export interface MonitoringS3Output { /** * @public - *

A URI that identifies the Amazon S3 storage location where Amazon SageMaker - * saves the results of a monitoring job.

+ *

A VpcConfig object that specifies the VPC that you want your compilation job + * to connect to. Control access to your models by configuring the VPC. For more + * information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.

*/ - S3Uri: string | undefined; + VpcConfig?: NeoVpcConfig; /** * @public - *

The local path to the Amazon S3 storage location where Amazon SageMaker - * saves the results of a monitoring job. LocalPath is an absolute path for the output - * data.

+ *

Specifies a limit to how long a model compilation job can run. When the job reaches + * the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training + * costs.

*/ - LocalPath: string | undefined; + StoppingCondition: StoppingCondition | undefined; /** * @public - *

Whether to upload the results of the monitoring job continuously or after the job - * completes.

+ *

An array of key-value pairs. You can use tags to categorize your Amazon Web Services + * resources in different ways, for example, by purpose, owner, or environment. For more + * information, see Tagging Amazon Web Services Resources.

*/ - S3UploadMode?: ProcessingS3UploadMode; + Tags?: Tag[]; } /** * @public - *

The output object for a monitoring job.

*/ -export interface MonitoringOutput { +export interface CreateCompilationJobResponse { /** * @public - *

The Amazon S3 storage location where the results of a monitoring job are - * saved.

+ *

If the action is successful, the service sends back an HTTP 200 response. Amazon SageMaker returns + * the following data in JSON format:

+ *
    + *
  • + *

    + * CompilationJobArn: The Amazon Resource Name (ARN) of the compiled + * job.

    + *
    • + *
*/ - S3Output: MonitoringS3Output | undefined; + CompilationJobArn: string | undefined; } /** * @public - *

The output configuration for monitoring jobs.

*/ -export interface MonitoringOutputConfig { +export interface CreateContextRequest { /** * @public - *

Monitoring outputs for monitoring jobs. This is where the output of the periodic - * monitoring jobs is uploaded.

+ *

The name of the context. Must be unique to your account in an Amazon Web Services Region.

*/ - MonitoringOutputs: MonitoringOutput[] | undefined; + ContextName: string | undefined; /** * @public - *

The Key Management Service (KMS) key that Amazon SageMaker uses to - * encrypt the model artifacts at rest using Amazon S3 server-side encryption.

+ *

The source type, ID, and URI.

*/ - KmsKeyId?: string; -} - -/** - * @public - * @enum - */ -export const ProcessingInstanceType = { - ML_C4_2XLARGE: "ml.c4.2xlarge", - ML_C4_4XLARGE: "ml.c4.4xlarge", - ML_C4_8XLARGE: "ml.c4.8xlarge", - ML_C4_XLARGE: "ml.c4.xlarge", - ML_C5_18XLARGE: "ml.c5.18xlarge", - ML_C5_2XLARGE: "ml.c5.2xlarge", - ML_C5_4XLARGE: "ml.c5.4xlarge", - ML_C5_9XLARGE: "ml.c5.9xlarge", - ML_C5_XLARGE: "ml.c5.xlarge", - ML_G4DN_12XLARGE: "ml.g4dn.12xlarge", - ML_G4DN_16XLARGE: "ml.g4dn.16xlarge", - ML_G4DN_2XLARGE: "ml.g4dn.2xlarge", - ML_G4DN_4XLARGE: "ml.g4dn.4xlarge", - ML_G4DN_8XLARGE: "ml.g4dn.8xlarge", - ML_G4DN_XLARGE: "ml.g4dn.xlarge", - ML_M4_10XLARGE: "ml.m4.10xlarge", - ML_M4_16XLARGE: "ml.m4.16xlarge", - ML_M4_2XLARGE: "ml.m4.2xlarge", - ML_M4_4XLARGE: "ml.m4.4xlarge", - ML_M4_XLARGE: "ml.m4.xlarge", - ML_M5_12XLARGE: "ml.m5.12xlarge", - ML_M5_24XLARGE: "ml.m5.24xlarge", - ML_M5_2XLARGE: "ml.m5.2xlarge", - ML_M5_4XLARGE: "ml.m5.4xlarge", - ML_M5_LARGE: "ml.m5.large", - ML_M5_XLARGE: "ml.m5.xlarge", - ML_P2_16XLARGE: "ml.p2.16xlarge", - ML_P2_8XLARGE: "ml.p2.8xlarge", - ML_P2_XLARGE: "ml.p2.xlarge", - ML_P3_16XLARGE: "ml.p3.16xlarge", - ML_P3_2XLARGE: "ml.p3.2xlarge", - ML_P3_8XLARGE: "ml.p3.8xlarge", - ML_R5_12XLARGE: "ml.r5.12xlarge", - ML_R5_16XLARGE: "ml.r5.16xlarge", - ML_R5_24XLARGE: "ml.r5.24xlarge", - ML_R5_2XLARGE: "ml.r5.2xlarge", - ML_R5_4XLARGE: "ml.r5.4xlarge", - ML_R5_8XLARGE: "ml.r5.8xlarge", - ML_R5_LARGE: "ml.r5.large", - ML_R5_XLARGE: "ml.r5.xlarge", - ML_T3_2XLARGE: "ml.t3.2xlarge", - ML_T3_LARGE: "ml.t3.large", - ML_T3_MEDIUM: "ml.t3.medium", - ML_T3_XLARGE: "ml.t3.xlarge", -} as const; - -/** - * @public - */ -export type ProcessingInstanceType = (typeof ProcessingInstanceType)[keyof typeof ProcessingInstanceType]; + Source: ContextSource | undefined; -/** - * @public - *

Configuration for the cluster used to run model monitoring jobs.

- */ -export interface MonitoringClusterConfig { /** * @public - *

The number of ML compute instances to use in the model monitoring job. For distributed - * processing jobs, specify a value greater than 1. The default value is 1.

+ *

The context type.

*/ - InstanceCount: number | undefined; + ContextType: string | undefined; /** * @public - *

The ML compute instance type for the processing job.

+ *

The description of the context.

*/ - InstanceType: ProcessingInstanceType | undefined; + Description?: string; /** * @public - *

The size of the ML storage volume, in gigabytes, that you want to provision. You must - * specify sufficient ML storage for your scenario.

+ *

A list of properties to add to the context.

*/ - VolumeSizeInGB: number | undefined; + Properties?: Record; /** * @public - *

The Key Management Service (KMS) key that Amazon SageMaker uses to - * encrypt data on the storage volume attached to the ML compute instance(s) that run the - * model monitoring job.

+ *

A list of tags to apply to the context.

*/ - VolumeKmsKeyId?: string; + Tags?: Tag[]; } /** * @public - *

Identifies the resources to deploy for a monitoring job.

*/ -export interface MonitoringResources { +export interface CreateContextResponse { /** * @public - *

The configuration for the cluster resources used to run the processing job.

+ *

The Amazon Resource Name (ARN) of the context.

*/ - ClusterConfig: MonitoringClusterConfig | undefined; + ContextArn?: string; } diff --git a/clients/client-sagemaker/src/models/models_1.ts b/clients/client-sagemaker/src/models/models_1.ts index a9acb9683cdd..22914ca53178 100644 --- a/clients/client-sagemaker/src/models/models_1.ts +++ b/clients/client-sagemaker/src/models/models_1.ts @@ -8,8 +8,6 @@ import { AppNetworkAccessType, AppSecurityGroupManagement, AppSpecification, - AppType, - ArtifactSource, AsyncInferenceConfig, AthenaDatasetDefinition, AuthMode, @@ -27,15 +25,12 @@ import { CapacitySize, CaptureContentTypeHeader, CaptureOption, - CaptureStatus, CategoricalParameter, CategoricalParameterRange, Channel, CheckpointConfig, ClarifyExplainerConfig, CodeRepository, - CognitoConfig, - CognitoMemberDefinition, CollectionConfig, CollectionConfiguration, CollectionType, @@ -43,10 +38,6 @@ import { ContentClassifier, ContinuousParameterRange, ConvergenceDetected, - DataQualityAppSpecification, - DataQualityBaselineConfig, - DataQualityJobInput, - EndpointInput, HyperParameterScalingType, HyperParameterTuningJobObjective, InferenceSpecification, @@ -54,15 +45,9 @@ import { MetricDefinition, MetricsSource, ModelApprovalStatus, - MonitoringConstraintsResource, - MonitoringOutputConfig, - MonitoringResources, - MonitoringStatisticsResource, OutputDataConfig, - ProcessingInstanceType, ProcessingS3DataDistributionType, ProcessingS3InputMode, - ProcessingS3UploadMode, ProductionVariantInstanceType, ResourceConfig, ResourceSpec, @@ -79,1678 +64,1569 @@ import { /** * @public - *

The networking configuration for the monitoring job.

- */ -export interface MonitoringNetworkConfig { - /** - * @public - *

Whether to encrypt all communications between the instances used for the monitoring - * jobs. Choose True to encrypt communications. Encryption provides greater - * security for distributed jobs, but the processing might take longer.

- */ - EnableInterContainerTrafficEncryption?: boolean; - - /** - * @public - *

Whether to allow inbound and outbound network calls to and from the containers used for - * the monitoring job.

- */ - EnableNetworkIsolation?: boolean; - - /** - * @public - *

Specifies a VPC that your training jobs and hosted models have access to. Control - * access to and from your training and model containers by configuring the VPC. For more - * information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Training Jobs - * by Using an Amazon Virtual Private Cloud.

- */ - VpcConfig?: VpcConfig; -} - -/** - * @public - *

A time limit for how long the monitoring job is allowed to run before stopping.

+ *

Information about the container that a data quality monitoring job runs.

*/ -export interface MonitoringStoppingCondition { +export interface DataQualityAppSpecification { /** * @public - *

The maximum runtime allowed in seconds.

- * - *

The MaxRuntimeInSeconds cannot exceed the frequency of the job. For data - * quality and model explainability, this can be up to 3600 seconds for an hourly schedule. - * For model bias and model quality hourly schedules, this can be up to 1800 - * seconds.

- * + *

The container image that the data quality monitoring job runs.

*/ - MaxRuntimeInSeconds: number | undefined; -} + ImageUri: string | undefined; -/** - * @public - */ -export interface CreateDataQualityJobDefinitionRequest { /** * @public - *

The name for the monitoring job definition.

+ *

The entrypoint for a container used to run a monitoring job.

*/ - JobDefinitionName: string | undefined; + ContainerEntrypoint?: string[]; /** * @public - *

Configures the constraints and baselines for the monitoring job.

+ *

The arguments to send to the container that the monitoring job runs.

*/ - DataQualityBaselineConfig?: DataQualityBaselineConfig; + ContainerArguments?: string[]; /** * @public - *

Specifies the container that runs the monitoring job.

+ *

An Amazon S3 URI to a script that is called per row prior to running analysis. It can + * base64 decode the payload and convert it into a flattened JSON so that the built-in container can use + * the converted data. Applicable only for the built-in (first party) containers.

*/ - DataQualityAppSpecification: DataQualityAppSpecification | undefined; + RecordPreprocessorSourceUri?: string; /** * @public - *

A list of inputs for the monitoring job. Currently endpoints are supported as monitoring - * inputs.

+ *

An Amazon S3 URI to a script that is called after analysis has been performed. Applicable + * only for the built-in (first party) containers.

*/ - DataQualityJobInput: DataQualityJobInput | undefined; + PostAnalyticsProcessorSourceUri?: string; /** * @public - *

The output configuration for monitoring jobs.

+ *

Sets the environment variables in the container that the monitoring job runs.

*/ - DataQualityJobOutputConfig: MonitoringOutputConfig | undefined; + Environment?: Record; +} +/** + * @public + *

The constraints resource for a monitoring job.

+ */ +export interface MonitoringConstraintsResource { /** * @public - *

Identifies the resources to deploy for a monitoring job.

+ *

The Amazon S3 URI for the constraints resource.

*/ - JobResources: MonitoringResources | undefined; + S3Uri?: string; +} +/** + * @public + *

The statistics resource for a monitoring job.

+ */ +export interface MonitoringStatisticsResource { /** * @public - *

Specifies networking configuration for the monitoring job.

+ *

The Amazon S3 URI for the statistics resource.

*/ - NetworkConfig?: MonitoringNetworkConfig; + S3Uri?: string; +} +/** + * @public + *

Configuration for monitoring constraints and monitoring statistics. These baseline resources are + * compared against the results of the current job from the series of jobs scheduled to collect data + * periodically.

+ */ +export interface DataQualityBaselineConfig { /** * @public - *

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can - * assume to perform tasks on your behalf.

+ *

The name of the job that performs baselining for the data quality monitoring job.

*/ - RoleArn: string | undefined; + BaseliningJobName?: string; /** * @public - *

A time limit for how long the monitoring job is allowed to run before stopping.

+ *

The constraints resource for a monitoring job.

*/ - StoppingCondition?: MonitoringStoppingCondition; + ConstraintsResource?: MonitoringConstraintsResource; /** * @public - *

(Optional) An array of key-value pairs. For more information, see - * - * Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

+ *

The statistics resource for a monitoring job.

*/ - Tags?: Tag[]; + StatisticsResource?: MonitoringStatisticsResource; } /** * @public + *

Input object for the endpoint

*/ -export interface CreateDataQualityJobDefinitionResponse { +export interface EndpointInput { /** * @public - *

The Amazon Resource Name (ARN) of the job definition.

+ *

An endpoint in customer's account which has enabled DataCaptureConfig + * enabled.

*/ - JobDefinitionArn: string | undefined; -} - -/** - * @public - * @enum - */ -export const EdgePresetDeploymentType = { - GreengrassV2Component: "GreengrassV2Component", -} as const; - -/** - * @public - */ -export type EdgePresetDeploymentType = (typeof EdgePresetDeploymentType)[keyof typeof EdgePresetDeploymentType]; + EndpointName: string | undefined; -/** - * @public - *

The output configuration.

- */ -export interface EdgeOutputConfig { /** * @public - *

The Amazon Simple Storage (S3) bucker URI.

+ *

Path to the filesystem where the endpoint data is available to the container.

*/ - S3OutputLocation: string | undefined; + LocalPath: string | undefined; /** * @public - *

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. - * If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account.

+ *

Whether the Pipe or File is used as the input mode for + * transferring data for the monitoring job. Pipe mode is recommended for large + * datasets. File mode is useful for small files that fit in memory. Defaults to + * File.

*/ - KmsKeyId?: string; + S3InputMode?: ProcessingS3InputMode; /** * @public - *

The deployment type SageMaker Edge Manager will create. - * Currently only supports Amazon Web Services IoT Greengrass Version 2 components.

+ *

Whether input data distributed in Amazon S3 is fully replicated or sharded by an + * Amazon S3 key. Defaults to FullyReplicated + *

*/ - PresetDeploymentType?: EdgePresetDeploymentType; + S3DataDistributionType?: ProcessingS3DataDistributionType; /** * @public - *

The configuration used to create deployment artifacts. - * Specify configuration options with a JSON string. The available configuration options for each type are:

- *
    - *
  • - *

    - * ComponentName (optional) - Name of the GreenGrass V2 component. If not specified, - * the default name generated consists of "SagemakerEdgeManager" and the name of your SageMaker Edge Manager - * packaging job.

    - *
    • - *
  • - *

    - * ComponentDescription (optional) - Description of the component.

    - *
    • - *
  • - *

    - * ComponentVersion (optional) - The version of the component.

    - * - *

    Amazon Web Services IoT Greengrass uses semantic versions for components. Semantic versions follow a - * major.minor.patch number system. For example, version 1.0.0 represents the first - * major release for a component. For more information, see the semantic version specification.

    - *     - *
    • - *
  • - *

    - * PlatformOS (optional) - The name of the operating system for the platform. - * Supported platforms include Windows and Linux.

    - *
    • - *
  • - *

    - * PlatformArchitecture (optional) - The processor architecture for the platform.

    - *

    Supported architectures Windows include: Windows32_x86, Windows64_x64.

    - *

    Supported architectures for Linux include: Linux x86_64, Linux ARMV8.

    - *
    • - *
+ *

The attributes of the input data that are the input features.

*/ - PresetDeploymentConfig?: string; -} + FeaturesAttribute?: string; -/** - * @public - */ -export interface CreateDeviceFleetRequest { /** * @public - *

The name of the fleet that the device belongs to.

+ *

The attribute of the input data that represents the ground truth label.

*/ - DeviceFleetName: string | undefined; + InferenceAttribute?: string; /** * @public - *

The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).

+ *

In a classification problem, the attribute that represents the class probability.

*/ - RoleArn?: string; + ProbabilityAttribute?: string; /** * @public - *

A description of the fleet.

+ *

The threshold for the class probability to be evaluated as a positive result.

*/ - Description?: string; + ProbabilityThresholdAttribute?: number; /** * @public - *

The output configuration for storing sample data collected by the fleet.

+ *

If specified, monitoring jobs substract this time from the start time. For information + * about using offsets for scheduling monitoring jobs, see Schedule Model + * Quality Monitoring Jobs.

*/ - OutputConfig: EdgeOutputConfig | undefined; + StartTimeOffset?: string; /** * @public - *

Creates tags for the specified fleet.

+ *

If specified, monitoring jobs substract this time from the end time. For information + * about using offsets for scheduling monitoring jobs, see Schedule Model + * Quality Monitoring Jobs.

*/ - Tags?: Tag[]; + EndTimeOffset?: string; /** * @public - *

Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. - * The name of the role alias generated will match this pattern: - * "SageMakerEdge-\{DeviceFleetName\}".

- *

For example, if your device fleet is called "demo-fleet", the name of - * the role alias will be "SageMakerEdge-demo-fleet".

+ *

The attributes of the input data to exclude from the analysis.

*/ - EnableIotRoleAlias?: boolean; + ExcludeFeaturesAttribute?: string; } /** * @public - *

The JupyterServer app settings.

+ *

The input for the data quality monitoring job. Currently endpoints are supported for + * input.

*/ -export interface JupyterServerAppSettings { - /** - * @public - *

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterServer app. If you use the LifecycleConfigArns parameter, then this parameter is also required.

- */ - DefaultResourceSpec?: ResourceSpec; - +export interface DataQualityJobInput { /** * @public - *

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. If you use this parameter, the DefaultResourceSpec parameter is also required.

- * - *

To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

- * + *

Input object for the endpoint

*/ - LifecycleConfigArns?: string[]; + EndpointInput?: EndpointInput; /** * @public - *

A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer application.

+ *

Input object for the batch transform job.

*/ - CodeRepositories?: CodeRepository[]; + BatchTransformInput?: BatchTransformInput; } /** * @public - *

A custom SageMaker image. For more information, see - * Bring your own SageMaker image.

+ * @enum */ -export interface CustomImage { +export const ProcessingS3UploadMode = { + CONTINUOUS: "Continuous", + END_OF_JOB: "EndOfJob", +} as const; + +/** + * @public + */ +export type ProcessingS3UploadMode = (typeof ProcessingS3UploadMode)[keyof typeof ProcessingS3UploadMode]; + +/** + * @public + *

Information about where and how you want to store the results of a monitoring + * job.

+ */ +export interface MonitoringS3Output { /** * @public - *

The name of the CustomImage. Must be unique to your account.

+ *

A URI that identifies the Amazon S3 storage location where Amazon SageMaker + * saves the results of a monitoring job.

*/ - ImageName: string | undefined; + S3Uri: string | undefined; /** * @public - *

The version number of the CustomImage.

+ *

The local path to the Amazon S3 storage location where Amazon SageMaker + * saves the results of a monitoring job. LocalPath is an absolute path for the output + * data.

*/ - ImageVersionNumber?: number; + LocalPath: string | undefined; /** * @public - *

The name of the AppImageConfig.

+ *

Whether to upload the results of the monitoring job continuously or after the job + * completes.

*/ - AppImageConfigName: string | undefined; + S3UploadMode?: ProcessingS3UploadMode; } /** * @public - *

The KernelGateway app settings.

+ *

The output object for a monitoring job.

*/ -export interface KernelGatewayAppSettings { +export interface MonitoringOutput { /** * @public - *

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.

- * - *

The Amazon SageMaker Studio UI does not use the default instance type value set here. The default - * instance type set here is used when Apps are created using the Amazon Web Services Command Line Interface or Amazon Web Services CloudFormation - * and the instance type parameter value is not passed.

- * + *

The Amazon S3 storage location where the results of a monitoring job are + * saved.

*/ - DefaultResourceSpec?: ResourceSpec; + S3Output: MonitoringS3Output | undefined; +} +/** + * @public + *

The output configuration for monitoring jobs.

+ */ +export interface MonitoringOutputConfig { /** * @public - *

A list of custom SageMaker images that are configured to run as a KernelGateway app.

+ *

Monitoring outputs for monitoring jobs. This is where the output of the periodic + * monitoring jobs is uploaded.

*/ - CustomImages?: CustomImage[]; + MonitoringOutputs: MonitoringOutput[] | undefined; /** * @public - *

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.

- * - *

To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

- * + *

The Key Management Service (KMS) key that Amazon SageMaker uses to + * encrypt the model artifacts at rest using Amazon S3 server-side encryption.

*/ - LifecycleConfigArns?: string[]; + KmsKeyId?: string; } /** * @public - *

A collection of settings that apply to spaces created in the Domain.

+ * @enum */ -export interface DefaultSpaceSettings { - /** - * @public - *

The ARN of the execution role for the space.

- */ - ExecutionRole?: string; +export const ProcessingInstanceType = { + ML_C4_2XLARGE: "ml.c4.2xlarge", + ML_C4_4XLARGE: "ml.c4.4xlarge", + ML_C4_8XLARGE: "ml.c4.8xlarge", + ML_C4_XLARGE: "ml.c4.xlarge", + ML_C5_18XLARGE: "ml.c5.18xlarge", + ML_C5_2XLARGE: "ml.c5.2xlarge", + ML_C5_4XLARGE: "ml.c5.4xlarge", + ML_C5_9XLARGE: "ml.c5.9xlarge", + ML_C5_XLARGE: "ml.c5.xlarge", + ML_G4DN_12XLARGE: "ml.g4dn.12xlarge", + ML_G4DN_16XLARGE: "ml.g4dn.16xlarge", + ML_G4DN_2XLARGE: "ml.g4dn.2xlarge", + ML_G4DN_4XLARGE: "ml.g4dn.4xlarge", + ML_G4DN_8XLARGE: "ml.g4dn.8xlarge", + ML_G4DN_XLARGE: "ml.g4dn.xlarge", + ML_M4_10XLARGE: "ml.m4.10xlarge", + ML_M4_16XLARGE: "ml.m4.16xlarge", + ML_M4_2XLARGE: "ml.m4.2xlarge", + ML_M4_4XLARGE: "ml.m4.4xlarge", + ML_M4_XLARGE: "ml.m4.xlarge", + ML_M5_12XLARGE: "ml.m5.12xlarge", + ML_M5_24XLARGE: "ml.m5.24xlarge", + ML_M5_2XLARGE: "ml.m5.2xlarge", + ML_M5_4XLARGE: "ml.m5.4xlarge", + ML_M5_LARGE: "ml.m5.large", + ML_M5_XLARGE: "ml.m5.xlarge", + ML_P2_16XLARGE: "ml.p2.16xlarge", + ML_P2_8XLARGE: "ml.p2.8xlarge", + ML_P2_XLARGE: "ml.p2.xlarge", + ML_P3_16XLARGE: "ml.p3.16xlarge", + ML_P3_2XLARGE: "ml.p3.2xlarge", + ML_P3_8XLARGE: "ml.p3.8xlarge", + ML_R5_12XLARGE: "ml.r5.12xlarge", + ML_R5_16XLARGE: "ml.r5.16xlarge", + ML_R5_24XLARGE: "ml.r5.24xlarge", + ML_R5_2XLARGE: "ml.r5.2xlarge", + ML_R5_4XLARGE: "ml.r5.4xlarge", + ML_R5_8XLARGE: "ml.r5.8xlarge", + ML_R5_LARGE: "ml.r5.large", + ML_R5_XLARGE: "ml.r5.xlarge", + ML_T3_2XLARGE: "ml.t3.2xlarge", + ML_T3_LARGE: "ml.t3.large", + ML_T3_MEDIUM: "ml.t3.medium", + ML_T3_XLARGE: "ml.t3.xlarge", +} as const; - /** - * @public - *

The security group IDs for the Amazon Virtual Private Cloud that the space uses for communication.

- */ - SecurityGroups?: string[]; +/** + * @public + */ +export type ProcessingInstanceType = (typeof ProcessingInstanceType)[keyof typeof ProcessingInstanceType]; +/** + * @public + *

Configuration for the cluster used to run model monitoring jobs.

+ */ +export interface MonitoringClusterConfig { /** * @public - *

The JupyterServer app settings.

+ *

The number of ML compute instances to use in the model monitoring job. For distributed + * processing jobs, specify a value greater than 1. The default value is 1.

*/ - JupyterServerAppSettings?: JupyterServerAppSettings; + InstanceCount: number | undefined; /** * @public - *

The KernelGateway app settings.

+ *

The ML compute instance type for the processing job.

*/ - KernelGatewayAppSettings?: KernelGatewayAppSettings; -} + InstanceType: ProcessingInstanceType | undefined; -/** - * @public - *

A collection of settings that apply to an RSessionGateway app.

- */ -export interface RSessionAppSettings { /** * @public - *

Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that - * the version runs on.

+ *

The size of the ML storage volume, in gigabytes, that you want to provision. You must + * specify sufficient ML storage for your scenario.

*/ - DefaultResourceSpec?: ResourceSpec; + VolumeSizeInGB: number | undefined; /** * @public - *

A list of custom SageMaker images that are configured to run as a RSession app.

+ *

The Key Management Service (KMS) key that Amazon SageMaker uses to + * encrypt data on the storage volume attached to the ML compute instance(s) that run the + * model monitoring job.

*/ - CustomImages?: CustomImage[]; + VolumeKmsKeyId?: string; } /** * @public - * @enum - */ -export const RStudioServerProAccessStatus = { - Disabled: "DISABLED", - Enabled: "ENABLED", -} as const; - -/** - * @public - */ -export type RStudioServerProAccessStatus = - (typeof RStudioServerProAccessStatus)[keyof typeof RStudioServerProAccessStatus]; - -/** - * @public - * @enum - */ -export const RStudioServerProUserGroup = { - Admin: "R_STUDIO_ADMIN", - User: "R_STUDIO_USER", -} as const; - -/** - * @public - */ -export type RStudioServerProUserGroup = (typeof RStudioServerProUserGroup)[keyof typeof RStudioServerProUserGroup]; - -/** - * @public - *

A collection of settings that configure user interaction with the - * RStudioServerPro app.

+ *

Identifies the resources to deploy for a monitoring job.

*/ -export interface RStudioServerProAppSettings { - /** - * @public - *

Indicates whether the current user has access to the RStudioServerPro - * app.

- */ - AccessStatus?: RStudioServerProAccessStatus; - +export interface MonitoringResources { /** * @public - *

The level of permissions that the user has within the RStudioServerPro - * app. This value defaults to `User`. The `Admin` value allows the user access to the - * RStudio Administrative Dashboard.

+ *

The configuration for the cluster resources used to run the processing job.

*/ - UserGroup?: RStudioServerProUserGroup; + ClusterConfig: MonitoringClusterConfig | undefined; } /** * @public - * @enum - */ -export const NotebookOutputOption = { - Allowed: "Allowed", - Disabled: "Disabled", -} as const; - -/** - * @public - */ -export type NotebookOutputOption = (typeof NotebookOutputOption)[keyof typeof NotebookOutputOption]; - -/** - * @public - *

Specifies options for sharing SageMaker Studio notebooks. These settings are - * specified as part of DefaultUserSettings when the CreateDomain - * API is called, and as part of UserSettings when the CreateUserProfile - * API is called. When SharingSettings is not specified, notebook sharing - * isn't allowed.

+ *

The networking configuration for the monitoring job.

*/ -export interface SharingSettings { +export interface MonitoringNetworkConfig { /** * @public - *

Whether to include the notebook cell output when sharing the notebook. The default - * is Disabled.

+ *

Whether to encrypt all communications between the instances used for the monitoring + * jobs. Choose True to encrypt communications. Encryption provides greater + * security for distributed jobs, but the processing might take longer.

*/ - NotebookOutputOption?: NotebookOutputOption; + EnableInterContainerTrafficEncryption?: boolean; /** * @public - *

When NotebookOutputOption is Allowed, the Amazon S3 bucket used - * to store the shared notebook snapshots.

+ *

Whether to allow inbound and outbound network calls to and from the containers used for + * the monitoring job.

*/ - S3OutputPath?: string; + EnableNetworkIsolation?: boolean; /** * @public - *

When NotebookOutputOption is Allowed, the Amazon Web Services Key Management Service (KMS) - * encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

+ *

Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources + * have access to. You can control access to and from your resources by configuring a VPC. + * For more information, see Give SageMaker Access to Resources in your Amazon VPC.

*/ - S3KmsKeyId?: string; + VpcConfig?: VpcConfig; } /** * @public - *

The TensorBoard app settings.

+ *

A time limit for how long the monitoring job is allowed to run before stopping.

*/ -export interface TensorBoardAppSettings { +export interface MonitoringStoppingCondition { /** * @public - *

The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

+ *

The maximum runtime allowed in seconds.

+ * + *

The MaxRuntimeInSeconds cannot exceed the frequency of the job. For data + * quality and model explainability, this can be up to 3600 seconds for an hourly schedule. + * For model bias and model quality hourly schedules, this can be up to 1800 + * seconds.

+ * */ - DefaultResourceSpec?: ResourceSpec; + MaxRuntimeInSeconds: number | undefined; } /** * @public - *

A collection of settings that apply to users of Amazon SageMaker Studio. These settings are - * specified when the CreateUserProfile API is called, and as DefaultUserSettings - * when the CreateDomain API is called.

- *

- * SecurityGroups is aggregated when specified in both calls. For all other - * settings in UserSettings, the values specified in CreateUserProfile - * take precedence over those specified in CreateDomain.

*/ -export interface UserSettings { +export interface CreateDataQualityJobDefinitionRequest { /** * @public - *

The execution role for the user.

+ *

The name for the monitoring job definition.

*/ - ExecutionRole?: string; + JobDefinitionName: string | undefined; /** * @public - *

The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

- *

Optional when the CreateDomain.AppNetworkAccessType parameter is set to - * PublicInternetOnly.

- *

Required when the CreateDomain.AppNetworkAccessType parameter is set to - * VpcOnly, unless specified as part of the DefaultUserSettings for the domain.

- *

Amazon SageMaker adds a security group to allow NFS traffic from SageMaker Studio. Therefore, the - * number of security groups that you can specify is one less than the maximum number shown.

+ *

Configures the constraints and baselines for the monitoring job.

*/ - SecurityGroups?: string[]; + DataQualityBaselineConfig?: DataQualityBaselineConfig; /** * @public - *

Specifies options for sharing SageMaker Studio notebooks.

+ *

Specifies the container that runs the monitoring job.

*/ - SharingSettings?: SharingSettings; + DataQualityAppSpecification: DataQualityAppSpecification | undefined; /** * @public - *

The Jupyter server's app settings.

+ *

A list of inputs for the monitoring job. Currently endpoints are supported as monitoring + * inputs.

*/ - JupyterServerAppSettings?: JupyterServerAppSettings; + DataQualityJobInput: DataQualityJobInput | undefined; /** * @public - *

The kernel gateway app settings.

+ *

The output configuration for monitoring jobs.

*/ - KernelGatewayAppSettings?: KernelGatewayAppSettings; + DataQualityJobOutputConfig: MonitoringOutputConfig | undefined; /** * @public - *

The TensorBoard app settings.

+ *

Identifies the resources to deploy for a monitoring job.

*/ - TensorBoardAppSettings?: TensorBoardAppSettings; + JobResources: MonitoringResources | undefined; /** * @public - *

A collection of settings that configure user interaction with the - * RStudioServerPro app.

+ *

Specifies networking configuration for the monitoring job.

*/ - RStudioServerProAppSettings?: RStudioServerProAppSettings; + NetworkConfig?: MonitoringNetworkConfig; /** * @public - *

A collection of settings that configure the RSessionGateway app.

+ *

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can + * assume to perform tasks on your behalf.

*/ - RSessionAppSettings?: RSessionAppSettings; + RoleArn: string | undefined; /** * @public - *

The Canvas app settings.

+ *

A time limit for how long the monitoring job is allowed to run before stopping.

*/ - CanvasAppSettings?: CanvasAppSettings; + StoppingCondition?: MonitoringStoppingCondition; + + /** + * @public + *

(Optional) An array of key-value pairs. For more information, see + * + * Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

+ */ + Tags?: Tag[]; +} + +/** + * @public + */ +export interface CreateDataQualityJobDefinitionResponse { + /** + * @public + *

The Amazon Resource Name (ARN) of the job definition.

+ */ + JobDefinitionArn: string | undefined; } /** * @public * @enum */ -export const ExecutionRoleIdentityConfig = { - DISABLED: "DISABLED", - USER_PROFILE_NAME: "USER_PROFILE_NAME", +export const EdgePresetDeploymentType = { + GreengrassV2Component: "GreengrassV2Component", } as const; /** * @public */ -export type ExecutionRoleIdentityConfig = - (typeof ExecutionRoleIdentityConfig)[keyof typeof ExecutionRoleIdentityConfig]; +export type EdgePresetDeploymentType = (typeof EdgePresetDeploymentType)[keyof typeof EdgePresetDeploymentType]; /** * @public - *

A collection of settings that configure the RStudioServerPro Domain-level - * app.

+ *

The output configuration.

*/ -export interface RStudioServerProDomainSettings { +export interface EdgeOutputConfig { /** * @public - *

The ARN of the execution role for the RStudioServerPro Domain-level - * app.

+ *

The Amazon Simple Storage (S3) bucker URI.

*/ - DomainExecutionRoleArn: string | undefined; + S3OutputLocation: string | undefined; /** * @public - *

A URL pointing to an RStudio Connect server.

+ *

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. + * If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account.

*/ - RStudioConnectUrl?: string; + KmsKeyId?: string; /** * @public - *

A URL pointing to an RStudio Package Manager server.

+ *

The deployment type SageMaker Edge Manager will create. + * Currently only supports Amazon Web Services IoT Greengrass Version 2 components.

*/ - RStudioPackageManagerUrl?: string; + PresetDeploymentType?: EdgePresetDeploymentType; /** * @public - *

Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that - * the version runs on.

+ *

The configuration used to create deployment artifacts. + * Specify configuration options with a JSON string. The available configuration options for each type are:

+ *
    + *
  • + *

    + * ComponentName (optional) - Name of the GreenGrass V2 component. If not specified, + * the default name generated consists of "SagemakerEdgeManager" and the name of your SageMaker Edge Manager + * packaging job.

    + *
    • + *
  • + *

    + * ComponentDescription (optional) - Description of the component.

    + *
    • + *
  • + *

    + * ComponentVersion (optional) - The version of the component.

    + * + *

    Amazon Web Services IoT Greengrass uses semantic versions for components. Semantic versions follow a + * major.minor.patch number system. For example, version 1.0.0 represents the first + * major release for a component. For more information, see the semantic version specification.

    + *     + *
    • + *
  • + *

    + * PlatformOS (optional) - The name of the operating system for the platform. + * Supported platforms include Windows and Linux.

    + *
    • + *
  • + *

    + * PlatformArchitecture (optional) - The processor architecture for the platform.

    + *

    Supported architectures Windows include: Windows32_x86, Windows64_x64.

    + *

    Supported architectures for Linux include: Linux x86_64, Linux ARMV8.

    + *
    • + *
*/ - DefaultResourceSpec?: ResourceSpec; + PresetDeploymentConfig?: string; } /** * @public - *

A collection of settings that apply to the SageMaker Domain. These - * settings are specified through the CreateDomain API call.

*/ -export interface DomainSettings { +export interface CreateDeviceFleetRequest { /** * @public - *

The security groups for the Amazon Virtual Private Cloud that the Domain uses for - * communication between Domain-level apps and user apps.

+ *

The name of the fleet that the device belongs to.

*/ - SecurityGroupIds?: string[]; + DeviceFleetName: string | undefined; /** * @public - *

A collection of settings that configure the RStudioServerPro Domain-level - * app.

+ *

The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).

*/ - RStudioServerProDomainSettings?: RStudioServerProDomainSettings; + RoleArn?: string; /** * @public - *

The configuration for attaching a SageMaker user profile name to the execution role as a - * sts:SourceIdentity key.

+ *

A description of the fleet.

*/ - ExecutionRoleIdentityConfig?: ExecutionRoleIdentityConfig; -} + Description?: string; -/** - * @public - */ -export interface CreateDomainRequest { /** * @public - *

A name for the domain.

+ *

The output configuration for storing sample data collected by the fleet.

*/ - DomainName: string | undefined; + OutputConfig: EdgeOutputConfig | undefined; /** * @public - *

The mode of authentication that members use to access the domain.

+ *

Creates tags for the specified fleet.

*/ - AuthMode: AuthMode | undefined; + Tags?: Tag[]; /** * @public - *

The default settings to use to create a user profile when UserSettings isn't specified - * in the call to the CreateUserProfile API.

- *

- * SecurityGroups is aggregated when specified in both calls. For all other - * settings in UserSettings, the values specified in CreateUserProfile - * take precedence over those specified in CreateDomain.

+ *

Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. + * The name of the role alias generated will match this pattern: + * "SageMakerEdge-\{DeviceFleetName\}".

+ *

For example, if your device fleet is called "demo-fleet", the name of + * the role alias will be "SageMakerEdge-demo-fleet".

*/ - DefaultUserSettings: UserSettings | undefined; + EnableIotRoleAlias?: boolean; +} +/** + * @public + *

The JupyterServer app settings.

+ */ +export interface JupyterServerAppSettings { /** * @public - *

The VPC subnets that Studio uses for communication.

+ *

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterServer app. If you use the LifecycleConfigArns parameter, then this parameter is also required.

*/ - SubnetIds: string[] | undefined; + DefaultResourceSpec?: ResourceSpec; /** * @public - *

The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

+ *

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. If you use this parameter, the DefaultResourceSpec parameter is also required.

+ * + *

To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

+ * */ - VpcId: string | undefined; + LifecycleConfigArns?: string[]; /** * @public - *

Tags to associated with the Domain. Each tag consists of a key and an optional value. - * Tag keys must be unique per resource. Tags are searchable using the - * Search API.

- *

Tags that you specify for the Domain are also added to all Apps that the - * Domain launches.

+ *

A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer application.

*/ - Tags?: Tag[]; + CodeRepositories?: CodeRepository[]; +} +/** + * @public + *

A custom SageMaker image. For more information, see + * Bring your own SageMaker image.

+ */ +export interface CustomImage { /** * @public - *

Specifies the VPC used for non-EFS traffic. The default value is - * PublicInternetOnly.

- *
    - *
  • - *

    - * PublicInternetOnly - Non-EFS traffic is through a VPC managed by - * Amazon SageMaker, which allows direct internet access

    - *
    • - *
  • - *

    - * VpcOnly - All Studio traffic is through the specified VPC and subnets

    - *
    • - *
+ *

The name of the CustomImage. Must be unique to your account.

*/ - AppNetworkAccessType?: AppNetworkAccessType; + ImageName: string | undefined; /** * @public - * @deprecated - * - *

Use KmsKeyId.

+ *

The version number of the CustomImage.

*/ - HomeEfsFileSystemKmsKeyId?: string; + ImageVersionNumber?: number; /** * @public - *

SageMaker uses Amazon Web Services KMS to encrypt the EFS volume attached to the domain with an Amazon Web Services managed - * key by default. For more control, specify a customer managed key.

+ *

The name of the AppImageConfig.

*/ - KmsKeyId?: string; + AppImageConfigName: string | undefined; +} +/** + * @public + *

The KernelGateway app settings.

+ */ +export interface KernelGatewayAppSettings { /** * @public - *

The entity that creates and manages the required security groups for inter-app - * communication in VPCOnly mode. Required when - * CreateDomain.AppNetworkAccessType is VPCOnly and - * DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is - * provided. If setting up the domain for use with RStudio, this value must be set to - * Service.

+ *

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.

+ * + *

The Amazon SageMaker Studio UI does not use the default instance type value set here. The default + * instance type set here is used when Apps are created using the Amazon Web Services Command Line Interface or Amazon Web Services CloudFormation + * and the instance type parameter value is not passed.

+ * */ - AppSecurityGroupManagement?: AppSecurityGroupManagement; + DefaultResourceSpec?: ResourceSpec; /** * @public - *

A collection of Domain settings.

+ *

A list of custom SageMaker images that are configured to run as a KernelGateway app.

*/ - DomainSettings?: DomainSettings; + CustomImages?: CustomImage[]; /** * @public - *

The default settings used to create a space.

+ *

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.

+ * + *

To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

+ * */ - DefaultSpaceSettings?: DefaultSpaceSettings; + LifecycleConfigArns?: string[]; } /** * @public + *

A collection of settings that apply to spaces created in the Domain.

*/ -export interface CreateDomainResponse { +export interface DefaultSpaceSettings { /** * @public - *

The Amazon Resource Name (ARN) of the created domain.

+ *

The ARN of the execution role for the space.

*/ - DomainArn?: string; + ExecutionRole?: string; /** * @public - *

The URL to the created domain.

+ *

The security group IDs for the Amazon Virtual Private Cloud that the space uses for communication.

*/ - Url?: string; + SecurityGroups?: string[]; + + /** + * @public + *

The JupyterServer app settings.

+ */ + JupyterServerAppSettings?: JupyterServerAppSettings; + + /** + * @public + *

The KernelGateway app settings.

+ */ + KernelGatewayAppSettings?: KernelGatewayAppSettings; } /** * @public - *

Contains information about the configuration of a model in a deployment.

+ *

A collection of settings that apply to an RSessionGateway app.

*/ -export interface EdgeDeploymentModelConfig { +export interface RSessionAppSettings { /** * @public - *

The name the device application uses to reference this model.

+ *

Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that + * the version runs on.

*/ - ModelHandle: string | undefined; + DefaultResourceSpec?: ResourceSpec; /** * @public - *

The edge packaging job associated with this deployment.

+ *

A list of custom SageMaker images that are configured to run as a RSession app.

*/ - EdgePackagingJobName: string | undefined; + CustomImages?: CustomImage[]; } /** * @public * @enum */ -export const FailureHandlingPolicy = { - DoNothing: "DO_NOTHING", - RollbackOnFailure: "ROLLBACK_ON_FAILURE", +export const RStudioServerProAccessStatus = { + Disabled: "DISABLED", + Enabled: "ENABLED", } as const; /** * @public */ -export type FailureHandlingPolicy = (typeof FailureHandlingPolicy)[keyof typeof FailureHandlingPolicy]; - -/** - * @public - *

Contains information about the configuration of a deployment.

- */ -export interface EdgeDeploymentConfig { - /** - * @public - *

Toggle that determines whether to rollback to previous configuration if the current - * deployment fails. By default this is turned on. You may turn this off if you want to - * investigate the errors yourself.

- */ - FailureHandlingPolicy: FailureHandlingPolicy | undefined; -} +export type RStudioServerProAccessStatus = + (typeof RStudioServerProAccessStatus)[keyof typeof RStudioServerProAccessStatus]; /** * @public * @enum */ -export const DeviceSubsetType = { - NameContains: "NAMECONTAINS", - Percentage: "PERCENTAGE", - Selection: "SELECTION", +export const RStudioServerProUserGroup = { + Admin: "R_STUDIO_ADMIN", + User: "R_STUDIO_USER", } as const; /** * @public */ -export type DeviceSubsetType = (typeof DeviceSubsetType)[keyof typeof DeviceSubsetType]; +export type RStudioServerProUserGroup = (typeof RStudioServerProUserGroup)[keyof typeof RStudioServerProUserGroup]; /** * @public - *

Contains information about the configurations of selected devices.

+ *

A collection of settings that configure user interaction with the + * RStudioServerPro app.

*/ -export interface DeviceSelectionConfig { +export interface RStudioServerProAppSettings { /** * @public - *

Type of device subsets to deploy to the current stage.

+ *

Indicates whether the current user has access to the RStudioServerPro + * app.

*/ - DeviceSubsetType: DeviceSubsetType | undefined; + AccessStatus?: RStudioServerProAccessStatus; /** * @public - *

Percentage of devices in the fleet to deploy to the current stage.

+ *

The level of permissions that the user has within the RStudioServerPro + * app. This value defaults to `User`. The `Admin` value allows the user access to the + * RStudio Administrative Dashboard.

*/ - Percentage?: number; + UserGroup?: RStudioServerProUserGroup; +} - /** - * @public - *

List of devices chosen to deploy.

- */ - DeviceNames?: string[]; +/** + * @public + * @enum + */ +export const NotebookOutputOption = { + Allowed: "Allowed", + Disabled: "Disabled", +} as const; - /** - * @public - *

A filter to select devices with names containing this name.

- */ - DeviceNameContains?: string; -} +/** + * @public + */ +export type NotebookOutputOption = (typeof NotebookOutputOption)[keyof typeof NotebookOutputOption]; /** * @public - *

Contains information about a stage in an edge deployment plan.

+ *

Specifies options for sharing Amazon SageMaker Studio notebooks. These settings are + * specified as part of DefaultUserSettings when the CreateDomain + * API is called, and as part of UserSettings when the CreateUserProfile + * API is called. When SharingSettings is not specified, notebook sharing + * isn't allowed.

*/ -export interface DeploymentStage { +export interface SharingSettings { /** * @public - *

The name of the stage.

+ *

Whether to include the notebook cell output when sharing the notebook. The default + * is Disabled.

*/ - StageName: string | undefined; + NotebookOutputOption?: NotebookOutputOption; /** * @public - *

Configuration of the devices in the stage.

+ *

When NotebookOutputOption is Allowed, the Amazon S3 bucket used + * to store the shared notebook snapshots.

*/ - DeviceSelectionConfig: DeviceSelectionConfig | undefined; + S3OutputPath?: string; /** * @public - *

Configuration of the deployment details.

+ *

When NotebookOutputOption is Allowed, the Amazon Web Services Key Management Service (KMS) + * encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

*/ - DeploymentConfig?: EdgeDeploymentConfig; + S3KmsKeyId?: string; } /** * @public + * @enum */ -export interface CreateEdgeDeploymentPlanRequest { - /** - * @public - *

The name of the edge deployment plan.

- */ - EdgeDeploymentPlanName: string | undefined; - - /** - * @public - *

List of models associated with the edge deployment plan.

- */ - ModelConfigs: EdgeDeploymentModelConfig[] | undefined; - - /** - * @public - *

The device fleet used for this edge deployment plan.

- */ - DeviceFleetName: string | undefined; +export const StudioWebPortal = { + Disabled: "DISABLED", + Enabled: "ENABLED", +} as const; - /** - * @public - *

List of stages of the edge deployment plan. The number of stages is limited to 10 per - * deployment.

- */ - Stages?: DeploymentStage[]; +/** + * @public + */ +export type StudioWebPortal = (typeof StudioWebPortal)[keyof typeof StudioWebPortal]; +/** + * @public + *

The TensorBoard app settings.

+ */ +export interface TensorBoardAppSettings { /** * @public - *

List of tags with which to tag the edge deployment plan.

+ *

The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

*/ - Tags?: Tag[]; + DefaultResourceSpec?: ResourceSpec; } /** * @public + *

A collection of settings that apply to users in a domain. These settings are + * specified when the CreateUserProfile API is called, and as DefaultUserSettings + * when the CreateDomain API is called.

+ *

+ * SecurityGroups is aggregated when specified in both calls. For all other + * settings in UserSettings, the values specified in CreateUserProfile + * take precedence over those specified in CreateDomain.

*/ -export interface CreateEdgeDeploymentPlanResponse { +export interface UserSettings { /** * @public - *

The ARN of the edge deployment plan.

+ *

The execution role for the user.

*/ - EdgeDeploymentPlanArn: string | undefined; -} + ExecutionRole?: string; -/** - * @public - */ -export interface CreateEdgeDeploymentStageRequest { /** * @public - *

The name of the edge deployment plan.

+ *

The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

+ *

Optional when the CreateDomain.AppNetworkAccessType parameter is set to + * PublicInternetOnly.

+ *

Required when the CreateDomain.AppNetworkAccessType parameter is set to + * VpcOnly, unless specified as part of the DefaultUserSettings for the domain.

+ *

Amazon SageMaker adds a security group to allow NFS traffic from Amazon SageMaker Studio. Therefore, the + * number of security groups that you can specify is one less than the maximum number shown.

*/ - EdgeDeploymentPlanName: string | undefined; + SecurityGroups?: string[]; /** * @public - *

List of stages to be added to the edge deployment plan.

+ *

Specifies options for sharing Amazon SageMaker Studio notebooks.

*/ - Stages: DeploymentStage[] | undefined; -} + SharingSettings?: SharingSettings; -/** - * @public - */ -export interface CreateEdgePackagingJobRequest { /** * @public - *

The name of the edge packaging job.

+ *

The Jupyter server's app settings.

*/ - EdgePackagingJobName: string | undefined; + JupyterServerAppSettings?: JupyterServerAppSettings; /** * @public - *

The name of the SageMaker Neo compilation job that will be used to locate model artifacts for packaging.

+ *

The kernel gateway app settings.

*/ - CompilationJobName: string | undefined; + KernelGatewayAppSettings?: KernelGatewayAppSettings; /** * @public - *

The name of the model.

+ *

The TensorBoard app settings.

*/ - ModelName: string | undefined; + TensorBoardAppSettings?: TensorBoardAppSettings; /** * @public - *

The version of the model.

+ *

A collection of settings that configure user interaction with the + * RStudioServerPro app.

*/ - ModelVersion: string | undefined; + RStudioServerProAppSettings?: RStudioServerProAppSettings; /** * @public - *

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact SageMaker Neo.

+ *

A collection of settings that configure the RSessionGateway app.

*/ - RoleArn: string | undefined; + RSessionAppSettings?: RSessionAppSettings; /** * @public - *

Provides information about the output location for the packaged model.

+ *

The Canvas app settings.

*/ - OutputConfig: EdgeOutputConfig | undefined; + CanvasAppSettings?: CanvasAppSettings; /** * @public - *

The Amazon Web Services KMS key to use when encrypting the EBS volume the edge packaging job runs on.

+ *

The default experience that the user is directed to when accessing the domain. The supported values are:

+ *
    + *
  • + *

    + * studio::: Indicates that Studio is the default experience. This value can only be passed if StudioWebPortal is set to ENABLED.

    + *
    • + *
  • + *

    + * app:JupyterServer:: Indicates that Studio Classic is the default experience.

    + *
    • + *
*/ - ResourceKey?: string; + DefaultLandingUri?: string; /** * @public - *

Creates tags for the packaging job.

+ *

Whether the user can access Studio. If this value is set to DISABLED, the user cannot access Studio, even if that is the default experience for the domain.

*/ - Tags?: Tag[]; + StudioWebPortal?: StudioWebPortal; } /** * @public - *

Specifies a rolling deployment strategy for updating a SageMaker endpoint.

+ * @enum */ -export interface RollingUpdatePolicy { +export const ExecutionRoleIdentityConfig = { + DISABLED: "DISABLED", + USER_PROFILE_NAME: "USER_PROFILE_NAME", +} as const; + +/** + * @public + */ +export type ExecutionRoleIdentityConfig = + (typeof ExecutionRoleIdentityConfig)[keyof typeof ExecutionRoleIdentityConfig]; + +/** + * @public + *

A collection of settings that configure the RStudioServerPro Domain-level + * app.

+ */ +export interface RStudioServerProDomainSettings { /** * @public - *

Batch size for each rolling step to provision capacity and turn on traffic on the new - * endpoint fleet, and terminate capacity on the old endpoint fleet. Value must be between - * 5% to 50% of the variant's total instance count.

+ *

The ARN of the execution role for the RStudioServerPro Domain-level + * app.

*/ - MaximumBatchSize: CapacitySize | undefined; + DomainExecutionRoleArn: string | undefined; /** * @public - *

The length of the baking period, during which SageMaker monitors alarms for each batch on - * the new fleet.

+ *

A URL pointing to an RStudio Connect server.

*/ - WaitIntervalInSeconds: number | undefined; + RStudioConnectUrl?: string; /** * @public - *

The time limit for the total deployment. Exceeding this limit causes a timeout.

+ *

A URL pointing to an RStudio Package Manager server.

*/ - MaximumExecutionTimeoutInSeconds?: number; + RStudioPackageManagerUrl?: string; /** * @public - *

Batch size for rollback to the old endpoint fleet. Each rolling step to provision - * capacity and turn on traffic on the old endpoint fleet, and terminate capacity on the - * new endpoint fleet. If this field is absent, the default value will be set to 100% of - * total capacity which means to bring up the whole capacity of the old fleet at once - * during rollback.

+ *

Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that + * the version runs on.

*/ - RollbackMaximumBatchSize?: CapacitySize; + DefaultResourceSpec?: ResourceSpec; } /** * @public - *

The deployment configuration for an endpoint, which contains the desired deployment - * strategy and rollback configurations.

+ *

A collection of settings that apply to the SageMaker Domain. These + * settings are specified through the CreateDomain API call.

*/ -export interface DeploymentConfig { +export interface DomainSettings { /** * @public - *

Update policy for a blue/green deployment. If this update policy is specified, SageMaker - * creates a new fleet during the deployment while maintaining the old fleet. SageMaker flips - * traffic to the new fleet according to the specified traffic routing configuration. Only - * one update policy should be used in the deployment configuration. If no update policy is - * specified, SageMaker uses a blue/green deployment strategy with all at once traffic shifting - * by default.

+ *

The security groups for the Amazon Virtual Private Cloud that the Domain uses for + * communication between Domain-level apps and user apps.

*/ - BlueGreenUpdatePolicy?: BlueGreenUpdatePolicy; + SecurityGroupIds?: string[]; /** * @public - *

Automatic rollback configuration for handling endpoint deployment failures and - * recovery.

+ *

A collection of settings that configure the RStudioServerPro Domain-level + * app.

*/ - AutoRollbackConfiguration?: AutoRollbackConfig; + RStudioServerProDomainSettings?: RStudioServerProDomainSettings; /** * @public - *

Specifies a rolling deployment strategy for updating a SageMaker endpoint.

+ *

The configuration for attaching a SageMaker user profile name to the execution role as a + * sts:SourceIdentity key.

*/ - RollingUpdatePolicy?: RollingUpdatePolicy; + ExecutionRoleIdentityConfig?: ExecutionRoleIdentityConfig; } /** * @public */ -export interface CreateEndpointInput { +export interface CreateDomainRequest { /** * @public - *

The name of the endpoint.The name must be unique within an Amazon Web Services - * Region in your Amazon Web Services account. The name is case-insensitive in - * CreateEndpoint, but the case is preserved and must be matched in InvokeEndpoint.

+ *

A name for the domain.

*/ - EndpointName: string | undefined; + DomainName: string | undefined; /** * @public - *

The name of an endpoint configuration. For more information, see CreateEndpointConfig.

+ *

The mode of authentication that members use to access the domain.

*/ - EndpointConfigName: string | undefined; + AuthMode: AuthMode | undefined; /** * @public - *

The deployment configuration for an endpoint, which contains the desired deployment - * strategy and rollback configurations.

- */ - DeploymentConfig?: DeploymentConfig; - - /** - * @public - *

An array of key-value pairs. You can use tags to categorize your Amazon Web Services - * resources in different ways, for example, by purpose, owner, or environment. For more - * information, see Tagging Amazon Web Services Resources.

- */ - Tags?: Tag[]; -} - -/** - * @public - */ -export interface CreateEndpointOutput { - /** - * @public - *

The Amazon Resource Name (ARN) of the endpoint.

+ *

The default settings to use to create a user profile when UserSettings isn't specified + * in the call to the CreateUserProfile API.

+ *

+ * SecurityGroups is aggregated when specified in both calls. For all other + * settings in UserSettings, the values specified in CreateUserProfile + * take precedence over those specified in CreateDomain.

*/ - EndpointArn: string | undefined; -} + DefaultUserSettings: UserSettings | undefined; -/** - * @public - *

Configuration to control how SageMaker captures inference data.

- */ -export interface DataCaptureConfig { /** * @public - *

Whether data capture should be enabled or disabled (defaults to enabled).

+ *

The VPC subnets that the domain uses for communication.

*/ - EnableCapture?: boolean; + SubnetIds: string[] | undefined; /** * @public - *

The percentage of requests SageMaker will capture. A lower value is recommended - * for Endpoints with high traffic.

+ *

The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

*/ - InitialSamplingPercentage: number | undefined; + VpcId: string | undefined; /** * @public - *

The Amazon S3 location used to capture the data.

+ *

Tags to associated with the Domain. Each tag consists of a key and an optional value. + * Tag keys must be unique per resource. Tags are searchable using the + * Search API.

+ *

Tags that you specify for the Domain are also added to all Apps that the + * Domain launches.

*/ - DestinationS3Uri: string | undefined; + Tags?: Tag[]; /** * @public - *

The Amazon Resource Name (ARN) of an Key Management Service key that SageMaker - * uses to encrypt the captured data at rest using Amazon S3 server-side - * encryption.

- *

The KmsKeyId can be any of the following formats:

+ *

Specifies the VPC used for non-EFS traffic. The default value is + * PublicInternetOnly.

*
    *
  • - *

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab - *

    - *
    • - *
  • - *

    Key ARN: - * arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - *

    - *
    • - *
  • - *

    Alias name: alias/ExampleAlias - *

    + *

    + * PublicInternetOnly - Non-EFS traffic is through a VPC managed by + * Amazon SageMaker, which allows direct internet access

    *
    • *
  • - *

    Alias name ARN: - * arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias - *

    + *

    + * VpcOnly - All traffic is through the specified VPC and subnets

    *
    • *
*/ + AppNetworkAccessType?: AppNetworkAccessType; + + /** + * @public + * @deprecated + * + *

Use KmsKeyId.

+ */ + HomeEfsFileSystemKmsKeyId?: string; + + /** + * @public + *

SageMaker uses Amazon Web Services KMS to encrypt the EFS volume attached to the domain with an Amazon Web Services managed + * key by default. For more control, specify a customer managed key.

+ */ KmsKeyId?: string; /** * @public - *

Specifies data Model Monitor will capture. You can configure whether to collect only - * input, only output, or both

+ *

The entity that creates and manages the required security groups for inter-app + * communication in VPCOnly mode. Required when + * CreateDomain.AppNetworkAccessType is VPCOnly and + * DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is + * provided. If setting up the domain for use with RStudio, this value must be set to + * Service.

*/ - CaptureOptions: CaptureOption[] | undefined; + AppSecurityGroupManagement?: AppSecurityGroupManagement; /** * @public - *

Configuration specifying how to treat different headers. If no headers are specified - * SageMaker will by default base64 encode when capturing the data.

+ *

A collection of Domain settings.

*/ - CaptureContentTypeHeader?: CaptureContentTypeHeader; + DomainSettings?: DomainSettings; + + /** + * @public + *

The default settings used to create a space.

+ */ + DefaultSpaceSettings?: DefaultSpaceSettings; } /** * @public - *

A parameter to activate explainers.

*/ -export interface ExplainerConfig { +export interface CreateDomainResponse { /** * @public - *

A member of ExplainerConfig that contains configuration parameters for - * the SageMaker Clarify explainer.

+ *

The Amazon Resource Name (ARN) of the created domain.

*/ - ClarifyExplainerConfig?: ClarifyExplainerConfig; + DomainArn?: string; + + /** + * @public + *

The URL to the created domain.

+ */ + Url?: string; +} + +/** + * @public + *

Contains information about the configuration of a model in a deployment.

+ */ +export interface EdgeDeploymentModelConfig { + /** + * @public + *

The name the device application uses to reference this model.

+ */ + ModelHandle: string | undefined; + + /** + * @public + *

The edge packaging job associated with this deployment.

+ */ + EdgePackagingJobName: string | undefined; } /** * @public * @enum */ -export const ProductionVariantAcceleratorType = { - ML_EIA1_LARGE: "ml.eia1.large", - ML_EIA1_MEDIUM: "ml.eia1.medium", - ML_EIA1_XLARGE: "ml.eia1.xlarge", - ML_EIA2_LARGE: "ml.eia2.large", - ML_EIA2_MEDIUM: "ml.eia2.medium", - ML_EIA2_XLARGE: "ml.eia2.xlarge", +export const FailureHandlingPolicy = { + DoNothing: "DO_NOTHING", + RollbackOnFailure: "ROLLBACK_ON_FAILURE", } as const; /** * @public */ -export type ProductionVariantAcceleratorType = - (typeof ProductionVariantAcceleratorType)[keyof typeof ProductionVariantAcceleratorType]; +export type FailureHandlingPolicy = (typeof FailureHandlingPolicy)[keyof typeof FailureHandlingPolicy]; /** * @public - *

Specifies configuration for a core dump from the model container when the process - * crashes.

+ *

Contains information about the configuration of a deployment.

*/ -export interface ProductionVariantCoreDumpConfig { - /** - * @public - *

The Amazon S3 bucket to send the core dump to.

- */ - DestinationS3Uri: string | undefined; - +export interface EdgeDeploymentConfig { /** * @public - *

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker - * uses to encrypt the core dump data at rest using Amazon S3 server-side encryption. The - * KmsKeyId can be any of the following formats:

- *
    - *
  • - *

    // KMS Key ID

    - *

    - * "1234abcd-12ab-34cd-56ef-1234567890ab" - *

    - *
    • - *
  • - *

    // Amazon Resource Name (ARN) of a KMS Key

    - *

    - * "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" - *

    - *
    • - *
  • - *

    // KMS Key Alias

    - *

    - * "alias/ExampleAlias" - *

    - *
    • - *
  • - *

    // Amazon Resource Name (ARN) of a KMS Key Alias

    - *

    - * "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias" - *

    - *
    • - *
- *

If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must - * include permissions to call kms:Encrypt. If you don't provide a KMS key ID, - * SageMaker uses the default KMS key for Amazon S3 for your role's account. SageMaker uses server-side - * encryption with KMS-managed keys for OutputDataConfig. If you use a bucket - * policy with an s3:PutObject permission that only allows objects with - * server-side encryption, set the condition key of - * s3:x-amz-server-side-encryption to "aws:kms". For more - * information, see KMS-Managed Encryption - * Keys in the Amazon Simple Storage Service Developer Guide. - *

- *

The KMS key policy must grant permission to the IAM role that you specify in your - * CreateEndpoint and UpdateEndpoint requests. For more - * information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management - * Service Developer Guide.

+ *

Toggle that determines whether to rollback to previous configuration if the current + * deployment fails. By default this is turned on. You may turn this off if you want to + * investigate the errors yourself.

*/ - KmsKeyId?: string; + FailureHandlingPolicy: FailureHandlingPolicy | undefined; } /** * @public - *

Specifies the serverless configuration for an endpoint variant.

+ * @enum */ -export interface ProductionVariantServerlessConfig { +export const DeviceSubsetType = { + NameContains: "NAMECONTAINS", + Percentage: "PERCENTAGE", + Selection: "SELECTION", +} as const; + +/** + * @public + */ +export type DeviceSubsetType = (typeof DeviceSubsetType)[keyof typeof DeviceSubsetType]; + +/** + * @public + *

Contains information about the configurations of selected devices.

+ */ +export interface DeviceSelectionConfig { /** * @public - *

The memory size of your serverless endpoint. Valid values are in 1 GB increments: 1024 MB, 2048 MB, 3072 MB, 4096 MB, 5120 MB, or 6144 MB.

+ *

Type of device subsets to deploy to the current stage.

*/ - MemorySizeInMB: number | undefined; + DeviceSubsetType: DeviceSubsetType | undefined; /** * @public - *

The maximum number of concurrent invocations your serverless endpoint can process.

+ *

Percentage of devices in the fleet to deploy to the current stage.

*/ - MaxConcurrency: number | undefined; + Percentage?: number; /** * @public - *

The amount of provisioned concurrency to allocate for the serverless endpoint. - * Should be less than or equal to MaxConcurrency.

- * - *

This field is not supported for serverless endpoint recommendations for Inference Recommender jobs. - * For more information about creating an Inference Recommender job, see - * CreateInferenceRecommendationsJobs.

- * + *

List of devices chosen to deploy.

*/ - ProvisionedConcurrency?: number; + DeviceNames?: string[]; + + /** + * @public + *

A filter to select devices with names containing this name.

+ */ + DeviceNameContains?: string; } /** * @public - *

Identifies a model that you want to host and the resources chosen to deploy for - * hosting it. If you are deploying multiple models, tell SageMaker how to distribute traffic - * among the models by specifying variant weights. For more information on production - * variants, check Production variants. - *

+ *

Contains information about a stage in an edge deployment plan.

*/ -export interface ProductionVariant { - /** - * @public - *

The name of the production variant.

- */ - VariantName: string | undefined; - +export interface DeploymentStage { /** * @public - *

The name of the model that you want to host. This is the name that you specified - * when creating the model.

+ *

The name of the stage.

*/ - ModelName: string | undefined; + StageName: string | undefined; /** * @public - *

Number of instances to launch initially.

+ *

Configuration of the devices in the stage.

*/ - InitialInstanceCount?: number; + DeviceSelectionConfig: DeviceSelectionConfig | undefined; /** * @public - *

The ML compute instance type.

+ *

Configuration of the deployment details.

*/ - InstanceType?: ProductionVariantInstanceType; + DeploymentConfig?: EdgeDeploymentConfig; +} +/** + * @public + */ +export interface CreateEdgeDeploymentPlanRequest { /** * @public - *

Determines initial traffic distribution among all of the models that you specify in - * the endpoint configuration. The traffic to a production variant is determined by the - * ratio of the VariantWeight to the sum of all VariantWeight - * values across all ProductionVariants. If unspecified, it defaults to 1.0. - *

+ *

The name of the edge deployment plan.

*/ - InitialVariantWeight?: number; + EdgeDeploymentPlanName: string | undefined; /** * @public - *

The size of the Elastic Inference (EI) instance to use for the production variant. EI - * instances provide on-demand GPU computing for inference. For more information, see - * Using Elastic - * Inference in Amazon SageMaker.

+ *

List of models associated with the edge deployment plan.

*/ - AcceleratorType?: ProductionVariantAcceleratorType; + ModelConfigs: EdgeDeploymentModelConfig[] | undefined; /** * @public - *

Specifies configuration for a core dump from the model container when the process - * crashes.

+ *

The device fleet used for this edge deployment plan.

*/ - CoreDumpConfig?: ProductionVariantCoreDumpConfig; + DeviceFleetName: string | undefined; /** * @public - *

The serverless configuration for an endpoint. Specifies a serverless endpoint configuration instead of an instance-based endpoint configuration.

+ *

List of stages of the edge deployment plan. The number of stages is limited to 10 per + * deployment.

*/ - ServerlessConfig?: ProductionVariantServerlessConfig; + Stages?: DeploymentStage[]; /** * @public - *

The size, in GB, of the ML storage volume attached to individual inference instance - * associated with the production variant. Currently only Amazon EBS gp2 storage volumes are - * supported.

+ *

List of tags with which to tag the edge deployment plan.

*/ - VolumeSizeInGB?: number; + Tags?: Tag[]; +} +/** + * @public + */ +export interface CreateEdgeDeploymentPlanResponse { /** * @public - *

The timeout value, in seconds, to download and extract the model that you want to host - * from Amazon S3 to the individual inference instance associated with this production - * variant.

+ *

The ARN of the edge deployment plan.

*/ - ModelDataDownloadTimeoutInSeconds?: number; + EdgeDeploymentPlanArn: string | undefined; +} +/** + * @public + */ +export interface CreateEdgeDeploymentStageRequest { /** * @public - *

The timeout value, in seconds, for your inference container to pass health check by - * SageMaker Hosting. For more information about health check, see How Your Container Should Respond to Health Check (Ping) Requests.

+ *

The name of the edge deployment plan.

*/ - ContainerStartupHealthCheckTimeoutInSeconds?: number; + EdgeDeploymentPlanName: string | undefined; /** * @public - *

You can use this parameter to turn on native Amazon Web Services Systems Manager (SSM) - * access for a production variant behind an endpoint. By default, SSM access is disabled - * for all production variants behind an endpoint. You can turn on or turn off SSM access - * for a production variant behind an existing endpoint by creating a new endpoint - * configuration and calling UpdateEndpoint.

+ *

List of stages to be added to the edge deployment plan.

*/ - EnableSSMAccess?: boolean; + Stages: DeploymentStage[] | undefined; } /** * @public */ -export interface CreateEndpointConfigInput { - /** - * @public - *

The name of the endpoint configuration. You specify this name in a CreateEndpoint request.

- */ - EndpointConfigName: string | undefined; - +export interface CreateEdgePackagingJobRequest { /** * @public - *

An array of ProductionVariant objects, one for each model that you want - * to host at this endpoint.

+ *

The name of the edge packaging job.

*/ - ProductionVariants: ProductionVariant[] | undefined; + EdgePackagingJobName: string | undefined; /** * @public - *

Configuration to control how SageMaker captures inference data.

+ *

The name of the SageMaker Neo compilation job that will be used to locate model artifacts for packaging.

*/ - DataCaptureConfig?: DataCaptureConfig; + CompilationJobName: string | undefined; /** * @public - *

An array of key-value pairs. You can use tags to categorize your Amazon Web Services - * resources in different ways, for example, by purpose, owner, or environment. For more - * information, see Tagging Amazon Web Services Resources.

+ *

The name of the model.

*/ - Tags?: Tag[]; + ModelName: string | undefined; /** * @public - *

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that - * SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that - * hosts the endpoint.

- *

The KmsKeyId can be any of the following formats:

- *
    - *
  • - *

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab - *

    - *
    • - *
  • - *

    Key ARN: - * arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - *

    - *
    • - *
  • - *

    Alias name: alias/ExampleAlias - *

    - *
    • - *
  • - *

    Alias name ARN: - * arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias - *

    - *
    • - *
- *

The KMS key policy must grant permission to the IAM role that you specify in your - * CreateEndpoint, UpdateEndpoint requests. For more - * information, refer to the Amazon Web Services Key Management Service section Using Key - * Policies in Amazon Web Services KMS - *

- * - *

Certain Nitro-based instances include local storage, dependent on the instance - * type. Local storage volumes are encrypted using a hardware module on the instance. - * You can't request a KmsKeyId when using an instance type with local - * storage. If any of the models that you specify in the - * ProductionVariants parameter use nitro-based instances with local - * storage, do not specify a value for the KmsKeyId parameter. If you - * specify a value for KmsKeyId when using any nitro-based instances with - * local storage, the call to CreateEndpointConfig fails.

- *

For a list of instance types that support local instance storage, see Instance Store Volumes.

- *

For more information about local instance storage encryption, see SSD - * Instance Store Volumes.

- * + *

The version of the model.

*/ - KmsKeyId?: string; + ModelVersion: string | undefined; /** * @public - *

Specifies configuration for how an endpoint performs asynchronous inference. This is a - * required field in order for your Endpoint to be invoked using InvokeEndpointAsync.

+ *

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact SageMaker Neo.

*/ - AsyncInferenceConfig?: AsyncInferenceConfig; + RoleArn: string | undefined; /** * @public - *

A member of CreateEndpointConfig that enables explainers.

+ *

Provides information about the output location for the packaged model.

*/ - ExplainerConfig?: ExplainerConfig; + OutputConfig: EdgeOutputConfig | undefined; /** * @public - *

An array of ProductionVariant objects, one for each model that you want - * to host at this endpoint in shadow mode with production traffic replicated from the - * model specified on ProductionVariants. If you use this field, you can only - * specify one variant for ProductionVariants and one variant for - * ShadowProductionVariants.

+ *

The Amazon Web Services KMS key to use when encrypting the EBS volume the edge packaging job runs on.

*/ - ShadowProductionVariants?: ProductionVariant[]; -} + ResourceKey?: string; -/** - * @public - */ -export interface CreateEndpointConfigOutput { /** * @public - *

The Amazon Resource Name (ARN) of the endpoint configuration.

+ *

Creates tags for the packaging job.

*/ - EndpointConfigArn: string | undefined; + Tags?: Tag[]; } /** * @public + *

Specifies a rolling deployment strategy for updating a SageMaker endpoint.

*/ -export interface CreateExperimentRequest { +export interface RollingUpdatePolicy { /** * @public - *

The name of the experiment. The name must be unique in your Amazon Web Services account and is not - * case-sensitive.

+ *

Batch size for each rolling step to provision capacity and turn on traffic on the new + * endpoint fleet, and terminate capacity on the old endpoint fleet. Value must be between + * 5% to 50% of the variant's total instance count.

*/ - ExperimentName: string | undefined; + MaximumBatchSize: CapacitySize | undefined; /** * @public - *

The name of the experiment as displayed. The name doesn't need to be unique. If you don't - * specify DisplayName, the value in ExperimentName is - * displayed.

+ *

The length of the baking period, during which SageMaker monitors alarms for each batch on + * the new fleet.

*/ - DisplayName?: string; + WaitIntervalInSeconds: number | undefined; /** * @public - *

The description of the experiment.

+ *

The time limit for the total deployment. Exceeding this limit causes a timeout.

*/ - Description?: string; + MaximumExecutionTimeoutInSeconds?: number; /** * @public - *

A list of tags to associate with the experiment. You can use Search API - * to search on the tags.

+ *

Batch size for rollback to the old endpoint fleet. Each rolling step to provision + * capacity and turn on traffic on the old endpoint fleet, and terminate capacity on the + * new endpoint fleet. If this field is absent, the default value will be set to 100% of + * total capacity which means to bring up the whole capacity of the old fleet at once + * during rollback.

*/ - Tags?: Tag[]; + RollbackMaximumBatchSize?: CapacitySize; } /** * @public + *

The deployment configuration for an endpoint, which contains the desired deployment + * strategy and rollback configurations.

*/ -export interface CreateExperimentResponse { +export interface DeploymentConfig { /** * @public - *

The Amazon Resource Name (ARN) of the experiment.

+ *

Update policy for a blue/green deployment. If this update policy is specified, SageMaker + * creates a new fleet during the deployment while maintaining the old fleet. SageMaker flips + * traffic to the new fleet according to the specified traffic routing configuration. Only + * one update policy should be used in the deployment configuration. If no update policy is + * specified, SageMaker uses a blue/green deployment strategy with all at once traffic shifting + * by default.

*/ - ExperimentArn?: string; -} + BlueGreenUpdatePolicy?: BlueGreenUpdatePolicy; -/** - * @public - * @enum - */ -export const FeatureType = { - FRACTIONAL: "Fractional", - INTEGRAL: "Integral", - STRING: "String", -} as const; + /** + * @public + *

Automatic rollback configuration for handling endpoint deployment failures and + * recovery.

+ */ + AutoRollbackConfiguration?: AutoRollbackConfig; -/** - * @public - */ -export type FeatureType = (typeof FeatureType)[keyof typeof FeatureType]; + /** + * @public + *

Specifies a rolling deployment strategy for updating a SageMaker endpoint.

+ */ + RollingUpdatePolicy?: RollingUpdatePolicy; +} /** * @public - *

A list of features. You must include FeatureName and - * FeatureType. Valid feature FeatureTypes are - * Integral, Fractional and String.

*/ -export interface FeatureDefinition { +export interface CreateEndpointInput { /** * @public - *

The name of a feature. The type must be a string. FeatureName cannot be any - * of the following: is_deleted, write_time, - * api_invocation_time.

+ *

The name of the endpoint.The name must be unique within an Amazon Web Services + * Region in your Amazon Web Services account. The name is case-insensitive in + * CreateEndpoint, but the case is preserved and must be matched in InvokeEndpoint.

*/ - FeatureName?: string; + EndpointName: string | undefined; /** * @public - *

The value type of a feature. Valid values are Integral, Fractional, or String.

+ *

The name of an endpoint configuration. For more information, see CreateEndpointConfig.

*/ - FeatureType?: FeatureType; + EndpointConfigName: string | undefined; /** * @public - *

A grouping of elements where each element within the collection must have the same - * feature type (String, Integral, or - * Fractional).

- *
    - *
  • - *

    - * List: An ordered collection of elements.

    - *
    • - *
  • - *

    - * Set: An unordered collection of unique elements.

    - *
    • - *
  • - *

    - * Vector: A specialized list that represents a fixed-size array of - * elements. The vector dimension is determined by you. Must have elements with - * fractional feature types.

    - *
    • - *
+ *

The deployment configuration for an endpoint, which contains the desired deployment + * strategy and rollback configurations.

*/ - CollectionType?: CollectionType; + DeploymentConfig?: DeploymentConfig; /** * @public - *

Configuration for your collection.

+ *

An array of key-value pairs. You can use tags to categorize your Amazon Web Services + * resources in different ways, for example, by purpose, owner, or environment. For more + * information, see Tagging Amazon Web Services Resources.

*/ - CollectionConfig?: CollectionConfig; + Tags?: Tag[]; } /** * @public - *

The meta data of the Glue table which serves as data catalog for the - * OfflineStore.

*/ -export interface DataCatalogConfig { +export interface CreateEndpointOutput { /** * @public - *

The name of the Glue table.

+ *

The Amazon Resource Name (ARN) of the endpoint.

*/ - TableName: string | undefined; + EndpointArn: string | undefined; +} +/** + * @public + *

Configuration to control how SageMaker captures inference data.

+ */ +export interface DataCaptureConfig { /** * @public - *

The name of the Glue table catalog.

+ *

Whether data capture should be enabled or disabled (defaults to enabled).

*/ - Catalog: string | undefined; + EnableCapture?: boolean; /** * @public - *

The name of the Glue table database.

+ *

The percentage of requests SageMaker will capture. A lower value is recommended + * for Endpoints with high traffic.

*/ - Database: string | undefined; -} + InitialSamplingPercentage: number | undefined; -/** - * @public - *

The Amazon Simple Storage (Amazon S3) location and and security configuration for - * OfflineStore.

- */ -export interface S3StorageConfig { /** * @public - *

The S3 URI, or location in Amazon S3, of OfflineStore.

- *

S3 URIs have a format similar to the following: - * s3://example-bucket/prefix/.

+ *

The Amazon S3 location used to capture the data.

*/ - S3Uri: string | undefined; + DestinationS3Uri: string | undefined; /** * @public - *

The Amazon Web Services Key Management Service (KMS) key ARN of the key used to encrypt - * any objects written into the OfflineStore S3 location.

- *

The IAM roleARN that is passed as a parameter to - * CreateFeatureGroup must have below permissions to the - * KmsKeyId:

+ *

The Amazon Resource Name (ARN) of an Key Management Service key that SageMaker + * uses to encrypt the captured data at rest using Amazon S3 server-side + * encryption.

+ *

The KmsKeyId can be any of the following formats:

*
    *
  • - *

    - * "kms:GenerateDataKey" + *

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + *

    + *
    • + *
  • + *

    Key ARN: + * arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + *

    + *
    • + *
  • + *

    Alias name: alias/ExampleAlias + *

    + *
    • + *
  • + *

    Alias name ARN: + * arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias *

    *
    • *
@@ -1759,466 +1635,1105 @@ export interface S3StorageConfig { /** * @public - *

The S3 path where offline records are written.

+ *

Specifies data Model Monitor will capture. You can configure whether to collect only + * input, only output, or both

*/ - ResolvedOutputS3Uri?: string; + CaptureOptions: CaptureOption[] | undefined; + + /** + * @public + *

Configuration specifying how to treat different headers. If no headers are specified + * SageMaker will by default base64 encode when capturing the data.

+ */ + CaptureContentTypeHeader?: CaptureContentTypeHeader; +} + +/** + * @public + *

A parameter to activate explainers.

+ */ +export interface ExplainerConfig { + /** + * @public + *

A member of ExplainerConfig that contains configuration parameters for + * the SageMaker Clarify explainer.

+ */ + ClarifyExplainerConfig?: ClarifyExplainerConfig; } /** * @public * @enum */ -export const TableFormat = { - GLUE: "Glue", - ICEBERG: "Iceberg", +export const ProductionVariantAcceleratorType = { + ML_EIA1_LARGE: "ml.eia1.large", + ML_EIA1_MEDIUM: "ml.eia1.medium", + ML_EIA1_XLARGE: "ml.eia1.xlarge", + ML_EIA2_LARGE: "ml.eia2.large", + ML_EIA2_MEDIUM: "ml.eia2.medium", + ML_EIA2_XLARGE: "ml.eia2.xlarge", } as const; /** * @public */ -export type TableFormat = (typeof TableFormat)[keyof typeof TableFormat]; +export type ProductionVariantAcceleratorType = + (typeof ProductionVariantAcceleratorType)[keyof typeof ProductionVariantAcceleratorType]; /** * @public - *

The configuration of an OfflineStore.

- *

Provide an OfflineStoreConfig in a request to - * CreateFeatureGroup to create an OfflineStore.

- *

To encrypt an OfflineStore using at rest data encryption, specify Amazon Web Services Key Management Service (KMS) key ID, or KMSKeyId, in - * S3StorageConfig.

+ *

Specifies configuration for a core dump from the model container when the process + * crashes.

*/ -export interface OfflineStoreConfig { +export interface ProductionVariantCoreDumpConfig { /** * @public - *

The Amazon Simple Storage (Amazon S3) location of OfflineStore.

+ *

The Amazon S3 bucket to send the core dump to.

*/ - S3StorageConfig: S3StorageConfig | undefined; + DestinationS3Uri: string | undefined; /** * @public - *

Set to True to disable the automatic creation of an Amazon Web Services Glue - * table when configuring an OfflineStore. If set to False, Feature - * Store will name the OfflineStore Glue table following Athena's - * naming recommendations.

- *

The default value is False.

+ *

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker + * uses to encrypt the core dump data at rest using Amazon S3 server-side encryption. The + * KmsKeyId can be any of the following formats:

+ *
    + *
  • + *

    // KMS Key ID

    + *

    + * "1234abcd-12ab-34cd-56ef-1234567890ab" + *

    + *
    • + *
  • + *

    // Amazon Resource Name (ARN) of a KMS Key

    + *

    + * "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + *

    + *
    • + *
  • + *

    // KMS Key Alias

    + *

    + * "alias/ExampleAlias" + *

    + *
    • + *
  • + *

    // Amazon Resource Name (ARN) of a KMS Key Alias

    + *

    + * "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias" + *

    + *
    • + *
+ *

If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must + * include permissions to call kms:Encrypt. If you don't provide a KMS key ID, + * SageMaker uses the default KMS key for Amazon S3 for your role's account. SageMaker uses server-side + * encryption with KMS-managed keys for OutputDataConfig. If you use a bucket + * policy with an s3:PutObject permission that only allows objects with + * server-side encryption, set the condition key of + * s3:x-amz-server-side-encryption to "aws:kms". For more + * information, see KMS-Managed Encryption + * Keys in the Amazon Simple Storage Service Developer Guide. + *

+ *

The KMS key policy must grant permission to the IAM role that you specify in your + * CreateEndpoint and UpdateEndpoint requests. For more + * information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management + * Service Developer Guide.

*/ - DisableGlueTableCreation?: boolean; + KmsKeyId?: string; +} + +/** + * @public + * @enum + */ +export const ManagedInstanceScalingStatus = { + DISABLED: "DISABLED", + ENABLED: "ENABLED", +} as const; + +/** + * @public + */ +export type ManagedInstanceScalingStatus = + (typeof ManagedInstanceScalingStatus)[keyof typeof ManagedInstanceScalingStatus]; +/** + * @public + *

Settings that control the range in the number of instances that the endpoint provisions + * as it scales up or down to accommodate traffic.

+ */ +export interface ProductionVariantManagedInstanceScaling { /** * @public - *

The meta data of the Glue table that is autogenerated when an OfflineStore - * is created.

+ *

Indicates whether managed instance scaling is enabled.

*/ - DataCatalogConfig?: DataCatalogConfig; + Status?: ManagedInstanceScalingStatus; /** * @public - *

Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.

+ *

The minimum number of instances that the endpoint must retain when it scales down to + * accommodate a decrease in traffic.

*/ - TableFormat?: TableFormat; + MinInstanceCount?: number; + + /** + * @public + *

The maximum number of instances that the endpoint can provision when it scales up to + * accommodate an increase in traffic.

+ */ + MaxInstanceCount?: number; } /** * @public - *

The security configuration for OnlineStore.

+ * @enum */ -export interface OnlineStoreSecurityConfig { +export const RoutingStrategy = { + LEAST_OUTSTANDING_REQUESTS: "LEAST_OUTSTANDING_REQUESTS", + RANDOM: "RANDOM", +} as const; + +/** + * @public + */ +export type RoutingStrategy = (typeof RoutingStrategy)[keyof typeof RoutingStrategy]; + +/** + * @public + *

Settings that control how the endpoint routes incoming traffic to the instances that the + * endpoint hosts.

+ */ +export interface ProductionVariantRoutingConfig { /** * @public - *

The Amazon Web Services Key Management Service (KMS) key ARN that SageMaker Feature Store - * uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side - * encryption.

- *

The caller (either user or IAM role) of CreateFeatureGroup must have below - * permissions to the OnlineStore - * KmsKeyId:

+ *

Sets how the endpoint routes incoming traffic:

*
    *
  • *

    - * "kms:Encrypt" - *

    - *
    • - *
  • - *

    - * "kms:Decrypt" - *

    + * LEAST_OUTSTANDING_REQUESTS: The endpoint routes requests to the + * specific instances that have more capacity to process them.

    *
    • *
  • *

    - * "kms:DescribeKey" - *

    - *
    • - *
  • - *

    - * "kms:CreateGrant" - *

    - *
    • - *
  • - *

    - * "kms:RetireGrant" - *

    - *
    • - *
  • - *

    - * "kms:ReEncryptFrom" - *

    - *
    • - *
  • - *

    - * "kms:ReEncryptTo" - *

    - *
    • - *
  • - *

    - * "kms:GenerateDataKey" - *

    - *
    • - *
  • - *

    - * "kms:ListAliases" - *

    - *
    • - *
  • - *

    - * "kms:ListGrants" - *

    - *
    • - *
  • - *

    - * "kms:RevokeGrant" - *

    - *
    • - *
- *

The caller (either user or IAM role) to all DataPlane operations - * (PutRecord, GetRecord, DeleteRecord) must have the - * following permissions to the KmsKeyId:

- *
    - *
  • - *

    - * "kms:Decrypt" - *

    + * RANDOM: The endpoint routes each request to a randomly chosen + * instance.

    *
    • *
*/ - KmsKeyId?: string; + RoutingStrategy: RoutingStrategy | undefined; } /** * @public - * @enum - */ -export const StorageType = { - IN_MEMORY: "InMemory", - STANDARD: "Standard", -} as const; - -/** - * @public - */ -export type StorageType = (typeof StorageType)[keyof typeof StorageType]; - -/** - * @public - * @enum - */ -export const TtlDurationUnit = { - DAYS: "Days", - HOURS: "Hours", - MINUTES: "Minutes", - SECONDS: "Seconds", - WEEKS: "Weeks", -} as const; - -/** - * @public + *

Specifies the serverless configuration for an endpoint variant.

*/ -export type TtlDurationUnit = (typeof TtlDurationUnit)[keyof typeof TtlDurationUnit]; +export interface ProductionVariantServerlessConfig { + /** + * @public + *

The memory size of your serverless endpoint. Valid values are in 1 GB increments: 1024 MB, 2048 MB, 3072 MB, 4096 MB, 5120 MB, or 6144 MB.

+ */ + MemorySizeInMB: number | undefined; -/** - * @public - *

Time to live duration, where the record is hard deleted after the expiration time is - * reached; ExpiresAt = EventTime + TtlDuration. For - * information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

- */ -export interface TtlDuration { /** * @public - *

- * TtlDuration time unit.

+ *

The maximum number of concurrent invocations your serverless endpoint can process.

*/ - Unit?: TtlDurationUnit; + MaxConcurrency: number | undefined; /** * @public - *

- * TtlDuration time value.

+ *

The amount of provisioned concurrency to allocate for the serverless endpoint. + * Should be less than or equal to MaxConcurrency.

+ * + *

This field is not supported for serverless endpoint recommendations for Inference Recommender jobs. + * For more information about creating an Inference Recommender job, see + * CreateInferenceRecommendationsJobs.

+ * */ - Value?: number; + ProvisionedConcurrency?: number; } /** * @public - *

Use this to specify the Amazon Web Services Key Management Service (KMS) Key ID, or - * KMSKeyId, for at rest data encryption. You can turn - * OnlineStore on or off by specifying the EnableOnlineStore flag - * at General Assembly.

- *

The default value is False.

+ *

Identifies a model that you want to host and the resources chosen to deploy for + * hosting it. If you are deploying multiple models, tell SageMaker how to distribute traffic + * among the models by specifying variant weights. For more information on production + * variants, check Production variants. + *

*/ -export interface OnlineStoreConfig { +export interface ProductionVariant { /** * @public - *

Use to specify KMS Key ID (KMSKeyId) for at-rest encryption of your - * OnlineStore.

+ *

The name of the production variant.

*/ - SecurityConfig?: OnlineStoreSecurityConfig; + VariantName: string | undefined; /** * @public - *

Turn OnlineStore off by specifying False for the - * EnableOnlineStore flag. Turn OnlineStore on by specifying - * True for the EnableOnlineStore flag.

- *

The default value is False.

+ *

The name of the model that you want to host. This is the name that you specified + * when creating the model.

*/ - EnableOnlineStore?: boolean; + ModelName?: string; /** * @public - *

Time to live duration, where the record is hard deleted after the expiration time is - * reached; ExpiresAt = EventTime + TtlDuration. For - * information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

+ *

Number of instances to launch initially.

*/ - TtlDuration?: TtlDuration; + InitialInstanceCount?: number; /** * @public - *

Option for different tiers of low latency storage for real-time data retrieval.

- *
    - *
  • - *

    - * Standard: A managed low latency data store for feature groups.

    - *
    • - *
  • - *

    - * InMemory: A managed data store for feature groups that supports very - * low latency retrieval.

    - *
    • - *
+ *

The ML compute instance type.

*/ - StorageType?: StorageType; -} + InstanceType?: ProductionVariantInstanceType; -/** - * @public - */ -export interface CreateFeatureGroupRequest { /** * @public - *

The name of the FeatureGroup. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account. The name:

- *
    - *
  • - *

    Must start and end with an alphanumeric character.

    - *
    • - *
  • - *

    Can only contain alphanumeric character and hyphens. Spaces are not allowed. + *

    Determines initial traffic distribution among all of the models that you specify in + * the endpoint configuration. The traffic to a production variant is determined by the + * ratio of the VariantWeight to the sum of all VariantWeight + * values across all ProductionVariants. If unspecified, it defaults to 1.0. *

    - *
    • - *
*/ - FeatureGroupName: string | undefined; + InitialVariantWeight?: number; /** * @public - *

The name of the Feature whose value uniquely identifies a - * Record defined in the FeatureStore. Only the latest record per - * identifier value will be stored in the OnlineStore. - * RecordIdentifierFeatureName must be one of feature definitions' - * names.

- *

You use the RecordIdentifierFeatureName to access data in a - * FeatureStore.

- *

This name:

- *
    - *
  • - *

    Must start and end with an alphanumeric character.

    - *
    • - *
  • - *

    Can only contains alphanumeric characters, hyphens, underscores. Spaces are not - * allowed.

    - *
    • - *
+ *

The size of the Elastic Inference (EI) instance to use for the production variant. EI + * instances provide on-demand GPU computing for inference. For more information, see + * Using Elastic + * Inference in Amazon SageMaker.

*/ - RecordIdentifierFeatureName: string | undefined; + AcceleratorType?: ProductionVariantAcceleratorType; /** * @public - *

The name of the feature that stores the EventTime of a Record - * in a FeatureGroup.

- *

An EventTime is a point in time when a new event occurs that corresponds to - * the creation or update of a Record in a FeatureGroup. All - * Records in the FeatureGroup must have a corresponding - * EventTime.

- *

An EventTime can be a String or Fractional.

- *
    - *
  • - *

    - * Fractional: EventTime feature values must be a Unix - * timestamp in seconds.

    - *
    • - *
  • - *

    - * String: EventTime feature values must be an ISO-8601 - * string in the format. The following formats are supported - * yyyy-MM-dd'T'HH:mm:ssZ and yyyy-MM-dd'T'HH:mm:ss.SSSZ - * where yyyy, MM, and dd represent the year, - * month, and day respectively and HH, mm, ss, - * and if applicable, SSS represent the hour, month, second and - * milliseconds respsectively. 'T' and Z are constants.

    - *
    • - *
+ *

Specifies configuration for a core dump from the model container when the process + * crashes.

*/ - EventTimeFeatureName: string | undefined; + CoreDumpConfig?: ProductionVariantCoreDumpConfig; /** * @public - *

A list of Feature names and types. Name and Type - * is compulsory per Feature.

- *

Valid feature FeatureTypes are Integral, - * Fractional and String.

- *

- * FeatureNames cannot be any of the following: is_deleted, - * write_time, api_invocation_time - *

- *

You can create up to 2,500 FeatureDefinitions per - * FeatureGroup.

+ *

The serverless configuration for an endpoint. Specifies a serverless endpoint configuration instead of an instance-based endpoint configuration.

*/ - FeatureDefinitions: FeatureDefinition[] | undefined; + ServerlessConfig?: ProductionVariantServerlessConfig; /** * @public - *

You can turn the OnlineStore on or off by specifying True for - * the EnableOnlineStore flag in OnlineStoreConfig.

- *

You can also include an Amazon Web Services KMS key ID (KMSKeyId) for - * at-rest encryption of the OnlineStore.

- *

The default value is False.

+ *

The size, in GB, of the ML storage volume attached to individual inference instance + * associated with the production variant. Currently only Amazon EBS gp2 storage volumes are + * supported.

*/ - OnlineStoreConfig?: OnlineStoreConfig; + VolumeSizeInGB?: number; /** * @public - *

Use this to configure an OfflineFeatureStore. This parameter allows you to - * specify:

- *
    - *
  • - *

    The Amazon Simple Storage Service (Amazon S3) location of an - * OfflineStore.

    - *
    • - *
  • - *

    A configuration for an Amazon Web Services Glue or Amazon Web Services Hive data - * catalog.

    + *

    The timeout value, in seconds, to download and extract the model that you want to host + * from Amazon S3 to the individual inference instance associated with this production + * variant.

    + */ + ModelDataDownloadTimeoutInSeconds?: number; + + /** + * @public + *

    The timeout value, in seconds, for your inference container to pass health check by + * SageMaker Hosting. For more information about health check, see How Your Container Should Respond to Health Check (Ping) Requests.

    + */ + ContainerStartupHealthCheckTimeoutInSeconds?: number; + + /** + * @public + *

    You can use this parameter to turn on native Amazon Web Services Systems Manager (SSM) + * access for a production variant behind an endpoint. By default, SSM access is disabled + * for all production variants behind an endpoint. You can turn on or turn off SSM access + * for a production variant behind an existing endpoint by creating a new endpoint + * configuration and calling UpdateEndpoint.

    + */ + EnableSSMAccess?: boolean; + + /** + * @public + *

    Settings that control the range in the number of instances that the endpoint provisions + * as it scales up or down to accommodate traffic.

    + */ + ManagedInstanceScaling?: ProductionVariantManagedInstanceScaling; + + /** + * @public + *

    Settings that control how the endpoint routes incoming traffic to the instances that the + * endpoint hosts.

    + */ + RoutingConfig?: ProductionVariantRoutingConfig; +} + +/** + * @public + */ +export interface CreateEndpointConfigInput { + /** + * @public + *

    The name of the endpoint configuration. You specify this name in a CreateEndpoint request.

    + */ + EndpointConfigName: string | undefined; + + /** + * @public + *

    An array of ProductionVariant objects, one for each model that you want + * to host at this endpoint.

    + */ + ProductionVariants: ProductionVariant[] | undefined; + + /** + * @public + *

    Configuration to control how SageMaker captures inference data.

    + */ + DataCaptureConfig?: DataCaptureConfig; + + /** + * @public + *

    An array of key-value pairs. You can use tags to categorize your Amazon Web Services + * resources in different ways, for example, by purpose, owner, or environment. For more + * information, see Tagging Amazon Web Services Resources.

    + */ + Tags?: Tag[]; + + /** + * @public + *

    The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that + * SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that + * hosts the endpoint.

    + *

    The KmsKeyId can be any of the following formats:

    + *
      + *
    • + *

      Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + *

      *
      • *
    • - *

      An KMS encryption key to encrypt the Amazon S3 location used for - * OfflineStore. If KMS encryption key is not specified, by default we - * encrypt all data at rest using Amazon Web Services KMS key. By defining your bucket-level - * key for SSE, you can reduce Amazon Web Services KMS requests costs by up to - * 99 percent.

      + *

      Key ARN: + * arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + *

      *
      • *
    • - *

      Format for the offline store table. Supported formats are Glue (Default) and - * Apache Iceberg.

      + *

      Alias name: alias/ExampleAlias + *

      + *
      • + *
    • + *

      Alias name ARN: + * arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias + *

      *
      • *
    - *

    To learn more about this parameter, see OfflineStoreConfig.

    + *

    The KMS key policy must grant permission to the IAM role that you specify in your + * CreateEndpoint, UpdateEndpoint requests. For more + * information, refer to the Amazon Web Services Key Management Service section Using Key + * Policies in Amazon Web Services KMS + *

    + * + *

    Certain Nitro-based instances include local storage, dependent on the instance + * type. Local storage volumes are encrypted using a hardware module on the instance. + * You can't request a KmsKeyId when using an instance type with local + * storage. If any of the models that you specify in the + * ProductionVariants parameter use nitro-based instances with local + * storage, do not specify a value for the KmsKeyId parameter. If you + * specify a value for KmsKeyId when using any nitro-based instances with + * local storage, the call to CreateEndpointConfig fails.

    + *

    For a list of instance types that support local instance storage, see Instance Store Volumes.

    + *

    For more information about local instance storage encryption, see SSD + * Instance Store Volumes.

    + *     */ - OfflineStoreConfig?: OfflineStoreConfig; + KmsKeyId?: string; /** * @public - *

    The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the - * OfflineStore if an OfflineStoreConfig is provided.

    + *

    Specifies configuration for how an endpoint performs asynchronous inference. This is a + * required field in order for your Endpoint to be invoked using InvokeEndpointAsync.

    */ - RoleArn?: string; + AsyncInferenceConfig?: AsyncInferenceConfig; /** * @public - *

    A free-form description of a FeatureGroup.

    + *

    A member of CreateEndpointConfig that enables explainers.

    */ - Description?: string; + ExplainerConfig?: ExplainerConfig; /** * @public - *

    Tags used to identify Features in each FeatureGroup.

    + *

    An array of ProductionVariant objects, one for each model that you want + * to host at this endpoint in shadow mode with production traffic replicated from the + * model specified on ProductionVariants. If you use this field, you can only + * specify one variant for ProductionVariants and one variant for + * ShadowProductionVariants.

    */ - Tags?: Tag[]; + ShadowProductionVariants?: ProductionVariant[]; + + /** + * @public + *

    The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform actions on your behalf. For more information, see SageMaker + * Roles.

    + * + *

    To be able to pass this role to Amazon SageMaker, the caller of this action must + * have the iam:PassRole permission.

    + *     + */ + ExecutionRoleArn?: string; + + /** + * @public + *

    Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources + * have access to. You can control access to and from your resources by configuring a VPC. + * For more information, see Give SageMaker Access to Resources in your Amazon VPC.

    + */ + VpcConfig?: VpcConfig; + + /** + * @public + *

    Sets whether all model containers deployed to the endpoint are isolated. If they are, no + * inbound or outbound network calls can be made to or from the model containers.

    + */ + EnableNetworkIsolation?: boolean; } /** * @public */ -export interface CreateFeatureGroupResponse { +export interface CreateEndpointConfigOutput { /** * @public - *

    The Amazon Resource Name (ARN) of the FeatureGroup. This is a unique - * identifier for the feature group.

    + *

    The Amazon Resource Name (ARN) of the endpoint configuration.

    */ - FeatureGroupArn: string | undefined; + EndpointConfigArn: string | undefined; } /** * @public - *

    Defines under what conditions SageMaker creates a human loop. Used within CreateFlowDefinition. See HumanLoopActivationConditionsConfig for the required - * format of activation conditions.

    */ -export interface HumanLoopActivationConditionsConfig { +export interface CreateExperimentRequest { /** * @public - *

    JSON expressing use-case specific conditions declaratively. If any condition is matched, atomic tasks are created against the configured work team. - * The set of conditions is different for Rekognition and Textract. For more information about how to structure the JSON, see - * JSON Schema for Human Loop Activation Conditions in Amazon Augmented AI - * in the Amazon SageMaker Developer Guide.

    + *

    The name of the experiment. The name must be unique in your Amazon Web Services account and is not + * case-sensitive.

    */ - HumanLoopActivationConditions: __LazyJsonString | string | undefined; + ExperimentName: string | undefined; + + /** + * @public + *

    The name of the experiment as displayed. The name doesn't need to be unique. If you don't + * specify DisplayName, the value in ExperimentName is + * displayed.

    + */ + DisplayName?: string; + + /** + * @public + *

    The description of the experiment.

    + */ + Description?: string; + + /** + * @public + *

    A list of tags to associate with the experiment. You can use Search API + * to search on the tags.

    + */ + Tags?: Tag[]; } /** * @public - *

    Provides information about how and under what conditions SageMaker creates a human loop. If HumanLoopActivationConfig is not given, then all requests go to humans.

    */ -export interface HumanLoopActivationConfig { +export interface CreateExperimentResponse { /** * @public - *

    Container structure for defining under what conditions SageMaker creates a human - * loop.

    + *

    The Amazon Resource Name (ARN) of the experiment.

    */ - HumanLoopActivationConditionsConfig: HumanLoopActivationConditionsConfig | undefined; + ExperimentArn?: string; } /** * @public - *

    Represents an amount of money in United States dollars.

    + * @enum */ -export interface USD { +export const FeatureType = { + FRACTIONAL: "Fractional", + INTEGRAL: "Integral", + STRING: "String", +} as const; + +/** + * @public + */ +export type FeatureType = (typeof FeatureType)[keyof typeof FeatureType]; + +/** + * @public + *

    A list of features. You must include FeatureName and + * FeatureType. Valid feature FeatureTypes are + * Integral, Fractional and String.

    + */ +export interface FeatureDefinition { /** * @public - *

    The whole number of dollars in the amount.

    + *

    The name of a feature. The type must be a string. FeatureName cannot be any + * of the following: is_deleted, write_time, + * api_invocation_time.

    */ - Dollars?: number; + FeatureName?: string; /** * @public - *

    The fractional portion, in cents, of the amount.

    + *

    The value type of a feature. Valid values are Integral, Fractional, or String.

    */ - Cents?: number; + FeatureType?: FeatureType; /** * @public - *

    Fractions of a cent, in tenths.

    + *

    A grouping of elements where each element within the collection must have the same + * feature type (String, Integral, or + * Fractional).

    + *
      + *
    • + *

      + * List: An ordered collection of elements.

      + *
      • + *
    • + *

      + * Set: An unordered collection of unique elements.

      + *
      • + *
    • + *

      + * Vector: A specialized list that represents a fixed-size array of + * elements. The vector dimension is determined by you. Must have elements with + * fractional feature types.

      + *
      • + *
    */ - TenthFractionsOfACent?: number; + CollectionType?: CollectionType; + + /** + * @public + *

    Configuration for your collection.

    + */ + CollectionConfig?: CollectionConfig; } /** * @public - *

    Defines the amount of money paid to an Amazon Mechanical Turk worker for each task performed.

    - *

    Use one of the following prices for bounding box tasks. Prices are in US dollars and - * should be based on the complexity of the task; the longer it takes in your initial + *

    The meta data of the Glue table which serves as data catalog for the + * OfflineStore.

    + */ +export interface DataCatalogConfig { + /** + * @public + *

    The name of the Glue table.

    + */ + TableName: string | undefined; + + /** + * @public + *

    The name of the Glue table catalog.

    + */ + Catalog: string | undefined; + + /** + * @public + *

    The name of the Glue table database.

    + */ + Database: string | undefined; +} + +/** + * @public + *

    The Amazon Simple Storage (Amazon S3) location and and security configuration for + * OfflineStore.

    + */ +export interface S3StorageConfig { + /** + * @public + *

    The S3 URI, or location in Amazon S3, of OfflineStore.

    + *

    S3 URIs have a format similar to the following: + * s3://example-bucket/prefix/.

    + */ + S3Uri: string | undefined; + + /** + * @public + *

    The Amazon Web Services Key Management Service (KMS) key ARN of the key used to encrypt + * any objects written into the OfflineStore S3 location.

    + *

    The IAM roleARN that is passed as a parameter to + * CreateFeatureGroup must have below permissions to the + * KmsKeyId:

    + *
      + *
    • + *

      + * "kms:GenerateDataKey" + *

      + *
      • + *
    + */ + KmsKeyId?: string; + + /** + * @public + *

    The S3 path where offline records are written.

    + */ + ResolvedOutputS3Uri?: string; +} + +/** + * @public + * @enum + */ +export const TableFormat = { + GLUE: "Glue", + ICEBERG: "Iceberg", +} as const; + +/** + * @public + */ +export type TableFormat = (typeof TableFormat)[keyof typeof TableFormat]; + +/** + * @public + *

    The configuration of an OfflineStore.

    + *

    Provide an OfflineStoreConfig in a request to + * CreateFeatureGroup to create an OfflineStore.

    + *

    To encrypt an OfflineStore using at rest data encryption, specify Amazon Web Services Key Management Service (KMS) key ID, or KMSKeyId, in + * S3StorageConfig.

    + */ +export interface OfflineStoreConfig { + /** + * @public + *

    The Amazon Simple Storage (Amazon S3) location of OfflineStore.

    + */ + S3StorageConfig: S3StorageConfig | undefined; + + /** + * @public + *

    Set to True to disable the automatic creation of an Amazon Web Services Glue + * table when configuring an OfflineStore. If set to False, Feature + * Store will name the OfflineStore Glue table following Athena's + * naming recommendations.

    + *

    The default value is False.

    + */ + DisableGlueTableCreation?: boolean; + + /** + * @public + *

    The meta data of the Glue table that is autogenerated when an OfflineStore + * is created.

    + */ + DataCatalogConfig?: DataCatalogConfig; + + /** + * @public + *

    Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.

    + */ + TableFormat?: TableFormat; +} + +/** + * @public + *

    The security configuration for OnlineStore.

    + */ +export interface OnlineStoreSecurityConfig { + /** + * @public + *

    The Amazon Web Services Key Management Service (KMS) key ARN that SageMaker Feature Store + * uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side + * encryption.

    + *

    The caller (either user or IAM role) of CreateFeatureGroup must have below + * permissions to the OnlineStore + * KmsKeyId:

    + *
      + *
    • + *

      + * "kms:Encrypt" + *

      + *
      • + *
    • + *

      + * "kms:Decrypt" + *

      + *
      • + *
    • + *

      + * "kms:DescribeKey" + *

      + *
      • + *
    • + *

      + * "kms:CreateGrant" + *

      + *
      • + *
    • + *

      + * "kms:RetireGrant" + *

      + *
      • + *
    • + *

      + * "kms:ReEncryptFrom" + *

      + *
      • + *
    • + *

      + * "kms:ReEncryptTo" + *

      + *
      • + *
    • + *

      + * "kms:GenerateDataKey" + *

      + *
      • + *
    • + *

      + * "kms:ListAliases" + *

      + *
      • + *
    • + *

      + * "kms:ListGrants" + *

      + *
      • + *
    • + *

      + * "kms:RevokeGrant" + *

      + *
      • + *
    + *

    The caller (either user or IAM role) to all DataPlane operations + * (PutRecord, GetRecord, DeleteRecord) must have the + * following permissions to the KmsKeyId:

    + *
      + *
    • + *

      + * "kms:Decrypt" + *

      + *
      • + *
    + */ + KmsKeyId?: string; +} + +/** + * @public + * @enum + */ +export const StorageType = { + IN_MEMORY: "InMemory", + STANDARD: "Standard", +} as const; + +/** + * @public + */ +export type StorageType = (typeof StorageType)[keyof typeof StorageType]; + +/** + * @public + * @enum + */ +export const TtlDurationUnit = { + DAYS: "Days", + HOURS: "Hours", + MINUTES: "Minutes", + SECONDS: "Seconds", + WEEKS: "Weeks", +} as const; + +/** + * @public + */ +export type TtlDurationUnit = (typeof TtlDurationUnit)[keyof typeof TtlDurationUnit]; + +/** + * @public + *

    Time to live duration, where the record is hard deleted after the expiration time is + * reached; ExpiresAt = EventTime + TtlDuration. For + * information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

    + */ +export interface TtlDuration { + /** + * @public + *

    + * TtlDuration time unit.

    + */ + Unit?: TtlDurationUnit; + + /** + * @public + *

    + * TtlDuration time value.

    + */ + Value?: number; +} + +/** + * @public + *

    Use this to specify the Amazon Web Services Key Management Service (KMS) Key ID, or + * KMSKeyId, for at rest data encryption. You can turn + * OnlineStore on or off by specifying the EnableOnlineStore flag + * at General Assembly.

    + *

    The default value is False.

    + */ +export interface OnlineStoreConfig { + /** + * @public + *

    Use to specify KMS Key ID (KMSKeyId) for at-rest encryption of your + * OnlineStore.

    + */ + SecurityConfig?: OnlineStoreSecurityConfig; + + /** + * @public + *

    Turn OnlineStore off by specifying False for the + * EnableOnlineStore flag. Turn OnlineStore on by specifying + * True for the EnableOnlineStore flag.

    + *

    The default value is False.

    + */ + EnableOnlineStore?: boolean; + + /** + * @public + *

    Time to live duration, where the record is hard deleted after the expiration time is + * reached; ExpiresAt = EventTime + TtlDuration. For + * information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

    + */ + TtlDuration?: TtlDuration; + + /** + * @public + *

    Option for different tiers of low latency storage for real-time data retrieval.

    + *
      + *
    • + *

      + * Standard: A managed low latency data store for feature groups.

      + *
      • + *
    • + *

      + * InMemory: A managed data store for feature groups that supports very + * low latency retrieval.

      + *
      • + *
    + */ + StorageType?: StorageType; +} + +/** + * @public + */ +export interface CreateFeatureGroupRequest { + /** + * @public + *

    The name of the FeatureGroup. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account. The name:

    + *
      + *
    • + *

      Must start and end with an alphanumeric character.

      + *
      • + *
    • + *

      Can only contain alphanumeric character and hyphens. Spaces are not allowed. + *

      + *
      • + *
    + */ + FeatureGroupName: string | undefined; + + /** + * @public + *

    The name of the Feature whose value uniquely identifies a + * Record defined in the FeatureStore. Only the latest record per + * identifier value will be stored in the OnlineStore. + * RecordIdentifierFeatureName must be one of feature definitions' + * names.

    + *

    You use the RecordIdentifierFeatureName to access data in a + * FeatureStore.

    + *

    This name:

    + *
      + *
    • + *

      Must start and end with an alphanumeric character.

      + *
      • + *
    • + *

      Can only contains alphanumeric characters, hyphens, underscores. Spaces are not + * allowed.

      + *
      • + *
    + */ + RecordIdentifierFeatureName: string | undefined; + + /** + * @public + *

    The name of the feature that stores the EventTime of a Record + * in a FeatureGroup.

    + *

    An EventTime is a point in time when a new event occurs that corresponds to + * the creation or update of a Record in a FeatureGroup. All + * Records in the FeatureGroup must have a corresponding + * EventTime.

    + *

    An EventTime can be a String or Fractional.

    + *
      + *
    • + *

      + * Fractional: EventTime feature values must be a Unix + * timestamp in seconds.

      + *
      • + *
    • + *

      + * String: EventTime feature values must be an ISO-8601 + * string in the format. The following formats are supported + * yyyy-MM-dd'T'HH:mm:ssZ and yyyy-MM-dd'T'HH:mm:ss.SSSZ + * where yyyy, MM, and dd represent the year, + * month, and day respectively and HH, mm, ss, + * and if applicable, SSS represent the hour, month, second and + * milliseconds respsectively. 'T' and Z are constants.

      + *
      • + *
    + */ + EventTimeFeatureName: string | undefined; + + /** + * @public + *

    A list of Feature names and types. Name and Type + * is compulsory per Feature.

    + *

    Valid feature FeatureTypes are Integral, + * Fractional and String.

    + *

    + * FeatureNames cannot be any of the following: is_deleted, + * write_time, api_invocation_time + *

    + *

    You can create up to 2,500 FeatureDefinitions per + * FeatureGroup.

    + */ + FeatureDefinitions: FeatureDefinition[] | undefined; + + /** + * @public + *

    You can turn the OnlineStore on or off by specifying True for + * the EnableOnlineStore flag in OnlineStoreConfig.

    + *

    You can also include an Amazon Web Services KMS key ID (KMSKeyId) for + * at-rest encryption of the OnlineStore.

    + *

    The default value is False.

    + */ + OnlineStoreConfig?: OnlineStoreConfig; + + /** + * @public + *

    Use this to configure an OfflineFeatureStore. This parameter allows you to + * specify:

    + *
      + *
    • + *

      The Amazon Simple Storage Service (Amazon S3) location of an + * OfflineStore.

      + *
      • + *
    • + *

      A configuration for an Amazon Web Services Glue or Amazon Web Services Hive data + * catalog.

      + *
      • + *
    • + *

      An KMS encryption key to encrypt the Amazon S3 location used for + * OfflineStore. If KMS encryption key is not specified, by default we + * encrypt all data at rest using Amazon Web Services KMS key. By defining your bucket-level + * key for SSE, you can reduce Amazon Web Services KMS requests costs by up to + * 99 percent.

      + *
      • + *
    • + *

      Format for the offline store table. Supported formats are Glue (Default) and + * Apache Iceberg.

      + *
      • + *
    + *

    To learn more about this parameter, see OfflineStoreConfig.

    + */ + OfflineStoreConfig?: OfflineStoreConfig; + + /** + * @public + *

    The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the + * OfflineStore if an OfflineStoreConfig is provided.

    + */ + RoleArn?: string; + + /** + * @public + *

    A free-form description of a FeatureGroup.

    + */ + Description?: string; + + /** + * @public + *

    Tags used to identify Features in each FeatureGroup.

    + */ + Tags?: Tag[]; +} + +/** + * @public + */ +export interface CreateFeatureGroupResponse { + /** + * @public + *

    The Amazon Resource Name (ARN) of the FeatureGroup. This is a unique + * identifier for the feature group.

    + */ + FeatureGroupArn: string | undefined; +} + +/** + * @public + *

    Defines under what conditions SageMaker creates a human loop. Used within CreateFlowDefinition. See HumanLoopActivationConditionsConfig for the required + * format of activation conditions.

    + */ +export interface HumanLoopActivationConditionsConfig { + /** + * @public + *

    JSON expressing use-case specific conditions declaratively. If any condition is matched, atomic tasks are created against the configured work team. + * The set of conditions is different for Rekognition and Textract. For more information about how to structure the JSON, see + * JSON Schema for Human Loop Activation Conditions in Amazon Augmented AI + * in the Amazon SageMaker Developer Guide.

    + */ + HumanLoopActivationConditions: __LazyJsonString | string | undefined; +} + +/** + * @public + *

    Provides information about how and under what conditions SageMaker creates a human loop. If HumanLoopActivationConfig is not given, then all requests go to humans.

    + */ +export interface HumanLoopActivationConfig { + /** + * @public + *

    Container structure for defining under what conditions SageMaker creates a human + * loop.

    + */ + HumanLoopActivationConditionsConfig: HumanLoopActivationConditionsConfig | undefined; +} + +/** + * @public + *

    Represents an amount of money in United States dollars.

    + */ +export interface USD { + /** + * @public + *

    The whole number of dollars in the amount.

    + */ + Dollars?: number; + + /** + * @public + *

    The fractional portion, in cents, of the amount.

    + */ + Cents?: number; + + /** + * @public + *

    Fractions of a cent, in tenths.

    + */ + TenthFractionsOfACent?: number; +} + +/** + * @public + *

    Defines the amount of money paid to an Amazon Mechanical Turk worker for each task performed.

    + *

    Use one of the following prices for bounding box tasks. Prices are in US dollars and + * should be based on the complexity of the task; the longer it takes in your initial * testing, the more you should offer.

    *
      *
    • @@ -4316,6 +4831,194 @@ export interface CreateImageVersionResponse { ImageVersionArn?: string; } +/** + * @public + *

      Runtime settings for a model that is deployed with an inference component.

      + */ +export interface InferenceComponentRuntimeConfig { + /** + * @public + *

      The number of runtime copies of the model container to deploy with the inference + * component. Each copy can serve inference requests.

      + */ + CopyCount: number | undefined; +} + +/** + * @public + *

      Defines the compute resources to allocate to run a model that you assign to an inference + * component. These resources include CPU cores, accelerators, and memory.

      + */ +export interface InferenceComponentComputeResourceRequirements { + /** + * @public + *

      The number of CPU cores to allocate to run a model that you assign to an inference + * component.

      + */ + NumberOfCpuCoresRequired?: number; + + /** + * @public + *

      The number of accelerators to allocate to run a model that you assign to an inference + * component. Accelerators include GPUs and Amazon Web Services Inferentia.

      + */ + NumberOfAcceleratorDevicesRequired?: number; + + /** + * @public + *

      The minimum MB of memory to allocate to run a model that you assign to an inference + * component.

      + */ + MinMemoryRequiredInMb: number | undefined; + + /** + * @public + *

      The maximum MB of memory to allocate to run a model that you assign to an inference + * component.

      + */ + MaxMemoryRequiredInMb?: number; +} + +/** + * @public + *

      Defines a container that provides the runtime environment for a model that you deploy + * with an inference component.

      + */ +export interface InferenceComponentContainerSpecification { + /** + * @public + *

      The Amazon Elastic Container Registry (Amazon ECR) path where the Docker image for the model is stored.

      + */ + Image?: string; + + /** + * @public + *

      The Amazon S3 path where the model artifacts, which result from model training, + * are stored. This path must point to a single gzip compressed tar archive (.tar.gz + * suffix).

      + */ + ArtifactUrl?: string; + + /** + * @public + *

      The environment variables to set in the Docker container. Each key and value in the + * Environment string-to-string map can have length of up to 1024. We support up to 16 entries + * in the map.

      + */ + Environment?: Record; +} + +/** + * @public + *

      Settings that take effect while the model container starts up.

      + */ +export interface InferenceComponentStartupParameters { + /** + * @public + *

      The timeout value, in seconds, to download and extract the model that you want to host + * from Amazon S3 to the individual inference instance associated with this inference + * component.

      + */ + ModelDataDownloadTimeoutInSeconds?: number; + + /** + * @public + *

      The timeout value, in seconds, for your inference container to pass health check by + * Amazon S3 Hosting. For more information about health check, see How Your Container Should Respond to Health Check (Ping) Requests.

      + */ + ContainerStartupHealthCheckTimeoutInSeconds?: number; +} + +/** + * @public + *

      Details about the resources to deploy with this inference component, including the + * model, container, and compute resources.

      + */ +export interface InferenceComponentSpecification { + /** + * @public + *

      The name of an existing SageMaker model object in your account that you want to + * deploy with the inference component.

      + */ + ModelName?: string; + + /** + * @public + *

      Defines a container that provides the runtime environment for a model that you deploy + * with an inference component.

      + */ + Container?: InferenceComponentContainerSpecification; + + /** + * @public + *

      Settings that take effect while the model container starts up.

      + */ + StartupParameters?: InferenceComponentStartupParameters; + + /** + * @public + *

      The compute resources allocated to run the model assigned + * to the inference component.

      + */ + ComputeResourceRequirements: InferenceComponentComputeResourceRequirements | undefined; +} + +/** + * @public + */ +export interface CreateInferenceComponentInput { + /** + * @public + *

      A unique name to assign to the inference component.

      + */ + InferenceComponentName: string | undefined; + + /** + * @public + *

      The name of an existing endpoint where you host the inference component.

      + */ + EndpointName: string | undefined; + + /** + * @public + *

      The name of an existing production variant where you host the inference + * component.

      + */ + VariantName: string | undefined; + + /** + * @public + *

      Details about the resources to deploy with this inference component, including the + * model, container, and compute resources.

      + */ + Specification: InferenceComponentSpecification | undefined; + + /** + * @public + *

      Runtime settings for a model that is deployed with an inference component.

      + */ + RuntimeConfig: InferenceComponentRuntimeConfig | undefined; + + /** + * @public + *

      A list of key-value pairs associated with the model. For more information, see Tagging Amazon Web Services + * resources in the Amazon Web Services General + * Reference.

      + */ + Tags?: Tag[]; +} + +/** + * @public + */ +export interface CreateInferenceComponentOutput { + /** + * @public + *

      The Amazon Resource Name (ARN) of the inference component.

      + */ + InferenceComponentArn: string | undefined; +} + /** * @public *

      The Amazon S3 location and configuration for storing inference request and response data.

      @@ -6802,1806 +7505,1281 @@ export interface HumanTaskConfig { *
      • *
    • *

      - * arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectDetection - *

      - *
      • - *
    • - *

      - * arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectDetection - *

      - *
      • - *
    • - *

      - * arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectDetection - *

      - *
      • - *
    • - *

      - * arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectDetection - *

      - *
      • - *
    • - *

      - * arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectDetection - *

      - *
      • - *
    - *

    - * 3D point cloud object tracking adjustment - Adjust 3D - * cuboids across a sequence of point cloud frames.

    - *
      - *
    • - *

      - * arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectTracking - *

      - *
      • - *
    • - *

      - * arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectTracking - *

      - *
      • - *
    • - *

      - * arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectTracking - *

      - *
      • - *
    • - *

      - * arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectTracking - *

      - *
      • - *
    • - *

      - * arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectTracking - *

      - *
      • - *
    • - *

      - * arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectTracking - *

      - *
      • - *
    • - *

      - * arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectTracking - *

      - *
      • - *
    • - *

      - * arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectTracking - *

      - *
      • - *
    • - *

      - * arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectTracking - *

      - *
      • - *
    • - *

      - * arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectTracking - *

      - *
      • - *
    • - *

      - * arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectTracking - *

      - *
      • - *
    • - *

      - * arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectTracking - *

      - *
      • - *
    - *

    - * 3D point cloud semantic segmentation adjustment - - * Adjust semantic segmentation masks in a 3D point cloud.

    - *
      - *
    • - *

      - * arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudSemanticSegmentation - *

      - *
      • - *
    • - *

      - * arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudSemanticSegmentation - *

      - *
      • - *
    • - *

      - * arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudSemanticSegmentation - *

      - *
      • - *
    • - *

      - * arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudSemanticSegmentation - *

      - *
      • - *
    • - *

      - * arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudSemanticSegmentation - *

      - *
      • - *
    • - *

      - * arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudSemanticSegmentation - *

      - *
      • - *
    • - *

      - * arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudSemanticSegmentation - *

      - *
      • - *
    • - *

      - * arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudSemanticSegmentation + * arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectDetection *

      *
      • *
    • *

      - * arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudSemanticSegmentation + * arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectDetection *

      *
      • *
    • *

      - * arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudSemanticSegmentation + * arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectDetection *

      *
      • *
    • *

      - * arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudSemanticSegmentation + * arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectDetection *

      *
      • *
    • *

      - * arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudSemanticSegmentation + * arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectDetection *

      *
      • *
    - */ - PreHumanTaskLambdaArn: string | undefined; - - /** - * @public - *

    Keywords used to describe the task so that workers on Amazon Mechanical Turk can - * discover the task.

    - */ - TaskKeywords?: string[]; - - /** - * @public - *

    A title for the task for your human workers.

    - */ - TaskTitle: string | undefined; - - /** - * @public - *

    A description of the task for your human workers.

    - */ - TaskDescription: string | undefined; - - /** - * @public - *

    The number of human workers that will label an object.

    - */ - NumberOfHumanWorkersPerDataObject: number | undefined; - - /** - * @public - *

    The amount of time that a worker has to complete a task.

    - *

    If you create a custom labeling job, the maximum value for this parameter is 8 hours - * (28,800 seconds).

    - *

    If you create a labeling job using a built-in task type the maximum - * for this parameter depends on the task type you use:

    + *

    + * 3D point cloud object tracking adjustment - Adjust 3D + * cuboids across a sequence of point cloud frames.

    *
      *
    • - *

      For image and - * text labeling jobs, - * the maximum is 8 hours (28,800 seconds).

      - *
      • - *
    • - *

      For 3D point cloud and video frame labeling jobs, the maximum is 30 days (2952,000 seconds) for non-AL mode. For most users, the maximum is also 30 days.

      + *

      + * arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectTracking + *

      *
      • - *
    - */ - TaskTimeLimitInSeconds: number | undefined; - - /** - * @public - *

    The length of time that a task remains available for labeling by human workers. The - * default and maximum values for this parameter depend on the type of workforce you - * use.

    - *
      *
    • - *

      If you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours (43,200 seconds). - * The default is 6 hours (21,600 seconds).

      + *

      + * arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectTracking + *

      *
      • *
    • - *

      If you choose a private or vendor workforce, the default value is 30 days (2592,000 seconds) for non-AL mode. For most users, the maximum is also 30 days.

      + *

      + * arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectTracking + *

      *
      • - *
    - */ - TaskAvailabilityLifetimeInSeconds?: number; - - /** - * @public - *

    Defines the maximum number of data objects that can be labeled by human workers at the - * same time. Also referred to as batch size. Each object may have more than one worker at one time. - * The default value is 1000 objects. To increase the maximum value to 5000 objects, contact Amazon Web Services Support.

    - */ - MaxConcurrentTaskCount?: number; - - /** - * @public - *

    Configures how labels are consolidated across human workers.

    - */ - AnnotationConsolidationConfig: AnnotationConsolidationConfig | undefined; - - /** - * @public - *

    The price that you pay for each task performed by an Amazon Mechanical Turk worker.

    - */ - PublicWorkforceTaskPrice?: PublicWorkforceTaskPrice; -} - -/** - * @public - *

    Attributes of the data specified by the customer. Use these to describe the data to be - * labeled.

    - */ -export interface LabelingJobDataAttributes { - /** - * @public - *

    Declares that your content is free of personally identifiable information or adult - * content. SageMaker may restrict the Amazon Mechanical Turk workers that can view your task - * based on this information.

    - */ - ContentClassifiers?: ContentClassifier[]; -} - -/** - * @public - *

    The Amazon S3 location of the input data objects.

    - */ -export interface LabelingJobS3DataSource { - /** - * @public - *

    The Amazon S3 location of the manifest file that describes the input data objects.

    - *

    The input manifest file referenced in ManifestS3Uri must contain one of - * the following keys: source-ref or source. The value of the - * keys are interpreted as follows:

    - *
      *
    • *

      - * source-ref: The source of the object is the Amazon S3 object - * specified in the value. Use this value when the object is a binary object, such - * as an image.

      + * arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectTracking + *

      *
      • *
    • *

      - * source: The source of the object is the value. Use this - * value when the object is a text value.

      + * arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectTracking + *

      *
      • - *
    - *

    If you are a new user of Ground Truth, it is recommended you review Use an Input Manifest File in the Amazon SageMaker Developer Guide to learn how to - * create an input manifest file.

    - */ - ManifestS3Uri: string | undefined; -} - -/** - * @public - *

    An Amazon SNS data source used for streaming labeling jobs.

    - */ -export interface LabelingJobSnsDataSource { - /** - * @public - *

    The Amazon SNS input topic Amazon Resource Name (ARN). Specify the ARN of the input topic - * you will use to send new data objects to a streaming labeling job.

    - */ - SnsTopicArn: string | undefined; -} - -/** - * @public - *

    Provides information about the location of input data.

    - *

    You must specify at least one of the following: S3DataSource or SnsDataSource.

    - *

    Use SnsDataSource to specify an SNS input topic - * for a streaming labeling job. If you do not specify - * and SNS input topic ARN, Ground Truth will create a one-time labeling job.

    - *

    Use S3DataSource to specify an input - * manifest file for both streaming and one-time labeling jobs. - * Adding an S3DataSource is optional if you use SnsDataSource to create a streaming labeling job.

    - */ -export interface LabelingJobDataSource { - /** - * @public - *

    The Amazon S3 location of the input data objects.

    - */ - S3DataSource?: LabelingJobS3DataSource; - - /** - * @public - *

    An Amazon SNS data source used for streaming labeling jobs. To learn more, see Send Data to a Streaming Labeling Job.

    - */ - SnsDataSource?: LabelingJobSnsDataSource; -} - -/** - * @public - *

    Input configuration information for a labeling job.

    - */ -export interface LabelingJobInputConfig { - /** - * @public - *

    The location of the input data.

    - */ - DataSource: LabelingJobDataSource | undefined; - - /** - * @public - *

    Attributes of the data specified by the customer.

    - */ - DataAttributes?: LabelingJobDataAttributes; -} - -/** - * @public - *

    Configure encryption on the storage volume attached to the ML compute instance used to - * run automated data labeling model training and inference.

    - */ -export interface LabelingJobResourceConfig { - /** - * @public - *

    The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume - * attached to the ML compute instance(s) that run the training and inference jobs used for - * automated data labeling.

    - *

    You can only specify a VolumeKmsKeyId when you create a labeling job with - * automated data labeling enabled using the API operation CreateLabelingJob. - * You cannot specify an Amazon Web Services KMS key to encrypt the storage volume used for - * automated data labeling model training and inference when you create a labeling job - * using the console. To learn more, see Output Data and Storage Volume - * Encryption.

    - *

    The VolumeKmsKeyId can be any of the following formats:

    - *
      *
    • - *

      KMS Key ID

      *

      - * "1234abcd-12ab-34cd-56ef-1234567890ab" + * arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectTracking *

      *
      • *
    • - *

      Amazon Resource Name (ARN) of a KMS Key

      *

      - * "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + * arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectTracking *

      *
      • - *
    - */ - VolumeKmsKeyId?: string; - - /** - * @public - *

    Specifies a VPC that your training jobs and hosted models have access to. Control - * access to and from your training and model containers by configuring the VPC. For more - * information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Training Jobs - * by Using an Amazon Virtual Private Cloud.

    - */ - VpcConfig?: VpcConfig; -} - -/** - * @public - *

    Provides configuration information for auto-labeling of your data objects. A - * LabelingJobAlgorithmsConfig object must be supplied in order to use - * auto-labeling.

    - */ -export interface LabelingJobAlgorithmsConfig { - /** - * @public - *

    Specifies the Amazon Resource Name (ARN) of the algorithm used for auto-labeling. You - * must select one of the following ARNs:

    - *
      *
    • *

      - * Image classification + * arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectTracking *

      + *
      • + *
    • *

      - * arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/image-classification + * arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectTracking *

      *
      • *
    • *

      - * Text classification + * arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectTracking *

      + *
      • + *
    • *

      - * arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/text-classification + * arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectTracking *

      *
      • *
    • *

      - * Object detection + * arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectTracking *

      + *
      • + *
    + *

    + * 3D point cloud semantic segmentation adjustment - + * Adjust semantic segmentation masks in a 3D point cloud.

    + *
      + *
    • *

      - * arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/object-detection + * arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudSemanticSegmentation *

      *
      • *
    • *

      - * Semantic Segmentation + * arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudSemanticSegmentation *

      + *
      • + *
    • *

      - * arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/semantic-segmentation + * arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudSemanticSegmentation *

      *
      • - *
    - */ - LabelingJobAlgorithmSpecificationArn: string | undefined; - - /** - * @public - *

    At the end of an auto-label job Ground Truth sends the Amazon Resource Name (ARN) of the final - * model used for auto-labeling. You can use this model as the starting point for - * subsequent similar jobs by providing the ARN of the model here.

    - */ - InitialActiveLearningModelArn?: string; - - /** - * @public - *

    Provides configuration information for a labeling job.

    - */ - LabelingJobResourceConfig?: LabelingJobResourceConfig; -} - -/** - * @public - *

    Output configuration information for a labeling job.

    - */ -export interface LabelingJobOutputConfig { - /** - * @public - *

    The Amazon S3 location to write output data.

    - */ - S3OutputPath: string | undefined; - - /** - * @public - *

    The Amazon Web Services Key Management Service ID of the key used to encrypt the output data, if any.

    - *

    If you provide your own KMS key ID, you must add the required permissions to your KMS - * key described in Encrypt Output Data and Storage Volume with Amazon Web Services KMS.

    - *

    If you don't provide a KMS key ID, Amazon SageMaker uses the default Amazon Web Services KMS key for Amazon S3 for your - * role's account to encrypt your output data.

    - *

    If you use a bucket policy with an s3:PutObject permission that only - * allows objects with server-side encryption, set the condition key of - * s3:x-amz-server-side-encryption to "aws:kms". For more - * information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer - * Guide. - *

    - */ - KmsKeyId?: string; - - /** - * @public - *

    An Amazon Simple Notification Service (Amazon SNS) output topic ARN. Provide a SnsTopicArn if you want to - * do real time chaining to another streaming job and receive an Amazon SNS notifications each - * time a data object is submitted by a worker.

    - *

    If you provide an SnsTopicArn in OutputConfig, when workers - * complete labeling tasks, Ground Truth will send labeling task output data to the SNS output - * topic you specify here.

    - *

    To learn more, see Receive Output Data from a Streaming Labeling - * Job.

    - */ - SnsTopicArn?: string; -} - -/** - * @public - *

    A set of conditions for stopping a labeling job. If any of the conditions are met, the - * job is automatically stopped. You can use these conditions to control the cost of data - * labeling.

    - * - *

    Labeling jobs fail after 30 days with an appropriate client error message.

    - *     - */ -export interface LabelingJobStoppingConditions { - /** - * @public - *

    The maximum number of objects that can be labeled by human workers.

    - */ - MaxHumanLabeledObjectCount?: number; - - /** - * @public - *

    The maximum number of input data objects that should be labeled.

    - */ - MaxPercentageOfInputDatasetLabeled?: number; -} - -/** - * @public - */ -export interface CreateLabelingJobRequest { - /** - * @public - *

    The name of the labeling job. This name is used to identify the job in a list of - * labeling jobs. Labeling job names must be unique within an Amazon Web Services account and region. - * LabelingJobName is not case sensitive. For example, Example-job and - * example-job are considered the same labeling job name by Ground Truth.

    - */ - LabelingJobName: string | undefined; - - /** - * @public - *

    The attribute name to use for the label in the output manifest file. This is the key - * for the key/value pair formed with the label that a worker assigns to the object. The - * LabelAttributeName must meet the following requirements.

    - *
      *
    • - *

      The name can't end with "-metadata".

      + *

      + * arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudSemanticSegmentation + *

      *
      • *
    • - *

      If you are using one of the following built-in task types, - * the attribute name must end with "-ref". If the task type - * you are using is not listed below, the attribute name must - * not end with "-ref".

      - *
        - *
      • - *

        Image semantic segmentation (SemanticSegmentation), and - * adjustment (AdjustmentSemanticSegmentation) and - * verification (VerificationSemanticSegmentation) labeling - * jobs for this task type.

        - *
        • - *
      • - *

        Video frame object detection (VideoObjectDetection), and - * adjustment and verification - * (AdjustmentVideoObjectDetection) labeling jobs for this - * task type.

        - *
        • - *
      • - *

        Video frame object tracking (VideoObjectTracking), and - * adjustment and verification (AdjustmentVideoObjectTracking) - * labeling jobs for this task type.

        - *
        • - *
      • - *

        3D point cloud semantic segmentation - * (3DPointCloudSemanticSegmentation), and adjustment and - * verification (Adjustment3DPointCloudSemanticSegmentation) - * labeling jobs for this task type.

        - *
        • - *
      • - *

        3D point cloud object tracking - * (3DPointCloudObjectTracking), and adjustment and - * verification (Adjustment3DPointCloudObjectTracking) - * labeling jobs for this task type.

        - *
        • - *
      + *

      + * arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudSemanticSegmentation + *

      *
      • - *
    - *

    - * - *

    If you are creating an adjustment or verification labeling job, you must use a - * different - * LabelAttributeName than the one used in the original labeling job. The - * original labeling job is the Ground Truth labeling job that produced the labels that you - * want verified or adjusted. To learn more about adjustment and verification labeling - * jobs, see Verify and Adjust - * Labels.

    - *     - */ - LabelAttributeName: string | undefined; - - /** - * @public - *

    Input data for the labeling job, such as the Amazon S3 location of the data objects and the - * location of the manifest file that describes the data objects.

    - *

    You must specify at least one of the following: S3DataSource or - * SnsDataSource.

    - *
      *
    • - *

      Use SnsDataSource to specify an SNS input topic for a streaming - * labeling job. If you do not specify and SNS input topic ARN, Ground Truth will - * create a one-time labeling job that stops after all data objects in the input - * manifest file have been labeled.

      + *

      + * arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudSemanticSegmentation + *

      *
      • *
    • - *

      Use S3DataSource to specify an input manifest file for both - * streaming and one-time labeling jobs. Adding an S3DataSource is - * optional if you use SnsDataSource to create a streaming labeling - * job.

      + *

      + * arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudSemanticSegmentation + *

      *
      • - *
    - *

    If you use the Amazon Mechanical Turk workforce, your input data should not include - * confidential information, personal information or protected health information. Use - * ContentClassifiers to specify that your data is free of personally - * identifiable information and adult content.

    - */ - InputConfig: LabelingJobInputConfig | undefined; - - /** - * @public - *

    The location of the output data and the Amazon Web Services Key Management Service key ID for the key used to encrypt - * the output data, if any.

    - */ - OutputConfig: LabelingJobOutputConfig | undefined; - - /** - * @public - *

    The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf - * during data labeling. You must grant this role the necessary permissions so that Amazon SageMaker - * can successfully complete data labeling.

    - */ - RoleArn: string | undefined; - - /** - * @public - *

    The S3 URI of the file, referred to as a label category configuration - * file, that defines the categories used to label the data objects.

    - *

    For 3D point cloud and video frame task types, you can add label category attributes - * and frame attributes to your label category configuration file. To learn how, see Create a - * Labeling Category Configuration File for 3D Point Cloud Labeling Jobs.

    - *

    For named entity recognition jobs, in addition to "labels", you must - * provide worker instructions in the label category configuration file using the - * "instructions" parameter: "instructions": - * \{"shortInstruction":"

    Add header

    Add Instructions

    ", - * "fullInstruction":"

    Add additional instructions.

    "\}    . For details - * and an example, see Create a - * Named Entity Recognition Labeling Job (API) .

    - *

    For all other built-in task types and custom - * tasks, your label category configuration file must be a JSON file in the - * following format. Identify the labels you want to use by replacing label_1, - * label_2,...,label_n with your label - * categories.

    - *

    - * \{ - *

    - *

    - * "document-version": "2018-11-28", - *

    - *

    - * "labels": [\{"label": "label_1"\},\{"label": "label_2"\},...\{"label": - * "label_n"\}] - *

    - *

    - * \} - *

    - *

    Note the following about the label category configuration file:

    - *
      *
    • - *

      For image classification and text classification (single and multi-label) you - * must specify at least two label categories. For all other task types, the - * minimum number of label categories required is one.

      + *

      + * arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudSemanticSegmentation + *

      *
      • *
    • - *

      Each label category must be unique, you cannot specify duplicate label - * categories.

      + *

      + * arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudSemanticSegmentation + *

      *
      • *
    • - *

      If you create a 3D point cloud or video frame adjustment or verification - * labeling job, you must include auditLabelAttributeName in the label - * category configuration. Use this parameter to enter the - * LabelAttributeName - * of the labeling job you want to - * adjust or verify annotations of.

      + *

      + * arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudSemanticSegmentation + *

      + *
      • + *
    • + *

      + * arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudSemanticSegmentation + *

      + *
      • + *
    • + *

      + * arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudSemanticSegmentation + *

      *
      • *
    */ - LabelCategoryConfigS3Uri?: string; - - /** - * @public - *

    A set of conditions for stopping the labeling job. If any of the conditions are met, - * the job is automatically stopped. You can use these conditions to control the cost of - * data labeling.

    - */ - StoppingConditions?: LabelingJobStoppingConditions; + PreHumanTaskLambdaArn: string | undefined; /** * @public - *

    Configures the information required to perform automated data labeling.

    + *

    Keywords used to describe the task so that workers on Amazon Mechanical Turk can + * discover the task.

    */ - LabelingJobAlgorithmsConfig?: LabelingJobAlgorithmsConfig; + TaskKeywords?: string[]; /** * @public - *

    Configures the labeling task and how it is presented to workers; including, but not limited to price, keywords, and batch size (task count).

    + *

    A title for the task for your human workers.

    */ - HumanTaskConfig: HumanTaskConfig | undefined; + TaskTitle: string | undefined; /** * @public - *

    An array of key/value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management - * User Guide.

    + *

    A description of the task for your human workers.

    */ - Tags?: Tag[]; -} + TaskDescription: string | undefined; -/** - * @public - */ -export interface CreateLabelingJobResponse { /** * @public - *

    The Amazon Resource Name (ARN) of the labeling job. You use this ARN to identify the - * labeling job.

    + *

    The number of human workers that will label an object.

    */ - LabelingJobArn: string | undefined; -} - -/** - * @public - * @enum - */ -export const InferenceExecutionMode = { - DIRECT: "Direct", - SERIAL: "Serial", -} as const; - -/** - * @public - */ -export type InferenceExecutionMode = (typeof InferenceExecutionMode)[keyof typeof InferenceExecutionMode]; + NumberOfHumanWorkersPerDataObject: number | undefined; -/** - * @public - *

    Specifies details about how containers in a multi-container endpoint are run.

    - */ -export interface InferenceExecutionConfig { /** * @public - *

    How containers in a multi-container are run. The following values are valid.

    + *

    The amount of time that a worker has to complete a task.

    + *

    If you create a custom labeling job, the maximum value for this parameter is 8 hours + * (28,800 seconds).

    + *

    If you create a labeling job using a built-in task type the maximum + * for this parameter depends on the task type you use:

    *
      *
    • - *

      - * SERIAL - Containers run as a serial pipeline.

      + *

      For image and + * text labeling jobs, + * the maximum is 8 hours (28,800 seconds).

      *
      • *
    • - *

      - * DIRECT - Only the individual container that you specify is - * run.

      + *

      For 3D point cloud and video frame labeling jobs, the maximum is 30 days (2952,000 seconds) for non-AL mode. For most users, the maximum is also 30 days.

      *
      • *
    */ - Mode: InferenceExecutionMode | undefined; -} - -/** - * @public - */ -export interface CreateModelInput { - /** - * @public - *

    The name of the new model.

    - */ - ModelName: string | undefined; - - /** - * @public - *

    The location of the primary docker image containing inference code, associated - * artifacts, and custom environment map that the inference code uses when the model is - * deployed for predictions.

    - */ - PrimaryContainer?: ContainerDefinition; - - /** - * @public - *

    Specifies the containers in the inference pipeline.

    - */ - Containers?: ContainerDefinition[]; - - /** - * @public - *

    Specifies details of how containers in a multi-container endpoint are called.

    - */ - InferenceExecutionConfig?: InferenceExecutionConfig; + TaskTimeLimitInSeconds: number | undefined; /** * @public - *

    The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access model - * artifacts and docker image for deployment on ML compute instances or for batch transform - * jobs. Deploying on ML compute instances is part of model hosting. For more information, - * see SageMaker - * Roles.

    - * - *

    To be able to pass this role to SageMaker, the caller of this API must have the - * iam:PassRole permission.

    - *     + *

    The length of time that a task remains available for labeling by human workers. The + * default and maximum values for this parameter depend on the type of workforce you + * use.

    + *
      + *
    • + *

      If you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours (43,200 seconds). + * The default is 6 hours (21,600 seconds).

      + *
      • + *
    • + *

      If you choose a private or vendor workforce, the default value is 30 days (2592,000 seconds) for non-AL mode. For most users, the maximum is also 30 days.

      + *
      • + *
    */ - ExecutionRoleArn: string | undefined; + TaskAvailabilityLifetimeInSeconds?: number; /** * @public - *

    An array of key-value pairs. You can use tags to categorize your Amazon Web Services - * resources in different ways, for example, by purpose, owner, or environment. For more - * information, see Tagging Amazon Web Services Resources.

    + *

    Defines the maximum number of data objects that can be labeled by human workers at the + * same time. Also referred to as batch size. Each object may have more than one worker at one time. + * The default value is 1000 objects. To increase the maximum value to 5000 objects, contact Amazon Web Services Support.

    */ - Tags?: Tag[]; + MaxConcurrentTaskCount?: number; /** * @public - *

    A VpcConfig object that specifies the VPC that you want your model to connect - * to. Control access to and from your model container by configuring the VPC. - * VpcConfig is used in hosting services and in batch transform. For more - * information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Data in Batch - * Transform Jobs by Using an Amazon Virtual Private Cloud.

    + *

    Configures how labels are consolidated across human workers.

    */ - VpcConfig?: VpcConfig; + AnnotationConsolidationConfig: AnnotationConsolidationConfig | undefined; /** * @public - *

    Isolates the model container. No inbound or outbound network calls can be made to or - * from the model container.

    + *

    The price that you pay for each task performed by an Amazon Mechanical Turk worker.

    */ - EnableNetworkIsolation?: boolean; + PublicWorkforceTaskPrice?: PublicWorkforceTaskPrice; } /** * @public + *

    Attributes of the data specified by the customer. Use these to describe the data to be + * labeled.

    */ -export interface CreateModelOutput { +export interface LabelingJobDataAttributes { /** * @public - *

    The ARN of the model created in SageMaker.

    + *

    Declares that your content is free of personally identifiable information or adult + * content. SageMaker may restrict the Amazon Mechanical Turk workers that can view your task + * based on this information.

    */ - ModelArn: string | undefined; + ContentClassifiers?: ContentClassifier[]; } /** * @public - *

    Docker container image configuration object for the model bias job.

    + *

    The Amazon S3 location of the input data objects.

    */ -export interface ModelBiasAppSpecification { - /** - * @public - *

    The container image to be run by the model bias job.

    - */ - ImageUri: string | undefined; - - /** - * @public - *

    JSON formatted S3 file that defines bias parameters. For more information on this JSON - * configuration file, see Configure - * bias parameters.

    - */ - ConfigUri: string | undefined; - +export interface LabelingJobS3DataSource { /** * @public - *

    Sets the environment variables in the Docker container.

    + *

    The Amazon S3 location of the manifest file that describes the input data objects.

    + *

    The input manifest file referenced in ManifestS3Uri must contain one of + * the following keys: source-ref or source. The value of the + * keys are interpreted as follows:

    + *
      + *
    • + *

      + * source-ref: The source of the object is the Amazon S3 object + * specified in the value. Use this value when the object is a binary object, such + * as an image.

      + *
      • + *
    • + *

      + * source: The source of the object is the value. Use this + * value when the object is a text value.

      + *
      • + *
    + *

    If you are a new user of Ground Truth, it is recommended you review Use an Input Manifest File in the Amazon SageMaker Developer Guide to learn how to + * create an input manifest file.

    */ - Environment?: Record; + ManifestS3Uri: string | undefined; } /** * @public - *

    The configuration for a baseline model bias job.

    + *

    An Amazon SNS data source used for streaming labeling jobs.

    */ -export interface ModelBiasBaselineConfig { - /** - * @public - *

    The name of the baseline model bias job.

    - */ - BaseliningJobName?: string; - +export interface LabelingJobSnsDataSource { /** * @public - *

    The constraints resource for a monitoring job.

    + *

    The Amazon SNS input topic Amazon Resource Name (ARN). Specify the ARN of the input topic + * you will use to send new data objects to a streaming labeling job.

    */ - ConstraintsResource?: MonitoringConstraintsResource; + SnsTopicArn: string | undefined; } /** * @public - *

    The ground truth labels for the dataset used for the monitoring job.

    + *

    Provides information about the location of input data.

    + *

    You must specify at least one of the following: S3DataSource or SnsDataSource.

    + *

    Use SnsDataSource to specify an SNS input topic + * for a streaming labeling job. If you do not specify + * and SNS input topic ARN, Ground Truth will create a one-time labeling job.

    + *

    Use S3DataSource to specify an input + * manifest file for both streaming and one-time labeling jobs. + * Adding an S3DataSource is optional if you use SnsDataSource to create a streaming labeling job.

    */ -export interface MonitoringGroundTruthS3Input { +export interface LabelingJobDataSource { + /** + * @public + *

    The Amazon S3 location of the input data objects.

    + */ + S3DataSource?: LabelingJobS3DataSource; + /** * @public - *

    The address of the Amazon S3 location of the ground truth labels.

    + *

    An Amazon SNS data source used for streaming labeling jobs. To learn more, see Send Data to a Streaming Labeling Job.

    */ - S3Uri?: string; + SnsDataSource?: LabelingJobSnsDataSource; } /** * @public - *

    Inputs for the model bias job.

    + *

    Input configuration information for a labeling job.

    */ -export interface ModelBiasJobInput { - /** - * @public - *

    Input object for the endpoint

    - */ - EndpointInput?: EndpointInput; - +export interface LabelingJobInputConfig { /** * @public - *

    Input object for the batch transform job.

    + *

    The location of the input data.

    */ - BatchTransformInput?: BatchTransformInput; + DataSource: LabelingJobDataSource | undefined; /** * @public - *

    Location of ground truth labels to use in model bias job.

    + *

    Attributes of the data specified by the customer.

    */ - GroundTruthS3Input: MonitoringGroundTruthS3Input | undefined; + DataAttributes?: LabelingJobDataAttributes; } /** * @public + *

    Configure encryption on the storage volume attached to the ML compute instance used to + * run automated data labeling model training and inference.

    */ -export interface CreateModelBiasJobDefinitionRequest { +export interface LabelingJobResourceConfig { /** * @public - *

    The name of the bias job definition. The name must be unique within an Amazon Web Services - * Region in the Amazon Web Services account.

    + *

    The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume + * attached to the ML compute instance(s) that run the training and inference jobs used for + * automated data labeling.

    + *

    You can only specify a VolumeKmsKeyId when you create a labeling job with + * automated data labeling enabled using the API operation CreateLabelingJob. + * You cannot specify an Amazon Web Services KMS key to encrypt the storage volume used for + * automated data labeling model training and inference when you create a labeling job + * using the console. To learn more, see Output Data and Storage Volume + * Encryption.

    + *

    The VolumeKmsKeyId can be any of the following formats:

    + *
      + *
    • + *

      KMS Key ID

      + *

      + * "1234abcd-12ab-34cd-56ef-1234567890ab" + *

      + *
      • + *
    • + *

      Amazon Resource Name (ARN) of a KMS Key

      + *

      + * "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + *

      + *
      • + *
    */ - JobDefinitionName: string | undefined; + VolumeKmsKeyId?: string; /** * @public - *

    The baseline configuration for a model bias job.

    + *

    Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources + * have access to. You can control access to and from your resources by configuring a VPC. + * For more information, see Give SageMaker Access to Resources in your Amazon VPC.

    */ - ModelBiasBaselineConfig?: ModelBiasBaselineConfig; + VpcConfig?: VpcConfig; +} +/** + * @public + *

    Provides configuration information for auto-labeling of your data objects. A + * LabelingJobAlgorithmsConfig object must be supplied in order to use + * auto-labeling.

    + */ +export interface LabelingJobAlgorithmsConfig { /** * @public - *

    Configures the model bias job to run a specified Docker container image.

    + *

    Specifies the Amazon Resource Name (ARN) of the algorithm used for auto-labeling. You + * must select one of the following ARNs:

    + *
      + *
    • + *

      + * Image classification + *

      + *

      + * arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/image-classification + *

      + *
      • + *
    • + *

      + * Text classification + *

      + *

      + * arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/text-classification + *

      + *
      • + *
    • + *

      + * Object detection + *

      + *

      + * arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/object-detection + *

      + *
      • + *
    • + *

      + * Semantic Segmentation + *

      + *

      + * arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/semantic-segmentation + *

      + *
      • + *
    */ - ModelBiasAppSpecification: ModelBiasAppSpecification | undefined; + LabelingJobAlgorithmSpecificationArn: string | undefined; /** * @public - *

    Inputs for the model bias job.

    + *

    At the end of an auto-label job Ground Truth sends the Amazon Resource Name (ARN) of the final + * model used for auto-labeling. You can use this model as the starting point for + * subsequent similar jobs by providing the ARN of the model here.

    */ - ModelBiasJobInput: ModelBiasJobInput | undefined; + InitialActiveLearningModelArn?: string; /** * @public - *

    The output configuration for monitoring jobs.

    + *

    Provides configuration information for a labeling job.

    */ - ModelBiasJobOutputConfig: MonitoringOutputConfig | undefined; + LabelingJobResourceConfig?: LabelingJobResourceConfig; +} +/** + * @public + *

    Output configuration information for a labeling job.

    + */ +export interface LabelingJobOutputConfig { /** * @public - *

    Identifies the resources to deploy for a monitoring job.

    + *

    The Amazon S3 location to write output data.

    */ - JobResources: MonitoringResources | undefined; + S3OutputPath: string | undefined; /** * @public - *

    Networking options for a model bias job.

    + *

    The Amazon Web Services Key Management Service ID of the key used to encrypt the output data, if any.

    + *

    If you provide your own KMS key ID, you must add the required permissions to your KMS + * key described in Encrypt Output Data and Storage Volume with Amazon Web Services KMS.

    + *

    If you don't provide a KMS key ID, Amazon SageMaker uses the default Amazon Web Services KMS key for Amazon S3 for your + * role's account to encrypt your output data.

    + *

    If you use a bucket policy with an s3:PutObject permission that only + * allows objects with server-side encryption, set the condition key of + * s3:x-amz-server-side-encryption to "aws:kms". For more + * information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer + * Guide. + *

    */ - NetworkConfig?: MonitoringNetworkConfig; + KmsKeyId?: string; /** * @public - *

    The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can - * assume to perform tasks on your behalf.

    + *

    An Amazon Simple Notification Service (Amazon SNS) output topic ARN. Provide a SnsTopicArn if you want to + * do real time chaining to another streaming job and receive an Amazon SNS notifications each + * time a data object is submitted by a worker.

    + *

    If you provide an SnsTopicArn in OutputConfig, when workers + * complete labeling tasks, Ground Truth will send labeling task output data to the SNS output + * topic you specify here.

    + *

    To learn more, see Receive Output Data from a Streaming Labeling + * Job.

    */ - RoleArn: string | undefined; + SnsTopicArn?: string; +} +/** + * @public + *

    A set of conditions for stopping a labeling job. If any of the conditions are met, the + * job is automatically stopped. You can use these conditions to control the cost of data + * labeling.

    + * + *

    Labeling jobs fail after 30 days with an appropriate client error message.

    + *     + */ +export interface LabelingJobStoppingConditions { /** * @public - *

    A time limit for how long the monitoring job is allowed to run before stopping.

    + *

    The maximum number of objects that can be labeled by human workers.

    */ - StoppingCondition?: MonitoringStoppingCondition; + MaxHumanLabeledObjectCount?: number; /** * @public - *

    (Optional) An array of key-value pairs. For more information, see - * - * Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

    + *

    The maximum number of input data objects that should be labeled.

    */ - Tags?: Tag[]; + MaxPercentageOfInputDatasetLabeled?: number; } /** * @public */ -export interface CreateModelBiasJobDefinitionResponse { +export interface CreateLabelingJobRequest { /** * @public - *

    The Amazon Resource Name (ARN) of the model bias job.

    + *

    The name of the labeling job. This name is used to identify the job in a list of + * labeling jobs. Labeling job names must be unique within an Amazon Web Services account and region. + * LabelingJobName is not case sensitive. For example, Example-job and + * example-job are considered the same labeling job name by Ground Truth.

    */ - JobDefinitionArn: string | undefined; -} - -/** - * @public - * @enum - */ -export const ModelCardStatus = { - APPROVED: "Approved", - ARCHIVED: "Archived", - DRAFT: "Draft", - PENDINGREVIEW: "PendingReview", -} as const; - -/** - * @public - */ -export type ModelCardStatus = (typeof ModelCardStatus)[keyof typeof ModelCardStatus]; + LabelingJobName: string | undefined; -/** - * @public - *

    Configure the security settings to protect model card data.

    - */ -export interface ModelCardSecurityConfig { /** * @public - *

    A Key Management Service - * key - * ID to use for encrypting a model card.

    + *

    The attribute name to use for the label in the output manifest file. This is the key + * for the key/value pair formed with the label that a worker assigns to the object. The + * LabelAttributeName must meet the following requirements.

    + *
      + *
    • + *

      The name can't end with "-metadata".

      + *
      • + *
    • + *

      If you are using one of the following built-in task types, + * the attribute name must end with "-ref". If the task type + * you are using is not listed below, the attribute name must + * not end with "-ref".

      + *
        + *
      • + *

        Image semantic segmentation (SemanticSegmentation), and + * adjustment (AdjustmentSemanticSegmentation) and + * verification (VerificationSemanticSegmentation) labeling + * jobs for this task type.

        + *
        • + *
      • + *

        Video frame object detection (VideoObjectDetection), and + * adjustment and verification + * (AdjustmentVideoObjectDetection) labeling jobs for this + * task type.

        + *
        • + *
      • + *

        Video frame object tracking (VideoObjectTracking), and + * adjustment and verification (AdjustmentVideoObjectTracking) + * labeling jobs for this task type.

        + *
        • + *
      • + *

        3D point cloud semantic segmentation + * (3DPointCloudSemanticSegmentation), and adjustment and + * verification (Adjustment3DPointCloudSemanticSegmentation) + * labeling jobs for this task type.

        + *
        • + *
      • + *

        3D point cloud object tracking + * (3DPointCloudObjectTracking), and adjustment and + * verification (Adjustment3DPointCloudObjectTracking) + * labeling jobs for this task type.

        + *
        • + *
      + *
      • + *
    + *

    + * + *

    If you are creating an adjustment or verification labeling job, you must use a + * different + * LabelAttributeName than the one used in the original labeling job. The + * original labeling job is the Ground Truth labeling job that produced the labels that you + * want verified or adjusted. To learn more about adjustment and verification labeling + * jobs, see Verify and Adjust + * Labels.

    + *     */ - KmsKeyId?: string; -} + LabelAttributeName: string | undefined; -/** - * @public - */ -export interface CreateModelCardRequest { /** * @public - *

    The unique name of the model card.

    + *

    Input data for the labeling job, such as the Amazon S3 location of the data objects and the + * location of the manifest file that describes the data objects.

    + *

    You must specify at least one of the following: S3DataSource or + * SnsDataSource.

    + *
      + *
    • + *

      Use SnsDataSource to specify an SNS input topic for a streaming + * labeling job. If you do not specify and SNS input topic ARN, Ground Truth will + * create a one-time labeling job that stops after all data objects in the input + * manifest file have been labeled.

      + *
      • + *
    • + *

      Use S3DataSource to specify an input manifest file for both + * streaming and one-time labeling jobs. Adding an S3DataSource is + * optional if you use SnsDataSource to create a streaming labeling + * job.

      + *
      • + *
    + *

    If you use the Amazon Mechanical Turk workforce, your input data should not include + * confidential information, personal information or protected health information. Use + * ContentClassifiers to specify that your data is free of personally + * identifiable information and adult content.

    */ - ModelCardName: string | undefined; + InputConfig: LabelingJobInputConfig | undefined; /** * @public - *

    An optional Key Management Service - * key to encrypt, decrypt, and re-encrypt model card content for regulated workloads with - * highly sensitive data.

    + *

    The location of the output data and the Amazon Web Services Key Management Service key ID for the key used to encrypt + * the output data, if any.

    */ - SecurityConfig?: ModelCardSecurityConfig; + OutputConfig: LabelingJobOutputConfig | undefined; /** * @public - *

    The content of the model card. Content must be in model card JSON schema and provided as a string.

    + *

    The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf + * during data labeling. You must grant this role the necessary permissions so that Amazon SageMaker + * can successfully complete data labeling.

    */ - Content: string | undefined; + RoleArn: string | undefined; /** * @public - *

    The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

    + *

    The S3 URI of the file, referred to as a label category configuration + * file, that defines the categories used to label the data objects.

    + *

    For 3D point cloud and video frame task types, you can add label category attributes + * and frame attributes to your label category configuration file. To learn how, see Create a + * Labeling Category Configuration File for 3D Point Cloud Labeling Jobs.

    + *

    For named entity recognition jobs, in addition to "labels", you must + * provide worker instructions in the label category configuration file using the + * "instructions" parameter: "instructions": + * \{"shortInstruction":"

    Add header

    Add Instructions

    ", + * "fullInstruction":"

    Add additional instructions.

    "\}    . For details + * and an example, see Create a + * Named Entity Recognition Labeling Job (API) .

    + *

    For all other built-in task types and custom + * tasks, your label category configuration file must be a JSON file in the + * following format. Identify the labels you want to use by replacing label_1, + * label_2,...,label_n with your label + * categories.

    + *

    + * \{ + *

    + *

    + * "document-version": "2018-11-28", + *

    + *

    + * "labels": [\{"label": "label_1"\},\{"label": "label_2"\},...\{"label": + * "label_n"\}] + *

    + *

    + * \} + *

    + *

    Note the following about the label category configuration file:

    *
      *
    • - *

      - * Draft: The model card is a work in progress.

      - *
      • - *
    • - *

      - * PendingReview: The model card is pending review.

      + *

      For image classification and text classification (single and multi-label) you + * must specify at least two label categories. For all other task types, the + * minimum number of label categories required is one.

      *
      • *
    • - *

      - * Approved: The model card is approved.

      + *

      Each label category must be unique, you cannot specify duplicate label + * categories.

      *
      • *
    • - *

      - * Archived: The model card is archived. No more updates should be made to the model - * card, but it can still be exported.

      + *

      If you create a 3D point cloud or video frame adjustment or verification + * labeling job, you must include auditLabelAttributeName in the label + * category configuration. Use this parameter to enter the + * LabelAttributeName + * of the labeling job you want to + * adjust or verify annotations of.

      *
      • *
    */ - ModelCardStatus: ModelCardStatus | undefined; - - /** - * @public - *

    Key-value pairs used to manage metadata for model cards.

    - */ - Tags?: Tag[]; -} - -/** - * @public - */ -export interface CreateModelCardResponse { - /** - * @public - *

    The Amazon Resource Name (ARN) of the successfully created model card.

    - */ - ModelCardArn: string | undefined; -} - -/** - * @public - *

    Configure the export output details for an Amazon SageMaker Model Card.

    - */ -export interface ModelCardExportOutputConfig { - /** - * @public - *

    The Amazon S3 output path to export your model card PDF.

    - */ - S3OutputPath: string | undefined; -} + LabelCategoryConfigS3Uri?: string; -/** - * @public - */ -export interface CreateModelCardExportJobRequest { /** * @public - *

    The name or Amazon Resource Name (ARN) of the model card to export.

    + *

    A set of conditions for stopping the labeling job. If any of the conditions are met, + * the job is automatically stopped. You can use these conditions to control the cost of + * data labeling.

    */ - ModelCardName: string | undefined; + StoppingConditions?: LabelingJobStoppingConditions; /** * @public - *

    The version of the model card to export. If a version is not provided, then the latest version of the model card is exported.

    + *

    Configures the information required to perform automated data labeling.

    */ - ModelCardVersion?: number; + LabelingJobAlgorithmsConfig?: LabelingJobAlgorithmsConfig; /** * @public - *

    The name of the model card export job.

    + *

    Configures the labeling task and how it is presented to workers; including, but not limited to price, keywords, and batch size (task count).

    */ - ModelCardExportJobName: string | undefined; + HumanTaskConfig: HumanTaskConfig | undefined; /** * @public - *

    The model card output configuration that specifies the Amazon S3 path for exporting.

    + *

    An array of key/value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management + * User Guide.

    */ - OutputConfig: ModelCardExportOutputConfig | undefined; + Tags?: Tag[]; } /** * @public */ -export interface CreateModelCardExportJobResponse { +export interface CreateLabelingJobResponse { /** * @public - *

    The Amazon Resource Name (ARN) of the model card export job.

    + *

    The Amazon Resource Name (ARN) of the labeling job. You use this ARN to identify the + * labeling job.

    */ - ModelCardExportJobArn: string | undefined; + LabelingJobArn: string | undefined; } /** * @public - *

    Docker container image configuration object for the model explainability job.

    + * @enum */ -export interface ModelExplainabilityAppSpecification { - /** - * @public - *

    The container image to be run by the model explainability job.

    - */ - ImageUri: string | undefined; - - /** - * @public - *

    JSON formatted Amazon S3 file that defines explainability parameters. For more - * information on this JSON configuration file, see Configure model explainability parameters.

    - */ - ConfigUri: string | undefined; - - /** - * @public - *

    Sets the environment variables in the Docker container.

    - */ - Environment?: Record; -} +export const InferenceExecutionMode = { + DIRECT: "Direct", + SERIAL: "Serial", +} as const; /** * @public - *

    The configuration for a baseline model explainability job.

    */ -export interface ModelExplainabilityBaselineConfig { - /** - * @public - *

    The name of the baseline model explainability job.

    - */ - BaseliningJobName?: string; - - /** - * @public - *

    The constraints resource for a monitoring job.

    - */ - ConstraintsResource?: MonitoringConstraintsResource; -} +export type InferenceExecutionMode = (typeof InferenceExecutionMode)[keyof typeof InferenceExecutionMode]; /** * @public - *

    Inputs for the model explainability job.

    + *

    Specifies details about how containers in a multi-container endpoint are run.

    */ -export interface ModelExplainabilityJobInput { - /** - * @public - *

    Input object for the endpoint

    - */ - EndpointInput?: EndpointInput; - +export interface InferenceExecutionConfig { /** * @public - *

    Input object for the batch transform job.

    + *

    How containers in a multi-container are run. The following values are valid.

    + *
      + *
    • + *

      + * SERIAL - Containers run as a serial pipeline.

      + *
      • + *
    • + *

      + * DIRECT - Only the individual container that you specify is + * run.

      + *
      • + *
    */ - BatchTransformInput?: BatchTransformInput; + Mode: InferenceExecutionMode | undefined; } /** * @public */ -export interface CreateModelExplainabilityJobDefinitionRequest { - /** - * @public - *

    The name of the model explainability job definition. The name must be unique within an - * Amazon Web Services Region in the Amazon Web Services account.

    - */ - JobDefinitionName: string | undefined; - - /** - * @public - *

    The baseline configuration for a model explainability job.

    - */ - ModelExplainabilityBaselineConfig?: ModelExplainabilityBaselineConfig; - +export interface CreateModelInput { /** * @public - *

    Configures the model explainability job to run a specified Docker container image.

    + *

    The name of the new model.

    */ - ModelExplainabilityAppSpecification: ModelExplainabilityAppSpecification | undefined; + ModelName: string | undefined; /** * @public - *

    Inputs for the model explainability job.

    + *

    The location of the primary docker image containing inference code, associated + * artifacts, and custom environment map that the inference code uses when the model is + * deployed for predictions.

    */ - ModelExplainabilityJobInput: ModelExplainabilityJobInput | undefined; + PrimaryContainer?: ContainerDefinition; /** * @public - *

    The output configuration for monitoring jobs.

    + *

    Specifies the containers in the inference pipeline.

    */ - ModelExplainabilityJobOutputConfig: MonitoringOutputConfig | undefined; + Containers?: ContainerDefinition[]; /** * @public - *

    Identifies the resources to deploy for a monitoring job.

    + *

    Specifies details of how containers in a multi-container endpoint are called.

    */ - JobResources: MonitoringResources | undefined; + InferenceExecutionConfig?: InferenceExecutionConfig; /** * @public - *

    Networking options for a model explainability job.

    + *

    The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access model + * artifacts and docker image for deployment on ML compute instances or for batch transform + * jobs. Deploying on ML compute instances is part of model hosting. For more information, + * see SageMaker + * Roles.

    + * + *

    To be able to pass this role to SageMaker, the caller of this API must have the + * iam:PassRole permission.

    + *     */ - NetworkConfig?: MonitoringNetworkConfig; + ExecutionRoleArn?: string; /** * @public - *

    The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can - * assume to perform tasks on your behalf.

    + *

    An array of key-value pairs. You can use tags to categorize your Amazon Web Services + * resources in different ways, for example, by purpose, owner, or environment. For more + * information, see Tagging Amazon Web Services Resources.

    */ - RoleArn: string | undefined; + Tags?: Tag[]; /** * @public - *

    A time limit for how long the monitoring job is allowed to run before stopping.

    + *

    A VpcConfig object that specifies the VPC that you want your model to connect + * to. Control access to and from your model container by configuring the VPC. + * VpcConfig is used in hosting services and in batch transform. For more + * information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Data in Batch + * Transform Jobs by Using an Amazon Virtual Private Cloud.

    */ - StoppingCondition?: MonitoringStoppingCondition; + VpcConfig?: VpcConfig; /** * @public - *

    (Optional) An array of key-value pairs. For more information, see - * - * Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

    + *

    Isolates the model container. No inbound or outbound network calls can be made to or + * from the model container.

    */ - Tags?: Tag[]; + EnableNetworkIsolation?: boolean; } /** * @public */ -export interface CreateModelExplainabilityJobDefinitionResponse { +export interface CreateModelOutput { /** * @public - *

    The Amazon Resource Name (ARN) of the model explainability job.

    + *

    The ARN of the model created in SageMaker.

    */ - JobDefinitionArn: string | undefined; + ModelArn: string | undefined; } /** * @public - *

    Contains details regarding the file source.

    + *

    Docker container image configuration object for the model bias job.

    */ -export interface FileSource { +export interface ModelBiasAppSpecification { /** * @public - *

    The type of content stored in the file source.

    + *

    The container image to be run by the model bias job.

    */ - ContentType?: string; + ImageUri: string | undefined; /** * @public - *

    The digest of the file source.

    + *

    JSON formatted S3 file that defines bias parameters. For more information on this JSON + * configuration file, see Configure + * bias parameters.

    */ - ContentDigest?: string; + ConfigUri: string | undefined; /** * @public - *

    The Amazon S3 URI for the file source.

    + *

    Sets the environment variables in the Docker container.

    */ - S3Uri: string | undefined; + Environment?: Record; } /** * @public - *

    Represents the drift check bias baselines that can be used when the model monitor is set using the - * model package.

    + *

    The configuration for a baseline model bias job.

    */ -export interface DriftCheckBias { - /** - * @public - *

    The bias config file for a model.

    - */ - ConfigFile?: FileSource; - +export interface ModelBiasBaselineConfig { /** * @public - *

    The pre-training constraints.

    + *

    The name of the baseline model bias job.

    */ - PreTrainingConstraints?: MetricsSource; + BaseliningJobName?: string; /** * @public - *

    The post-training constraints.

    + *

    The constraints resource for a monitoring job.

    */ - PostTrainingConstraints?: MetricsSource; + ConstraintsResource?: MonitoringConstraintsResource; } /** * @public - *

    Represents the drift check explainability baselines that can be used when the model monitor is set - * using the model package.

    + *

    The ground truth labels for the dataset used for the monitoring job.

    */ -export interface DriftCheckExplainability { - /** - * @public - *

    The drift check explainability constraints.

    - */ - Constraints?: MetricsSource; - +export interface MonitoringGroundTruthS3Input { /** * @public - *

    The explainability config file for the model.

    + *

    The address of the Amazon S3 location of the ground truth labels.

    */ - ConfigFile?: FileSource; + S3Uri?: string; } /** * @public - *

    Represents the drift check data quality baselines that can be used when the model monitor is set using - * the model package.

    + *

    Inputs for the model bias job.

    */ -export interface DriftCheckModelDataQuality { - /** - * @public - *

    The drift check model data quality statistics.

    - */ - Statistics?: MetricsSource; - +export interface ModelBiasJobInput { /** * @public - *

    The drift check model data quality constraints.

    + *

    Input object for the endpoint

    */ - Constraints?: MetricsSource; -} + EndpointInput?: EndpointInput; -/** - * @public - *

    Represents the drift check model quality baselines that can be used when the model monitor is set using - * the model package.

    - */ -export interface DriftCheckModelQuality { /** * @public - *

    The drift check model quality statistics.

    + *

    Input object for the batch transform job.

    */ - Statistics?: MetricsSource; + BatchTransformInput?: BatchTransformInput; /** * @public - *

    The drift check model quality constraints.

    + *

    Location of ground truth labels to use in model bias job.

    */ - Constraints?: MetricsSource; + GroundTruthS3Input: MonitoringGroundTruthS3Input | undefined; } /** * @public - *

    Represents the drift check baselines that can be used when the model monitor is set using the model - * package.

    */ -export interface DriftCheckBaselines { - /** - * @public - *

    Represents the drift check bias baselines that can be used when the model monitor is set using the model - * package.

    - */ - Bias?: DriftCheckBias; - - /** - * @public - *

    Represents the drift check explainability baselines that can be used when the model monitor is set using - * the model package.

    - */ - Explainability?: DriftCheckExplainability; - +export interface CreateModelBiasJobDefinitionRequest { /** * @public - *

    Represents the drift check model quality baselines that can be used when the model monitor is set using - * the model package.

    + *

    The name of the bias job definition. The name must be unique within an Amazon Web Services + * Region in the Amazon Web Services account.

    */ - ModelQuality?: DriftCheckModelQuality; + JobDefinitionName: string | undefined; /** * @public - *

    Represents the drift check model data quality baselines that can be used when the model monitor is set - * using the model package.

    + *

    The baseline configuration for a model bias job.

    */ - ModelDataQuality?: DriftCheckModelDataQuality; -} + ModelBiasBaselineConfig?: ModelBiasBaselineConfig; -/** - * @public - *

    Contains explainability metrics for a model.

    - */ -export interface Explainability { /** * @public - *

    The explainability report for a model.

    + *

    Configures the model bias job to run a specified Docker container image.

    */ - Report?: MetricsSource; -} + ModelBiasAppSpecification: ModelBiasAppSpecification | undefined; -/** - * @public - *

    Data quality constraints and statistics for a model.

    - */ -export interface ModelDataQuality { /** * @public - *

    Data quality statistics for a model.

    + *

    Inputs for the model bias job.

    */ - Statistics?: MetricsSource; + ModelBiasJobInput: ModelBiasJobInput | undefined; /** * @public - *

    Data quality constraints for a model.

    + *

    The output configuration for monitoring jobs.

    */ - Constraints?: MetricsSource; -} + ModelBiasJobOutputConfig: MonitoringOutputConfig | undefined; -/** - * @public - *

    Model quality statistics and constraints.

    - */ -export interface ModelQuality { /** * @public - *

    Model quality statistics.

    + *

    Identifies the resources to deploy for a monitoring job.

    */ - Statistics?: MetricsSource; + JobResources: MonitoringResources | undefined; /** * @public - *

    Model quality constraints.

    + *

    Networking options for a model bias job.

    */ - Constraints?: MetricsSource; -} + NetworkConfig?: MonitoringNetworkConfig; -/** - * @public - *

    Contains metrics captured from a model.

    - */ -export interface ModelMetrics { /** * @public - *

    Metrics that measure the quality of a model.

    + *

    The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can + * assume to perform tasks on your behalf.

    */ - ModelQuality?: ModelQuality; + RoleArn: string | undefined; /** * @public - *

    Metrics that measure the quality of the input data for a model.

    + *

    A time limit for how long the monitoring job is allowed to run before stopping.

    */ - ModelDataQuality?: ModelDataQuality; + StoppingCondition?: MonitoringStoppingCondition; /** * @public - *

    Metrics that measure bais in a model.

    + *

    (Optional) An array of key-value pairs. For more information, see + * + * Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

    */ - Bias?: Bias; + Tags?: Tag[]; +} +/** + * @public + */ +export interface CreateModelBiasJobDefinitionResponse { /** * @public - *

    Metrics that help explain a model.

    + *

    The Amazon Resource Name (ARN) of the model bias job.

    */ - Explainability?: Explainability; + JobDefinitionArn: string | undefined; } /** * @public * @enum */ -export const SkipModelValidation = { - ALL: "All", - NONE: "None", +export const ModelCardStatus = { + APPROVED: "Approved", + ARCHIVED: "Archived", + DRAFT: "Draft", + PENDINGREVIEW: "PendingReview", } as const; /** * @public */ -export type SkipModelValidation = (typeof SkipModelValidation)[keyof typeof SkipModelValidation]; +export type ModelCardStatus = (typeof ModelCardStatus)[keyof typeof ModelCardStatus]; /** * @public - *

    Specifies an algorithm that was used to create the model package. The algorithm must - * be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.

    + *

    Configure the security settings to protect model card data.

    */ -export interface SourceAlgorithm { - /** - * @public - *

    The Amazon S3 path where the model artifacts, which result from model training, are stored. - * This path must point to a single gzip compressed tar archive - * (.tar.gz suffix).

    - * - *

    The model artifacts must be in an S3 bucket that is in the same Amazon Web Services - * region as the algorithm.

    - *     - */ - ModelDataUrl?: string; - +export interface ModelCardSecurityConfig { /** * @public - *

    The name of an algorithm that was used to create the model package. The algorithm must - * be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.

    + *

    A Key Management Service + * key + * ID to use for encrypting a model card.

    */ - AlgorithmName: string | undefined; + KmsKeyId?: string; } /** * @public - *

    A list of algorithms that were used to create a model package.

    */ -export interface SourceAlgorithmSpecification { +export interface CreateModelCardRequest { /** * @public - *

    A list of the algorithms that were used to create a model package.

    + *

    The unique name of the model card.

    */ - SourceAlgorithms: SourceAlgorithm[] | undefined; -} + ModelCardName: string | undefined; -/** - * @public - *

    Contains data, such as the inputs and targeted instance types that are used in the - * process of validating the model package.

    - *

    The data provided in the validation profile is made available to your buyers on Amazon Web Services - * Marketplace.

    - */ -export interface ModelPackageValidationProfile { /** * @public - *

    The name of the profile for the model package.

    + *

    An optional Key Management Service + * key to encrypt, decrypt, and re-encrypt model card content for regulated workloads with + * highly sensitive data.

    */ - ProfileName: string | undefined; + SecurityConfig?: ModelCardSecurityConfig; /** * @public - *

    The TransformJobDefinition object that describes the transform job used - * for the validation of the model package.

    + *

    The content of the model card. Content must be in model card JSON schema and provided as a string.

    */ - TransformJobDefinition: TransformJobDefinition | undefined; -} + Content: string | undefined; -/** - * @public - *

    Specifies batch transform jobs that SageMaker runs to validate your model package.

    - */ -export interface ModelPackageValidationSpecification { /** * @public - *

    The IAM roles to be used for the validation of the model package.

    + *

    The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

    + *
      + *
    • + *

      + * Draft: The model card is a work in progress.

      + *
      • + *
    • + *

      + * PendingReview: The model card is pending review.

      + *
      • + *
    • + *

      + * Approved: The model card is approved.

      + *
      • + *
    • + *

      + * Archived: The model card is archived. No more updates should be made to the model + * card, but it can still be exported.

      + *
      • + *
    */ - ValidationRole: string | undefined; + ModelCardStatus: ModelCardStatus | undefined; /** * @public - *

    An array of ModelPackageValidationProfile objects, each of which - * specifies a batch transform job that SageMaker runs to validate your model package.

    + *

    Key-value pairs used to manage metadata for model cards.

    */ - ValidationProfiles: ModelPackageValidationProfile[] | undefined; + Tags?: Tag[]; } /** * @public */ -export interface CreateModelPackageInput { +export interface CreateModelCardResponse { /** * @public - *

    The name of the model package. The name must have 1 to 63 characters. Valid characters - * are a-z, A-Z, 0-9, and - (hyphen).

    - *

    This parameter is required for unversioned models. It is not applicable to versioned - * models.

    + *

    The Amazon Resource Name (ARN) of the successfully created model card.

    */ - ModelPackageName?: string; + ModelCardArn: string | undefined; +} +/** + * @public + *

    Configure the export output details for an Amazon SageMaker Model Card.

    + */ +export interface ModelCardExportOutputConfig { /** * @public - *

    The name or Amazon Resource Name (ARN) of the model package group that this model version belongs to.

    - *

    This parameter is required for versioned models, and does not apply to unversioned - * models.

    + *

    The Amazon S3 output path to export your model card PDF.

    */ - ModelPackageGroupName?: string; + S3OutputPath: string | undefined; +} +/** + * @public + */ +export interface CreateModelCardExportJobRequest { /** * @public - *

    A description of the model package.

    + *

    The name or Amazon Resource Name (ARN) of the model card to export.

    */ - ModelPackageDescription?: string; + ModelCardName: string | undefined; /** * @public - *

    Specifies details about inference jobs that can be run with models based on this model - * package, including the following:

    - *
      - *
    • - *

      The Amazon ECR paths of containers that contain the inference code and model - * artifacts.

      - *
      • - *
    • - *

      The instance types that the model package supports for transform jobs and - * real-time endpoints used for inference.

      - *
      • - *
    • - *

      The input and output content formats that the model package supports for - * inference.

      - *
      • - *
    + *

    The version of the model card to export. If a version is not provided, then the latest version of the model card is exported.

    */ - InferenceSpecification?: InferenceSpecification; + ModelCardVersion?: number; /** * @public - *

    Specifies configurations for one or more transform jobs that SageMaker runs to test the - * model package.

    + *

    The name of the model card export job.

    */ - ValidationSpecification?: ModelPackageValidationSpecification; + ModelCardExportJobName: string | undefined; /** * @public - *

    Details about the algorithm that was used to create the model package.

    + *

    The model card output configuration that specifies the Amazon S3 path for exporting.

    */ - SourceAlgorithmSpecification?: SourceAlgorithmSpecification; + OutputConfig: ModelCardExportOutputConfig | undefined; +} + +/** + * @public + */ +export interface CreateModelCardExportJobResponse { + /** + * @public + *

    The Amazon Resource Name (ARN) of the model card export job.

    + */ + ModelCardExportJobArn: string | undefined; +} +/** + * @public + *

    Docker container image configuration object for the model explainability job.

    + */ +export interface ModelExplainabilityAppSpecification { /** * @public - *

    Whether to certify the model package for listing on Amazon Web Services Marketplace.

    - *

    This parameter is optional for unversioned models, and does not apply to versioned - * models.

    + *

    The container image to be run by the model explainability job.

    */ - CertifyForMarketplace?: boolean; + ImageUri: string | undefined; /** * @public - *

    A list of key value pairs associated with the model. For more information, see Tagging Amazon Web Services - * resources in the Amazon Web Services General Reference Guide.

    - *

    If you supply ModelPackageGroupName, your model package belongs to the model group - * you specify and uses the tags associated with the model group. In this case, you cannot - * supply a tag argument. - *

    + *

    JSON formatted Amazon S3 file that defines explainability parameters. For more + * information on this JSON configuration file, see Configure model explainability parameters.

    */ - Tags?: Tag[]; + ConfigUri: string | undefined; /** * @public - *

    Whether the model is approved for deployment.

    - *

    This parameter is optional for versioned models, and does not apply to unversioned - * models.

    - *

    For versioned models, the value of this parameter must be set to Approved - * to deploy the model.

    + *

    Sets the environment variables in the Docker container.

    */ - ModelApprovalStatus?: ModelApprovalStatus; + Environment?: Record; +} +/** + * @public + *

    The configuration for a baseline model explainability job.

    + */ +export interface ModelExplainabilityBaselineConfig { /** * @public - *

    Metadata properties of the tracking entity, trial, or trial component.

    + *

    The name of the baseline model explainability job.

    */ - MetadataProperties?: MetadataProperties; + BaseliningJobName?: string; /** * @public - *

    A structure that contains model metrics reports.

    + *

    The constraints resource for a monitoring job.

    */ - ModelMetrics?: ModelMetrics; + ConstraintsResource?: MonitoringConstraintsResource; +} +/** + * @public + *

    Inputs for the model explainability job.

    + */ +export interface ModelExplainabilityJobInput { /** * @public - *

    A unique token that guarantees that the call to this API is idempotent.

    + *

    Input object for the endpoint

    */ - ClientToken?: string; + EndpointInput?: EndpointInput; /** * @public - *

    The metadata properties associated with the model package versions.

    + *

    Input object for the batch transform job.

    */ - CustomerMetadataProperties?: Record; + BatchTransformInput?: BatchTransformInput; +} +/** + * @public + */ +export interface CreateModelExplainabilityJobDefinitionRequest { /** * @public - *

    Represents the drift check baselines that can be used when the model monitor is set using the model package. - * For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide. - *

    + *

    The name of the model explainability job definition. The name must be unique within an + * Amazon Web Services Region in the Amazon Web Services account.

    */ - DriftCheckBaselines?: DriftCheckBaselines; + JobDefinitionName: string | undefined; /** * @public - *

    The machine learning domain of your model package and its components. Common - * machine learning domains include computer vision and natural language processing.

    + *

    The baseline configuration for a model explainability job.

    */ - Domain?: string; + ModelExplainabilityBaselineConfig?: ModelExplainabilityBaselineConfig; /** * @public - *

    The machine learning task your model package accomplishes. Common machine - * learning tasks include object detection and image classification. The following - * tasks are supported by Inference Recommender: - * "IMAGE_CLASSIFICATION" | "OBJECT_DETECTION" | "TEXT_GENERATION" |"IMAGE_SEGMENTATION" | - * "FILL_MASK" | "CLASSIFICATION" | "REGRESSION" | "OTHER".

    - *

    Specify "OTHER" if none of the tasks listed fit your use case.

    + *

    Configures the model explainability job to run a specified Docker container image.

    */ - Task?: string; + ModelExplainabilityAppSpecification: ModelExplainabilityAppSpecification | undefined; /** * @public - *

    The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point - * to a single gzip compressed tar archive (.tar.gz suffix). This archive can hold multiple files - * that are all equally used in the load test. Each file in the archive must satisfy the size constraints of the - * InvokeEndpoint call.

    + *

    Inputs for the model explainability job.

    */ - SamplePayloadUrl?: string; + ModelExplainabilityJobInput: ModelExplainabilityJobInput | undefined; /** * @public - *

    An array of additional Inference Specification objects. Each additional - * Inference Specification specifies artifacts based on this model package that can - * be used on inference endpoints. Generally used with SageMaker Neo to store the - * compiled artifacts.

    + *

    The output configuration for monitoring jobs.

    */ - AdditionalInferenceSpecifications?: AdditionalInferenceSpecificationDefinition[]; + ModelExplainabilityJobOutputConfig: MonitoringOutputConfig | undefined; /** * @public - *

    Indicates if you want to skip model validation.

    + *

    Identifies the resources to deploy for a monitoring job.

    */ - SkipModelValidation?: SkipModelValidation; -} + JobResources: MonitoringResources | undefined; -/** - * @public - */ -export interface CreateModelPackageOutput { /** * @public - *

    The Amazon Resource Name (ARN) of the new model package.

    + *

    Networking options for a model explainability job.

    */ - ModelPackageArn: string | undefined; -} + NetworkConfig?: MonitoringNetworkConfig; -/** - * @public - */ -export interface CreateModelPackageGroupInput { /** * @public - *

    The name of the model group.

    + *

    The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can + * assume to perform tasks on your behalf.

    */ - ModelPackageGroupName: string | undefined; + RoleArn: string | undefined; /** * @public - *

    A description for the model group.

    + *

    A time limit for how long the monitoring job is allowed to run before stopping.

    */ - ModelPackageGroupDescription?: string; + StoppingCondition?: MonitoringStoppingCondition; /** * @public - *

    A list of key value pairs associated with the model group. For more information, see - * Tagging Amazon Web Services - * resources in the Amazon Web Services General Reference Guide.

    + *

    (Optional) An array of key-value pairs. For more information, see + * + * Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

    */ Tags?: Tag[]; } @@ -8609,557 +8787,523 @@ export interface CreateModelPackageGroupInput { /** * @public */ -export interface CreateModelPackageGroupOutput { +export interface CreateModelExplainabilityJobDefinitionResponse { /** * @public - *

    The Amazon Resource Name (ARN) of the model group.

    + *

    The Amazon Resource Name (ARN) of the model explainability job.

    */ - ModelPackageGroupArn: string | undefined; + JobDefinitionArn: string | undefined; } /** * @public - * @enum - */ -export const MonitoringProblemType = { - BINARY_CLASSIFICATION: "BinaryClassification", - MULTICLASS_CLASSIFICATION: "MulticlassClassification", - REGRESSION: "Regression", -} as const; - -/** - * @public + *

    Contains details regarding the file source.

    */ -export type MonitoringProblemType = (typeof MonitoringProblemType)[keyof typeof MonitoringProblemType]; +export interface FileSource { + /** + * @public + *

    The type of content stored in the file source.

    + */ + ContentType?: string; -/** - * @public - *

    Container image configuration object for the monitoring job.

    - */ -export interface ModelQualityAppSpecification { /** * @public - *

    The address of the container image that the monitoring job runs.

    + *

    The digest of the file source.

    */ - ImageUri: string | undefined; + ContentDigest?: string; /** * @public - *

    Specifies the entrypoint for a container that the monitoring job runs.

    + *

    The Amazon S3 URI for the file source.

    */ - ContainerEntrypoint?: string[]; + S3Uri: string | undefined; +} +/** + * @public + *

    Represents the drift check bias baselines that can be used when the model monitor is set using the + * model package.

    + */ +export interface DriftCheckBias { /** * @public - *

    An array of arguments for the container used to run the monitoring job.

    + *

    The bias config file for a model.

    */ - ContainerArguments?: string[]; + ConfigFile?: FileSource; /** * @public - *

    An Amazon S3 URI to a script that is called per row prior to running analysis. It can - * base64 decode the payload and convert it into a flattened JSON so that the built-in container can use - * the converted data. Applicable only for the built-in (first party) containers.

    + *

    The pre-training constraints.

    */ - RecordPreprocessorSourceUri?: string; + PreTrainingConstraints?: MetricsSource; /** * @public - *

    An Amazon S3 URI to a script that is called after analysis has been performed. Applicable - * only for the built-in (first party) containers.

    + *

    The post-training constraints.

    */ - PostAnalyticsProcessorSourceUri?: string; + PostTrainingConstraints?: MetricsSource; +} +/** + * @public + *

    Represents the drift check explainability baselines that can be used when the model monitor is set + * using the model package.

    + */ +export interface DriftCheckExplainability { /** * @public - *

    The machine learning problem type of the model that the monitoring job monitors.

    + *

    The drift check explainability constraints.

    */ - ProblemType?: MonitoringProblemType; + Constraints?: MetricsSource; /** * @public - *

    Sets the environment variables in the container that the monitoring job runs.

    + *

    The explainability config file for the model.

    */ - Environment?: Record; + ConfigFile?: FileSource; } /** * @public - *

    Configuration for monitoring constraints and monitoring statistics. These baseline resources are - * compared against the results of the current job from the series of jobs scheduled to collect data - * periodically.

    + *

    Represents the drift check data quality baselines that can be used when the model monitor is set using + * the model package.

    */ -export interface ModelQualityBaselineConfig { +export interface DriftCheckModelDataQuality { /** * @public - *

    The name of the job that performs baselining for the monitoring job.

    + *

    The drift check model data quality statistics.

    */ - BaseliningJobName?: string; + Statistics?: MetricsSource; /** * @public - *

    The constraints resource for a monitoring job.

    + *

    The drift check model data quality constraints.

    */ - ConstraintsResource?: MonitoringConstraintsResource; + Constraints?: MetricsSource; } /** * @public - *

    The input for the model quality monitoring job. Currently endpoints are supported for - * input for model quality monitoring jobs.

    + *

    Represents the drift check model quality baselines that can be used when the model monitor is set using + * the model package.

    */ -export interface ModelQualityJobInput { - /** - * @public - *

    Input object for the endpoint

    - */ - EndpointInput?: EndpointInput; - +export interface DriftCheckModelQuality { /** * @public - *

    Input object for the batch transform job.

    + *

    The drift check model quality statistics.

    */ - BatchTransformInput?: BatchTransformInput; + Statistics?: MetricsSource; /** * @public - *

    The ground truth label provided for the model.

    + *

    The drift check model quality constraints.

    */ - GroundTruthS3Input: MonitoringGroundTruthS3Input | undefined; + Constraints?: MetricsSource; } /** * @public + *

    Represents the drift check baselines that can be used when the model monitor is set using the model + * package.

    */ -export interface CreateModelQualityJobDefinitionRequest { - /** - * @public - *

    The name of the monitoring job definition.

    - */ - JobDefinitionName: string | undefined; - +export interface DriftCheckBaselines { /** * @public - *

    Specifies the constraints and baselines for the monitoring job.

    + *

    Represents the drift check bias baselines that can be used when the model monitor is set using the model + * package.

    */ - ModelQualityBaselineConfig?: ModelQualityBaselineConfig; + Bias?: DriftCheckBias; /** * @public - *

    The container that runs the monitoring job.

    + *

    Represents the drift check explainability baselines that can be used when the model monitor is set using + * the model package.

    */ - ModelQualityAppSpecification: ModelQualityAppSpecification | undefined; + Explainability?: DriftCheckExplainability; /** * @public - *

    A list of the inputs that are monitored. Currently endpoints are supported.

    + *

    Represents the drift check model quality baselines that can be used when the model monitor is set using + * the model package.

    */ - ModelQualityJobInput: ModelQualityJobInput | undefined; + ModelQuality?: DriftCheckModelQuality; /** * @public - *

    The output configuration for monitoring jobs.

    + *

    Represents the drift check model data quality baselines that can be used when the model monitor is set + * using the model package.

    */ - ModelQualityJobOutputConfig: MonitoringOutputConfig | undefined; + ModelDataQuality?: DriftCheckModelDataQuality; +} +/** + * @public + *

    Contains explainability metrics for a model.

    + */ +export interface Explainability { /** * @public - *

    Identifies the resources to deploy for a monitoring job.

    + *

    The explainability report for a model.

    */ - JobResources: MonitoringResources | undefined; + Report?: MetricsSource; +} +/** + * @public + *

    Data quality constraints and statistics for a model.

    + */ +export interface ModelDataQuality { /** * @public - *

    Specifies the network configuration for the monitoring job.

    + *

    Data quality statistics for a model.

    */ - NetworkConfig?: MonitoringNetworkConfig; + Statistics?: MetricsSource; /** * @public - *

    The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can - * assume to perform tasks on your behalf.

    + *

    Data quality constraints for a model.

    */ - RoleArn: string | undefined; + Constraints?: MetricsSource; +} +/** + * @public + *

    Model quality statistics and constraints.

    + */ +export interface ModelQuality { /** * @public - *

    A time limit for how long the monitoring job is allowed to run before stopping.

    + *

    Model quality statistics.

    */ - StoppingCondition?: MonitoringStoppingCondition; + Statistics?: MetricsSource; /** * @public - *

    (Optional) An array of key-value pairs. For more information, see - * - * Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

    + *

    Model quality constraints.

    */ - Tags?: Tag[]; + Constraints?: MetricsSource; } /** * @public + *

    Contains metrics captured from a model.

    */ -export interface CreateModelQualityJobDefinitionResponse { +export interface ModelMetrics { /** * @public - *

    The Amazon Resource Name (ARN) of the model quality monitoring job.

    + *

    Metrics that measure the quality of a model.

    */ - JobDefinitionArn: string | undefined; -} + ModelQuality?: ModelQuality; -/** - * @public - *

    Configuration for monitoring constraints and monitoring statistics. These baseline resources are - * compared against the results of the current job from the series of jobs scheduled to collect data - * periodically.

    - */ -export interface MonitoringBaselineConfig { /** * @public - *

    The name of the job that performs baselining for the monitoring job.

    + *

    Metrics that measure the quality of the input data for a model.

    */ - BaseliningJobName?: string; + ModelDataQuality?: ModelDataQuality; /** * @public - *

    The baseline constraint file in Amazon S3 that the current monitoring job should - * validated against.

    + *

    Metrics that measure bais in a model.

    */ - ConstraintsResource?: MonitoringConstraintsResource; + Bias?: Bias; /** * @public - *

    The baseline statistics file in Amazon S3 that the current monitoring job should - * be validated against.

    + *

    Metrics that help explain a model.

    */ - StatisticsResource?: MonitoringStatisticsResource; + Explainability?: Explainability; } /** * @public - *

    Container image configuration object for the monitoring job.

    + * @enum */ -export interface MonitoringAppSpecification { +export const SkipModelValidation = { + ALL: "All", + NONE: "None", +} as const; + +/** + * @public + */ +export type SkipModelValidation = (typeof SkipModelValidation)[keyof typeof SkipModelValidation]; + +/** + * @public + *

    Specifies an algorithm that was used to create the model package. The algorithm must + * be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.

    + */ +export interface SourceAlgorithm { /** * @public - *

    The container image to be run by the monitoring job.

    + *

    The Amazon S3 path where the model artifacts, which result from model training, are stored. + * This path must point to a single gzip compressed tar archive + * (.tar.gz suffix).

    + * + *

    The model artifacts must be in an S3 bucket that is in the same Amazon Web Services + * region as the algorithm.

    + *     */ - ImageUri: string | undefined; + ModelDataUrl?: string; /** * @public - *

    Specifies the entrypoint for a container used to run the monitoring job.

    + *

    The name of an algorithm that was used to create the model package. The algorithm must + * be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.

    */ - ContainerEntrypoint?: string[]; + AlgorithmName: string | undefined; +} +/** + * @public + *

    A list of algorithms that were used to create a model package.

    + */ +export interface SourceAlgorithmSpecification { /** * @public - *

    An array of arguments for the container used to run the monitoring job.

    + *

    A list of the algorithms that were used to create a model package.

    */ - ContainerArguments?: string[]; + SourceAlgorithms: SourceAlgorithm[] | undefined; +} +/** + * @public + *

    Contains data, such as the inputs and targeted instance types that are used in the + * process of validating the model package.

    + *

    The data provided in the validation profile is made available to your buyers on Amazon Web Services + * Marketplace.

    + */ +export interface ModelPackageValidationProfile { /** * @public - *

    An Amazon S3 URI to a script that is called per row prior to running analysis. It can - * base64 decode the payload and convert it into a flattened JSON so that the built-in container can use - * the converted data. Applicable only for the built-in (first party) containers.

    + *

    The name of the profile for the model package.

    */ - RecordPreprocessorSourceUri?: string; + ProfileName: string | undefined; /** * @public - *

    An Amazon S3 URI to a script that is called after analysis has been performed. Applicable - * only for the built-in (first party) containers.

    + *

    The TransformJobDefinition object that describes the transform job used + * for the validation of the model package.

    */ - PostAnalyticsProcessorSourceUri?: string; + TransformJobDefinition: TransformJobDefinition | undefined; } /** * @public - *

    The inputs for a monitoring job.

    + *

    Specifies batch transform jobs that SageMaker runs to validate your model package.

    */ -export interface MonitoringInput { +export interface ModelPackageValidationSpecification { /** * @public - *

    The endpoint for a monitoring job.

    + *

    The IAM roles to be used for the validation of the model package.

    */ - EndpointInput?: EndpointInput; + ValidationRole: string | undefined; /** * @public - *

    Input object for the batch transform job.

    + *

    An array of ModelPackageValidationProfile objects, each of which + * specifies a batch transform job that SageMaker runs to validate your model package.

    */ - BatchTransformInput?: BatchTransformInput; + ValidationProfiles: ModelPackageValidationProfile[] | undefined; } /** * @public - *

    Networking options for a job, such as network traffic encryption between containers, - * whether to allow inbound and outbound network calls to and from containers, and the VPC - * subnets and security groups to use for VPC-enabled jobs.

    */ -export interface NetworkConfig { +export interface CreateModelPackageInput { /** * @public - *

    Whether to encrypt all communications between distributed processing jobs. Choose - * True to encrypt communications. Encryption provides greater security for distributed - * processing jobs, but the processing might take longer.

    + *

    The name of the model package. The name must have 1 to 63 characters. Valid characters + * are a-z, A-Z, 0-9, and - (hyphen).

    + *

    This parameter is required for unversioned models. It is not applicable to versioned + * models.

    */ - EnableInterContainerTrafficEncryption?: boolean; + ModelPackageName?: string; /** * @public - *

    Whether to allow inbound and outbound network calls to and from the containers used for - * the processing job.

    + *

    The name or Amazon Resource Name (ARN) of the model package group that this model version belongs to.

    + *

    This parameter is required for versioned models, and does not apply to unversioned + * models.

    */ - EnableNetworkIsolation?: boolean; + ModelPackageGroupName?: string; /** * @public - *

    Specifies a VPC that your training jobs and hosted models have access to. Control - * access to and from your training and model containers by configuring the VPC. For more - * information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Training Jobs - * by Using an Amazon Virtual Private Cloud.

    + *

    A description of the model package.

    */ - VpcConfig?: VpcConfig; -} + ModelPackageDescription?: string; -/** - * @public - *

    Defines the monitoring job.

    - */ -export interface MonitoringJobDefinition { /** * @public - *

    Baseline configuration used to validate that the data conforms to the specified - * constraints and statistics

    + *

    Specifies details about inference jobs that can be run with models based on this model + * package, including the following:

    + *
      + *
    • + *

      The Amazon ECR paths of containers that contain the inference code and model + * artifacts.

      + *
      • + *
    • + *

      The instance types that the model package supports for transform jobs and + * real-time endpoints used for inference.

      + *
      • + *
    • + *

      The input and output content formats that the model package supports for + * inference.

      + *
      • + *
    */ - BaselineConfig?: MonitoringBaselineConfig; + InferenceSpecification?: InferenceSpecification; /** * @public - *

    The array of inputs for the monitoring job. Currently we support monitoring an Amazon SageMaker Endpoint.

    + *

    Specifies configurations for one or more transform jobs that SageMaker runs to test the + * model package.

    */ - MonitoringInputs: MonitoringInput[] | undefined; + ValidationSpecification?: ModelPackageValidationSpecification; /** * @public - *

    The array of outputs from the monitoring job to be uploaded to Amazon S3.

    + *

    Details about the algorithm that was used to create the model package.

    */ - MonitoringOutputConfig: MonitoringOutputConfig | undefined; + SourceAlgorithmSpecification?: SourceAlgorithmSpecification; /** * @public - *

    Identifies the resources, ML compute instances, and ML storage volumes to deploy for a - * monitoring job. In distributed processing, you specify more than one instance.

    + *

    Whether to certify the model package for listing on Amazon Web Services Marketplace.

    + *

    This parameter is optional for unversioned models, and does not apply to versioned + * models.

    */ - MonitoringResources: MonitoringResources | undefined; + CertifyForMarketplace?: boolean; /** * @public - *

    Configures the monitoring job to run a specified Docker container image.

    + *

    A list of key value pairs associated with the model. For more information, see Tagging Amazon Web Services + * resources in the Amazon Web Services General Reference Guide.

    + *

    If you supply ModelPackageGroupName, your model package belongs to the model group + * you specify and uses the tags associated with the model group. In this case, you cannot + * supply a tag argument. + *

    */ - MonitoringAppSpecification: MonitoringAppSpecification | undefined; + Tags?: Tag[]; /** * @public - *

    Specifies a time limit for how long the monitoring job is allowed to run.

    + *

    Whether the model is approved for deployment.

    + *

    This parameter is optional for versioned models, and does not apply to unversioned + * models.

    + *

    For versioned models, the value of this parameter must be set to Approved + * to deploy the model.

    */ - StoppingCondition?: MonitoringStoppingCondition; + ModelApprovalStatus?: ModelApprovalStatus; /** * @public - *

    Sets the environment variables in the Docker container.

    + *

    Metadata properties of the tracking entity, trial, or trial component.

    */ - Environment?: Record; + MetadataProperties?: MetadataProperties; /** * @public - *

    Specifies networking options for an monitoring job.

    + *

    A structure that contains model metrics reports.

    */ - NetworkConfig?: NetworkConfig; + ModelMetrics?: ModelMetrics; /** * @public - *

    The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can - * assume to perform tasks on your behalf.

    + *

    A unique token that guarantees that the call to this API is idempotent.

    */ - RoleArn: string | undefined; -} - -/** - * @public - * @enum - */ -export const MonitoringType = { - DATA_QUALITY: "DataQuality", - MODEL_BIAS: "ModelBias", - MODEL_EXPLAINABILITY: "ModelExplainability", - MODEL_QUALITY: "ModelQuality", -} as const; + ClientToken?: string; -/** - * @public - */ -export type MonitoringType = (typeof MonitoringType)[keyof typeof MonitoringType]; + /** + * @public + *

    The metadata properties associated with the model package versions.

    + */ + CustomerMetadataProperties?: Record; -/** - * @public - *

    Configuration details about the monitoring schedule.

    - */ -export interface ScheduleConfig { /** * @public - *

    A cron expression that describes details about the monitoring schedule.

    - *

    The supported cron expressions are:

    - *
      - *
    • - *

      If you want to set the job to start every hour, use the following:

      - *

      - * Hourly: cron(0 * ? * * *) - *

      - *
      • - *
    • - *

      If you want to start the job daily:

      - *

      - * cron(0 [00-23] ? * * *) - *

      - *
      • - *
    • - *

      If you want to run the job one time, immediately, use the following - * keyword:

      - *

      - * NOW - *

      - *
      • - *
    - *

    For example, the following are valid cron expressions:

    - *
      - *
    • - *

      Daily at noon UTC: cron(0 12 ? * * *) - *

      - *
      • - *
    • - *

      Daily at midnight UTC: cron(0 0 ? * * *) - *

      - *
      • - *
    - *

    To support running every 6, 12 hours, the following are also supported:

    - *

    - * cron(0 [00-23]/[01-24] ? * * *) - *

    - *

    For example, the following are valid cron expressions:

    - *
      - *
    • - *

      Every 12 hours, starting at 5pm UTC: cron(0 17/12 ? * * *) - *

      - *
      • - *
    • - *

      Every two hours starting at midnight: cron(0 0/2 ? * * *) - *

      - *
      • - *
    - * - *
      - *
    • - *

      Even though the cron expression is set to start at 5PM UTC, note that there - * could be a delay of 0-20 minutes from the actual requested time to run the - * execution.

      - *
      • - *
    • - *

      We recommend that if you would like a daily schedule, you do not provide this - * parameter. Amazon SageMaker will pick a time for running every day.

      - *
      • - *
    - *     - *

    You can also specify the keyword NOW to run the monitoring job immediately, - * one time, without recurring.

    + *

    Represents the drift check baselines that can be used when the model monitor is set using the model package. + * For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide. + *

    */ - ScheduleExpression: string | undefined; + DriftCheckBaselines?: DriftCheckBaselines; /** * @public - *

    Sets the start time for a monitoring job window. Express this time as an offset to the - * times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the - * ScheduleExpression parameter. Specify this offset in ISO 8601 duration - * format. For example, if you want to monitor the five hours of data in your dataset that - * precede the start of each monitoring job, you would specify: "-PT5H".

    - *

    The start time that you specify must not precede the end time that you specify by more - * than 24 hours. You specify the end time with the DataAnalysisEndTime - * parameter.

    - *

    If you set ScheduleExpression to NOW, this parameter is - * required.

    + *

    The machine learning domain of your model package and its components. Common + * machine learning domains include computer vision and natural language processing.

    */ - DataAnalysisStartTime?: string; + Domain?: string; /** * @public - *

    Sets the end time for a monitoring job window. Express this time as an offset to the - * times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the - * ScheduleExpression parameter. Specify this offset in ISO 8601 duration - * format. For example, if you want to end the window one hour before the start of each - * monitoring job, you would specify: "-PT1H".

    - *

    The end time that you specify must not follow the start time that you specify by more - * than 24 hours. You specify the start time with the DataAnalysisStartTime - * parameter.

    - *

    If you set ScheduleExpression to NOW, this parameter is - * required.

    + *

    The machine learning task your model package accomplishes. Common machine + * learning tasks include object detection and image classification. The following + * tasks are supported by Inference Recommender: + * "IMAGE_CLASSIFICATION" | "OBJECT_DETECTION" | "TEXT_GENERATION" |"IMAGE_SEGMENTATION" | + * "FILL_MASK" | "CLASSIFICATION" | "REGRESSION" | "OTHER".

    + *

    Specify "OTHER" if none of the tasks listed fit your use case.

    */ - DataAnalysisEndTime?: string; -} + Task?: string; -/** - * @public - *

    Configures the monitoring schedule and defines the monitoring job.

    - */ -export interface MonitoringScheduleConfig { /** * @public - *

    Configures the monitoring schedule.

    + *

    The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point + * to a single gzip compressed tar archive (.tar.gz suffix). This archive can hold multiple files + * that are all equally used in the load test. Each file in the archive must satisfy the size constraints of the + * InvokeEndpoint call.

    */ - ScheduleConfig?: ScheduleConfig; + SamplePayloadUrl?: string; /** * @public - *

    Defines the monitoring job.

    + *

    An array of additional Inference Specification objects. Each additional + * Inference Specification specifies artifacts based on this model package that can + * be used on inference endpoints. Generally used with SageMaker Neo to store the + * compiled artifacts.

    */ - MonitoringJobDefinition?: MonitoringJobDefinition; + AdditionalInferenceSpecifications?: AdditionalInferenceSpecificationDefinition[]; /** * @public - *

    The name of the monitoring job definition to schedule.

    + *

    Indicates if you want to skip model validation.

    */ - MonitoringJobDefinitionName?: string; + SkipModelValidation?: SkipModelValidation; +} +/** + * @public + */ +export interface CreateModelPackageOutput { /** * @public - *

    The type of the monitoring job definition to schedule.

    + *

    The Amazon Resource Name (ARN) of the new model package.

    */ - MonitoringType?: MonitoringType; + ModelPackageArn: string | undefined; } /** * @public */ -export interface CreateMonitoringScheduleRequest { +export interface CreateModelPackageGroupInput { /** * @public - *

    The name of the monitoring schedule. The name must be unique within an Amazon Web Services - * Region within an Amazon Web Services account.

    + *

    The name of the model group.

    */ - MonitoringScheduleName: string | undefined; + ModelPackageGroupName: string | undefined; /** * @public - *

    The configuration object that specifies the monitoring schedule and defines the monitoring - * job.

    + *

    A description for the model group.

    */ - MonitoringScheduleConfig: MonitoringScheduleConfig | undefined; + ModelPackageGroupDescription?: string; /** * @public - *

    (Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost - * Management User Guide.

    + *

    A list of key value pairs associated with the model group. For more information, see + * Tagging Amazon Web Services + * resources in the Amazon Web Services General Reference Guide.

    */ Tags?: Tag[]; } @@ -9167,2608 +9311,2654 @@ export interface CreateMonitoringScheduleRequest { /** * @public */ -export interface CreateMonitoringScheduleResponse { +export interface CreateModelPackageGroupOutput { /** * @public - *

    The Amazon Resource Name (ARN) of the monitoring schedule.

    + *

    The Amazon Resource Name (ARN) of the model group.

    */ - MonitoringScheduleArn: string | undefined; + ModelPackageGroupArn: string | undefined; } /** * @public * @enum */ -export const NotebookInstanceAcceleratorType = { - ML_EIA1_LARGE: "ml.eia1.large", - ML_EIA1_MEDIUM: "ml.eia1.medium", - ML_EIA1_XLARGE: "ml.eia1.xlarge", - ML_EIA2_LARGE: "ml.eia2.large", - ML_EIA2_MEDIUM: "ml.eia2.medium", - ML_EIA2_XLARGE: "ml.eia2.xlarge", +export const MonitoringProblemType = { + BINARY_CLASSIFICATION: "BinaryClassification", + MULTICLASS_CLASSIFICATION: "MulticlassClassification", + REGRESSION: "Regression", } as const; /** * @public */ -export type NotebookInstanceAcceleratorType = - (typeof NotebookInstanceAcceleratorType)[keyof typeof NotebookInstanceAcceleratorType]; - -/** - * @public - * @enum - */ -export const DirectInternetAccess = { - DISABLED: "Disabled", - ENABLED: "Enabled", -} as const; +export type MonitoringProblemType = (typeof MonitoringProblemType)[keyof typeof MonitoringProblemType]; /** * @public + *

    Container image configuration object for the monitoring job.

    */ -export type DirectInternetAccess = (typeof DirectInternetAccess)[keyof typeof DirectInternetAccess]; +export interface ModelQualityAppSpecification { + /** + * @public + *

    The address of the container image that the monitoring job runs.

    + */ + ImageUri: string | undefined; -/** - * @public - *

    Information on the IMDS configuration of the notebook instance

    - */ -export interface InstanceMetadataServiceConfiguration { /** * @public - *

    Indicates the minimum IMDS version that the notebook instance supports. When passed as part of CreateNotebookInstance, if no value is selected, then it defaults to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part of UpdateNotebookInstance, there is no default.

    + *

    Specifies the entrypoint for a container that the monitoring job runs.

    */ - MinimumInstanceMetadataServiceVersion: string | undefined; -} + ContainerEntrypoint?: string[]; -/** - * @public - * @enum - */ -export const RootAccess = { - DISABLED: "Disabled", - ENABLED: "Enabled", -} as const; + /** + * @public + *

    An array of arguments for the container used to run the monitoring job.

    + */ + ContainerArguments?: string[]; -/** - * @public - */ -export type RootAccess = (typeof RootAccess)[keyof typeof RootAccess]; + /** + * @public + *

    An Amazon S3 URI to a script that is called per row prior to running analysis. It can + * base64 decode the payload and convert it into a flattened JSON so that the built-in container can use + * the converted data. Applicable only for the built-in (first party) containers.

    + */ + RecordPreprocessorSourceUri?: string; -/** - * @public - */ -export interface CreateNotebookInstanceInput { /** * @public - *

    The name of the new notebook instance.

    + *

    An Amazon S3 URI to a script that is called after analysis has been performed. Applicable + * only for the built-in (first party) containers.

    */ - NotebookInstanceName: string | undefined; + PostAnalyticsProcessorSourceUri?: string; /** * @public - *

    The type of ML compute instance to launch for the notebook instance.

    + *

    The machine learning problem type of the model that the monitoring job monitors.

    */ - InstanceType: _InstanceType | undefined; + ProblemType?: MonitoringProblemType; /** * @public - *

    The ID of the subnet in a VPC to which you would like to have a connectivity from - * your ML compute instance.

    + *

    Sets the environment variables in the container that the monitoring job runs.

    */ - SubnetId?: string; + Environment?: Record; +} +/** + * @public + *

    Configuration for monitoring constraints and monitoring statistics. These baseline resources are + * compared against the results of the current job from the series of jobs scheduled to collect data + * periodically.

    + */ +export interface ModelQualityBaselineConfig { /** * @public - *

    The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be - * for the same VPC as specified in the subnet.

    + *

    The name of the job that performs baselining for the monitoring job.

    */ - SecurityGroupIds?: string[]; + BaseliningJobName?: string; /** * @public - *

    When you send any requests to Amazon Web Services resources from the notebook - * instance, SageMaker assumes this role to perform tasks on your behalf. You must grant this - * role necessary permissions so SageMaker can perform these tasks. The policy must allow the - * SageMaker service principal (sagemaker.amazonaws.com) permissions to assume this role. For - * more information, see SageMaker Roles.

    - * - *

    To be able to pass this role to SageMaker, the caller of this API must have the - * iam:PassRole permission.

    - *     + *

    The constraints resource for a monitoring job.

    */ - RoleArn: string | undefined; + ConstraintsResource?: MonitoringConstraintsResource; +} +/** + * @public + *

    The input for the model quality monitoring job. Currently endpoints are supported for + * input for model quality monitoring jobs.

    + */ +export interface ModelQualityJobInput { /** * @public - *

    The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that - * SageMaker uses to encrypt data on the storage volume attached to your notebook instance. The - * KMS key you provide must be enabled. For information, see Enabling and Disabling - * Keys in the Amazon Web Services Key Management Service Developer - * Guide.

    + *

    Input object for the endpoint

    */ - KmsKeyId?: string; + EndpointInput?: EndpointInput; /** * @public - *

    An array of key-value pairs. You can use tags to categorize your Amazon Web Services - * resources in different ways, for example, by purpose, owner, or environment. For more - * information, see Tagging Amazon Web Services Resources.

    + *

    Input object for the batch transform job.

    */ - Tags?: Tag[]; + BatchTransformInput?: BatchTransformInput; /** * @public - *

    The name of a lifecycle configuration to associate with the notebook instance. For - * information about lifestyle configurations, see Step 2.1: (Optional) - * Customize a Notebook Instance.

    + *

    The ground truth label provided for the model.

    */ - LifecycleConfigName?: string; + GroundTruthS3Input: MonitoringGroundTruthS3Input | undefined; +} +/** + * @public + */ +export interface CreateModelQualityJobDefinitionRequest { /** * @public - *

    Sets whether SageMaker provides internet access to the notebook instance. If you set this - * to Disabled this notebook instance is able to access resources only in your - * VPC, and is not be able to connect to SageMaker training and endpoint services unless you - * configure a NAT Gateway in your VPC.

    - *

    For more information, see Notebook Instances Are Internet-Enabled by Default. You can set the value - * of this parameter to Disabled only if you set a value for the - * SubnetId parameter.

    + *

    The name of the monitoring job definition.

    */ - DirectInternetAccess?: DirectInternetAccess; + JobDefinitionName: string | undefined; /** * @public - *

    The size, in GB, of the ML storage volume to attach to the notebook instance. The - * default value is 5 GB.

    + *

    Specifies the constraints and baselines for the monitoring job.

    */ - VolumeSizeInGB?: number; + ModelQualityBaselineConfig?: ModelQualityBaselineConfig; /** * @public - *

    A list of Elastic Inference (EI) instance types to associate with this notebook - * instance. Currently, only one instance type can be associated with a notebook instance. - * For more information, see Using Elastic Inference in Amazon SageMaker.

    + *

    The container that runs the monitoring job.

    */ - AcceleratorTypes?: NotebookInstanceAcceleratorType[]; + ModelQualityAppSpecification: ModelQualityAppSpecification | undefined; /** * @public - *

    A Git repository to associate with the notebook instance as its default code - * repository. This can be either the name of a Git repository stored as a resource in your - * account, or the URL of a Git repository in Amazon Web Services CodeCommit - * or in any other Git repository. When you open a notebook instance, it opens in the - * directory that contains this repository. For more information, see Associating Git - * Repositories with SageMaker Notebook Instances.

    + *

    A list of the inputs that are monitored. Currently endpoints are supported.

    */ - DefaultCodeRepository?: string; + ModelQualityJobInput: ModelQualityJobInput | undefined; /** * @public - *

    An array of up to three Git repositories to associate with the notebook instance. - * These can be either the names of Git repositories stored as resources in your account, - * or the URL of Git repositories in Amazon Web Services CodeCommit - * or in any other Git repository. These repositories are cloned at the same level as the - * default repository of your notebook instance. For more information, see Associating Git - * Repositories with SageMaker Notebook Instances.

    + *

    The output configuration for monitoring jobs.

    */ - AdditionalCodeRepositories?: string[]; + ModelQualityJobOutputConfig: MonitoringOutputConfig | undefined; /** * @public - *

    Whether root access is enabled or disabled for users of the notebook instance. The - * default value is Enabled.

    - * - *

    Lifecycle configurations need root access to be able to set up a notebook - * instance. Because of this, lifecycle configurations associated with a notebook - * instance always run with root access even if you disable root access for - * users.

    - *     + *

    Identifies the resources to deploy for a monitoring job.

    + */ + JobResources: MonitoringResources | undefined; + + /** + * @public + *

    Specifies the network configuration for the monitoring job.

    */ - RootAccess?: RootAccess; + NetworkConfig?: MonitoringNetworkConfig; /** * @public - *

    The platform identifier of the notebook instance runtime environment.

    + *

    The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can + * assume to perform tasks on your behalf.

    */ - PlatformIdentifier?: string; + RoleArn: string | undefined; /** * @public - *

    Information on the IMDS configuration of the notebook instance

    + *

    A time limit for how long the monitoring job is allowed to run before stopping.

    */ - InstanceMetadataServiceConfiguration?: InstanceMetadataServiceConfiguration; -} + StoppingCondition?: MonitoringStoppingCondition; -/** - * @public - */ -export interface CreateNotebookInstanceOutput { /** * @public - *

    The Amazon Resource Name (ARN) of the notebook instance.

    + *

    (Optional) An array of key-value pairs. For more information, see + * + * Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

    */ - NotebookInstanceArn?: string; + Tags?: Tag[]; } /** * @public - *

    Contains the notebook instance lifecycle configuration script.

    - *

    Each lifecycle configuration script has a limit of 16384 characters.

    - *

    The value of the $PATH environment variable that is available to both - * scripts is /sbin:bin:/usr/sbin:/usr/bin.

    - *

    View CloudWatch Logs for notebook instance lifecycle configurations in log group - * /aws/sagemaker/NotebookInstances in log stream - * [notebook-instance-name]/[LifecycleConfigHook].

    - *

    Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs - * for longer than 5 minutes, it fails and the notebook instance is not created or - * started.

    - *

    For information about notebook instance lifestyle configurations, see Step - * 2.1: (Optional) Customize a Notebook Instance.

    */ -export interface NotebookInstanceLifecycleHook { +export interface CreateModelQualityJobDefinitionResponse { /** * @public - *

    A base64-encoded string that contains a shell script for a notebook instance lifecycle - * configuration.

    + *

    The Amazon Resource Name (ARN) of the model quality monitoring job.

    */ - Content?: string; + JobDefinitionArn: string | undefined; } /** * @public + *

    Configuration for monitoring constraints and monitoring statistics. These baseline resources are + * compared against the results of the current job from the series of jobs scheduled to collect data + * periodically.

    */ -export interface CreateNotebookInstanceLifecycleConfigInput { +export interface MonitoringBaselineConfig { /** * @public - *

    The name of the lifecycle configuration.

    + *

    The name of the job that performs baselining for the monitoring job.

    */ - NotebookInstanceLifecycleConfigName: string | undefined; + BaseliningJobName?: string; /** * @public - *

    A shell script that runs only once, when you create a notebook instance. The shell - * script must be a base64-encoded string.

    + *

    The baseline constraint file in Amazon S3 that the current monitoring job should + * validated against.

    */ - OnCreate?: NotebookInstanceLifecycleHook[]; + ConstraintsResource?: MonitoringConstraintsResource; /** * @public - *

    A shell script that runs every time you start a notebook instance, including when you - * create the notebook instance. The shell script must be a base64-encoded string.

    + *

    The baseline statistics file in Amazon S3 that the current monitoring job should + * be validated against.

    */ - OnStart?: NotebookInstanceLifecycleHook[]; + StatisticsResource?: MonitoringStatisticsResource; } /** * @public + *

    Container image configuration object for the monitoring job.

    */ -export interface CreateNotebookInstanceLifecycleConfigOutput { +export interface MonitoringAppSpecification { /** * @public - *

    The Amazon Resource Name (ARN) of the lifecycle configuration.

    + *

    The container image to be run by the monitoring job.

    */ - NotebookInstanceLifecycleConfigArn?: string; + ImageUri: string | undefined; + + /** + * @public + *

    Specifies the entrypoint for a container used to run the monitoring job.

    + */ + ContainerEntrypoint?: string[]; + + /** + * @public + *

    An array of arguments for the container used to run the monitoring job.

    + */ + ContainerArguments?: string[]; + + /** + * @public + *

    An Amazon S3 URI to a script that is called per row prior to running analysis. It can + * base64 decode the payload and convert it into a flattened JSON so that the built-in container can use + * the converted data. Applicable only for the built-in (first party) containers.

    + */ + RecordPreprocessorSourceUri?: string; + + /** + * @public + *

    An Amazon S3 URI to a script that is called after analysis has been performed. Applicable + * only for the built-in (first party) containers.

    + */ + PostAnalyticsProcessorSourceUri?: string; } /** * @public - *

    Configuration that controls the parallelism of the pipeline. - * By default, the parallelism configuration specified applies to all - * executions of the pipeline unless overridden.

    + *

    The inputs for a monitoring job.

    */ -export interface ParallelismConfiguration { +export interface MonitoringInput { /** * @public - *

    The max number of steps that can be executed in parallel.

    + *

    The endpoint for a monitoring job.

    */ - MaxParallelExecutionSteps: number | undefined; + EndpointInput?: EndpointInput; + + /** + * @public + *

    Input object for the batch transform job.

    + */ + BatchTransformInput?: BatchTransformInput; } /** * @public - *

    The location of the pipeline definition stored in Amazon S3.

    + *

    Networking options for a job, such as network traffic encryption between containers, + * whether to allow inbound and outbound network calls to and from containers, and the VPC + * subnets and security groups to use for VPC-enabled jobs.

    */ -export interface PipelineDefinitionS3Location { +export interface NetworkConfig { /** * @public - *

    Name of the S3 bucket.

    + *

    Whether to encrypt all communications between distributed processing jobs. Choose + * True to encrypt communications. Encryption provides greater security for distributed + * processing jobs, but the processing might take longer.

    */ - Bucket: string | undefined; + EnableInterContainerTrafficEncryption?: boolean; /** * @public - *

    The object key (or key name) uniquely identifies the - * object in an S3 bucket.

    + *

    Whether to allow inbound and outbound network calls to and from the containers used for + * the processing job.

    */ - ObjectKey: string | undefined; + EnableNetworkIsolation?: boolean; /** * @public - *

    Version Id of the pipeline definition file. If not specified, Amazon SageMaker - * will retrieve the latest version.

    + *

    Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources + * have access to. You can control access to and from your resources by configuring a VPC. + * For more information, see Give SageMaker Access to Resources in your Amazon VPC.

    */ - VersionId?: string; + VpcConfig?: VpcConfig; } /** * @public + *

    Defines the monitoring job.

    */ -export interface CreatePipelineRequest { +export interface MonitoringJobDefinition { /** * @public - *

    The name of the pipeline.

    + *

    Baseline configuration used to validate that the data conforms to the specified + * constraints and statistics

    */ - PipelineName: string | undefined; + BaselineConfig?: MonitoringBaselineConfig; /** * @public - *

    The display name of the pipeline.

    + *

    The array of inputs for the monitoring job. Currently we support monitoring an Amazon SageMaker Endpoint.

    */ - PipelineDisplayName?: string; + MonitoringInputs: MonitoringInput[] | undefined; /** * @public - *

    The JSON - * pipeline definition of the pipeline.

    + *

    The array of outputs from the monitoring job to be uploaded to Amazon S3.

    */ - PipelineDefinition?: string; + MonitoringOutputConfig: MonitoringOutputConfig | undefined; /** * @public - *

    The location of the pipeline definition stored in Amazon S3. If specified, - * SageMaker will retrieve the pipeline definition from this location.

    + *

    Identifies the resources, ML compute instances, and ML storage volumes to deploy for a + * monitoring job. In distributed processing, you specify more than one instance.

    */ - PipelineDefinitionS3Location?: PipelineDefinitionS3Location; + MonitoringResources: MonitoringResources | undefined; /** * @public - *

    A description of the pipeline.

    + *

    Configures the monitoring job to run a specified Docker container image.

    */ - PipelineDescription?: string; + MonitoringAppSpecification: MonitoringAppSpecification | undefined; /** * @public - *

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the - * operation. An idempotent operation completes no more than one time.

    + *

    Specifies a time limit for how long the monitoring job is allowed to run.

    */ - ClientRequestToken?: string; + StoppingCondition?: MonitoringStoppingCondition; /** * @public - *

    The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources.

    + *

    Sets the environment variables in the Docker container.

    + */ + Environment?: Record; + + /** + * @public + *

    Specifies networking options for an monitoring job.

    + */ + NetworkConfig?: NetworkConfig; + + /** + * @public + *

    The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can + * assume to perform tasks on your behalf.

    */ RoleArn: string | undefined; +} + +/** + * @public + * @enum + */ +export const MonitoringType = { + DATA_QUALITY: "DataQuality", + MODEL_BIAS: "ModelBias", + MODEL_EXPLAINABILITY: "ModelExplainability", + MODEL_QUALITY: "ModelQuality", +} as const; + +/** + * @public + */ +export type MonitoringType = (typeof MonitoringType)[keyof typeof MonitoringType]; +/** + * @public + *

    Configuration details about the monitoring schedule.

    + */ +export interface ScheduleConfig { /** * @public - *

    A list of tags to apply to the created pipeline.

    + *

    A cron expression that describes details about the monitoring schedule.

    + *

    The supported cron expressions are:

    + *
      + *
    • + *

      If you want to set the job to start every hour, use the following:

      + *

      + * Hourly: cron(0 * ? * * *) + *

      + *
      • + *
    • + *

      If you want to start the job daily:

      + *

      + * cron(0 [00-23] ? * * *) + *

      + *
      • + *
    • + *

      If you want to run the job one time, immediately, use the following + * keyword:

      + *

      + * NOW + *

      + *
      • + *
    + *

    For example, the following are valid cron expressions:

    + *
      + *
    • + *

      Daily at noon UTC: cron(0 12 ? * * *) + *

      + *
      • + *
    • + *

      Daily at midnight UTC: cron(0 0 ? * * *) + *

      + *
      • + *
    + *

    To support running every 6, 12 hours, the following are also supported:

    + *

    + * cron(0 [00-23]/[01-24] ? * * *) + *

    + *

    For example, the following are valid cron expressions:

    + *
      + *
    • + *

      Every 12 hours, starting at 5pm UTC: cron(0 17/12 ? * * *) + *

      + *
      • + *
    • + *

      Every two hours starting at midnight: cron(0 0/2 ? * * *) + *

      + *
      • + *
    + * + *
      + *
    • + *

      Even though the cron expression is set to start at 5PM UTC, note that there + * could be a delay of 0-20 minutes from the actual requested time to run the + * execution.

      + *
      • + *
    • + *

      We recommend that if you would like a daily schedule, you do not provide this + * parameter. Amazon SageMaker will pick a time for running every day.

      + *
      • + *
    + *     + *

    You can also specify the keyword NOW to run the monitoring job immediately, + * one time, without recurring.

    */ - Tags?: Tag[]; + ScheduleExpression: string | undefined; /** * @public - *

    This is the configuration that controls the parallelism of the pipeline. - * If specified, it applies to all runs of this pipeline by default.

    + *

    Sets the start time for a monitoring job window. Express this time as an offset to the + * times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the + * ScheduleExpression parameter. Specify this offset in ISO 8601 duration + * format. For example, if you want to monitor the five hours of data in your dataset that + * precede the start of each monitoring job, you would specify: "-PT5H".

    + *

    The start time that you specify must not precede the end time that you specify by more + * than 24 hours. You specify the end time with the DataAnalysisEndTime + * parameter.

    + *

    If you set ScheduleExpression to NOW, this parameter is + * required.

    */ - ParallelismConfiguration?: ParallelismConfiguration; -} + DataAnalysisStartTime?: string; -/** - * @public - */ -export interface CreatePipelineResponse { /** * @public - *

    The Amazon Resource Name (ARN) of the created pipeline.

    + *

    Sets the end time for a monitoring job window. Express this time as an offset to the + * times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the + * ScheduleExpression parameter. Specify this offset in ISO 8601 duration + * format. For example, if you want to end the window one hour before the start of each + * monitoring job, you would specify: "-PT1H".

    + *

    The end time that you specify must not follow the start time that you specify by more + * than 24 hours. You specify the start time with the DataAnalysisStartTime + * parameter.

    + *

    If you set ScheduleExpression to NOW, this parameter is + * required.

    */ - PipelineArn?: string; + DataAnalysisEndTime?: string; } /** * @public + *

    Configures the monitoring schedule and defines the monitoring job.

    */ -export interface CreatePresignedDomainUrlRequest { - /** - * @public - *

    The domain ID.

    - */ - DomainId: string | undefined; - - /** - * @public - *

    The name of the UserProfile to sign-in as.

    - */ - UserProfileName: string | undefined; - +export interface MonitoringScheduleConfig { /** * @public - *

    The session expiration duration in seconds. This value defaults to 43200.

    + *

    Configures the monitoring schedule.

    */ - SessionExpirationDurationInSeconds?: number; + ScheduleConfig?: ScheduleConfig; /** * @public - *

    The number of seconds until the pre-signed URL expires. This value defaults to - * 300.

    + *

    Defines the monitoring job.

    */ - ExpiresInSeconds?: number; + MonitoringJobDefinition?: MonitoringJobDefinition; /** * @public - *

    The name of the space.

    + *

    The name of the monitoring job definition to schedule.

    */ - SpaceName?: string; -} + MonitoringJobDefinitionName?: string; -/** - * @public - */ -export interface CreatePresignedDomainUrlResponse { /** * @public - *

    The presigned URL.

    + *

    The type of the monitoring job definition to schedule.

    */ - AuthorizedUrl?: string; + MonitoringType?: MonitoringType; } /** * @public */ -export interface CreatePresignedNotebookInstanceUrlInput { +export interface CreateMonitoringScheduleRequest { /** * @public - *

    The name of the notebook instance.

    + *

    The name of the monitoring schedule. The name must be unique within an Amazon Web Services + * Region within an Amazon Web Services account.

    */ - NotebookInstanceName: string | undefined; + MonitoringScheduleName: string | undefined; /** * @public - *

    The duration of the session, in seconds. The default is 12 hours.

    + *

    The configuration object that specifies the monitoring schedule and defines the monitoring + * job.

    */ - SessionExpirationDurationInSeconds?: number; -} + MonitoringScheduleConfig: MonitoringScheduleConfig | undefined; -/** - * @public - */ -export interface CreatePresignedNotebookInstanceUrlOutput { /** * @public - *

    A JSON object that contains the URL string.

    + *

    (Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost + * Management User Guide.

    */ - AuthorizedUrl?: string; + Tags?: Tag[]; } /** * @public - *

    Associates a SageMaker job as a trial component with an experiment and trial. Specified when - * you call the following APIs:

    - * */ -export interface ExperimentConfig { - /** - * @public - *

    The name of an existing experiment to associate with the trial component.

    - */ - ExperimentName?: string; - - /** - * @public - *

    The name of an existing trial to associate the trial component with. If not specified, a - * new trial is created.

    - */ - TrialName?: string; - - /** - * @public - *

    The display name for the trial component. If this key isn't specified, the display name is - * the trial component name.

    - */ - TrialComponentDisplayName?: string; - +export interface CreateMonitoringScheduleResponse { /** * @public - *

    The name of the experiment run to associate with the trial component.

    + *

    The Amazon Resource Name (ARN) of the monitoring schedule.

    */ - RunName?: string; + MonitoringScheduleArn: string | undefined; } /** * @public * @enum */ -export const DataDistributionType = { - FULLYREPLICATED: "FullyReplicated", - SHARDEDBYS3KEY: "ShardedByS3Key", +export const NotebookInstanceAcceleratorType = { + ML_EIA1_LARGE: "ml.eia1.large", + ML_EIA1_MEDIUM: "ml.eia1.medium", + ML_EIA1_XLARGE: "ml.eia1.xlarge", + ML_EIA2_LARGE: "ml.eia2.large", + ML_EIA2_MEDIUM: "ml.eia2.medium", + ML_EIA2_XLARGE: "ml.eia2.xlarge", } as const; /** * @public */ -export type DataDistributionType = (typeof DataDistributionType)[keyof typeof DataDistributionType]; +export type NotebookInstanceAcceleratorType = + (typeof NotebookInstanceAcceleratorType)[keyof typeof NotebookInstanceAcceleratorType]; /** * @public * @enum */ -export const InputMode = { - FILE: "File", - PIPE: "Pipe", +export const DirectInternetAccess = { + DISABLED: "Disabled", + ENABLED: "Enabled", } as const; /** * @public */ -export type InputMode = (typeof InputMode)[keyof typeof InputMode]; +export type DirectInternetAccess = (typeof DirectInternetAccess)[keyof typeof DirectInternetAccess]; /** * @public - * @enum + *

    Information on the IMDS configuration of the notebook instance

    */ -export const RedshiftResultCompressionType = { - BZIP2: "BZIP2", - GZIP: "GZIP", - NONE: "None", - SNAPPY: "SNAPPY", - ZSTD: "ZSTD", -} as const; +export interface InstanceMetadataServiceConfiguration { + /** + * @public + *

    Indicates the minimum IMDS version that the notebook instance supports. When passed as part of CreateNotebookInstance, if no value is selected, then it defaults to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part of UpdateNotebookInstance, there is no default.

    + */ + MinimumInstanceMetadataServiceVersion: string | undefined; +} /** * @public + * @enum */ -export type RedshiftResultCompressionType = - (typeof RedshiftResultCompressionType)[keyof typeof RedshiftResultCompressionType]; +export const RootAccess = { + DISABLED: "Disabled", + ENABLED: "Enabled", +} as const; /** * @public - * @enum */ -export const RedshiftResultFormat = { - CSV: "CSV", - PARQUET: "PARQUET", -} as const; +export type RootAccess = (typeof RootAccess)[keyof typeof RootAccess]; /** * @public */ -export type RedshiftResultFormat = (typeof RedshiftResultFormat)[keyof typeof RedshiftResultFormat]; +export interface CreateNotebookInstanceInput { + /** + * @public + *

    The name of the new notebook instance.

    + */ + NotebookInstanceName: string | undefined; + + /** + * @public + *

    The type of ML compute instance to launch for the notebook instance.

    + */ + InstanceType: _InstanceType | undefined; + + /** + * @public + *

    The ID of the subnet in a VPC to which you would like to have a connectivity from + * your ML compute instance.

    + */ + SubnetId?: string; + + /** + * @public + *

    The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be + * for the same VPC as specified in the subnet.

    + */ + SecurityGroupIds?: string[]; + + /** + * @public + *

    When you send any requests to Amazon Web Services resources from the notebook + * instance, SageMaker assumes this role to perform tasks on your behalf. You must grant this + * role necessary permissions so SageMaker can perform these tasks. The policy must allow the + * SageMaker service principal (sagemaker.amazonaws.com) permissions to assume this role. For + * more information, see SageMaker Roles.

    + * + *

    To be able to pass this role to SageMaker, the caller of this API must have the + * iam:PassRole permission.

    + *     + */ + RoleArn: string | undefined; + + /** + * @public + *

    The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that + * SageMaker uses to encrypt data on the storage volume attached to your notebook instance. The + * KMS key you provide must be enabled. For information, see Enabling and Disabling + * Keys in the Amazon Web Services Key Management Service Developer + * Guide.

    + */ + KmsKeyId?: string; + + /** + * @public + *

    An array of key-value pairs. You can use tags to categorize your Amazon Web Services + * resources in different ways, for example, by purpose, owner, or environment. For more + * information, see Tagging Amazon Web Services Resources.

    + */ + Tags?: Tag[]; -/** - * @public - *

    Configuration for Redshift Dataset Definition input.

    - */ -export interface RedshiftDatasetDefinition { /** * @public - *

    The Redshift cluster Identifier.

    + *

    The name of a lifecycle configuration to associate with the notebook instance. For + * information about lifestyle configurations, see Step 2.1: (Optional) + * Customize a Notebook Instance.

    */ - ClusterId: string | undefined; + LifecycleConfigName?: string; /** * @public - *

    The name of the Redshift database used in Redshift query execution.

    + *

    Sets whether SageMaker provides internet access to the notebook instance. If you set this + * to Disabled this notebook instance is able to access resources only in your + * VPC, and is not be able to connect to SageMaker training and endpoint services unless you + * configure a NAT Gateway in your VPC.

    + *

    For more information, see Notebook Instances Are Internet-Enabled by Default. You can set the value + * of this parameter to Disabled only if you set a value for the + * SubnetId parameter.

    */ - Database: string | undefined; + DirectInternetAccess?: DirectInternetAccess; /** * @public - *

    The database user name used in Redshift query execution.

    + *

    The size, in GB, of the ML storage volume to attach to the notebook instance. The + * default value is 5 GB.

    */ - DbUser: string | undefined; + VolumeSizeInGB?: number; /** * @public - *

    The SQL query statements to be executed.

    + *

    A list of Elastic Inference (EI) instance types to associate with this notebook + * instance. Currently, only one instance type can be associated with a notebook instance. + * For more information, see Using Elastic Inference in Amazon SageMaker.

    */ - QueryString: string | undefined; + AcceleratorTypes?: NotebookInstanceAcceleratorType[]; /** * @public - *

    The IAM role attached to your Redshift cluster that Amazon SageMaker uses to generate datasets.

    + *

    A Git repository to associate with the notebook instance as its default code + * repository. This can be either the name of a Git repository stored as a resource in your + * account, or the URL of a Git repository in Amazon Web Services CodeCommit + * or in any other Git repository. When you open a notebook instance, it opens in the + * directory that contains this repository. For more information, see Associating Git + * Repositories with SageMaker Notebook Instances.

    */ - ClusterRoleArn: string | undefined; + DefaultCodeRepository?: string; /** * @public - *

    The location in Amazon S3 where the Redshift query results are stored.

    + *

    An array of up to three Git repositories to associate with the notebook instance. + * These can be either the names of Git repositories stored as resources in your account, + * or the URL of Git repositories in Amazon Web Services CodeCommit + * or in any other Git repository. These repositories are cloned at the same level as the + * default repository of your notebook instance. For more information, see Associating Git + * Repositories with SageMaker Notebook Instances.

    */ - OutputS3Uri: string | undefined; + AdditionalCodeRepositories?: string[]; /** * @public - *

    The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data from a - * Redshift execution.

    + *

    Whether root access is enabled or disabled for users of the notebook instance. The + * default value is Enabled.

    + * + *

    Lifecycle configurations need root access to be able to set up a notebook + * instance. Because of this, lifecycle configurations associated with a notebook + * instance always run with root access even if you disable root access for + * users.

    + *     */ - KmsKeyId?: string; + RootAccess?: RootAccess; /** * @public - *

    The data storage format for Redshift query results.

    + *

    The platform identifier of the notebook instance runtime environment.

    */ - OutputFormat: RedshiftResultFormat | undefined; + PlatformIdentifier?: string; /** * @public - *

    The compression used for Redshift query results.

    + *

    Information on the IMDS configuration of the notebook instance

    */ - OutputCompression?: RedshiftResultCompressionType; + InstanceMetadataServiceConfiguration?: InstanceMetadataServiceConfiguration; } /** * @public - *

    Configuration for Dataset Definition inputs. The Dataset Definition input must specify - * exactly one of either AthenaDatasetDefinition or RedshiftDatasetDefinition - * types.

    */ -export interface DatasetDefinition { +export interface CreateNotebookInstanceOutput { /** * @public - *

    Configuration for Athena Dataset Definition input.

    + *

    The Amazon Resource Name (ARN) of the notebook instance.

    */ - AthenaDatasetDefinition?: AthenaDatasetDefinition; + NotebookInstanceArn?: string; +} +/** + * @public + *

    Contains the notebook instance lifecycle configuration script.

    + *

    Each lifecycle configuration script has a limit of 16384 characters.

    + *

    The value of the $PATH environment variable that is available to both + * scripts is /sbin:bin:/usr/sbin:/usr/bin.

    + *

    View CloudWatch Logs for notebook instance lifecycle configurations in log group + * /aws/sagemaker/NotebookInstances in log stream + * [notebook-instance-name]/[LifecycleConfigHook].

    + *

    Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs + * for longer than 5 minutes, it fails and the notebook instance is not created or + * started.

    + *

    For information about notebook instance lifestyle configurations, see Step + * 2.1: (Optional) Customize a Notebook Instance.

    + */ +export interface NotebookInstanceLifecycleHook { /** * @public - *

    Configuration for Redshift Dataset Definition input.

    + *

    A base64-encoded string that contains a shell script for a notebook instance lifecycle + * configuration.

    */ - RedshiftDatasetDefinition?: RedshiftDatasetDefinition; + Content?: string; +} +/** + * @public + */ +export interface CreateNotebookInstanceLifecycleConfigInput { /** * @public - *

    The local path where you want Amazon SageMaker to download the Dataset Definition inputs to run a - * processing job. LocalPath is an absolute path to the input data. This is a required - * parameter when AppManaged is False (default).

    + *

    The name of the lifecycle configuration.

    */ - LocalPath?: string; + NotebookInstanceLifecycleConfigName: string | undefined; /** * @public - *

    Whether the generated dataset is FullyReplicated or - * ShardedByS3Key (default).

    + *

    A shell script that runs only once, when you create a notebook instance. The shell + * script must be a base64-encoded string.

    */ - DataDistributionType?: DataDistributionType; + OnCreate?: NotebookInstanceLifecycleHook[]; /** * @public - *

    Whether to use File or Pipe input mode. In File (default) mode, - * Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store - * (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used - * input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your - * algorithm without using the EBS volume.

    + *

    A shell script that runs every time you start a notebook instance, including when you + * create the notebook instance. The shell script must be a base64-encoded string.

    */ - InputMode?: InputMode; + OnStart?: NotebookInstanceLifecycleHook[]; } /** * @public - * @enum */ -export const ProcessingS3CompressionType = { - GZIP: "Gzip", - NONE: "None", -} as const; +export interface CreateNotebookInstanceLifecycleConfigOutput { + /** + * @public + *

    The Amazon Resource Name (ARN) of the lifecycle configuration.

    + */ + NotebookInstanceLifecycleConfigArn?: string; +} /** * @public + *

    Configuration that controls the parallelism of the pipeline. + * By default, the parallelism configuration specified applies to all + * executions of the pipeline unless overridden.

    */ -export type ProcessingS3CompressionType = - (typeof ProcessingS3CompressionType)[keyof typeof ProcessingS3CompressionType]; +export interface ParallelismConfiguration { + /** + * @public + *

    The max number of steps that can be executed in parallel.

    + */ + MaxParallelExecutionSteps: number | undefined; +} /** * @public - * @enum + *

    The location of the pipeline definition stored in Amazon S3.

    */ -export const ProcessingS3DataType = { - MANIFEST_FILE: "ManifestFile", - S3_PREFIX: "S3Prefix", -} as const; +export interface PipelineDefinitionS3Location { + /** + * @public + *

    Name of the S3 bucket.

    + */ + Bucket: string | undefined; -/** - * @public - */ -export type ProcessingS3DataType = (typeof ProcessingS3DataType)[keyof typeof ProcessingS3DataType]; + /** + * @public + *

    The object key (or key name) uniquely identifies the + * object in an S3 bucket.

    + */ + ObjectKey: string | undefined; -/** - * @public - *

    Configuration for downloading input data from Amazon S3 into the processing container.

    - */ -export interface ProcessingS3Input { /** * @public - *

    The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.

    + *

    Version Id of the pipeline definition file. If not specified, Amazon SageMaker + * will retrieve the latest version.

    */ - S3Uri: string | undefined; + VersionId?: string; +} +/** + * @public + */ +export interface CreatePipelineRequest { /** * @public - *

    The local path in your container where you want Amazon SageMaker to write input data to. - * LocalPath is an absolute path to the input data and must begin with - * /opt/ml/processing/. LocalPath is a required - * parameter when AppManaged is False (default).

    + *

    The name of the pipeline.

    */ - LocalPath?: string; + PipelineName: string | undefined; /** * @public - *

    Whether you use an S3Prefix or a ManifestFile for - * the data type. If you choose S3Prefix, S3Uri identifies a key - * name prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing - * job. If you choose ManifestFile, S3Uri identifies an object - * that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for - * the processing job.

    + *

    The display name of the pipeline.

    */ - S3DataType: ProcessingS3DataType | undefined; + PipelineDisplayName?: string; /** * @public - *

    Whether to use File or Pipe input mode. In File mode, Amazon SageMaker copies the data - * from the input source onto the local ML storage volume before starting your processing - * container. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker - * streams input data from the source directly to your processing container into named - * pipes without using the ML storage volume.

    + *

    The JSON + * pipeline definition of the pipeline.

    */ - S3InputMode?: ProcessingS3InputMode; + PipelineDefinition?: string; /** * @public - *

    Whether to distribute the data from Amazon S3 to all processing instances with - * FullyReplicated, or whether the data from Amazon S3 is shared by Amazon S3 key, - * downloading one shard of data to each processing instance.

    + *

    The location of the pipeline definition stored in Amazon S3. If specified, + * SageMaker will retrieve the pipeline definition from this location.

    */ - S3DataDistributionType?: ProcessingS3DataDistributionType; + PipelineDefinitionS3Location?: PipelineDefinitionS3Location; /** * @public - *

    Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing - * container. Gzip can only be used when Pipe mode is - * specified as the S3InputMode. In Pipe mode, Amazon SageMaker streams input - * data from the source directly to your container without using the EBS volume.

    + *

    A description of the pipeline.

    */ - S3CompressionType?: ProcessingS3CompressionType; -} + PipelineDescription?: string; -/** - * @public - *

    The inputs for a processing job. The processing input must specify exactly one of either - * S3Input or DatasetDefinition types.

    - */ -export interface ProcessingInput { /** * @public - *

    The name for the processing job input.

    + *

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the + * operation. An idempotent operation completes no more than one time.

    */ - InputName: string | undefined; + ClientRequestToken?: string; /** * @public - *

    When True, input operations such as data download are managed natively by the - * processing job application. When False (default), input operations are managed by Amazon SageMaker.

    + *

    The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources.

    */ - AppManaged?: boolean; + RoleArn: string | undefined; /** * @public - *

    Configuration for downloading input data from Amazon S3 into the processing container.

    + *

    A list of tags to apply to the created pipeline.

    */ - S3Input?: ProcessingS3Input; + Tags?: Tag[]; /** * @public - *

    Configuration for a Dataset Definition input.

    + *

    This is the configuration that controls the parallelism of the pipeline. + * If specified, it applies to all runs of this pipeline by default.

    */ - DatasetDefinition?: DatasetDefinition; + ParallelismConfiguration?: ParallelismConfiguration; } /** * @public - *

    Configuration for processing job outputs in Amazon SageMaker Feature Store.

    */ -export interface ProcessingFeatureStoreOutput { +export interface CreatePipelineResponse { /** * @public - *

    The name of the Amazon SageMaker FeatureGroup to use as the destination for processing job output. Note that your - * processing script is responsible for putting records into your Feature Store.

    + *

    The Amazon Resource Name (ARN) of the created pipeline.

    */ - FeatureGroupName: string | undefined; + PipelineArn?: string; } /** * @public - *

    Configuration for uploading output data to Amazon S3 from the processing container.

    */ -export interface ProcessingS3Output { +export interface CreatePresignedDomainUrlRequest { /** * @public - *

    A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of - * a processing job.

    + *

    The domain ID.

    */ - S3Uri: string | undefined; + DomainId: string | undefined; /** * @public - *

    The local path of a directory where you want Amazon SageMaker to upload its contents to Amazon S3. - * LocalPath is an absolute path to a directory containing output files. - * This directory will be created by the platform and exist when your container's - * entrypoint is invoked.

    + *

    The name of the UserProfile to sign-in as.

    */ - LocalPath: string | undefined; + UserProfileName: string | undefined; /** * @public - *

    Whether to upload the results of the processing job continuously or after the job - * completes.

    + *

    The session expiration duration in seconds. This value defaults to 43200.

    */ - S3UploadMode: ProcessingS3UploadMode | undefined; -} + SessionExpirationDurationInSeconds?: number; -/** - * @public - *

    Describes the results of a processing job. The processing output must specify exactly one of - * either S3Output or FeatureStoreOutput types.

    - */ -export interface ProcessingOutput { /** * @public - *

    The name for the processing job output.

    + *

    The number of seconds until the pre-signed URL expires. This value defaults to + * 300.

    */ - OutputName: string | undefined; + ExpiresInSeconds?: number; /** * @public - *

    Configuration for processing job outputs in Amazon S3.

    + *

    The name of the space.

    */ - S3Output?: ProcessingS3Output; + SpaceName?: string; /** * @public - *

    Configuration for processing job outputs in Amazon SageMaker Feature Store. This processing output - * type is only supported when AppManaged is specified.

    + *

    The landing page that the user is directed to when accessing the presigned URL. Using this value, users can access Studio or Studio Classic, even if it is not the default experience for the domain. The supported values are:

    + *
      + *
    • + *

      + * studio::relative/path: Directs users to the relative path in Studio.

      + *
      • + *
    • + *

      + * app:JupyterServer:relative/path: Directs users to the relative path in the Studio Classic application.

      + *
      • + *
    • + *

      + * app:JupyterLab:relative/path: Directs users to the relative path in the JupyterLab application.

      + *
      • + *
    • + *

      + * app:RStudioServerPro:relative/path: Directs users to the relative path in the RStudio application.

      + *
      • + *
    • + *

      + * app:Canvas:relative/path: Directs users to the relative path in the Canvas application.

      + *
      • + *
    */ - FeatureStoreOutput?: ProcessingFeatureStoreOutput; + LandingUri?: string; +} +/** + * @public + */ +export interface CreatePresignedDomainUrlResponse { /** * @public - *

    When True, output operations such as data upload are managed natively by the - * processing job application. When False (default), output operations are managed by - * Amazon SageMaker.

    + *

    The presigned URL.

    */ - AppManaged?: boolean; + AuthorizedUrl?: string; } /** * @public - *

    Configuration for uploading output from the processing container.

    */ -export interface ProcessingOutputConfig { +export interface CreatePresignedNotebookInstanceUrlInput { /** * @public - *

    An array of outputs configuring the data to upload from the processing container.

    + *

    The name of the notebook instance.

    */ - Outputs: ProcessingOutput[] | undefined; + NotebookInstanceName: string | undefined; /** * @public - *

    The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the processing - * job output. KmsKeyId can be an ID of a KMS key, ARN of a KMS key, alias of - * a KMS key, or alias of a KMS key. The KmsKeyId is applied to all - * outputs.

    + *

    The duration of the session, in seconds. The default is 12 hours.

    */ - KmsKeyId?: string; + SessionExpirationDurationInSeconds?: number; } /** * @public - *

    Configuration for the cluster used to run a processing job.

    */ -export interface ProcessingClusterConfig { +export interface CreatePresignedNotebookInstanceUrlOutput { /** * @public - *

    The number of ML compute instances to use in the processing job. For distributed - * processing jobs, specify a value greater than 1. The default value is 1.

    + *

    A JSON object that contains the URL string.

    */ - InstanceCount: number | undefined; + AuthorizedUrl?: string; +} +/** + * @public + *

    Associates a SageMaker job as a trial component with an experiment and trial. Specified when + * you call the following APIs:

    + * + */ +export interface ExperimentConfig { /** * @public - *

    The ML compute instance type for the processing job.

    + *

    The name of an existing experiment to associate with the trial component.

    */ - InstanceType: ProcessingInstanceType | undefined; + ExperimentName?: string; /** * @public - *

    The size of the ML storage volume in gigabytes that you want to provision. You must - * specify sufficient ML storage for your scenario.

    - * - *

    Certain Nitro-based instances include local storage with a fixed total size, - * dependent on the instance type. When using these instances for processing, Amazon SageMaker mounts - * the local instance storage instead of Amazon EBS gp2 storage. You can't request a - * VolumeSizeInGB greater than the total size of the local instance - * storage.

    - *

    For a list of instance types that support local instance storage, including the - * total size per instance type, see Instance Store Volumes.

    - *     + *

    The name of an existing trial to associate the trial component with. If not specified, a + * new trial is created.

    */ - VolumeSizeInGB: number | undefined; + TrialName?: string; /** * @public - *

    The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the - * storage volume attached to the ML compute instance(s) that run the processing job. - *

    - * - *

    Certain Nitro-based instances include local storage, dependent on the instance - * type. Local storage volumes are encrypted using a hardware module on the instance. - * You can't request a VolumeKmsKeyId when using an instance type with - * local storage.

    - *

    For a list of instance types that support local instance storage, see Instance Store Volumes.

    - *

    For more information about local instance storage encryption, see SSD - * Instance Store Volumes.

    - *     + *

    The display name for the trial component. If this key isn't specified, the display name is + * the trial component name.

    */ - VolumeKmsKeyId?: string; -} + TrialComponentDisplayName?: string; -/** - * @public - *

    Identifies the resources, ML compute instances, and ML storage volumes to deploy for a - * processing job. In distributed training, you specify more than one instance.

    - */ -export interface ProcessingResources { /** * @public - *

    The configuration for the resources in a cluster used to run the processing - * job.

    + *

    The name of the experiment run to associate with the trial component.

    */ - ClusterConfig: ProcessingClusterConfig | undefined; + RunName?: string; } /** * @public - *

    Configures conditions under which the processing job should be stopped, such as how long - * the processing job has been running. After the condition is met, the processing job is stopped.

    + * @enum */ -export interface ProcessingStoppingCondition { - /** - * @public - *

    Specifies the maximum runtime in seconds.

    - */ - MaxRuntimeInSeconds: number | undefined; -} +export const DataDistributionType = { + FULLYREPLICATED: "FullyReplicated", + SHARDEDBYS3KEY: "ShardedByS3Key", +} as const; /** * @public */ -export interface CreateProcessingJobRequest { - /** - * @public - *

    An array of inputs configuring the data to download into the - * processing container.

    - */ - ProcessingInputs?: ProcessingInput[]; +export type DataDistributionType = (typeof DataDistributionType)[keyof typeof DataDistributionType]; - /** - * @public - *

    Output configuration for the processing job.

    - */ - ProcessingOutputConfig?: ProcessingOutputConfig; +/** + * @public + * @enum + */ +export const InputMode = { + FILE: "File", + PIPE: "Pipe", +} as const; - /** - * @public - *

    The name of the processing job. The name must be unique within an Amazon Web Services Region in the - * Amazon Web Services account.

    - */ - ProcessingJobName: string | undefined; +/** + * @public + */ +export type InputMode = (typeof InputMode)[keyof typeof InputMode]; + +/** + * @public + * @enum + */ +export const RedshiftResultCompressionType = { + BZIP2: "BZIP2", + GZIP: "GZIP", + NONE: "None", + SNAPPY: "SNAPPY", + ZSTD: "ZSTD", +} as const; + +/** + * @public + */ +export type RedshiftResultCompressionType = + (typeof RedshiftResultCompressionType)[keyof typeof RedshiftResultCompressionType]; + +/** + * @public + * @enum + */ +export const RedshiftResultFormat = { + CSV: "CSV", + PARQUET: "PARQUET", +} as const; + +/** + * @public + */ +export type RedshiftResultFormat = (typeof RedshiftResultFormat)[keyof typeof RedshiftResultFormat]; +/** + * @public + *

    Configuration for Redshift Dataset Definition input.

    + */ +export interface RedshiftDatasetDefinition { /** * @public - *

    Identifies the resources, ML compute instances, and ML storage volumes to deploy for a - * processing job. In distributed training, you specify more than one instance.

    + *

    The Redshift cluster Identifier.

    */ - ProcessingResources: ProcessingResources | undefined; + ClusterId: string | undefined; /** * @public - *

    The time limit for how long the processing job is allowed to run.

    + *

    The name of the Redshift database used in Redshift query execution.

    */ - StoppingCondition?: ProcessingStoppingCondition; + Database: string | undefined; /** * @public - *

    Configures the processing job to run a specified Docker container image.

    + *

    The database user name used in Redshift query execution.

    */ - AppSpecification: AppSpecification | undefined; + DbUser: string | undefined; /** * @public - *

    The environment variables to set in the Docker container. Up to - * 100 key and values entries in the map are supported.

    + *

    The SQL query statements to be executed.

    */ - Environment?: Record; + QueryString: string | undefined; /** * @public - *

    Networking options for a processing job, such as whether to allow inbound and - * outbound network calls to and from processing containers, and the VPC subnets and - * security groups to use for VPC-enabled processing jobs.

    + *

    The IAM role attached to your Redshift cluster that Amazon SageMaker uses to generate datasets.

    */ - NetworkConfig?: NetworkConfig; + ClusterRoleArn: string | undefined; /** * @public - *

    The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on - * your behalf.

    + *

    The location in Amazon S3 where the Redshift query results are stored.

    */ - RoleArn: string | undefined; + OutputS3Uri: string | undefined; /** * @public - *

    (Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management - * User Guide.

    + *

    The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data from a + * Redshift execution.

    */ - Tags?: Tag[]; + KmsKeyId?: string; /** * @public - *

    Associates a SageMaker job as a trial component with an experiment and trial. Specified when - * you call the following APIs:

    - * + *

    The data storage format for Redshift query results.

    */ - ExperimentConfig?: ExperimentConfig; -} + OutputFormat: RedshiftResultFormat | undefined; -/** - * @public - */ -export interface CreateProcessingJobResponse { /** * @public - *

    The Amazon Resource Name (ARN) of the processing job.

    + *

    The compression used for Redshift query results.

    */ - ProcessingJobArn: string | undefined; + OutputCompression?: RedshiftResultCompressionType; } /** * @public - *

    A key value pair used when you provision a project as a service catalog product. For - * information, see What is Amazon Web Services Service - * Catalog.

    + *

    Configuration for Dataset Definition inputs. The Dataset Definition input must specify + * exactly one of either AthenaDatasetDefinition or RedshiftDatasetDefinition + * types.

    */ -export interface ProvisioningParameter { - /** - * @public - *

    The key that identifies a provisioning parameter.

    - */ - Key?: string; - +export interface DatasetDefinition { /** * @public - *

    The value of the provisioning parameter.

    + *

    Configuration for Athena Dataset Definition input.

    */ - Value?: string; -} + AthenaDatasetDefinition?: AthenaDatasetDefinition; -/** - * @public - *

    Details that you specify to provision a service catalog product. For information about - * service catalog, see What is Amazon Web Services Service - * Catalog.

    - */ -export interface ServiceCatalogProvisioningDetails { /** * @public - *

    The ID of the product to provision.

    + *

    Configuration for Redshift Dataset Definition input.

    */ - ProductId: string | undefined; + RedshiftDatasetDefinition?: RedshiftDatasetDefinition; /** * @public - *

    The ID of the provisioning artifact.

    + *

    The local path where you want Amazon SageMaker to download the Dataset Definition inputs to run a + * processing job. LocalPath is an absolute path to the input data. This is a required + * parameter when AppManaged is False (default).

    */ - ProvisioningArtifactId?: string; + LocalPath?: string; /** * @public - *

    The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path.

    + *

    Whether the generated dataset is FullyReplicated or + * ShardedByS3Key (default).

    */ - PathId?: string; + DataDistributionType?: DataDistributionType; /** * @public - *

    A list of key value pairs that you specify when you provision a product.

    + *

    Whether to use File or Pipe input mode. In File (default) mode, + * Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store + * (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used + * input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your + * algorithm without using the EBS volume.

    */ - ProvisioningParameters?: ProvisioningParameter[]; + InputMode?: InputMode; } /** * @public + * @enum */ -export interface CreateProjectInput { - /** - * @public - *

    The name of the project.

    - */ - ProjectName: string | undefined; - - /** - * @public - *

    A description for the project.

    - */ - ProjectDescription?: string; - - /** - * @public - *

    The product ID and provisioning artifact ID to provision a service catalog. The provisioning - * artifact ID will default to the latest provisioning artifact ID of the product, if you don't - * provide the provisioning artifact ID. For more information, see What is Amazon Web Services Service - * Catalog.

    - */ - ServiceCatalogProvisioningDetails: ServiceCatalogProvisioningDetails | undefined; - - /** - * @public - *

    An array of key-value pairs that you want to use to organize and track your Amazon Web Services - * resource costs. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

    - */ - Tags?: Tag[]; -} +export const ProcessingS3CompressionType = { + GZIP: "Gzip", + NONE: "None", +} as const; /** * @public */ -export interface CreateProjectOutput { - /** - * @public - *

    The Amazon Resource Name (ARN) of the project.

    - */ - ProjectArn: string | undefined; +export type ProcessingS3CompressionType = + (typeof ProcessingS3CompressionType)[keyof typeof ProcessingS3CompressionType]; - /** - * @public - *

    The ID of the new project.

    - */ - ProjectId: string | undefined; -} +/** + * @public + * @enum + */ +export const ProcessingS3DataType = { + MANIFEST_FILE: "ManifestFile", + S3_PREFIX: "S3Prefix", +} as const; /** * @public - *

    A collection of space settings.

    */ -export interface SpaceSettings { - /** - * @public - *

    The JupyterServer app settings.

    - */ - JupyterServerAppSettings?: JupyterServerAppSettings; +export type ProcessingS3DataType = (typeof ProcessingS3DataType)[keyof typeof ProcessingS3DataType]; +/** + * @public + *

    Configuration for downloading input data from Amazon S3 into the processing container.

    + */ +export interface ProcessingS3Input { /** * @public - *

    The KernelGateway app settings.

    + *

    The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.

    */ - KernelGatewayAppSettings?: KernelGatewayAppSettings; -} + S3Uri: string | undefined; -/** - * @public - */ -export interface CreateSpaceRequest { /** * @public - *

    The ID of the associated Domain.

    + *

    The local path in your container where you want Amazon SageMaker to write input data to. + * LocalPath is an absolute path to the input data and must begin with + * /opt/ml/processing/. LocalPath is a required + * parameter when AppManaged is False (default).

    */ - DomainId: string | undefined; + LocalPath?: string; /** * @public - *

    The name of the space.

    + *

    Whether you use an S3Prefix or a ManifestFile for + * the data type. If you choose S3Prefix, S3Uri identifies a key + * name prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing + * job. If you choose ManifestFile, S3Uri identifies an object + * that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for + * the processing job.

    */ - SpaceName: string | undefined; + S3DataType: ProcessingS3DataType | undefined; /** * @public - *

    Tags to associated with the space. Each tag consists of a key and an optional value. - * Tag keys must be unique for each resource. Tags are searchable using the - * Search API.

    + *

    Whether to use File or Pipe input mode. In File mode, Amazon SageMaker copies the data + * from the input source onto the local ML storage volume before starting your processing + * container. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker + * streams input data from the source directly to your processing container into named + * pipes without using the ML storage volume.

    */ - Tags?: Tag[]; + S3InputMode?: ProcessingS3InputMode; /** * @public - *

    A collection of space settings.

    + *

    Whether to distribute the data from Amazon S3 to all processing instances with + * FullyReplicated, or whether the data from Amazon S3 is shared by Amazon S3 key, + * downloading one shard of data to each processing instance.

    */ - SpaceSettings?: SpaceSettings; -} + S3DataDistributionType?: ProcessingS3DataDistributionType; -/** - * @public - */ -export interface CreateSpaceResponse { /** * @public - *

    The space's Amazon Resource Name (ARN).

    + *

    Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing + * container. Gzip can only be used when Pipe mode is + * specified as the S3InputMode. In Pipe mode, Amazon SageMaker streams input + * data from the source directly to your container without using the EBS volume.

    */ - SpaceArn?: string; + S3CompressionType?: ProcessingS3CompressionType; } /** * @public - * @enum - */ -export const StudioLifecycleConfigAppType = { - JupyterServer: "JupyterServer", - KernelGateway: "KernelGateway", -} as const; - -/** - * @public - */ -export type StudioLifecycleConfigAppType = - (typeof StudioLifecycleConfigAppType)[keyof typeof StudioLifecycleConfigAppType]; - -/** - * @public + *

    The inputs for a processing job. The processing input must specify exactly one of either + * S3Input or DatasetDefinition types.

    */ -export interface CreateStudioLifecycleConfigRequest { +export interface ProcessingInput { /** * @public - *

    The name of the Studio Lifecycle Configuration to create.

    + *

    The name for the processing job input.

    */ - StudioLifecycleConfigName: string | undefined; + InputName: string | undefined; /** * @public - *

    The content of your Studio Lifecycle Configuration script. This content must be base64 encoded.

    + *

    When True, input operations such as data download are managed natively by the + * processing job application. When False (default), input operations are managed by Amazon SageMaker.

    */ - StudioLifecycleConfigContent: string | undefined; + AppManaged?: boolean; /** * @public - *

    The App type that the Lifecycle Configuration is attached to.

    + *

    Configuration for downloading input data from Amazon S3 into the processing container.

    */ - StudioLifecycleConfigAppType: StudioLifecycleConfigAppType | undefined; + S3Input?: ProcessingS3Input; /** * @public - *

    Tags to be associated with the Lifecycle Configuration. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.

    + *

    Configuration for a Dataset Definition input.

    */ - Tags?: Tag[]; + DatasetDefinition?: DatasetDefinition; } /** * @public + *

    Configuration for processing job outputs in Amazon SageMaker Feature Store.

    */ -export interface CreateStudioLifecycleConfigResponse { +export interface ProcessingFeatureStoreOutput { /** * @public - *

    The ARN of your created Lifecycle Configuration.

    + *

    The name of the Amazon SageMaker FeatureGroup to use as the destination for processing job output. Note that your + * processing script is responsible for putting records into your Feature Store.

    */ - StudioLifecycleConfigArn?: string; + FeatureGroupName: string | undefined; } /** * @public - *

    Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and - * storage paths. To learn more about - * how to configure the DebugHookConfig parameter, - * see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

    + *

    Configuration for uploading output data to Amazon S3 from the processing container.

    */ -export interface DebugHookConfig { - /** - * @public - *

    Path to local storage location for metrics and tensors. Defaults to - * /opt/ml/output/tensors/.

    - */ - LocalPath?: string; - +export interface ProcessingS3Output { /** * @public - *

    Path to Amazon S3 storage location for metrics and tensors.

    + *

    A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of + * a processing job.

    */ - S3OutputPath: string | undefined; + S3Uri: string | undefined; /** * @public - *

    Configuration information for the Amazon SageMaker Debugger hook parameters.

    + *

    The local path of a directory where you want Amazon SageMaker to upload its contents to Amazon S3. + * LocalPath is an absolute path to a directory containing output files. + * This directory will be created by the platform and exist when your container's + * entrypoint is invoked.

    */ - HookParameters?: Record; + LocalPath: string | undefined; /** * @public - *

    Configuration information for Amazon SageMaker Debugger tensor collections. To learn more about - * how to configure the CollectionConfiguration parameter, - * see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job. - *

    + *

    Whether to upload the results of the processing job continuously or after the job + * completes.

    */ - CollectionConfigurations?: CollectionConfiguration[]; + S3UploadMode: ProcessingS3UploadMode | undefined; } /** * @public - *

    Configuration information for SageMaker Debugger rules for debugging. To learn more about - * how to configure the DebugRuleConfiguration parameter, - * see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

    + *

    Describes the results of a processing job. The processing output must specify exactly one of + * either S3Output or FeatureStoreOutput types.

    */ -export interface DebugRuleConfiguration { - /** - * @public - *

    The name of the rule configuration. It must be unique relative to other rule - * configuration names.

    - */ - RuleConfigurationName: string | undefined; - +export interface ProcessingOutput { /** * @public - *

    Path to local storage location for output of rules. Defaults to - * /opt/ml/processing/output/rule/.

    + *

    The name for the processing job output.

    */ - LocalPath?: string; + OutputName: string | undefined; /** * @public - *

    Path to Amazon S3 storage location for rules.

    + *

    Configuration for processing job outputs in Amazon S3.

    */ - S3OutputPath?: string; + S3Output?: ProcessingS3Output; /** * @public - *

    The Amazon Elastic Container (ECR) Image for the managed rule evaluation.

    + *

    Configuration for processing job outputs in Amazon SageMaker Feature Store. This processing output + * type is only supported when AppManaged is specified.

    */ - RuleEvaluatorImage: string | undefined; + FeatureStoreOutput?: ProcessingFeatureStoreOutput; /** * @public - *

    The instance type to deploy a custom rule for debugging a training job.

    + *

    When True, output operations such as data upload are managed natively by the + * processing job application. When False (default), output operations are managed by + * Amazon SageMaker.

    */ - InstanceType?: ProcessingInstanceType; + AppManaged?: boolean; +} +/** + * @public + *

    Configuration for uploading output from the processing container.

    + */ +export interface ProcessingOutputConfig { /** * @public - *

    The size, in GB, of the ML storage volume attached to the processing instance.

    + *

    An array of outputs configuring the data to upload from the processing container.

    */ - VolumeSizeInGB?: number; + Outputs: ProcessingOutput[] | undefined; /** * @public - *

    Runtime configuration for rule container.

    + *

    The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the processing + * job output. KmsKeyId can be an ID of a KMS key, ARN of a KMS key, alias of + * a KMS key, or alias of a KMS key. The KmsKeyId is applied to all + * outputs.

    */ - RuleParameters?: Record; + KmsKeyId?: string; } /** * @public - *

    Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and - * storage paths.

    + *

    Configuration for the cluster used to run a processing job.

    */ -export interface ProfilerConfig { +export interface ProcessingClusterConfig { /** * @public - *

    Path to Amazon S3 storage location for system and framework metrics.

    + *

    The number of ML compute instances to use in the processing job. For distributed + * processing jobs, specify a value greater than 1. The default value is 1.

    */ - S3OutputPath?: string; + InstanceCount: number | undefined; /** * @public - *

    A time interval for capturing system metrics in milliseconds. Available values are - * 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.

    + *

    The ML compute instance type for the processing job.

    */ - ProfilingIntervalInMilliseconds?: number; + InstanceType: ProcessingInstanceType | undefined; /** * @public - *

    Configuration information for capturing framework metrics. Available key strings for different profiling options are - * DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig. - * The following codes are configuration structures for the ProfilingParameters parameter. To learn more about - * how to configure the ProfilingParameters parameter, - * see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job. - *

    + *

    The size of the ML storage volume in gigabytes that you want to provision. You must + * specify sufficient ML storage for your scenario.

    + * + *

    Certain Nitro-based instances include local storage with a fixed total size, + * dependent on the instance type. When using these instances for processing, Amazon SageMaker mounts + * the local instance storage instead of Amazon EBS gp2 storage. You can't request a + * VolumeSizeInGB greater than the total size of the local instance + * storage.

    + *

    For a list of instance types that support local instance storage, including the + * total size per instance type, see Instance Store Volumes.

    + *     */ - ProfilingParameters?: Record; + VolumeSizeInGB: number | undefined; /** * @public - *

    Configuration to turn off Amazon SageMaker Debugger's system monitoring and profiling functionality. To turn it off, set to True.

    + *

    The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the + * storage volume attached to the ML compute instance(s) that run the processing job. + *

    + * + *

    Certain Nitro-based instances include local storage, dependent on the instance + * type. Local storage volumes are encrypted using a hardware module on the instance. + * You can't request a VolumeKmsKeyId when using an instance type with + * local storage.

    + *

    For a list of instance types that support local instance storage, see Instance Store Volumes.

    + *

    For more information about local instance storage encryption, see SSD + * Instance Store Volumes.

    + *     */ - DisableProfiler?: boolean; + VolumeKmsKeyId?: string; } /** * @public - *

    Configuration information for profiling rules.

    + *

    Identifies the resources, ML compute instances, and ML storage volumes to deploy for a + * processing job. In distributed training, you specify more than one instance.

    */ -export interface ProfilerRuleConfiguration { +export interface ProcessingResources { /** * @public - *

    The name of the rule configuration. It must be unique relative to other rule configuration names.

    + *

    The configuration for the resources in a cluster used to run the processing + * job.

    */ - RuleConfigurationName: string | undefined; + ClusterConfig: ProcessingClusterConfig | undefined; +} +/** + * @public + *

    Configures conditions under which the processing job should be stopped, such as how long + * the processing job has been running. After the condition is met, the processing job is stopped.

    + */ +export interface ProcessingStoppingCondition { /** * @public - *

    Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.

    + *

    Specifies the maximum runtime in seconds.

    */ - LocalPath?: string; + MaxRuntimeInSeconds: number | undefined; +} +/** + * @public + */ +export interface CreateProcessingJobRequest { /** * @public - *

    Path to Amazon S3 storage location for rules.

    + *

    An array of inputs configuring the data to download into the + * processing container.

    */ - S3OutputPath?: string; + ProcessingInputs?: ProcessingInput[]; /** * @public - *

    The Amazon Elastic Container Registry Image for the managed rule evaluation.

    + *

    Output configuration for the processing job.

    */ - RuleEvaluatorImage: string | undefined; + ProcessingOutputConfig?: ProcessingOutputConfig; /** * @public - *

    The instance type to deploy a custom rule for profiling a training job.

    + *

    The name of the processing job. The name must be unique within an Amazon Web Services Region in the + * Amazon Web Services account.

    */ - InstanceType?: ProcessingInstanceType; + ProcessingJobName: string | undefined; /** * @public - *

    The size, in GB, of the ML storage volume attached to the processing instance.

    + *

    Identifies the resources, ML compute instances, and ML storage volumes to deploy for a + * processing job. In distributed training, you specify more than one instance.

    */ - VolumeSizeInGB?: number; + ProcessingResources: ProcessingResources | undefined; /** * @public - *

    Runtime configuration for rule container.

    + *

    The time limit for how long the processing job is allowed to run.

    */ - RuleParameters?: Record; -} + StoppingCondition?: ProcessingStoppingCondition; -/** - * @public - *

    Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data.

    - */ -export interface TensorBoardOutputConfig { /** * @public - *

    Path to local storage location for tensorBoard output. Defaults to - * /opt/ml/output/tensorboard.

    + *

    Configures the processing job to run a specified Docker container image.

    */ - LocalPath?: string; + AppSpecification: AppSpecification | undefined; /** * @public - *

    Path to Amazon S3 storage location for TensorBoard output.

    + *

    The environment variables to set in the Docker container. Up to + * 100 key and values entries in the map are supported.

    */ - S3OutputPath: string | undefined; -} + Environment?: Record; -/** - * @public - */ -export interface CreateTrainingJobRequest { /** * @public - *

    The name of the training job. The name must be unique within an Amazon Web Services - * Region in an Amazon Web Services account.

    + *

    Networking options for a processing job, such as whether to allow inbound and + * outbound network calls to and from processing containers, and the VPC subnets and + * security groups to use for VPC-enabled processing jobs.

    */ - TrainingJobName: string | undefined; + NetworkConfig?: NetworkConfig; /** * @public - *

    Algorithm-specific parameters that influence the quality of the model. You set - * hyperparameters before you start the learning process. For a list of hyperparameters for - * each training algorithm provided by SageMaker, see Algorithms.

    - *

    You can specify a maximum of 100 hyperparameters. Each hyperparameter is a - * key-value pair. Each key and value is limited to 256 characters, as specified by the - * Length Constraint.

    - * - *

    Do not include any security-sensitive information including account access IDs, - * secrets or tokens in any hyperparameter field. If the use of security-sensitive - * credentials are detected, SageMaker will reject your training job request and return an - * exception error.

    - *     + *

    The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on + * your behalf.

    */ - HyperParameters?: Record; + RoleArn: string | undefined; /** * @public - *

    The registry path of the Docker image that contains the training algorithm and - * algorithm-specific metadata, including the input mode. For more information about - * algorithms provided by SageMaker, see Algorithms. For information about - * providing your own algorithms, see Using Your Own Algorithms with - * Amazon SageMaker.

    + *

    (Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management + * User Guide.

    + */ + Tags?: Tag[]; + + /** + * @public + *

    Associates a SageMaker job as a trial component with an experiment and trial. Specified when + * you call the following APIs:

    + * */ - AlgorithmSpecification: AlgorithmSpecification | undefined; + ExperimentConfig?: ExperimentConfig; +} +/** + * @public + */ +export interface CreateProcessingJobResponse { /** * @public - *

    The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to perform - * tasks on your behalf.

    - *

    During model training, SageMaker needs your permission to read input data from an S3 - * bucket, download a Docker image that contains training code, write model artifacts to an - * S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant - * permissions for all of these tasks to an IAM role. For more information, see SageMaker - * Roles.

    - * - *

    To be able to pass this role to SageMaker, the caller of this API must have the - * iam:PassRole permission.

    - *     + *

    The Amazon Resource Name (ARN) of the processing job.

    */ - RoleArn: string | undefined; + ProcessingJobArn: string | undefined; +} +/** + * @public + *

    A key value pair used when you provision a project as a service catalog product. For + * information, see What is Amazon Web Services Service + * Catalog.

    + */ +export interface ProvisioningParameter { /** * @public - *

    An array of Channel objects. Each channel is a named input source. - * InputDataConfig describes the input data and its location.

    - *

    Algorithms can accept input data from one or more channels. For example, an - * algorithm might have two channels of input data, training_data and - * validation_data. The configuration for each channel provides the S3, - * EFS, or FSx location where the input data is stored. It also provides information about - * the stored data: the MIME type, compression method, and whether the data is wrapped in - * RecordIO format.

    - *

    Depending on the input mode that the algorithm supports, SageMaker either copies input - * data files from an S3 bucket to a local directory in the Docker container, or makes it - * available as input streams. For example, if you specify an EFS location, input data - * files are available as input streams. They do not need to be downloaded.

    - *

    Your input must be in the same Amazon Web Services region as your training - * job.

    + *

    The key that identifies a provisioning parameter.

    */ - InputDataConfig?: Channel[]; + Key?: string; /** * @public - *

    Specifies the path to the S3 location where you want to store model artifacts. SageMaker - * creates subfolders for the artifacts.

    + *

    The value of the provisioning parameter.

    */ - OutputDataConfig: OutputDataConfig | undefined; + Value?: string; +} +/** + * @public + *

    Details that you specify to provision a service catalog product. For information about + * service catalog, see What is Amazon Web Services Service + * Catalog.

    + */ +export interface ServiceCatalogProvisioningDetails { /** * @public - *

    The resources, including the ML compute instances and ML storage volumes, to use - * for model training.

    - *

    ML storage volumes store model artifacts and incremental states. Training - * algorithms might also use ML storage volumes for scratch space. If you want SageMaker to use - * the ML storage volume to store the training data, choose File as the - * TrainingInputMode in the algorithm specification. For distributed - * training algorithms, specify an instance count greater than 1.

    + *

    The ID of the product to provision.

    */ - ResourceConfig: ResourceConfig | undefined; + ProductId: string | undefined; /** * @public - *

    A VpcConfig object that specifies the VPC that you want your training job to - * connect to. Control access to and from your training container by configuring the VPC. - * For more information, see Protect Training Jobs by Using an Amazon - * Virtual Private Cloud.

    + *

    The ID of the provisioning artifact.

    */ - VpcConfig?: VpcConfig; + ProvisioningArtifactId?: string; /** * @public - *

    Specifies a limit to how long a model training job can run. It also specifies how long - * a managed Spot training job has to complete. When the job reaches the time limit, SageMaker - * ends the training job. Use this API to cap model training costs.

    - *

    To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays - * job termination for 120 seconds. Algorithms can use this 120-second window to save the - * model artifacts, so the results of training are not lost.

    + *

    The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path.

    */ - StoppingCondition: StoppingCondition | undefined; + PathId?: string; /** * @public - *

    An array of key-value pairs. You can use tags to categorize your Amazon Web Services - * resources in different ways, for example, by purpose, owner, or environment. For more - * information, see Tagging Amazon Web Services Resources.

    + *

    A list of key value pairs that you specify when you provision a product.

    */ - Tags?: Tag[]; + ProvisioningParameters?: ProvisioningParameter[]; +} +/** + * @public + */ +export interface CreateProjectInput { /** * @public - *

    Isolates the training container. No inbound or outbound network calls can be made, - * except for calls between peers within a training cluster for distributed training. If - * you enable network isolation for training jobs that are configured to use a VPC, SageMaker - * downloads and uploads customer data and model artifacts through the specified VPC, but - * the training container does not have network access.

    + *

    The name of the project.

    */ - EnableNetworkIsolation?: boolean; + ProjectName: string | undefined; /** * @public - *

    To encrypt all communications between ML compute instances in distributed training, - * choose True. Encryption provides greater security for distributed training, - * but training might take longer. How long it takes depends on the amount of communication - * between compute instances, especially if you use a deep learning algorithm in - * distributed training. For more information, see Protect Communications Between ML - * Compute Instances in a Distributed Training Job.

    + *

    A description for the project.

    */ - EnableInterContainerTrafficEncryption?: boolean; + ProjectDescription?: string; /** * @public - *

    To train models using managed spot training, choose True. Managed spot - * training provides a fully managed and scalable infrastructure for training machine - * learning models. this option is useful when training jobs can be interrupted and when - * there is flexibility when the training job is run.

    - *

    The complete and intermediate results of jobs are stored in an Amazon S3 bucket, and can be - * used as a starting point to train models incrementally. Amazon SageMaker provides metrics and - * logs in CloudWatch. They can be used to see when managed spot training jobs are running, - * interrupted, resumed, or completed.

    + *

    The product ID and provisioning artifact ID to provision a service catalog. The provisioning + * artifact ID will default to the latest provisioning artifact ID of the product, if you don't + * provide the provisioning artifact ID. For more information, see What is Amazon Web Services Service + * Catalog.

    */ - EnableManagedSpotTraining?: boolean; + ServiceCatalogProvisioningDetails: ServiceCatalogProvisioningDetails | undefined; /** * @public - *

    Contains information about the output location for managed spot training checkpoint - * data.

    + *

    An array of key-value pairs that you want to use to organize and track your Amazon Web Services + * resource costs. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

    */ - CheckpointConfig?: CheckpointConfig; + Tags?: Tag[]; +} +/** + * @public + */ +export interface CreateProjectOutput { /** * @public - *

    Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and - * storage paths. To learn more about - * how to configure the DebugHookConfig parameter, - * see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

    + *

    The Amazon Resource Name (ARN) of the project.

    */ - DebugHookConfig?: DebugHookConfig; + ProjectArn: string | undefined; /** * @public - *

    Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.

    + *

    The ID of the new project.

    */ - DebugRuleConfigurations?: DebugRuleConfiguration[]; + ProjectId: string | undefined; +} +/** + * @public + *

    A collection of space settings.

    + */ +export interface SpaceSettings { /** * @public - *

    Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data.

    + *

    The JupyterServer app settings.

    */ - TensorBoardOutputConfig?: TensorBoardOutputConfig; + JupyterServerAppSettings?: JupyterServerAppSettings; /** * @public - *

    Associates a SageMaker job as a trial component with an experiment and trial. Specified when - * you call the following APIs:

    - * + *

    The KernelGateway app settings.

    */ - ExperimentConfig?: ExperimentConfig; + KernelGatewayAppSettings?: KernelGatewayAppSettings; +} +/** + * @public + */ +export interface CreateSpaceRequest { /** * @public - *

    Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and - * storage paths.

    + *

    The ID of the associated Domain.

    */ - ProfilerConfig?: ProfilerConfig; + DomainId: string | undefined; /** * @public - *

    Configuration information for Amazon SageMaker Debugger rules for profiling system and framework - * metrics.

    + *

    The name of the space.

    */ - ProfilerRuleConfigurations?: ProfilerRuleConfiguration[]; + SpaceName: string | undefined; /** * @public - *

    The environment variables to set in the Docker container.

    + *

    Tags to associated with the space. Each tag consists of a key and an optional value. + * Tag keys must be unique for each resource. Tags are searchable using the + * Search API.

    */ - Environment?: Record; + Tags?: Tag[]; /** * @public - *

    The number of times to retry the job when the job fails due to an - * InternalServerError.

    + *

    A collection of space settings.

    */ - RetryStrategy?: RetryStrategy; + SpaceSettings?: SpaceSettings; } /** * @public */ -export interface CreateTrainingJobResponse { +export interface CreateSpaceResponse { /** * @public - *

    The Amazon Resource Name (ARN) of the training job.

    + *

    The space's Amazon Resource Name (ARN).

    */ - TrainingJobArn: string | undefined; + SpaceArn?: string; } /** * @public * @enum */ -export const JoinSource = { - INPUT: "Input", - NONE: "None", +export const StudioLifecycleConfigAppType = { + JupyterServer: "JupyterServer", + KernelGateway: "KernelGateway", } as const; /** * @public */ -export type JoinSource = (typeof JoinSource)[keyof typeof JoinSource]; +export type StudioLifecycleConfigAppType = + (typeof StudioLifecycleConfigAppType)[keyof typeof StudioLifecycleConfigAppType]; /** * @public - *

    The data structure used to specify the data to be used for inference in a batch - * transform job and to associate the data that is relevant to the prediction results in - * the output. The input filter provided allows you to exclude input data that is not - * needed for inference in a batch transform job. The output filter provided allows you to - * include input data relevant to interpreting the predictions in the output from the job. - * For more information, see Associate Prediction - * Results with their Corresponding Input Records.

    */ -export interface DataProcessing { +export interface CreateStudioLifecycleConfigRequest { + /** + * @public + *

    The name of the Amazon SageMaker Studio Lifecycle Configuration to create.

    + */ + StudioLifecycleConfigName: string | undefined; + /** * @public - *

    A JSONPath expression used to select a portion of the input data to pass to - * the algorithm. Use the InputFilter parameter to exclude fields, such as an - * ID column, from the input. If you want SageMaker to pass the entire input dataset to the - * algorithm, accept the default value $.

    - *

    Examples: "$", "$[1:]", "$.features" - *

    + *

    The content of your Amazon SageMaker Studio Lifecycle Configuration script. This content must be base64 encoded.

    */ - InputFilter?: string; + StudioLifecycleConfigContent: string | undefined; /** * @public - *

    A JSONPath expression used to select a portion of the joined dataset to save - * in the output file for a batch transform job. If you want SageMaker to store the entire input - * dataset in the output file, leave the default value, $. If you specify - * indexes that aren't within the dimension size of the joined dataset, you get an - * error.

    - *

    Examples: "$", "$[0,5:]", - * "$['id','SageMakerOutput']" - *

    + *

    The App type that the Lifecycle Configuration is attached to.

    */ - OutputFilter?: string; + StudioLifecycleConfigAppType: StudioLifecycleConfigAppType | undefined; /** * @public - *

    Specifies the source of the data to join with the transformed data. The valid values - * are None and Input. The default value is None, - * which specifies not to join the input with the transformed data. If you want the batch - * transform job to join the original input data with the transformed data, set - * JoinSource to Input. You can specify - * OutputFilter as an additional filter to select a portion of the joined - * dataset and store it in the output file.

    - *

    For JSON or JSONLines objects, such as a JSON array, SageMaker adds the transformed data to - * the input JSON object in an attribute called SageMakerOutput. The joined - * result for JSON must be a key-value pair object. If the input is not a key-value pair - * object, SageMaker creates a new JSON file. In the new JSON file, and the input data is stored - * under the SageMakerInput key and the results are stored in - * SageMakerOutput.

    - *

    For CSV data, SageMaker takes each row as a JSON array and joins the transformed data with - * the input by appending each transformed row to the end of the input. The joined data has - * the original input data followed by the transformed data and the output is a CSV - * file.

    - *

    For information on how joining in applied, see Workflow for Associating Inferences with Input Records.

    + *

    Tags to be associated with the Lifecycle Configuration. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.

    */ - JoinSource?: JoinSource; + Tags?: Tag[]; } /** * @public - *

    Configures the timeout and maximum number of retries for processing a transform job - * invocation.

    */ -export interface ModelClientConfig { - /** - * @public - *

    The timeout value in seconds for an invocation request. The default value is - * 600.

    - */ - InvocationsTimeoutInSeconds?: number; - +export interface CreateStudioLifecycleConfigResponse { /** * @public - *

    The maximum number of retries when invocation requests are failing. The default value - * is 3.

    + *

    The ARN of your created Lifecycle Configuration.

    */ - InvocationsMaxRetries?: number; + StudioLifecycleConfigArn?: string; } /** * @public + *

    Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and + * storage paths. To learn more about + * how to configure the DebugHookConfig parameter, + * see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

    */ -export interface CreateTransformJobRequest { +export interface DebugHookConfig { /** * @public - *

    The name of the transform job. The name must be unique within an Amazon Web Services Region in an - * Amazon Web Services account.

    + *

    Path to local storage location for metrics and tensors. Defaults to + * /opt/ml/output/tensors/.

    */ - TransformJobName: string | undefined; + LocalPath?: string; /** * @public - *

    The name of the model that you want to use for the transform job. - * ModelName must be the name of an existing Amazon SageMaker model within an Amazon Web Services - * Region in an Amazon Web Services account.

    + *

    Path to Amazon S3 storage location for metrics and tensors.

    */ - ModelName: string | undefined; + S3OutputPath: string | undefined; /** * @public - *

    The maximum number of parallel requests that can be sent to each instance in a - * transform job. If MaxConcurrentTransforms is set to 0 or left - * unset, Amazon SageMaker checks the optional execution-parameters to determine the settings for your - * chosen algorithm. If the execution-parameters endpoint is not enabled, the default value - * is 1. For more information on execution-parameters, see How Containers Serve Requests. For built-in algorithms, you don't need to - * set a value for MaxConcurrentTransforms.

    + *

    Configuration information for the Amazon SageMaker Debugger hook parameters.

    */ - MaxConcurrentTransforms?: number; + HookParameters?: Record; /** * @public - *

    Configures the timeout and maximum number of retries for processing a transform job - * invocation.

    + *

    Configuration information for Amazon SageMaker Debugger tensor collections. To learn more about + * how to configure the CollectionConfiguration parameter, + * see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job. + *

    */ - ModelClientConfig?: ModelClientConfig; + CollectionConfigurations?: CollectionConfiguration[]; +} +/** + * @public + *

    Configuration information for SageMaker Debugger rules for debugging. To learn more about + * how to configure the DebugRuleConfiguration parameter, + * see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

    + */ +export interface DebugRuleConfiguration { /** * @public - *

    The maximum allowed size of the payload, in MB. A payload is the - * data portion of a record (without metadata). The value in MaxPayloadInMB - * must be greater than, or equal to, the size of a single record. To estimate the size of - * a record in MB, divide the size of your dataset by the number of records. To ensure that - * the records fit within the maximum payload size, we recommend using a slightly larger - * value. The default value is 6 MB. - *

    - *

    The value of MaxPayloadInMB cannot be greater than 100 MB. If you specify - * the MaxConcurrentTransforms parameter, the value of - * (MaxConcurrentTransforms * MaxPayloadInMB) also cannot exceed 100 - * MB.

    - *

    For cases where the payload might be arbitrarily large and is transmitted using HTTP - * chunked encoding, set the value to 0. - * This - * feature works only in supported algorithms. Currently, Amazon SageMaker built-in - * algorithms do not support HTTP chunked encoding.

    + *

    The name of the rule configuration. It must be unique relative to other rule + * configuration names.

    */ - MaxPayloadInMB?: number; + RuleConfigurationName: string | undefined; /** * @public - *

    Specifies the number of records to include in a mini-batch for an HTTP inference - * request. A record - * is a single unit of input data that - * inference can be made on. For example, a single line in a CSV file is a record.

    - *

    To enable the batch strategy, you must set the SplitType property to - * Line, RecordIO, or TFRecord.

    - *

    To use only one record when making an HTTP invocation request to a container, set - * BatchStrategy to SingleRecord and SplitType - * to Line.

    - *

    To fit as many records in a mini-batch as can fit within the - * MaxPayloadInMB limit, set BatchStrategy to - * MultiRecord and SplitType to Line.

    + *

    Path to local storage location for output of rules. Defaults to + * /opt/ml/processing/output/rule/.

    */ - BatchStrategy?: BatchStrategy; + LocalPath?: string; /** * @public - *

    The environment variables to set in the Docker container. We support up to 16 key and - * values entries in the map.

    + *

    Path to Amazon S3 storage location for rules.

    */ - Environment?: Record; + S3OutputPath?: string; /** * @public - *

    Describes the input source and - * the - * way the transform job consumes it.

    + *

    The Amazon Elastic Container (ECR) Image for the managed rule evaluation.

    */ - TransformInput: TransformInput | undefined; + RuleEvaluatorImage: string | undefined; /** * @public - *

    Describes the results of the transform job.

    + *

    The instance type to deploy a custom rule for debugging a training job.

    */ - TransformOutput: TransformOutput | undefined; + InstanceType?: ProcessingInstanceType; /** * @public - *

    Configuration to control how SageMaker captures inference data.

    + *

    The size, in GB, of the ML storage volume attached to the processing instance.

    */ - DataCaptureConfig?: BatchDataCaptureConfig; + VolumeSizeInGB?: number; /** * @public - *

    Describes the resources, including - * ML - * instance types and ML instance count, to use for the transform - * job.

    + *

    Runtime configuration for rule container.

    */ - TransformResources: TransformResources | undefined; + RuleParameters?: Record; +} +/** + * @public + *

    Configuration information for the infrastructure health check of a training job. A SageMaker-provided health check tests the health of instance hardware and cluster network + * connectivity.

    + */ +export interface InfraCheckConfig { /** * @public - *

    The data structure used to specify the data to be used for inference in a batch - * transform job and to associate the data that is relevant to the prediction results in - * the output. The input filter provided allows you to exclude input data that is not - * needed for inference in a batch transform job. The output filter provided allows you to - * include input data relevant to interpreting the predictions in the output from the job. - * For more information, see Associate Prediction - * Results with their Corresponding Input Records.

    + *

    Enables an infrastructure health check.

    */ - DataProcessing?: DataProcessing; + EnableInfraCheck?: boolean; +} +/** + * @public + *

    Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and + * storage paths.

    + */ +export interface ProfilerConfig { /** * @public - *

    (Optional) - * An - * array of key-value pairs. For more information, see Using - * Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User - * Guide.

    + *

    Path to Amazon S3 storage location for system and framework metrics.

    */ - Tags?: Tag[]; + S3OutputPath?: string; /** * @public - *

    Associates a SageMaker job as a trial component with an experiment and trial. Specified when - * you call the following APIs:

    - * + *

    A time interval for capturing system metrics in milliseconds. Available values are + * 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.

    */ - ExperimentConfig?: ExperimentConfig; -} + ProfilingIntervalInMilliseconds?: number; -/** - * @public - */ -export interface CreateTransformJobResponse { /** * @public - *

    The Amazon Resource Name (ARN) of the transform job.

    + *

    Configuration information for capturing framework metrics. Available key strings for different profiling options are + * DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig. + * The following codes are configuration structures for the ProfilingParameters parameter. To learn more about + * how to configure the ProfilingParameters parameter, + * see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job. + *

    */ - TransformJobArn: string | undefined; + ProfilingParameters?: Record; + + /** + * @public + *

    Configuration to turn off Amazon SageMaker Debugger's system monitoring and profiling functionality. To turn it off, set to True.

    + */ + DisableProfiler?: boolean; } /** * @public + *

    Configuration information for profiling rules.

    */ -export interface CreateTrialRequest { +export interface ProfilerRuleConfiguration { /** * @public - *

    The name of the trial. The name must be unique in your Amazon Web Services account and is not - * case-sensitive.

    + *

    The name of the rule configuration. It must be unique relative to other rule configuration names.

    */ - TrialName: string | undefined; + RuleConfigurationName: string | undefined; /** * @public - *

    The name of the trial as displayed. The name doesn't need to be unique. If - * DisplayName isn't specified, TrialName is displayed.

    + *

    Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.

    */ - DisplayName?: string; + LocalPath?: string; /** * @public - *

    The name of the experiment to associate the trial with.

    + *

    Path to Amazon S3 storage location for rules.

    */ - ExperimentName: string | undefined; + S3OutputPath?: string; /** * @public - *

    Metadata properties of the tracking entity, trial, or trial component.

    + *

    The Amazon Elastic Container Registry Image for the managed rule evaluation.

    + */ + RuleEvaluatorImage: string | undefined; + + /** + * @public + *

    The instance type to deploy a custom rule for profiling a training job.

    */ - MetadataProperties?: MetadataProperties; + InstanceType?: ProcessingInstanceType; /** * @public - *

    A list of tags to associate with the trial. You can use Search API to - * search on the tags.

    + *

    The size, in GB, of the ML storage volume attached to the processing instance.

    */ - Tags?: Tag[]; -} + VolumeSizeInGB?: number; -/** - * @public - */ -export interface CreateTrialResponse { /** * @public - *

    The Amazon Resource Name (ARN) of the trial.

    + *

    Runtime configuration for rule container.

    */ - TrialArn?: string; + RuleParameters?: Record; } /** * @public - *

    Represents an input or output artifact of a trial component. You specify - * TrialComponentArtifact as part of the InputArtifacts and - * OutputArtifacts parameters in the CreateTrialComponent - * request.

    - *

    Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and - * instance types. Examples of output artifacts are metrics, snapshots, logs, and images.

    + *

    Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data.

    */ -export interface TrialComponentArtifact { +export interface TensorBoardOutputConfig { /** * @public - *

    The media type of the artifact, which indicates the type of data in the artifact file. The - * media type consists of a type and a subtype - * concatenated with a slash (/) character, for example, text/csv, image/jpeg, and s3/uri. The - * type specifies the category of the media. The subtype specifies the kind of data.

    + *

    Path to local storage location for tensorBoard output. Defaults to + * /opt/ml/output/tensorboard.

    */ - MediaType?: string; + LocalPath?: string; /** * @public - *

    The location of the artifact.

    + *

    Path to Amazon S3 storage location for TensorBoard output.

    */ - Value: string | undefined; + S3OutputPath: string | undefined; } -/** - * @public - *

    The value of a hyperparameter. Only one of NumberValue or - * StringValue can be specified.

    - *

    This object is specified in the CreateTrialComponent request.

    - */ -export type TrialComponentParameterValue = - | TrialComponentParameterValue.NumberValueMember - | TrialComponentParameterValue.StringValueMember - | TrialComponentParameterValue.$UnknownMember; - /** * @public */ -export namespace TrialComponentParameterValue { +export interface CreateTrainingJobRequest { /** * @public - *

    The string value of a categorical hyperparameter. If you specify a value for this - * parameter, you can't specify the NumberValue parameter.

    + *

    The name of the training job. The name must be unique within an Amazon Web Services + * Region in an Amazon Web Services account.

    */ - export interface StringValueMember { - StringValue: string; - NumberValue?: never; - $unknown?: never; - } + TrainingJobName: string | undefined; /** * @public - *

    The numeric value of a numeric hyperparameter. If you specify a value for this parameter, - * you can't specify the StringValue parameter.

    + *

    Algorithm-specific parameters that influence the quality of the model. You set + * hyperparameters before you start the learning process. For a list of hyperparameters for + * each training algorithm provided by SageMaker, see Algorithms.

    + *

    You can specify a maximum of 100 hyperparameters. Each hyperparameter is a + * key-value pair. Each key and value is limited to 256 characters, as specified by the + * Length Constraint.

    + * + *

    Do not include any security-sensitive information including account access IDs, + * secrets or tokens in any hyperparameter field. If the use of security-sensitive + * credentials are detected, SageMaker will reject your training job request and return an + * exception error.

    + *     */ - export interface NumberValueMember { - StringValue?: never; - NumberValue: number; - $unknown?: never; - } + HyperParameters?: Record; /** * @public + *

    The registry path of the Docker image that contains the training algorithm and + * algorithm-specific metadata, including the input mode. For more information about + * algorithms provided by SageMaker, see Algorithms. For information about + * providing your own algorithms, see Using Your Own Algorithms with + * Amazon SageMaker.

    */ - export interface $UnknownMember { - StringValue?: never; - NumberValue?: never; - $unknown: [string, any]; - } - - export interface Visitor { - StringValue: (value: string) => T; - NumberValue: (value: number) => T; - _: (name: string, value: any) => T; - } - - export const visit = (value: TrialComponentParameterValue, visitor: Visitor): T => { - if (value.StringValue !== undefined) return visitor.StringValue(value.StringValue); - if (value.NumberValue !== undefined) return visitor.NumberValue(value.NumberValue); - return visitor._(value.$unknown[0], value.$unknown[1]); - }; -} - -/** - * @public - * @enum - */ -export const TrialComponentPrimaryStatus = { - COMPLETED: "Completed", - FAILED: "Failed", - IN_PROGRESS: "InProgress", - STOPPED: "Stopped", - STOPPING: "Stopping", -} as const; + AlgorithmSpecification: AlgorithmSpecification | undefined; -/** - * @public - */ -export type TrialComponentPrimaryStatus = - (typeof TrialComponentPrimaryStatus)[keyof typeof TrialComponentPrimaryStatus]; + /** + * @public + *

    The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to perform + * tasks on your behalf.

    + *

    During model training, SageMaker needs your permission to read input data from an S3 + * bucket, download a Docker image that contains training code, write model artifacts to an + * S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant + * permissions for all of these tasks to an IAM role. For more information, see SageMaker + * Roles.

    + * + *

    To be able to pass this role to SageMaker, the caller of this API must have the + * iam:PassRole permission.

    + *     + */ + RoleArn: string | undefined; -/** - * @public - *

    The status of the trial component.

    - */ -export interface TrialComponentStatus { /** * @public - *

    The status of the trial component.

    + *

    An array of Channel objects. Each channel is a named input source. + * InputDataConfig describes the input data and its location.

    + *

    Algorithms can accept input data from one or more channels. For example, an + * algorithm might have two channels of input data, training_data and + * validation_data. The configuration for each channel provides the S3, + * EFS, or FSx location where the input data is stored. It also provides information about + * the stored data: the MIME type, compression method, and whether the data is wrapped in + * RecordIO format.

    + *

    Depending on the input mode that the algorithm supports, SageMaker either copies input + * data files from an S3 bucket to a local directory in the Docker container, or makes it + * available as input streams. For example, if you specify an EFS location, input data + * files are available as input streams. They do not need to be downloaded.

    + *

    Your input must be in the same Amazon Web Services region as your training + * job.

    */ - PrimaryStatus?: TrialComponentPrimaryStatus; + InputDataConfig?: Channel[]; /** * @public - *

    If the component failed, a message describing why.

    + *

    Specifies the path to the S3 location where you want to store model artifacts. SageMaker + * creates subfolders for the artifacts.

    */ - Message?: string; -} + OutputDataConfig: OutputDataConfig | undefined; -/** - * @public - */ -export interface CreateTrialComponentRequest { /** * @public - *

    The name of the component. The name must be unique in your Amazon Web Services account and is not - * case-sensitive.

    + *

    The resources, including the ML compute instances and ML storage volumes, to use + * for model training.

    + *

    ML storage volumes store model artifacts and incremental states. Training + * algorithms might also use ML storage volumes for scratch space. If you want SageMaker to use + * the ML storage volume to store the training data, choose File as the + * TrainingInputMode in the algorithm specification. For distributed + * training algorithms, specify an instance count greater than 1.

    */ - TrialComponentName: string | undefined; + ResourceConfig: ResourceConfig | undefined; /** * @public - *

    The name of the component as displayed. The name doesn't need to be unique. If - * DisplayName isn't specified, TrialComponentName is - * displayed.

    + *

    A VpcConfig object that specifies the VPC that you want your training job to + * connect to. Control access to and from your training container by configuring the VPC. + * For more information, see Protect Training Jobs by Using an Amazon + * Virtual Private Cloud.

    */ - DisplayName?: string; + VpcConfig?: VpcConfig; /** * @public - *

    The status of the component. States include:

    - *
      - *
    • - *

      InProgress

      - *
      • - *
    • - *

      Completed

      - *
      • - *
    • - *

      Failed

      - *
      • - *
    + *

    Specifies a limit to how long a model training job can run. It also specifies how long + * a managed Spot training job has to complete. When the job reaches the time limit, SageMaker + * ends the training job. Use this API to cap model training costs.

    + *

    To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays + * job termination for 120 seconds. Algorithms can use this 120-second window to save the + * model artifacts, so the results of training are not lost.

    */ - Status?: TrialComponentStatus; + StoppingCondition: StoppingCondition | undefined; /** * @public - *

    When the component started.

    + *

    An array of key-value pairs. You can use tags to categorize your Amazon Web Services + * resources in different ways, for example, by purpose, owner, or environment. For more + * information, see Tagging Amazon Web Services Resources.

    */ - StartTime?: Date; + Tags?: Tag[]; /** * @public - *

    When the component ended.

    + *

    Isolates the training container. No inbound or outbound network calls can be made, + * except for calls between peers within a training cluster for distributed training. If + * you enable network isolation for training jobs that are configured to use a VPC, SageMaker + * downloads and uploads customer data and model artifacts through the specified VPC, but + * the training container does not have network access.

    */ - EndTime?: Date; + EnableNetworkIsolation?: boolean; /** * @public - *

    The hyperparameters for the component.

    + *

    To encrypt all communications between ML compute instances in distributed training, + * choose True. Encryption provides greater security for distributed training, + * but training might take longer. How long it takes depends on the amount of communication + * between compute instances, especially if you use a deep learning algorithm in + * distributed training. For more information, see Protect Communications Between ML + * Compute Instances in a Distributed Training Job.

    */ - Parameters?: Record; + EnableInterContainerTrafficEncryption?: boolean; /** * @public - *

    The input artifacts for the component. Examples of input artifacts are datasets, - * algorithms, hyperparameters, source code, and instance types.

    + *

    To train models using managed spot training, choose True. Managed spot + * training provides a fully managed and scalable infrastructure for training machine + * learning models. this option is useful when training jobs can be interrupted and when + * there is flexibility when the training job is run.

    + *

    The complete and intermediate results of jobs are stored in an Amazon S3 bucket, and can be + * used as a starting point to train models incrementally. Amazon SageMaker provides metrics and + * logs in CloudWatch. They can be used to see when managed spot training jobs are running, + * interrupted, resumed, or completed.

    */ - InputArtifacts?: Record; + EnableManagedSpotTraining?: boolean; /** * @public - *

    The output artifacts for the component. Examples of output artifacts are metrics, - * snapshots, logs, and images.

    + *

    Contains information about the output location for managed spot training checkpoint + * data.

    */ - OutputArtifacts?: Record; + CheckpointConfig?: CheckpointConfig; /** * @public - *

    Metadata properties of the tracking entity, trial, or trial component.

    + *

    Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and + * storage paths. To learn more about + * how to configure the DebugHookConfig parameter, + * see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

    */ - MetadataProperties?: MetadataProperties; + DebugHookConfig?: DebugHookConfig; /** * @public - *

    A list of tags to associate with the component. You can use Search API - * to search on the tags.

    + *

    Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.

    */ - Tags?: Tag[]; -} + DebugRuleConfigurations?: DebugRuleConfiguration[]; -/** - * @public - */ -export interface CreateTrialComponentResponse { /** * @public - *

    The Amazon Resource Name (ARN) of the trial component.

    + *

    Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data.

    */ - TrialComponentArn?: string; -} + TensorBoardOutputConfig?: TensorBoardOutputConfig; -/** - * @public - */ -export interface CreateUserProfileRequest { /** * @public - *

    The ID of the associated Domain.

    + *

    Associates a SageMaker job as a trial component with an experiment and trial. Specified when + * you call the following APIs:

    + * */ - DomainId: string | undefined; + ExperimentConfig?: ExperimentConfig; /** * @public - *

    A name for the UserProfile. This value is not case sensitive.

    + *

    Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and + * storage paths.

    */ - UserProfileName: string | undefined; + ProfilerConfig?: ProfilerConfig; /** * @public - *

    A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName". - * If the Domain's AuthMode is IAM Identity Center, this field is required. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified. - *

    + *

    Configuration information for Amazon SageMaker Debugger rules for profiling system and framework + * metrics.

    */ - SingleSignOnUserIdentifier?: string; + ProfilerRuleConfigurations?: ProfilerRuleConfiguration[]; /** * @public - *

    The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain's AuthMode is IAM Identity Center, this field is - * required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified. - *

    + *

    The environment variables to set in the Docker container.

    */ - SingleSignOnUserValue?: string; + Environment?: Record; /** * @public - *

    Each tag consists of a key and an optional value. - * Tag keys must be unique per resource.

    - *

    Tags that you specify for the User Profile are also added to all Apps that the - * User Profile launches.

    + *

    The number of times to retry the job when the job fails due to an + * InternalServerError.

    */ - Tags?: Tag[]; + RetryStrategy?: RetryStrategy; /** * @public - *

    A collection of settings.

    + *

    Contains information about the infrastructure health check configuration for the training job.

    */ - UserSettings?: UserSettings; + InfraCheckConfig?: InfraCheckConfig; } /** * @public */ -export interface CreateUserProfileResponse { +export interface CreateTrainingJobResponse { /** * @public - *

    The user profile Amazon Resource Name (ARN).

    + *

    The Amazon Resource Name (ARN) of the training job.

    */ - UserProfileArn?: string; + TrainingJobArn: string | undefined; } /** * @public - *

    Use this parameter to configure your OIDC Identity Provider (IdP).

    + * @enum */ -export interface OidcConfig { - /** - * @public - *

    The OIDC IdP client ID used to configure your private workforce.

    - */ - ClientId: string | undefined; - - /** - * @public - *

    The OIDC IdP client secret used to configure your private workforce.

    - */ - ClientSecret: string | undefined; +export const JoinSource = { + INPUT: "Input", + NONE: "None", +} as const; - /** - * @public - *

    The OIDC IdP issuer used to configure your private workforce.

    - */ - Issuer: string | undefined; +/** + * @public + */ +export type JoinSource = (typeof JoinSource)[keyof typeof JoinSource]; +/** + * @public + *

    The data structure used to specify the data to be used for inference in a batch + * transform job and to associate the data that is relevant to the prediction results in + * the output. The input filter provided allows you to exclude input data that is not + * needed for inference in a batch transform job. The output filter provided allows you to + * include input data relevant to interpreting the predictions in the output from the job. + * For more information, see Associate Prediction + * Results with their Corresponding Input Records.

    + */ +export interface DataProcessing { /** * @public - *

    The OIDC IdP authorization endpoint used to configure your private workforce.

    + *

    A JSONPath expression used to select a portion of the input data to pass to + * the algorithm. Use the InputFilter parameter to exclude fields, such as an + * ID column, from the input. If you want SageMaker to pass the entire input dataset to the + * algorithm, accept the default value $.

    + *

    Examples: "$", "$[1:]", "$.features" + *

    */ - AuthorizationEndpoint: string | undefined; + InputFilter?: string; /** * @public - *

    The OIDC IdP token endpoint used to configure your private workforce.

    + *

    A JSONPath expression used to select a portion of the joined dataset to save + * in the output file for a batch transform job. If you want SageMaker to store the entire input + * dataset in the output file, leave the default value, $. If you specify + * indexes that aren't within the dimension size of the joined dataset, you get an + * error.

    + *

    Examples: "$", "$[0,5:]", + * "$['id','SageMakerOutput']" + *

    */ - TokenEndpoint: string | undefined; + OutputFilter?: string; /** * @public - *

    The OIDC IdP user information endpoint used to configure your private workforce.

    + *

    Specifies the source of the data to join with the transformed data. The valid values + * are None and Input. The default value is None, + * which specifies not to join the input with the transformed data. If you want the batch + * transform job to join the original input data with the transformed data, set + * JoinSource to Input. You can specify + * OutputFilter as an additional filter to select a portion of the joined + * dataset and store it in the output file.

    + *

    For JSON or JSONLines objects, such as a JSON array, SageMaker adds the transformed data to + * the input JSON object in an attribute called SageMakerOutput. The joined + * result for JSON must be a key-value pair object. If the input is not a key-value pair + * object, SageMaker creates a new JSON file. In the new JSON file, and the input data is stored + * under the SageMakerInput key and the results are stored in + * SageMakerOutput.

    + *

    For CSV data, SageMaker takes each row as a JSON array and joins the transformed data with + * the input by appending each transformed row to the end of the input. The joined data has + * the original input data followed by the transformed data and the output is a CSV + * file.

    + *

    For information on how joining in applied, see Workflow for Associating Inferences with Input Records.

    */ - UserInfoEndpoint: string | undefined; + JoinSource?: JoinSource; +} +/** + * @public + *

    Configures the timeout and maximum number of retries for processing a transform job + * invocation.

    + */ +export interface ModelClientConfig { /** * @public - *

    The OIDC IdP logout endpoint used to configure your private workforce.

    + *

    The timeout value in seconds for an invocation request. The default value is + * 600.

    */ - LogoutEndpoint: string | undefined; + InvocationsTimeoutInSeconds?: number; /** * @public - *

    The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.

    + *

    The maximum number of retries when invocation requests are failing. The default value + * is 3.

    */ - JwksUri: string | undefined; + InvocationsMaxRetries?: number; } /** * @public - *

    A list of IP address ranges (CIDRs). Used to create an allow - * list of IP addresses for a private workforce. Workers will only be able to login to their worker portal from an - * IP address within this range. By default, a workforce isn't restricted to specific IP addresses.

    */ -export interface SourceIpConfig { +export interface CreateTransformJobRequest { /** * @public - *

    A list of one to ten Classless Inter-Domain Routing (CIDR) values.

    - *

    Maximum: Ten CIDR values

    - * - *

    The following Length Constraints apply to individual CIDR values in - * the CIDR value list.

    - *     + *

    The name of the transform job. The name must be unique within an Amazon Web Services Region in an + * Amazon Web Services account.

    */ - Cidrs: string[] | undefined; -} + TransformJobName: string | undefined; -/** - * @public - *

    The VPC object you use to create or update a workforce.

    - */ -export interface WorkforceVpcConfigRequest { /** * @public - *

    The ID of the VPC that the workforce uses for communication.

    + *

    The name of the model that you want to use for the transform job. + * ModelName must be the name of an existing Amazon SageMaker model within an Amazon Web Services + * Region in an Amazon Web Services account.

    */ - VpcId?: string; + ModelName: string | undefined; /** * @public - *

    The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

    + *

    The maximum number of parallel requests that can be sent to each instance in a + * transform job. If MaxConcurrentTransforms is set to 0 or left + * unset, Amazon SageMaker checks the optional execution-parameters to determine the settings for your + * chosen algorithm. If the execution-parameters endpoint is not enabled, the default value + * is 1. For more information on execution-parameters, see How Containers Serve Requests. For built-in algorithms, you don't need to + * set a value for MaxConcurrentTransforms.

    */ - SecurityGroupIds?: string[]; + MaxConcurrentTransforms?: number; /** * @public - *

    The ID of the subnets in the VPC that you want to connect.

    + *

    Configures the timeout and maximum number of retries for processing a transform job + * invocation.

    */ - Subnets?: string[]; -} + ModelClientConfig?: ModelClientConfig; -/** - * @public - */ -export interface CreateWorkforceRequest { /** * @public - *

    Use this parameter to configure an Amazon Cognito private workforce. - * A single Cognito workforce is created using and corresponds to a single - * - * Amazon Cognito user pool.

    - *

    Do not use OidcConfig if you specify values for - * CognitoConfig.

    + *

    The maximum allowed size of the payload, in MB. A payload is the + * data portion of a record (without metadata). The value in MaxPayloadInMB + * must be greater than, or equal to, the size of a single record. To estimate the size of + * a record in MB, divide the size of your dataset by the number of records. To ensure that + * the records fit within the maximum payload size, we recommend using a slightly larger + * value. The default value is 6 MB. + *

    + *

    The value of MaxPayloadInMB cannot be greater than 100 MB. If you specify + * the MaxConcurrentTransforms parameter, the value of + * (MaxConcurrentTransforms * MaxPayloadInMB) also cannot exceed 100 + * MB.

    + *

    For cases where the payload might be arbitrarily large and is transmitted using HTTP + * chunked encoding, set the value to 0. + * This + * feature works only in supported algorithms. Currently, Amazon SageMaker built-in + * algorithms do not support HTTP chunked encoding.

    */ - CognitoConfig?: CognitoConfig; + MaxPayloadInMB?: number; /** * @public - *

    Use this parameter to configure a private workforce using your own OIDC Identity Provider.

    - *

    Do not use CognitoConfig if you specify values for - * OidcConfig.

    + *

    Specifies the number of records to include in a mini-batch for an HTTP inference + * request. A record + * is a single unit of input data that + * inference can be made on. For example, a single line in a CSV file is a record.

    + *

    To enable the batch strategy, you must set the SplitType property to + * Line, RecordIO, or TFRecord.

    + *

    To use only one record when making an HTTP invocation request to a container, set + * BatchStrategy to SingleRecord and SplitType + * to Line.

    + *

    To fit as many records in a mini-batch as can fit within the + * MaxPayloadInMB limit, set BatchStrategy to + * MultiRecord and SplitType to Line.

    */ - OidcConfig?: OidcConfig; + BatchStrategy?: BatchStrategy; /** * @public - *

    A list of IP address ranges (CIDRs). Used to create an allow - * list of IP addresses for a private workforce. Workers will only be able to login to their worker portal from an - * IP address within this range. By default, a workforce isn't restricted to specific IP addresses.

    + *

    The environment variables to set in the Docker container. We support up to 16 key and + * values entries in the map.

    */ - SourceIpConfig?: SourceIpConfig; + Environment?: Record; /** * @public - *

    The name of the private workforce.

    + *

    Describes the input source and + * the + * way the transform job consumes it.

    */ - WorkforceName: string | undefined; + TransformInput: TransformInput | undefined; /** * @public - *

    An array of key-value pairs that contain metadata to help you categorize and - * organize our workforce. Each tag consists of a key and a value, - * both of which you define.

    + *

    Describes the results of the transform job.

    */ - Tags?: Tag[]; + TransformOutput: TransformOutput | undefined; /** * @public - *

    Use this parameter to configure a workforce using VPC.

    + *

    Configuration to control how SageMaker captures inference data.

    */ - WorkforceVpcConfig?: WorkforceVpcConfigRequest; -} + DataCaptureConfig?: BatchDataCaptureConfig; -/** - * @public - */ -export interface CreateWorkforceResponse { /** * @public - *

    The Amazon Resource Name (ARN) of the workforce.

    + *

    Describes the resources, including + * ML + * instance types and ML instance count, to use for the transform + * job.

    */ - WorkforceArn: string | undefined; -} + TransformResources: TransformResources | undefined; -/** - * @public - *

    A list of user groups that exist in your OIDC Identity Provider (IdP). - * One to ten groups can be used to create a single private work team. - * When you add a user group to the list of Groups, you can add that user group to one or more - * private work teams. If you add a user group to a private work team, all workers in that user group - * are added to the work team.

    - */ -export interface OidcMemberDefinition { /** * @public - *

    A list of comma seperated strings that identifies - * user groups in your OIDC IdP. Each user group is - * made up of a group of private workers.

    + *

    The data structure used to specify the data to be used for inference in a batch + * transform job and to associate the data that is relevant to the prediction results in + * the output. The input filter provided allows you to exclude input data that is not + * needed for inference in a batch transform job. The output filter provided allows you to + * include input data relevant to interpreting the predictions in the output from the job. + * For more information, see Associate Prediction + * Results with their Corresponding Input Records.

    */ - Groups: string[] | undefined; -} + DataProcessing?: DataProcessing; -/** - * @public - *

    Defines an Amazon Cognito or your own OIDC IdP user group that is part of a work team.

    - */ -export interface MemberDefinition { /** * @public - *

    The Amazon Cognito user group that is part of the work team.

    + *

    (Optional) + * An + * array of key-value pairs. For more information, see Using + * Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User + * Guide.

    */ - CognitoMemberDefinition?: CognitoMemberDefinition; + Tags?: Tag[]; /** * @public - *

    A list user groups that exist in your OIDC Identity Provider (IdP). - * One to ten groups can be used to create a single private work team. - * When you add a user group to the list of Groups, you can add that user group to one or more - * private work teams. If you add a user group to a private work team, all workers in that user group - * are added to the work team.

    + *

    Associates a SageMaker job as a trial component with an experiment and trial. Specified when + * you call the following APIs:

    + * */ - OidcMemberDefinition?: OidcMemberDefinition; + ExperimentConfig?: ExperimentConfig; } /** * @public - *

    Configures Amazon SNS notifications of available or expiring work items for work - * teams.

    */ -export interface NotificationConfiguration { +export interface CreateTransformJobResponse { /** * @public - *

    The ARN for the Amazon SNS topic to which notifications should be published.

    + *

    The Amazon Resource Name (ARN) of the transform job.

    */ - NotificationTopicArn?: string; + TransformJobArn: string | undefined; } /** * @public */ -export interface CreateWorkteamRequest { - /** - * @public - *

    The name of the work team. Use this name to identify the work team.

    - */ - WorkteamName: string | undefined; - +export interface CreateTrialRequest { /** * @public - *

    The name of the workforce.

    + *

    The name of the trial. The name must be unique in your Amazon Web Services account and is not + * case-sensitive.

    */ - WorkforceName?: string; + TrialName: string | undefined; /** * @public - *

    A list of MemberDefinition objects that contains objects that identify - * the workers that make up the work team.

    - *

    Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For - * private workforces created using Amazon Cognito use CognitoMemberDefinition. For - * workforces created using your own OIDC identity provider (IdP) use - * OidcMemberDefinition. Do not provide input for both of these parameters - * in a single request.

    - *

    For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito - * user groups within the user pool used to create a workforce. All of the - * CognitoMemberDefinition objects that make up the member definition must - * have the same ClientId and UserPool values. To add a Amazon - * Cognito user group to an existing worker pool, see Adding groups to a User - * Pool. For more information about user pools, see Amazon Cognito User - * Pools.

    - *

    For workforces created using your own OIDC IdP, specify the user groups that you want to - * include in your private work team in OidcMemberDefinition by listing those groups - * in Groups.

    + *

    The name of the trial as displayed. The name doesn't need to be unique. If + * DisplayName isn't specified, TrialName is displayed.

    */ - MemberDefinitions: MemberDefinition[] | undefined; + DisplayName?: string; /** * @public - *

    A description of the work team.

    + *

    The name of the experiment to associate the trial with.

    */ - Description: string | undefined; + ExperimentName: string | undefined; /** * @public - *

    Configures notification of workers regarding available or expiring work items.

    + *

    Metadata properties of the tracking entity, trial, or trial component.

    */ - NotificationConfiguration?: NotificationConfiguration; + MetadataProperties?: MetadataProperties; /** * @public - *

    An array of key-value pairs.

    - *

    For more information, see Resource - * Tag and Using - * Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User - * Guide.

    + *

    A list of tags to associate with the trial. You can use Search API to + * search on the tags.

    */ Tags?: Tag[]; } @@ -11776,115 +11966,107 @@ export interface CreateWorkteamRequest { /** * @public */ -export interface CreateWorkteamResponse { +export interface CreateTrialResponse { /** * @public - *

    The Amazon Resource Name (ARN) of the work team. You can use this ARN to identify the - * work team.

    + *

    The Amazon Resource Name (ARN) of the trial.

    */ - WorkteamArn?: string; + TrialArn?: string; } /** * @public - * @enum - */ -export const CrossAccountFilterOption = { - CROSS_ACCOUNT: "CrossAccount", - SAME_ACCOUNT: "SameAccount", -} as const; - -/** - * @public - */ -export type CrossAccountFilterOption = (typeof CrossAccountFilterOption)[keyof typeof CrossAccountFilterOption]; - -/** - * @public - * @enum - */ -export const Statistic = { - AVERAGE: "Average", - MAXIMUM: "Maximum", - MINIMUM: "Minimum", - SAMPLE_COUNT: "SampleCount", - SUM: "Sum", -} as const; - -/** - * @public - */ -export type Statistic = (typeof Statistic)[keyof typeof Statistic]; - -/** - * @public - *

    A customized metric.

    + *

    Represents an input or output artifact of a trial component. You specify + * TrialComponentArtifact as part of the InputArtifacts and + * OutputArtifacts parameters in the CreateTrialComponent + * request.

    + *

    Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and + * instance types. Examples of output artifacts are metrics, snapshots, logs, and images.

    */ -export interface CustomizedMetricSpecification { - /** - * @public - *

    The name of the customized metric.

    - */ - MetricName?: string; - +export interface TrialComponentArtifact { /** * @public - *

    The namespace of the customized metric.

    + *

    The media type of the artifact, which indicates the type of data in the artifact file. The + * media type consists of a type and a subtype + * concatenated with a slash (/) character, for example, text/csv, image/jpeg, and s3/uri. The + * type specifies the category of the media. The subtype specifies the kind of data.

    */ - Namespace?: string; + MediaType?: string; /** * @public - *

    The statistic of the customized metric.

    + *

    The location of the artifact.

    */ - Statistic?: Statistic; + Value: string | undefined; } /** * @public - *

    The currently active data capture configuration used by your Endpoint.

    + *

    The value of a hyperparameter. Only one of NumberValue or + * StringValue can be specified.

    + *

    This object is specified in the CreateTrialComponent request.

    */ -export interface DataCaptureConfigSummary { - /** - * @public - *

    Whether data capture is enabled or disabled.

    - */ - EnableCapture: boolean | undefined; +export type TrialComponentParameterValue = + | TrialComponentParameterValue.NumberValueMember + | TrialComponentParameterValue.StringValueMember + | TrialComponentParameterValue.$UnknownMember; +/** + * @public + */ +export namespace TrialComponentParameterValue { /** * @public - *

    Whether data capture is currently functional.

    + *

    The string value of a categorical hyperparameter. If you specify a value for this + * parameter, you can't specify the NumberValue parameter.

    */ - CaptureStatus: CaptureStatus | undefined; + export interface StringValueMember { + StringValue: string; + NumberValue?: never; + $unknown?: never; + } /** * @public - *

    The percentage of requests being captured by your Endpoint.

    + *

    The numeric value of a numeric hyperparameter. If you specify a value for this parameter, + * you can't specify the StringValue parameter.

    */ - CurrentSamplingPercentage: number | undefined; + export interface NumberValueMember { + StringValue?: never; + NumberValue: number; + $unknown?: never; + } /** * @public - *

    The Amazon S3 location being used to capture the data.

    */ - DestinationS3Uri: string | undefined; + export interface $UnknownMember { + StringValue?: never; + NumberValue?: never; + $unknown: [string, any]; + } - /** - * @public - *

    The KMS key being used to encrypt the data in Amazon S3.

    - */ - KmsKeyId: string | undefined; + export interface Visitor { + StringValue: (value: string) => T; + NumberValue: (value: number) => T; + _: (name: string, value: any) => T; + } + + export const visit = (value: TrialComponentParameterValue, visitor: Visitor): T => { + if (value.StringValue !== undefined) return visitor.StringValue(value.StringValue); + if (value.NumberValue !== undefined) return visitor.NumberValue(value.NumberValue); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; } /** * @public * @enum */ -export const RuleEvaluationStatus = { - ERROR: "Error", +export const TrialComponentPrimaryStatus = { + COMPLETED: "Completed", + FAILED: "Failed", IN_PROGRESS: "InProgress", - ISSUES_FOUND: "IssuesFound", - NO_ISSUES_FOUND: "NoIssuesFound", STOPPED: "Stopped", STOPPING: "Stopping", } as const; @@ -11892,183 +12074,166 @@ export const RuleEvaluationStatus = { /** * @public */ -export type RuleEvaluationStatus = (typeof RuleEvaluationStatus)[keyof typeof RuleEvaluationStatus]; +export type TrialComponentPrimaryStatus = + (typeof TrialComponentPrimaryStatus)[keyof typeof TrialComponentPrimaryStatus]; /** * @public - *

    Information about the status of the rule evaluation.

    + *

    The status of the trial component.

    */ -export interface DebugRuleEvaluationStatus { - /** - * @public - *

    The name of the rule configuration.

    - */ - RuleConfigurationName?: string; - +export interface TrialComponentStatus { /** * @public - *

    The Amazon Resource Name (ARN) of the rule evaluation job.

    + *

    The status of the trial component.

    */ - RuleEvaluationJobArn?: string; + PrimaryStatus?: TrialComponentPrimaryStatus; /** * @public - *

    Status of the rule evaluation.

    + *

    If the component failed, a message describing why.

    */ - RuleEvaluationStatus?: RuleEvaluationStatus; + Message?: string; +} +/** + * @public + */ +export interface CreateTrialComponentRequest { /** * @public - *

    Details from the rule evaluation.

    + *

    The name of the component. The name must be unique in your Amazon Web Services account and is not + * case-sensitive.

    */ - StatusDetails?: string; + TrialComponentName: string | undefined; /** * @public - *

    Timestamp when the rule evaluation status was last modified.

    + *

    The name of the component as displayed. The name doesn't need to be unique. If + * DisplayName isn't specified, TrialComponentName is + * displayed.

    */ - LastModifiedTime?: Date; -} + DisplayName?: string; -/** - * @public - */ -export interface DeleteActionRequest { /** * @public - *

    The name of the action to delete.

    + *

    The status of the component. States include:

    + *
      + *
    • + *

      InProgress

      + *
      • + *
    • + *

      Completed

      + *
      • + *
    • + *

      Failed

      + *
      • + *
    */ - ActionName: string | undefined; -} + Status?: TrialComponentStatus; -/** - * @public - */ -export interface DeleteActionResponse { /** * @public - *

    The Amazon Resource Name (ARN) of the action.

    + *

    When the component started.

    */ - ActionArn?: string; -} + StartTime?: Date; -/** - * @public - */ -export interface DeleteAlgorithmInput { /** * @public - *

    The name of the algorithm to delete.

    + *

    When the component ended.

    */ - AlgorithmName: string | undefined; -} + EndTime?: Date; -/** - * @public - */ -export interface DeleteAppRequest { /** * @public - *

    The domain ID.

    + *

    The hyperparameters for the component.

    */ - DomainId: string | undefined; + Parameters?: Record; /** * @public - *

    The user profile name. If this value is not set, then SpaceName must be set.

    + *

    The input artifacts for the component. Examples of input artifacts are datasets, + * algorithms, hyperparameters, source code, and instance types.

    */ - UserProfileName?: string; + InputArtifacts?: Record; /** * @public - *

    The type of app.

    + *

    The output artifacts for the component. Examples of output artifacts are metrics, + * snapshots, logs, and images.

    */ - AppType: AppType | undefined; + OutputArtifacts?: Record; /** * @public - *

    The name of the app.

    + *

    Metadata properties of the tracking entity, trial, or trial component.

    */ - AppName: string | undefined; + MetadataProperties?: MetadataProperties; /** * @public - *

    The name of the space. If this value is not set, then UserProfileName must be set.

    + *

    A list of tags to associate with the component. You can use Search API + * to search on the tags.

    */ - SpaceName?: string; + Tags?: Tag[]; } /** * @public */ -export interface DeleteAppImageConfigRequest { +export interface CreateTrialComponentResponse { /** * @public - *

    The name of the AppImageConfig to delete.

    + *

    The Amazon Resource Name (ARN) of the trial component.

    */ - AppImageConfigName: string | undefined; + TrialComponentArn?: string; } /** * @public */ -export interface DeleteArtifactRequest { - /** - * @public - *

    The Amazon Resource Name (ARN) of the artifact to delete.

    - */ - ArtifactArn?: string; - +export interface CreateUserProfileRequest { /** * @public - *

    The URI of the source.

    + *

    The ID of the associated Domain.

    */ - Source?: ArtifactSource; -} + DomainId: string | undefined; -/** - * @public - */ -export interface DeleteArtifactResponse { /** * @public - *

    The Amazon Resource Name (ARN) of the artifact.

    + *

    A name for the UserProfile. This value is not case sensitive.

    */ - ArtifactArn?: string; -} + UserProfileName: string | undefined; -/** - * @public - */ -export interface DeleteAssociationRequest { /** * @public - *

    The ARN of the source.

    + *

    A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName". + * If the Domain's AuthMode is IAM Identity Center, this field is required. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified. + *

    */ - SourceArn: string | undefined; + SingleSignOnUserIdentifier?: string; /** * @public - *

    The Amazon Resource Name (ARN) of the destination.

    + *

    The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain's AuthMode is IAM Identity Center, this field is + * required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified. + *

    */ - DestinationArn: string | undefined; -} + SingleSignOnUserValue?: string; -/** - * @public - */ -export interface DeleteAssociationResponse { /** * @public - *

    The ARN of the source.

    + *

    Each tag consists of a key and an optional value. + * Tag keys must be unique per resource.

    + *

    Tags that you specify for the User Profile are also added to all Apps that the + * User Profile launches.

    */ - SourceArn?: string; + Tags?: Tag[]; /** * @public - *

    The Amazon Resource Name (ARN) of the destination.

    + *

    A collection of settings.

    */ - DestinationArn?: string; + UserSettings?: UserSettings; } /** @@ -12078,19 +12243,3 @@ export const CreateModelCardRequestFilterSensitiveLog = (obj: CreateModelCardReq ...obj, ...(obj.Content && { Content: SENSITIVE_STRING }), }); - -/** - * @internal - */ -export const OidcConfigFilterSensitiveLog = (obj: OidcConfig): any => ({ - ...obj, - ...(obj.ClientSecret && { ClientSecret: SENSITIVE_STRING }), -}); - -/** - * @internal - */ -export const CreateWorkforceRequestFilterSensitiveLog = (obj: CreateWorkforceRequest): any => ({ - ...obj, - ...(obj.OidcConfig && { OidcConfig: OidcConfigFilterSensitiveLog(obj.OidcConfig) }), -}); diff --git a/clients/client-sagemaker/src/models/models_2.ts b/clients/client-sagemaker/src/models/models_2.ts index 91856dcebc42..910b64d0ba10 100644 --- a/clients/client-sagemaker/src/models/models_2.ts +++ b/clients/client-sagemaker/src/models/models_2.ts @@ -15,7 +15,6 @@ import { AppStatus, AppType, ArtifactSource, - AssociationEdgeType, AsyncInferenceConfig, AuthMode, AutoMLCandidate, @@ -37,15 +36,17 @@ import { Autotune, BatchDataCaptureConfig, BatchStrategy, + CaptureStatus, Channel, CheckpointConfig, + ClusterInstanceGroupDetails, + ClusterNodeDetails, + ClusterStatus, CognitoConfig, + CognitoMemberDefinition, CompilationJobStatus, ContainerDefinition, ContextSource, - DataQualityAppSpecification, - DataQualityBaselineConfig, - DataQualityJobInput, GitConfig, HyperParameterTuningJobObjectiveType, InferenceSpecification, @@ -55,8 +56,6 @@ import { ModelApprovalStatus, ModelDeployConfig, ModelPackageStatus, - MonitoringOutputConfig, - MonitoringResources, NeoVpcConfig, ObjectiveStatus, OutputConfig, @@ -76,13 +75,13 @@ import { } from "./models_0"; import { _InstanceType, - CustomizedMetricSpecification, DataCaptureConfig, - DataCaptureConfigSummary, DataProcessing, + DataQualityAppSpecification, + DataQualityBaselineConfig, + DataQualityJobInput, DebugHookConfig, DebugRuleConfiguration, - DebugRuleEvaluationStatus, DefaultSpaceSettings, DeploymentConfig, DeviceSelectionConfig, @@ -94,7 +93,6 @@ import { EdgeOutputConfig, EdgePresetDeploymentType, EndpointInfo, - ExecutionRoleIdentityConfig, ExperimentConfig, ExplainerConfig, FeatureDefinition, @@ -108,17 +106,19 @@ import { HyperParameterTrainingJobDefinition, HyperParameterTuningJobConfig, HyperParameterTuningJobWarmStartConfig, + InferenceComponentComputeResourceRequirements, + InferenceComponentStartupParameters, InferenceExecutionConfig, InferenceExperimentDataStorageConfig, InferenceExperimentSchedule, InferenceExperimentType, + InfraCheckConfig, InstanceMetadataServiceConfiguration, JobType, LabelingJobAlgorithmsConfig, LabelingJobInputConfig, LabelingJobOutputConfig, LabelingJobStoppingConditions, - MemberDefinition, ModelBiasAppSpecification, ModelBiasBaselineConfig, ModelBiasJobInput, @@ -136,13 +136,14 @@ import { ModelQualityBaselineConfig, ModelQualityJobInput, MonitoringNetworkConfig, + MonitoringOutputConfig, + MonitoringResources, MonitoringScheduleConfig, MonitoringStoppingCondition, MonitoringType, NetworkConfig, NotebookInstanceAcceleratorType, NotebookInstanceLifecycleHook, - NotificationConfiguration, OfflineStoreConfig, OnlineStoreConfig, ParallelismConfiguration, @@ -153,6 +154,8 @@ import { Processor, ProductionVariant, ProductionVariantAcceleratorType, + ProductionVariantManagedInstanceScaling, + ProductionVariantRoutingConfig, ProductionVariantServerlessConfig, ProfilerConfig, ProfilerRuleConfiguration, @@ -161,12 +164,10 @@ import { RecommendationJobType, RetryStrategy, RootAccess, - RuleEvaluationStatus, ServiceCatalogProvisioningDetails, ShadowModeConfig, SkipModelValidation, SourceAlgorithmSpecification, - SourceIpConfig, SpaceSettings, StudioLifecycleConfigAppType, TensorBoardOutputConfig, @@ -180,1056 +181,1218 @@ import { /** * @public */ -export interface DeleteCodeRepositoryInput { +export interface CreateUserProfileResponse { /** * @public - *

    The name of the Git repository to delete.

    + *

    The user profile Amazon Resource Name (ARN).

    */ - CodeRepositoryName: string | undefined; + UserProfileArn?: string; } /** * @public + *

    Use this parameter to configure your OIDC Identity Provider (IdP).

    */ -export interface DeleteContextRequest { +export interface OidcConfig { /** * @public - *

    The name of the context to delete.

    + *

    The OIDC IdP client ID used to configure your private workforce.

    */ - ContextName: string | undefined; -} + ClientId: string | undefined; -/** - * @public - */ -export interface DeleteContextResponse { /** * @public - *

    The Amazon Resource Name (ARN) of the context.

    + *

    The OIDC IdP client secret used to configure your private workforce.

    */ - ContextArn?: string; -} + ClientSecret: string | undefined; -/** - * @public - */ -export interface DeleteDataQualityJobDefinitionRequest { /** * @public - *

    The name of the data quality monitoring job definition to delete.

    + *

    The OIDC IdP issuer used to configure your private workforce.

    */ - JobDefinitionName: string | undefined; -} + Issuer: string | undefined; -/** - * @public - */ -export interface DeleteDeviceFleetRequest { /** * @public - *

    The name of the fleet to delete.

    + *

    The OIDC IdP authorization endpoint used to configure your private workforce.

    */ - DeviceFleetName: string | undefined; -} - -/** - * @public - * @enum - */ -export const RetentionType = { - Delete: "Delete", - Retain: "Retain", -} as const; + AuthorizationEndpoint: string | undefined; -/** - * @public - */ -export type RetentionType = (typeof RetentionType)[keyof typeof RetentionType]; + /** + * @public + *

    The OIDC IdP token endpoint used to configure your private workforce.

    + */ + TokenEndpoint: string | undefined; -/** - * @public - *

    The retention policy for data stored on an Amazon Elastic File System (EFS) volume.

    - */ -export interface RetentionPolicy { /** * @public - *

    The default is Retain, which specifies to keep the data stored on the EFS volume.

    - *

    Specify Delete to delete the data stored on the EFS volume.

    + *

    The OIDC IdP user information endpoint used to configure your private workforce.

    */ - HomeEfsFileSystem?: RetentionType; -} + UserInfoEndpoint: string | undefined; -/** - * @public - */ -export interface DeleteDomainRequest { /** * @public - *

    The domain ID.

    + *

    The OIDC IdP logout endpoint used to configure your private workforce.

    */ - DomainId: string | undefined; + LogoutEndpoint: string | undefined; /** * @public - *

    The retention policy for this domain, which specifies whether resources will be retained after the Domain is deleted. - * By default, all resources are retained (not automatically deleted). - *

    + *

    The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.

    */ - RetentionPolicy?: RetentionPolicy; + JwksUri: string | undefined; } /** * @public + *

    A list of IP address ranges (CIDRs). Used to create an allow + * list of IP addresses for a private workforce. Workers will only be able to login to their worker portal from an + * IP address within this range. By default, a workforce isn't restricted to specific IP addresses.

    */ -export interface DeleteEdgeDeploymentPlanRequest { +export interface SourceIpConfig { /** * @public - *

    The name of the edge deployment plan to delete.

    + *

    A list of one to ten Classless Inter-Domain Routing (CIDR) values.

    + *

    Maximum: Ten CIDR values

    + * + *

    The following Length Constraints apply to individual CIDR values in + * the CIDR value list.

    + *     */ - EdgeDeploymentPlanName: string | undefined; + Cidrs: string[] | undefined; } /** * @public + *

    The VPC object you use to create or update a workforce.

    */ -export interface DeleteEdgeDeploymentStageRequest { +export interface WorkforceVpcConfigRequest { /** * @public - *

    The name of the edge deployment plan from which the stage will be deleted.

    + *

    The ID of the VPC that the workforce uses for communication.

    */ - EdgeDeploymentPlanName: string | undefined; + VpcId?: string; /** * @public - *

    The name of the stage.

    + *

    The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

    */ - StageName: string | undefined; -} + SecurityGroupIds?: string[]; -/** - * @public - */ -export interface DeleteEndpointInput { /** * @public - *

    The name of the endpoint that you want to delete.

    + *

    The ID of the subnets in the VPC that you want to connect.

    */ - EndpointName: string | undefined; + Subnets?: string[]; } /** * @public */ -export interface DeleteEndpointConfigInput { +export interface CreateWorkforceRequest { /** * @public - *

    The name of the endpoint configuration that you want to delete.

    + *

    Use this parameter to configure an Amazon Cognito private workforce. + * A single Cognito workforce is created using and corresponds to a single + * + * Amazon Cognito user pool.

    + *

    Do not use OidcConfig if you specify values for + * CognitoConfig.

    */ - EndpointConfigName: string | undefined; -} + CognitoConfig?: CognitoConfig; -/** - * @public - */ -export interface DeleteExperimentRequest { /** * @public - *

    The name of the experiment to delete.

    + *

    Use this parameter to configure a private workforce using your own OIDC Identity Provider.

    + *

    Do not use CognitoConfig if you specify values for + * OidcConfig.

    */ - ExperimentName: string | undefined; -} + OidcConfig?: OidcConfig; -/** - * @public - */ -export interface DeleteExperimentResponse { /** * @public - *

    The Amazon Resource Name (ARN) of the experiment that is being deleted.

    + *

    A list of IP address ranges (CIDRs). Used to create an allow + * list of IP addresses for a private workforce. Workers will only be able to login to their worker portal from an + * IP address within this range. By default, a workforce isn't restricted to specific IP addresses.

    */ - ExperimentArn?: string; + SourceIpConfig?: SourceIpConfig; + + /** + * @public + *

    The name of the private workforce.

    + */ + WorkforceName: string | undefined; + + /** + * @public + *

    An array of key-value pairs that contain metadata to help you categorize and + * organize our workforce. Each tag consists of a key and a value, + * both of which you define.

    + */ + Tags?: Tag[]; + + /** + * @public + *

    Use this parameter to configure a workforce using VPC.

    + */ + WorkforceVpcConfig?: WorkforceVpcConfigRequest; } /** * @public */ -export interface DeleteFeatureGroupRequest { +export interface CreateWorkforceResponse { /** * @public - *

    The name of the FeatureGroup you want to delete. The name must be unique - * within an Amazon Web Services Region in an Amazon Web Services account.

    + *

    The Amazon Resource Name (ARN) of the workforce.

    */ - FeatureGroupName: string | undefined; + WorkforceArn: string | undefined; } /** * @public + *

    A list of user groups that exist in your OIDC Identity Provider (IdP). + * One to ten groups can be used to create a single private work team. + * When you add a user group to the list of Groups, you can add that user group to one or more + * private work teams. If you add a user group to a private work team, all workers in that user group + * are added to the work team.

    */ -export interface DeleteFlowDefinitionRequest { +export interface OidcMemberDefinition { /** * @public - *

    The name of the flow definition you are deleting.

    + *

    A list of comma seperated strings that identifies + * user groups in your OIDC IdP. Each user group is + * made up of a group of private workers.

    */ - FlowDefinitionName: string | undefined; + Groups: string[] | undefined; } /** * @public + *

    Defines an Amazon Cognito or your own OIDC IdP user group that is part of a work team.

    */ -export interface DeleteFlowDefinitionResponse {} +export interface MemberDefinition { + /** + * @public + *

    The Amazon Cognito user group that is part of the work team.

    + */ + CognitoMemberDefinition?: CognitoMemberDefinition; -/** - * @public - */ -export interface DeleteHubRequest { /** * @public - *

    The name of the hub to delete.

    + *

    A list user groups that exist in your OIDC Identity Provider (IdP). + * One to ten groups can be used to create a single private work team. + * When you add a user group to the list of Groups, you can add that user group to one or more + * private work teams. If you add a user group to a private work team, all workers in that user group + * are added to the work team.

    */ - HubName: string | undefined; + OidcMemberDefinition?: OidcMemberDefinition; } /** * @public - * @enum + *

    Configures Amazon SNS notifications of available or expiring work items for work + * teams.

    */ -export const HubContentType = { - MODEL: "Model", - NOTEBOOK: "Notebook", -} as const; +export interface NotificationConfiguration { + /** + * @public + *

    The ARN for the Amazon SNS topic to which notifications should be published.

    + */ + NotificationTopicArn?: string; +} /** * @public */ -export type HubContentType = (typeof HubContentType)[keyof typeof HubContentType]; +export interface CreateWorkteamRequest { + /** + * @public + *

    The name of the work team. Use this name to identify the work team.

    + */ + WorkteamName: string | undefined; -/** - * @public - */ -export interface DeleteHubContentRequest { /** * @public - *

    The name of the hub that you want to delete content in.

    + *

    The name of the workforce.

    */ - HubName: string | undefined; + WorkforceName?: string; /** * @public - *

    The type of content that you want to delete from a hub.

    + *

    A list of MemberDefinition objects that contains objects that identify + * the workers that make up the work team.

    + *

    Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For + * private workforces created using Amazon Cognito use CognitoMemberDefinition. For + * workforces created using your own OIDC identity provider (IdP) use + * OidcMemberDefinition. Do not provide input for both of these parameters + * in a single request.

    + *

    For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito + * user groups within the user pool used to create a workforce. All of the + * CognitoMemberDefinition objects that make up the member definition must + * have the same ClientId and UserPool values. To add a Amazon + * Cognito user group to an existing worker pool, see Adding groups to a User + * Pool. For more information about user pools, see Amazon Cognito User + * Pools.

    + *

    For workforces created using your own OIDC IdP, specify the user groups that you want to + * include in your private work team in OidcMemberDefinition by listing those groups + * in Groups.

    */ - HubContentType: HubContentType | undefined; + MemberDefinitions: MemberDefinition[] | undefined; /** * @public - *

    The name of the content that you want to delete from a hub.

    + *

    A description of the work team.

    */ - HubContentName: string | undefined; + Description: string | undefined; /** * @public - *

    The version of the content that you want to delete from a hub.

    + *

    Configures notification of workers regarding available or expiring work items.

    */ - HubContentVersion: string | undefined; + NotificationConfiguration?: NotificationConfiguration; + + /** + * @public + *

    An array of key-value pairs.

    + *

    For more information, see Resource + * Tag and Using + * Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User + * Guide.

    + */ + Tags?: Tag[]; } /** * @public */ -export interface DeleteHumanTaskUiRequest { +export interface CreateWorkteamResponse { /** * @public - *

    The name of the human task user interface (work task template) you want to delete.

    + *

    The Amazon Resource Name (ARN) of the work team. You can use this ARN to identify the + * work team.

    */ - HumanTaskUiName: string | undefined; + WorkteamArn?: string; } /** * @public + * @enum */ -export interface DeleteHumanTaskUiResponse {} +export const CrossAccountFilterOption = { + CROSS_ACCOUNT: "CrossAccount", + SAME_ACCOUNT: "SameAccount", +} as const; /** * @public */ -export interface DeleteImageRequest { - /** - * @public - *

    The name of the image to delete.

    - */ - ImageName: string | undefined; -} +export type CrossAccountFilterOption = (typeof CrossAccountFilterOption)[keyof typeof CrossAccountFilterOption]; /** * @public + * @enum */ -export interface DeleteImageResponse {} +export const Statistic = { + AVERAGE: "Average", + MAXIMUM: "Maximum", + MINIMUM: "Minimum", + SAMPLE_COUNT: "SampleCount", + SUM: "Sum", +} as const; /** * @public */ -export interface DeleteImageVersionRequest { +export type Statistic = (typeof Statistic)[keyof typeof Statistic]; + +/** + * @public + *

    A customized metric.

    + */ +export interface CustomizedMetricSpecification { /** * @public - *

    The name of the image to delete.

    + *

    The name of the customized metric.

    */ - ImageName: string | undefined; + MetricName?: string; /** * @public - *

    The version to delete.

    + *

    The namespace of the customized metric.

    */ - Version?: number; + Namespace?: string; /** * @public - *

    The alias of the image to delete.

    + *

    The statistic of the customized metric.

    */ - Alias?: string; + Statistic?: Statistic; } /** * @public + *

    The currently active data capture configuration used by your Endpoint.

    */ -export interface DeleteImageVersionResponse {} +export interface DataCaptureConfigSummary { + /** + * @public + *

    Whether data capture is enabled or disabled.

    + */ + EnableCapture: boolean | undefined; -/** - * @public - */ -export interface DeleteInferenceExperimentRequest { /** * @public - *

    The name of the inference experiment you want to delete.

    + *

    Whether data capture is currently functional.

    */ - Name: string | undefined; -} + CaptureStatus: CaptureStatus | undefined; -/** - * @public - */ -export interface DeleteInferenceExperimentResponse { /** * @public - *

    The ARN of the deleted inference experiment.

    + *

    The percentage of requests being captured by your Endpoint.

    */ - InferenceExperimentArn: string | undefined; -} + CurrentSamplingPercentage: number | undefined; -/** - * @public - */ -export interface DeleteModelInput { /** * @public - *

    The name of the model to delete.

    + *

    The Amazon S3 location being used to capture the data.

    */ - ModelName: string | undefined; + DestinationS3Uri: string | undefined; + + /** + * @public + *

    The KMS key being used to encrypt the data in Amazon S3.

    + */ + KmsKeyId: string | undefined; } /** * @public + * @enum */ -export interface DeleteModelBiasJobDefinitionRequest { - /** - * @public - *

    The name of the model bias job definition to delete.

    - */ - JobDefinitionName: string | undefined; -} +export const RuleEvaluationStatus = { + ERROR: "Error", + IN_PROGRESS: "InProgress", + ISSUES_FOUND: "IssuesFound", + NO_ISSUES_FOUND: "NoIssuesFound", + STOPPED: "Stopped", + STOPPING: "Stopping", +} as const; /** * @public */ -export interface DeleteModelCardRequest { - /** - * @public - *

    The name of the model card to delete.

    - */ - ModelCardName: string | undefined; -} +export type RuleEvaluationStatus = (typeof RuleEvaluationStatus)[keyof typeof RuleEvaluationStatus]; /** * @public + *

    Information about the status of the rule evaluation.

    */ -export interface DeleteModelExplainabilityJobDefinitionRequest { +export interface DebugRuleEvaluationStatus { /** * @public - *

    The name of the model explainability job definition to delete.

    + *

    The name of the rule configuration.

    */ - JobDefinitionName: string | undefined; -} + RuleConfigurationName?: string; -/** - * @public - */ -export interface DeleteModelPackageInput { /** * @public - *

    The name or Amazon Resource Name (ARN) of the model package to delete.

    - *

    When you specify a name, the name must have 1 to 63 characters. Valid - * characters are a-z, A-Z, 0-9, and - (hyphen).

    + *

    The Amazon Resource Name (ARN) of the rule evaluation job.

    */ - ModelPackageName: string | undefined; -} + RuleEvaluationJobArn?: string; -/** - * @public - */ -export interface DeleteModelPackageGroupInput { /** * @public - *

    The name of the model group to delete.

    + *

    Status of the rule evaluation.

    */ - ModelPackageGroupName: string | undefined; -} + RuleEvaluationStatus?: RuleEvaluationStatus; -/** - * @public - */ -export interface DeleteModelPackageGroupPolicyInput { /** * @public - *

    The name of the model group for which to delete the policy.

    + *

    Details from the rule evaluation.

    */ - ModelPackageGroupName: string | undefined; -} + StatusDetails?: string; -/** - * @public - */ -export interface DeleteModelQualityJobDefinitionRequest { /** * @public - *

    The name of the model quality monitoring job definition to delete.

    + *

    Timestamp when the rule evaluation status was last modified.

    */ - JobDefinitionName: string | undefined; + LastModifiedTime?: Date; } /** * @public */ -export interface DeleteMonitoringScheduleRequest { +export interface DeleteActionRequest { /** * @public - *

    The name of the monitoring schedule to delete.

    + *

    The name of the action to delete.

    */ - MonitoringScheduleName: string | undefined; + ActionName: string | undefined; } /** * @public */ -export interface DeleteNotebookInstanceInput { +export interface DeleteActionResponse { /** * @public - *

    The name of the SageMaker notebook instance to delete.

    + *

    The Amazon Resource Name (ARN) of the action.

    */ - NotebookInstanceName: string | undefined; + ActionArn?: string; } /** * @public */ -export interface DeleteNotebookInstanceLifecycleConfigInput { +export interface DeleteAlgorithmInput { /** * @public - *

    The name of the lifecycle configuration to delete.

    + *

    The name of the algorithm to delete.

    */ - NotebookInstanceLifecycleConfigName: string | undefined; + AlgorithmName: string | undefined; } /** * @public */ -export interface DeletePipelineRequest { +export interface DeleteAppRequest { /** * @public - *

    The name of the pipeline to delete.

    + *

    The domain ID.

    */ - PipelineName: string | undefined; + DomainId: string | undefined; /** * @public - *

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the - * operation. An idempotent operation completes no more than one time.

    + *

    The user profile name. If this value is not set, then SpaceName must be set.

    */ - ClientRequestToken?: string; -} + UserProfileName?: string; -/** - * @public - */ -export interface DeletePipelineResponse { /** * @public - *

    The Amazon Resource Name (ARN) of the pipeline to delete.

    + *

    The type of app.

    */ - PipelineArn?: string; + AppType: AppType | undefined; + + /** + * @public + *

    The name of the app.

    + */ + AppName: string | undefined; + + /** + * @public + *

    The name of the space. If this value is not set, then UserProfileName must be set.

    + */ + SpaceName?: string; } /** * @public */ -export interface DeleteProjectInput { +export interface DeleteAppImageConfigRequest { /** * @public - *

    The name of the project to delete.

    + *

    The name of the AppImageConfig to delete.

    */ - ProjectName: string | undefined; + AppImageConfigName: string | undefined; } /** * @public */ -export interface DeleteSpaceRequest { +export interface DeleteArtifactRequest { /** * @public - *

    The ID of the associated Domain.

    + *

    The Amazon Resource Name (ARN) of the artifact to delete.

    */ - DomainId: string | undefined; + ArtifactArn?: string; /** * @public - *

    The name of the space.

    + *

    The URI of the source.

    */ - SpaceName: string | undefined; + Source?: ArtifactSource; } /** * @public */ -export interface DeleteStudioLifecycleConfigRequest { +export interface DeleteArtifactResponse { /** * @public - *

    The name of the Studio Lifecycle Configuration to delete.

    + *

    The Amazon Resource Name (ARN) of the artifact.

    */ - StudioLifecycleConfigName: string | undefined; + ArtifactArn?: string; } /** * @public */ -export interface DeleteTagsInput { +export interface DeleteAssociationRequest { /** * @public - *

    The Amazon Resource Name (ARN) of the resource whose tags you want to - * delete.

    + *

    The ARN of the source.

    */ - ResourceArn: string | undefined; + SourceArn: string | undefined; /** * @public - *

    An array or one or more tag keys to delete.

    + *

    The Amazon Resource Name (ARN) of the destination.

    */ - TagKeys: string[] | undefined; + DestinationArn: string | undefined; } /** * @public */ -export interface DeleteTagsOutput {} +export interface DeleteAssociationResponse { + /** + * @public + *

    The ARN of the source.

    + */ + SourceArn?: string; + + /** + * @public + *

    The Amazon Resource Name (ARN) of the destination.

    + */ + DestinationArn?: string; +} /** * @public */ -export interface DeleteTrialRequest { +export interface DeleteClusterRequest { /** * @public - *

    The name of the trial to delete.

    + *

    The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster to delete.

    */ - TrialName: string | undefined; + ClusterName: string | undefined; } /** * @public */ -export interface DeleteTrialResponse { +export interface DeleteClusterResponse { /** * @public - *

    The Amazon Resource Name (ARN) of the trial that is being deleted.

    + *

    The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster to delete.

    */ - TrialArn?: string; + ClusterArn: string | undefined; } /** * @public */ -export interface DeleteTrialComponentRequest { +export interface DeleteCodeRepositoryInput { /** * @public - *

    The name of the component to delete.

    + *

    The name of the Git repository to delete.

    */ - TrialComponentName: string | undefined; + CodeRepositoryName: string | undefined; } /** * @public */ -export interface DeleteTrialComponentResponse { +export interface DeleteContextRequest { /** * @public - *

    The Amazon Resource Name (ARN) of the component is being deleted.

    + *

    The name of the context to delete.

    */ - TrialComponentArn?: string; + ContextName: string | undefined; } /** * @public */ -export interface DeleteUserProfileRequest { +export interface DeleteContextResponse { /** * @public - *

    The domain ID.

    + *

    The Amazon Resource Name (ARN) of the context.

    */ - DomainId: string | undefined; + ContextArn?: string; +} +/** + * @public + */ +export interface DeleteDataQualityJobDefinitionRequest { /** * @public - *

    The user profile name.

    + *

    The name of the data quality monitoring job definition to delete.

    */ - UserProfileName: string | undefined; + JobDefinitionName: string | undefined; } /** * @public */ -export interface DeleteWorkforceRequest { +export interface DeleteDeviceFleetRequest { /** * @public - *

    The name of the workforce.

    + *

    The name of the fleet to delete.

    */ - WorkforceName: string | undefined; + DeviceFleetName: string | undefined; } /** * @public + * @enum */ -export interface DeleteWorkforceResponse {} +export const RetentionType = { + Delete: "Delete", + Retain: "Retain", +} as const; /** * @public */ -export interface DeleteWorkteamRequest { - /** - * @public - *

    The name of the work team to delete.

    - */ - WorkteamName: string | undefined; -} +export type RetentionType = (typeof RetentionType)[keyof typeof RetentionType]; /** * @public + *

    The retention policy for data stored on an Amazon Elastic File System (EFS) volume.

    */ -export interface DeleteWorkteamResponse { +export interface RetentionPolicy { /** * @public - *

    Returns true if the work team was successfully deleted; otherwise, - * returns false.

    + *

    The default is Retain, which specifies to keep the data stored on the EFS volume.

    + *

    Specify Delete to delete the data stored on the EFS volume.

    */ - Success: boolean | undefined; + HomeEfsFileSystem?: RetentionType; } /** * @public - *

    Gets the Amazon EC2 Container Registry path of the docker image of the model that is hosted in this ProductionVariant.

    - *

    If you used the registry/repository[:tag] form to specify the image path - * of the primary container when you created the model hosted in this - * ProductionVariant, the path resolves to a path of the form - * registry/repository[@digest]. A digest is a hash value that identifies - * a specific version of an image. For information about Amazon ECR paths, see Pulling an Image in the Amazon ECR User Guide.

    */ -export interface DeployedImage { +export interface DeleteDomainRequest { /** * @public - *

    The image path you specified when you created the model.

    + *

    The domain ID.

    */ - SpecifiedImage?: string; + DomainId: string | undefined; /** * @public - *

    The specific digest path of the image hosted in this - * ProductionVariant.

    + *

    The retention policy for this domain, which specifies whether resources will be retained after the Domain is deleted. + * By default, all resources are retained (not automatically deleted). + *

    */ - ResolvedImage?: string; + RetentionPolicy?: RetentionPolicy; +} +/** + * @public + */ +export interface DeleteEdgeDeploymentPlanRequest { /** * @public - *

    The date and time when the image path for the model resolved to the - * ResolvedImage - *

    + *

    The name of the edge deployment plan to delete.

    */ - ResolutionTime?: Date; + EdgeDeploymentPlanName: string | undefined; } /** * @public - *

    The recommended configuration to use for Real-Time Inference.

    */ -export interface RealTimeInferenceRecommendation { +export interface DeleteEdgeDeploymentStageRequest { /** * @public - *

    The recommendation ID which uniquely identifies each recommendation.

    + *

    The name of the edge deployment plan from which the stage will be deleted.

    */ - RecommendationId: string | undefined; + EdgeDeploymentPlanName: string | undefined; /** * @public - *

    The recommended instance type for Real-Time Inference.

    + *

    The name of the stage.

    */ - InstanceType: ProductionVariantInstanceType | undefined; + StageName: string | undefined; +} +/** + * @public + */ +export interface DeleteEndpointInput { /** * @public - *

    The recommended environment variables to set in the model container for Real-Time Inference.

    + *

    The name of the endpoint that you want to delete.

    */ - Environment?: Record; + EndpointName: string | undefined; } /** * @public - * @enum */ -export const RecommendationStatus = { - COMPLETED: "COMPLETED", - FAILED: "FAILED", - IN_PROGRESS: "IN_PROGRESS", - NOT_APPLICABLE: "NOT_APPLICABLE", -} as const; +export interface DeleteEndpointConfigInput { + /** + * @public + *

    The name of the endpoint configuration that you want to delete.

    + */ + EndpointConfigName: string | undefined; +} /** * @public */ -export type RecommendationStatus = (typeof RecommendationStatus)[keyof typeof RecommendationStatus]; +export interface DeleteExperimentRequest { + /** + * @public + *

    The name of the experiment to delete.

    + */ + ExperimentName: string | undefined; +} /** * @public - *

    A set of recommended deployment configurations for the model. To get more advanced recommendations, see - * CreateInferenceRecommendationsJob - * to create an inference recommendation job.

    */ -export interface DeploymentRecommendation { +export interface DeleteExperimentResponse { /** * @public - *

    Status of the deployment recommendation. The status NOT_APPLICABLE means that SageMaker - * is unable to provide a default recommendation for the model using the information provided. If the deployment status is IN_PROGRESS, - * retry your API call after a few seconds to get a COMPLETED deployment recommendation.

    + *

    The Amazon Resource Name (ARN) of the experiment that is being deleted.

    */ - RecommendationStatus: RecommendationStatus | undefined; + ExperimentArn?: string; +} +/** + * @public + */ +export interface DeleteFeatureGroupRequest { /** * @public - *

    A list of RealTimeInferenceRecommendation items.

    + *

    The name of the FeatureGroup you want to delete. The name must be unique + * within an Amazon Web Services Region in an Amazon Web Services account.

    */ - RealTimeInferenceRecommendations?: RealTimeInferenceRecommendation[]; + FeatureGroupName: string | undefined; } /** * @public - * @enum */ -export const StageStatus = { - Creating: "CREATING", - Deployed: "DEPLOYED", - Failed: "FAILED", - InProgress: "INPROGRESS", - ReadyToDeploy: "READYTODEPLOY", - Starting: "STARTING", - Stopped: "STOPPED", - Stopping: "STOPPING", -} as const; +export interface DeleteFlowDefinitionRequest { + /** + * @public + *

    The name of the flow definition you are deleting.

    + */ + FlowDefinitionName: string | undefined; +} /** * @public */ -export type StageStatus = (typeof StageStatus)[keyof typeof StageStatus]; +export interface DeleteFlowDefinitionResponse {} /** * @public - *

    Contains information summarizing the deployment stage results.

    */ -export interface EdgeDeploymentStatus { +export interface DeleteHubRequest { /** * @public - *

    The general status of the current stage.

    + *

    The name of the hub to delete.

    */ - StageStatus: StageStatus | undefined; + HubName: string | undefined; +} + +/** + * @public + * @enum + */ +export const HubContentType = { + MODEL: "Model", + NOTEBOOK: "Notebook", +} as const; + +/** + * @public + */ +export type HubContentType = (typeof HubContentType)[keyof typeof HubContentType]; +/** + * @public + */ +export interface DeleteHubContentRequest { /** * @public - *

    The number of edge devices with the successful deployment in the current stage.

    + *

    The name of the hub that you want to delete content in.

    */ - EdgeDeploymentSuccessInStage: number | undefined; + HubName: string | undefined; /** * @public - *

    The number of edge devices yet to pick up the deployment in current stage, or in - * progress.

    + *

    The type of content that you want to delete from a hub.

    */ - EdgeDeploymentPendingInStage: number | undefined; + HubContentType: HubContentType | undefined; /** * @public - *

    The number of edge devices that failed the deployment in current stage.

    + *

    The name of the content that you want to delete from a hub.

    */ - EdgeDeploymentFailedInStage: number | undefined; + HubContentName: string | undefined; /** * @public - *

    A detailed message about deployment status in current stage.

    + *

    The version of the content that you want to delete from a hub.

    */ - EdgeDeploymentStatusMessage?: string; + HubContentVersion: string | undefined; +} +/** + * @public + */ +export interface DeleteHumanTaskUiRequest { /** * @public - *

    The time when the deployment API started.

    + *

    The name of the human task user interface (work task template) you want to delete.

    */ - EdgeDeploymentStageStartTime?: Date; + HumanTaskUiName: string | undefined; } /** * @public - *

    Contains information summarizing the deployment stage results.

    */ -export interface DeploymentStageStatusSummary { +export interface DeleteHumanTaskUiResponse {} + +/** + * @public + */ +export interface DeleteImageRequest { /** * @public - *

    The name of the stage.

    + *

    The name of the image to delete.

    */ - StageName: string | undefined; + ImageName: string | undefined; +} + +/** + * @public + */ +export interface DeleteImageResponse {} +/** + * @public + */ +export interface DeleteImageVersionRequest { /** * @public - *

    Configuration of the devices in the stage.

    + *

    The name of the image to delete.

    */ - DeviceSelectionConfig: DeviceSelectionConfig | undefined; + ImageName: string | undefined; /** * @public - *

    Configuration of the deployment details.

    + *

    The version to delete.

    */ - DeploymentConfig: EdgeDeploymentConfig | undefined; + Version?: number; /** * @public - *

    General status of the current state.

    + *

    The alias of the image to delete.

    */ - DeploymentStatus: EdgeDeploymentStatus | undefined; + Alias?: string; } /** * @public */ -export interface DeregisterDevicesRequest { - /** - * @public - *

    The name of the fleet the devices belong to.

    - */ - DeviceFleetName: string | undefined; +export interface DeleteImageVersionResponse {} +/** + * @public + */ +export interface DeleteInferenceComponentInput { /** * @public - *

    The unique IDs of the devices.

    + *

    The name of the inference component to delete.

    */ - DeviceNames: string[] | undefined; + InferenceComponentName: string | undefined; } /** * @public - *

    Information that SageMaker Neo automatically derived about the model.

    */ -export interface DerivedInformation { +export interface DeleteInferenceExperimentRequest { /** * @public - *

    The data input configuration that SageMaker Neo automatically derived for the model. - * When SageMaker Neo derives this information, you don't need to specify the data input - * configuration when you create a compilation job.

    + *

    The name of the inference experiment you want to delete.

    */ - DerivedDataInputConfig?: string; + Name: string | undefined; } /** * @public */ -export interface DescribeActionRequest { +export interface DeleteInferenceExperimentResponse { /** * @public - *

    The name of the action to describe.

    + *

    The ARN of the deleted inference experiment.

    */ - ActionName: string | undefined; + InferenceExperimentArn: string | undefined; } /** * @public */ -export interface DescribeActionResponse { +export interface DeleteModelInput { /** * @public - *

    The name of the action.

    + *

    The name of the model to delete.

    */ - ActionName?: string; + ModelName: string | undefined; +} +/** + * @public + */ +export interface DeleteModelBiasJobDefinitionRequest { /** * @public - *

    The Amazon Resource Name (ARN) of the action.

    + *

    The name of the model bias job definition to delete.

    */ - ActionArn?: string; + JobDefinitionName: string | undefined; +} +/** + * @public + */ +export interface DeleteModelCardRequest { /** * @public - *

    The source of the action.

    + *

    The name of the model card to delete.

    */ - Source?: ActionSource; + ModelCardName: string | undefined; +} +/** + * @public + */ +export interface DeleteModelExplainabilityJobDefinitionRequest { /** * @public - *

    The type of the action.

    + *

    The name of the model explainability job definition to delete.

    */ - ActionType?: string; + JobDefinitionName: string | undefined; +} +/** + * @public + */ +export interface DeleteModelPackageInput { /** * @public - *

    The description of the action.

    + *

    The name or Amazon Resource Name (ARN) of the model package to delete.

    + *

    When you specify a name, the name must have 1 to 63 characters. Valid + * characters are a-z, A-Z, 0-9, and - (hyphen).

    */ - Description?: string; + ModelPackageName: string | undefined; +} +/** + * @public + */ +export interface DeleteModelPackageGroupInput { /** * @public - *

    The status of the action.

    + *

    The name of the model group to delete.

    */ - Status?: ActionStatus; + ModelPackageGroupName: string | undefined; +} +/** + * @public + */ +export interface DeleteModelPackageGroupPolicyInput { /** * @public - *

    A list of the action's properties.

    + *

    The name of the model group for which to delete the policy.

    */ - Properties?: Record; + ModelPackageGroupName: string | undefined; +} +/** + * @public + */ +export interface DeleteModelQualityJobDefinitionRequest { /** * @public - *

    When the action was created.

    + *

    The name of the model quality monitoring job definition to delete.

    */ - CreationTime?: Date; + JobDefinitionName: string | undefined; +} +/** + * @public + */ +export interface DeleteMonitoringScheduleRequest { /** * @public - *

    Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.

    + *

    The name of the monitoring schedule to delete.

    */ - CreatedBy?: UserContext; + MonitoringScheduleName: string | undefined; +} +/** + * @public + */ +export interface DeleteNotebookInstanceInput { /** * @public - *

    When the action was last modified.

    + *

    The name of the SageMaker notebook instance to delete.

    */ - LastModifiedTime?: Date; + NotebookInstanceName: string | undefined; +} +/** + * @public + */ +export interface DeleteNotebookInstanceLifecycleConfigInput { /** * @public - *

    Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.

    + *

    The name of the lifecycle configuration to delete.

    */ - LastModifiedBy?: UserContext; + NotebookInstanceLifecycleConfigName: string | undefined; +} +/** + * @public + */ +export interface DeletePipelineRequest { /** * @public - *

    Metadata properties of the tracking entity, trial, or trial component.

    + *

    The name of the pipeline to delete.

    */ - MetadataProperties?: MetadataProperties; + PipelineName: string | undefined; /** * @public - *

    The Amazon Resource Name (ARN) of the lineage group.

    + *

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the + * operation. An idempotent operation completes no more than one time.

    */ - LineageGroupArn?: string; + ClientRequestToken?: string; } /** * @public */ -export interface DescribeAlgorithmInput { +export interface DeletePipelineResponse { /** * @public - *

    The name of the algorithm to describe.

    + *

    The Amazon Resource Name (ARN) of the pipeline to delete.

    */ - AlgorithmName: string | undefined; + PipelineArn?: string; } /** * @public */ -export interface DescribeAlgorithmOutput { +export interface DeleteProjectInput { /** * @public - *

    The name of the algorithm being described.

    + *

    The name of the project to delete.

    */ - AlgorithmName: string | undefined; + ProjectName: string | undefined; +} +/** + * @public + */ +export interface DeleteSpaceRequest { /** * @public - *

    The Amazon Resource Name (ARN) of the algorithm.

    + *

    The ID of the associated Domain.

    */ - AlgorithmArn: string | undefined; + DomainId: string | undefined; /** * @public - *

    A brief summary about the algorithm.

    + *

    The name of the space.

    */ - AlgorithmDescription?: string; + SpaceName: string | undefined; +} +/** + * @public + */ +export interface DeleteStudioLifecycleConfigRequest { /** * @public - *

    A timestamp specifying when the algorithm was created.

    + *

    The name of the Amazon SageMaker Studio Lifecycle Configuration to delete.

    */ - CreationTime: Date | undefined; + StudioLifecycleConfigName: string | undefined; +} +/** + * @public + */ +export interface DeleteTagsInput { /** * @public - *

    Details about training jobs run by this algorithm.

    + *

    The Amazon Resource Name (ARN) of the resource whose tags you want to + * delete.

    */ - TrainingSpecification: TrainingSpecification | undefined; + ResourceArn: string | undefined; /** * @public - *

    Details about inference jobs that the algorithm runs.

    + *

    An array or one or more tag keys to delete.

    */ - InferenceSpecification?: InferenceSpecification; + TagKeys: string[] | undefined; +} - /** - * @public - *

    Details about configurations for one or more training jobs that SageMaker runs to test the - * algorithm.

    - */ - ValidationSpecification?: AlgorithmValidationSpecification; +/** + * @public + */ +export interface DeleteTagsOutput {} +/** + * @public + */ +export interface DeleteTrialRequest { /** * @public - *

    The current status of the algorithm.

    + *

    The name of the trial to delete.

    */ - AlgorithmStatus: AlgorithmStatus | undefined; + TrialName: string | undefined; +} +/** + * @public + */ +export interface DeleteTrialResponse { /** * @public - *

    Details about the current status of the algorithm.

    + *

    The Amazon Resource Name (ARN) of the trial that is being deleted.

    */ - AlgorithmStatusDetails: AlgorithmStatusDetails | undefined; + TrialArn?: string; +} +/** + * @public + */ +export interface DeleteTrialComponentRequest { /** * @public - *

    The product identifier of the algorithm.

    + *

    The name of the component to delete.

    */ - ProductId?: string; + TrialComponentName: string | undefined; +} +/** + * @public + */ +export interface DeleteTrialComponentResponse { /** * @public - *

    Whether the algorithm is certified to be listed in Amazon Web Services - * Marketplace.

    + *

    The Amazon Resource Name (ARN) of the component is being deleted.

    */ - CertifyForMarketplace?: boolean; + TrialComponentArn?: string; } /** * @public */ -export interface DescribeAppRequest { +export interface DeleteUserProfileRequest { /** * @public *

    The domain ID.

    @@ -1238,200 +1401,328 @@ export interface DescribeAppRequest { /** * @public - *

    The user profile name. If this value is not set, then SpaceName must be set.

    + *

    The user profile name.

    */ - UserProfileName?: string; + UserProfileName: string | undefined; +} +/** + * @public + */ +export interface DeleteWorkforceRequest { /** * @public - *

    The type of app.

    + *

    The name of the workforce.

    */ - AppType: AppType | undefined; + WorkforceName: string | undefined; +} - /** - * @public - *

    The name of the app.

    - */ - AppName: string | undefined; +/** + * @public + */ +export interface DeleteWorkforceResponse {} +/** + * @public + */ +export interface DeleteWorkteamRequest { /** * @public - *

    The name of the space.

    + *

    The name of the work team to delete.

    */ - SpaceName?: string; + WorkteamName: string | undefined; } /** * @public */ -export interface DescribeAppResponse { - /** - * @public - *

    The Amazon Resource Name (ARN) of the app.

    - */ - AppArn?: string; - +export interface DeleteWorkteamResponse { /** * @public - *

    The type of app.

    + *

    Returns true if the work team was successfully deleted; otherwise, + * returns false.

    */ - AppType?: AppType; + Success: boolean | undefined; +} +/** + * @public + *

    Gets the Amazon EC2 Container Registry path of the docker image of the model that is hosted in this ProductionVariant.

    + *

    If you used the registry/repository[:tag] form to specify the image path + * of the primary container when you created the model hosted in this + * ProductionVariant, the path resolves to a path of the form + * registry/repository[@digest]. A digest is a hash value that identifies + * a specific version of an image. For information about Amazon ECR paths, see Pulling an Image in the Amazon ECR User Guide.

    + */ +export interface DeployedImage { /** * @public - *

    The name of the app.

    + *

    The image path you specified when you created the model.

    */ - AppName?: string; + SpecifiedImage?: string; /** * @public - *

    The domain ID.

    + *

    The specific digest path of the image hosted in this + * ProductionVariant.

    */ - DomainId?: string; + ResolvedImage?: string; /** * @public - *

    The user profile name.

    + *

    The date and time when the image path for the model resolved to the + * ResolvedImage + *

    */ - UserProfileName?: string; + ResolutionTime?: Date; +} +/** + * @public + *

    The recommended configuration to use for Real-Time Inference.

    + */ +export interface RealTimeInferenceRecommendation { /** * @public - *

    The status.

    + *

    The recommendation ID which uniquely identifies each recommendation.

    */ - Status?: AppStatus; + RecommendationId: string | undefined; /** * @public - *

    The timestamp of the last health check.

    + *

    The recommended instance type for Real-Time Inference.

    */ - LastHealthCheckTimestamp?: Date; + InstanceType: ProductionVariantInstanceType | undefined; /** * @public - *

    The timestamp of the last user's activity. LastUserActivityTimestamp is also updated when SageMaker performs health checks without user activity. As a result, this value is set to the same value as LastHealthCheckTimestamp.

    + *

    The recommended environment variables to set in the model container for Real-Time Inference.

    */ - LastUserActivityTimestamp?: Date; + Environment?: Record; +} - /** - * @public - *

    The creation time.

    - */ - CreationTime?: Date; +/** + * @public + * @enum + */ +export const RecommendationStatus = { + COMPLETED: "COMPLETED", + FAILED: "FAILED", + IN_PROGRESS: "IN_PROGRESS", + NOT_APPLICABLE: "NOT_APPLICABLE", +} as const; - /** - * @public - *

    The failure reason.

    - */ - FailureReason?: string; +/** + * @public + */ +export type RecommendationStatus = (typeof RecommendationStatus)[keyof typeof RecommendationStatus]; +/** + * @public + *

    A set of recommended deployment configurations for the model. To get more advanced recommendations, see + * CreateInferenceRecommendationsJob + * to create an inference recommendation job.

    + */ +export interface DeploymentRecommendation { /** * @public - *

    The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

    + *

    Status of the deployment recommendation. The status NOT_APPLICABLE means that SageMaker + * is unable to provide a default recommendation for the model using the information provided. If the deployment status is IN_PROGRESS, + * retry your API call after a few seconds to get a COMPLETED deployment recommendation.

    */ - ResourceSpec?: ResourceSpec; + RecommendationStatus: RecommendationStatus | undefined; /** * @public - *

    The name of the space. If this value is not set, then UserProfileName must be set.

    + *

    A list of RealTimeInferenceRecommendation items.

    */ - SpaceName?: string; + RealTimeInferenceRecommendations?: RealTimeInferenceRecommendation[]; } /** * @public + * @enum */ -export interface DescribeAppImageConfigRequest { +export const StageStatus = { + Creating: "CREATING", + Deployed: "DEPLOYED", + Failed: "FAILED", + InProgress: "INPROGRESS", + ReadyToDeploy: "READYTODEPLOY", + Starting: "STARTING", + Stopped: "STOPPED", + Stopping: "STOPPING", +} as const; + +/** + * @public + */ +export type StageStatus = (typeof StageStatus)[keyof typeof StageStatus]; + +/** + * @public + *

    Contains information summarizing the deployment stage results.

    + */ +export interface EdgeDeploymentStatus { /** * @public - *

    The name of the AppImageConfig to describe.

    + *

    The general status of the current stage.

    */ - AppImageConfigName: string | undefined; + StageStatus: StageStatus | undefined; + + /** + * @public + *

    The number of edge devices with the successful deployment in the current stage.

    + */ + EdgeDeploymentSuccessInStage: number | undefined; + + /** + * @public + *

    The number of edge devices yet to pick up the deployment in current stage, or in + * progress.

    + */ + EdgeDeploymentPendingInStage: number | undefined; + + /** + * @public + *

    The number of edge devices that failed the deployment in current stage.

    + */ + EdgeDeploymentFailedInStage: number | undefined; + + /** + * @public + *

    A detailed message about deployment status in current stage.

    + */ + EdgeDeploymentStatusMessage?: string; + + /** + * @public + *

    The time when the deployment API started.

    + */ + EdgeDeploymentStageStartTime?: Date; } /** * @public + *

    Contains information summarizing the deployment stage results.

    */ -export interface DescribeAppImageConfigResponse { +export interface DeploymentStageStatusSummary { /** * @public - *

    The Amazon Resource Name (ARN) of the AppImageConfig.

    + *

    The name of the stage.

    */ - AppImageConfigArn?: string; + StageName: string | undefined; /** * @public - *

    The name of the AppImageConfig.

    + *

    Configuration of the devices in the stage.

    */ - AppImageConfigName?: string; + DeviceSelectionConfig: DeviceSelectionConfig | undefined; /** * @public - *

    When the AppImageConfig was created.

    + *

    Configuration of the deployment details.

    */ - CreationTime?: Date; + DeploymentConfig: EdgeDeploymentConfig | undefined; /** * @public - *

    When the AppImageConfig was last modified.

    + *

    General status of the current state.

    */ - LastModifiedTime?: Date; + DeploymentStatus: EdgeDeploymentStatus | undefined; +} + +/** + * @public + */ +export interface DeregisterDevicesRequest { + /** + * @public + *

    The name of the fleet the devices belong to.

    + */ + DeviceFleetName: string | undefined; /** * @public - *

    The configuration of a KernelGateway app.

    + *

    The unique IDs of the devices.

    */ - KernelGatewayImageConfig?: KernelGatewayImageConfig; + DeviceNames: string[] | undefined; } /** * @public + *

    Information that SageMaker Neo automatically derived about the model.

    */ -export interface DescribeArtifactRequest { +export interface DerivedInformation { /** * @public - *

    The Amazon Resource Name (ARN) of the artifact to describe.

    + *

    The data input configuration that SageMaker Neo automatically derived for the model. + * When SageMaker Neo derives this information, you don't need to specify the data input + * configuration when you create a compilation job.

    */ - ArtifactArn: string | undefined; + DerivedDataInputConfig?: string; } /** * @public */ -export interface DescribeArtifactResponse { +export interface DescribeActionRequest { /** * @public - *

    The name of the artifact.

    + *

    The name of the action to describe.

    */ - ArtifactName?: string; + ActionName: string | undefined; +} +/** + * @public + */ +export interface DescribeActionResponse { /** * @public - *

    The Amazon Resource Name (ARN) of the artifact.

    + *

    The name of the action.

    */ - ArtifactArn?: string; + ActionName?: string; /** * @public - *

    The source of the artifact.

    + *

    The Amazon Resource Name (ARN) of the action.

    */ - Source?: ArtifactSource; + ActionArn?: string; /** * @public - *

    The type of the artifact.

    + *

    The source of the action.

    */ - ArtifactType?: string; + Source?: ActionSource; /** * @public - *

    A list of the artifact's properties.

    + *

    The type of the action.

    + */ + ActionType?: string; + + /** + * @public + *

    The description of the action.

    + */ + Description?: string; + + /** + * @public + *

    The status of the action.

    + */ + Status?: ActionStatus; + + /** + * @public + *

    A list of the action's properties.

    */ Properties?: Record; /** * @public - *

    When the artifact was created.

    + *

    When the action was created.

    */ CreationTime?: Date; @@ -1444,7 +1735,7 @@ export interface DescribeArtifactResponse { /** * @public - *

    When the artifact was last modified.

    + *

    When the action was last modified.

    */ LastModifiedTime?: Date; @@ -1471,4881 +1762,5172 @@ export interface DescribeArtifactResponse { /** * @public */ -export interface DescribeAutoMLJobRequest { +export interface DescribeAlgorithmInput { /** * @public - *

    Requests information about an AutoML job using its unique name.

    + *

    The name of the algorithm to describe.

    */ - AutoMLJobName: string | undefined; + AlgorithmName: string | undefined; } /** * @public - *

    Provides information about the endpoint of the model deployment.

    */ -export interface ModelDeployResult { +export interface DescribeAlgorithmOutput { /** * @public - *

    The name of the endpoint to which the model has been deployed.

    - * - *

    If model deployment fails, this field is omitted from the response.

    - *     + *

    The name of the algorithm being described.

    */ - EndpointName?: string; -} + AlgorithmName: string | undefined; -/** - * @public - *

    The resolved attributes.

    - */ -export interface ResolvedAttributes { /** * @public - *

    Specifies a metric to minimize or maximize as the objective of an AutoML job.

    + *

    The Amazon Resource Name (ARN) of the algorithm.

    */ - AutoMLJobObjective?: AutoMLJobObjective; + AlgorithmArn: string | undefined; /** * @public - *

    The problem type.

    + *

    A brief summary about the algorithm.

    */ - ProblemType?: ProblemType; + AlgorithmDescription?: string; /** * @public - *

    How long a job is allowed to run, or how many candidates a job is allowed to - * generate.

    + *

    A timestamp specifying when the algorithm was created.

    */ - CompletionCriteria?: AutoMLJobCompletionCriteria; -} + CreationTime: Date | undefined; -/** - * @public - */ -export interface DescribeAutoMLJobResponse { /** * @public - *

    Returns the name of the AutoML job.

    + *

    Details about training jobs run by this algorithm.

    */ - AutoMLJobName: string | undefined; + TrainingSpecification: TrainingSpecification | undefined; /** * @public - *

    Returns the ARN of the AutoML job.

    + *

    Details about inference jobs that the algorithm runs.

    */ - AutoMLJobArn: string | undefined; + InferenceSpecification?: InferenceSpecification; /** * @public - *

    Returns the input data configuration for the AutoML job.

    + *

    Details about configurations for one or more training jobs that SageMaker runs to test the + * algorithm.

    */ - InputDataConfig: AutoMLChannel[] | undefined; + ValidationSpecification?: AlgorithmValidationSpecification; /** * @public - *

    Returns the job's output data config.

    + *

    The current status of the algorithm.

    */ - OutputDataConfig: AutoMLOutputDataConfig | undefined; + AlgorithmStatus: AlgorithmStatus | undefined; /** * @public - *

    The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that has read permission to the input data - * location and write permission to the output data location in Amazon S3.

    + *

    Details about the current status of the algorithm.

    */ - RoleArn: string | undefined; + AlgorithmStatusDetails: AlgorithmStatusDetails | undefined; /** * @public - *

    Returns the job's objective.

    + *

    The product identifier of the algorithm.

    */ - AutoMLJobObjective?: AutoMLJobObjective; + ProductId?: string; /** * @public - *

    Returns the job's problem type.

    + *

    Whether the algorithm is certified to be listed in Amazon Web Services + * Marketplace.

    */ - ProblemType?: ProblemType; + CertifyForMarketplace?: boolean; +} +/** + * @public + */ +export interface DescribeAppRequest { /** * @public - *

    Returns the configuration for the AutoML job.

    + *

    The domain ID.

    */ - AutoMLJobConfig?: AutoMLJobConfig; + DomainId: string | undefined; /** * @public - *

    Returns the creation time of the AutoML job.

    + *

    The user profile name. If this value is not set, then SpaceName must be set.

    */ - CreationTime: Date | undefined; + UserProfileName?: string; /** * @public - *

    Returns the end time of the AutoML job.

    + *

    The type of app.

    */ - EndTime?: Date; + AppType: AppType | undefined; /** * @public - *

    Returns the job's last modified time.

    + *

    The name of the app.

    */ - LastModifiedTime: Date | undefined; + AppName: string | undefined; /** * @public - *

    Returns the failure reason for an AutoML job, when applicable.

    + *

    The name of the space.

    */ - FailureReason?: string; + SpaceName?: string; +} +/** + * @public + */ +export interface DescribeAppResponse { /** * @public - *

    Returns a list of reasons for partial failures within an AutoML job.

    + *

    The Amazon Resource Name (ARN) of the app.

    */ - PartialFailureReasons?: AutoMLPartialFailureReason[]; + AppArn?: string; /** * @public - *

    The best model candidate selected by SageMaker Autopilot using both the best objective metric and - * lowest InferenceLatency for - * an experiment.

    + *

    The type of app.

    */ - BestCandidate?: AutoMLCandidate; + AppType?: AppType; /** * @public - *

    Returns the status of the AutoML job.

    + *

    The name of the app.

    */ - AutoMLJobStatus: AutoMLJobStatus | undefined; + AppName?: string; /** * @public - *

    Returns the secondary status of the AutoML job.

    + *

    The domain ID.

    */ - AutoMLJobSecondaryStatus: AutoMLJobSecondaryStatus | undefined; + DomainId?: string; /** * @public - *

    Indicates whether the output for an AutoML job generates candidate definitions - * only.

    + *

    The user profile name.

    */ - GenerateCandidateDefinitionsOnly?: boolean; + UserProfileName?: string; /** * @public - *

    Returns information on the job's artifacts found in - * AutoMLJobArtifacts.

    + *

    The status.

    */ - AutoMLJobArtifacts?: AutoMLJobArtifacts; + Status?: AppStatus; /** * @public - *

    Contains ProblemType, AutoMLJobObjective, and - * CompletionCriteria. If you do not provide these values, they are - * inferred.

    + *

    The timestamp of the last health check.

    */ - ResolvedAttributes?: ResolvedAttributes; + LastHealthCheckTimestamp?: Date; /** * @public - *

    Indicates whether the model was deployed automatically to an endpoint and the name of - * that endpoint if deployed automatically.

    + *

    The timestamp of the last user's activity. LastUserActivityTimestamp is also updated when SageMaker performs health checks without user activity. As a result, this value is set to the same value as LastHealthCheckTimestamp.

    */ - ModelDeployConfig?: ModelDeployConfig; + LastUserActivityTimestamp?: Date; /** * @public - *

    Provides information about endpoint for the model deployment.

    + *

    The creation time.

    */ - ModelDeployResult?: ModelDeployResult; + CreationTime?: Date; + + /** + * @public + *

    The failure reason.

    + */ + FailureReason?: string; + + /** + * @public + *

    The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

    + */ + ResourceSpec?: ResourceSpec; + + /** + * @public + *

    The name of the space. If this value is not set, then UserProfileName must be set.

    + */ + SpaceName?: string; } /** * @public */ -export interface DescribeAutoMLJobV2Request { +export interface DescribeAppImageConfigRequest { /** * @public - *

    Requests information about an AutoML job V2 using its unique name.

    + *

    The name of the AppImageConfig to describe.

    */ - AutoMLJobName: string | undefined; + AppImageConfigName: string | undefined; } /** * @public */ -export interface DescribeAutoMLJobV2Response { +export interface DescribeAppImageConfigResponse { /** * @public - *

    Returns the name of the AutoML job V2.

    + *

    The Amazon Resource Name (ARN) of the AppImageConfig.

    */ - AutoMLJobName: string | undefined; + AppImageConfigArn?: string; /** * @public - *

    Returns the Amazon Resource Name (ARN) of the AutoML job V2.

    + *

    The name of the AppImageConfig.

    */ - AutoMLJobArn: string | undefined; + AppImageConfigName?: string; /** * @public - *

    Returns an array of channel objects describing the input data and their location.

    + *

    When the AppImageConfig was created.

    */ - AutoMLJobInputDataConfig: AutoMLJobChannel[] | undefined; + CreationTime?: Date; /** * @public - *

    Returns the job's output data config.

    + *

    When the AppImageConfig was last modified.

    */ - OutputDataConfig: AutoMLOutputDataConfig | undefined; + LastModifiedTime?: Date; /** * @public - *

    The ARN of the Identity and Access Management role that has read permission to the input data location and - * write permission to the output data location in Amazon S3.

    + *

    The configuration of a KernelGateway app.

    */ - RoleArn: string | undefined; + KernelGatewayImageConfig?: KernelGatewayImageConfig; +} +/** + * @public + */ +export interface DescribeArtifactRequest { /** * @public - *

    Returns the job's objective.

    + *

    The Amazon Resource Name (ARN) of the artifact to describe.

    */ - AutoMLJobObjective?: AutoMLJobObjective; + ArtifactArn: string | undefined; +} +/** + * @public + */ +export interface DescribeArtifactResponse { /** * @public - *

    Returns the configuration settings of the problem type set for the AutoML job V2.

    + *

    The name of the artifact.

    */ - AutoMLProblemTypeConfig?: AutoMLProblemTypeConfig; + ArtifactName?: string; /** * @public - *

    Returns the creation time of the AutoML job V2.

    + *

    The Amazon Resource Name (ARN) of the artifact.

    */ - CreationTime: Date | undefined; + ArtifactArn?: string; /** * @public - *

    Returns the end time of the AutoML job V2.

    + *

    The source of the artifact.

    */ - EndTime?: Date; + Source?: ArtifactSource; /** * @public - *

    Returns the job's last modified time.

    + *

    The type of the artifact.

    */ - LastModifiedTime: Date | undefined; + ArtifactType?: string; /** * @public - *

    Returns the reason for the failure of the AutoML job V2, when applicable.

    + *

    A list of the artifact's properties.

    */ - FailureReason?: string; + Properties?: Record; /** * @public - *

    Returns a list of reasons for partial failures within an AutoML job V2.

    + *

    When the artifact was created.

    */ - PartialFailureReasons?: AutoMLPartialFailureReason[]; + CreationTime?: Date; /** * @public - *

    Information about the candidate produced by an AutoML training job V2, including its - * status, steps, and other properties.

    + *

    Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.

    */ - BestCandidate?: AutoMLCandidate; + CreatedBy?: UserContext; /** * @public - *

    Returns the status of the AutoML job V2.

    + *

    When the artifact was last modified.

    */ - AutoMLJobStatus: AutoMLJobStatus | undefined; + LastModifiedTime?: Date; /** * @public - *

    Returns the secondary status of the AutoML job V2.

    + *

    Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.

    */ - AutoMLJobSecondaryStatus: AutoMLJobSecondaryStatus | undefined; + LastModifiedBy?: UserContext; /** * @public - *

    Indicates whether the model was deployed automatically to an endpoint and the name of - * that endpoint if deployed automatically.

    + *

    Metadata properties of the tracking entity, trial, or trial component.

    */ - ModelDeployConfig?: ModelDeployConfig; + MetadataProperties?: MetadataProperties; /** * @public - *

    Provides information about endpoint for the model deployment.

    + *

    The Amazon Resource Name (ARN) of the lineage group.

    */ - ModelDeployResult?: ModelDeployResult; + LineageGroupArn?: string; +} +/** + * @public + */ +export interface DescribeAutoMLJobRequest { /** * @public - *

    Returns the configuration settings of how the data are split into train and validation - * datasets.

    + *

    Requests information about an AutoML job using its unique name.

    */ - DataSplitConfig?: AutoMLDataSplitConfig; + AutoMLJobName: string | undefined; +} +/** + * @public + *

    Provides information about the endpoint of the model deployment.

    + */ +export interface ModelDeployResult { /** * @public - *

    Returns the security configuration for traffic encryption or Amazon VPC settings.

    + *

    The name of the endpoint to which the model has been deployed.

    + * + *

    If model deployment fails, this field is omitted from the response.

    + *     */ - SecurityConfig?: AutoMLSecurityConfig; + EndpointName?: string; +} +/** + * @public + *

    The resolved attributes.

    + */ +export interface ResolvedAttributes { /** * @public - *

    The artifacts that are generated during an AutoML job.

    + *

    Specifies a metric to minimize or maximize as the objective of an AutoML job.

    */ - AutoMLJobArtifacts?: AutoMLJobArtifacts; + AutoMLJobObjective?: AutoMLJobObjective; /** * @public - *

    Returns the resolved attributes used by the AutoML job V2.

    + *

    The problem type.

    */ - ResolvedAttributes?: AutoMLResolvedAttributes; + ProblemType?: ProblemType; /** * @public - *

    Returns the name of the problem type configuration set for the AutoML job V2.

    + *

    How long a job is allowed to run, or how many candidates a job is allowed to + * generate.

    */ - AutoMLProblemTypeConfigName?: AutoMLProblemTypeConfigName; + CompletionCriteria?: AutoMLJobCompletionCriteria; } /** * @public */ -export interface DescribeCodeRepositoryInput { +export interface DescribeAutoMLJobResponse { /** * @public - *

    The name of the Git repository to describe.

    + *

    Returns the name of the AutoML job.

    */ - CodeRepositoryName: string | undefined; -} + AutoMLJobName: string | undefined; -/** - * @public - */ -export interface DescribeCodeRepositoryOutput { /** * @public - *

    The name of the Git repository.

    + *

    Returns the ARN of the AutoML job.

    */ - CodeRepositoryName: string | undefined; + AutoMLJobArn: string | undefined; /** * @public - *

    The Amazon Resource Name (ARN) of the Git repository.

    + *

    Returns the input data configuration for the AutoML job.

    */ - CodeRepositoryArn: string | undefined; + InputDataConfig: AutoMLChannel[] | undefined; /** * @public - *

    The date and time that the repository was created.

    + *

    Returns the job's output data config.

    */ - CreationTime: Date | undefined; + OutputDataConfig: AutoMLOutputDataConfig | undefined; /** * @public - *

    The date and time that the repository was last changed.

    + *

    The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that has read permission to the input data + * location and write permission to the output data location in Amazon S3.

    */ - LastModifiedTime: Date | undefined; + RoleArn: string | undefined; /** * @public - *

    Configuration details about the repository, including the URL where the repository is - * located, the default branch, and the Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the - * repository.

    + *

    Returns the job's objective.

    */ - GitConfig?: GitConfig; -} + AutoMLJobObjective?: AutoMLJobObjective; -/** - * @public - */ -export interface DescribeCompilationJobRequest { /** * @public - *

    The name of the model compilation job that you want information about.

    + *

    Returns the job's problem type.

    */ - CompilationJobName: string | undefined; -} + ProblemType?: ProblemType; -/** - * @public - *

    Provides information about the location that is configured for storing model - * artifacts.

    - *

    Model artifacts are the output that results from training a model, and typically - * consist of trained parameters, a model definition that describes how to compute - * inferences, and other metadata.

    - */ -export interface ModelArtifacts { /** * @public - *

    The path of the S3 object that contains the model artifacts. For example, - * s3://bucket-name/keynameprefix/model.tar.gz.

    + *

    Returns the configuration for the AutoML job.

    */ - S3ModelArtifacts: string | undefined; -} + AutoMLJobConfig?: AutoMLJobConfig; -/** - * @public - *

    Provides information to verify the integrity of stored model artifacts.

    - */ -export interface ModelDigests { /** * @public - *

    Provides a hash value that uniquely identifies the stored model - * artifacts.

    + *

    Returns the creation time of the AutoML job.

    */ - ArtifactDigest?: string; -} + CreationTime: Date | undefined; -/** - * @public - */ -export interface DescribeCompilationJobResponse { /** * @public - *

    The name of the model compilation job.

    + *

    Returns the end time of the AutoML job.

    */ - CompilationJobName: string | undefined; + EndTime?: Date; /** * @public - *

    The Amazon Resource Name (ARN) of the model compilation job.

    + *

    Returns the job's last modified time.

    */ - CompilationJobArn: string | undefined; + LastModifiedTime: Date | undefined; /** * @public - *

    The status of the model compilation job.

    + *

    Returns the failure reason for an AutoML job, when applicable.

    */ - CompilationJobStatus: CompilationJobStatus | undefined; + FailureReason?: string; /** * @public - *

    The time when the model compilation job started the CompilationJob - * instances.

    - *

    You are billed for the time between this timestamp and the timestamp in the - * CompilationEndTime field. In Amazon CloudWatch Logs, the start time might be later - * than this time. That's because it takes time to download the compilation job, which - * depends on the size of the compilation job container.

    + *

    Returns a list of reasons for partial failures within an AutoML job.

    */ - CompilationStartTime?: Date; + PartialFailureReasons?: AutoMLPartialFailureReason[]; /** * @public - *

    The time when the model compilation job on a compilation job instance ended. For a - * successful or stopped job, this is when the job's model artifacts have finished - * uploading. For a failed job, this is when Amazon SageMaker detected that the job failed.

    + *

    The best model candidate selected by SageMaker Autopilot using both the best objective metric and + * lowest InferenceLatency for + * an experiment.

    */ - CompilationEndTime?: Date; + BestCandidate?: AutoMLCandidate; /** * @public - *

    Specifies a limit to how long a model compilation job can run. When the job reaches - * the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training - * costs.

    + *

    Returns the status of the AutoML job.

    */ - StoppingCondition: StoppingCondition | undefined; + AutoMLJobStatus: AutoMLJobStatus | undefined; /** * @public - *

    The inference image to use when compiling a model. Specify an image only if the target - * device is a cloud instance.

    + *

    Returns the secondary status of the AutoML job.

    */ - InferenceImage?: string; + AutoMLJobSecondaryStatus: AutoMLJobSecondaryStatus | undefined; /** * @public - *

    The Amazon Resource Name (ARN) of the versioned model package that was - * provided to SageMaker Neo when you initiated a compilation job.

    + *

    Indicates whether the output for an AutoML job generates candidate definitions + * only.

    */ - ModelPackageVersionArn?: string; + GenerateCandidateDefinitionsOnly?: boolean; /** * @public - *

    The time that the model compilation job was created.

    + *

    Returns information on the job's artifacts found in + * AutoMLJobArtifacts.

    */ - CreationTime: Date | undefined; + AutoMLJobArtifacts?: AutoMLJobArtifacts; /** * @public - *

    The time that the status - * of - * the model compilation job was last modified.

    + *

    Contains ProblemType, AutoMLJobObjective, and + * CompletionCriteria. If you do not provide these values, they are + * inferred.

    */ - LastModifiedTime: Date | undefined; + ResolvedAttributes?: ResolvedAttributes; /** * @public - *

    If a model compilation job failed, the reason it failed.

    + *

    Indicates whether the model was deployed automatically to an endpoint and the name of + * that endpoint if deployed automatically.

    */ - FailureReason: string | undefined; + ModelDeployConfig?: ModelDeployConfig; /** * @public - *

    Information about the location in Amazon S3 that has been configured for storing the model - * artifacts used in the compilation job.

    + *

    Provides information about endpoint for the model deployment.

    */ - ModelArtifacts: ModelArtifacts | undefined; + ModelDeployResult?: ModelDeployResult; +} +/** + * @public + */ +export interface DescribeAutoMLJobV2Request { /** * @public - *

    Provides a BLAKE2 hash value that identifies the compiled model artifacts in - * Amazon S3.

    + *

    Requests information about an AutoML job V2 using its unique name.

    */ - ModelDigests?: ModelDigests; + AutoMLJobName: string | undefined; +} +/** + * @public + */ +export interface DescribeAutoMLJobV2Response { /** * @public - *

    The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to perform the model - * compilation job.

    + *

    Returns the name of the AutoML job V2.

    */ - RoleArn: string | undefined; + AutoMLJobName: string | undefined; /** * @public - *

    Information about the location in Amazon S3 of the input model artifacts, the name and - * shape of the expected data inputs, and the framework in which the model was - * trained.

    + *

    Returns the Amazon Resource Name (ARN) of the AutoML job V2.

    */ - InputConfig: InputConfig | undefined; + AutoMLJobArn: string | undefined; /** * @public - *

    Information about the output location for the compiled model and the target device - * that the model runs on.

    + *

    Returns an array of channel objects describing the input data and their location.

    */ - OutputConfig: OutputConfig | undefined; + AutoMLJobInputDataConfig: AutoMLJobChannel[] | undefined; /** * @public - *

    A VpcConfig object that specifies the VPC that you want your compilation job - * to connect to. Control access to your models by configuring the VPC. For more - * information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.

    + *

    Returns the job's output data config.

    */ - VpcConfig?: NeoVpcConfig; + OutputDataConfig: AutoMLOutputDataConfig | undefined; /** * @public - *

    Information that SageMaker Neo automatically derived about the model.

    + *

    The ARN of the Identity and Access Management role that has read permission to the input data location and + * write permission to the output data location in Amazon S3.

    */ - DerivedInformation?: DerivedInformation; -} + RoleArn: string | undefined; -/** - * @public - */ -export interface DescribeContextRequest { /** * @public - *

    The name of the context to describe.

    + *

    Returns the job's objective.

    */ - ContextName: string | undefined; -} + AutoMLJobObjective?: AutoMLJobObjective; -/** - * @public - */ -export interface DescribeContextResponse { /** * @public - *

    The name of the context.

    + *

    Returns the configuration settings of the problem type set for the AutoML job V2.

    */ - ContextName?: string; + AutoMLProblemTypeConfig?: AutoMLProblemTypeConfig; /** * @public - *

    The Amazon Resource Name (ARN) of the context.

    + *

    Returns the creation time of the AutoML job V2.

    */ - ContextArn?: string; + CreationTime: Date | undefined; /** * @public - *

    The source of the context.

    + *

    Returns the end time of the AutoML job V2.

    */ - Source?: ContextSource; + EndTime?: Date; /** * @public - *

    The type of the context.

    + *

    Returns the job's last modified time.

    */ - ContextType?: string; + LastModifiedTime: Date | undefined; /** * @public - *

    The description of the context.

    + *

    Returns the reason for the failure of the AutoML job V2, when applicable.

    */ - Description?: string; + FailureReason?: string; /** * @public - *

    A list of the context's properties.

    + *

    Returns a list of reasons for partial failures within an AutoML job V2.

    */ - Properties?: Record; + PartialFailureReasons?: AutoMLPartialFailureReason[]; /** * @public - *

    When the context was created.

    + *

    Information about the candidate produced by an AutoML training job V2, including its + * status, steps, and other properties.

    */ - CreationTime?: Date; + BestCandidate?: AutoMLCandidate; /** * @public - *

    Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.

    + *

    Returns the status of the AutoML job V2.

    */ - CreatedBy?: UserContext; + AutoMLJobStatus: AutoMLJobStatus | undefined; /** * @public - *

    When the context was last modified.

    + *

    Returns the secondary status of the AutoML job V2.

    */ - LastModifiedTime?: Date; + AutoMLJobSecondaryStatus: AutoMLJobSecondaryStatus | undefined; /** * @public - *

    Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.

    + *

    Indicates whether the model was deployed automatically to an endpoint and the name of + * that endpoint if deployed automatically.

    */ - LastModifiedBy?: UserContext; + ModelDeployConfig?: ModelDeployConfig; /** * @public - *

    The Amazon Resource Name (ARN) of the lineage group.

    + *

    Provides information about endpoint for the model deployment.

    */ - LineageGroupArn?: string; -} + ModelDeployResult?: ModelDeployResult; -/** - * @public - */ -export interface DescribeDataQualityJobDefinitionRequest { /** * @public - *

    The name of the data quality monitoring job definition to describe.

    + *

    Returns the configuration settings of how the data are split into train and validation + * datasets.

    */ - JobDefinitionName: string | undefined; -} + DataSplitConfig?: AutoMLDataSplitConfig; -/** - * @public - */ -export interface DescribeDataQualityJobDefinitionResponse { /** * @public - *

    The Amazon Resource Name (ARN) of the data quality monitoring job definition.

    + *

    Returns the security configuration for traffic encryption or Amazon VPC settings.

    */ - JobDefinitionArn: string | undefined; + SecurityConfig?: AutoMLSecurityConfig; /** * @public - *

    The name of the data quality monitoring job definition.

    + *

    The artifacts that are generated during an AutoML job.

    */ - JobDefinitionName: string | undefined; + AutoMLJobArtifacts?: AutoMLJobArtifacts; /** * @public - *

    The time that the data quality monitoring job definition was created.

    + *

    Returns the resolved attributes used by the AutoML job V2.

    */ - CreationTime: Date | undefined; + ResolvedAttributes?: AutoMLResolvedAttributes; /** * @public - *

    The constraints and baselines for the data quality monitoring job definition.

    + *

    Returns the name of the problem type configuration set for the AutoML job V2.

    */ - DataQualityBaselineConfig?: DataQualityBaselineConfig; + AutoMLProblemTypeConfigName?: AutoMLProblemTypeConfigName; +} +/** + * @public + */ +export interface DescribeClusterRequest { /** * @public - *

    Information about the container that runs the data quality monitoring job.

    + *

    The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

    */ - DataQualityAppSpecification: DataQualityAppSpecification | undefined; + ClusterName: string | undefined; +} +/** + * @public + */ +export interface DescribeClusterResponse { /** * @public - *

    The list of inputs for the data quality monitoring job. Currently endpoints are - * supported.

    + *

    The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

    */ - DataQualityJobInput: DataQualityJobInput | undefined; + ClusterArn: string | undefined; /** * @public - *

    The output configuration for monitoring jobs.

    + *

    The name of the SageMaker HyperPod cluster.

    */ - DataQualityJobOutputConfig: MonitoringOutputConfig | undefined; + ClusterName?: string; /** * @public - *

    Identifies the resources to deploy for a monitoring job.

    + *

    The status of the SageMaker HyperPod cluster.

    */ - JobResources: MonitoringResources | undefined; + ClusterStatus: ClusterStatus | undefined; /** * @public - *

    The networking configuration for the data quality monitoring job.

    + *

    The time when the SageMaker Cluster is created.

    */ - NetworkConfig?: MonitoringNetworkConfig; + CreationTime?: Date; /** * @public - *

    The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can - * assume to perform tasks on your behalf.

    + *

    The failure message of the SageMaker HyperPod cluster.

    */ - RoleArn: string | undefined; + FailureMessage?: string; /** * @public - *

    A time limit for how long the monitoring job is allowed to run before stopping.

    + *

    The instance groups of the SageMaker HyperPod cluster.

    */ - StoppingCondition?: MonitoringStoppingCondition; + InstanceGroups: ClusterInstanceGroupDetails[] | undefined; + + /** + * @public + *

    Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources + * have access to. You can control access to and from your resources by configuring a VPC. + * For more information, see Give SageMaker Access to Resources in your Amazon VPC.

    + */ + VpcConfig?: VpcConfig; } /** * @public */ -export interface DescribeDeviceRequest { +export interface DescribeClusterNodeRequest { /** * @public - *

    Next token of device description.

    + *

    The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which the instance is.

    */ - NextToken?: string; + ClusterName: string | undefined; /** * @public - *

    The unique ID of the device.

    + *

    The ID of the instance.

    */ - DeviceName: string | undefined; + NodeId: string | undefined; +} +/** + * @public + */ +export interface DescribeClusterNodeResponse { /** * @public - *

    The name of the fleet the devices belong to.

    + *

    The details of the instance.

    */ - DeviceFleetName: string | undefined; + NodeDetails: ClusterNodeDetails | undefined; } /** * @public - *

    The model on the edge device.

    */ -export interface EdgeModel { +export interface DescribeCodeRepositoryInput { /** * @public - *

    The name of the model.

    + *

    The name of the Git repository to describe.

    */ - ModelName: string | undefined; + CodeRepositoryName: string | undefined; +} +/** + * @public + */ +export interface DescribeCodeRepositoryOutput { /** * @public - *

    The model version.

    + *

    The name of the Git repository.

    */ - ModelVersion: string | undefined; + CodeRepositoryName: string | undefined; /** * @public - *

    The timestamp of the last data sample taken.

    + *

    The Amazon Resource Name (ARN) of the Git repository.

    */ - LatestSampleTime?: Date; + CodeRepositoryArn: string | undefined; /** * @public - *

    The timestamp of the last inference that was made.

    + *

    The date and time that the repository was created.

    */ - LatestInference?: Date; + CreationTime: Date | undefined; + + /** + * @public + *

    The date and time that the repository was last changed.

    + */ + LastModifiedTime: Date | undefined; + + /** + * @public + *

    Configuration details about the repository, including the URL where the repository is + * located, the default branch, and the Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the + * repository.

    + */ + GitConfig?: GitConfig; } /** * @public */ -export interface DescribeDeviceResponse { +export interface DescribeCompilationJobRequest { /** * @public - *

    The Amazon Resource Name (ARN) of the device.

    + *

    The name of the model compilation job that you want information about.

    */ - DeviceArn?: string; + CompilationJobName: string | undefined; +} +/** + * @public + *

    Provides information about the location that is configured for storing model + * artifacts.

    + *

    Model artifacts are the output that results from training a model, and typically + * consist of trained parameters, a model definition that describes how to compute + * inferences, and other metadata.

    + */ +export interface ModelArtifacts { /** * @public - *

    The unique identifier of the device.

    + *

    The path of the S3 object that contains the model artifacts. For example, + * s3://bucket-name/keynameprefix/model.tar.gz.

    */ - DeviceName: string | undefined; + S3ModelArtifacts: string | undefined; +} +/** + * @public + *

    Provides information to verify the integrity of stored model artifacts.

    + */ +export interface ModelDigests { /** * @public - *

    A description of the device.

    + *

    Provides a hash value that uniquely identifies the stored model + * artifacts.

    */ - Description?: string; + ArtifactDigest?: string; +} +/** + * @public + */ +export interface DescribeCompilationJobResponse { /** * @public - *

    The name of the fleet the device belongs to.

    + *

    The name of the model compilation job.

    */ - DeviceFleetName: string | undefined; + CompilationJobName: string | undefined; /** * @public - *

    The Amazon Web Services Internet of Things (IoT) object thing name associated with the device.

    + *

    The Amazon Resource Name (ARN) of the model compilation job.

    */ - IotThingName?: string; + CompilationJobArn: string | undefined; /** * @public - *

    The timestamp of the last registration or de-reregistration.

    + *

    The status of the model compilation job.

    */ - RegistrationTime: Date | undefined; + CompilationJobStatus: CompilationJobStatus | undefined; /** * @public - *

    The last heartbeat received from the device.

    + *

    The time when the model compilation job started the CompilationJob + * instances.

    + *

    You are billed for the time between this timestamp and the timestamp in the + * CompilationEndTime field. In Amazon CloudWatch Logs, the start time might be later + * than this time. That's because it takes time to download the compilation job, which + * depends on the size of the compilation job container.

    */ - LatestHeartbeat?: Date; + CompilationStartTime?: Date; /** * @public - *

    Models on the device.

    + *

    The time when the model compilation job on a compilation job instance ended. For a + * successful or stopped job, this is when the job's model artifacts have finished + * uploading. For a failed job, this is when Amazon SageMaker detected that the job failed.

    */ - Models?: EdgeModel[]; + CompilationEndTime?: Date; /** * @public - *

    The maximum number of models.

    + *

    Specifies a limit to how long a model compilation job can run. When the job reaches + * the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training + * costs.

    */ - MaxModels?: number; + StoppingCondition: StoppingCondition | undefined; /** * @public - *

    The response from the last list when returning a list large enough to need tokening.

    + *

    The inference image to use when compiling a model. Specify an image only if the target + * device is a cloud instance.

    */ - NextToken?: string; + InferenceImage?: string; /** * @public - *

    Edge Manager agent version.

    + *

    The Amazon Resource Name (ARN) of the versioned model package that was + * provided to SageMaker Neo when you initiated a compilation job.

    */ - AgentVersion?: string; -} + ModelPackageVersionArn?: string; -/** - * @public - */ -export interface DescribeDeviceFleetRequest { /** * @public - *

    The name of the fleet.

    + *

    The time that the model compilation job was created.

    */ - DeviceFleetName: string | undefined; -} + CreationTime: Date | undefined; -/** - * @public - */ -export interface DescribeDeviceFleetResponse { /** * @public - *

    The name of the fleet.

    + *

    The time that the status + * of + * the model compilation job was last modified.

    */ - DeviceFleetName: string | undefined; + LastModifiedTime: Date | undefined; /** * @public - *

    The The Amazon Resource Name (ARN) of the fleet.

    + *

    If a model compilation job failed, the reason it failed.

    */ - DeviceFleetArn: string | undefined; + FailureReason: string | undefined; /** * @public - *

    The output configuration for storing sampled data.

    + *

    Information about the location in Amazon S3 that has been configured for storing the model + * artifacts used in the compilation job.

    */ - OutputConfig: EdgeOutputConfig | undefined; + ModelArtifacts: ModelArtifacts | undefined; /** * @public - *

    A description of the fleet.

    + *

    Provides a BLAKE2 hash value that identifies the compiled model artifacts in + * Amazon S3.

    */ - Description?: string; + ModelDigests?: ModelDigests; /** * @public - *

    Timestamp of when the device fleet was created.

    + *

    The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to perform the model + * compilation job.

    */ - CreationTime: Date | undefined; + RoleArn: string | undefined; /** * @public - *

    Timestamp of when the device fleet was last updated.

    + *

    Information about the location in Amazon S3 of the input model artifacts, the name and + * shape of the expected data inputs, and the framework in which the model was + * trained.

    */ - LastModifiedTime: Date | undefined; + InputConfig: InputConfig | undefined; /** * @public - *

    The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).

    + *

    Information about the output location for the compiled model and the target device + * that the model runs on.

    */ - RoleArn?: string; + OutputConfig: OutputConfig | undefined; /** * @public - *

    The Amazon Resource Name (ARN) alias created in Amazon Web Services Internet of Things (IoT).

    + *

    A VpcConfig object that specifies the VPC that you want your compilation job + * to connect to. Control access to your models by configuring the VPC. For more + * information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.

    */ - IotRoleAlias?: string; -} + VpcConfig?: NeoVpcConfig; -/** - * @public - */ -export interface DescribeDomainRequest { /** * @public - *

    The domain ID.

    + *

    Information that SageMaker Neo automatically derived about the model.

    */ - DomainId: string | undefined; + DerivedInformation?: DerivedInformation; } -/** - * @public - * @enum - */ -export const DomainStatus = { - Delete_Failed: "Delete_Failed", - Deleting: "Deleting", - Failed: "Failed", - InService: "InService", - Pending: "Pending", - Update_Failed: "Update_Failed", - Updating: "Updating", -} as const; - /** * @public */ -export type DomainStatus = (typeof DomainStatus)[keyof typeof DomainStatus]; +export interface DescribeContextRequest { + /** + * @public + *

    The name of the context to describe.

    + */ + ContextName: string | undefined; +} /** * @public */ -export interface DescribeDomainResponse { +export interface DescribeContextResponse { /** * @public - *

    The domain's Amazon Resource Name (ARN).

    + *

    The name of the context.

    */ - DomainArn?: string; + ContextName?: string; /** * @public - *

    The domain ID.

    + *

    The Amazon Resource Name (ARN) of the context.

    */ - DomainId?: string; + ContextArn?: string; /** * @public - *

    The domain name.

    + *

    The source of the context.

    */ - DomainName?: string; + Source?: ContextSource; /** * @public - *

    The ID of the Amazon Elastic File System (EFS) managed by this Domain.

    + *

    The type of the context.

    */ - HomeEfsFileSystemId?: string; + ContextType?: string; /** * @public - *

    The IAM Identity Center managed application instance ID.

    + *

    The description of the context.

    */ - SingleSignOnManagedApplicationInstanceId?: string; + Description?: string; /** * @public - *

    The ARN of the application managed by SageMaker in IAM Identity Center. This value is only returned for domains created after September 19, 2023.

    + *

    A list of the context's properties.

    */ - SingleSignOnApplicationArn?: string; + Properties?: Record; /** * @public - *

    The status.

    + *

    When the context was created.

    */ - Status?: DomainStatus; + CreationTime?: Date; /** * @public - *

    The creation time.

    + *

    Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.

    */ - CreationTime?: Date; + CreatedBy?: UserContext; /** * @public - *

    The last modified time.

    + *

    When the context was last modified.

    */ LastModifiedTime?: Date; /** * @public - *

    The failure reason.

    + *

    Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.

    */ - FailureReason?: string; + LastModifiedBy?: UserContext; /** * @public - *

    The domain's authentication mode.

    + *

    The Amazon Resource Name (ARN) of the lineage group.

    */ - AuthMode?: AuthMode; + LineageGroupArn?: string; +} +/** + * @public + */ +export interface DescribeDataQualityJobDefinitionRequest { /** * @public - *

    Settings which are applied to UserProfiles in this domain if settings are not explicitly specified - * in a given UserProfile. - *

    + *

    The name of the data quality monitoring job definition to describe.

    */ - DefaultUserSettings?: UserSettings; + JobDefinitionName: string | undefined; +} - /** +/** + * @public + */ +export interface DescribeDataQualityJobDefinitionResponse { + /** * @public - *

    Specifies the VPC used for non-EFS traffic. The default value is - * PublicInternetOnly.

    - *
      - *
    • - *

      - * PublicInternetOnly - Non-EFS traffic is through a VPC managed by - * Amazon SageMaker, which allows direct internet access

      - *
      • - *
    • - *

      - * VpcOnly - All Studio traffic is through the specified VPC and subnets

      - *
      • - *
    + *

    The Amazon Resource Name (ARN) of the data quality monitoring job definition.

    */ - AppNetworkAccessType?: AppNetworkAccessType; + JobDefinitionArn: string | undefined; /** * @public - * @deprecated - * - *

    Use KmsKeyId.

    + *

    The name of the data quality monitoring job definition.

    */ - HomeEfsFileSystemKmsKeyId?: string; + JobDefinitionName: string | undefined; /** * @public - *

    The VPC subnets that Studio uses for communication.

    + *

    The time that the data quality monitoring job definition was created.

    */ - SubnetIds?: string[]; + CreationTime: Date | undefined; /** * @public - *

    The domain's URL.

    + *

    The constraints and baselines for the data quality monitoring job definition.

    */ - Url?: string; + DataQualityBaselineConfig?: DataQualityBaselineConfig; /** * @public - *

    The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

    + *

    Information about the container that runs the data quality monitoring job.

    */ - VpcId?: string; + DataQualityAppSpecification: DataQualityAppSpecification | undefined; /** * @public - *

    The Amazon Web Services KMS customer managed key used to encrypt - * the EFS volume attached to the domain.

    + *

    The list of inputs for the data quality monitoring job. Currently endpoints are + * supported.

    */ - KmsKeyId?: string; + DataQualityJobInput: DataQualityJobInput | undefined; /** * @public - *

    A collection of Domain settings.

    + *

    The output configuration for monitoring jobs.

    */ - DomainSettings?: DomainSettings; + DataQualityJobOutputConfig: MonitoringOutputConfig | undefined; /** * @public - *

    The entity that creates and manages the required security groups for inter-app - * communication in VPCOnly mode. Required when - * CreateDomain.AppNetworkAccessType is VPCOnly and - * DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is - * provided.

    + *

    Identifies the resources to deploy for a monitoring job.

    */ - AppSecurityGroupManagement?: AppSecurityGroupManagement; + JobResources: MonitoringResources | undefined; /** * @public - *

    The ID of the security group that authorizes traffic between the - * RSessionGateway apps and the RStudioServerPro app.

    + *

    The networking configuration for the data quality monitoring job.

    */ - SecurityGroupIdForDomainBoundary?: string; + NetworkConfig?: MonitoringNetworkConfig; /** * @public - *

    The default settings used to create a space.

    + *

    The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can + * assume to perform tasks on your behalf.

    */ - DefaultSpaceSettings?: DefaultSpaceSettings; + RoleArn: string | undefined; + + /** + * @public + *

    A time limit for how long the monitoring job is allowed to run before stopping.

    + */ + StoppingCondition?: MonitoringStoppingCondition; } /** * @public */ -export interface DescribeEdgeDeploymentPlanRequest { +export interface DescribeDeviceRequest { /** * @public - *

    The name of the deployment plan to describe.

    + *

    Next token of device description.

    */ - EdgeDeploymentPlanName: string | undefined; + NextToken?: string; /** * @public - *

    If the edge deployment plan has enough stages to require tokening, then this is the - * response from the last list of stages returned.

    + *

    The unique ID of the device.

    */ - NextToken?: string; + DeviceName: string | undefined; /** * @public - *

    The maximum number of results to select (50 by default).

    + *

    The name of the fleet the devices belong to.

    */ - MaxResults?: number; + DeviceFleetName: string | undefined; } /** * @public + *

    The model on the edge device.

    */ -export interface DescribeEdgeDeploymentPlanResponse { - /** - * @public - *

    The ARN of edge deployment plan.

    - */ - EdgeDeploymentPlanArn: string | undefined; - +export interface EdgeModel { /** * @public - *

    The name of the edge deployment plan.

    + *

    The name of the model.

    */ - EdgeDeploymentPlanName: string | undefined; + ModelName: string | undefined; /** * @public - *

    List of models associated with the edge deployment plan.

    + *

    The model version.

    */ - ModelConfigs: EdgeDeploymentModelConfig[] | undefined; + ModelVersion: string | undefined; /** * @public - *

    The device fleet used for this edge deployment plan.

    + *

    The timestamp of the last data sample taken.

    */ - DeviceFleetName: string | undefined; + LatestSampleTime?: Date; /** * @public - *

    The number of edge devices with the successful deployment.

    + *

    The timestamp of the last inference that was made.

    */ - EdgeDeploymentSuccess?: number; + LatestInference?: Date; +} +/** + * @public + */ +export interface DescribeDeviceResponse { /** * @public - *

    The number of edge devices yet to pick up deployment, or in progress.

    + *

    The Amazon Resource Name (ARN) of the device.

    */ - EdgeDeploymentPending?: number; + DeviceArn?: string; /** * @public - *

    The number of edge devices that failed the deployment.

    + *

    The unique identifier of the device.

    */ - EdgeDeploymentFailed?: number; + DeviceName: string | undefined; /** * @public - *

    List of stages in the edge deployment plan.

    + *

    A description of the device.

    */ - Stages: DeploymentStageStatusSummary[] | undefined; + Description?: string; /** * @public - *

    Token to use when calling the next set of stages in the edge deployment plan.

    + *

    The name of the fleet the device belongs to.

    */ - NextToken?: string; + DeviceFleetName: string | undefined; /** * @public - *

    The time when the edge deployment plan was created.

    + *

    The Amazon Web Services Internet of Things (IoT) object thing name associated with the device.

    */ - CreationTime?: Date; + IotThingName?: string; /** * @public - *

    The time when the edge deployment plan was last updated.

    + *

    The timestamp of the last registration or de-reregistration.

    */ - LastModifiedTime?: Date; -} + RegistrationTime: Date | undefined; -/** - * @public - */ -export interface DescribeEdgePackagingJobRequest { /** * @public - *

    The name of the edge packaging job.

    + *

    The last heartbeat received from the device.

    */ - EdgePackagingJobName: string | undefined; -} - -/** - * @public - * @enum - */ -export const EdgePackagingJobStatus = { - Completed: "COMPLETED", - Failed: "FAILED", - InProgress: "INPROGRESS", - Starting: "STARTING", - Stopped: "STOPPED", - Stopping: "STOPPING", -} as const; - -/** - * @public - */ -export type EdgePackagingJobStatus = (typeof EdgePackagingJobStatus)[keyof typeof EdgePackagingJobStatus]; - -/** - * @public - * @enum - */ -export const EdgePresetDeploymentStatus = { - Completed: "COMPLETED", - Failed: "FAILED", -} as const; - -/** - * @public - */ -export type EdgePresetDeploymentStatus = (typeof EdgePresetDeploymentStatus)[keyof typeof EdgePresetDeploymentStatus]; + LatestHeartbeat?: Date; -/** - * @public - *

    The output of a SageMaker Edge Manager deployable resource.

    - */ -export interface EdgePresetDeploymentOutput { /** * @public - *

    The deployment type created by SageMaker Edge Manager. Currently only - * supports Amazon Web Services IoT Greengrass Version 2 components.

    + *

    Models on the device.

    */ - Type: EdgePresetDeploymentType | undefined; + Models?: EdgeModel[]; /** * @public - *

    The Amazon Resource Name (ARN) of the generated deployable resource.

    + *

    The maximum number of models.

    */ - Artifact?: string; + MaxModels?: number; /** * @public - *

    The status of the deployable resource.

    + *

    The response from the last list when returning a list large enough to need tokening.

    */ - Status?: EdgePresetDeploymentStatus; + NextToken?: string; /** * @public - *

    Returns a message describing the status of the deployed resource.

    + *

    Edge Manager agent version.

    */ - StatusMessage?: string; + AgentVersion?: string; } /** * @public */ -export interface DescribeEdgePackagingJobResponse { +export interface DescribeDeviceFleetRequest { /** * @public - *

    The Amazon Resource Name (ARN) of the edge packaging job.

    + *

    The name of the fleet.

    */ - EdgePackagingJobArn: string | undefined; + DeviceFleetName: string | undefined; +} +/** + * @public + */ +export interface DescribeDeviceFleetResponse { /** * @public - *

    The name of the edge packaging job.

    + *

    The name of the fleet.

    */ - EdgePackagingJobName: string | undefined; + DeviceFleetName: string | undefined; /** * @public - *

    The name of the SageMaker Neo compilation job that is used to locate model artifacts that are being packaged.

    + *

    The The Amazon Resource Name (ARN) of the fleet.

    */ - CompilationJobName?: string; + DeviceFleetArn: string | undefined; /** * @public - *

    The name of the model.

    + *

    The output configuration for storing sampled data.

    */ - ModelName?: string; + OutputConfig: EdgeOutputConfig | undefined; /** * @public - *

    The version of the model.

    + *

    A description of the fleet.

    */ - ModelVersion?: string; + Description?: string; /** * @public - *

    The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact Neo.

    + *

    Timestamp of when the device fleet was created.

    */ - RoleArn?: string; + CreationTime: Date | undefined; /** * @public - *

    The output configuration for the edge packaging job.

    + *

    Timestamp of when the device fleet was last updated.

    */ - OutputConfig?: EdgeOutputConfig; + LastModifiedTime: Date | undefined; /** * @public - *

    The Amazon Web Services KMS key to use when encrypting the EBS volume the job run on.

    + *

    The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).

    */ - ResourceKey?: string; + RoleArn?: string; /** * @public - *

    The current status of the packaging job.

    + *

    The Amazon Resource Name (ARN) alias created in Amazon Web Services Internet of Things (IoT).

    */ - EdgePackagingJobStatus: EdgePackagingJobStatus | undefined; + IotRoleAlias?: string; +} +/** + * @public + */ +export interface DescribeDomainRequest { /** * @public - *

    Returns a message describing the job status and error messages.

    + *

    The domain ID.

    */ - EdgePackagingJobStatusMessage?: string; + DomainId: string | undefined; +} +/** + * @public + * @enum + */ +export const DomainStatus = { + Delete_Failed: "Delete_Failed", + Deleting: "Deleting", + Failed: "Failed", + InService: "InService", + Pending: "Pending", + Update_Failed: "Update_Failed", + Updating: "Updating", +} as const; + +/** + * @public + */ +export type DomainStatus = (typeof DomainStatus)[keyof typeof DomainStatus]; + +/** + * @public + */ +export interface DescribeDomainResponse { /** * @public - *

    The timestamp of when the packaging job was created.

    + *

    The domain's Amazon Resource Name (ARN).

    */ - CreationTime?: Date; + DomainArn?: string; /** * @public - *

    The timestamp of when the job was last updated.

    + *

    The domain ID.

    */ - LastModifiedTime?: Date; + DomainId?: string; /** * @public - *

    The Amazon Simple Storage (S3) URI where model artifacts ares stored.

    + *

    The domain name.

    */ - ModelArtifact?: string; + DomainName?: string; /** * @public - *

    The signature document of files in the model artifact.

    + *

    The ID of the Amazon Elastic File System (EFS) managed by this Domain.

    */ - ModelSignature?: string; + HomeEfsFileSystemId?: string; /** * @public - *

    The output of a SageMaker Edge Manager deployable resource.

    + *

    The IAM Identity Center managed application instance ID.

    */ - PresetDeploymentOutput?: EdgePresetDeploymentOutput; -} + SingleSignOnManagedApplicationInstanceId?: string; -/** - * @public - */ -export interface DescribeEndpointInput { /** * @public - *

    The name of the endpoint.

    + *

    The ARN of the application managed by SageMaker in IAM Identity Center. This value is only returned for domains created after September 19, 2023.

    */ - EndpointName: string | undefined; -} + SingleSignOnApplicationArn?: string; -/** - * @public - * @enum - */ -export const EndpointStatus = { - CREATING: "Creating", - DELETING: "Deleting", - FAILED: "Failed", - IN_SERVICE: "InService", - OUT_OF_SERVICE: "OutOfService", - ROLLING_BACK: "RollingBack", - SYSTEM_UPDATING: "SystemUpdating", - UPDATE_ROLLBACK_FAILED: "UpdateRollbackFailed", - UPDATING: "Updating", -} as const; + /** + * @public + *

    The status.

    + */ + Status?: DomainStatus; -/** - * @public - */ -export type EndpointStatus = (typeof EndpointStatus)[keyof typeof EndpointStatus]; + /** + * @public + *

    The creation time.

    + */ + CreationTime?: Date; -/** - * @public - * @enum - */ -export const VariantStatus = { - ACTIVATING_TRAFFIC: "ActivatingTraffic", - BAKING: "Baking", - CREATING: "Creating", - DELETING: "Deleting", - UPDATING: "Updating", -} as const; + /** + * @public + *

    The last modified time.

    + */ + LastModifiedTime?: Date; -/** - * @public - */ -export type VariantStatus = (typeof VariantStatus)[keyof typeof VariantStatus]; + /** + * @public + *

    The failure reason.

    + */ + FailureReason?: string; -/** - * @public - *

    Describes the status of the production variant.

    - */ -export interface ProductionVariantStatus { /** * @public - *

    The endpoint variant status which describes the current deployment stage status or - * operational status.

    + *

    The domain's authentication mode.

    + */ + AuthMode?: AuthMode; + + /** + * @public + *

    Settings which are applied to UserProfiles in this domain if settings are not explicitly specified + * in a given UserProfile. + *

    + */ + DefaultUserSettings?: UserSettings; + + /** + * @public + *

    Specifies the VPC used for non-EFS traffic. The default value is + * PublicInternetOnly.

    *
      *
    • *

      - * Creating: Creating inference resources for the production - * variant.

      - *
      • - *
    • - *

      - * Deleting: Terminating inference resources for the production - * variant.

      - *
      • - *
    • - *

      - * Updating: Updating capacity for the production variant.

      - *
      • - *
    • - *

      - * ActivatingTraffic: Turning on traffic for the production - * variant.

      + * PublicInternetOnly - Non-EFS traffic is through a VPC managed by + * Amazon SageMaker, which allows direct internet access

      *
      • *
    • *

      - * Baking: Waiting period to monitor the CloudWatch alarms in the - * automatic rollback configuration.

      + * VpcOnly - All traffic is through the specified VPC and subnets

      *
      • *
    */ - Status: VariantStatus | undefined; - - /** - * @public - *

    A message that describes the status of the production variant.

    - */ - StatusMessage?: string; + AppNetworkAccessType?: AppNetworkAccessType; /** * @public - *

    The start time of the current status change.

    + * @deprecated + * + *

    Use KmsKeyId.

    */ - StartTime?: Date; -} + HomeEfsFileSystemKmsKeyId?: string; -/** - * @public - *

    The production variant summary for a deployment when an endpoint is creating or - * updating with the CreateEndpoint - * or UpdateEndpoint - * operations. Describes the VariantStatus , weight and capacity for a - * production variant associated with an endpoint.

    - */ -export interface PendingProductionVariantSummary { /** * @public - *

    The name of the variant.

    + *

    The VPC subnets that the domain uses for communication.

    */ - VariantName: string | undefined; + SubnetIds?: string[]; /** * @public - *

    An array of DeployedImage objects that specify the Amazon EC2 Container - * Registry paths of the inference images deployed on instances of this - * ProductionVariant.

    + *

    The domain's URL.

    */ - DeployedImages?: DeployedImage[]; + Url?: string; /** * @public - *

    The weight associated with the variant.

    + *

    The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

    */ - CurrentWeight?: number; + VpcId?: string; /** * @public - *

    The requested weight for the variant in this deployment, as specified in the endpoint - * configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.

    + *

    The Amazon Web Services KMS customer managed key used to encrypt + * the EFS volume attached to the domain.

    */ - DesiredWeight?: number; + KmsKeyId?: string; /** * @public - *

    The number of instances associated with the variant.

    + *

    A collection of Domain settings.

    */ - CurrentInstanceCount?: number; + DomainSettings?: DomainSettings; /** * @public - *

    The number of instances requested in this deployment, as specified in the endpoint - * configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.

    + *

    The entity that creates and manages the required security groups for inter-app + * communication in VPCOnly mode. Required when + * CreateDomain.AppNetworkAccessType is VPCOnly and + * DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is + * provided.

    */ - DesiredInstanceCount?: number; + AppSecurityGroupManagement?: AppSecurityGroupManagement; /** * @public - *

    The type of instances associated with the variant.

    + *

    The ID of the security group that authorizes traffic between the + * RSessionGateway apps and the RStudioServerPro app.

    */ - InstanceType?: ProductionVariantInstanceType; + SecurityGroupIdForDomainBoundary?: string; /** * @public - *

    The size of the Elastic Inference (EI) instance to use for the production variant. EI - * instances provide on-demand GPU computing for inference. For more information, see - * Using Elastic - * Inference in Amazon SageMaker.

    + *

    The default settings used to create a space.

    */ - AcceleratorType?: ProductionVariantAcceleratorType; + DefaultSpaceSettings?: DefaultSpaceSettings; +} +/** + * @public + */ +export interface DescribeEdgeDeploymentPlanRequest { /** * @public - *

    The endpoint variant status which describes the current deployment stage status or - * operational status.

    + *

    The name of the deployment plan to describe.

    */ - VariantStatus?: ProductionVariantStatus[]; + EdgeDeploymentPlanName: string | undefined; /** * @public - *

    The serverless configuration for the endpoint.

    + *

    If the edge deployment plan has enough stages to require tokening, then this is the + * response from the last list of stages returned.

    */ - CurrentServerlessConfig?: ProductionVariantServerlessConfig; + NextToken?: string; /** * @public - *

    The serverless configuration requested for this deployment, as specified in the endpoint configuration for the endpoint.

    + *

    The maximum number of results to select (50 by default).

    */ - DesiredServerlessConfig?: ProductionVariantServerlessConfig; + MaxResults?: number; } /** * @public - *

    The summary of an in-progress deployment when an endpoint is creating or updating with - * a new endpoint configuration.

    */ -export interface PendingDeploymentSummary { +export interface DescribeEdgeDeploymentPlanResponse { /** * @public - *

    The name of the endpoint configuration used in the deployment.

    + *

    The ARN of edge deployment plan.

    */ - EndpointConfigName: string | undefined; + EdgeDeploymentPlanArn: string | undefined; /** * @public - *

    An array of PendingProductionVariantSummary objects, one for each model hosted behind - * this endpoint for the in-progress deployment.

    + *

    The name of the edge deployment plan.

    */ - ProductionVariants?: PendingProductionVariantSummary[]; + EdgeDeploymentPlanName: string | undefined; /** * @public - *

    The start time of the deployment.

    + *

    List of models associated with the edge deployment plan.

    */ - StartTime?: Date; + ModelConfigs: EdgeDeploymentModelConfig[] | undefined; /** * @public - *

    An array of PendingProductionVariantSummary objects, one for each model hosted behind - * this endpoint in shadow mode with production traffic replicated from the model specified - * on ProductionVariants for the in-progress deployment.

    - */ - ShadowProductionVariants?: PendingProductionVariantSummary[]; -} - -/** - * @public - *

    Describes weight and capacities for a production variant associated with an - * endpoint. If you sent a request to the UpdateEndpointWeightsAndCapacities - * API and the endpoint status is Updating, you get different desired and - * current values.

    - */ -export interface ProductionVariantSummary { - /** - * @public - *

    The name of the variant.

    + *

    The device fleet used for this edge deployment plan.

    */ - VariantName: string | undefined; + DeviceFleetName: string | undefined; /** * @public - *

    An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the - * inference images deployed on instances of this ProductionVariant.

    + *

    The number of edge devices with the successful deployment.

    */ - DeployedImages?: DeployedImage[]; + EdgeDeploymentSuccess?: number; /** * @public - *

    The weight associated with the variant.

    + *

    The number of edge devices yet to pick up deployment, or in progress.

    */ - CurrentWeight?: number; + EdgeDeploymentPending?: number; /** * @public - *

    The requested weight, as specified in the - * UpdateEndpointWeightsAndCapacities request.

    + *

    The number of edge devices that failed the deployment.

    */ - DesiredWeight?: number; + EdgeDeploymentFailed?: number; /** * @public - *

    The number of instances associated with the variant.

    + *

    List of stages in the edge deployment plan.

    */ - CurrentInstanceCount?: number; + Stages: DeploymentStageStatusSummary[] | undefined; /** * @public - *

    The number of instances requested in the - * UpdateEndpointWeightsAndCapacities request.

    + *

    Token to use when calling the next set of stages in the edge deployment plan.

    */ - DesiredInstanceCount?: number; + NextToken?: string; /** * @public - *

    The endpoint variant status which describes the current deployment stage status or - * operational status.

    + *

    The time when the edge deployment plan was created.

    */ - VariantStatus?: ProductionVariantStatus[]; + CreationTime?: Date; /** * @public - *

    The serverless configuration for the endpoint.

    + *

    The time when the edge deployment plan was last updated.

    */ - CurrentServerlessConfig?: ProductionVariantServerlessConfig; + LastModifiedTime?: Date; +} +/** + * @public + */ +export interface DescribeEdgePackagingJobRequest { /** * @public - *

    The serverless configuration requested for the endpoint update.

    + *

    The name of the edge packaging job.

    */ - DesiredServerlessConfig?: ProductionVariantServerlessConfig; + EdgePackagingJobName: string | undefined; } /** * @public + * @enum */ -export interface DescribeEndpointOutput { +export const EdgePackagingJobStatus = { + Completed: "COMPLETED", + Failed: "FAILED", + InProgress: "INPROGRESS", + Starting: "STARTING", + Stopped: "STOPPED", + Stopping: "STOPPING", +} as const; + +/** + * @public + */ +export type EdgePackagingJobStatus = (typeof EdgePackagingJobStatus)[keyof typeof EdgePackagingJobStatus]; + +/** + * @public + * @enum + */ +export const EdgePresetDeploymentStatus = { + Completed: "COMPLETED", + Failed: "FAILED", +} as const; + +/** + * @public + */ +export type EdgePresetDeploymentStatus = (typeof EdgePresetDeploymentStatus)[keyof typeof EdgePresetDeploymentStatus]; + +/** + * @public + *

    The output of a SageMaker Edge Manager deployable resource.

    + */ +export interface EdgePresetDeploymentOutput { /** * @public - *

    Name of the endpoint.

    + *

    The deployment type created by SageMaker Edge Manager. Currently only + * supports Amazon Web Services IoT Greengrass Version 2 components.

    */ - EndpointName: string | undefined; + Type: EdgePresetDeploymentType | undefined; /** * @public - *

    The Amazon Resource Name (ARN) of the endpoint.

    + *

    The Amazon Resource Name (ARN) of the generated deployable resource.

    */ - EndpointArn: string | undefined; + Artifact?: string; /** * @public - *

    The name of the endpoint configuration associated with this endpoint.

    + *

    The status of the deployable resource.

    */ - EndpointConfigName: string | undefined; + Status?: EdgePresetDeploymentStatus; /** * @public - *

    An array of ProductionVariantSummary objects, one for each model hosted behind this - * endpoint.

    + *

    Returns a message describing the status of the deployed resource.

    */ - ProductionVariants?: ProductionVariantSummary[]; + StatusMessage?: string; +} +/** + * @public + */ +export interface DescribeEdgePackagingJobResponse { /** * @public - *

    The currently active data capture configuration used by your Endpoint.

    + *

    The Amazon Resource Name (ARN) of the edge packaging job.

    */ - DataCaptureConfig?: DataCaptureConfigSummary; + EdgePackagingJobArn: string | undefined; /** * @public - *

    The status of the endpoint.

    - *
      - *
    • - *

      - * OutOfService: Endpoint is not available to take incoming - * requests.

      - *
      • - *
    • - *

      - * Creating: CreateEndpoint is executing.

      - *
      • - *
    • - *

      - * Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

      - *
      • - *
    • - *

      - * SystemUpdating: Endpoint is undergoing maintenance and cannot be - * updated or deleted or re-scaled until it has completed. This maintenance - * operation does not change any customer-specified values such as VPC config, KMS - * encryption, model, instance type, or instance count.

      - *
      • - *
    • - *

      - * RollingBack: Endpoint fails to scale up or down or change its - * variant weight and is in the process of rolling back to its previous - * configuration. Once the rollback completes, endpoint returns to an - * InService status. This transitional status only applies to an - * endpoint that has autoscaling enabled and is undergoing variant weight or - * capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called - * explicitly.

      - *
      • - *
    • - *

      - * InService: Endpoint is available to process incoming - * requests.

      - *
      • - *
    • - *

      - * Deleting: DeleteEndpoint is executing.

      - *
      • - *
    • - *

      - * Failed: Endpoint could not be created, updated, or re-scaled. Use - * the FailureReason value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a - * failed endpoint.

      - *
      • - *
    • - *

      - * UpdateRollbackFailed: Both the rolling deployment and - * auto-rollback failed. Your endpoint is in service with a mix of the old and new - * endpoint configurations. For information about how to remedy this issue and - * restore the endpoint's status to InService, see Rolling - * Deployments.

      - *
      • - *
    + *

    The name of the edge packaging job.

    */ - EndpointStatus: EndpointStatus | undefined; + EdgePackagingJobName: string | undefined; /** * @public - *

    If the status of the endpoint is Failed, the reason why it failed. - *

    + *

    The name of the SageMaker Neo compilation job that is used to locate model artifacts that are being packaged.

    */ - FailureReason?: string; + CompilationJobName?: string; /** * @public - *

    A timestamp that shows when the endpoint was created.

    + *

    The name of the model.

    */ - CreationTime: Date | undefined; + ModelName?: string; /** * @public - *

    A timestamp that shows when the endpoint was last modified.

    + *

    The version of the model.

    */ - LastModifiedTime: Date | undefined; + ModelVersion?: string; /** * @public - *

    The most recent deployment configuration for the endpoint.

    + *

    The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact Neo.

    */ - LastDeploymentConfig?: DeploymentConfig; + RoleArn?: string; /** * @public - *

    Returns the description of an endpoint configuration created using the - * CreateEndpointConfig - * API.

    + *

    The output configuration for the edge packaging job.

    */ - AsyncInferenceConfig?: AsyncInferenceConfig; + OutputConfig?: EdgeOutputConfig; /** * @public - *

    Returns the summary of an in-progress deployment. This field is only returned when the - * endpoint is creating or updating with a new endpoint configuration.

    + *

    The Amazon Web Services KMS key to use when encrypting the EBS volume the job run on.

    */ - PendingDeploymentSummary?: PendingDeploymentSummary; + ResourceKey?: string; /** * @public - *

    The configuration parameters for an explainer.

    + *

    The current status of the packaging job.

    */ - ExplainerConfig?: ExplainerConfig; + EdgePackagingJobStatus: EdgePackagingJobStatus | undefined; /** * @public - *

    An array of ProductionVariantSummary objects, one for each model that you want to host - * at this endpoint in shadow mode with production traffic replicated from the model - * specified on ProductionVariants.

    + *

    Returns a message describing the job status and error messages.

    */ - ShadowProductionVariants?: ProductionVariantSummary[]; -} + EdgePackagingJobStatusMessage?: string; -/** - * @public - */ -export interface DescribeEndpointConfigInput { /** * @public - *

    The name of the endpoint configuration.

    + *

    The timestamp of when the packaging job was created.

    */ - EndpointConfigName: string | undefined; -} + CreationTime?: Date; -/** - * @public - */ -export interface DescribeEndpointConfigOutput { /** * @public - *

    Name of the SageMaker endpoint configuration.

    + *

    The timestamp of when the job was last updated.

    */ - EndpointConfigName: string | undefined; + LastModifiedTime?: Date; /** * @public - *

    The Amazon Resource Name (ARN) of the endpoint configuration.

    + *

    The Amazon Simple Storage (S3) URI where model artifacts ares stored.

    */ - EndpointConfigArn: string | undefined; + ModelArtifact?: string; /** * @public - *

    An array of ProductionVariant objects, one for each model that you - * want to host at this endpoint.

    + *

    The signature document of files in the model artifact.

    */ - ProductionVariants: ProductionVariant[] | undefined; + ModelSignature?: string; /** * @public - *

    Configuration to control how SageMaker captures inference data.

    + *

    The output of a SageMaker Edge Manager deployable resource.

    */ - DataCaptureConfig?: DataCaptureConfig; + PresetDeploymentOutput?: EdgePresetDeploymentOutput; +} +/** + * @public + */ +export interface DescribeEndpointInput { /** * @public - *

    Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML - * storage volume attached to the instance.

    + *

    The name of the endpoint.

    */ - KmsKeyId?: string; + EndpointName: string | undefined; +} - /** - * @public - *

    A timestamp that shows when the endpoint configuration was created.

    - */ - CreationTime: Date | undefined; +/** + * @public + * @enum + */ +export const EndpointStatus = { + CREATING: "Creating", + DELETING: "Deleting", + FAILED: "Failed", + IN_SERVICE: "InService", + OUT_OF_SERVICE: "OutOfService", + ROLLING_BACK: "RollingBack", + SYSTEM_UPDATING: "SystemUpdating", + UPDATE_ROLLBACK_FAILED: "UpdateRollbackFailed", + UPDATING: "Updating", +} as const; + +/** + * @public + */ +export type EndpointStatus = (typeof EndpointStatus)[keyof typeof EndpointStatus]; + +/** + * @public + * @enum + */ +export const VariantStatus = { + ACTIVATING_TRAFFIC: "ActivatingTraffic", + BAKING: "Baking", + CREATING: "Creating", + DELETING: "Deleting", + UPDATING: "Updating", +} as const; + +/** + * @public + */ +export type VariantStatus = (typeof VariantStatus)[keyof typeof VariantStatus]; +/** + * @public + *

    Describes the status of the production variant.

    + */ +export interface ProductionVariantStatus { /** * @public - *

    Returns the description of an endpoint configuration created using the - * CreateEndpointConfig - * API.

    + *

    The endpoint variant status which describes the current deployment stage status or + * operational status.

    + *
      + *
    • + *

      + * Creating: Creating inference resources for the production + * variant.

      + *
      • + *
    • + *

      + * Deleting: Terminating inference resources for the production + * variant.

      + *
      • + *
    • + *

      + * Updating: Updating capacity for the production variant.

      + *
      • + *
    • + *

      + * ActivatingTraffic: Turning on traffic for the production + * variant.

      + *
      • + *
    • + *

      + * Baking: Waiting period to monitor the CloudWatch alarms in the + * automatic rollback configuration.

      + *
      • + *
    */ - AsyncInferenceConfig?: AsyncInferenceConfig; + Status: VariantStatus | undefined; /** * @public - *

    The configuration parameters for an explainer.

    + *

    A message that describes the status of the production variant.

    */ - ExplainerConfig?: ExplainerConfig; + StatusMessage?: string; /** * @public - *

    An array of ProductionVariant objects, one for each model that you want - * to host at this endpoint in shadow mode with production traffic replicated from the - * model specified on ProductionVariants.

    + *

    The start time of the current status change.

    */ - ShadowProductionVariants?: ProductionVariant[]; + StartTime?: Date; } /** * @public + *

    The production variant summary for a deployment when an endpoint is creating or + * updating with the CreateEndpoint + * or UpdateEndpoint + * operations. Describes the VariantStatus , weight and capacity for a + * production variant associated with an endpoint.

    */ -export interface DescribeExperimentRequest { +export interface PendingProductionVariantSummary { /** * @public - *

    The name of the experiment to describe.

    + *

    The name of the variant.

    */ - ExperimentName: string | undefined; -} + VariantName: string | undefined; -/** - * @public - *

    The source of the experiment.

    - */ -export interface ExperimentSource { /** * @public - *

    The Amazon Resource Name (ARN) of the source.

    + *

    An array of DeployedImage objects that specify the Amazon EC2 Container + * Registry paths of the inference images deployed on instances of this + * ProductionVariant.

    */ - SourceArn: string | undefined; + DeployedImages?: DeployedImage[]; /** * @public - *

    The source type.

    + *

    The weight associated with the variant.

    */ - SourceType?: string; -} + CurrentWeight?: number; -/** - * @public - */ -export interface DescribeExperimentResponse { /** * @public - *

    The name of the experiment.

    + *

    The requested weight for the variant in this deployment, as specified in the endpoint + * configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.

    */ - ExperimentName?: string; + DesiredWeight?: number; /** * @public - *

    The Amazon Resource Name (ARN) of the experiment.

    + *

    The number of instances associated with the variant.

    */ - ExperimentArn?: string; + CurrentInstanceCount?: number; /** * @public - *

    The name of the experiment as displayed. If DisplayName isn't specified, - * ExperimentName is displayed.

    + *

    The number of instances requested in this deployment, as specified in the endpoint + * configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.

    */ - DisplayName?: string; + DesiredInstanceCount?: number; /** * @public - *

    The Amazon Resource Name (ARN) of the source and, optionally, the type.

    + *

    The type of instances associated with the variant.

    */ - Source?: ExperimentSource; + InstanceType?: ProductionVariantInstanceType; /** * @public - *

    The description of the experiment.

    + *

    The size of the Elastic Inference (EI) instance to use for the production variant. EI + * instances provide on-demand GPU computing for inference. For more information, see + * Using Elastic + * Inference in Amazon SageMaker.

    */ - Description?: string; + AcceleratorType?: ProductionVariantAcceleratorType; /** * @public - *

    When the experiment was created.

    + *

    The endpoint variant status which describes the current deployment stage status or + * operational status.

    */ - CreationTime?: Date; + VariantStatus?: ProductionVariantStatus[]; /** * @public - *

    Who created the experiment.

    + *

    The serverless configuration for the endpoint.

    */ - CreatedBy?: UserContext; + CurrentServerlessConfig?: ProductionVariantServerlessConfig; /** * @public - *

    When the experiment was last modified.

    + *

    The serverless configuration requested for this deployment, as specified in the endpoint configuration for the endpoint.

    */ - LastModifiedTime?: Date; + DesiredServerlessConfig?: ProductionVariantServerlessConfig; /** * @public - *

    Who last modified the experiment.

    + *

    Settings that control the range in the number of instances that the endpoint provisions + * as it scales up or down to accommodate traffic.

    */ - LastModifiedBy?: UserContext; + ManagedInstanceScaling?: ProductionVariantManagedInstanceScaling; + + /** + * @public + *

    Settings that control how the endpoint routes incoming traffic to the instances that the + * endpoint hosts.

    + */ + RoutingConfig?: ProductionVariantRoutingConfig; } /** * @public + *

    The summary of an in-progress deployment when an endpoint is creating or updating with + * a new endpoint configuration.

    */ -export interface DescribeFeatureGroupRequest { +export interface PendingDeploymentSummary { /** * @public - *

    The name or Amazon Resource Name (ARN) of the FeatureGroup you want - * described.

    + *

    The name of the endpoint configuration used in the deployment.

    */ - FeatureGroupName: string | undefined; + EndpointConfigName: string | undefined; /** * @public - *

    A token to resume pagination of the list of Features - * (FeatureDefinitions). 2,500 Features are returned by - * default.

    + *

    An array of PendingProductionVariantSummary objects, one for each model hosted behind + * this endpoint for the in-progress deployment.

    */ - NextToken?: string; -} - -/** - * @public - * @enum - */ -export const FeatureGroupStatus = { - CREATED: "Created", - CREATE_FAILED: "CreateFailed", - CREATING: "Creating", - DELETE_FAILED: "DeleteFailed", - DELETING: "Deleting", -} as const; + ProductionVariants?: PendingProductionVariantSummary[]; -/** - * @public - */ -export type FeatureGroupStatus = (typeof FeatureGroupStatus)[keyof typeof FeatureGroupStatus]; + /** + * @public + *

    The start time of the deployment.

    + */ + StartTime?: Date; -/** - * @public - * @enum - */ -export const LastUpdateStatusValue = { - FAILED: "Failed", - IN_PROGRESS: "InProgress", - SUCCESSFUL: "Successful", -} as const; + /** + * @public + *

    An array of PendingProductionVariantSummary objects, one for each model hosted behind + * this endpoint in shadow mode with production traffic replicated from the model specified + * on ProductionVariants for the in-progress deployment.

    + */ + ShadowProductionVariants?: PendingProductionVariantSummary[]; +} /** * @public + *

    Describes weight and capacities for a production variant associated with an + * endpoint. If you sent a request to the UpdateEndpointWeightsAndCapacities + * API and the endpoint status is Updating, you get different desired and + * current values.

    */ -export type LastUpdateStatusValue = (typeof LastUpdateStatusValue)[keyof typeof LastUpdateStatusValue]; +export interface ProductionVariantSummary { + /** + * @public + *

    The name of the variant.

    + */ + VariantName: string | undefined; -/** - * @public - *

    A value that indicates whether the update was successful.

    - */ -export interface LastUpdateStatus { /** * @public - *

    A value that indicates whether the update was made successful.

    + *

    An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the + * inference images deployed on instances of this ProductionVariant.

    */ - Status: LastUpdateStatusValue | undefined; + DeployedImages?: DeployedImage[]; /** * @public - *

    If the update wasn't successful, indicates the reason why it failed.

    + *

    The weight associated with the variant.

    */ - FailureReason?: string; -} + CurrentWeight?: number; -/** - * @public - * @enum - */ -export const OfflineStoreStatusValue = { - ACTIVE: "Active", - BLOCKED: "Blocked", - DISABLED: "Disabled", -} as const; + /** + * @public + *

    The requested weight, as specified in the + * UpdateEndpointWeightsAndCapacities request.

    + */ + DesiredWeight?: number; -/** - * @public - */ -export type OfflineStoreStatusValue = (typeof OfflineStoreStatusValue)[keyof typeof OfflineStoreStatusValue]; + /** + * @public + *

    The number of instances associated with the variant.

    + */ + CurrentInstanceCount?: number; -/** - * @public - *

    The status of OfflineStore.

    - */ -export interface OfflineStoreStatus { /** * @public - *

    An OfflineStore status.

    + *

    The number of instances requested in the + * UpdateEndpointWeightsAndCapacities request.

    */ - Status: OfflineStoreStatusValue | undefined; + DesiredInstanceCount?: number; /** * @public - *

    The justification for why the OfflineStoreStatus is Blocked (if applicable).

    + *

    The endpoint variant status which describes the current deployment stage status or + * operational status.

    */ - BlockedReason?: string; -} + VariantStatus?: ProductionVariantStatus[]; -/** - * @public - */ -export interface DescribeFeatureGroupResponse { /** * @public - *

    The Amazon Resource Name (ARN) of the FeatureGroup.

    + *

    The serverless configuration for the endpoint.

    */ - FeatureGroupArn: string | undefined; + CurrentServerlessConfig?: ProductionVariantServerlessConfig; /** * @public - *

    he name of the FeatureGroup.

    + *

    The serverless configuration requested for the endpoint update.

    */ - FeatureGroupName: string | undefined; + DesiredServerlessConfig?: ProductionVariantServerlessConfig; /** * @public - *

    The name of the Feature used for RecordIdentifier, whose value - * uniquely identifies a record stored in the feature store.

    + *

    Settings that control the range in the number of instances that the endpoint provisions + * as it scales up or down to accommodate traffic.

    */ - RecordIdentifierFeatureName: string | undefined; + ManagedInstanceScaling?: ProductionVariantManagedInstanceScaling; /** * @public - *

    The name of the feature that stores the EventTime of a Record in a - * FeatureGroup.

    - *

    An EventTime is a point in time when a new event occurs that corresponds - * to the creation or update of a Record in a FeatureGroup. All - * Records in the FeatureGroup have a corresponding - * EventTime.

    + *

    Settings that control how the endpoint routes incoming traffic to the instances that the + * endpoint hosts.

    */ - EventTimeFeatureName: string | undefined; + RoutingConfig?: ProductionVariantRoutingConfig; +} +/** + * @public + */ +export interface DescribeEndpointOutput { /** * @public - *

    A list of the Features in the FeatureGroup. Each feature is - * defined by a FeatureName and FeatureType.

    + *

    Name of the endpoint.

    */ - FeatureDefinitions: FeatureDefinition[] | undefined; + EndpointName: string | undefined; /** * @public - *

    A timestamp indicating when SageMaker created the FeatureGroup.

    + *

    The Amazon Resource Name (ARN) of the endpoint.

    */ - CreationTime: Date | undefined; + EndpointArn: string | undefined; /** * @public - *

    A timestamp indicating when the feature group was last updated.

    + *

    The name of the endpoint configuration associated with this endpoint.

    */ - LastModifiedTime?: Date; + EndpointConfigName: string | undefined; /** * @public - *

    The configuration for the OnlineStore.

    + *

    An array of ProductionVariantSummary objects, one for each model hosted behind this + * endpoint.

    */ - OnlineStoreConfig?: OnlineStoreConfig; + ProductionVariants?: ProductionVariantSummary[]; /** * @public - *

    The configuration of the offline store. It includes the following configurations:

    + *

    The currently active data capture configuration used by your Endpoint.

    + */ + DataCaptureConfig?: DataCaptureConfigSummary; + + /** + * @public + *

    The status of the endpoint.

    *
      *
    • - *

      Amazon S3 location of the offline store.

      + *

      + * OutOfService: Endpoint is not available to take incoming + * requests.

      *
      • *
    • - *

      Configuration of the Glue data catalog.

      + *

      + * Creating: CreateEndpoint is executing.

      *
      • *
    • - *

      Table format of the offline store.

      + *

      + * Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

      *
      • *
    • - *

      Option to disable the automatic creation of a Glue table for the offline - * store.

      + *

      + * SystemUpdating: Endpoint is undergoing maintenance and cannot be + * updated or deleted or re-scaled until it has completed. This maintenance + * operation does not change any customer-specified values such as VPC config, KMS + * encryption, model, instance type, or instance count.

      *
      • *
    • - *

      Encryption configuration.

      + *

      + * RollingBack: Endpoint fails to scale up or down or change its + * variant weight and is in the process of rolling back to its previous + * configuration. Once the rollback completes, endpoint returns to an + * InService status. This transitional status only applies to an + * endpoint that has autoscaling enabled and is undergoing variant weight or + * capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called + * explicitly.

      + *
      • + *
    • + *

      + * InService: Endpoint is available to process incoming + * requests.

      + *
      • + *
    • + *

      + * Deleting: DeleteEndpoint is executing.

      + *
      • + *
    • + *

      + * Failed: Endpoint could not be created, updated, or re-scaled. Use + * the FailureReason value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a + * failed endpoint.

      + *
      • + *
    • + *

      + * UpdateRollbackFailed: Both the rolling deployment and + * auto-rollback failed. Your endpoint is in service with a mix of the old and new + * endpoint configurations. For information about how to remedy this issue and + * restore the endpoint's status to InService, see Rolling + * Deployments.

      *
      • *
    */ - OfflineStoreConfig?: OfflineStoreConfig; + EndpointStatus: EndpointStatus | undefined; /** * @public - *

    The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the - * OfflineStore if an OfflineStoreConfig is provided.

    + *

    If the status of the endpoint is Failed, the reason why it failed. + *

    */ - RoleArn?: string; + FailureReason?: string; /** * @public - *

    The status of the feature group.

    + *

    A timestamp that shows when the endpoint was created.

    */ - FeatureGroupStatus?: FeatureGroupStatus; + CreationTime: Date | undefined; /** * @public - *

    The status of the OfflineStore. Notifies you if replicating data into the - * OfflineStore has failed. Returns either: Active or - * Blocked - *

    + *

    A timestamp that shows when the endpoint was last modified.

    */ - OfflineStoreStatus?: OfflineStoreStatus; + LastModifiedTime: Date | undefined; /** * @public - *

    A value indicating whether the update made to the feature group was successful.

    + *

    The most recent deployment configuration for the endpoint.

    */ - LastUpdateStatus?: LastUpdateStatus; + LastDeploymentConfig?: DeploymentConfig; /** * @public - *

    The reason that the FeatureGroup failed to be replicated in the - * OfflineStore. This is failure can occur because:

    - *
      - *
    • - *

      The FeatureGroup could not be created in the - * OfflineStore.

      - *
      • - *
    • - *

      The FeatureGroup could not be deleted from the - * OfflineStore.

      - *
      • - *
    + *

    Returns the description of an endpoint configuration created using the + * CreateEndpointConfig + * API.

    */ - FailureReason?: string; + AsyncInferenceConfig?: AsyncInferenceConfig; /** * @public - *

    A free form description of the feature group.

    + *

    Returns the summary of an in-progress deployment. This field is only returned when the + * endpoint is creating or updating with a new endpoint configuration.

    */ - Description?: string; + PendingDeploymentSummary?: PendingDeploymentSummary; /** * @public - *

    A token to resume pagination of the list of Features - * (FeatureDefinitions).

    + *

    The configuration parameters for an explainer.

    */ - NextToken: string | undefined; + ExplainerConfig?: ExplainerConfig; /** * @public - *

    The size of the OnlineStore in bytes.

    + *

    An array of ProductionVariantSummary objects, one for each model that you want to host + * at this endpoint in shadow mode with production traffic replicated from the model + * specified on ProductionVariants.

    */ - OnlineStoreTotalSizeBytes?: number; + ShadowProductionVariants?: ProductionVariantSummary[]; } /** * @public */ -export interface DescribeFeatureMetadataRequest { - /** - * @public - *

    The name or Amazon Resource Name (ARN) of the feature group containing the - * feature.

    - */ - FeatureGroupName: string | undefined; - +export interface DescribeEndpointConfigInput { /** * @public - *

    The name of the feature.

    + *

    The name of the endpoint configuration.

    */ - FeatureName: string | undefined; + EndpointConfigName: string | undefined; } /** * @public - *

    A key-value pair that you specify to describe the feature.

    */ -export interface FeatureParameter { +export interface DescribeEndpointConfigOutput { /** * @public - *

    A key that must contain a value to describe the feature.

    + *

    Name of the SageMaker endpoint configuration.

    */ - Key?: string; + EndpointConfigName: string | undefined; /** * @public - *

    The value that belongs to a key.

    + *

    The Amazon Resource Name (ARN) of the endpoint configuration.

    */ - Value?: string; -} + EndpointConfigArn: string | undefined; -/** - * @public - */ -export interface DescribeFeatureMetadataResponse { /** * @public - *

    The Amazon Resource Number (ARN) of the feature group that contains the feature.

    + *

    An array of ProductionVariant objects, one for each model that you + * want to host at this endpoint.

    */ - FeatureGroupArn: string | undefined; + ProductionVariants: ProductionVariant[] | undefined; /** * @public - *

    The name of the feature group that you've specified.

    + *

    Configuration to control how SageMaker captures inference data.

    */ - FeatureGroupName: string | undefined; + DataCaptureConfig?: DataCaptureConfig; /** * @public - *

    The name of the feature that you've specified.

    + *

    Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML + * storage volume attached to the instance.

    */ - FeatureName: string | undefined; + KmsKeyId?: string; /** * @public - *

    The data type of the feature.

    + *

    A timestamp that shows when the endpoint configuration was created.

    */ - FeatureType: FeatureType | undefined; + CreationTime: Date | undefined; /** * @public - *

    A timestamp indicating when the feature was created.

    + *

    Returns the description of an endpoint configuration created using the + * CreateEndpointConfig + * API.

    */ - CreationTime: Date | undefined; + AsyncInferenceConfig?: AsyncInferenceConfig; /** * @public - *

    A timestamp indicating when the metadata for the feature group was modified. For - * example, if you add a parameter describing the feature, the timestamp changes to reflect - * the last time you

    + *

    The configuration parameters for an explainer.

    */ - LastModifiedTime: Date | undefined; + ExplainerConfig?: ExplainerConfig; /** * @public - *

    The description you added to describe the feature.

    - */ - Description?: string; + *

    An array of ProductionVariant objects, one for each model that you want + * to host at this endpoint in shadow mode with production traffic replicated from the + * model specified on ProductionVariants.

    + */ + ShadowProductionVariants?: ProductionVariant[]; /** * @public - *

    The key-value pairs that you added to describe the feature.

    + *

    The Amazon Resource Name (ARN) of the IAM role that you assigned to the + * endpoint configuration.

    */ - Parameters?: FeatureParameter[]; -} + ExecutionRoleArn?: string; -/** - * @public - */ -export interface DescribeFlowDefinitionRequest { /** * @public - *

    The name of the flow definition.

    + *

    Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources + * have access to. You can control access to and from your resources by configuring a VPC. + * For more information, see Give SageMaker Access to Resources in your Amazon VPC.

    */ - FlowDefinitionName: string | undefined; + VpcConfig?: VpcConfig; + + /** + * @public + *

    Indicates whether all model containers deployed to the endpoint are isolated. If they + * are, no inbound or outbound network calls can be made to or from the model + * containers.

    + */ + EnableNetworkIsolation?: boolean; } /** * @public - * @enum */ -export const FlowDefinitionStatus = { - ACTIVE: "Active", - DELETING: "Deleting", - FAILED: "Failed", - INITIALIZING: "Initializing", -} as const; +export interface DescribeExperimentRequest { + /** + * @public + *

    The name of the experiment to describe.

    + */ + ExperimentName: string | undefined; +} /** * @public + *

    The source of the experiment.

    */ -export type FlowDefinitionStatus = (typeof FlowDefinitionStatus)[keyof typeof FlowDefinitionStatus]; +export interface ExperimentSource { + /** + * @public + *

    The Amazon Resource Name (ARN) of the source.

    + */ + SourceArn: string | undefined; -/** - * @public - */ -export interface DescribeFlowDefinitionResponse { /** * @public - *

    The Amazon Resource Name (ARN) of the flow defintion.

    + *

    The source type.

    */ - FlowDefinitionArn: string | undefined; + SourceType?: string; +} +/** + * @public + */ +export interface DescribeExperimentResponse { /** * @public - *

    The Amazon Resource Name (ARN) of the flow definition.

    + *

    The name of the experiment.

    */ - FlowDefinitionName: string | undefined; + ExperimentName?: string; /** * @public - *

    The status of the flow definition. Valid values are listed below.

    + *

    The Amazon Resource Name (ARN) of the experiment.

    */ - FlowDefinitionStatus: FlowDefinitionStatus | undefined; + ExperimentArn?: string; /** * @public - *

    The timestamp when the flow definition was created.

    + *

    The name of the experiment as displayed. If DisplayName isn't specified, + * ExperimentName is displayed.

    */ - CreationTime: Date | undefined; + DisplayName?: string; /** * @public - *

    Container for configuring the source of human task requests. Used to specify if - * Amazon Rekognition or Amazon Textract is used as an integration source.

    + *

    The Amazon Resource Name (ARN) of the source and, optionally, the type.

    */ - HumanLoopRequestSource?: HumanLoopRequestSource; + Source?: ExperimentSource; /** * @public - *

    An object containing information about what triggers a human review workflow.

    + *

    The description of the experiment.

    */ - HumanLoopActivationConfig?: HumanLoopActivationConfig; + Description?: string; /** * @public - *

    An object containing information about who works on the task, the workforce task price, and other task details.

    + *

    When the experiment was created.

    */ - HumanLoopConfig: HumanLoopConfig | undefined; + CreationTime?: Date; /** * @public - *

    An object containing information about the output file.

    + *

    Who created the experiment.

    */ - OutputConfig: FlowDefinitionOutputConfig | undefined; + CreatedBy?: UserContext; /** * @public - *

    The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) execution role for the flow definition.

    + *

    When the experiment was last modified.

    */ - RoleArn: string | undefined; + LastModifiedTime?: Date; /** * @public - *

    The reason your flow definition failed.

    + *

    Who last modified the experiment.

    */ - FailureReason?: string; + LastModifiedBy?: UserContext; } /** * @public */ -export interface DescribeHubRequest { +export interface DescribeFeatureGroupRequest { /** * @public - *

    The name of the hub to describe.

    + *

    The name or Amazon Resource Name (ARN) of the FeatureGroup you want + * described.

    */ - HubName: string | undefined; + FeatureGroupName: string | undefined; + + /** + * @public + *

    A token to resume pagination of the list of Features + * (FeatureDefinitions). 2,500 Features are returned by + * default.

    + */ + NextToken?: string; } /** * @public * @enum */ -export const HubStatus = { +export const FeatureGroupStatus = { + CREATED: "Created", CREATE_FAILED: "CreateFailed", CREATING: "Creating", DELETE_FAILED: "DeleteFailed", DELETING: "Deleting", - IN_SERVICE: "InService", - UPDATE_FAILED: "UpdateFailed", - UPDATING: "Updating", } as const; /** * @public */ -export type HubStatus = (typeof HubStatus)[keyof typeof HubStatus]; +export type FeatureGroupStatus = (typeof FeatureGroupStatus)[keyof typeof FeatureGroupStatus]; /** * @public + * @enum */ -export interface DescribeHubResponse { +export const LastUpdateStatusValue = { + FAILED: "Failed", + IN_PROGRESS: "InProgress", + SUCCESSFUL: "Successful", +} as const; + +/** + * @public + */ +export type LastUpdateStatusValue = (typeof LastUpdateStatusValue)[keyof typeof LastUpdateStatusValue]; + +/** + * @public + *

    A value that indicates whether the update was successful.

    + */ +export interface LastUpdateStatus { /** * @public - *

    The name of the hub.

    + *

    A value that indicates whether the update was made successful.

    */ - HubName: string | undefined; + Status: LastUpdateStatusValue | undefined; /** * @public - *

    The Amazon Resource Name (ARN) of the hub.

    + *

    If the update wasn't successful, indicates the reason why it failed.

    */ - HubArn: string | undefined; + FailureReason?: string; +} + +/** + * @public + * @enum + */ +export const OfflineStoreStatusValue = { + ACTIVE: "Active", + BLOCKED: "Blocked", + DISABLED: "Disabled", +} as const; + +/** + * @public + */ +export type OfflineStoreStatusValue = (typeof OfflineStoreStatusValue)[keyof typeof OfflineStoreStatusValue]; +/** + * @public + *

    The status of OfflineStore.

    + */ +export interface OfflineStoreStatus { /** * @public - *

    The display name of the hub.

    + *

    An OfflineStore status.

    */ - HubDisplayName?: string; + Status: OfflineStoreStatusValue | undefined; /** * @public - *

    A description of the hub.

    + *

    The justification for why the OfflineStoreStatus is Blocked (if applicable).

    */ - HubDescription?: string; + BlockedReason?: string; +} +/** + * @public + */ +export interface DescribeFeatureGroupResponse { /** * @public - *

    The searchable keywords for the hub.

    + *

    The Amazon Resource Name (ARN) of the FeatureGroup.

    */ - HubSearchKeywords?: string[]; + FeatureGroupArn: string | undefined; /** * @public - *

    The Amazon S3 storage configuration for the hub.

    + *

    he name of the FeatureGroup.

    */ - S3StorageConfig?: HubS3StorageConfig; + FeatureGroupName: string | undefined; /** * @public - *

    The status of the hub.

    + *

    The name of the Feature used for RecordIdentifier, whose value + * uniquely identifies a record stored in the feature store.

    */ - HubStatus: HubStatus | undefined; + RecordIdentifierFeatureName: string | undefined; /** * @public - *

    The failure reason if importing hub content failed.

    + *

    The name of the feature that stores the EventTime of a Record in a + * FeatureGroup.

    + *

    An EventTime is a point in time when a new event occurs that corresponds + * to the creation or update of a Record in a FeatureGroup. All + * Records in the FeatureGroup have a corresponding + * EventTime.

    */ - FailureReason?: string; + EventTimeFeatureName: string | undefined; /** * @public - *

    The date and time that the hub was created.

    + *

    A list of the Features in the FeatureGroup. Each feature is + * defined by a FeatureName and FeatureType.

    */ - CreationTime: Date | undefined; + FeatureDefinitions: FeatureDefinition[] | undefined; /** * @public - *

    The date and time that the hub was last modified.

    + *

    A timestamp indicating when SageMaker created the FeatureGroup.

    */ - LastModifiedTime: Date | undefined; -} + CreationTime: Date | undefined; -/** - * @public - */ -export interface DescribeHubContentRequest { /** * @public - *

    The name of the hub that contains the content to describe.

    + *

    A timestamp indicating when the feature group was last updated.

    */ - HubName: string | undefined; + LastModifiedTime?: Date; /** * @public - *

    The type of content in the hub.

    + *

    The configuration for the OnlineStore.

    */ - HubContentType: HubContentType | undefined; + OnlineStoreConfig?: OnlineStoreConfig; /** * @public - *

    The name of the content to describe.

    + *

    The configuration of the offline store. It includes the following configurations:

    + *
      + *
    • + *

      Amazon S3 location of the offline store.

      + *
      • + *
    • + *

      Configuration of the Glue data catalog.

      + *
      • + *
    • + *

      Table format of the offline store.

      + *
      • + *
    • + *

      Option to disable the automatic creation of a Glue table for the offline + * store.

      + *
      • + *
    • + *

      Encryption configuration.

      + *
      • + *
    */ - HubContentName: string | undefined; + OfflineStoreConfig?: OfflineStoreConfig; /** * @public - *

    The version of the content to describe.

    + *

    The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the + * OfflineStore if an OfflineStoreConfig is provided.

    */ - HubContentVersion?: string; -} + RoleArn?: string; -/** - * @public - *

    Any dependencies related to hub content, such as scripts, model artifacts, datasets, or notebooks.

    - */ -export interface HubContentDependency { /** * @public - *

    The hub content dependency origin path.

    + *

    The status of the feature group.

    */ - DependencyOriginPath?: string; + FeatureGroupStatus?: FeatureGroupStatus; /** * @public - *

    The hub content dependency copy path.

    + *

    The status of the OfflineStore. Notifies you if replicating data into the + * OfflineStore has failed. Returns either: Active or + * Blocked + *

    */ - DependencyCopyPath?: string; -} - -/** - * @public - * @enum - */ -export const HubContentStatus = { - AVAILABLE: "Available", - DELETE_FAILED: "DeleteFailed", - DELETING: "Deleting", - IMPORTING: "Importing", - IMPORT_FAILED: "ImportFailed", -} as const; + OfflineStoreStatus?: OfflineStoreStatus; -/** - * @public - */ -export type HubContentStatus = (typeof HubContentStatus)[keyof typeof HubContentStatus]; + /** + * @public + *

    A value indicating whether the update made to the feature group was successful.

    + */ + LastUpdateStatus?: LastUpdateStatus; -/** - * @public - */ -export interface DescribeHubContentResponse { /** * @public - *

    The name of the hub content.

    + *

    The reason that the FeatureGroup failed to be replicated in the + * OfflineStore. This is failure can occur because:

    + *
      + *
    • + *

      The FeatureGroup could not be created in the + * OfflineStore.

      + *
      • + *
    • + *

      The FeatureGroup could not be deleted from the + * OfflineStore.

      + *
      • + *
    */ - HubContentName: string | undefined; + FailureReason?: string; /** * @public - *

    The Amazon Resource Name (ARN) of the hub content.

    + *

    A free form description of the feature group.

    */ - HubContentArn: string | undefined; + Description?: string; /** * @public - *

    The version of the hub content.

    + *

    A token to resume pagination of the list of Features + * (FeatureDefinitions).

    */ - HubContentVersion: string | undefined; + NextToken: string | undefined; /** * @public - *

    The type of hub content.

    + *

    The size of the OnlineStore in bytes.

    */ - HubContentType: HubContentType | undefined; + OnlineStoreTotalSizeBytes?: number; +} +/** + * @public + */ +export interface DescribeFeatureMetadataRequest { /** * @public - *

    The document schema version for the hub content.

    + *

    The name or Amazon Resource Name (ARN) of the feature group containing the + * feature.

    */ - DocumentSchemaVersion: string | undefined; + FeatureGroupName: string | undefined; /** * @public - *

    The name of the hub that contains the content.

    + *

    The name of the feature.

    */ - HubName: string | undefined; + FeatureName: string | undefined; +} +/** + * @public + *

    A key-value pair that you specify to describe the feature.

    + */ +export interface FeatureParameter { /** * @public - *

    The Amazon Resource Name (ARN) of the hub that contains the content.

    + *

    A key that must contain a value to describe the feature.

    */ - HubArn: string | undefined; + Key?: string; /** * @public - *

    The display name of the hub content.

    + *

    The value that belongs to a key.

    */ - HubContentDisplayName?: string; + Value?: string; +} +/** + * @public + */ +export interface DescribeFeatureMetadataResponse { /** * @public - *

    A description of the hub content.

    + *

    The Amazon Resource Number (ARN) of the feature group that contains the feature.

    */ - HubContentDescription?: string; + FeatureGroupArn: string | undefined; /** * @public - *

    A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.

    + *

    The name of the feature group that you've specified.

    */ - HubContentMarkdown?: string; + FeatureGroupName: string | undefined; /** * @public - *

    The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.

    + *

    The name of the feature that you've specified.

    */ - HubContentDocument: string | undefined; + FeatureName: string | undefined; /** * @public - *

    The searchable keywords for the hub content.

    + *

    The data type of the feature.

    */ - HubContentSearchKeywords?: string[]; + FeatureType: FeatureType | undefined; /** * @public - *

    The location of any dependencies that the hub content has, such as scripts, model artifacts, datasets, or notebooks.

    + *

    A timestamp indicating when the feature was created.

    */ - HubContentDependencies?: HubContentDependency[]; + CreationTime: Date | undefined; /** * @public - *

    The status of the hub content.

    + *

    A timestamp indicating when the metadata for the feature group was modified. For + * example, if you add a parameter describing the feature, the timestamp changes to reflect + * the last time you

    */ - HubContentStatus: HubContentStatus | undefined; + LastModifiedTime: Date | undefined; /** * @public - *

    The failure reason if importing hub content failed.

    + *

    The description you added to describe the feature.

    */ - FailureReason?: string; + Description?: string; /** * @public - *

    The date and time that hub content was created.

    + *

    The key-value pairs that you added to describe the feature.

    */ - CreationTime: Date | undefined; + Parameters?: FeatureParameter[]; } /** * @public */ -export interface DescribeHumanTaskUiRequest { +export interface DescribeFlowDefinitionRequest { /** * @public - *

    The name of the human task user interface - * (worker task template) you want information about.

    + *

    The name of the flow definition.

    */ - HumanTaskUiName: string | undefined; + FlowDefinitionName: string | undefined; } /** * @public * @enum */ -export const HumanTaskUiStatus = { +export const FlowDefinitionStatus = { ACTIVE: "Active", DELETING: "Deleting", + FAILED: "Failed", + INITIALIZING: "Initializing", } as const; /** * @public */ -export type HumanTaskUiStatus = (typeof HumanTaskUiStatus)[keyof typeof HumanTaskUiStatus]; +export type FlowDefinitionStatus = (typeof FlowDefinitionStatus)[keyof typeof FlowDefinitionStatus]; /** * @public - *

    Container for user interface template information.

    */ -export interface UiTemplateInfo { +export interface DescribeFlowDefinitionResponse { /** * @public - *

    The URL for the user interface template.

    + *

    The Amazon Resource Name (ARN) of the flow defintion.

    */ - Url?: string; + FlowDefinitionArn: string | undefined; /** * @public - *

    The SHA-256 digest of the contents of the template.

    + *

    The Amazon Resource Name (ARN) of the flow definition.

    */ - ContentSha256?: string; -} + FlowDefinitionName: string | undefined; -/** - * @public - */ -export interface DescribeHumanTaskUiResponse { /** * @public - *

    The Amazon Resource Name (ARN) of the human task user interface (worker task template).

    + *

    The status of the flow definition. Valid values are listed below.

    */ - HumanTaskUiArn: string | undefined; + FlowDefinitionStatus: FlowDefinitionStatus | undefined; /** * @public - *

    The name of the human task user interface (worker task template).

    + *

    The timestamp when the flow definition was created.

    */ - HumanTaskUiName: string | undefined; + CreationTime: Date | undefined; /** * @public - *

    The status of the human task user interface (worker task template). Valid values are listed below.

    + *

    Container for configuring the source of human task requests. Used to specify if + * Amazon Rekognition or Amazon Textract is used as an integration source.

    */ - HumanTaskUiStatus?: HumanTaskUiStatus; + HumanLoopRequestSource?: HumanLoopRequestSource; /** * @public - *

    The timestamp when the human task user interface was created.

    + *

    An object containing information about what triggers a human review workflow.

    */ - CreationTime: Date | undefined; + HumanLoopActivationConfig?: HumanLoopActivationConfig; /** * @public - *

    Container for user interface template information.

    + *

    An object containing information about who works on the task, the workforce task price, and other task details.

    */ - UiTemplate: UiTemplateInfo | undefined; -} + HumanLoopConfig: HumanLoopConfig | undefined; -/** - * @public - */ -export interface DescribeHyperParameterTuningJobRequest { /** * @public - *

    The name of the tuning job.

    + *

    An object containing information about the output file.

    */ - HyperParameterTuningJobName: string | undefined; -} + OutputConfig: FlowDefinitionOutputConfig | undefined; -/** - * @public - *

    Shows the latest objective metric emitted by a training job that was launched by a - * hyperparameter tuning job. You define the objective metric in the - * HyperParameterTuningJobObjective parameter of HyperParameterTuningJobConfig.

    - */ -export interface FinalHyperParameterTuningJobObjectiveMetric { /** * @public - *

    Select if you want to minimize or maximize the objective metric during hyperparameter - * tuning.

    + *

    The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) execution role for the flow definition.

    */ - Type?: HyperParameterTuningJobObjectiveType; + RoleArn: string | undefined; /** * @public - *

    The name of the objective metric. For SageMaker built-in algorithms, metrics are defined - * per algorithm. See the metrics for XGBoost as an - * example. You can also use a custom algorithm for training and define your own metrics. - * For more information, see Define metrics and environment variables.

    + *

    The reason your flow definition failed.

    */ - MetricName: string | undefined; + FailureReason?: string; +} +/** + * @public + */ +export interface DescribeHubRequest { /** * @public - *

    The value of the objective metric.

    + *

    The name of the hub to describe.

    */ - Value: number | undefined; + HubName: string | undefined; } /** * @public * @enum */ -export const TrainingJobStatus = { - COMPLETED: "Completed", - FAILED: "Failed", - IN_PROGRESS: "InProgress", - STOPPED: "Stopped", - STOPPING: "Stopping", +export const HubStatus = { + CREATE_FAILED: "CreateFailed", + CREATING: "Creating", + DELETE_FAILED: "DeleteFailed", + DELETING: "Deleting", + IN_SERVICE: "InService", + UPDATE_FAILED: "UpdateFailed", + UPDATING: "Updating", } as const; /** * @public */ -export type TrainingJobStatus = (typeof TrainingJobStatus)[keyof typeof TrainingJobStatus]; +export type HubStatus = (typeof HubStatus)[keyof typeof HubStatus]; /** * @public - *

    The container for the summary information about a training job.

    */ -export interface HyperParameterTrainingJobSummary { +export interface DescribeHubResponse { /** * @public - *

    The training job definition name.

    + *

    The name of the hub.

    */ - TrainingJobDefinitionName?: string; + HubName: string | undefined; /** * @public - *

    The name of the training job.

    + *

    The Amazon Resource Name (ARN) of the hub.

    */ - TrainingJobName: string | undefined; + HubArn: string | undefined; /** * @public - *

    The Amazon Resource Name (ARN) of the training job.

    + *

    The display name of the hub.

    */ - TrainingJobArn: string | undefined; + HubDisplayName?: string; /** * @public - *

    The HyperParameter tuning job that launched the training job.

    + *

    A description of the hub.

    */ - TuningJobName?: string; + HubDescription?: string; /** * @public - *

    The date and time that the training job was created.

    + *

    The searchable keywords for the hub.

    */ - CreationTime: Date | undefined; + HubSearchKeywords?: string[]; /** * @public - *

    The date and time that the training job started.

    + *

    The Amazon S3 storage configuration for the hub.

    */ - TrainingStartTime?: Date; + S3StorageConfig?: HubS3StorageConfig; /** * @public - *

    Specifies the time when the training job ends on training instances. You are billed - * for the time interval between the value of TrainingStartTime and this time. - * For successful jobs and stopped jobs, this is the time after model artifacts are - * uploaded. For failed jobs, this is the time when SageMaker detects a job failure.

    + *

    The status of the hub.

    */ - TrainingEndTime?: Date; + HubStatus: HubStatus | undefined; /** * @public - *

    The - * status - * of the training job.

    + *

    The failure reason if importing hub content failed.

    */ - TrainingJobStatus: TrainingJobStatus | undefined; + FailureReason?: string; /** * @public - *

    A - * list of the hyperparameters for which you specified ranges to - * search.

    + *

    The date and time that the hub was created.

    */ - TunedHyperParameters: Record | undefined; + CreationTime: Date | undefined; /** * @public - *

    The - * reason that the training job failed. - *

    + *

    The date and time that the hub was last modified.

    */ - FailureReason?: string; + LastModifiedTime: Date | undefined; +} +/** + * @public + */ +export interface DescribeHubContentRequest { /** * @public - *

    The FinalHyperParameterTuningJobObjectiveMetric object that specifies the - * value - * of the - * objective - * metric of the tuning job that launched this training job.

    + *

    The name of the hub that contains the content to describe.

    */ - FinalHyperParameterTuningJobObjectiveMetric?: FinalHyperParameterTuningJobObjectiveMetric; + HubName: string | undefined; /** * @public - *

    The status of the objective metric for the training job:

    - *
      - *
    • - *

      Succeeded: The - * final - * objective metric for the training job was evaluated by the - * hyperparameter tuning job and - * used - * in the hyperparameter tuning process.

      - *
      • - *
    - *
      - *
    • - *

      Pending: The training job is in progress and evaluation of its final objective - * metric is pending.

      - *
      • - *
    - *
      - *
    • - *

      Failed: - * The final objective metric for the training job was not evaluated, and was not - * used in the hyperparameter tuning process. This typically occurs when the - * training job failed or did not emit an objective - * metric.

      - *
      • - *
    + *

    The type of content in the hub.

    */ - ObjectiveStatus?: ObjectiveStatus; + HubContentType: HubContentType | undefined; + + /** + * @public + *

    The name of the content to describe.

    + */ + HubContentName: string | undefined; + + /** + * @public + *

    The version of the content to describe.

    + */ + HubContentVersion?: string; } /** * @public - *

    The total resources consumed by your hyperparameter tuning job.

    + *

    Any dependencies related to hub content, such as scripts, model artifacts, datasets, or notebooks.

    */ -export interface HyperParameterTuningJobConsumedResources { +export interface HubContentDependency { /** * @public - *

    The wall clock runtime in seconds used by your hyperparameter tuning job.

    + *

    The hub content dependency origin path.

    */ - RuntimeInSeconds?: number; + DependencyOriginPath?: string; + + /** + * @public + *

    The hub content dependency copy path.

    + */ + DependencyCopyPath?: string; } /** * @public * @enum */ -export const HyperParameterTuningJobStatus = { - COMPLETED: "Completed", - FAILED: "Failed", - IN_PROGRESS: "InProgress", - STOPPED: "Stopped", - STOPPING: "Stopping", +export const HubContentStatus = { + AVAILABLE: "Available", + DELETE_FAILED: "DeleteFailed", + DELETING: "Deleting", + IMPORTING: "Importing", + IMPORT_FAILED: "ImportFailed", } as const; /** * @public */ -export type HyperParameterTuningJobStatus = - (typeof HyperParameterTuningJobStatus)[keyof typeof HyperParameterTuningJobStatus]; +export type HubContentStatus = (typeof HubContentStatus)[keyof typeof HubContentStatus]; /** * @public - *

    Specifies the number of training jobs that this hyperparameter tuning job launched, - * categorized by the status of their objective metric. The objective metric status shows - * whether the - * final - * objective metric for the training job has been evaluated by the - * tuning job and used in the hyperparameter tuning process.

    */ -export interface ObjectiveStatusCounters { +export interface DescribeHubContentResponse { /** * @public - *

    The number of training jobs whose final objective metric was evaluated by the - * hyperparameter tuning job and used in the hyperparameter tuning process.

    + *

    The name of the hub content.

    */ - Succeeded?: number; + HubContentName: string | undefined; /** * @public - *

    The number of training jobs that are in progress and pending evaluation of their final - * objective metric.

    + *

    The Amazon Resource Name (ARN) of the hub content.

    */ - Pending?: number; + HubContentArn: string | undefined; /** * @public - *

    The number of training jobs whose final objective metric was not evaluated and used in - * the hyperparameter tuning process. This typically occurs when the training job failed or - * did not emit an objective metric.

    + *

    The version of the hub content.

    */ - Failed?: number; -} + HubContentVersion: string | undefined; -/** - * @public - *

    The numbers of training jobs launched by a hyperparameter tuning job, categorized by - * status.

    - */ -export interface TrainingJobStatusCounters { /** * @public - *

    The number of completed training jobs launched by the hyperparameter tuning - * job.

    + *

    The type of hub content.

    */ - Completed?: number; + HubContentType: HubContentType | undefined; /** * @public - *

    The number of in-progress training jobs launched by a hyperparameter tuning - * job.

    + *

    The document schema version for the hub content.

    */ - InProgress?: number; + DocumentSchemaVersion: string | undefined; /** * @public - *

    The number of training jobs that failed, but can be retried. A failed training job can - * be retried only if it failed because an internal service error occurred.

    + *

    The name of the hub that contains the content.

    */ - RetryableError?: number; + HubName: string | undefined; /** * @public - *

    The number of training jobs that failed and can't be retried. A failed training job - * can't be retried if it failed because a client error occurred.

    + *

    The Amazon Resource Name (ARN) of the hub that contains the content.

    */ - NonRetryableError?: number; + HubArn: string | undefined; /** * @public - *

    The number of training jobs launched by a hyperparameter tuning job that were - * manually - * stopped.

    + *

    The display name of the hub content.

    */ - Stopped?: number; -} + HubContentDisplayName?: string; -/** - * @public - *

    A structure that contains runtime information about both current and completed - * hyperparameter tuning jobs.

    - */ -export interface HyperParameterTuningJobCompletionDetails { /** * @public - *

    The number of training jobs launched by a tuning job that are not improving (1% or - * less) as measured by model performance evaluated against an objective function.

    + *

    A description of the hub content.

    */ - NumberOfTrainingJobsObjectiveNotImproving?: number; + HubContentDescription?: string; /** * @public - *

    The time in timestamp format that AMT detected model convergence, as defined by a lack - * of significant improvement over time based on criteria developed over a wide range of - * diverse benchmarking tests.

    + *

    A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.

    */ - ConvergenceDetectedTime?: Date; -} + HubContentMarkdown?: string; -/** - * @public - */ -export interface DescribeHyperParameterTuningJobResponse { /** * @public - *

    The name of the hyperparameter tuning job.

    + *

    The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.

    */ - HyperParameterTuningJobName: string | undefined; + HubContentDocument: string | undefined; /** * @public - *

    The Amazon Resource Name (ARN) of the tuning job.

    + *

    The searchable keywords for the hub content.

    */ - HyperParameterTuningJobArn: string | undefined; + HubContentSearchKeywords?: string[]; /** * @public - *

    The HyperParameterTuningJobConfig object that specifies the configuration of - * the tuning job.

    + *

    The location of any dependencies that the hub content has, such as scripts, model artifacts, datasets, or notebooks.

    */ - HyperParameterTuningJobConfig: HyperParameterTuningJobConfig | undefined; + HubContentDependencies?: HubContentDependency[]; /** * @public - *

    The HyperParameterTrainingJobDefinition object that specifies the definition of - * the training jobs that this tuning job launches.

    + *

    The status of the hub content.

    */ - TrainingJobDefinition?: HyperParameterTrainingJobDefinition; + HubContentStatus: HubContentStatus | undefined; /** * @public - *

    A list of the HyperParameterTrainingJobDefinition objects launched for this tuning - * job.

    + *

    The failure reason if importing hub content failed.

    */ - TrainingJobDefinitions?: HyperParameterTrainingJobDefinition[]; + FailureReason?: string; /** * @public - *

    The status of the tuning job: InProgress, Completed, Failed, Stopping, or - * Stopped.

    + *

    The date and time that hub content was created.

    */ - HyperParameterTuningJobStatus: HyperParameterTuningJobStatus | undefined; + CreationTime: Date | undefined; +} +/** + * @public + */ +export interface DescribeHumanTaskUiRequest { /** * @public - *

    The date and time that the tuning job started.

    + *

    The name of the human task user interface + * (worker task template) you want information about.

    */ - CreationTime: Date | undefined; + HumanTaskUiName: string | undefined; +} + +/** + * @public + * @enum + */ +export const HumanTaskUiStatus = { + ACTIVE: "Active", + DELETING: "Deleting", +} as const; +/** + * @public + */ +export type HumanTaskUiStatus = (typeof HumanTaskUiStatus)[keyof typeof HumanTaskUiStatus]; + +/** + * @public + *

    Container for user interface template information.

    + */ +export interface UiTemplateInfo { /** * @public - *

    The date and time that the tuning job ended.

    + *

    The URL for the user interface template.

    */ - HyperParameterTuningEndTime?: Date; + Url?: string; /** * @public - *

    The date and time that the status of the tuning job was modified.

    + *

    The SHA-256 digest of the contents of the template.

    */ - LastModifiedTime?: Date; - - /** - * @public - *

    The TrainingJobStatusCounters object that specifies the number of training - * jobs, categorized by status, that this tuning job launched.

    - */ - TrainingJobStatusCounters: TrainingJobStatusCounters | undefined; + ContentSha256?: string; +} +/** + * @public + */ +export interface DescribeHumanTaskUiResponse { /** * @public - *

    The ObjectiveStatusCounters object that specifies the number of training jobs, - * categorized by the status of their final objective metric, that this tuning job - * launched.

    + *

    The Amazon Resource Name (ARN) of the human task user interface (worker task template).

    */ - ObjectiveStatusCounters: ObjectiveStatusCounters | undefined; + HumanTaskUiArn: string | undefined; /** * @public - *

    A TrainingJobSummary object that describes the training job that completed - * with the best current HyperParameterTuningJobObjective.

    + *

    The name of the human task user interface (worker task template).

    */ - BestTrainingJob?: HyperParameterTrainingJobSummary; + HumanTaskUiName: string | undefined; /** * @public - *

    If the hyperparameter tuning job is an warm start tuning job with a - * WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the - * TrainingJobSummary for the training job with the best objective metric - * value of all training jobs launched by this tuning job and all parent jobs specified for - * the warm start tuning job.

    + *

    The status of the human task user interface (worker task template). Valid values are listed below.

    */ - OverallBestTrainingJob?: HyperParameterTrainingJobSummary; + HumanTaskUiStatus?: HumanTaskUiStatus; /** * @public - *

    The configuration for starting the hyperparameter parameter tuning job using one or - * more previous tuning jobs as a starting point. The results of previous tuning jobs are - * used to inform which combinations of hyperparameters to search over in the new tuning - * job.

    + *

    The timestamp when the human task user interface was created.

    */ - WarmStartConfig?: HyperParameterTuningJobWarmStartConfig; + CreationTime: Date | undefined; /** * @public - *

    If the tuning job failed, the reason it failed.

    + *

    Container for user interface template information.

    */ - FailureReason?: string; + UiTemplate: UiTemplateInfo | undefined; +} +/** + * @public + */ +export interface DescribeHyperParameterTuningJobRequest { /** * @public - *

    Tuning job completion information returned as the response from a hyperparameter - * tuning job. This information tells if your tuning job has or has not converged. It also - * includes the number of training jobs that have not improved model performance as - * evaluated against the objective function.

    + *

    The name of the tuning job.

    */ - TuningJobCompletionDetails?: HyperParameterTuningJobCompletionDetails; + HyperParameterTuningJobName: string | undefined; +} +/** + * @public + *

    Shows the latest objective metric emitted by a training job that was launched by a + * hyperparameter tuning job. You define the objective metric in the + * HyperParameterTuningJobObjective parameter of HyperParameterTuningJobConfig.

    + */ +export interface FinalHyperParameterTuningJobObjectiveMetric { /** * @public - *

    The total resources consumed by your hyperparameter tuning job.

    + *

    Select if you want to minimize or maximize the objective metric during hyperparameter + * tuning.

    */ - ConsumedResources?: HyperParameterTuningJobConsumedResources; + Type?: HyperParameterTuningJobObjectiveType; /** * @public - *

    A flag to indicate if autotune is enabled for the hyperparameter tuning job.

    + *

    The name of the objective metric. For SageMaker built-in algorithms, metrics are defined + * per algorithm. See the metrics for XGBoost as an + * example. You can also use a custom algorithm for training and define your own metrics. + * For more information, see Define metrics and environment variables.

    */ - Autotune?: Autotune; -} + MetricName: string | undefined; -/** - * @public - */ -export interface DescribeImageRequest { /** * @public - *

    The name of the image to describe.

    + *

    The value of the objective metric.

    */ - ImageName: string | undefined; + Value: number | undefined; } /** * @public * @enum */ -export const ImageStatus = { - CREATED: "CREATED", - CREATE_FAILED: "CREATE_FAILED", - CREATING: "CREATING", - DELETE_FAILED: "DELETE_FAILED", - DELETING: "DELETING", - UPDATE_FAILED: "UPDATE_FAILED", - UPDATING: "UPDATING", +export const TrainingJobStatus = { + COMPLETED: "Completed", + FAILED: "Failed", + IN_PROGRESS: "InProgress", + STOPPED: "Stopped", + STOPPING: "Stopping", } as const; /** * @public */ -export type ImageStatus = (typeof ImageStatus)[keyof typeof ImageStatus]; +export type TrainingJobStatus = (typeof TrainingJobStatus)[keyof typeof TrainingJobStatus]; /** * @public + *

    The container for the summary information about a training job.

    */ -export interface DescribeImageResponse { +export interface HyperParameterTrainingJobSummary { /** * @public - *

    When the image was created.

    + *

    The training job definition name.

    */ - CreationTime?: Date; + TrainingJobDefinitionName?: string; /** * @public - *

    The description of the image.

    + *

    The name of the training job.

    */ - Description?: string; + TrainingJobName: string | undefined; /** * @public - *

    The name of the image as displayed.

    + *

    The Amazon Resource Name (ARN) of the training job.

    */ - DisplayName?: string; + TrainingJobArn: string | undefined; /** * @public - *

    When a create, update, or delete operation fails, the reason for the failure.

    + *

    The HyperParameter tuning job that launched the training job.

    */ - FailureReason?: string; + TuningJobName?: string; /** * @public - *

    The ARN of the image.

    + *

    The date and time that the training job was created.

    */ - ImageArn?: string; + CreationTime: Date | undefined; /** * @public - *

    The name of the image.

    + *

    The date and time that the training job started.

    */ - ImageName?: string; + TrainingStartTime?: Date; /** * @public - *

    The status of the image.

    + *

    Specifies the time when the training job ends on training instances. You are billed + * for the time interval between the value of TrainingStartTime and this time. + * For successful jobs and stopped jobs, this is the time after model artifacts are + * uploaded. For failed jobs, this is the time when SageMaker detects a job failure.

    */ - ImageStatus?: ImageStatus; + TrainingEndTime?: Date; /** * @public - *

    When the image was last modified.

    + *

    The + * status + * of the training job.

    */ - LastModifiedTime?: Date; + TrainingJobStatus: TrainingJobStatus | undefined; /** * @public - *

    The ARN of the IAM role that enables Amazon SageMaker to perform tasks on your behalf.

    + *

    A + * list of the hyperparameters for which you specified ranges to + * search.

    */ - RoleArn?: string; -} + TunedHyperParameters: Record | undefined; -/** - * @public - */ -export interface DescribeImageVersionRequest { /** * @public - *

    The name of the image.

    + *

    The + * reason that the training job failed. + *

    */ - ImageName: string | undefined; + FailureReason?: string; /** * @public - *

    The version of the image. If not specified, the latest version is described.

    + *

    The FinalHyperParameterTuningJobObjectiveMetric object that specifies the + * value + * of the + * objective + * metric of the tuning job that launched this training job.

    */ - Version?: number; + FinalHyperParameterTuningJobObjectiveMetric?: FinalHyperParameterTuningJobObjectiveMetric; /** * @public - *

    The alias of the image version.

    + *

    The status of the objective metric for the training job:

    + *
      + *
    • + *

      Succeeded: The + * final + * objective metric for the training job was evaluated by the + * hyperparameter tuning job and + * used + * in the hyperparameter tuning process.

      + *
      • + *
    + *
      + *
    • + *

      Pending: The training job is in progress and evaluation of its final objective + * metric is pending.

      + *
      • + *
    + *
      + *
    • + *

      Failed: + * The final objective metric for the training job was not evaluated, and was not + * used in the hyperparameter tuning process. This typically occurs when the + * training job failed or did not emit an objective + * metric.

      + *
      • + *
    */ - Alias?: string; + ObjectiveStatus?: ObjectiveStatus; +} + +/** + * @public + *

    The total resources consumed by your hyperparameter tuning job.

    + */ +export interface HyperParameterTuningJobConsumedResources { + /** + * @public + *

    The wall clock runtime in seconds used by your hyperparameter tuning job.

    + */ + RuntimeInSeconds?: number; } /** * @public * @enum */ -export const ImageVersionStatus = { - CREATED: "CREATED", - CREATE_FAILED: "CREATE_FAILED", - CREATING: "CREATING", - DELETE_FAILED: "DELETE_FAILED", - DELETING: "DELETING", +export const HyperParameterTuningJobStatus = { + COMPLETED: "Completed", + FAILED: "Failed", + IN_PROGRESS: "InProgress", + STOPPED: "Stopped", + STOPPING: "Stopping", } as const; /** * @public */ -export type ImageVersionStatus = (typeof ImageVersionStatus)[keyof typeof ImageVersionStatus]; +export type HyperParameterTuningJobStatus = + (typeof HyperParameterTuningJobStatus)[keyof typeof HyperParameterTuningJobStatus]; /** * @public + *

    Specifies the number of training jobs that this hyperparameter tuning job launched, + * categorized by the status of their objective metric. The objective metric status shows + * whether the + * final + * objective metric for the training job has been evaluated by the + * tuning job and used in the hyperparameter tuning process.

    */ -export interface DescribeImageVersionResponse { +export interface ObjectiveStatusCounters { /** * @public - *

    The registry path of the container image on which this image version is based.

    + *

    The number of training jobs whose final objective metric was evaluated by the + * hyperparameter tuning job and used in the hyperparameter tuning process.

    */ - BaseImage?: string; + Succeeded?: number; /** * @public - *

    The registry path of the container image that contains this image version.

    + *

    The number of training jobs that are in progress and pending evaluation of their final + * objective metric.

    */ - ContainerImage?: string; + Pending?: number; /** * @public - *

    When the version was created.

    + *

    The number of training jobs whose final objective metric was not evaluated and used in + * the hyperparameter tuning process. This typically occurs when the training job failed or + * did not emit an objective metric.

    */ - CreationTime?: Date; + Failed?: number; +} +/** + * @public + *

    The numbers of training jobs launched by a hyperparameter tuning job, categorized by + * status.

    + */ +export interface TrainingJobStatusCounters { /** * @public - *

    When a create or delete operation fails, the reason for the failure.

    + *

    The number of completed training jobs launched by the hyperparameter tuning + * job.

    */ - FailureReason?: string; + Completed?: number; /** * @public - *

    The ARN of the image the version is based on.

    + *

    The number of in-progress training jobs launched by a hyperparameter tuning + * job.

    */ - ImageArn?: string; + InProgress?: number; /** * @public - *

    The ARN of the version.

    + *

    The number of training jobs that failed, but can be retried. A failed training job can + * be retried only if it failed because an internal service error occurred.

    */ - ImageVersionArn?: string; + RetryableError?: number; /** * @public - *

    The status of the version.

    + *

    The number of training jobs that failed and can't be retried. A failed training job + * can't be retried if it failed because a client error occurred.

    */ - ImageVersionStatus?: ImageVersionStatus; + NonRetryableError?: number; /** * @public - *

    When the version was last modified.

    + *

    The number of training jobs launched by a hyperparameter tuning job that were + * manually + * stopped.

    */ - LastModifiedTime?: Date; + Stopped?: number; +} +/** + * @public + *

    A structure that contains runtime information about both current and completed + * hyperparameter tuning jobs.

    + */ +export interface HyperParameterTuningJobCompletionDetails { /** * @public - *

    The version number.

    + *

    The number of training jobs launched by a tuning job that are not improving (1% or + * less) as measured by model performance evaluated against an objective function.

    */ - Version?: number; + NumberOfTrainingJobsObjectiveNotImproving?: number; /** * @public - *

    The stability of the image version specified by the maintainer.

    - *
      - *
    • - *

      - * NOT_PROVIDED: The maintainers did not provide a status for image version stability.

      - *
      • - *
    • - *

      - * STABLE: The image version is stable.

      - *
      • - *
    • - *

      - * TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

      - *
      • - *
    • - *

      - * ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

      - *
      • - *
    + *

    The time in timestamp format that AMT detected model convergence, as defined by a lack + * of significant improvement over time based on criteria developed over a wide range of + * diverse benchmarking tests.

    */ - VendorGuidance?: VendorGuidance; + ConvergenceDetectedTime?: Date; +} +/** + * @public + */ +export interface DescribeHyperParameterTuningJobResponse { /** * @public - *

    Indicates SageMaker job type compatibility.

    - *
      - *
    • - *

      - * TRAINING: The image version is compatible with SageMaker training jobs.

      - *
      • - *
    • - *

      - * INFERENCE: The image version is compatible with SageMaker inference jobs.

      - *
      • - *
    • - *

      - * NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.

      - *
      • - *
    + *

    The name of the hyperparameter tuning job.

    */ - JobType?: JobType; + HyperParameterTuningJobName: string | undefined; /** * @public - *

    The machine learning framework vended in the image version.

    + *

    The Amazon Resource Name (ARN) of the tuning job.

    */ - MLFramework?: string; + HyperParameterTuningJobArn: string | undefined; /** * @public - *

    The supported programming language and its version.

    + *

    The HyperParameterTuningJobConfig object that specifies the configuration of + * the tuning job.

    */ - ProgrammingLang?: string; + HyperParameterTuningJobConfig: HyperParameterTuningJobConfig | undefined; /** * @public - *

    Indicates CPU or GPU compatibility.

    - *
      - *
    • - *

      - * CPU: The image version is compatible with CPU.

      - *
      • - *
    • - *

      - * GPU: The image version is compatible with GPU.

      - *
      • - *
    + *

    The HyperParameterTrainingJobDefinition object that specifies the definition of + * the training jobs that this tuning job launches.

    */ - Processor?: Processor; + TrainingJobDefinition?: HyperParameterTrainingJobDefinition; /** * @public - *

    Indicates Horovod compatibility.

    + *

    A list of the HyperParameterTrainingJobDefinition objects launched for this tuning + * job.

    */ - Horovod?: boolean; + TrainingJobDefinitions?: HyperParameterTrainingJobDefinition[]; /** * @public - *

    The maintainer description of the image version.

    + *

    The status of the tuning job: InProgress, Completed, Failed, Stopping, or + * Stopped.

    */ - ReleaseNotes?: string; -} + HyperParameterTuningJobStatus: HyperParameterTuningJobStatus | undefined; -/** - * @public - */ -export interface DescribeInferenceExperimentRequest { /** * @public - *

    The name of the inference experiment to describe.

    + *

    The date and time that the tuning job started.

    */ - Name: string | undefined; -} + CreationTime: Date | undefined; -/** - * @public - *

    The metadata of the endpoint.

    - */ -export interface EndpointMetadata { /** * @public - *

    The name of the endpoint.

    + *

    The date and time that the tuning job ended.

    */ - EndpointName: string | undefined; + HyperParameterTuningEndTime?: Date; /** * @public - *

    The name of the endpoint configuration.

    + *

    The date and time that the status of the tuning job was modified.

    */ - EndpointConfigName?: string; + LastModifiedTime?: Date; /** * @public - *

    - * The status of the endpoint. For possible values of the status of an endpoint, see EndpointSummary. - *

    + *

    The TrainingJobStatusCounters object that specifies the number of training + * jobs, categorized by status, that this tuning job launched.

    */ - EndpointStatus?: EndpointStatus; + TrainingJobStatusCounters: TrainingJobStatusCounters | undefined; /** * @public - *

    - * If the status of the endpoint is Failed, or the status is InService but update - * operation fails, this provides the reason why it failed. - *

    + *

    The ObjectiveStatusCounters object that specifies the number of training jobs, + * categorized by the status of their final objective metric, that this tuning job + * launched.

    + */ + ObjectiveStatusCounters: ObjectiveStatusCounters | undefined; + + /** + * @public + *

    A TrainingJobSummary object that describes the training job that completed + * with the best current HyperParameterTuningJobObjective.

    + */ + BestTrainingJob?: HyperParameterTrainingJobSummary; + + /** + * @public + *

    If the hyperparameter tuning job is an warm start tuning job with a + * WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the + * TrainingJobSummary for the training job with the best objective metric + * value of all training jobs launched by this tuning job and all parent jobs specified for + * the warm start tuning job.

    + */ + OverallBestTrainingJob?: HyperParameterTrainingJobSummary; + + /** + * @public + *

    The configuration for starting the hyperparameter parameter tuning job using one or + * more previous tuning jobs as a starting point. The results of previous tuning jobs are + * used to inform which combinations of hyperparameters to search over in the new tuning + * job.

    + */ + WarmStartConfig?: HyperParameterTuningJobWarmStartConfig; + + /** + * @public + *

    If the tuning job failed, the reason it failed.

    */ FailureReason?: string; + + /** + * @public + *

    Tuning job completion information returned as the response from a hyperparameter + * tuning job. This information tells if your tuning job has or has not converged. It also + * includes the number of training jobs that have not improved model performance as + * evaluated against the objective function.

    + */ + TuningJobCompletionDetails?: HyperParameterTuningJobCompletionDetails; + + /** + * @public + *

    The total resources consumed by your hyperparameter tuning job.

    + */ + ConsumedResources?: HyperParameterTuningJobConsumedResources; + + /** + * @public + *

    A flag to indicate if autotune is enabled for the hyperparameter tuning job.

    + */ + Autotune?: Autotune; +} + +/** + * @public + */ +export interface DescribeImageRequest { + /** + * @public + *

    The name of the image to describe.

    + */ + ImageName: string | undefined; } /** * @public * @enum */ -export const ModelVariantStatus = { - CREATING: "Creating", - DELETED: "Deleted", - DELETING: "Deleting", - IN_SERVICE: "InService", - UPDATING: "Updating", +export const ImageStatus = { + CREATED: "CREATED", + CREATE_FAILED: "CREATE_FAILED", + CREATING: "CREATING", + DELETE_FAILED: "DELETE_FAILED", + DELETING: "DELETING", + UPDATE_FAILED: "UPDATE_FAILED", + UPDATING: "UPDATING", } as const; /** * @public */ -export type ModelVariantStatus = (typeof ModelVariantStatus)[keyof typeof ModelVariantStatus]; +export type ImageStatus = (typeof ImageStatus)[keyof typeof ImageStatus]; /** * @public - *

    Summary of the deployment configuration of a model.

    */ -export interface ModelVariantConfigSummary { +export interface DescribeImageResponse { /** * @public - *

    The name of the Amazon SageMaker Model entity.

    + *

    When the image was created.

    */ - ModelName: string | undefined; + CreationTime?: Date; /** * @public - *

    The name of the variant.

    + *

    The description of the image.

    */ - VariantName: string | undefined; + Description?: string; /** * @public - *

    The configuration of the infrastructure that the model has been deployed to.

    + *

    The name of the image as displayed.

    */ - InfrastructureConfig: ModelInfrastructureConfig | undefined; + DisplayName?: string; /** * @public - *

    The status of deployment for the model variant on the hosted inference endpoint.

    - *
      - *
    • - *

      - * Creating - Amazon SageMaker is preparing the model variant on the hosted inference endpoint. - *

      - *
      • - *
    • - *

      - * InService - The model variant is running on the hosted inference endpoint. - *

      - *
      • - *
    • - *

      - * Updating - Amazon SageMaker is updating the model variant on the hosted inference endpoint. - *

      - *
      • - *
    • - *

      - * Deleting - Amazon SageMaker is deleting the model variant on the hosted inference endpoint. - *

      - *
      • - *
    • - *

      - * Deleted - The model variant has been deleted on the hosted inference endpoint. This - * can only happen after stopping the experiment. - *

      - *
      • - *
    + *

    When a create, update, or delete operation fails, the reason for the failure.

    */ - Status: ModelVariantStatus | undefined; + FailureReason?: string; + + /** + * @public + *

    The ARN of the image.

    + */ + ImageArn?: string; + + /** + * @public + *

    The name of the image.

    + */ + ImageName?: string; + + /** + * @public + *

    The status of the image.

    + */ + ImageStatus?: ImageStatus; + + /** + * @public + *

    When the image was last modified.

    + */ + LastModifiedTime?: Date; + + /** + * @public + *

    The ARN of the IAM role that enables Amazon SageMaker to perform tasks on your behalf.

    + */ + RoleArn?: string; +} + +/** + * @public + */ +export interface DescribeImageVersionRequest { + /** + * @public + *

    The name of the image.

    + */ + ImageName: string | undefined; + + /** + * @public + *

    The version of the image. If not specified, the latest version is described.

    + */ + Version?: number; + + /** + * @public + *

    The alias of the image version.

    + */ + Alias?: string; } /** * @public * @enum */ -export const InferenceExperimentStatus = { - CANCELLED: "Cancelled", - COMPLETED: "Completed", - CREATED: "Created", - CREATING: "Creating", - RUNNING: "Running", - STARTING: "Starting", - STOPPING: "Stopping", - UPDATING: "Updating", +export const ImageVersionStatus = { + CREATED: "CREATED", + CREATE_FAILED: "CREATE_FAILED", + CREATING: "CREATING", + DELETE_FAILED: "DELETE_FAILED", + DELETING: "DELETING", } as const; /** * @public */ -export type InferenceExperimentStatus = (typeof InferenceExperimentStatus)[keyof typeof InferenceExperimentStatus]; +export type ImageVersionStatus = (typeof ImageVersionStatus)[keyof typeof ImageVersionStatus]; /** * @public */ -export interface DescribeInferenceExperimentResponse { +export interface DescribeImageVersionResponse { /** * @public - *

    The ARN of the inference experiment being described.

    + *

    The registry path of the container image on which this image version is based.

    */ - Arn: string | undefined; + BaseImage?: string; /** * @public - *

    The name of the inference experiment.

    + *

    The registry path of the container image that contains this image version.

    */ - Name: string | undefined; + ContainerImage?: string; /** * @public - *

    The type of the inference experiment.

    + *

    When the version was created.

    */ - Type: InferenceExperimentType | undefined; + CreationTime?: Date; /** * @public - *

    The duration for which the inference experiment ran or will run.

    + *

    When a create or delete operation fails, the reason for the failure.

    */ - Schedule?: InferenceExperimentSchedule; + FailureReason?: string; /** * @public - *

    - * The status of the inference experiment. The following are the possible statuses for an inference - * experiment: - *

    + *

    The ARN of the image the version is based on.

    + */ + ImageArn?: string; + + /** + * @public + *

    The ARN of the version.

    + */ + ImageVersionArn?: string; + + /** + * @public + *

    The status of the version.

    + */ + ImageVersionStatus?: ImageVersionStatus; + + /** + * @public + *

    When the version was last modified.

    + */ + LastModifiedTime?: Date; + + /** + * @public + *

    The version number.

    + */ + Version?: number; + + /** + * @public + *

    The stability of the image version specified by the maintainer.

    *
      *
    • *

      - * Creating - Amazon SageMaker is creating your experiment. - *

      - *
      • - *
    • - *

      - * Created - Amazon SageMaker has finished the creation of your experiment and will begin the - * experiment at the scheduled time. - *

      + * NOT_PROVIDED: The maintainers did not provide a status for image version stability.

      *
      • *
    • *

      - * Updating - When you make changes to your experiment, your experiment shows as updating. - *

      + * STABLE: The image version is stable.

      *
      • *
    • *

      - * Starting - Amazon SageMaker is beginning your experiment. - *

      + * TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

      *
      • *
    • *

      - * Running - Your experiment is in progress. - *

      + * ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

      *
      • + *
    + */ + VendorGuidance?: VendorGuidance; + + /** + * @public + *

    Indicates SageMaker job type compatibility.

    + *
      *
    • *

      - * Stopping - Amazon SageMaker is stopping your experiment. - *

      + * TRAINING: The image version is compatible with SageMaker training jobs.

      *
      • *
    • *

      - * Completed - Your experiment has completed. - *

      + * INFERENCE: The image version is compatible with SageMaker inference jobs.

      *
      • *
    • *

      - * Cancelled - When you conclude your experiment early using the StopInferenceExperiment API, or if any operation fails with an unexpected error, it shows - * as cancelled. - *

      + * NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.

      *
      • *
    */ - Status: InferenceExperimentStatus | undefined; + JobType?: JobType; /** * @public - *

    - * The error message or client-specified Reason from the StopInferenceExperiment - * API, that explains the status of the inference experiment. - *

    + *

    The machine learning framework vended in the image version.

    */ - StatusReason?: string; + MLFramework?: string; /** * @public - *

    The description of the inference experiment.

    + *

    The supported programming language and its version.

    */ - Description?: string; + ProgrammingLang?: string; /** * @public - *

    The timestamp at which you created the inference experiment.

    + *

    Indicates CPU or GPU compatibility.

    + *
      + *
    • + *

      + * CPU: The image version is compatible with CPU.

      + *
      • + *
    • + *

      + * GPU: The image version is compatible with GPU.

      + *
      • + *
    */ - CreationTime?: Date; + Processor?: Processor; /** * @public - *

    - * The timestamp at which the inference experiment was completed. - *

    + *

    Indicates Horovod compatibility.

    */ - CompletionTime?: Date; + Horovod?: boolean; /** * @public - *

    The timestamp at which you last modified the inference experiment.

    + *

    The maintainer description of the image version.

    */ - LastModifiedTime?: Date; + ReleaseNotes?: string; +} +/** + * @public + */ +export interface DescribeInferenceComponentInput { /** * @public - *

    - * The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage - * Amazon SageMaker Inference endpoints for model deployment. - *

    + *

    The name of the inference component.

    */ - RoleArn?: string; + InferenceComponentName: string | undefined; +} + +/** + * @public + * @enum + */ +export const InferenceComponentStatus = { + CREATING: "Creating", + DELETING: "Deleting", + FAILED: "Failed", + IN_SERVICE: "InService", + UPDATING: "Updating", +} as const; + +/** + * @public + */ +export type InferenceComponentStatus = (typeof InferenceComponentStatus)[keyof typeof InferenceComponentStatus]; +/** + * @public + *

    Details about the runtime settings for the model that is deployed with the inference + * component.

    + */ +export interface InferenceComponentRuntimeConfigSummary { /** * @public - *

    The metadata of the endpoint on which the inference experiment ran.

    + *

    The number of runtime copies of the model container that you requested to deploy with + * the inference component.

    */ - EndpointMetadata: EndpointMetadata | undefined; + DesiredCopyCount?: number; /** * @public - *

    - * An array of ModelVariantConfigSummary objects. There is one for each variant in the inference - * experiment. Each ModelVariantConfigSummary object in the array describes the infrastructure - * configuration for deploying the corresponding variant. - *

    + *

    The number of runtime copies of the model container that are currently deployed.

    */ - ModelVariants: ModelVariantConfigSummary[] | undefined; - - /** - * @public - *

    The Amazon S3 location and configuration for storing inference request and response data.

    - */ - DataStorageConfig?: InferenceExperimentDataStorageConfig; + CurrentCopyCount?: number; +} +/** + * @public + *

    Details about the resources that are deployed with this inference component.

    + */ +export interface InferenceComponentContainerSpecificationSummary { /** * @public - *

    - * The configuration of ShadowMode inference experiment type, which shows the production variant - * that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the - * inference requests. For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates. - *

    + *

    Gets the Amazon EC2 Container Registry path of the docker image of the model that is hosted in this ProductionVariant.

    + *

    If you used the registry/repository[:tag] form to specify the image path + * of the primary container when you created the model hosted in this + * ProductionVariant, the path resolves to a path of the form + * registry/repository[@digest]. A digest is a hash value that identifies + * a specific version of an image. For information about Amazon ECR paths, see Pulling an Image in the Amazon ECR User Guide.

    */ - ShadowModeConfig?: ShadowModeConfig; + DeployedImage?: DeployedImage; /** * @public - *

    - * The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on - * the storage volume attached to the ML compute instance that hosts the endpoint. For more information, see - * CreateInferenceExperiment. - *

    + *

    The Amazon S3 path where the model artifacts are stored.

    */ - KmsKey?: string; -} + ArtifactUrl?: string; -/** - * @public - */ -export interface DescribeInferenceRecommendationsJobRequest { /** * @public - *

    The name of the job. The name must be unique within an - * Amazon Web Services Region in the Amazon Web Services account.

    + *

    The environment variables to set in the Docker container.

    */ - JobName: string | undefined; + Environment?: Record; } /** * @public - *

    The metrics for an existing endpoint compared in an Inference Recommender job.

    + *

    Details about the resources that are deployed with this inference component.

    */ -export interface InferenceMetrics { +export interface InferenceComponentSpecificationSummary { /** * @public - *

    The expected maximum number of requests per minute for the instance.

    + *

    The name of the SageMaker model object that is deployed with the inference + * component.

    */ - MaxInvocations: number | undefined; + ModelName?: string; /** * @public - *

    The expected model latency at maximum invocations per minute for the instance.

    + *

    Details about the container that provides the runtime environment for the model that is + * deployed with the inference component.

    */ - ModelLatency: number | undefined; -} + Container?: InferenceComponentContainerSpecificationSummary; -/** - * @public - *

    The performance results from running an Inference Recommender job on an existing endpoint.

    - */ -export interface EndpointPerformance { /** * @public - *

    The metrics for an existing endpoint.

    + *

    Settings that take effect while the model container starts up.

    */ - Metrics: InferenceMetrics | undefined; + StartupParameters?: InferenceComponentStartupParameters; /** * @public - *

    Details about a customer endpoint that was compared in an Inference Recommender job.

    + *

    The compute resources allocated to run the model assigned + * to the inference component.

    */ - EndpointInfo: EndpointInfo | undefined; + ComputeResourceRequirements?: InferenceComponentComputeResourceRequirements; } /** * @public - *

    The endpoint configuration made by Inference Recommender during a recommendation job.

    */ -export interface EndpointOutputConfiguration { - /** - * @public - *

    The name of the endpoint made during a recommendation job.

    - */ - EndpointName: string | undefined; - +export interface DescribeInferenceComponentOutput { /** * @public - *

    The name of the production variant (deployed model) made during a recommendation job.

    + *

    The name of the inference component.

    */ - VariantName: string | undefined; + InferenceComponentName: string | undefined; /** * @public - *

    The instance type recommended by Amazon SageMaker Inference Recommender.

    + *

    The Amazon Resource Name (ARN) of the inference component.

    */ - InstanceType?: ProductionVariantInstanceType; + InferenceComponentArn: string | undefined; /** * @public - *

    The number of instances recommended to launch initially.

    + *

    The name of the endpoint that hosts the inference component.

    */ - InitialInstanceCount?: number; + EndpointName: string | undefined; /** * @public - *

    Specifies the serverless configuration for an endpoint variant.

    + *

    The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.

    */ - ServerlessConfig?: ProductionVariantServerlessConfig; -} + EndpointArn: string | undefined; -/** - * @public - *

    The metrics of recommendations.

    - */ -export interface RecommendationMetrics { /** * @public - *

    Defines the cost per hour for the instance.

    + *

    The name of the production variant that hosts the inference component.

    */ - CostPerHour: number | undefined; + VariantName?: string; /** * @public - *

    Defines the cost per inference for the instance .

    + *

    If the inference component status is Failed, the reason for the + * failure.

    */ - CostPerInference: number | undefined; + FailureReason?: string; /** * @public - *

    The expected maximum number of requests per minute for the instance.

    + *

    Details about the resources that are deployed with this inference component.

    */ - MaxInvocations: number | undefined; + Specification?: InferenceComponentSpecificationSummary; /** * @public - *

    The expected model latency at maximum invocation per minute for the instance.

    + *

    Details about the runtime settings for the model that is deployed with the inference + * component.

    */ - ModelLatency: number | undefined; + RuntimeConfig?: InferenceComponentRuntimeConfigSummary; /** * @public - *

    The expected CPU utilization at maximum invocations per minute for the instance.

    - *

    - * NaN indicates that the value is not available.

    + *

    The time when the inference component was created.

    */ - CpuUtilization?: number; + CreationTime: Date | undefined; /** * @public - *

    The expected memory utilization at maximum invocations per minute for the instance.

    - *

    - * NaN indicates that the value is not available.

    + *

    The time when the inference component was last updated.

    */ - MemoryUtilization?: number; + LastModifiedTime: Date | undefined; /** * @public - *

    The time it takes to launch new compute resources for a serverless endpoint. - * The time can vary depending on the model size, how long it takes to download the - * model, and the start-up time of the container.

    - *

    - * NaN indicates that the value is not available.

    + *

    The status of the inference component.

    */ - ModelSetupTime?: number; + InferenceComponentStatus?: InferenceComponentStatus; } /** * @public - *

    A list of environment parameters suggested by the Amazon SageMaker Inference Recommender.

    */ -export interface EnvironmentParameter { - /** - * @public - *

    The environment key suggested by the Amazon SageMaker Inference Recommender.

    - */ - Key: string | undefined; - - /** - * @public - *

    The value type suggested by the Amazon SageMaker Inference Recommender.

    - */ - ValueType: string | undefined; - +export interface DescribeInferenceExperimentRequest { /** * @public - *

    The value suggested by the Amazon SageMaker Inference Recommender.

    + *

    The name of the inference experiment to describe.

    */ - Value: string | undefined; + Name: string | undefined; } /** * @public - *

    Defines the model configuration. Includes the specification name and environment parameters.

    + *

    The metadata of the endpoint.

    */ -export interface ModelConfiguration { +export interface EndpointMetadata { /** * @public - *

    The inference specification name in the model package version.

    + *

    The name of the endpoint.

    */ - InferenceSpecificationName?: string; + EndpointName: string | undefined; /** * @public - *

    Defines the environment parameters that includes key, value types, and values.

    + *

    The name of the endpoint configuration.

    */ - EnvironmentParameters?: EnvironmentParameter[]; + EndpointConfigName?: string; /** * @public - *

    The name of the compilation job used to create the recommended model artifacts.

    + *

    + * The status of the endpoint. For possible values of the status of an endpoint, see EndpointSummary. + *

    */ - CompilationJobName?: string; + EndpointStatus?: EndpointStatus; + + /** + * @public + *

    + * If the status of the endpoint is Failed, or the status is InService but update + * operation fails, this provides the reason why it failed. + *

    + */ + FailureReason?: string; } /** * @public - *

    A list of recommendations made by Amazon SageMaker Inference Recommender.

    + * @enum */ -export interface InferenceRecommendation { - /** - * @public - *

    The metrics used to decide what recommendation to make.

    - */ - Metrics: RecommendationMetrics | undefined; +export const ModelVariantStatus = { + CREATING: "Creating", + DELETED: "Deleted", + DELETING: "Deleting", + IN_SERVICE: "InService", + UPDATING: "Updating", +} as const; - /** - * @public - *

    Defines the endpoint configuration parameters.

    - */ - EndpointConfiguration: EndpointOutputConfiguration | undefined; +/** + * @public + */ +export type ModelVariantStatus = (typeof ModelVariantStatus)[keyof typeof ModelVariantStatus]; +/** + * @public + *

    Summary of the deployment configuration of a model.

    + */ +export interface ModelVariantConfigSummary { /** * @public - *

    Defines the model configuration.

    + *

    The name of the Amazon SageMaker Model entity.

    */ - ModelConfiguration: ModelConfiguration | undefined; + ModelName: string | undefined; /** * @public - *

    The recommendation ID which uniquely identifies each recommendation.

    + *

    The name of the variant.

    */ - RecommendationId?: string; + VariantName: string | undefined; /** * @public - *

    A timestamp that shows when the benchmark completed.

    + *

    The configuration of the infrastructure that the model has been deployed to.

    */ - InvocationEndTime?: Date; + InfrastructureConfig: ModelInfrastructureConfig | undefined; /** * @public - *

    A timestamp that shows when the benchmark started.

    + *

    The status of deployment for the model variant on the hosted inference endpoint.

    + *
      + *
    • + *

      + * Creating - Amazon SageMaker is preparing the model variant on the hosted inference endpoint. + *

      + *
      • + *
    • + *

      + * InService - The model variant is running on the hosted inference endpoint. + *

      + *
      • + *
    • + *

      + * Updating - Amazon SageMaker is updating the model variant on the hosted inference endpoint. + *

      + *
      • + *
    • + *

      + * Deleting - Amazon SageMaker is deleting the model variant on the hosted inference endpoint. + *

      + *
      • + *
    • + *

      + * Deleted - The model variant has been deleted on the hosted inference endpoint. This + * can only happen after stopping the experiment. + *

      + *
      • + *
    */ - InvocationStartTime?: Date; + Status: ModelVariantStatus | undefined; } /** * @public * @enum */ -export const RecommendationJobStatus = { - COMPLETED: "COMPLETED", - FAILED: "FAILED", - IN_PROGRESS: "IN_PROGRESS", - PENDING: "PENDING", - STOPPED: "STOPPED", - STOPPING: "STOPPING", +export const InferenceExperimentStatus = { + CANCELLED: "Cancelled", + COMPLETED: "Completed", + CREATED: "Created", + CREATING: "Creating", + RUNNING: "Running", + STARTING: "Starting", + STOPPING: "Stopping", + UPDATING: "Updating", } as const; /** * @public */ -export type RecommendationJobStatus = (typeof RecommendationJobStatus)[keyof typeof RecommendationJobStatus]; +export type InferenceExperimentStatus = (typeof InferenceExperimentStatus)[keyof typeof InferenceExperimentStatus]; /** * @public */ -export interface DescribeInferenceRecommendationsJobResponse { +export interface DescribeInferenceExperimentResponse { /** * @public - *

    The name of the job. The name must be unique within an - * Amazon Web Services Region in the Amazon Web Services account.

    + *

    The ARN of the inference experiment being described.

    */ - JobName: string | undefined; + Arn: string | undefined; /** * @public - *

    The job description that you provided when you initiated the job.

    + *

    The name of the inference experiment.

    */ - JobDescription?: string; + Name: string | undefined; /** * @public - *

    The job type that you provided when you initiated the job.

    + *

    The type of the inference experiment.

    */ - JobType: RecommendationJobType | undefined; + Type: InferenceExperimentType | undefined; /** * @public - *

    The Amazon Resource Name (ARN) of the job.

    + *

    The duration for which the inference experiment ran or will run.

    */ - JobArn: string | undefined; + Schedule?: InferenceExperimentSchedule; /** * @public - *

    The Amazon Resource Name (ARN) of the Amazon Web Services - * Identity and Access Management (IAM) role you provided when you initiated the job.

    + *

    + * The status of the inference experiment. The following are the possible statuses for an inference + * experiment: + *

    + *
      + *
    • + *

      + * Creating - Amazon SageMaker is creating your experiment. + *

      + *
      • + *
    • + *

      + * Created - Amazon SageMaker has finished the creation of your experiment and will begin the + * experiment at the scheduled time. + *

      + *
      • + *
    • + *

      + * Updating - When you make changes to your experiment, your experiment shows as updating. + *

      + *
      • + *
    • + *

      + * Starting - Amazon SageMaker is beginning your experiment. + *

      + *
      • + *
    • + *

      + * Running - Your experiment is in progress. + *

      + *
      • + *
    • + *

      + * Stopping - Amazon SageMaker is stopping your experiment. + *

      + *
      • + *
    • + *

      + * Completed - Your experiment has completed. + *

      + *
      • + *
    • + *

      + * Cancelled - When you conclude your experiment early using the StopInferenceExperiment API, or if any operation fails with an unexpected error, it shows + * as cancelled. + *

      + *
      • + *
    */ - RoleArn: string | undefined; + Status: InferenceExperimentStatus | undefined; /** * @public - *

    The status of the job.

    + *

    + * The error message or client-specified Reason from the StopInferenceExperiment + * API, that explains the status of the inference experiment. + *

    */ - Status: RecommendationJobStatus | undefined; + StatusReason?: string; /** * @public - *

    A timestamp that shows when the job was created.

    + *

    The description of the inference experiment.

    */ - CreationTime: Date | undefined; + Description?: string; /** * @public - *

    A timestamp that shows when the job completed.

    + *

    The timestamp at which you created the inference experiment.

    + */ + CreationTime?: Date; + + /** + * @public + *

    + * The timestamp at which the inference experiment was completed. + *

    */ CompletionTime?: Date; /** * @public - *

    A timestamp that shows when the job was last modified.

    + *

    The timestamp at which you last modified the inference experiment.

    */ - LastModifiedTime: Date | undefined; + LastModifiedTime?: Date; /** * @public - *

    If the job fails, provides information why the job failed.

    + *

    + * The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage + * Amazon SageMaker Inference endpoints for model deployment. + *

    */ - FailureReason?: string; + RoleArn?: string; /** * @public - *

    Returns information about the versioned model package Amazon Resource Name (ARN), - * the traffic pattern, and endpoint configurations you provided when you initiated the job.

    + *

    The metadata of the endpoint on which the inference experiment ran.

    */ - InputConfig: RecommendationJobInputConfig | undefined; + EndpointMetadata: EndpointMetadata | undefined; /** * @public - *

    The stopping conditions that you provided when you initiated the job.

    + *

    + * An array of ModelVariantConfigSummary objects. There is one for each variant in the inference + * experiment. Each ModelVariantConfigSummary object in the array describes the infrastructure + * configuration for deploying the corresponding variant. + *

    */ - StoppingConditions?: RecommendationJobStoppingConditions; + ModelVariants: ModelVariantConfigSummary[] | undefined; /** * @public - *

    The recommendations made by Inference Recommender.

    + *

    The Amazon S3 location and configuration for storing inference request and response data.

    */ - InferenceRecommendations?: InferenceRecommendation[]; + DataStorageConfig?: InferenceExperimentDataStorageConfig; /** * @public - *

    The performance results from running an Inference Recommender job on an existing endpoint.

    + *

    + * The configuration of ShadowMode inference experiment type, which shows the production variant + * that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the + * inference requests. For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates. + *

    */ - EndpointPerformances?: EndpointPerformance[]; -} + ShadowModeConfig?: ShadowModeConfig; -/** - * @public - */ -export interface DescribeLabelingJobRequest { /** * @public - *

    The name of the labeling job to return information for.

    + *

    + * The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on + * the storage volume attached to the ML compute instance that hosts the endpoint. For more information, see + * CreateInferenceExperiment. + *

    */ - LabelingJobName: string | undefined; + KmsKey?: string; } /** * @public - *

    Provides a breakdown of the number of objects labeled.

    */ -export interface LabelCounters { - /** - * @public - *

    The total number of objects labeled.

    - */ - TotalLabeled?: number; - - /** - * @public - *

    The total number of objects labeled by a human worker.

    - */ - HumanLabeled?: number; - +export interface DescribeInferenceRecommendationsJobRequest { /** * @public - *

    The total number of objects labeled by automated data labeling.

    + *

    The name of the job. The name must be unique within an + * Amazon Web Services Region in the Amazon Web Services account.

    */ - MachineLabeled?: number; + JobName: string | undefined; +} +/** + * @public + *

    The metrics for an existing endpoint compared in an Inference Recommender job.

    + */ +export interface InferenceMetrics { /** * @public - *

    The total number of objects that could not be labeled due to an error.

    + *

    The expected maximum number of requests per minute for the instance.

    */ - FailedNonRetryableError?: number; + MaxInvocations: number | undefined; /** * @public - *

    The total number of objects not yet labeled.

    + *

    The expected model latency at maximum invocations per minute for the instance.

    */ - Unlabeled?: number; + ModelLatency: number | undefined; } /** * @public - *

    Specifies the location of the output produced by the labeling job.

    + *

    The performance results from running an Inference Recommender job on an existing endpoint.

    */ -export interface LabelingJobOutput { +export interface EndpointPerformance { /** * @public - *

    The Amazon S3 bucket location of the manifest file for labeled data.

    + *

    The metrics for an existing endpoint.

    */ - OutputDatasetS3Uri: string | undefined; + Metrics: InferenceMetrics | undefined; /** * @public - *

    The Amazon Resource Name (ARN) for the most recent SageMaker model trained as part of - * automated data labeling.

    + *

    Details about a customer endpoint that was compared in an Inference Recommender job.

    */ - FinalActiveLearningModelArn?: string; + EndpointInfo: EndpointInfo | undefined; } /** * @public - * @enum - */ -export const LabelingJobStatus = { - COMPLETED: "Completed", - FAILED: "Failed", - INITIALIZING: "Initializing", - IN_PROGRESS: "InProgress", - STOPPED: "Stopped", - STOPPING: "Stopping", -} as const; - -/** - * @public - */ -export type LabelingJobStatus = (typeof LabelingJobStatus)[keyof typeof LabelingJobStatus]; - -/** - * @public + *

    The endpoint configuration made by Inference Recommender during a recommendation job.

    */ -export interface DescribeLabelingJobResponse { +export interface EndpointOutputConfiguration { /** * @public - *

    The processing status of the labeling job.

    + *

    The name of the endpoint made during a recommendation job.

    */ - LabelingJobStatus: LabelingJobStatus | undefined; + EndpointName: string | undefined; /** * @public - *

    Provides a breakdown of the number of data objects labeled by humans, the number of - * objects labeled by machine, the number of objects than couldn't be labeled, and the - * total number of objects labeled.

    + *

    The name of the production variant (deployed model) made during a recommendation job.

    */ - LabelCounters: LabelCounters | undefined; + VariantName: string | undefined; /** * @public - *

    If the job failed, the reason that it failed.

    + *

    The instance type recommended by Amazon SageMaker Inference Recommender.

    */ - FailureReason?: string; + InstanceType?: ProductionVariantInstanceType; /** * @public - *

    The date and time that the labeling job was created.

    + *

    The number of instances recommended to launch initially.

    */ - CreationTime: Date | undefined; + InitialInstanceCount?: number; /** * @public - *

    The date and time that the labeling job was last updated.

    + *

    Specifies the serverless configuration for an endpoint variant.

    */ - LastModifiedTime: Date | undefined; + ServerlessConfig?: ProductionVariantServerlessConfig; +} +/** + * @public + *

    The metrics of recommendations.

    + */ +export interface RecommendationMetrics { /** * @public - *

    A unique identifier for work done as part of a labeling job.

    + *

    Defines the cost per hour for the instance.

    */ - JobReferenceCode: string | undefined; + CostPerHour: number | undefined; /** * @public - *

    The name assigned to the labeling job when it was created.

    + *

    Defines the cost per inference for the instance .

    */ - LabelingJobName: string | undefined; + CostPerInference: number | undefined; /** * @public - *

    The Amazon Resource Name (ARN) of the labeling job.

    + *

    The expected maximum number of requests per minute for the instance.

    */ - LabelingJobArn: string | undefined; + MaxInvocations: number | undefined; /** * @public - *

    The attribute used as the label in the output manifest file.

    + *

    The expected model latency at maximum invocation per minute for the instance.

    */ - LabelAttributeName?: string; + ModelLatency: number | undefined; /** * @public - *

    Input configuration information for the labeling job, such as the Amazon S3 location of the - * data objects and the location of the manifest file that describes the data - * objects.

    + *

    The expected CPU utilization at maximum invocations per minute for the instance.

    + *

    + * NaN indicates that the value is not available.

    */ - InputConfig: LabelingJobInputConfig | undefined; + CpuUtilization?: number; /** * @public - *

    The location of the job's output data and the Amazon Web Services Key Management - * Service key ID for the key used to encrypt the output data, if any.

    + *

    The expected memory utilization at maximum invocations per minute for the instance.

    + *

    + * NaN indicates that the value is not available.

    */ - OutputConfig: LabelingJobOutputConfig | undefined; + MemoryUtilization?: number; /** * @public - *

    The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf - * during data labeling.

    + *

    The time it takes to launch new compute resources for a serverless endpoint. + * The time can vary depending on the model size, how long it takes to download the + * model, and the start-up time of the container.

    + *

    + * NaN indicates that the value is not available.

    */ - RoleArn: string | undefined; - + ModelSetupTime?: number; +} + +/** + * @public + *

    A list of environment parameters suggested by the Amazon SageMaker Inference Recommender.

    + */ +export interface EnvironmentParameter { /** * @public - *

    The S3 location of the JSON file that defines the categories used to label data - * objects. Please note the following label-category limits:

    - *
      - *
    • - *

      Semantic segmentation labeling jobs using automated labeling: 20 labels

      - *
      • - *
    • - *

      Box bounding labeling jobs (all): 10 labels

      - *
      • - *
    - *

    The file is a JSON structure in the following format:

    - *

    - * \{ - *

    - *

    - * "document-version": "2018-11-28" - *

    - *

    - * "labels": [ - *

    - *

    - * \{ - *

    - *

    - * "label": "label 1" - *

    - *

    - * \}, - *

    - *

    - * \{ - *

    - *

    - * "label": "label 2" - *

    - *

    - * \}, - *

    - *

    - * ... - *

    - *

    - * \{ - *

    - *

    - * "label": "label n" - *

    - *

    - * \} - *

    - *

    - * ] - *

    - *

    - * \} - *

    + *

    The environment key suggested by the Amazon SageMaker Inference Recommender.

    */ - LabelCategoryConfigS3Uri?: string; + Key: string | undefined; /** * @public - *

    A set of conditions for stopping a labeling job. If any of the conditions are met, the - * job is automatically stopped.

    + *

    The value type suggested by the Amazon SageMaker Inference Recommender.

    */ - StoppingConditions?: LabelingJobStoppingConditions; + ValueType: string | undefined; /** * @public - *

    Configuration information for automated data labeling.

    + *

    The value suggested by the Amazon SageMaker Inference Recommender.

    */ - LabelingJobAlgorithmsConfig?: LabelingJobAlgorithmsConfig; + Value: string | undefined; +} +/** + * @public + *

    Defines the model configuration. Includes the specification name and environment parameters.

    + */ +export interface ModelConfiguration { /** * @public - *

    Configuration information required for human workers to complete a labeling - * task.

    + *

    The inference specification name in the model package version.

    */ - HumanTaskConfig: HumanTaskConfig | undefined; + InferenceSpecificationName?: string; /** * @public - *

    An array of key-value pairs. You can use tags to categorize your Amazon Web Services - * resources in different ways, for example, by purpose, owner, or environment. For more - * information, see Tagging Amazon Web Services Resources.

    + *

    Defines the environment parameters that includes key, value types, and values.

    */ - Tags?: Tag[]; + EnvironmentParameters?: EnvironmentParameter[]; /** * @public - *

    The location of the output produced by the labeling job.

    + *

    The name of the compilation job used to create the recommended model artifacts.

    */ - LabelingJobOutput?: LabelingJobOutput; + CompilationJobName?: string; } /** * @public + *

    A list of recommendations made by Amazon SageMaker Inference Recommender.

    */ -export interface DescribeLineageGroupRequest { +export interface InferenceRecommendation { /** * @public - *

    The name of the lineage group.

    + *

    The metrics used to decide what recommendation to make.

    */ - LineageGroupName: string | undefined; -} + Metrics: RecommendationMetrics | undefined; -/** - * @public - */ -export interface DescribeLineageGroupResponse { /** * @public - *

    The name of the lineage group.

    + *

    Defines the endpoint configuration parameters.

    */ - LineageGroupName?: string; + EndpointConfiguration: EndpointOutputConfiguration | undefined; /** * @public - *

    The Amazon Resource Name (ARN) of the lineage group.

    + *

    Defines the model configuration.

    */ - LineageGroupArn?: string; + ModelConfiguration: ModelConfiguration | undefined; /** * @public - *

    The display name of the lineage group.

    + *

    The recommendation ID which uniquely identifies each recommendation.

    */ - DisplayName?: string; + RecommendationId?: string; /** * @public - *

    The description of the lineage group.

    + *

    A timestamp that shows when the benchmark completed.

    */ - Description?: string; + InvocationEndTime?: Date; /** * @public - *

    The creation time of lineage group.

    + *

    A timestamp that shows when the benchmark started.

    */ - CreationTime?: Date; + InvocationStartTime?: Date; +} + +/** + * @public + * @enum + */ +export const RecommendationJobStatus = { + COMPLETED: "COMPLETED", + FAILED: "FAILED", + IN_PROGRESS: "IN_PROGRESS", + PENDING: "PENDING", + STOPPED: "STOPPED", + STOPPING: "STOPPING", +} as const; + +/** + * @public + */ +export type RecommendationJobStatus = (typeof RecommendationJobStatus)[keyof typeof RecommendationJobStatus]; +/** + * @public + */ +export interface DescribeInferenceRecommendationsJobResponse { /** * @public - *

    Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.

    + *

    The name of the job. The name must be unique within an + * Amazon Web Services Region in the Amazon Web Services account.

    */ - CreatedBy?: UserContext; + JobName: string | undefined; /** * @public - *

    The last modified time of the lineage group.

    + *

    The job description that you provided when you initiated the job.

    */ - LastModifiedTime?: Date; + JobDescription?: string; /** * @public - *

    Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.

    + *

    The job type that you provided when you initiated the job.

    */ - LastModifiedBy?: UserContext; -} + JobType: RecommendationJobType | undefined; -/** - * @public - */ -export interface DescribeModelInput { /** * @public - *

    The name of the model.

    + *

    The Amazon Resource Name (ARN) of the job.

    */ - ModelName: string | undefined; -} + JobArn: string | undefined; -/** - * @public - */ -export interface DescribeModelOutput { /** * @public - *

    Name of the SageMaker model.

    + *

    The Amazon Resource Name (ARN) of the Amazon Web Services + * Identity and Access Management (IAM) role you provided when you initiated the job.

    */ - ModelName: string | undefined; + RoleArn: string | undefined; /** * @public - *

    The location of the primary inference code, associated artifacts, and custom - * environment map that the inference code uses when it is deployed in production. - *

    + *

    The status of the job.

    */ - PrimaryContainer?: ContainerDefinition; + Status: RecommendationJobStatus | undefined; /** * @public - *

    The containers in the inference pipeline.

    + *

    A timestamp that shows when the job was created.

    */ - Containers?: ContainerDefinition[]; + CreationTime: Date | undefined; /** * @public - *

    Specifies details of how containers in a multi-container endpoint are called.

    + *

    A timestamp that shows when the job completed.

    */ - InferenceExecutionConfig?: InferenceExecutionConfig; + CompletionTime?: Date; /** * @public - *

    The Amazon Resource Name (ARN) of the IAM role that you specified for the - * model.

    + *

    A timestamp that shows when the job was last modified.

    */ - ExecutionRoleArn: string | undefined; + LastModifiedTime: Date | undefined; /** * @public - *

    A VpcConfig object that specifies the VPC that this model has access to. For - * more information, see Protect Endpoints by Using an Amazon Virtual - * Private Cloud - *

    + *

    If the job fails, provides information why the job failed.

    */ - VpcConfig?: VpcConfig; + FailureReason?: string; /** * @public - *

    A timestamp that shows when the model was created.

    + *

    Returns information about the versioned model package Amazon Resource Name (ARN), + * the traffic pattern, and endpoint configurations you provided when you initiated the job.

    */ - CreationTime: Date | undefined; + InputConfig: RecommendationJobInputConfig | undefined; /** * @public - *

    The Amazon Resource Name (ARN) of the model.

    + *

    The stopping conditions that you provided when you initiated the job.

    */ - ModelArn: string | undefined; + StoppingConditions?: RecommendationJobStoppingConditions; /** * @public - *

    If True, no inbound or outbound network calls can be made to or from the - * model container.

    + *

    The recommendations made by Inference Recommender.

    */ - EnableNetworkIsolation?: boolean; + InferenceRecommendations?: InferenceRecommendation[]; /** * @public - *

    A set of recommended deployment configurations for the model.

    + *

    The performance results from running an Inference Recommender job on an existing endpoint.

    */ - DeploymentRecommendation?: DeploymentRecommendation; + EndpointPerformances?: EndpointPerformance[]; } /** * @public */ -export interface DescribeModelBiasJobDefinitionRequest { +export interface DescribeLabelingJobRequest { /** * @public - *

    The name of the model bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

    + *

    The name of the labeling job to return information for.

    */ - JobDefinitionName: string | undefined; + LabelingJobName: string | undefined; } /** * @public + *

    Provides a breakdown of the number of objects labeled.

    */ -export interface DescribeModelBiasJobDefinitionResponse { +export interface LabelCounters { /** * @public - *

    The Amazon Resource Name (ARN) of the model bias job.

    + *

    The total number of objects labeled.

    */ - JobDefinitionArn: string | undefined; + TotalLabeled?: number; /** * @public - *

    The name of the bias job definition. The name must be unique within an Amazon Web Services - * Region in the Amazon Web Services account.

    + *

    The total number of objects labeled by a human worker.

    */ - JobDefinitionName: string | undefined; + HumanLabeled?: number; /** * @public - *

    The time at which the model bias job was created.

    + *

    The total number of objects labeled by automated data labeling.

    */ - CreationTime: Date | undefined; + MachineLabeled?: number; /** * @public - *

    The baseline configuration for a model bias job.

    + *

    The total number of objects that could not be labeled due to an error.

    */ - ModelBiasBaselineConfig?: ModelBiasBaselineConfig; + FailedNonRetryableError?: number; /** * @public - *

    Configures the model bias job to run a specified Docker container image.

    + *

    The total number of objects not yet labeled.

    */ - ModelBiasAppSpecification: ModelBiasAppSpecification | undefined; + Unlabeled?: number; +} +/** + * @public + *

    Specifies the location of the output produced by the labeling job.

    + */ +export interface LabelingJobOutput { /** * @public - *

    Inputs for the model bias job.

    + *

    The Amazon S3 bucket location of the manifest file for labeled data.

    */ - ModelBiasJobInput: ModelBiasJobInput | undefined; + OutputDatasetS3Uri: string | undefined; /** * @public - *

    The output configuration for monitoring jobs.

    + *

    The Amazon Resource Name (ARN) for the most recent SageMaker model trained as part of + * automated data labeling.

    */ - ModelBiasJobOutputConfig: MonitoringOutputConfig | undefined; + FinalActiveLearningModelArn?: string; +} + +/** + * @public + * @enum + */ +export const LabelingJobStatus = { + COMPLETED: "Completed", + FAILED: "Failed", + INITIALIZING: "Initializing", + IN_PROGRESS: "InProgress", + STOPPED: "Stopped", + STOPPING: "Stopping", +} as const; +/** + * @public + */ +export type LabelingJobStatus = (typeof LabelingJobStatus)[keyof typeof LabelingJobStatus]; + +/** + * @public + */ +export interface DescribeLabelingJobResponse { /** * @public - *

    Identifies the resources to deploy for a monitoring job.

    + *

    The processing status of the labeling job.

    */ - JobResources: MonitoringResources | undefined; + LabelingJobStatus: LabelingJobStatus | undefined; /** * @public - *

    Networking options for a model bias job.

    + *

    Provides a breakdown of the number of data objects labeled by humans, the number of + * objects labeled by machine, the number of objects than couldn't be labeled, and the + * total number of objects labeled.

    */ - NetworkConfig?: MonitoringNetworkConfig; + LabelCounters: LabelCounters | undefined; /** * @public - *

    The Amazon Resource Name (ARN) of the IAM role that has read permission to the - * input data location and write permission to the output data location in Amazon S3.

    + *

    If the job failed, the reason that it failed.

    */ - RoleArn: string | undefined; + FailureReason?: string; /** * @public - *

    A time limit for how long the monitoring job is allowed to run before stopping.

    + *

    The date and time that the labeling job was created.

    */ - StoppingCondition?: MonitoringStoppingCondition; -} + CreationTime: Date | undefined; -/** - * @public - */ -export interface DescribeModelCardRequest { /** * @public - *

    The name or Amazon Resource Name (ARN) of the model card to describe.

    + *

    The date and time that the labeling job was last updated.

    */ - ModelCardName: string | undefined; + LastModifiedTime: Date | undefined; /** * @public - *

    The version of the model card to describe. If a version is not provided, then the latest version of the model card is described.

    + *

    A unique identifier for work done as part of a labeling job.

    */ - ModelCardVersion?: number; -} + JobReferenceCode: string | undefined; -/** - * @public - * @enum - */ -export const ModelCardProcessingStatus = { - CONTENT_DELETED: "ContentDeleted", - DELETE_COMPLETED: "DeleteCompleted", - DELETE_FAILED: "DeleteFailed", - DELETE_INPROGRESS: "DeleteInProgress", - DELETE_PENDING: "DeletePending", - EXPORTJOBS_DELETED: "ExportJobsDeleted", -} as const; + /** + * @public + *

    The name assigned to the labeling job when it was created.

    + */ + LabelingJobName: string | undefined; -/** - * @public - */ -export type ModelCardProcessingStatus = (typeof ModelCardProcessingStatus)[keyof typeof ModelCardProcessingStatus]; + /** + * @public + *

    The Amazon Resource Name (ARN) of the labeling job.

    + */ + LabelingJobArn: string | undefined; -/** - * @public - */ -export interface DescribeModelCardResponse { /** * @public - *

    The Amazon Resource Name (ARN) of the model card.

    + *

    The attribute used as the label in the output manifest file.

    */ - ModelCardArn: string | undefined; + LabelAttributeName?: string; /** * @public - *

    The name of the model card.

    + *

    Input configuration information for the labeling job, such as the Amazon S3 location of the + * data objects and the location of the manifest file that describes the data + * objects.

    */ - ModelCardName: string | undefined; + InputConfig: LabelingJobInputConfig | undefined; /** * @public - *

    The version of the model card.

    + *

    The location of the job's output data and the Amazon Web Services Key Management + * Service key ID for the key used to encrypt the output data, if any.

    */ - ModelCardVersion: number | undefined; + OutputConfig: LabelingJobOutputConfig | undefined; /** * @public - *

    The content of the model card.

    + *

    The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf + * during data labeling.

    */ - Content: string | undefined; + RoleArn: string | undefined; /** * @public - *

    The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

    + *

    The S3 location of the JSON file that defines the categories used to label data + * objects. Please note the following label-category limits:

    *
      *
    • - *

      - * Draft: The model card is a work in progress.

      - *
      • - *
    • - *

      - * PendingReview: The model card is pending review.

      - *
      • - *
    • - *

      - * Approved: The model card is approved.

      + *

      Semantic segmentation labeling jobs using automated labeling: 20 labels

      *
      • *
    • - *

      - * Archived: The model card is archived. No more updates should be made to the model - * card, but it can still be exported.

      + *

      Box bounding labeling jobs (all): 10 labels

      *
      • *
    + *

    The file is a JSON structure in the following format:

    + *

    + * \{ + *

    + *

    + * "document-version": "2018-11-28" + *

    + *

    + * "labels": [ + *

    + *

    + * \{ + *

    + *

    + * "label": "label 1" + *

    + *

    + * \}, + *

    + *

    + * \{ + *

    + *

    + * "label": "label 2" + *

    + *

    + * \}, + *

    + *

    + * ... + *

    + *

    + * \{ + *

    + *

    + * "label": "label n" + *

    + *

    + * \} + *

    + *

    + * ] + *

    + *

    + * \} + *

    */ - ModelCardStatus: ModelCardStatus | undefined; - - /** - * @public - *

    The security configuration used to protect model card content.

    - */ - SecurityConfig?: ModelCardSecurityConfig; + LabelCategoryConfigS3Uri?: string; /** * @public - *

    The date and time the model card was created.

    + *

    A set of conditions for stopping a labeling job. If any of the conditions are met, the + * job is automatically stopped.

    */ - CreationTime: Date | undefined; + StoppingConditions?: LabelingJobStoppingConditions; /** * @public - *

    Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.

    + *

    Configuration information for automated data labeling.

    */ - CreatedBy: UserContext | undefined; + LabelingJobAlgorithmsConfig?: LabelingJobAlgorithmsConfig; /** * @public - *

    The date and time the model card was last modified.

    + *

    Configuration information required for human workers to complete a labeling + * task.

    */ - LastModifiedTime?: Date; + HumanTaskConfig: HumanTaskConfig | undefined; /** * @public - *

    Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.

    + *

    An array of key-value pairs. You can use tags to categorize your Amazon Web Services + * resources in different ways, for example, by purpose, owner, or environment. For more + * information, see Tagging Amazon Web Services Resources.

    */ - LastModifiedBy?: UserContext; + Tags?: Tag[]; /** * @public - *

    The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.

    - *
      - *
    • - *

      - * DeletePending: Model card deletion request received.

      - *
      • - *
    • - *

      - * DeleteInProgress: Model card deletion is in progress.

      - *
      • - *
    • - *

      - * ContentDeleted: Deleted model card content.

      - *
      • - *
    • - *

      - * ExportJobsDeleted: Deleted all export jobs associated with the model card.

      - *
      • - *
    • - *

      - * DeleteCompleted: Successfully deleted the model card.

      - *
      • - *
    • - *

      - * DeleteFailed: The model card failed to delete.

      - *
      • - *
    + *

    The location of the output produced by the labeling job.

    */ - ModelCardProcessingStatus?: ModelCardProcessingStatus; + LabelingJobOutput?: LabelingJobOutput; } /** * @public */ -export interface DescribeModelCardExportJobRequest { +export interface DescribeLineageGroupRequest { /** * @public - *

    The Amazon Resource Name (ARN) of the model card export job to describe.

    + *

    The name of the lineage group.

    */ - ModelCardExportJobArn: string | undefined; + LineageGroupName: string | undefined; } /** * @public - *

    The artifacts of the model card export job.

    */ -export interface ModelCardExportArtifacts { +export interface DescribeLineageGroupResponse { /** * @public - *

    The Amazon S3 URI of the exported model artifacts.

    + *

    The name of the lineage group.

    */ - S3ExportArtifacts: string | undefined; -} + LineageGroupName?: string; -/** - * @public - * @enum - */ -export const ModelCardExportJobStatus = { - COMPLETED: "Completed", - FAILED: "Failed", - IN_PROGRESS: "InProgress", -} as const; + /** + * @public + *

    The Amazon Resource Name (ARN) of the lineage group.

    + */ + LineageGroupArn?: string; + + /** + * @public + *

    The display name of the lineage group.

    + */ + DisplayName?: string; + + /** + * @public + *

    The description of the lineage group.

    + */ + Description?: string; + + /** + * @public + *

    The creation time of lineage group.

    + */ + CreationTime?: Date; + + /** + * @public + *

    Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.

    + */ + CreatedBy?: UserContext; + + /** + * @public + *

    The last modified time of the lineage group.

    + */ + LastModifiedTime?: Date; + + /** + * @public + *

    Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.

    + */ + LastModifiedBy?: UserContext; +} /** * @public */ -export type ModelCardExportJobStatus = (typeof ModelCardExportJobStatus)[keyof typeof ModelCardExportJobStatus]; +export interface DescribeModelInput { + /** + * @public + *

    The name of the model.

    + */ + ModelName: string | undefined; +} /** * @public */ -export interface DescribeModelCardExportJobResponse { +export interface DescribeModelOutput { /** * @public - *

    The name of the model card export job to describe.

    + *

    Name of the SageMaker model.

    */ - ModelCardExportJobName: string | undefined; + ModelName: string | undefined; /** * @public - *

    The Amazon Resource Name (ARN) of the model card export job.

    + *

    The location of the primary inference code, associated artifacts, and custom + * environment map that the inference code uses when it is deployed in production. + *

    */ - ModelCardExportJobArn: string | undefined; + PrimaryContainer?: ContainerDefinition; /** * @public - *

    The completion status of the model card export job.

    - *
      - *
    • - *

      - * InProgress: The model card export job is in progress.

      - *
      • - *
    • - *

      - * Completed: The model card export job is complete.

      - *
      • - *
    • - *

      - * Failed: The model card export job failed. To see the reason for the failure, see - * the FailureReason field in the response to a - * DescribeModelCardExportJob call.

      - *
      • - *
    + *

    The containers in the inference pipeline.

    */ - Status: ModelCardExportJobStatus | undefined; + Containers?: ContainerDefinition[]; /** * @public - *

    The name or Amazon Resource Name (ARN) of the model card that the model export job exports.

    + *

    Specifies details of how containers in a multi-container endpoint are called.

    */ - ModelCardName: string | undefined; + InferenceExecutionConfig?: InferenceExecutionConfig; /** * @public - *

    The version of the model card that the model export job exports.

    + *

    The Amazon Resource Name (ARN) of the IAM role that you specified for the + * model.

    */ - ModelCardVersion: number | undefined; + ExecutionRoleArn?: string; /** * @public - *

    The export output details for the model card.

    + *

    A VpcConfig object that specifies the VPC that this model has access to. For + * more information, see Protect Endpoints by Using an Amazon Virtual + * Private Cloud + *

    */ - OutputConfig: ModelCardExportOutputConfig | undefined; + VpcConfig?: VpcConfig; /** * @public - *

    The date and time that the model export job was created.

    + *

    A timestamp that shows when the model was created.

    */ - CreatedAt: Date | undefined; + CreationTime: Date | undefined; /** * @public - *

    The date and time that the model export job was last modified.

    + *

    The Amazon Resource Name (ARN) of the model.

    */ - LastModifiedAt: Date | undefined; + ModelArn: string | undefined; /** * @public - *

    The failure reason if the model export job fails.

    + *

    If True, no inbound or outbound network calls can be made to or from the + * model container.

    */ - FailureReason?: string; + EnableNetworkIsolation?: boolean; /** * @public - *

    The exported model card artifacts.

    + *

    A set of recommended deployment configurations for the model.

    */ - ExportArtifacts?: ModelCardExportArtifacts; + DeploymentRecommendation?: DeploymentRecommendation; } /** * @public */ -export interface DescribeModelExplainabilityJobDefinitionRequest { +export interface DescribeModelBiasJobDefinitionRequest { /** * @public - *

    The name of the model explainability job definition. The name must be unique within an - * Amazon Web Services Region in the Amazon Web Services account.

    + *

    The name of the model bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

    */ JobDefinitionName: string | undefined; } @@ -6353,48 +6935,49 @@ export interface DescribeModelExplainabilityJobDefinitionRequest { /** * @public */ -export interface DescribeModelExplainabilityJobDefinitionResponse { +export interface DescribeModelBiasJobDefinitionResponse { /** * @public - *

    The Amazon Resource Name (ARN) of the model explainability job.

    + *

    The Amazon Resource Name (ARN) of the model bias job.

    */ JobDefinitionArn: string | undefined; /** * @public - *

    The name of the explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

    + *

    The name of the bias job definition. The name must be unique within an Amazon Web Services + * Region in the Amazon Web Services account.

    */ JobDefinitionName: string | undefined; /** * @public - *

    The time at which the model explainability job was created.

    + *

    The time at which the model bias job was created.

    */ CreationTime: Date | undefined; /** * @public - *

    The baseline configuration for a model explainability job.

    + *

    The baseline configuration for a model bias job.

    */ - ModelExplainabilityBaselineConfig?: ModelExplainabilityBaselineConfig; + ModelBiasBaselineConfig?: ModelBiasBaselineConfig; /** * @public - *

    Configures the model explainability job to run a specified Docker container image.

    + *

    Configures the model bias job to run a specified Docker container image.

    */ - ModelExplainabilityAppSpecification: ModelExplainabilityAppSpecification | undefined; + ModelBiasAppSpecification: ModelBiasAppSpecification | undefined; /** * @public - *

    Inputs for the model explainability job.

    + *

    Inputs for the model bias job.

    */ - ModelExplainabilityJobInput: ModelExplainabilityJobInput | undefined; + ModelBiasJobInput: ModelBiasJobInput | undefined; /** * @public *

    The output configuration for monitoring jobs.

    */ - ModelExplainabilityJobOutputConfig: MonitoringOutputConfig | undefined; + ModelBiasJobOutputConfig: MonitoringOutputConfig | undefined; /** * @public @@ -6404,7 +6987,7 @@ export interface DescribeModelExplainabilityJobDefinitionResponse { /** * @public - *

    Networking options for a model explainability job.

    + *

    Networking options for a model bias job.

    */ NetworkConfig?: MonitoringNetworkConfig; @@ -6425,308 +7008,664 @@ export interface DescribeModelExplainabilityJobDefinitionResponse { /** * @public */ -export interface DescribeModelPackageInput { +export interface DescribeModelCardRequest { /** * @public - *

    The name or Amazon Resource Name (ARN) of the model package to describe.

    - *

    When you specify a name, the name must have 1 to 63 characters. Valid - * characters are a-z, A-Z, 0-9, and - (hyphen).

    + *

    The name or Amazon Resource Name (ARN) of the model card to describe.

    */ - ModelPackageName: string | undefined; + ModelCardName: string | undefined; + + /** + * @public + *

    The version of the model card to describe. If a version is not provided, then the latest version of the model card is described.

    + */ + ModelCardVersion?: number; } /** * @public * @enum */ -export const DetailedModelPackageStatus = { - COMPLETED: "Completed", - FAILED: "Failed", - IN_PROGRESS: "InProgress", - NOT_STARTED: "NotStarted", +export const ModelCardProcessingStatus = { + CONTENT_DELETED: "ContentDeleted", + DELETE_COMPLETED: "DeleteCompleted", + DELETE_FAILED: "DeleteFailed", + DELETE_INPROGRESS: "DeleteInProgress", + DELETE_PENDING: "DeletePending", + EXPORTJOBS_DELETED: "ExportJobsDeleted", } as const; /** * @public */ -export type DetailedModelPackageStatus = (typeof DetailedModelPackageStatus)[keyof typeof DetailedModelPackageStatus]; +export type ModelCardProcessingStatus = (typeof ModelCardProcessingStatus)[keyof typeof ModelCardProcessingStatus]; /** * @public - *

    Represents the overall status of a model package.

    */ -export interface ModelPackageStatusItem { +export interface DescribeModelCardResponse { /** * @public - *

    The name of the model package for which the overall status is being reported.

    + *

    The Amazon Resource Name (ARN) of the model card.

    */ - Name: string | undefined; + ModelCardArn: string | undefined; /** * @public - *

    The current status.

    + *

    The name of the model card.

    */ - Status: DetailedModelPackageStatus | undefined; + ModelCardName: string | undefined; /** * @public - *

    if the overall status is Failed, the reason for the failure.

    + *

    The version of the model card.

    */ - FailureReason?: string; -} + ModelCardVersion: number | undefined; -/** - * @public - *

    Specifies the validation and image scan statuses of the model package.

    - */ -export interface ModelPackageStatusDetails { /** * @public - *

    The validation status of the model package.

    + *

    The content of the model card.

    */ - ValidationStatuses: ModelPackageStatusItem[] | undefined; + Content: string | undefined; /** * @public - *

    The status of the scan of the Docker image container for the model package.

    + *

    The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

    + *
      + *
    • + *

      + * Draft: The model card is a work in progress.

      + *
      • + *
    • + *

      + * PendingReview: The model card is pending review.

      + *
      • + *
    • + *

      + * Approved: The model card is approved.

      + *
      • + *
    • + *

      + * Archived: The model card is archived. No more updates should be made to the model + * card, but it can still be exported.

      + *
      • + *
    */ - ImageScanStatuses?: ModelPackageStatusItem[]; -} + ModelCardStatus: ModelCardStatus | undefined; -/** - * @public - */ -export interface DescribeModelPackageOutput { /** * @public - *

    The name of the model package being described.

    + *

    The security configuration used to protect model card content.

    */ - ModelPackageName: string | undefined; + SecurityConfig?: ModelCardSecurityConfig; /** * @public - *

    If the model is a versioned model, the name of the model group that the versioned - * model belongs to.

    + *

    The date and time the model card was created.

    */ - ModelPackageGroupName?: string; + CreationTime: Date | undefined; /** * @public - *

    The version of the model package.

    + *

    Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.

    */ - ModelPackageVersion?: number; + CreatedBy: UserContext | undefined; /** * @public - *

    The Amazon Resource Name (ARN) of the model package.

    + *

    The date and time the model card was last modified.

    */ - ModelPackageArn: string | undefined; + LastModifiedTime?: Date; /** * @public - *

    A brief summary of the model package.

    + *

    Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.

    */ - ModelPackageDescription?: string; + LastModifiedBy?: UserContext; /** * @public - *

    A timestamp specifying when the model package was created.

    + *

    The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.

    + *
      + *
    • + *

      + * DeletePending: Model card deletion request received.

      + *
      • + *
    • + *

      + * DeleteInProgress: Model card deletion is in progress.

      + *
      • + *
    • + *

      + * ContentDeleted: Deleted model card content.

      + *
      • + *
    • + *

      + * ExportJobsDeleted: Deleted all export jobs associated with the model card.

      + *
      • + *
    • + *

      + * DeleteCompleted: Successfully deleted the model card.

      + *
      • + *
    • + *

      + * DeleteFailed: The model card failed to delete.

      + *
      • + *
    */ - CreationTime: Date | undefined; + ModelCardProcessingStatus?: ModelCardProcessingStatus; +} +/** + * @public + */ +export interface DescribeModelCardExportJobRequest { /** * @public - *

    Details about inference jobs that can be run with models based on this model - * package.

    + *

    The Amazon Resource Name (ARN) of the model card export job to describe.

    */ - InferenceSpecification?: InferenceSpecification; + ModelCardExportJobArn: string | undefined; +} +/** + * @public + *

    The artifacts of the model card export job.

    + */ +export interface ModelCardExportArtifacts { /** * @public - *

    Details about the algorithm that was used to create the model package.

    + *

    The Amazon S3 URI of the exported model artifacts.

    */ - SourceAlgorithmSpecification?: SourceAlgorithmSpecification; + S3ExportArtifacts: string | undefined; +} + +/** + * @public + * @enum + */ +export const ModelCardExportJobStatus = { + COMPLETED: "Completed", + FAILED: "Failed", + IN_PROGRESS: "InProgress", +} as const; + +/** + * @public + */ +export type ModelCardExportJobStatus = (typeof ModelCardExportJobStatus)[keyof typeof ModelCardExportJobStatus]; +/** + * @public + */ +export interface DescribeModelCardExportJobResponse { /** * @public - *

    Configurations for one or more transform jobs that SageMaker runs to test the model - * package.

    + *

    The name of the model card export job to describe.

    */ - ValidationSpecification?: ModelPackageValidationSpecification; + ModelCardExportJobName: string | undefined; /** * @public - *

    The current status of the model package.

    + *

    The Amazon Resource Name (ARN) of the model card export job.

    */ - ModelPackageStatus: ModelPackageStatus | undefined; + ModelCardExportJobArn: string | undefined; /** * @public - *

    Details about the current status of the model package.

    + *

    The completion status of the model card export job.

    + *
      + *
    • + *

      + * InProgress: The model card export job is in progress.

      + *
      • + *
    • + *

      + * Completed: The model card export job is complete.

      + *
      • + *
    • + *

      + * Failed: The model card export job failed. To see the reason for the failure, see + * the FailureReason field in the response to a + * DescribeModelCardExportJob call.

      + *
      • + *
    */ - ModelPackageStatusDetails: ModelPackageStatusDetails | undefined; + Status: ModelCardExportJobStatus | undefined; /** * @public - *

    Whether the model package is certified for listing on Amazon Web Services Marketplace.

    + *

    The name or Amazon Resource Name (ARN) of the model card that the model export job exports.

    */ - CertifyForMarketplace?: boolean; + ModelCardName: string | undefined; /** * @public - *

    The approval status of the model package.

    + *

    The version of the model card that the model export job exports.

    */ - ModelApprovalStatus?: ModelApprovalStatus; + ModelCardVersion: number | undefined; /** * @public - *

    Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.

    + *

    The export output details for the model card.

    */ - CreatedBy?: UserContext; + OutputConfig: ModelCardExportOutputConfig | undefined; /** * @public - *

    Metadata properties of the tracking entity, trial, or trial component.

    + *

    The date and time that the model export job was created.

    */ - MetadataProperties?: MetadataProperties; + CreatedAt: Date | undefined; /** * @public - *

    Metrics for the model.

    + *

    The date and time that the model export job was last modified.

    */ - ModelMetrics?: ModelMetrics; + LastModifiedAt: Date | undefined; /** * @public - *

    The last time that the model package was modified.

    + *

    The failure reason if the model export job fails.

    */ - LastModifiedTime?: Date; + FailureReason?: string; /** * @public - *

    Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.

    + *

    The exported model card artifacts.

    */ - LastModifiedBy?: UserContext; + ExportArtifacts?: ModelCardExportArtifacts; +} +/** + * @public + */ +export interface DescribeModelExplainabilityJobDefinitionRequest { /** * @public - *

    A description provided for the model approval.

    + *

    The name of the model explainability job definition. The name must be unique within an + * Amazon Web Services Region in the Amazon Web Services account.

    */ - ApprovalDescription?: string; + JobDefinitionName: string | undefined; +} +/** + * @public + */ +export interface DescribeModelExplainabilityJobDefinitionResponse { /** * @public - *

    The metadata properties associated with the model package versions.

    + *

    The Amazon Resource Name (ARN) of the model explainability job.

    */ - CustomerMetadataProperties?: Record; + JobDefinitionArn: string | undefined; /** * @public - *

    Represents the drift check baselines that can be used when the model monitor is set using the model package. - * For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide. - *

    + *

    The name of the explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

    */ - DriftCheckBaselines?: DriftCheckBaselines; + JobDefinitionName: string | undefined; /** * @public - *

    The machine learning domain of the model package you specified. Common machine - * learning domains include computer vision and natural language processing.

    + *

    The time at which the model explainability job was created.

    */ - Domain?: string; + CreationTime: Date | undefined; /** * @public - *

    The machine learning task you specified that your model package accomplishes. - * Common machine learning tasks include object detection and image classification.

    + *

    The baseline configuration for a model explainability job.

    */ - Task?: string; + ModelExplainabilityBaselineConfig?: ModelExplainabilityBaselineConfig; /** * @public - *

    The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path points to a single - * gzip compressed tar archive (.tar.gz suffix).

    + *

    Configures the model explainability job to run a specified Docker container image.

    */ - SamplePayloadUrl?: string; + ModelExplainabilityAppSpecification: ModelExplainabilityAppSpecification | undefined; /** * @public - *

    An array of additional Inference Specification objects. Each additional - * Inference Specification specifies artifacts based on this model package that can - * be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

    + *

    Inputs for the model explainability job.

    */ - AdditionalInferenceSpecifications?: AdditionalInferenceSpecificationDefinition[]; + ModelExplainabilityJobInput: ModelExplainabilityJobInput | undefined; /** * @public - *

    Indicates if you want to skip model validation.

    + *

    The output configuration for monitoring jobs.

    */ - SkipModelValidation?: SkipModelValidation; + ModelExplainabilityJobOutputConfig: MonitoringOutputConfig | undefined; + + /** + * @public + *

    Identifies the resources to deploy for a monitoring job.

    + */ + JobResources: MonitoringResources | undefined; + + /** + * @public + *

    Networking options for a model explainability job.

    + */ + NetworkConfig?: MonitoringNetworkConfig; + + /** + * @public + *

    The Amazon Resource Name (ARN) of the IAM role that has read permission to the + * input data location and write permission to the output data location in Amazon S3.

    + */ + RoleArn: string | undefined; + + /** + * @public + *

    A time limit for how long the monitoring job is allowed to run before stopping.

    + */ + StoppingCondition?: MonitoringStoppingCondition; } /** * @public */ -export interface DescribeModelPackageGroupInput { +export interface DescribeModelPackageInput { /** * @public - *

    The name of gthe model group to describe.

    + *

    The name or Amazon Resource Name (ARN) of the model package to describe.

    + *

    When you specify a name, the name must have 1 to 63 characters. Valid + * characters are a-z, A-Z, 0-9, and - (hyphen).

    */ - ModelPackageGroupName: string | undefined; + ModelPackageName: string | undefined; } /** * @public * @enum */ -export const ModelPackageGroupStatus = { +export const DetailedModelPackageStatus = { COMPLETED: "Completed", - DELETE_FAILED: "DeleteFailed", - DELETING: "Deleting", FAILED: "Failed", IN_PROGRESS: "InProgress", - PENDING: "Pending", + NOT_STARTED: "NotStarted", } as const; /** * @public */ -export type ModelPackageGroupStatus = (typeof ModelPackageGroupStatus)[keyof typeof ModelPackageGroupStatus]; +export type DetailedModelPackageStatus = (typeof DetailedModelPackageStatus)[keyof typeof DetailedModelPackageStatus]; /** * @public + *

    Represents the overall status of a model package.

    */ -export interface DescribeModelPackageGroupOutput { +export interface ModelPackageStatusItem { /** * @public - *

    The name of the model group.

    + *

    The name of the model package for which the overall status is being reported.

    */ - ModelPackageGroupName: string | undefined; + Name: string | undefined; /** * @public - *

    The Amazon Resource Name (ARN) of the model group.

    + *

    The current status.

    */ - ModelPackageGroupArn: string | undefined; + Status: DetailedModelPackageStatus | undefined; /** * @public - *

    A description of the model group.

    + *

    if the overall status is Failed, the reason for the failure.

    */ - ModelPackageGroupDescription?: string; + FailureReason?: string; +} +/** + * @public + *

    Specifies the validation and image scan statuses of the model package.

    + */ +export interface ModelPackageStatusDetails { /** * @public - *

    The time that the model group was created.

    + *

    The validation status of the model package.

    */ - CreationTime: Date | undefined; + ValidationStatuses: ModelPackageStatusItem[] | undefined; /** * @public - *

    Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.

    + *

    The status of the scan of the Docker image container for the model package.

    + */ + ImageScanStatuses?: ModelPackageStatusItem[]; +} + +/** + * @public + */ +export interface DescribeModelPackageOutput { + /** + * @public + *

    The name of the model package being described.

    + */ + ModelPackageName: string | undefined; + + /** + * @public + *

    If the model is a versioned model, the name of the model group that the versioned + * model belongs to.

    + */ + ModelPackageGroupName?: string; + + /** + * @public + *

    The version of the model package.

    + */ + ModelPackageVersion?: number; + + /** + * @public + *

    The Amazon Resource Name (ARN) of the model package.

    + */ + ModelPackageArn: string | undefined; + + /** + * @public + *

    A brief summary of the model package.

    + */ + ModelPackageDescription?: string; + + /** + * @public + *

    A timestamp specifying when the model package was created.

    + */ + CreationTime: Date | undefined; + + /** + * @public + *

    Details about inference jobs that can be run with models based on this model + * package.

    + */ + InferenceSpecification?: InferenceSpecification; + + /** + * @public + *

    Details about the algorithm that was used to create the model package.

    + */ + SourceAlgorithmSpecification?: SourceAlgorithmSpecification; + + /** + * @public + *

    Configurations for one or more transform jobs that SageMaker runs to test the model + * package.

    + */ + ValidationSpecification?: ModelPackageValidationSpecification; + + /** + * @public + *

    The current status of the model package.

    + */ + ModelPackageStatus: ModelPackageStatus | undefined; + + /** + * @public + *

    Details about the current status of the model package.

    + */ + ModelPackageStatusDetails: ModelPackageStatusDetails | undefined; + + /** + * @public + *

    Whether the model package is certified for listing on Amazon Web Services Marketplace.

    + */ + CertifyForMarketplace?: boolean; + + /** + * @public + *

    The approval status of the model package.

    + */ + ModelApprovalStatus?: ModelApprovalStatus; + + /** + * @public + *

    Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.

    + */ + CreatedBy?: UserContext; + + /** + * @public + *

    Metadata properties of the tracking entity, trial, or trial component.

    + */ + MetadataProperties?: MetadataProperties; + + /** + * @public + *

    Metrics for the model.

    + */ + ModelMetrics?: ModelMetrics; + + /** + * @public + *

    The last time that the model package was modified.

    + */ + LastModifiedTime?: Date; + + /** + * @public + *

    Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.

    + */ + LastModifiedBy?: UserContext; + + /** + * @public + *

    A description provided for the model approval.

    + */ + ApprovalDescription?: string; + + /** + * @public + *

    The metadata properties associated with the model package versions.

    + */ + CustomerMetadataProperties?: Record; + + /** + * @public + *

    Represents the drift check baselines that can be used when the model monitor is set using the model package. + * For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide. + *

    + */ + DriftCheckBaselines?: DriftCheckBaselines; + + /** + * @public + *

    The machine learning domain of the model package you specified. Common machine + * learning domains include computer vision and natural language processing.

    + */ + Domain?: string; + + /** + * @public + *

    The machine learning task you specified that your model package accomplishes. + * Common machine learning tasks include object detection and image classification.

    + */ + Task?: string; + + /** + * @public + *

    The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path points to a single + * gzip compressed tar archive (.tar.gz suffix).

    + */ + SamplePayloadUrl?: string; + + /** + * @public + *

    An array of additional Inference Specification objects. Each additional + * Inference Specification specifies artifacts based on this model package that can + * be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

    + */ + AdditionalInferenceSpecifications?: AdditionalInferenceSpecificationDefinition[]; + + /** + * @public + *

    Indicates if you want to skip model validation.

    + */ + SkipModelValidation?: SkipModelValidation; +} + +/** + * @public + */ +export interface DescribeModelPackageGroupInput { + /** + * @public + *

    The name of gthe model group to describe.

    + */ + ModelPackageGroupName: string | undefined; +} + +/** + * @public + * @enum + */ +export const ModelPackageGroupStatus = { + COMPLETED: "Completed", + DELETE_FAILED: "DeleteFailed", + DELETING: "Deleting", + FAILED: "Failed", + IN_PROGRESS: "InProgress", + PENDING: "Pending", +} as const; + +/** + * @public + */ +export type ModelPackageGroupStatus = (typeof ModelPackageGroupStatus)[keyof typeof ModelPackageGroupStatus]; + +/** + * @public + */ +export interface DescribeModelPackageGroupOutput { + /** + * @public + *

    The name of the model group.

    + */ + ModelPackageGroupName: string | undefined; + + /** + * @public + *

    The Amazon Resource Name (ARN) of the model group.

    + */ + ModelPackageGroupArn: string | undefined; + + /** + * @public + *

    A description of the model group.

    + */ + ModelPackageGroupDescription?: string; + + /** + * @public + *

    The time that the model group was created.

    + */ + CreationTime: Date | undefined; + + /** + * @public + *

    Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.

    */ CreatedBy: UserContext | undefined; @@ -7987,6 +8926,23 @@ export interface DescribeSpaceResponse { *

    A collection of space settings.

    */ SpaceSettings?: SpaceSettings; + + /** + * @public + *

    Returns the URL of the space. If the space is created with Amazon Web Services IAM Identity Center (Successor to Amazon Web Services Single Sign-On) authentication, users can navigate to the URL after appending the respective redirect parameter for the application type to be federated through Amazon Web Services IAM Identity Center.

    + *

    The following application types are supported:

    + *
      + *
    • + *

      Studio Classic: &redirect=JupyterServer + *

      + *
      • + *
    • + *

      JupyterLab: &redirect=JupyterLab + *

      + *
      • + *
    + */ + Url?: string; } /** @@ -7995,7 +8951,7 @@ export interface DescribeSpaceResponse { export interface DescribeStudioLifecycleConfigRequest { /** * @public - *

    The name of the Studio Lifecycle Configuration to describe.

    + *

    The name of the Amazon SageMaker Studio Lifecycle Configuration to describe.

    */ StudioLifecycleConfigName: string | undefined; } @@ -8012,25 +8968,25 @@ export interface DescribeStudioLifecycleConfigResponse { /** * @public - *

    The name of the Studio Lifecycle Configuration that is described.

    + *

    The name of the Amazon SageMaker Studio Lifecycle Configuration that is described.

    */ StudioLifecycleConfigName?: string; /** * @public - *

    The creation time of the Studio Lifecycle Configuration.

    + *

    The creation time of the Amazon SageMaker Studio Lifecycle Configuration.

    */ CreationTime?: Date; /** * @public - *

    This value is equivalent to CreationTime because Studio Lifecycle Configurations are immutable.

    + *

    This value is equivalent to CreationTime because Amazon SageMaker Studio Lifecycle Configurations are immutable.

    */ LastModifiedTime?: Date; /** * @public - *

    The content of your Studio Lifecycle Configuration script.

    + *

    The content of your Amazon SageMaker Studio Lifecycle Configuration script.

    */ StudioLifecycleConfigContent?: string; @@ -8825,1873 +9781,692 @@ export interface DescribeTrainingJobResponse { * if BillableTimeInSeconds is 100 and TrainingTimeInSeconds is * 500, the savings is 80%.

    */ - BillableTimeInSeconds?: number; - - /** - * @public - *

    Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and - * storage paths. To learn more about - * how to configure the DebugHookConfig parameter, - * see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

    - */ - DebugHookConfig?: DebugHookConfig; - - /** - * @public - *

    Associates a SageMaker job as a trial component with an experiment and trial. Specified when - * you call the following APIs:

    - * - */ - ExperimentConfig?: ExperimentConfig; - - /** - * @public - *

    Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.

    - */ - DebugRuleConfigurations?: DebugRuleConfiguration[]; - - /** - * @public - *

    Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data.

    - */ - TensorBoardOutputConfig?: TensorBoardOutputConfig; - - /** - * @public - *

    Evaluation status of Amazon SageMaker Debugger rules for debugging on a training job.

    - */ - DebugRuleEvaluationStatuses?: DebugRuleEvaluationStatus[]; - - /** - * @public - *

    Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and - * storage paths.

    - */ - ProfilerConfig?: ProfilerConfig; - - /** - * @public - *

    Configuration information for Amazon SageMaker Debugger rules for profiling system and framework - * metrics.

    - */ - ProfilerRuleConfigurations?: ProfilerRuleConfiguration[]; - - /** - * @public - *

    Evaluation status of Amazon SageMaker Debugger rules for profiling on a training job.

    - */ - ProfilerRuleEvaluationStatuses?: ProfilerRuleEvaluationStatus[]; - - /** - * @public - *

    Profiling status of a training job.

    - */ - ProfilingStatus?: ProfilingStatus; - - /** - * @public - *

    The number of times to retry the job when the job fails due to an - * InternalServerError.

    - */ - RetryStrategy?: RetryStrategy; - - /** - * @public - *

    The environment variables to set in the Docker container.

    - */ - Environment?: Record; - - /** - * @public - *

    The status of the warm pool associated with the training job.

    - */ - WarmPoolStatus?: WarmPoolStatus; -} - -/** - * @public - */ -export interface DescribeTransformJobRequest { - /** - * @public - *

    The name of the transform job that you want to view details of.

    - */ - TransformJobName: string | undefined; -} - -/** - * @public - * @enum - */ -export const TransformJobStatus = { - COMPLETED: "Completed", - FAILED: "Failed", - IN_PROGRESS: "InProgress", - STOPPED: "Stopped", - STOPPING: "Stopping", -} as const; - -/** - * @public - */ -export type TransformJobStatus = (typeof TransformJobStatus)[keyof typeof TransformJobStatus]; - -/** - * @public - */ -export interface DescribeTransformJobResponse { - /** - * @public - *

    The name of the transform job.

    - */ - TransformJobName: string | undefined; - - /** - * @public - *

    The Amazon Resource Name (ARN) of the transform job.

    - */ - TransformJobArn: string | undefined; - - /** - * @public - *

    The - * status of the transform job. If the transform job failed, the reason - * is returned in the FailureReason field.

    - */ - TransformJobStatus: TransformJobStatus | undefined; - - /** - * @public - *

    If the transform job failed, FailureReason describes - * why - * it failed. A transform job creates a log file, which includes error - * messages, and stores it - * as - * an Amazon S3 object. For more information, see Log Amazon SageMaker Events with - * Amazon CloudWatch.

    - */ - FailureReason?: string; - - /** - * @public - *

    The name of the model used in the transform job.

    - */ - ModelName: string | undefined; - - /** - * @public - *

    The - * maximum number - * of - * parallel requests on each instance node - * that can be launched in a transform job. The default value is 1.

    - */ - MaxConcurrentTransforms?: number; - - /** - * @public - *

    The timeout and maximum number of retries for processing a transform job - * invocation.

    - */ - ModelClientConfig?: ModelClientConfig; - - /** - * @public - *

    The - * maximum - * payload size, in MB, used in the - * transform job.

    - */ - MaxPayloadInMB?: number; - - /** - * @public - *

    Specifies the number of records to include in a mini-batch for an HTTP inference - * request. - * A record - * is a single unit of input data that inference - * can be made on. For example, a single line in a CSV file is a record.

    - *

    To enable the batch strategy, you must set SplitType - * to - * Line, RecordIO, or - * TFRecord.

    - */ - BatchStrategy?: BatchStrategy; - - /** - * @public - *

    The - * environment variables to set in the Docker container. We support up to 16 key and values - * entries in the map.

    - */ - Environment?: Record; - - /** - * @public - *

    Describes the dataset to be transformed and the Amazon S3 location where it is - * stored.

    - */ - TransformInput: TransformInput | undefined; - - /** - * @public - *

    Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the - * transform job.

    - */ - TransformOutput?: TransformOutput; - - /** - * @public - *

    Configuration to control how SageMaker captures inference data.

    - */ - DataCaptureConfig?: BatchDataCaptureConfig; - - /** - * @public - *

    Describes - * the resources, including ML instance types and ML instance count, to - * use for the transform job.

    - */ - TransformResources: TransformResources | undefined; - - /** - * @public - *

    A timestamp that shows when the transform Job was created.

    - */ - CreationTime: Date | undefined; - - /** - * @public - *

    Indicates when the transform job starts - * on - * ML instances. You are billed for the time interval between this time - * and the value of TransformEndTime.

    - */ - TransformStartTime?: Date; - - /** - * @public - *

    Indicates when the transform job has been - * - * completed, or has stopped or failed. You are billed for the time - * interval between this time and the value of TransformStartTime.

    - */ - TransformEndTime?: Date; - - /** - * @public - *

    The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the - * transform or training job.

    - */ - LabelingJobArn?: string; - - /** - * @public - *

    The Amazon Resource Name (ARN) of the AutoML transform job.

    - */ - AutoMLJobArn?: string; - - /** - * @public - *

    The data structure used to specify the data to be used for inference in a batch - * transform job and to associate the data that is relevant to the prediction results in - * the output. The input filter provided allows you to exclude input data that is not - * needed for inference in a batch transform job. The output filter provided allows you to - * include input data relevant to interpreting the predictions in the output from the job. - * For more information, see Associate Prediction - * Results with their Corresponding Input Records.

    - */ - DataProcessing?: DataProcessing; - - /** - * @public - *

    Associates a SageMaker job as a trial component with an experiment and trial. Specified when - * you call the following APIs:

    - * - */ - ExperimentConfig?: ExperimentConfig; -} - -/** - * @public - */ -export interface DescribeTrialRequest { - /** - * @public - *

    The name of the trial to describe.

    - */ - TrialName: string | undefined; -} - -/** - * @public - *

    The source of the trial.

    - */ -export interface TrialSource { - /** - * @public - *

    The Amazon Resource Name (ARN) of the source.

    - */ - SourceArn: string | undefined; - - /** - * @public - *

    The source job type.

    - */ - SourceType?: string; -} - -/** - * @public - */ -export interface DescribeTrialResponse { - /** - * @public - *

    The name of the trial.

    - */ - TrialName?: string; - - /** - * @public - *

    The Amazon Resource Name (ARN) of the trial.

    - */ - TrialArn?: string; - - /** - * @public - *

    The name of the trial as displayed. If DisplayName isn't specified, - * TrialName is displayed.

    - */ - DisplayName?: string; - - /** - * @public - *

    The name of the experiment the trial is part of.

    - */ - ExperimentName?: string; - - /** - * @public - *

    The Amazon Resource Name (ARN) of the source and, optionally, the job type.

    - */ - Source?: TrialSource; - - /** - * @public - *

    When the trial was created.

    - */ - CreationTime?: Date; - - /** - * @public - *

    Who created the trial.

    - */ - CreatedBy?: UserContext; - - /** - * @public - *

    When the trial was last modified.

    - */ - LastModifiedTime?: Date; - - /** - * @public - *

    Who last modified the trial.

    - */ - LastModifiedBy?: UserContext; - - /** - * @public - *

    Metadata properties of the tracking entity, trial, or trial component.

    - */ - MetadataProperties?: MetadataProperties; -} - -/** - * @public - */ -export interface DescribeTrialComponentRequest { - /** - * @public - *

    The name of the trial component to describe.

    - */ - TrialComponentName: string | undefined; -} - -/** - * @public - *

    A summary of the metrics of a trial component.

    - */ -export interface TrialComponentMetricSummary { - /** - * @public - *

    The name of the metric.

    - */ - MetricName?: string; - - /** - * @public - *

    The Amazon Resource Name (ARN) of the source.

    - */ - SourceArn?: string; - - /** - * @public - *

    When the metric was last updated.

    - */ - TimeStamp?: Date; - - /** - * @public - *

    The maximum value of the metric.

    - */ - Max?: number; - - /** - * @public - *

    The minimum value of the metric.

    - */ - Min?: number; - - /** - * @public - *

    The most recent value of the metric.

    - */ - Last?: number; - - /** - * @public - *

    The number of samples used to generate the metric.

    - */ - Count?: number; - - /** - * @public - *

    The average value of the metric.

    - */ - Avg?: number; - - /** - * @public - *

    The standard deviation of the metric.

    - */ - StdDev?: number; -} - -/** - * @public - *

    The Amazon Resource Name (ARN) and job type of the source of a trial component.

    - */ -export interface TrialComponentSource { - /** - * @public - *

    The source Amazon Resource Name (ARN).

    - */ - SourceArn: string | undefined; - - /** - * @public - *

    The source job type.

    - */ - SourceType?: string; -} - -/** - * @public - */ -export interface DescribeTrialComponentResponse { - /** - * @public - *

    The name of the trial component.

    - */ - TrialComponentName?: string; - - /** - * @public - *

    The Amazon Resource Name (ARN) of the trial component.

    - */ - TrialComponentArn?: string; - - /** - * @public - *

    The name of the component as displayed. If DisplayName isn't specified, - * TrialComponentName is displayed.

    - */ - DisplayName?: string; - - /** - * @public - *

    The Amazon Resource Name (ARN) of the source and, optionally, the job type.

    - */ - Source?: TrialComponentSource; - - /** - * @public - *

    The status of the component. States include:

    - *
      - *
    • - *

      InProgress

      - *
      • - *
    • - *

      Completed

      - *
      • - *
    • - *

      Failed

      - *
      • - *
    - */ - Status?: TrialComponentStatus; - - /** - * @public - *

    When the component started.

    - */ - StartTime?: Date; - - /** - * @public - *

    When the component ended.

    - */ - EndTime?: Date; - - /** - * @public - *

    When the component was created.

    - */ - CreationTime?: Date; - - /** - * @public - *

    Who created the trial component.

    - */ - CreatedBy?: UserContext; - - /** - * @public - *

    When the component was last modified.

    - */ - LastModifiedTime?: Date; - - /** - * @public - *

    Who last modified the component.

    - */ - LastModifiedBy?: UserContext; - - /** - * @public - *

    The hyperparameters of the component.

    - */ - Parameters?: Record; - - /** - * @public - *

    The input artifacts of the component.

    - */ - InputArtifacts?: Record; - - /** - * @public - *

    The output artifacts of the component.

    - */ - OutputArtifacts?: Record; - - /** - * @public - *

    Metadata properties of the tracking entity, trial, or trial component.

    - */ - MetadataProperties?: MetadataProperties; - - /** - * @public - *

    The metrics for the component.

    - */ - Metrics?: TrialComponentMetricSummary[]; - - /** - * @public - *

    The Amazon Resource Name (ARN) of the lineage group.

    - */ - LineageGroupArn?: string; - - /** - * @public - *

    A list of ARNs and, if applicable, job types for multiple sources of an experiment - * run.

    - */ - Sources?: TrialComponentSource[]; -} - -/** - * @public - */ -export interface DescribeUserProfileRequest { - /** - * @public - *

    The domain ID.

    - */ - DomainId: string | undefined; - - /** - * @public - *

    The user profile name. This value is not case sensitive.

    - */ - UserProfileName: string | undefined; -} - -/** - * @public - * @enum - */ -export const UserProfileStatus = { - Delete_Failed: "Delete_Failed", - Deleting: "Deleting", - Failed: "Failed", - InService: "InService", - Pending: "Pending", - Update_Failed: "Update_Failed", - Updating: "Updating", -} as const; - -/** - * @public - */ -export type UserProfileStatus = (typeof UserProfileStatus)[keyof typeof UserProfileStatus]; - -/** - * @public - */ -export interface DescribeUserProfileResponse { - /** - * @public - *

    The ID of the domain that contains the profile.

    - */ - DomainId?: string; - - /** - * @public - *

    The user profile Amazon Resource Name (ARN).

    - */ - UserProfileArn?: string; - - /** - * @public - *

    The user profile name.

    - */ - UserProfileName?: string; - - /** - * @public - *

    The ID of the user's profile in the Amazon Elastic File System (EFS) volume.

    - */ - HomeEfsFileSystemUid?: string; - - /** - * @public - *

    The status.

    - */ - Status?: UserProfileStatus; - - /** - * @public - *

    The last modified time.

    - */ - LastModifiedTime?: Date; - - /** - * @public - *

    The creation time.

    - */ - CreationTime?: Date; - - /** - * @public - *

    The failure reason.

    - */ - FailureReason?: string; - - /** - * @public - *

    The IAM Identity Center user identifier.

    - */ - SingleSignOnUserIdentifier?: string; - - /** - * @public - *

    The IAM Identity Center user value.

    - */ - SingleSignOnUserValue?: string; - - /** - * @public - *

    A collection of settings.

    - */ - UserSettings?: UserSettings; -} - -/** - * @public - */ -export interface DescribeWorkforceRequest { - /** - * @public - *

    The name of the private workforce whose access you want to restrict. - * WorkforceName is automatically set to default when a - * workforce is created and cannot be modified.

    - */ - WorkforceName: string | undefined; -} - -/** - * @public - *

    Your OIDC IdP workforce configuration.

    - */ -export interface OidcConfigForResponse { - /** - * @public - *

    The OIDC IdP client ID used to configure your private workforce.

    - */ - ClientId?: string; - - /** - * @public - *

    The OIDC IdP issuer used to configure your private workforce.

    - */ - Issuer?: string; - - /** - * @public - *

    The OIDC IdP authorization endpoint used to configure your private workforce.

    - */ - AuthorizationEndpoint?: string; - - /** - * @public - *

    The OIDC IdP token endpoint used to configure your private workforce.

    - */ - TokenEndpoint?: string; - - /** - * @public - *

    The OIDC IdP user information endpoint used to configure your private workforce.

    - */ - UserInfoEndpoint?: string; - - /** - * @public - *

    The OIDC IdP logout endpoint used to configure your private workforce.

    - */ - LogoutEndpoint?: string; - - /** - * @public - *

    The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.

    - */ - JwksUri?: string; -} - -/** - * @public - * @enum - */ -export const WorkforceStatus = { - ACTIVE: "Active", - DELETING: "Deleting", - FAILED: "Failed", - INITIALIZING: "Initializing", - UPDATING: "Updating", -} as const; - -/** - * @public - */ -export type WorkforceStatus = (typeof WorkforceStatus)[keyof typeof WorkforceStatus]; - -/** - * @public - *

    A VpcConfig object that specifies the VPC that you want your workforce to connect to.

    - */ -export interface WorkforceVpcConfigResponse { - /** - * @public - *

    The ID of the VPC that the workforce uses for communication.

    - */ - VpcId: string | undefined; - - /** - * @public - *

    The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

    - */ - SecurityGroupIds: string[] | undefined; - - /** - * @public - *

    The ID of the subnets in the VPC that you want to connect.

    - */ - Subnets: string[] | undefined; - - /** - * @public - *

    The IDs for the VPC service endpoints of your VPC workforce when it is created and updated.

    - */ - VpcEndpointId?: string; -} - -/** - * @public - *

    A single private workforce, which is automatically created when you create your first - * private work team. You can create one private work force in each Amazon Web Services Region. By default, - * any workforce-related API operation used in a specific region will apply to the - * workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

    - */ -export interface Workforce { - /** - * @public - *

    The name of the private workforce.

    - */ - WorkforceName: string | undefined; - - /** - * @public - *

    The Amazon Resource Name (ARN) of the private workforce.

    - */ - WorkforceArn: string | undefined; - - /** - * @public - *

    The most recent date that UpdateWorkforce was used to - * successfully add one or more IP address ranges (CIDRs) to a private workforce's - * allow list.

    - */ - LastUpdatedDate?: Date; - - /** - * @public - *

    A list of one to ten IP address ranges (CIDRs) to be added to the - * workforce allow list. By default, a workforce isn't restricted to specific IP addresses.

    - */ - SourceIpConfig?: SourceIpConfig; - - /** - * @public - *

    The subdomain for your OIDC Identity Provider.

    - */ - SubDomain?: string; - - /** - * @public - *

    The configuration of an Amazon Cognito workforce. - * A single Cognito workforce is created using and corresponds to a single - * - * Amazon Cognito user pool.

    - */ - CognitoConfig?: CognitoConfig; - - /** - * @public - *

    The configuration of an OIDC Identity Provider (IdP) private workforce.

    - */ - OidcConfig?: OidcConfigForResponse; - - /** - * @public - *

    The date that the workforce is created.

    - */ - CreateDate?: Date; - - /** - * @public - *

    The configuration of a VPC workforce.

    - */ - WorkforceVpcConfig?: WorkforceVpcConfigResponse; - - /** - * @public - *

    The status of your workforce.

    - */ - Status?: WorkforceStatus; - - /** - * @public - *

    The reason your workforce failed.

    - */ - FailureReason?: string; -} - -/** - * @public - */ -export interface DescribeWorkforceResponse { - /** - * @public - *

    A single private workforce, which is automatically created when you create your first - * private work team. You can create one private work force in each Amazon Web Services Region. By default, - * any workforce-related API operation used in a specific region will apply to the - * workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

    - */ - Workforce: Workforce | undefined; -} - -/** - * @public - */ -export interface DescribeWorkteamRequest { - /** - * @public - *

    The name of the work team to return a description of.

    - */ - WorkteamName: string | undefined; -} - -/** - * @public - *

    Provides details about a labeling work team.

    - */ -export interface Workteam { - /** - * @public - *

    The name of the work team.

    - */ - WorkteamName: string | undefined; - - /** - * @public - *

    A list of MemberDefinition objects that contains objects that identify - * the workers that make up the work team.

    - *

    Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). - * For private workforces created using Amazon Cognito use - * CognitoMemberDefinition. For workforces created using your own OIDC identity - * provider (IdP) use OidcMemberDefinition.

    - */ - MemberDefinitions: MemberDefinition[] | undefined; - - /** - * @public - *

    The Amazon Resource Name (ARN) that identifies the work team.

    - */ - WorkteamArn: string | undefined; - - /** - * @public - *

    The Amazon Resource Name (ARN) of the workforce.

    - */ - WorkforceArn?: string; - - /** - * @public - *

    The Amazon Marketplace identifier for a vendor's work team.

    - */ - ProductListingIds?: string[]; - - /** - * @public - *

    A description of the work team.

    - */ - Description: string | undefined; - - /** - * @public - *

    The URI of the labeling job's user interface. Workers open this URI to start labeling - * your data objects.

    - */ - SubDomain?: string; - - /** - * @public - *

    The date and time that the work team was created (timestamp).

    - */ - CreateDate?: Date; - - /** - * @public - *

    The date and time that the work team was last updated (timestamp).

    - */ - LastUpdatedDate?: Date; - - /** - * @public - *

    Configures SNS notifications of available or expiring work items for work - * teams.

    - */ - NotificationConfiguration?: NotificationConfiguration; -} - -/** - * @public - */ -export interface DescribeWorkteamResponse { - /** - * @public - *

    A Workteam instance that contains information about the work team. - *

    - */ - Workteam: Workteam | undefined; -} - -/** - * @public - *

    Specifies the serverless update concurrency configuration for an endpoint variant.

    - */ -export interface ProductionVariantServerlessUpdateConfig { - /** - * @public - *

    The updated maximum number of concurrent invocations your serverless endpoint can process.

    - */ - MaxConcurrency?: number; - - /** - * @public - *

    The updated amount of provisioned concurrency to allocate for the serverless endpoint. - * Should be less than or equal to MaxConcurrency.

    - */ - ProvisionedConcurrency?: number; -} - -/** - * @public - *

    Specifies weight and capacity values for a production variant.

    - */ -export interface DesiredWeightAndCapacity { - /** - * @public - *

    The name of the variant to update.

    - */ - VariantName: string | undefined; - - /** - * @public - *

    The variant's weight.

    - */ - DesiredWeight?: number; - - /** - * @public - *

    The variant's capacity.

    - */ - DesiredInstanceCount?: number; - - /** - * @public - *

    Specifies the serverless update concurrency configuration for an endpoint variant.

    - */ - ServerlessUpdateConfig?: ProductionVariantServerlessUpdateConfig; -} - -/** - * @public - *

    Information of a particular device.

    - */ -export interface Device { - /** - * @public - *

    The name of the device.

    - */ - DeviceName: string | undefined; - - /** - * @public - *

    Description of the device.

    - */ - Description?: string; - - /** - * @public - *

    Amazon Web Services Internet of Things (IoT) object name.

    - */ - IotThingName?: string; -} - -/** - * @public - * @enum - */ -export const DeviceDeploymentStatus = { - Deployed: "DEPLOYED", - Failed: "FAILED", - InProgress: "INPROGRESS", - ReadyToDeploy: "READYTODEPLOY", - Stopped: "STOPPED", - Stopping: "STOPPING", -} as const; - -/** - * @public - */ -export type DeviceDeploymentStatus = (typeof DeviceDeploymentStatus)[keyof typeof DeviceDeploymentStatus]; - -/** - * @public - *

    Contains information summarizing device details and deployment status.

    - */ -export interface DeviceDeploymentSummary { - /** - * @public - *

    The ARN of the edge deployment plan.

    - */ - EdgeDeploymentPlanArn: string | undefined; + BillableTimeInSeconds?: number; /** * @public - *

    The name of the edge deployment plan.

    + *

    Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and + * storage paths. To learn more about + * how to configure the DebugHookConfig parameter, + * see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

    */ - EdgeDeploymentPlanName: string | undefined; + DebugHookConfig?: DebugHookConfig; /** * @public - *

    The name of the stage in the edge deployment plan.

    + *

    Associates a SageMaker job as a trial component with an experiment and trial. Specified when + * you call the following APIs:

    + * */ - StageName: string | undefined; + ExperimentConfig?: ExperimentConfig; /** * @public - *

    The name of the deployed stage.

    + *

    Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.

    */ - DeployedStageName?: string; + DebugRuleConfigurations?: DebugRuleConfiguration[]; /** * @public - *

    The name of the fleet to which the device belongs to.

    + *

    Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data.

    */ - DeviceFleetName?: string; + TensorBoardOutputConfig?: TensorBoardOutputConfig; /** * @public - *

    The name of the device.

    + *

    Evaluation status of Amazon SageMaker Debugger rules for debugging on a training job.

    */ - DeviceName: string | undefined; + DebugRuleEvaluationStatuses?: DebugRuleEvaluationStatus[]; /** * @public - *

    The ARN of the device.

    + *

    Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and + * storage paths.

    */ - DeviceArn: string | undefined; + ProfilerConfig?: ProfilerConfig; /** * @public - *

    The deployment status of the device.

    + *

    Configuration information for Amazon SageMaker Debugger rules for profiling system and framework + * metrics.

    */ - DeviceDeploymentStatus?: DeviceDeploymentStatus; + ProfilerRuleConfigurations?: ProfilerRuleConfiguration[]; /** * @public - *

    The detailed error message for the deployoment status result.

    + *

    Evaluation status of Amazon SageMaker Debugger rules for profiling on a training job.

    */ - DeviceDeploymentStatusMessage?: string; + ProfilerRuleEvaluationStatuses?: ProfilerRuleEvaluationStatus[]; /** * @public - *

    The description of the device.

    + *

    Profiling status of a training job.

    */ - Description?: string; + ProfilingStatus?: ProfilingStatus; /** * @public - *

    The time when the deployment on the device started.

    + *

    The number of times to retry the job when the job fails due to an + * InternalServerError.

    */ - DeploymentStartTime?: Date; -} + RetryStrategy?: RetryStrategy; -/** - * @public - *

    Summary of the device fleet.

    - */ -export interface DeviceFleetSummary { /** * @public - *

    Amazon Resource Name (ARN) of the device fleet.

    + *

    The environment variables to set in the Docker container.

    */ - DeviceFleetArn: string | undefined; + Environment?: Record; /** * @public - *

    Name of the device fleet.

    + *

    The status of the warm pool associated with the training job.

    */ - DeviceFleetName: string | undefined; + WarmPoolStatus?: WarmPoolStatus; /** * @public - *

    Timestamp of when the device fleet was created.

    + *

    Contains information about the infrastructure health check configuration for the training job.

    */ - CreationTime?: Date; + InfraCheckConfig?: InfraCheckConfig; +} +/** + * @public + */ +export interface DescribeTransformJobRequest { /** * @public - *

    Timestamp of when the device fleet was last updated.

    + *

    The name of the transform job that you want to view details of.

    */ - LastModifiedTime?: Date; + TransformJobName: string | undefined; } /** * @public - *

    Status of devices.

    + * @enum + */ +export const TransformJobStatus = { + COMPLETED: "Completed", + FAILED: "Failed", + IN_PROGRESS: "InProgress", + STOPPED: "Stopped", + STOPPING: "Stopping", +} as const; + +/** + * @public + */ +export type TransformJobStatus = (typeof TransformJobStatus)[keyof typeof TransformJobStatus]; + +/** + * @public */ -export interface DeviceStats { +export interface DescribeTransformJobResponse { /** * @public - *

    The number of devices connected with a heartbeat.

    + *

    The name of the transform job.

    */ - ConnectedDeviceCount: number | undefined; + TransformJobName: string | undefined; /** * @public - *

    The number of registered devices.

    + *

    The Amazon Resource Name (ARN) of the transform job.

    */ - RegisteredDeviceCount: number | undefined; -} + TransformJobArn: string | undefined; -/** - * @public - *

    Summary of model on edge device.

    - */ -export interface EdgeModelSummary { /** * @public - *

    The name of the model.

    + *

    The + * status of the transform job. If the transform job failed, the reason + * is returned in the FailureReason field.

    */ - ModelName: string | undefined; + TransformJobStatus: TransformJobStatus | undefined; /** * @public - *

    The version model.

    + *

    If the transform job failed, FailureReason describes + * why + * it failed. A transform job creates a log file, which includes error + * messages, and stores it + * as + * an Amazon S3 object. For more information, see Log Amazon SageMaker Events with + * Amazon CloudWatch.

    */ - ModelVersion: string | undefined; -} + FailureReason?: string; -/** - * @public - *

    Summary of the device.

    - */ -export interface DeviceSummary { /** * @public - *

    The unique identifier of the device.

    + *

    The name of the model used in the transform job.

    */ - DeviceName: string | undefined; + ModelName: string | undefined; /** * @public - *

    Amazon Resource Name (ARN) of the device.

    + *

    The + * maximum number + * of + * parallel requests on each instance node + * that can be launched in a transform job. The default value is 1.

    */ - DeviceArn: string | undefined; + MaxConcurrentTransforms?: number; /** * @public - *

    A description of the device.

    + *

    The timeout and maximum number of retries for processing a transform job + * invocation.

    */ - Description?: string; + ModelClientConfig?: ModelClientConfig; /** * @public - *

    The name of the fleet the device belongs to.

    + *

    The + * maximum + * payload size, in MB, used in the + * transform job.

    */ - DeviceFleetName?: string; + MaxPayloadInMB?: number; /** * @public - *

    The Amazon Web Services Internet of Things (IoT) object thing name associated with the device..

    + *

    Specifies the number of records to include in a mini-batch for an HTTP inference + * request. + * A record + * is a single unit of input data that inference + * can be made on. For example, a single line in a CSV file is a record.

    + *

    To enable the batch strategy, you must set SplitType + * to + * Line, RecordIO, or + * TFRecord.

    */ - IotThingName?: string; + BatchStrategy?: BatchStrategy; /** * @public - *

    The timestamp of the last registration or de-reregistration.

    + *

    The + * environment variables to set in the Docker container. We support up to 16 key and values + * entries in the map.

    */ - RegistrationTime?: Date; + Environment?: Record; /** * @public - *

    The last heartbeat received from the device.

    + *

    Describes the dataset to be transformed and the Amazon S3 location where it is + * stored.

    */ - LatestHeartbeat?: Date; + TransformInput: TransformInput | undefined; /** * @public - *

    Models on the device.

    + *

    Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the + * transform job.

    */ - Models?: EdgeModelSummary[]; + TransformOutput?: TransformOutput; /** * @public - *

    Edge Manager agent version.

    + *

    Configuration to control how SageMaker captures inference data.

    */ - AgentVersion?: string; -} - -/** - * @public - * @enum - */ -export const Direction = { - ASCENDANTS: "Ascendants", - BOTH: "Both", - DESCENDANTS: "Descendants", -} as const; - -/** - * @public - */ -export type Direction = (typeof Direction)[keyof typeof Direction]; - -/** - * @public - */ -export interface DisableSagemakerServicecatalogPortfolioInput {} - -/** - * @public - */ -export interface DisableSagemakerServicecatalogPortfolioOutput {} + DataCaptureConfig?: BatchDataCaptureConfig; -/** - * @public - */ -export interface DisassociateTrialComponentRequest { /** * @public - *

    The name of the component to disassociate from the trial.

    + *

    Describes + * the resources, including ML instance types and ML instance count, to + * use for the transform job.

    */ - TrialComponentName: string | undefined; + TransformResources: TransformResources | undefined; /** * @public - *

    The name of the trial to disassociate from.

    + *

    A timestamp that shows when the transform Job was created.

    */ - TrialName: string | undefined; -} + CreationTime: Date | undefined; -/** - * @public - */ -export interface DisassociateTrialComponentResponse { /** * @public - *

    The Amazon Resource Name (ARN) of the trial component.

    + *

    Indicates when the transform job starts + * on + * ML instances. You are billed for the time interval between this time + * and the value of TransformEndTime.

    */ - TrialComponentArn?: string; + TransformStartTime?: Date; /** * @public - *

    The Amazon Resource Name (ARN) of the trial.

    + *

    Indicates when the transform job has been + * + * completed, or has stopped or failed. You are billed for the time + * interval between this time and the value of TransformStartTime.

    */ - TrialArn?: string; -} + TransformEndTime?: Date; -/** - * @public - *

    The domain's details.

    - */ -export interface DomainDetails { /** * @public - *

    The domain's Amazon Resource Name (ARN).

    + *

    The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the + * transform or training job.

    */ - DomainArn?: string; + LabelingJobArn?: string; /** * @public - *

    The domain ID.

    + *

    The Amazon Resource Name (ARN) of the AutoML transform job.

    */ - DomainId?: string; + AutoMLJobArn?: string; /** * @public - *

    The domain name.

    + *

    The data structure used to specify the data to be used for inference in a batch + * transform job and to associate the data that is relevant to the prediction results in + * the output. The input filter provided allows you to exclude input data that is not + * needed for inference in a batch transform job. The output filter provided allows you to + * include input data relevant to interpreting the predictions in the output from the job. + * For more information, see Associate Prediction + * Results with their Corresponding Input Records.

    */ - DomainName?: string; + DataProcessing?: DataProcessing; /** * @public - *

    The status.

    + *

    Associates a SageMaker job as a trial component with an experiment and trial. Specified when + * you call the following APIs:

    + * */ - Status?: DomainStatus; + ExperimentConfig?: ExperimentConfig; +} +/** + * @public + */ +export interface DescribeTrialRequest { /** * @public - *

    The creation time.

    + *

    The name of the trial to describe.

    */ - CreationTime?: Date; + TrialName: string | undefined; +} +/** + * @public + *

    The source of the trial.

    + */ +export interface TrialSource { /** * @public - *

    The last modified time.

    + *

    The Amazon Resource Name (ARN) of the source.

    */ - LastModifiedTime?: Date; + SourceArn: string | undefined; /** * @public - *

    The domain's URL.

    + *

    The source job type.

    */ - Url?: string; + SourceType?: string; } /** * @public - *

    A collection of settings that update the current configuration for the - * RStudioServerPro Domain-level app.

    */ -export interface RStudioServerProDomainSettingsForUpdate { - /** - * @public - *

    The execution role for the RStudioServerPro Domain-level app.

    - */ - DomainExecutionRoleArn: string | undefined; - +export interface DescribeTrialResponse { /** * @public - *

    Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that - * the version runs on.

    + *

    The name of the trial.

    */ - DefaultResourceSpec?: ResourceSpec; + TrialName?: string; /** * @public - *

    A URL pointing to an RStudio Connect server.

    + *

    The Amazon Resource Name (ARN) of the trial.

    */ - RStudioConnectUrl?: string; + TrialArn?: string; /** * @public - *

    A URL pointing to an RStudio Package Manager server.

    + *

    The name of the trial as displayed. If DisplayName isn't specified, + * TrialName is displayed.

    */ - RStudioPackageManagerUrl?: string; -} + DisplayName?: string; -/** - * @public - *

    A collection of Domain configuration settings to update.

    - */ -export interface DomainSettingsForUpdate { /** * @public - *

    A collection of RStudioServerPro Domain-level app settings to update. A - * single RStudioServerPro application is created for a domain.

    + *

    The name of the experiment the trial is part of.

    */ - RStudioServerProDomainSettingsForUpdate?: RStudioServerProDomainSettingsForUpdate; + ExperimentName?: string; /** * @public - *

    The configuration for attaching a SageMaker user profile name to the execution role as a - * sts:SourceIdentity key. This configuration can only be modified if there - * are no apps in the InService or Pending state.

    + *

    The Amazon Resource Name (ARN) of the source and, optionally, the job type.

    */ - ExecutionRoleIdentityConfig?: ExecutionRoleIdentityConfig; + Source?: TrialSource; /** * @public - *

    The security groups for the Amazon Virtual Private Cloud that the Domain uses for - * communication between Domain-level apps and user apps.

    + *

    When the trial was created.

    */ - SecurityGroupIds?: string[]; -} + CreationTime?: Date; -/** - * @public - *

    A specification for a predefined metric.

    - */ -export interface PredefinedMetricSpecification { /** * @public - *

    The metric type. You can only apply SageMaker metric types to SageMaker endpoints.

    + *

    Who created the trial.

    */ - PredefinedMetricType?: string; -} - -/** - * @public - *

    An object containing information about a metric.

    - */ -export type MetricSpecification = - | MetricSpecification.CustomizedMember - | MetricSpecification.PredefinedMember - | MetricSpecification.$UnknownMember; + CreatedBy?: UserContext; -/** - * @public - */ -export namespace MetricSpecification { /** * @public - *

    Information about a predefined metric.

    + *

    When the trial was last modified.

    */ - export interface PredefinedMember { - Predefined: PredefinedMetricSpecification; - Customized?: never; - $unknown?: never; - } + LastModifiedTime?: Date; /** * @public - *

    Information about a customized metric.

    + *

    Who last modified the trial.

    */ - export interface CustomizedMember { - Predefined?: never; - Customized: CustomizedMetricSpecification; - $unknown?: never; - } + LastModifiedBy?: UserContext; /** * @public + *

    Metadata properties of the tracking entity, trial, or trial component.

    */ - export interface $UnknownMember { - Predefined?: never; - Customized?: never; - $unknown: [string, any]; - } - - export interface Visitor { - Predefined: (value: PredefinedMetricSpecification) => T; - Customized: (value: CustomizedMetricSpecification) => T; - _: (name: string, value: any) => T; - } - - export const visit = (value: MetricSpecification, visitor: Visitor): T => { - if (value.Predefined !== undefined) return visitor.Predefined(value.Predefined); - if (value.Customized !== undefined) return visitor.Customized(value.Customized); - return visitor._(value.$unknown[0], value.$unknown[1]); - }; + MetadataProperties?: MetadataProperties; } /** * @public - *

    A target tracking scaling policy. Includes support for predefined or customized metrics.

    - *

    When using the PutScalingPolicy API, - * this parameter is required when you are creating a policy with the policy type TargetTrackingScaling.

    */ -export interface TargetTrackingScalingPolicyConfiguration { - /** - * @public - *

    An object containing information about a metric.

    - */ - MetricSpecification?: MetricSpecification; - +export interface DescribeTrialComponentRequest { /** * @public - *

    The recommended target value to specify for the metric when creating a scaling policy.

    + *

    The name of the trial component to describe.

    */ - TargetValue?: number; + TrialComponentName: string | undefined; } /** * @public - *

    An object containing a recommended scaling policy.

    - */ -export type ScalingPolicy = ScalingPolicy.TargetTrackingMember | ScalingPolicy.$UnknownMember; - -/** - * @public + *

    A summary of the metrics of a trial component.

    */ -export namespace ScalingPolicy { - /** - * @public - *

    A target tracking scaling policy. Includes support for predefined or customized metrics.

    - */ - export interface TargetTrackingMember { - TargetTracking: TargetTrackingScalingPolicyConfiguration; - $unknown?: never; - } - +export interface TrialComponentMetricSummary { /** * @public + *

    The name of the metric.

    */ - export interface $UnknownMember { - TargetTracking?: never; - $unknown: [string, any]; - } - - export interface Visitor { - TargetTracking: (value: TargetTrackingScalingPolicyConfiguration) => T; - _: (name: string, value: any) => T; - } - - export const visit = (value: ScalingPolicy, visitor: Visitor): T => { - if (value.TargetTracking !== undefined) return visitor.TargetTracking(value.TargetTracking); - return visitor._(value.$unknown[0], value.$unknown[1]); - }; -} + MetricName?: string; -/** - * @public - *

    An object with the recommended values for you to specify when creating an autoscaling policy.

    - */ -export interface DynamicScalingConfiguration { /** * @public - *

    The recommended minimum capacity to specify for your autoscaling policy.

    + *

    The Amazon Resource Name (ARN) of the source.

    */ - MinCapacity?: number; + SourceArn?: string; /** * @public - *

    The recommended maximum capacity to specify for your autoscaling policy.

    + *

    When the metric was last updated.

    */ - MaxCapacity?: number; + TimeStamp?: Date; /** * @public - *

    The recommended scale in cooldown time for your autoscaling policy.

    + *

    The maximum value of the metric.

    */ - ScaleInCooldown?: number; + Max?: number; /** * @public - *

    The recommended scale out cooldown time for your autoscaling policy.

    + *

    The minimum value of the metric.

    */ - ScaleOutCooldown?: number; + Min?: number; /** * @public - *

    An object of the scaling policies for each metric.

    + *

    The most recent value of the metric.

    */ - ScalingPolicies?: ScalingPolicy[]; -} + Last?: number; -/** - * @public - *

    A directed edge connecting two lineage entities.

    - */ -export interface Edge { /** * @public - *

    The Amazon Resource Name (ARN) of the source lineage entity of the directed edge.

    + *

    The number of samples used to generate the metric.

    */ - SourceArn?: string; + Count?: number; /** * @public - *

    The Amazon Resource Name (ARN) of the destination lineage entity of the directed edge.

    + *

    The average value of the metric.

    */ - DestinationArn?: string; + Avg?: number; /** * @public - *

    The type of the Association(Edge) between the source and destination. For example ContributedTo, - * Produced, or DerivedFrom.

    + *

    The standard deviation of the metric.

    */ - AssociationType?: AssociationEdgeType; + StdDev?: number; } /** * @public - *

    Contains information summarizing an edge deployment plan.

    + *

    The Amazon Resource Name (ARN) and job type of the source of a trial component.

    */ -export interface EdgeDeploymentPlanSummary { - /** - * @public - *

    The ARN of the edge deployment plan.

    - */ - EdgeDeploymentPlanArn: string | undefined; - - /** - * @public - *

    The name of the edge deployment plan.

    - */ - EdgeDeploymentPlanName: string | undefined; - +export interface TrialComponentSource { /** * @public - *

    The name of the device fleet used for the deployment.

    + *

    The source Amazon Resource Name (ARN).

    */ - DeviceFleetName: string | undefined; + SourceArn: string | undefined; /** * @public - *

    The number of edge devices with the successful deployment.

    + *

    The source job type.

    */ - EdgeDeploymentSuccess: number | undefined; + SourceType?: string; +} +/** + * @public + */ +export interface DescribeTrialComponentResponse { /** * @public - *

    The number of edge devices yet to pick up the deployment, or in progress.

    + *

    The name of the trial component.

    */ - EdgeDeploymentPending: number | undefined; + TrialComponentName?: string; /** * @public - *

    The number of edge devices that failed the deployment.

    + *

    The Amazon Resource Name (ARN) of the trial component.

    */ - EdgeDeploymentFailed: number | undefined; + TrialComponentArn?: string; /** * @public - *

    The time when the edge deployment plan was created.

    + *

    The name of the component as displayed. If DisplayName isn't specified, + * TrialComponentName is displayed.

    */ - CreationTime?: Date; + DisplayName?: string; /** * @public - *

    The time when the edge deployment plan was last updated.

    + *

    The Amazon Resource Name (ARN) of the source and, optionally, the job type.

    */ - LastModifiedTime?: Date; -} + Source?: TrialComponentSource; -/** - * @public - *

    Status of edge devices with this model.

    - */ -export interface EdgeModelStat { /** * @public - *

    The name of the model.

    + *

    The status of the component. States include:

    + *
      + *
    • + *

      InProgress

      + *
      • + *
    • + *

      Completed

      + *
      • + *
    • + *

      Failed

      + *
      • + *
    */ - ModelName: string | undefined; + Status?: TrialComponentStatus; /** * @public - *

    The model version.

    + *

    When the component started.

    */ - ModelVersion: string | undefined; + StartTime?: Date; /** * @public - *

    The number of devices that have this model version and do not have a heart beat.

    + *

    When the component ended.

    */ - OfflineDeviceCount: number | undefined; + EndTime?: Date; /** * @public - *

    The number of devices that have this model version and have a heart beat.

    + *

    When the component was created.

    */ - ConnectedDeviceCount: number | undefined; + CreationTime?: Date; /** * @public - *

    The number of devices that have this model version, a heart beat, and are currently running.

    + *

    Who created the trial component.

    */ - ActiveDeviceCount: number | undefined; + CreatedBy?: UserContext; /** * @public - *

    The number of devices with this model version and are producing sample data.

    + *

    When the component was last modified.

    */ - SamplingDeviceCount: number | undefined; -} + LastModifiedTime?: Date; -/** - * @public - *

    Summary of edge packaging job.

    - */ -export interface EdgePackagingJobSummary { /** * @public - *

    The Amazon Resource Name (ARN) of the edge packaging job.

    + *

    Who last modified the component.

    */ - EdgePackagingJobArn: string | undefined; + LastModifiedBy?: UserContext; /** * @public - *

    The name of the edge packaging job.

    + *

    The hyperparameters of the component.

    */ - EdgePackagingJobName: string | undefined; + Parameters?: Record; /** * @public - *

    The status of the edge packaging job.

    + *

    The input artifacts of the component.

    */ - EdgePackagingJobStatus: EdgePackagingJobStatus | undefined; + InputArtifacts?: Record; /** * @public - *

    The name of the SageMaker Neo compilation job.

    + *

    The output artifacts of the component.

    */ - CompilationJobName?: string; + OutputArtifacts?: Record; /** * @public - *

    The name of the model.

    + *

    Metadata properties of the tracking entity, trial, or trial component.

    */ - ModelName?: string; + MetadataProperties?: MetadataProperties; /** * @public - *

    The version of the model.

    + *

    The metrics for the component.

    */ - ModelVersion?: string; + Metrics?: TrialComponentMetricSummary[]; /** * @public - *

    The timestamp of when the job was created.

    + *

    The Amazon Resource Name (ARN) of the lineage group.

    */ - CreationTime?: Date; + LineageGroupArn?: string; /** * @public - *

    The timestamp of when the edge packaging job was last updated.

    + *

    A list of ARNs and, if applicable, job types for multiple sources of an experiment + * run.

    */ - LastModifiedTime?: Date; + Sources?: TrialComponentSource[]; } /** * @public - *

    The configurations and outcomes of an Amazon EMR step execution.

    */ -export interface EMRStepMetadata { - /** - * @public - *

    The identifier of the EMR cluster.

    - */ - ClusterId?: string; - - /** - * @public - *

    The identifier of the EMR cluster step.

    - */ - StepId?: string; - +export interface DescribeUserProfileRequest { /** * @public - *

    The name of the EMR cluster step.

    + *

    The domain ID.

    */ - StepName?: string; + DomainId: string | undefined; /** * @public - *

    The path to the log file where the cluster step's failure root cause - * is recorded.

    + *

    The user profile name. This value is not case sensitive.

    */ - LogFilePath?: string; + UserProfileName: string | undefined; } /** * @public + * @enum */ -export interface EnableSagemakerServicecatalogPortfolioInput {} +export const UserProfileStatus = { + Delete_Failed: "Delete_Failed", + Deleting: "Deleting", + Failed: "Failed", + InService: "InService", + Pending: "Pending", + Update_Failed: "Update_Failed", + Updating: "Updating", +} as const; /** * @public */ -export interface EnableSagemakerServicecatalogPortfolioOutput {} +export type UserProfileStatus = (typeof UserProfileStatus)[keyof typeof UserProfileStatus]; + +/** + * @internal + */ +export const OidcConfigFilterSensitiveLog = (obj: OidcConfig): any => ({ + ...obj, + ...(obj.ClientSecret && { ClientSecret: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const CreateWorkforceRequestFilterSensitiveLog = (obj: CreateWorkforceRequest): any => ({ + ...obj, + ...(obj.OidcConfig && { OidcConfig: OidcConfigFilterSensitiveLog(obj.OidcConfig) }), +}); /** * @internal diff --git a/clients/client-sagemaker/src/models/models_3.ts b/clients/client-sagemaker/src/models/models_3.ts index 54c510bb8543..0161ccd9a903 100644 --- a/clients/client-sagemaker/src/models/models_3.ts +++ b/clients/client-sagemaker/src/models/models_3.ts @@ -22,32 +22,34 @@ import { CandidateSortBy, CandidateStatus, ClarifyCheckStepMetadata, + ClusterNodeSummary, + ClusterSortBy, + ClusterSummary, CodeRepositorySortBy, CodeRepositorySortOrder, CodeRepositorySummary, + CognitoConfig, CompilationJobStatus, CompilationJobSummary, ConditionStepMetadata, - ContainerDefinition, ContextSummary, ModelApprovalStatus, ModelPackageStatus, OutputParameter, + ResourceSpec, Tag, UserContext, - VpcConfig, } from "./models_0"; import { _InstanceType, - DataCaptureConfigSummary, EdgeOutputConfig, + ExecutionRoleIdentityConfig, FeatureDefinition, FeatureType, HyperParameterTrainingJobDefinition, HyperParameterTuningJobConfig, HyperParameterTuningJobStrategyType, HyperParameterTuningJobWarmStartConfig, - InferenceExecutionConfig, InferenceExperimentSchedule, InferenceExperimentType, LabelingJobInputConfig, @@ -58,22 +60,13 @@ import { OnlineStoreConfig, RecommendationJobType, ResourceLimits, - StudioLifecycleConfigAppType, - TrialComponentStatus, + UserSettings, } from "./models_1"; import { - DeploymentRecommendation, - DeviceDeploymentSummary, - DeviceFleetSummary, - DeviceStats, - DeviceSummary, - DomainDetails, - DynamicScalingConfiguration, - EdgeDeploymentPlanSummary, - EdgeModelStat, + CustomizedMetricSpecification, + DataCaptureConfigSummary, + DomainStatus, EdgePackagingJobStatus, - EdgePackagingJobSummary, - EMRStepMetadata, EndpointOutputConfiguration, EndpointStatus, ExecutionStatus, @@ -90,17 +83,20 @@ import { HyperParameterTuningJobStatus, ImageStatus, ImageVersionStatus, + InferenceComponentStatus, InferenceExperimentStatus, InferenceMetrics, LabelCounters, LabelingJobOutput, LabelingJobStatus, LastUpdateStatus, + MemberDefinition, ModelCardExportJobStatus, ModelConfiguration, ModelPackageGroupStatus, MonitoringExecutionSummary, NotebookInstanceStatus, + NotificationConfiguration, ObjectiveStatusCounters, OfflineStoreStatus, OfflineStoreStatusValue, @@ -111,1685 +107,1432 @@ import { RecommendationJobStatus, RecommendationMetrics, ScheduleStatus, - SpaceStatus, - SubscribedWorkteam, - TrainingJobStatus, + SourceIpConfig, TrainingJobStatusCounters, - TransformJobStatus, - TrialComponentSource, - TrialSource, UserProfileStatus, - WarmPoolResourceStatus, - WarmPoolStatus, - Workforce, - Workteam, } from "./models_2"; /** * @public - *

    A schedule for a model monitoring job. For information about model monitor, see - * Amazon SageMaker Model - * Monitor.

    */ -export interface MonitoringSchedule { +export interface DescribeUserProfileResponse { /** * @public - *

    The Amazon Resource Name (ARN) of the monitoring schedule.

    + *

    The ID of the domain that contains the profile.

    */ - MonitoringScheduleArn?: string; + DomainId?: string; /** * @public - *

    The name of the monitoring schedule.

    + *

    The user profile Amazon Resource Name (ARN).

    */ - MonitoringScheduleName?: string; + UserProfileArn?: string; /** * @public - *

    The status of the monitoring schedule. This can be one of the following values.

    - *
      - *
    • - *

      - * PENDING - The schedule is pending being created.

      - *
      • - *
    • - *

      - * FAILED - The schedule failed.

      - *
      • - *
    • - *

      - * SCHEDULED - The schedule was successfully created.

      - *
      • - *
    • - *

      - * STOPPED - The schedule was stopped.

      - *
      • - *
    + *

    The user profile name.

    */ - MonitoringScheduleStatus?: ScheduleStatus; + UserProfileName?: string; /** * @public - *

    The type of the monitoring job definition to schedule.

    + *

    The ID of the user's profile in the Amazon Elastic File System (EFS) volume.

    */ - MonitoringType?: MonitoringType; + HomeEfsFileSystemUid?: string; /** * @public - *

    If the monitoring schedule failed, the reason it failed.

    + *

    The status.

    */ - FailureReason?: string; + Status?: UserProfileStatus; /** * @public - *

    The time that the monitoring schedule was created.

    + *

    The last modified time.

    */ - CreationTime?: Date; + LastModifiedTime?: Date; /** * @public - *

    The last time the monitoring schedule was changed.

    + *

    The creation time.

    */ - LastModifiedTime?: Date; + CreationTime?: Date; /** * @public - *

    Configures the monitoring schedule and defines the monitoring job.

    + *

    The failure reason.

    */ - MonitoringScheduleConfig?: MonitoringScheduleConfig; + FailureReason?: string; /** * @public - *

    The endpoint that hosts the model being monitored.

    + *

    The IAM Identity Center user identifier.

    */ - EndpointName?: string; + SingleSignOnUserIdentifier?: string; /** * @public - *

    Summary of information about the last monitoring job to run.

    + *

    The IAM Identity Center user value.

    */ - LastMonitoringExecutionSummary?: MonitoringExecutionSummary; + SingleSignOnUserValue?: string; /** * @public - *

    A list of the tags associated with the monitoring schedlue. For more information, see Tagging Amazon Web Services - * resources in the Amazon Web Services General Reference Guide.

    + *

    A collection of settings.

    */ - Tags?: Tag[]; + UserSettings?: UserSettings; } /** * @public - *

    A hosted endpoint for real-time inference.

    */ -export interface Endpoint { +export interface DescribeWorkforceRequest { /** * @public - *

    The name of the endpoint.

    + *

    The name of the private workforce whose access you want to restrict. + * WorkforceName is automatically set to default when a + * workforce is created and cannot be modified.

    */ - EndpointName: string | undefined; + WorkforceName: string | undefined; +} +/** + * @public + *

    Your OIDC IdP workforce configuration.

    + */ +export interface OidcConfigForResponse { /** * @public - *

    The Amazon Resource Name (ARN) of the endpoint.

    + *

    The OIDC IdP client ID used to configure your private workforce.

    */ - EndpointArn: string | undefined; + ClientId?: string; /** * @public - *

    The endpoint configuration associated with the endpoint.

    + *

    The OIDC IdP issuer used to configure your private workforce.

    */ - EndpointConfigName: string | undefined; + Issuer?: string; /** * @public - *

    A list of the production variants hosted on the endpoint. Each production variant is a - * model.

    + *

    The OIDC IdP authorization endpoint used to configure your private workforce.

    */ - ProductionVariants?: ProductionVariantSummary[]; + AuthorizationEndpoint?: string; /** * @public - *

    The currently active data capture configuration used by your Endpoint.

    + *

    The OIDC IdP token endpoint used to configure your private workforce.

    */ - DataCaptureConfig?: DataCaptureConfigSummary; + TokenEndpoint?: string; /** * @public - *

    The status of the endpoint.

    + *

    The OIDC IdP user information endpoint used to configure your private workforce.

    */ - EndpointStatus: EndpointStatus | undefined; + UserInfoEndpoint?: string; /** * @public - *

    If the endpoint failed, the reason it failed.

    + *

    The OIDC IdP logout endpoint used to configure your private workforce.

    */ - FailureReason?: string; + LogoutEndpoint?: string; /** * @public - *

    The time that the endpoint was created.

    + *

    The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.

    */ - CreationTime: Date | undefined; + JwksUri?: string; +} + +/** + * @public + * @enum + */ +export const WorkforceStatus = { + ACTIVE: "Active", + DELETING: "Deleting", + FAILED: "Failed", + INITIALIZING: "Initializing", + UPDATING: "Updating", +} as const; +/** + * @public + */ +export type WorkforceStatus = (typeof WorkforceStatus)[keyof typeof WorkforceStatus]; + +/** + * @public + *

    A VpcConfig object that specifies the VPC that you want your workforce to connect to.

    + */ +export interface WorkforceVpcConfigResponse { /** * @public - *

    The last time the endpoint was modified.

    + *

    The ID of the VPC that the workforce uses for communication.

    */ - LastModifiedTime: Date | undefined; + VpcId: string | undefined; /** * @public - *

    A list of monitoring schedules for the endpoint. For information about model - * monitoring, see Amazon SageMaker Model Monitor.

    + *

    The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

    */ - MonitoringSchedules?: MonitoringSchedule[]; + SecurityGroupIds: string[] | undefined; /** * @public - *

    A list of the tags associated with the endpoint. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General - * Reference Guide.

    + *

    The ID of the subnets in the VPC that you want to connect.

    */ - Tags?: Tag[]; + Subnets: string[] | undefined; /** * @public - *

    A list of the shadow variants hosted on the endpoint. Each shadow variant is a model - * in shadow mode with production traffic replicated from the production variant.

    + *

    The IDs for the VPC service endpoints of your VPC workforce when it is created and updated.

    */ - ShadowProductionVariants?: ProductionVariantSummary[]; + VpcEndpointId?: string; } /** * @public - * @enum + *

    A single private workforce, which is automatically created when you create your first + * private work team. You can create one private work force in each Amazon Web Services Region. By default, + * any workforce-related API operation used in a specific region will apply to the + * workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

    */ -export const EndpointConfigSortKey = { - CreationTime: "CreationTime", - Name: "Name", -} as const; +export interface Workforce { + /** + * @public + *

    The name of the private workforce.

    + */ + WorkforceName: string | undefined; -/** - * @public - */ -export type EndpointConfigSortKey = (typeof EndpointConfigSortKey)[keyof typeof EndpointConfigSortKey]; + /** + * @public + *

    The Amazon Resource Name (ARN) of the private workforce.

    + */ + WorkforceArn: string | undefined; -/** - * @public - *

    Provides summary information for an endpoint configuration.

    - */ -export interface EndpointConfigSummary { /** * @public - *

    The name of the endpoint configuration.

    + *

    The most recent date that UpdateWorkforce was used to + * successfully add one or more IP address ranges (CIDRs) to a private workforce's + * allow list.

    */ - EndpointConfigName: string | undefined; + LastUpdatedDate?: Date; /** * @public - *

    The Amazon Resource Name (ARN) of the endpoint configuration.

    + *

    A list of one to ten IP address ranges (CIDRs) to be added to the + * workforce allow list. By default, a workforce isn't restricted to specific IP addresses.

    */ - EndpointConfigArn: string | undefined; + SourceIpConfig?: SourceIpConfig; /** * @public - *

    A timestamp that shows when the endpoint configuration was created.

    + *

    The subdomain for your OIDC Identity Provider.

    */ - CreationTime: Date | undefined; -} + SubDomain?: string; -/** - * @public - * @enum - */ -export const EndpointSortKey = { - CreationTime: "CreationTime", - Name: "Name", - Status: "Status", -} as const; + /** + * @public + *

    The configuration of an Amazon Cognito workforce. + * A single Cognito workforce is created using and corresponds to a single + * + * Amazon Cognito user pool.

    + */ + CognitoConfig?: CognitoConfig; -/** - * @public - */ -export type EndpointSortKey = (typeof EndpointSortKey)[keyof typeof EndpointSortKey]; + /** + * @public + *

    The configuration of an OIDC Identity Provider (IdP) private workforce.

    + */ + OidcConfig?: OidcConfigForResponse; -/** - * @public - *

    Provides summary information for an endpoint.

    - */ -export interface EndpointSummary { /** * @public - *

    The name of the endpoint.

    + *

    The date that the workforce is created.

    */ - EndpointName: string | undefined; + CreateDate?: Date; /** * @public - *

    The Amazon Resource Name (ARN) of the endpoint.

    + *

    The configuration of a VPC workforce.

    */ - EndpointArn: string | undefined; + WorkforceVpcConfig?: WorkforceVpcConfigResponse; /** * @public - *

    A timestamp that shows when the endpoint was created.

    + *

    The status of your workforce.

    */ - CreationTime: Date | undefined; + Status?: WorkforceStatus; /** * @public - *

    A timestamp that shows when the endpoint was last modified.

    + *

    The reason your workforce failed.

    */ - LastModifiedTime: Date | undefined; + FailureReason?: string; +} +/** + * @public + */ +export interface DescribeWorkforceResponse { /** * @public - *

    The status of the endpoint.

    - *
      - *
    • - *

      - * OutOfService: Endpoint is not available to take incoming - * requests.

      - *
      • - *
    • - *

      - * Creating: CreateEndpoint is executing.

      - *
      • - *
    • - *

      - * Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

      - *
      • - *
    • - *

      - * SystemUpdating: Endpoint is undergoing maintenance and cannot be - * updated or deleted or re-scaled until it has completed. This maintenance - * operation does not change any customer-specified values such as VPC config, KMS - * encryption, model, instance type, or instance count.

      - *
      • - *
    • - *

      - * RollingBack: Endpoint fails to scale up or down or change its - * variant weight and is in the process of rolling back to its previous - * configuration. Once the rollback completes, endpoint returns to an - * InService status. This transitional status only applies to an - * endpoint that has autoscaling enabled and is undergoing variant weight or - * capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called - * explicitly.

      - *
      • - *
    • - *

      - * InService: Endpoint is available to process incoming - * requests.

      - *
      • - *
    • - *

      - * Deleting: DeleteEndpoint is executing.

      - *
      • - *
    • - *

      - * Failed: Endpoint could not be created, updated, or re-scaled. Use - * DescribeEndpointOutput$FailureReason for information about the - * failure. DeleteEndpoint is the only operation that can be performed on a - * failed endpoint.

      - *
      • - *
    - *

    To get a list of endpoints with a specified status, use the StatusEquals - * filter with a call to ListEndpoints.

    + *

    A single private workforce, which is automatically created when you create your first + * private work team. You can create one private work force in each Amazon Web Services Region. By default, + * any workforce-related API operation used in a specific region will apply to the + * workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

    */ - EndpointStatus: EndpointStatus | undefined; + Workforce: Workforce | undefined; } /** * @public - *

    The properties of an experiment as returned by the Search API.

    */ -export interface Experiment { +export interface DescribeWorkteamRequest { /** * @public - *

    The name of the experiment.

    + *

    The name of the work team to return a description of.

    */ - ExperimentName?: string; + WorkteamName: string | undefined; +} +/** + * @public + *

    Provides details about a labeling work team.

    + */ +export interface Workteam { /** * @public - *

    The Amazon Resource Name (ARN) of the experiment.

    + *

    The name of the work team.

    */ - ExperimentArn?: string; + WorkteamName: string | undefined; /** * @public - *

    The name of the experiment as displayed. If DisplayName isn't specified, - * ExperimentName is displayed.

    + *

    A list of MemberDefinition objects that contains objects that identify + * the workers that make up the work team.

    + *

    Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). + * For private workforces created using Amazon Cognito use + * CognitoMemberDefinition. For workforces created using your own OIDC identity + * provider (IdP) use OidcMemberDefinition.

    */ - DisplayName?: string; + MemberDefinitions: MemberDefinition[] | undefined; /** * @public - *

    The source of the experiment.

    + *

    The Amazon Resource Name (ARN) that identifies the work team.

    */ - Source?: ExperimentSource; + WorkteamArn: string | undefined; /** * @public - *

    The description of the experiment.

    + *

    The Amazon Resource Name (ARN) of the workforce.

    */ - Description?: string; + WorkforceArn?: string; /** * @public - *

    When the experiment was created.

    + *

    The Amazon Marketplace identifier for a vendor's work team.

    */ - CreationTime?: Date; + ProductListingIds?: string[]; /** * @public - *

    Who created the experiment.

    + *

    A description of the work team.

    */ - CreatedBy?: UserContext; + Description: string | undefined; /** * @public - *

    When the experiment was last modified.

    + *

    The URI of the labeling job's user interface. Workers open this URI to start labeling + * your data objects.

    */ - LastModifiedTime?: Date; + SubDomain?: string; /** * @public - *

    Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.

    + *

    The date and time that the work team was created (timestamp).

    */ - LastModifiedBy?: UserContext; + CreateDate?: Date; /** * @public - *

    The list of tags that are associated with the experiment. You can use Search API to search on the tags.

    + *

    The date and time that the work team was last updated (timestamp).

    */ - Tags?: Tag[]; + LastUpdatedDate?: Date; + + /** + * @public + *

    Configures SNS notifications of available or expiring work items for work + * teams.

    + */ + NotificationConfiguration?: NotificationConfiguration; } /** * @public - *

    A summary of the properties of an experiment. To get the complete set of properties, call - * the DescribeExperiment API and provide the - * ExperimentName.

    */ -export interface ExperimentSummary { +export interface DescribeWorkteamResponse { /** * @public - *

    The Amazon Resource Name (ARN) of the experiment.

    + *

    A Workteam instance that contains information about the work team. + *

    */ - ExperimentArn?: string; + Workteam: Workteam | undefined; +} +/** + * @public + *

    Specifies the serverless update concurrency configuration for an endpoint variant.

    + */ +export interface ProductionVariantServerlessUpdateConfig { /** * @public - *

    The name of the experiment.

    + *

    The updated maximum number of concurrent invocations your serverless endpoint can process.

    */ - ExperimentName?: string; + MaxConcurrency?: number; /** * @public - *

    The name of the experiment as displayed. If DisplayName isn't specified, - * ExperimentName is displayed.

    + *

    The updated amount of provisioned concurrency to allocate for the serverless endpoint. + * Should be less than or equal to MaxConcurrency.

    */ - DisplayName?: string; + ProvisionedConcurrency?: number; +} +/** + * @public + *

    Specifies weight and capacity values for a production variant.

    + */ +export interface DesiredWeightAndCapacity { /** * @public - *

    The source of the experiment.

    + *

    The name of the variant to update.

    */ - ExperimentSource?: ExperimentSource; + VariantName: string | undefined; /** * @public - *

    When the experiment was created.

    + *

    The variant's weight.

    */ - CreationTime?: Date; + DesiredWeight?: number; /** * @public - *

    When the experiment was last modified.

    + *

    The variant's capacity.

    */ - LastModifiedTime?: Date; + DesiredInstanceCount?: number; + + /** + * @public + *

    Specifies the serverless update concurrency configuration for an endpoint variant.

    + */ + ServerlessUpdateConfig?: ProductionVariantServerlessUpdateConfig; } /** * @public - *

    The container for the metadata for Fail step.

    + *

    Information of a particular device.

    */ -export interface FailStepMetadata { +export interface Device { /** * @public - *

    A message that you define and then is processed and rendered by - * the Fail step when the error occurs.

    + *

    The name of the device.

    */ - ErrorMessage?: string; + DeviceName: string | undefined; + + /** + * @public + *

    Description of the device.

    + */ + Description?: string; + + /** + * @public + *

    Amazon Web Services Internet of Things (IoT) object name.

    + */ + IotThingName?: string; } /** * @public - *

    Amazon SageMaker Feature Store stores features in a collection called Feature Group. A - * Feature Group can be visualized as a table which has rows, with a unique identifier for - * each row where each column in the table is a feature. In principle, a Feature Group is - * composed of features and values per features.

    + * @enum */ -export interface FeatureGroup { +export const DeviceDeploymentStatus = { + Deployed: "DEPLOYED", + Failed: "FAILED", + InProgress: "INPROGRESS", + ReadyToDeploy: "READYTODEPLOY", + Stopped: "STOPPED", + Stopping: "STOPPING", +} as const; + +/** + * @public + */ +export type DeviceDeploymentStatus = (typeof DeviceDeploymentStatus)[keyof typeof DeviceDeploymentStatus]; + +/** + * @public + *

    Contains information summarizing device details and deployment status.

    + */ +export interface DeviceDeploymentSummary { /** * @public - *

    The Amazon Resource Name (ARN) of a FeatureGroup.

    + *

    The ARN of the edge deployment plan.

    */ - FeatureGroupArn?: string; + EdgeDeploymentPlanArn: string | undefined; /** * @public - *

    The name of the FeatureGroup.

    + *

    The name of the edge deployment plan.

    */ - FeatureGroupName?: string; + EdgeDeploymentPlanName: string | undefined; /** * @public - *

    The name of the Feature whose value uniquely identifies a - * Record defined in the FeatureGroup - * FeatureDefinitions.

    + *

    The name of the stage in the edge deployment plan.

    */ - RecordIdentifierFeatureName?: string; + StageName: string | undefined; /** * @public - *

    The name of the feature that stores the EventTime of a Record in a - * FeatureGroup.

    - *

    A EventTime is point in time when a new event occurs that corresponds to - * the creation or update of a Record in FeatureGroup. All - * Records in the FeatureGroup must have a corresponding - * EventTime.

    + *

    The name of the deployed stage.

    */ - EventTimeFeatureName?: string; + DeployedStageName?: string; /** * @public - *

    A list of Features. Each Feature must include a - * FeatureName and a FeatureType.

    - *

    Valid FeatureTypes are Integral, Fractional and - * String.

    - *

    - * FeatureNames cannot be any of the following: is_deleted, - * write_time, api_invocation_time.

    - *

    You can create up to 2,500 FeatureDefinitions per - * FeatureGroup.

    + *

    The name of the fleet to which the device belongs to.

    */ - FeatureDefinitions?: FeatureDefinition[]; + DeviceFleetName?: string; /** * @public - *

    The time a FeatureGroup was created.

    + *

    The name of the device.

    + */ + DeviceName: string | undefined; + + /** + * @public + *

    The ARN of the device.

    + */ + DeviceArn: string | undefined; + + /** + * @public + *

    The deployment status of the device.

    + */ + DeviceDeploymentStatus?: DeviceDeploymentStatus; + + /** + * @public + *

    The detailed error message for the deployoment status result.

    + */ + DeviceDeploymentStatusMessage?: string; + + /** + * @public + *

    The description of the device.

    + */ + Description?: string; + + /** + * @public + *

    The time when the deployment on the device started.

    + */ + DeploymentStartTime?: Date; +} + +/** + * @public + *

    Summary of the device fleet.

    + */ +export interface DeviceFleetSummary { + /** + * @public + *

    Amazon Resource Name (ARN) of the device fleet.

    + */ + DeviceFleetArn: string | undefined; + + /** + * @public + *

    Name of the device fleet.

    + */ + DeviceFleetName: string | undefined; + + /** + * @public + *

    Timestamp of when the device fleet was created.

    */ CreationTime?: Date; /** * @public - *

    A timestamp indicating the last time you updated the feature group.

    + *

    Timestamp of when the device fleet was last updated.

    */ LastModifiedTime?: Date; +} +/** + * @public + *

    Status of devices.

    + */ +export interface DeviceStats { /** * @public - *

    Use this to specify the Amazon Web Services Key Management Service (KMS) Key ID, or - * KMSKeyId, for at rest data encryption. You can turn - * OnlineStore on or off by specifying the EnableOnlineStore flag - * at General Assembly.

    - *

    The default value is False.

    + *

    The number of devices connected with a heartbeat.

    */ - OnlineStoreConfig?: OnlineStoreConfig; + ConnectedDeviceCount: number | undefined; /** * @public - *

    The configuration of an OfflineStore.

    - *

    Provide an OfflineStoreConfig in a request to - * CreateFeatureGroup to create an OfflineStore.

    - *

    To encrypt an OfflineStore using at rest data encryption, specify Amazon Web Services Key Management Service (KMS) key ID, or KMSKeyId, in - * S3StorageConfig.

    + *

    The number of registered devices.

    */ - OfflineStoreConfig?: OfflineStoreConfig; + RegisteredDeviceCount: number | undefined; +} +/** + * @public + *

    Summary of model on edge device.

    + */ +export interface EdgeModelSummary { /** * @public - *

    The Amazon Resource Name (ARN) of the IAM execution role used to create the feature - * group.

    + *

    The name of the model.

    */ - RoleArn?: string; + ModelName: string | undefined; /** * @public - *

    A FeatureGroup status.

    + *

    The version model.

    */ - FeatureGroupStatus?: FeatureGroupStatus; + ModelVersion: string | undefined; +} + +/** + * @public + *

    Summary of the device.

    + */ +export interface DeviceSummary { + /** + * @public + *

    The unique identifier of the device.

    + */ + DeviceName: string | undefined; /** * @public - *

    The status of OfflineStore.

    + *

    Amazon Resource Name (ARN) of the device.

    */ - OfflineStoreStatus?: OfflineStoreStatus; + DeviceArn: string | undefined; /** * @public - *

    A value that indicates whether the feature group was updated successfully.

    + *

    A description of the device.

    */ - LastUpdateStatus?: LastUpdateStatus; + Description?: string; /** * @public - *

    The reason that the FeatureGroup failed to be replicated in the - * OfflineStore. This is failure may be due to a failure to create a - * FeatureGroup in or delete a FeatureGroup from the - * OfflineStore.

    + *

    The name of the fleet the device belongs to.

    */ - FailureReason?: string; + DeviceFleetName?: string; /** * @public - *

    A free form description of a FeatureGroup.

    + *

    The Amazon Web Services Internet of Things (IoT) object thing name associated with the device..

    */ - Description?: string; + IotThingName?: string; /** * @public - *

    Tags used to define a FeatureGroup.

    + *

    The timestamp of the last registration or de-reregistration.

    */ - Tags?: Tag[]; + RegistrationTime?: Date; + + /** + * @public + *

    The last heartbeat received from the device.

    + */ + LatestHeartbeat?: Date; + + /** + * @public + *

    Models on the device.

    + */ + Models?: EdgeModelSummary[]; + + /** + * @public + *

    Edge Manager agent version.

    + */ + AgentVersion?: string; } /** * @public * @enum */ -export const FeatureGroupSortBy = { - CREATION_TIME: "CreationTime", - FEATURE_GROUP_STATUS: "FeatureGroupStatus", - NAME: "Name", - OFFLINE_STORE_STATUS: "OfflineStoreStatus", +export const Direction = { + ASCENDANTS: "Ascendants", + BOTH: "Both", + DESCENDANTS: "Descendants", } as const; /** * @public */ -export type FeatureGroupSortBy = (typeof FeatureGroupSortBy)[keyof typeof FeatureGroupSortBy]; +export type Direction = (typeof Direction)[keyof typeof Direction]; /** * @public - * @enum */ -export const FeatureGroupSortOrder = { - ASCENDING: "Ascending", - DESCENDING: "Descending", -} as const; +export interface DisableSagemakerServicecatalogPortfolioInput {} /** * @public */ -export type FeatureGroupSortOrder = (typeof FeatureGroupSortOrder)[keyof typeof FeatureGroupSortOrder]; +export interface DisableSagemakerServicecatalogPortfolioOutput {} /** * @public - *

    The name, ARN, CreationTime, FeatureGroup values, - * LastUpdatedTime and EnableOnlineStorage status of a - * FeatureGroup.

    */ -export interface FeatureGroupSummary { +export interface DisassociateTrialComponentRequest { /** * @public - *

    The name of FeatureGroup.

    - */ - FeatureGroupName: string | undefined; - - /** - * @public - *

    Unique identifier for the FeatureGroup.

    + *

    The name of the component to disassociate from the trial.

    */ - FeatureGroupArn: string | undefined; + TrialComponentName: string | undefined; /** * @public - *

    A timestamp indicating the time of creation time of the - * FeatureGroup.

    + *

    The name of the trial to disassociate from.

    */ - CreationTime: Date | undefined; + TrialName: string | undefined; +} +/** + * @public + */ +export interface DisassociateTrialComponentResponse { /** * @public - *

    The status of a FeatureGroup. The status can be any of the following: - * Creating, Created, CreateFail, - * Deleting or DetailFail.

    + *

    The Amazon Resource Name (ARN) of the trial component.

    */ - FeatureGroupStatus?: FeatureGroupStatus; + TrialComponentArn?: string; /** * @public - *

    Notifies you if replicating data into the OfflineStore has failed. Returns - * either: Active or Blocked.

    + *

    The Amazon Resource Name (ARN) of the trial.

    */ - OfflineStoreStatus?: OfflineStoreStatus; + TrialArn?: string; } /** * @public - *

    The metadata for a feature. It can either be metadata that you specify, or metadata that - * is updated automatically.

    + *

    The domain's details.

    */ -export interface FeatureMetadata { +export interface DomainDetails { /** * @public - *

    The Amazon Resource Number (ARN) of the feature group.

    + *

    The domain's Amazon Resource Name (ARN).

    */ - FeatureGroupArn?: string; + DomainArn?: string; /** * @public - *

    The name of the feature group containing the feature.

    + *

    The domain ID.

    */ - FeatureGroupName?: string; + DomainId?: string; /** * @public - *

    The name of feature.

    + *

    The domain name.

    */ - FeatureName?: string; + DomainName?: string; /** * @public - *

    The data type of the feature.

    + *

    The status.

    */ - FeatureType?: FeatureType; + Status?: DomainStatus; /** * @public - *

    A timestamp indicating when the feature was created.

    + *

    The creation time.

    */ CreationTime?: Date; /** * @public - *

    A timestamp indicating when the feature was last modified.

    + *

    The last modified time.

    */ LastModifiedTime?: Date; /** * @public - *

    An optional description that you specify to better describe the feature.

    + *

    The domain's URL.

    */ - Description?: string; - - /** - * @public - *

    Optional key-value pairs that you specify to better describe the feature.

    - */ - Parameters?: FeatureParameter[]; -} - -/** - * @public - * @enum - */ -export const Operator = { - CONTAINS: "Contains", - EQUALS: "Equals", - EXISTS: "Exists", - GREATER_THAN: "GreaterThan", - GREATER_THAN_OR_EQUAL_TO: "GreaterThanOrEqualTo", - IN: "In", - LESS_THAN: "LessThan", - LESS_THAN_OR_EQUAL_TO: "LessThanOrEqualTo", - NOT_EQUALS: "NotEquals", - NOT_EXISTS: "NotExists", -} as const; + Url?: string; +} /** * @public + *

    A collection of settings that update the current configuration for the + * RStudioServerPro Domain-level app.

    */ -export type Operator = (typeof Operator)[keyof typeof Operator]; +export interface RStudioServerProDomainSettingsForUpdate { + /** + * @public + *

    The execution role for the RStudioServerPro Domain-level app.

    + */ + DomainExecutionRoleArn: string | undefined; -/** - * @public - *

    A conditional statement for a search expression that includes a resource property, a - * Boolean operator, and a value. Resources that match the statement are returned in the - * results from the Search API.

    - *

    If you specify a Value, but not an Operator, SageMaker uses the - * equals operator.

    - *

    In search, there are several property types:

    - *
    - *
    Metrics
    - *
    - *

    To define a metric filter, enter a value using the form - * "Metrics.", where is - * a metric name. For example, the following filter searches for training jobs - * with an "accuracy" metric greater than - * "0.9":

    - *

    - * \{ - *

    - *

    - * "Name": "Metrics.accuracy", - *

    - *

    - * "Operator": "GreaterThan", - *

    - *

    - * "Value": "0.9" - *

    - *

    - * \} - *

    - *
    - *
    HyperParameters
    - *
    - *

    To define a hyperparameter filter, enter a value with the form - * "HyperParameters.". Decimal hyperparameter - * values are treated as a decimal in a comparison if the specified - * Value is also a decimal value. If the specified - * Value is an integer, the decimal hyperparameter values are - * treated as integers. For example, the following filter is satisfied by - * training jobs with a "learning_rate" hyperparameter that is - * less than "0.5":

    - *

    - * \{ - *

    - *

    - * "Name": "HyperParameters.learning_rate", - *

    - *

    - * "Operator": "LessThan", - *

    - *

    - * "Value": "0.5" - *

    - *

    - * \} - *

    - *
    - *
    Tags
    - *
    - *

    To define a tag filter, enter a value with the form - * Tags..

    - *
    - *
    - */ -export interface Filter { /** * @public - *

    A resource property name. For example, TrainingJobName. For - * valid property names, see SearchRecord. - * You must specify a valid property for the resource.

    + *

    Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that + * the version runs on.

    */ - Name: string | undefined; + DefaultResourceSpec?: ResourceSpec; /** * @public - *

    A Boolean binary operator that is used to evaluate the filter. The operator field - * contains one of the following values:

    - *
    - *
    Equals
    - *
    - *

    The value of Name equals Value.

    - *
    - *
    NotEquals
    - *
    - *

    The value of Name doesn't equal Value.

    - *
    - *
    Exists
    - *
    - *

    The Name property exists.

    - *
    - *
    NotExists
    - *
    - *

    The Name property does not exist.

    - *
    - *
    GreaterThan
    - *
    - *

    The value of Name is greater than Value. - * Not supported for text properties.

    - *
    - *
    GreaterThanOrEqualTo
    - *
    - *

    The value of Name is greater than or equal to Value. - * Not supported for text properties.

    - *
    - *
    LessThan
    - *
    - *

    The value of Name is less than Value. - * Not supported for text properties.

    - *
    - *
    LessThanOrEqualTo
    - *
    - *

    The value of Name is less than or equal to Value. - * Not supported for text properties.

    - *
    - *
    In
    - *
    - *

    The value of Name is one of the comma delimited strings in - * Value. Only supported for text properties.

    - *
    - *
    Contains
    - *
    - *

    The value of Name contains the string Value. - * Only supported for text properties.

    - *

    A SearchExpression can include the Contains operator - * multiple times when the value of Name is one of the following:

    - *
      - *
    • - *

      - * Experiment.DisplayName - *

      - *
      • - *
    • - *

      - * Experiment.ExperimentName - *

      - *
      • - *
    • - *

      - * Experiment.Tags - *

      - *
      • - *
    • - *

      - * Trial.DisplayName - *

      - *
      • - *
    • - *

      - * Trial.TrialName - *

      - *
      • - *
    • - *

      - * Trial.Tags - *

      - *
      • - *
    • - *

      - * TrialComponent.DisplayName - *

      - *
      • - *
    • - *

      - * TrialComponent.TrialComponentName - *

      - *
      • - *
    • - *

      - * TrialComponent.Tags - *

      - *
      • - *
    • - *

      - * TrialComponent.InputArtifacts - *

      - *
      • - *
    • - *

      - * TrialComponent.OutputArtifacts - *

      - *
      • - *
    - *

    A SearchExpression can include only one Contains operator - * for all other values of Name. In these cases, if you include multiple - * Contains operators in the SearchExpression, the result is - * the following error message: "'CONTAINS' operator usage limit of 1 - * exceeded."

    - *
    - *
    + *

    A URL pointing to an RStudio Connect server.

    */ - Operator?: Operator; + RStudioConnectUrl?: string; /** * @public - *

    A value used with Name and Operator to determine which - * resources satisfy the filter's condition. For numerical properties, Value - * must be an integer or floating-point decimal. For timestamp properties, - * Value must be an ISO 8601 date-time string of the following format: - * YYYY-mm-dd'T'HH:MM:SS.

    + *

    A URL pointing to an RStudio Package Manager server.

    */ - Value?: string; + RStudioPackageManagerUrl?: string; } /** * @public - *

    Contains summary information about the flow definition.

    + *

    A collection of Domain configuration settings to update.

    */ -export interface FlowDefinitionSummary { - /** - * @public - *

    The name of the flow definition.

    - */ - FlowDefinitionName: string | undefined; - - /** - * @public - *

    The Amazon Resource Name (ARN) of the flow definition.

    - */ - FlowDefinitionArn: string | undefined; - +export interface DomainSettingsForUpdate { /** * @public - *

    The status of the flow definition. Valid values:

    + *

    A collection of RStudioServerPro Domain-level app settings to update. A + * single RStudioServerPro application is created for a domain.

    */ - FlowDefinitionStatus: FlowDefinitionStatus | undefined; + RStudioServerProDomainSettingsForUpdate?: RStudioServerProDomainSettingsForUpdate; /** * @public - *

    The timestamp when SageMaker created the flow definition.

    + *

    The configuration for attaching a SageMaker user profile name to the execution role as a + * sts:SourceIdentity key. This configuration can only be modified if there + * are no apps in the InService or Pending state.

    */ - CreationTime: Date | undefined; + ExecutionRoleIdentityConfig?: ExecutionRoleIdentityConfig; /** * @public - *

    The reason why the flow definition creation failed. A failure reason is returned only when the flow definition status is Failed.

    + *

    The security groups for the Amazon Virtual Private Cloud that the Domain uses for + * communication between Domain-level apps and user apps.

    */ - FailureReason?: string; + SecurityGroupIds?: string[]; } /** * @public + *

    A specification for a predefined metric.

    */ -export interface GetDeviceFleetReportRequest { +export interface PredefinedMetricSpecification { /** * @public - *

    The name of the fleet.

    + *

    The metric type. You can only apply SageMaker metric types to SageMaker endpoints.

    */ - DeviceFleetName: string | undefined; + PredefinedMetricType?: string; } /** * @public + *

    An object containing information about a metric.

    */ -export interface GetDeviceFleetReportResponse { - /** - * @public - *

    The Amazon Resource Name (ARN) of the device.

    - */ - DeviceFleetArn: string | undefined; +export type MetricSpecification = + | MetricSpecification.CustomizedMember + | MetricSpecification.PredefinedMember + | MetricSpecification.$UnknownMember; +/** + * @public + */ +export namespace MetricSpecification { /** * @public - *

    The name of the fleet.

    + *

    Information about a predefined metric.

    */ - DeviceFleetName: string | undefined; + export interface PredefinedMember { + Predefined: PredefinedMetricSpecification; + Customized?: never; + $unknown?: never; + } /** * @public - *

    The output configuration for storing sample data collected by the fleet.

    + *

    Information about a customized metric.

    */ - OutputConfig?: EdgeOutputConfig; + export interface CustomizedMember { + Predefined?: never; + Customized: CustomizedMetricSpecification; + $unknown?: never; + } /** * @public - *

    Description of the fleet.

    */ - Description?: string; + export interface $UnknownMember { + Predefined?: never; + Customized?: never; + $unknown: [string, any]; + } - /** - * @public - *

    Timestamp of when the report was generated.

    - */ - ReportGenerated?: Date; + export interface Visitor { + Predefined: (value: PredefinedMetricSpecification) => T; + Customized: (value: CustomizedMetricSpecification) => T; + _: (name: string, value: any) => T; + } - /** - * @public - *

    Status of devices.

    - */ - DeviceStats?: DeviceStats; + export const visit = (value: MetricSpecification, visitor: Visitor): T => { + if (value.Predefined !== undefined) return visitor.Predefined(value.Predefined); + if (value.Customized !== undefined) return visitor.Customized(value.Customized); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; +} +/** + * @public + *

    A target tracking scaling policy. Includes support for predefined or customized metrics.

    + *

    When using the PutScalingPolicy API, + * this parameter is required when you are creating a policy with the policy type TargetTrackingScaling.

    + */ +export interface TargetTrackingScalingPolicyConfiguration { /** * @public - *

    The versions of Edge Manager agent deployed on the fleet.

    + *

    An object containing information about a metric.

    */ - AgentVersions?: AgentVersion[]; + MetricSpecification?: MetricSpecification; /** * @public - *

    Status of model on device.

    + *

    The recommended target value to specify for the metric when creating a scaling policy.

    */ - ModelStats?: EdgeModelStat[]; + TargetValue?: number; } /** * @public + *

    An object containing a recommended scaling policy.

    */ -export interface GetLineageGroupPolicyRequest { - /** - * @public - *

    The name or Amazon Resource Name (ARN) of the lineage group.

    - */ - LineageGroupName: string | undefined; -} +export type ScalingPolicy = ScalingPolicy.TargetTrackingMember | ScalingPolicy.$UnknownMember; /** * @public */ -export interface GetLineageGroupPolicyResponse { +export namespace ScalingPolicy { /** * @public - *

    The Amazon Resource Name (ARN) of the lineage group.

    + *

    A target tracking scaling policy. Includes support for predefined or customized metrics.

    */ - LineageGroupArn?: string; + export interface TargetTrackingMember { + TargetTracking: TargetTrackingScalingPolicyConfiguration; + $unknown?: never; + } /** * @public - *

    The resource policy that gives access to the lineage group in another account.

    */ - ResourcePolicy?: string; + export interface $UnknownMember { + TargetTracking?: never; + $unknown: [string, any]; + } + + export interface Visitor { + TargetTracking: (value: TargetTrackingScalingPolicyConfiguration) => T; + _: (name: string, value: any) => T; + } + + export const visit = (value: ScalingPolicy, visitor: Visitor): T => { + if (value.TargetTracking !== undefined) return visitor.TargetTracking(value.TargetTracking); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; } /** * @public + *

    An object with the recommended values for you to specify when creating an autoscaling policy.

    */ -export interface GetModelPackageGroupPolicyInput { +export interface DynamicScalingConfiguration { /** * @public - *

    The name of the model group for which to get the resource policy.

    + *

    The recommended minimum capacity to specify for your autoscaling policy.

    */ - ModelPackageGroupName: string | undefined; -} + MinCapacity?: number; -/** - * @public - */ -export interface GetModelPackageGroupPolicyOutput { /** * @public - *

    The resource policy for the model group.

    + *

    The recommended maximum capacity to specify for your autoscaling policy.

    */ - ResourcePolicy: string | undefined; -} - -/** - * @public - */ -export interface GetSagemakerServicecatalogPortfolioStatusInput {} + MaxCapacity?: number; -/** - * @public - * @enum - */ -export const SagemakerServicecatalogStatus = { - DISABLED: "Disabled", - ENABLED: "Enabled", -} as const; + /** + * @public + *

    The recommended scale in cooldown time for your autoscaling policy.

    + */ + ScaleInCooldown?: number; -/** - * @public - */ -export type SagemakerServicecatalogStatus = - (typeof SagemakerServicecatalogStatus)[keyof typeof SagemakerServicecatalogStatus]; + /** + * @public + *

    The recommended scale out cooldown time for your autoscaling policy.

    + */ + ScaleOutCooldown?: number; -/** - * @public - */ -export interface GetSagemakerServicecatalogPortfolioStatusOutput { /** * @public - *

    Whether Service Catalog is enabled or disabled in SageMaker.

    + *

    An object of the scaling policies for each metric.

    */ - Status?: SagemakerServicecatalogStatus; + ScalingPolicies?: ScalingPolicy[]; } /** * @public - *

    An object where you specify the anticipated traffic pattern for an endpoint.

    + *

    A directed edge connecting two lineage entities.

    */ -export interface ScalingPolicyObjective { +export interface Edge { /** * @public - *

    The minimum number of expected requests to your endpoint per minute.

    + *

    The Amazon Resource Name (ARN) of the source lineage entity of the directed edge.

    */ - MinInvocationsPerMinute?: number; + SourceArn?: string; /** * @public - *

    The maximum number of expected requests to your endpoint per minute.

    + *

    The Amazon Resource Name (ARN) of the destination lineage entity of the directed edge.

    */ - MaxInvocationsPerMinute?: number; + DestinationArn?: string; + + /** + * @public + *

    The type of the Association(Edge) between the source and destination. For example ContributedTo, + * Produced, or DerivedFrom.

    + */ + AssociationType?: AssociationEdgeType; } /** * @public + *

    Contains information summarizing an edge deployment plan.

    */ -export interface GetScalingConfigurationRecommendationRequest { +export interface EdgeDeploymentPlanSummary { /** * @public - *

    The name of a previously completed Inference Recommender job.

    + *

    The ARN of the edge deployment plan.

    */ - InferenceRecommendationsJobName: string | undefined; + EdgeDeploymentPlanArn: string | undefined; /** * @public - *

    The recommendation ID of a previously completed inference recommendation. This ID should come from one of the - * recommendations returned by the job specified in the InferenceRecommendationsJobName field.

    - *

    Specify either this field or the EndpointName field.

    + *

    The name of the edge deployment plan.

    */ - RecommendationId?: string; + EdgeDeploymentPlanName: string | undefined; /** * @public - *

    The name of an endpoint benchmarked during a previously completed inference recommendation job. This name should come from one of the - * recommendations returned by the job specified in the InferenceRecommendationsJobName field.

    - *

    Specify either this field or the RecommendationId field.

    + *

    The name of the device fleet used for the deployment.

    */ - EndpointName?: string; + DeviceFleetName: string | undefined; /** * @public - *

    The percentage of how much utilization you want an instance to use before autoscaling. The default value is 50%.

    + *

    The number of edge devices with the successful deployment.

    */ - TargetCpuUtilizationPerCore?: number; + EdgeDeploymentSuccess: number | undefined; /** * @public - *

    An object where you specify the anticipated traffic pattern for an endpoint.

    + *

    The number of edge devices yet to pick up the deployment, or in progress.

    */ - ScalingPolicyObjective?: ScalingPolicyObjective; -} + EdgeDeploymentPending: number | undefined; -/** - * @public - *

    The metric for a scaling policy.

    - */ -export interface ScalingPolicyMetric { /** * @public - *

    The number of invocations sent to a model, normalized by InstanceCount - * in each ProductionVariant. 1/numberOfInstances is sent as the value on each - * request, where numberOfInstances is the number of active instances for the - * ProductionVariant behind the endpoint at the time of the request.

    + *

    The number of edge devices that failed the deployment.

    */ - InvocationsPerInstance?: number; + EdgeDeploymentFailed: number | undefined; /** * @public - *

    The interval of time taken by a model to respond as viewed from SageMaker. - * This interval includes the local communication times taken to send the request - * and to fetch the response from the container of a model and the time taken to - * complete the inference in the container.

    + *

    The time when the edge deployment plan was created.

    */ - ModelLatency?: number; -} + CreationTime?: Date; -/** - * @public - */ -export interface GetScalingConfigurationRecommendationResponse { /** * @public - *

    The name of a previously completed Inference Recommender job.

    + *

    The time when the edge deployment plan was last updated.

    */ - InferenceRecommendationsJobName?: string; + LastModifiedTime?: Date; +} +/** + * @public + *

    Status of edge devices with this model.

    + */ +export interface EdgeModelStat { /** * @public - *

    The recommendation ID of a previously completed inference recommendation.

    + *

    The name of the model.

    */ - RecommendationId?: string; + ModelName: string | undefined; /** * @public - *

    The name of an endpoint benchmarked during a previously completed Inference Recommender job.

    + *

    The model version.

    */ - EndpointName?: string; + ModelVersion: string | undefined; /** * @public - *

    The percentage of how much utilization you want an instance to use before autoscaling, which you specified in the request. The default value is 50%.

    + *

    The number of devices that have this model version and do not have a heart beat.

    */ - TargetCpuUtilizationPerCore?: number; + OfflineDeviceCount: number | undefined; /** * @public - *

    An object representing the anticipated traffic pattern for an endpoint that you specified in the request.

    + *

    The number of devices that have this model version and have a heart beat.

    */ - ScalingPolicyObjective?: ScalingPolicyObjective; + ConnectedDeviceCount: number | undefined; /** * @public - *

    An object with a list of metrics that were benchmarked during the previously completed Inference Recommender job.

    + *

    The number of devices that have this model version, a heart beat, and are currently running.

    */ - Metric?: ScalingPolicyMetric; + ActiveDeviceCount: number | undefined; /** * @public - *

    An object with the recommended values for you to specify when creating an autoscaling policy.

    + *

    The number of devices with this model version and are producing sample data.

    */ - DynamicScalingConfiguration?: DynamicScalingConfiguration; + SamplingDeviceCount: number | undefined; } /** * @public - * @enum - */ -export const ResourceType = { - ENDPOINT: "Endpoint", - EXPERIMENT: "Experiment", - EXPERIMENT_TRIAL: "ExperimentTrial", - EXPERIMENT_TRIAL_COMPONENT: "ExperimentTrialComponent", - FEATURE_GROUP: "FeatureGroup", - FEATURE_METADATA: "FeatureMetadata", - HYPER_PARAMETER_TUNING_JOB: "HyperParameterTuningJob", - MODEL: "Model", - MODEL_CARD: "ModelCard", - MODEL_PACKAGE: "ModelPackage", - MODEL_PACKAGE_GROUP: "ModelPackageGroup", - PIPELINE: "Pipeline", - PIPELINE_EXECUTION: "PipelineExecution", - PROJECT: "Project", - TRAINING_JOB: "TrainingJob", -} as const; - -/** - * @public + *

    Summary of edge packaging job.

    */ -export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType]; +export interface EdgePackagingJobSummary { + /** + * @public + *

    The Amazon Resource Name (ARN) of the edge packaging job.

    + */ + EdgePackagingJobArn: string | undefined; -/** - * @public - *

    Part of the SuggestionQuery type. Specifies a hint for retrieving property - * names that begin with the specified text.

    - */ -export interface PropertyNameQuery { /** * @public - *

    Text that begins a property's name.

    + *

    The name of the edge packaging job.

    */ - PropertyNameHint: string | undefined; -} + EdgePackagingJobName: string | undefined; -/** - * @public - *

    Specified in the GetSearchSuggestions request. - * Limits the property names that are included in the response.

    - */ -export interface SuggestionQuery { /** * @public - *

    Defines a property name hint. Only property - * names that begin with the specified hint are included in the response.

    + *

    The status of the edge packaging job.

    */ - PropertyNameQuery?: PropertyNameQuery; -} + EdgePackagingJobStatus: EdgePackagingJobStatus | undefined; -/** - * @public - */ -export interface GetSearchSuggestionsRequest { /** * @public - *

    The name of the SageMaker resource to search for.

    + *

    The name of the SageMaker Neo compilation job.

    */ - Resource: ResourceType | undefined; + CompilationJobName?: string; /** * @public - *

    Limits the property names that are included in the response.

    + *

    The name of the model.

    */ - SuggestionQuery?: SuggestionQuery; -} + ModelName?: string; -/** - * @public - *

    A property name returned from a GetSearchSuggestions call that specifies - * a value in the PropertyNameQuery field.

    - */ -export interface PropertyNameSuggestion { /** * @public - *

    A suggested property name based on what you entered in the search textbox in the SageMaker - * console.

    + *

    The version of the model.

    */ - PropertyName?: string; -} + ModelVersion?: string; -/** - * @public - */ -export interface GetSearchSuggestionsResponse { /** * @public - *

    A list of property names for a Resource that match a - * SuggestionQuery.

    + *

    The timestamp of when the job was created.

    */ - PropertyNameSuggestions?: PropertyNameSuggestion[]; -} + CreationTime?: Date; -/** - * @public - *

    Specifies configuration details for a Git repository when the repository is - * updated.

    - */ -export interface GitConfigForUpdate { /** * @public - *

    The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that - * contains the credentials used to access the git repository. The secret must have a - * staging label of AWSCURRENT and must be in the following format:

    - *

    - * \{"username": UserName, "password": - * Password\} - *

    + *

    The timestamp of when the edge packaging job was last updated.

    */ - SecretArn?: string; + LastModifiedTime?: Date; } /** * @public - *

    Information about hub content.

    + *

    The configurations and outcomes of an Amazon EMR step execution.

    */ -export interface HubContentInfo { +export interface EMRStepMetadata { /** * @public - *

    The name of the hub content.

    - */ - HubContentName: string | undefined; - - /** - * @public - *

    The Amazon Resource Name (ARN) of the hub content.

    + *

    The identifier of the EMR cluster.

    */ - HubContentArn: string | undefined; + ClusterId?: string; /** * @public - *

    The version of the hub content.

    + *

    The identifier of the EMR cluster step.

    */ - HubContentVersion: string | undefined; + StepId?: string; /** * @public - *

    The type of hub content.

    + *

    The name of the EMR cluster step.

    */ - HubContentType: HubContentType | undefined; + StepName?: string; /** * @public - *

    The version of the hub content document schema.

    + *

    The path to the log file where the cluster step's failure root cause + * is recorded.

    */ - DocumentSchemaVersion: string | undefined; - - /** - * @public - *

    The display name of the hub content.

    - */ - HubContentDisplayName?: string; - - /** - * @public - *

    A description of the hub content.

    - */ - HubContentDescription?: string; - - /** - * @public - *

    The searchable keywords for the hub content.

    - */ - HubContentSearchKeywords?: string[]; - - /** - * @public - *

    The status of the hub content.

    - */ - HubContentStatus: HubContentStatus | undefined; - - /** - * @public - *

    The date and time that the hub content was created.

    - */ - CreationTime: Date | undefined; -} + LogFilePath?: string; +} /** * @public - * @enum */ -export const HubContentSortBy = { - CREATION_TIME: "CreationTime", - HUB_CONTENT_NAME: "HubContentName", - HUB_CONTENT_STATUS: "HubContentStatus", -} as const; +export interface EnableSagemakerServicecatalogPortfolioInput {} /** * @public */ -export type HubContentSortBy = (typeof HubContentSortBy)[keyof typeof HubContentSortBy]; +export interface EnableSagemakerServicecatalogPortfolioOutput {} /** * @public - *

    Information about a hub.

    + *

    A schedule for a model monitoring job. For information about model monitor, see + * Amazon SageMaker Model + * Monitor.

    */ -export interface HubInfo { +export interface MonitoringSchedule { /** * @public - *

    The name of the hub.

    + *

    The Amazon Resource Name (ARN) of the monitoring schedule.

    */ - HubName: string | undefined; + MonitoringScheduleArn?: string; /** * @public - *

    The Amazon Resource Name (ARN) of the hub.

    + *

    The name of the monitoring schedule.

    */ - HubArn: string | undefined; + MonitoringScheduleName?: string; /** * @public - *

    The display name of the hub.

    + *

    The status of the monitoring schedule. This can be one of the following values.

    + *
      + *
    • + *

      + * PENDING - The schedule is pending being created.

      + *
      • + *
    • + *

      + * FAILED - The schedule failed.

      + *
      • + *
    • + *

      + * SCHEDULED - The schedule was successfully created.

      + *
      • + *
    • + *

      + * STOPPED - The schedule was stopped.

      + *
      • + *
    */ - HubDisplayName?: string; + MonitoringScheduleStatus?: ScheduleStatus; /** * @public - *

    A description of the hub.

    + *

    The type of the monitoring job definition to schedule.

    */ - HubDescription?: string; + MonitoringType?: MonitoringType; /** * @public - *

    The searchable keywords for the hub.

    + *

    If the monitoring schedule failed, the reason it failed.

    */ - HubSearchKeywords?: string[]; + FailureReason?: string; /** * @public - *

    The status of the hub.

    + *

    The time that the monitoring schedule was created.

    */ - HubStatus: HubStatus | undefined; + CreationTime?: Date; /** * @public - *

    The date and time that the hub was created.

    + *

    The last time the monitoring schedule was changed.

    */ - CreationTime: Date | undefined; + LastModifiedTime?: Date; /** * @public - *

    The date and time that the hub was last modified.

    + *

    Configures the monitoring schedule and defines the monitoring job.

    */ - LastModifiedTime: Date | undefined; -} - -/** - * @public - * @enum - */ -export const HubSortBy = { - ACCOUNT_ID_OWNER: "AccountIdOwner", - CREATION_TIME: "CreationTime", - HUB_NAME: "HubName", - HUB_STATUS: "HubStatus", -} as const; - -/** - * @public - */ -export type HubSortBy = (typeof HubSortBy)[keyof typeof HubSortBy]; + MonitoringScheduleConfig?: MonitoringScheduleConfig; -/** - * @public - *

    Container for human task user interface information.

    - */ -export interface HumanTaskUiSummary { /** * @public - *

    The name of the human task user interface.

    + *

    The endpoint that hosts the model being monitored.

    */ - HumanTaskUiName: string | undefined; + EndpointName?: string; /** * @public - *

    The Amazon Resource Name (ARN) of the human task user interface.

    + *

    Summary of information about the last monitoring job to run.

    */ - HumanTaskUiArn: string | undefined; + LastMonitoringExecutionSummary?: MonitoringExecutionSummary; /** * @public - *

    A timestamp when SageMaker created the human task user interface.

    + *

    A list of the tags associated with the monitoring schedlue. For more information, see Tagging Amazon Web Services + * resources in the Amazon Web Services General Reference Guide.

    */ - CreationTime: Date | undefined; + Tags?: Tag[]; } /** * @public - *

    An entity returned by the SearchRecord API - * containing the properties of a hyperparameter tuning job.

    + *

    A hosted endpoint for real-time inference.

    */ -export interface HyperParameterTuningJobSearchEntity { - /** - * @public - *

    The name of a hyperparameter tuning job.

    - */ - HyperParameterTuningJobName?: string; - +export interface Endpoint { /** * @public - *

    The Amazon Resource Name (ARN) of a hyperparameter tuning job.

    + *

    The name of the endpoint.

    */ - HyperParameterTuningJobArn?: string; + EndpointName: string | undefined; /** * @public - *

    Configures a hyperparameter tuning job.

    + *

    The Amazon Resource Name (ARN) of the endpoint.

    */ - HyperParameterTuningJobConfig?: HyperParameterTuningJobConfig; + EndpointArn: string | undefined; /** * @public - *

    Defines - * the training jobs launched by a hyperparameter tuning job.

    + *

    The endpoint configuration associated with the endpoint.

    */ - TrainingJobDefinition?: HyperParameterTrainingJobDefinition; + EndpointConfigName: string | undefined; /** * @public - *

    The job definitions included in a hyperparameter tuning job.

    + *

    A list of the production variants hosted on the endpoint. Each production variant is a + * model.

    */ - TrainingJobDefinitions?: HyperParameterTrainingJobDefinition[]; + ProductionVariants?: ProductionVariantSummary[]; /** * @public - *

    The status of a hyperparameter tuning job.

    + *

    The currently active data capture configuration used by your Endpoint.

    */ - HyperParameterTuningJobStatus?: HyperParameterTuningJobStatus; + DataCaptureConfig?: DataCaptureConfigSummary; /** * @public - *

    The time that a hyperparameter tuning job was created.

    + *

    The status of the endpoint.

    */ - CreationTime?: Date; + EndpointStatus: EndpointStatus | undefined; /** * @public - *

    The time that a hyperparameter tuning job ended.

    + *

    If the endpoint failed, the reason it failed.

    */ - HyperParameterTuningEndTime?: Date; + FailureReason?: string; /** * @public - *

    The time that a hyperparameter tuning job was last modified.

    + *

    The time that the endpoint was created.

    */ - LastModifiedTime?: Date; + CreationTime: Date | undefined; /** * @public - *

    The numbers of training jobs launched by a hyperparameter tuning job, categorized by - * status.

    + *

    The last time the endpoint was modified.

    */ - TrainingJobStatusCounters?: TrainingJobStatusCounters; + LastModifiedTime: Date | undefined; /** * @public - *

    Specifies the number of training jobs that this hyperparameter tuning job launched, - * categorized by the status of their objective metric. The objective metric status shows - * whether the - * final - * objective metric for the training job has been evaluated by the - * tuning job and used in the hyperparameter tuning process.

    + *

    A list of monitoring schedules for the endpoint. For information about model + * monitoring, see Amazon SageMaker Model Monitor.

    */ - ObjectiveStatusCounters?: ObjectiveStatusCounters; + MonitoringSchedules?: MonitoringSchedule[]; /** * @public - *

    The container for the summary information about a training job.

    + *

    A list of the tags associated with the endpoint. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General + * Reference Guide.

    */ - BestTrainingJob?: HyperParameterTrainingJobSummary; + Tags?: Tag[]; /** * @public - *

    The container for the summary information about a training job.

    + *

    A list of the shadow variants hosted on the endpoint. Each shadow variant is a model + * in shadow mode with production traffic replicated from the production variant.

    */ - OverallBestTrainingJob?: HyperParameterTrainingJobSummary; + ShadowProductionVariants?: ProductionVariantSummary[]; +} - /** - * @public - *

    Specifies the configuration for a hyperparameter tuning job that uses one or more - * previous hyperparameter tuning jobs as a starting point. The results of previous tuning - * jobs are used to inform which combinations of hyperparameters to search over in the new - * tuning job.

    - *

    All training jobs launched by the new hyperparameter tuning job are evaluated by using - * the objective metric, and the training job that performs the best is compared to the - * best training jobs from the parent tuning jobs. From these, the training job that - * performs the best as measured by the objective metric is returned as the overall best - * training job.

    - * - *

    All training jobs launched by parent hyperparameter tuning jobs and the new - * hyperparameter tuning jobs count against the limit of training jobs for the tuning - * job.

    - *     - */ - WarmStartConfig?: HyperParameterTuningJobWarmStartConfig; +/** + * @public + * @enum + */ +export const EndpointConfigSortKey = { + CreationTime: "CreationTime", + Name: "Name", +} as const; - /** - * @public - *

    The error that was created when a hyperparameter tuning job failed.

    - */ - FailureReason?: string; +/** + * @public + */ +export type EndpointConfigSortKey = (typeof EndpointConfigSortKey)[keyof typeof EndpointConfigSortKey]; +/** + * @public + *

    Provides summary information for an endpoint configuration.

    + */ +export interface EndpointConfigSummary { /** * @public - *

    The tags associated with a hyperparameter tuning job. For more information see Tagging Amazon Web Services resources.

    + *

    The name of the endpoint configuration.

    */ - Tags?: Tag[]; + EndpointConfigName: string | undefined; /** * @public - *

    Information about either a current or completed hyperparameter tuning job.

    + *

    The Amazon Resource Name (ARN) of the endpoint configuration.

    */ - TuningJobCompletionDetails?: HyperParameterTuningJobCompletionDetails; + EndpointConfigArn: string | undefined; /** * @public - *

    The total amount of resources consumed by a hyperparameter tuning job.

    + *

    A timestamp that shows when the endpoint configuration was created.

    */ - ConsumedResources?: HyperParameterTuningJobConsumedResources; + CreationTime: Date | undefined; } /** * @public * @enum */ -export const HyperParameterTuningJobSortByOptions = { +export const EndpointSortKey = { CreationTime: "CreationTime", Name: "Name", Status: "Status", @@ -1798,2049 +1541,2437 @@ export const HyperParameterTuningJobSortByOptions = { /** * @public */ -export type HyperParameterTuningJobSortByOptions = - (typeof HyperParameterTuningJobSortByOptions)[keyof typeof HyperParameterTuningJobSortByOptions]; +export type EndpointSortKey = (typeof EndpointSortKey)[keyof typeof EndpointSortKey]; /** * @public - *

    Provides summary information about a hyperparameter tuning job.

    + *

    Provides summary information for an endpoint.

    */ -export interface HyperParameterTuningJobSummary { +export interface EndpointSummary { /** * @public - *

    The name of the tuning job.

    + *

    The name of the endpoint.

    */ - HyperParameterTuningJobName: string | undefined; + EndpointName: string | undefined; /** * @public - *

    The - * Amazon - * Resource Name (ARN) of the tuning job.

    + *

    The Amazon Resource Name (ARN) of the endpoint.

    */ - HyperParameterTuningJobArn: string | undefined; + EndpointArn: string | undefined; /** * @public - *

    The status of the - * tuning - * job.

    + *

    A timestamp that shows when the endpoint was created.

    */ - HyperParameterTuningJobStatus: HyperParameterTuningJobStatus | undefined; + CreationTime: Date | undefined; /** * @public - *

    Specifies the search strategy hyperparameter tuning uses to choose which - * hyperparameters to - * evaluate - * at each iteration.

    + *

    A timestamp that shows when the endpoint was last modified.

    */ - Strategy: HyperParameterTuningJobStrategyType | undefined; + LastModifiedTime: Date | undefined; /** * @public - *

    The date and time that the tuning job was created.

    + *

    The status of the endpoint.

    + *
      + *
    • + *

      + * OutOfService: Endpoint is not available to take incoming + * requests.

      + *
      • + *
    • + *

      + * Creating: CreateEndpoint is executing.

      + *
      • + *
    • + *

      + * Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

      + *
      • + *
    • + *

      + * SystemUpdating: Endpoint is undergoing maintenance and cannot be + * updated or deleted or re-scaled until it has completed. This maintenance + * operation does not change any customer-specified values such as VPC config, KMS + * encryption, model, instance type, or instance count.

      + *
      • + *
    • + *

      + * RollingBack: Endpoint fails to scale up or down or change its + * variant weight and is in the process of rolling back to its previous + * configuration. Once the rollback completes, endpoint returns to an + * InService status. This transitional status only applies to an + * endpoint that has autoscaling enabled and is undergoing variant weight or + * capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called + * explicitly.

      + *
      • + *
    • + *

      + * InService: Endpoint is available to process incoming + * requests.

      + *
      • + *
    • + *

      + * Deleting: DeleteEndpoint is executing.

      + *
      • + *
    • + *

      + * Failed: Endpoint could not be created, updated, or re-scaled. Use + * DescribeEndpointOutput$FailureReason for information about the + * failure. DeleteEndpoint is the only operation that can be performed on a + * failed endpoint.

      + *
      • + *
    + *

    To get a list of endpoints with a specified status, use the StatusEquals + * filter with a call to ListEndpoints.

    */ - CreationTime: Date | undefined; + EndpointStatus: EndpointStatus | undefined; +} +/** + * @public + *

    The properties of an experiment as returned by the Search API.

    + */ +export interface Experiment { /** * @public - *

    The date and time that the tuning job ended.

    + *

    The name of the experiment.

    */ - HyperParameterTuningEndTime?: Date; + ExperimentName?: string; /** * @public - *

    The date and time that the tuning job was - * modified.

    + *

    The Amazon Resource Name (ARN) of the experiment.

    */ - LastModifiedTime?: Date; + ExperimentArn?: string; /** * @public - *

    The TrainingJobStatusCounters object that specifies the numbers of training - * jobs, categorized by status, that this tuning job launched.

    + *

    The name of the experiment as displayed. If DisplayName isn't specified, + * ExperimentName is displayed.

    */ - TrainingJobStatusCounters: TrainingJobStatusCounters | undefined; + DisplayName?: string; /** * @public - *

    The ObjectiveStatusCounters object that specifies the numbers of training jobs, - * categorized by objective metric status, that this tuning job launched.

    + *

    The source of the experiment.

    */ - ObjectiveStatusCounters: ObjectiveStatusCounters | undefined; + Source?: ExperimentSource; /** * @public - *

    The ResourceLimits - * object that specifies the maximum number of training jobs and parallel training jobs - * allowed for this tuning job.

    + *

    The description of the experiment.

    */ - ResourceLimits?: ResourceLimits; -} + Description?: string; -/** - * @public - *

    A SageMaker image. A SageMaker image represents a set of container images that are derived from - * a common base container image. Each of these container images is represented by a SageMaker - * ImageVersion.

    - */ -export interface Image { /** * @public - *

    When the image was created.

    + *

    When the experiment was created.

    */ - CreationTime: Date | undefined; + CreationTime?: Date; /** * @public - *

    The description of the image.

    + *

    Who created the experiment.

    */ - Description?: string; + CreatedBy?: UserContext; /** * @public - *

    The name of the image as displayed.

    + *

    When the experiment was last modified.

    */ - DisplayName?: string; + LastModifiedTime?: Date; /** * @public - *

    When a create, update, or delete operation fails, the reason for the failure.

    + *

    Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.

    */ - FailureReason?: string; + LastModifiedBy?: UserContext; /** * @public - *

    The ARN of the image.

    + *

    The list of tags that are associated with the experiment. You can use Search API to search on the tags.

    */ - ImageArn: string | undefined; + Tags?: Tag[]; +} +/** + * @public + *

    A summary of the properties of an experiment. To get the complete set of properties, call + * the DescribeExperiment API and provide the + * ExperimentName.

    + */ +export interface ExperimentSummary { /** * @public - *

    The name of the image.

    + *

    The Amazon Resource Name (ARN) of the experiment.

    */ - ImageName: string | undefined; + ExperimentArn?: string; /** * @public - *

    The status of the image.

    + *

    The name of the experiment.

    */ - ImageStatus: ImageStatus | undefined; + ExperimentName?: string; /** * @public - *

    When the image was last modified.

    + *

    The name of the experiment as displayed. If DisplayName isn't specified, + * ExperimentName is displayed.

    */ - LastModifiedTime: Date | undefined; -} + DisplayName?: string; -/** - * @public - * @enum - */ -export const ImageSortBy = { - CREATION_TIME: "CREATION_TIME", - IMAGE_NAME: "IMAGE_NAME", - LAST_MODIFIED_TIME: "LAST_MODIFIED_TIME", -} as const; + /** + * @public + *

    The source of the experiment.

    + */ + ExperimentSource?: ExperimentSource; -/** - * @public - */ -export type ImageSortBy = (typeof ImageSortBy)[keyof typeof ImageSortBy]; + /** + * @public + *

    When the experiment was created.

    + */ + CreationTime?: Date; -/** - * @public - * @enum - */ -export const ImageSortOrder = { - ASCENDING: "ASCENDING", - DESCENDING: "DESCENDING", -} as const; + /** + * @public + *

    When the experiment was last modified.

    + */ + LastModifiedTime?: Date; +} /** * @public + *

    The container for the metadata for Fail step.

    */ -export type ImageSortOrder = (typeof ImageSortOrder)[keyof typeof ImageSortOrder]; +export interface FailStepMetadata { + /** + * @public + *

    A message that you define and then is processed and rendered by + * the Fail step when the error occurs.

    + */ + ErrorMessage?: string; +} /** * @public - *

    A version of a SageMaker Image. A version represents an existing container - * image.

    + *

    Amazon SageMaker Feature Store stores features in a collection called Feature Group. A + * Feature Group can be visualized as a table which has rows, with a unique identifier for + * each row where each column in the table is a feature. In principle, a Feature Group is + * composed of features and values per features.

    */ -export interface ImageVersion { +export interface FeatureGroup { /** * @public - *

    When the version was created.

    + *

    The Amazon Resource Name (ARN) of a FeatureGroup.

    */ - CreationTime: Date | undefined; + FeatureGroupArn?: string; /** * @public - *

    When a create or delete operation fails, the reason for the failure.

    + *

    The name of the FeatureGroup.

    */ - FailureReason?: string; + FeatureGroupName?: string; /** * @public - *

    The ARN of the image the version is based on.

    + *

    The name of the Feature whose value uniquely identifies a + * Record defined in the FeatureGroup + * FeatureDefinitions.

    */ - ImageArn: string | undefined; + RecordIdentifierFeatureName?: string; /** * @public - *

    The ARN of the version.

    + *

    The name of the feature that stores the EventTime of a Record in a + * FeatureGroup.

    + *

    A EventTime is point in time when a new event occurs that corresponds to + * the creation or update of a Record in FeatureGroup. All + * Records in the FeatureGroup must have a corresponding + * EventTime.

    */ - ImageVersionArn: string | undefined; + EventTimeFeatureName?: string; /** * @public - *

    The status of the version.

    + *

    A list of Features. Each Feature must include a + * FeatureName and a FeatureType.

    + *

    Valid FeatureTypes are Integral, Fractional and + * String.

    + *

    + * FeatureNames cannot be any of the following: is_deleted, + * write_time, api_invocation_time.

    + *

    You can create up to 2,500 FeatureDefinitions per + * FeatureGroup.

    */ - ImageVersionStatus: ImageVersionStatus | undefined; + FeatureDefinitions?: FeatureDefinition[]; /** * @public - *

    When the version was last modified.

    + *

    The time a FeatureGroup was created.

    */ - LastModifiedTime: Date | undefined; + CreationTime?: Date; /** * @public - *

    The version number.

    + *

    A timestamp indicating the last time you updated the feature group.

    */ - Version: number | undefined; + LastModifiedTime?: Date; + + /** + * @public + *

    Use this to specify the Amazon Web Services Key Management Service (KMS) Key ID, or + * KMSKeyId, for at rest data encryption. You can turn + * OnlineStore on or off by specifying the EnableOnlineStore flag + * at General Assembly.

    + *

    The default value is False.

    + */ + OnlineStoreConfig?: OnlineStoreConfig; + + /** + * @public + *

    The configuration of an OfflineStore.

    + *

    Provide an OfflineStoreConfig in a request to + * CreateFeatureGroup to create an OfflineStore.

    + *

    To encrypt an OfflineStore using at rest data encryption, specify Amazon Web Services Key Management Service (KMS) key ID, or KMSKeyId, in + * S3StorageConfig.

    + */ + OfflineStoreConfig?: OfflineStoreConfig; + + /** + * @public + *

    The Amazon Resource Name (ARN) of the IAM execution role used to create the feature + * group.

    + */ + RoleArn?: string; + + /** + * @public + *

    A FeatureGroup status.

    + */ + FeatureGroupStatus?: FeatureGroupStatus; + + /** + * @public + *

    The status of OfflineStore.

    + */ + OfflineStoreStatus?: OfflineStoreStatus; + + /** + * @public + *

    A value that indicates whether the feature group was updated successfully.

    + */ + LastUpdateStatus?: LastUpdateStatus; + + /** + * @public + *

    The reason that the FeatureGroup failed to be replicated in the + * OfflineStore. This is failure may be due to a failure to create a + * FeatureGroup in or delete a FeatureGroup from the + * OfflineStore.

    + */ + FailureReason?: string; + + /** + * @public + *

    A free form description of a FeatureGroup.

    + */ + Description?: string; + + /** + * @public + *

    Tags used to define a FeatureGroup.

    + */ + Tags?: Tag[]; } /** * @public * @enum */ -export const ImageVersionSortBy = { - CREATION_TIME: "CREATION_TIME", - LAST_MODIFIED_TIME: "LAST_MODIFIED_TIME", - VERSION: "VERSION", +export const FeatureGroupSortBy = { + CREATION_TIME: "CreationTime", + FEATURE_GROUP_STATUS: "FeatureGroupStatus", + NAME: "Name", + OFFLINE_STORE_STATUS: "OfflineStoreStatus", } as const; /** * @public */ -export type ImageVersionSortBy = (typeof ImageVersionSortBy)[keyof typeof ImageVersionSortBy]; +export type FeatureGroupSortBy = (typeof FeatureGroupSortBy)[keyof typeof FeatureGroupSortBy]; /** * @public * @enum */ -export const ImageVersionSortOrder = { - ASCENDING: "ASCENDING", - DESCENDING: "DESCENDING", +export const FeatureGroupSortOrder = { + ASCENDING: "Ascending", + DESCENDING: "Descending", } as const; /** * @public */ -export type ImageVersionSortOrder = (typeof ImageVersionSortOrder)[keyof typeof ImageVersionSortOrder]; +export type FeatureGroupSortOrder = (typeof FeatureGroupSortOrder)[keyof typeof FeatureGroupSortOrder]; /** * @public + *

    The name, ARN, CreationTime, FeatureGroup values, + * LastUpdatedTime and EnableOnlineStorage status of a + * FeatureGroup.

    */ -export interface ImportHubContentRequest { +export interface FeatureGroupSummary { /** * @public - *

    The name of the hub content to import.

    + *

    The name of FeatureGroup.

    */ - HubContentName: string | undefined; + FeatureGroupName: string | undefined; /** * @public - *

    The version of the hub content to import.

    + *

    Unique identifier for the FeatureGroup.

    */ - HubContentVersion?: string; + FeatureGroupArn: string | undefined; /** * @public - *

    The type of hub content to import.

    + *

    A timestamp indicating the time of creation time of the + * FeatureGroup.

    */ - HubContentType: HubContentType | undefined; + CreationTime: Date | undefined; /** * @public - *

    The version of the hub content schema to import.

    + *

    The status of a FeatureGroup. The status can be any of the following: + * Creating, Created, CreateFail, + * Deleting or DetailFail.

    */ - DocumentSchemaVersion: string | undefined; + FeatureGroupStatus?: FeatureGroupStatus; /** * @public - *

    The name of the hub to import content into.

    + *

    Notifies you if replicating data into the OfflineStore has failed. Returns + * either: Active or Blocked.

    */ - HubName: string | undefined; + OfflineStoreStatus?: OfflineStoreStatus; +} +/** + * @public + *

    The metadata for a feature. It can either be metadata that you specify, or metadata that + * is updated automatically.

    + */ +export interface FeatureMetadata { /** * @public - *

    The display name of the hub content to import.

    + *

    The Amazon Resource Number (ARN) of the feature group.

    */ - HubContentDisplayName?: string; + FeatureGroupArn?: string; /** * @public - *

    A description of the hub content to import.

    + *

    The name of the feature group containing the feature.

    */ - HubContentDescription?: string; + FeatureGroupName?: string; /** * @public - *

    A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.

    + *

    The name of feature.

    */ - HubContentMarkdown?: string; + FeatureName?: string; /** * @public - *

    The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.

    + *

    The data type of the feature.

    */ - HubContentDocument: string | undefined; + FeatureType?: FeatureType; /** * @public - *

    The searchable keywords of the hub content.

    + *

    A timestamp indicating when the feature was created.

    */ - HubContentSearchKeywords?: string[]; + CreationTime?: Date; /** * @public - *

    Any tags associated with the hub content.

    + *

    A timestamp indicating when the feature was last modified.

    */ - Tags?: Tag[]; -} + LastModifiedTime?: Date; -/** - * @public - */ -export interface ImportHubContentResponse { /** * @public - *

    The ARN of the hub that the content was imported into.

    + *

    An optional description that you specify to better describe the feature.

    */ - HubArn: string | undefined; + Description?: string; /** * @public - *

    The ARN of the hub content that was imported.

    + *

    Optional key-value pairs that you specify to better describe the feature.

    */ - HubContentArn: string | undefined; + Parameters?: FeatureParameter[]; } /** * @public - *

    Lists a summary of properties of an inference experiment.

    + * @enum */ -export interface InferenceExperimentSummary { - /** - * @public - *

    The name of the inference experiment.

    - */ - Name: string | undefined; - - /** - * @public - *

    The type of the inference experiment.

    - */ - Type: InferenceExperimentType | undefined; +export const Operator = { + CONTAINS: "Contains", + EQUALS: "Equals", + EXISTS: "Exists", + GREATER_THAN: "GreaterThan", + GREATER_THAN_OR_EQUAL_TO: "GreaterThanOrEqualTo", + IN: "In", + LESS_THAN: "LessThan", + LESS_THAN_OR_EQUAL_TO: "LessThanOrEqualTo", + NOT_EQUALS: "NotEquals", + NOT_EXISTS: "NotExists", +} as const; - /** - * @public - *

    The duration for which the inference experiment ran or will run.

    - *

    The maximum duration that you can set for an inference experiment is 30 days.

    - */ - Schedule?: InferenceExperimentSchedule; +/** + * @public + */ +export type Operator = (typeof Operator)[keyof typeof Operator]; +/** + * @public + *

    A conditional statement for a search expression that includes a resource property, a + * Boolean operator, and a value. Resources that match the statement are returned in the + * results from the Search API.

    + *

    If you specify a Value, but not an Operator, SageMaker uses the + * equals operator.

    + *

    In search, there are several property types:

    + *
    + *
    Metrics
    + *
    + *

    To define a metric filter, enter a value using the form + * "Metrics.", where is + * a metric name. For example, the following filter searches for training jobs + * with an "accuracy" metric greater than + * "0.9":

    + *

    + * \{ + *

    + *

    + * "Name": "Metrics.accuracy", + *

    + *

    + * "Operator": "GreaterThan", + *

    + *

    + * "Value": "0.9" + *

    + *

    + * \} + *

    + *
    + *
    HyperParameters
    + *
    + *

    To define a hyperparameter filter, enter a value with the form + * "HyperParameters.". Decimal hyperparameter + * values are treated as a decimal in a comparison if the specified + * Value is also a decimal value. If the specified + * Value is an integer, the decimal hyperparameter values are + * treated as integers. For example, the following filter is satisfied by + * training jobs with a "learning_rate" hyperparameter that is + * less than "0.5":

    + *

    + * \{ + *

    + *

    + * "Name": "HyperParameters.learning_rate", + *

    + *

    + * "Operator": "LessThan", + *

    + *

    + * "Value": "0.5" + *

    + *

    + * \} + *

    + *
    + *
    Tags
    + *
    + *

    To define a tag filter, enter a value with the form + * Tags..

    + *
    + *
    + */ +export interface Filter { /** * @public - *

    The status of the inference experiment.

    + *

    A resource property name. For example, TrainingJobName. For + * valid property names, see SearchRecord. + * You must specify a valid property for the resource.

    */ - Status: InferenceExperimentStatus | undefined; + Name: string | undefined; /** * @public - *

    The error message for the inference experiment status result.

    + *

    A Boolean binary operator that is used to evaluate the filter. The operator field + * contains one of the following values:

    + *
    + *
    Equals
    + *
    + *

    The value of Name equals Value.

    + *
    + *
    NotEquals
    + *
    + *

    The value of Name doesn't equal Value.

    + *
    + *
    Exists
    + *
    + *

    The Name property exists.

    + *
    + *
    NotExists
    + *
    + *

    The Name property does not exist.

    + *
    + *
    GreaterThan
    + *
    + *

    The value of Name is greater than Value. + * Not supported for text properties.

    + *
    + *
    GreaterThanOrEqualTo
    + *
    + *

    The value of Name is greater than or equal to Value. + * Not supported for text properties.

    + *
    + *
    LessThan
    + *
    + *

    The value of Name is less than Value. + * Not supported for text properties.

    + *
    + *
    LessThanOrEqualTo
    + *
    + *

    The value of Name is less than or equal to Value. + * Not supported for text properties.

    + *
    + *
    In
    + *
    + *

    The value of Name is one of the comma delimited strings in + * Value. Only supported for text properties.

    + *
    + *
    Contains
    + *
    + *

    The value of Name contains the string Value. + * Only supported for text properties.

    + *

    A SearchExpression can include the Contains operator + * multiple times when the value of Name is one of the following:

    + *
      + *
    • + *

      + * Experiment.DisplayName + *

      + *
      • + *
    • + *

      + * Experiment.ExperimentName + *

      + *
      • + *
    • + *

      + * Experiment.Tags + *

      + *
      • + *
    • + *

      + * Trial.DisplayName + *

      + *
      • + *
    • + *

      + * Trial.TrialName + *

      + *
      • + *
    • + *

      + * Trial.Tags + *

      + *
      • + *
    • + *

      + * TrialComponent.DisplayName + *

      + *
      • + *
    • + *

      + * TrialComponent.TrialComponentName + *

      + *
      • + *
    • + *

      + * TrialComponent.Tags + *

      + *
      • + *
    • + *

      + * TrialComponent.InputArtifacts + *

      + *
      • + *
    • + *

      + * TrialComponent.OutputArtifacts + *

      + *
      • + *
    + *

    A SearchExpression can include only one Contains operator + * for all other values of Name. In these cases, if you include multiple + * Contains operators in the SearchExpression, the result is + * the following error message: "'CONTAINS' operator usage limit of 1 + * exceeded."

    + *
    + *
    */ - StatusReason?: string; + Operator?: Operator; /** * @public - *

    The description of the inference experiment.

    + *

    A value used with Name and Operator to determine which + * resources satisfy the filter's condition. For numerical properties, Value + * must be an integer or floating-point decimal. For timestamp properties, + * Value must be an ISO 8601 date-time string of the following format: + * YYYY-mm-dd'T'HH:MM:SS.

    */ - Description?: string; + Value?: string; +} +/** + * @public + *

    Contains summary information about the flow definition.

    + */ +export interface FlowDefinitionSummary { /** * @public - *

    The timestamp at which the inference experiment was created.

    + *

    The name of the flow definition.

    */ - CreationTime: Date | undefined; + FlowDefinitionName: string | undefined; /** * @public - *

    The timestamp at which the inference experiment was completed.

    + *

    The Amazon Resource Name (ARN) of the flow definition.

    */ - CompletionTime?: Date; + FlowDefinitionArn: string | undefined; /** * @public - *

    The timestamp when you last modified the inference experiment.

    + *

    The status of the flow definition. Valid values:

    */ - LastModifiedTime: Date | undefined; + FlowDefinitionStatus: FlowDefinitionStatus | undefined; /** * @public - *

    - * The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage - * Amazon SageMaker Inference endpoints for model deployment. - *

    + *

    The timestamp when SageMaker created the flow definition.

    */ - RoleArn?: string; -} + CreationTime: Date | undefined; -/** - * @public - * @enum - */ -export const InferenceExperimentStopDesiredState = { - CANCELLED: "Cancelled", - COMPLETED: "Completed", -} as const; + /** + * @public + *

    The reason why the flow definition creation failed. A failure reason is returned only when the flow definition status is Failed.

    + */ + FailureReason?: string; +} /** * @public */ -export type InferenceExperimentStopDesiredState = - (typeof InferenceExperimentStopDesiredState)[keyof typeof InferenceExperimentStopDesiredState]; +export interface GetDeviceFleetReportRequest { + /** + * @public + *

    The name of the fleet.

    + */ + DeviceFleetName: string | undefined; +} /** * @public - *

    A structure that contains a list of recommendation jobs.

    */ -export interface InferenceRecommendationsJob { +export interface GetDeviceFleetReportResponse { /** * @public - *

    The name of the job.

    + *

    The Amazon Resource Name (ARN) of the device.

    */ - JobName: string | undefined; + DeviceFleetArn: string | undefined; /** * @public - *

    The job description.

    + *

    The name of the fleet.

    */ - JobDescription: string | undefined; + DeviceFleetName: string | undefined; /** * @public - *

    The recommendation job type.

    + *

    The output configuration for storing sample data collected by the fleet.

    */ - JobType: RecommendationJobType | undefined; + OutputConfig?: EdgeOutputConfig; /** * @public - *

    The Amazon Resource Name (ARN) of the recommendation job.

    + *

    Description of the fleet.

    */ - JobArn: string | undefined; + Description?: string; /** * @public - *

    The status of the job.

    + *

    Timestamp of when the report was generated.

    */ - Status: RecommendationJobStatus | undefined; + ReportGenerated?: Date; /** * @public - *

    A timestamp that shows when the job was created.

    + *

    Status of devices.

    */ - CreationTime: Date | undefined; + DeviceStats?: DeviceStats; /** * @public - *

    A timestamp that shows when the job completed.

    + *

    The versions of Edge Manager agent deployed on the fleet.

    */ - CompletionTime?: Date; + AgentVersions?: AgentVersion[]; /** * @public - *

    The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker - * to perform tasks on your behalf.

    + *

    Status of model on device.

    */ - RoleArn: string | undefined; + ModelStats?: EdgeModelStat[]; +} +/** + * @public + */ +export interface GetLineageGroupPolicyRequest { /** * @public - *

    A timestamp that shows when the job was last modified.

    + *

    The name or Amazon Resource Name (ARN) of the lineage group.

    */ - LastModifiedTime: Date | undefined; + LineageGroupName: string | undefined; +} +/** + * @public + */ +export interface GetLineageGroupPolicyResponse { /** * @public - *

    If the job fails, provides information why the job failed.

    + *

    The Amazon Resource Name (ARN) of the lineage group.

    */ - FailureReason?: string; + LineageGroupArn?: string; /** * @public - *

    The name of the created model.

    + *

    The resource policy that gives access to the lineage group in another account.

    */ - ModelName?: string; + ResourcePolicy?: string; +} +/** + * @public + */ +export interface GetModelPackageGroupPolicyInput { /** * @public - *

    The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. - * This path must point to a single gzip compressed tar archive (.tar.gz suffix).

    + *

    The name of the model group for which to get the resource policy.

    */ - SamplePayloadUrl?: string; + ModelPackageGroupName: string | undefined; +} +/** + * @public + */ +export interface GetModelPackageGroupPolicyOutput { /** * @public - *

    The Amazon Resource Name (ARN) of a versioned model package.

    + *

    The resource policy for the model group.

    */ - ModelPackageVersionArn?: string; + ResourcePolicy: string | undefined; } /** * @public - *

    The details for a specific benchmark from an Inference Recommender job.

    */ -export interface RecommendationJobInferenceBenchmark { +export interface GetSagemakerServicecatalogPortfolioStatusInput {} + +/** + * @public + * @enum + */ +export const SagemakerServicecatalogStatus = { + DISABLED: "Disabled", + ENABLED: "Enabled", +} as const; + +/** + * @public + */ +export type SagemakerServicecatalogStatus = + (typeof SagemakerServicecatalogStatus)[keyof typeof SagemakerServicecatalogStatus]; + +/** + * @public + */ +export interface GetSagemakerServicecatalogPortfolioStatusOutput { /** * @public - *

    The metrics of recommendations.

    + *

    Whether Service Catalog is enabled or disabled in SageMaker.

    */ - Metrics?: RecommendationMetrics; + Status?: SagemakerServicecatalogStatus; +} +/** + * @public + *

    An object where you specify the anticipated traffic pattern for an endpoint.

    + */ +export interface ScalingPolicyObjective { /** * @public - *

    The endpoint configuration made by Inference Recommender during a recommendation job.

    + *

    The minimum number of expected requests to your endpoint per minute.

    */ - EndpointConfiguration?: EndpointOutputConfiguration; + MinInvocationsPerMinute?: number; /** * @public - *

    Defines the model configuration. Includes the specification name and environment parameters.

    + *

    The maximum number of expected requests to your endpoint per minute.

    */ - ModelConfiguration: ModelConfiguration | undefined; + MaxInvocationsPerMinute?: number; +} +/** + * @public + */ +export interface GetScalingConfigurationRecommendationRequest { /** * @public - *

    The reason why a benchmark failed.

    + *

    The name of a previously completed Inference Recommender job.

    */ - FailureReason?: string; + InferenceRecommendationsJobName: string | undefined; /** * @public - *

    The metrics for an existing endpoint compared in an Inference Recommender job.

    + *

    The recommendation ID of a previously completed inference recommendation. This ID should come from one of the + * recommendations returned by the job specified in the InferenceRecommendationsJobName field.

    + *

    Specify either this field or the EndpointName field.

    */ - EndpointMetrics?: InferenceMetrics; + RecommendationId?: string; /** * @public - *

    A timestamp that shows when the benchmark completed.

    + *

    The name of an endpoint benchmarked during a previously completed inference recommendation job. This name should come from one of the + * recommendations returned by the job specified in the InferenceRecommendationsJobName field.

    + *

    Specify either this field or the RecommendationId field.

    */ - InvocationEndTime?: Date; + EndpointName?: string; /** * @public - *

    A timestamp that shows when the benchmark started.

    + *

    The percentage of how much utilization you want an instance to use before autoscaling. The default value is 50%.

    */ - InvocationStartTime?: Date; + TargetCpuUtilizationPerCore?: number; + + /** + * @public + *

    An object where you specify the anticipated traffic pattern for an endpoint.

    + */ + ScalingPolicyObjective?: ScalingPolicyObjective; } /** * @public - * @enum + *

    The metric for a scaling policy.

    */ -export const RecommendationStepType = { - BENCHMARK: "BENCHMARK", -} as const; +export interface ScalingPolicyMetric { + /** + * @public + *

    The number of invocations sent to a model, normalized by InstanceCount + * in each ProductionVariant. 1/numberOfInstances is sent as the value on each + * request, where numberOfInstances is the number of active instances for the + * ProductionVariant behind the endpoint at the time of the request.

    + */ + InvocationsPerInstance?: number; -/** - * @public - */ -export type RecommendationStepType = (typeof RecommendationStepType)[keyof typeof RecommendationStepType]; + /** + * @public + *

    The interval of time taken by a model to respond as viewed from SageMaker. + * This interval includes the local communication times taken to send the request + * and to fetch the response from the container of a model and the time taken to + * complete the inference in the container.

    + */ + ModelLatency?: number; +} /** * @public - *

    A returned array object for the Steps response field in the - * ListInferenceRecommendationsJobSteps API command.

    */ -export interface InferenceRecommendationsJobStep { +export interface GetScalingConfigurationRecommendationResponse { /** * @public - *

    The type of the subtask.

    - *

    - * BENCHMARK: Evaluate the performance of your model on different instance types.

    + *

    The name of a previously completed Inference Recommender job.

    */ - StepType: RecommendationStepType | undefined; + InferenceRecommendationsJobName?: string; /** * @public - *

    The name of the Inference Recommender job.

    + *

    The recommendation ID of a previously completed inference recommendation.

    */ - JobName: string | undefined; + RecommendationId?: string; /** * @public - *

    The current status of the benchmark.

    + *

    The name of an endpoint benchmarked during a previously completed Inference Recommender job.

    */ - Status: RecommendationJobStatus | undefined; + EndpointName?: string; /** * @public - *

    The details for a specific benchmark.

    + *

    The percentage of how much utilization you want an instance to use before autoscaling, which you specified in the request. The default value is 50%.

    */ - InferenceBenchmark?: RecommendationJobInferenceBenchmark; -} + TargetCpuUtilizationPerCore?: number; -/** - * @public - *

    Provides counts for human-labeled tasks in the labeling job.

    - */ -export interface LabelCountersForWorkteam { /** * @public - *

    The total number of data objects labeled by a human worker.

    + *

    An object representing the anticipated traffic pattern for an endpoint that you specified in the request.

    */ - HumanLabeled?: number; + ScalingPolicyObjective?: ScalingPolicyObjective; /** * @public - *

    The total number of data objects that need to be labeled by a human worker.

    + *

    An object with a list of metrics that were benchmarked during the previously completed Inference Recommender job.

    */ - PendingHuman?: number; + Metric?: ScalingPolicyMetric; /** * @public - *

    The total number of tasks in the labeling job.

    + *

    An object with the recommended values for you to specify when creating an autoscaling policy.

    */ - Total?: number; + DynamicScalingConfiguration?: DynamicScalingConfiguration; } /** * @public - *

    Provides summary information for a work team.

    + * @enum + */ +export const ResourceType = { + ENDPOINT: "Endpoint", + EXPERIMENT: "Experiment", + EXPERIMENT_TRIAL: "ExperimentTrial", + EXPERIMENT_TRIAL_COMPONENT: "ExperimentTrialComponent", + FEATURE_GROUP: "FeatureGroup", + FEATURE_METADATA: "FeatureMetadata", + HYPER_PARAMETER_TUNING_JOB: "HyperParameterTuningJob", + MODEL: "Model", + MODEL_CARD: "ModelCard", + MODEL_PACKAGE: "ModelPackage", + MODEL_PACKAGE_GROUP: "ModelPackageGroup", + PIPELINE: "Pipeline", + PIPELINE_EXECUTION: "PipelineExecution", + PROJECT: "Project", + TRAINING_JOB: "TrainingJob", +} as const; + +/** + * @public + */ +export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType]; + +/** + * @public + *

    Part of the SuggestionQuery type. Specifies a hint for retrieving property + * names that begin with the specified text.

    */ -export interface LabelingJobForWorkteamSummary { - /** - * @public - *

    The name of the labeling job that the work team is assigned to.

    - */ - LabelingJobName?: string; - +export interface PropertyNameQuery { /** * @public - *

    A unique identifier for a labeling job. You can use this to refer to a specific - * labeling job.

    + *

    Text that begins a property's name.

    */ - JobReferenceCode: string | undefined; + PropertyNameHint: string | undefined; +} +/** + * @public + *

    Specified in the GetSearchSuggestions request. + * Limits the property names that are included in the response.

    + */ +export interface SuggestionQuery { /** * @public - *

    The Amazon Web Services account ID of the account used to start the labeling - * job.

    + *

    Defines a property name hint. Only property + * names that begin with the specified hint are included in the response.

    */ - WorkRequesterAccountId: string | undefined; + PropertyNameQuery?: PropertyNameQuery; +} +/** + * @public + */ +export interface GetSearchSuggestionsRequest { /** * @public - *

    The date and time that the labeling job was created.

    + *

    The name of the SageMaker resource to search for.

    */ - CreationTime: Date | undefined; + Resource: ResourceType | undefined; /** * @public - *

    Provides information about the progress of a labeling job.

    + *

    Limits the property names that are included in the response.

    */ - LabelCounters?: LabelCountersForWorkteam; + SuggestionQuery?: SuggestionQuery; +} +/** + * @public + *

    A property name returned from a GetSearchSuggestions call that specifies + * a value in the PropertyNameQuery field.

    + */ +export interface PropertyNameSuggestion { /** * @public - *

    The configured number of workers per data object.

    + *

    A suggested property name based on what you entered in the search textbox in the SageMaker + * console.

    */ - NumberOfHumanWorkersPerDataObject?: number; + PropertyName?: string; } /** * @public - *

    Provides summary information about a labeling job.

    */ -export interface LabelingJobSummary { +export interface GetSearchSuggestionsResponse { /** * @public - *

    The name of the labeling job.

    + *

    A list of property names for a Resource that match a + * SuggestionQuery.

    */ - LabelingJobName: string | undefined; + PropertyNameSuggestions?: PropertyNameSuggestion[]; +} +/** + * @public + *

    Specifies configuration details for a Git repository when the repository is + * updated.

    + */ +export interface GitConfigForUpdate { /** * @public - *

    The Amazon Resource Name (ARN) assigned to the labeling job when it was - * created.

    + *

    The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that + * contains the credentials used to access the git repository. The secret must have a + * staging label of AWSCURRENT and must be in the following format:

    + *

    + * \{"username": UserName, "password": + * Password\} + *

    */ - LabelingJobArn: string | undefined; + SecretArn?: string; +} +/** + * @public + *

    Information about hub content.

    + */ +export interface HubContentInfo { /** * @public - *

    The date and time that the job was created (timestamp).

    + *

    The name of the hub content.

    */ - CreationTime: Date | undefined; + HubContentName: string | undefined; /** * @public - *

    The date and time that the job was last modified (timestamp).

    + *

    The Amazon Resource Name (ARN) of the hub content.

    */ - LastModifiedTime: Date | undefined; + HubContentArn: string | undefined; /** * @public - *

    The current status of the labeling job.

    + *

    The version of the hub content.

    */ - LabelingJobStatus: LabelingJobStatus | undefined; + HubContentVersion: string | undefined; /** * @public - *

    Counts showing the progress of the labeling job.

    + *

    The type of hub content.

    */ - LabelCounters: LabelCounters | undefined; + HubContentType: HubContentType | undefined; /** * @public - *

    The Amazon Resource Name (ARN) of the work team assigned to the job.

    + *

    The version of the hub content document schema.

    */ - WorkteamArn: string | undefined; + DocumentSchemaVersion: string | undefined; /** * @public - *

    The Amazon Resource Name (ARN) of a Lambda function. The function is run before each - * data object is sent to a worker.

    + *

    The display name of the hub content.

    */ - PreHumanTaskLambdaArn: string | undefined; + HubContentDisplayName?: string; /** * @public - *

    The Amazon Resource Name (ARN) of the Lambda function used to consolidate the - * annotations from individual workers into a label for a data object. For more - * information, see Annotation - * Consolidation.

    + *

    A description of the hub content.

    */ - AnnotationConsolidationLambdaArn?: string; + HubContentDescription?: string; /** * @public - *

    If the LabelingJobStatus field is Failed, this field - * contains a description of the error.

    + *

    The searchable keywords for the hub content.

    */ - FailureReason?: string; + HubContentSearchKeywords?: string[]; /** * @public - *

    The location of the output produced by the labeling job.

    + *

    The status of the hub content.

    */ - LabelingJobOutput?: LabelingJobOutput; + HubContentStatus: HubContentStatus | undefined; /** * @public - *

    Input configuration for the labeling job.

    + *

    The date and time that the hub content was created.

    */ - InputConfig?: LabelingJobInputConfig; + CreationTime: Date | undefined; } /** * @public - *

    Metadata for a Lambda step.

    + * @enum */ -export interface LambdaStepMetadata { - /** - * @public - *

    The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution.

    - */ - Arn?: string; +export const HubContentSortBy = { + CREATION_TIME: "CreationTime", + HUB_CONTENT_NAME: "HubContentName", + HUB_CONTENT_STATUS: "HubContentStatus", +} as const; - /** - * @public - *

    A list of the output parameters of the Lambda step.

    - */ - OutputParameters?: OutputParameter[]; -} +/** + * @public + */ +export type HubContentSortBy = (typeof HubContentSortBy)[keyof typeof HubContentSortBy]; /** * @public - *

    Lists a summary of the properties of a lineage group. A lineage group provides a group of shareable lineage entity - * resources.

    + *

    Information about a hub.

    */ -export interface LineageGroupSummary { +export interface HubInfo { /** * @public - *

    The Amazon Resource Name (ARN) of the lineage group resource.

    + *

    The name of the hub.

    */ - LineageGroupArn?: string; + HubName: string | undefined; /** * @public - *

    The name or Amazon Resource Name (ARN) of the lineage group.

    + *

    The Amazon Resource Name (ARN) of the hub.

    */ - LineageGroupName?: string; + HubArn: string | undefined; /** * @public - *

    The display name of the lineage group summary.

    + *

    The display name of the hub.

    */ - DisplayName?: string; + HubDisplayName?: string; /** * @public - *

    The creation time of the lineage group summary.

    + *

    A description of the hub.

    */ - CreationTime?: Date; + HubDescription?: string; /** * @public - *

    The last modified time of the lineage group summary.

    + *

    The searchable keywords for the hub.

    */ - LastModifiedTime?: Date; -} - -/** - * @public - * @enum - */ -export const LineageType = { - ACTION: "Action", - ARTIFACT: "Artifact", - CONTEXT: "Context", - TRIAL_COMPONENT: "TrialComponent", -} as const; - -/** - * @public - */ -export type LineageType = (typeof LineageType)[keyof typeof LineageType]; - -/** - * @public - * @enum - */ -export const SortActionsBy = { - CREATION_TIME: "CreationTime", - NAME: "Name", -} as const; - -/** - * @public - */ -export type SortActionsBy = (typeof SortActionsBy)[keyof typeof SortActionsBy]; - -/** - * @public - * @enum - */ -export const SortOrder = { - ASCENDING: "Ascending", - DESCENDING: "Descending", -} as const; - -/** - * @public - */ -export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder]; + HubSearchKeywords?: string[]; -/** - * @public - */ -export interface ListActionsRequest { /** * @public - *

    A filter that returns only actions with the specified source URI.

    + *

    The status of the hub.

    */ - SourceUri?: string; + HubStatus: HubStatus | undefined; /** * @public - *

    A filter that returns only actions of the specified type.

    + *

    The date and time that the hub was created.

    */ - ActionType?: string; + CreationTime: Date | undefined; /** * @public - *

    A filter that returns only actions created on or after the specified time.

    + *

    The date and time that the hub was last modified.

    */ - CreatedAfter?: Date; + LastModifiedTime: Date | undefined; +} - /** - * @public - *

    A filter that returns only actions created on or before the specified time.

    - */ - CreatedBefore?: Date; +/** + * @public + * @enum + */ +export const HubSortBy = { + ACCOUNT_ID_OWNER: "AccountIdOwner", + CREATION_TIME: "CreationTime", + HUB_NAME: "HubName", + HUB_STATUS: "HubStatus", +} as const; - /** - * @public - *

    The property used to sort results. The default value is CreationTime.

    - */ - SortBy?: SortActionsBy; +/** + * @public + */ +export type HubSortBy = (typeof HubSortBy)[keyof typeof HubSortBy]; +/** + * @public + *

    Container for human task user interface information.

    + */ +export interface HumanTaskUiSummary { /** * @public - *

    The sort order. The default value is Descending.

    + *

    The name of the human task user interface.

    */ - SortOrder?: SortOrder; + HumanTaskUiName: string | undefined; /** * @public - *

    If the previous call to ListActions didn't return the full set of actions, - * the call returns a token for getting the next set of actions.

    + *

    The Amazon Resource Name (ARN) of the human task user interface.

    */ - NextToken?: string; + HumanTaskUiArn: string | undefined; /** * @public - *

    The maximum number of actions to return in the response. The default value is 10.

    + *

    A timestamp when SageMaker created the human task user interface.

    */ - MaxResults?: number; + CreationTime: Date | undefined; } /** * @public + *

    An entity returned by the SearchRecord API + * containing the properties of a hyperparameter tuning job.

    */ -export interface ListActionsResponse { +export interface HyperParameterTuningJobSearchEntity { /** * @public - *

    A list of actions and their properties.

    + *

    The name of a hyperparameter tuning job.

    */ - ActionSummaries?: ActionSummary[]; + HyperParameterTuningJobName?: string; /** * @public - *

    A token for getting the next set of actions, if there are any.

    + *

    The Amazon Resource Name (ARN) of a hyperparameter tuning job.

    */ - NextToken?: string; -} + HyperParameterTuningJobArn?: string; -/** - * @public - */ -export interface ListAlgorithmsInput { /** * @public - *

    A filter that returns only algorithms created after the specified time - * (timestamp).

    + *

    Configures a hyperparameter tuning job.

    */ - CreationTimeAfter?: Date; + HyperParameterTuningJobConfig?: HyperParameterTuningJobConfig; /** * @public - *

    A filter that returns only algorithms created before the specified time - * (timestamp).

    + *

    Defines + * the training jobs launched by a hyperparameter tuning job.

    */ - CreationTimeBefore?: Date; + TrainingJobDefinition?: HyperParameterTrainingJobDefinition; /** * @public - *

    The maximum number of algorithms to return in the response.

    + *

    The job definitions included in a hyperparameter tuning job.

    */ - MaxResults?: number; + TrainingJobDefinitions?: HyperParameterTrainingJobDefinition[]; /** * @public - *

    A string in the algorithm name. This filter returns only algorithms whose name - * contains the specified string.

    + *

    The status of a hyperparameter tuning job.

    */ - NameContains?: string; + HyperParameterTuningJobStatus?: HyperParameterTuningJobStatus; /** * @public - *

    If the response to a previous ListAlgorithms request was truncated, the - * response includes a NextToken. To retrieve the next set of algorithms, use - * the token in the next request.

    + *

    The time that a hyperparameter tuning job was created.

    */ - NextToken?: string; + CreationTime?: Date; /** * @public - *

    The parameter by which to sort the results. The default is - * CreationTime.

    + *

    The time that a hyperparameter tuning job ended.

    */ - SortBy?: AlgorithmSortBy; + HyperParameterTuningEndTime?: Date; /** * @public - *

    The sort order for the results. The default is Ascending.

    + *

    The time that a hyperparameter tuning job was last modified.

    */ - SortOrder?: SortOrder; -} + LastModifiedTime?: Date; -/** - * @public - */ -export interface ListAlgorithmsOutput { /** * @public - *

    >An array of AlgorithmSummary objects, each of which lists an - * algorithm.

    + *

    The numbers of training jobs launched by a hyperparameter tuning job, categorized by + * status.

    */ - AlgorithmSummaryList: AlgorithmSummary[] | undefined; + TrainingJobStatusCounters?: TrainingJobStatusCounters; /** * @public - *

    If the response is truncated, SageMaker returns this token. To retrieve the next set of - * algorithms, use it in the subsequent request.

    + *

    Specifies the number of training jobs that this hyperparameter tuning job launched, + * categorized by the status of their objective metric. The objective metric status shows + * whether the + * final + * objective metric for the training job has been evaluated by the + * tuning job and used in the hyperparameter tuning process.

    */ - NextToken?: string; -} + ObjectiveStatusCounters?: ObjectiveStatusCounters; -/** - * @public - */ -export interface ListAliasesRequest { /** * @public - *

    The name of the image.

    + *

    The container for the summary information about a training job.

    */ - ImageName: string | undefined; + BestTrainingJob?: HyperParameterTrainingJobSummary; /** * @public - *

    The alias of the image version.

    + *

    The container for the summary information about a training job.

    */ - Alias?: string; + OverallBestTrainingJob?: HyperParameterTrainingJobSummary; /** * @public - *

    The version of the image. If image version is not specified, the aliases of all versions of the image are listed.

    + *

    Specifies the configuration for a hyperparameter tuning job that uses one or more + * previous hyperparameter tuning jobs as a starting point. The results of previous tuning + * jobs are used to inform which combinations of hyperparameters to search over in the new + * tuning job.

    + *

    All training jobs launched by the new hyperparameter tuning job are evaluated by using + * the objective metric, and the training job that performs the best is compared to the + * best training jobs from the parent tuning jobs. From these, the training job that + * performs the best as measured by the objective metric is returned as the overall best + * training job.

    + * + *

    All training jobs launched by parent hyperparameter tuning jobs and the new + * hyperparameter tuning jobs count against the limit of training jobs for the tuning + * job.

    + *     */ - Version?: number; + WarmStartConfig?: HyperParameterTuningJobWarmStartConfig; /** * @public - *

    The maximum number of aliases to return.

    + *

    The error that was created when a hyperparameter tuning job failed.

    */ - MaxResults?: number; + FailureReason?: string; /** * @public - *

    If the previous call to ListAliases didn't return the full set of - * aliases, the call returns a token for retrieving the next set of aliases.

    + *

    The tags associated with a hyperparameter tuning job. For more information see Tagging Amazon Web Services resources.

    */ - NextToken?: string; -} + Tags?: Tag[]; -/** - * @public - */ -export interface ListAliasesResponse { /** * @public - *

    A list of SageMaker image version aliases.

    + *

    Information about either a current or completed hyperparameter tuning job.

    */ - SageMakerImageVersionAliases?: string[]; + TuningJobCompletionDetails?: HyperParameterTuningJobCompletionDetails; /** * @public - *

    A token for getting the next set of aliases, if more aliases exist.

    + *

    The total amount of resources consumed by a hyperparameter tuning job.

    */ - NextToken?: string; + ConsumedResources?: HyperParameterTuningJobConsumedResources; } /** * @public + * @enum */ -export interface ListAppImageConfigsRequest { - /** - * @public - *

    The total number of items to return in the response. If the total - * number of items available is more than the value specified, a NextToken - * is provided in the response. To resume pagination, provide the NextToken - * value in the as part of a subsequent call. The default value is 10.

    - */ - MaxResults?: number; +export const HyperParameterTuningJobSortByOptions = { + CreationTime: "CreationTime", + Name: "Name", + Status: "Status", +} as const; + +/** + * @public + */ +export type HyperParameterTuningJobSortByOptions = + (typeof HyperParameterTuningJobSortByOptions)[keyof typeof HyperParameterTuningJobSortByOptions]; +/** + * @public + *

    Provides summary information about a hyperparameter tuning job.

    + */ +export interface HyperParameterTuningJobSummary { /** * @public - *

    If the previous call to ListImages didn't return the full set of - * AppImageConfigs, the call returns a token for getting the next set of AppImageConfigs.

    + *

    The name of the tuning job.

    */ - NextToken?: string; + HyperParameterTuningJobName: string | undefined; /** * @public - *

    A filter that returns only AppImageConfigs whose name contains the specified string.

    + *

    The + * Amazon + * Resource Name (ARN) of the tuning job.

    */ - NameContains?: string; + HyperParameterTuningJobArn: string | undefined; /** * @public - *

    A filter that returns only AppImageConfigs created on or before the specified time.

    + *

    The status of the + * tuning + * job.

    */ - CreationTimeBefore?: Date; + HyperParameterTuningJobStatus: HyperParameterTuningJobStatus | undefined; /** * @public - *

    A filter that returns only AppImageConfigs created on or after the specified time.

    + *

    Specifies the search strategy hyperparameter tuning uses to choose which + * hyperparameters to + * evaluate + * at each iteration.

    */ - CreationTimeAfter?: Date; + Strategy: HyperParameterTuningJobStrategyType | undefined; /** * @public - *

    A filter that returns only AppImageConfigs modified on or before the specified time.

    + *

    The date and time that the tuning job was created.

    */ - ModifiedTimeBefore?: Date; + CreationTime: Date | undefined; /** * @public - *

    A filter that returns only AppImageConfigs modified on or after the specified time.

    + *

    The date and time that the tuning job ended.

    */ - ModifiedTimeAfter?: Date; + HyperParameterTuningEndTime?: Date; /** * @public - *

    The property used to sort results. The default value is CreationTime.

    + *

    The date and time that the tuning job was + * modified.

    */ - SortBy?: AppImageConfigSortKey; + LastModifiedTime?: Date; /** * @public - *

    The sort order. The default value is Descending.

    + *

    The TrainingJobStatusCounters object that specifies the numbers of training + * jobs, categorized by status, that this tuning job launched.

    */ - SortOrder?: SortOrder; -} + TrainingJobStatusCounters: TrainingJobStatusCounters | undefined; -/** - * @public - */ -export interface ListAppImageConfigsResponse { /** * @public - *

    A token for getting the next set of AppImageConfigs, if there are any.

    + *

    The ObjectiveStatusCounters object that specifies the numbers of training jobs, + * categorized by objective metric status, that this tuning job launched.

    */ - NextToken?: string; + ObjectiveStatusCounters: ObjectiveStatusCounters | undefined; /** * @public - *

    A list of AppImageConfigs and their properties.

    + *

    The ResourceLimits + * object that specifies the maximum number of training jobs and parallel training jobs + * allowed for this tuning job.

    */ - AppImageConfigs?: AppImageConfigDetails[]; + ResourceLimits?: ResourceLimits; } /** * @public + *

    A SageMaker image. A SageMaker image represents a set of container images that are derived from + * a common base container image. Each of these container images is represented by a SageMaker + * ImageVersion.

    */ -export interface ListAppsRequest { - /** - * @public - *

    If the previous response was truncated, you will receive this token. - * Use it in your next request to receive the next set of results.

    - */ - NextToken?: string; - - /** - * @public - *

    The total number of items to return in the response. If the total - * number of items available is more than the value specified, a NextToken - * is provided in the response. To resume pagination, provide the NextToken - * value in the as part of a subsequent call. The default value is 10.

    +export interface Image { + /** + * @public + *

    When the image was created.

    */ - MaxResults?: number; + CreationTime: Date | undefined; /** * @public - *

    The sort order for the results. The default is Ascending.

    + *

    The description of the image.

    */ - SortOrder?: SortOrder; + Description?: string; /** * @public - *

    The parameter by which to sort the results. The default is CreationTime.

    + *

    The name of the image as displayed.

    */ - SortBy?: AppSortKey; + DisplayName?: string; /** * @public - *

    A parameter to search for the domain ID.

    + *

    When a create, update, or delete operation fails, the reason for the failure.

    */ - DomainIdEquals?: string; + FailureReason?: string; /** * @public - *

    A parameter to search by user profile name. If SpaceNameEquals is set, then this value cannot be set.

    + *

    The ARN of the image.

    */ - UserProfileNameEquals?: string; + ImageArn: string | undefined; /** * @public - *

    A parameter to search by space name. If UserProfileNameEquals is set, then this value cannot be set.

    + *

    The name of the image.

    */ - SpaceNameEquals?: string; -} + ImageName: string | undefined; -/** - * @public - */ -export interface ListAppsResponse { /** * @public - *

    The list of apps.

    + *

    The status of the image.

    */ - Apps?: AppDetails[]; + ImageStatus: ImageStatus | undefined; /** * @public - *

    If the previous response was truncated, you will receive this token. - * Use it in your next request to receive the next set of results.

    + *

    When the image was last modified.

    */ - NextToken?: string; + LastModifiedTime: Date | undefined; } /** * @public * @enum */ -export const SortArtifactsBy = { - CREATION_TIME: "CreationTime", +export const ImageSortBy = { + CREATION_TIME: "CREATION_TIME", + IMAGE_NAME: "IMAGE_NAME", + LAST_MODIFIED_TIME: "LAST_MODIFIED_TIME", } as const; /** * @public */ -export type SortArtifactsBy = (typeof SortArtifactsBy)[keyof typeof SortArtifactsBy]; +export type ImageSortBy = (typeof ImageSortBy)[keyof typeof ImageSortBy]; + +/** + * @public + * @enum + */ +export const ImageSortOrder = { + ASCENDING: "ASCENDING", + DESCENDING: "DESCENDING", +} as const; /** * @public */ -export interface ListArtifactsRequest { - /** - * @public - *

    A filter that returns only artifacts with the specified source URI.

    - */ - SourceUri?: string; +export type ImageSortOrder = (typeof ImageSortOrder)[keyof typeof ImageSortOrder]; +/** + * @public + *

    A version of a SageMaker Image. A version represents an existing container + * image.

    + */ +export interface ImageVersion { /** * @public - *

    A filter that returns only artifacts of the specified type.

    + *

    When the version was created.

    */ - ArtifactType?: string; + CreationTime: Date | undefined; /** * @public - *

    A filter that returns only artifacts created on or after the specified time.

    + *

    When a create or delete operation fails, the reason for the failure.

    */ - CreatedAfter?: Date; + FailureReason?: string; /** * @public - *

    A filter that returns only artifacts created on or before the specified time.

    + *

    The ARN of the image the version is based on.

    */ - CreatedBefore?: Date; + ImageArn: string | undefined; /** * @public - *

    The property used to sort results. The default value is CreationTime.

    + *

    The ARN of the version.

    */ - SortBy?: SortArtifactsBy; + ImageVersionArn: string | undefined; /** * @public - *

    The sort order. The default value is Descending.

    + *

    The status of the version.

    */ - SortOrder?: SortOrder; + ImageVersionStatus: ImageVersionStatus | undefined; /** * @public - *

    If the previous call to ListArtifacts didn't return the full set of artifacts, - * the call returns a token for getting the next set of artifacts.

    + *

    When the version was last modified.

    */ - NextToken?: string; + LastModifiedTime: Date | undefined; /** * @public - *

    The maximum number of artifacts to return in the response. The default value is 10.

    + *

    The version number.

    */ - MaxResults?: number; + Version: number | undefined; } /** * @public + * @enum */ -export interface ListArtifactsResponse { - /** - * @public - *

    A list of artifacts and their properties.

    - */ - ArtifactSummaries?: ArtifactSummary[]; +export const ImageVersionSortBy = { + CREATION_TIME: "CREATION_TIME", + LAST_MODIFIED_TIME: "LAST_MODIFIED_TIME", + VERSION: "VERSION", +} as const; - /** - * @public - *

    A token for getting the next set of artifacts, if there are any.

    - */ - NextToken?: string; -} +/** + * @public + */ +export type ImageVersionSortBy = (typeof ImageVersionSortBy)[keyof typeof ImageVersionSortBy]; /** * @public * @enum */ -export const SortAssociationsBy = { - CREATION_TIME: "CreationTime", - DESTINATION_ARN: "DestinationArn", - DESTINATION_TYPE: "DestinationType", - SOURCE_ARN: "SourceArn", - SOURCE_TYPE: "SourceType", +export const ImageVersionSortOrder = { + ASCENDING: "ASCENDING", + DESCENDING: "DESCENDING", } as const; /** * @public */ -export type SortAssociationsBy = (typeof SortAssociationsBy)[keyof typeof SortAssociationsBy]; +export type ImageVersionSortOrder = (typeof ImageVersionSortOrder)[keyof typeof ImageVersionSortOrder]; /** * @public */ -export interface ListAssociationsRequest { +export interface ImportHubContentRequest { /** * @public - *

    A filter that returns only associations with the specified source ARN.

    + *

    The name of the hub content to import.

    */ - SourceArn?: string; + HubContentName: string | undefined; /** * @public - *

    A filter that returns only associations with the specified destination Amazon Resource Name (ARN).

    + *

    The version of the hub content to import.

    */ - DestinationArn?: string; + HubContentVersion?: string; /** * @public - *

    A filter that returns only associations with the specified source type.

    + *

    The type of hub content to import.

    */ - SourceType?: string; + HubContentType: HubContentType | undefined; /** * @public - *

    A filter that returns only associations with the specified destination type.

    + *

    The version of the hub content schema to import.

    */ - DestinationType?: string; + DocumentSchemaVersion: string | undefined; /** * @public - *

    A filter that returns only associations of the specified type.

    + *

    The name of the hub to import content into.

    */ - AssociationType?: AssociationEdgeType; + HubName: string | undefined; /** * @public - *

    A filter that returns only associations created on or after the specified time.

    + *

    The display name of the hub content to import.

    */ - CreatedAfter?: Date; + HubContentDisplayName?: string; /** * @public - *

    A filter that returns only associations created on or before the specified time.

    + *

    A description of the hub content to import.

    */ - CreatedBefore?: Date; + HubContentDescription?: string; /** * @public - *

    The property used to sort results. The default value is CreationTime.

    + *

    A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.

    */ - SortBy?: SortAssociationsBy; + HubContentMarkdown?: string; /** * @public - *

    The sort order. The default value is Descending.

    + *

    The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.

    */ - SortOrder?: SortOrder; + HubContentDocument: string | undefined; /** * @public - *

    If the previous call to ListAssociations didn't return the full set of associations, - * the call returns a token for getting the next set of associations.

    + *

    The searchable keywords of the hub content.

    */ - NextToken?: string; + HubContentSearchKeywords?: string[]; /** * @public - *

    The maximum number of associations to return in the response. The default value is 10.

    + *

    Any tags associated with the hub content.

    */ - MaxResults?: number; + Tags?: Tag[]; } /** * @public */ -export interface ListAssociationsResponse { +export interface ImportHubContentResponse { /** * @public - *

    A list of associations and their properties.

    + *

    The ARN of the hub that the content was imported into.

    */ - AssociationSummaries?: AssociationSummary[]; + HubArn: string | undefined; /** * @public - *

    A token for getting the next set of associations, if there are any.

    + *

    The ARN of the hub content that was imported.

    */ - NextToken?: string; + HubContentArn: string | undefined; } /** * @public + * @enum */ -export interface ListAutoMLJobsRequest { - /** - * @public - *

    Request a list of jobs, using a filter for time.

    - */ - CreationTimeAfter?: Date; +export const InferenceComponentSortKey = { + CreationTime: "CreationTime", + Name: "Name", + Status: "Status", +} as const; - /** - * @public - *

    Request a list of jobs, using a filter for time.

    - */ - CreationTimeBefore?: Date; +/** + * @public + */ +export type InferenceComponentSortKey = (typeof InferenceComponentSortKey)[keyof typeof InferenceComponentSortKey]; +/** + * @public + *

    A summary of the properties of an inference component.

    + */ +export interface InferenceComponentSummary { /** * @public - *

    Request a list of jobs, using a filter for time.

    + *

    The time when the inference component was created.

    */ - LastModifiedTimeAfter?: Date; + CreationTime: Date | undefined; /** * @public - *

    Request a list of jobs, using a filter for time.

    + *

    The Amazon Resource Name (ARN) of the inference component.

    */ - LastModifiedTimeBefore?: Date; + InferenceComponentArn: string | undefined; /** * @public - *

    Request a list of jobs, using a search filter for name.

    + *

    The name of the inference component.

    */ - NameContains?: string; + InferenceComponentName: string | undefined; /** * @public - *

    Request a list of jobs, using a filter for status.

    + *

    The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.

    */ - StatusEquals?: AutoMLJobStatus; + EndpointArn: string | undefined; /** * @public - *

    The sort order for the results. The default is Descending.

    + *

    The name of the endpoint that hosts the inference component.

    */ - SortOrder?: AutoMLSortOrder; + EndpointName: string | undefined; /** * @public - *

    The parameter by which to sort the results. The default is Name.

    + *

    The name of the production variant that hosts the inference component.

    */ - SortBy?: AutoMLSortBy; + VariantName: string | undefined; /** * @public - *

    Request a list of jobs up to a specified limit.

    + *

    The status of the inference component.

    */ - MaxResults?: number; + InferenceComponentStatus?: InferenceComponentStatus; /** * @public - *

    If the previous response was truncated, you receive this token. Use it in your next - * request to receive the next set of results.

    + *

    The time when the inference component was last updated.

    */ - NextToken?: string; + LastModifiedTime: Date | undefined; } /** * @public + *

    Lists a summary of properties of an inference experiment.

    */ -export interface ListAutoMLJobsResponse { +export interface InferenceExperimentSummary { /** * @public - *

    Returns a summary list of jobs.

    + *

    The name of the inference experiment.

    */ - AutoMLJobSummaries: AutoMLJobSummary[] | undefined; + Name: string | undefined; /** * @public - *

    If the previous response was truncated, you receive this token. Use it in your next - * request to receive the next set of results.

    + *

    The type of the inference experiment.

    */ - NextToken?: string; -} + Type: InferenceExperimentType | undefined; -/** - * @public - */ -export interface ListCandidatesForAutoMLJobRequest { /** * @public - *

    List the candidates created for the job by providing the job's name.

    + *

    The duration for which the inference experiment ran or will run.

    + *

    The maximum duration that you can set for an inference experiment is 30 days.

    + */ + Schedule?: InferenceExperimentSchedule; + + /** + * @public + *

    The status of the inference experiment.

    */ - AutoMLJobName: string | undefined; + Status: InferenceExperimentStatus | undefined; /** * @public - *

    List the candidates for the job and filter by status.

    + *

    The error message for the inference experiment status result.

    */ - StatusEquals?: CandidateStatus; + StatusReason?: string; /** * @public - *

    List the candidates for the job and filter by candidate name.

    + *

    The description of the inference experiment.

    */ - CandidateNameEquals?: string; + Description?: string; /** * @public - *

    The sort order for the results. The default is Ascending.

    + *

    The timestamp at which the inference experiment was created.

    */ - SortOrder?: AutoMLSortOrder; + CreationTime: Date | undefined; /** * @public - *

    The parameter by which to sort the results. The default is - * Descending.

    + *

    The timestamp at which the inference experiment was completed.

    */ - SortBy?: CandidateSortBy; + CompletionTime?: Date; /** * @public - *

    List the job's candidates up to a specified limit.

    + *

    The timestamp when you last modified the inference experiment.

    */ - MaxResults?: number; + LastModifiedTime: Date | undefined; /** * @public - *

    If the previous response was truncated, you receive this token. Use it in your next - * request to receive the next set of results.

    + *

    + * The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage + * Amazon SageMaker Inference endpoints for model deployment. + *

    */ - NextToken?: string; + RoleArn?: string; } /** * @public + * @enum */ -export interface ListCandidatesForAutoMLJobResponse { +export const InferenceExperimentStopDesiredState = { + CANCELLED: "Cancelled", + COMPLETED: "Completed", +} as const; + +/** + * @public + */ +export type InferenceExperimentStopDesiredState = + (typeof InferenceExperimentStopDesiredState)[keyof typeof InferenceExperimentStopDesiredState]; + +/** + * @public + *

    A structure that contains a list of recommendation jobs.

    + */ +export interface InferenceRecommendationsJob { /** * @public - *

    Summaries about the AutoMLCandidates.

    + *

    The name of the job.

    */ - Candidates: AutoMLCandidate[] | undefined; + JobName: string | undefined; /** * @public - *

    If the previous response was truncated, you receive this token. Use it in your next - * request to receive the next set of results.

    + *

    The job description.

    */ - NextToken?: string; -} + JobDescription: string | undefined; -/** - * @public - */ -export interface ListCodeRepositoriesInput { /** * @public - *

    A filter that returns only Git repositories that were created after the specified - * time.

    + *

    The recommendation job type.

    */ - CreationTimeAfter?: Date; + JobType: RecommendationJobType | undefined; /** * @public - *

    A filter that returns only Git repositories that were created before the specified - * time.

    + *

    The Amazon Resource Name (ARN) of the recommendation job.

    */ - CreationTimeBefore?: Date; + JobArn: string | undefined; /** * @public - *

    A filter that returns only Git repositories that were last modified after the - * specified time.

    + *

    The status of the job.

    */ - LastModifiedTimeAfter?: Date; + Status: RecommendationJobStatus | undefined; /** * @public - *

    A filter that returns only Git repositories that were last modified before the - * specified time.

    + *

    A timestamp that shows when the job was created.

    */ - LastModifiedTimeBefore?: Date; + CreationTime: Date | undefined; /** * @public - *

    The maximum number of Git repositories to return in the response.

    + *

    A timestamp that shows when the job completed.

    */ - MaxResults?: number; + CompletionTime?: Date; /** * @public - *

    A string in the Git repositories name. This filter returns only repositories whose - * name contains the specified string.

    + *

    The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker + * to perform tasks on your behalf.

    */ - NameContains?: string; + RoleArn: string | undefined; /** * @public - *

    If the result of a ListCodeRepositoriesOutput request was truncated, the - * response includes a NextToken. To get the next set of Git repositories, use - * the token in the next request.

    + *

    A timestamp that shows when the job was last modified.

    */ - NextToken?: string; + LastModifiedTime: Date | undefined; /** * @public - *

    The field to sort results by. The default is Name.

    + *

    If the job fails, provides information why the job failed.

    */ - SortBy?: CodeRepositorySortBy; + FailureReason?: string; /** * @public - *

    The sort order for results. The default is Ascending.

    + *

    The name of the created model.

    */ - SortOrder?: CodeRepositorySortOrder; -} + ModelName?: string; -/** - * @public - */ -export interface ListCodeRepositoriesOutput { /** * @public - *

    Gets a list of summaries of the Git repositories. Each summary specifies the following - * values for the repository:

    - *
      - *
    • - *

      Name

      - *
      • - *
    • - *

      Amazon Resource Name (ARN)

      - *
      • - *
    • - *

      Creation time

      - *
      • - *
    • - *

      Last modified time

      - *
      • - *
    • - *

      Configuration information, including the URL location of the repository and - * the ARN of the Amazon Web Services Secrets Manager secret that contains the - * credentials used to access the repository.

      - *
      • - *
    + *

    The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. + * This path must point to a single gzip compressed tar archive (.tar.gz suffix).

    */ - CodeRepositorySummaryList: CodeRepositorySummary[] | undefined; + SamplePayloadUrl?: string; /** * @public - *

    If the result of a ListCodeRepositoriesOutput request was truncated, the - * response includes a NextToken. To get the next set of Git repositories, use - * the token in the next request.

    + *

    The Amazon Resource Name (ARN) of a versioned model package.

    */ - NextToken?: string; + ModelPackageVersionArn?: string; } /** * @public - * @enum - */ -export const ListCompilationJobsSortBy = { - CREATION_TIME: "CreationTime", - NAME: "Name", - STATUS: "Status", -} as const; - -/** - * @public - */ -export type ListCompilationJobsSortBy = (typeof ListCompilationJobsSortBy)[keyof typeof ListCompilationJobsSortBy]; - -/** - * @public + *

    The details for a specific benchmark from an Inference Recommender job.

    */ -export interface ListCompilationJobsRequest { +export interface RecommendationJobInferenceBenchmark { /** * @public - *

    If the result of the previous ListCompilationJobs request was truncated, - * the response includes a NextToken. To retrieve the next set of model - * compilation jobs, use the token in the next request.

    + *

    The metrics of recommendations.

    */ - NextToken?: string; + Metrics?: RecommendationMetrics; /** * @public - *

    The maximum number of model compilation jobs to return in the response.

    + *

    The endpoint configuration made by Inference Recommender during a recommendation job.

    */ - MaxResults?: number; + EndpointConfiguration?: EndpointOutputConfiguration; /** * @public - *

    A filter that returns the model compilation jobs that were created after a specified - * time.

    + *

    Defines the model configuration. Includes the specification name and environment parameters.

    */ - CreationTimeAfter?: Date; + ModelConfiguration: ModelConfiguration | undefined; /** * @public - *

    A filter that returns the model compilation jobs that were created before a specified - * time.

    + *

    The reason why a benchmark failed.

    */ - CreationTimeBefore?: Date; + FailureReason?: string; /** * @public - *

    A filter that returns the model compilation jobs that were modified after a specified - * time.

    + *

    The metrics for an existing endpoint compared in an Inference Recommender job.

    */ - LastModifiedTimeAfter?: Date; + EndpointMetrics?: InferenceMetrics; /** * @public - *

    A filter that returns the model compilation jobs that were modified before a specified - * time.

    + *

    A timestamp that shows when the benchmark completed.

    */ - LastModifiedTimeBefore?: Date; + InvocationEndTime?: Date; /** * @public - *

    A filter that returns the model compilation jobs whose name contains a specified - * string.

    + *

    A timestamp that shows when the benchmark started.

    */ - NameContains?: string; + InvocationStartTime?: Date; +} - /** - * @public - *

    A filter that retrieves model compilation jobs with a specific - * CompilationJobStatus status.

    - */ - StatusEquals?: CompilationJobStatus; +/** + * @public + * @enum + */ +export const RecommendationStepType = { + BENCHMARK: "BENCHMARK", +} as const; + +/** + * @public + */ +export type RecommendationStepType = (typeof RecommendationStepType)[keyof typeof RecommendationStepType]; +/** + * @public + *

    A returned array object for the Steps response field in the + * ListInferenceRecommendationsJobSteps API command.

    + */ +export interface InferenceRecommendationsJobStep { /** * @public - *

    The field by which to sort results. The default is CreationTime.

    + *

    The type of the subtask.

    + *

    + * BENCHMARK: Evaluate the performance of your model on different instance types.

    */ - SortBy?: ListCompilationJobsSortBy; + StepType: RecommendationStepType | undefined; /** * @public - *

    The sort order for results. The default is Ascending.

    + *

    The name of the Inference Recommender job.

    */ - SortOrder?: SortOrder; -} + JobName: string | undefined; -/** - * @public - */ -export interface ListCompilationJobsResponse { /** * @public - *

    An array of CompilationJobSummary objects, each describing a model compilation job. - *

    + *

    The current status of the benchmark.

    */ - CompilationJobSummaries: CompilationJobSummary[] | undefined; + Status: RecommendationJobStatus | undefined; /** * @public - *

    If the response is truncated, Amazon SageMaker returns this NextToken. To retrieve - * the next set of model compilation jobs, use this token in the next request.

    - */ - NextToken?: string; -} - -/** - * @public - * @enum - */ -export const SortContextsBy = { - CREATION_TIME: "CreationTime", - NAME: "Name", -} as const; + *

    The details for a specific benchmark.

    + */ + InferenceBenchmark?: RecommendationJobInferenceBenchmark; +} /** * @public + *

    Provides counts for human-labeled tasks in the labeling job.

    */ -export type SortContextsBy = (typeof SortContextsBy)[keyof typeof SortContextsBy]; +export interface LabelCountersForWorkteam { + /** + * @public + *

    The total number of data objects labeled by a human worker.

    + */ + HumanLabeled?: number; -/** - * @public - */ -export interface ListContextsRequest { /** * @public - *

    A filter that returns only contexts with the specified source URI.

    + *

    The total number of data objects that need to be labeled by a human worker.

    */ - SourceUri?: string; + PendingHuman?: number; /** * @public - *

    A filter that returns only contexts of the specified type.

    + *

    The total number of tasks in the labeling job.

    */ - ContextType?: string; + Total?: number; +} +/** + * @public + *

    Provides summary information for a work team.

    + */ +export interface LabelingJobForWorkteamSummary { /** * @public - *

    A filter that returns only contexts created on or after the specified time.

    + *

    The name of the labeling job that the work team is assigned to.

    */ - CreatedAfter?: Date; + LabelingJobName?: string; /** * @public - *

    A filter that returns only contexts created on or before the specified time.

    + *

    A unique identifier for a labeling job. You can use this to refer to a specific + * labeling job.

    */ - CreatedBefore?: Date; + JobReferenceCode: string | undefined; /** * @public - *

    The property used to sort results. The default value is CreationTime.

    + *

    The Amazon Web Services account ID of the account used to start the labeling + * job.

    */ - SortBy?: SortContextsBy; + WorkRequesterAccountId: string | undefined; /** * @public - *

    The sort order. The default value is Descending.

    + *

    The date and time that the labeling job was created.

    */ - SortOrder?: SortOrder; + CreationTime: Date | undefined; /** * @public - *

    If the previous call to ListContexts didn't return the full set of contexts, - * the call returns a token for getting the next set of contexts.

    + *

    Provides information about the progress of a labeling job.

    */ - NextToken?: string; + LabelCounters?: LabelCountersForWorkteam; /** * @public - *

    The maximum number of contexts to return in the response. The default value is 10.

    + *

    The configured number of workers per data object.

    */ - MaxResults?: number; + NumberOfHumanWorkersPerDataObject?: number; } /** * @public + *

    Provides summary information about a labeling job.

    */ -export interface ListContextsResponse { +export interface LabelingJobSummary { /** * @public - *

    A list of contexts and their properties.

    + *

    The name of the labeling job.

    */ - ContextSummaries?: ContextSummary[]; + LabelingJobName: string | undefined; /** * @public - *

    A token for getting the next set of contexts, if there are any.

    + *

    The Amazon Resource Name (ARN) assigned to the labeling job when it was + * created.

    */ - NextToken?: string; -} + LabelingJobArn: string | undefined; -/** - * @public - * @enum - */ -export const MonitoringJobDefinitionSortKey = { - CREATION_TIME: "CreationTime", - NAME: "Name", -} as const; + /** + * @public + *

    The date and time that the job was created (timestamp).

    + */ + CreationTime: Date | undefined; -/** - * @public - */ -export type MonitoringJobDefinitionSortKey = - (typeof MonitoringJobDefinitionSortKey)[keyof typeof MonitoringJobDefinitionSortKey]; + /** + * @public + *

    The date and time that the job was last modified (timestamp).

    + */ + LastModifiedTime: Date | undefined; -/** - * @public - */ -export interface ListDataQualityJobDefinitionsRequest { /** * @public - *

    A filter that lists the data quality job definitions associated with the specified - * endpoint.

    + *

    The current status of the labeling job.

    */ - EndpointName?: string; + LabelingJobStatus: LabelingJobStatus | undefined; /** * @public - *

    The field to sort results by. The default is CreationTime.

    + *

    Counts showing the progress of the labeling job.

    */ - SortBy?: MonitoringJobDefinitionSortKey; + LabelCounters: LabelCounters | undefined; /** * @public - *

    Whether to sort the results in Ascending or Descending order. - * The default is Descending.

    + *

    The Amazon Resource Name (ARN) of the work team assigned to the job.

    */ - SortOrder?: SortOrder; + WorkteamArn: string | undefined; /** * @public - *

    If the result of the previous ListDataQualityJobDefinitions request was - * truncated, the response includes a NextToken. To retrieve the next set of - * transform jobs, use the token in the next request.>

    + *

    The Amazon Resource Name (ARN) of a Lambda function. The function is run before each + * data object is sent to a worker.

    */ - NextToken?: string; + PreHumanTaskLambdaArn: string | undefined; /** * @public - *

    The maximum number of data quality monitoring job definitions to return in the - * response.

    + *

    The Amazon Resource Name (ARN) of the Lambda function used to consolidate the + * annotations from individual workers into a label for a data object. For more + * information, see Annotation + * Consolidation.

    */ - MaxResults?: number; + AnnotationConsolidationLambdaArn?: string; /** * @public - *

    A string in the data quality monitoring job definition name. This filter returns only - * data quality monitoring job definitions whose name contains the specified string.

    + *

    If the LabelingJobStatus field is Failed, this field + * contains a description of the error.

    */ - NameContains?: string; + FailureReason?: string; /** * @public - *

    A filter that returns only data quality monitoring job definitions created before the - * specified time.

    + *

    The location of the output produced by the labeling job.

    */ - CreationTimeBefore?: Date; + LabelingJobOutput?: LabelingJobOutput; /** * @public - *

    A filter that returns only data quality monitoring job definitions created after the - * specified time.

    + *

    Input configuration for the labeling job.

    */ - CreationTimeAfter?: Date; + InputConfig?: LabelingJobInputConfig; } /** * @public - *

    Summary information about a monitoring job.

    + *

    Metadata for a Lambda step.

    */ -export interface MonitoringJobDefinitionSummary { +export interface LambdaStepMetadata { /** * @public - *

    The name of the monitoring job.

    + *

    The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution.

    */ - MonitoringJobDefinitionName: string | undefined; + Arn?: string; /** * @public - *

    The Amazon Resource Name (ARN) of the monitoring job.

    + *

    A list of the output parameters of the Lambda step.

    */ - MonitoringJobDefinitionArn: string | undefined; + OutputParameters?: OutputParameter[]; +} + +/** + * @public + *

    Lists a summary of the properties of a lineage group. A lineage group provides a group of shareable lineage entity + * resources.

    + */ +export interface LineageGroupSummary { + /** + * @public + *

    The Amazon Resource Name (ARN) of the lineage group resource.

    + */ + LineageGroupArn?: string; /** * @public - *

    The time that the monitoring job was created.

    + *

    The name or Amazon Resource Name (ARN) of the lineage group.

    */ - CreationTime: Date | undefined; + LineageGroupName?: string; /** * @public - *

    The name of the endpoint that the job monitors.

    + *

    The display name of the lineage group summary.

    */ - EndpointName: string | undefined; -} + DisplayName?: string; -/** - * @public - */ -export interface ListDataQualityJobDefinitionsResponse { /** * @public - *

    A list of data quality monitoring job definitions.

    + *

    The creation time of the lineage group summary.

    */ - JobDefinitionSummaries: MonitoringJobDefinitionSummary[] | undefined; + CreationTime?: Date; /** * @public - *

    If the result of the previous ListDataQualityJobDefinitions request was - * truncated, the response includes a NextToken. To retrieve the next set of data - * quality monitoring job definitions, use the token in the next request.

    + *

    The last modified time of the lineage group summary.

    */ - NextToken?: string; + LastModifiedTime?: Date; } /** * @public * @enum */ -export const ListDeviceFleetsSortBy = { - CreationTime: "CREATION_TIME", - LastModifiedTime: "LAST_MODIFIED_TIME", - Name: "NAME", +export const LineageType = { + ACTION: "Action", + ARTIFACT: "Artifact", + CONTEXT: "Context", + TRIAL_COMPONENT: "TrialComponent", } as const; /** * @public */ -export type ListDeviceFleetsSortBy = (typeof ListDeviceFleetsSortBy)[keyof typeof ListDeviceFleetsSortBy]; +export type LineageType = (typeof LineageType)[keyof typeof LineageType]; /** * @public + * @enum */ -export interface ListDeviceFleetsRequest { - /** - * @public - *

    The response from the last list when returning a list large enough to need tokening.

    - */ - NextToken?: string; +export const SortActionsBy = { + CREATION_TIME: "CreationTime", + NAME: "Name", +} as const; + +/** + * @public + */ +export type SortActionsBy = (typeof SortActionsBy)[keyof typeof SortActionsBy]; + +/** + * @public + * @enum + */ +export const SortOrder = { + ASCENDING: "Ascending", + DESCENDING: "Descending", +} as const; + +/** + * @public + */ +export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder]; +/** + * @public + */ +export interface ListActionsRequest { /** * @public - *

    The maximum number of results to select.

    + *

    A filter that returns only actions with the specified source URI.

    */ - MaxResults?: number; + SourceUri?: string; /** * @public - *

    Filter fleets where packaging job was created after specified time.

    + *

    A filter that returns only actions of the specified type.

    */ - CreationTimeAfter?: Date; + ActionType?: string; /** * @public - *

    Filter fleets where the edge packaging job was created before specified time.

    + *

    A filter that returns only actions created on or after the specified time.

    */ - CreationTimeBefore?: Date; + CreatedAfter?: Date; /** * @public - *

    Select fleets where the job was updated after X

    + *

    A filter that returns only actions created on or before the specified time.

    */ - LastModifiedTimeAfter?: Date; + CreatedBefore?: Date; /** * @public - *

    Select fleets where the job was updated before X

    + *

    The property used to sort results. The default value is CreationTime.

    */ - LastModifiedTimeBefore?: Date; + SortBy?: SortActionsBy; /** * @public - *

    Filter for fleets containing this name in their fleet device name.

    + *

    The sort order. The default value is Descending.

    */ - NameContains?: string; + SortOrder?: SortOrder; /** * @public - *

    The column to sort by.

    + *

    If the previous call to ListActions didn't return the full set of actions, + * the call returns a token for getting the next set of actions.

    */ - SortBy?: ListDeviceFleetsSortBy; + NextToken?: string; /** * @public - *

    What direction to sort in.

    + *

    The maximum number of actions to return in the response. The default value is 10.

    */ - SortOrder?: SortOrder; + MaxResults?: number; } /** * @public */ -export interface ListDeviceFleetsResponse { +export interface ListActionsResponse { /** * @public - *

    Summary of the device fleet.

    + *

    A list of actions and their properties.

    */ - DeviceFleetSummaries: DeviceFleetSummary[] | undefined; + ActionSummaries?: ActionSummary[]; /** * @public - *

    The response from the last list when returning a list large enough to need tokening.

    + *

    A token for getting the next set of actions, if there are any.

    */ NextToken?: string; } @@ -3848,51 +3979,71 @@ export interface ListDeviceFleetsResponse { /** * @public */ -export interface ListDevicesRequest { +export interface ListAlgorithmsInput { /** * @public - *

    The response from the last list when returning a list large enough to need tokening.

    + *

    A filter that returns only algorithms created after the specified time + * (timestamp).

    */ - NextToken?: string; + CreationTimeAfter?: Date; /** * @public - *

    Maximum number of results to select.

    + *

    A filter that returns only algorithms created before the specified time + * (timestamp).

    + */ + CreationTimeBefore?: Date; + + /** + * @public + *

    The maximum number of algorithms to return in the response.

    */ MaxResults?: number; /** * @public - *

    Select fleets where the job was updated after X

    + *

    A string in the algorithm name. This filter returns only algorithms whose name + * contains the specified string.

    */ - LatestHeartbeatAfter?: Date; + NameContains?: string; /** * @public - *

    A filter that searches devices that contains this name in any of their models.

    + *

    If the response to a previous ListAlgorithms request was truncated, the + * response includes a NextToken. To retrieve the next set of algorithms, use + * the token in the next request.

    */ - ModelName?: string; + NextToken?: string; /** * @public - *

    Filter for fleets containing this name in their device fleet name.

    + *

    The parameter by which to sort the results. The default is + * CreationTime.

    */ - DeviceFleetName?: string; + SortBy?: AlgorithmSortBy; + + /** + * @public + *

    The sort order for the results. The default is Ascending.

    + */ + SortOrder?: SortOrder; } /** * @public */ -export interface ListDevicesResponse { +export interface ListAlgorithmsOutput { /** * @public - *

    Summary of devices.

    + *

    >An array of AlgorithmSummary objects, each of which lists an + * algorithm.

    */ - DeviceSummaries: DeviceSummary[] | undefined; + AlgorithmSummaryList: AlgorithmSummary[] | undefined; /** * @public - *

    The response from the last list when returning a list large enough to need tokening.

    + *

    If the response is truncated, SageMaker returns this token. To retrieve the next set of + * algorithms, use it in the subsequent request.

    */ NextToken?: string; } @@ -3900,123 +4051,115 @@ export interface ListDevicesResponse { /** * @public */ -export interface ListDomainsRequest { +export interface ListAliasesRequest { /** * @public - *

    If the previous response was truncated, you will receive this token. - * Use it in your next request to receive the next set of results.

    + *

    The name of the image.

    */ - NextToken?: string; + ImageName: string | undefined; /** * @public - *

    The total number of items to return in the response. If the total - * number of items available is more than the value specified, a NextToken - * is provided in the response. To resume pagination, provide the NextToken - * value in the as part of a subsequent call. The default value is 10.

    + *

    The alias of the image version.

    */ - MaxResults?: number; -} + Alias?: string; -/** - * @public - */ -export interface ListDomainsResponse { /** * @public - *

    The list of domains.

    + *

    The version of the image. If image version is not specified, the aliases of all versions of the image are listed.

    */ - Domains?: DomainDetails[]; + Version?: number; /** * @public - *

    If the previous response was truncated, you will receive this token. - * Use it in your next request to receive the next set of results.

    + *

    The maximum number of aliases to return.

    + */ + MaxResults?: number; + + /** + * @public + *

    If the previous call to ListAliases didn't return the full set of + * aliases, the call returns a token for retrieving the next set of aliases.

    */ NextToken?: string; } -/** - * @public - * @enum - */ -export const ListEdgeDeploymentPlansSortBy = { - CreationTime: "CREATION_TIME", - DeviceFleetName: "DEVICE_FLEET_NAME", - LastModifiedTime: "LAST_MODIFIED_TIME", - Name: "NAME", -} as const; - /** * @public */ -export type ListEdgeDeploymentPlansSortBy = - (typeof ListEdgeDeploymentPlansSortBy)[keyof typeof ListEdgeDeploymentPlansSortBy]; +export interface ListAliasesResponse { + /** + * @public + *

    A list of SageMaker image version aliases.

    + */ + SageMakerImageVersionAliases?: string[]; -/** - * @public - */ -export interface ListEdgeDeploymentPlansRequest { /** * @public - *

    The response from the last list when returning a list large enough to need - * tokening.

    + *

    A token for getting the next set of aliases, if more aliases exist.

    */ NextToken?: string; +} +/** + * @public + */ +export interface ListAppImageConfigsRequest { /** * @public - *

    The maximum number of results to select (50 by default).

    + *

    The total number of items to return in the response. If the total + * number of items available is more than the value specified, a NextToken + * is provided in the response. To resume pagination, provide the NextToken + * value in the as part of a subsequent call. The default value is 10.

    */ MaxResults?: number; /** * @public - *

    Selects edge deployment plans created after this time.

    + *

    If the previous call to ListImages didn't return the full set of + * AppImageConfigs, the call returns a token for getting the next set of AppImageConfigs.

    */ - CreationTimeAfter?: Date; + NextToken?: string; /** * @public - *

    Selects edge deployment plans created before this time.

    + *

    A filter that returns only AppImageConfigs whose name contains the specified string.

    */ - CreationTimeBefore?: Date; + NameContains?: string; /** * @public - *

    Selects edge deployment plans that were last updated after this time.

    + *

    A filter that returns only AppImageConfigs created on or before the specified time.

    */ - LastModifiedTimeAfter?: Date; + CreationTimeBefore?: Date; /** * @public - *

    Selects edge deployment plans that were last updated before this time.

    + *

    A filter that returns only AppImageConfigs created on or after the specified time.

    */ - LastModifiedTimeBefore?: Date; + CreationTimeAfter?: Date; /** * @public - *

    Selects edge deployment plans with names containing this name.

    + *

    A filter that returns only AppImageConfigs modified on or before the specified time.

    */ - NameContains?: string; + ModifiedTimeBefore?: Date; /** * @public - *

    Selects edge deployment plans with a device fleet name containing this name.

    + *

    A filter that returns only AppImageConfigs modified on or after the specified time.

    */ - DeviceFleetNameContains?: string; + ModifiedTimeAfter?: Date; /** * @public - *

    The column by which to sort the edge deployment plans. Can be one of - * NAME, DEVICEFLEETNAME, CREATIONTIME, - * LASTMODIFIEDTIME.

    + *

    The property used to sort results. The default value is CreationTime.

    */ - SortBy?: ListEdgeDeploymentPlansSortBy; + SortBy?: AppImageConfigSortKey; /** * @public - *

    The direction of the sorting (ascending or descending).

    + *

    The sort order. The default value is Descending.

    */ SortOrder?: SortOrder; } @@ -4024,122 +4167,85 @@ export interface ListEdgeDeploymentPlansRequest { /** * @public */ -export interface ListEdgeDeploymentPlansResponse { +export interface ListAppImageConfigsResponse { /** * @public - *

    List of summaries of edge deployment plans.

    + *

    A token for getting the next set of AppImageConfigs, if there are any.

    */ - EdgeDeploymentPlanSummaries: EdgeDeploymentPlanSummary[] | undefined; + NextToken?: string; /** * @public - *

    The token to use when calling the next page of results.

    + *

    A list of AppImageConfigs and their properties.

    */ - NextToken?: string; + AppImageConfigs?: AppImageConfigDetails[]; } -/** - * @public - * @enum - */ -export const ListEdgePackagingJobsSortBy = { - CreationTime: "CREATION_TIME", - EdgePackagingJobStatus: "STATUS", - LastModifiedTime: "LAST_MODIFIED_TIME", - ModelName: "MODEL_NAME", - Name: "NAME", -} as const; - /** * @public */ -export type ListEdgePackagingJobsSortBy = - (typeof ListEdgePackagingJobsSortBy)[keyof typeof ListEdgePackagingJobsSortBy]; - -/** - * @public - */ -export interface ListEdgePackagingJobsRequest { +export interface ListAppsRequest { /** * @public - *

    The response from the last list when returning a list large enough to need tokening.

    + *

    If the previous response was truncated, you will receive this token. + * Use it in your next request to receive the next set of results.

    */ NextToken?: string; /** * @public - *

    Maximum number of results to select.

    + *

    The total number of items to return in the response. If the total + * number of items available is more than the value specified, a NextToken + * is provided in the response. To resume pagination, provide the NextToken + * value in the as part of a subsequent call. The default value is 10.

    */ MaxResults?: number; /** * @public - *

    Select jobs where the job was created after specified time.

    - */ - CreationTimeAfter?: Date; - - /** - * @public - *

    Select jobs where the job was created before specified time.

    - */ - CreationTimeBefore?: Date; - - /** - * @public - *

    Select jobs where the job was updated after specified time.

    - */ - LastModifiedTimeAfter?: Date; - - /** - * @public - *

    Select jobs where the job was updated before specified time.

    - */ - LastModifiedTimeBefore?: Date; - - /** - * @public - *

    Filter for jobs containing this name in their packaging job name.

    + *

    The sort order for the results. The default is Ascending.

    */ - NameContains?: string; + SortOrder?: SortOrder; /** * @public - *

    Filter for jobs where the model name contains this string.

    + *

    The parameter by which to sort the results. The default is CreationTime.

    */ - ModelNameContains?: string; + SortBy?: AppSortKey; /** * @public - *

    The job status to filter for.

    + *

    A parameter to search for the domain ID.

    */ - StatusEquals?: EdgePackagingJobStatus; + DomainIdEquals?: string; /** * @public - *

    Use to specify what column to sort by.

    + *

    A parameter to search by user profile name. If SpaceNameEquals is set, then this value cannot be set.

    */ - SortBy?: ListEdgePackagingJobsSortBy; + UserProfileNameEquals?: string; /** * @public - *

    What direction to sort by.

    + *

    A parameter to search by space name. If UserProfileNameEquals is set, then this value cannot be set.

    */ - SortOrder?: SortOrder; + SpaceNameEquals?: string; } /** * @public */ -export interface ListEdgePackagingJobsResponse { +export interface ListAppsResponse { /** * @public - *

    Summaries of edge packaging jobs.

    + *

    The list of apps.

    */ - EdgePackagingJobSummaries: EdgePackagingJobSummary[] | undefined; + Apps?: AppDetails[]; /** * @public - *

    Token to use when calling the next page of results.

    + *

    If the previous response was truncated, you will receive this token. + * Use it in your next request to receive the next set of results.

    */ NextToken?: string; } @@ -4148,247 +4254,254 @@ export interface ListEdgePackagingJobsResponse { * @public * @enum */ -export const OrderKey = { - Ascending: "Ascending", - Descending: "Descending", +export const SortArtifactsBy = { + CREATION_TIME: "CreationTime", } as const; /** * @public */ -export type OrderKey = (typeof OrderKey)[keyof typeof OrderKey]; +export type SortArtifactsBy = (typeof SortArtifactsBy)[keyof typeof SortArtifactsBy]; /** * @public */ -export interface ListEndpointConfigsInput { +export interface ListArtifactsRequest { /** * @public - *

    The field to sort results by. The default is CreationTime.

    + *

    A filter that returns only artifacts with the specified source URI.

    */ - SortBy?: EndpointConfigSortKey; + SourceUri?: string; /** * @public - *

    The sort order for results. The default is Descending.

    + *

    A filter that returns only artifacts of the specified type.

    */ - SortOrder?: OrderKey; + ArtifactType?: string; /** * @public - *

    If the result of the previous ListEndpointConfig request was - * truncated, the response includes a NextToken. To retrieve the next set of - * endpoint configurations, use the token in the next request.

    + *

    A filter that returns only artifacts created on or after the specified time.

    */ - NextToken?: string; + CreatedAfter?: Date; /** * @public - *

    The maximum number of training jobs to return in the response.

    + *

    A filter that returns only artifacts created on or before the specified time.

    */ - MaxResults?: number; + CreatedBefore?: Date; /** * @public - *

    A string in the endpoint configuration name. This filter returns only endpoint - * configurations whose name contains the specified string.

    + *

    The property used to sort results. The default value is CreationTime.

    */ - NameContains?: string; + SortBy?: SortArtifactsBy; /** * @public - *

    A filter that returns only endpoint configurations created before the specified - * time (timestamp).

    + *

    The sort order. The default value is Descending.

    */ - CreationTimeBefore?: Date; + SortOrder?: SortOrder; /** * @public - *

    A filter that returns only endpoint configurations with a creation time greater - * than or equal to the specified time (timestamp).

    + *

    If the previous call to ListArtifacts didn't return the full set of artifacts, + * the call returns a token for getting the next set of artifacts.

    */ - CreationTimeAfter?: Date; + NextToken?: string; + + /** + * @public + *

    The maximum number of artifacts to return in the response. The default value is 10.

    + */ + MaxResults?: number; } /** * @public */ -export interface ListEndpointConfigsOutput { +export interface ListArtifactsResponse { /** * @public - *

    An array of endpoint configurations.

    + *

    A list of artifacts and their properties.

    */ - EndpointConfigs: EndpointConfigSummary[] | undefined; + ArtifactSummaries?: ArtifactSummary[]; /** * @public - *

    If the response is truncated, SageMaker returns this token. To retrieve the next set of - * endpoint configurations, use it in the subsequent request

    + *

    A token for getting the next set of artifacts, if there are any.

    */ NextToken?: string; } +/** + * @public + * @enum + */ +export const SortAssociationsBy = { + CREATION_TIME: "CreationTime", + DESTINATION_ARN: "DestinationArn", + DESTINATION_TYPE: "DestinationType", + SOURCE_ARN: "SourceArn", + SOURCE_TYPE: "SourceType", +} as const; + /** * @public */ -export interface ListEndpointsInput { +export type SortAssociationsBy = (typeof SortAssociationsBy)[keyof typeof SortAssociationsBy]; + +/** + * @public + */ +export interface ListAssociationsRequest { /** * @public - *

    Sorts the list of results. The default is CreationTime.

    + *

    A filter that returns only associations with the specified source ARN.

    */ - SortBy?: EndpointSortKey; + SourceArn?: string; /** * @public - *

    The sort order for results. The default is Descending.

    + *

    A filter that returns only associations with the specified destination Amazon Resource Name (ARN).

    */ - SortOrder?: OrderKey; + DestinationArn?: string; /** * @public - *

    If the result of a ListEndpoints request was truncated, the response - * includes a NextToken. To retrieve the next set of endpoints, use the token - * in the next request.

    + *

    A filter that returns only associations with the specified source type.

    */ - NextToken?: string; + SourceType?: string; /** * @public - *

    The maximum number of endpoints to return in the response. This value defaults to - * 10.

    + *

    A filter that returns only associations with the specified destination type.

    */ - MaxResults?: number; + DestinationType?: string; /** * @public - *

    A string in endpoint names. This filter returns only endpoints whose name contains - * the specified string.

    + *

    A filter that returns only associations of the specified type.

    */ - NameContains?: string; + AssociationType?: AssociationEdgeType; /** * @public - *

    A filter that returns only endpoints that were created before the specified time - * (timestamp).

    + *

    A filter that returns only associations created on or after the specified time.

    */ - CreationTimeBefore?: Date; + CreatedAfter?: Date; /** * @public - *

    A filter that returns only endpoints with a creation time greater than or equal to - * the specified time (timestamp).

    + *

    A filter that returns only associations created on or before the specified time.

    */ - CreationTimeAfter?: Date; + CreatedBefore?: Date; /** * @public - *

    A filter that returns only endpoints that were modified before the specified - * timestamp.

    + *

    The property used to sort results. The default value is CreationTime.

    */ - LastModifiedTimeBefore?: Date; + SortBy?: SortAssociationsBy; /** * @public - *

    A filter that returns only endpoints that were modified after the specified - * timestamp.

    + *

    The sort order. The default value is Descending.

    */ - LastModifiedTimeAfter?: Date; + SortOrder?: SortOrder; /** * @public - *

    A filter that returns only endpoints with the specified status.

    + *

    If the previous call to ListAssociations didn't return the full set of associations, + * the call returns a token for getting the next set of associations.

    */ - StatusEquals?: EndpointStatus; + NextToken?: string; + + /** + * @public + *

    The maximum number of associations to return in the response. The default value is 10.

    + */ + MaxResults?: number; } /** * @public */ -export interface ListEndpointsOutput { +export interface ListAssociationsResponse { /** * @public - *

    An array or endpoint objects.

    + *

    A list of associations and their properties.

    */ - Endpoints: EndpointSummary[] | undefined; + AssociationSummaries?: AssociationSummary[]; /** * @public - *

    If the response is truncated, SageMaker returns this token. To retrieve the next set of - * training jobs, use it in the subsequent request.

    + *

    A token for getting the next set of associations, if there are any.

    */ NextToken?: string; } /** * @public - * @enum */ -export const SortExperimentsBy = { - CREATION_TIME: "CreationTime", - NAME: "Name", -} as const; +export interface ListAutoMLJobsRequest { + /** + * @public + *

    Request a list of jobs, using a filter for time.

    + */ + CreationTimeAfter?: Date; -/** - * @public - */ -export type SortExperimentsBy = (typeof SortExperimentsBy)[keyof typeof SortExperimentsBy]; + /** + * @public + *

    Request a list of jobs, using a filter for time.

    + */ + CreationTimeBefore?: Date; -/** - * @public - */ -export interface ListExperimentsRequest { /** * @public - *

    A filter that returns only experiments created after the specified time.

    + *

    Request a list of jobs, using a filter for time.

    */ - CreatedAfter?: Date; + LastModifiedTimeAfter?: Date; /** * @public - *

    A filter that returns only experiments created before the specified time.

    + *

    Request a list of jobs, using a filter for time.

    */ - CreatedBefore?: Date; + LastModifiedTimeBefore?: Date; /** * @public - *

    The property used to sort results. The default value is CreationTime.

    + *

    Request a list of jobs, using a search filter for name.

    */ - SortBy?: SortExperimentsBy; + NameContains?: string; /** * @public - *

    The sort order. The default value is Descending.

    + *

    Request a list of jobs, using a filter for status.

    */ - SortOrder?: SortOrder; + StatusEquals?: AutoMLJobStatus; /** * @public - *

    If the previous call to ListExperiments didn't return the full set of - * experiments, the call returns a token for getting the next set of experiments.

    + *

    The sort order for the results. The default is Descending.

    */ - NextToken?: string; + SortOrder?: AutoMLSortOrder; /** * @public - *

    The maximum number of experiments to return in the response. The default value is - * 10.

    + *

    The parameter by which to sort the results. The default is Name.

    */ - MaxResults?: number; -} + SortBy?: AutoMLSortBy; -/** - * @public - */ -export interface ListExperimentsResponse { /** * @public - *

    A list of the summaries of your experiments.

    + *

    Request a list of jobs up to a specified limit.

    */ - ExperimentSummaries?: ExperimentSummary[]; + MaxResults?: number; /** * @public - *

    A token for getting the next set of experiments, if there are any.

    + *

    If the previous response was truncated, you receive this token. Use it in your next + * request to receive the next set of results.

    */ NextToken?: string; } @@ -4396,62 +4509,66 @@ export interface ListExperimentsResponse { /** * @public */ -export interface ListFeatureGroupsRequest { +export interface ListAutoMLJobsResponse { /** * @public - *

    A string that partially matches one or more FeatureGroups names. Filters - * FeatureGroups by name.

    + *

    Returns a summary list of jobs.

    */ - NameContains?: string; + AutoMLJobSummaries: AutoMLJobSummary[] | undefined; /** * @public - *

    A FeatureGroup status. Filters by FeatureGroup status.

    + *

    If the previous response was truncated, you receive this token. Use it in your next + * request to receive the next set of results.

    */ - FeatureGroupStatusEquals?: FeatureGroupStatus; + NextToken?: string; +} +/** + * @public + */ +export interface ListCandidatesForAutoMLJobRequest { /** * @public - *

    An OfflineStore status. Filters by OfflineStore status. - *

    + *

    List the candidates created for the job by providing the job's name.

    */ - OfflineStoreStatusEquals?: OfflineStoreStatusValue; + AutoMLJobName: string | undefined; /** * @public - *

    Use this parameter to search for FeatureGroupss created after a specific - * date and time.

    + *

    List the candidates for the job and filter by status.

    */ - CreationTimeAfter?: Date; + StatusEquals?: CandidateStatus; /** * @public - *

    Use this parameter to search for FeatureGroupss created before a specific - * date and time.

    + *

    List the candidates for the job and filter by candidate name.

    */ - CreationTimeBefore?: Date; + CandidateNameEquals?: string; /** * @public - *

    The order in which feature groups are listed.

    + *

    The sort order for the results. The default is Ascending.

    */ - SortOrder?: FeatureGroupSortOrder; + SortOrder?: AutoMLSortOrder; /** * @public - *

    The value on which the feature group list is sorted.

    + *

    The parameter by which to sort the results. The default is + * Descending.

    */ - SortBy?: FeatureGroupSortBy; + SortBy?: CandidateSortBy; /** * @public - *

    The maximum number of results returned by ListFeatureGroups.

    + *

    List the job's candidates up to a specified limit.

    */ MaxResults?: number; /** * @public - *

    A token to resume pagination of ListFeatureGroups results.

    + *

    If the previous response was truncated, you receive this token. Use it in your next + * request to receive the next set of results.

    */ NextToken?: string; } @@ -4459,349 +4576,500 @@ export interface ListFeatureGroupsRequest { /** * @public */ -export interface ListFeatureGroupsResponse { +export interface ListCandidatesForAutoMLJobResponse { /** * @public - *

    A summary of feature groups.

    + *

    Summaries about the AutoMLCandidates.

    */ - FeatureGroupSummaries: FeatureGroupSummary[] | undefined; + Candidates: AutoMLCandidate[] | undefined; /** * @public - *

    A token to resume pagination of ListFeatureGroups results.

    + *

    If the previous response was truncated, you receive this token. Use it in your next + * request to receive the next set of results.

    */ - NextToken: string | undefined; + NextToken?: string; } /** * @public */ -export interface ListFlowDefinitionsRequest { +export interface ListClusterNodesRequest { /** * @public - *

    A filter that returns only flow definitions with a creation time greater than or equal to the specified timestamp.

    + *

    The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve the list of nodes.

    + */ + ClusterName: string | undefined; + + /** + * @public + *

    A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time. Timestamps are + * formatted according to the ISO 8601 standard.

    + *

    Acceptable formats include:

    + *
      + *
    • + *

      + * YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example, + * 2014-10-01T20:30:00.000Z + *

      + *
      • + *
    • + *

      + * YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example, + * 2014-10-01T12:30:00.000-08:00 + *

      + *
      • + *
    • + *

      + * YYYY-MM-DD, for example, 2014-10-01 + *

      + *
      • + *
    • + *

      Unix time in seconds, for example, 1412195400. This is also referred to as Unix + * Epoch time and represents the number of seconds since midnight, January 1, 1970 + * UTC.

      + *
      • + *
    + *

    For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User + * Guide.

    */ CreationTimeAfter?: Date; /** * @public - *

    A filter that returns only flow definitions that were created before the specified timestamp.

    + *

    A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The + * acceptable formats are the same as the timestamp formats for + * CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User + * Guide.

    */ CreationTimeBefore?: Date; /** * @public - *

    An optional value that specifies whether you want the results sorted in Ascending or Descending order.

    + *

    A filter that returns the instance groups whose name contain a specified string.

    */ - SortOrder?: SortOrder; + InstanceGroupNameContains?: string; /** * @public - *

    A token to resume pagination.

    + *

    The maximum number of nodes to return in the response.

    */ - NextToken?: string; + MaxResults?: number; /** * @public - *

    The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.

    + *

    If the result of the previous ListClusterNodes request was truncated, the + * response includes a NextToken. To retrieve the next set of cluster nodes, use + * the token in the next request.

    */ - MaxResults?: number; -} + NextToken?: string; -/** - * @public - */ -export interface ListFlowDefinitionsResponse { /** * @public - *

    An array of objects describing the flow definitions.

    + *

    The field by which to sort results. The default value is + * CREATION_TIME.

    */ - FlowDefinitionSummaries: FlowDefinitionSummary[] | undefined; + SortBy?: ClusterSortBy; /** * @public - *

    A token to resume pagination.

    + *

    The sort order for results. The default value is Ascending.

    */ - NextToken?: string; + SortOrder?: SortOrder; } /** * @public */ -export interface ListHubContentsRequest { - /** - * @public - *

    The name of the hub to list the contents of.

    - */ - HubName: string | undefined; - +export interface ListClusterNodesResponse { /** * @public - *

    The type of hub content to list.

    + *

    The next token specified for listing instances in a SageMaker HyperPod cluster.

    */ - HubContentType: HubContentType | undefined; + NextToken: string | undefined; /** * @public - *

    Only list hub content if the name contains the specified string.

    + *

    The summaries of listed instances in a SageMaker HyperPod cluster

    */ - NameContains?: string; + ClusterNodeSummaries: ClusterNodeSummary[] | undefined; +} +/** + * @public + */ +export interface ListClustersRequest { /** * @public - *

    The upper bound of the hub content schema verion.

    + *

    Set a start time for the time range during which you want to list SageMaker HyperPod clusters. + * Timestamps are formatted according to the ISO 8601 standard.

    + *

    Acceptable formats include:

    + *
      + *
    • + *

      + * YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example, + * 2014-10-01T20:30:00.000Z + *

      + *
      • + *
    • + *

      + * YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example, + * 2014-10-01T12:30:00.000-08:00 + *

      + *
      • + *
    • + *

      + * YYYY-MM-DD, for example, 2014-10-01 + *

      + *
      • + *
    • + *

      Unix time in seconds, for example, 1412195400. This is also referred + * to as Unix Epoch time and represents the number of seconds since midnight, January 1, + * 1970 UTC.

      + *
      • + *
    + *

    For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User + * Guide.

    */ - MaxSchemaVersion?: string; + CreationTimeAfter?: Date; /** * @public - *

    Only list hub content that was created before the time specified.

    + *

    Set an end time for the time range during which you want to list SageMaker HyperPod clusters. A + * filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable + * formats are the same as the timestamp formats for CreationTimeAfter. For more + * information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User + * Guide.

    */ CreationTimeBefore?: Date; /** * @public - *

    Only list hub content that was created after the time specified.

    + *

    Set the maximum number of SageMaker HyperPod clusters to list.

    */ - CreationTimeAfter?: Date; + MaxResults?: number; /** * @public - *

    Sort hub content versions by either name or creation time.

    + *

    Set the maximum number of instances to print in the list.

    */ - SortBy?: HubContentSortBy; + NameContains?: string; /** * @public - *

    Sort hubs by ascending or descending order.

    + *

    Set the next token to retrieve the list of SageMaker HyperPod clusters.

    */ - SortOrder?: SortOrder; + NextToken?: string; /** * @public - *

    The maximum amount of hub content to list.

    + *

    The field by which to sort results. The default value is + * CREATION_TIME.

    */ - MaxResults?: number; + SortBy?: ClusterSortBy; /** * @public - *

    If the response to a previous ListHubContents request was truncated, the response includes a NextToken. To retrieve the next set of hub content, use the token in the next request.

    + *

    The sort order for results. The default value is Ascending.

    */ - NextToken?: string; + SortOrder?: SortOrder; } /** * @public */ -export interface ListHubContentsResponse { +export interface ListClustersResponse { /** * @public - *

    The summaries of the listed hub content.

    + *

    If the result of the previous ListClusters request was truncated, the + * response includes a NextToken. To retrieve the next set of clusters, use the + * token in the next request.

    */ - HubContentSummaries: HubContentInfo[] | undefined; + NextToken: string | undefined; /** * @public - *

    If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content, use it in the subsequent request.

    + *

    The summaries of listed SageMaker HyperPod clusters.

    */ - NextToken?: string; + ClusterSummaries: ClusterSummary[] | undefined; } /** * @public */ -export interface ListHubContentVersionsRequest { +export interface ListCodeRepositoriesInput { /** * @public - *

    The name of the hub to list the content versions of.

    + *

    A filter that returns only Git repositories that were created after the specified + * time.

    */ - HubName: string | undefined; + CreationTimeAfter?: Date; /** * @public - *

    The type of hub content to list versions of.

    + *

    A filter that returns only Git repositories that were created before the specified + * time.

    */ - HubContentType: HubContentType | undefined; + CreationTimeBefore?: Date; /** * @public - *

    The name of the hub content.

    + *

    A filter that returns only Git repositories that were last modified after the + * specified time.

    */ - HubContentName: string | undefined; + LastModifiedTimeAfter?: Date; /** * @public - *

    The lower bound of the hub content versions to list.

    + *

    A filter that returns only Git repositories that were last modified before the + * specified time.

    */ - MinVersion?: string; + LastModifiedTimeBefore?: Date; /** * @public - *

    The upper bound of the hub content schema version.

    + *

    The maximum number of Git repositories to return in the response.

    */ - MaxSchemaVersion?: string; + MaxResults?: number; /** * @public - *

    Only list hub content versions that were created before the time specified.

    + *

    A string in the Git repositories name. This filter returns only repositories whose + * name contains the specified string.

    */ - CreationTimeBefore?: Date; + NameContains?: string; /** * @public - *

    Only list hub content versions that were created after the time specified.

    + *

    If the result of a ListCodeRepositoriesOutput request was truncated, the + * response includes a NextToken. To get the next set of Git repositories, use + * the token in the next request.

    */ - CreationTimeAfter?: Date; + NextToken?: string; /** * @public - *

    Sort hub content versions by either name or creation time.

    + *

    The field to sort results by. The default is Name.

    */ - SortBy?: HubContentSortBy; + SortBy?: CodeRepositorySortBy; /** * @public - *

    Sort hub content versions by ascending or descending order.

    + *

    The sort order for results. The default is Ascending.

    */ - SortOrder?: SortOrder; + SortOrder?: CodeRepositorySortOrder; +} +/** + * @public + */ +export interface ListCodeRepositoriesOutput { /** * @public - *

    The maximum number of hub content versions to list.

    + *

    Gets a list of summaries of the Git repositories. Each summary specifies the following + * values for the repository:

    + *
      + *
    • + *

      Name

      + *
      • + *
    • + *

      Amazon Resource Name (ARN)

      + *
      • + *
    • + *

      Creation time

      + *
      • + *
    • + *

      Last modified time

      + *
      • + *
    • + *

      Configuration information, including the URL location of the repository and + * the ARN of the Amazon Web Services Secrets Manager secret that contains the + * credentials used to access the repository.

      + *
      • + *
    */ - MaxResults?: number; + CodeRepositorySummaryList: CodeRepositorySummary[] | undefined; /** * @public - *

    If the response to a previous ListHubContentVersions request was truncated, the response includes a NextToken. To retrieve the next set of hub content versions, use the token in the next request.

    + *

    If the result of a ListCodeRepositoriesOutput request was truncated, the + * response includes a NextToken. To get the next set of Git repositories, use + * the token in the next request.

    */ NextToken?: string; } /** * @public + * @enum */ -export interface ListHubContentVersionsResponse { +export const ListCompilationJobsSortBy = { + CREATION_TIME: "CreationTime", + NAME: "Name", + STATUS: "Status", +} as const; + +/** + * @public + */ +export type ListCompilationJobsSortBy = (typeof ListCompilationJobsSortBy)[keyof typeof ListCompilationJobsSortBy]; + +/** + * @public + */ +export interface ListCompilationJobsRequest { /** * @public - *

    The summaries of the listed hub content versions.

    + *

    If the result of the previous ListCompilationJobs request was truncated, + * the response includes a NextToken. To retrieve the next set of model + * compilation jobs, use the token in the next request.

    */ - HubContentSummaries: HubContentInfo[] | undefined; + NextToken?: string; /** * @public - *

    If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content versions, use it in the subsequent request.

    + *

    The maximum number of model compilation jobs to return in the response.

    */ - NextToken?: string; -} + MaxResults?: number; -/** - * @public - */ -export interface ListHubsRequest { /** * @public - *

    Only list hubs with names that contain the specified string.

    + *

    A filter that returns the model compilation jobs that were created after a specified + * time.

    */ - NameContains?: string; + CreationTimeAfter?: Date; /** * @public - *

    Only list hubs that were created before the time specified.

    + *

    A filter that returns the model compilation jobs that were created before a specified + * time.

    */ CreationTimeBefore?: Date; /** * @public - *

    Only list hubs that were created after the time specified.

    + *

    A filter that returns the model compilation jobs that were modified after a specified + * time.

    */ - CreationTimeAfter?: Date; + LastModifiedTimeAfter?: Date; /** * @public - *

    Only list hubs that were last modified before the time specified.

    + *

    A filter that returns the model compilation jobs that were modified before a specified + * time.

    */ LastModifiedTimeBefore?: Date; /** * @public - *

    Only list hubs that were last modified after the time specified.

    + *

    A filter that returns the model compilation jobs whose name contains a specified + * string.

    */ - LastModifiedTimeAfter?: Date; + NameContains?: string; /** * @public - *

    Sort hubs by either name or creation time.

    + *

    A filter that retrieves model compilation jobs with a specific + * CompilationJobStatus status.

    */ - SortBy?: HubSortBy; + StatusEquals?: CompilationJobStatus; /** * @public - *

    Sort hubs by ascending or descending order.

    + *

    The field by which to sort results. The default is CreationTime.

    + */ + SortBy?: ListCompilationJobsSortBy; + + /** + * @public + *

    The sort order for results. The default is Ascending.

    */ SortOrder?: SortOrder; +} +/** + * @public + */ +export interface ListCompilationJobsResponse { /** * @public - *

    The maximum number of hubs to list.

    + *

    An array of CompilationJobSummary objects, each describing a model compilation job. + *

    */ - MaxResults?: number; + CompilationJobSummaries: CompilationJobSummary[] | undefined; /** * @public - *

    If the response to a previous ListHubs request was truncated, the response includes a NextToken. To retrieve the next set of hubs, use the token in the next request.

    + *

    If the response is truncated, Amazon SageMaker returns this NextToken. To retrieve + * the next set of model compilation jobs, use this token in the next request.

    */ NextToken?: string; } /** * @public + * @enum */ -export interface ListHubsResponse { +export const SortContextsBy = { + CREATION_TIME: "CreationTime", + NAME: "Name", +} as const; + +/** + * @public + */ +export type SortContextsBy = (typeof SortContextsBy)[keyof typeof SortContextsBy]; + +/** + * @public + */ +export interface ListContextsRequest { /** * @public - *

    The summaries of the listed hubs.

    + *

    A filter that returns only contexts with the specified source URI.

    */ - HubSummaries: HubInfo[] | undefined; + SourceUri?: string; /** * @public - *

    If the response is truncated, SageMaker returns this token. To retrieve the next set of hubs, use it in the subsequent request.

    + *

    A filter that returns only contexts of the specified type.

    */ - NextToken?: string; -} + ContextType?: string; -/** - * @public - */ -export interface ListHumanTaskUisRequest { /** * @public - *

    A filter that returns only human task user interfaces with a creation time greater than or equal to the specified timestamp.

    + *

    A filter that returns only contexts created on or after the specified time.

    */ - CreationTimeAfter?: Date; + CreatedAfter?: Date; /** * @public - *

    A filter that returns only human task user interfaces that were created before the specified timestamp.

    + *

    A filter that returns only contexts created on or before the specified time.

    */ - CreationTimeBefore?: Date; + CreatedBefore?: Date; /** * @public - *

    An optional value that specifies whether you want the results sorted in Ascending or Descending order.

    + *

    The property used to sort results. The default value is CreationTime.

    + */ + SortBy?: SortContextsBy; + + /** + * @public + *

    The sort order. The default value is Descending.

    */ SortOrder?: SortOrder; /** * @public - *

    A token to resume pagination.

    + *

    If the previous call to ListContexts didn't return the full set of contexts, + * the call returns a token for getting the next set of contexts.

    */ NextToken?: string; /** * @public - *

    The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.

    + *

    The maximum number of contexts to return in the response. The default value is 10.

    */ MaxResults?: number; } @@ -4809,189 +5077,232 @@ export interface ListHumanTaskUisRequest { /** * @public */ -export interface ListHumanTaskUisResponse { +export interface ListContextsResponse { /** * @public - *

    An array of objects describing the human task user interfaces.

    + *

    A list of contexts and their properties.

    */ - HumanTaskUiSummaries: HumanTaskUiSummary[] | undefined; + ContextSummaries?: ContextSummary[]; /** * @public - *

    A token to resume pagination.

    + *

    A token for getting the next set of contexts, if there are any.

    */ NextToken?: string; } /** * @public + * @enum */ -export interface ListHyperParameterTuningJobsRequest { +export const MonitoringJobDefinitionSortKey = { + CREATION_TIME: "CreationTime", + NAME: "Name", +} as const; + +/** + * @public + */ +export type MonitoringJobDefinitionSortKey = + (typeof MonitoringJobDefinitionSortKey)[keyof typeof MonitoringJobDefinitionSortKey]; + +/** + * @public + */ +export interface ListDataQualityJobDefinitionsRequest { /** * @public - *

    If the result of the previous ListHyperParameterTuningJobs request was - * truncated, the response includes a NextToken. To retrieve the next set of - * tuning jobs, use the token in the next request.

    + *

    A filter that lists the data quality job definitions associated with the specified + * endpoint.

    */ - NextToken?: string; + EndpointName?: string; /** * @public - *

    The - * maximum number of tuning jobs to return. The default value is - * 10.

    + *

    The field to sort results by. The default is CreationTime.

    */ - MaxResults?: number; + SortBy?: MonitoringJobDefinitionSortKey; /** * @public - *

    The field to sort results by. The default is Name.

    + *

    Whether to sort the results in Ascending or Descending order. + * The default is Descending.

    */ - SortBy?: HyperParameterTuningJobSortByOptions; + SortOrder?: SortOrder; /** * @public - *

    The sort order for results. The default is Ascending.

    + *

    If the result of the previous ListDataQualityJobDefinitions request was + * truncated, the response includes a NextToken. To retrieve the next set of + * transform jobs, use the token in the next request.>

    */ - SortOrder?: SortOrder; + NextToken?: string; /** * @public - *

    A string in the tuning job name. This filter returns only tuning jobs whose name - * contains the specified string.

    + *

    The maximum number of data quality monitoring job definitions to return in the + * response.

    + */ + MaxResults?: number; + + /** + * @public + *

    A string in the data quality monitoring job definition name. This filter returns only + * data quality monitoring job definitions whose name contains the specified string.

    */ NameContains?: string; /** * @public - *

    A filter that returns only tuning jobs that were created after the specified - * time.

    + *

    A filter that returns only data quality monitoring job definitions created before the + * specified time.

    + */ + CreationTimeBefore?: Date; + + /** + * @public + *

    A filter that returns only data quality monitoring job definitions created after the + * specified time.

    */ CreationTimeAfter?: Date; +} +/** + * @public + *

    Summary information about a monitoring job.

    + */ +export interface MonitoringJobDefinitionSummary { /** * @public - *

    A filter that returns only tuning jobs that were created before the specified - * time.

    + *

    The name of the monitoring job.

    */ - CreationTimeBefore?: Date; + MonitoringJobDefinitionName: string | undefined; /** * @public - *

    A filter that returns only tuning jobs that were modified after the specified - * time.

    + *

    The Amazon Resource Name (ARN) of the monitoring job.

    */ - LastModifiedTimeAfter?: Date; + MonitoringJobDefinitionArn: string | undefined; /** * @public - *

    A filter that returns only tuning jobs that were modified before the specified - * time.

    + *

    The time that the monitoring job was created.

    */ - LastModifiedTimeBefore?: Date; + CreationTime: Date | undefined; /** * @public - *

    A filter that returns only tuning jobs with the specified status.

    + *

    The name of the endpoint that the job monitors.

    */ - StatusEquals?: HyperParameterTuningJobStatus; + EndpointName: string | undefined; } /** * @public */ -export interface ListHyperParameterTuningJobsResponse { +export interface ListDataQualityJobDefinitionsResponse { /** * @public - *

    A list of HyperParameterTuningJobSummary objects that - * describe - * the tuning jobs that the ListHyperParameterTuningJobs - * request returned.

    + *

    A list of data quality monitoring job definitions.

    */ - HyperParameterTuningJobSummaries: HyperParameterTuningJobSummary[] | undefined; + JobDefinitionSummaries: MonitoringJobDefinitionSummary[] | undefined; /** * @public - *

    If the result of this ListHyperParameterTuningJobs request was truncated, - * the response includes a NextToken. To retrieve the next set of tuning jobs, - * use the token in the next request.

    + *

    If the result of the previous ListDataQualityJobDefinitions request was + * truncated, the response includes a NextToken. To retrieve the next set of data + * quality monitoring job definitions, use the token in the next request.

    */ NextToken?: string; } /** * @public + * @enum */ -export interface ListImagesRequest { +export const ListDeviceFleetsSortBy = { + CreationTime: "CREATION_TIME", + LastModifiedTime: "LAST_MODIFIED_TIME", + Name: "NAME", +} as const; + +/** + * @public + */ +export type ListDeviceFleetsSortBy = (typeof ListDeviceFleetsSortBy)[keyof typeof ListDeviceFleetsSortBy]; + +/** + * @public + */ +export interface ListDeviceFleetsRequest { /** * @public - *

    A filter that returns only images created on or after the specified time.

    + *

    The response from the last list when returning a list large enough to need tokening.

    */ - CreationTimeAfter?: Date; + NextToken?: string; /** * @public - *

    A filter that returns only images created on or before the specified time.

    + *

    The maximum number of results to select.

    */ - CreationTimeBefore?: Date; + MaxResults?: number; /** * @public - *

    A filter that returns only images modified on or after the specified time.

    + *

    Filter fleets where packaging job was created after specified time.

    */ - LastModifiedTimeAfter?: Date; + CreationTimeAfter?: Date; /** * @public - *

    A filter that returns only images modified on or before the specified time.

    + *

    Filter fleets where the edge packaging job was created before specified time.

    */ - LastModifiedTimeBefore?: Date; + CreationTimeBefore?: Date; /** * @public - *

    The maximum number of images to return in the response. The default value is 10.

    + *

    Select fleets where the job was updated after X

    */ - MaxResults?: number; + LastModifiedTimeAfter?: Date; /** * @public - *

    A filter that returns only images whose name contains the specified string.

    + *

    Select fleets where the job was updated before X

    */ - NameContains?: string; + LastModifiedTimeBefore?: Date; /** * @public - *

    If the previous call to ListImages didn't return the full set of images, - * the call returns a token for getting the next set of images.

    + *

    Filter for fleets containing this name in their fleet device name.

    */ - NextToken?: string; + NameContains?: string; /** * @public - *

    The property used to sort results. The default value is CREATION_TIME.

    + *

    The column to sort by.

    */ - SortBy?: ImageSortBy; + SortBy?: ListDeviceFleetsSortBy; /** * @public - *

    The sort order. The default value is DESCENDING.

    + *

    What direction to sort in.

    */ - SortOrder?: ImageSortOrder; + SortOrder?: SortOrder; } /** * @public */ -export interface ListImagesResponse { +export interface ListDeviceFleetsResponse { /** * @public - *

    A list of images and their properties.

    + *

    Summary of the device fleet.

    */ - Images?: Image[]; + DeviceFleetSummaries: DeviceFleetSummary[] | undefined; /** * @public - *

    A token for getting the next set of images, if there are any.

    + *

    The response from the last list when returning a list large enough to need tokening.

    */ NextToken?: string; } @@ -4999,76 +5310,90 @@ export interface ListImagesResponse { /** * @public */ -export interface ListImageVersionsRequest { +export interface ListDevicesRequest { /** * @public - *

    A filter that returns only versions created on or after the specified time.

    + *

    The response from the last list when returning a list large enough to need tokening.

    */ - CreationTimeAfter?: Date; + NextToken?: string; /** * @public - *

    A filter that returns only versions created on or before the specified time.

    + *

    Maximum number of results to select.

    */ - CreationTimeBefore?: Date; + MaxResults?: number; /** * @public - *

    The name of the image to list the versions of.

    + *

    Select fleets where the job was updated after X

    */ - ImageName: string | undefined; + LatestHeartbeatAfter?: Date; /** * @public - *

    A filter that returns only versions modified on or after the specified time.

    + *

    A filter that searches devices that contains this name in any of their models.

    */ - LastModifiedTimeAfter?: Date; + ModelName?: string; /** * @public - *

    A filter that returns only versions modified on or before the specified time.

    + *

    Filter for fleets containing this name in their device fleet name.

    */ - LastModifiedTimeBefore?: Date; + DeviceFleetName?: string; +} +/** + * @public + */ +export interface ListDevicesResponse { /** * @public - *

    The maximum number of versions to return in the response. The default value is 10.

    + *

    Summary of devices.

    */ - MaxResults?: number; + DeviceSummaries: DeviceSummary[] | undefined; /** * @public - *

    If the previous call to ListImageVersions didn't return the full set of - * versions, the call returns a token for getting the next set of versions.

    + *

    The response from the last list when returning a list large enough to need tokening.

    */ NextToken?: string; +} +/** + * @public + */ +export interface ListDomainsRequest { /** * @public - *

    The property used to sort results. The default value is CREATION_TIME.

    + *

    If the previous response was truncated, you will receive this token. + * Use it in your next request to receive the next set of results.

    */ - SortBy?: ImageVersionSortBy; + NextToken?: string; /** * @public - *

    The sort order. The default value is DESCENDING.

    + *

    The total number of items to return in the response. If the total + * number of items available is more than the value specified, a NextToken + * is provided in the response. To resume pagination, provide the NextToken + * value in the as part of a subsequent call. The default value is 10.

    */ - SortOrder?: ImageVersionSortOrder; + MaxResults?: number; } /** * @public */ -export interface ListImageVersionsResponse { +export interface ListDomainsResponse { /** * @public - *

    A list of versions and their properties.

    + *

    The list of domains.

    */ - ImageVersions?: ImageVersion[]; + Domains?: DomainDetails[]; /** * @public - *

    A token for getting the next set of versions, if there are any.

    + *

    If the previous response was truncated, you will receive this token. + * Use it in your next request to receive the next set of results.

    */ NextToken?: string; } @@ -5077,103 +5402,96 @@ export interface ListImageVersionsResponse { * @public * @enum */ -export const SortInferenceExperimentsBy = { - CREATION_TIME: "CreationTime", - NAME: "Name", - STATUS: "Status", +export const ListEdgeDeploymentPlansSortBy = { + CreationTime: "CREATION_TIME", + DeviceFleetName: "DEVICE_FLEET_NAME", + LastModifiedTime: "LAST_MODIFIED_TIME", + Name: "NAME", } as const; /** * @public */ -export type SortInferenceExperimentsBy = (typeof SortInferenceExperimentsBy)[keyof typeof SortInferenceExperimentsBy]; +export type ListEdgeDeploymentPlansSortBy = + (typeof ListEdgeDeploymentPlansSortBy)[keyof typeof ListEdgeDeploymentPlansSortBy]; /** * @public */ -export interface ListInferenceExperimentsRequest { - /** - * @public - *

    Selects inference experiments whose names contain this name.

    - */ - NameContains?: string; - +export interface ListEdgeDeploymentPlansRequest { /** * @public - *

    - * Selects inference experiments of this type. For the possible types of inference experiments, see CreateInferenceExperiment. - *

    + *

    The response from the last list when returning a list large enough to need + * tokening.

    */ - Type?: InferenceExperimentType; + NextToken?: string; /** * @public - *

    - * Selects inference experiments which are in this status. For the possible statuses, see DescribeInferenceExperiment. - *

    + *

    The maximum number of results to select (50 by default).

    */ - StatusEquals?: InferenceExperimentStatus; + MaxResults?: number; /** * @public - *

    Selects inference experiments which were created after this timestamp.

    + *

    Selects edge deployment plans created after this time.

    */ CreationTimeAfter?: Date; /** * @public - *

    Selects inference experiments which were created before this timestamp.

    + *

    Selects edge deployment plans created before this time.

    */ CreationTimeBefore?: Date; /** * @public - *

    Selects inference experiments which were last modified after this timestamp.

    + *

    Selects edge deployment plans that were last updated after this time.

    */ LastModifiedTimeAfter?: Date; /** * @public - *

    Selects inference experiments which were last modified before this timestamp.

    + *

    Selects edge deployment plans that were last updated before this time.

    */ LastModifiedTimeBefore?: Date; /** * @public - *

    The column by which to sort the listed inference experiments.

    + *

    Selects edge deployment plans with names containing this name.

    */ - SortBy?: SortInferenceExperimentsBy; + NameContains?: string; /** * @public - *

    The direction of sorting (ascending or descending).

    + *

    Selects edge deployment plans with a device fleet name containing this name.

    */ - SortOrder?: SortOrder; + DeviceFleetNameContains?: string; /** * @public - *

    - * The response from the last list when returning a list large enough to need tokening. - *

    + *

    The column by which to sort the edge deployment plans. Can be one of + * NAME, DEVICEFLEETNAME, CREATIONTIME, + * LASTMODIFIEDTIME.

    */ - NextToken?: string; + SortBy?: ListEdgeDeploymentPlansSortBy; /** * @public - *

    The maximum number of results to select.

    + *

    The direction of the sorting (ascending or descending).

    */ - MaxResults?: number; + SortOrder?: SortOrder; } /** * @public */ -export interface ListInferenceExperimentsResponse { +export interface ListEdgeDeploymentPlansResponse { /** * @public - *

    List of inference experiments.

    + *

    List of summaries of edge deployment plans.

    */ - InferenceExperiments?: InferenceExperimentSummary[]; + EdgeDeploymentPlanSummaries: EdgeDeploymentPlanSummary[] | undefined; /** * @public @@ -5186,164 +5504,104 @@ export interface ListInferenceExperimentsResponse { * @public * @enum */ -export const ListInferenceRecommendationsJobsSortBy = { - CREATION_TIME: "CreationTime", - NAME: "Name", - STATUS: "Status", +export const ListEdgePackagingJobsSortBy = { + CreationTime: "CREATION_TIME", + EdgePackagingJobStatus: "STATUS", + LastModifiedTime: "LAST_MODIFIED_TIME", + ModelName: "MODEL_NAME", + Name: "NAME", } as const; /** * @public */ -export type ListInferenceRecommendationsJobsSortBy = - (typeof ListInferenceRecommendationsJobsSortBy)[keyof typeof ListInferenceRecommendationsJobsSortBy]; +export type ListEdgePackagingJobsSortBy = + (typeof ListEdgePackagingJobsSortBy)[keyof typeof ListEdgePackagingJobsSortBy]; /** * @public */ -export interface ListInferenceRecommendationsJobsRequest { - /** - * @public - *

    A filter that returns only jobs created after the specified time (timestamp).

    - */ - CreationTimeAfter?: Date; - - /** - * @public - *

    A filter that returns only jobs created before the specified time (timestamp).

    - */ - CreationTimeBefore?: Date; - - /** - * @public - *

    A filter that returns only jobs that were last modified after the specified time (timestamp).

    - */ - LastModifiedTimeAfter?: Date; - - /** - * @public - *

    A filter that returns only jobs that were last modified before the specified time (timestamp).

    - */ - LastModifiedTimeBefore?: Date; - - /** - * @public - *

    A string in the job name. This filter returns only recommendations whose name contains the specified string.

    - */ - NameContains?: string; - - /** - * @public - *

    A filter that retrieves only inference recommendations jobs with a specific status.

    - */ - StatusEquals?: RecommendationJobStatus; - - /** - * @public - *

    The parameter by which to sort the results.

    - */ - SortBy?: ListInferenceRecommendationsJobsSortBy; - - /** - * @public - *

    The sort order for the results.

    - */ - SortOrder?: SortOrder; - +export interface ListEdgePackagingJobsRequest { /** * @public - *

    If the response to a previous ListInferenceRecommendationsJobsRequest request - * was truncated, the response includes a NextToken. To retrieve the next set - * of recommendations, use the token in the next request.

    + *

    The response from the last list when returning a list large enough to need tokening.

    */ NextToken?: string; /** * @public - *

    The maximum number of recommendations to return in the response.

    + *

    Maximum number of results to select.

    */ MaxResults?: number; /** * @public - *

    A filter that returns only jobs that were created for this model.

    + *

    Select jobs where the job was created after specified time.

    */ - ModelNameEquals?: string; + CreationTimeAfter?: Date; /** * @public - *

    A filter that returns only jobs that were created for this versioned model package.

    + *

    Select jobs where the job was created before specified time.

    */ - ModelPackageVersionArnEquals?: string; -} + CreationTimeBefore?: Date; -/** - * @public - */ -export interface ListInferenceRecommendationsJobsResponse { /** * @public - *

    The recommendations created from the Amazon SageMaker Inference Recommender job.

    + *

    Select jobs where the job was updated after specified time.

    */ - InferenceRecommendationsJobs: InferenceRecommendationsJob[] | undefined; + LastModifiedTimeAfter?: Date; /** * @public - *

    A token for getting the next set of recommendations, if there are any.

    + *

    Select jobs where the job was updated before specified time.

    */ - NextToken?: string; -} + LastModifiedTimeBefore?: Date; -/** - * @public - */ -export interface ListInferenceRecommendationsJobStepsRequest { /** * @public - *

    The name for the Inference Recommender job.

    + *

    Filter for jobs containing this name in their packaging job name.

    */ - JobName: string | undefined; + NameContains?: string; /** * @public - *

    A filter to return benchmarks of a specified status. If this field is left empty, then all benchmarks are returned.

    + *

    Filter for jobs where the model name contains this string.

    */ - Status?: RecommendationJobStatus; + ModelNameContains?: string; /** * @public - *

    A filter to return details about the specified type of subtask.

    - *

    - * BENCHMARK: Evaluate the performance of your model on different instance types.

    + *

    The job status to filter for.

    */ - StepType?: RecommendationStepType; + StatusEquals?: EdgePackagingJobStatus; /** * @public - *

    The maximum number of results to return.

    + *

    Use to specify what column to sort by.

    */ - MaxResults?: number; + SortBy?: ListEdgePackagingJobsSortBy; /** * @public - *

    A token that you can specify to return more results from the list. Specify this field if you have a token that was returned from a previous request.

    + *

    What direction to sort by.

    */ - NextToken?: string; + SortOrder?: SortOrder; } /** * @public */ -export interface ListInferenceRecommendationsJobStepsResponse { +export interface ListEdgePackagingJobsResponse { /** * @public - *

    A list of all subtask details in Inference Recommender.

    + *

    Summaries of edge packaging jobs.

    */ - Steps?: InferenceRecommendationsJobStep[]; + EdgePackagingJobSummaries: EdgePackagingJobSummary[] | undefined; /** * @public - *

    A token that you can specify in your next request to return more results from the list.

    + *

    Token to use when calling the next page of results.

    */ NextToken?: string; } @@ -5352,196 +5610,173 @@ export interface ListInferenceRecommendationsJobStepsResponse { * @public * @enum */ -export const SortBy = { - CREATION_TIME: "CreationTime", - NAME: "Name", - STATUS: "Status", +export const OrderKey = { + Ascending: "Ascending", + Descending: "Descending", } as const; /** * @public */ -export type SortBy = (typeof SortBy)[keyof typeof SortBy]; - -/** - * @public - */ -export interface ListLabelingJobsRequest { - /** - * @public - *

    A filter that returns only labeling jobs created after the specified time - * (timestamp).

    - */ - CreationTimeAfter?: Date; - - /** - * @public - *

    A filter that returns only labeling jobs created before the specified time - * (timestamp).

    - */ - CreationTimeBefore?: Date; - - /** - * @public - *

    A filter that returns only labeling jobs modified after the specified time - * (timestamp).

    - */ - LastModifiedTimeAfter?: Date; +export type OrderKey = (typeof OrderKey)[keyof typeof OrderKey]; +/** + * @public + */ +export interface ListEndpointConfigsInput { /** * @public - *

    A filter that returns only labeling jobs modified before the specified time - * (timestamp).

    + *

    The field to sort results by. The default is CreationTime.

    */ - LastModifiedTimeBefore?: Date; + SortBy?: EndpointConfigSortKey; /** * @public - *

    The maximum number of labeling jobs to return in each page of the response.

    + *

    The sort order for results. The default is Descending.

    */ - MaxResults?: number; + SortOrder?: OrderKey; /** * @public - *

    If the result of the previous ListLabelingJobs request was truncated, the - * response includes a NextToken. To retrieve the next set of labeling jobs, - * use the token in the next request.

    + *

    If the result of the previous ListEndpointConfig request was + * truncated, the response includes a NextToken. To retrieve the next set of + * endpoint configurations, use the token in the next request.

    */ NextToken?: string; /** * @public - *

    A string in the labeling job name. This filter returns only labeling jobs whose name - * contains the specified string.

    + *

    The maximum number of training jobs to return in the response.

    */ - NameContains?: string; + MaxResults?: number; /** * @public - *

    The field to sort results by. The default is CreationTime.

    + *

    A string in the endpoint configuration name. This filter returns only endpoint + * configurations whose name contains the specified string.

    */ - SortBy?: SortBy; + NameContains?: string; /** * @public - *

    The sort order for results. The default is Ascending.

    + *

    A filter that returns only endpoint configurations created before the specified + * time (timestamp).

    */ - SortOrder?: SortOrder; + CreationTimeBefore?: Date; /** * @public - *

    A filter that retrieves only labeling jobs with a specific status.

    + *

    A filter that returns only endpoint configurations with a creation time greater + * than or equal to the specified time (timestamp).

    */ - StatusEquals?: LabelingJobStatus; + CreationTimeAfter?: Date; } /** * @public */ -export interface ListLabelingJobsResponse { +export interface ListEndpointConfigsOutput { /** * @public - *

    An array of LabelingJobSummary objects, each describing a labeling - * job.

    + *

    An array of endpoint configurations.

    */ - LabelingJobSummaryList?: LabelingJobSummary[]; + EndpointConfigs: EndpointConfigSummary[] | undefined; /** * @public - *

    If the response is truncated, SageMaker returns this token. To retrieve the next set of - * labeling jobs, use it in the subsequent request.

    + *

    If the response is truncated, SageMaker returns this token. To retrieve the next set of + * endpoint configurations, use it in the subsequent request

    */ NextToken?: string; } /** * @public - * @enum */ -export const ListLabelingJobsForWorkteamSortByOptions = { - CREATION_TIME: "CreationTime", -} as const; +export interface ListEndpointsInput { + /** + * @public + *

    Sorts the list of results. The default is CreationTime.

    + */ + SortBy?: EndpointSortKey; -/** - * @public - */ -export type ListLabelingJobsForWorkteamSortByOptions = - (typeof ListLabelingJobsForWorkteamSortByOptions)[keyof typeof ListLabelingJobsForWorkteamSortByOptions]; + /** + * @public + *

    The sort order for results. The default is Descending.

    + */ + SortOrder?: OrderKey; -/** - * @public - */ -export interface ListLabelingJobsForWorkteamRequest { /** * @public - *

    The Amazon Resource Name (ARN) of the work team for which you want to see labeling - * jobs for.

    + *

    If the result of a ListEndpoints request was truncated, the response + * includes a NextToken. To retrieve the next set of endpoints, use the token + * in the next request.

    */ - WorkteamArn: string | undefined; + NextToken?: string; /** * @public - *

    The maximum number of labeling jobs to return in each page of the response.

    + *

    The maximum number of endpoints to return in the response. This value defaults to + * 10.

    */ MaxResults?: number; /** * @public - *

    If the result of the previous ListLabelingJobsForWorkteam request was - * truncated, the response includes a NextToken. To retrieve the next set of - * labeling jobs, use the token in the next request.

    + *

    A string in endpoint names. This filter returns only endpoints whose name contains + * the specified string.

    */ - NextToken?: string; + NameContains?: string; /** * @public - *

    A filter that returns only labeling jobs created after the specified time + *

    A filter that returns only endpoints that were created before the specified time * (timestamp).

    */ - CreationTimeAfter?: Date; + CreationTimeBefore?: Date; /** * @public - *

    A filter that returns only labeling jobs created before the specified time - * (timestamp).

    + *

    A filter that returns only endpoints with a creation time greater than or equal to + * the specified time (timestamp).

    */ - CreationTimeBefore?: Date; + CreationTimeAfter?: Date; /** * @public - *

    A filter the limits jobs to only the ones whose job reference code contains the - * specified string.

    + *

    A filter that returns only endpoints that were modified before the specified + * timestamp.

    */ - JobReferenceCodeContains?: string; + LastModifiedTimeBefore?: Date; /** * @public - *

    The field to sort results by. The default is CreationTime.

    + *

    A filter that returns only endpoints that were modified after the specified + * timestamp.

    */ - SortBy?: ListLabelingJobsForWorkteamSortByOptions; + LastModifiedTimeAfter?: Date; /** * @public - *

    The sort order for results. The default is Ascending.

    + *

    A filter that returns only endpoints with the specified status.

    */ - SortOrder?: SortOrder; + StatusEquals?: EndpointStatus; } /** * @public */ -export interface ListLabelingJobsForWorkteamResponse { +export interface ListEndpointsOutput { /** * @public - *

    An array of LabelingJobSummary objects, each describing a labeling - * job.

    + *

    An array or endpoint objects.

    */ - LabelingJobSummaryList: LabelingJobForWorkteamSummary[] | undefined; + Endpoints: EndpointSummary[] | undefined; /** * @public - *

    If the response is truncated, SageMaker returns this token. To retrieve the next set of - * labeling jobs, use it in the subsequent request.

    + *

    If the response is truncated, SageMaker returns this token. To retrieve the next set of + * training jobs, use it in the subsequent request.

    */ NextToken?: string; } @@ -5550,7 +5785,7 @@ export interface ListLabelingJobsForWorkteamResponse { * @public * @enum */ -export const SortLineageGroupsBy = { +export const SortExperimentsBy = { CREATION_TIME: "CreationTime", NAME: "Name", } as const; @@ -5558,48 +5793,47 @@ export const SortLineageGroupsBy = { /** * @public */ -export type SortLineageGroupsBy = (typeof SortLineageGroupsBy)[keyof typeof SortLineageGroupsBy]; +export type SortExperimentsBy = (typeof SortExperimentsBy)[keyof typeof SortExperimentsBy]; /** * @public */ -export interface ListLineageGroupsRequest { +export interface ListExperimentsRequest { /** * @public - *

    A timestamp to filter against lineage groups created after a certain point in time.

    + *

    A filter that returns only experiments created after the specified time.

    */ CreatedAfter?: Date; /** * @public - *

    A timestamp to filter against lineage groups created before a certain point in time.

    + *

    A filter that returns only experiments created before the specified time.

    */ CreatedBefore?: Date; /** * @public - *

    The parameter by which to sort the results. The default is - * CreationTime.

    + *

    The property used to sort results. The default value is CreationTime.

    */ - SortBy?: SortLineageGroupsBy; + SortBy?: SortExperimentsBy; /** * @public - *

    The sort order for the results. The default is Ascending.

    + *

    The sort order. The default value is Descending.

    */ SortOrder?: SortOrder; /** * @public - *

    If the response is truncated, SageMaker returns this token. To retrieve the next set of - * algorithms, use it in the subsequent request.

    + *

    If the previous call to ListExperiments didn't return the full set of + * experiments, the call returns a token for getting the next set of experiments.

    */ NextToken?: string; /** * @public - *

    The maximum number of endpoints to return in the response. This value defaults to - * 10.

    + *

    The maximum number of experiments to return in the response. The default value is + * 10.

    */ MaxResults?: number; } @@ -5607,17 +5841,16 @@ export interface ListLineageGroupsRequest { /** * @public */ -export interface ListLineageGroupsResponse { +export interface ListExperimentsResponse { /** * @public - *

    A list of lineage groups and their properties.

    + *

    A list of the summaries of your experiments.

    */ - LineageGroupSummaries?: LineageGroupSummary[]; + ExperimentSummaries?: ExperimentSummary[]; /** * @public - *

    If the response is truncated, SageMaker returns this token. To retrieve the next set of - * algorithms, use it in the subsequent request.

    + *

    A token for getting the next set of experiments, if there are any.

    */ NextToken?: string; } @@ -5625,540 +5858,602 @@ export interface ListLineageGroupsResponse { /** * @public */ -export interface ListModelBiasJobDefinitionsRequest { +export interface ListFeatureGroupsRequest { /** * @public - *

    Name of the endpoint to monitor for model bias.

    + *

    A string that partially matches one or more FeatureGroups names. Filters + * FeatureGroups by name.

    */ - EndpointName?: string; + NameContains?: string; /** * @public - *

    Whether to sort results by the Name or CreationTime field. - * The default is CreationTime.

    + *

    A FeatureGroup status. Filters by FeatureGroup status.

    */ - SortBy?: MonitoringJobDefinitionSortKey; + FeatureGroupStatusEquals?: FeatureGroupStatus; /** * @public - *

    Whether to sort the results in Ascending or Descending order. - * The default is Descending.

    + *

    An OfflineStore status. Filters by OfflineStore status. + *

    */ - SortOrder?: SortOrder; + OfflineStoreStatusEquals?: OfflineStoreStatusValue; /** * @public - *

    The token returned if the response is truncated. To retrieve the next set of job executions, use - * it in the next request.

    + *

    Use this parameter to search for FeatureGroupss created after a specific + * date and time.

    */ - NextToken?: string; + CreationTimeAfter?: Date; /** * @public - *

    The maximum number of model bias jobs to return in the response. The default value is - * 10.

    + *

    Use this parameter to search for FeatureGroupss created before a specific + * date and time.

    */ - MaxResults?: number; + CreationTimeBefore?: Date; /** * @public - *

    Filter for model bias jobs whose name contains a specified string.

    + *

    The order in which feature groups are listed.

    */ - NameContains?: string; + SortOrder?: FeatureGroupSortOrder; /** * @public - *

    A filter that returns only model bias jobs created before a specified time.

    + *

    The value on which the feature group list is sorted.

    */ - CreationTimeBefore?: Date; + SortBy?: FeatureGroupSortBy; /** * @public - *

    A filter that returns only model bias jobs created after a specified time.

    + *

    The maximum number of results returned by ListFeatureGroups.

    */ - CreationTimeAfter?: Date; + MaxResults?: number; + + /** + * @public + *

    A token to resume pagination of ListFeatureGroups results.

    + */ + NextToken?: string; } /** * @public */ -export interface ListModelBiasJobDefinitionsResponse { +export interface ListFeatureGroupsResponse { /** * @public - *

    A JSON array in which each element is a summary for a model bias jobs.

    + *

    A summary of feature groups.

    */ - JobDefinitionSummaries: MonitoringJobDefinitionSummary[] | undefined; + FeatureGroupSummaries: FeatureGroupSummary[] | undefined; /** * @public - *

    The token returned if the response is truncated. To retrieve the next set of job executions, use - * it in the next request.

    + *

    A token to resume pagination of ListFeatureGroups results.

    */ - NextToken?: string; + NextToken: string | undefined; } /** * @public - * @enum */ -export const ModelCardExportJobSortBy = { - CREATION_TIME: "CreationTime", - NAME: "Name", - STATUS: "Status", -} as const; +export interface ListFlowDefinitionsRequest { + /** + * @public + *

    A filter that returns only flow definitions with a creation time greater than or equal to the specified timestamp.

    + */ + CreationTimeAfter?: Date; + + /** + * @public + *

    A filter that returns only flow definitions that were created before the specified timestamp.

    + */ + CreationTimeBefore?: Date; + + /** + * @public + *

    An optional value that specifies whether you want the results sorted in Ascending or Descending order.

    + */ + SortOrder?: SortOrder; + + /** + * @public + *

    A token to resume pagination.

    + */ + NextToken?: string; + + /** + * @public + *

    The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.

    + */ + MaxResults?: number; +} /** * @public */ -export type ModelCardExportJobSortBy = (typeof ModelCardExportJobSortBy)[keyof typeof ModelCardExportJobSortBy]; +export interface ListFlowDefinitionsResponse { + /** + * @public + *

    An array of objects describing the flow definitions.

    + */ + FlowDefinitionSummaries: FlowDefinitionSummary[] | undefined; -/** - * @public - * @enum - */ -export const ModelCardExportJobSortOrder = { - ASCENDING: "Ascending", - DESCENDING: "Descending", -} as const; + /** + * @public + *

    A token to resume pagination.

    + */ + NextToken?: string; +} /** * @public */ -export type ModelCardExportJobSortOrder = - (typeof ModelCardExportJobSortOrder)[keyof typeof ModelCardExportJobSortOrder]; +export interface ListHubContentsRequest { + /** + * @public + *

    The name of the hub to list the contents of.

    + */ + HubName: string | undefined; -/** - * @public - */ -export interface ListModelCardExportJobsRequest { /** * @public - *

    List export jobs for the model card with the specified name.

    + *

    The type of hub content to list.

    */ - ModelCardName: string | undefined; + HubContentType: HubContentType | undefined; /** * @public - *

    List export jobs for the model card with the specified version.

    + *

    Only list hub content if the name contains the specified string.

    */ - ModelCardVersion?: number; + NameContains?: string; /** * @public - *

    Only list model card export jobs that were created after the time specified.

    + *

    The upper bound of the hub content schema verion.

    */ - CreationTimeAfter?: Date; + MaxSchemaVersion?: string; /** * @public - *

    Only list model card export jobs that were created before the time specified.

    + *

    Only list hub content that was created before the time specified.

    */ CreationTimeBefore?: Date; /** * @public - *

    Only list model card export jobs with names that contain the specified string.

    + *

    Only list hub content that was created after the time specified.

    */ - ModelCardExportJobNameContains?: string; + CreationTimeAfter?: Date; /** * @public - *

    Only list model card export jobs with the specified status.

    + *

    Sort hub content versions by either name or creation time.

    */ - StatusEquals?: ModelCardExportJobStatus; + SortBy?: HubContentSortBy; /** * @public - *

    Sort model card export jobs by either name or creation time. Sorts by creation time by default.

    + *

    Sort hubs by ascending or descending order.

    */ - SortBy?: ModelCardExportJobSortBy; + SortOrder?: SortOrder; /** * @public - *

    Sort model card export jobs by ascending or descending order.

    + *

    The maximum amount of hub content to list.

    */ - SortOrder?: ModelCardExportJobSortOrder; + MaxResults?: number; /** * @public - *

    If the response to a previous ListModelCardExportJobs request was - * truncated, the response includes a NextToken. To retrieve the next set of - * model card export jobs, use the token in the next request.

    + *

    If the response to a previous ListHubContents request was truncated, the response includes a NextToken. To retrieve the next set of hub content, use the token in the next request.

    */ NextToken?: string; +} +/** + * @public + */ +export interface ListHubContentsResponse { /** * @public - *

    The maximum number of model card export jobs to list.

    + *

    The summaries of the listed hub content.

    */ - MaxResults?: number; + HubContentSummaries: HubContentInfo[] | undefined; + + /** + * @public + *

    If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content, use it in the subsequent request.

    + */ + NextToken?: string; } /** * @public - *

    The summary of the Amazon SageMaker Model Card export job.

    */ -export interface ModelCardExportJobSummary { +export interface ListHubContentVersionsRequest { /** * @public - *

    The name of the model card export job.

    + *

    The name of the hub to list the content versions of.

    */ - ModelCardExportJobName: string | undefined; + HubName: string | undefined; /** * @public - *

    The Amazon Resource Name (ARN) of the model card export job.

    + *

    The type of hub content to list versions of.

    */ - ModelCardExportJobArn: string | undefined; + HubContentType: HubContentType | undefined; /** * @public - *

    The completion status of the model card export job.

    + *

    The name of the hub content.

    */ - Status: ModelCardExportJobStatus | undefined; + HubContentName: string | undefined; /** * @public - *

    The name of the model card that the export job exports.

    + *

    The lower bound of the hub content versions to list.

    */ - ModelCardName: string | undefined; + MinVersion?: string; /** * @public - *

    The version of the model card that the export job exports.

    + *

    The upper bound of the hub content schema version.

    */ - ModelCardVersion: number | undefined; + MaxSchemaVersion?: string; /** * @public - *

    The date and time that the model card export job was created.

    + *

    Only list hub content versions that were created before the time specified.

    */ - CreatedAt: Date | undefined; + CreationTimeBefore?: Date; /** * @public - *

    The date and time that the model card export job was last modified..

    + *

    Only list hub content versions that were created after the time specified.

    */ - LastModifiedAt: Date | undefined; -} + CreationTimeAfter?: Date; -/** - * @public - */ -export interface ListModelCardExportJobsResponse { /** * @public - *

    The summaries of the listed model card export jobs.

    + *

    Sort hub content versions by either name or creation time.

    */ - ModelCardExportJobSummaries: ModelCardExportJobSummary[] | undefined; + SortBy?: HubContentSortBy; /** * @public - *

    If the response is truncated, SageMaker returns this token. To retrieve the next set of model - * card export jobs, use it in the subsequent request.

    + *

    Sort hub content versions by ascending or descending order.

    + */ + SortOrder?: SortOrder; + + /** + * @public + *

    The maximum number of hub content versions to list.

    + */ + MaxResults?: number; + + /** + * @public + *

    If the response to a previous ListHubContentVersions request was truncated, the response includes a NextToken. To retrieve the next set of hub content versions, use the token in the next request.

    */ NextToken?: string; } /** * @public - * @enum */ -export const ModelCardSortBy = { - CREATION_TIME: "CreationTime", - NAME: "Name", -} as const; +export interface ListHubContentVersionsResponse { + /** + * @public + *

    The summaries of the listed hub content versions.

    + */ + HubContentSummaries: HubContentInfo[] | undefined; -/** - * @public - */ -export type ModelCardSortBy = (typeof ModelCardSortBy)[keyof typeof ModelCardSortBy]; + /** + * @public + *

    If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content versions, use it in the subsequent request.

    + */ + NextToken?: string; +} /** * @public - * @enum */ -export const ModelCardSortOrder = { - ASCENDING: "Ascending", - DESCENDING: "Descending", -} as const; +export interface ListHubsRequest { + /** + * @public + *

    Only list hubs with names that contain the specified string.

    + */ + NameContains?: string; -/** - * @public - */ -export type ModelCardSortOrder = (typeof ModelCardSortOrder)[keyof typeof ModelCardSortOrder]; + /** + * @public + *

    Only list hubs that were created before the time specified.

    + */ + CreationTimeBefore?: Date; -/** - * @public - */ -export interface ListModelCardsRequest { /** * @public - *

    Only list model cards that were created after the time specified.

    + *

    Only list hubs that were created after the time specified.

    */ CreationTimeAfter?: Date; /** * @public - *

    Only list model cards that were created before the time specified.

    + *

    Only list hubs that were last modified before the time specified.

    */ - CreationTimeBefore?: Date; + LastModifiedTimeBefore?: Date; /** * @public - *

    The maximum number of model cards to list.

    + *

    Only list hubs that were last modified after the time specified.

    */ - MaxResults?: number; + LastModifiedTimeAfter?: Date; /** * @public - *

    Only list model cards with names that contain the specified string.

    + *

    Sort hubs by either name or creation time.

    */ - NameContains?: string; + SortBy?: HubSortBy; /** * @public - *

    Only list model cards with the specified approval status.

    + *

    Sort hubs by ascending or descending order.

    */ - ModelCardStatus?: ModelCardStatus; + SortOrder?: SortOrder; /** * @public - *

    If the response to a previous ListModelCards request was truncated, the - * response includes a NextToken. To retrieve the next set of model cards, use - * the token in the next request.

    + *

    The maximum number of hubs to list.

    + */ + MaxResults?: number; + + /** + * @public + *

    If the response to a previous ListHubs request was truncated, the response includes a NextToken. To retrieve the next set of hubs, use the token in the next request.

    */ NextToken?: string; +} +/** + * @public + */ +export interface ListHubsResponse { /** * @public - *

    Sort model cards by either name or creation time. Sorts by creation time by default.

    + *

    The summaries of the listed hubs.

    */ - SortBy?: ModelCardSortBy; + HubSummaries: HubInfo[] | undefined; /** * @public - *

    Sort model cards by ascending or descending order.

    + *

    If the response is truncated, SageMaker returns this token. To retrieve the next set of hubs, use it in the subsequent request.

    */ - SortOrder?: ModelCardSortOrder; + NextToken?: string; } /** * @public - *

    A summary of the model card.

    */ -export interface ModelCardSummary { +export interface ListHumanTaskUisRequest { /** * @public - *

    The name of the model card.

    + *

    A filter that returns only human task user interfaces with a creation time greater than or equal to the specified timestamp.

    */ - ModelCardName: string | undefined; + CreationTimeAfter?: Date; /** * @public - *

    The Amazon Resource Name (ARN) of the model card.

    + *

    A filter that returns only human task user interfaces that were created before the specified timestamp.

    */ - ModelCardArn: string | undefined; + CreationTimeBefore?: Date; /** * @public - *

    The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

    - *
      - *
    • - *

      - * Draft: The model card is a work in progress.

      - *
      • - *
    • - *

      - * PendingReview: The model card is pending review.

      - *
      • - *
    • - *

      - * Approved: The model card is approved.

      - *
      • - *
    • - *

      - * Archived: The model card is archived. No more updates should be made to the model - * card, but it can still be exported.

      - *
      • - *
    + *

    An optional value that specifies whether you want the results sorted in Ascending or Descending order.

    */ - ModelCardStatus: ModelCardStatus | undefined; + SortOrder?: SortOrder; /** * @public - *

    The date and time that the model card was created.

    + *

    A token to resume pagination.

    */ - CreationTime: Date | undefined; + NextToken?: string; /** * @public - *

    The date and time that the model card was last modified.

    + *

    The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.

    */ - LastModifiedTime?: Date; + MaxResults?: number; } /** * @public */ -export interface ListModelCardsResponse { +export interface ListHumanTaskUisResponse { /** * @public - *

    The summaries of the listed model cards.

    + *

    An array of objects describing the human task user interfaces.

    */ - ModelCardSummaries: ModelCardSummary[] | undefined; + HumanTaskUiSummaries: HumanTaskUiSummary[] | undefined; /** * @public - *

    If the response is truncated, SageMaker returns this token. To retrieve the next set of model - * cards, use it in the subsequent request.

    + *

    A token to resume pagination.

    */ NextToken?: string; } /** * @public - * @enum */ -export const ModelCardVersionSortBy = { - VERSION: "Version", -} as const; +export interface ListHyperParameterTuningJobsRequest { + /** + * @public + *

    If the result of the previous ListHyperParameterTuningJobs request was + * truncated, the response includes a NextToken. To retrieve the next set of + * tuning jobs, use the token in the next request.

    + */ + NextToken?: string; -/** - * @public - */ -export type ModelCardVersionSortBy = (typeof ModelCardVersionSortBy)[keyof typeof ModelCardVersionSortBy]; + /** + * @public + *

    The + * maximum number of tuning jobs to return. The default value is + * 10.

    + */ + MaxResults?: number; -/** - * @public - */ -export interface ListModelCardVersionsRequest { /** * @public - *

    Only list model card versions that were created after the time specified.

    + *

    The field to sort results by. The default is Name.

    */ - CreationTimeAfter?: Date; + SortBy?: HyperParameterTuningJobSortByOptions; /** * @public - *

    Only list model card versions that were created before the time specified.

    + *

    The sort order for results. The default is Ascending.

    */ - CreationTimeBefore?: Date; + SortOrder?: SortOrder; /** * @public - *

    The maximum number of model card versions to list.

    + *

    A string in the tuning job name. This filter returns only tuning jobs whose name + * contains the specified string.

    */ - MaxResults?: number; + NameContains?: string; /** * @public - *

    List model card versions for the model card with the specified name or Amazon Resource Name (ARN).

    + *

    A filter that returns only tuning jobs that were created after the specified + * time.

    */ - ModelCardName: string | undefined; + CreationTimeAfter?: Date; /** * @public - *

    Only list model card versions with the specified approval status.

    + *

    A filter that returns only tuning jobs that were created before the specified + * time.

    */ - ModelCardStatus?: ModelCardStatus; + CreationTimeBefore?: Date; /** * @public - *

    If the response to a previous ListModelCardVersions request was truncated, - * the response includes a NextToken. To retrieve the next set of model card - * versions, use the token in the next request.

    + *

    A filter that returns only tuning jobs that were modified after the specified + * time.

    */ - NextToken?: string; + LastModifiedTimeAfter?: Date; /** * @public - *

    Sort listed model card versions by version. Sorts by version by default.

    + *

    A filter that returns only tuning jobs that were modified before the specified + * time.

    */ - SortBy?: ModelCardVersionSortBy; + LastModifiedTimeBefore?: Date; /** * @public - *

    Sort model card versions by ascending or descending order.

    + *

    A filter that returns only tuning jobs with the specified status.

    */ - SortOrder?: ModelCardSortOrder; + StatusEquals?: HyperParameterTuningJobStatus; } /** * @public - *

    A summary of a specific version of the model card.

    */ -export interface ModelCardVersionSummary { +export interface ListHyperParameterTuningJobsResponse { /** * @public - *

    The name of the model card.

    + *

    A list of HyperParameterTuningJobSummary objects that + * describe + * the tuning jobs that the ListHyperParameterTuningJobs + * request returned.

    */ - ModelCardName: string | undefined; + HyperParameterTuningJobSummaries: HyperParameterTuningJobSummary[] | undefined; /** * @public - *

    The Amazon Resource Name (ARN) of the model card.

    + *

    If the result of this ListHyperParameterTuningJobs request was truncated, + * the response includes a NextToken. To retrieve the next set of tuning jobs, + * use the token in the next request.

    */ - ModelCardArn: string | undefined; + NextToken?: string; +} +/** + * @public + */ +export interface ListImagesRequest { /** * @public - *

    The approval status of the model card version within your organization. Different organizations might have different criteria for model card review and approval.

    - *
      - *
    • - *

      - * Draft: The model card is a work in progress.

      - *
      • - *
    • - *

      - * PendingReview: The model card is pending review.

      - *
      • - *
    • - *

      - * Approved: The model card is approved.

      - *
      • - *
    • - *

      - * Archived: The model card is archived. No more updates should be made to the model - * card, but it can still be exported.

      - *
      • - *
    + *

    A filter that returns only images created on or after the specified time.

    */ - ModelCardStatus: ModelCardStatus | undefined; + CreationTimeAfter?: Date; /** * @public - *

    A version of the model card.

    + *

    A filter that returns only images created on or before the specified time.

    */ - ModelCardVersion: number | undefined; + CreationTimeBefore?: Date; /** * @public - *

    The date and time that the model card version was created.

    + *

    A filter that returns only images modified on or after the specified time.

    */ - CreationTime: Date | undefined; + LastModifiedTimeAfter?: Date; /** * @public - *

    The time date and time that the model card version was last modified.

    + *

    A filter that returns only images modified on or before the specified time.

    */ - LastModifiedTime?: Date; + LastModifiedTimeBefore?: Date; + + /** + * @public + *

    The maximum number of images to return in the response. The default value is 10.

    + */ + MaxResults?: number; + + /** + * @public + *

    A filter that returns only images whose name contains the specified string.

    + */ + NameContains?: string; + + /** + * @public + *

    If the previous call to ListImages didn't return the full set of images, + * the call returns a token for getting the next set of images.

    + */ + NextToken?: string; + + /** + * @public + *

    The property used to sort results. The default value is CREATION_TIME.

    + */ + SortBy?: ImageSortBy; + + /** + * @public + *

    The sort order. The default value is DESCENDING.

    + */ + SortOrder?: ImageSortOrder; } /** * @public */ -export interface ListModelCardVersionsResponse { +export interface ListImagesResponse { /** * @public - *

    The summaries of the listed versions of the model card.

    + *

    A list of images and their properties.

    */ - ModelCardVersionSummaryList: ModelCardVersionSummary[] | undefined; + Images?: Image[]; /** * @public - *

    If the response is truncated, SageMaker returns this token. To retrieve the next set of model - * card versions, use it in the subsequent request.

    + *

    A token for getting the next set of images, if there are any.

    */ NextToken?: string; } @@ -6166,205 +6461,183 @@ export interface ListModelCardVersionsResponse { /** * @public */ -export interface ListModelExplainabilityJobDefinitionsRequest { +export interface ListImageVersionsRequest { /** * @public - *

    Name of the endpoint to monitor for model explainability.

    + *

    A filter that returns only versions created on or after the specified time.

    */ - EndpointName?: string; + CreationTimeAfter?: Date; /** * @public - *

    Whether to sort results by the Name or CreationTime field. - * The default is CreationTime.

    + *

    A filter that returns only versions created on or before the specified time.

    */ - SortBy?: MonitoringJobDefinitionSortKey; + CreationTimeBefore?: Date; /** * @public - *

    Whether to sort the results in Ascending or Descending order. - * The default is Descending.

    + *

    The name of the image to list the versions of.

    */ - SortOrder?: SortOrder; + ImageName: string | undefined; /** * @public - *

    The token returned if the response is truncated. To retrieve the next set of job executions, use - * it in the next request.

    + *

    A filter that returns only versions modified on or after the specified time.

    */ - NextToken?: string; + LastModifiedTimeAfter?: Date; /** * @public - *

    The maximum number of jobs to return in the response. The default value is 10.

    + *

    A filter that returns only versions modified on or before the specified time.

    + */ + LastModifiedTimeBefore?: Date; + + /** + * @public + *

    The maximum number of versions to return in the response. The default value is 10.

    */ MaxResults?: number; /** * @public - *

    Filter for model explainability jobs whose name contains a specified string.

    + *

    If the previous call to ListImageVersions didn't return the full set of + * versions, the call returns a token for getting the next set of versions.

    */ - NameContains?: string; + NextToken?: string; /** * @public - *

    A filter that returns only model explainability jobs created before a specified - * time.

    + *

    The property used to sort results. The default value is CREATION_TIME.

    */ - CreationTimeBefore?: Date; + SortBy?: ImageVersionSortBy; /** * @public - *

    A filter that returns only model explainability jobs created after a specified - * time.

    + *

    The sort order. The default value is DESCENDING.

    */ - CreationTimeAfter?: Date; + SortOrder?: ImageVersionSortOrder; } /** * @public */ -export interface ListModelExplainabilityJobDefinitionsResponse { +export interface ListImageVersionsResponse { /** * @public - *

    A JSON array in which each element is a summary for a explainability bias jobs.

    + *

    A list of versions and their properties.

    */ - JobDefinitionSummaries: MonitoringJobDefinitionSummary[] | undefined; + ImageVersions?: ImageVersion[]; /** * @public - *

    The token returned if the response is truncated. To retrieve the next set of job executions, use - * it in the next request.

    + *

    A token for getting the next set of versions, if there are any.

    */ NextToken?: string; } /** * @public - * @enum - */ -export const ModelMetadataFilterType = { - DOMAIN: "Domain", - FRAMEWORK: "Framework", - FRAMEWORKVERSION: "FrameworkVersion", - TASK: "Task", -} as const; - -/** - * @public - */ -export type ModelMetadataFilterType = (typeof ModelMetadataFilterType)[keyof typeof ModelMetadataFilterType]; - -/** - * @public - *

    Part of the search expression. You can specify the name and value - * (domain, task, framework, framework version, task, and model).

    */ -export interface ModelMetadataFilter { +export interface ListInferenceComponentsInput { + /** + * @public + *

    The field by which to sort the inference components in the response. The default is + * CreationTime.

    + */ + SortBy?: InferenceComponentSortKey; + /** * @public - *

    The name of the of the model to filter by.

    + *

    The sort order for results. The default is Descending.

    */ - Name: ModelMetadataFilterType | undefined; + SortOrder?: OrderKey; /** * @public - *

    The value to filter the model metadata.

    + *

    A token that you use to get the next set of results following a truncated response. If + * the response to the previous request was truncated, that response provides the value for + * this token.

    */ - Value: string | undefined; -} + NextToken?: string; -/** - * @public - *

    One or more filters that searches for the specified resource or resources in - * a search. All resource objects that satisfy the expression's condition are - * included in the search results

    - */ -export interface ModelMetadataSearchExpression { /** * @public - *

    A list of filter objects.

    + *

    The maximum number of inference components to return in the response. This value + * defaults to 10.

    */ - Filters?: ModelMetadataFilter[]; -} + MaxResults?: number; -/** - * @public - */ -export interface ListModelMetadataRequest { /** * @public - *

    One or more filters that searches for the specified resource or resources - * in a search. All resource objects that satisfy the expression's condition are - * included in the search results. Specify the Framework, FrameworkVersion, Domain - * or Task to filter supported. Filter names and values are case-sensitive.

    + *

    Filters the results to only those inference components with a name that contains the + * specified string.

    */ - SearchExpression?: ModelMetadataSearchExpression; + NameContains?: string; /** * @public - *

    If the response to a previous ListModelMetadataResponse request was truncated, - * the response includes a NextToken. To retrieve the next set of model metadata, - * use the token in the next request.

    + *

    Filters the results to only those inference components that were created before the + * specified time.

    */ - NextToken?: string; + CreationTimeBefore?: Date; /** * @public - *

    The maximum number of models to return in the response.

    + *

    Filters the results to only those inference components that were created after the + * specified time.

    */ - MaxResults?: number; -} + CreationTimeAfter?: Date; -/** - * @public - *

    A summary of the model metadata.

    - */ -export interface ModelMetadataSummary { /** * @public - *

    The machine learning domain of the model.

    + *

    Filters the results to only those inference components that were updated before the + * specified time.

    */ - Domain: string | undefined; + LastModifiedTimeBefore?: Date; /** * @public - *

    The machine learning framework of the model.

    + *

    Filters the results to only those inference components that were updated after the + * specified time.

    */ - Framework: string | undefined; + LastModifiedTimeAfter?: Date; /** * @public - *

    The machine learning task of the model.

    + *

    Filters the results to only those inference components with the specified status.

    */ - Task: string | undefined; + StatusEquals?: InferenceComponentStatus; /** * @public - *

    The name of the model.

    + *

    An endpoint name to filter the listed inference components. The response includes only + * those inference components that are hosted at the specified endpoint.

    */ - Model: string | undefined; + EndpointNameEquals?: string; /** * @public - *

    The framework version of the model.

    + *

    A production variant name to filter the listed inference components. The response + * includes only those inference components that are hosted at the specified variant.

    */ - FrameworkVersion: string | undefined; + VariantNameEquals?: string; } /** * @public */ -export interface ListModelMetadataResponse { +export interface ListInferenceComponentsOutput { /** * @public - *

    A structure that holds model metadata.

    + *

    A list of inference components and their properties that matches any of the filters you + * specified in the request.

    */ - ModelMetadataSummaries: ModelMetadataSummary[] | undefined; + InferenceComponents: InferenceComponentSummary[] | undefined; /** * @public - *

    A token for getting the next set of recommendations, if there are any.

    + *

    The token to use in a subsequent request to get the next set of results following a + * truncated response.

    */ NextToken?: string; } @@ -6373,116 +6646,107 @@ export interface ListModelMetadataResponse { * @public * @enum */ -export const ModelPackageGroupSortBy = { +export const SortInferenceExperimentsBy = { CREATION_TIME: "CreationTime", NAME: "Name", + STATUS: "Status", } as const; /** * @public */ -export type ModelPackageGroupSortBy = (typeof ModelPackageGroupSortBy)[keyof typeof ModelPackageGroupSortBy]; +export type SortInferenceExperimentsBy = (typeof SortInferenceExperimentsBy)[keyof typeof SortInferenceExperimentsBy]; /** * @public */ -export interface ListModelPackageGroupsInput { - /** - * @public - *

    A filter that returns only model groups created after the specified time.

    - */ - CreationTimeAfter?: Date; - +export interface ListInferenceExperimentsRequest { /** * @public - *

    A filter that returns only model groups created before the specified time.

    + *

    Selects inference experiments whose names contain this name.

    */ - CreationTimeBefore?: Date; + NameContains?: string; /** * @public - *

    The maximum number of results to return in the response.

    + *

    + * Selects inference experiments of this type. For the possible types of inference experiments, see CreateInferenceExperiment. + *

    */ - MaxResults?: number; + Type?: InferenceExperimentType; /** * @public - *

    A string in the model group name. This filter returns only model groups whose name - * contains the specified string.

    + *

    + * Selects inference experiments which are in this status. For the possible statuses, see DescribeInferenceExperiment. + *

    */ - NameContains?: string; + StatusEquals?: InferenceExperimentStatus; /** * @public - *

    If the result of the previous ListModelPackageGroups request was - * truncated, the response includes a NextToken. To retrieve the next set of - * model groups, use the token in the next request.

    + *

    Selects inference experiments which were created after this timestamp.

    */ - NextToken?: string; + CreationTimeAfter?: Date; /** * @public - *

    The field to sort results by. The default is CreationTime.

    + *

    Selects inference experiments which were created before this timestamp.

    */ - SortBy?: ModelPackageGroupSortBy; + CreationTimeBefore?: Date; /** * @public - *

    The sort order for results. The default is Ascending.

    + *

    Selects inference experiments which were last modified after this timestamp.

    */ - SortOrder?: SortOrder; -} + LastModifiedTimeAfter?: Date; -/** - * @public - *

    Summary information about a model group.

    - */ -export interface ModelPackageGroupSummary { /** * @public - *

    The name of the model group.

    + *

    Selects inference experiments which were last modified before this timestamp.

    */ - ModelPackageGroupName: string | undefined; + LastModifiedTimeBefore?: Date; /** * @public - *

    The Amazon Resource Name (ARN) of the model group.

    + *

    The column by which to sort the listed inference experiments.

    */ - ModelPackageGroupArn: string | undefined; + SortBy?: SortInferenceExperimentsBy; /** * @public - *

    A description of the model group.

    + *

    The direction of sorting (ascending or descending).

    */ - ModelPackageGroupDescription?: string; + SortOrder?: SortOrder; /** * @public - *

    The time that the model group was created.

    + *

    + * The response from the last list when returning a list large enough to need tokening. + *

    */ - CreationTime: Date | undefined; + NextToken?: string; /** * @public - *

    The status of the model group.

    + *

    The maximum number of results to select.

    */ - ModelPackageGroupStatus: ModelPackageGroupStatus | undefined; + MaxResults?: number; } /** * @public */ -export interface ListModelPackageGroupsOutput { +export interface ListInferenceExperimentsResponse { /** * @public - *

    A list of summaries of the model groups in your Amazon Web Services account.

    + *

    List of inference experiments.

    */ - ModelPackageGroupSummaryList: ModelPackageGroupSummary[] | undefined; + InferenceExperiments?: InferenceExperimentSummary[]; /** * @public - *

    If the response is truncated, SageMaker returns this token. To retrieve the next set - * of model groups, use it in the subsequent request.

    + *

    The token to use when calling the next page of results.

    */ NextToken?: string; } @@ -6491,204 +6755,110 @@ export interface ListModelPackageGroupsOutput { * @public * @enum */ -export const ModelPackageType = { - BOTH: "Both", - UNVERSIONED: "Unversioned", - VERSIONED: "Versioned", -} as const; - -/** - * @public - */ -export type ModelPackageType = (typeof ModelPackageType)[keyof typeof ModelPackageType]; - -/** - * @public - * @enum - */ -export const ModelPackageSortBy = { +export const ListInferenceRecommendationsJobsSortBy = { CREATION_TIME: "CreationTime", NAME: "Name", + STATUS: "Status", } as const; /** * @public */ -export type ModelPackageSortBy = (typeof ModelPackageSortBy)[keyof typeof ModelPackageSortBy]; +export type ListInferenceRecommendationsJobsSortBy = + (typeof ListInferenceRecommendationsJobsSortBy)[keyof typeof ListInferenceRecommendationsJobsSortBy]; /** * @public */ -export interface ListModelPackagesInput { +export interface ListInferenceRecommendationsJobsRequest { /** * @public - *

    A filter that returns only model packages created after the specified time - * (timestamp).

    + *

    A filter that returns only jobs created after the specified time (timestamp).

    */ CreationTimeAfter?: Date; /** * @public - *

    A filter that returns only model packages created before the specified time - * (timestamp).

    + *

    A filter that returns only jobs created before the specified time (timestamp).

    */ CreationTimeBefore?: Date; /** * @public - *

    The maximum number of model packages to return in the response.

    - */ - MaxResults?: number; - - /** - * @public - *

    A string in the model package name. This filter returns only model packages whose name - * contains the specified string.

    - */ - NameContains?: string; - - /** - * @public - *

    A filter that returns only the model packages with the specified approval - * status.

    - */ - ModelApprovalStatus?: ModelApprovalStatus; - - /** - * @public - *

    A filter that returns only model versions that belong to the specified model group.

    - */ - ModelPackageGroupName?: string; - - /** - * @public - *

    A filter that returns only the model packages of the specified type. This can be one - * of the following values.

    - *
      - *
    • - *

      - * UNVERSIONED - List only unversioined models. - * This is the default value if no ModelPackageType is specified.

      - *
      • - *
    • - *

      - * VERSIONED - List only versioned models.

      - *
      • - *
    • - *

      - * BOTH - List both versioned and unversioned models.

      - *
      • - *
    - */ - ModelPackageType?: ModelPackageType; - - /** - * @public - *

    If the response to a previous ListModelPackages request was truncated, - * the response includes a NextToken. To retrieve the next set of model - * packages, use the token in the next request.

    - */ - NextToken?: string; - - /** - * @public - *

    The parameter by which to sort the results. The default is - * CreationTime.

    + *

    A filter that returns only jobs that were last modified after the specified time (timestamp).

    */ - SortBy?: ModelPackageSortBy; + LastModifiedTimeAfter?: Date; /** * @public - *

    The sort order for the results. The default is Ascending.

    + *

    A filter that returns only jobs that were last modified before the specified time (timestamp).

    */ - SortOrder?: SortOrder; -} + LastModifiedTimeBefore?: Date; -/** - * @public - *

    Provides summary information about a model package.

    - */ -export interface ModelPackageSummary { /** * @public - *

    The name of the model package.

    + *

    A string in the job name. This filter returns only recommendations whose name contains the specified string.

    */ - ModelPackageName?: string; + NameContains?: string; /** * @public - *

    If the model package is a versioned model, the model group that the versioned model - * belongs to.

    + *

    A filter that retrieves only inference recommendations jobs with a specific status.

    */ - ModelPackageGroupName?: string; + StatusEquals?: RecommendationJobStatus; /** * @public - *

    If the model package is a versioned model, the version of the model.

    + *

    The parameter by which to sort the results.

    */ - ModelPackageVersion?: number; + SortBy?: ListInferenceRecommendationsJobsSortBy; /** * @public - *

    The Amazon Resource Name (ARN) of the model package.

    + *

    The sort order for the results.

    */ - ModelPackageArn: string | undefined; + SortOrder?: SortOrder; /** * @public - *

    A brief description of the model package.

    + *

    If the response to a previous ListInferenceRecommendationsJobsRequest request + * was truncated, the response includes a NextToken. To retrieve the next set + * of recommendations, use the token in the next request.

    */ - ModelPackageDescription?: string; + NextToken?: string; /** * @public - *

    A timestamp that shows when the model package was created.

    + *

    The maximum number of recommendations to return in the response.

    */ - CreationTime: Date | undefined; + MaxResults?: number; /** * @public - *

    The overall status of the model package.

    + *

    A filter that returns only jobs that were created for this model.

    */ - ModelPackageStatus: ModelPackageStatus | undefined; + ModelNameEquals?: string; /** * @public - *

    The approval status of the model. This can be one of the following values.

    - *
      - *
    • - *

      - * APPROVED - The model is approved

      - *
      • - *
    • - *

      - * REJECTED - The model is rejected.

      - *
      • - *
    • - *

      - * PENDING_MANUAL_APPROVAL - The model is waiting for manual - * approval.

      - *
      • - *
    + *

    A filter that returns only jobs that were created for this versioned model package.

    */ - ModelApprovalStatus?: ModelApprovalStatus; + ModelPackageVersionArnEquals?: string; } /** * @public */ -export interface ListModelPackagesOutput { +export interface ListInferenceRecommendationsJobsResponse { /** * @public - *

    An array of ModelPackageSummary objects, each of which lists a model - * package.

    + *

    The recommendations created from the Amazon SageMaker Inference Recommender job.

    */ - ModelPackageSummaryList: ModelPackageSummary[] | undefined; + InferenceRecommendationsJobs: InferenceRecommendationsJob[] | undefined; /** * @public - *

    If the response is truncated, SageMaker returns this token. To retrieve the next set of - * model packages, use it in the subsequent request.

    + *

    A token for getting the next set of recommendations, if there are any.

    */ NextToken?: string; } @@ -6696,78 +6866,53 @@ export interface ListModelPackagesOutput { /** * @public */ -export interface ListModelQualityJobDefinitionsRequest { - /** - * @public - *

    A filter that returns only model quality monitoring job definitions that are associated - * with the specified endpoint.

    - */ - EndpointName?: string; - +export interface ListInferenceRecommendationsJobStepsRequest { /** * @public - *

    The field to sort results by. The default is CreationTime.

    + *

    The name for the Inference Recommender job.

    */ - SortBy?: MonitoringJobDefinitionSortKey; + JobName: string | undefined; /** * @public - *

    Whether to sort the results in Ascending or Descending order. - * The default is Descending.

    + *

    A filter to return benchmarks of a specified status. If this field is left empty, then all benchmarks are returned.

    */ - SortOrder?: SortOrder; + Status?: RecommendationJobStatus; /** * @public - *

    If the result of the previous ListModelQualityJobDefinitions request was - * truncated, the response includes a NextToken. To retrieve the next set of - * model quality monitoring job definitions, use the token in the next request.

    + *

    A filter to return details about the specified type of subtask.

    + *

    + * BENCHMARK: Evaluate the performance of your model on different instance types.

    */ - NextToken?: string; + StepType?: RecommendationStepType; /** * @public - *

    The maximum number of results to return in a call to - * ListModelQualityJobDefinitions.

    + *

    The maximum number of results to return.

    */ MaxResults?: number; /** * @public - *

    A string in the transform job name. This filter returns only model quality monitoring - * job definitions whose name contains the specified string.

    - */ - NameContains?: string; - - /** - * @public - *

    A filter that returns only model quality monitoring job definitions created before the - * specified time.

    - */ - CreationTimeBefore?: Date; - - /** - * @public - *

    A filter that returns only model quality monitoring job definitions created after the - * specified time.

    + *

    A token that you can specify to return more results from the list. Specify this field if you have a token that was returned from a previous request.

    */ - CreationTimeAfter?: Date; + NextToken?: string; } /** * @public */ -export interface ListModelQualityJobDefinitionsResponse { +export interface ListInferenceRecommendationsJobStepsResponse { /** * @public - *

    A list of summaries of model quality monitoring job definitions.

    + *

    A list of all subtask details in Inference Recommender.

    */ - JobDefinitionSummaries: MonitoringJobDefinitionSummary[] | undefined; + Steps?: InferenceRecommendationsJobStep[]; /** * @public - *

    If the response is truncated, Amazon SageMaker returns this token. To retrieve the - * next set of model quality monitoring job definitions, use it in the next request.

    + *

    A token that you can specify in your next request to return more results from the list.

    */ NextToken?: string; } @@ -6776,107 +6921,104 @@ export interface ListModelQualityJobDefinitionsResponse { * @public * @enum */ -export const ModelSortKey = { - CreationTime: "CreationTime", - Name: "Name", +export const SortBy = { + CREATION_TIME: "CreationTime", + NAME: "Name", + STATUS: "Status", } as const; /** * @public */ -export type ModelSortKey = (typeof ModelSortKey)[keyof typeof ModelSortKey]; +export type SortBy = (typeof SortBy)[keyof typeof SortBy]; /** * @public */ -export interface ListModelsInput { +export interface ListLabelingJobsRequest { /** * @public - *

    Sorts the list of results. The default is CreationTime.

    + *

    A filter that returns only labeling jobs created after the specified time + * (timestamp).

    */ - SortBy?: ModelSortKey; + CreationTimeAfter?: Date; /** * @public - *

    The sort order for results. The default is Descending.

    + *

    A filter that returns only labeling jobs created before the specified time + * (timestamp).

    */ - SortOrder?: OrderKey; + CreationTimeBefore?: Date; /** * @public - *

    If the response to a previous ListModels request was truncated, the - * response includes a NextToken. To retrieve the next set of models, use the - * token in the next request.

    + *

    A filter that returns only labeling jobs modified after the specified time + * (timestamp).

    */ - NextToken?: string; + LastModifiedTimeAfter?: Date; /** * @public - *

    The maximum number of models to return in the response.

    + *

    A filter that returns only labeling jobs modified before the specified time + * (timestamp).

    */ - MaxResults?: number; + LastModifiedTimeBefore?: Date; /** * @public - *

    A string in the model name. This filter returns only models whose name contains the - * specified string.

    + *

    The maximum number of labeling jobs to return in each page of the response.

    */ - NameContains?: string; + MaxResults?: number; /** * @public - *

    A filter that returns only models created before the specified time - * (timestamp).

    + *

    If the result of the previous ListLabelingJobs request was truncated, the + * response includes a NextToken. To retrieve the next set of labeling jobs, + * use the token in the next request.

    */ - CreationTimeBefore?: Date; + NextToken?: string; /** * @public - *

    A filter that returns only models with a creation time greater than or equal to the - * specified time (timestamp).

    + *

    A string in the labeling job name. This filter returns only labeling jobs whose name + * contains the specified string.

    */ - CreationTimeAfter?: Date; -} + NameContains?: string; -/** - * @public - *

    Provides summary information about a model.

    - */ -export interface ModelSummary { /** * @public - *

    The name of the model that you want a summary for.

    + *

    The field to sort results by. The default is CreationTime.

    */ - ModelName: string | undefined; + SortBy?: SortBy; /** * @public - *

    The Amazon Resource Name (ARN) of the model.

    + *

    The sort order for results. The default is Ascending.

    */ - ModelArn: string | undefined; + SortOrder?: SortOrder; /** * @public - *

    A timestamp that indicates when the model was created.

    + *

    A filter that retrieves only labeling jobs with a specific status.

    */ - CreationTime: Date | undefined; + StatusEquals?: LabelingJobStatus; } /** * @public */ -export interface ListModelsOutput { +export interface ListLabelingJobsResponse { /** * @public - *

    An array of ModelSummary objects, each of which lists a - * model.

    + *

    An array of LabelingJobSummary objects, each describing a labeling + * job.

    */ - Models: ModelSummary[] | undefined; + LabelingJobSummaryList?: LabelingJobSummary[]; /** * @public - *

    If the response is truncated, SageMaker returns this token. To retrieve the next set of - * models, use it in the subsequent request.

    + *

    If the response is truncated, SageMaker returns this token. To retrieve the next set of + * labeling jobs, use it in the subsequent request.

    */ NextToken?: string; } @@ -6885,260 +7027,241 @@ export interface ListModelsOutput { * @public * @enum */ -export const MonitoringAlertHistorySortKey = { - CreationTime: "CreationTime", - Status: "Status", -} as const; - -/** - * @public - */ -export type MonitoringAlertHistorySortKey = - (typeof MonitoringAlertHistorySortKey)[keyof typeof MonitoringAlertHistorySortKey]; - -/** - * @public - * @enum - */ -export const MonitoringAlertStatus = { - IN_ALERT: "InAlert", - OK: "OK", +export const ListLabelingJobsForWorkteamSortByOptions = { + CREATION_TIME: "CreationTime", } as const; /** * @public */ -export type MonitoringAlertStatus = (typeof MonitoringAlertStatus)[keyof typeof MonitoringAlertStatus]; +export type ListLabelingJobsForWorkteamSortByOptions = + (typeof ListLabelingJobsForWorkteamSortByOptions)[keyof typeof ListLabelingJobsForWorkteamSortByOptions]; /** * @public */ -export interface ListMonitoringAlertHistoryRequest { - /** - * @public - *

    The name of a monitoring schedule.

    - */ - MonitoringScheduleName?: string; - - /** - * @public - *

    The name of a monitoring alert.

    - */ - MonitoringAlertName?: string; - - /** - * @public - *

    The field used to sort results. The default is CreationTime.

    - */ - SortBy?: MonitoringAlertHistorySortKey; - - /** - * @public - *

    The sort order, whether Ascending or Descending, of the alert - * history. The default is Descending.

    - */ - SortOrder?: SortOrder; - +export interface ListLabelingJobsForWorkteamRequest { /** * @public - *

    If the result of the previous ListMonitoringAlertHistory request was - * truncated, the response includes a NextToken. To retrieve the next set of - * alerts in the history, use the token in the next request.

    + *

    The Amazon Resource Name (ARN) of the work team for which you want to see labeling + * jobs for.

    */ - NextToken?: string; + WorkteamArn: string | undefined; /** * @public - *

    The maximum number of results to display. The default is 100.

    + *

    The maximum number of labeling jobs to return in each page of the response.

    */ MaxResults?: number; /** * @public - *

    A filter that returns only alerts created on or before the specified time.

    - */ - CreationTimeBefore?: Date; - - /** - * @public - *

    A filter that returns only alerts created on or after the specified time.

    + *

    If the result of the previous ListLabelingJobsForWorkteam request was + * truncated, the response includes a NextToken. To retrieve the next set of + * labeling jobs, use the token in the next request.

    */ - CreationTimeAfter?: Date; + NextToken?: string; /** * @public - *

    A filter that retrieves only alerts with a specific status.

    + *

    A filter that returns only labeling jobs created after the specified time + * (timestamp).

    */ - StatusEquals?: MonitoringAlertStatus; -} + CreationTimeAfter?: Date; -/** - * @public - *

    Provides summary information of an alert's history.

    - */ -export interface MonitoringAlertHistorySummary { /** * @public - *

    The name of a monitoring schedule.

    + *

    A filter that returns only labeling jobs created before the specified time + * (timestamp).

    */ - MonitoringScheduleName: string | undefined; + CreationTimeBefore?: Date; /** * @public - *

    The name of a monitoring alert.

    + *

    A filter the limits jobs to only the ones whose job reference code contains the + * specified string.

    */ - MonitoringAlertName: string | undefined; + JobReferenceCodeContains?: string; /** * @public - *

    A timestamp that indicates when the first alert transition occurred in an alert history. - * An alert transition can be from status InAlert to OK, - * or from OK to InAlert.

    + *

    The field to sort results by. The default is CreationTime.

    */ - CreationTime: Date | undefined; + SortBy?: ListLabelingJobsForWorkteamSortByOptions; /** * @public - *

    The current alert status of an alert.

    + *

    The sort order for results. The default is Ascending.

    */ - AlertStatus: MonitoringAlertStatus | undefined; + SortOrder?: SortOrder; } /** * @public */ -export interface ListMonitoringAlertHistoryResponse { +export interface ListLabelingJobsForWorkteamResponse { /** * @public - *

    An alert history for a model monitoring schedule.

    + *

    An array of LabelingJobSummary objects, each describing a labeling + * job.

    */ - MonitoringAlertHistory?: MonitoringAlertHistorySummary[]; + LabelingJobSummaryList: LabelingJobForWorkteamSummary[] | undefined; /** * @public *

    If the response is truncated, SageMaker returns this token. To retrieve the next set of - * alerts, use it in the subsequent request.

    + * labeling jobs, use it in the subsequent request.

    */ NextToken?: string; } /** * @public + * @enum */ -export interface ListMonitoringAlertsRequest { +export const SortLineageGroupsBy = { + CREATION_TIME: "CreationTime", + NAME: "Name", +} as const; + +/** + * @public + */ +export type SortLineageGroupsBy = (typeof SortLineageGroupsBy)[keyof typeof SortLineageGroupsBy]; + +/** + * @public + */ +export interface ListLineageGroupsRequest { /** * @public - *

    The name of a monitoring schedule.

    + *

    A timestamp to filter against lineage groups created after a certain point in time.

    */ - MonitoringScheduleName: string | undefined; + CreatedAfter?: Date; /** * @public - *

    If the result of the previous ListMonitoringAlerts request was truncated, - * the response includes a NextToken. To retrieve the next set of alerts in the - * history, use the token in the next request.

    + *

    A timestamp to filter against lineage groups created before a certain point in time.

    + */ + CreatedBefore?: Date; + + /** + * @public + *

    The parameter by which to sort the results. The default is + * CreationTime.

    + */ + SortBy?: SortLineageGroupsBy; + + /** + * @public + *

    The sort order for the results. The default is Ascending.

    + */ + SortOrder?: SortOrder; + + /** + * @public + *

    If the response is truncated, SageMaker returns this token. To retrieve the next set of + * algorithms, use it in the subsequent request.

    */ NextToken?: string; /** * @public - *

    The maximum number of results to display. The default is 100.

    + *

    The maximum number of endpoints to return in the response. This value defaults to + * 10.

    */ MaxResults?: number; } /** * @public - *

    An alert action taken to light up an icon on the Amazon SageMaker Model Dashboard when an alert goes into - * InAlert status.

    */ -export interface ModelDashboardIndicatorAction { +export interface ListLineageGroupsResponse { /** * @public - *

    Indicates whether the alert action is turned on.

    + *

    A list of lineage groups and their properties.

    */ - Enabled?: boolean; -} + LineageGroupSummaries?: LineageGroupSummary[]; -/** - * @public - *

    A list of alert actions taken in response to an alert going into - * InAlert status.

    - */ -export interface MonitoringAlertActions { /** * @public - *

    An alert action taken to light up an icon on the Model Dashboard when an alert goes into - * InAlert status.

    + *

    If the response is truncated, SageMaker returns this token. To retrieve the next set of + * algorithms, use it in the subsequent request.

    */ - ModelDashboardIndicator?: ModelDashboardIndicatorAction; + NextToken?: string; } /** * @public - *

    Provides summary information about a monitor alert.

    */ -export interface MonitoringAlertSummary { +export interface ListModelBiasJobDefinitionsRequest { /** * @public - *

    The name of a monitoring alert.

    + *

    Name of the endpoint to monitor for model bias.

    */ - MonitoringAlertName: string | undefined; + EndpointName?: string; /** * @public - *

    A timestamp that indicates when a monitor alert was created.

    + *

    Whether to sort results by the Name or CreationTime field. + * The default is CreationTime.

    */ - CreationTime: Date | undefined; + SortBy?: MonitoringJobDefinitionSortKey; /** * @public - *

    A timestamp that indicates when a monitor alert was last updated.

    + *

    Whether to sort the results in Ascending or Descending order. + * The default is Descending.

    */ - LastModifiedTime: Date | undefined; + SortOrder?: SortOrder; /** * @public - *

    The current status of an alert.

    + *

    The token returned if the response is truncated. To retrieve the next set of job executions, use + * it in the next request.

    */ - AlertStatus: MonitoringAlertStatus | undefined; + NextToken?: string; /** * @public - *

    Within EvaluationPeriod, how many execution failures will raise an - * alert.

    + *

    The maximum number of model bias jobs to return in the response. The default value is + * 10.

    */ - DatapointsToAlert: number | undefined; + MaxResults?: number; /** * @public - *

    The number of most recent monitoring executions to consider when evaluating alert - * status.

    + *

    Filter for model bias jobs whose name contains a specified string.

    */ - EvaluationPeriod: number | undefined; + NameContains?: string; /** * @public - *

    A list of alert actions taken in response to an alert going into - * InAlert status.

    + *

    A filter that returns only model bias jobs created before a specified time.

    */ - Actions: MonitoringAlertActions | undefined; + CreationTimeBefore?: Date; + + /** + * @public + *

    A filter that returns only model bias jobs created after a specified time.

    + */ + CreationTimeAfter?: Date; } /** * @public */ -export interface ListMonitoringAlertsResponse { +export interface ListModelBiasJobDefinitionsResponse { /** * @public - *

    A JSON array where each element is a summary for a monitoring alert.

    + *

    A JSON array in which each element is a summary for a model bias jobs.

    */ - MonitoringAlertSummaries?: MonitoringAlertSummary[]; + JobDefinitionSummaries: MonitoringJobDefinitionSummary[] | undefined; /** * @public - *

    If the response is truncated, SageMaker returns this token. To retrieve the next set of - * alerts, use it in the subsequent request.

    + *

    The token returned if the response is truncated. To retrieve the next set of job executions, use + * it in the next request.

    */ NextToken?: string; } @@ -7147,131 +7270,161 @@ export interface ListMonitoringAlertsResponse { * @public * @enum */ -export const MonitoringExecutionSortKey = { +export const ModelCardExportJobSortBy = { CREATION_TIME: "CreationTime", - SCHEDULED_TIME: "ScheduledTime", + NAME: "Name", STATUS: "Status", } as const; /** * @public */ -export type MonitoringExecutionSortKey = (typeof MonitoringExecutionSortKey)[keyof typeof MonitoringExecutionSortKey]; +export type ModelCardExportJobSortBy = (typeof ModelCardExportJobSortBy)[keyof typeof ModelCardExportJobSortBy]; /** * @public + * @enum */ -export interface ListMonitoringExecutionsRequest { +export const ModelCardExportJobSortOrder = { + ASCENDING: "Ascending", + DESCENDING: "Descending", +} as const; + +/** + * @public + */ +export type ModelCardExportJobSortOrder = + (typeof ModelCardExportJobSortOrder)[keyof typeof ModelCardExportJobSortOrder]; + +/** + * @public + */ +export interface ListModelCardExportJobsRequest { /** * @public - *

    Name of a specific schedule to fetch jobs for.

    + *

    List export jobs for the model card with the specified name.

    */ - MonitoringScheduleName?: string; + ModelCardName: string | undefined; /** * @public - *

    Name of a specific endpoint to fetch jobs for.

    + *

    List export jobs for the model card with the specified version.

    */ - EndpointName?: string; + ModelCardVersion?: number; /** * @public - *

    Whether to sort the results by the Status, CreationTime, or - * ScheduledTime field. The default is CreationTime.

    + *

    Only list model card export jobs that were created after the time specified.

    */ - SortBy?: MonitoringExecutionSortKey; + CreationTimeAfter?: Date; /** * @public - *

    Whether to sort the results in Ascending or Descending order. - * The default is Descending.

    + *

    Only list model card export jobs that were created before the time specified.

    */ - SortOrder?: SortOrder; + CreationTimeBefore?: Date; /** * @public - *

    The token returned if the response is truncated. To retrieve the next set of job executions, use - * it in the next request.

    + *

    Only list model card export jobs with names that contain the specified string.

    */ - NextToken?: string; + ModelCardExportJobNameContains?: string; /** * @public - *

    The maximum number of jobs to return in the response. The default value is 10.

    + *

    Only list model card export jobs with the specified status.

    */ - MaxResults?: number; + StatusEquals?: ModelCardExportJobStatus; /** * @public - *

    Filter for jobs scheduled before a specified time.

    + *

    Sort model card export jobs by either name or creation time. Sorts by creation time by default.

    */ - ScheduledTimeBefore?: Date; + SortBy?: ModelCardExportJobSortBy; /** * @public - *

    Filter for jobs scheduled after a specified time.

    + *

    Sort model card export jobs by ascending or descending order.

    */ - ScheduledTimeAfter?: Date; + SortOrder?: ModelCardExportJobSortOrder; /** * @public - *

    A filter that returns only jobs created before a specified time.

    + *

    If the response to a previous ListModelCardExportJobs request was + * truncated, the response includes a NextToken. To retrieve the next set of + * model card export jobs, use the token in the next request.

    */ - CreationTimeBefore?: Date; + NextToken?: string; /** * @public - *

    A filter that returns only jobs created after a specified time.

    + *

    The maximum number of model card export jobs to list.

    */ - CreationTimeAfter?: Date; + MaxResults?: number; +} +/** + * @public + *

    The summary of the Amazon SageMaker Model Card export job.

    + */ +export interface ModelCardExportJobSummary { /** * @public - *

    A filter that returns only jobs modified after a specified time.

    + *

    The name of the model card export job.

    */ - LastModifiedTimeBefore?: Date; + ModelCardExportJobName: string | undefined; /** * @public - *

    A filter that returns only jobs modified before a specified time.

    + *

    The Amazon Resource Name (ARN) of the model card export job.

    + */ + ModelCardExportJobArn: string | undefined; + + /** + * @public + *

    The completion status of the model card export job.

    + */ + Status: ModelCardExportJobStatus | undefined; + + /** + * @public + *

    The name of the model card that the export job exports.

    */ - LastModifiedTimeAfter?: Date; + ModelCardName: string | undefined; /** * @public - *

    A filter that retrieves only jobs with a specific status.

    + *

    The version of the model card that the export job exports.

    */ - StatusEquals?: ExecutionStatus; + ModelCardVersion: number | undefined; /** * @public - *

    Gets a list of the monitoring job runs of the specified monitoring job - * definitions.

    + *

    The date and time that the model card export job was created.

    */ - MonitoringJobDefinitionName?: string; + CreatedAt: Date | undefined; /** * @public - *

    A filter that returns only the monitoring job runs of the specified monitoring - * type.

    + *

    The date and time that the model card export job was last modified..

    */ - MonitoringTypeEquals?: MonitoringType; + LastModifiedAt: Date | undefined; } /** * @public */ -export interface ListMonitoringExecutionsResponse { +export interface ListModelCardExportJobsResponse { /** * @public - *

    A JSON array in which each element is a summary for a monitoring execution.

    + *

    The summaries of the listed model card export jobs.

    */ - MonitoringExecutionSummaries: MonitoringExecutionSummary[] | undefined; + ModelCardExportJobSummaries: ModelCardExportJobSummary[] | undefined; /** * @public - *

    The token returned if the response is truncated. To retrieve the next set of job executions, use - * it in the next request.

    + *

    If the response is truncated, SageMaker returns this token. To retrieve the next set of model + * card export jobs, use it in the subsequent request.

    */ NextToken?: string; } @@ -7280,173 +7433,154 @@ export interface ListMonitoringExecutionsResponse { * @public * @enum */ -export const MonitoringScheduleSortKey = { +export const ModelCardSortBy = { CREATION_TIME: "CreationTime", NAME: "Name", - STATUS: "Status", } as const; /** * @public */ -export type MonitoringScheduleSortKey = (typeof MonitoringScheduleSortKey)[keyof typeof MonitoringScheduleSortKey]; +export type ModelCardSortBy = (typeof ModelCardSortBy)[keyof typeof ModelCardSortBy]; /** * @public + * @enum */ -export interface ListMonitoringSchedulesRequest { - /** - * @public - *

    Name of a specific endpoint to fetch schedules for.

    - */ - EndpointName?: string; +export const ModelCardSortOrder = { + ASCENDING: "Ascending", + DESCENDING: "Descending", +} as const; - /** - * @public - *

    Whether to sort the results by the Status, CreationTime, or - * ScheduledTime field. The default is CreationTime.

    - */ - SortBy?: MonitoringScheduleSortKey; +/** + * @public + */ +export type ModelCardSortOrder = (typeof ModelCardSortOrder)[keyof typeof ModelCardSortOrder]; +/** + * @public + */ +export interface ListModelCardsRequest { /** * @public - *

    Whether to sort the results in Ascending or Descending order. - * The default is Descending.

    + *

    Only list model cards that were created after the time specified.

    */ - SortOrder?: SortOrder; + CreationTimeAfter?: Date; /** * @public - *

    The token returned if the response is truncated. To retrieve the next set of job executions, use - * it in the next request.

    + *

    Only list model cards that were created before the time specified.

    */ - NextToken?: string; + CreationTimeBefore?: Date; /** * @public - *

    The maximum number of jobs to return in the response. The default value is 10.

    + *

    The maximum number of model cards to list.

    */ MaxResults?: number; /** * @public - *

    Filter for monitoring schedules whose name contains a specified string.

    + *

    Only list model cards with names that contain the specified string.

    */ NameContains?: string; /** * @public - *

    A filter that returns only monitoring schedules created before a specified time.

    - */ - CreationTimeBefore?: Date; - - /** - * @public - *

    A filter that returns only monitoring schedules created after a specified time.

    - */ - CreationTimeAfter?: Date; - - /** - * @public - *

    A filter that returns only monitoring schedules modified before a specified time.

    - */ - LastModifiedTimeBefore?: Date; - - /** - * @public - *

    A filter that returns only monitoring schedules modified after a specified time.

    + *

    Only list model cards with the specified approval status.

    */ - LastModifiedTimeAfter?: Date; + ModelCardStatus?: ModelCardStatus; /** * @public - *

    A filter that returns only monitoring schedules modified before a specified time.

    + *

    If the response to a previous ListModelCards request was truncated, the + * response includes a NextToken. To retrieve the next set of model cards, use + * the token in the next request.

    */ - StatusEquals?: ScheduleStatus; + NextToken?: string; /** * @public - *

    Gets a list of the monitoring schedules for the specified monitoring job - * definition.

    + *

    Sort model cards by either name or creation time. Sorts by creation time by default.

    */ - MonitoringJobDefinitionName?: string; + SortBy?: ModelCardSortBy; /** * @public - *

    A filter that returns only the monitoring schedules for the specified monitoring - * type.

    + *

    Sort model cards by ascending or descending order.

    */ - MonitoringTypeEquals?: MonitoringType; + SortOrder?: ModelCardSortOrder; } /** * @public - *

    Summarizes the monitoring schedule.

    + *

    A summary of the model card.

    */ -export interface MonitoringScheduleSummary { - /** - * @public - *

    The name of the monitoring schedule.

    - */ - MonitoringScheduleName: string | undefined; - - /** - * @public - *

    The Amazon Resource Name (ARN) of the monitoring schedule.

    - */ - MonitoringScheduleArn: string | undefined; - - /** - * @public - *

    The creation time of the monitoring schedule.

    - */ - CreationTime: Date | undefined; - +export interface ModelCardSummary { /** * @public - *

    The last time the monitoring schedule was modified.

    + *

    The name of the model card.

    */ - LastModifiedTime: Date | undefined; + ModelCardName: string | undefined; /** * @public - *

    The status of the monitoring schedule.

    + *

    The Amazon Resource Name (ARN) of the model card.

    */ - MonitoringScheduleStatus: ScheduleStatus | undefined; + ModelCardArn: string | undefined; /** * @public - *

    The name of the endpoint using the monitoring schedule.

    + *

    The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

    + *
      + *
    • + *

      + * Draft: The model card is a work in progress.

      + *
      • + *
    • + *

      + * PendingReview: The model card is pending review.

      + *
      • + *
    • + *

      + * Approved: The model card is approved.

      + *
      • + *
    • + *

      + * Archived: The model card is archived. No more updates should be made to the model + * card, but it can still be exported.

      + *
      • + *
    */ - EndpointName?: string; + ModelCardStatus: ModelCardStatus | undefined; /** * @public - *

    The name of the monitoring job definition that the schedule is for.

    + *

    The date and time that the model card was created.

    */ - MonitoringJobDefinitionName?: string; + CreationTime: Date | undefined; /** * @public - *

    The type of the monitoring job definition that the schedule is for.

    + *

    The date and time that the model card was last modified.

    */ - MonitoringType?: MonitoringType; + LastModifiedTime?: Date; } /** * @public */ -export interface ListMonitoringSchedulesResponse { +export interface ListModelCardsResponse { /** * @public - *

    A JSON array in which each element is a summary for a monitoring schedule.

    + *

    The summaries of the listed model cards.

    */ - MonitoringScheduleSummaries: MonitoringScheduleSummary[] | undefined; + ModelCardSummaries: ModelCardSummary[] | undefined; /** * @public - *

    The token returned if the response is truncated. To retrieve the next set of job executions, use - * it in the next request.

    + *

    If the response is truncated, SageMaker returns this token. To retrieve the next set of model + * cards, use it in the subsequent request.

    */ NextToken?: string; } @@ -7455,125 +7589,127 @@ export interface ListMonitoringSchedulesResponse { * @public * @enum */ -export const NotebookInstanceLifecycleConfigSortKey = { - CREATION_TIME: "CreationTime", - LAST_MODIFIED_TIME: "LastModifiedTime", - NAME: "Name", +export const ModelCardVersionSortBy = { + VERSION: "Version", } as const; /** * @public */ -export type NotebookInstanceLifecycleConfigSortKey = - (typeof NotebookInstanceLifecycleConfigSortKey)[keyof typeof NotebookInstanceLifecycleConfigSortKey]; - -/** - * @public - * @enum - */ -export const NotebookInstanceLifecycleConfigSortOrder = { - ASCENDING: "Ascending", - DESCENDING: "Descending", -} as const; +export type ModelCardVersionSortBy = (typeof ModelCardVersionSortBy)[keyof typeof ModelCardVersionSortBy]; /** * @public */ -export type NotebookInstanceLifecycleConfigSortOrder = - (typeof NotebookInstanceLifecycleConfigSortOrder)[keyof typeof NotebookInstanceLifecycleConfigSortOrder]; +export interface ListModelCardVersionsRequest { + /** + * @public + *

    Only list model card versions that were created after the time specified.

    + */ + CreationTimeAfter?: Date; -/** - * @public - */ -export interface ListNotebookInstanceLifecycleConfigsInput { /** * @public - *

    If the result of a ListNotebookInstanceLifecycleConfigs request was - * truncated, the response includes a NextToken. To get the next set of - * lifecycle configurations, use the token in the next request.

    + *

    Only list model card versions that were created before the time specified.

    */ - NextToken?: string; + CreationTimeBefore?: Date; /** * @public - *

    The maximum number of lifecycle configurations to return in the response.

    + *

    The maximum number of model card versions to list.

    */ MaxResults?: number; /** * @public - *

    Sorts the list of results. The default is CreationTime.

    + *

    List model card versions for the model card with the specified name or Amazon Resource Name (ARN).

    */ - SortBy?: NotebookInstanceLifecycleConfigSortKey; + ModelCardName: string | undefined; /** * @public - *

    The sort order for results.

    + *

    Only list model card versions with the specified approval status.

    */ - SortOrder?: NotebookInstanceLifecycleConfigSortOrder; + ModelCardStatus?: ModelCardStatus; /** * @public - *

    A string in the lifecycle configuration name. This filter returns only lifecycle - * configurations whose name contains the specified string.

    + *

    If the response to a previous ListModelCardVersions request was truncated, + * the response includes a NextToken. To retrieve the next set of model card + * versions, use the token in the next request.

    */ - NameContains?: string; + NextToken?: string; /** * @public - *

    A filter that returns only lifecycle configurations that were created before the - * specified time (timestamp).

    + *

    Sort listed model card versions by version. Sorts by version by default.

    */ - CreationTimeBefore?: Date; + SortBy?: ModelCardVersionSortBy; /** * @public - *

    A filter that returns only lifecycle configurations that were created after the - * specified time (timestamp).

    + *

    Sort model card versions by ascending or descending order.

    */ - CreationTimeAfter?: Date; + SortOrder?: ModelCardSortOrder; +} +/** + * @public + *

    A summary of a specific version of the model card.

    + */ +export interface ModelCardVersionSummary { /** * @public - *

    A filter that returns only lifecycle configurations that were modified before the - * specified time (timestamp).

    + *

    The name of the model card.

    */ - LastModifiedTimeBefore?: Date; + ModelCardName: string | undefined; /** * @public - *

    A filter that returns only lifecycle configurations that were modified after the - * specified time (timestamp).

    + *

    The Amazon Resource Name (ARN) of the model card.

    */ - LastModifiedTimeAfter?: Date; -} + ModelCardArn: string | undefined; -/** - * @public - *

    Provides a summary of a notebook instance lifecycle configuration.

    - */ -export interface NotebookInstanceLifecycleConfigSummary { /** * @public - *

    The name of the lifecycle configuration.

    + *

    The approval status of the model card version within your organization. Different organizations might have different criteria for model card review and approval.

    + *
      + *
    • + *

      + * Draft: The model card is a work in progress.

      + *
      • + *
    • + *

      + * PendingReview: The model card is pending review.

      + *
      • + *
    • + *

      + * Approved: The model card is approved.

      + *
      • + *
    • + *

      + * Archived: The model card is archived. No more updates should be made to the model + * card, but it can still be exported.

      + *
      • + *
    */ - NotebookInstanceLifecycleConfigName: string | undefined; + ModelCardStatus: ModelCardStatus | undefined; /** * @public - *

    The Amazon Resource Name (ARN) of the lifecycle configuration.

    + *

    A version of the model card.

    */ - NotebookInstanceLifecycleConfigArn: string | undefined; + ModelCardVersion: number | undefined; /** * @public - *

    A timestamp that tells when the lifecycle configuration was created.

    + *

    The date and time that the model card version was created.

    */ - CreationTime?: Date; + CreationTime: Date | undefined; /** * @public - *

    A timestamp that tells when the lifecycle configuration was last modified.

    + *

    The time date and time that the model card version was last modified.

    */ LastModifiedTime?: Date; } @@ -7581,1021 +7717,876 @@ export interface NotebookInstanceLifecycleConfigSummary { /** * @public */ -export interface ListNotebookInstanceLifecycleConfigsOutput { +export interface ListModelCardVersionsResponse { /** * @public - *

    If the response is truncated, SageMaker returns this token. To get the next set of - * lifecycle configurations, use it in the next request.

    + *

    The summaries of the listed versions of the model card.

    */ - NextToken?: string; + ModelCardVersionSummaryList: ModelCardVersionSummary[] | undefined; /** * @public - *

    An array of NotebookInstanceLifecycleConfiguration objects, each listing - * a lifecycle configuration.

    + *

    If the response is truncated, SageMaker returns this token. To retrieve the next set of model + * card versions, use it in the subsequent request.

    */ - NotebookInstanceLifecycleConfigs?: NotebookInstanceLifecycleConfigSummary[]; + NextToken?: string; } -/** - * @public - * @enum - */ -export const NotebookInstanceSortKey = { - CREATION_TIME: "CreationTime", - NAME: "Name", - STATUS: "Status", -} as const; - -/** - * @public - */ -export type NotebookInstanceSortKey = (typeof NotebookInstanceSortKey)[keyof typeof NotebookInstanceSortKey]; - -/** - * @public - * @enum - */ -export const NotebookInstanceSortOrder = { - ASCENDING: "Ascending", - DESCENDING: "Descending", -} as const; - /** * @public */ -export type NotebookInstanceSortOrder = (typeof NotebookInstanceSortOrder)[keyof typeof NotebookInstanceSortOrder]; +export interface ListModelExplainabilityJobDefinitionsRequest { + /** + * @public + *

    Name of the endpoint to monitor for model explainability.

    + */ + EndpointName?: string; -/** - * @public - */ -export interface ListNotebookInstancesInput { /** * @public - *

    If the previous call to the ListNotebookInstances is truncated, the - * response includes a NextToken. You can use this token in your subsequent - * ListNotebookInstances request to fetch the next set of notebook - * instances.

    - * - *

    You might specify a filter or a sort order in your request. When response is - * truncated, you must use the same values for the filer and sort order in the next - * request.

    - *     + *

    Whether to sort results by the Name or CreationTime field. + * The default is CreationTime.

    */ - NextToken?: string; + SortBy?: MonitoringJobDefinitionSortKey; /** * @public - *

    The maximum number of notebook instances to return.

    + *

    Whether to sort the results in Ascending or Descending order. + * The default is Descending.

    */ - MaxResults?: number; + SortOrder?: SortOrder; /** * @public - *

    The field to sort results by. The default is Name.

    + *

    The token returned if the response is truncated. To retrieve the next set of job executions, use + * it in the next request.

    */ - SortBy?: NotebookInstanceSortKey; + NextToken?: string; /** * @public - *

    The sort order for results.

    + *

    The maximum number of jobs to return in the response. The default value is 10.

    */ - SortOrder?: NotebookInstanceSortOrder; + MaxResults?: number; /** * @public - *

    A string in the notebook instances' name. This filter returns only notebook - * instances whose name contains the specified string.

    + *

    Filter for model explainability jobs whose name contains a specified string.

    */ NameContains?: string; /** * @public - *

    A filter that returns only notebook instances that were created before the - * specified time (timestamp).

    + *

    A filter that returns only model explainability jobs created before a specified + * time.

    */ CreationTimeBefore?: Date; /** * @public - *

    A filter that returns only notebook instances that were created after the specified - * time (timestamp).

    + *

    A filter that returns only model explainability jobs created after a specified + * time.

    */ CreationTimeAfter?: Date; +} +/** + * @public + */ +export interface ListModelExplainabilityJobDefinitionsResponse { /** * @public - *

    A filter that returns only notebook instances that were modified before the - * specified time (timestamp).

    + *

    A JSON array in which each element is a summary for a explainability bias jobs.

    */ - LastModifiedTimeBefore?: Date; + JobDefinitionSummaries: MonitoringJobDefinitionSummary[] | undefined; /** * @public - *

    A filter that returns only notebook instances that were modified after the - * specified time (timestamp).

    + *

    The token returned if the response is truncated. To retrieve the next set of job executions, use + * it in the next request.

    */ - LastModifiedTimeAfter?: Date; + NextToken?: string; +} - /** - * @public - *

    A filter that returns only notebook instances with the specified status.

    - */ - StatusEquals?: NotebookInstanceStatus; +/** + * @public + * @enum + */ +export const ModelMetadataFilterType = { + DOMAIN: "Domain", + FRAMEWORK: "Framework", + FRAMEWORKVERSION: "FrameworkVersion", + TASK: "Task", +} as const; - /** - * @public - *

    A string in the name of a notebook instances lifecycle configuration associated with - * this notebook instance. This filter returns only notebook instances associated with a - * lifecycle configuration with a name that contains the specified string.

    - */ - NotebookInstanceLifecycleConfigNameContains?: string; +/** + * @public + */ +export type ModelMetadataFilterType = (typeof ModelMetadataFilterType)[keyof typeof ModelMetadataFilterType]; +/** + * @public + *

    Part of the search expression. You can specify the name and value + * (domain, task, framework, framework version, task, and model).

    + */ +export interface ModelMetadataFilter { /** * @public - *

    A string in the name or URL of a Git repository associated with this notebook - * instance. This filter returns only notebook instances associated with a git repository - * with a name that contains the specified string.

    + *

    The name of the of the model to filter by.

    */ - DefaultCodeRepositoryContains?: string; + Name: ModelMetadataFilterType | undefined; /** * @public - *

    A filter that returns only notebook instances with associated with the specified git - * repository.

    + *

    The value to filter the model metadata.

    */ - AdditionalCodeRepositoryEquals?: string; + Value: string | undefined; } /** * @public - *

    Provides summary information for an SageMaker notebook instance.

    + *

    One or more filters that searches for the specified resource or resources in + * a search. All resource objects that satisfy the expression's condition are + * included in the search results

    */ -export interface NotebookInstanceSummary { - /** - * @public - *

    The name of the notebook instance that you want a summary for.

    - */ - NotebookInstanceName: string | undefined; - +export interface ModelMetadataSearchExpression { /** * @public - *

    The Amazon Resource Name (ARN) of the notebook instance.

    + *

    A list of filter objects.

    */ - NotebookInstanceArn: string | undefined; + Filters?: ModelMetadataFilter[]; +} +/** + * @public + */ +export interface ListModelMetadataRequest { /** * @public - *

    The status of the notebook instance.

    + *

    One or more filters that searches for the specified resource or resources + * in a search. All resource objects that satisfy the expression's condition are + * included in the search results. Specify the Framework, FrameworkVersion, Domain + * or Task to filter supported. Filter names and values are case-sensitive.

    */ - NotebookInstanceStatus?: NotebookInstanceStatus; + SearchExpression?: ModelMetadataSearchExpression; /** * @public - *

    The URL that you use to connect to the Jupyter notebook running in your notebook - * instance.

    + *

    If the response to a previous ListModelMetadataResponse request was truncated, + * the response includes a NextToken. To retrieve the next set of model metadata, + * use the token in the next request.

    */ - Url?: string; + NextToken?: string; /** * @public - *

    The type of ML compute instance that the notebook instance is running on.

    + *

    The maximum number of models to return in the response.

    */ - InstanceType?: _InstanceType; + MaxResults?: number; +} +/** + * @public + *

    A summary of the model metadata.

    + */ +export interface ModelMetadataSummary { /** * @public - *

    A timestamp that shows when the notebook instance was created.

    + *

    The machine learning domain of the model.

    */ - CreationTime?: Date; + Domain: string | undefined; /** * @public - *

    A timestamp that shows when the notebook instance was last modified.

    + *

    The machine learning framework of the model.

    */ - LastModifiedTime?: Date; + Framework: string | undefined; /** * @public - *

    The name of a notebook instance lifecycle configuration associated with this notebook - * instance.

    - *

    For information about notebook instance lifestyle configurations, see Step - * 2.1: (Optional) Customize a Notebook Instance.

    + *

    The machine learning task of the model.

    */ - NotebookInstanceLifecycleConfigName?: string; - - /** - * @public - *

    The Git repository associated with the notebook instance as its default code - * repository. This can be either the name of a Git repository stored as a resource in your - * account, or the URL of a Git repository in Amazon Web Services CodeCommit - * or in any other Git repository. When you open a notebook instance, it opens in the - * directory that contains this repository. For more information, see Associating Git - * Repositories with SageMaker Notebook Instances.

    + Task: string | undefined; + + /** + * @public + *

    The name of the model.

    */ - DefaultCodeRepository?: string; + Model: string | undefined; /** * @public - *

    An array of up to three Git repositories associated with the notebook instance. These - * can be either the names of Git repositories stored as resources in your account, or the - * URL of Git repositories in Amazon Web Services CodeCommit - * or in any other Git repository. These repositories are cloned at the same level as the - * default repository of your notebook instance. For more information, see Associating Git - * Repositories with SageMaker Notebook Instances.

    + *

    The framework version of the model.

    */ - AdditionalCodeRepositories?: string[]; + FrameworkVersion: string | undefined; } /** * @public */ -export interface ListNotebookInstancesOutput { +export interface ListModelMetadataResponse { /** * @public - *

    If the response to the previous ListNotebookInstances request was - * truncated, SageMaker returns this token. To retrieve the next set of notebook instances, use - * the token in the next request.

    + *

    A structure that holds model metadata.

    */ - NextToken?: string; + ModelMetadataSummaries: ModelMetadataSummary[] | undefined; /** * @public - *

    An array of NotebookInstanceSummary objects, one for each notebook - * instance.

    + *

    A token for getting the next set of recommendations, if there are any.

    */ - NotebookInstances?: NotebookInstanceSummary[]; + NextToken?: string; } /** * @public * @enum */ -export const SortPipelineExecutionsBy = { +export const ModelPackageGroupSortBy = { CREATION_TIME: "CreationTime", - PIPELINE_EXECUTION_ARN: "PipelineExecutionArn", + NAME: "Name", } as const; /** * @public */ -export type SortPipelineExecutionsBy = (typeof SortPipelineExecutionsBy)[keyof typeof SortPipelineExecutionsBy]; +export type ModelPackageGroupSortBy = (typeof ModelPackageGroupSortBy)[keyof typeof ModelPackageGroupSortBy]; /** * @public */ -export interface ListPipelineExecutionsRequest { +export interface ListModelPackageGroupsInput { /** * @public - *

    The name or Amazon Resource Name (ARN) of the pipeline.

    + *

    A filter that returns only model groups created after the specified time.

    */ - PipelineName: string | undefined; + CreationTimeAfter?: Date; /** * @public - *

    A filter that returns the pipeline executions that were created after a specified - * time.

    + *

    A filter that returns only model groups created before the specified time.

    */ - CreatedAfter?: Date; + CreationTimeBefore?: Date; /** * @public - *

    A filter that returns the pipeline executions that were created before a specified - * time.

    + *

    The maximum number of results to return in the response.

    */ - CreatedBefore?: Date; + MaxResults?: number; /** * @public - *

    The field by which to sort results. The default is CreatedTime.

    + *

    A string in the model group name. This filter returns only model groups whose name + * contains the specified string.

    */ - SortBy?: SortPipelineExecutionsBy; + NameContains?: string; /** * @public - *

    The sort order for results.

    + *

    If the result of the previous ListModelPackageGroups request was + * truncated, the response includes a NextToken. To retrieve the next set of + * model groups, use the token in the next request.

    */ - SortOrder?: SortOrder; + NextToken?: string; /** * @public - *

    If the result of the previous ListPipelineExecutions request was truncated, - * the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.

    + *

    The field to sort results by. The default is CreationTime.

    */ - NextToken?: string; + SortBy?: ModelPackageGroupSortBy; /** * @public - *

    The maximum number of pipeline executions to return in the response.

    + *

    The sort order for results. The default is Ascending.

    */ - MaxResults?: number; + SortOrder?: SortOrder; } /** * @public - *

    A pipeline execution summary.

    + *

    Summary information about a model group.

    */ -export interface PipelineExecutionSummary { - /** - * @public - *

    The Amazon Resource Name (ARN) of the pipeline execution.

    - */ - PipelineExecutionArn?: string; - +export interface ModelPackageGroupSummary { /** * @public - *

    The start time of the pipeline execution.

    + *

    The name of the model group.

    */ - StartTime?: Date; + ModelPackageGroupName: string | undefined; /** * @public - *

    The status of the pipeline execution.

    + *

    The Amazon Resource Name (ARN) of the model group.

    */ - PipelineExecutionStatus?: PipelineExecutionStatus; + ModelPackageGroupArn: string | undefined; /** * @public - *

    The description of the pipeline execution.

    + *

    A description of the model group.

    */ - PipelineExecutionDescription?: string; + ModelPackageGroupDescription?: string; /** * @public - *

    The display name of the pipeline execution.

    + *

    The time that the model group was created.

    */ - PipelineExecutionDisplayName?: string; + CreationTime: Date | undefined; /** * @public - *

    A message generated by SageMaker Pipelines describing why the pipeline execution failed.

    + *

    The status of the model group.

    */ - PipelineExecutionFailureReason?: string; + ModelPackageGroupStatus: ModelPackageGroupStatus | undefined; } /** * @public */ -export interface ListPipelineExecutionsResponse { +export interface ListModelPackageGroupsOutput { /** * @public - *

    Contains a sorted list of pipeline execution summary objects matching the specified - * filters. Each run summary includes the Amazon Resource Name (ARN) of the pipeline execution, the run date, - * and the status. This list can be empty.

    + *

    A list of summaries of the model groups in your Amazon Web Services account.

    */ - PipelineExecutionSummaries?: PipelineExecutionSummary[]; + ModelPackageGroupSummaryList: ModelPackageGroupSummary[] | undefined; /** * @public - *

    If the result of the previous ListPipelineExecutions request was truncated, - * the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.

    + *

    If the response is truncated, SageMaker returns this token. To retrieve the next set + * of model groups, use it in the subsequent request.

    */ NextToken?: string; } /** * @public + * @enum */ -export interface ListPipelineExecutionStepsRequest { - /** - * @public - *

    The Amazon Resource Name (ARN) of the pipeline execution.

    - */ - PipelineExecutionArn?: string; - - /** - * @public - *

    If the result of the previous ListPipelineExecutionSteps request was truncated, - * the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.

    - */ - NextToken?: string; - - /** - * @public - *

    The maximum number of pipeline execution steps to return in the response.

    - */ - MaxResults?: number; +export const ModelPackageType = { + BOTH: "Both", + UNVERSIONED: "Unversioned", + VERSIONED: "Versioned", +} as const; - /** - * @public - *

    The field by which to sort results. The default is CreatedTime.

    - */ - SortOrder?: SortOrder; -} +/** + * @public + */ +export type ModelPackageType = (typeof ModelPackageType)[keyof typeof ModelPackageType]; /** * @public - *

    Metadata for Model steps.

    + * @enum */ -export interface ModelStepMetadata { - /** - * @public - *

    The Amazon Resource Name (ARN) of the created model.

    - */ - Arn?: string; -} +export const ModelPackageSortBy = { + CREATION_TIME: "CreationTime", + NAME: "Name", +} as const; /** * @public - *

    Metadata for a processing job step.

    */ -export interface ProcessingJobStepMetadata { - /** - * @public - *

    The Amazon Resource Name (ARN) of the processing job.

    - */ - Arn?: string; -} +export type ModelPackageSortBy = (typeof ModelPackageSortBy)[keyof typeof ModelPackageSortBy]; /** * @public - *

    Container for the metadata for a Quality check step. For more information, see - * the topic on QualityCheck step in the Amazon SageMaker Developer Guide. - *

    */ -export interface QualityCheckStepMetadata { +export interface ListModelPackagesInput { /** * @public - *

    The type of the Quality check step.

    + *

    A filter that returns only model packages created after the specified time + * (timestamp).

    */ - CheckType?: string; + CreationTimeAfter?: Date; /** * @public - *

    The Amazon S3 URI of the baseline statistics file used for the drift check.

    + *

    A filter that returns only model packages created before the specified time + * (timestamp).

    */ - BaselineUsedForDriftCheckStatistics?: string; + CreationTimeBefore?: Date; /** * @public - *

    The Amazon S3 URI of the baseline constraints file used for the drift check.

    + *

    The maximum number of model packages to return in the response.

    */ - BaselineUsedForDriftCheckConstraints?: string; + MaxResults?: number; /** * @public - *

    The Amazon S3 URI of the newly calculated baseline statistics file.

    + *

    A string in the model package name. This filter returns only model packages whose name + * contains the specified string.

    */ - CalculatedBaselineStatistics?: string; + NameContains?: string; /** * @public - *

    The Amazon S3 URI of the newly calculated baseline constraints file.

    + *

    A filter that returns only the model packages with the specified approval + * status.

    */ - CalculatedBaselineConstraints?: string; + ModelApprovalStatus?: ModelApprovalStatus; /** * @public - *

    The model package group name.

    + *

    A filter that returns only model versions that belong to the specified model group.

    */ ModelPackageGroupName?: string; /** * @public - *

    The Amazon S3 URI of violation report if violations are detected.

    - */ - ViolationReport?: string; - - /** - * @public - *

    The Amazon Resource Name (ARN) of the Quality check processing job that was run by this step execution.

    - */ - CheckJobArn?: string; - - /** - * @public - *

    This flag indicates if the drift check against the previous baseline will be skipped or not. - * If it is set to False, the previous baseline of the configured check type must be available.

    - */ - SkipCheck?: boolean; - - /** - * @public - *

    This flag indicates if a newly calculated baseline can be accessed through step properties - * BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. - * If it is set to False, the previous baseline of the configured check type must also be available. - * These can be accessed through the BaselineUsedForDriftCheckConstraints and - * BaselineUsedForDriftCheckStatistics properties.

    - */ - RegisterNewBaseline?: boolean; -} - -/** - * @public - *

    Metadata for a register model job step.

    - */ -export interface RegisterModelStepMetadata { - /** - * @public - *

    The Amazon Resource Name (ARN) of the model package.

    + *

    A filter that returns only the model packages of the specified type. This can be one + * of the following values.

    + *
      + *
    • + *

      + * UNVERSIONED - List only unversioined models. + * This is the default value if no ModelPackageType is specified.

      + *
      • + *
    • + *

      + * VERSIONED - List only versioned models.

      + *
      • + *
    • + *

      + * BOTH - List both versioned and unversioned models.

      + *
      • + *
    */ - Arn?: string; -} + ModelPackageType?: ModelPackageType; -/** - * @public - *

    Metadata for a training job step.

    - */ -export interface TrainingJobStepMetadata { /** * @public - *

    The Amazon Resource Name (ARN) of the training job that was run by this step execution.

    + *

    If the response to a previous ListModelPackages request was truncated, + * the response includes a NextToken. To retrieve the next set of model + * packages, use the token in the next request.

    */ - Arn?: string; -} + NextToken?: string; -/** - * @public - *

    Metadata for a transform job step.

    - */ -export interface TransformJobStepMetadata { /** * @public - *

    The Amazon Resource Name (ARN) of the transform job that was run by this step execution.

    + *

    The parameter by which to sort the results. The default is + * CreationTime.

    */ - Arn?: string; -} + SortBy?: ModelPackageSortBy; -/** - * @public - *

    Metadata for a tuning step.

    - */ -export interface TuningJobStepMetaData { /** * @public - *

    The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.

    + *

    The sort order for the results. The default is Ascending.

    */ - Arn?: string; + SortOrder?: SortOrder; } /** * @public - *

    Metadata for a step execution.

    + *

    Provides summary information about a model package.

    */ -export interface PipelineExecutionStepMetadata { - /** - * @public - *

    The Amazon Resource Name (ARN) of the training job that was run by this step execution.

    - */ - TrainingJob?: TrainingJobStepMetadata; - - /** - * @public - *

    The Amazon Resource Name (ARN) of the processing job that was run by this step execution.

    - */ - ProcessingJob?: ProcessingJobStepMetadata; - +export interface ModelPackageSummary { /** * @public - *

    The Amazon Resource Name (ARN) of the transform job that was run by this step execution.

    + *

    The name of the model package.

    */ - TransformJob?: TransformJobStepMetadata; + ModelPackageName?: string; /** * @public - *

    The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.

    + *

    If the model package is a versioned model, the model group that the versioned model + * belongs to.

    */ - TuningJob?: TuningJobStepMetaData; + ModelPackageGroupName?: string; /** * @public - *

    The Amazon Resource Name (ARN) of the model that was created by this step execution.

    + *

    If the model package is a versioned model, the version of the model.

    */ - Model?: ModelStepMetadata; + ModelPackageVersion?: number; /** * @public - *

    The Amazon Resource Name (ARN) of the model package that the model was registered to by this step execution.

    + *

    The Amazon Resource Name (ARN) of the model package.

    */ - RegisterModel?: RegisterModelStepMetadata; + ModelPackageArn: string | undefined; /** * @public - *

    The outcome of the condition evaluation that was run by this step execution.

    + *

    A brief description of the model package.

    */ - Condition?: ConditionStepMetadata; + ModelPackageDescription?: string; /** * @public - *

    The URL of the Amazon SQS queue used by this step execution, the pipeline generated token, - * and a list of output parameters.

    + *

    A timestamp that shows when the model package was created.

    */ - Callback?: CallbackStepMetadata; + CreationTime: Date | undefined; /** * @public - *

    The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list of - * output parameters.

    + *

    The overall status of the model package.

    */ - Lambda?: LambdaStepMetadata; + ModelPackageStatus: ModelPackageStatus | undefined; /** * @public - *

    The configurations and outcomes of the check step execution. This includes:

    + *

    The approval status of the model. This can be one of the following values.

    *
      *
    • - *

      The type of the check conducted.

      - *
      • - *
    • - *

      The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.

      - *
      • - *
    • - *

      The Amazon S3 URIs of newly calculated baseline constraints and statistics.

      - *
      • - *
    • - *

      The model package group name provided.

      - *
      • - *
    • - *

      The Amazon S3 URI of the violation report if violations detected.

      - *
      • - *
    • - *

      The Amazon Resource Name (ARN) of check processing job initiated by the step execution.

      + *

      + * APPROVED - The model is approved

      *
      • *
    • - *

      The Boolean flags indicating if the drift check is skipped.

      + *

      + * REJECTED - The model is rejected.

      *
      • *
    • - *

      If step property BaselineUsedForDriftCheck is set the same as - * CalculatedBaseline.

      + *

      + * PENDING_MANUAL_APPROVAL - The model is waiting for manual + * approval.

      *
      • *
    */ - QualityCheck?: QualityCheckStepMetadata; + ModelApprovalStatus?: ModelApprovalStatus; +} +/** + * @public + */ +export interface ListModelPackagesOutput { /** * @public - *

    Container for the metadata for a Clarify check step. The configurations - * and outcomes of the check step execution. This includes:

    - *
      - *
    • - *

      The type of the check conducted,

      - *
      • - *
    • - *

      The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.

      - *
      • - *
    • - *

      The Amazon S3 URIs of newly calculated baseline constraints and statistics.

      - *
      • - *
    • - *

      The model package group name provided.

      - *
      • - *
    • - *

      The Amazon S3 URI of the violation report if violations detected.

      - *
      • - *
    • - *

      The Amazon Resource Name (ARN) of check processing job initiated by the step execution.

      - *
      • - *
    • - *

      The boolean flags indicating if the drift check is skipped.

      - *
      • - *
    • - *

      If step property BaselineUsedForDriftCheck is set the same as - * CalculatedBaseline.

      - *
      • - *
    + *

    An array of ModelPackageSummary objects, each of which lists a model + * package.

    */ - ClarifyCheck?: ClarifyCheckStepMetadata; + ModelPackageSummaryList: ModelPackageSummary[] | undefined; /** * @public - *

    The configurations and outcomes of an Amazon EMR step execution.

    + *

    If the response is truncated, SageMaker returns this token. To retrieve the next set of + * model packages, use it in the subsequent request.

    */ - EMR?: EMRStepMetadata; + NextToken?: string; +} +/** + * @public + */ +export interface ListModelQualityJobDefinitionsRequest { /** * @public - *

    The configurations and outcomes of a Fail step execution.

    + *

    A filter that returns only model quality monitoring job definitions that are associated + * with the specified endpoint.

    */ - Fail?: FailStepMetadata; + EndpointName?: string; /** * @public - *

    The Amazon Resource Name (ARN) of the AutoML job that was run by this step.

    + *

    The field to sort results by. The default is CreationTime.

    */ - AutoMLJob?: AutoMLJobStepMetadata; -} + SortBy?: MonitoringJobDefinitionSortKey; -/** - * @public - *

    The ARN from an execution of the current pipeline.

    - */ -export interface SelectiveExecutionResult { /** * @public - *

    The ARN from an execution of the current pipeline.

    + *

    Whether to sort the results in Ascending or Descending order. + * The default is Descending.

    */ - SourcePipelineExecutionArn?: string; -} - -/** - * @public - * @enum - */ -export const StepStatus = { - EXECUTING: "Executing", - FAILED: "Failed", - STARTING: "Starting", - STOPPED: "Stopped", - STOPPING: "Stopping", - SUCCEEDED: "Succeeded", -} as const; + SortOrder?: SortOrder; -/** - * @public - */ -export type StepStatus = (typeof StepStatus)[keyof typeof StepStatus]; + /** + * @public + *

    If the result of the previous ListModelQualityJobDefinitions request was + * truncated, the response includes a NextToken. To retrieve the next set of + * model quality monitoring job definitions, use the token in the next request.

    + */ + NextToken?: string; -/** - * @public - *

    An execution of a step in a pipeline.

    - */ -export interface PipelineExecutionStep { /** * @public - *

    The name of the step that is executed.

    + *

    The maximum number of results to return in a call to + * ListModelQualityJobDefinitions.

    */ - StepName?: string; + MaxResults?: number; /** * @public - *

    The display name of the step.

    + *

    A string in the transform job name. This filter returns only model quality monitoring + * job definitions whose name contains the specified string.

    */ - StepDisplayName?: string; + NameContains?: string; /** * @public - *

    The description of the step.

    + *

    A filter that returns only model quality monitoring job definitions created before the + * specified time.

    */ - StepDescription?: string; + CreationTimeBefore?: Date; /** * @public - *

    The time that the step started executing.

    + *

    A filter that returns only model quality monitoring job definitions created after the + * specified time.

    */ - StartTime?: Date; + CreationTimeAfter?: Date; +} +/** + * @public + */ +export interface ListModelQualityJobDefinitionsResponse { /** * @public - *

    The time that the step stopped executing.

    + *

    A list of summaries of model quality monitoring job definitions.

    */ - EndTime?: Date; + JobDefinitionSummaries: MonitoringJobDefinitionSummary[] | undefined; /** * @public - *

    The status of the step execution.

    + *

    If the response is truncated, Amazon SageMaker returns this token. To retrieve the + * next set of model quality monitoring job definitions, use it in the next request.

    */ - StepStatus?: StepStatus; + NextToken?: string; +} + +/** + * @public + * @enum + */ +export const ModelSortKey = { + CreationTime: "CreationTime", + Name: "Name", +} as const; + +/** + * @public + */ +export type ModelSortKey = (typeof ModelSortKey)[keyof typeof ModelSortKey]; +/** + * @public + */ +export interface ListModelsInput { /** * @public - *

    If this pipeline execution step was cached, details on the cache hit.

    + *

    Sorts the list of results. The default is CreationTime.

    */ - CacheHitResult?: CacheHitResult; + SortBy?: ModelSortKey; /** * @public - *

    The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.

    + *

    The sort order for results. The default is Descending.

    */ - AttemptCount?: number; + SortOrder?: OrderKey; /** * @public - *

    The reason why the step failed execution. This is only returned if the step failed its execution.

    + *

    If the response to a previous ListModels request was truncated, the + * response includes a NextToken. To retrieve the next set of models, use the + * token in the next request.

    */ - FailureReason?: string; + NextToken?: string; /** * @public - *

    Metadata to run the pipeline step.

    + *

    The maximum number of models to return in the response.

    */ - Metadata?: PipelineExecutionStepMetadata; + MaxResults?: number; /** * @public - *

    The ARN from an execution of the current pipeline from which - * results are reused for this step.

    + *

    A string in the model name. This filter returns only models whose name contains the + * specified string.

    */ - SelectiveExecutionResult?: SelectiveExecutionResult; -} + NameContains?: string; -/** - * @public - */ -export interface ListPipelineExecutionStepsResponse { /** * @public - *

    A list of PipeLineExecutionStep objects. Each - * PipeLineExecutionStep consists of StepName, StartTime, EndTime, StepStatus, - * and Metadata. Metadata is an object with properties for each job that contains relevant - * information about the job created by the step.

    + *

    A filter that returns only models created before the specified time + * (timestamp).

    */ - PipelineExecutionSteps?: PipelineExecutionStep[]; + CreationTimeBefore?: Date; /** * @public - *

    If the result of the previous ListPipelineExecutionSteps request was truncated, - * the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.

    + *

    A filter that returns only models with a creation time greater than or equal to the + * specified time (timestamp).

    */ - NextToken?: string; + CreationTimeAfter?: Date; } /** * @public + *

    Provides summary information about a model.

    */ -export interface ListPipelineParametersForExecutionRequest { +export interface ModelSummary { /** * @public - *

    The Amazon Resource Name (ARN) of the pipeline execution.

    + *

    The name of the model that you want a summary for.

    */ - PipelineExecutionArn: string | undefined; + ModelName: string | undefined; /** * @public - *

    If the result of the previous ListPipelineParametersForExecution request was truncated, - * the response includes a NextToken. To retrieve the next set of parameters, use the token in the next request.

    + *

    The Amazon Resource Name (ARN) of the model.

    */ - NextToken?: string; + ModelArn: string | undefined; /** * @public - *

    The maximum number of parameters to return in the response.

    + *

    A timestamp that indicates when the model was created.

    */ - MaxResults?: number; + CreationTime: Date | undefined; } /** * @public - *

    Assigns a value to a named Pipeline parameter.

    */ -export interface Parameter { +export interface ListModelsOutput { /** * @public - *

    The name of the parameter to assign a value to. This - * parameter name must match a named parameter in the - * pipeline definition.

    + *

    An array of ModelSummary objects, each of which lists a + * model.

    */ - Name: string | undefined; + Models: ModelSummary[] | undefined; /** * @public - *

    The literal value for the parameter.

    + *

    If the response is truncated, SageMaker returns this token. To retrieve the next set of + * models, use it in the subsequent request.

    */ - Value: string | undefined; + NextToken?: string; } /** * @public + * @enum */ -export interface ListPipelineParametersForExecutionResponse { - /** - * @public - *

    Contains a list of pipeline parameters. This list can be empty.

    - */ - PipelineParameters?: Parameter[]; +export const MonitoringAlertHistorySortKey = { + CreationTime: "CreationTime", + Status: "Status", +} as const; - /** - * @public - *

    If the result of the previous ListPipelineParametersForExecution request was truncated, - * the response includes a NextToken. To retrieve the next set of parameters, use the token in the next request.

    - */ - NextToken?: string; -} +/** + * @public + */ +export type MonitoringAlertHistorySortKey = + (typeof MonitoringAlertHistorySortKey)[keyof typeof MonitoringAlertHistorySortKey]; /** * @public * @enum */ -export const SortPipelinesBy = { - CREATION_TIME: "CreationTime", - NAME: "Name", +export const MonitoringAlertStatus = { + IN_ALERT: "InAlert", + OK: "OK", } as const; /** * @public */ -export type SortPipelinesBy = (typeof SortPipelinesBy)[keyof typeof SortPipelinesBy]; +export type MonitoringAlertStatus = (typeof MonitoringAlertStatus)[keyof typeof MonitoringAlertStatus]; /** * @public */ -export interface ListPipelinesRequest { - /** - * @public - *

    The prefix of the pipeline name.

    - */ - PipelineNamePrefix?: string; - +export interface ListMonitoringAlertHistoryRequest { /** * @public - *

    A filter that returns the pipelines that were created after a specified - * time.

    + *

    The name of a monitoring schedule.

    */ - CreatedAfter?: Date; + MonitoringScheduleName?: string; /** * @public - *

    A filter that returns the pipelines that were created before a specified - * time.

    + *

    The name of a monitoring alert.

    */ - CreatedBefore?: Date; + MonitoringAlertName?: string; /** * @public - *

    The field by which to sort results. The default is CreatedTime.

    + *

    The field used to sort results. The default is CreationTime.

    */ - SortBy?: SortPipelinesBy; + SortBy?: MonitoringAlertHistorySortKey; /** * @public - *

    The sort order for results.

    + *

    The sort order, whether Ascending or Descending, of the alert + * history. The default is Descending.

    */ SortOrder?: SortOrder; /** * @public - *

    If the result of the previous ListPipelines request was truncated, - * the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.

    + *

    If the result of the previous ListMonitoringAlertHistory request was + * truncated, the response includes a NextToken. To retrieve the next set of + * alerts in the history, use the token in the next request.

    */ NextToken?: string; /** * @public - *

    The maximum number of pipelines to return in the response.

    + *

    The maximum number of results to display. The default is 100.

    */ MaxResults?: number; -} - -/** - * @public - *

    A summary of a pipeline.

    - */ -export interface PipelineSummary { - /** - * @public - *

    The Amazon Resource Name (ARN) of the pipeline.

    - */ - PipelineArn?: string; /** * @public - *

    The name of the pipeline.

    + *

    A filter that returns only alerts created on or before the specified time.

    */ - PipelineName?: string; + CreationTimeBefore?: Date; /** * @public - *

    The display name of the pipeline.

    + *

    A filter that returns only alerts created on or after the specified time.

    */ - PipelineDisplayName?: string; + CreationTimeAfter?: Date; /** * @public - *

    The description of the pipeline.

    + *

    A filter that retrieves only alerts with a specific status.

    */ - PipelineDescription?: string; + StatusEquals?: MonitoringAlertStatus; +} +/** + * @public + *

    Provides summary information of an alert's history.

    + */ +export interface MonitoringAlertHistorySummary { /** * @public - *

    The Amazon Resource Name (ARN) that the pipeline used to execute.

    + *

    The name of a monitoring schedule.

    */ - RoleArn?: string; + MonitoringScheduleName: string | undefined; /** * @public - *

    The creation time of the pipeline.

    + *

    The name of a monitoring alert.

    */ - CreationTime?: Date; + MonitoringAlertName: string | undefined; /** * @public - *

    The time that the pipeline was last modified.

    + *

    A timestamp that indicates when the first alert transition occurred in an alert history. + * An alert transition can be from status InAlert to OK, + * or from OK to InAlert.

    */ - LastModifiedTime?: Date; + CreationTime: Date | undefined; /** * @public - *

    The last time that a pipeline execution began.

    + *

    The current alert status of an alert.

    */ - LastExecutionTime?: Date; + AlertStatus: MonitoringAlertStatus | undefined; } /** * @public */ -export interface ListPipelinesResponse { +export interface ListMonitoringAlertHistoryResponse { /** * @public - *

    Contains a sorted list of PipelineSummary objects matching the specified - * filters. Each PipelineSummary consists of PipelineArn, PipelineName, - * ExperimentName, PipelineDescription, CreationTime, LastModifiedTime, LastRunTime, and - * RoleArn. This list can be empty.

    + *

    An alert history for a model monitoring schedule.

    */ - PipelineSummaries?: PipelineSummary[]; + MonitoringAlertHistory?: MonitoringAlertHistorySummary[]; /** * @public - *

    If the result of the previous ListPipelines request was truncated, - * the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.

    + *

    If the response is truncated, SageMaker returns this token. To retrieve the next set of + * alerts, use it in the subsequent request.

    */ NextToken?: string; } @@ -8603,142 +8594,120 @@ export interface ListPipelinesResponse { /** * @public */ -export interface ListProcessingJobsRequest { - /** - * @public - *

    A filter that returns only processing jobs created after the specified time.

    - */ - CreationTimeAfter?: Date; - - /** - * @public - *

    A filter that returns only processing jobs created after the specified time.

    - */ - CreationTimeBefore?: Date; - - /** - * @public - *

    A filter that returns only processing jobs modified after the specified time.

    - */ - LastModifiedTimeAfter?: Date; - - /** - * @public - *

    A filter that returns only processing jobs modified before the specified time.

    - */ - LastModifiedTimeBefore?: Date; - - /** - * @public - *

    A string in the processing job name. This filter returns only processing jobs whose - * name contains the specified string.

    - */ - NameContains?: string; - - /** - * @public - *

    A filter that retrieves only processing jobs with a specific status.

    - */ - StatusEquals?: ProcessingJobStatus; - +export interface ListMonitoringAlertsRequest { /** * @public - *

    The field to sort results by. The default is CreationTime.

    + *

    The name of a monitoring schedule.

    */ - SortBy?: SortBy; + MonitoringScheduleName: string | undefined; /** * @public - *

    The sort order for results. The default is Ascending.

    + *

    If the result of the previous ListMonitoringAlerts request was truncated, + * the response includes a NextToken. To retrieve the next set of alerts in the + * history, use the token in the next request.

    */ - SortOrder?: SortOrder; + NextToken?: string; /** * @public - *

    If the result of the previous ListProcessingJobs request was truncated, - * the response includes a NextToken. To retrieve the next set of processing - * jobs, use the token in the next request.

    + *

    The maximum number of results to display. The default is 100.

    */ - NextToken?: string; + MaxResults?: number; +} +/** + * @public + *

    An alert action taken to light up an icon on the Amazon SageMaker Model Dashboard when an alert goes into + * InAlert status.

    + */ +export interface ModelDashboardIndicatorAction { /** * @public - *

    The maximum number of processing jobs to return in the response.

    + *

    Indicates whether the alert action is turned on.

    */ - MaxResults?: number; + Enabled?: boolean; } /** * @public - *

    Summary of information about a processing job.

    + *

    A list of alert actions taken in response to an alert going into + * InAlert status.

    */ -export interface ProcessingJobSummary { +export interface MonitoringAlertActions { /** * @public - *

    The name of the processing job.

    + *

    An alert action taken to light up an icon on the Model Dashboard when an alert goes into + * InAlert status.

    */ - ProcessingJobName: string | undefined; + ModelDashboardIndicator?: ModelDashboardIndicatorAction; +} +/** + * @public + *

    Provides summary information about a monitor alert.

    + */ +export interface MonitoringAlertSummary { /** * @public - *

    The Amazon Resource Name (ARN) of the processing job..

    + *

    The name of a monitoring alert.

    */ - ProcessingJobArn: string | undefined; + MonitoringAlertName: string | undefined; /** * @public - *

    The time at which the processing job was created.

    + *

    A timestamp that indicates when a monitor alert was created.

    */ CreationTime: Date | undefined; /** * @public - *

    The time at which the processing job completed.

    + *

    A timestamp that indicates when a monitor alert was last updated.

    */ - ProcessingEndTime?: Date; + LastModifiedTime: Date | undefined; /** * @public - *

    A timestamp that indicates the last time the processing job was modified.

    + *

    The current status of an alert.

    */ - LastModifiedTime?: Date; + AlertStatus: MonitoringAlertStatus | undefined; /** * @public - *

    The status of the processing job.

    + *

    Within EvaluationPeriod, how many execution failures will raise an + * alert.

    */ - ProcessingJobStatus: ProcessingJobStatus | undefined; + DatapointsToAlert: number | undefined; /** * @public - *

    A string, up to one KB in size, that contains the reason a processing job failed, if - * it failed.

    + *

    The number of most recent monitoring executions to consider when evaluating alert + * status.

    */ - FailureReason?: string; + EvaluationPeriod: number | undefined; /** * @public - *

    An optional string, up to one KB in size, that contains metadata from the processing - * container when the processing job exits.

    + *

    A list of alert actions taken in response to an alert going into + * InAlert status.

    */ - ExitMessage?: string; + Actions: MonitoringAlertActions | undefined; } /** * @public */ -export interface ListProcessingJobsResponse { +export interface ListMonitoringAlertsResponse { /** * @public - *

    An array of ProcessingJobSummary objects, each listing a processing - * job.

    + *

    A JSON array where each element is a summary for a monitoring alert.

    */ - ProcessingJobSummaries: ProcessingJobSummary[] | undefined; + MonitoringAlertSummaries?: MonitoringAlertSummary[]; /** * @public - *

    If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of - * processing jobs, use it in the subsequent request.

    + *

    If the response is truncated, SageMaker returns this token. To retrieve the next set of + * alerts, use it in the subsequent request.

    */ NextToken?: string; } @@ -8747,138 +8716,131 @@ export interface ListProcessingJobsResponse { * @public * @enum */ -export const ProjectSortBy = { +export const MonitoringExecutionSortKey = { CREATION_TIME: "CreationTime", - NAME: "Name", + SCHEDULED_TIME: "ScheduledTime", + STATUS: "Status", } as const; /** * @public */ -export type ProjectSortBy = (typeof ProjectSortBy)[keyof typeof ProjectSortBy]; +export type MonitoringExecutionSortKey = (typeof MonitoringExecutionSortKey)[keyof typeof MonitoringExecutionSortKey]; /** * @public - * @enum */ -export const ProjectSortOrder = { - ASCENDING: "Ascending", - DESCENDING: "Descending", -} as const; +export interface ListMonitoringExecutionsRequest { + /** + * @public + *

    Name of a specific schedule to fetch jobs for.

    + */ + MonitoringScheduleName?: string; -/** - * @public - */ -export type ProjectSortOrder = (typeof ProjectSortOrder)[keyof typeof ProjectSortOrder]; + /** + * @public + *

    Name of a specific endpoint to fetch jobs for.

    + */ + EndpointName?: string; -/** - * @public - */ -export interface ListProjectsInput { /** * @public - *

    A filter that returns the projects that were created after a specified - * time.

    + *

    Whether to sort the results by the Status, CreationTime, or + * ScheduledTime field. The default is CreationTime.

    */ - CreationTimeAfter?: Date; + SortBy?: MonitoringExecutionSortKey; /** * @public - *

    A filter that returns the projects that were created before a specified - * time.

    + *

    Whether to sort the results in Ascending or Descending order. + * The default is Descending.

    */ - CreationTimeBefore?: Date; + SortOrder?: SortOrder; /** * @public - *

    The maximum number of projects to return in the response.

    + *

    The token returned if the response is truncated. To retrieve the next set of job executions, use + * it in the next request.

    */ - MaxResults?: number; + NextToken?: string; /** * @public - *

    A filter that returns the projects whose name contains a specified - * string.

    + *

    The maximum number of jobs to return in the response. The default value is 10.

    */ - NameContains?: string; + MaxResults?: number; /** * @public - *

    If the result of the previous ListProjects request was truncated, - * the response includes a NextToken. To retrieve the next set of projects, use the token in the next request.

    + *

    Filter for jobs scheduled before a specified time.

    */ - NextToken?: string; + ScheduledTimeBefore?: Date; /** * @public - *

    The field by which to sort results. The default is CreationTime.

    + *

    Filter for jobs scheduled after a specified time.

    */ - SortBy?: ProjectSortBy; + ScheduledTimeAfter?: Date; /** * @public - *

    The sort order for results. The default is Ascending.

    + *

    A filter that returns only jobs created before a specified time.

    */ - SortOrder?: ProjectSortOrder; -} + CreationTimeBefore?: Date; -/** - * @public - *

    Information about a project.

    - */ -export interface ProjectSummary { /** * @public - *

    The name of the project.

    + *

    A filter that returns only jobs created after a specified time.

    */ - ProjectName: string | undefined; + CreationTimeAfter?: Date; /** * @public - *

    The description of the project.

    + *

    A filter that returns only jobs modified after a specified time.

    */ - ProjectDescription?: string; + LastModifiedTimeBefore?: Date; /** * @public - *

    The Amazon Resource Name (ARN) of the project.

    + *

    A filter that returns only jobs modified before a specified time.

    */ - ProjectArn: string | undefined; + LastModifiedTimeAfter?: Date; /** * @public - *

    The ID of the project.

    + *

    A filter that retrieves only jobs with a specific status.

    */ - ProjectId: string | undefined; + StatusEquals?: ExecutionStatus; /** * @public - *

    The time that the project was created.

    + *

    Gets a list of the monitoring job runs of the specified monitoring job + * definitions.

    */ - CreationTime: Date | undefined; + MonitoringJobDefinitionName?: string; /** * @public - *

    The status of the project.

    + *

    A filter that returns only the monitoring job runs of the specified monitoring + * type.

    */ - ProjectStatus: ProjectStatus | undefined; + MonitoringTypeEquals?: MonitoringType; } /** * @public */ -export interface ListProjectsOutput { +export interface ListMonitoringExecutionsResponse { /** * @public - *

    A list of summaries of projects.

    + *

    A JSON array in which each element is a summary for a monitoring execution.

    */ - ProjectSummaryList: ProjectSummary[] | undefined; + MonitoringExecutionSummaries: MonitoringExecutionSummary[] | undefined; /** * @public - *

    If the result of the previous ListCompilationJobs request was truncated, - * the response includes a NextToken. To retrieve the next set of model - * compilation jobs, use the token in the next request.

    + *

    The token returned if the response is truncated. To retrieve the next set of job executions, use + * it in the next request.

    */ NextToken?: string; } @@ -8887,125 +8849,173 @@ export interface ListProjectsOutput { * @public * @enum */ -export const ResourceCatalogSortBy = { +export const MonitoringScheduleSortKey = { CREATION_TIME: "CreationTime", + NAME: "Name", + STATUS: "Status", } as const; /** * @public */ -export type ResourceCatalogSortBy = (typeof ResourceCatalogSortBy)[keyof typeof ResourceCatalogSortBy]; +export type MonitoringScheduleSortKey = (typeof MonitoringScheduleSortKey)[keyof typeof MonitoringScheduleSortKey]; /** * @public - * @enum */ -export const ResourceCatalogSortOrder = { - ASCENDING: "Ascending", - DESCENDING: "Descending", -} as const; +export interface ListMonitoringSchedulesRequest { + /** + * @public + *

    Name of a specific endpoint to fetch schedules for.

    + */ + EndpointName?: string; -/** - * @public - */ -export type ResourceCatalogSortOrder = (typeof ResourceCatalogSortOrder)[keyof typeof ResourceCatalogSortOrder]; + /** + * @public + *

    Whether to sort the results by the Status, CreationTime, or + * ScheduledTime field. The default is CreationTime.

    + */ + SortBy?: MonitoringScheduleSortKey; + + /** + * @public + *

    Whether to sort the results in Ascending or Descending order. + * The default is Descending.

    + */ + SortOrder?: SortOrder; + + /** + * @public + *

    The token returned if the response is truncated. To retrieve the next set of job executions, use + * it in the next request.

    + */ + NextToken?: string; + + /** + * @public + *

    The maximum number of jobs to return in the response. The default value is 10.

    + */ + MaxResults?: number; + + /** + * @public + *

    Filter for monitoring schedules whose name contains a specified string.

    + */ + NameContains?: string; + + /** + * @public + *

    A filter that returns only monitoring schedules created before a specified time.

    + */ + CreationTimeBefore?: Date; + + /** + * @public + *

    A filter that returns only monitoring schedules created after a specified time.

    + */ + CreationTimeAfter?: Date; + + /** + * @public + *

    A filter that returns only monitoring schedules modified before a specified time.

    + */ + LastModifiedTimeBefore?: Date; + + /** + * @public + *

    A filter that returns only monitoring schedules modified after a specified time.

    + */ + LastModifiedTimeAfter?: Date; -/** - * @public - */ -export interface ListResourceCatalogsRequest { /** * @public - *

    A string that partially matches one or more ResourceCatalogs names. - * Filters ResourceCatalog by name.

    + *

    A filter that returns only monitoring schedules modified before a specified time.

    */ - NameContains?: string; + StatusEquals?: ScheduleStatus; /** * @public - *

    Use this parameter to search for ResourceCatalogs created after a - * specific date and time.

    + *

    Gets a list of the monitoring schedules for the specified monitoring job + * definition.

    */ - CreationTimeAfter?: Date; + MonitoringJobDefinitionName?: string; /** * @public - *

    Use this parameter to search for ResourceCatalogs created before a - * specific date and time.

    + *

    A filter that returns only the monitoring schedules for the specified monitoring + * type.

    */ - CreationTimeBefore?: Date; + MonitoringTypeEquals?: MonitoringType; +} +/** + * @public + *

    Summarizes the monitoring schedule.

    + */ +export interface MonitoringScheduleSummary { /** * @public - *

    The order in which the resource catalogs are listed.

    + *

    The name of the monitoring schedule.

    */ - SortOrder?: ResourceCatalogSortOrder; + MonitoringScheduleName: string | undefined; /** * @public - *

    The value on which the resource catalog list is sorted.

    + *

    The Amazon Resource Name (ARN) of the monitoring schedule.

    */ - SortBy?: ResourceCatalogSortBy; + MonitoringScheduleArn: string | undefined; /** * @public - *

    The maximum number of results returned by ListResourceCatalogs.

    + *

    The creation time of the monitoring schedule.

    */ - MaxResults?: number; + CreationTime: Date | undefined; /** * @public - *

    A token to resume pagination of ListResourceCatalogs results.

    + *

    The last time the monitoring schedule was modified.

    */ - NextToken?: string; -} + LastModifiedTime: Date | undefined; -/** - * @public - *

    A resource catalog containing all of the resources of a specific resource type within - * a resource owner account. For an example on sharing the Amazon SageMaker Feature Store - * DefaultFeatureGroupCatalog, see Share Amazon SageMaker Catalog resource type in the Amazon SageMaker Developer Guide. - *

    - */ -export interface ResourceCatalog { /** * @public - *

    The Amazon Resource Name (ARN) of the ResourceCatalog.

    + *

    The status of the monitoring schedule.

    */ - ResourceCatalogArn: string | undefined; + MonitoringScheduleStatus: ScheduleStatus | undefined; /** * @public - *

    The name of the ResourceCatalog.

    + *

    The name of the endpoint using the monitoring schedule.

    */ - ResourceCatalogName: string | undefined; + EndpointName?: string; /** * @public - *

    A free form description of the ResourceCatalog.

    + *

    The name of the monitoring job definition that the schedule is for.

    */ - Description: string | undefined; + MonitoringJobDefinitionName?: string; /** * @public - *

    The time the ResourceCatalog was created.

    + *

    The type of the monitoring job definition that the schedule is for.

    */ - CreationTime: Date | undefined; + MonitoringType?: MonitoringType; } /** * @public */ -export interface ListResourceCatalogsResponse { +export interface ListMonitoringSchedulesResponse { /** * @public - *

    A list of the requested ResourceCatalogs.

    + *

    A JSON array in which each element is a summary for a monitoring schedule.

    */ - ResourceCatalogs?: ResourceCatalog[]; + MonitoringScheduleSummaries: MonitoringScheduleSummary[] | undefined; /** * @public - *

    A token to resume pagination of ListResourceCatalogs results.

    + *

    The token returned if the response is truncated. To retrieve the next set of job executions, use + * it in the next request.

    */ NextToken?: string; } @@ -9014,951 +9024,1008 @@ export interface ListResourceCatalogsResponse { * @public * @enum */ -export const SpaceSortKey = { - CreationTime: "CreationTime", - LastModifiedTime: "LastModifiedTime", +export const NotebookInstanceLifecycleConfigSortKey = { + CREATION_TIME: "CreationTime", + LAST_MODIFIED_TIME: "LastModifiedTime", + NAME: "Name", +} as const; + +/** + * @public + */ +export type NotebookInstanceLifecycleConfigSortKey = + (typeof NotebookInstanceLifecycleConfigSortKey)[keyof typeof NotebookInstanceLifecycleConfigSortKey]; + +/** + * @public + * @enum + */ +export const NotebookInstanceLifecycleConfigSortOrder = { + ASCENDING: "Ascending", + DESCENDING: "Descending", } as const; /** * @public */ -export type SpaceSortKey = (typeof SpaceSortKey)[keyof typeof SpaceSortKey]; +export type NotebookInstanceLifecycleConfigSortOrder = + (typeof NotebookInstanceLifecycleConfigSortOrder)[keyof typeof NotebookInstanceLifecycleConfigSortOrder]; /** * @public */ -export interface ListSpacesRequest { +export interface ListNotebookInstanceLifecycleConfigsInput { /** * @public - *

    If the previous response was truncated, you will receive this token. - * Use it in your next request to receive the next set of results.

    + *

    If the result of a ListNotebookInstanceLifecycleConfigs request was + * truncated, the response includes a NextToken. To get the next set of + * lifecycle configurations, use the token in the next request.

    */ NextToken?: string; /** * @public - *

    The total number of items to return in the response. If the total - * number of items available is more than the value specified, a NextToken - * is provided in the response. To resume pagination, provide the NextToken - * value in the as part of a subsequent call. The default value is 10.

    + *

    The maximum number of lifecycle configurations to return in the response.

    */ MaxResults?: number; /** * @public - *

    The sort order for the results. The default is Ascending.

    + *

    Sorts the list of results. The default is CreationTime.

    */ - SortOrder?: SortOrder; + SortBy?: NotebookInstanceLifecycleConfigSortKey; /** * @public - *

    The parameter by which to sort the results. The default is CreationTime.

    + *

    The sort order for results.

    */ - SortBy?: SpaceSortKey; + SortOrder?: NotebookInstanceLifecycleConfigSortOrder; /** * @public - *

    A parameter to search for the Domain ID.

    + *

    A string in the lifecycle configuration name. This filter returns only lifecycle + * configurations whose name contains the specified string.

    */ - DomainIdEquals?: string; + NameContains?: string; /** * @public - *

    A parameter by which to filter the results.

    + *

    A filter that returns only lifecycle configurations that were created before the + * specified time (timestamp).

    */ - SpaceNameContains?: string; -} + CreationTimeBefore?: Date; -/** - * @public - *

    The space's details.

    - */ -export interface SpaceDetails { /** * @public - *

    The ID of the associated Domain.

    + *

    A filter that returns only lifecycle configurations that were created after the + * specified time (timestamp).

    */ - DomainId?: string; + CreationTimeAfter?: Date; /** * @public - *

    The name of the space.

    + *

    A filter that returns only lifecycle configurations that were modified before the + * specified time (timestamp).

    */ - SpaceName?: string; + LastModifiedTimeBefore?: Date; /** * @public - *

    The status.

    + *

    A filter that returns only lifecycle configurations that were modified after the + * specified time (timestamp).

    */ - Status?: SpaceStatus; + LastModifiedTimeAfter?: Date; +} +/** + * @public + *

    Provides a summary of a notebook instance lifecycle configuration.

    + */ +export interface NotebookInstanceLifecycleConfigSummary { /** * @public - *

    The creation time.

    + *

    The name of the lifecycle configuration.

    */ - CreationTime?: Date; + NotebookInstanceLifecycleConfigName: string | undefined; /** * @public - *

    The last modified time.

    + *

    The Amazon Resource Name (ARN) of the lifecycle configuration.

    */ - LastModifiedTime?: Date; -} + NotebookInstanceLifecycleConfigArn: string | undefined; -/** - * @public - */ -export interface ListSpacesResponse { /** * @public - *

    The list of spaces.

    + *

    A timestamp that tells when the lifecycle configuration was created.

    */ - Spaces?: SpaceDetails[]; + CreationTime?: Date; /** * @public - *

    If the previous response was truncated, you will receive this token. - * Use it in your next request to receive the next set of results.

    + *

    A timestamp that tells when the lifecycle configuration was last modified.

    */ - NextToken?: string; + LastModifiedTime?: Date; } /** * @public */ -export interface ListStageDevicesRequest { +export interface ListNotebookInstanceLifecycleConfigsOutput { /** * @public - *

    The response from the last list when returning a list large enough to neeed - * tokening.

    + *

    If the response is truncated, SageMaker returns this token. To get the next set of + * lifecycle configurations, use it in the next request.

    */ NextToken?: string; /** * @public - *

    The maximum number of requests to select.

    - */ - MaxResults?: number; - - /** - * @public - *

    The name of the edge deployment plan.

    - */ - EdgeDeploymentPlanName: string | undefined; - - /** - * @public - *

    Toggle for excluding devices deployed in other stages.

    - */ - ExcludeDevicesDeployedInOtherStage?: boolean; - - /** - * @public - *

    The name of the stage in the deployment.

    + *

    An array of NotebookInstanceLifecycleConfiguration objects, each listing + * a lifecycle configuration.

    */ - StageName: string | undefined; + NotebookInstanceLifecycleConfigs?: NotebookInstanceLifecycleConfigSummary[]; } /** * @public + * @enum */ -export interface ListStageDevicesResponse { - /** - * @public - *

    List of summaries of devices allocated to the stage.

    - */ - DeviceDeploymentSummaries: DeviceDeploymentSummary[] | undefined; +export const NotebookInstanceSortKey = { + CREATION_TIME: "CreationTime", + NAME: "Name", + STATUS: "Status", +} as const; - /** - * @public - *

    The token to use when calling the next page of results.

    - */ - NextToken?: string; -} +/** + * @public + */ +export type NotebookInstanceSortKey = (typeof NotebookInstanceSortKey)[keyof typeof NotebookInstanceSortKey]; /** * @public * @enum */ -export const StudioLifecycleConfigSortKey = { - CreationTime: "CreationTime", - LastModifiedTime: "LastModifiedTime", - Name: "Name", +export const NotebookInstanceSortOrder = { + ASCENDING: "Ascending", + DESCENDING: "Descending", } as const; /** * @public */ -export type StudioLifecycleConfigSortKey = - (typeof StudioLifecycleConfigSortKey)[keyof typeof StudioLifecycleConfigSortKey]; +export type NotebookInstanceSortOrder = (typeof NotebookInstanceSortOrder)[keyof typeof NotebookInstanceSortOrder]; /** * @public */ -export interface ListStudioLifecycleConfigsRequest { +export interface ListNotebookInstancesInput { /** * @public - *

    The total number of items to return in the response. If the total - * number of items available is more than the value specified, a NextToken - * is provided in the response. To resume pagination, provide the NextToken - * value in the as part of a subsequent call. The default value is 10.

    + *

    If the previous call to the ListNotebookInstances is truncated, the + * response includes a NextToken. You can use this token in your subsequent + * ListNotebookInstances request to fetch the next set of notebook + * instances.

    + * + *

    You might specify a filter or a sort order in your request. When response is + * truncated, you must use the same values for the filer and sort order in the next + * request.

    + *     + */ + NextToken?: string; + + /** + * @public + *

    The maximum number of notebook instances to return.

    */ MaxResults?: number; /** * @public - *

    If the previous call to ListStudioLifecycleConfigs didn't return the full set of Lifecycle Configurations, the call returns a token for getting the next set of Lifecycle Configurations.

    + *

    The field to sort results by. The default is Name.

    */ - NextToken?: string; + SortBy?: NotebookInstanceSortKey; /** * @public - *

    A string in the Lifecycle Configuration name. This filter returns only Lifecycle Configurations whose name contains the specified string.

    + *

    The sort order for results.

    */ - NameContains?: string; + SortOrder?: NotebookInstanceSortOrder; /** * @public - *

    A parameter to search for the App Type to which the Lifecycle Configuration is attached.

    + *

    A string in the notebook instances' name. This filter returns only notebook + * instances whose name contains the specified string.

    */ - AppTypeEquals?: StudioLifecycleConfigAppType; + NameContains?: string; /** * @public - *

    A filter that returns only Lifecycle Configurations created on or before the specified time.

    + *

    A filter that returns only notebook instances that were created before the + * specified time (timestamp).

    */ CreationTimeBefore?: Date; /** * @public - *

    A filter that returns only Lifecycle Configurations created on or after the specified time.

    + *

    A filter that returns only notebook instances that were created after the specified + * time (timestamp).

    */ CreationTimeAfter?: Date; /** * @public - *

    A filter that returns only Lifecycle Configurations modified before the specified time.

    + *

    A filter that returns only notebook instances that were modified before the + * specified time (timestamp).

    */ - ModifiedTimeBefore?: Date; + LastModifiedTimeBefore?: Date; /** * @public - *

    A filter that returns only Lifecycle Configurations modified after the specified time.

    + *

    A filter that returns only notebook instances that were modified after the + * specified time (timestamp).

    */ - ModifiedTimeAfter?: Date; + LastModifiedTimeAfter?: Date; /** * @public - *

    The property used to sort results. The default value is CreationTime.

    + *

    A filter that returns only notebook instances with the specified status.

    */ - SortBy?: StudioLifecycleConfigSortKey; + StatusEquals?: NotebookInstanceStatus; /** * @public - *

    The sort order. The default value is Descending.

    + *

    A string in the name of a notebook instances lifecycle configuration associated with + * this notebook instance. This filter returns only notebook instances associated with a + * lifecycle configuration with a name that contains the specified string.

    */ - SortOrder?: SortOrder; + NotebookInstanceLifecycleConfigNameContains?: string; + + /** + * @public + *

    A string in the name or URL of a Git repository associated with this notebook + * instance. This filter returns only notebook instances associated with a git repository + * with a name that contains the specified string.

    + */ + DefaultCodeRepositoryContains?: string; + + /** + * @public + *

    A filter that returns only notebook instances with associated with the specified git + * repository.

    + */ + AdditionalCodeRepositoryEquals?: string; } /** * @public - *

    Details of the Studio Lifecycle Configuration.

    + *

    Provides summary information for an SageMaker notebook instance.

    */ -export interface StudioLifecycleConfigDetails { +export interface NotebookInstanceSummary { /** * @public - *

    The Amazon Resource Name (ARN) of the Lifecycle Configuration.

    + *

    The name of the notebook instance that you want a summary for.

    */ - StudioLifecycleConfigArn?: string; + NotebookInstanceName: string | undefined; /** * @public - *

    The name of the Studio Lifecycle Configuration.

    + *

    The Amazon Resource Name (ARN) of the notebook instance.

    */ - StudioLifecycleConfigName?: string; + NotebookInstanceArn: string | undefined; /** * @public - *

    The creation time of the Studio Lifecycle Configuration.

    + *

    The status of the notebook instance.

    */ - CreationTime?: Date; + NotebookInstanceStatus?: NotebookInstanceStatus; /** * @public - *

    This value is equivalent to CreationTime because Studio Lifecycle Configurations are immutable.

    + *

    The URL that you use to connect to the Jupyter notebook running in your notebook + * instance.

    */ - LastModifiedTime?: Date; + Url?: string; /** * @public - *

    The App type to which the Lifecycle Configuration is attached.

    + *

    The type of ML compute instance that the notebook instance is running on.

    */ - StudioLifecycleConfigAppType?: StudioLifecycleConfigAppType; -} + InstanceType?: _InstanceType; -/** - * @public - */ -export interface ListStudioLifecycleConfigsResponse { /** * @public - *

    If the previous response was truncated, you will receive this token. - * Use it in your next request to receive the next set of results.

    + *

    A timestamp that shows when the notebook instance was created.

    */ - NextToken?: string; + CreationTime?: Date; /** * @public - *

    A list of Lifecycle Configurations and their properties.

    + *

    A timestamp that shows when the notebook instance was last modified.

    */ - StudioLifecycleConfigs?: StudioLifecycleConfigDetails[]; -} + LastModifiedTime?: Date; -/** - * @public - */ -export interface ListSubscribedWorkteamsRequest { /** * @public - *

    A string in the work team name. This filter returns only work teams whose name - * contains the specified string.

    + *

    The name of a notebook instance lifecycle configuration associated with this notebook + * instance.

    + *

    For information about notebook instance lifestyle configurations, see Step + * 2.1: (Optional) Customize a Notebook Instance.

    */ - NameContains?: string; + NotebookInstanceLifecycleConfigName?: string; /** * @public - *

    If the result of the previous ListSubscribedWorkteams request was - * truncated, the response includes a NextToken. To retrieve the next set of - * labeling jobs, use the token in the next request.

    + *

    The Git repository associated with the notebook instance as its default code + * repository. This can be either the name of a Git repository stored as a resource in your + * account, or the URL of a Git repository in Amazon Web Services CodeCommit + * or in any other Git repository. When you open a notebook instance, it opens in the + * directory that contains this repository. For more information, see Associating Git + * Repositories with SageMaker Notebook Instances.

    */ - NextToken?: string; + DefaultCodeRepository?: string; /** * @public - *

    The maximum number of work teams to return in each page of the response.

    + *

    An array of up to three Git repositories associated with the notebook instance. These + * can be either the names of Git repositories stored as resources in your account, or the + * URL of Git repositories in Amazon Web Services CodeCommit + * or in any other Git repository. These repositories are cloned at the same level as the + * default repository of your notebook instance. For more information, see Associating Git + * Repositories with SageMaker Notebook Instances.

    */ - MaxResults?: number; + AdditionalCodeRepositories?: string[]; } /** * @public */ -export interface ListSubscribedWorkteamsResponse { +export interface ListNotebookInstancesOutput { /** * @public - *

    An array of Workteam objects, each describing a work team.

    + *

    If the response to the previous ListNotebookInstances request was + * truncated, SageMaker returns this token. To retrieve the next set of notebook instances, use + * the token in the next request.

    */ - SubscribedWorkteams: SubscribedWorkteam[] | undefined; + NextToken?: string; /** * @public - *

    If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of - * work teams, use it in the subsequent request.

    + *

    An array of NotebookInstanceSummary objects, one for each notebook + * instance.

    */ - NextToken?: string; + NotebookInstances?: NotebookInstanceSummary[]; } +/** + * @public + * @enum + */ +export const SortPipelineExecutionsBy = { + CREATION_TIME: "CreationTime", + PIPELINE_EXECUTION_ARN: "PipelineExecutionArn", +} as const; + +/** + * @public + */ +export type SortPipelineExecutionsBy = (typeof SortPipelineExecutionsBy)[keyof typeof SortPipelineExecutionsBy]; + /** * @public */ -export interface ListTagsInput { +export interface ListPipelineExecutionsRequest { /** * @public - *

    The Amazon Resource Name (ARN) of the resource whose tags you want to - * retrieve.

    + *

    The name or Amazon Resource Name (ARN) of the pipeline.

    */ - ResourceArn: string | undefined; + PipelineName: string | undefined; /** * @public - *

    If the response to the previous ListTags request is truncated, SageMaker - * returns this token. To retrieve the next set of tags, use it in the subsequent request. - *

    + *

    A filter that returns the pipeline executions that were created after a specified + * time.

    */ - NextToken?: string; + CreatedAfter?: Date; /** * @public - *

    Maximum number of tags to return.

    + *

    A filter that returns the pipeline executions that were created before a specified + * time.

    */ - MaxResults?: number; -} + CreatedBefore?: Date; -/** - * @public - */ -export interface ListTagsOutput { /** * @public - *

    An array of Tag objects, each with a tag key and a value.

    + *

    The field by which to sort results. The default is CreatedTime.

    */ - Tags?: Tag[]; + SortBy?: SortPipelineExecutionsBy; /** * @public - *

    If response is truncated, SageMaker includes a token in the response. You can use this - * token in your subsequent request to fetch next set of tokens.

    + *

    The sort order for results.

    */ - NextToken?: string; -} + SortOrder?: SortOrder; -/** - * @public - */ -export interface ListTrainingJobsRequest { /** * @public - *

    If the result of the previous ListTrainingJobs request was truncated, - * the response includes a NextToken. To retrieve the next set of training - * jobs, use the token in the next request.

    + *

    If the result of the previous ListPipelineExecutions request was truncated, + * the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.

    */ NextToken?: string; /** * @public - *

    The maximum number of training jobs to return in the response.

    + *

    The maximum number of pipeline executions to return in the response.

    */ MaxResults?: number; +} +/** + * @public + *

    A pipeline execution summary.

    + */ +export interface PipelineExecutionSummary { /** * @public - *

    A filter that returns only training jobs created after the specified time - * (timestamp).

    - */ - CreationTimeAfter?: Date; - - /** - * @public - *

    A filter that returns only training jobs created before the specified time - * (timestamp).

    + *

    The Amazon Resource Name (ARN) of the pipeline execution.

    */ - CreationTimeBefore?: Date; + PipelineExecutionArn?: string; /** * @public - *

    A filter that returns only training jobs modified after the specified time - * (timestamp).

    + *

    The start time of the pipeline execution.

    */ - LastModifiedTimeAfter?: Date; + StartTime?: Date; /** * @public - *

    A filter that returns only training jobs modified before the specified time - * (timestamp).

    + *

    The status of the pipeline execution.

    */ - LastModifiedTimeBefore?: Date; + PipelineExecutionStatus?: PipelineExecutionStatus; /** * @public - *

    A string in the training job name. This filter returns only training jobs whose - * name contains the specified string.

    + *

    The description of the pipeline execution.

    */ - NameContains?: string; + PipelineExecutionDescription?: string; /** * @public - *

    A filter that retrieves only training jobs with a specific status.

    + *

    The display name of the pipeline execution.

    */ - StatusEquals?: TrainingJobStatus; + PipelineExecutionDisplayName?: string; /** * @public - *

    The field to sort results by. The default is CreationTime.

    + *

    A message generated by SageMaker Pipelines describing why the pipeline execution failed.

    */ - SortBy?: SortBy; + PipelineExecutionFailureReason?: string; +} +/** + * @public + */ +export interface ListPipelineExecutionsResponse { /** * @public - *

    The sort order for results. The default is Ascending.

    + *

    Contains a sorted list of pipeline execution summary objects matching the specified + * filters. Each run summary includes the Amazon Resource Name (ARN) of the pipeline execution, the run date, + * and the status. This list can be empty.

    */ - SortOrder?: SortOrder; + PipelineExecutionSummaries?: PipelineExecutionSummary[]; /** * @public - *

    A filter that retrieves only training jobs with a specific warm pool status.

    + *

    If the result of the previous ListPipelineExecutions request was truncated, + * the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.

    */ - WarmPoolStatusEquals?: WarmPoolResourceStatus; + NextToken?: string; } /** * @public - *

    Provides summary information about a training job.

    */ -export interface TrainingJobSummary { - /** - * @public - *

    The name of the training job that you want a summary for.

    - */ - TrainingJobName: string | undefined; - +export interface ListPipelineExecutionStepsRequest { /** * @public - *

    The Amazon Resource Name (ARN) of the training job.

    + *

    The Amazon Resource Name (ARN) of the pipeline execution.

    */ - TrainingJobArn: string | undefined; + PipelineExecutionArn?: string; /** * @public - *

    A timestamp that shows when the training job was created.

    + *

    If the result of the previous ListPipelineExecutionSteps request was truncated, + * the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.

    */ - CreationTime: Date | undefined; + NextToken?: string; /** * @public - *

    A timestamp that shows when the training job ended. This field is set only if the - * training job has one of the terminal statuses (Completed, - * Failed, or Stopped).

    + *

    The maximum number of pipeline execution steps to return in the response.

    */ - TrainingEndTime?: Date; + MaxResults?: number; /** * @public - *

    Timestamp when the training job was last modified.

    + *

    The field by which to sort results. The default is CreatedTime.

    */ - LastModifiedTime?: Date; + SortOrder?: SortOrder; +} +/** + * @public + *

    Metadata for Model steps.

    + */ +export interface ModelStepMetadata { /** * @public - *

    The status of the training job.

    + *

    The Amazon Resource Name (ARN) of the created model.

    */ - TrainingJobStatus: TrainingJobStatus | undefined; + Arn?: string; +} +/** + * @public + *

    Metadata for a processing job step.

    + */ +export interface ProcessingJobStepMetadata { /** * @public - *

    The status of the warm pool associated with the training job.

    + *

    The Amazon Resource Name (ARN) of the processing job.

    */ - WarmPoolStatus?: WarmPoolStatus; + Arn?: string; } /** * @public + *

    Container for the metadata for a Quality check step. For more information, see + * the topic on QualityCheck step in the Amazon SageMaker Developer Guide. + *

    */ -export interface ListTrainingJobsResponse { +export interface QualityCheckStepMetadata { /** * @public - *

    An array of TrainingJobSummary objects, each listing a training - * job.

    + *

    The type of the Quality check step.

    */ - TrainingJobSummaries: TrainingJobSummary[] | undefined; + CheckType?: string; /** * @public - *

    If the response is truncated, SageMaker returns this token. To retrieve the next set of - * training jobs, use it in the subsequent request.

    + *

    The Amazon S3 URI of the baseline statistics file used for the drift check.

    */ - NextToken?: string; -} + BaselineUsedForDriftCheckStatistics?: string; -/** - * @public - * @enum - */ -export const TrainingJobSortByOptions = { - CreationTime: "CreationTime", - FinalObjectiveMetricValue: "FinalObjectiveMetricValue", - Name: "Name", - Status: "Status", -} as const; + /** + * @public + *

    The Amazon S3 URI of the baseline constraints file used for the drift check.

    + */ + BaselineUsedForDriftCheckConstraints?: string; -/** - * @public - */ -export type TrainingJobSortByOptions = (typeof TrainingJobSortByOptions)[keyof typeof TrainingJobSortByOptions]; + /** + * @public + *

    The Amazon S3 URI of the newly calculated baseline statistics file.

    + */ + CalculatedBaselineStatistics?: string; -/** - * @public - */ -export interface ListTrainingJobsForHyperParameterTuningJobRequest { /** * @public - *

    The name of the tuning job whose training jobs you want to list.

    + *

    The Amazon S3 URI of the newly calculated baseline constraints file.

    */ - HyperParameterTuningJobName: string | undefined; + CalculatedBaselineConstraints?: string; /** * @public - *

    If the result of the previous ListTrainingJobsForHyperParameterTuningJob - * request was truncated, the response includes a NextToken. To retrieve the - * next set of training jobs, use the token in the next request.

    + *

    The model package group name.

    */ - NextToken?: string; + ModelPackageGroupName?: string; /** * @public - *

    The maximum number of training jobs to return. The default value is 10.

    + *

    The Amazon S3 URI of violation report if violations are detected.

    */ - MaxResults?: number; + ViolationReport?: string; /** * @public - *

    A filter that returns only training jobs with the specified status.

    + *

    The Amazon Resource Name (ARN) of the Quality check processing job that was run by this step execution.

    */ - StatusEquals?: TrainingJobStatus; + CheckJobArn?: string; /** * @public - *

    The field to sort results by. The default is Name.

    - *

    If the value of this field is FinalObjectiveMetricValue, any training - * jobs that did not return an objective metric are not listed.

    + *

    This flag indicates if the drift check against the previous baseline will be skipped or not. + * If it is set to False, the previous baseline of the configured check type must be available.

    */ - SortBy?: TrainingJobSortByOptions; + SkipCheck?: boolean; /** * @public - *

    The sort order for results. The default is Ascending.

    + *

    This flag indicates if a newly calculated baseline can be accessed through step properties + * BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. + * If it is set to False, the previous baseline of the configured check type must also be available. + * These can be accessed through the BaselineUsedForDriftCheckConstraints and + * BaselineUsedForDriftCheckStatistics properties.

    */ - SortOrder?: SortOrder; + RegisterNewBaseline?: boolean; } /** * @public + *

    Metadata for a register model job step.

    */ -export interface ListTrainingJobsForHyperParameterTuningJobResponse { - /** - * @public - *

    A list of TrainingJobSummary objects that - * describe - * the training jobs that the - * ListTrainingJobsForHyperParameterTuningJob request returned.

    - */ - TrainingJobSummaries: HyperParameterTrainingJobSummary[] | undefined; - +export interface RegisterModelStepMetadata { /** * @public - *

    If the result of this ListTrainingJobsForHyperParameterTuningJob request - * was truncated, the response includes a NextToken. To retrieve the next set - * of training jobs, use the token in the next request.

    + *

    The Amazon Resource Name (ARN) of the model package.

    */ - NextToken?: string; + Arn?: string; } /** * @public + *

    Metadata for a training job step.

    */ -export interface ListTransformJobsRequest { +export interface TrainingJobStepMetadata { /** * @public - *

    A filter that returns only transform jobs created after the specified time.

    + *

    The Amazon Resource Name (ARN) of the training job that was run by this step execution.

    */ - CreationTimeAfter?: Date; + Arn?: string; +} +/** + * @public + *

    Metadata for a transform job step.

    + */ +export interface TransformJobStepMetadata { /** * @public - *

    A filter that returns only transform jobs created before the specified time.

    + *

    The Amazon Resource Name (ARN) of the transform job that was run by this step execution.

    */ - CreationTimeBefore?: Date; + Arn?: string; +} +/** + * @public + *

    Metadata for a tuning step.

    + */ +export interface TuningJobStepMetaData { /** * @public - *

    A filter that returns only transform jobs modified after the specified time.

    + *

    The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.

    */ - LastModifiedTimeAfter?: Date; + Arn?: string; +} +/** + * @public + *

    Metadata for a step execution.

    + */ +export interface PipelineExecutionStepMetadata { /** * @public - *

    A filter that returns only transform jobs modified before the specified time.

    + *

    The Amazon Resource Name (ARN) of the training job that was run by this step execution.

    */ - LastModifiedTimeBefore?: Date; + TrainingJob?: TrainingJobStepMetadata; /** * @public - *

    A string in the transform job name. This filter returns only transform jobs whose name - * contains the specified string.

    + *

    The Amazon Resource Name (ARN) of the processing job that was run by this step execution.

    */ - NameContains?: string; + ProcessingJob?: ProcessingJobStepMetadata; /** * @public - *

    A filter that retrieves only transform jobs with a specific status.

    + *

    The Amazon Resource Name (ARN) of the transform job that was run by this step execution.

    */ - StatusEquals?: TransformJobStatus; + TransformJob?: TransformJobStepMetadata; /** * @public - *

    The field to sort results by. The default is CreationTime.

    + *

    The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.

    */ - SortBy?: SortBy; + TuningJob?: TuningJobStepMetaData; /** * @public - *

    The sort order for results. The default is Descending.

    + *

    The Amazon Resource Name (ARN) of the model that was created by this step execution.

    */ - SortOrder?: SortOrder; + Model?: ModelStepMetadata; /** * @public - *

    If the result of the previous ListTransformJobs request was truncated, - * the response includes a NextToken. To retrieve the next set of transform - * jobs, use the token in the next request.

    + *

    The Amazon Resource Name (ARN) of the model package that the model was registered to by this step execution.

    */ - NextToken?: string; + RegisterModel?: RegisterModelStepMetadata; /** * @public - *

    The maximum number of transform jobs to return in the response. The default value is 10.

    + *

    The outcome of the condition evaluation that was run by this step execution.

    */ - MaxResults?: number; -} + Condition?: ConditionStepMetadata; -/** - * @public - *

    Provides a - * summary - * of a transform job. Multiple TransformJobSummary objects are returned as a - * list after in response to a ListTransformJobs call.

    - */ -export interface TransformJobSummary { /** * @public - *

    The name of the transform job.

    + *

    The URL of the Amazon SQS queue used by this step execution, the pipeline generated token, + * and a list of output parameters.

    */ - TransformJobName: string | undefined; + Callback?: CallbackStepMetadata; /** * @public - *

    The Amazon Resource Name (ARN) of the transform job.

    + *

    The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list of + * output parameters.

    */ - TransformJobArn: string | undefined; + Lambda?: LambdaStepMetadata; /** * @public - *

    A timestamp that shows when the transform Job was created.

    + *

    The configurations and outcomes of the check step execution. This includes:

    + *
      + *
    • + *

      The type of the check conducted.

      + *
      • + *
    • + *

      The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.

      + *
      • + *
    • + *

      The Amazon S3 URIs of newly calculated baseline constraints and statistics.

      + *
      • + *
    • + *

      The model package group name provided.

      + *
      • + *
    • + *

      The Amazon S3 URI of the violation report if violations detected.

      + *
      • + *
    • + *

      The Amazon Resource Name (ARN) of check processing job initiated by the step execution.

      + *
      • + *
    • + *

      The Boolean flags indicating if the drift check is skipped.

      + *
      • + *
    • + *

      If step property BaselineUsedForDriftCheck is set the same as + * CalculatedBaseline.

      + *
      • + *
    */ - CreationTime: Date | undefined; + QualityCheck?: QualityCheckStepMetadata; /** * @public - *

    Indicates when the transform - * job - * ends on compute instances. For successful jobs and stopped jobs, this - * is the exact time - * recorded - * after the results are uploaded. For failed jobs, this is when Amazon SageMaker - * detected that the job failed.

    + *

    Container for the metadata for a Clarify check step. The configurations + * and outcomes of the check step execution. This includes:

    + *
      + *
    • + *

      The type of the check conducted,

      + *
      • + *
    • + *

      The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.

      + *
      • + *
    • + *

      The Amazon S3 URIs of newly calculated baseline constraints and statistics.

      + *
      • + *
    • + *

      The model package group name provided.

      + *
      • + *
    • + *

      The Amazon S3 URI of the violation report if violations detected.

      + *
      • + *
    • + *

      The Amazon Resource Name (ARN) of check processing job initiated by the step execution.

      + *
      • + *
    • + *

      The boolean flags indicating if the drift check is skipped.

      + *
      • + *
    • + *

      If step property BaselineUsedForDriftCheck is set the same as + * CalculatedBaseline.

      + *
      • + *
    */ - TransformEndTime?: Date; + ClarifyCheck?: ClarifyCheckStepMetadata; /** * @public - *

    Indicates when the transform job was last modified.

    + *

    The configurations and outcomes of an Amazon EMR step execution.

    */ - LastModifiedTime?: Date; + EMR?: EMRStepMetadata; /** * @public - *

    The status of the transform job.

    + *

    The configurations and outcomes of a Fail step execution.

    */ - TransformJobStatus: TransformJobStatus | undefined; + Fail?: FailStepMetadata; /** * @public - *

    If the transform job failed, - * the - * reason it failed.

    + *

    The Amazon Resource Name (ARN) of the AutoML job that was run by this step.

    */ - FailureReason?: string; + AutoMLJob?: AutoMLJobStepMetadata; } /** * @public + *

    The ARN from an execution of the current pipeline.

    */ -export interface ListTransformJobsResponse { - /** - * @public - *

    An array of - * TransformJobSummary - * objects.

    - */ - TransformJobSummaries: TransformJobSummary[] | undefined; - +export interface SelectiveExecutionResult { /** * @public - *

    If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of - * transform jobs, use it in the next request.

    + *

    The ARN from an execution of the current pipeline.

    */ - NextToken?: string; + SourcePipelineExecutionArn?: string; } /** * @public * @enum */ -export const SortTrialComponentsBy = { - CREATION_TIME: "CreationTime", - NAME: "Name", +export const StepStatus = { + EXECUTING: "Executing", + FAILED: "Failed", + STARTING: "Starting", + STOPPED: "Stopped", + STOPPING: "Stopping", + SUCCEEDED: "Succeeded", } as const; /** * @public */ -export type SortTrialComponentsBy = (typeof SortTrialComponentsBy)[keyof typeof SortTrialComponentsBy]; +export type StepStatus = (typeof StepStatus)[keyof typeof StepStatus]; /** * @public + *

    An execution of a step in a pipeline.

    */ -export interface ListTrialComponentsRequest { - /** - * @public - *

    A filter that returns only components that are part of the specified experiment. If you - * specify ExperimentName, you can't filter by SourceArn or - * TrialName.

    - */ - ExperimentName?: string; - - /** - * @public - *

    A filter that returns only components that are part of the specified trial. If you specify - * TrialName, you can't filter by ExperimentName or - * SourceArn.

    - */ - TrialName?: string; - +export interface PipelineExecutionStep { /** * @public - *

    A filter that returns only components that have the specified source Amazon Resource Name (ARN). - * If you specify SourceArn, you can't filter by ExperimentName - * or TrialName.

    + *

    The name of the step that is executed.

    */ - SourceArn?: string; + StepName?: string; /** * @public - *

    A filter that returns only components created after the specified time.

    + *

    The display name of the step.

    */ - CreatedAfter?: Date; + StepDisplayName?: string; /** * @public - *

    A filter that returns only components created before the specified time.

    + *

    The description of the step.

    */ - CreatedBefore?: Date; + StepDescription?: string; /** * @public - *

    The property used to sort results. The default value is CreationTime.

    + *

    The time that the step started executing.

    */ - SortBy?: SortTrialComponentsBy; + StartTime?: Date; /** * @public - *

    The sort order. The default value is Descending.

    + *

    The time that the step stopped executing.

    */ - SortOrder?: SortOrder; + EndTime?: Date; /** * @public - *

    The maximum number of components to return in the response. The default value is - * 10.

    + *

    The status of the step execution.

    */ - MaxResults?: number; + StepStatus?: StepStatus; /** * @public - *

    If the previous call to ListTrialComponents didn't return the full set of - * components, the call returns a token for getting the next set of components.

    + *

    If this pipeline execution step was cached, details on the cache hit.

    */ - NextToken?: string; -} + CacheHitResult?: CacheHitResult; -/** - * @public - *

    A summary of the properties of a trial component. To get all the properties, call the - * DescribeTrialComponent API and provide the - * TrialComponentName.

    - */ -export interface TrialComponentSummary { /** * @public - *

    The name of the trial component.

    + *

    The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.

    */ - TrialComponentName?: string; + AttemptCount?: number; /** * @public - *

    The Amazon Resource Name (ARN) of the trial component.

    + *

    The reason why the step failed execution. This is only returned if the step failed its execution.

    */ - TrialComponentArn?: string; + FailureReason?: string; /** * @public - *

    The name of the component as displayed. If DisplayName isn't specified, - * TrialComponentName is displayed.

    + *

    Metadata to run the pipeline step.

    */ - DisplayName?: string; + Metadata?: PipelineExecutionStepMetadata; /** * @public - *

    The Amazon Resource Name (ARN) and job type of the source of a trial component.

    + *

    The ARN from an execution of the current pipeline from which + * results are reused for this step.

    */ - TrialComponentSource?: TrialComponentSource; + SelectiveExecutionResult?: SelectiveExecutionResult; +} +/** + * @public + */ +export interface ListPipelineExecutionStepsResponse { /** * @public - *

    The status of the component. States include:

    - *
      - *
    • - *

      InProgress

      - *
      • - *
    • - *

      Completed

      - *
      • - *
    • - *

      Failed

      - *
      • - *
    + *

    A list of PipeLineExecutionStep objects. Each + * PipeLineExecutionStep consists of StepName, StartTime, EndTime, StepStatus, + * and Metadata. Metadata is an object with properties for each job that contains relevant + * information about the job created by the step.

    */ - Status?: TrialComponentStatus; + PipelineExecutionSteps?: PipelineExecutionStep[]; /** * @public - *

    When the component started.

    + *

    If the result of the previous ListPipelineExecutionSteps request was truncated, + * the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.

    */ - StartTime?: Date; + NextToken?: string; +} +/** + * @public + */ +export interface ListPipelineParametersForExecutionRequest { /** * @public - *

    When the component ended.

    + *

    The Amazon Resource Name (ARN) of the pipeline execution.

    */ - EndTime?: Date; + PipelineExecutionArn: string | undefined; /** * @public - *

    When the component was created.

    + *

    If the result of the previous ListPipelineParametersForExecution request was truncated, + * the response includes a NextToken. To retrieve the next set of parameters, use the token in the next request.

    */ - CreationTime?: Date; + NextToken?: string; /** * @public - *

    Who created the trial component.

    + *

    The maximum number of parameters to return in the response.

    */ - CreatedBy?: UserContext; + MaxResults?: number; +} +/** + * @public + *

    Assigns a value to a named Pipeline parameter.

    + */ +export interface Parameter { /** * @public - *

    When the component was last modified.

    + *

    The name of the parameter to assign a value to. This + * parameter name must match a named parameter in the + * pipeline definition.

    */ - LastModifiedTime?: Date; + Name: string | undefined; /** * @public - *

    Who last modified the component.

    + *

    The literal value for the parameter.

    */ - LastModifiedBy?: UserContext; + Value: string | undefined; } /** * @public */ -export interface ListTrialComponentsResponse { +export interface ListPipelineParametersForExecutionResponse { /** * @public - *

    A list of the summaries of your trial components.

    + *

    Contains a list of pipeline parameters. This list can be empty.

    */ - TrialComponentSummaries?: TrialComponentSummary[]; + PipelineParameters?: Parameter[]; /** * @public - *

    A token for getting the next set of components, if there are any.

    + *

    If the result of the previous ListPipelineParametersForExecution request was truncated, + * the response includes a NextToken. To retrieve the next set of parameters, use the token in the next request.

    */ NextToken?: string; } @@ -9967,7 +10034,7 @@ export interface ListTrialComponentsResponse { * @public * @enum */ -export const SortTrialsBy = { +export const SortPipelinesBy = { CREATION_TIME: "CreationTime", NAME: "Name", } as const; @@ -9975,300 +10042,272 @@ export const SortTrialsBy = { /** * @public */ -export type SortTrialsBy = (typeof SortTrialsBy)[keyof typeof SortTrialsBy]; +export type SortPipelinesBy = (typeof SortPipelinesBy)[keyof typeof SortPipelinesBy]; /** * @public */ -export interface ListTrialsRequest { - /** - * @public - *

    A filter that returns only trials that are part of the specified experiment.

    - */ - ExperimentName?: string; - +export interface ListPipelinesRequest { /** * @public - *

    A filter that returns only trials that are associated with the specified trial - * component.

    + *

    The prefix of the pipeline name.

    */ - TrialComponentName?: string; + PipelineNamePrefix?: string; /** * @public - *

    A filter that returns only trials created after the specified time.

    + *

    A filter that returns the pipelines that were created after a specified + * time.

    */ CreatedAfter?: Date; /** * @public - *

    A filter that returns only trials created before the specified time.

    + *

    A filter that returns the pipelines that were created before a specified + * time.

    */ CreatedBefore?: Date; /** * @public - *

    The property used to sort results. The default value is CreationTime.

    + *

    The field by which to sort results. The default is CreatedTime.

    */ - SortBy?: SortTrialsBy; + SortBy?: SortPipelinesBy; /** * @public - *

    The sort order. The default value is Descending.

    + *

    The sort order for results.

    */ SortOrder?: SortOrder; /** * @public - *

    The maximum number of trials to return in the response. The default value is 10.

    + *

    If the result of the previous ListPipelines request was truncated, + * the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.

    */ - MaxResults?: number; + NextToken?: string; /** * @public - *

    If the previous call to ListTrials didn't return the full set of trials, the - * call returns a token for getting the next set of trials.

    + *

    The maximum number of pipelines to return in the response.

    */ - NextToken?: string; + MaxResults?: number; } /** * @public - *

    A summary of the properties of a trial. To get the complete set of properties, call the - * DescribeTrial API and provide the TrialName.

    + *

    A summary of a pipeline.

    */ -export interface TrialSummary { +export interface PipelineSummary { /** * @public - *

    The Amazon Resource Name (ARN) of the trial.

    + *

    The Amazon Resource Name (ARN) of the pipeline.

    */ - TrialArn?: string; + PipelineArn?: string; + + /** + * @public + *

    The name of the pipeline.

    + */ + PipelineName?: string; /** * @public - *

    The name of the trial.

    + *

    The display name of the pipeline.

    */ - TrialName?: string; + PipelineDisplayName?: string; /** * @public - *

    The name of the trial as displayed. If DisplayName isn't specified, - * TrialName is displayed.

    + *

    The description of the pipeline.

    */ - DisplayName?: string; + PipelineDescription?: string; /** * @public - *

    The source of the trial.

    + *

    The Amazon Resource Name (ARN) that the pipeline used to execute.

    */ - TrialSource?: TrialSource; + RoleArn?: string; /** * @public - *

    When the trial was created.

    + *

    The creation time of the pipeline.

    */ CreationTime?: Date; /** * @public - *

    When the trial was last modified.

    + *

    The time that the pipeline was last modified.

    */ LastModifiedTime?: Date; + + /** + * @public + *

    The last time that a pipeline execution began.

    + */ + LastExecutionTime?: Date; } /** * @public */ -export interface ListTrialsResponse { +export interface ListPipelinesResponse { /** * @public - *

    A list of the summaries of your trials.

    + *

    Contains a sorted list of PipelineSummary objects matching the specified + * filters. Each PipelineSummary consists of PipelineArn, PipelineName, + * ExperimentName, PipelineDescription, CreationTime, LastModifiedTime, LastRunTime, and + * RoleArn. This list can be empty.

    */ - TrialSummaries?: TrialSummary[]; + PipelineSummaries?: PipelineSummary[]; /** * @public - *

    A token for getting the next set of trials, if there are any.

    + *

    If the result of the previous ListPipelines request was truncated, + * the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.

    */ NextToken?: string; } -/** - * @public - * @enum - */ -export const UserProfileSortKey = { - CreationTime: "CreationTime", - LastModifiedTime: "LastModifiedTime", -} as const; - -/** - * @public - */ -export type UserProfileSortKey = (typeof UserProfileSortKey)[keyof typeof UserProfileSortKey]; - /** * @public */ -export interface ListUserProfilesRequest { - /** - * @public - *

    If the previous response was truncated, you will receive this token. - * Use it in your next request to receive the next set of results.

    - */ - NextToken?: string; - +export interface ListProcessingJobsRequest { /** * @public - *

    The total number of items to return in the response. If the total - * number of items available is more than the value specified, a NextToken - * is provided in the response. To resume pagination, provide the NextToken - * value in the as part of a subsequent call. The default value is 10.

    + *

    A filter that returns only processing jobs created after the specified time.

    */ - MaxResults?: number; + CreationTimeAfter?: Date; /** * @public - *

    The sort order for the results. The default is Ascending.

    + *

    A filter that returns only processing jobs created after the specified time.

    */ - SortOrder?: SortOrder; + CreationTimeBefore?: Date; /** * @public - *

    The parameter by which to sort the results. The default is CreationTime.

    + *

    A filter that returns only processing jobs modified after the specified time.

    */ - SortBy?: UserProfileSortKey; + LastModifiedTimeAfter?: Date; /** * @public - *

    A parameter by which to filter the results.

    + *

    A filter that returns only processing jobs modified before the specified time.

    */ - DomainIdEquals?: string; + LastModifiedTimeBefore?: Date; /** * @public - *

    A parameter by which to filter the results.

    + *

    A string in the processing job name. This filter returns only processing jobs whose + * name contains the specified string.

    */ - UserProfileNameContains?: string; -} + NameContains?: string; -/** - * @public - *

    The user profile details.

    - */ -export interface UserProfileDetails { /** * @public - *

    The domain ID.

    + *

    A filter that retrieves only processing jobs with a specific status.

    */ - DomainId?: string; + StatusEquals?: ProcessingJobStatus; /** * @public - *

    The user profile name.

    + *

    The field to sort results by. The default is CreationTime.

    */ - UserProfileName?: string; + SortBy?: SortBy; /** * @public - *

    The status.

    + *

    The sort order for results. The default is Ascending.

    */ - Status?: UserProfileStatus; + SortOrder?: SortOrder; /** * @public - *

    The creation time.

    + *

    If the result of the previous ListProcessingJobs request was truncated, + * the response includes a NextToken. To retrieve the next set of processing + * jobs, use the token in the next request.

    */ - CreationTime?: Date; + NextToken?: string; /** * @public - *

    The last modified time.

    + *

    The maximum number of processing jobs to return in the response.

    */ - LastModifiedTime?: Date; + MaxResults?: number; } /** * @public + *

    Summary of information about a processing job.

    */ -export interface ListUserProfilesResponse { +export interface ProcessingJobSummary { /** * @public - *

    The list of user profiles.

    + *

    The name of the processing job.

    */ - UserProfiles?: UserProfileDetails[]; + ProcessingJobName: string | undefined; /** * @public - *

    If the previous response was truncated, you will receive this token. - * Use it in your next request to receive the next set of results.

    + *

    The Amazon Resource Name (ARN) of the processing job..

    */ - NextToken?: string; -} - -/** - * @public - * @enum - */ -export const ListWorkforcesSortByOptions = { - CreateDate: "CreateDate", - Name: "Name", -} as const; + ProcessingJobArn: string | undefined; -/** - * @public - */ -export type ListWorkforcesSortByOptions = - (typeof ListWorkforcesSortByOptions)[keyof typeof ListWorkforcesSortByOptions]; + /** + * @public + *

    The time at which the processing job was created.

    + */ + CreationTime: Date | undefined; -/** - * @public - */ -export interface ListWorkforcesRequest { /** * @public - *

    Sort workforces using the workforce name or creation date.

    + *

    The time at which the processing job completed.

    */ - SortBy?: ListWorkforcesSortByOptions; + ProcessingEndTime?: Date; /** * @public - *

    Sort workforces in ascending or descending order.

    + *

    A timestamp that indicates the last time the processing job was modified.

    */ - SortOrder?: SortOrder; + LastModifiedTime?: Date; /** * @public - *

    A filter you can use to search for workforces using part of the workforce name.

    + *

    The status of the processing job.

    */ - NameContains?: string; + ProcessingJobStatus: ProcessingJobStatus | undefined; /** * @public - *

    A token to resume pagination.

    + *

    A string, up to one KB in size, that contains the reason a processing job failed, if + * it failed.

    */ - NextToken?: string; + FailureReason?: string; /** * @public - *

    The maximum number of workforces returned in the response.

    + *

    An optional string, up to one KB in size, that contains metadata from the processing + * container when the processing job exits.

    */ - MaxResults?: number; + ExitMessage?: string; } /** * @public */ -export interface ListWorkforcesResponse { +export interface ListProcessingJobsResponse { /** * @public - *

    A list containing information about your workforce.

    + *

    An array of ProcessingJobSummary objects, each listing a processing + * job.

    */ - Workforces: Workforce[] | undefined; + ProcessingJobSummaries: ProcessingJobSummary[] | undefined; /** * @public - *

    A token to resume pagination.

    + *

    If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of + * processing jobs, use it in the subsequent request.

    */ NextToken?: string; } @@ -10277,147 +10316,138 @@ export interface ListWorkforcesResponse { * @public * @enum */ -export const ListWorkteamsSortByOptions = { - CreateDate: "CreateDate", - Name: "Name", +export const ProjectSortBy = { + CREATION_TIME: "CreationTime", + NAME: "Name", } as const; /** * @public */ -export type ListWorkteamsSortByOptions = (typeof ListWorkteamsSortByOptions)[keyof typeof ListWorkteamsSortByOptions]; +export type ProjectSortBy = (typeof ProjectSortBy)[keyof typeof ProjectSortBy]; /** * @public + * @enum */ -export interface ListWorkteamsRequest { - /** - * @public - *

    The field to sort results by. The default is CreationTime.

    - */ - SortBy?: ListWorkteamsSortByOptions; +export const ProjectSortOrder = { + ASCENDING: "Ascending", + DESCENDING: "Descending", +} as const; - /** - * @public - *

    The sort order for results. The default is Ascending.

    - */ - SortOrder?: SortOrder; +/** + * @public + */ +export type ProjectSortOrder = (typeof ProjectSortOrder)[keyof typeof ProjectSortOrder]; +/** + * @public + */ +export interface ListProjectsInput { /** * @public - *

    A string in the work team's name. This filter returns only work teams whose name - * contains the specified string.

    + *

    A filter that returns the projects that were created after a specified + * time.

    */ - NameContains?: string; + CreationTimeAfter?: Date; /** * @public - *

    If the result of the previous ListWorkteams request was truncated, the - * response includes a NextToken. To retrieve the next set of labeling jobs, - * use the token in the next request.

    + *

    A filter that returns the projects that were created before a specified + * time.

    */ - NextToken?: string; + CreationTimeBefore?: Date; /** * @public - *

    The maximum number of work teams to return in each page of the response.

    + *

    The maximum number of projects to return in the response.

    */ MaxResults?: number; -} -/** - * @public - */ -export interface ListWorkteamsResponse { /** * @public - *

    An array of Workteam objects, each describing a work team.

    + *

    A filter that returns the projects whose name contains a specified + * string.

    */ - Workteams: Workteam[] | undefined; + NameContains?: string; /** * @public - *

    If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of - * work teams, use it in the subsequent request.

    + *

    If the result of the previous ListProjects request was truncated, + * the response includes a NextToken. To retrieve the next set of projects, use the token in the next request.

    */ NextToken?: string; -} - -/** - * @public - *

    The properties of a model as returned by the Search API.

    - */ -export interface Model { - /** - * @public - *

    The name of the model.

    - */ - ModelName?: string; /** * @public - *

    Describes the container, as part of model definition.

    + *

    The field by which to sort results. The default is CreationTime.

    */ - PrimaryContainer?: ContainerDefinition; + SortBy?: ProjectSortBy; /** * @public - *

    The containers in the inference pipeline.

    + *

    The sort order for results. The default is Ascending.

    */ - Containers?: ContainerDefinition[]; + SortOrder?: ProjectSortOrder; +} +/** + * @public + *

    Information about a project.

    + */ +export interface ProjectSummary { /** * @public - *

    Specifies details about how containers in a multi-container endpoint are run.

    + *

    The name of the project.

    */ - InferenceExecutionConfig?: InferenceExecutionConfig; + ProjectName: string | undefined; /** * @public - *

    The Amazon Resource Name (ARN) of the IAM role that you specified for the - * model.

    + *

    The description of the project.

    */ - ExecutionRoleArn?: string; + ProjectDescription?: string; /** * @public - *

    Specifies a VPC that your training jobs and hosted models have access to. Control - * access to and from your training and model containers by configuring the VPC. For more - * information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Training Jobs - * by Using an Amazon Virtual Private Cloud.

    + *

    The Amazon Resource Name (ARN) of the project.

    */ - VpcConfig?: VpcConfig; + ProjectArn: string | undefined; /** * @public - *

    A timestamp that indicates when the model was created.

    + *

    The ID of the project.

    */ - CreationTime?: Date; + ProjectId: string | undefined; /** * @public - *

    The Amazon Resource Name (ARN) of the model.

    + *

    The time that the project was created.

    */ - ModelArn?: string; + CreationTime: Date | undefined; /** * @public - *

    Isolates the model container. No inbound or outbound network calls can be made to or - * from the model container.

    + *

    The status of the project.

    */ - EnableNetworkIsolation?: boolean; + ProjectStatus: ProjectStatus | undefined; +} +/** + * @public + */ +export interface ListProjectsOutput { /** * @public - *

    A list of key-value pairs associated with the model. For more information, see - * Tagging Amazon Web Services - * resources in the Amazon Web Services General Reference Guide.

    + *

    A list of summaries of projects.

    */ - Tags?: Tag[]; + ProjectSummaryList: ProjectSummary[] | undefined; /** * @public - *

    A set of recommended deployment configurations for the model.

    + *

    If the result of the previous ListCompilationJobs request was truncated, + * the response includes a NextToken. To retrieve the next set of model + * compilation jobs, use the token in the next request.

    */ - DeploymentRecommendation?: DeploymentRecommendation; + NextToken?: string; } diff --git a/clients/client-sagemaker/src/models/models_4.ts b/clients/client-sagemaker/src/models/models_4.ts index bdf28be732e6..65611e0a1304 100644 --- a/clients/client-sagemaker/src/models/models_4.ts +++ b/clients/client-sagemaker/src/models/models_4.ts @@ -5,6 +5,7 @@ import { ActionStatus, AdditionalInferenceSpecificationDefinition, AlgorithmSpecification, + AppNetworkAccessType, AppSecurityGroupManagement, AppSpecification, BatchDataCaptureConfig, @@ -13,6 +14,8 @@ import { BooleanOperator, Channel, CheckpointConfig, + ClusterInstanceGroupSpecification, + ContainerDefinition, InferenceSpecification, KernelGatewayImageConfig, MetadataProperties, @@ -31,22 +34,22 @@ import { } from "./models_0"; import { _InstanceType, - CrossAccountFilterOption, DataProcessing, DebugHookConfig, DebugRuleConfiguration, - DebugRuleEvaluationStatus, DefaultSpaceSettings, DeploymentConfig, DriftCheckBaselines, EdgeOutputConfig, ExperimentConfig, FeatureDefinition, + InferenceComponentRuntimeConfig, + InferenceComponentSpecification, + InferenceExecutionConfig, InferenceExperimentDataStorageConfig, InferenceExperimentSchedule, InstanceMetadataServiceConfiguration, JobType, - MemberDefinition, ModelCardSecurityConfig, ModelCardStatus, ModelClientConfig, @@ -58,9 +61,6 @@ import { NetworkConfig, NotebookInstanceAcceleratorType, NotebookInstanceLifecycleHook, - NotificationConfiguration, - OidcConfig, - OidcConfigFilterSensitiveLog, ParallelismConfiguration, PipelineDefinitionS3Location, ProcessingInput, @@ -77,8 +77,8 @@ import { ShadowModeConfig, SkipModelValidation, SourceAlgorithmSpecification, - SourceIpConfig, SpaceSettings, + StudioLifecycleConfigAppType, TensorBoardOutputConfig, TrialComponentArtifact, TrialComponentParameterValue, @@ -87,21 +87,23 @@ import { UiTemplate, UserSettings, VendorGuidance, - WorkforceVpcConfigRequest, } from "./models_1"; import { - DesiredWeightAndCapacity, - Device, - Direction, - DomainSettingsForUpdate, - Edge, + CrossAccountFilterOption, + DebugRuleEvaluationStatus, + DeploymentRecommendation, EndpointStatus, FeatureParameter, + HyperParameterTrainingJobSummary, + MemberDefinition, MetricData, ModelArtifacts, ModelPackageGroupStatus, ModelPackageStatusDetails, MonitoringExecutionSummary, + NotificationConfiguration, + OidcConfig, + OidcConfigFilterSensitiveLog, PipelineExecutionStatus, PipelineExperimentConfig, PipelineStatus, @@ -112,15 +114,26 @@ import { SecondaryStatusTransition, SelectiveExecutionConfig, ServiceCatalogProvisionedProductDetails, + SourceIpConfig, + SpaceStatus, + SubscribedWorkteam, TrainingJobStatus, TransformJobStatus, TrialComponentMetricSummary, TrialComponentSource, TrialSource, - Workforce, - Workteam, + UserProfileStatus, + WarmPoolResourceStatus, + WarmPoolStatus, + WorkforceVpcConfigRequest, } from "./models_2"; import { + DesiredWeightAndCapacity, + Device, + DeviceDeploymentSummary, + Direction, + DomainSettingsForUpdate, + Edge, Endpoint, Experiment, FeatureGroup, @@ -130,12 +143,1553 @@ import { HyperParameterTuningJobSearchEntity, InferenceExperimentStopDesiredState, LineageType, - Model, MonitoringAlertSummary, Parameter, ResourceType, + SortBy, + SortOrder, + Workforce, + Workteam, } from "./models_3"; +/** + * @public + * @enum + */ +export const ResourceCatalogSortBy = { + CREATION_TIME: "CreationTime", +} as const; + +/** + * @public + */ +export type ResourceCatalogSortBy = (typeof ResourceCatalogSortBy)[keyof typeof ResourceCatalogSortBy]; + +/** + * @public + * @enum + */ +export const ResourceCatalogSortOrder = { + ASCENDING: "Ascending", + DESCENDING: "Descending", +} as const; + +/** + * @public + */ +export type ResourceCatalogSortOrder = (typeof ResourceCatalogSortOrder)[keyof typeof ResourceCatalogSortOrder]; + +/** + * @public + */ +export interface ListResourceCatalogsRequest { + /** + * @public + *

    A string that partially matches one or more ResourceCatalogs names. + * Filters ResourceCatalog by name.

    + */ + NameContains?: string; + + /** + * @public + *

    Use this parameter to search for ResourceCatalogs created after a + * specific date and time.

    + */ + CreationTimeAfter?: Date; + + /** + * @public + *

    Use this parameter to search for ResourceCatalogs created before a + * specific date and time.

    + */ + CreationTimeBefore?: Date; + + /** + * @public + *

    The order in which the resource catalogs are listed.

    + */ + SortOrder?: ResourceCatalogSortOrder; + + /** + * @public + *

    The value on which the resource catalog list is sorted.

    + */ + SortBy?: ResourceCatalogSortBy; + + /** + * @public + *

    The maximum number of results returned by ListResourceCatalogs.

    + */ + MaxResults?: number; + + /** + * @public + *

    A token to resume pagination of ListResourceCatalogs results.

    + */ + NextToken?: string; +} + +/** + * @public + *

    A resource catalog containing all of the resources of a specific resource type within + * a resource owner account. For an example on sharing the Amazon SageMaker Feature Store + * DefaultFeatureGroupCatalog, see Share Amazon SageMaker Catalog resource type in the Amazon SageMaker Developer Guide. + *

    + */ +export interface ResourceCatalog { + /** + * @public + *

    The Amazon Resource Name (ARN) of the ResourceCatalog.

    + */ + ResourceCatalogArn: string | undefined; + + /** + * @public + *

    The name of the ResourceCatalog.

    + */ + ResourceCatalogName: string | undefined; + + /** + * @public + *

    A free form description of the ResourceCatalog.

    + */ + Description: string | undefined; + + /** + * @public + *

    The time the ResourceCatalog was created.

    + */ + CreationTime: Date | undefined; +} + +/** + * @public + */ +export interface ListResourceCatalogsResponse { + /** + * @public + *

    A list of the requested ResourceCatalogs.

    + */ + ResourceCatalogs?: ResourceCatalog[]; + + /** + * @public + *

    A token to resume pagination of ListResourceCatalogs results.

    + */ + NextToken?: string; +} + +/** + * @public + * @enum + */ +export const SpaceSortKey = { + CreationTime: "CreationTime", + LastModifiedTime: "LastModifiedTime", +} as const; + +/** + * @public + */ +export type SpaceSortKey = (typeof SpaceSortKey)[keyof typeof SpaceSortKey]; + +/** + * @public + */ +export interface ListSpacesRequest { + /** + * @public + *

    If the previous response was truncated, you will receive this token. + * Use it in your next request to receive the next set of results.

    + */ + NextToken?: string; + + /** + * @public + *

    The total number of items to return in the response. If the total + * number of items available is more than the value specified, a NextToken + * is provided in the response. To resume pagination, provide the NextToken + * value in the as part of a subsequent call. The default value is 10.

    + */ + MaxResults?: number; + + /** + * @public + *

    The sort order for the results. The default is Ascending.

    + */ + SortOrder?: SortOrder; + + /** + * @public + *

    The parameter by which to sort the results. The default is CreationTime.

    + */ + SortBy?: SpaceSortKey; + + /** + * @public + *

    A parameter to search for the Domain ID.

    + */ + DomainIdEquals?: string; + + /** + * @public + *

    A parameter by which to filter the results.

    + */ + SpaceNameContains?: string; +} + +/** + * @public + *

    The space's details.

    + */ +export interface SpaceDetails { + /** + * @public + *

    The ID of the associated Domain.

    + */ + DomainId?: string; + + /** + * @public + *

    The name of the space.

    + */ + SpaceName?: string; + + /** + * @public + *

    The status.

    + */ + Status?: SpaceStatus; + + /** + * @public + *

    The creation time.

    + */ + CreationTime?: Date; + + /** + * @public + *

    The last modified time.

    + */ + LastModifiedTime?: Date; +} + +/** + * @public + */ +export interface ListSpacesResponse { + /** + * @public + *

    The list of spaces.

    + */ + Spaces?: SpaceDetails[]; + + /** + * @public + *

    If the previous response was truncated, you will receive this token. + * Use it in your next request to receive the next set of results.

    + */ + NextToken?: string; +} + +/** + * @public + */ +export interface ListStageDevicesRequest { + /** + * @public + *

    The response from the last list when returning a list large enough to neeed + * tokening.

    + */ + NextToken?: string; + + /** + * @public + *

    The maximum number of requests to select.

    + */ + MaxResults?: number; + + /** + * @public + *

    The name of the edge deployment plan.

    + */ + EdgeDeploymentPlanName: string | undefined; + + /** + * @public + *

    Toggle for excluding devices deployed in other stages.

    + */ + ExcludeDevicesDeployedInOtherStage?: boolean; + + /** + * @public + *

    The name of the stage in the deployment.

    + */ + StageName: string | undefined; +} + +/** + * @public + */ +export interface ListStageDevicesResponse { + /** + * @public + *

    List of summaries of devices allocated to the stage.

    + */ + DeviceDeploymentSummaries: DeviceDeploymentSummary[] | undefined; + + /** + * @public + *

    The token to use when calling the next page of results.

    + */ + NextToken?: string; +} + +/** + * @public + * @enum + */ +export const StudioLifecycleConfigSortKey = { + CreationTime: "CreationTime", + LastModifiedTime: "LastModifiedTime", + Name: "Name", +} as const; + +/** + * @public + */ +export type StudioLifecycleConfigSortKey = + (typeof StudioLifecycleConfigSortKey)[keyof typeof StudioLifecycleConfigSortKey]; + +/** + * @public + */ +export interface ListStudioLifecycleConfigsRequest { + /** + * @public + *

    The total number of items to return in the response. If the total + * number of items available is more than the value specified, a NextToken + * is provided in the response. To resume pagination, provide the NextToken + * value in the as part of a subsequent call. The default value is 10.

    + */ + MaxResults?: number; + + /** + * @public + *

    If the previous call to ListStudioLifecycleConfigs didn't return the full set of Lifecycle Configurations, the call returns a token for getting the next set of Lifecycle Configurations.

    + */ + NextToken?: string; + + /** + * @public + *

    A string in the Lifecycle Configuration name. This filter returns only Lifecycle Configurations whose name contains the specified string.

    + */ + NameContains?: string; + + /** + * @public + *

    A parameter to search for the App Type to which the Lifecycle Configuration is attached.

    + */ + AppTypeEquals?: StudioLifecycleConfigAppType; + + /** + * @public + *

    A filter that returns only Lifecycle Configurations created on or before the specified time.

    + */ + CreationTimeBefore?: Date; + + /** + * @public + *

    A filter that returns only Lifecycle Configurations created on or after the specified time.

    + */ + CreationTimeAfter?: Date; + + /** + * @public + *

    A filter that returns only Lifecycle Configurations modified before the specified time.

    + */ + ModifiedTimeBefore?: Date; + + /** + * @public + *

    A filter that returns only Lifecycle Configurations modified after the specified time.

    + */ + ModifiedTimeAfter?: Date; + + /** + * @public + *

    The property used to sort results. The default value is CreationTime.

    + */ + SortBy?: StudioLifecycleConfigSortKey; + + /** + * @public + *

    The sort order. The default value is Descending.

    + */ + SortOrder?: SortOrder; +} + +/** + * @public + *

    Details of the Amazon SageMaker Studio Lifecycle Configuration.

    + */ +export interface StudioLifecycleConfigDetails { + /** + * @public + *

    The Amazon Resource Name (ARN) of the Lifecycle Configuration.

    + */ + StudioLifecycleConfigArn?: string; + + /** + * @public + *

    The name of the Amazon SageMaker Studio Lifecycle Configuration.

    + */ + StudioLifecycleConfigName?: string; + + /** + * @public + *

    The creation time of the Amazon SageMaker Studio Lifecycle Configuration.

    + */ + CreationTime?: Date; + + /** + * @public + *

    This value is equivalent to CreationTime because Amazon SageMaker Studio Lifecycle Configurations are immutable.

    + */ + LastModifiedTime?: Date; + + /** + * @public + *

    The App type to which the Lifecycle Configuration is attached.

    + */ + StudioLifecycleConfigAppType?: StudioLifecycleConfigAppType; +} + +/** + * @public + */ +export interface ListStudioLifecycleConfigsResponse { + /** + * @public + *

    If the previous response was truncated, you will receive this token. + * Use it in your next request to receive the next set of results.

    + */ + NextToken?: string; + + /** + * @public + *

    A list of Lifecycle Configurations and their properties.

    + */ + StudioLifecycleConfigs?: StudioLifecycleConfigDetails[]; +} + +/** + * @public + */ +export interface ListSubscribedWorkteamsRequest { + /** + * @public + *

    A string in the work team name. This filter returns only work teams whose name + * contains the specified string.

    + */ + NameContains?: string; + + /** + * @public + *

    If the result of the previous ListSubscribedWorkteams request was + * truncated, the response includes a NextToken. To retrieve the next set of + * labeling jobs, use the token in the next request.

    + */ + NextToken?: string; + + /** + * @public + *

    The maximum number of work teams to return in each page of the response.

    + */ + MaxResults?: number; +} + +/** + * @public + */ +export interface ListSubscribedWorkteamsResponse { + /** + * @public + *

    An array of Workteam objects, each describing a work team.

    + */ + SubscribedWorkteams: SubscribedWorkteam[] | undefined; + + /** + * @public + *

    If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of + * work teams, use it in the subsequent request.

    + */ + NextToken?: string; +} + +/** + * @public + */ +export interface ListTagsInput { + /** + * @public + *

    The Amazon Resource Name (ARN) of the resource whose tags you want to + * retrieve.

    + */ + ResourceArn: string | undefined; + + /** + * @public + *

    If the response to the previous ListTags request is truncated, SageMaker + * returns this token. To retrieve the next set of tags, use it in the subsequent request. + *

    + */ + NextToken?: string; + + /** + * @public + *

    Maximum number of tags to return.

    + */ + MaxResults?: number; +} + +/** + * @public + */ +export interface ListTagsOutput { + /** + * @public + *

    An array of Tag objects, each with a tag key and a value.

    + */ + Tags?: Tag[]; + + /** + * @public + *

    If response is truncated, SageMaker includes a token in the response. You can use this + * token in your subsequent request to fetch next set of tokens.

    + */ + NextToken?: string; +} + +/** + * @public + */ +export interface ListTrainingJobsRequest { + /** + * @public + *

    If the result of the previous ListTrainingJobs request was truncated, + * the response includes a NextToken. To retrieve the next set of training + * jobs, use the token in the next request.

    + */ + NextToken?: string; + + /** + * @public + *

    The maximum number of training jobs to return in the response.

    + */ + MaxResults?: number; + + /** + * @public + *

    A filter that returns only training jobs created after the specified time + * (timestamp).

    + */ + CreationTimeAfter?: Date; + + /** + * @public + *

    A filter that returns only training jobs created before the specified time + * (timestamp).

    + */ + CreationTimeBefore?: Date; + + /** + * @public + *

    A filter that returns only training jobs modified after the specified time + * (timestamp).

    + */ + LastModifiedTimeAfter?: Date; + + /** + * @public + *

    A filter that returns only training jobs modified before the specified time + * (timestamp).

    + */ + LastModifiedTimeBefore?: Date; + + /** + * @public + *

    A string in the training job name. This filter returns only training jobs whose + * name contains the specified string.

    + */ + NameContains?: string; + + /** + * @public + *

    A filter that retrieves only training jobs with a specific status.

    + */ + StatusEquals?: TrainingJobStatus; + + /** + * @public + *

    The field to sort results by. The default is CreationTime.

    + */ + SortBy?: SortBy; + + /** + * @public + *

    The sort order for results. The default is Ascending.

    + */ + SortOrder?: SortOrder; + + /** + * @public + *

    A filter that retrieves only training jobs with a specific warm pool status.

    + */ + WarmPoolStatusEquals?: WarmPoolResourceStatus; +} + +/** + * @public + *

    Provides summary information about a training job.

    + */ +export interface TrainingJobSummary { + /** + * @public + *

    The name of the training job that you want a summary for.

    + */ + TrainingJobName: string | undefined; + + /** + * @public + *

    The Amazon Resource Name (ARN) of the training job.

    + */ + TrainingJobArn: string | undefined; + + /** + * @public + *

    A timestamp that shows when the training job was created.

    + */ + CreationTime: Date | undefined; + + /** + * @public + *

    A timestamp that shows when the training job ended. This field is set only if the + * training job has one of the terminal statuses (Completed, + * Failed, or Stopped).

    + */ + TrainingEndTime?: Date; + + /** + * @public + *

    Timestamp when the training job was last modified.

    + */ + LastModifiedTime?: Date; + + /** + * @public + *

    The status of the training job.

    + */ + TrainingJobStatus: TrainingJobStatus | undefined; + + /** + * @public + *

    The status of the warm pool associated with the training job.

    + */ + WarmPoolStatus?: WarmPoolStatus; +} + +/** + * @public + */ +export interface ListTrainingJobsResponse { + /** + * @public + *

    An array of TrainingJobSummary objects, each listing a training + * job.

    + */ + TrainingJobSummaries: TrainingJobSummary[] | undefined; + + /** + * @public + *

    If the response is truncated, SageMaker returns this token. To retrieve the next set of + * training jobs, use it in the subsequent request.

    + */ + NextToken?: string; +} + +/** + * @public + * @enum + */ +export const TrainingJobSortByOptions = { + CreationTime: "CreationTime", + FinalObjectiveMetricValue: "FinalObjectiveMetricValue", + Name: "Name", + Status: "Status", +} as const; + +/** + * @public + */ +export type TrainingJobSortByOptions = (typeof TrainingJobSortByOptions)[keyof typeof TrainingJobSortByOptions]; + +/** + * @public + */ +export interface ListTrainingJobsForHyperParameterTuningJobRequest { + /** + * @public + *

    The name of the tuning job whose training jobs you want to list.

    + */ + HyperParameterTuningJobName: string | undefined; + + /** + * @public + *

    If the result of the previous ListTrainingJobsForHyperParameterTuningJob + * request was truncated, the response includes a NextToken. To retrieve the + * next set of training jobs, use the token in the next request.

    + */ + NextToken?: string; + + /** + * @public + *

    The maximum number of training jobs to return. The default value is 10.

    + */ + MaxResults?: number; + + /** + * @public + *

    A filter that returns only training jobs with the specified status.

    + */ + StatusEquals?: TrainingJobStatus; + + /** + * @public + *

    The field to sort results by. The default is Name.

    + *

    If the value of this field is FinalObjectiveMetricValue, any training + * jobs that did not return an objective metric are not listed.

    + */ + SortBy?: TrainingJobSortByOptions; + + /** + * @public + *

    The sort order for results. The default is Ascending.

    + */ + SortOrder?: SortOrder; +} + +/** + * @public + */ +export interface ListTrainingJobsForHyperParameterTuningJobResponse { + /** + * @public + *

    A list of TrainingJobSummary objects that + * describe + * the training jobs that the + * ListTrainingJobsForHyperParameterTuningJob request returned.

    + */ + TrainingJobSummaries: HyperParameterTrainingJobSummary[] | undefined; + + /** + * @public + *

    If the result of this ListTrainingJobsForHyperParameterTuningJob request + * was truncated, the response includes a NextToken. To retrieve the next set + * of training jobs, use the token in the next request.

    + */ + NextToken?: string; +} + +/** + * @public + */ +export interface ListTransformJobsRequest { + /** + * @public + *

    A filter that returns only transform jobs created after the specified time.

    + */ + CreationTimeAfter?: Date; + + /** + * @public + *

    A filter that returns only transform jobs created before the specified time.

    + */ + CreationTimeBefore?: Date; + + /** + * @public + *

    A filter that returns only transform jobs modified after the specified time.

    + */ + LastModifiedTimeAfter?: Date; + + /** + * @public + *

    A filter that returns only transform jobs modified before the specified time.

    + */ + LastModifiedTimeBefore?: Date; + + /** + * @public + *

    A string in the transform job name. This filter returns only transform jobs whose name + * contains the specified string.

    + */ + NameContains?: string; + + /** + * @public + *

    A filter that retrieves only transform jobs with a specific status.

    + */ + StatusEquals?: TransformJobStatus; + + /** + * @public + *

    The field to sort results by. The default is CreationTime.

    + */ + SortBy?: SortBy; + + /** + * @public + *

    The sort order for results. The default is Descending.

    + */ + SortOrder?: SortOrder; + + /** + * @public + *

    If the result of the previous ListTransformJobs request was truncated, + * the response includes a NextToken. To retrieve the next set of transform + * jobs, use the token in the next request.

    + */ + NextToken?: string; + + /** + * @public + *

    The maximum number of transform jobs to return in the response. The default value is 10.

    + */ + MaxResults?: number; +} + +/** + * @public + *

    Provides a + * summary + * of a transform job. Multiple TransformJobSummary objects are returned as a + * list after in response to a ListTransformJobs call.

    + */ +export interface TransformJobSummary { + /** + * @public + *

    The name of the transform job.

    + */ + TransformJobName: string | undefined; + + /** + * @public + *

    The Amazon Resource Name (ARN) of the transform job.

    + */ + TransformJobArn: string | undefined; + + /** + * @public + *

    A timestamp that shows when the transform Job was created.

    + */ + CreationTime: Date | undefined; + + /** + * @public + *

    Indicates when the transform + * job + * ends on compute instances. For successful jobs and stopped jobs, this + * is the exact time + * recorded + * after the results are uploaded. For failed jobs, this is when Amazon SageMaker + * detected that the job failed.

    + */ + TransformEndTime?: Date; + + /** + * @public + *

    Indicates when the transform job was last modified.

    + */ + LastModifiedTime?: Date; + + /** + * @public + *

    The status of the transform job.

    + */ + TransformJobStatus: TransformJobStatus | undefined; + + /** + * @public + *

    If the transform job failed, + * the + * reason it failed.

    + */ + FailureReason?: string; +} + +/** + * @public + */ +export interface ListTransformJobsResponse { + /** + * @public + *

    An array of + * TransformJobSummary + * objects.

    + */ + TransformJobSummaries: TransformJobSummary[] | undefined; + + /** + * @public + *

    If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of + * transform jobs, use it in the next request.

    + */ + NextToken?: string; +} + +/** + * @public + * @enum + */ +export const SortTrialComponentsBy = { + CREATION_TIME: "CreationTime", + NAME: "Name", +} as const; + +/** + * @public + */ +export type SortTrialComponentsBy = (typeof SortTrialComponentsBy)[keyof typeof SortTrialComponentsBy]; + +/** + * @public + */ +export interface ListTrialComponentsRequest { + /** + * @public + *

    A filter that returns only components that are part of the specified experiment. If you + * specify ExperimentName, you can't filter by SourceArn or + * TrialName.

    + */ + ExperimentName?: string; + + /** + * @public + *

    A filter that returns only components that are part of the specified trial. If you specify + * TrialName, you can't filter by ExperimentName or + * SourceArn.

    + */ + TrialName?: string; + + /** + * @public + *

    A filter that returns only components that have the specified source Amazon Resource Name (ARN). + * If you specify SourceArn, you can't filter by ExperimentName + * or TrialName.

    + */ + SourceArn?: string; + + /** + * @public + *

    A filter that returns only components created after the specified time.

    + */ + CreatedAfter?: Date; + + /** + * @public + *

    A filter that returns only components created before the specified time.

    + */ + CreatedBefore?: Date; + + /** + * @public + *

    The property used to sort results. The default value is CreationTime.

    + */ + SortBy?: SortTrialComponentsBy; + + /** + * @public + *

    The sort order. The default value is Descending.

    + */ + SortOrder?: SortOrder; + + /** + * @public + *

    The maximum number of components to return in the response. The default value is + * 10.

    + */ + MaxResults?: number; + + /** + * @public + *

    If the previous call to ListTrialComponents didn't return the full set of + * components, the call returns a token for getting the next set of components.

    + */ + NextToken?: string; +} + +/** + * @public + *

    A summary of the properties of a trial component. To get all the properties, call the + * DescribeTrialComponent API and provide the + * TrialComponentName.

    + */ +export interface TrialComponentSummary { + /** + * @public + *

    The name of the trial component.

    + */ + TrialComponentName?: string; + + /** + * @public + *

    The Amazon Resource Name (ARN) of the trial component.

    + */ + TrialComponentArn?: string; + + /** + * @public + *

    The name of the component as displayed. If DisplayName isn't specified, + * TrialComponentName is displayed.

    + */ + DisplayName?: string; + + /** + * @public + *

    The Amazon Resource Name (ARN) and job type of the source of a trial component.

    + */ + TrialComponentSource?: TrialComponentSource; + + /** + * @public + *

    The status of the component. States include:

    + *
      + *
    • + *

      InProgress

      + *
      • + *
    • + *

      Completed

      + *
      • + *
    • + *

      Failed

      + *
      • + *
    + */ + Status?: TrialComponentStatus; + + /** + * @public + *

    When the component started.

    + */ + StartTime?: Date; + + /** + * @public + *

    When the component ended.

    + */ + EndTime?: Date; + + /** + * @public + *

    When the component was created.

    + */ + CreationTime?: Date; + + /** + * @public + *

    Who created the trial component.

    + */ + CreatedBy?: UserContext; + + /** + * @public + *

    When the component was last modified.

    + */ + LastModifiedTime?: Date; + + /** + * @public + *

    Who last modified the component.

    + */ + LastModifiedBy?: UserContext; +} + +/** + * @public + */ +export interface ListTrialComponentsResponse { + /** + * @public + *

    A list of the summaries of your trial components.

    + */ + TrialComponentSummaries?: TrialComponentSummary[]; + + /** + * @public + *

    A token for getting the next set of components, if there are any.

    + */ + NextToken?: string; +} + +/** + * @public + * @enum + */ +export const SortTrialsBy = { + CREATION_TIME: "CreationTime", + NAME: "Name", +} as const; + +/** + * @public + */ +export type SortTrialsBy = (typeof SortTrialsBy)[keyof typeof SortTrialsBy]; + +/** + * @public + */ +export interface ListTrialsRequest { + /** + * @public + *

    A filter that returns only trials that are part of the specified experiment.

    + */ + ExperimentName?: string; + + /** + * @public + *

    A filter that returns only trials that are associated with the specified trial + * component.

    + */ + TrialComponentName?: string; + + /** + * @public + *

    A filter that returns only trials created after the specified time.

    + */ + CreatedAfter?: Date; + + /** + * @public + *

    A filter that returns only trials created before the specified time.

    + */ + CreatedBefore?: Date; + + /** + * @public + *

    The property used to sort results. The default value is CreationTime.

    + */ + SortBy?: SortTrialsBy; + + /** + * @public + *

    The sort order. The default value is Descending.

    + */ + SortOrder?: SortOrder; + + /** + * @public + *

    The maximum number of trials to return in the response. The default value is 10.

    + */ + MaxResults?: number; + + /** + * @public + *

    If the previous call to ListTrials didn't return the full set of trials, the + * call returns a token for getting the next set of trials.

    + */ + NextToken?: string; +} + +/** + * @public + *

    A summary of the properties of a trial. To get the complete set of properties, call the + * DescribeTrial API and provide the TrialName.

    + */ +export interface TrialSummary { + /** + * @public + *

    The Amazon Resource Name (ARN) of the trial.

    + */ + TrialArn?: string; + + /** + * @public + *

    The name of the trial.

    + */ + TrialName?: string; + + /** + * @public + *

    The name of the trial as displayed. If DisplayName isn't specified, + * TrialName is displayed.

    + */ + DisplayName?: string; + + /** + * @public + *

    The source of the trial.

    + */ + TrialSource?: TrialSource; + + /** + * @public + *

    When the trial was created.

    + */ + CreationTime?: Date; + + /** + * @public + *

    When the trial was last modified.

    + */ + LastModifiedTime?: Date; +} + +/** + * @public + */ +export interface ListTrialsResponse { + /** + * @public + *

    A list of the summaries of your trials.

    + */ + TrialSummaries?: TrialSummary[]; + + /** + * @public + *

    A token for getting the next set of trials, if there are any.

    + */ + NextToken?: string; +} + +/** + * @public + * @enum + */ +export const UserProfileSortKey = { + CreationTime: "CreationTime", + LastModifiedTime: "LastModifiedTime", +} as const; + +/** + * @public + */ +export type UserProfileSortKey = (typeof UserProfileSortKey)[keyof typeof UserProfileSortKey]; + +/** + * @public + */ +export interface ListUserProfilesRequest { + /** + * @public + *

    If the previous response was truncated, you will receive this token. + * Use it in your next request to receive the next set of results.

    + */ + NextToken?: string; + + /** + * @public + *

    The total number of items to return in the response. If the total + * number of items available is more than the value specified, a NextToken + * is provided in the response. To resume pagination, provide the NextToken + * value in the as part of a subsequent call. The default value is 10.

    + */ + MaxResults?: number; + + /** + * @public + *

    The sort order for the results. The default is Ascending.

    + */ + SortOrder?: SortOrder; + + /** + * @public + *

    The parameter by which to sort the results. The default is CreationTime.

    + */ + SortBy?: UserProfileSortKey; + + /** + * @public + *

    A parameter by which to filter the results.

    + */ + DomainIdEquals?: string; + + /** + * @public + *

    A parameter by which to filter the results.

    + */ + UserProfileNameContains?: string; +} + +/** + * @public + *

    The user profile details.

    + */ +export interface UserProfileDetails { + /** + * @public + *

    The domain ID.

    + */ + DomainId?: string; + + /** + * @public + *

    The user profile name.

    + */ + UserProfileName?: string; + + /** + * @public + *

    The status.

    + */ + Status?: UserProfileStatus; + + /** + * @public + *

    The creation time.

    + */ + CreationTime?: Date; + + /** + * @public + *

    The last modified time.

    + */ + LastModifiedTime?: Date; +} + +/** + * @public + */ +export interface ListUserProfilesResponse { + /** + * @public + *

    The list of user profiles.

    + */ + UserProfiles?: UserProfileDetails[]; + + /** + * @public + *

    If the previous response was truncated, you will receive this token. + * Use it in your next request to receive the next set of results.

    + */ + NextToken?: string; +} + +/** + * @public + * @enum + */ +export const ListWorkforcesSortByOptions = { + CreateDate: "CreateDate", + Name: "Name", +} as const; + +/** + * @public + */ +export type ListWorkforcesSortByOptions = + (typeof ListWorkforcesSortByOptions)[keyof typeof ListWorkforcesSortByOptions]; + +/** + * @public + */ +export interface ListWorkforcesRequest { + /** + * @public + *

    Sort workforces using the workforce name or creation date.

    + */ + SortBy?: ListWorkforcesSortByOptions; + + /** + * @public + *

    Sort workforces in ascending or descending order.

    + */ + SortOrder?: SortOrder; + + /** + * @public + *

    A filter you can use to search for workforces using part of the workforce name.

    + */ + NameContains?: string; + + /** + * @public + *

    A token to resume pagination.

    + */ + NextToken?: string; + + /** + * @public + *

    The maximum number of workforces returned in the response.

    + */ + MaxResults?: number; +} + +/** + * @public + */ +export interface ListWorkforcesResponse { + /** + * @public + *

    A list containing information about your workforce.

    + */ + Workforces: Workforce[] | undefined; + + /** + * @public + *

    A token to resume pagination.

    + */ + NextToken?: string; +} + +/** + * @public + * @enum + */ +export const ListWorkteamsSortByOptions = { + CreateDate: "CreateDate", + Name: "Name", +} as const; + +/** + * @public + */ +export type ListWorkteamsSortByOptions = (typeof ListWorkteamsSortByOptions)[keyof typeof ListWorkteamsSortByOptions]; + +/** + * @public + */ +export interface ListWorkteamsRequest { + /** + * @public + *

    The field to sort results by. The default is CreationTime.

    + */ + SortBy?: ListWorkteamsSortByOptions; + + /** + * @public + *

    The sort order for results. The default is Ascending.

    + */ + SortOrder?: SortOrder; + + /** + * @public + *

    A string in the work team's name. This filter returns only work teams whose name + * contains the specified string.

    + */ + NameContains?: string; + + /** + * @public + *

    If the result of the previous ListWorkteams request was truncated, the + * response includes a NextToken. To retrieve the next set of labeling jobs, + * use the token in the next request.

    + */ + NextToken?: string; + + /** + * @public + *

    The maximum number of work teams to return in each page of the response.

    + */ + MaxResults?: number; +} + +/** + * @public + */ +export interface ListWorkteamsResponse { + /** + * @public + *

    An array of Workteam objects, each describing a work team.

    + */ + Workteams: Workteam[] | undefined; + + /** + * @public + *

    If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of + * work teams, use it in the subsequent request.

    + */ + NextToken?: string; +} + +/** + * @public + *

    The properties of a model as returned by the Search API.

    + */ +export interface Model { + /** + * @public + *

    The name of the model.

    + */ + ModelName?: string; + + /** + * @public + *

    Describes the container, as part of model definition.

    + */ + PrimaryContainer?: ContainerDefinition; + + /** + * @public + *

    The containers in the inference pipeline.

    + */ + Containers?: ContainerDefinition[]; + + /** + * @public + *

    Specifies details about how containers in a multi-container endpoint are run.

    + */ + InferenceExecutionConfig?: InferenceExecutionConfig; + + /** + * @public + *

    The Amazon Resource Name (ARN) of the IAM role that you specified for the + * model.

    + */ + ExecutionRoleArn?: string; + + /** + * @public + *

    Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources + * have access to. You can control access to and from your resources by configuring a VPC. + * For more information, see Give SageMaker Access to Resources in your Amazon VPC.

    + */ + VpcConfig?: VpcConfig; + + /** + * @public + *

    A timestamp that indicates when the model was created.

    + */ + CreationTime?: Date; + + /** + * @public + *

    The Amazon Resource Name (ARN) of the model.

    + */ + ModelArn?: string; + + /** + * @public + *

    Isolates the model container. No inbound or outbound network calls can be made to or + * from the model container.

    + */ + EnableNetworkIsolation?: boolean; + + /** + * @public + *

    A list of key-value pairs associated with the model. For more information, see + * Tagging Amazon Web Services + * resources in the Amazon Web Services General Reference Guide.

    + */ + Tags?: Tag[]; + + /** + * @public + *

    A set of recommended deployment configurations for the model.

    + */ + DeploymentRecommendation?: DeploymentRecommendation; +} + /** * @public *

    An Amazon SageMaker Model Card.

    @@ -3267,6 +4821,34 @@ export interface UpdateArtifactResponse { ArtifactArn?: string; } +/** + * @public + */ +export interface UpdateClusterRequest { + /** + * @public + *

    Specify the name of the SageMaker HyperPod cluster you want to update.

    + */ + ClusterName: string | undefined; + + /** + * @public + *

    Specify the instance groups to update.

    + */ + InstanceGroups: ClusterInstanceGroupSpecification[] | undefined; +} + +/** + * @public + */ +export interface UpdateClusterResponse { + /** + * @public + *

    The Amazon Resource Name (ARN) of the updated SageMaker HyperPod cluster.

    + */ + ClusterArn: string | undefined; +} + /** * @public */ @@ -3436,6 +5018,36 @@ export interface UpdateDomainRequest { * Service.

    */ AppSecurityGroupManagement?: AppSecurityGroupManagement; + + /** + * @public + *

    The VPC subnets that Studio uses for communication.

    + *

    If removing subnets, ensure there are no apps in the InService, + * Pending, or Deleting state.

    + */ + SubnetIds?: string[]; + + /** + * @public + *

    Specifies the VPC used for non-EFS traffic.

    + *
      + *
    • + *

      + * PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, + * which allows direct internet access.

      + *
      • + *
    • + *

      + * VpcOnly - All Studio traffic is through the specified VPC and subnets.

      + *
      • + *
    + *

    This configuration can only be modified if there are no apps in the InService, + * Pending, or Deleting state. The configuration cannot be updated if + * DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is already set + * or DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided + * as part of the same request.

    + */ + AppNetworkAccessType?: AppNetworkAccessType; } /** @@ -3916,6 +5528,69 @@ export interface UpdateImageVersionResponse { ImageVersionArn?: string; } +/** + * @public + */ +export interface UpdateInferenceComponentInput { + /** + * @public + *

    The name of the inference component.

    + */ + InferenceComponentName: string | undefined; + + /** + * @public + *

    Details about the resources to deploy with this inference component, including the + * model, container, and compute resources.

    + */ + Specification?: InferenceComponentSpecification; + + /** + * @public + *

    Runtime settings for a model that is deployed with an inference component.

    + */ + RuntimeConfig?: InferenceComponentRuntimeConfig; +} + +/** + * @public + */ +export interface UpdateInferenceComponentOutput { + /** + * @public + *

    The Amazon Resource Name (ARN) of the inference component.

    + */ + InferenceComponentArn: string | undefined; +} + +/** + * @public + */ +export interface UpdateInferenceComponentRuntimeConfigInput { + /** + * @public + *

    The name of the inference component to update.

    + */ + InferenceComponentName: string | undefined; + + /** + * @public + *

    Runtime settings for a model that is deployed with an inference component.

    + */ + DesiredRuntimeConfig: InferenceComponentRuntimeConfig | undefined; +} + +/** + * @public + */ +export interface UpdateInferenceComponentRuntimeConfigOutput { + /** + * @public + *

    The Amazon Resource Name (ARN) of the inference component.

    + */ + InferenceComponentArn: string | undefined; +} + /** * @public */ diff --git a/clients/client-sagemaker/src/pagination/ListInferenceComponentsPaginator.ts b/clients/client-sagemaker/src/pagination/ListInferenceComponentsPaginator.ts new file mode 100644 index 000000000000..2c42ddac42e6 --- /dev/null +++ b/clients/client-sagemaker/src/pagination/ListInferenceComponentsPaginator.ts @@ -0,0 +1,50 @@ +// smithy-typescript generated code +import { Paginator } from "@smithy/types"; + +import { + ListInferenceComponentsCommand, + ListInferenceComponentsCommandInput, + ListInferenceComponentsCommandOutput, +} from "../commands/ListInferenceComponentsCommand"; +import { SageMakerClient } from "../SageMakerClient"; +import { SageMakerPaginationConfiguration } from "./Interfaces"; + +/** + * @internal + */ +const makePagedClientRequest = async ( + client: SageMakerClient, + input: ListInferenceComponentsCommandInput, + ...args: any +): Promise => { + // @ts-ignore + return await client.send(new ListInferenceComponentsCommand(input), ...args); +}; +/** + * @public + */ +export async function* paginateListInferenceComponents( + config: SageMakerPaginationConfiguration, + input: ListInferenceComponentsCommandInput, + ...additionalArguments: any +): Paginator { + // ToDo: replace with actual type instead of typeof input.NextToken + let token: typeof input.NextToken | undefined = config.startingToken || undefined; + let hasNext = true; + let page: ListInferenceComponentsCommandOutput; + while (hasNext) { + input.NextToken = token; + input["MaxResults"] = config.pageSize; + if (config.client instanceof SageMakerClient) { + page = await makePagedClientRequest(config.client, input, ...additionalArguments); + } else { + throw new Error("Invalid client, expected SageMaker | SageMakerClient"); + } + yield page; + const prevToken = token; + token = page.NextToken; + hasNext = !!(token && (!config.stopOnSameToken || token !== prevToken)); + } + // @ts-ignore + return undefined; +} diff --git a/clients/client-sagemaker/src/pagination/index.ts b/clients/client-sagemaker/src/pagination/index.ts index 2a7864bae972..8fcb5d13817d 100644 --- a/clients/client-sagemaker/src/pagination/index.ts +++ b/clients/client-sagemaker/src/pagination/index.ts @@ -26,6 +26,7 @@ export * from "./ListHumanTaskUisPaginator"; export * from "./ListHyperParameterTuningJobsPaginator"; export * from "./ListImageVersionsPaginator"; export * from "./ListImagesPaginator"; +export * from "./ListInferenceComponentsPaginator"; export * from "./ListInferenceExperimentsPaginator"; export * from "./ListInferenceRecommendationsJobStepsPaginator"; export * from "./ListInferenceRecommendationsJobsPaginator"; diff --git a/clients/client-sagemaker/src/protocols/Aws_json1_1.ts b/clients/client-sagemaker/src/protocols/Aws_json1_1.ts index 2e9cb4250bf8..f4760c07f4e2 100644 --- a/clients/client-sagemaker/src/protocols/Aws_json1_1.ts +++ b/clients/client-sagemaker/src/protocols/Aws_json1_1.ts @@ -47,6 +47,7 @@ import { import { CreateArtifactCommandInput, CreateArtifactCommandOutput } from "../commands/CreateArtifactCommand"; import { CreateAutoMLJobCommandInput, CreateAutoMLJobCommandOutput } from "../commands/CreateAutoMLJobCommand"; import { CreateAutoMLJobV2CommandInput, CreateAutoMLJobV2CommandOutput } from "../commands/CreateAutoMLJobV2Command"; +import { CreateClusterCommandInput, CreateClusterCommandOutput } from "../commands/CreateClusterCommand"; import { CreateCodeRepositoryCommandInput, CreateCodeRepositoryCommandOutput, @@ -93,6 +94,10 @@ import { } from "../commands/CreateHyperParameterTuningJobCommand"; import { CreateImageCommandInput, CreateImageCommandOutput } from "../commands/CreateImageCommand"; import { CreateImageVersionCommandInput, CreateImageVersionCommandOutput } from "../commands/CreateImageVersionCommand"; +import { + CreateInferenceComponentCommandInput, + CreateInferenceComponentCommandOutput, +} from "../commands/CreateInferenceComponentCommand"; import { CreateInferenceExperimentCommandInput, CreateInferenceExperimentCommandOutput, @@ -175,6 +180,7 @@ import { } from "../commands/DeleteAppImageConfigCommand"; import { DeleteArtifactCommandInput, DeleteArtifactCommandOutput } from "../commands/DeleteArtifactCommand"; import { DeleteAssociationCommandInput, DeleteAssociationCommandOutput } from "../commands/DeleteAssociationCommand"; +import { DeleteClusterCommandInput, DeleteClusterCommandOutput } from "../commands/DeleteClusterCommand"; import { DeleteCodeRepositoryCommandInput, DeleteCodeRepositoryCommandOutput, @@ -210,6 +216,10 @@ import { DeleteHubContentCommandInput, DeleteHubContentCommandOutput } from "../ import { DeleteHumanTaskUiCommandInput, DeleteHumanTaskUiCommandOutput } from "../commands/DeleteHumanTaskUiCommand"; import { DeleteImageCommandInput, DeleteImageCommandOutput } from "../commands/DeleteImageCommand"; import { DeleteImageVersionCommandInput, DeleteImageVersionCommandOutput } from "../commands/DeleteImageVersionCommand"; +import { + DeleteInferenceComponentCommandInput, + DeleteInferenceComponentCommandOutput, +} from "../commands/DeleteInferenceComponentCommand"; import { DeleteInferenceExperimentCommandInput, DeleteInferenceExperimentCommandOutput, @@ -279,6 +289,11 @@ import { DescribeAutoMLJobV2CommandInput, DescribeAutoMLJobV2CommandOutput, } from "../commands/DescribeAutoMLJobV2Command"; +import { DescribeClusterCommandInput, DescribeClusterCommandOutput } from "../commands/DescribeClusterCommand"; +import { + DescribeClusterNodeCommandInput, + DescribeClusterNodeCommandOutput, +} from "../commands/DescribeClusterNodeCommand"; import { DescribeCodeRepositoryCommandInput, DescribeCodeRepositoryCommandOutput, @@ -339,6 +354,10 @@ import { DescribeImageVersionCommandInput, DescribeImageVersionCommandOutput, } from "../commands/DescribeImageVersionCommand"; +import { + DescribeInferenceComponentCommandInput, + DescribeInferenceComponentCommandOutput, +} from "../commands/DescribeInferenceComponentCommand"; import { DescribeInferenceExperimentCommandInput, DescribeInferenceExperimentCommandOutput, @@ -487,6 +506,8 @@ import { ListCandidatesForAutoMLJobCommandInput, ListCandidatesForAutoMLJobCommandOutput, } from "../commands/ListCandidatesForAutoMLJobCommand"; +import { ListClusterNodesCommandInput, ListClusterNodesCommandOutput } from "../commands/ListClusterNodesCommand"; +import { ListClustersCommandInput, ListClustersCommandOutput } from "../commands/ListClustersCommand"; import { ListCodeRepositoriesCommandInput, ListCodeRepositoriesCommandOutput, @@ -535,6 +556,10 @@ import { } from "../commands/ListHyperParameterTuningJobsCommand"; import { ListImagesCommandInput, ListImagesCommandOutput } from "../commands/ListImagesCommand"; import { ListImageVersionsCommandInput, ListImageVersionsCommandOutput } from "../commands/ListImageVersionsCommand"; +import { + ListInferenceComponentsCommandInput, + ListInferenceComponentsCommandOutput, +} from "../commands/ListInferenceComponentsCommand"; import { ListInferenceExperimentsCommandInput, ListInferenceExperimentsCommandOutput, @@ -733,6 +758,7 @@ import { UpdateAppImageConfigCommandOutput, } from "../commands/UpdateAppImageConfigCommand"; import { UpdateArtifactCommandInput, UpdateArtifactCommandOutput } from "../commands/UpdateArtifactCommand"; +import { UpdateClusterCommandInput, UpdateClusterCommandOutput } from "../commands/UpdateClusterCommand"; import { UpdateCodeRepositoryCommandInput, UpdateCodeRepositoryCommandOutput, @@ -755,6 +781,14 @@ import { import { UpdateHubCommandInput, UpdateHubCommandOutput } from "../commands/UpdateHubCommand"; import { UpdateImageCommandInput, UpdateImageCommandOutput } from "../commands/UpdateImageCommand"; import { UpdateImageVersionCommandInput, UpdateImageVersionCommandOutput } from "../commands/UpdateImageVersionCommand"; +import { + UpdateInferenceComponentCommandInput, + UpdateInferenceComponentCommandOutput, +} from "../commands/UpdateInferenceComponentCommand"; +import { + UpdateInferenceComponentRuntimeConfigCommandInput, + UpdateInferenceComponentRuntimeConfigCommandOutput, +} from "../commands/UpdateInferenceComponentRuntimeConfigCommand"; import { UpdateInferenceExperimentCommandInput, UpdateInferenceExperimentCommandOutput, @@ -885,6 +919,13 @@ import { ClarifyShapBaselineConfig, ClarifyShapConfig, ClarifyTextConfig, + ClusterInstanceGroupDetails, + ClusterInstanceGroupSpecification, + ClusterInstanceStatusDetails, + ClusterLifeCycleConfig, + ClusterNodeDetails, + ClusterNodeSummary, + ClusterSummary, CodeRepository, CodeRepositorySummary, CognitoConfig, @@ -916,18 +957,16 @@ import { CreateAutoMLJobResponse, CreateAutoMLJobV2Request, CreateAutoMLJobV2Response, + CreateClusterRequest, + CreateClusterResponse, CreateCodeRepositoryInput, CreateCodeRepositoryOutput, CreateCompilationJobRequest, CreateCompilationJobResponse, CreateContextRequest, CreateContextResponse, - DataQualityAppSpecification, - DataQualityBaselineConfig, - DataQualityJobInput, DataSource, DirectDeploySettings, - EndpointInput, FileSystemConfig, FileSystemDataSource, FillingType, @@ -957,17 +996,10 @@ import { ModelInput, ModelPackageContainerDefinition, ModelRegisterSettings, - MonitoringClusterConfig, - MonitoringConstraintsResource, MonitoringCsvDatasetFormat, MonitoringDatasetFormat, MonitoringJsonDatasetFormat, - MonitoringOutput, - MonitoringOutputConfig, MonitoringParquetDatasetFormat, - MonitoringResources, - MonitoringS3Output, - MonitoringStatisticsResource, MultiModelConfig, NeoVpcConfig, OutputConfig, @@ -1045,6 +1077,8 @@ import { CreateImageResponse, CreateImageVersionRequest, CreateImageVersionResponse, + CreateInferenceComponentInput, + CreateInferenceComponentOutput, CreateInferenceExperimentRequest, CreateInferenceExperimentResponse, CreateInferenceRecommendationsJobRequest, @@ -1096,31 +1130,17 @@ import { CreateTrialRequest, CreateTrialResponse, CreateUserProfileRequest, - CreateUserProfileResponse, - CreateWorkforceRequest, - CreateWorkforceResponse, - CreateWorkteamRequest, - CreateWorkteamResponse, CustomImage, - CustomizedMetricSpecification, DataCaptureConfig, - DataCaptureConfigSummary, DataCatalogConfig, DataProcessing, + DataQualityAppSpecification, + DataQualityBaselineConfig, + DataQualityJobInput, DatasetDefinition, DebugHookConfig, DebugRuleConfiguration, - DebugRuleEvaluationStatus, DefaultSpaceSettings, - DeleteActionRequest, - DeleteActionResponse, - DeleteAlgorithmInput, - DeleteAppImageConfigRequest, - DeleteAppRequest, - DeleteArtifactRequest, - DeleteArtifactResponse, - DeleteAssociationRequest, - DeleteAssociationResponse, DeploymentConfig, DeploymentStage, DeviceSelectionConfig, @@ -1134,6 +1154,7 @@ import { EdgeDeploymentModelConfig, EdgeOutputConfig, EndpointInfo, + EndpointInput, EndpointInputConfiguration, EnvironmentParameterRanges, ExperimentConfig, @@ -1156,9 +1177,15 @@ import { HyperParameterTuningJobStrategyConfig, HyperParameterTuningJobWarmStartConfig, HyperParameterTuningResourceConfig, + InferenceComponentComputeResourceRequirements, + InferenceComponentContainerSpecification, + InferenceComponentRuntimeConfig, + InferenceComponentSpecification, + InferenceComponentStartupParameters, InferenceExecutionConfig, InferenceExperimentDataStorageConfig, InferenceExperimentSchedule, + InfraCheckConfig, InstanceMetadataServiceConfiguration, IntegerParameterRange, JupyterServerAppSettings, @@ -1172,7 +1199,6 @@ import { LabelingJobS3DataSource, LabelingJobSnsDataSource, LabelingJobStoppingConditions, - MemberDefinition, ModelBiasAppSpecification, ModelBiasBaselineConfig, ModelBiasJobInput, @@ -1195,19 +1221,23 @@ import { ModelVariantConfig, MonitoringAppSpecification, MonitoringBaselineConfig, + MonitoringClusterConfig, + MonitoringConstraintsResource, MonitoringGroundTruthS3Input, MonitoringInput, MonitoringJobDefinition, MonitoringNetworkConfig, + MonitoringOutput, + MonitoringOutputConfig, + MonitoringResources, + MonitoringS3Output, MonitoringScheduleConfig, + MonitoringStatisticsResource, MonitoringStoppingCondition, NetworkConfig, NotebookInstanceAcceleratorType, NotebookInstanceLifecycleHook, - NotificationConfiguration, OfflineStoreConfig, - OidcConfig, - OidcMemberDefinition, OnlineStoreConfig, OnlineStoreSecurityConfig, ParallelismConfiguration, @@ -1226,6 +1256,8 @@ import { ProcessingStoppingCondition, ProductionVariant, ProductionVariantCoreDumpConfig, + ProductionVariantManagedInstanceScaling, + ProductionVariantRoutingConfig, ProductionVariantServerlessConfig, ProfilerConfig, ProfilerRuleConfiguration, @@ -1255,7 +1287,6 @@ import { SharingSettings, SourceAlgorithm, SourceAlgorithmSpecification, - SourceIpConfig, SpaceSettings, Stairs, TensorBoardAppSettings, @@ -1270,9 +1301,27 @@ import { UiTemplate, USD, UserSettings, - WorkforceVpcConfigRequest, } from "../models/models_1"; import { + CreateUserProfileResponse, + CreateWorkforceRequest, + CreateWorkforceResponse, + CreateWorkteamRequest, + CreateWorkteamResponse, + CustomizedMetricSpecification, + DataCaptureConfigSummary, + DebugRuleEvaluationStatus, + DeleteActionRequest, + DeleteActionResponse, + DeleteAlgorithmInput, + DeleteAppImageConfigRequest, + DeleteAppRequest, + DeleteArtifactRequest, + DeleteArtifactResponse, + DeleteAssociationRequest, + DeleteAssociationResponse, + DeleteClusterRequest, + DeleteClusterResponse, DeleteCodeRepositoryInput, DeleteContextRequest, DeleteContextResponse, @@ -1296,6 +1345,7 @@ import { DeleteImageResponse, DeleteImageVersionRequest, DeleteImageVersionResponse, + DeleteInferenceComponentInput, DeleteInferenceExperimentRequest, DeleteInferenceExperimentResponse, DeleteModelBiasJobDefinitionRequest, @@ -1344,6 +1394,10 @@ import { DescribeAutoMLJobResponse, DescribeAutoMLJobV2Request, DescribeAutoMLJobV2Response, + DescribeClusterNodeRequest, + DescribeClusterNodeResponse, + DescribeClusterRequest, + DescribeClusterResponse, DescribeCodeRepositoryInput, DescribeCodeRepositoryOutput, DescribeCompilationJobRequest, @@ -1386,6 +1440,8 @@ import { DescribeImageResponse, DescribeImageVersionRequest, DescribeImageVersionResponse, + DescribeInferenceComponentInput, + DescribeInferenceComponentOutput, DescribeInferenceExperimentRequest, DescribeInferenceExperimentResponse, DescribeInferenceRecommendationsJobRequest, @@ -1441,35 +1497,9 @@ import { DescribeTrialRequest, DescribeTrialResponse, DescribeUserProfileRequest, - DescribeUserProfileResponse, - DescribeWorkforceRequest, - DescribeWorkforceResponse, - DescribeWorkteamRequest, - DescribeWorkteamResponse, - DesiredWeightAndCapacity, - Device, - DeviceDeploymentSummary, - DeviceFleetSummary, - DeviceStats, - DeviceSummary, - DisableSagemakerServicecatalogPortfolioInput, - DisableSagemakerServicecatalogPortfolioOutput, - DisassociateTrialComponentRequest, - DisassociateTrialComponentResponse, - DomainDetails, - DomainSettingsForUpdate, - DynamicScalingConfiguration, - Edge, - EdgeDeploymentPlanSummary, EdgeDeploymentStatus, EdgeModel, - EdgeModelStat, - EdgeModelSummary, - EdgePackagingJobSummary, EdgePresetDeploymentOutput, - EMRStepMetadata, - EnableSagemakerServicecatalogPortfolioInput, - EnableSagemakerServicecatalogPortfolioOutput, EndpointMetadata, EndpointOutputConfiguration, EndpointPerformance, @@ -1481,13 +1511,16 @@ import { HyperParameterTrainingJobSummary, HyperParameterTuningJobCompletionDetails, HyperParameterTuningJobConsumedResources, + InferenceComponentContainerSpecificationSummary, + InferenceComponentRuntimeConfigSummary, + InferenceComponentSpecificationSummary, InferenceMetrics, InferenceRecommendation, LabelCounters, LabelingJobOutput, LastUpdateStatus, + MemberDefinition, MetricData, - MetricSpecification, ModelArtifacts, ModelCardExportArtifacts, ModelConfiguration, @@ -1497,14 +1530,14 @@ import { ModelPackageStatusItem, ModelVariantConfigSummary, MonitoringExecutionSummary, + NotificationConfiguration, ObjectiveStatusCounters, OfflineStoreStatus, - OidcConfigForResponse, + OidcConfig, + OidcMemberDefinition, PendingDeploymentSummary, PendingProductionVariantSummary, PipelineExperimentConfig, - PredefinedMetricSpecification, - ProductionVariantServerlessUpdateConfig, ProductionVariantStatus, ProductionVariantSummary, ProfilerRuleEvaluationStatus, @@ -1512,25 +1545,47 @@ import { RecommendationMetrics, ResolvedAttributes, RetentionPolicy, - RStudioServerProDomainSettingsForUpdate, - ScalingPolicy, SecondaryStatusTransition, SelectedStep, SelectiveExecutionConfig, ServiceCatalogProvisionedProductDetails, + SourceIpConfig, SubscribedWorkteam, - TargetTrackingScalingPolicyConfiguration, TrainingJobStatusCounters, TrialComponentMetricSummary, TrialComponentSource, TrialSource, UiTemplateInfo, WarmPoolStatus, - Workforce, - WorkforceVpcConfigResponse, - Workteam, + WorkforceVpcConfigRequest, } from "../models/models_2"; import { + DescribeUserProfileResponse, + DescribeWorkforceRequest, + DescribeWorkforceResponse, + DescribeWorkteamRequest, + DescribeWorkteamResponse, + DesiredWeightAndCapacity, + Device, + DeviceDeploymentSummary, + DeviceFleetSummary, + DeviceStats, + DeviceSummary, + DisableSagemakerServicecatalogPortfolioInput, + DisableSagemakerServicecatalogPortfolioOutput, + DisassociateTrialComponentRequest, + DisassociateTrialComponentResponse, + DomainDetails, + DomainSettingsForUpdate, + DynamicScalingConfiguration, + Edge, + EdgeDeploymentPlanSummary, + EdgeModelStat, + EdgeModelSummary, + EdgePackagingJobSummary, + EMRStepMetadata, + EnableSagemakerServicecatalogPortfolioInput, + EnableSagemakerServicecatalogPortfolioOutput, Endpoint, EndpointConfigSummary, EndpointSummary, @@ -1564,6 +1619,7 @@ import { ImageVersion, ImportHubContentRequest, ImportHubContentResponse, + InferenceComponentSummary, InferenceExperimentSummary, InferenceRecommendationsJob, InferenceRecommendationsJobStep, @@ -1591,6 +1647,10 @@ import { ListAutoMLJobsResponse, ListCandidatesForAutoMLJobRequest, ListCandidatesForAutoMLJobResponse, + ListClusterNodesRequest, + ListClusterNodesResponse, + ListClustersRequest, + ListClustersResponse, ListCodeRepositoriesInput, ListCodeRepositoriesOutput, ListCompilationJobsRequest, @@ -1633,6 +1693,8 @@ import { ListImagesResponse, ListImageVersionsRequest, ListImageVersionsResponse, + ListInferenceComponentsInput, + ListInferenceComponentsOutput, ListInferenceExperimentsRequest, ListInferenceExperimentsResponse, ListInferenceRecommendationsJobsRequest, @@ -1689,35 +1751,7 @@ import { ListProcessingJobsResponse, ListProjectsInput, ListProjectsOutput, - ListResourceCatalogsRequest, - ListResourceCatalogsResponse, - ListSpacesRequest, - ListSpacesResponse, - ListStageDevicesRequest, - ListStageDevicesResponse, - ListStudioLifecycleConfigsRequest, - ListStudioLifecycleConfigsResponse, - ListSubscribedWorkteamsRequest, - ListSubscribedWorkteamsResponse, - ListTagsInput, - ListTagsOutput, - ListTrainingJobsForHyperParameterTuningJobRequest, - ListTrainingJobsForHyperParameterTuningJobResponse, - ListTrainingJobsRequest, - ListTrainingJobsResponse, - ListTransformJobsRequest, - ListTransformJobsResponse, - ListTrialComponentsRequest, - ListTrialComponentsResponse, - ListTrialsRequest, - ListTrialsResponse, - ListUserProfilesRequest, - ListUserProfilesResponse, - ListWorkforcesRequest, - ListWorkforcesResponse, - ListWorkteamsRequest, - ListWorkteamsResponse, - Model, + MetricSpecification, ModelCardExportJobSummary, ModelCardSummary, ModelCardVersionSummary, @@ -1737,36 +1771,66 @@ import { MonitoringScheduleSummary, NotebookInstanceLifecycleConfigSummary, NotebookInstanceSummary, + OidcConfigForResponse, Parameter, PipelineExecutionStep, PipelineExecutionStepMetadata, PipelineExecutionSummary, PipelineSummary, + PredefinedMetricSpecification, ProcessingJobStepMetadata, ProcessingJobSummary, + ProductionVariantServerlessUpdateConfig, ProjectSummary, PropertyNameQuery, PropertyNameSuggestion, QualityCheckStepMetadata, RecommendationJobInferenceBenchmark, RegisterModelStepMetadata, - ResourceCatalog, + RStudioServerProDomainSettingsForUpdate, + ScalingPolicy, ScalingPolicyMetric, ScalingPolicyObjective, SelectiveExecutionResult, - SpaceDetails, - StudioLifecycleConfigDetails, SuggestionQuery, + TargetTrackingScalingPolicyConfiguration, TrainingJobStepMetadata, - TrainingJobSummary, TransformJobStepMetadata, - TransformJobSummary, - TrialComponentSummary, - TrialSummary, TuningJobStepMetaData, - UserProfileDetails, + Workforce, + WorkforceVpcConfigResponse, + Workteam, } from "../models/models_3"; import { + ListResourceCatalogsRequest, + ListResourceCatalogsResponse, + ListSpacesRequest, + ListSpacesResponse, + ListStageDevicesRequest, + ListStageDevicesResponse, + ListStudioLifecycleConfigsRequest, + ListStudioLifecycleConfigsResponse, + ListSubscribedWorkteamsRequest, + ListSubscribedWorkteamsResponse, + ListTagsInput, + ListTagsOutput, + ListTrainingJobsForHyperParameterTuningJobRequest, + ListTrainingJobsForHyperParameterTuningJobResponse, + ListTrainingJobsRequest, + ListTrainingJobsResponse, + ListTransformJobsRequest, + ListTransformJobsResponse, + ListTrialComponentsRequest, + ListTrialComponentsResponse, + ListTrialsRequest, + ListTrialsResponse, + ListUserProfilesRequest, + ListUserProfilesResponse, + ListWorkforcesRequest, + ListWorkforcesResponse, + ListWorkteamsRequest, + ListWorkteamsResponse, + Model, ModelCard, ModelDashboardEndpoint, ModelDashboardModel, @@ -1793,6 +1857,7 @@ import { RenderingError, RenderUiTemplateRequest, RenderUiTemplateResponse, + ResourceCatalog, ResourceConfigForUpdate, RetryPipelineExecutionRequest, RetryPipelineExecutionResponse, @@ -1805,6 +1870,7 @@ import { SendPipelineExecutionStepSuccessRequest, SendPipelineExecutionStepSuccessResponse, ServiceCatalogProvisioningUpdateDetails, + SpaceDetails, StartEdgeDeploymentStageRequest, StartInferenceExperimentRequest, StartInferenceExperimentResponse, @@ -1828,18 +1894,25 @@ import { StopProcessingJobRequest, StopTrainingJobRequest, StopTransformJobRequest, + StudioLifecycleConfigDetails, TrainingJob, + TrainingJobSummary, TransformJob, + TransformJobSummary, Trial, TrialComponent, TrialComponentSimpleSummary, TrialComponentSourceDetail, + TrialComponentSummary, + TrialSummary, UpdateActionRequest, UpdateActionResponse, UpdateAppImageConfigRequest, UpdateAppImageConfigResponse, UpdateArtifactRequest, UpdateArtifactResponse, + UpdateClusterRequest, + UpdateClusterResponse, UpdateCodeRepositoryInput, UpdateCodeRepositoryOutput, UpdateContextRequest, @@ -1863,6 +1936,10 @@ import { UpdateImageResponse, UpdateImageVersionRequest, UpdateImageVersionResponse, + UpdateInferenceComponentInput, + UpdateInferenceComponentOutput, + UpdateInferenceComponentRuntimeConfigInput, + UpdateInferenceComponentRuntimeConfigOutput, UpdateInferenceExperimentRequest, UpdateInferenceExperimentResponse, UpdateModelCardRequest, @@ -1897,6 +1974,7 @@ import { UpdateWorkforceResponse, UpdateWorkteamRequest, UpdateWorkteamResponse, + UserProfileDetails, VariantProperty, Vertex, } from "../models/models_4"; @@ -2045,6 +2123,19 @@ export const se_CreateAutoMLJobV2Command = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +/** + * serializeAws_json1_1CreateClusterCommand + */ +export const se_CreateClusterCommand = async ( + input: CreateClusterCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("CreateCluster"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + /** * serializeAws_json1_1CreateCodeRepositoryCommand */ @@ -2292,6 +2383,19 @@ export const se_CreateImageVersionCommand = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +/** + * serializeAws_json1_1CreateInferenceComponentCommand + */ +export const se_CreateInferenceComponentCommand = async ( + input: CreateInferenceComponentCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("CreateInferenceComponent"); + let body: any; + body = JSON.stringify(se_CreateInferenceComponentInput(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + /** * serializeAws_json1_1CreateInferenceExperimentCommand */ @@ -2734,6 +2838,19 @@ export const se_DeleteAssociationCommand = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +/** + * serializeAws_json1_1DeleteClusterCommand + */ +export const se_DeleteClusterCommand = async ( + input: DeleteClusterCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("DeleteCluster"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + /** * serializeAws_json1_1DeleteCodeRepositoryCommand */ @@ -2955,6 +3072,19 @@ export const se_DeleteImageVersionCommand = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +/** + * serializeAws_json1_1DeleteInferenceComponentCommand + */ +export const se_DeleteInferenceComponentCommand = async ( + input: DeleteInferenceComponentCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("DeleteInferenceComponent"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + /** * serializeAws_json1_1DeleteInferenceExperimentCommand */ @@ -3345,6 +3475,32 @@ export const se_DescribeAutoMLJobV2Command = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +/** + * serializeAws_json1_1DescribeClusterCommand + */ +export const se_DescribeClusterCommand = async ( + input: DescribeClusterCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("DescribeCluster"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +/** + * serializeAws_json1_1DescribeClusterNodeCommand + */ +export const se_DescribeClusterNodeCommand = async ( + input: DescribeClusterNodeCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("DescribeClusterNode"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + /** * serializeAws_json1_1DescribeCodeRepositoryCommand */ @@ -3618,6 +3774,19 @@ export const se_DescribeImageVersionCommand = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +/** + * serializeAws_json1_1DescribeInferenceComponentCommand + */ +export const se_DescribeInferenceComponentCommand = async ( + input: DescribeInferenceComponentCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("DescribeInferenceComponent"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + /** * serializeAws_json1_1DescribeInferenceExperimentCommand */ @@ -4255,6 +4424,32 @@ export const se_ListCandidatesForAutoMLJobCommand = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +/** + * serializeAws_json1_1ListClusterNodesCommand + */ +export const se_ListClusterNodesCommand = async ( + input: ListClusterNodesCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("ListClusterNodes"); + let body: any; + body = JSON.stringify(se_ListClusterNodesRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +/** + * serializeAws_json1_1ListClustersCommand + */ +export const se_ListClustersCommand = async ( + input: ListClustersCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("ListClusters"); + let body: any; + body = JSON.stringify(se_ListClustersRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + /** * serializeAws_json1_1ListCodeRepositoriesCommand */ @@ -4528,6 +4723,19 @@ export const se_ListImageVersionsCommand = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +/** + * serializeAws_json1_1ListInferenceComponentsCommand + */ +export const se_ListInferenceComponentsCommand = async ( + input: ListInferenceComponentsCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("ListInferenceComponents"); + let body: any; + body = JSON.stringify(se_ListInferenceComponentsInput(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + /** * serializeAws_json1_1ListInferenceExperimentsCommand */ @@ -5461,6 +5669,19 @@ export const se_UpdateArtifactCommand = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +/** + * serializeAws_json1_1UpdateClusterCommand + */ +export const se_UpdateClusterCommand = async ( + input: UpdateClusterCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("UpdateCluster"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + /** * serializeAws_json1_1UpdateCodeRepositoryCommand */ @@ -5630,6 +5851,32 @@ export const se_UpdateImageVersionCommand = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +/** + * serializeAws_json1_1UpdateInferenceComponentCommand + */ +export const se_UpdateInferenceComponentCommand = async ( + input: UpdateInferenceComponentCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("UpdateInferenceComponent"); + let body: any; + body = JSON.stringify(se_UpdateInferenceComponentInput(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +/** + * serializeAws_json1_1UpdateInferenceComponentRuntimeConfigCommand + */ +export const se_UpdateInferenceComponentRuntimeConfigCommand = async ( + input: UpdateInferenceComponentRuntimeConfigCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("UpdateInferenceComponentRuntimeConfig"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + /** * serializeAws_json1_1UpdateInferenceExperimentCommand */ @@ -6354,6 +6601,55 @@ const de_CreateAutoMLJobV2CommandError = async ( } }; +/** + * deserializeAws_json1_1CreateClusterCommand + */ +export const de_CreateClusterCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode >= 300) { + return de_CreateClusterCommandError(output, context); + } + const data: any = await parseBody(output.body, context); + let contents: any = {}; + contents = de_CreateClusterResponse(data, context); + const response: CreateClusterCommandOutput = { + $metadata: deserializeMetadata(output), + ...contents, + }; + return response; +}; + +/** + * deserializeAws_json1_1CreateClusterCommandError + */ +const de_CreateClusterCommandError = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + const parsedOutput: any = { + ...output, + body: await parseErrorBody(output.body, context), + }; + const errorCode = loadRestJsonErrorCode(output, parsedOutput.body); + switch (errorCode) { + case "ResourceInUse": + case "com.amazonaws.sagemaker#ResourceInUse": + throw await de_ResourceInUseRes(parsedOutput, context); + case "ResourceLimitExceeded": + case "com.amazonaws.sagemaker#ResourceLimitExceeded": + throw await de_ResourceLimitExceededRes(parsedOutput, context); + default: + const parsedBody = parsedOutput.body; + return throwDefaultError({ + output, + parsedBody, + errorCode, + }); + } +}; + /** * deserializeAws_json1_1CreateCodeRepositoryCommand */ @@ -7249,6 +7545,52 @@ const de_CreateImageVersionCommandError = async ( } }; +/** + * deserializeAws_json1_1CreateInferenceComponentCommand + */ +export const de_CreateInferenceComponentCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode >= 300) { + return de_CreateInferenceComponentCommandError(output, context); + } + const data: any = await parseBody(output.body, context); + let contents: any = {}; + contents = de_CreateInferenceComponentOutput(data, context); + const response: CreateInferenceComponentCommandOutput = { + $metadata: deserializeMetadata(output), + ...contents, + }; + return response; +}; + +/** + * deserializeAws_json1_1CreateInferenceComponentCommandError + */ +const de_CreateInferenceComponentCommandError = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + const parsedOutput: any = { + ...output, + body: await parseErrorBody(output.body, context), + }; + const errorCode = loadRestJsonErrorCode(output, parsedOutput.body); + switch (errorCode) { + case "ResourceLimitExceeded": + case "com.amazonaws.sagemaker#ResourceLimitExceeded": + throw await de_ResourceLimitExceededRes(parsedOutput, context); + default: + const parsedBody = parsedOutput.body; + return throwDefaultError({ + output, + parsedBody, + errorCode, + }); + } +}; + /** * deserializeAws_json1_1CreateInferenceExperimentCommand */ @@ -8855,6 +9197,55 @@ const de_DeleteAssociationCommandError = async ( } }; +/** + * deserializeAws_json1_1DeleteClusterCommand + */ +export const de_DeleteClusterCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode >= 300) { + return de_DeleteClusterCommandError(output, context); + } + const data: any = await parseBody(output.body, context); + let contents: any = {}; + contents = de_DeleteClusterResponse(data, context); + const response: DeleteClusterCommandOutput = { + $metadata: deserializeMetadata(output), + ...contents, + }; + return response; +}; + +/** + * deserializeAws_json1_1DeleteClusterCommandError + */ +const de_DeleteClusterCommandError = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + const parsedOutput: any = { + ...output, + body: await parseErrorBody(output.body, context), + }; + const errorCode = loadRestJsonErrorCode(output, parsedOutput.body); + switch (errorCode) { + case "ConflictException": + case "com.amazonaws.sagemaker#ConflictException": + throw await de_ConflictExceptionRes(parsedOutput, context); + case "ResourceNotFound": + case "com.amazonaws.sagemaker#ResourceNotFound": + throw await de_ResourceNotFoundRes(parsedOutput, context); + default: + const parsedBody = parsedOutput.body; + return throwDefaultError({ + output, + parsedBody, + errorCode, + }); + } +}; + /** * deserializeAws_json1_1DeleteCodeRepositoryCommand */ @@ -9604,6 +9995,43 @@ const de_DeleteImageVersionCommandError = async ( } }; +/** + * deserializeAws_json1_1DeleteInferenceComponentCommand + */ +export const de_DeleteInferenceComponentCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode >= 300) { + return de_DeleteInferenceComponentCommandError(output, context); + } + await collectBody(output.body, context); + const response: DeleteInferenceComponentCommandOutput = { + $metadata: deserializeMetadata(output), + }; + return response; +}; + +/** + * deserializeAws_json1_1DeleteInferenceComponentCommandError + */ +const de_DeleteInferenceComponentCommandError = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + const parsedOutput: any = { + ...output, + body: await parseErrorBody(output.body, context), + }; + const errorCode = loadRestJsonErrorCode(output, parsedOutput.body); + const parsedBody = parsedOutput.body; + return throwDefaultError({ + output, + parsedBody, + errorCode, + }); +}; + /** * deserializeAws_json1_1DeleteInferenceExperimentCommand */ @@ -10903,6 +11331,98 @@ const de_DescribeAutoMLJobV2CommandError = async ( } }; +/** + * deserializeAws_json1_1DescribeClusterCommand + */ +export const de_DescribeClusterCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode >= 300) { + return de_DescribeClusterCommandError(output, context); + } + const data: any = await parseBody(output.body, context); + let contents: any = {}; + contents = de_DescribeClusterResponse(data, context); + const response: DescribeClusterCommandOutput = { + $metadata: deserializeMetadata(output), + ...contents, + }; + return response; +}; + +/** + * deserializeAws_json1_1DescribeClusterCommandError + */ +const de_DescribeClusterCommandError = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + const parsedOutput: any = { + ...output, + body: await parseErrorBody(output.body, context), + }; + const errorCode = loadRestJsonErrorCode(output, parsedOutput.body); + switch (errorCode) { + case "ResourceNotFound": + case "com.amazonaws.sagemaker#ResourceNotFound": + throw await de_ResourceNotFoundRes(parsedOutput, context); + default: + const parsedBody = parsedOutput.body; + return throwDefaultError({ + output, + parsedBody, + errorCode, + }); + } +}; + +/** + * deserializeAws_json1_1DescribeClusterNodeCommand + */ +export const de_DescribeClusterNodeCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode >= 300) { + return de_DescribeClusterNodeCommandError(output, context); + } + const data: any = await parseBody(output.body, context); + let contents: any = {}; + contents = de_DescribeClusterNodeResponse(data, context); + const response: DescribeClusterNodeCommandOutput = { + $metadata: deserializeMetadata(output), + ...contents, + }; + return response; +}; + +/** + * deserializeAws_json1_1DescribeClusterNodeCommandError + */ +const de_DescribeClusterNodeCommandError = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + const parsedOutput: any = { + ...output, + body: await parseErrorBody(output.body, context), + }; + const errorCode = loadRestJsonErrorCode(output, parsedOutput.body); + switch (errorCode) { + case "ResourceNotFound": + case "com.amazonaws.sagemaker#ResourceNotFound": + throw await de_ResourceNotFoundRes(parsedOutput, context); + default: + const parsedBody = parsedOutput.body; + return throwDefaultError({ + output, + parsedBody, + errorCode, + }); + } +}; + /** * deserializeAws_json1_1DescribeCodeRepositoryCommand */ @@ -11851,6 +12371,46 @@ const de_DescribeImageVersionCommandError = async ( } }; +/** + * deserializeAws_json1_1DescribeInferenceComponentCommand + */ +export const de_DescribeInferenceComponentCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode >= 300) { + return de_DescribeInferenceComponentCommandError(output, context); + } + const data: any = await parseBody(output.body, context); + let contents: any = {}; + contents = de_DescribeInferenceComponentOutput(data, context); + const response: DescribeInferenceComponentCommandOutput = { + $metadata: deserializeMetadata(output), + ...contents, + }; + return response; +}; + +/** + * deserializeAws_json1_1DescribeInferenceComponentCommandError + */ +const de_DescribeInferenceComponentCommandError = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + const parsedOutput: any = { + ...output, + body: await parseErrorBody(output.body, context), + }; + const errorCode = loadRestJsonErrorCode(output, parsedOutput.body); + const parsedBody = parsedOutput.body; + return throwDefaultError({ + output, + parsedBody, + errorCode, + }); +}; + /** * deserializeAws_json1_1DescribeInferenceExperimentCommand */ @@ -13997,6 +14557,92 @@ const de_ListCandidatesForAutoMLJobCommandError = async ( } }; +/** + * deserializeAws_json1_1ListClusterNodesCommand + */ +export const de_ListClusterNodesCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode >= 300) { + return de_ListClusterNodesCommandError(output, context); + } + const data: any = await parseBody(output.body, context); + let contents: any = {}; + contents = de_ListClusterNodesResponse(data, context); + const response: ListClusterNodesCommandOutput = { + $metadata: deserializeMetadata(output), + ...contents, + }; + return response; +}; + +/** + * deserializeAws_json1_1ListClusterNodesCommandError + */ +const de_ListClusterNodesCommandError = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + const parsedOutput: any = { + ...output, + body: await parseErrorBody(output.body, context), + }; + const errorCode = loadRestJsonErrorCode(output, parsedOutput.body); + switch (errorCode) { + case "ResourceNotFound": + case "com.amazonaws.sagemaker#ResourceNotFound": + throw await de_ResourceNotFoundRes(parsedOutput, context); + default: + const parsedBody = parsedOutput.body; + return throwDefaultError({ + output, + parsedBody, + errorCode, + }); + } +}; + +/** + * deserializeAws_json1_1ListClustersCommand + */ +export const de_ListClustersCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode >= 300) { + return de_ListClustersCommandError(output, context); + } + const data: any = await parseBody(output.body, context); + let contents: any = {}; + contents = de_ListClustersResponse(data, context); + const response: ListClustersCommandOutput = { + $metadata: deserializeMetadata(output), + ...contents, + }; + return response; +}; + +/** + * deserializeAws_json1_1ListClustersCommandError + */ +const de_ListClustersCommandError = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + const parsedOutput: any = { + ...output, + body: await parseErrorBody(output.body, context), + }; + const errorCode = loadRestJsonErrorCode(output, parsedOutput.body); + const parsedBody = parsedOutput.body; + return throwDefaultError({ + output, + parsedBody, + errorCode, + }); +}; + /** * deserializeAws_json1_1ListCodeRepositoriesCommand */ @@ -14861,6 +15507,46 @@ const de_ListImageVersionsCommandError = async ( } }; +/** + * deserializeAws_json1_1ListInferenceComponentsCommand + */ +export const de_ListInferenceComponentsCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode >= 300) { + return de_ListInferenceComponentsCommandError(output, context); + } + const data: any = await parseBody(output.body, context); + let contents: any = {}; + contents = de_ListInferenceComponentsOutput(data, context); + const response: ListInferenceComponentsCommandOutput = { + $metadata: deserializeMetadata(output), + ...contents, + }; + return response; +}; + +/** + * deserializeAws_json1_1ListInferenceComponentsCommandError + */ +const de_ListInferenceComponentsCommandError = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + const parsedOutput: any = { + ...output, + body: await parseErrorBody(output.body, context), + }; + const errorCode = loadRestJsonErrorCode(output, parsedOutput.body); + const parsedBody = parsedOutput.body; + return throwDefaultError({ + output, + parsedBody, + errorCode, + }); +}; + /** * deserializeAws_json1_1ListInferenceExperimentsCommand */ @@ -17933,6 +18619,58 @@ const de_UpdateArtifactCommandError = async ( } }; +/** + * deserializeAws_json1_1UpdateClusterCommand + */ +export const de_UpdateClusterCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode >= 300) { + return de_UpdateClusterCommandError(output, context); + } + const data: any = await parseBody(output.body, context); + let contents: any = {}; + contents = de_UpdateClusterResponse(data, context); + const response: UpdateClusterCommandOutput = { + $metadata: deserializeMetadata(output), + ...contents, + }; + return response; +}; + +/** + * deserializeAws_json1_1UpdateClusterCommandError + */ +const de_UpdateClusterCommandError = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + const parsedOutput: any = { + ...output, + body: await parseErrorBody(output.body, context), + }; + const errorCode = loadRestJsonErrorCode(output, parsedOutput.body); + switch (errorCode) { + case "ConflictException": + case "com.amazonaws.sagemaker#ConflictException": + throw await de_ConflictExceptionRes(parsedOutput, context); + case "ResourceLimitExceeded": + case "com.amazonaws.sagemaker#ResourceLimitExceeded": + throw await de_ResourceLimitExceededRes(parsedOutput, context); + case "ResourceNotFound": + case "com.amazonaws.sagemaker#ResourceNotFound": + throw await de_ResourceNotFoundRes(parsedOutput, context); + default: + const parsedBody = parsedOutput.body; + return throwDefaultError({ + output, + parsedBody, + errorCode, + }); + } +}; + /** * deserializeAws_json1_1UpdateCodeRepositoryCommand */ @@ -18528,6 +19266,98 @@ const de_UpdateImageVersionCommandError = async ( } }; +/** + * deserializeAws_json1_1UpdateInferenceComponentCommand + */ +export const de_UpdateInferenceComponentCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode >= 300) { + return de_UpdateInferenceComponentCommandError(output, context); + } + const data: any = await parseBody(output.body, context); + let contents: any = {}; + contents = de_UpdateInferenceComponentOutput(data, context); + const response: UpdateInferenceComponentCommandOutput = { + $metadata: deserializeMetadata(output), + ...contents, + }; + return response; +}; + +/** + * deserializeAws_json1_1UpdateInferenceComponentCommandError + */ +const de_UpdateInferenceComponentCommandError = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + const parsedOutput: any = { + ...output, + body: await parseErrorBody(output.body, context), + }; + const errorCode = loadRestJsonErrorCode(output, parsedOutput.body); + switch (errorCode) { + case "ResourceLimitExceeded": + case "com.amazonaws.sagemaker#ResourceLimitExceeded": + throw await de_ResourceLimitExceededRes(parsedOutput, context); + default: + const parsedBody = parsedOutput.body; + return throwDefaultError({ + output, + parsedBody, + errorCode, + }); + } +}; + +/** + * deserializeAws_json1_1UpdateInferenceComponentRuntimeConfigCommand + */ +export const de_UpdateInferenceComponentRuntimeConfigCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode >= 300) { + return de_UpdateInferenceComponentRuntimeConfigCommandError(output, context); + } + const data: any = await parseBody(output.body, context); + let contents: any = {}; + contents = de_UpdateInferenceComponentRuntimeConfigOutput(data, context); + const response: UpdateInferenceComponentRuntimeConfigCommandOutput = { + $metadata: deserializeMetadata(output), + ...contents, + }; + return response; +}; + +/** + * deserializeAws_json1_1UpdateInferenceComponentRuntimeConfigCommandError + */ +const de_UpdateInferenceComponentRuntimeConfigCommandError = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + const parsedOutput: any = { + ...output, + body: await parseErrorBody(output.body, context), + }; + const errorCode = loadRestJsonErrorCode(output, parsedOutput.body); + switch (errorCode) { + case "ResourceLimitExceeded": + case "com.amazonaws.sagemaker#ResourceLimitExceeded": + throw await de_ResourceLimitExceededRes(parsedOutput, context); + default: + const parsedBody = parsedOutput.body; + return throwDefaultError({ + output, + parsedBody, + errorCode, + }); + } +}; + /** * deserializeAws_json1_1UpdateInferenceExperimentCommand */ @@ -19580,6 +20410,12 @@ const se_BatchTransformInput = (input: BatchTransformInput, context: __SerdeCont // se_ClarifyTextConfig omitted. +// se_ClusterInstanceGroupSpecification omitted. + +// se_ClusterInstanceGroupSpecifications omitted. + +// se_ClusterLifeCycleConfig omitted. + // se_CodeRepositories omitted. // se_CodeRepository omitted. @@ -19666,6 +20502,8 @@ const se_CreateAutoMLJobV2Request = (input: CreateAutoMLJobV2Request, context: _ }); }; +// se_CreateClusterRequest omitted. + // se_CreateCodeRepositoryInput omitted. // se_CreateCompilationJobRequest omitted. @@ -19710,12 +20548,15 @@ const se_CreateEndpointConfigInput = (input: CreateEndpointConfigInput, context: return take(input, { AsyncInferenceConfig: _json, DataCaptureConfig: _json, + EnableNetworkIsolation: [], EndpointConfigName: [], + ExecutionRoleArn: [], ExplainerConfig: _json, KmsKeyId: [], ProductionVariants: (_) => se_ProductionVariantList(_, context), ShadowProductionVariants: (_) => se_ProductionVariantList(_, context), Tags: _json, + VpcConfig: _json, }); }; @@ -19783,6 +20624,20 @@ const se_CreateImageVersionRequest = (input: CreateImageVersionRequest, context: }); }; +/** + * serializeAws_json1_1CreateInferenceComponentInput + */ +const se_CreateInferenceComponentInput = (input: CreateInferenceComponentInput, context: __SerdeContext): any => { + return take(input, { + EndpointName: [], + InferenceComponentName: [], + RuntimeConfig: _json, + Specification: (_) => se_InferenceComponentSpecification(_, context), + Tags: _json, + VariantName: [], + }); +}; + /** * serializeAws_json1_1CreateInferenceExperimentRequest */ @@ -20032,6 +20887,8 @@ const se_DataQualityJobInput = (input: DataQualityJobInput, context: __SerdeCont // se_DeleteAssociationRequest omitted. +// se_DeleteClusterRequest omitted. + // se_DeleteCodeRepositoryInput omitted. // se_DeleteContextRequest omitted. @@ -20066,6 +20923,8 @@ const se_DataQualityJobInput = (input: DataQualityJobInput, context: __SerdeCont // se_DeleteImageVersionRequest omitted. +// se_DeleteInferenceComponentInput omitted. + // se_DeleteInferenceExperimentRequest omitted. // se_DeleteModelBiasJobDefinitionRequest omitted. @@ -20140,6 +20999,10 @@ const se_DeletePipelineRequest = (input: DeletePipelineRequest, context: __Serde // se_DescribeAutoMLJobV2Request omitted. +// se_DescribeClusterNodeRequest omitted. + +// se_DescribeClusterRequest omitted. + // se_DescribeCodeRepositoryInput omitted. // se_DescribeCompilationJobRequest omitted. @@ -20182,6 +21045,8 @@ const se_DeletePipelineRequest = (input: DeletePipelineRequest, context: __Serde // se_DescribeImageVersionRequest omitted. +// se_DescribeInferenceComponentInput omitted. + // se_DescribeInferenceExperimentRequest omitted. // se_DescribeInferenceRecommendationsJobRequest omitted. @@ -20491,6 +21356,39 @@ const se_HyperParameterTuningJobConfig = (input: HyperParameterTuningJobConfig, // se_ImportHubContentRequest omitted. +/** + * serializeAws_json1_1InferenceComponentComputeResourceRequirements + */ +const se_InferenceComponentComputeResourceRequirements = ( + input: InferenceComponentComputeResourceRequirements, + context: __SerdeContext +): any => { + return take(input, { + MaxMemoryRequiredInMb: [], + MinMemoryRequiredInMb: [], + NumberOfAcceleratorDevicesRequired: __serializeFloat, + NumberOfCpuCoresRequired: __serializeFloat, + }); +}; + +// se_InferenceComponentContainerSpecification omitted. + +// se_InferenceComponentRuntimeConfig omitted. + +/** + * serializeAws_json1_1InferenceComponentSpecification + */ +const se_InferenceComponentSpecification = (input: InferenceComponentSpecification, context: __SerdeContext): any => { + return take(input, { + ComputeResourceRequirements: (_) => se_InferenceComponentComputeResourceRequirements(_, context), + Container: _json, + ModelName: [], + StartupParameters: _json, + }); +}; + +// se_InferenceComponentStartupParameters omitted. + // se_InferenceExecutionConfig omitted. // se_InferenceExperimentDataStorageConfig omitted. @@ -20507,6 +21405,8 @@ const se_InferenceExperimentSchedule = (input: InferenceExperimentSchedule, cont // se_InferenceSpecification omitted. +// se_InfraCheckConfig omitted. + // se_InputConfig omitted. // se_InputDataConfig omitted. @@ -20670,6 +21570,37 @@ const se_ListAutoMLJobsRequest = (input: ListAutoMLJobsRequest, context: __Serde // se_ListCandidatesForAutoMLJobRequest omitted. +/** + * serializeAws_json1_1ListClusterNodesRequest + */ +const se_ListClusterNodesRequest = (input: ListClusterNodesRequest, context: __SerdeContext): any => { + return take(input, { + ClusterName: [], + CreationTimeAfter: (_) => Math.round(_.getTime() / 1000), + CreationTimeBefore: (_) => Math.round(_.getTime() / 1000), + InstanceGroupNameContains: [], + MaxResults: [], + NextToken: [], + SortBy: [], + SortOrder: [], + }); +}; + +/** + * serializeAws_json1_1ListClustersRequest + */ +const se_ListClustersRequest = (input: ListClustersRequest, context: __SerdeContext): any => { + return take(input, { + CreationTimeAfter: (_) => Math.round(_.getTime() / 1000), + CreationTimeBefore: (_) => Math.round(_.getTime() / 1000), + MaxResults: [], + NameContains: [], + NextToken: [], + SortBy: [], + SortOrder: [], + }); +}; + /** * serializeAws_json1_1ListCodeRepositoriesInput */ @@ -21008,6 +21939,26 @@ const se_ListImageVersionsRequest = (input: ListImageVersionsRequest, context: _ }); }; +/** + * serializeAws_json1_1ListInferenceComponentsInput + */ +const se_ListInferenceComponentsInput = (input: ListInferenceComponentsInput, context: __SerdeContext): any => { + return take(input, { + CreationTimeAfter: (_) => Math.round(_.getTime() / 1000), + CreationTimeBefore: (_) => Math.round(_.getTime() / 1000), + EndpointNameEquals: [], + LastModifiedTimeAfter: (_) => Math.round(_.getTime() / 1000), + LastModifiedTimeBefore: (_) => Math.round(_.getTime() / 1000), + MaxResults: [], + NameContains: [], + NextToken: [], + SortBy: [], + SortOrder: [], + StatusEquals: [], + VariantNameEquals: [], + }); +}; + /** * serializeAws_json1_1ListInferenceExperimentsRequest */ @@ -21856,8 +22807,10 @@ const se_ProductionVariant = (input: ProductionVariant, context: __SerdeContext) InitialInstanceCount: [], InitialVariantWeight: __serializeFloat, InstanceType: [], + ManagedInstanceScaling: _json, ModelDataDownloadTimeoutInSeconds: [], ModelName: [], + RoutingConfig: _json, ServerlessConfig: _json, VariantName: [], VolumeSizeInGB: [], @@ -21877,6 +22830,10 @@ const se_ProductionVariantList = (input: ProductionVariant[], context: __SerdeCo }); }; +// se_ProductionVariantManagedInstanceScaling omitted. + +// se_ProductionVariantRoutingConfig omitted. + // se_ProductionVariantServerlessConfig omitted. // se_ProductionVariantServerlessUpdateConfig omitted. @@ -22211,6 +23168,8 @@ const se_StopPipelineExecutionRequest = (input: StopPipelineExecutionRequest, co // se_TextClassificationJobConfig omitted. +// se_TextGenerationHyperParameters omitted. + // se_TextGenerationJobConfig omitted. // se_TimeSeriesConfig omitted. @@ -22313,6 +23272,8 @@ const se_TuningJobCompletionCriteria = (input: TuningJobCompletionCriteria, cont // se_UpdateArtifactRequest omitted. +// se_UpdateClusterRequest omitted. + // se_UpdateCodeRepositoryInput omitted. // se_UpdateContextRequest omitted. @@ -22350,6 +23311,19 @@ const se_UpdateEndpointWeightsAndCapacitiesInput = ( // se_UpdateImageVersionRequest omitted. +/** + * serializeAws_json1_1UpdateInferenceComponentInput + */ +const se_UpdateInferenceComponentInput = (input: UpdateInferenceComponentInput, context: __SerdeContext): any => { + return take(input, { + InferenceComponentName: [], + RuntimeConfig: _json, + Specification: (_) => se_InferenceComponentSpecification(_, context), + }); +}; + +// se_UpdateInferenceComponentRuntimeConfigInput omitted. + /** * serializeAws_json1_1UpdateInferenceExperimentRequest */ @@ -23901,6 +24875,117 @@ const de_ClarifyTextConfig = (output: any, context: __SerdeContext): ClarifyText }) as any; }; +/** + * deserializeAws_json1_1ClusterInstanceGroupDetails + */ +const de_ClusterInstanceGroupDetails = (output: any, context: __SerdeContext): ClusterInstanceGroupDetails => { + return take(output, { + CurrentCount: __expectInt32, + ExecutionRole: __expectString, + InstanceGroupName: __expectString, + InstanceType: __expectString, + LifeCycleConfig: (_: any) => de_ClusterLifeCycleConfig(_, context), + TargetCount: __expectInt32, + ThreadsPerCore: __expectInt32, + }) as any; +}; + +/** + * deserializeAws_json1_1ClusterInstanceGroupDetailsList + */ +const de_ClusterInstanceGroupDetailsList = (output: any, context: __SerdeContext): ClusterInstanceGroupDetails[] => { + const retVal = (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + return de_ClusterInstanceGroupDetails(entry, context); + }); + return retVal; +}; + +/** + * deserializeAws_json1_1ClusterInstanceStatusDetails + */ +const de_ClusterInstanceStatusDetails = (output: any, context: __SerdeContext): ClusterInstanceStatusDetails => { + return take(output, { + Message: __expectString, + Status: __expectString, + }) as any; +}; + +/** + * deserializeAws_json1_1ClusterLifeCycleConfig + */ +const de_ClusterLifeCycleConfig = (output: any, context: __SerdeContext): ClusterLifeCycleConfig => { + return take(output, { + OnCreate: __expectString, + SourceS3Uri: __expectString, + }) as any; +}; + +/** + * deserializeAws_json1_1ClusterNodeDetails + */ +const de_ClusterNodeDetails = (output: any, context: __SerdeContext): ClusterNodeDetails => { + return take(output, { + InstanceGroupName: __expectString, + InstanceId: __expectString, + InstanceStatus: (_: any) => de_ClusterInstanceStatusDetails(_, context), + InstanceType: __expectString, + LaunchTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), + LifeCycleConfig: (_: any) => de_ClusterLifeCycleConfig(_, context), + ThreadsPerCore: __expectInt32, + }) as any; +}; + +/** + * deserializeAws_json1_1ClusterNodeSummaries + */ +const de_ClusterNodeSummaries = (output: any, context: __SerdeContext): ClusterNodeSummary[] => { + const retVal = (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + return de_ClusterNodeSummary(entry, context); + }); + return retVal; +}; + +/** + * deserializeAws_json1_1ClusterNodeSummary + */ +const de_ClusterNodeSummary = (output: any, context: __SerdeContext): ClusterNodeSummary => { + return take(output, { + InstanceGroupName: __expectString, + InstanceId: __expectString, + InstanceStatus: (_: any) => de_ClusterInstanceStatusDetails(_, context), + InstanceType: __expectString, + LaunchTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), + }) as any; +}; + +/** + * deserializeAws_json1_1ClusterSummaries + */ +const de_ClusterSummaries = (output: any, context: __SerdeContext): ClusterSummary[] => { + const retVal = (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + return de_ClusterSummary(entry, context); + }); + return retVal; +}; + +/** + * deserializeAws_json1_1ClusterSummary + */ +const de_ClusterSummary = (output: any, context: __SerdeContext): ClusterSummary => { + return take(output, { + ClusterArn: __expectString, + ClusterName: __expectString, + ClusterStatus: __expectString, + CreationTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), + }) as any; +}; + /** * deserializeAws_json1_1CodeRepositories */ @@ -24300,6 +25385,15 @@ const de_CreateAutoMLJobV2Response = (output: any, context: __SerdeContext): Cre }) as any; }; +/** + * deserializeAws_json1_1CreateClusterResponse + */ +const de_CreateClusterResponse = (output: any, context: __SerdeContext): CreateClusterResponse => { + return take(output, { + ClusterArn: __expectString, + }) as any; +}; + /** * deserializeAws_json1_1CreateCodeRepositoryOutput */ @@ -24454,6 +25548,15 @@ const de_CreateImageVersionResponse = (output: any, context: __SerdeContext): Cr }) as any; }; +/** + * deserializeAws_json1_1CreateInferenceComponentOutput + */ +const de_CreateInferenceComponentOutput = (output: any, context: __SerdeContext): CreateInferenceComponentOutput => { + return take(output, { + InferenceComponentArn: __expectString, + }) as any; +}; + /** * deserializeAws_json1_1CreateInferenceExperimentResponse */ @@ -25010,6 +26113,15 @@ const de_DeleteAssociationResponse = (output: any, context: __SerdeContext): Del }) as any; }; +/** + * deserializeAws_json1_1DeleteClusterResponse + */ +const de_DeleteClusterResponse = (output: any, context: __SerdeContext): DeleteClusterResponse => { + return take(output, { + ClusterArn: __expectString, + }) as any; +}; + /** * deserializeAws_json1_1DeleteContextResponse */ @@ -25346,6 +26458,30 @@ const de_DescribeAutoMLJobV2Response = (output: any, context: __SerdeContext): D }) as any; }; +/** + * deserializeAws_json1_1DescribeClusterNodeResponse + */ +const de_DescribeClusterNodeResponse = (output: any, context: __SerdeContext): DescribeClusterNodeResponse => { + return take(output, { + NodeDetails: (_: any) => de_ClusterNodeDetails(_, context), + }) as any; +}; + +/** + * deserializeAws_json1_1DescribeClusterResponse + */ +const de_DescribeClusterResponse = (output: any, context: __SerdeContext): DescribeClusterResponse => { + return take(output, { + ClusterArn: __expectString, + ClusterName: __expectString, + ClusterStatus: __expectString, + CreationTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), + FailureMessage: __expectString, + InstanceGroups: (_: any) => de_ClusterInstanceGroupDetailsList(_, context), + VpcConfig: (_: any) => de_VpcConfig(_, context), + }) as any; +}; + /** * deserializeAws_json1_1DescribeCodeRepositoryOutput */ @@ -25547,12 +26683,15 @@ const de_DescribeEndpointConfigOutput = (output: any, context: __SerdeContext): AsyncInferenceConfig: (_: any) => de_AsyncInferenceConfig(_, context), CreationTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), DataCaptureConfig: (_: any) => de_DataCaptureConfig(_, context), + EnableNetworkIsolation: __expectBoolean, EndpointConfigArn: __expectString, EndpointConfigName: __expectString, + ExecutionRoleArn: __expectString, ExplainerConfig: (_: any) => de_ExplainerConfig(_, context), KmsKeyId: __expectString, ProductionVariants: (_: any) => de_ProductionVariantList(_, context), ShadowProductionVariants: (_: any) => de_ProductionVariantList(_, context), + VpcConfig: (_: any) => de_VpcConfig(_, context), }) as any; }; @@ -25779,6 +26918,28 @@ const de_DescribeImageVersionResponse = (output: any, context: __SerdeContext): }) as any; }; +/** + * deserializeAws_json1_1DescribeInferenceComponentOutput + */ +const de_DescribeInferenceComponentOutput = ( + output: any, + context: __SerdeContext +): DescribeInferenceComponentOutput => { + return take(output, { + CreationTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), + EndpointArn: __expectString, + EndpointName: __expectString, + FailureReason: __expectString, + InferenceComponentArn: __expectString, + InferenceComponentName: __expectString, + InferenceComponentStatus: __expectString, + LastModifiedTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), + RuntimeConfig: (_: any) => de_InferenceComponentRuntimeConfigSummary(_, context), + Specification: (_: any) => de_InferenceComponentSpecificationSummary(_, context), + VariantName: __expectString, + }) as any; +}; + /** * deserializeAws_json1_1DescribeInferenceExperimentResponse */ @@ -26233,6 +27394,7 @@ const de_DescribeSpaceResponse = (output: any, context: __SerdeContext): Describ SpaceName: __expectString, SpaceSettings: (_: any) => de_SpaceSettings(_, context), Status: __expectString, + Url: __expectString, }) as any; }; @@ -26286,6 +27448,7 @@ const de_DescribeTrainingJobResponse = (output: any, context: __SerdeContext): D FailureReason: __expectString, FinalMetricDataList: (_: any) => de_FinalMetricDataList(_, context), HyperParameters: (_: any) => de_HyperParameters(_, context), + InfraCheckConfig: (_: any) => de_InfraCheckConfig(_, context), InputDataConfig: (_: any) => de_InputDataConfig(_, context), LabelingJobArn: __expectString, LastModifiedTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), @@ -28352,6 +29515,104 @@ const de_ImportHubContentResponse = (output: any, context: __SerdeContext): Impo }) as any; }; +/** + * deserializeAws_json1_1InferenceComponentComputeResourceRequirements + */ +const de_InferenceComponentComputeResourceRequirements = ( + output: any, + context: __SerdeContext +): InferenceComponentComputeResourceRequirements => { + return take(output, { + MaxMemoryRequiredInMb: __expectInt32, + MinMemoryRequiredInMb: __expectInt32, + NumberOfAcceleratorDevicesRequired: __limitedParseFloat32, + NumberOfCpuCoresRequired: __limitedParseFloat32, + }) as any; +}; + +/** + * deserializeAws_json1_1InferenceComponentContainerSpecificationSummary + */ +const de_InferenceComponentContainerSpecificationSummary = ( + output: any, + context: __SerdeContext +): InferenceComponentContainerSpecificationSummary => { + return take(output, { + ArtifactUrl: __expectString, + DeployedImage: (_: any) => de_DeployedImage(_, context), + Environment: (_: any) => de_EnvironmentMap(_, context), + }) as any; +}; + +/** + * deserializeAws_json1_1InferenceComponentRuntimeConfigSummary + */ +const de_InferenceComponentRuntimeConfigSummary = ( + output: any, + context: __SerdeContext +): InferenceComponentRuntimeConfigSummary => { + return take(output, { + CurrentCopyCount: __expectInt32, + DesiredCopyCount: __expectInt32, + }) as any; +}; + +/** + * deserializeAws_json1_1InferenceComponentSpecificationSummary + */ +const de_InferenceComponentSpecificationSummary = ( + output: any, + context: __SerdeContext +): InferenceComponentSpecificationSummary => { + return take(output, { + ComputeResourceRequirements: (_: any) => de_InferenceComponentComputeResourceRequirements(_, context), + Container: (_: any) => de_InferenceComponentContainerSpecificationSummary(_, context), + ModelName: __expectString, + StartupParameters: (_: any) => de_InferenceComponentStartupParameters(_, context), + }) as any; +}; + +/** + * deserializeAws_json1_1InferenceComponentStartupParameters + */ +const de_InferenceComponentStartupParameters = ( + output: any, + context: __SerdeContext +): InferenceComponentStartupParameters => { + return take(output, { + ContainerStartupHealthCheckTimeoutInSeconds: __expectInt32, + ModelDataDownloadTimeoutInSeconds: __expectInt32, + }) as any; +}; + +/** + * deserializeAws_json1_1InferenceComponentSummary + */ +const de_InferenceComponentSummary = (output: any, context: __SerdeContext): InferenceComponentSummary => { + return take(output, { + CreationTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), + EndpointArn: __expectString, + EndpointName: __expectString, + InferenceComponentArn: __expectString, + InferenceComponentName: __expectString, + InferenceComponentStatus: __expectString, + LastModifiedTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), + VariantName: __expectString, + }) as any; +}; + +/** + * deserializeAws_json1_1InferenceComponentSummaryList + */ +const de_InferenceComponentSummaryList = (output: any, context: __SerdeContext): InferenceComponentSummary[] => { + const retVal = (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + return de_InferenceComponentSummary(entry, context); + }); + return retVal; +}; + /** * deserializeAws_json1_1InferenceExecutionConfig */ @@ -28524,6 +29785,15 @@ const de_InferenceSpecification = (output: any, context: __SerdeContext): Infere }) as any; }; +/** + * deserializeAws_json1_1InfraCheckConfig + */ +const de_InfraCheckConfig = (output: any, context: __SerdeContext): InfraCheckConfig => { + return take(output, { + EnableInfraCheck: __expectBoolean, + }) as any; +}; + /** * deserializeAws_json1_1InputConfig */ @@ -29066,6 +30336,26 @@ const de_ListCandidatesForAutoMLJobResponse = ( }) as any; }; +/** + * deserializeAws_json1_1ListClusterNodesResponse + */ +const de_ListClusterNodesResponse = (output: any, context: __SerdeContext): ListClusterNodesResponse => { + return take(output, { + ClusterNodeSummaries: (_: any) => de_ClusterNodeSummaries(_, context), + NextToken: __expectString, + }) as any; +}; + +/** + * deserializeAws_json1_1ListClustersResponse + */ +const de_ListClustersResponse = (output: any, context: __SerdeContext): ListClustersResponse => { + return take(output, { + ClusterSummaries: (_: any) => de_ClusterSummaries(_, context), + NextToken: __expectString, + }) as any; +}; + /** * deserializeAws_json1_1ListCodeRepositoriesOutput */ @@ -29282,6 +30572,16 @@ const de_ListImageVersionsResponse = (output: any, context: __SerdeContext): Lis }) as any; }; +/** + * deserializeAws_json1_1ListInferenceComponentsOutput + */ +const de_ListInferenceComponentsOutput = (output: any, context: __SerdeContext): ListInferenceComponentsOutput => { + return take(output, { + InferenceComponents: (_: any) => de_InferenceComponentSummaryList(_, context), + NextToken: __expectString, + }) as any; +}; + /** * deserializeAws_json1_1ListInferenceExperimentsResponse */ @@ -31526,6 +32826,8 @@ const de_PendingProductionVariantSummary = (output: any, context: __SerdeContext DesiredServerlessConfig: (_: any) => de_ProductionVariantServerlessConfig(_, context), DesiredWeight: __limitedParseFloat32, InstanceType: __expectString, + ManagedInstanceScaling: (_: any) => de_ProductionVariantManagedInstanceScaling(_, context), + RoutingConfig: (_: any) => de_ProductionVariantRoutingConfig(_, context), VariantName: __expectString, VariantStatus: (_: any) => de_ProductionVariantStatusList(_, context), }) as any; @@ -31952,8 +33254,10 @@ const de_ProductionVariant = (output: any, context: __SerdeContext): ProductionV InitialInstanceCount: __expectInt32, InitialVariantWeight: __limitedParseFloat32, InstanceType: __expectString, + ManagedInstanceScaling: (_: any) => de_ProductionVariantManagedInstanceScaling(_, context), ModelDataDownloadTimeoutInSeconds: __expectInt32, ModelName: __expectString, + RoutingConfig: (_: any) => de_ProductionVariantRoutingConfig(_, context), ServerlessConfig: (_: any) => de_ProductionVariantServerlessConfig(_, context), VariantName: __expectString, VolumeSizeInGB: __expectInt32, @@ -31982,6 +33286,29 @@ const de_ProductionVariantList = (output: any, context: __SerdeContext): Product return retVal; }; +/** + * deserializeAws_json1_1ProductionVariantManagedInstanceScaling + */ +const de_ProductionVariantManagedInstanceScaling = ( + output: any, + context: __SerdeContext +): ProductionVariantManagedInstanceScaling => { + return take(output, { + MaxInstanceCount: __expectInt32, + MinInstanceCount: __expectInt32, + Status: __expectString, + }) as any; +}; + +/** + * deserializeAws_json1_1ProductionVariantRoutingConfig + */ +const de_ProductionVariantRoutingConfig = (output: any, context: __SerdeContext): ProductionVariantRoutingConfig => { + return take(output, { + RoutingStrategy: __expectString, + }) as any; +}; + /** * deserializeAws_json1_1ProductionVariantServerlessConfig */ @@ -32031,6 +33358,8 @@ const de_ProductionVariantSummary = (output: any, context: __SerdeContext): Prod DesiredInstanceCount: __expectInt32, DesiredServerlessConfig: (_: any) => de_ProductionVariantServerlessConfig(_, context), DesiredWeight: __limitedParseFloat32, + ManagedInstanceScaling: (_: any) => de_ProductionVariantManagedInstanceScaling(_, context), + RoutingConfig: (_: any) => de_ProductionVariantRoutingConfig(_, context), VariantName: __expectString, VariantStatus: (_: any) => de_ProductionVariantStatusList(_, context), }) as any; @@ -32662,6 +33991,7 @@ const de_ResourceSpec = (output: any, context: __SerdeContext): ResourceSpec => InstanceType: __expectString, LifecycleConfigArn: __expectString, SageMakerImageArn: __expectString, + SageMakerImageVersionAlias: __expectString, SageMakerImageVersionArn: __expectString, }) as any; }; @@ -33392,6 +34722,19 @@ const de_TextClassificationJobConfig = (output: any, context: __SerdeContext): T }) as any; }; +/** + * deserializeAws_json1_1TextGenerationHyperParameters + */ +const de_TextGenerationHyperParameters = (output: any, context: __SerdeContext): Record => { + return Object.entries(output).reduce((acc: Record, [key, value]: [string, any]) => { + if (value === null) { + return acc; + } + acc[key as string] = __expectString(value) as any; + return acc; + }, {} as Record); +}; + /** * deserializeAws_json1_1TextGenerationJobConfig */ @@ -33399,6 +34742,7 @@ const de_TextGenerationJobConfig = (output: any, context: __SerdeContext): TextG return take(output, { BaseModelName: __expectString, CompletionCriteria: (_: any) => de_AutoMLJobCompletionCriteria(_, context), + TextGenerationHyperParameters: (_: any) => de_TextGenerationHyperParameters(_, context), }) as any; }; @@ -34185,6 +35529,15 @@ const de_UpdateArtifactResponse = (output: any, context: __SerdeContext): Update }) as any; }; +/** + * deserializeAws_json1_1UpdateClusterResponse + */ +const de_UpdateClusterResponse = (output: any, context: __SerdeContext): UpdateClusterResponse => { + return take(output, { + ClusterArn: __expectString, + }) as any; +}; + /** * deserializeAws_json1_1UpdateCodeRepositoryOutput */ @@ -34278,6 +35631,27 @@ const de_UpdateImageVersionResponse = (output: any, context: __SerdeContext): Up }) as any; }; +/** + * deserializeAws_json1_1UpdateInferenceComponentOutput + */ +const de_UpdateInferenceComponentOutput = (output: any, context: __SerdeContext): UpdateInferenceComponentOutput => { + return take(output, { + InferenceComponentArn: __expectString, + }) as any; +}; + +/** + * deserializeAws_json1_1UpdateInferenceComponentRuntimeConfigOutput + */ +const de_UpdateInferenceComponentRuntimeConfigOutput = ( + output: any, + context: __SerdeContext +): UpdateInferenceComponentRuntimeConfigOutput => { + return take(output, { + InferenceComponentArn: __expectString, + }) as any; +}; + /** * deserializeAws_json1_1UpdateInferenceExperimentResponse */ @@ -34491,6 +35865,7 @@ const de_UserProfileList = (output: any, context: __SerdeContext): UserProfileDe const de_UserSettings = (output: any, context: __SerdeContext): UserSettings => { return take(output, { CanvasAppSettings: (_: any) => de_CanvasAppSettings(_, context), + DefaultLandingUri: __expectString, ExecutionRole: __expectString, JupyterServerAppSettings: (_: any) => de_JupyterServerAppSettings(_, context), KernelGatewayAppSettings: (_: any) => de_KernelGatewayAppSettings(_, context), @@ -34498,6 +35873,7 @@ const de_UserSettings = (output: any, context: __SerdeContext): UserSettings => RStudioServerProAppSettings: (_: any) => de_RStudioServerProAppSettings(_, context), SecurityGroups: (_: any) => de_SecurityGroupIds(_, context), SharingSettings: (_: any) => de_SharingSettings(_, context), + StudioWebPortal: __expectString, TensorBoardAppSettings: (_: any) => de_TensorBoardAppSettings(_, context), }) as any; }; diff --git a/codegen/sdk-codegen/aws-models/sagemaker.json b/codegen/sdk-codegen/aws-models/sagemaker.json index d4f26816885b..f356d5a9db11 100644 --- a/codegen/sdk-codegen/aws-models/sagemaker.json +++ b/codegen/sdk-codegen/aws-models/sagemaker.json @@ -262,7 +262,7 @@ "target": "com.amazonaws.sagemaker#AddTagsOutput" }, "traits": { - "smithy.api#documentation": "

    Adds or overwrites one or more tags for the specified SageMaker resource. You can add\n tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform\n jobs, models, labeling jobs, work teams, endpoint configurations, and\n endpoints.

    \n

    Each tag consists of a key and an optional value. Tag keys must be unique per\n resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies.

    \n \n

    Tags that you add to a hyperparameter tuning job by calling this API are also\n added to any training jobs that the hyperparameter tuning job launches after you\n call this API, but not to training jobs that the hyperparameter tuning job launched\n before you called this API. To make sure that the tags associated with a\n hyperparameter tuning job are also added to all training jobs that the\n hyperparameter tuning job launches, add the tags when you first create the tuning\n job by specifying them in the Tags parameter of CreateHyperParameterTuningJob\n

    \n     \n \n

    Tags that you add to a SageMaker Studio Domain or User Profile by calling this API\n are also added to any Apps that the Domain or User Profile launches after you call\n this API, but not to Apps that the Domain or User Profile launched before you called\n this API. To make sure that the tags associated with a Domain or User Profile are\n also added to all Apps that the Domain or User Profile launches, add the tags when\n you first create the Domain or User Profile by specifying them in the\n Tags parameter of CreateDomain\n or CreateUserProfile.

    \n     " + "smithy.api#documentation": "

    Adds or overwrites one or more tags for the specified SageMaker resource. You can add\n tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform\n jobs, models, labeling jobs, work teams, endpoint configurations, and\n endpoints.

    \n

    Each tag consists of a key and an optional value. Tag keys must be unique per\n resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies.

    \n \n

    Tags that you add to a hyperparameter tuning job by calling this API are also\n added to any training jobs that the hyperparameter tuning job launches after you\n call this API, but not to training jobs that the hyperparameter tuning job launched\n before you called this API. To make sure that the tags associated with a\n hyperparameter tuning job are also added to all training jobs that the\n hyperparameter tuning job launches, add the tags when you first create the tuning\n job by specifying them in the Tags parameter of CreateHyperParameterTuningJob\n

    \n     \n \n

    Tags that you add to a SageMaker Domain or User Profile by calling this API\n are also added to any Apps that the Domain or User Profile launches after you call\n this API, but not to Apps that the Domain or User Profile launched before you called\n this API. To make sure that the tags associated with a Domain or User Profile are\n also added to all Apps that the Domain or User Profile launches, add the tags when\n you first create the Domain or User Profile by specifying them in the\n Tags parameter of CreateDomain\n or CreateUserProfile.

    \n     " } }, "com.amazonaws.sagemaker#AddTagsInput": { @@ -2730,7 +2730,7 @@ "MaxRuntimePerTrainingJobInSeconds": { "target": "com.amazonaws.sagemaker#MaxRuntimePerTrainingJobInSeconds", "traits": { - "smithy.api#documentation": "

    The maximum time, in seconds, that each training job executed inside hyperparameter\n tuning is allowed to run as part of a hyperparameter tuning job. For more information, see\n the StoppingCondition\n used by the CreateHyperParameterTuningJob action.

    \n

    For job V2s (jobs created by calling CreateAutoMLJobV2), this field\n controls the runtime of the job candidate.

    " + "smithy.api#documentation": "

    The maximum time, in seconds, that each training job executed inside hyperparameter\n tuning is allowed to run as part of a hyperparameter tuning job. For more information, see\n the StoppingCondition\n used by the CreateHyperParameterTuningJob action.

    \n

    For job V2s (jobs created by calling CreateAutoMLJobV2), this field\n controls the runtime of the job candidate.

    \n

    For TextGenerationJobConfig problem types, the maximum time defaults to 72 hours\n (259200 seconds).

    " } }, "MaxAutoMLJobRuntimeInSeconds": { @@ -5749,6 +5749,741 @@ "smithy.api#pattern": "^[a-zA-Z0-9-]+$" } }, + "com.amazonaws.sagemaker#ClusterArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:cluster/[a-z0-9]{12}$" + } + }, + "com.amazonaws.sagemaker#ClusterInstanceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#ClusterInstanceGroupDetails": { + "type": "structure", + "members": { + "CurrentCount": { + "target": "com.amazonaws.sagemaker#ClusterNonNegativeInstanceCount", + "traits": { + "smithy.api#documentation": "

    The number of instances that are currently in the instance group of a\n SageMaker HyperPod cluster.

    " + } + }, + "TargetCount": { + "target": "com.amazonaws.sagemaker#ClusterInstanceCount", + "traits": { + "smithy.api#documentation": "

    The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.

    " + } + }, + "InstanceGroupName": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupName", + "traits": { + "smithy.api#documentation": "

    The name of the instance group of a SageMaker HyperPod cluster.

    " + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ClusterInstanceType", + "traits": { + "smithy.api#documentation": "

    The instance type of the instance group of a SageMaker HyperPod cluster.

    " + } + }, + "LifeCycleConfig": { + "target": "com.amazonaws.sagemaker#ClusterLifeCycleConfig", + "traits": { + "smithy.api#documentation": "

    Details of LifeCycle configuration for the instance group.

    " + } + }, + "ExecutionRole": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

    The execution role for the instance group to assume.

    " + } + }, + "ThreadsPerCore": { + "target": "com.amazonaws.sagemaker#ClusterThreadsPerCore", + "traits": { + "smithy.api#documentation": "

    The number you specified to TreadsPerCore in CreateCluster for\n enabling or disabling multithreading. For instance types that support multithreading, you\n can specify 1 for disabling multithreading and 2 for enabling multithreading. For more\n information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud\n User Guide.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Details of an instance group in a SageMaker HyperPod cluster.

    " + } + }, + "com.amazonaws.sagemaker#ClusterInstanceGroupDetailsList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupDetails" + } + }, + "com.amazonaws.sagemaker#ClusterInstanceGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + } + }, + "com.amazonaws.sagemaker#ClusterInstanceGroupSpecification": { + "type": "structure", + "members": { + "InstanceCount": { + "target": "com.amazonaws.sagemaker#ClusterInstanceCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.

    ", + "smithy.api#required": {} + } + }, + "InstanceGroupName": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    Specifies the name of the instance group.

    ", + "smithy.api#required": {} + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ClusterInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    Specifies the instance type of the instance group.

    ", + "smithy.api#required": {} + } + }, + "LifeCycleConfig": { + "target": "com.amazonaws.sagemaker#ClusterLifeCycleConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    Specifies the LifeCycle configuration for the instance group.

    ", + "smithy.api#required": {} + } + }, + "ExecutionRole": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    Specifies an IAM execution role to be assumed by the instance group.

    ", + "smithy.api#required": {} + } + }, + "ThreadsPerCore": { + "target": "com.amazonaws.sagemaker#ClusterThreadsPerCore", + "traits": { + "smithy.api#documentation": "

    Specifies the value for Threads per core. For instance types that\n support multithreading, you can specify 1 for disabling multithreading and\n 2 for enabling multithreading. For instance types that doesn't support\n multithreading, specify 1. For more information, see the reference table of\n CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud\n User Guide.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    The specifications of an instance group that you need to define.

    " + } + }, + "com.amazonaws.sagemaker#ClusterInstanceGroupSpecifications": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupSpecification" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#ClusterInstanceStatus": { + "type": "enum", + "members": { + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Running" + } + }, + "FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failure" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "SHUTTING_DOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ShuttingDown" + } + }, + "SYSTEM_UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SystemUpdating" + } + } + } + }, + "com.amazonaws.sagemaker#ClusterInstanceStatusDetails": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.sagemaker#ClusterInstanceStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The status of an instance in a SageMaker HyperPod cluster.

    ", + "smithy.api#required": {} + } + }, + "Message": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

    The message from an instance in a SageMaker HyperPod cluster.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Details of an instance in a SageMaker HyperPod cluster.

    " + } + }, + "com.amazonaws.sagemaker#ClusterInstanceType": { + "type": "enum", + "members": { + "ML_P4D_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p4d.24xlarge" + } + }, + "ML_P4DE_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p4de.24xlarge" + } + }, + "ML_P5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p5.48xlarge" + } + }, + "ML_TRN1_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1.32xlarge" + } + }, + "ML_TRN1N_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1n.32xlarge" + } + }, + "ML_G5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.xlarge" + } + }, + "ML_G5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.2xlarge" + } + }, + "ML_G5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.4xlarge" + } + }, + "ML_G5_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.8xlarge" + } + }, + "ML_G5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.12xlarge" + } + }, + "ML_G5_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.16xlarge" + } + }, + "ML_G5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.24xlarge" + } + }, + "ML_G5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.48xlarge" + } + }, + "ML_C5_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.large" + } + }, + "ML_C5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.xlarge" + } + }, + "ML_C5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.2xlarge" + } + }, + "ML_C5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.4xlarge" + } + }, + "ML_C5_9XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.9xlarge" + } + }, + "ML_C5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.12xlarge" + } + }, + "ML_C5_18XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.18xlarge" + } + }, + "ML_C5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.24xlarge" + } + }, + "ML_C5N_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5n.large" + } + }, + "ML_C5N_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5n.2xlarge" + } + }, + "ML_C5N_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5n.4xlarge" + } + }, + "ML_C5N_9XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5n.9xlarge" + } + }, + "ML_C5N_18XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5n.18xlarge" + } + }, + "ML_M5_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.large" + } + }, + "ML_M5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.xlarge" + } + }, + "ML_M5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.2xlarge" + } + }, + "ML_M5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.4xlarge" + } + }, + "ML_M5_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.8xlarge" + } + }, + "ML_M5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.12xlarge" + } + }, + "ML_M5_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.16xlarge" + } + }, + "ML_M5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.24xlarge" + } + }, + "ML_T3_MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.medium" + } + }, + "ML_T3_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.large" + } + }, + "ML_T3_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.xlarge" + } + }, + "ML_T3_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.2xlarge" + } + } + } + }, + "com.amazonaws.sagemaker#ClusterLifeCycleConfig": { + "type": "structure", + "members": { + "SourceS3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    An Amazon S3 bucket path where your LifeCycle scripts are stored.

    ", + "smithy.api#required": {} + } + }, + "OnCreate": { + "target": "com.amazonaws.sagemaker#ClusterLifeCycleConfigFileName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The directory of the LifeCycle script under SourceS3Uri. This LifeCycle\n script runs during cluster creation.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    The LifeCycle configuration for a SageMaker HyperPod cluster.

    " + } + }, + "com.amazonaws.sagemaker#ClusterLifeCycleConfigFileName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\S\\s]+$" + } + }, + "com.amazonaws.sagemaker#ClusterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + } + }, + "com.amazonaws.sagemaker#ClusterNameOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:cluster/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})$" + } + }, + "com.amazonaws.sagemaker#ClusterNodeDetails": { + "type": "structure", + "members": { + "InstanceGroupName": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupName", + "traits": { + "smithy.api#documentation": "

    The instance group name in which the instance is.

    " + } + }, + "InstanceId": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

    The ID of the instance.

    " + } + }, + "InstanceStatus": { + "target": "com.amazonaws.sagemaker#ClusterInstanceStatusDetails", + "traits": { + "smithy.api#documentation": "

    The status of the instance.

    " + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ClusterInstanceType", + "traits": { + "smithy.api#documentation": "

    The type of the instance.

    " + } + }, + "LaunchTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

    The time when the instance is launched.

    " + } + }, + "LifeCycleConfig": { + "target": "com.amazonaws.sagemaker#ClusterLifeCycleConfig", + "traits": { + "smithy.api#documentation": "

    The LifeCycle configuration applied to the instance.

    " + } + }, + "ThreadsPerCore": { + "target": "com.amazonaws.sagemaker#ClusterThreadsPerCore", + "traits": { + "smithy.api#documentation": "

    The number of threads per CPU core you specified under\n CreateCluster.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Details of an instance (also called a node interchangeably) in a\n SageMaker HyperPod cluster.

    " + } + }, + "com.amazonaws.sagemaker#ClusterNodeId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z][-a-zA-Z0-9]*$" + } + }, + "com.amazonaws.sagemaker#ClusterNodeSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ClusterNodeSummary" + } + }, + "com.amazonaws.sagemaker#ClusterNodeSummary": { + "type": "structure", + "members": { + "InstanceGroupName": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The name of the instance group in which the instance is.

    ", + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The ID of the instance.

    ", + "smithy.api#required": {} + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ClusterInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The type of the instance.

    ", + "smithy.api#required": {} + } + }, + "LaunchTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The time when the instance is launched.

    ", + "smithy.api#required": {} + } + }, + "InstanceStatus": { + "target": "com.amazonaws.sagemaker#ClusterInstanceStatusDetails", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The status of the instance.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    Lists a summary of the properties of an instance (also called a\n node interchangeably) of a SageMaker HyperPod cluster.

    " + } + }, + "com.amazonaws.sagemaker#ClusterNonNegativeInstanceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#ClusterSortBy": { + "type": "enum", + "members": { + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_TIME" + } + }, + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAME" + } + } + } + }, + "com.amazonaws.sagemaker#ClusterStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "INSERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InService" + } + }, + "ROLLINGBACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RollingBack" + } + }, + "SYSTEMUPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SystemUpdating" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + } + } + }, + "com.amazonaws.sagemaker#ClusterSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ClusterSummary" + } + }, + "com.amazonaws.sagemaker#ClusterSummary": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

    ", + "smithy.api#required": {} + } + }, + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The name of the SageMaker HyperPod cluster.

    ", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The time when the SageMaker HyperPod cluster is created.

    ", + "smithy.api#required": {} + } + }, + "ClusterStatus": { + "target": "com.amazonaws.sagemaker#ClusterStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The status of the SageMaker HyperPod cluster.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    Lists a summary of the properties of a SageMaker HyperPod cluster.

    " + } + }, + "com.amazonaws.sagemaker#ClusterThreadsPerCore": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 2 + } + } + }, "com.amazonaws.sagemaker#CodeRepositories": { "type": "list", "member": { @@ -6931,7 +7666,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a running app for the specified UserProfile. This operation is automatically\n invoked by Amazon SageMaker Studio upon access to the associated Domain, and when new kernel\n configurations are selected by the user. A user may have multiple Apps active simultaneously.

    " + "smithy.api#documentation": "

    Creates a running app for the specified UserProfile. This operation is automatically\n invoked by Amazon SageMaker upon access to the associated Domain, and when new kernel\n configurations are selected by the user. A user may have multiple Apps active simultaneously.

    " } }, "com.amazonaws.sagemaker#CreateAppImageConfig": { @@ -7365,6 +8100,75 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#CreateCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateClusterRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

    Creates a SageMaker HyperPod cluster. SageMaker HyperPod is a capability of SageMaker for creating and managing\n persistent clusters for developing large machine learning models, such as large language\n models (LLMs) and diffusion models. To learn more, see Amazon SageMaker HyperPod in the Amazon SageMaker Developer Guide.

    " + } + }, + "com.amazonaws.sagemaker#CreateClusterRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The name for the new SageMaker HyperPod cluster.

    ", + "smithy.api#required": {} + } + }, + "InstanceGroups": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupSpecifications", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The instance groups to be created in the SageMaker HyperPod cluster.

    ", + "smithy.api#required": {} + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig" + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

    Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can\n add tags to your cluster in the same way you add them in other Amazon Web Services services\n that support tagging. To learn more about tagging Amazon Web Services resources in general,\n see Tagging Amazon Web Services Resources User Guide.

    " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateClusterResponse": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the cluster.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#CreateCodeRepository": { "type": "operation", "input": { @@ -7800,7 +8604,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a Domain used by Amazon SageMaker Studio. A domain consists of an associated\n Amazon Elastic File System (EFS) volume, a list of authorized users, and a variety of security, application,\n policy, and Amazon Virtual Private Cloud (VPC) configurations.\n Users within a domain can share notebook files and other artifacts with each other.

    \n

    \n EFS storage\n

    \n

    When a domain is created, an EFS volume is created for use by all of the users within the\n domain. Each user receives a private home directory within the EFS volume for notebooks,\n Git repositories, and data files.

    \n

    SageMaker uses the Amazon Web Services Key Management Service (Amazon Web Services KMS) to encrypt the EFS volume attached to the domain with\n an Amazon Web Services managed key by default. For more control, you can specify a\n customer managed key. For more information, see\n Protect Data at\n Rest Using Encryption.

    \n

    \n VPC configuration\n

    \n

    All SageMaker Studio traffic between the domain and the EFS volume is through the specified\n VPC and subnets. For other Studio traffic, you can specify the AppNetworkAccessType\n parameter. AppNetworkAccessType corresponds to the network access type that you\n choose when you onboard to Studio. The following options are available:

    \n
      \n
    • \n

      \n PublicInternetOnly - Non-EFS traffic goes through a VPC managed by\n Amazon SageMaker, which allows internet access. This is the default value.

      \n
      • \n
    • \n

      \n VpcOnly - All Studio traffic is through the specified VPC and subnets.\n Internet access is disabled by default. To allow internet access, you must specify a\n NAT gateway.

      \n

      When internet access is disabled, you won't be able to run a Studio notebook or to\n train or host models unless your VPC has an interface endpoint to the SageMaker API and runtime\n or a NAT gateway and your security groups allow outbound connections.

      \n
      • \n
    \n \n

    NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules\n in order to launch a SageMaker Studio app successfully.

    \n     \n

    For more information, see\n Connect\n SageMaker Studio Notebooks to Resources in a VPC.

    " + "smithy.api#documentation": "

    Creates a Domain. A domain consists of an associated\n Amazon Elastic File System (EFS) volume, a list of authorized users, and a variety of security, application,\n policy, and Amazon Virtual Private Cloud (VPC) configurations.\n Users within a domain can share notebook files and other artifacts with each other.

    \n

    \n EFS storage\n

    \n

    When a domain is created, an EFS volume is created for use by all of the users within the\n domain. Each user receives a private home directory within the EFS volume for notebooks,\n Git repositories, and data files.

    \n

    SageMaker uses the Amazon Web Services Key Management Service (Amazon Web Services KMS) to encrypt the EFS volume attached to the domain with\n an Amazon Web Services managed key by default. For more control, you can specify a\n customer managed key. For more information, see\n Protect Data at\n Rest Using Encryption.

    \n

    \n VPC configuration\n

    \n

    All traffic between the domain and the EFS volume is through the specified\n VPC and subnets. For other traffic, you can specify the AppNetworkAccessType\n parameter. AppNetworkAccessType corresponds to the network access type that you\n choose when you onboard to the domain. The following options are available:

    \n
      \n
    • \n

      \n PublicInternetOnly - Non-EFS traffic goes through a VPC managed by\n Amazon SageMaker, which allows internet access. This is the default value.

      \n
      • \n
    • \n

      \n VpcOnly - All traffic is through the specified VPC and subnets.\n Internet access is disabled by default. To allow internet access, you must specify a\n NAT gateway.

      \n

      When internet access is disabled, you won't be able to run a Amazon SageMaker Studio notebook or to\n train or host models unless your VPC has an interface endpoint to the SageMaker API and runtime\n or a NAT gateway and your security groups allow outbound connections.

      \n
      • \n
    \n \n

    NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules\n in order to launch a Amazon SageMaker Studio app successfully.

    \n     \n

    For more information, see\n Connect\n Amazon SageMaker Studio Notebooks to Resources in a VPC.

    " } }, "com.amazonaws.sagemaker#CreateDomainRequest": { @@ -7834,7 +8638,7 @@ "target": "com.amazonaws.sagemaker#Subnets", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

    The VPC subnets that Studio uses for communication.

    ", + "smithy.api#documentation": "

    The VPC subnets that the domain uses for communication.

    ", "smithy.api#required": {} } }, @@ -7842,7 +8646,7 @@ "target": "com.amazonaws.sagemaker#VpcId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

    The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

    ", + "smithy.api#documentation": "

    The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

    ", "smithy.api#required": {} } }, @@ -7855,7 +8659,7 @@ "AppNetworkAccessType": { "target": "com.amazonaws.sagemaker#AppNetworkAccessType", "traits": { - "smithy.api#documentation": "

    Specifies the VPC used for non-EFS traffic. The default value is\n PublicInternetOnly.

    \n
      \n
    • \n

      \n PublicInternetOnly - Non-EFS traffic is through a VPC managed by\n Amazon SageMaker, which allows direct internet access

      \n
      • \n
    • \n

      \n VpcOnly - All Studio traffic is through the specified VPC and subnets

      \n
      • \n
    " + "smithy.api#documentation": "

    Specifies the VPC used for non-EFS traffic. The default value is\n PublicInternetOnly.

    \n
      \n
    • \n

      \n PublicInternetOnly - Non-EFS traffic is through a VPC managed by\n Amazon SageMaker, which allows direct internet access

      \n
      • \n
    • \n

      \n VpcOnly - All traffic is through the specified VPC and subnets

      \n
      • \n
    " } }, "HomeEfsFileSystemKmsKeyId": { @@ -8204,6 +9008,21 @@ "traits": { "smithy.api#documentation": "

    An array of ProductionVariant objects, one for each model that you want\n to host at this endpoint in shadow mode with production traffic replicated from the\n model specified on ProductionVariants. If you use this field, you can only\n specify one variant for ProductionVariants and one variant for\n ShadowProductionVariants.

    " } + }, + "ExecutionRoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform actions on your behalf. For more information, see SageMaker\n Roles.

    \n \n

    To be able to pass this role to Amazon SageMaker, the caller of this action must\n have the iam:PassRole permission.

    \n     " + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig" + }, + "EnableNetworkIsolation": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

    Sets whether all model containers deployed to the endpoint are isolated. If they are, no\n inbound or outbound network calls can be made to or from the model containers.

    " + } } }, "traits": { @@ -8973,6 +9792,93 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#CreateInferenceComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#CreateInferenceComponentInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#CreateInferenceComponentOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

    Creates an inference component, which is a SageMaker hosting object that you can\n use to deploy a model to an endpoint. In the inference component settings, you specify the\n model, the endpoint, and how the model utilizes the resources that the endpoint hosts. You\n can optimize resource utilization by tailoring how the required CPU cores, accelerators,\n and memory are allocated. You can deploy multiple inference components to an endpoint,\n where each inference component contains one model and the resource utilization needs for\n that individual model. After you deploy an inference component, you can directly invoke the\n associated model when you use the InvokeEndpoint API action.

    " + } + }, + "com.amazonaws.sagemaker#CreateInferenceComponentInput": { + "type": "structure", + "members": { + "InferenceComponentName": { + "target": "com.amazonaws.sagemaker#InferenceComponentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    A unique name to assign to the inference component.

    ", + "smithy.api#required": {} + } + }, + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The name of an existing endpoint where you host the inference component.

    ", + "smithy.api#required": {} + } + }, + "VariantName": { + "target": "com.amazonaws.sagemaker#VariantName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The name of an existing production variant where you host the inference\n component.

    ", + "smithy.api#required": {} + } + }, + "Specification": { + "target": "com.amazonaws.sagemaker#InferenceComponentSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    Details about the resources to deploy with this inference component, including the\n model, container, and compute resources.

    ", + "smithy.api#required": {} + } + }, + "RuntimeConfig": { + "target": "com.amazonaws.sagemaker#InferenceComponentRuntimeConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    Runtime settings for a model that is deployed with an inference component.

    ", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

    A list of key-value pairs associated with the model. For more information, see Tagging Amazon Web Services\n resources in the Amazon Web Services General\n Reference.

    " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateInferenceComponentOutput": { + "type": "structure", + "members": { + "InferenceComponentArn": { + "target": "com.amazonaws.sagemaker#InferenceComponentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the inference component.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#CreateInferenceExperiment": { "type": "operation", "input": { @@ -9739,9 +10645,7 @@ "ExecutionRoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access model\n artifacts and docker image for deployment on ML compute instances or for batch transform\n jobs. Deploying on ML compute instances is part of model hosting. For more information,\n see SageMaker\n Roles.

    \n \n

    To be able to pass this role to SageMaker, the caller of this API must have the\n iam:PassRole permission.

    \n     ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access model\n artifacts and docker image for deployment on ML compute instances or for batch transform\n jobs. Deploying on ML compute instances is part of model hosting. For more information,\n see SageMaker\n Roles.

    \n \n

    To be able to pass this role to SageMaker, the caller of this API must have the\n iam:PassRole permission.

    \n     " } }, "Tags": { @@ -10494,7 +11398,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser,\n the user will be automatically signed in to Amazon SageMaker Studio, and granted access to all of\n the Apps and files associated with the Domain's Amazon Elastic File System (EFS) volume.\n This operation can only be called when the authentication mode equals IAM.\n

    \n

    The IAM role or user passed to this API defines the permissions to access the app. Once\n the presigned URL is created, no additional permission is required to access this URL. IAM\n authorization policies for this API are also enforced for every HTTP request and WebSocket\n frame that attempts to connect to the app.

    \n

    You can restrict access to this API and to the\n URL that it returns to a list of IP addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more\n information, see Connect to SageMaker Studio Through an Interface VPC Endpoint\n .

    \n \n

    The URL that you get from a call to CreatePresignedDomainUrl has a default timeout of 5 minutes. You can configure this value using ExpiresInSeconds. If you try to use the URL after the timeout limit expires, you\n are directed to the Amazon Web Services console sign-in page.

    \n     " + "smithy.api#documentation": "

    Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser,\n the user will be automatically signed in to the domain, and granted access to all of\n the Apps and files associated with the Domain's Amazon Elastic File System (EFS) volume.\n This operation can only be called when the authentication mode equals IAM.\n

    \n

    The IAM role or user passed to this API defines the permissions to access the app. Once\n the presigned URL is created, no additional permission is required to access this URL. IAM\n authorization policies for this API are also enforced for every HTTP request and WebSocket\n frame that attempts to connect to the app.

    \n

    You can restrict access to this API and to the\n URL that it returns to a list of IP addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more\n information, see Connect to Amazon SageMaker Studio Through an Interface VPC Endpoint\n .

    \n \n

    The URL that you get from a call to CreatePresignedDomainUrl has a default timeout of 5 minutes. You can configure this value using ExpiresInSeconds. If you try to use the URL after the timeout limit expires, you\n are directed to the Amazon Web Services console sign-in page.

    \n     " } }, "com.amazonaws.sagemaker#CreatePresignedDomainUrlRequest": { @@ -10533,6 +11437,12 @@ "traits": { "smithy.api#documentation": "

    The name of the space.

    " } + }, + "LandingUri": { + "target": "com.amazonaws.sagemaker#LandingUri", + "traits": { + "smithy.api#documentation": "

    The landing page that the user is directed to when accessing the presigned URL. Using this value, users can access Studio or Studio Classic, even if it is not the default experience for the domain. The supported values are:

    \n
      \n
    • \n

      \n studio::relative/path: Directs users to the relative path in Studio.

      \n
      • \n
    • \n

      \n app:JupyterServer:relative/path: Directs users to the relative path in the Studio Classic application.

      \n
      • \n
    • \n

      \n app:JupyterLab:relative/path: Directs users to the relative path in the JupyterLab application.

      \n
      • \n
    • \n

      \n app:RStudioServerPro:relative/path: Directs users to the relative path in the RStudio application.

      \n
      • \n
    • \n

      \n app:Canvas:relative/path: Directs users to the relative path in the Canvas application.

      \n
      • \n
    " + } } }, "traits": { @@ -10880,7 +11790,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a new Studio Lifecycle Configuration.

    " + "smithy.api#documentation": "

    Creates a new Amazon SageMaker Studio Lifecycle Configuration.

    " } }, "com.amazonaws.sagemaker#CreateStudioLifecycleConfigRequest": { @@ -10890,7 +11800,7 @@ "target": "com.amazonaws.sagemaker#StudioLifecycleConfigName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

    The name of the Studio Lifecycle Configuration to create.

    ", + "smithy.api#documentation": "

    The name of the Amazon SageMaker Studio Lifecycle Configuration to create.

    ", "smithy.api#required": {} } }, @@ -10898,7 +11808,7 @@ "target": "com.amazonaws.sagemaker#StudioLifecycleConfigContent", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

    The content of your Studio Lifecycle Configuration script. This content must be base64 encoded.

    ", + "smithy.api#documentation": "

    The content of your Amazon SageMaker Studio Lifecycle Configuration script. This content must be base64 encoded.

    ", "smithy.api#required": {} } }, @@ -11092,6 +12002,12 @@ "traits": { "smithy.api#documentation": "

    The number of times to retry the job when the job fails due to an\n InternalServerError.

    " } + }, + "InfraCheckConfig": { + "target": "com.amazonaws.sagemaker#InfraCheckConfig", + "traits": { + "smithy.api#documentation": "

    Contains information about the infrastructure health check configuration for the training job.

    " + } } }, "traits": { @@ -11440,7 +12356,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a user profile. A user profile represents a single user within a domain, and is\n the main way to reference a \"person\" for the purposes of sharing, reporting, and other\n user-oriented features. This entity is created when a user onboards to Amazon SageMaker Studio. If an\n administrator invites a person by email or imports them from IAM Identity Center, a user profile is\n automatically created. A user profile is the primary holder of settings for an individual\n user and has a reference to the user's private Amazon Elastic File System (EFS) home directory.\n

    " + "smithy.api#documentation": "

    Creates a user profile. A user profile represents a single user within a domain, and is\n the main way to reference a \"person\" for the purposes of sharing, reporting, and other\n user-oriented features. This entity is created when a user onboards to a domain. If an\n administrator invites a person by email or imports them from IAM Identity Center, a user profile is\n automatically created. A user profile is the primary holder of settings for an individual\n user and has a reference to the user's private Amazon Elastic File System (EFS) home directory.\n

    " } }, "com.amazonaws.sagemaker#CreateUserProfileRequest": { @@ -12642,6 +13558,58 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#DeleteCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteClusterRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DeleteClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

    Delete a SageMaker HyperPod cluster.

    " + } + }, + "com.amazonaws.sagemaker#DeleteClusterRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster to delete.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DeleteClusterResponse": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster to delete.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#DeleteCodeRepository": { "type": "operation", "input": { @@ -13312,6 +14280,34 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#DeleteInferenceComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DeleteInferenceComponentInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "

    Deletes an inference component.

    " + } + }, + "com.amazonaws.sagemaker#DeleteInferenceComponentInput": { + "type": "structure", + "members": { + "InferenceComponentName": { + "target": "com.amazonaws.sagemaker#InferenceComponentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The name of the inference component to delete.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.sagemaker#DeleteInferenceExperiment": { "type": "operation", "input": { @@ -13860,7 +14856,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Deletes the Studio Lifecycle Configuration. In order to delete the Lifecycle Configuration, there must be no running apps using the Lifecycle Configuration. You must also remove the Lifecycle Configuration from UserSettings in all Domains and UserProfiles.

    " + "smithy.api#documentation": "

    Deletes the Amazon SageMaker Studio Lifecycle Configuration. In order to delete the Lifecycle Configuration, there must be no running apps using the Lifecycle Configuration. You must also remove the Lifecycle Configuration from UserSettings in all Domains and UserProfiles.

    " } }, "com.amazonaws.sagemaker#DeleteStudioLifecycleConfigRequest": { @@ -13870,7 +14866,7 @@ "target": "com.amazonaws.sagemaker#StudioLifecycleConfigName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

    The name of the Studio Lifecycle Configuration to delete.

    ", + "smithy.api#documentation": "

    The name of the Amazon SageMaker Studio Lifecycle Configuration to delete.

    ", "smithy.api#required": {} } } @@ -13888,7 +14884,7 @@ "target": "com.amazonaws.sagemaker#DeleteTagsOutput" }, "traits": { - "smithy.api#documentation": "

    Deletes the specified tags from an SageMaker resource.

    \n

    To list a resource's tags, use the ListTags API.

    \n \n

    When you call this API to delete tags from a hyperparameter tuning job, the\n deleted tags are not removed from training jobs that the hyperparameter tuning job\n launched before you called this API.

    \n     \n \n

    When you call this API to delete tags from a SageMaker Studio Domain or User\n Profile, the deleted tags are not removed from Apps that the SageMaker Studio Domain\n or User Profile launched before you called this API.

    \n     " + "smithy.api#documentation": "

    Deletes the specified tags from an SageMaker resource.

    \n

    To list a resource's tags, use the ListTags API.

    \n \n

    When you call this API to delete tags from a hyperparameter tuning job, the\n deleted tags are not removed from training jobs that the hyperparameter tuning job\n launched before you called this API.

    \n     \n \n

    When you call this API to delete tags from a SageMaker Domain or User\n Profile, the deleted tags are not removed from Apps that the SageMaker Domain\n or User Profile launched before you called this API.

    \n     " } }, "com.amazonaws.sagemaker#DeleteTagsInput": { @@ -15291,6 +16287,149 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#DescribeCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeClusterRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

    Retrieves information of a SageMaker HyperPod cluster.

    " + } + }, + "com.amazonaws.sagemaker#DescribeClusterNode": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeClusterNodeRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeClusterNodeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

    Retrieves information of an instance (also called a node\n interchangeably) of a SageMaker HyperPod cluster.

    " + } + }, + "com.amazonaws.sagemaker#DescribeClusterNodeRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which the instance is.

    ", + "smithy.api#required": {} + } + }, + "NodeId": { + "target": "com.amazonaws.sagemaker#ClusterNodeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The ID of the instance.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeClusterNodeResponse": { + "type": "structure", + "members": { + "NodeDetails": { + "target": "com.amazonaws.sagemaker#ClusterNodeDetails", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The details of the instance.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#DescribeClusterRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeClusterResponse": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

    ", + "smithy.api#required": {} + } + }, + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterName", + "traits": { + "smithy.api#documentation": "

    The name of the SageMaker HyperPod cluster.

    " + } + }, + "ClusterStatus": { + "target": "com.amazonaws.sagemaker#ClusterStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The status of the SageMaker HyperPod cluster.

    ", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

    The time when the SageMaker Cluster is created.

    " + } + }, + "FailureMessage": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

    The failure message of the SageMaker HyperPod cluster.

    " + } + }, + "InstanceGroups": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupDetailsList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The instance groups of the SageMaker HyperPod cluster.

    ", + "smithy.api#required": {} + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig" + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#DescribeCodeRepository": { "type": "operation", "input": { @@ -16092,7 +17231,7 @@ "AppNetworkAccessType": { "target": "com.amazonaws.sagemaker#AppNetworkAccessType", "traits": { - "smithy.api#documentation": "

    Specifies the VPC used for non-EFS traffic. The default value is\n PublicInternetOnly.

    \n
      \n
    • \n

      \n PublicInternetOnly - Non-EFS traffic is through a VPC managed by\n Amazon SageMaker, which allows direct internet access

      \n
      • \n
    • \n

      \n VpcOnly - All Studio traffic is through the specified VPC and subnets

      \n
      • \n
    " + "smithy.api#documentation": "

    Specifies the VPC used for non-EFS traffic. The default value is\n PublicInternetOnly.

    \n
      \n
    • \n

      \n PublicInternetOnly - Non-EFS traffic is through a VPC managed by\n Amazon SageMaker, which allows direct internet access

      \n
      • \n
    • \n

      \n VpcOnly - All traffic is through the specified VPC and subnets

      \n
      • \n
    " } }, "HomeEfsFileSystemKmsKeyId": { @@ -16107,7 +17246,7 @@ "SubnetIds": { "target": "com.amazonaws.sagemaker#Subnets", "traits": { - "smithy.api#documentation": "

    The VPC subnets that Studio uses for communication.

    " + "smithy.api#documentation": "

    The VPC subnets that the domain uses for communication.

    " } }, "Url": { @@ -16119,7 +17258,7 @@ "VpcId": { "target": "com.amazonaws.sagemaker#VpcId", "traits": { - "smithy.api#documentation": "

    The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

    " + "smithy.api#documentation": "

    The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

    " } }, "KmsKeyId": { @@ -16579,6 +17718,21 @@ "traits": { "smithy.api#documentation": "

    An array of ProductionVariant objects, one for each model that you want\n to host at this endpoint in shadow mode with production traffic replicated from the\n model specified on ProductionVariants.

    " } + }, + "ExecutionRoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM role that you assigned to the\n endpoint configuration.

    " + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig" + }, + "EnableNetworkIsolation": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

    Indicates whether all model containers deployed to the endpoint are isolated. If they\n are, no inbound or outbound network calls can be made to or from the model\n containers.

    " + } } }, "traits": { @@ -18109,6 +19263,120 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#DescribeInferenceComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeInferenceComponentInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeInferenceComponentOutput" + }, + "traits": { + "smithy.api#documentation": "

    Returns information about an inference component.

    " + } + }, + "com.amazonaws.sagemaker#DescribeInferenceComponentInput": { + "type": "structure", + "members": { + "InferenceComponentName": { + "target": "com.amazonaws.sagemaker#InferenceComponentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The name of the inference component.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeInferenceComponentOutput": { + "type": "structure", + "members": { + "InferenceComponentName": { + "target": "com.amazonaws.sagemaker#InferenceComponentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The name of the inference component.

    ", + "smithy.api#required": {} + } + }, + "InferenceComponentArn": { + "target": "com.amazonaws.sagemaker#InferenceComponentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the inference component.

    ", + "smithy.api#required": {} + } + }, + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The name of the endpoint that hosts the inference component.

    ", + "smithy.api#required": {} + } + }, + "EndpointArn": { + "target": "com.amazonaws.sagemaker#EndpointArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.

    ", + "smithy.api#required": {} + } + }, + "VariantName": { + "target": "com.amazonaws.sagemaker#VariantName", + "traits": { + "smithy.api#documentation": "

    The name of the production variant that hosts the inference component.

    " + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

    If the inference component status is Failed, the reason for the\n failure.

    " + } + }, + "Specification": { + "target": "com.amazonaws.sagemaker#InferenceComponentSpecificationSummary", + "traits": { + "smithy.api#documentation": "

    Details about the resources that are deployed with this inference component.

    " + } + }, + "RuntimeConfig": { + "target": "com.amazonaws.sagemaker#InferenceComponentRuntimeConfigSummary", + "traits": { + "smithy.api#documentation": "

    Details about the runtime settings for the model that is deployed with the inference\n component.

    " + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The time when the inference component was created.

    ", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The time when the inference component was last updated.

    ", + "smithy.api#required": {} + } + }, + "InferenceComponentStatus": { + "target": "com.amazonaws.sagemaker#InferenceComponentStatus", + "traits": { + "smithy.api#documentation": "

    The status of the inference component.

    " + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#DescribeInferenceExperiment": { "type": "operation", "input": { @@ -19189,9 +20457,7 @@ "ExecutionRoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM role that you specified for the\n model.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM role that you specified for the\n model.

    " } }, "VpcConfig": { @@ -20756,6 +22022,12 @@ "traits": { "smithy.api#documentation": "

    A collection of space settings.

    " } + }, + "Url": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "

    Returns the URL of the space. If the space is created with Amazon Web Services IAM Identity Center (Successor to Amazon Web Services Single Sign-On) authentication, users can navigate to the URL after appending the respective redirect parameter for the application type to be federated through Amazon Web Services IAM Identity Center.

    \n

    The following application types are supported:

    \n
      \n
    • \n

      Studio Classic: &redirect=JupyterServer\n

      \n
      • \n
    • \n

      JupyterLab: &redirect=JupyterLab\n

      \n
      • \n
    " + } } }, "traits": { @@ -20776,7 +22048,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Describes the Studio Lifecycle Configuration.

    " + "smithy.api#documentation": "

    Describes the Amazon SageMaker Studio Lifecycle Configuration.

    " } }, "com.amazonaws.sagemaker#DescribeStudioLifecycleConfigRequest": { @@ -20786,7 +22058,7 @@ "target": "com.amazonaws.sagemaker#StudioLifecycleConfigName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

    The name of the Studio Lifecycle Configuration to describe.

    ", + "smithy.api#documentation": "

    The name of the Amazon SageMaker Studio Lifecycle Configuration to describe.

    ", "smithy.api#required": {} } } @@ -20807,25 +22079,25 @@ "StudioLifecycleConfigName": { "target": "com.amazonaws.sagemaker#StudioLifecycleConfigName", "traits": { - "smithy.api#documentation": "

    The name of the Studio Lifecycle Configuration that is described.

    " + "smithy.api#documentation": "

    The name of the Amazon SageMaker Studio Lifecycle Configuration that is described.

    " } }, "CreationTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The creation time of the Studio Lifecycle Configuration.

    " + "smithy.api#documentation": "

    The creation time of the Amazon SageMaker Studio Lifecycle Configuration.

    " } }, "LastModifiedTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    This value is equivalent to CreationTime because Studio Lifecycle Configurations are immutable.

    " + "smithy.api#documentation": "

    This value is equivalent to CreationTime because Amazon SageMaker Studio Lifecycle Configurations are immutable.

    " } }, "StudioLifecycleConfigContent": { "target": "com.amazonaws.sagemaker#StudioLifecycleConfigContent", "traits": { - "smithy.api#documentation": "

    The content of your Studio Lifecycle Configuration script.

    " + "smithy.api#documentation": "

    The content of your Amazon SageMaker Studio Lifecycle Configuration script.

    " } }, "StudioLifecycleConfigAppType": { @@ -21211,6 +22483,12 @@ "traits": { "smithy.api#documentation": "

    The status of the warm pool associated with the training job.

    " } + }, + "InfraCheckConfig": { + "target": "com.amazonaws.sagemaker#InfraCheckConfig", + "traits": { + "smithy.api#documentation": "

    Contains information about the infrastructure health check configuration for the training job.

    " + } } }, "traits": { @@ -23596,6 +24874,9 @@ "com.amazonaws.sagemaker#EnableCapture": { "type": "boolean" }, + "com.amazonaws.sagemaker#EnableInfraCheck": { + "type": "boolean" + }, "com.amazonaws.sagemaker#EnableIotRoleAlias": { "type": "boolean" }, @@ -28718,6 +29999,16 @@ "smithy.api#documentation": "

    A version of a SageMaker Image. A version represents an existing container\n image.

    " } }, + "com.amazonaws.sagemaker#ImageVersionAlias": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(^\\d+$)|(^\\d+.\\d+$)|(^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$)$" + } + }, "com.amazonaws.sagemaker#ImageVersionArn": { "type": "string", "traits": { @@ -28954,6 +30245,382 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#InferenceComponentArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + } + } + }, + "com.amazonaws.sagemaker#InferenceComponentComputeResourceRequirements": { + "type": "structure", + "members": { + "NumberOfCpuCoresRequired": { + "target": "com.amazonaws.sagemaker#NumberOfCpuCores", + "traits": { + "smithy.api#documentation": "

    The number of CPU cores to allocate to run a model that you assign to an inference\n component.

    " + } + }, + "NumberOfAcceleratorDevicesRequired": { + "target": "com.amazonaws.sagemaker#NumberOfAcceleratorDevices", + "traits": { + "smithy.api#documentation": "

    The number of accelerators to allocate to run a model that you assign to an inference\n component. Accelerators include GPUs and Amazon Web Services Inferentia.

    " + } + }, + "MinMemoryRequiredInMb": { + "target": "com.amazonaws.sagemaker#MemoryInMb", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The minimum MB of memory to allocate to run a model that you assign to an inference\n component.

    ", + "smithy.api#required": {} + } + }, + "MaxMemoryRequiredInMb": { + "target": "com.amazonaws.sagemaker#MemoryInMb", + "traits": { + "smithy.api#documentation": "

    The maximum MB of memory to allocate to run a model that you assign to an inference\n component.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Defines the compute resources to allocate to run a model that you assign to an inference\n component. These resources include CPU cores, accelerators, and memory.

    " + } + }, + "com.amazonaws.sagemaker#InferenceComponentContainerSpecification": { + "type": "structure", + "members": { + "Image": { + "target": "com.amazonaws.sagemaker#ContainerImage", + "traits": { + "smithy.api#documentation": "

    The Amazon Elastic Container Registry (Amazon ECR) path where the Docker image for the model is stored.

    " + } + }, + "ArtifactUrl": { + "target": "com.amazonaws.sagemaker#Url", + "traits": { + "smithy.api#documentation": "

    The Amazon S3 path where the model artifacts, which result from model training,\n are stored. This path must point to a single gzip compressed tar archive (.tar.gz\n suffix).

    " + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#EnvironmentMap", + "traits": { + "smithy.api#documentation": "

    The environment variables to set in the Docker container. Each key and value in the\n Environment string-to-string map can have length of up to 1024. We support up to 16 entries\n in the map.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Defines a container that provides the runtime environment for a model that you deploy\n with an inference component.

    " + } + }, + "com.amazonaws.sagemaker#InferenceComponentContainerSpecificationSummary": { + "type": "structure", + "members": { + "DeployedImage": { + "target": "com.amazonaws.sagemaker#DeployedImage" + }, + "ArtifactUrl": { + "target": "com.amazonaws.sagemaker#Url", + "traits": { + "smithy.api#documentation": "

    The Amazon S3 path where the model artifacts are stored.

    " + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#EnvironmentMap", + "traits": { + "smithy.api#documentation": "

    The environment variables to set in the Docker container.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Details about the resources that are deployed with this inference component.

    " + } + }, + "com.amazonaws.sagemaker#InferenceComponentCopyCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemaker#InferenceComponentName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?$" + } + }, + "com.amazonaws.sagemaker#InferenceComponentNameContains": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.sagemaker#InferenceComponentRuntimeConfig": { + "type": "structure", + "members": { + "CopyCount": { + "target": "com.amazonaws.sagemaker#InferenceComponentCopyCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The number of runtime copies of the model container to deploy with the inference\n component. Each copy can serve inference requests.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    Runtime settings for a model that is deployed with an inference component.

    " + } + }, + "com.amazonaws.sagemaker#InferenceComponentRuntimeConfigSummary": { + "type": "structure", + "members": { + "DesiredCopyCount": { + "target": "com.amazonaws.sagemaker#InferenceComponentCopyCount", + "traits": { + "smithy.api#documentation": "

    The number of runtime copies of the model container that you requested to deploy with\n the inference component.

    " + } + }, + "CurrentCopyCount": { + "target": "com.amazonaws.sagemaker#InferenceComponentCopyCount", + "traits": { + "smithy.api#documentation": "

    The number of runtime copies of the model container that are currently deployed.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Details about the runtime settings for the model that is deployed with the inference\n component.

    " + } + }, + "com.amazonaws.sagemaker#InferenceComponentSortKey": { + "type": "enum", + "members": { + "Name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CreationTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "Status": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + } + } + }, + "com.amazonaws.sagemaker#InferenceComponentSpecification": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", + "traits": { + "smithy.api#documentation": "

    The name of an existing SageMaker model object in your account that you want to\n deploy with the inference component.

    " + } + }, + "Container": { + "target": "com.amazonaws.sagemaker#InferenceComponentContainerSpecification", + "traits": { + "smithy.api#documentation": "

    Defines a container that provides the runtime environment for a model that you deploy\n with an inference component.

    " + } + }, + "StartupParameters": { + "target": "com.amazonaws.sagemaker#InferenceComponentStartupParameters", + "traits": { + "smithy.api#documentation": "

    Settings that take effect while the model container starts up.

    " + } + }, + "ComputeResourceRequirements": { + "target": "com.amazonaws.sagemaker#InferenceComponentComputeResourceRequirements", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The compute resources allocated to run the model assigned \n to the inference component.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    Details about the resources to deploy with this inference component, including the\n model, container, and compute resources.

    " + } + }, + "com.amazonaws.sagemaker#InferenceComponentSpecificationSummary": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", + "traits": { + "smithy.api#documentation": "

    The name of the SageMaker model object that is deployed with the inference\n component.

    " + } + }, + "Container": { + "target": "com.amazonaws.sagemaker#InferenceComponentContainerSpecificationSummary", + "traits": { + "smithy.api#documentation": "

    Details about the container that provides the runtime environment for the model that is\n deployed with the inference component.

    " + } + }, + "StartupParameters": { + "target": "com.amazonaws.sagemaker#InferenceComponentStartupParameters", + "traits": { + "smithy.api#documentation": "

    Settings that take effect while the model container starts up.

    " + } + }, + "ComputeResourceRequirements": { + "target": "com.amazonaws.sagemaker#InferenceComponentComputeResourceRequirements", + "traits": { + "smithy.api#documentation": "

    The compute resources allocated to run the model assigned \n to the inference component.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Details about the resources that are deployed with this inference component.

    " + } + }, + "com.amazonaws.sagemaker#InferenceComponentStartupParameters": { + "type": "structure", + "members": { + "ModelDataDownloadTimeoutInSeconds": { + "target": "com.amazonaws.sagemaker#ProductionVariantModelDataDownloadTimeoutInSeconds", + "traits": { + "smithy.api#documentation": "

    The timeout value, in seconds, to download and extract the model that you want to host\n from Amazon S3 to the individual inference instance associated with this inference\n component.

    " + } + }, + "ContainerStartupHealthCheckTimeoutInSeconds": { + "target": "com.amazonaws.sagemaker#ProductionVariantContainerStartupHealthCheckTimeoutInSeconds", + "traits": { + "smithy.api#documentation": "

    The timeout value, in seconds, for your inference container to pass health check by\n Amazon S3 Hosting. For more information about health check, see How Your Container Should Respond to Health Check (Ping) Requests.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Settings that take effect while the model container starts up.

    " + } + }, + "com.amazonaws.sagemaker#InferenceComponentStatus": { + "type": "enum", + "members": { + "IN_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InService" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + } + } + }, + "com.amazonaws.sagemaker#InferenceComponentSummary": { + "type": "structure", + "members": { + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The time when the inference component was created.

    ", + "smithy.api#required": {} + } + }, + "InferenceComponentArn": { + "target": "com.amazonaws.sagemaker#InferenceComponentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the inference component.

    ", + "smithy.api#required": {} + } + }, + "InferenceComponentName": { + "target": "com.amazonaws.sagemaker#InferenceComponentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The name of the inference component.

    ", + "smithy.api#required": {} + } + }, + "EndpointArn": { + "target": "com.amazonaws.sagemaker#EndpointArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.

    ", + "smithy.api#required": {} + } + }, + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The name of the endpoint that hosts the inference component.

    ", + "smithy.api#required": {} + } + }, + "VariantName": { + "target": "com.amazonaws.sagemaker#VariantName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The name of the production variant that hosts the inference component.

    ", + "smithy.api#required": {} + } + }, + "InferenceComponentStatus": { + "target": "com.amazonaws.sagemaker#InferenceComponentStatus", + "traits": { + "smithy.api#documentation": "

    The status of the inference component.

    " + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The time when the inference component was last updated.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    A summary of the properties of an inference component.

    " + } + }, + "com.amazonaws.sagemaker#InferenceComponentSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#InferenceComponentSummary" + } + }, "com.amazonaws.sagemaker#InferenceExecutionConfig": { "type": "structure", "members": { @@ -29534,6 +31201,20 @@ "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" } }, + "com.amazonaws.sagemaker#InfraCheckConfig": { + "type": "structure", + "members": { + "EnableInfraCheck": { + "target": "com.amazonaws.sagemaker#EnableInfraCheck", + "traits": { + "smithy.api#documentation": "

    Enables an infrastructure health check.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Configuration information for the infrastructure health check of a training job. A SageMaker-provided health check tests the health of instance hardware and cluster network \n connectivity.

    " + } + }, "com.amazonaws.sagemaker#InitialInstanceCount": { "type": "integer", "traits": { @@ -31101,6 +32782,15 @@ "smithy.api#documentation": "

    Metadata for a Lambda step.

    " } }, + "com.amazonaws.sagemaker#LandingUri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1023 + } + } + }, "com.amazonaws.sagemaker#LastModifiedTime": { "type": "timestamp" }, @@ -32144,6 +33834,191 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#ListClusterNodes": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListClusterNodesRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListClusterNodesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

    Retrieves the list of instances (also called nodes interchangeably)\n in a SageMaker HyperPod cluster.

    " + } + }, + "com.amazonaws.sagemaker#ListClusterNodesRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve the list of nodes.

    ", + "smithy.api#required": {} + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

    A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time. Timestamps are\n formatted according to the ISO 8601 standard.

    \n

    Acceptable formats include:

    \n
      \n
    • \n

      \n YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example,\n 2014-10-01T20:30:00.000Z\n

      \n
      • \n
    • \n

      \n YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example,\n 2014-10-01T12:30:00.000-08:00\n

      \n
      • \n
    • \n

      \n YYYY-MM-DD, for example, 2014-10-01\n

      \n
      • \n
    • \n

      Unix time in seconds, for example, 1412195400. This is also referred to as Unix\n Epoch time and represents the number of seconds since midnight, January 1, 1970\n UTC.

      \n
      • \n
    \n

    For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User\n Guide.

    " + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

    A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The\n acceptable formats are the same as the timestamp formats for\n CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User\n Guide.

    " + } + }, + "InstanceGroupNameContains": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupName", + "traits": { + "smithy.api#documentation": "

    A filter that returns the instance groups whose name contain a specified string.

    " + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

    The maximum number of nodes to return in the response.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

    If the result of the previous ListClusterNodes request was truncated, the\n response includes a NextToken. To retrieve the next set of cluster nodes, use\n the token in the next request.

    " + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#ClusterSortBy", + "traits": { + "smithy.api#documentation": "

    The field by which to sort results. The default value is\n CREATION_TIME.

    " + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

    The sort order for results. The default value is Ascending.

    " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListClusterNodesResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The next token specified for listing instances in a SageMaker HyperPod cluster.

    ", + "smithy.api#required": {} + } + }, + "ClusterNodeSummaries": { + "target": "com.amazonaws.sagemaker#ClusterNodeSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The summaries of listed instances in a SageMaker HyperPod cluster

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListClusters": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListClustersRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListClustersResponse" + }, + "traits": { + "smithy.api#documentation": "

    Retrieves the list of SageMaker HyperPod clusters.

    " + } + }, + "com.amazonaws.sagemaker#ListClustersRequest": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

    Set a start time for the time range during which you want to list SageMaker HyperPod clusters.\n Timestamps are formatted according to the ISO 8601 standard.

    \n

    Acceptable formats include:

    \n
      \n
    • \n

      \n YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example,\n 2014-10-01T20:30:00.000Z\n

      \n
      • \n
    • \n

      \n YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example,\n 2014-10-01T12:30:00.000-08:00\n

      \n
      • \n
    • \n

      \n YYYY-MM-DD, for example, 2014-10-01\n

      \n
      • \n
    • \n

      Unix time in seconds, for example, 1412195400. This is also referred\n to as Unix Epoch time and represents the number of seconds since midnight, January 1,\n 1970 UTC.

      \n
      • \n
    \n

    For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User\n Guide.

    " + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

    Set an end time for the time range during which you want to list SageMaker HyperPod clusters. A\n filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable\n formats are the same as the timestamp formats for CreationTimeAfter. For more\n information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User\n Guide.

    " + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

    Set the maximum number of SageMaker HyperPod clusters to list.

    " + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "

    Set the maximum number of instances to print in the list.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

    Set the next token to retrieve the list of SageMaker HyperPod clusters.

    " + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#ClusterSortBy", + "traits": { + "smithy.api#documentation": "

    The field by which to sort results. The default value is\n CREATION_TIME.

    " + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

    The sort order for results. The default value is Ascending.

    " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListClustersResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    If the result of the previous ListClusters request was truncated, the\n response includes a NextToken. To retrieve the next set of clusters, use the\n token in the next request.

    ", + "smithy.api#required": {} + } + }, + "ClusterSummaries": { + "target": "com.amazonaws.sagemaker#ClusterSummaries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The summaries of listed SageMaker HyperPod clusters.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#ListCodeRepositories": { "type": "operation", "input": { @@ -34294,6 +36169,126 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#ListInferenceComponents": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListInferenceComponentsInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListInferenceComponentsOutput" + }, + "traits": { + "smithy.api#documentation": "

    Lists the inference components in your account and their properties.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InferenceComponents", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListInferenceComponentsInput": { + "type": "structure", + "members": { + "SortBy": { + "target": "com.amazonaws.sagemaker#InferenceComponentSortKey", + "traits": { + "smithy.api#documentation": "

    The field by which to sort the inference components in the response. The default is\n CreationTime.

    " + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#OrderKey", + "traits": { + "smithy.api#documentation": "

    The sort order for results. The default is Descending.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#PaginationToken", + "traits": { + "smithy.api#documentation": "

    A token that you use to get the next set of results following a truncated response. If\n the response to the previous request was truncated, that response provides the value for\n this token.

    " + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

    The maximum number of inference components to return in the response. This value\n defaults to 10.

    " + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#InferenceComponentNameContains", + "traits": { + "smithy.api#documentation": "

    Filters the results to only those inference components with a name that contains the\n specified string.

    " + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

    Filters the results to only those inference components that were created before the\n specified time.

    " + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

    Filters the results to only those inference components that were created after the\n specified time.

    " + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

    Filters the results to only those inference components that were updated before the\n specified time.

    " + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

    Filters the results to only those inference components that were updated after the\n specified time.

    " + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#InferenceComponentStatus", + "traits": { + "smithy.api#documentation": "

    Filters the results to only those inference components with the specified status.

    " + } + }, + "EndpointNameEquals": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#documentation": "

    An endpoint name to filter the listed inference components. The response includes only\n those inference components that are hosted at the specified endpoint.

    " + } + }, + "VariantNameEquals": { + "target": "com.amazonaws.sagemaker#VariantName", + "traits": { + "smithy.api#documentation": "

    A production variant name to filter the listed inference components. The response\n includes only those inference components that are hosted at the specified variant.

    " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListInferenceComponentsOutput": { + "type": "structure", + "members": { + "InferenceComponents": { + "target": "com.amazonaws.sagemaker#InferenceComponentSummaryList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    A list of inference components and their properties that matches any of the filters you\n specified in the request.

    ", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#PaginationToken", + "traits": { + "smithy.api#documentation": "

    The token to use in a subsequent request to get the next set of results following a\n truncated response.

    " + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#ListInferenceExperiments": { "type": "operation", "input": { @@ -37355,7 +39350,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Lists the Studio Lifecycle Configurations in your Amazon Web Services Account.

    ", + "smithy.api#documentation": "

    Lists the Amazon SageMaker Studio Lifecycle Configurations in your Amazon Web Services Account.

    ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -38400,6 +40395,39 @@ "smithy.api#pattern": "^[a-zA-Z]+ ?\\d+\\.\\d+(\\.\\d+)?$" } }, + "com.amazonaws.sagemaker#ManagedInstanceScalingMaxInstanceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#ManagedInstanceScalingMinInstanceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#ManagedInstanceScalingStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, "com.amazonaws.sagemaker#MaxAutoMLJobRuntimeInSeconds": { "type": "integer", "traits": { @@ -38619,6 +40647,14 @@ } } }, + "com.amazonaws.sagemaker#MemoryInMb": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 128 + } + } + }, "com.amazonaws.sagemaker#MetadataProperties": { "type": "structure", "members": { @@ -43262,6 +45298,22 @@ "smithy.api#pattern": "^arn:aws[a-z\\-]*:sns:[a-z0-9\\-]*:[0-9]{12}:[a-zA-Z0-9_.-]*$" } }, + "com.amazonaws.sagemaker#NumberOfAcceleratorDevices": { + "type": "float", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#NumberOfCpuCores": { + "type": "float", + "traits": { + "smithy.api#range": { + "min": 0.25 + } + } + }, "com.amazonaws.sagemaker#NumberOfHumanWorkersPerDataObject": { "type": "integer", "traits": { @@ -44190,6 +46242,18 @@ "traits": { "smithy.api#documentation": "

    The serverless configuration requested for this deployment, as specified in the endpoint configuration for the endpoint.

    " } + }, + "ManagedInstanceScaling": { + "target": "com.amazonaws.sagemaker#ProductionVariantManagedInstanceScaling", + "traits": { + "smithy.api#documentation": "

    Settings that control the range in the number of instances that the endpoint provisions\n as it scales up or down to accommodate traffic.

    " + } + }, + "RoutingConfig": { + "target": "com.amazonaws.sagemaker#ProductionVariantRoutingConfig", + "traits": { + "smithy.api#documentation": "

    Settings that control how the endpoint routes incoming traffic to the instances that the\n endpoint hosts.

    " + } } }, "traits": { @@ -45990,9 +48054,7 @@ "ModelName": { "target": "com.amazonaws.sagemaker#ModelName", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

    The name of the model that you want to host. This is the name that you specified\n when creating the model.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The name of the model that you want to host. This is the name that you specified\n when creating the model.

    " } }, "InitialInstanceCount": { @@ -46054,6 +48116,18 @@ "traits": { "smithy.api#documentation": "

    You can use this parameter to turn on native Amazon Web Services Systems Manager (SSM)\n access for a production variant behind an endpoint. By default, SSM access is disabled\n for all production variants behind an endpoint. You can turn on or turn off SSM access\n for a production variant behind an existing endpoint by creating a new endpoint\n configuration and calling UpdateEndpoint.

    " } + }, + "ManagedInstanceScaling": { + "target": "com.amazonaws.sagemaker#ProductionVariantManagedInstanceScaling", + "traits": { + "smithy.api#documentation": "

    Settings that control the range in the number of instances that the endpoint provisions\n as it scales up or down to accommodate traffic.

    " + } + }, + "RoutingConfig": { + "target": "com.amazonaws.sagemaker#ProductionVariantRoutingConfig", + "traits": { + "smithy.api#documentation": "

    Settings that control how the endpoint routes incoming traffic to the instances that the\n endpoint hosts.

    " + } } }, "traits": { @@ -47037,6 +49111,32 @@ } } }, + "com.amazonaws.sagemaker#ProductionVariantManagedInstanceScaling": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.sagemaker#ManagedInstanceScalingStatus", + "traits": { + "smithy.api#documentation": "

    Indicates whether managed instance scaling is enabled.

    " + } + }, + "MinInstanceCount": { + "target": "com.amazonaws.sagemaker#ManagedInstanceScalingMinInstanceCount", + "traits": { + "smithy.api#documentation": "

    The minimum number of instances that the endpoint must retain when it scales down to\n accommodate a decrease in traffic.

    " + } + }, + "MaxInstanceCount": { + "target": "com.amazonaws.sagemaker#ManagedInstanceScalingMaxInstanceCount", + "traits": { + "smithy.api#documentation": "

    The maximum number of instances that the endpoint can provision when it scales up to\n accommodate an increase in traffic.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Settings that control the range in the number of instances that the endpoint provisions\n as it scales up or down to accommodate traffic.

    " + } + }, "com.amazonaws.sagemaker#ProductionVariantModelDataDownloadTimeoutInSeconds": { "type": "integer", "traits": { @@ -47046,6 +49146,22 @@ } } }, + "com.amazonaws.sagemaker#ProductionVariantRoutingConfig": { + "type": "structure", + "members": { + "RoutingStrategy": { + "target": "com.amazonaws.sagemaker#RoutingStrategy", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    Sets how the endpoint routes incoming traffic:

    \n
      \n
    • \n

      \n LEAST_OUTSTANDING_REQUESTS: The endpoint routes requests to the\n specific instances that have more capacity to process them.

      \n
      • \n
    • \n

      \n RANDOM: The endpoint routes each request to a randomly chosen\n instance.

      \n
      • \n
    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    Settings that control how the endpoint routes incoming traffic to the instances that the\n endpoint hosts.

    " + } + }, "com.amazonaws.sagemaker#ProductionVariantSSMAccess": { "type": "boolean" }, @@ -47197,6 +49313,18 @@ "traits": { "smithy.api#documentation": "

    The serverless configuration requested for the endpoint update.

    " } + }, + "ManagedInstanceScaling": { + "target": "com.amazonaws.sagemaker#ProductionVariantManagedInstanceScaling", + "traits": { + "smithy.api#documentation": "

    Settings that control the range in the number of instances that the endpoint provisions\n as it scales up or down to accommodate traffic.

    " + } + }, + "RoutingConfig": { + "target": "com.amazonaws.sagemaker#ProductionVariantRoutingConfig", + "traits": { + "smithy.api#documentation": "

    Settings that control how the endpoint routes incoming traffic to the instances that the\n endpoint hosts.

    " + } } }, "traits": { @@ -49711,6 +51839,12 @@ "smithy.api#documentation": "

    The ARN of the image version created on the instance.

    " } }, + "SageMakerImageVersionAlias": { + "target": "com.amazonaws.sagemaker#ImageVersionAlias", + "traits": { + "smithy.api#documentation": "

    The SageMakerImageVersionAlias.

    " + } + }, "InstanceType": { "target": "com.amazonaws.sagemaker#AppInstanceType", "traits": { @@ -50017,6 +52151,23 @@ } } }, + "com.amazonaws.sagemaker#RoutingStrategy": { + "type": "enum", + "members": { + "LEAST_OUTSTANDING_REQUESTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LEAST_OUTSTANDING_REQUESTS" + } + }, + "RANDOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RANDOM" + } + } + } + }, "com.amazonaws.sagemaker#RuleConfigurationName": { "type": "string", "traits": { @@ -50315,6 +52466,9 @@ { "target": "com.amazonaws.sagemaker#CreateAutoMLJobV2" }, + { + "target": "com.amazonaws.sagemaker#CreateCluster" + }, { "target": "com.amazonaws.sagemaker#CreateCodeRepository" }, @@ -50372,6 +52526,9 @@ { "target": "com.amazonaws.sagemaker#CreateImageVersion" }, + { + "target": "com.amazonaws.sagemaker#CreateInferenceComponent" + }, { "target": "com.amazonaws.sagemaker#CreateInferenceExperiment" }, @@ -50474,6 +52631,9 @@ { "target": "com.amazonaws.sagemaker#DeleteAssociation" }, + { + "target": "com.amazonaws.sagemaker#DeleteCluster" + }, { "target": "com.amazonaws.sagemaker#DeleteCodeRepository" }, @@ -50525,6 +52685,9 @@ { "target": "com.amazonaws.sagemaker#DeleteImageVersion" }, + { + "target": "com.amazonaws.sagemaker#DeleteInferenceComponent" + }, { "target": "com.amazonaws.sagemaker#DeleteInferenceExperiment" }, @@ -50615,6 +52778,12 @@ { "target": "com.amazonaws.sagemaker#DescribeAutoMLJobV2" }, + { + "target": "com.amazonaws.sagemaker#DescribeCluster" + }, + { + "target": "com.amazonaws.sagemaker#DescribeClusterNode" + }, { "target": "com.amazonaws.sagemaker#DescribeCodeRepository" }, @@ -50678,6 +52847,9 @@ { "target": "com.amazonaws.sagemaker#DescribeImageVersion" }, + { + "target": "com.amazonaws.sagemaker#DescribeInferenceComponent" + }, { "target": "com.amazonaws.sagemaker#DescribeInferenceExperiment" }, @@ -50825,6 +52997,12 @@ { "target": "com.amazonaws.sagemaker#ListCandidatesForAutoMLJob" }, + { + "target": "com.amazonaws.sagemaker#ListClusterNodes" + }, + { + "target": "com.amazonaws.sagemaker#ListClusters" + }, { "target": "com.amazonaws.sagemaker#ListCodeRepositories" }, @@ -50888,6 +53066,9 @@ { "target": "com.amazonaws.sagemaker#ListImageVersions" }, + { + "target": "com.amazonaws.sagemaker#ListInferenceComponents" + }, { "target": "com.amazonaws.sagemaker#ListInferenceExperiments" }, @@ -51104,6 +53285,9 @@ { "target": "com.amazonaws.sagemaker#UpdateArtifact" }, + { + "target": "com.amazonaws.sagemaker#UpdateCluster" + }, { "target": "com.amazonaws.sagemaker#UpdateCodeRepository" }, @@ -51143,6 +53327,12 @@ { "target": "com.amazonaws.sagemaker#UpdateImageVersion" }, + { + "target": "com.amazonaws.sagemaker#UpdateInferenceComponent" + }, + { + "target": "com.amazonaws.sagemaker#UpdateInferenceComponentRuntimeConfig" + }, { "target": "com.amazonaws.sagemaker#UpdateInferenceExperiment" }, @@ -53213,7 +55403,7 @@ } }, "traits": { - "smithy.api#documentation": "

    Specifies options for sharing SageMaker Studio notebooks. These settings are\n specified as part of DefaultUserSettings when the CreateDomain\n API is called, and as part of UserSettings when the CreateUserProfile\n API is called. When SharingSettings is not specified, notebook sharing\n isn't allowed.

    " + "smithy.api#documentation": "

    Specifies options for sharing Amazon SageMaker Studio notebooks. These settings are\n specified as part of DefaultUserSettings when the CreateDomain\n API is called, and as part of UserSettings when the CreateUserProfile\n API is called. When SharingSettings is not specified, notebook sharing\n isn't allowed.

    " } }, "com.amazonaws.sagemaker#ShuffleConfig": { @@ -54931,19 +57121,19 @@ "StudioLifecycleConfigName": { "target": "com.amazonaws.sagemaker#StudioLifecycleConfigName", "traits": { - "smithy.api#documentation": "

    The name of the Studio Lifecycle Configuration.

    " + "smithy.api#documentation": "

    The name of the Amazon SageMaker Studio Lifecycle Configuration.

    " } }, "CreationTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The creation time of the Studio Lifecycle Configuration.

    " + "smithy.api#documentation": "

    The creation time of the Amazon SageMaker Studio Lifecycle Configuration.

    " } }, "LastModifiedTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    This value is equivalent to CreationTime because Studio Lifecycle Configurations are immutable.

    " + "smithy.api#documentation": "

    This value is equivalent to CreationTime because Amazon SageMaker Studio Lifecycle Configurations are immutable.

    " } }, "StudioLifecycleConfigAppType": { @@ -54954,7 +57144,7 @@ } }, "traits": { - "smithy.api#documentation": "

    Details of the Studio Lifecycle Configuration.

    " + "smithy.api#documentation": "

    Details of the Amazon SageMaker Studio Lifecycle Configuration.

    " } }, "com.amazonaws.sagemaker#StudioLifecycleConfigName": { @@ -54996,6 +57186,23 @@ "target": "com.amazonaws.sagemaker#StudioLifecycleConfigDetails" } }, + "com.amazonaws.sagemaker#StudioWebPortal": { + "type": "enum", + "members": { + "Enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "Disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, "com.amazonaws.sagemaker#SubnetId": { "type": "string", "traits": { @@ -55803,16 +58010,60 @@ "smithy.api#documentation": "

    The collection of settings used by an AutoML job V2 for the text classification problem\n type.

    " } }, + "com.amazonaws.sagemaker#TextGenerationHyperParameterKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._-]+$" + } + }, + "com.amazonaws.sagemaker#TextGenerationHyperParameterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 16 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._-]+$" + } + }, + "com.amazonaws.sagemaker#TextGenerationHyperParameters": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#TextGenerationHyperParameterKey" + }, + "value": { + "target": "com.amazonaws.sagemaker#TextGenerationHyperParameterValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 30 + } + } + }, "com.amazonaws.sagemaker#TextGenerationJobConfig": { "type": "structure", "members": { "CompletionCriteria": { - "target": "com.amazonaws.sagemaker#AutoMLJobCompletionCriteria" + "target": "com.amazonaws.sagemaker#AutoMLJobCompletionCriteria", + "traits": { + "smithy.api#documentation": "

    How long a fine-tuning job is allowed to run. For TextGenerationJobConfig\n problem types, the MaxRuntimePerTrainingJobInSeconds attribute of AutoMLJobCompletionCriteria defaults to 72h\n (259200s).

    " + } }, "BaseModelName": { "target": "com.amazonaws.sagemaker#BaseModelName", "traits": { - "smithy.api#documentation": "

    The name of the base model to fine-tune. Autopilot supports fine-tuning a variety of large\n language models. For information on the list of supported models, see Text generation models supporting fine-tuning in Autopilot. If no\n BaseModelName is provided, the default model used is Falcon-7B-Instruct.\n

    " + "smithy.api#documentation": "

    The name of the base model to fine-tune. Autopilot supports fine-tuning a variety of large\n language models. For information on the list of supported models, see Text generation models supporting fine-tuning in Autopilot. If no\n BaseModelName is provided, the default model used is Falcon7BInstruct.

    " + } + }, + "TextGenerationHyperParameters": { + "target": "com.amazonaws.sagemaker#TextGenerationHyperParameters", + "traits": { + "smithy.api#documentation": "

    The hyperparameters used to configure and optimize the learning process of the base\n model. You can set any combination of the following hyperparameters for all base models.\n For more information on each supported hyperparameter, see Optimize\n the learning process of your text generation models with hyperparameters.

    \n
      \n
    • \n

      \n \"epochCount\": The number of times the model goes through the entire\n training dataset. Its value should be a string containing an integer value within the\n range of \"1\" to \"10\".

      \n
      • \n
    • \n

      \n \"batchSize\": The number of data samples used in each iteration of\n training. Its value should be a string containing an integer value within the range\n of \"1\" to \"64\".

      \n
      • \n
    • \n

      \n \"learningRate\": The step size at which a model's parameters are\n updated during training. Its value should be a string containing a floating-point\n value within the range of \"0\" to \"1\".

      \n
      • \n
    • \n

      \n \"learningRateWarmupSteps\": The number of training steps during which\n the learning rate gradually increases before reaching its target or maximum value.\n Its value should be a string containing an integer value within the range of \"0\" to\n \"250\".

      \n
      • \n
    \n

    Here is an example where all four hyperparameters are configured.

    \n

    \n { \"epochCount\":\"5\", \"learningRate\":\"0.5\", \"batchSize\": \"32\",\n \"learningRateWarmupSteps\": \"10\" }\n

    " } } }, @@ -58974,6 +61225,69 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#UpdateCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateClusterRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

    Update a SageMaker HyperPod cluster.

    " + } + }, + "com.amazonaws.sagemaker#UpdateClusterRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    Specify the name of the SageMaker HyperPod cluster you want to update.

    ", + "smithy.api#required": {} + } + }, + "InstanceGroups": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupSpecifications", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    Specify the instance groups to update.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateClusterResponse": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the updated SageMaker HyperPod cluster.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#UpdateCodeRepository": { "type": "operation", "input": { @@ -59244,6 +61558,18 @@ "traits": { "smithy.api#documentation": "

    The entity that creates and manages the required security groups for inter-app\n communication in VPCOnly mode. Required when\n CreateDomain.AppNetworkAccessType is VPCOnly and\n DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is\n provided. If setting up the domain for use with RStudio, this value must be set to\n Service.

    " } + }, + "SubnetIds": { + "target": "com.amazonaws.sagemaker#Subnets", + "traits": { + "smithy.api#documentation": "

    The VPC subnets that Studio uses for communication.

    \n

    If removing subnets, ensure there are no apps in the InService,\n Pending, or Deleting state.

    " + } + }, + "AppNetworkAccessType": { + "target": "com.amazonaws.sagemaker#AppNetworkAccessType", + "traits": { + "smithy.api#documentation": "

    Specifies the VPC used for non-EFS traffic.

    \n
      \n
    • \n

      \n PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker,\n which allows direct internet access.

      \n
      • \n
    • \n

      \n VpcOnly - All Studio traffic is through the specified VPC and subnets.

      \n
      • \n
    \n

    This configuration can only be modified if there are no apps in the InService,\n Pending, or Deleting state. The configuration cannot be updated if\n DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is already set\n or DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided\n as part of the same request.

    " + } } }, "traits": { @@ -59841,6 +62167,124 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#UpdateInferenceComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateInferenceComponentInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateInferenceComponentOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

    Updates an inference component.

    " + } + }, + "com.amazonaws.sagemaker#UpdateInferenceComponentInput": { + "type": "structure", + "members": { + "InferenceComponentName": { + "target": "com.amazonaws.sagemaker#InferenceComponentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The name of the inference component.

    ", + "smithy.api#required": {} + } + }, + "Specification": { + "target": "com.amazonaws.sagemaker#InferenceComponentSpecification", + "traits": { + "smithy.api#documentation": "

    Details about the resources to deploy with this inference component, including the\n model, container, and compute resources.

    " + } + }, + "RuntimeConfig": { + "target": "com.amazonaws.sagemaker#InferenceComponentRuntimeConfig", + "traits": { + "smithy.api#documentation": "

    Runtime settings for a model that is deployed with an inference component.

    " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateInferenceComponentOutput": { + "type": "structure", + "members": { + "InferenceComponentArn": { + "target": "com.amazonaws.sagemaker#InferenceComponentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the inference component.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#UpdateInferenceComponentRuntimeConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateInferenceComponentRuntimeConfigInput" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateInferenceComponentRuntimeConfigOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

    Runtime settings for a model that is deployed with an inference component.

    " + } + }, + "com.amazonaws.sagemaker#UpdateInferenceComponentRuntimeConfigInput": { + "type": "structure", + "members": { + "InferenceComponentName": { + "target": "com.amazonaws.sagemaker#InferenceComponentName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The name of the inference component to update.

    ", + "smithy.api#required": {} + } + }, + "DesiredRuntimeConfig": { + "target": "com.amazonaws.sagemaker#InferenceComponentRuntimeConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    Runtime settings for a model that is deployed with an inference component.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateInferenceComponentRuntimeConfigOutput": { + "type": "structure", + "members": { + "InferenceComponentArn": { + "target": "com.amazonaws.sagemaker#InferenceComponentArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the inference component.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#UpdateInferenceExperiment": { "type": "operation", "input": { @@ -61269,13 +63713,13 @@ "SecurityGroups": { "target": "com.amazonaws.sagemaker#SecurityGroupIds", "traits": { - "smithy.api#documentation": "

    The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

    \n

    Optional when the CreateDomain.AppNetworkAccessType parameter is set to\n PublicInternetOnly.

    \n

    Required when the CreateDomain.AppNetworkAccessType parameter is set to\n VpcOnly, unless specified as part of the DefaultUserSettings for the domain.

    \n

    Amazon SageMaker adds a security group to allow NFS traffic from SageMaker Studio. Therefore, the\n number of security groups that you can specify is one less than the maximum number shown.

    " + "smithy.api#documentation": "

    The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

    \n

    Optional when the CreateDomain.AppNetworkAccessType parameter is set to\n PublicInternetOnly.

    \n

    Required when the CreateDomain.AppNetworkAccessType parameter is set to\n VpcOnly, unless specified as part of the DefaultUserSettings for the domain.

    \n

    Amazon SageMaker adds a security group to allow NFS traffic from Amazon SageMaker Studio. Therefore, the\n number of security groups that you can specify is one less than the maximum number shown.

    " } }, "SharingSettings": { "target": "com.amazonaws.sagemaker#SharingSettings", "traits": { - "smithy.api#documentation": "

    Specifies options for sharing SageMaker Studio notebooks.

    " + "smithy.api#documentation": "

    Specifies options for sharing Amazon SageMaker Studio notebooks.

    " } }, "JupyterServerAppSettings": { @@ -61313,10 +63757,22 @@ "traits": { "smithy.api#documentation": "

    The Canvas app settings.

    " } + }, + "DefaultLandingUri": { + "target": "com.amazonaws.sagemaker#LandingUri", + "traits": { + "smithy.api#documentation": "

    The default experience that the user is directed to when accessing the domain. The supported values are:

    \n
      \n
    • \n

      \n studio::: Indicates that Studio is the default experience. This value can only be passed if StudioWebPortal is set to ENABLED.

      \n
      • \n
    • \n

      \n app:JupyterServer:: Indicates that Studio Classic is the default experience.

      \n
      • \n
    " + } + }, + "StudioWebPortal": { + "target": "com.amazonaws.sagemaker#StudioWebPortal", + "traits": { + "smithy.api#documentation": "

    Whether the user can access Studio. If this value is set to DISABLED, the user cannot access Studio, even if that is the default experience for the domain.

    " + } } }, "traits": { - "smithy.api#documentation": "

    A collection of settings that apply to users of Amazon SageMaker Studio. These settings are\n specified when the CreateUserProfile API is called, and as DefaultUserSettings\n when the CreateDomain API is called.

    \n

    \n SecurityGroups is aggregated when specified in both calls. For all other\n settings in UserSettings, the values specified in CreateUserProfile\n take precedence over those specified in CreateDomain.

    " + "smithy.api#documentation": "

    A collection of settings that apply to users in a domain. These settings are\n specified when the CreateUserProfile API is called, and as DefaultUserSettings\n when the CreateDomain API is called.

    \n

    \n SecurityGroups is aggregated when specified in both calls. For all other\n settings in UserSettings, the values specified in CreateUserProfile\n take precedence over those specified in CreateDomain.

    " } }, "com.amazonaws.sagemaker#UsersPerStep": { @@ -61579,7 +64035,7 @@ "target": "com.amazonaws.sagemaker#VpcSecurityGroupIds", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

    The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for\n the VPC that is specified in the Subnets field.

    ", + "smithy.api#documentation": "

    The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security\n groups for the VPC that is specified in the Subnets field.

    ", "smithy.api#required": {} } }, @@ -61593,7 +64049,7 @@ } }, "traits": { - "smithy.api#documentation": "

    Specifies a VPC that your training jobs and hosted models have access to. Control\n access to and from your training and model containers by configuring the VPC. For more\n information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Training Jobs\n by Using an Amazon Virtual Private Cloud.

    " + "smithy.api#documentation": "

    Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources\n have access to. You can control access to and from your resources by configuring a VPC.\n For more information, see Give SageMaker Access to Resources in your Amazon VPC.

    " } }, "com.amazonaws.sagemaker#VpcId": {