@aws-sdk/client-sagemaker 3.806.0 → 3.808.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -16
- package/dist-cjs/index.js +26 -26
- package/dist-es/waiters/waitForEndpointDeleted.js +2 -2
- package/dist-es/waiters/waitForEndpointInService.js +2 -2
- package/dist-es/waiters/waitForImageCreated.js +2 -2
- package/dist-es/waiters/waitForImageDeleted.js +2 -2
- package/dist-es/waiters/waitForImageUpdated.js +2 -2
- package/dist-es/waiters/waitForImageVersionCreated.js +2 -2
- package/dist-es/waiters/waitForImageVersionDeleted.js +2 -2
- package/dist-es/waiters/waitForNotebookInstanceDeleted.js +2 -2
- package/dist-es/waiters/waitForNotebookInstanceInService.js +2 -2
- package/dist-es/waiters/waitForNotebookInstanceStopped.js +2 -2
- package/dist-es/waiters/waitForProcessingJobCompletedOrStopped.js +2 -2
- package/dist-es/waiters/waitForTrainingJobCompletedOrStopped.js +2 -2
- package/dist-es/waiters/waitForTransformJobCompletedOrStopped.js +2 -2
- package/dist-types/SageMaker.d.ts +1 -16
- package/dist-types/SageMakerClient.d.ts +1 -16
- package/dist-types/commands/AddAssociationCommand.d.ts +2 -7
- package/dist-types/commands/AddTagsCommand.d.ts +1 -26
- package/dist-types/commands/AssociateTrialComponentCommand.d.ts +2 -4
- package/dist-types/commands/BatchDeleteClusterNodesCommand.d.ts +1 -17
- package/dist-types/commands/CreateActionCommand.d.ts +2 -7
- package/dist-types/commands/CreateAppCommand.d.ts +2 -6
- package/dist-types/commands/CreateAppImageConfigCommand.d.ts +1 -3
- package/dist-types/commands/CreateArtifactCommand.d.ts +2 -7
- package/dist-types/commands/CreateAutoMLJobCommand.d.ts +2 -26
- package/dist-types/commands/CreateAutoMLJobV2Command.d.ts +2 -33
- package/dist-types/commands/CreateClusterCommand.d.ts +2 -6
- package/dist-types/commands/CreateClusterSchedulerConfigCommand.d.ts +3 -7
- package/dist-types/commands/CreateCodeRepositoryCommand.d.ts +1 -7
- package/dist-types/commands/CreateCompilationJobCommand.d.ts +2 -33
- package/dist-types/commands/CreateComputeQuotaCommand.d.ts +3 -7
- package/dist-types/commands/CreateContextCommand.d.ts +2 -7
- package/dist-types/commands/CreateDataQualityJobDefinitionCommand.d.ts +2 -5
- package/dist-types/commands/CreateDeviceFleetCommand.d.ts +1 -2
- package/dist-types/commands/CreateDomainCommand.d.ts +2 -46
- package/dist-types/commands/CreateEdgeDeploymentPlanCommand.d.ts +2 -4
- package/dist-types/commands/CreateEdgeDeploymentStageCommand.d.ts +1 -2
- package/dist-types/commands/CreateEdgePackagingJobCommand.d.ts +1 -2
- package/dist-types/commands/CreateEndpointCommand.d.ts +2 -77
- package/dist-types/commands/CreateEndpointConfigCommand.d.ts +2 -33
- package/dist-types/commands/CreateExperimentCommand.d.ts +2 -22
- package/dist-types/commands/CreateFeatureGroupCommand.d.ts +2 -20
- package/dist-types/commands/CreateFlowDefinitionCommand.d.ts +1 -2
- package/dist-types/commands/CreateHubCommand.d.ts +1 -2
- package/dist-types/commands/CreateHubContentReferenceCommand.d.ts +1 -2
- package/dist-types/commands/CreateHumanTaskUiCommand.d.ts +1 -2
- package/dist-types/commands/CreateHyperParameterTuningJobCommand.d.ts +2 -18
- package/dist-types/commands/CreateImageCommand.d.ts +2 -5
- package/dist-types/commands/CreateImageVersionCommand.d.ts +2 -4
- package/dist-types/commands/CreateInferenceComponentCommand.d.ts +2 -10
- package/dist-types/commands/CreateInferenceExperimentCommand.d.ts +2 -17
- package/dist-types/commands/CreateInferenceRecommendationsJobCommand.d.ts +2 -4
- package/dist-types/commands/CreateLabelingJobCommand.d.ts +2 -40
- package/dist-types/commands/CreateMlflowTrackingServerCommand.d.ts +2 -5
- package/dist-types/commands/CreateModelBiasJobDefinitionCommand.d.ts +1 -2
- package/dist-types/commands/CreateModelCardCommand.d.ts +3 -6
- package/dist-types/commands/CreateModelCardExportJobCommand.d.ts +2 -4
- package/dist-types/commands/CreateModelCommand.d.ts +2 -19
- package/dist-types/commands/CreateModelExplainabilityJobDefinitionCommand.d.ts +1 -2
- package/dist-types/commands/CreateModelPackageCommand.d.ts +3 -24
- package/dist-types/commands/CreateModelPackageGroupCommand.d.ts +1 -2
- package/dist-types/commands/CreateModelQualityJobDefinitionCommand.d.ts +2 -5
- package/dist-types/commands/CreateMonitoringScheduleCommand.d.ts +2 -4
- package/dist-types/commands/CreateNotebookInstanceCommand.d.ts +2 -38
- package/dist-types/commands/CreateNotebookInstanceLifecycleConfigCommand.d.ts +2 -16
- package/dist-types/commands/CreateOptimizationJobCommand.d.ts +2 -8
- package/dist-types/commands/CreatePartnerAppCommand.d.ts +2 -4
- package/dist-types/commands/CreatePipelineCommand.d.ts +2 -4
- package/dist-types/commands/CreatePresignedDomainUrlCommand.d.ts +1 -26
- package/dist-types/commands/CreatePresignedMlflowTrackingServerUrlCommand.d.ts +1 -2
- package/dist-types/commands/CreatePresignedNotebookInstanceUrlCommand.d.ts +1 -18
- package/dist-types/commands/CreateProcessingJobCommand.d.ts +1 -2
- package/dist-types/commands/CreateProjectCommand.d.ts +2 -4
- package/dist-types/commands/CreateSpaceCommand.d.ts +1 -2
- package/dist-types/commands/CreateTrainingJobCommand.d.ts +2 -88
- package/dist-types/commands/CreateTrainingPlanCommand.d.ts +2 -63
- package/dist-types/commands/CreateTransformJobCommand.d.ts +2 -37
- package/dist-types/commands/CreateTrialCommand.d.ts +2 -13
- package/dist-types/commands/CreateTrialComponentCommand.d.ts +2 -12
- package/dist-types/commands/CreateUserProfileCommand.d.ts +2 -9
- package/dist-types/commands/CreateWorkforceCommand.d.ts +1 -18
- package/dist-types/commands/CreateWorkteamCommand.d.ts +2 -6
- package/dist-types/commands/DeleteAlgorithmCommand.d.ts +1 -2
- package/dist-types/commands/DeleteArtifactCommand.d.ts +1 -2
- package/dist-types/commands/DeleteClusterCommand.d.ts +1 -2
- package/dist-types/commands/DeleteCompilationJobCommand.d.ts +1 -8
- package/dist-types/commands/DeleteDomainCommand.d.ts +1 -4
- package/dist-types/commands/DeleteEdgeDeploymentPlanCommand.d.ts +1 -2
- package/dist-types/commands/DeleteEdgeDeploymentStageCommand.d.ts +1 -2
- package/dist-types/commands/DeleteEndpointCommand.d.ts +1 -11
- package/dist-types/commands/DeleteEndpointConfigCommand.d.ts +1 -9
- package/dist-types/commands/DeleteExperimentCommand.d.ts +1 -3
- package/dist-types/commands/DeleteFeatureGroupCommand.d.ts +1 -8
- package/dist-types/commands/DeleteHumanTaskUiCommand.d.ts +1 -5
- package/dist-types/commands/DeleteHyperParameterTuningJobCommand.d.ts +1 -4
- package/dist-types/commands/DeleteImageCommand.d.ts +1 -2
- package/dist-types/commands/DeleteImageVersionCommand.d.ts +1 -2
- package/dist-types/commands/DeleteInferenceExperimentCommand.d.ts +2 -9
- package/dist-types/commands/DeleteModelCardCommand.d.ts +1 -2
- package/dist-types/commands/DeleteModelCommand.d.ts +1 -4
- package/dist-types/commands/DeleteModelPackageCommand.d.ts +2 -6
- package/dist-types/commands/DeleteModelPackageGroupCommand.d.ts +1 -2
- package/dist-types/commands/DeleteMonitoringScheduleCommand.d.ts +1 -2
- package/dist-types/commands/DeleteNotebookInstanceCommand.d.ts +1 -6
- package/dist-types/commands/DeletePartnerAppCommand.d.ts +1 -2
- package/dist-types/commands/DeletePipelineCommand.d.ts +2 -6
- package/dist-types/commands/DeleteProjectCommand.d.ts +1 -2
- package/dist-types/commands/DeleteStudioLifecycleConfigCommand.d.ts +1 -4
- package/dist-types/commands/DeleteTagsCommand.d.ts +1 -12
- package/dist-types/commands/DeleteTrialCommand.d.ts +1 -3
- package/dist-types/commands/DeleteTrialComponentCommand.d.ts +1 -3
- package/dist-types/commands/DeleteUserProfileCommand.d.ts +1 -2
- package/dist-types/commands/DeleteWorkforceCommand.d.ts +1 -12
- package/dist-types/commands/DeleteWorkteamCommand.d.ts +1 -2
- package/dist-types/commands/DescribeAutoMLJobCommand.d.ts +1 -5
- package/dist-types/commands/DescribeAutoMLJobV2Command.d.ts +1 -2
- package/dist-types/commands/DescribeClusterNodeCommand.d.ts +1 -2
- package/dist-types/commands/DescribeClusterSchedulerConfigCommand.d.ts +1 -3
- package/dist-types/commands/DescribeCompilationJobCommand.d.ts +1 -3
- package/dist-types/commands/DescribeEndpointConfigCommand.d.ts +1 -2
- package/dist-types/commands/DescribeFeatureGroupCommand.d.ts +1 -3
- package/dist-types/commands/DescribeHyperParameterTuningJobCommand.d.ts +1 -3
- package/dist-types/commands/DescribeInferenceRecommendationsJobCommand.d.ts +1 -2
- package/dist-types/commands/DescribeLineageGroupCommand.d.ts +1 -3
- package/dist-types/commands/DescribeModelCommand.d.ts +1 -2
- package/dist-types/commands/DescribeModelPackageCommand.d.ts +1 -8
- package/dist-types/commands/DescribeNotebookInstanceLifecycleConfigCommand.d.ts +1 -3
- package/dist-types/commands/DescribeSubscribedWorkteamCommand.d.ts +1 -2
- package/dist-types/commands/DescribeTrainingJobCommand.d.ts +1 -7
- package/dist-types/commands/DescribeUserProfileCommand.d.ts +1 -2
- package/dist-types/commands/DescribeWorkforceCommand.d.ts +1 -6
- package/dist-types/commands/DescribeWorkteamCommand.d.ts +1 -3
- package/dist-types/commands/DisableSagemakerServicecatalogPortfolioCommand.d.ts +1 -2
- package/dist-types/commands/DisassociateTrialComponentCommand.d.ts +1 -6
- package/dist-types/commands/EnableSagemakerServicecatalogPortfolioCommand.d.ts +1 -2
- package/dist-types/commands/GetModelPackageGroupPolicyCommand.d.ts +1 -4
- package/dist-types/commands/GetSagemakerServicecatalogPortfolioStatusCommand.d.ts +1 -2
- package/dist-types/commands/GetScalingConfigurationRecommendationCommand.d.ts +1 -2
- package/dist-types/commands/GetSearchSuggestionsCommand.d.ts +1 -4
- package/dist-types/commands/ImportHubContentCommand.d.ts +1 -2
- package/dist-types/commands/ListAppImageConfigsCommand.d.ts +1 -3
- package/dist-types/commands/ListClusterNodesCommand.d.ts +1 -2
- package/dist-types/commands/ListCompilationJobsCommand.d.ts +1 -3
- package/dist-types/commands/ListExperimentsCommand.d.ts +1 -3
- package/dist-types/commands/ListHyperParameterTuningJobsCommand.d.ts +1 -3
- package/dist-types/commands/ListImageVersionsCommand.d.ts +1 -2
- package/dist-types/commands/ListImagesCommand.d.ts +1 -2
- package/dist-types/commands/ListInferenceRecommendationsJobStepsCommand.d.ts +1 -2
- package/dist-types/commands/ListLineageGroupsCommand.d.ts +1 -3
- package/dist-types/commands/ListModelMetadataCommand.d.ts +1 -2
- package/dist-types/commands/ListNotebookInstancesCommand.d.ts +1 -2
- package/dist-types/commands/ListResourceCatalogsCommand.d.ts +1 -2
- package/dist-types/commands/ListStageDevicesCommand.d.ts +1 -2
- package/dist-types/commands/ListStudioLifecycleConfigsCommand.d.ts +1 -2
- package/dist-types/commands/ListSubscribedWorkteamsCommand.d.ts +1 -3
- package/dist-types/commands/ListTrainingJobsCommand.d.ts +1 -22
- package/dist-types/commands/ListTrainingJobsForHyperParameterTuningJobCommand.d.ts +1 -2
- package/dist-types/commands/ListTrialComponentsCommand.d.ts +1 -20
- package/dist-types/commands/ListTrialsCommand.d.ts +1 -5
- package/dist-types/commands/ListWorkforcesCommand.d.ts +1 -2
- package/dist-types/commands/ListWorkteamsCommand.d.ts +1 -3
- package/dist-types/commands/PutModelPackageGroupPolicyCommand.d.ts +2 -6
- package/dist-types/commands/QueryLineageCommand.d.ts +1 -3
- package/dist-types/commands/RegisterDevicesCommand.d.ts +1 -2
- package/dist-types/commands/RetryPipelineExecutionCommand.d.ts +2 -4
- package/dist-types/commands/SearchCommand.d.ts +1 -10
- package/dist-types/commands/SearchTrainingPlanOfferingsCommand.d.ts +2 -17
- package/dist-types/commands/SendPipelineExecutionStepFailureCommand.d.ts +3 -7
- package/dist-types/commands/SendPipelineExecutionStepSuccessCommand.d.ts +3 -7
- package/dist-types/commands/StartInferenceExperimentCommand.d.ts +1 -2
- package/dist-types/commands/StartMlflowTrackingServerCommand.d.ts +1 -2
- package/dist-types/commands/StartMonitoringScheduleCommand.d.ts +1 -5
- package/dist-types/commands/StartNotebookInstanceCommand.d.ts +2 -6
- package/dist-types/commands/StartPipelineExecutionCommand.d.ts +2 -4
- package/dist-types/commands/StopCompilationJobCommand.d.ts +1 -7
- package/dist-types/commands/StopHyperParameterTuningJobCommand.d.ts +1 -7
- package/dist-types/commands/StopInferenceExperimentCommand.d.ts +1 -2
- package/dist-types/commands/StopLabelingJobCommand.d.ts +1 -2
- package/dist-types/commands/StopMlflowTrackingServerCommand.d.ts +1 -2
- package/dist-types/commands/StopNotebookInstanceCommand.d.ts +1 -8
- package/dist-types/commands/StopPipelineExecutionCommand.d.ts +2 -25
- package/dist-types/commands/StopTrainingJobCommand.d.ts +1 -7
- package/dist-types/commands/StopTransformJobCommand.d.ts +1 -6
- package/dist-types/commands/UpdateActionCommand.d.ts +1 -2
- package/dist-types/commands/UpdateArtifactCommand.d.ts +1 -2
- package/dist-types/commands/UpdateClusterCommand.d.ts +2 -4
- package/dist-types/commands/UpdateClusterSchedulerConfigCommand.d.ts +2 -4
- package/dist-types/commands/UpdateClusterSoftwareCommand.d.ts +2 -9
- package/dist-types/commands/UpdateCodeRepositoryCommand.d.ts +1 -2
- package/dist-types/commands/UpdateComputeQuotaCommand.d.ts +2 -4
- package/dist-types/commands/UpdateContextCommand.d.ts +1 -2
- package/dist-types/commands/UpdateDomainCommand.d.ts +1 -2
- package/dist-types/commands/UpdateEndpointCommand.d.ts +2 -22
- package/dist-types/commands/UpdateEndpointWeightsAndCapacitiesCommand.d.ts +2 -7
- package/dist-types/commands/UpdateExperimentCommand.d.ts +2 -4
- package/dist-types/commands/UpdateFeatureGroupCommand.d.ts +2 -17
- package/dist-types/commands/UpdateHubContentCommand.d.ts +1 -36
- package/dist-types/commands/UpdateHubContentReferenceCommand.d.ts +1 -14
- package/dist-types/commands/UpdateImageCommand.d.ts +1 -2
- package/dist-types/commands/UpdateInferenceComponentCommand.d.ts +1 -2
- package/dist-types/commands/UpdateInferenceComponentRuntimeConfigCommand.d.ts +1 -2
- package/dist-types/commands/UpdateInferenceExperimentCommand.d.ts +2 -7
- package/dist-types/commands/UpdateMlflowTrackingServerCommand.d.ts +2 -4
- package/dist-types/commands/UpdateModelCardCommand.d.ts +3 -8
- package/dist-types/commands/UpdateModelPackageCommand.d.ts +1 -2
- package/dist-types/commands/UpdateMonitoringAlertCommand.d.ts +1 -2
- package/dist-types/commands/UpdateMonitoringScheduleCommand.d.ts +1 -2
- package/dist-types/commands/UpdateNotebookInstanceCommand.d.ts +2 -5
- package/dist-types/commands/UpdateNotebookInstanceLifecycleConfigCommand.d.ts +1 -2
- package/dist-types/commands/UpdatePartnerAppCommand.d.ts +2 -3
- package/dist-types/commands/UpdatePipelineCommand.d.ts +1 -2
- package/dist-types/commands/UpdatePipelineExecutionCommand.d.ts +1 -2
- package/dist-types/commands/UpdateProjectCommand.d.ts +2 -10
- package/dist-types/commands/UpdateSpaceCommand.d.ts +2 -6
- package/dist-types/commands/UpdateTrainingJobCommand.d.ts +2 -4
- package/dist-types/commands/UpdateTrialCommand.d.ts +1 -2
- package/dist-types/commands/UpdateTrialComponentCommand.d.ts +1 -2
- package/dist-types/commands/UpdateUserProfileCommand.d.ts +1 -2
- package/dist-types/commands/UpdateWorkforceCommand.d.ts +2 -28
- package/dist-types/commands/UpdateWorkteamCommand.d.ts +1 -2
- package/dist-types/index.d.ts +1 -16
- package/dist-types/models/models_0.d.ts +370 -4018
- package/dist-types/models/models_1.d.ts +532 -5722
- package/dist-types/models/models_2.d.ts +328 -1436
- package/dist-types/models/models_3.d.ts +364 -2021
- package/dist-types/models/models_4.d.ts +462 -1693
- package/dist-types/models/models_5.d.ts +90 -441
- package/package.json +15 -15
|
@@ -93,8 +93,7 @@ export interface StopPipelineExecutionRequest {
|
|
|
93
93
|
*/
|
|
94
94
|
PipelineExecutionArn: string | undefined;
|
|
95
95
|
/**
|
|
96
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
97
|
-
* operation. An idempotent operation completes no more than once.</p>
|
|
96
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.</p>
|
|
98
97
|
* @public
|
|
99
98
|
*/
|
|
100
99
|
ClientRequestToken?: string | undefined;
|
|
@@ -269,8 +268,7 @@ export interface UpdateClusterRequest {
|
|
|
269
268
|
*/
|
|
270
269
|
NodeRecovery?: ClusterNodeRecovery | undefined;
|
|
271
270
|
/**
|
|
272
|
-
* <p>Specify the names of the instance groups to delete.
|
|
273
|
-
* Use a single <code>,</code> as the separator between multiple names.</p>
|
|
271
|
+
* <p>Specify the names of the instance groups to delete. Use a single <code>,</code> as the separator between multiple names.</p>
|
|
274
272
|
* @public
|
|
275
273
|
*/
|
|
276
274
|
InstanceGroupsToDelete?: string[] | undefined;
|
|
@@ -341,8 +339,7 @@ export interface UpdateClusterSoftwareInstanceGroupSpecification {
|
|
|
341
339
|
*/
|
|
342
340
|
export interface UpdateClusterSoftwareRequest {
|
|
343
341
|
/**
|
|
344
|
-
* <p>Specify the name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster you want to update for security
|
|
345
|
-
* patching.</p>
|
|
342
|
+
* <p>Specify the name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster you want to update for security patching.</p>
|
|
346
343
|
* @public
|
|
347
344
|
*/
|
|
348
345
|
ClusterName: string | undefined;
|
|
@@ -377,14 +374,7 @@ export interface UpdateCodeRepositoryInput {
|
|
|
377
374
|
*/
|
|
378
375
|
CodeRepositoryName: string | undefined;
|
|
379
376
|
/**
|
|
380
|
-
* <p>The configuration of the git repository, including the URL and the Amazon Resource
|
|
381
|
-
* Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the
|
|
382
|
-
* credentials used to access the repository. The secret must have a staging label of
|
|
383
|
-
* <code>AWSCURRENT</code> and must be in the following format:</p>
|
|
384
|
-
* <p>
|
|
385
|
-
* <code>\{"username": <i>UserName</i>, "password":
|
|
386
|
-
* <i>Password</i>\}</code>
|
|
387
|
-
* </p>
|
|
377
|
+
* <p>The configuration of the git repository, including the URL and the Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the repository. The secret must have a staging label of <code>AWSCURRENT</code> and must be in the following format:</p> <p> <code>\{"username": <i>UserName</i>, "password": <i>Password</i>\}</code> </p>
|
|
388
378
|
* @public
|
|
389
379
|
*/
|
|
390
380
|
GitConfig?: GitConfigForUpdate | undefined;
|
|
@@ -414,8 +404,7 @@ export interface UpdateComputeQuotaRequest {
|
|
|
414
404
|
*/
|
|
415
405
|
TargetVersion: number | undefined;
|
|
416
406
|
/**
|
|
417
|
-
* <p>Configuration of the compute allocation definition. This includes the resource sharing
|
|
418
|
-
* option, and the setting to preempt low priority tasks.</p>
|
|
407
|
+
* <p>Configuration of the compute allocation definition. This includes the resource sharing option, and the setting to preempt low priority tasks.</p>
|
|
419
408
|
* @public
|
|
420
409
|
*/
|
|
421
410
|
ComputeQuotaConfig?: ComputeQuotaConfig | undefined;
|
|
@@ -425,9 +414,7 @@ export interface UpdateComputeQuotaRequest {
|
|
|
425
414
|
*/
|
|
426
415
|
ComputeQuotaTarget?: ComputeQuotaTarget | undefined;
|
|
427
416
|
/**
|
|
428
|
-
* <p>The state of the compute allocation being described. Use to enable or disable compute
|
|
429
|
-
* allocation.</p>
|
|
430
|
-
* <p>Default is <code>Enabled</code>.</p>
|
|
417
|
+
* <p>The state of the compute allocation being described. Use to enable or disable compute allocation.</p> <p>Default is <code>Enabled</code>.</p>
|
|
431
418
|
* @public
|
|
432
419
|
*/
|
|
433
420
|
ActivationState?: ActivationState | undefined;
|
|
@@ -507,16 +494,12 @@ export interface UpdateDeviceFleetRequest {
|
|
|
507
494
|
*/
|
|
508
495
|
Description?: string | undefined;
|
|
509
496
|
/**
|
|
510
|
-
* <p>Output configuration
|
|
497
|
+
* <p>Output configuration for storing sample data collected by the fleet.</p>
|
|
511
498
|
* @public
|
|
512
499
|
*/
|
|
513
500
|
OutputConfig: EdgeOutputConfig | undefined;
|
|
514
501
|
/**
|
|
515
|
-
* <p>Whether to create an Amazon Web Services IoT Role Alias during device fleet creation.
|
|
516
|
-
* The name of the role alias generated will match this pattern:
|
|
517
|
-
* "SageMakerEdge-\{DeviceFleetName\}".</p>
|
|
518
|
-
* <p>For example, if your device fleet is called "demo-fleet", the name of
|
|
519
|
-
* the role alias will be "SageMakerEdge-demo-fleet".</p>
|
|
502
|
+
* <p>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\}".</p> <p>For example, if your device fleet is called "demo-fleet", the name of the role alias will be "SageMakerEdge-demo-fleet".</p>
|
|
520
503
|
* @public
|
|
521
504
|
*/
|
|
522
505
|
EnableIotRoleAlias?: boolean | undefined;
|
|
@@ -556,12 +539,7 @@ export interface UpdateDomainRequest {
|
|
|
556
539
|
*/
|
|
557
540
|
DomainSettingsForUpdate?: DomainSettingsForUpdate | undefined;
|
|
558
541
|
/**
|
|
559
|
-
* <p>The entity that creates and manages the required security groups for inter-app
|
|
560
|
-
* communication in <code>VPCOnly</code> mode. Required when
|
|
561
|
-
* <code>CreateDomain.AppNetworkAccessType</code> is <code>VPCOnly</code> and
|
|
562
|
-
* <code>DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn</code> is
|
|
563
|
-
* provided. If setting up the domain for use with RStudio, this value must be set to
|
|
564
|
-
* <code>Service</code>.</p>
|
|
542
|
+
* <p>The entity that creates and manages the required security groups for inter-app communication in <code>VPCOnly</code> mode. Required when <code>CreateDomain.AppNetworkAccessType</code> is <code>VPCOnly</code> and <code>DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn</code> is provided. If setting up the domain for use with RStudio, this value must be set to <code>Service</code>.</p>
|
|
565
543
|
* @public
|
|
566
544
|
*/
|
|
567
545
|
AppSecurityGroupManagement?: AppSecurityGroupManagement | undefined;
|
|
@@ -571,37 +549,17 @@ export interface UpdateDomainRequest {
|
|
|
571
549
|
*/
|
|
572
550
|
DefaultSpaceSettings?: DefaultSpaceSettings | undefined;
|
|
573
551
|
/**
|
|
574
|
-
* <p>The VPC subnets that Studio uses for communication.</p>
|
|
575
|
-
* <p>If removing subnets, ensure there are no apps in the <code>InService</code>,
|
|
576
|
-
* <code>Pending</code>, or <code>Deleting</code> state.</p>
|
|
552
|
+
* <p>The VPC subnets that Studio uses for communication.</p> <p>If removing subnets, ensure there are no apps in the <code>InService</code>, <code>Pending</code>, or <code>Deleting</code> state.</p>
|
|
577
553
|
* @public
|
|
578
554
|
*/
|
|
579
555
|
SubnetIds?: string[] | undefined;
|
|
580
556
|
/**
|
|
581
|
-
* <p>Specifies the VPC used for non-EFS traffic.</p>
|
|
582
|
-
* <ul>
|
|
583
|
-
* <li>
|
|
584
|
-
* <p>
|
|
585
|
-
* <code>PublicInternetOnly</code> - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access.</p>
|
|
586
|
-
* </li>
|
|
587
|
-
* <li>
|
|
588
|
-
* <p>
|
|
589
|
-
* <code>VpcOnly</code> - All Studio traffic is through the specified VPC and
|
|
590
|
-
* subnets.</p>
|
|
591
|
-
* </li>
|
|
592
|
-
* </ul>
|
|
593
|
-
* <p>This configuration can only be modified if there are no apps in the
|
|
594
|
-
* <code>InService</code>, <code>Pending</code>, or <code>Deleting</code> state. The
|
|
595
|
-
* configuration cannot be updated if
|
|
596
|
-
* <code>DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn</code> is already
|
|
597
|
-
* set or <code>DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn</code> is
|
|
598
|
-
* provided as part of the same request.</p>
|
|
557
|
+
* <p>Specifies the VPC used for non-EFS traffic.</p> <ul> <li> <p> <code>PublicInternetOnly</code> - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access.</p> </li> <li> <p> <code>VpcOnly</code> - All Studio traffic is through the specified VPC and subnets.</p> </li> </ul> <p>This configuration can only be modified if there are no apps in the <code>InService</code>, <code>Pending</code>, or <code>Deleting</code> state. The configuration cannot be updated if <code>DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn</code> is already set or <code>DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn</code> is provided as part of the same request.</p>
|
|
599
558
|
* @public
|
|
600
559
|
*/
|
|
601
560
|
AppNetworkAccessType?: AppNetworkAccessType | undefined;
|
|
602
561
|
/**
|
|
603
|
-
* <p>Indicates whether custom tag propagation is supported for the domain. Defaults to
|
|
604
|
-
* <code>DISABLED</code>.</p>
|
|
562
|
+
* <p>Indicates whether custom tag propagation is supported for the domain. Defaults to <code>DISABLED</code>.</p>
|
|
605
563
|
* @public
|
|
606
564
|
*/
|
|
607
565
|
TagPropagation?: TagPropagation | undefined;
|
|
@@ -630,35 +588,12 @@ export declare const VariantPropertyType: {
|
|
|
630
588
|
*/
|
|
631
589
|
export type VariantPropertyType = (typeof VariantPropertyType)[keyof typeof VariantPropertyType];
|
|
632
590
|
/**
|
|
633
|
-
* <p>Specifies a production variant property type for an Endpoint.</p>
|
|
634
|
-
* <p>If you are updating an endpoint with the <code>RetainAllVariantProperties</code>
|
|
635
|
-
* option of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html">UpdateEndpointInput</a> set to <code>true</code>, the
|
|
636
|
-
* <code>VariantProperty</code> objects listed in the
|
|
637
|
-
* <code>ExcludeRetainedVariantProperties</code> parameter of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html">UpdateEndpointInput</a> override the existing variant properties of the
|
|
638
|
-
* endpoint.</p>
|
|
591
|
+
* <p>Specifies a production variant property type for an Endpoint.</p> <p>If you are updating an endpoint with the <code>RetainAllVariantProperties</code> option of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html">UpdateEndpointInput</a> set to <code>true</code>, the <code>VariantProperty</code> objects listed in the <code>ExcludeRetainedVariantProperties</code> parameter of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html">UpdateEndpointInput</a> override the existing variant properties of the endpoint.</p>
|
|
639
592
|
* @public
|
|
640
593
|
*/
|
|
641
594
|
export interface VariantProperty {
|
|
642
595
|
/**
|
|
643
|
-
* <p>The type of variant property. The supported values are:</p>
|
|
644
|
-
* <ul>
|
|
645
|
-
* <li>
|
|
646
|
-
* <p>
|
|
647
|
-
* <code>DesiredInstanceCount</code>: Overrides the existing variant instance
|
|
648
|
-
* counts using the <code>InitialInstanceCount</code> values in the
|
|
649
|
-
* <code>ProductionVariants</code> of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html">CreateEndpointConfig</a>.</p>
|
|
650
|
-
* </li>
|
|
651
|
-
* <li>
|
|
652
|
-
* <p>
|
|
653
|
-
* <code>DesiredWeight</code>: Overrides the existing variant weights using the
|
|
654
|
-
* <code>InitialVariantWeight</code> values in the
|
|
655
|
-
* <code>ProductionVariants</code> of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html">CreateEndpointConfig</a>.</p>
|
|
656
|
-
* </li>
|
|
657
|
-
* <li>
|
|
658
|
-
* <p>
|
|
659
|
-
* <code>DataCaptureConfig</code>: (Not currently supported.)</p>
|
|
660
|
-
* </li>
|
|
661
|
-
* </ul>
|
|
596
|
+
* <p>The type of variant property. The supported values are:</p> <ul> <li> <p> <code>DesiredInstanceCount</code>: Overrides the existing variant instance counts using the <code>InitialInstanceCount</code> values in the <code>ProductionVariants</code> of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html">CreateEndpointConfig</a>.</p> </li> <li> <p> <code>DesiredWeight</code>: Overrides the existing variant weights using the <code>InitialVariantWeight</code> values in the <code>ProductionVariants</code> of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html">CreateEndpointConfig</a>.</p> </li> <li> <p> <code>DataCaptureConfig</code>: (Not currently supported.)</p> </li> </ul>
|
|
662
597
|
* @public
|
|
663
598
|
*/
|
|
664
599
|
VariantPropertyType: VariantPropertyType | undefined;
|
|
@@ -678,34 +613,22 @@ export interface UpdateEndpointInput {
|
|
|
678
613
|
*/
|
|
679
614
|
EndpointConfigName: string | undefined;
|
|
680
615
|
/**
|
|
681
|
-
* <p>When updating endpoint resources, enables or disables the retention of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VariantProperty.html">variant properties</a>, such as the instance count or the variant weight. To
|
|
682
|
-
* retain the variant properties of an endpoint when updating it, set
|
|
683
|
-
* <code>RetainAllVariantProperties</code> to <code>true</code>. To use the variant
|
|
684
|
-
* properties specified in a new <code>EndpointConfig</code> call when updating an
|
|
685
|
-
* endpoint, set <code>RetainAllVariantProperties</code> to <code>false</code>. The default
|
|
686
|
-
* is <code>false</code>.</p>
|
|
616
|
+
* <p>When updating endpoint resources, enables or disables the retention of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VariantProperty.html">variant properties</a>, such as the instance count or the variant weight. To retain the variant properties of an endpoint when updating it, set <code>RetainAllVariantProperties</code> to <code>true</code>. To use the variant properties specified in a new <code>EndpointConfig</code> call when updating an endpoint, set <code>RetainAllVariantProperties</code> to <code>false</code>. The default is <code>false</code>.</p>
|
|
687
617
|
* @public
|
|
688
618
|
*/
|
|
689
619
|
RetainAllVariantProperties?: boolean | undefined;
|
|
690
620
|
/**
|
|
691
|
-
* <p>When you are updating endpoint resources with <code>RetainAllVariantProperties</code>,
|
|
692
|
-
* whose value is set to <code>true</code>, <code>ExcludeRetainedVariantProperties</code>
|
|
693
|
-
* specifies the list of type <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VariantProperty.html">VariantProperty</a>
|
|
694
|
-
* to override with the values provided by <code>EndpointConfig</code>. If you don't
|
|
695
|
-
* specify a value for <code>ExcludeRetainedVariantProperties</code>, no variant properties
|
|
696
|
-
* are overridden. </p>
|
|
621
|
+
* <p>When you are updating endpoint resources with <code>RetainAllVariantProperties</code>, whose value is set to <code>true</code>, <code>ExcludeRetainedVariantProperties</code> specifies the list of type <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VariantProperty.html">VariantProperty</a> to override with the values provided by <code>EndpointConfig</code>. If you don't specify a value for <code>ExcludeRetainedVariantProperties</code>, no variant properties are overridden. </p>
|
|
697
622
|
* @public
|
|
698
623
|
*/
|
|
699
624
|
ExcludeRetainedVariantProperties?: VariantProperty[] | undefined;
|
|
700
625
|
/**
|
|
701
|
-
* <p>The deployment configuration for an endpoint, which contains the desired deployment
|
|
702
|
-
* strategy and rollback configurations.</p>
|
|
626
|
+
* <p>The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.</p>
|
|
703
627
|
* @public
|
|
704
628
|
*/
|
|
705
629
|
DeploymentConfig?: DeploymentConfig | undefined;
|
|
706
630
|
/**
|
|
707
|
-
* <p>Specifies whether to reuse the last deployment configuration. The default value is
|
|
708
|
-
* false (the configuration is not reused).</p>
|
|
631
|
+
* <p>Specifies whether to reuse the last deployment configuration. The default value is false (the configuration is not reused).</p>
|
|
709
632
|
* @public
|
|
710
633
|
*/
|
|
711
634
|
RetainDeploymentConfig?: boolean | undefined;
|
|
@@ -755,8 +678,7 @@ export interface UpdateExperimentRequest {
|
|
|
755
678
|
*/
|
|
756
679
|
ExperimentName: string | undefined;
|
|
757
680
|
/**
|
|
758
|
-
* <p>The name of the experiment as displayed. The name doesn't need to be unique. If
|
|
759
|
-
* <code>DisplayName</code> isn't specified, <code>ExperimentName</code> is displayed.</p>
|
|
681
|
+
* <p>The name of the experiment as displayed. The name doesn't need to be unique. If <code>DisplayName</code> isn't specified, <code>ExperimentName</code> is displayed.</p>
|
|
760
682
|
* @public
|
|
761
683
|
*/
|
|
762
684
|
DisplayName?: string | undefined;
|
|
@@ -777,29 +699,22 @@ export interface UpdateExperimentResponse {
|
|
|
777
699
|
ExperimentArn?: string | undefined;
|
|
778
700
|
}
|
|
779
701
|
/**
|
|
780
|
-
* <p>The new throughput configuration for the feature group. You can switch between on-demand
|
|
781
|
-
* and provisioned modes or update the read / write capacity of provisioned feature groups.
|
|
782
|
-
* You can switch a feature group to on-demand only once in a 24 hour period. </p>
|
|
702
|
+
* <p>The new throughput configuration for the feature group. You can switch between on-demand and provisioned modes or update the read / write capacity of provisioned feature groups. You can switch a feature group to on-demand only once in a 24 hour period. </p>
|
|
783
703
|
* @public
|
|
784
704
|
*/
|
|
785
705
|
export interface ThroughputConfigUpdate {
|
|
786
706
|
/**
|
|
787
|
-
* <p>Target throughput mode of the feature group. Throughput update is an asynchronous
|
|
788
|
-
* operation, and the outcome should be monitored by polling <code>LastUpdateStatus</code>
|
|
789
|
-
* field in <code>DescribeFeatureGroup</code> response. You cannot update a feature group's
|
|
790
|
-
* throughput while another update is in progress. </p>
|
|
707
|
+
* <p>Target throughput mode of the feature group. Throughput update is an asynchronous operation, and the outcome should be monitored by polling <code>LastUpdateStatus</code> field in <code>DescribeFeatureGroup</code> response. You cannot update a feature group's throughput while another update is in progress. </p>
|
|
791
708
|
* @public
|
|
792
709
|
*/
|
|
793
710
|
ThroughputMode?: ThroughputMode | undefined;
|
|
794
711
|
/**
|
|
795
|
-
* <p>For provisioned feature groups with online store enabled, this indicates the read
|
|
796
|
-
* throughput you are billed for and can consume without throttling. </p>
|
|
712
|
+
* <p>For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling. </p>
|
|
797
713
|
* @public
|
|
798
714
|
*/
|
|
799
715
|
ProvisionedReadCapacityUnits?: number | undefined;
|
|
800
716
|
/**
|
|
801
|
-
* <p>For provisioned feature groups, this indicates the write throughput you are billed for
|
|
802
|
-
* and can consume without throttling. </p>
|
|
717
|
+
* <p>For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling. </p>
|
|
803
718
|
* @public
|
|
804
719
|
*/
|
|
805
720
|
ProvisionedWriteCapacityUnits?: number | undefined;
|
|
@@ -814,9 +729,7 @@ export interface UpdateFeatureGroupRequest {
|
|
|
814
729
|
*/
|
|
815
730
|
FeatureGroupName: string | undefined;
|
|
816
731
|
/**
|
|
817
|
-
* <p>Updates the feature group. Updating a feature group is an asynchronous operation. When
|
|
818
|
-
* you get an HTTP 200 response, you've made a valid request. It takes some time after you've
|
|
819
|
-
* made a valid request for Feature Store to update the feature group.</p>
|
|
732
|
+
* <p>Updates the feature group. Updating a feature group is an asynchronous operation. When you get an HTTP 200 response, you've made a valid request. It takes some time after you've made a valid request for Feature Store to update the feature group.</p>
|
|
820
733
|
* @public
|
|
821
734
|
*/
|
|
822
735
|
FeatureAdditions?: FeatureDefinition[] | undefined;
|
|
@@ -826,9 +739,7 @@ export interface UpdateFeatureGroupRequest {
|
|
|
826
739
|
*/
|
|
827
740
|
OnlineStoreConfig?: OnlineStoreConfigUpdate | undefined;
|
|
828
741
|
/**
|
|
829
|
-
* <p>The new throughput configuration for the feature group. You can switch between on-demand
|
|
830
|
-
* and provisioned modes or update the read / write capacity of provisioned feature groups.
|
|
831
|
-
* You can switch a feature group to on-demand only once in a 24 hour period. </p>
|
|
742
|
+
* <p>The new throughput configuration for the feature group. You can switch between on-demand and provisioned modes or update the read / write capacity of provisioned feature groups. You can switch a feature group to on-demand only once in a 24 hour period. </p>
|
|
832
743
|
* @public
|
|
833
744
|
*/
|
|
834
745
|
ThroughputConfig?: ThroughputConfigUpdate | undefined;
|
|
@@ -848,8 +759,7 @@ export interface UpdateFeatureGroupResponse {
|
|
|
848
759
|
*/
|
|
849
760
|
export interface UpdateFeatureMetadataRequest {
|
|
850
761
|
/**
|
|
851
|
-
* <p>The name or Amazon Resource Name (ARN) of the feature group containing the feature that
|
|
852
|
-
* you're updating.</p>
|
|
762
|
+
* <p>The name or Amazon Resource Name (ARN) of the feature group containing the feature that you're updating.</p>
|
|
853
763
|
* @public
|
|
854
764
|
*/
|
|
855
765
|
FeatureGroupName: string | undefined;
|
|
@@ -869,8 +779,7 @@ export interface UpdateFeatureMetadataRequest {
|
|
|
869
779
|
*/
|
|
870
780
|
ParameterAdditions?: FeatureParameter[] | undefined;
|
|
871
781
|
/**
|
|
872
|
-
* <p>A list of parameter keys that you can specify to remove parameters that describe your
|
|
873
|
-
* feature.</p>
|
|
782
|
+
* <p>A list of parameter keys that you can specify to remove parameters that describe your feature.</p>
|
|
874
783
|
* @public
|
|
875
784
|
*/
|
|
876
785
|
ParameterRemovals?: string[] | undefined;
|
|
@@ -915,8 +824,7 @@ export interface UpdateHubResponse {
|
|
|
915
824
|
*/
|
|
916
825
|
export interface UpdateHubContentRequest {
|
|
917
826
|
/**
|
|
918
|
-
* <p>The name of the SageMaker hub that contains the hub content you want to update.
|
|
919
|
-
* You can optionally use the hub ARN instead.</p>
|
|
827
|
+
* <p>The name of the SageMaker hub that contains the hub content you want to update. You can optionally use the hub ARN instead.</p>
|
|
920
828
|
* @public
|
|
921
829
|
*/
|
|
922
830
|
HubName: string | undefined;
|
|
@@ -926,16 +834,12 @@ export interface UpdateHubContentRequest {
|
|
|
926
834
|
*/
|
|
927
835
|
HubContentName: string | undefined;
|
|
928
836
|
/**
|
|
929
|
-
* <p>The content type of the resource that you want to update. Only specify a
|
|
930
|
-
* <code>Model</code> or <code>Notebook</code> resource for this API. To
|
|
931
|
-
* update a <code>ModelReference</code>, use the
|
|
932
|
-
* <code>UpdateHubContentReference</code> API instead.</p>
|
|
837
|
+
* <p>The content type of the resource that you want to update. Only specify a <code>Model</code> or <code>Notebook</code> resource for this API. To update a <code>ModelReference</code>, use the <code>UpdateHubContentReference</code> API instead.</p>
|
|
933
838
|
* @public
|
|
934
839
|
*/
|
|
935
840
|
HubContentType: HubContentType | undefined;
|
|
936
841
|
/**
|
|
937
|
-
* <p>The hub content version that you want to update. For example, if you have
|
|
938
|
-
* two versions of a resource in your hub, you can update the second version.</p>
|
|
842
|
+
* <p>The hub content version that you want to update. For example, if you have two versions of a resource in your hub, you can update the second version.</p>
|
|
939
843
|
* @public
|
|
940
844
|
*/
|
|
941
845
|
HubContentVersion: string | undefined;
|
|
@@ -995,16 +899,12 @@ export interface UpdateHubContentReferenceRequest {
|
|
|
995
899
|
*/
|
|
996
900
|
HubContentName: string | undefined;
|
|
997
901
|
/**
|
|
998
|
-
* <p>The content type of the resource that you want to update. Only specify a
|
|
999
|
-
* <code>ModelReference</code> resource for this API. To update a <code>Model</code>
|
|
1000
|
-
* or <code>Notebook</code> resource, use the <code>UpdateHubContent</code> API instead.</p>
|
|
902
|
+
* <p>The content type of the resource that you want to update. Only specify a <code>ModelReference</code> resource for this API. To update a <code>Model</code> or <code>Notebook</code> resource, use the <code>UpdateHubContent</code> API instead.</p>
|
|
1001
903
|
* @public
|
|
1002
904
|
*/
|
|
1003
905
|
HubContentType: HubContentType | undefined;
|
|
1004
906
|
/**
|
|
1005
|
-
* <p>The minimum hub content version of the referenced model that you want to use.
|
|
1006
|
-
* The minimum version must be older than the latest available version of the referenced model.
|
|
1007
|
-
* To support all versions of a model, set the value to <code>1.0.0</code>.</p>
|
|
907
|
+
* <p>The minimum hub content version of the referenced model that you want to use. The minimum version must be older than the latest available version of the referenced model. To support all versions of a model, set the value to <code>1.0.0</code>.</p>
|
|
1008
908
|
* @public
|
|
1009
909
|
*/
|
|
1010
910
|
MinVersion?: string | undefined;
|
|
@@ -1029,8 +929,7 @@ export interface UpdateHubContentReferenceResponse {
|
|
|
1029
929
|
*/
|
|
1030
930
|
export interface UpdateImageRequest {
|
|
1031
931
|
/**
|
|
1032
|
-
* <p>A list of properties to delete. Only the <code>Description</code> and
|
|
1033
|
-
* <code>DisplayName</code> properties can be deleted.</p>
|
|
932
|
+
* <p>A list of properties to delete. Only the <code>Description</code> and <code>DisplayName</code> properties can be deleted.</p>
|
|
1034
933
|
* @public
|
|
1035
934
|
*/
|
|
1036
935
|
DeleteProperties?: string[] | undefined;
|
|
@@ -1095,44 +994,12 @@ export interface UpdateImageVersionRequest {
|
|
|
1095
994
|
*/
|
|
1096
995
|
AliasesToDelete?: string[] | undefined;
|
|
1097
996
|
/**
|
|
1098
|
-
* <p>The availability of the image version specified by the maintainer.</p>
|
|
1099
|
-
* <ul>
|
|
1100
|
-
* <li>
|
|
1101
|
-
* <p>
|
|
1102
|
-
* <code>NOT_PROVIDED</code>: The maintainers did not provide a status for image version stability.</p>
|
|
1103
|
-
* </li>
|
|
1104
|
-
* <li>
|
|
1105
|
-
* <p>
|
|
1106
|
-
* <code>STABLE</code>: The image version is stable.</p>
|
|
1107
|
-
* </li>
|
|
1108
|
-
* <li>
|
|
1109
|
-
* <p>
|
|
1110
|
-
* <code>TO_BE_ARCHIVED</code>: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.</p>
|
|
1111
|
-
* </li>
|
|
1112
|
-
* <li>
|
|
1113
|
-
* <p>
|
|
1114
|
-
* <code>ARCHIVED</code>: The image version is archived. Archived image versions are not searchable and are no longer actively supported. </p>
|
|
1115
|
-
* </li>
|
|
1116
|
-
* </ul>
|
|
997
|
+
* <p>The availability of the image version specified by the maintainer.</p> <ul> <li> <p> <code>NOT_PROVIDED</code>: The maintainers did not provide a status for image version stability.</p> </li> <li> <p> <code>STABLE</code>: The image version is stable.</p> </li> <li> <p> <code>TO_BE_ARCHIVED</code>: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.</p> </li> <li> <p> <code>ARCHIVED</code>: The image version is archived. Archived image versions are not searchable and are no longer actively supported. </p> </li> </ul>
|
|
1117
998
|
* @public
|
|
1118
999
|
*/
|
|
1119
1000
|
VendorGuidance?: VendorGuidance | undefined;
|
|
1120
1001
|
/**
|
|
1121
|
-
* <p>Indicates SageMaker AI job type compatibility.</p>
|
|
1122
|
-
* <ul>
|
|
1123
|
-
* <li>
|
|
1124
|
-
* <p>
|
|
1125
|
-
* <code>TRAINING</code>: The image version is compatible with SageMaker AI training jobs.</p>
|
|
1126
|
-
* </li>
|
|
1127
|
-
* <li>
|
|
1128
|
-
* <p>
|
|
1129
|
-
* <code>INFERENCE</code>: The image version is compatible with SageMaker AI inference jobs.</p>
|
|
1130
|
-
* </li>
|
|
1131
|
-
* <li>
|
|
1132
|
-
* <p>
|
|
1133
|
-
* <code>NOTEBOOK_KERNEL</code>: The image version is compatible with SageMaker AI notebook kernels.</p>
|
|
1134
|
-
* </li>
|
|
1135
|
-
* </ul>
|
|
1002
|
+
* <p>Indicates SageMaker AI job type compatibility.</p> <ul> <li> <p> <code>TRAINING</code>: The image version is compatible with SageMaker AI training jobs.</p> </li> <li> <p> <code>INFERENCE</code>: The image version is compatible with SageMaker AI inference jobs.</p> </li> <li> <p> <code>NOTEBOOK_KERNEL</code>: The image version is compatible with SageMaker AI notebook kernels.</p> </li> </ul>
|
|
1136
1003
|
* @public
|
|
1137
1004
|
*/
|
|
1138
1005
|
JobType?: JobType | undefined;
|
|
@@ -1147,17 +1014,7 @@ export interface UpdateImageVersionRequest {
|
|
|
1147
1014
|
*/
|
|
1148
1015
|
ProgrammingLang?: string | undefined;
|
|
1149
1016
|
/**
|
|
1150
|
-
* <p>Indicates CPU or GPU compatibility.</p>
|
|
1151
|
-
* <ul>
|
|
1152
|
-
* <li>
|
|
1153
|
-
* <p>
|
|
1154
|
-
* <code>CPU</code>: The image version is compatible with CPU.</p>
|
|
1155
|
-
* </li>
|
|
1156
|
-
* <li>
|
|
1157
|
-
* <p>
|
|
1158
|
-
* <code>GPU</code>: The image version is compatible with GPU.</p>
|
|
1159
|
-
* </li>
|
|
1160
|
-
* </ul>
|
|
1017
|
+
* <p>Indicates CPU or GPU compatibility.</p> <ul> <li> <p> <code>CPU</code>: The image version is compatible with CPU.</p> </li> <li> <p> <code>GPU</code>: The image version is compatible with GPU.</p> </li> </ul>
|
|
1161
1018
|
* @public
|
|
1162
1019
|
*/
|
|
1163
1020
|
Processor?: Processor | undefined;
|
|
@@ -1192,8 +1049,7 @@ export interface UpdateInferenceComponentInput {
|
|
|
1192
1049
|
*/
|
|
1193
1050
|
InferenceComponentName: string | undefined;
|
|
1194
1051
|
/**
|
|
1195
|
-
* <p>Details about the resources to deploy with this inference component, including the
|
|
1196
|
-
* model, container, and compute resources.</p>
|
|
1052
|
+
* <p>Details about the resources to deploy with this inference component, including the model, container, and compute resources.</p>
|
|
1197
1053
|
* @public
|
|
1198
1054
|
*/
|
|
1199
1055
|
Specification?: InferenceComponentSpecification | undefined;
|
|
@@ -1203,8 +1059,7 @@ export interface UpdateInferenceComponentInput {
|
|
|
1203
1059
|
*/
|
|
1204
1060
|
RuntimeConfig?: InferenceComponentRuntimeConfig | undefined;
|
|
1205
1061
|
/**
|
|
1206
|
-
* <p>The deployment configuration for the inference component. The configuration contains the
|
|
1207
|
-
* desired deployment strategy and rollback settings.</p>
|
|
1062
|
+
* <p>The deployment configuration for the inference component. The configuration contains the desired deployment strategy and rollback settings.</p>
|
|
1208
1063
|
* @public
|
|
1209
1064
|
*/
|
|
1210
1065
|
DeploymentConfig?: InferenceComponentDeploymentConfig | undefined;
|
|
@@ -1254,11 +1109,7 @@ export interface UpdateInferenceExperimentRequest {
|
|
|
1254
1109
|
*/
|
|
1255
1110
|
Name: string | undefined;
|
|
1256
1111
|
/**
|
|
1257
|
-
* <p>
|
|
1258
|
-
* The duration for which the inference experiment will run. If the status of the inference experiment is
|
|
1259
|
-
* <code>Created</code>, then you can update both the start and end dates. If the status of the inference
|
|
1260
|
-
* experiment is <code>Running</code>, then you can update only the end date.
|
|
1261
|
-
* </p>
|
|
1112
|
+
* <p> The duration for which the inference experiment will run. If the status of the inference experiment is <code>Created</code>, then you can update both the start and end dates. If the status of the inference experiment is <code>Running</code>, then you can update only the end date. </p>
|
|
1262
1113
|
* @public
|
|
1263
1114
|
*/
|
|
1264
1115
|
Schedule?: InferenceExperimentSchedule | undefined;
|
|
@@ -1268,10 +1119,7 @@ export interface UpdateInferenceExperimentRequest {
|
|
|
1268
1119
|
*/
|
|
1269
1120
|
Description?: string | undefined;
|
|
1270
1121
|
/**
|
|
1271
|
-
* <p>
|
|
1272
|
-
* An array of <code>ModelVariantConfig</code> objects. There is one for each variant, whose infrastructure
|
|
1273
|
-
* configuration you want to update.
|
|
1274
|
-
* </p>
|
|
1122
|
+
* <p> An array of <code>ModelVariantConfig</code> objects. There is one for each variant, whose infrastructure configuration you want to update. </p>
|
|
1275
1123
|
* @public
|
|
1276
1124
|
*/
|
|
1277
1125
|
ModelVariants?: ModelVariantConfig[] | undefined;
|
|
@@ -1281,12 +1129,7 @@ export interface UpdateInferenceExperimentRequest {
|
|
|
1281
1129
|
*/
|
|
1282
1130
|
DataStorageConfig?: InferenceExperimentDataStorageConfig | undefined;
|
|
1283
1131
|
/**
|
|
1284
|
-
* <p>
|
|
1285
|
-
* The configuration of <code>ShadowMode</code> inference experiment type. Use this field to specify a
|
|
1286
|
-
* production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a
|
|
1287
|
-
* percentage of the inference requests. For the shadow variant also specify the percentage of requests that
|
|
1288
|
-
* Amazon SageMaker replicates.
|
|
1289
|
-
* </p>
|
|
1132
|
+
* <p> The configuration of <code>ShadowMode</code> inference experiment type. Use this field to specify a production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant also specify the percentage of requests that Amazon SageMaker replicates. </p>
|
|
1290
1133
|
* @public
|
|
1291
1134
|
*/
|
|
1292
1135
|
ShadowModeConfig?: ShadowModeConfig | undefined;
|
|
@@ -1311,8 +1154,7 @@ export interface UpdateMlflowTrackingServerRequest {
|
|
|
1311
1154
|
*/
|
|
1312
1155
|
TrackingServerName: string | undefined;
|
|
1313
1156
|
/**
|
|
1314
|
-
* <p>The new S3 URI for the general purpose bucket to use as the artifact store for the MLflow
|
|
1315
|
-
* Tracking Server.</p>
|
|
1157
|
+
* <p>The new S3 URI for the general purpose bucket to use as the artifact store for the MLflow Tracking Server.</p>
|
|
1316
1158
|
* @public
|
|
1317
1159
|
*/
|
|
1318
1160
|
ArtifactStoreUri?: string | undefined;
|
|
@@ -1322,17 +1164,12 @@ export interface UpdateMlflowTrackingServerRequest {
|
|
|
1322
1164
|
*/
|
|
1323
1165
|
TrackingServerSize?: TrackingServerSize | undefined;
|
|
1324
1166
|
/**
|
|
1325
|
-
* <p>Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry.
|
|
1326
|
-
* To enable automatic model registration, set this value to <code>True</code>.
|
|
1327
|
-
* To disable automatic model registration, set this value to <code>False</code>.
|
|
1328
|
-
* If not specified, <code>AutomaticModelRegistration</code> defaults to <code>False</code>
|
|
1329
|
-
* </p>
|
|
1167
|
+
* <p>Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. To enable automatic model registration, set this value to <code>True</code>. To disable automatic model registration, set this value to <code>False</code>. If not specified, <code>AutomaticModelRegistration</code> defaults to <code>False</code> </p>
|
|
1330
1168
|
* @public
|
|
1331
1169
|
*/
|
|
1332
1170
|
AutomaticModelRegistration?: boolean | undefined;
|
|
1333
1171
|
/**
|
|
1334
|
-
* <p>The new weekly maintenance window start day and time to update. The maintenance window day and time should be
|
|
1335
|
-
* in Coordinated Universal Time (UTC) 24-hour standard time. For example: TUE:03:30.</p>
|
|
1172
|
+
* <p>The new weekly maintenance window start day and time to update. The maintenance window day and time should be in Coordinated Universal Time (UTC) 24-hour standard time. For example: TUE:03:30.</p>
|
|
1336
1173
|
* @public
|
|
1337
1174
|
*/
|
|
1338
1175
|
WeeklyMaintenanceWindowStart?: string | undefined;
|
|
@@ -1357,32 +1194,12 @@ export interface UpdateModelCardRequest {
|
|
|
1357
1194
|
*/
|
|
1358
1195
|
ModelCardName: string | undefined;
|
|
1359
1196
|
/**
|
|
1360
|
-
* <p>The updated model card content. Content must be in <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema">model card JSON schema</a> and provided as a string.</p>
|
|
1361
|
-
* <p>When updating model card content, be sure to include the full content and not just updated content.</p>
|
|
1197
|
+
* <p>The updated model card content. Content must be in <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema">model card JSON schema</a> and provided as a string.</p> <p>When updating model card content, be sure to include the full content and not just updated content.</p>
|
|
1362
1198
|
* @public
|
|
1363
1199
|
*/
|
|
1364
1200
|
Content?: string | undefined;
|
|
1365
1201
|
/**
|
|
1366
|
-
* <p>The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.</p>
|
|
1367
|
-
* <ul>
|
|
1368
|
-
* <li>
|
|
1369
|
-
* <p>
|
|
1370
|
-
* <code>Draft</code>: The model card is a work in progress.</p>
|
|
1371
|
-
* </li>
|
|
1372
|
-
* <li>
|
|
1373
|
-
* <p>
|
|
1374
|
-
* <code>PendingReview</code>: The model card is pending review.</p>
|
|
1375
|
-
* </li>
|
|
1376
|
-
* <li>
|
|
1377
|
-
* <p>
|
|
1378
|
-
* <code>Approved</code>: The model card is approved.</p>
|
|
1379
|
-
* </li>
|
|
1380
|
-
* <li>
|
|
1381
|
-
* <p>
|
|
1382
|
-
* <code>Archived</code>: The model card is archived. No more updates should be made to the model
|
|
1383
|
-
* card, but it can still be exported.</p>
|
|
1384
|
-
* </li>
|
|
1385
|
-
* </ul>
|
|
1202
|
+
* <p>The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.</p> <ul> <li> <p> <code>Draft</code>: The model card is a work in progress.</p> </li> <li> <p> <code>PendingReview</code>: The model card is pending review.</p> </li> <li> <p> <code>Approved</code>: The model card is approved.</p> </li> <li> <p> <code>Archived</code>: The model card is archived. No more updates should be made to the model card, but it can still be exported.</p> </li> </ul>
|
|
1386
1203
|
* @public
|
|
1387
1204
|
*/
|
|
1388
1205
|
ModelCardStatus?: ModelCardStatus | undefined;
|
|
@@ -1427,31 +1244,12 @@ export interface UpdateModelPackageInput {
|
|
|
1427
1244
|
*/
|
|
1428
1245
|
CustomerMetadataPropertiesToRemove?: string[] | undefined;
|
|
1429
1246
|
/**
|
|
1430
|
-
* <p>An array of additional Inference Specification objects to be added to the
|
|
1431
|
-
* existing array additional Inference Specification. Total number of additional
|
|
1432
|
-
* Inference Specifications can not exceed 15. Each additional Inference Specification
|
|
1433
|
-
* specifies artifacts based on this model package that can be used on inference endpoints.
|
|
1434
|
-
* Generally used with SageMaker Neo to store the compiled artifacts.</p>
|
|
1247
|
+
* <p>An array of additional Inference Specification objects to be added to the existing array additional Inference Specification. Total number of additional Inference Specifications can not exceed 15. 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.</p>
|
|
1435
1248
|
* @public
|
|
1436
1249
|
*/
|
|
1437
1250
|
AdditionalInferenceSpecificationsToAdd?: AdditionalInferenceSpecificationDefinition[] | undefined;
|
|
1438
1251
|
/**
|
|
1439
|
-
* <p>Specifies details about inference jobs that you can run with models based on this
|
|
1440
|
-
* model package, including the following information:</p>
|
|
1441
|
-
* <ul>
|
|
1442
|
-
* <li>
|
|
1443
|
-
* <p>The Amazon ECR paths of containers that contain the inference code and model
|
|
1444
|
-
* artifacts.</p>
|
|
1445
|
-
* </li>
|
|
1446
|
-
* <li>
|
|
1447
|
-
* <p>The instance types that the model package supports for transform jobs and
|
|
1448
|
-
* real-time endpoints used for inference.</p>
|
|
1449
|
-
* </li>
|
|
1450
|
-
* <li>
|
|
1451
|
-
* <p>The input and output content formats that the model package supports for
|
|
1452
|
-
* inference.</p>
|
|
1453
|
-
* </li>
|
|
1454
|
-
* </ul>
|
|
1252
|
+
* <p>Specifies details about inference jobs that you can run with models based on this model package, including the following information:</p> <ul> <li> <p>The Amazon ECR paths of containers that contain the inference code and model artifacts.</p> </li> <li> <p>The instance types that the model package supports for transform jobs and real-time endpoints used for inference.</p> </li> <li> <p>The input and output content formats that the model package supports for inference.</p> </li> </ul>
|
|
1455
1253
|
* @public
|
|
1456
1254
|
*/
|
|
1457
1255
|
InferenceSpecification?: InferenceSpecification | undefined;
|
|
@@ -1461,16 +1259,7 @@ export interface UpdateModelPackageInput {
|
|
|
1461
1259
|
*/
|
|
1462
1260
|
SourceUri?: string | undefined;
|
|
1463
1261
|
/**
|
|
1464
|
-
* <p>The model card associated with the model package. Since
|
|
1465
|
-
* <code>ModelPackageModelCard</code> is tied to a model package, it is a specific
|
|
1466
|
-
* usage of a model card and its schema is simplified compared to the schema of
|
|
1467
|
-
* <code>ModelCard</code>. The <code>ModelPackageModelCard</code> schema does not
|
|
1468
|
-
* include <code>model_package_details</code>, and <code>model_overview</code> is composed
|
|
1469
|
-
* of the <code>model_creator</code> and <code>model_artifact</code> properties. For more
|
|
1470
|
-
* information about the model package model card schema, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-registry-details.html#model-card-schema">Model
|
|
1471
|
-
* package model card schema</a>. For more information about the model card
|
|
1472
|
-
* associated with the model package, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-registry-details.html">View the Details of a Model
|
|
1473
|
-
* Version</a>.</p>
|
|
1262
|
+
* <p>The model card associated with the model package. Since <code>ModelPackageModelCard</code> is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of <code>ModelCard</code>. The <code>ModelPackageModelCard</code> schema does not include <code>model_package_details</code>, and <code>model_overview</code> is composed of the <code>model_creator</code> and <code>model_artifact</code> properties. For more information about the model package model card schema, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-registry-details.html#model-card-schema">Model package model card schema</a>. For more information about the model card associated with the model package, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-registry-details.html">View the Details of a Model Version</a>.</p>
|
|
1474
1263
|
* @public
|
|
1475
1264
|
*/
|
|
1476
1265
|
ModelCard?: ModelPackageModelCard | undefined;
|
|
@@ -1510,14 +1299,12 @@ export interface UpdateMonitoringAlertRequest {
|
|
|
1510
1299
|
*/
|
|
1511
1300
|
MonitoringAlertName: string | undefined;
|
|
1512
1301
|
/**
|
|
1513
|
-
* <p>Within <code>EvaluationPeriod</code>, how many execution failures will raise an
|
|
1514
|
-
* alert.</p>
|
|
1302
|
+
* <p>Within <code>EvaluationPeriod</code>, how many execution failures will raise an alert.</p>
|
|
1515
1303
|
* @public
|
|
1516
1304
|
*/
|
|
1517
1305
|
DatapointsToAlert: number | undefined;
|
|
1518
1306
|
/**
|
|
1519
|
-
* <p>The number of most recent monitoring executions to consider when evaluating alert
|
|
1520
|
-
* status.</p>
|
|
1307
|
+
* <p>The number of most recent monitoring executions to consider when evaluating alert status.</p>
|
|
1521
1308
|
* @public
|
|
1522
1309
|
*/
|
|
1523
1310
|
EvaluationPeriod: number | undefined;
|
|
@@ -1542,14 +1329,12 @@ export interface UpdateMonitoringAlertResponse {
|
|
|
1542
1329
|
*/
|
|
1543
1330
|
export interface UpdateMonitoringScheduleRequest {
|
|
1544
1331
|
/**
|
|
1545
|
-
* <p>The name of the monitoring schedule. The name must be unique within an Amazon Web Services
|
|
1546
|
-
* Region within an Amazon Web Services account.</p>
|
|
1332
|
+
* <p>The name of the monitoring schedule. The name must be unique within an Amazon Web Services Region within an Amazon Web Services account.</p>
|
|
1547
1333
|
* @public
|
|
1548
1334
|
*/
|
|
1549
1335
|
MonitoringScheduleName: string | undefined;
|
|
1550
1336
|
/**
|
|
1551
|
-
* <p>The configuration object that specifies the monitoring schedule and defines the monitoring
|
|
1552
|
-
* job.</p>
|
|
1337
|
+
* <p>The configuration object that specifies the monitoring schedule and defines the monitoring job.</p>
|
|
1553
1338
|
* @public
|
|
1554
1339
|
*/
|
|
1555
1340
|
MonitoringScheduleConfig: MonitoringScheduleConfig | undefined;
|
|
@@ -1579,99 +1364,57 @@ export interface UpdateNotebookInstanceInput {
|
|
|
1579
1364
|
*/
|
|
1580
1365
|
InstanceType?: _InstanceType | undefined;
|
|
1581
1366
|
/**
|
|
1582
|
-
* <p>The Amazon Resource Name (ARN) of the IAM role that SageMaker AI can assume to
|
|
1583
|
-
* access the notebook instance. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html">SageMaker AI Roles</a>. </p>
|
|
1584
|
-
* <note>
|
|
1585
|
-
* <p>To be able to pass this role to SageMaker AI, the caller of this API must
|
|
1586
|
-
* have the <code>iam:PassRole</code> permission.</p>
|
|
1587
|
-
* </note>
|
|
1367
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that SageMaker AI can assume to access the notebook instance. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html">SageMaker AI Roles</a>. </p> <note> <p>To be able to pass this role to SageMaker AI, the caller of this API must have the <code>iam:PassRole</code> permission.</p> </note>
|
|
1588
1368
|
* @public
|
|
1589
1369
|
*/
|
|
1590
1370
|
RoleArn?: string | undefined;
|
|
1591
1371
|
/**
|
|
1592
|
-
* <p>The name of a lifecycle configuration to associate with the notebook instance. For
|
|
1593
|
-
* information about lifestyle configurations, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html">Step 2.1: (Optional)
|
|
1594
|
-
* Customize a Notebook Instance</a>.</p>
|
|
1372
|
+
* <p>The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html">Step 2.1: (Optional) Customize a Notebook Instance</a>.</p>
|
|
1595
1373
|
* @public
|
|
1596
1374
|
*/
|
|
1597
1375
|
LifecycleConfigName?: string | undefined;
|
|
1598
1376
|
/**
|
|
1599
|
-
* <p>Set to <code>true</code> to remove the notebook instance lifecycle configuration
|
|
1600
|
-
* currently associated with the notebook instance. This operation is idempotent. If you
|
|
1601
|
-
* specify a lifecycle configuration that is not associated with the notebook instance when
|
|
1602
|
-
* you call this method, it does not throw an error.</p>
|
|
1377
|
+
* <p>Set to <code>true</code> to remove the notebook instance lifecycle configuration currently associated with the notebook instance. This operation is idempotent. If you specify a lifecycle configuration that is not associated with the notebook instance when you call this method, it does not throw an error.</p>
|
|
1603
1378
|
* @public
|
|
1604
1379
|
*/
|
|
1605
1380
|
DisassociateLifecycleConfig?: boolean | undefined;
|
|
1606
1381
|
/**
|
|
1607
|
-
* <p>The size, in GB, of the ML storage volume to attach to the notebook instance. The
|
|
1608
|
-
* default value is 5 GB. ML storage volumes are encrypted, so SageMaker AI can't
|
|
1609
|
-
* determine the amount of available free space on the volume. Because of this, you can
|
|
1610
|
-
* increase the volume size when you update a notebook instance, but you can't decrease the
|
|
1611
|
-
* volume size. If you want to decrease the size of the ML storage volume in use, create a
|
|
1612
|
-
* new notebook instance with the desired size.</p>
|
|
1382
|
+
* <p>The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. ML storage volumes are encrypted, so SageMaker AI can't determine the amount of available free space on the volume. Because of this, you can increase the volume size when you update a notebook instance, but you can't decrease the volume size. If you want to decrease the size of the ML storage volume in use, create a new notebook instance with the desired size.</p>
|
|
1613
1383
|
* @public
|
|
1614
1384
|
*/
|
|
1615
1385
|
VolumeSizeInGB?: number | undefined;
|
|
1616
1386
|
/**
|
|
1617
|
-
* <p>The Git repository to associate with the notebook instance as its default code
|
|
1618
|
-
* repository. This can be either the name of a Git repository stored as a resource in your
|
|
1619
|
-
* account, or the URL of a Git repository in <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a>
|
|
1620
|
-
* or in any other Git repository. When you open a notebook instance, it opens in the
|
|
1621
|
-
* directory that contains this repository. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html">Associating Git
|
|
1622
|
-
* Repositories with SageMaker AI Notebook Instances</a>.</p>
|
|
1387
|
+
* <p>The 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 <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a> 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 <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html">Associating Git Repositories with SageMaker AI Notebook Instances</a>.</p>
|
|
1623
1388
|
* @public
|
|
1624
1389
|
*/
|
|
1625
1390
|
DefaultCodeRepository?: string | undefined;
|
|
1626
1391
|
/**
|
|
1627
|
-
* <p>An array of up to three Git repositories to associate with the notebook instance.
|
|
1628
|
-
* These can be either the names of Git repositories stored as resources in your account,
|
|
1629
|
-
* or the URL of Git repositories in <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a>
|
|
1630
|
-
* or in any other Git repository. These repositories are cloned at the same level as the
|
|
1631
|
-
* default repository of your notebook instance. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html">Associating Git
|
|
1632
|
-
* Repositories with SageMaker AI Notebook Instances</a>.</p>
|
|
1392
|
+
* <p>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 <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a> 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 <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html">Associating Git Repositories with SageMaker AI Notebook Instances</a>.</p>
|
|
1633
1393
|
* @public
|
|
1634
1394
|
*/
|
|
1635
1395
|
AdditionalCodeRepositories?: string[] | undefined;
|
|
1636
1396
|
/**
|
|
1637
|
-
* <p>This parameter is no longer supported. Elastic Inference (EI) is no longer
|
|
1638
|
-
* available.</p>
|
|
1639
|
-
* <p>This parameter was used to specify a list of the EI instance types to associate with
|
|
1640
|
-
* this notebook instance.</p>
|
|
1397
|
+
* <p>This parameter is no longer supported. Elastic Inference (EI) is no longer available.</p> <p>This parameter was used to specify a list of the EI instance types to associate with this notebook instance.</p>
|
|
1641
1398
|
* @public
|
|
1642
1399
|
*/
|
|
1643
1400
|
AcceleratorTypes?: NotebookInstanceAcceleratorType[] | undefined;
|
|
1644
1401
|
/**
|
|
1645
|
-
* <p>This parameter is no longer supported. Elastic Inference (EI) is no longer
|
|
1646
|
-
* available.</p>
|
|
1647
|
-
* <p>This parameter was used to specify a list of the EI instance types to remove from this notebook
|
|
1648
|
-
* instance.</p>
|
|
1402
|
+
* <p>This parameter is no longer supported. Elastic Inference (EI) is no longer available.</p> <p>This parameter was used to specify a list of the EI instance types to remove from this notebook instance.</p>
|
|
1649
1403
|
* @public
|
|
1650
1404
|
*/
|
|
1651
1405
|
DisassociateAcceleratorTypes?: boolean | undefined;
|
|
1652
1406
|
/**
|
|
1653
|
-
* <p>The name or URL of the default Git repository to remove from this notebook instance.
|
|
1654
|
-
* This operation is idempotent. If you specify a Git repository that is not associated
|
|
1655
|
-
* with the notebook instance when you call this method, it does not throw an error.</p>
|
|
1407
|
+
* <p>The name or URL of the default Git repository to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.</p>
|
|
1656
1408
|
* @public
|
|
1657
1409
|
*/
|
|
1658
1410
|
DisassociateDefaultCodeRepository?: boolean | undefined;
|
|
1659
1411
|
/**
|
|
1660
|
-
* <p>A list of names or URLs of the default Git repositories to remove from this notebook
|
|
1661
|
-
* instance. This operation is idempotent. If you specify a Git repository that is not
|
|
1662
|
-
* associated with the notebook instance when you call this method, it does not throw an
|
|
1663
|
-
* error.</p>
|
|
1412
|
+
* <p>A list of names or URLs of the default Git repositories to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.</p>
|
|
1664
1413
|
* @public
|
|
1665
1414
|
*/
|
|
1666
1415
|
DisassociateAdditionalCodeRepositories?: boolean | undefined;
|
|
1667
1416
|
/**
|
|
1668
|
-
* <p>Whether root access is enabled or disabled for users of the notebook instance. The
|
|
1669
|
-
* default value is <code>Enabled</code>.</p>
|
|
1670
|
-
* <note>
|
|
1671
|
-
* <p>If you set this to <code>Disabled</code>, users don't have root access on the
|
|
1672
|
-
* notebook instance, but lifecycle configuration scripts still run with root
|
|
1673
|
-
* permissions.</p>
|
|
1674
|
-
* </note>
|
|
1417
|
+
* <p>Whether root access is enabled or disabled for users of the notebook instance. The default value is <code>Enabled</code>.</p> <note> <p>If you set this to <code>Disabled</code>, users don't have root access on the notebook instance, but lifecycle configuration scripts still run with root permissions.</p> </note>
|
|
1675
1418
|
* @public
|
|
1676
1419
|
*/
|
|
1677
1420
|
RootAccess?: RootAccess | undefined;
|
|
@@ -1696,15 +1439,12 @@ export interface UpdateNotebookInstanceLifecycleConfigInput {
|
|
|
1696
1439
|
*/
|
|
1697
1440
|
NotebookInstanceLifecycleConfigName: string | undefined;
|
|
1698
1441
|
/**
|
|
1699
|
-
* <p>The shell script that runs only once, when you create a notebook instance. The shell
|
|
1700
|
-
* script must be a base64-encoded string.</p>
|
|
1442
|
+
* <p>The shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.</p>
|
|
1701
1443
|
* @public
|
|
1702
1444
|
*/
|
|
1703
1445
|
OnCreate?: NotebookInstanceLifecycleHook[] | undefined;
|
|
1704
1446
|
/**
|
|
1705
|
-
* <p>The shell script that runs every time you start a notebook instance, including when
|
|
1706
|
-
* you create the notebook instance. The shell script must be a base64-encoded
|
|
1707
|
-
* string.</p>
|
|
1447
|
+
* <p>The 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.</p>
|
|
1708
1448
|
* @public
|
|
1709
1449
|
*/
|
|
1710
1450
|
OnStart?: NotebookInstanceLifecycleHook[] | undefined;
|
|
@@ -1749,8 +1489,7 @@ export interface UpdatePartnerAppRequest {
|
|
|
1749
1489
|
*/
|
|
1750
1490
|
ClientToken?: string | undefined;
|
|
1751
1491
|
/**
|
|
1752
|
-
* <p>Each tag consists of a key and an optional value. Tag keys must be unique per
|
|
1753
|
-
* resource.</p>
|
|
1492
|
+
* <p>Each tag consists of a key and an optional value. Tag keys must be unique per resource.</p>
|
|
1754
1493
|
* @public
|
|
1755
1494
|
*/
|
|
1756
1495
|
Tags?: Tag[] | undefined;
|
|
@@ -1785,8 +1524,7 @@ export interface UpdatePipelineRequest {
|
|
|
1785
1524
|
*/
|
|
1786
1525
|
PipelineDefinition?: string | undefined;
|
|
1787
1526
|
/**
|
|
1788
|
-
* <p>The location of the pipeline definition stored in Amazon S3. If specified,
|
|
1789
|
-
* SageMaker will retrieve the pipeline definition from this location.</p>
|
|
1527
|
+
* <p>The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.</p>
|
|
1790
1528
|
* @public
|
|
1791
1529
|
*/
|
|
1792
1530
|
PipelineDefinitionS3Location?: PipelineDefinitionS3Location | undefined;
|
|
@@ -1836,8 +1574,7 @@ export interface UpdatePipelineExecutionRequest {
|
|
|
1836
1574
|
*/
|
|
1837
1575
|
PipelineExecutionDisplayName?: string | undefined;
|
|
1838
1576
|
/**
|
|
1839
|
-
* <p>This configuration, if specified, overrides the parallelism configuration
|
|
1840
|
-
* of the parent pipeline for this specific run.</p>
|
|
1577
|
+
* <p>This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.</p>
|
|
1841
1578
|
* @public
|
|
1842
1579
|
*/
|
|
1843
1580
|
ParallelismConfiguration?: ParallelismConfiguration | undefined;
|
|
@@ -1853,9 +1590,7 @@ export interface UpdatePipelineExecutionResponse {
|
|
|
1853
1590
|
PipelineExecutionArn?: string | undefined;
|
|
1854
1591
|
}
|
|
1855
1592
|
/**
|
|
1856
|
-
* <p>Details that you specify to provision a service catalog product.
|
|
1857
|
-
* For information about service catalog, see <a href="https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html">What is Amazon Web Services Service Catalog</a>.
|
|
1858
|
-
* </p>
|
|
1593
|
+
* <p>Details that you specify to provision a service catalog product. For information about service catalog, see <a href="https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html">What is Amazon Web Services Service Catalog</a>. </p>
|
|
1859
1594
|
* @public
|
|
1860
1595
|
*/
|
|
1861
1596
|
export interface ServiceCatalogProvisioningUpdateDetails {
|
|
@@ -1885,21 +1620,12 @@ export interface UpdateProjectInput {
|
|
|
1885
1620
|
*/
|
|
1886
1621
|
ProjectDescription?: string | undefined;
|
|
1887
1622
|
/**
|
|
1888
|
-
* <p>The product ID and provisioning artifact ID to provision a service catalog.
|
|
1889
|
-
* The provisioning artifact ID will default to the latest provisioning artifact
|
|
1890
|
-
* ID of the product, if you don't provide the provisioning artifact ID. For more
|
|
1891
|
-
* information, see <a href="https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html">What is Amazon Web Services Service Catalog</a>.
|
|
1892
|
-
* </p>
|
|
1623
|
+
* <p>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 <a href="https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html">What is Amazon Web Services Service Catalog</a>. </p>
|
|
1893
1624
|
* @public
|
|
1894
1625
|
*/
|
|
1895
1626
|
ServiceCatalogProvisioningUpdateDetails?: ServiceCatalogProvisioningUpdateDetails | undefined;
|
|
1896
1627
|
/**
|
|
1897
|
-
* <p>An array of key-value pairs. You can use tags to categorize your
|
|
1898
|
-
* Amazon Web Services resources in different ways, for example, by purpose, owner, or
|
|
1899
|
-
* environment. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a>.
|
|
1900
|
-
* In addition, the project must have tag update constraints set in order to include this
|
|
1901
|
-
* parameter in the request. For more information, see <a href="https://docs.aws.amazon.com/servicecatalog/latest/adminguide/constraints-resourceupdate.html">Amazon Web Services Service
|
|
1902
|
-
* Catalog Tag Update Constraints</a>.</p>
|
|
1628
|
+
* <p>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 <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a>. In addition, the project must have tag update constraints set in order to include this parameter in the request. For more information, see <a href="https://docs.aws.amazon.com/servicecatalog/latest/adminguide/constraints-resourceupdate.html">Amazon Web Services Service Catalog Tag Update Constraints</a>.</p>
|
|
1903
1629
|
* @public
|
|
1904
1630
|
*/
|
|
1905
1631
|
Tags?: Tag[] | undefined;
|
|
@@ -1959,30 +1685,22 @@ export interface UpdateTrainingJobRequest {
|
|
|
1959
1685
|
*/
|
|
1960
1686
|
TrainingJobName: string | undefined;
|
|
1961
1687
|
/**
|
|
1962
|
-
* <p>Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and
|
|
1963
|
-
* storage paths.</p>
|
|
1688
|
+
* <p>Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and storage paths.</p>
|
|
1964
1689
|
* @public
|
|
1965
1690
|
*/
|
|
1966
1691
|
ProfilerConfig?: ProfilerConfigForUpdate | undefined;
|
|
1967
1692
|
/**
|
|
1968
|
-
* <p>Configuration information for Amazon SageMaker Debugger rules for profiling system and framework
|
|
1969
|
-
* metrics.</p>
|
|
1693
|
+
* <p>Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.</p>
|
|
1970
1694
|
* @public
|
|
1971
1695
|
*/
|
|
1972
1696
|
ProfilerRuleConfigurations?: ProfilerRuleConfiguration[] | undefined;
|
|
1973
1697
|
/**
|
|
1974
|
-
* <p>The training job <code>ResourceConfig</code> to update warm pool retention
|
|
1975
|
-
* length.</p>
|
|
1698
|
+
* <p>The training job <code>ResourceConfig</code> to update warm pool retention length.</p>
|
|
1976
1699
|
* @public
|
|
1977
1700
|
*/
|
|
1978
1701
|
ResourceConfig?: ResourceConfigForUpdate | undefined;
|
|
1979
1702
|
/**
|
|
1980
|
-
* <p>Configuration for remote debugging while the training job is running. You can update
|
|
1981
|
-
* the remote debugging configuration when the <code>SecondaryStatus</code> of the job is
|
|
1982
|
-
* <code>Downloading</code> or <code>Training</code>.To learn more about the remote
|
|
1983
|
-
* debugging functionality of SageMaker, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/train-remote-debugging.html">Access a training container
|
|
1984
|
-
* through Amazon Web Services Systems Manager (SSM) for remote
|
|
1985
|
-
* debugging</a>.</p>
|
|
1703
|
+
* <p>Configuration for remote debugging while the training job is running. You can update the remote debugging configuration when the <code>SecondaryStatus</code> of the job is <code>Downloading</code> or <code>Training</code>.To learn more about the remote debugging functionality of SageMaker, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/train-remote-debugging.html">Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging</a>.</p>
|
|
1986
1704
|
* @public
|
|
1987
1705
|
*/
|
|
1988
1706
|
RemoteDebugConfig?: RemoteDebugConfigForUpdate | undefined;
|
|
@@ -2007,8 +1725,7 @@ export interface UpdateTrialRequest {
|
|
|
2007
1725
|
*/
|
|
2008
1726
|
TrialName: string | undefined;
|
|
2009
1727
|
/**
|
|
2010
|
-
* <p>The name of the trial as displayed. The name doesn't need to be unique. If
|
|
2011
|
-
* <code>DisplayName</code> isn't specified, <code>TrialName</code> is displayed.</p>
|
|
1728
|
+
* <p>The name of the trial as displayed. The name doesn't need to be unique. If <code>DisplayName</code> isn't specified, <code>TrialName</code> is displayed.</p>
|
|
2012
1729
|
* @public
|
|
2013
1730
|
*/
|
|
2014
1731
|
DisplayName?: string | undefined;
|
|
@@ -2033,9 +1750,7 @@ export interface UpdateTrialComponentRequest {
|
|
|
2033
1750
|
*/
|
|
2034
1751
|
TrialComponentName: string | undefined;
|
|
2035
1752
|
/**
|
|
2036
|
-
* <p>The name of the component as displayed. The name doesn't need to be unique. If
|
|
2037
|
-
* <code>DisplayName</code> isn't specified, <code>TrialComponentName</code> is
|
|
2038
|
-
* displayed.</p>
|
|
1753
|
+
* <p>The name of the component as displayed. The name doesn't need to be unique. If <code>DisplayName</code> isn't specified, <code>TrialComponentName</code> is displayed.</p>
|
|
2039
1754
|
* @public
|
|
2040
1755
|
*/
|
|
2041
1756
|
DisplayName?: string | undefined;
|
|
@@ -2130,21 +1845,17 @@ export interface UpdateUserProfileResponse {
|
|
|
2130
1845
|
*/
|
|
2131
1846
|
export interface UpdateWorkforceRequest {
|
|
2132
1847
|
/**
|
|
2133
|
-
* <p>The name of the private workforce that you want to update. You can find your workforce
|
|
2134
|
-
* name by using the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListWorkforces.html">ListWorkforces</a> operation.</p>
|
|
1848
|
+
* <p>The name of the private workforce that you want to update. You can find your workforce name by using the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListWorkforces.html">ListWorkforces</a> operation.</p>
|
|
2135
1849
|
* @public
|
|
2136
1850
|
*/
|
|
2137
1851
|
WorkforceName: string | undefined;
|
|
2138
1852
|
/**
|
|
2139
|
-
* <p>A list of one to ten worker IP address ranges (<a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">CIDRs</a>) that can be used to
|
|
2140
|
-
* access tasks assigned to this workforce.</p>
|
|
2141
|
-
* <p>Maximum: Ten CIDR values</p>
|
|
1853
|
+
* <p>A list of one to ten worker IP address ranges (<a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">CIDRs</a>) that can be used to access tasks assigned to this workforce.</p> <p>Maximum: Ten CIDR values</p>
|
|
2142
1854
|
* @public
|
|
2143
1855
|
*/
|
|
2144
1856
|
SourceIpConfig?: SourceIpConfig | undefined;
|
|
2145
1857
|
/**
|
|
2146
|
-
* <p>Use this parameter to update your OIDC Identity Provider (IdP)
|
|
2147
|
-
* configuration for a workforce made using your own IdP.</p>
|
|
1858
|
+
* <p>Use this parameter to update your OIDC Identity Provider (IdP) configuration for a workforce made using your own IdP.</p>
|
|
2148
1859
|
* @public
|
|
2149
1860
|
*/
|
|
2150
1861
|
OidcConfig?: OidcConfig | undefined;
|
|
@@ -2159,9 +1870,7 @@ export interface UpdateWorkforceRequest {
|
|
|
2159
1870
|
*/
|
|
2160
1871
|
export interface UpdateWorkforceResponse {
|
|
2161
1872
|
/**
|
|
2162
|
-
* <p>A single private workforce. You can create one private work force in each Amazon Web Services Region. By default,
|
|
2163
|
-
* any workforce-related API operation used in a specific region will apply to the
|
|
2164
|
-
* workforce created in that region. To learn how to create a private workforce, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private.html">Create a Private Workforce</a>.</p>
|
|
1873
|
+
* <p>A single private workforce. 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 <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private.html">Create a Private Workforce</a>.</p>
|
|
2165
1874
|
* @public
|
|
2166
1875
|
*/
|
|
2167
1876
|
Workforce: Workforce | undefined;
|
|
@@ -2176,26 +1885,7 @@ export interface UpdateWorkteamRequest {
|
|
|
2176
1885
|
*/
|
|
2177
1886
|
WorkteamName: string | undefined;
|
|
2178
1887
|
/**
|
|
2179
|
-
* <p>A list of <code>MemberDefinition</code> objects that contains objects that identify
|
|
2180
|
-
* the workers that make up the work team. </p>
|
|
2181
|
-
* <p>Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP).
|
|
2182
|
-
* For private workforces created using Amazon Cognito use
|
|
2183
|
-
* <code>CognitoMemberDefinition</code>. For workforces created using your own OIDC identity
|
|
2184
|
-
* provider (IdP) use <code>OidcMemberDefinition</code>. You should not provide input
|
|
2185
|
-
* for both of these parameters in a single request.</p>
|
|
2186
|
-
* <p>For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito
|
|
2187
|
-
* <i>user groups</i> within the user pool used to create a workforce. All of the
|
|
2188
|
-
* <code>CognitoMemberDefinition</code> objects that make up the member definition must
|
|
2189
|
-
* have the same <code>ClientId</code> and <code>UserPool</code> values. To add a Amazon
|
|
2190
|
-
* Cognito user group to an existing worker pool, see <a href="">Adding groups to a User
|
|
2191
|
-
* Pool</a>. For more information about user pools, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html">Amazon Cognito User
|
|
2192
|
-
* Pools</a>.</p>
|
|
2193
|
-
* <p>For workforces created using your own OIDC IdP, specify the user groups that you want
|
|
2194
|
-
* to include in your private work team in <code>OidcMemberDefinition</code> by listing
|
|
2195
|
-
* those groups in <code>Groups</code>. Be aware that user groups that are already in the
|
|
2196
|
-
* work team must also be listed in <code>Groups</code> when you make this request to
|
|
2197
|
-
* remain on the work team. If you do not include these user groups, they will no longer be
|
|
2198
|
-
* associated with the work team you update. </p>
|
|
1888
|
+
* <p>A list of <code>MemberDefinition</code> objects that contains objects that identify the workers that make up the work team. </p> <p>Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use <code>CognitoMemberDefinition</code>. For workforces created using your own OIDC identity provider (IdP) use <code>OidcMemberDefinition</code>. You should not provide input for both of these parameters in a single request.</p> <p>For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito <i>user groups</i> within the user pool used to create a workforce. All of the <code>CognitoMemberDefinition</code> objects that make up the member definition must have the same <code>ClientId</code> and <code>UserPool</code> values. To add a Amazon Cognito user group to an existing worker pool, see <a href="">Adding groups to a User Pool</a>. For more information about user pools, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html">Amazon Cognito User Pools</a>.</p> <p>For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private work team in <code>OidcMemberDefinition</code> by listing those groups in <code>Groups</code>. Be aware that user groups that are already in the work team must also be listed in <code>Groups</code> when you make this request to remain on the work team. If you do not include these user groups, they will no longer be associated with the work team you update. </p>
|
|
2199
1889
|
* @public
|
|
2200
1890
|
*/
|
|
2201
1891
|
MemberDefinitions?: MemberDefinition[] | undefined;
|
|
@@ -2226,29 +1916,7 @@ export interface UpdateWorkteamResponse {
|
|
|
2226
1916
|
Workteam: Workteam | undefined;
|
|
2227
1917
|
}
|
|
2228
1918
|
/**
|
|
2229
|
-
* <p>A multi-expression that searches for the specified resource or resources in a search. All
|
|
2230
|
-
* resource objects that satisfy the expression's condition are included in the search results.
|
|
2231
|
-
* You must specify at least one subexpression, filter, or nested filter. A
|
|
2232
|
-
* <code>SearchExpression</code> can contain up to twenty elements.</p>
|
|
2233
|
-
* <p>A <code>SearchExpression</code> contains the following components:</p>
|
|
2234
|
-
* <ul>
|
|
2235
|
-
* <li>
|
|
2236
|
-
* <p>A list of <code>Filter</code> objects. Each filter defines a simple Boolean expression
|
|
2237
|
-
* comprised of a resource property name, Boolean operator, and value.</p>
|
|
2238
|
-
* </li>
|
|
2239
|
-
* <li>
|
|
2240
|
-
* <p>A list of <code>NestedFilter</code> objects. Each nested filter defines a list of
|
|
2241
|
-
* Boolean expressions using a list of resource properties. A nested filter is satisfied if a
|
|
2242
|
-
* single object in the list satisfies all Boolean expressions.</p>
|
|
2243
|
-
* </li>
|
|
2244
|
-
* <li>
|
|
2245
|
-
* <p>A list of <code>SearchExpression</code> objects. A search expression object can be
|
|
2246
|
-
* nested in a list of search expression objects.</p>
|
|
2247
|
-
* </li>
|
|
2248
|
-
* <li>
|
|
2249
|
-
* <p>A Boolean operator: <code>And</code> or <code>Or</code>.</p>
|
|
2250
|
-
* </li>
|
|
2251
|
-
* </ul>
|
|
1919
|
+
* <p>A multi-expression 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. You must specify at least one subexpression, filter, or nested filter. A <code>SearchExpression</code> can contain up to twenty elements.</p> <p>A <code>SearchExpression</code> contains the following components:</p> <ul> <li> <p>A list of <code>Filter</code> objects. Each filter defines a simple Boolean expression comprised of a resource property name, Boolean operator, and value.</p> </li> <li> <p>A list of <code>NestedFilter</code> objects. Each nested filter defines a list of Boolean expressions using a list of resource properties. A nested filter is satisfied if a single object in the list satisfies all Boolean expressions.</p> </li> <li> <p>A list of <code>SearchExpression</code> objects. A search expression object can be nested in a list of search expression objects.</p> </li> <li> <p>A Boolean operator: <code>And</code> or <code>Or</code>.</p> </li> </ul>
|
|
2252
1920
|
* @public
|
|
2253
1921
|
*/
|
|
2254
1922
|
export interface SearchExpression {
|
|
@@ -2268,11 +1936,7 @@ export interface SearchExpression {
|
|
|
2268
1936
|
*/
|
|
2269
1937
|
SubExpressions?: SearchExpression[] | undefined;
|
|
2270
1938
|
/**
|
|
2271
|
-
* <p>A Boolean operator used to evaluate the search expression. If you want every conditional
|
|
2272
|
-
* statement in all lists to be satisfied for the entire search expression to be true, specify
|
|
2273
|
-
* <code>And</code>. If only a single conditional statement needs to be true for the entire
|
|
2274
|
-
* search expression to be true, specify <code>Or</code>. The default value is
|
|
2275
|
-
* <code>And</code>.</p>
|
|
1939
|
+
* <p>A Boolean operator used to evaluate the search expression. If you want every conditional statement in all lists to be satisfied for the entire search expression to be true, specify <code>And</code>. If only a single conditional statement needs to be true for the entire search expression to be true, specify <code>Or</code>. The default value is <code>And</code>.</p>
|
|
2276
1940
|
* @public
|
|
2277
1941
|
*/
|
|
2278
1942
|
Operator?: BooleanOperator | undefined;
|
|
@@ -2287,31 +1951,22 @@ export interface SearchRequest {
|
|
|
2287
1951
|
*/
|
|
2288
1952
|
Resource: ResourceType | undefined;
|
|
2289
1953
|
/**
|
|
2290
|
-
* <p>A Boolean conditional statement. Resources must satisfy this condition to be included in
|
|
2291
|
-
* search results. You must provide at least one subexpression, filter, or nested filter. The
|
|
2292
|
-
* maximum number of recursive <code>SubExpressions</code>, <code>NestedFilters</code>, and
|
|
2293
|
-
* <code>Filters</code> that can be included in a <code>SearchExpression</code> object is
|
|
2294
|
-
* 50.</p>
|
|
1954
|
+
* <p>A Boolean conditional statement. Resources must satisfy this condition to be included in search results. You must provide at least one subexpression, filter, or nested filter. The maximum number of recursive <code>SubExpressions</code>, <code>NestedFilters</code>, and <code>Filters</code> that can be included in a <code>SearchExpression</code> object is 50.</p>
|
|
2295
1955
|
* @public
|
|
2296
1956
|
*/
|
|
2297
1957
|
SearchExpression?: SearchExpression | undefined;
|
|
2298
1958
|
/**
|
|
2299
|
-
* <p>The name of the resource property used to sort the <code>SearchResults</code>. The default
|
|
2300
|
-
* is <code>LastModifiedTime</code>.</p>
|
|
1959
|
+
* <p>The name of the resource property used to sort the <code>SearchResults</code>. The default is <code>LastModifiedTime</code>.</p>
|
|
2301
1960
|
* @public
|
|
2302
1961
|
*/
|
|
2303
1962
|
SortBy?: string | undefined;
|
|
2304
1963
|
/**
|
|
2305
|
-
* <p>How <code>SearchResults</code> are ordered. Valid values are <code>Ascending</code> or
|
|
2306
|
-
* <code>Descending</code>. The default is <code>Descending</code>.</p>
|
|
1964
|
+
* <p>How <code>SearchResults</code> are ordered. Valid values are <code>Ascending</code> or <code>Descending</code>. The default is <code>Descending</code>.</p>
|
|
2307
1965
|
* @public
|
|
2308
1966
|
*/
|
|
2309
1967
|
SortOrder?: SearchSortOrder | undefined;
|
|
2310
1968
|
/**
|
|
2311
|
-
* <p>If more than <code>MaxResults</code> resources match the specified
|
|
2312
|
-
* <code>SearchExpression</code>, the response includes a <code>NextToken</code>. The
|
|
2313
|
-
* <code>NextToken</code> can be passed to the next <code>SearchRequest</code> to continue
|
|
2314
|
-
* retrieving results.</p>
|
|
1969
|
+
* <p>If more than <code>MaxResults</code> resources match the specified <code>SearchExpression</code>, the response includes a <code>NextToken</code>. The <code>NextToken</code> can be passed to the next <code>SearchRequest</code> to continue retrieving results.</p>
|
|
2315
1970
|
* @public
|
|
2316
1971
|
*/
|
|
2317
1972
|
NextToken?: string | undefined;
|
|
@@ -2321,13 +1976,7 @@ export interface SearchRequest {
|
|
|
2321
1976
|
*/
|
|
2322
1977
|
MaxResults?: number | undefined;
|
|
2323
1978
|
/**
|
|
2324
|
-
* <p> A cross account filter option. When the value is <code>"CrossAccount"</code> the search
|
|
2325
|
-
* results will only include resources made discoverable to you from other accounts. When the
|
|
2326
|
-
* value is <code>"SameAccount"</code> or <code>null</code> the search results will only include
|
|
2327
|
-
* resources from your account. Default is <code>null</code>. For more information on searching
|
|
2328
|
-
* for resources made discoverable to your account, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/feature-store-cross-account-discoverability-use.html"> Search
|
|
2329
|
-
* discoverable resources</a> in the SageMaker Developer Guide. The maximum number of
|
|
2330
|
-
* <code>ResourceCatalog</code>s viewable is 1000. </p>
|
|
1979
|
+
* <p> A cross account filter option. When the value is <code>"CrossAccount"</code> the search results will only include resources made discoverable to you from other accounts. When the value is <code>"SameAccount"</code> or <code>null</code> the search results will only include resources from your account. Default is <code>null</code>. For more information on searching for resources made discoverable to your account, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/feature-store-cross-account-discoverability-use.html"> Search discoverable resources</a> in the SageMaker Developer Guide. The maximum number of <code>ResourceCatalog</code>s viewable is 1000. </p>
|
|
2331
1980
|
* @public
|
|
2332
1981
|
*/
|
|
2333
1982
|
CrossAccountFilterOption?: CrossAccountFilterOption | undefined;
|