@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
|
@@ -17,30 +17,22 @@ export interface MonitoringInput {
|
|
|
17
17
|
BatchTransformInput?: BatchTransformInput | undefined;
|
|
18
18
|
}
|
|
19
19
|
/**
|
|
20
|
-
* <p>Networking options for a job, such as network traffic encryption between containers,
|
|
21
|
-
* whether to allow inbound and outbound network calls to and from containers, and the VPC
|
|
22
|
-
* subnets and security groups to use for VPC-enabled jobs.</p>
|
|
20
|
+
* <p>Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.</p>
|
|
23
21
|
* @public
|
|
24
22
|
*/
|
|
25
23
|
export interface NetworkConfig {
|
|
26
24
|
/**
|
|
27
|
-
* <p>Whether to encrypt all communications between distributed processing jobs. Choose
|
|
28
|
-
* <code>True</code> to encrypt communications. Encryption provides greater security
|
|
29
|
-
* for distributed processing jobs, but the processing might take longer.</p>
|
|
25
|
+
* <p>Whether to encrypt all communications between distributed processing jobs. Choose <code>True</code> to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer.</p>
|
|
30
26
|
* @public
|
|
31
27
|
*/
|
|
32
28
|
EnableInterContainerTrafficEncryption?: boolean | undefined;
|
|
33
29
|
/**
|
|
34
|
-
* <p>Whether to allow inbound and outbound network calls to and from the containers used for
|
|
35
|
-
* the processing job.</p>
|
|
30
|
+
* <p>Whether to allow inbound and outbound network calls to and from the containers used for the processing job.</p>
|
|
36
31
|
* @public
|
|
37
32
|
*/
|
|
38
33
|
EnableNetworkIsolation?: boolean | undefined;
|
|
39
34
|
/**
|
|
40
|
-
* <p>Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources
|
|
41
|
-
* have access to. You can control access to and from your resources by configuring a VPC.
|
|
42
|
-
* For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html">Give SageMaker Access to
|
|
43
|
-
* Resources in your Amazon VPC</a>. </p>
|
|
35
|
+
* <p>Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html">Give SageMaker Access to Resources in your Amazon VPC</a>. </p>
|
|
44
36
|
* @public
|
|
45
37
|
*/
|
|
46
38
|
VpcConfig?: VpcConfig | undefined;
|
|
@@ -51,8 +43,7 @@ export interface NetworkConfig {
|
|
|
51
43
|
*/
|
|
52
44
|
export interface MonitoringJobDefinition {
|
|
53
45
|
/**
|
|
54
|
-
* <p>Baseline configuration used to validate that the data conforms to the specified
|
|
55
|
-
* constraints and statistics</p>
|
|
46
|
+
* <p>Baseline configuration used to validate that the data conforms to the specified constraints and statistics</p>
|
|
56
47
|
* @public
|
|
57
48
|
*/
|
|
58
49
|
BaselineConfig?: MonitoringBaselineConfig | undefined;
|
|
@@ -67,8 +58,7 @@ export interface MonitoringJobDefinition {
|
|
|
67
58
|
*/
|
|
68
59
|
MonitoringOutputConfig: MonitoringOutputConfig | undefined;
|
|
69
60
|
/**
|
|
70
|
-
* <p>Identifies the resources, ML compute instances, and ML storage volumes to deploy for a
|
|
71
|
-
* monitoring job. In distributed processing, you specify more than one instance.</p>
|
|
61
|
+
* <p>Identifies the resources, ML compute instances, and ML storage volumes to deploy for a monitoring job. In distributed processing, you specify more than one instance.</p>
|
|
72
62
|
* @public
|
|
73
63
|
*/
|
|
74
64
|
MonitoringResources: MonitoringResources | undefined;
|
|
@@ -93,8 +83,7 @@ export interface MonitoringJobDefinition {
|
|
|
93
83
|
*/
|
|
94
84
|
NetworkConfig?: NetworkConfig | undefined;
|
|
95
85
|
/**
|
|
96
|
-
* <p>The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can
|
|
97
|
-
* assume to perform tasks on your behalf.</p>
|
|
86
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.</p>
|
|
98
87
|
* @public
|
|
99
88
|
*/
|
|
100
89
|
RoleArn: string | undefined;
|
|
@@ -119,98 +108,17 @@ export type MonitoringType = (typeof MonitoringType)[keyof typeof MonitoringType
|
|
|
119
108
|
*/
|
|
120
109
|
export interface ScheduleConfig {
|
|
121
110
|
/**
|
|
122
|
-
* <p>A cron expression that describes details about the monitoring schedule.</p>
|
|
123
|
-
* <p>The supported cron expressions are:</p>
|
|
124
|
-
* <ul>
|
|
125
|
-
* <li>
|
|
126
|
-
* <p>If you want to set the job to start every hour, use the following:</p>
|
|
127
|
-
* <p>
|
|
128
|
-
* <code>Hourly: cron(0 * ? * * *)</code>
|
|
129
|
-
* </p>
|
|
130
|
-
* </li>
|
|
131
|
-
* <li>
|
|
132
|
-
* <p>If you want to start the job daily:</p>
|
|
133
|
-
* <p>
|
|
134
|
-
* <code>cron(0 [00-23] ? * * *)</code>
|
|
135
|
-
* </p>
|
|
136
|
-
* </li>
|
|
137
|
-
* <li>
|
|
138
|
-
* <p>If you want to run the job one time, immediately, use the following
|
|
139
|
-
* keyword:</p>
|
|
140
|
-
* <p>
|
|
141
|
-
* <code>NOW</code>
|
|
142
|
-
* </p>
|
|
143
|
-
* </li>
|
|
144
|
-
* </ul>
|
|
145
|
-
* <p>For example, the following are valid cron expressions:</p>
|
|
146
|
-
* <ul>
|
|
147
|
-
* <li>
|
|
148
|
-
* <p>Daily at noon UTC: <code>cron(0 12 ? * * *)</code>
|
|
149
|
-
* </p>
|
|
150
|
-
* </li>
|
|
151
|
-
* <li>
|
|
152
|
-
* <p>Daily at midnight UTC: <code>cron(0 0 ? * * *)</code>
|
|
153
|
-
* </p>
|
|
154
|
-
* </li>
|
|
155
|
-
* </ul>
|
|
156
|
-
* <p>To support running every 6, 12 hours, the following are also supported:</p>
|
|
157
|
-
* <p>
|
|
158
|
-
* <code>cron(0 [00-23]/[01-24] ? * * *)</code>
|
|
159
|
-
* </p>
|
|
160
|
-
* <p>For example, the following are valid cron expressions:</p>
|
|
161
|
-
* <ul>
|
|
162
|
-
* <li>
|
|
163
|
-
* <p>Every 12 hours, starting at 5pm UTC: <code>cron(0 17/12 ? * * *)</code>
|
|
164
|
-
* </p>
|
|
165
|
-
* </li>
|
|
166
|
-
* <li>
|
|
167
|
-
* <p>Every two hours starting at midnight: <code>cron(0 0/2 ? * * *)</code>
|
|
168
|
-
* </p>
|
|
169
|
-
* </li>
|
|
170
|
-
* </ul>
|
|
171
|
-
* <note>
|
|
172
|
-
* <ul>
|
|
173
|
-
* <li>
|
|
174
|
-
* <p>Even though the cron expression is set to start at 5PM UTC, note that there
|
|
175
|
-
* could be a delay of 0-20 minutes from the actual requested time to run the
|
|
176
|
-
* execution. </p>
|
|
177
|
-
* </li>
|
|
178
|
-
* <li>
|
|
179
|
-
* <p>We recommend that if you would like a daily schedule, you do not provide this
|
|
180
|
-
* parameter. Amazon SageMaker AI will pick a time for running every day.</p>
|
|
181
|
-
* </li>
|
|
182
|
-
* </ul>
|
|
183
|
-
* </note>
|
|
184
|
-
* <p>You can also specify the keyword <code>NOW</code> to run the monitoring job immediately,
|
|
185
|
-
* one time, without recurring.</p>
|
|
111
|
+
* <p>A cron expression that describes details about the monitoring schedule.</p> <p>The supported cron expressions are:</p> <ul> <li> <p>If you want to set the job to start every hour, use the following:</p> <p> <code>Hourly: cron(0 * ? * * *)</code> </p> </li> <li> <p>If you want to start the job daily:</p> <p> <code>cron(0 [00-23] ? * * *)</code> </p> </li> <li> <p>If you want to run the job one time, immediately, use the following keyword:</p> <p> <code>NOW</code> </p> </li> </ul> <p>For example, the following are valid cron expressions:</p> <ul> <li> <p>Daily at noon UTC: <code>cron(0 12 ? * * *)</code> </p> </li> <li> <p>Daily at midnight UTC: <code>cron(0 0 ? * * *)</code> </p> </li> </ul> <p>To support running every 6, 12 hours, the following are also supported:</p> <p> <code>cron(0 [00-23]/[01-24] ? * * *)</code> </p> <p>For example, the following are valid cron expressions:</p> <ul> <li> <p>Every 12 hours, starting at 5pm UTC: <code>cron(0 17/12 ? * * *)</code> </p> </li> <li> <p>Every two hours starting at midnight: <code>cron(0 0/2 ? * * *)</code> </p> </li> </ul> <note> <ul> <li> <p>Even though the cron expression is set to start at 5PM UTC, note that there could be a delay of 0-20 minutes from the actual requested time to run the execution. </p> </li> <li> <p>We recommend that if you would like a daily schedule, you do not provide this parameter. Amazon SageMaker AI will pick a time for running every day.</p> </li> </ul> </note> <p>You can also specify the keyword <code>NOW</code> to run the monitoring job immediately, one time, without recurring.</p>
|
|
186
112
|
* @public
|
|
187
113
|
*/
|
|
188
114
|
ScheduleExpression: string | undefined;
|
|
189
115
|
/**
|
|
190
|
-
* <p>Sets the start time for a monitoring job window. Express this time as an offset to the
|
|
191
|
-
* times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the
|
|
192
|
-
* <code>ScheduleExpression</code> parameter. Specify this offset in ISO 8601 duration
|
|
193
|
-
* format. For example, if you want to monitor the five hours of data in your dataset that
|
|
194
|
-
* precede the start of each monitoring job, you would specify: <code>"-PT5H"</code>.</p>
|
|
195
|
-
* <p>The start time that you specify must not precede the end time that you specify by more
|
|
196
|
-
* than 24 hours. You specify the end time with the <code>DataAnalysisEndTime</code>
|
|
197
|
-
* parameter.</p>
|
|
198
|
-
* <p>If you set <code>ScheduleExpression</code> to <code>NOW</code>, this parameter is
|
|
199
|
-
* required.</p>
|
|
116
|
+
* <p>Sets the start time for a monitoring job window. Express this time as an offset to the times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the <code>ScheduleExpression</code> parameter. Specify this offset in ISO 8601 duration format. For example, if you want to monitor the five hours of data in your dataset that precede the start of each monitoring job, you would specify: <code>"-PT5H"</code>.</p> <p>The start time that you specify must not precede the end time that you specify by more than 24 hours. You specify the end time with the <code>DataAnalysisEndTime</code> parameter.</p> <p>If you set <code>ScheduleExpression</code> to <code>NOW</code>, this parameter is required.</p>
|
|
200
117
|
* @public
|
|
201
118
|
*/
|
|
202
119
|
DataAnalysisStartTime?: string | undefined;
|
|
203
120
|
/**
|
|
204
|
-
* <p>Sets the end time for a monitoring job window. Express this time as an offset to the
|
|
205
|
-
* times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the
|
|
206
|
-
* <code>ScheduleExpression</code> parameter. Specify this offset in ISO 8601 duration
|
|
207
|
-
* format. For example, if you want to end the window one hour before the start of each
|
|
208
|
-
* monitoring job, you would specify: <code>"-PT1H"</code>.</p>
|
|
209
|
-
* <p>The end time that you specify must not follow the start time that you specify by more
|
|
210
|
-
* than 24 hours. You specify the start time with the <code>DataAnalysisStartTime</code>
|
|
211
|
-
* parameter.</p>
|
|
212
|
-
* <p>If you set <code>ScheduleExpression</code> to <code>NOW</code>, this parameter is
|
|
213
|
-
* required.</p>
|
|
121
|
+
* <p>Sets the end time for a monitoring job window. Express this time as an offset to the times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the <code>ScheduleExpression</code> parameter. Specify this offset in ISO 8601 duration format. For example, if you want to end the window one hour before the start of each monitoring job, you would specify: <code>"-PT1H"</code>.</p> <p>The end time that you specify must not follow the start time that you specify by more than 24 hours. You specify the start time with the <code>DataAnalysisStartTime</code> parameter.</p> <p>If you set <code>ScheduleExpression</code> to <code>NOW</code>, this parameter is required.</p>
|
|
214
122
|
* @public
|
|
215
123
|
*/
|
|
216
124
|
DataAnalysisEndTime?: string | undefined;
|
|
@@ -246,20 +154,17 @@ export interface MonitoringScheduleConfig {
|
|
|
246
154
|
*/
|
|
247
155
|
export interface CreateMonitoringScheduleRequest {
|
|
248
156
|
/**
|
|
249
|
-
* <p>The name of the monitoring schedule. The name must be unique within an Amazon Web Services
|
|
250
|
-
* Region within an Amazon Web Services account.</p>
|
|
157
|
+
* <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>
|
|
251
158
|
* @public
|
|
252
159
|
*/
|
|
253
160
|
MonitoringScheduleName: string | undefined;
|
|
254
161
|
/**
|
|
255
|
-
* <p>The configuration object that specifies the monitoring schedule and defines the monitoring
|
|
256
|
-
* job.</p>
|
|
162
|
+
* <p>The configuration object that specifies the monitoring schedule and defines the monitoring job.</p>
|
|
257
163
|
* @public
|
|
258
164
|
*/
|
|
259
165
|
MonitoringScheduleConfig: MonitoringScheduleConfig | undefined;
|
|
260
166
|
/**
|
|
261
|
-
* <p>(Optional) An array of key-value pairs. For more information, see <a href=" https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL">Using Cost Allocation Tags</a> in the <i>Amazon Web Services Billing and Cost
|
|
262
|
-
* Management User Guide</i>.</p>
|
|
167
|
+
* <p>(Optional) An array of key-value pairs. For more information, see <a href=" https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL">Using Cost Allocation Tags</a> in the <i>Amazon Web Services Billing and Cost Management User Guide</i>.</p>
|
|
263
168
|
* @public
|
|
264
169
|
*/
|
|
265
170
|
Tags?: Tag[] | undefined;
|
|
@@ -308,10 +213,7 @@ export type DirectInternetAccess = (typeof DirectInternetAccess)[keyof typeof Di
|
|
|
308
213
|
*/
|
|
309
214
|
export interface InstanceMetadataServiceConfiguration {
|
|
310
215
|
/**
|
|
311
|
-
* <p>Indicates the minimum IMDS version that the notebook instance supports. When passed as
|
|
312
|
-
* part of <code>CreateNotebookInstance</code>, if no value is selected, then it defaults
|
|
313
|
-
* to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part of
|
|
314
|
-
* <code>UpdateNotebookInstance</code>, there is no default.</p>
|
|
216
|
+
* <p>Indicates the minimum IMDS version that the notebook instance supports. When passed as part of <code>CreateNotebookInstance</code>, if no value is selected, then it defaults to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part of <code>UpdateNotebookInstance</code>, there is no default.</p>
|
|
315
217
|
* @public
|
|
316
218
|
*/
|
|
317
219
|
MinimumInstanceMetadataServiceVersion: string | undefined;
|
|
@@ -343,107 +245,62 @@ export interface CreateNotebookInstanceInput {
|
|
|
343
245
|
*/
|
|
344
246
|
InstanceType: _InstanceType | undefined;
|
|
345
247
|
/**
|
|
346
|
-
* <p>The ID of the subnet in a VPC to which you would like to have a connectivity from
|
|
347
|
-
* your ML compute instance. </p>
|
|
248
|
+
* <p>The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance. </p>
|
|
348
249
|
* @public
|
|
349
250
|
*/
|
|
350
251
|
SubnetId?: string | undefined;
|
|
351
252
|
/**
|
|
352
|
-
* <p>The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be
|
|
353
|
-
* for the same VPC as specified in the subnet. </p>
|
|
253
|
+
* <p>The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet. </p>
|
|
354
254
|
* @public
|
|
355
255
|
*/
|
|
356
256
|
SecurityGroupIds?: string[] | undefined;
|
|
357
257
|
/**
|
|
358
|
-
* <p> When you send any requests to Amazon Web Services resources from the notebook
|
|
359
|
-
* instance, SageMaker AI assumes this role to perform tasks on your behalf. You must
|
|
360
|
-
* grant this role necessary permissions so SageMaker AI can perform these tasks. The
|
|
361
|
-
* policy must allow the SageMaker AI service principal (sagemaker.amazonaws.com)
|
|
362
|
-
* permissions to assume this role. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html">SageMaker AI Roles</a>. </p>
|
|
363
|
-
* <note>
|
|
364
|
-
* <p>To be able to pass this role to SageMaker AI, the caller of this API must
|
|
365
|
-
* have the <code>iam:PassRole</code> permission.</p>
|
|
366
|
-
* </note>
|
|
258
|
+
* <p> When you send any requests to Amazon Web Services resources from the notebook instance, SageMaker AI assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so SageMaker AI can perform these tasks. The policy must allow the SageMaker AI service principal (sagemaker.amazonaws.com) permissions to assume this role. 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>
|
|
367
259
|
* @public
|
|
368
260
|
*/
|
|
369
261
|
RoleArn: string | undefined;
|
|
370
262
|
/**
|
|
371
|
-
* <p>The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that
|
|
372
|
-
* SageMaker AI uses to encrypt data on the storage volume attached to your
|
|
373
|
-
* notebook instance. The KMS key you provide must be enabled. For information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/enabling-keys.html">Enabling and
|
|
374
|
-
* Disabling Keys</a> in the <i>Amazon Web Services Key Management Service
|
|
375
|
-
* Developer Guide</i>.</p>
|
|
263
|
+
* <p>The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker AI uses to encrypt data on the storage volume attached to your notebook instance. The KMS key you provide must be enabled. For information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/enabling-keys.html">Enabling and Disabling Keys</a> in the <i>Amazon Web Services Key Management Service Developer Guide</i>.</p>
|
|
376
264
|
* @public
|
|
377
265
|
*/
|
|
378
266
|
KmsKeyId?: string | undefined;
|
|
379
267
|
/**
|
|
380
|
-
* <p>An array of key-value pairs. You can use tags to categorize your Amazon Web Services
|
|
381
|
-
* resources in different ways, for example, by purpose, owner, or environment. For more
|
|
382
|
-
* information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a>.</p>
|
|
268
|
+
* <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>.</p>
|
|
383
269
|
* @public
|
|
384
270
|
*/
|
|
385
271
|
Tags?: Tag[] | undefined;
|
|
386
272
|
/**
|
|
387
|
-
* <p>The name of a lifecycle configuration to associate with the notebook instance. For
|
|
388
|
-
* information about lifestyle configurations, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html">Step 2.1: (Optional)
|
|
389
|
-
* Customize a Notebook Instance</a>.</p>
|
|
273
|
+
* <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>
|
|
390
274
|
* @public
|
|
391
275
|
*/
|
|
392
276
|
LifecycleConfigName?: string | undefined;
|
|
393
277
|
/**
|
|
394
|
-
* <p>Sets whether SageMaker AI provides internet access to the notebook instance. If
|
|
395
|
-
* you set this to <code>Disabled</code> this notebook instance is able to access resources
|
|
396
|
-
* only in your VPC, and is not be able to connect to SageMaker AI training and
|
|
397
|
-
* endpoint services unless you configure a NAT Gateway in your VPC.</p>
|
|
398
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/appendix-additional-considerations.html#appendix-notebook-and-internet-access">Notebook Instances Are Internet-Enabled by Default</a>. You can set the value
|
|
399
|
-
* of this parameter to <code>Disabled</code> only if you set a value for the
|
|
400
|
-
* <code>SubnetId</code> parameter.</p>
|
|
278
|
+
* <p>Sets whether SageMaker AI provides internet access to the notebook instance. If you set this to <code>Disabled</code> this notebook instance is able to access resources only in your VPC, and is not be able to connect to SageMaker AI training and endpoint services unless you configure a NAT Gateway in your VPC.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/appendix-additional-considerations.html#appendix-notebook-and-internet-access">Notebook Instances Are Internet-Enabled by Default</a>. You can set the value of this parameter to <code>Disabled</code> only if you set a value for the <code>SubnetId</code> parameter.</p>
|
|
401
279
|
* @public
|
|
402
280
|
*/
|
|
403
281
|
DirectInternetAccess?: DirectInternetAccess | undefined;
|
|
404
282
|
/**
|
|
405
|
-
* <p>The size, in GB, of the ML storage volume to attach to the notebook instance. The
|
|
406
|
-
* default value is 5 GB.</p>
|
|
283
|
+
* <p>The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.</p>
|
|
407
284
|
* @public
|
|
408
285
|
*/
|
|
409
286
|
VolumeSizeInGB?: number | undefined;
|
|
410
287
|
/**
|
|
411
|
-
* <p>This parameter is no longer supported. Elastic Inference (EI) is no longer
|
|
412
|
-
* available.</p>
|
|
413
|
-
* <p>This parameter was used to specify a list of EI instance types to associate with this
|
|
414
|
-
* notebook instance.</p>
|
|
288
|
+
* <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 EI instance types to associate with this notebook instance.</p>
|
|
415
289
|
* @public
|
|
416
290
|
*/
|
|
417
291
|
AcceleratorTypes?: NotebookInstanceAcceleratorType[] | undefined;
|
|
418
292
|
/**
|
|
419
|
-
* <p>A Git repository to associate with the notebook instance as its default code
|
|
420
|
-
* repository. This can be either the name of a Git repository stored as a resource in your
|
|
421
|
-
* 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>
|
|
422
|
-
* or in any other Git repository. When you open a notebook instance, it opens in the
|
|
423
|
-
* 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
|
|
424
|
-
* Repositories with SageMaker AI Notebook Instances</a>.</p>
|
|
293
|
+
* <p>A Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in <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>
|
|
425
294
|
* @public
|
|
426
295
|
*/
|
|
427
296
|
DefaultCodeRepository?: string | undefined;
|
|
428
297
|
/**
|
|
429
|
-
* <p>An array of up to three Git repositories to associate with the notebook instance.
|
|
430
|
-
* These can be either the names of Git repositories stored as resources in your account,
|
|
431
|
-
* or the URL of Git repositories in <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a>
|
|
432
|
-
* or in any other Git repository. These repositories are cloned at the same level as the
|
|
433
|
-
* 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
|
|
434
|
-
* Repositories with SageMaker AI Notebook Instances</a>.</p>
|
|
298
|
+
* <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>
|
|
435
299
|
* @public
|
|
436
300
|
*/
|
|
437
301
|
AdditionalCodeRepositories?: string[] | undefined;
|
|
438
302
|
/**
|
|
439
|
-
* <p>Whether root access is enabled or disabled for users of the notebook instance. The
|
|
440
|
-
* default value is <code>Enabled</code>.</p>
|
|
441
|
-
* <note>
|
|
442
|
-
* <p>Lifecycle configurations need root access to be able to set up a notebook
|
|
443
|
-
* instance. Because of this, lifecycle configurations associated with a notebook
|
|
444
|
-
* instance always run with root access even if you disable root access for
|
|
445
|
-
* users.</p>
|
|
446
|
-
* </note>
|
|
303
|
+
* <p>Whether root access is enabled or disabled for users of the notebook instance. The default value is <code>Enabled</code>.</p> <note> <p>Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.</p> </note>
|
|
447
304
|
* @public
|
|
448
305
|
*/
|
|
449
306
|
RootAccess?: RootAccess | undefined;
|
|
@@ -469,24 +326,12 @@ export interface CreateNotebookInstanceOutput {
|
|
|
469
326
|
NotebookInstanceArn?: string | undefined;
|
|
470
327
|
}
|
|
471
328
|
/**
|
|
472
|
-
* <p>Contains the notebook instance lifecycle configuration script.</p>
|
|
473
|
-
* <p>Each lifecycle configuration script has a limit of 16384 characters.</p>
|
|
474
|
-
* <p>The value of the <code>$PATH</code> environment variable that is available to both
|
|
475
|
-
* scripts is <code>/sbin:bin:/usr/sbin:/usr/bin</code>.</p>
|
|
476
|
-
* <p>View Amazon CloudWatch Logs for notebook instance lifecycle configurations in log
|
|
477
|
-
* group <code>/aws/sagemaker/NotebookInstances</code> in log stream
|
|
478
|
-
* <code>[notebook-instance-name]/[LifecycleConfigHook]</code>.</p>
|
|
479
|
-
* <p>Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs
|
|
480
|
-
* for longer than 5 minutes, it fails and the notebook instance is not created or
|
|
481
|
-
* started.</p>
|
|
482
|
-
* <p>For information about notebook instance lifestyle configurations, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html">Step
|
|
483
|
-
* 2.1: (Optional) Customize a Notebook Instance</a>.</p>
|
|
329
|
+
* <p>Contains the notebook instance lifecycle configuration script.</p> <p>Each lifecycle configuration script has a limit of 16384 characters.</p> <p>The value of the <code>$PATH</code> environment variable that is available to both scripts is <code>/sbin:bin:/usr/sbin:/usr/bin</code>.</p> <p>View Amazon CloudWatch Logs for notebook instance lifecycle configurations in log group <code>/aws/sagemaker/NotebookInstances</code> in log stream <code>[notebook-instance-name]/[LifecycleConfigHook]</code>.</p> <p>Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started.</p> <p>For information about notebook instance 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>
|
|
484
330
|
* @public
|
|
485
331
|
*/
|
|
486
332
|
export interface NotebookInstanceLifecycleHook {
|
|
487
333
|
/**
|
|
488
|
-
* <p>A base64-encoded string that contains a shell script for a notebook instance lifecycle
|
|
489
|
-
* configuration.</p>
|
|
334
|
+
* <p>A base64-encoded string that contains a shell script for a notebook instance lifecycle configuration.</p>
|
|
490
335
|
* @public
|
|
491
336
|
*/
|
|
492
337
|
Content?: string | undefined;
|
|
@@ -501,21 +346,17 @@ export interface CreateNotebookInstanceLifecycleConfigInput {
|
|
|
501
346
|
*/
|
|
502
347
|
NotebookInstanceLifecycleConfigName: string | undefined;
|
|
503
348
|
/**
|
|
504
|
-
* <p>A shell script that runs only once, when you create a notebook instance. The shell
|
|
505
|
-
* script must be a base64-encoded string.</p>
|
|
349
|
+
* <p>A shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.</p>
|
|
506
350
|
* @public
|
|
507
351
|
*/
|
|
508
352
|
OnCreate?: NotebookInstanceLifecycleHook[] | undefined;
|
|
509
353
|
/**
|
|
510
|
-
* <p>A shell script that runs every time you start a notebook instance, including when you
|
|
511
|
-
* create the notebook instance. The shell script must be a base64-encoded string.</p>
|
|
354
|
+
* <p>A shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.</p>
|
|
512
355
|
* @public
|
|
513
356
|
*/
|
|
514
357
|
OnStart?: NotebookInstanceLifecycleHook[] | undefined;
|
|
515
358
|
/**
|
|
516
|
-
* <p>An array of key-value pairs. You can use tags to categorize your Amazon Web Services
|
|
517
|
-
* resources in different ways, for example, by purpose, owner, or environment. For more
|
|
518
|
-
* information, see <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html">Tagging Amazon Web Services Resources</a>.</p>
|
|
359
|
+
* <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/tag-editor/latest/userguide/tagging.html">Tagging Amazon Web Services Resources</a>.</p>
|
|
519
360
|
* @public
|
|
520
361
|
*/
|
|
521
362
|
Tags?: Tag[] | undefined;
|
|
@@ -580,11 +421,7 @@ export type OptimizationJobDeploymentInstanceType = (typeof OptimizationJobDeplo
|
|
|
580
421
|
*/
|
|
581
422
|
export interface OptimizationModelAccessConfig {
|
|
582
423
|
/**
|
|
583
|
-
* <p>Specifies agreement to the model end-user license agreement (EULA). The
|
|
584
|
-
* <code>AcceptEula</code> value must be explicitly defined as <code>True</code> in order
|
|
585
|
-
* to accept the EULA that this model requires. You are responsible for reviewing and
|
|
586
|
-
* complying with any applicable license terms and making sure they are acceptable for your
|
|
587
|
-
* use case before downloading or using a model.</p>
|
|
424
|
+
* <p>Specifies agreement to the model end-user license agreement (EULA). The <code>AcceptEula</code> value must be explicitly defined as <code>True</code> in order to accept the EULA that this model requires. You are responsible for reviewing and complying with any applicable license terms and making sure they are acceptable for your use case before downloading or using a model.</p>
|
|
588
425
|
* @public
|
|
589
426
|
*/
|
|
590
427
|
AcceptEula: boolean | undefined;
|
|
@@ -665,8 +502,7 @@ export interface ModelShardingConfig {
|
|
|
665
502
|
OverrideEnvironment?: Record<string, string> | undefined;
|
|
666
503
|
}
|
|
667
504
|
/**
|
|
668
|
-
* <p>Settings for an optimization technique that you apply with a model optimization
|
|
669
|
-
* job.</p>
|
|
505
|
+
* <p>Settings for an optimization technique that you apply with a model optimization job.</p>
|
|
670
506
|
* @public
|
|
671
507
|
*/
|
|
672
508
|
export type OptimizationConfig = OptimizationConfig.ModelCompilationConfigMember | OptimizationConfig.ModelQuantizationConfigMember | OptimizationConfig.ModelShardingConfigMember | OptimizationConfig.$UnknownMember;
|
|
@@ -727,34 +563,28 @@ export declare namespace OptimizationConfig {
|
|
|
727
563
|
*/
|
|
728
564
|
export interface OptimizationJobOutputConfig {
|
|
729
565
|
/**
|
|
730
|
-
* <p>The Amazon Resource Name (ARN) of a key in Amazon Web Services KMS. SageMaker uses they key to encrypt the artifacts of the
|
|
731
|
-
* optimized model when SageMaker uploads the model to Amazon S3.</p>
|
|
566
|
+
* <p>The Amazon Resource Name (ARN) of a key in Amazon Web Services KMS. SageMaker uses they key to encrypt the artifacts of the optimized model when SageMaker uploads the model to Amazon S3.</p>
|
|
732
567
|
* @public
|
|
733
568
|
*/
|
|
734
569
|
KmsKeyId?: string | undefined;
|
|
735
570
|
/**
|
|
736
|
-
* <p>The Amazon S3 URI for where to store the optimized model that you create with an optimization
|
|
737
|
-
* job.</p>
|
|
571
|
+
* <p>The Amazon S3 URI for where to store the optimized model that you create with an optimization job.</p>
|
|
738
572
|
* @public
|
|
739
573
|
*/
|
|
740
574
|
S3OutputLocation: string | undefined;
|
|
741
575
|
}
|
|
742
576
|
/**
|
|
743
|
-
* <p>A VPC in Amazon VPC that's accessible to an optimized that you create with an optimization
|
|
744
|
-
* job. You can control access to and from your resources by configuring a VPC. For more
|
|
745
|
-
* information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html">Give SageMaker Access to Resources in your Amazon VPC</a>. </p>
|
|
577
|
+
* <p>A VPC in Amazon VPC that's accessible to an optimized that you create with an optimization job. You can control access to and from your resources by configuring a VPC. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html">Give SageMaker Access to Resources in your Amazon VPC</a>. </p>
|
|
746
578
|
* @public
|
|
747
579
|
*/
|
|
748
580
|
export interface OptimizationVpcConfig {
|
|
749
581
|
/**
|
|
750
|
-
* <p>The VPC security group IDs, in the form <code>sg-xxxxxxxx</code>. Specify the security
|
|
751
|
-
* groups for the VPC that is specified in the <code>Subnets</code> field.</p>
|
|
582
|
+
* <p>The VPC security group IDs, in the form <code>sg-xxxxxxxx</code>. Specify the security groups for the VPC that is specified in the <code>Subnets</code> field.</p>
|
|
752
583
|
* @public
|
|
753
584
|
*/
|
|
754
585
|
SecurityGroupIds: string[] | undefined;
|
|
755
586
|
/**
|
|
756
|
-
* <p>The ID of the subnets in the VPC to which you want to connect your optimized
|
|
757
|
-
* model.</p>
|
|
587
|
+
* <p>The ID of the subnets in the VPC to which you want to connect your optimized model.</p>
|
|
758
588
|
* @public
|
|
759
589
|
*/
|
|
760
590
|
Subnets: string[] | undefined;
|
|
@@ -769,26 +599,7 @@ export interface CreateOptimizationJobRequest {
|
|
|
769
599
|
*/
|
|
770
600
|
OptimizationJobName: string | undefined;
|
|
771
601
|
/**
|
|
772
|
-
* <p>The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf. </p>
|
|
773
|
-
* <p>During model optimization, Amazon SageMaker AI needs your permission to:</p>
|
|
774
|
-
* <ul>
|
|
775
|
-
* <li>
|
|
776
|
-
* <p>Read input data from an S3 bucket</p>
|
|
777
|
-
* </li>
|
|
778
|
-
* <li>
|
|
779
|
-
* <p>Write model artifacts to an S3 bucket</p>
|
|
780
|
-
* </li>
|
|
781
|
-
* <li>
|
|
782
|
-
* <p>Write logs to Amazon CloudWatch Logs</p>
|
|
783
|
-
* </li>
|
|
784
|
-
* <li>
|
|
785
|
-
* <p>Publish metrics to Amazon CloudWatch</p>
|
|
786
|
-
* </li>
|
|
787
|
-
* </ul>
|
|
788
|
-
* <p>You grant permissions for all of these tasks to an IAM role. To pass this
|
|
789
|
-
* role to Amazon SageMaker AI, the caller of this API must have the
|
|
790
|
-
* <code>iam:PassRole</code> permission. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html">Amazon SageMaker AI Roles.</a>
|
|
791
|
-
* </p>
|
|
602
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf. </p> <p>During model optimization, Amazon SageMaker AI needs your permission to:</p> <ul> <li> <p>Read input data from an S3 bucket</p> </li> <li> <p>Write model artifacts to an S3 bucket</p> </li> <li> <p>Write logs to Amazon CloudWatch Logs</p> </li> <li> <p>Publish metrics to Amazon CloudWatch</p> </li> </ul> <p>You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker AI, the caller of this API must have the <code>iam:PassRole</code> permission. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html">Amazon SageMaker AI Roles.</a> </p>
|
|
792
603
|
* @public
|
|
793
604
|
*/
|
|
794
605
|
RoleArn: string | undefined;
|
|
@@ -818,29 +629,12 @@ export interface CreateOptimizationJobRequest {
|
|
|
818
629
|
*/
|
|
819
630
|
OutputConfig: OptimizationJobOutputConfig | undefined;
|
|
820
631
|
/**
|
|
821
|
-
* <p>Specifies a limit to how long a job can run. When the job reaches the time limit, SageMaker
|
|
822
|
-
* ends the job. Use this API to cap costs.</p>
|
|
823
|
-
* <p>To stop a training job, SageMaker sends the algorithm the <code>SIGTERM</code> signal,
|
|
824
|
-
* which delays job termination for 120 seconds. Algorithms can use this 120-second window
|
|
825
|
-
* to save the model artifacts, so the results of training are not lost. </p>
|
|
826
|
-
* <p>The training algorithms provided by SageMaker automatically save the intermediate results
|
|
827
|
-
* of a model training job when possible. This attempt to save artifacts is only a best
|
|
828
|
-
* effort case as model might not be in a state from which it can be saved. For example, if
|
|
829
|
-
* training has just started, the model might not be ready to save. When saved, this
|
|
830
|
-
* intermediate data is a valid model artifact. You can use it to create a model with
|
|
831
|
-
* <code>CreateModel</code>.</p>
|
|
832
|
-
* <note>
|
|
833
|
-
* <p>The Neural Topic Model (NTM) currently does not support saving intermediate model
|
|
834
|
-
* artifacts. When training NTMs, make sure that the maximum runtime is sufficient for
|
|
835
|
-
* the training job to complete.</p>
|
|
836
|
-
* </note>
|
|
632
|
+
* <p>Specifies a limit to how long a job can run. When the job reaches the time limit, SageMaker ends the job. Use this API to cap costs.</p> <p>To stop a training job, SageMaker sends the algorithm the <code>SIGTERM</code> signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost. </p> <p>The training algorithms provided by SageMaker automatically save the intermediate results of a model training job when possible. This attempt to save artifacts is only a best effort case as model might not be in a state from which it can be saved. For example, if training has just started, the model might not be ready to save. When saved, this intermediate data is a valid model artifact. You can use it to create a model with <code>CreateModel</code>.</p> <note> <p>The Neural Topic Model (NTM) currently does not support saving intermediate model artifacts. When training NTMs, make sure that the maximum runtime is sufficient for the training job to complete.</p> </note>
|
|
837
633
|
* @public
|
|
838
634
|
*/
|
|
839
635
|
StoppingCondition: StoppingCondition | undefined;
|
|
840
636
|
/**
|
|
841
|
-
* <p>A list of key-value pairs associated with the optimization job. For more information,
|
|
842
|
-
* see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference
|
|
843
|
-
* Guide</i>.</p>
|
|
637
|
+
* <p>A list of key-value pairs associated with the optimization job. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference Guide</i>.</p>
|
|
844
638
|
* @public
|
|
845
639
|
*/
|
|
846
640
|
Tags?: Tag[] | undefined;
|
|
@@ -932,8 +726,7 @@ export interface CreatePartnerAppRequest {
|
|
|
932
726
|
*/
|
|
933
727
|
ExecutionRoleArn: string | undefined;
|
|
934
728
|
/**
|
|
935
|
-
* <p>SageMaker Partner AI Apps uses Amazon Web Services KMS to encrypt data at rest using an Amazon Web Services managed key by default. For more control, specify a
|
|
936
|
-
* customer managed key.</p>
|
|
729
|
+
* <p>SageMaker Partner AI Apps uses Amazon Web Services KMS to encrypt data at rest using an Amazon Web Services managed key by default. For more control, specify a customer managed key.</p>
|
|
937
730
|
* @public
|
|
938
731
|
*/
|
|
939
732
|
KmsKeyId?: string | undefined;
|
|
@@ -968,8 +761,7 @@ export interface CreatePartnerAppRequest {
|
|
|
968
761
|
*/
|
|
969
762
|
ClientToken?: string | undefined;
|
|
970
763
|
/**
|
|
971
|
-
* <p>Each tag consists of a key and an optional value. Tag keys must be unique per
|
|
972
|
-
* resource.</p>
|
|
764
|
+
* <p>Each tag consists of a key and an optional value. Tag keys must be unique per resource.</p>
|
|
973
765
|
* @public
|
|
974
766
|
*/
|
|
975
767
|
Tags?: Tag[] | undefined;
|
|
@@ -1015,9 +807,7 @@ export interface CreatePartnerAppPresignedUrlResponse {
|
|
|
1015
807
|
Url?: string | undefined;
|
|
1016
808
|
}
|
|
1017
809
|
/**
|
|
1018
|
-
* <p>Configuration that controls the parallelism of the pipeline.
|
|
1019
|
-
* By default, the parallelism configuration specified applies to all
|
|
1020
|
-
* executions of the pipeline unless overridden.</p>
|
|
810
|
+
* <p>Configuration that controls the parallelism of the pipeline. By default, the parallelism configuration specified applies to all executions of the pipeline unless overridden.</p>
|
|
1021
811
|
* @public
|
|
1022
812
|
*/
|
|
1023
813
|
export interface ParallelismConfiguration {
|
|
@@ -1038,14 +828,12 @@ export interface PipelineDefinitionS3Location {
|
|
|
1038
828
|
*/
|
|
1039
829
|
Bucket: string | undefined;
|
|
1040
830
|
/**
|
|
1041
|
-
* <p>The object key (or key name) uniquely identifies the
|
|
1042
|
-
* object in an S3 bucket. </p>
|
|
831
|
+
* <p>The object key (or key name) uniquely identifies the object in an S3 bucket. </p>
|
|
1043
832
|
* @public
|
|
1044
833
|
*/
|
|
1045
834
|
ObjectKey: string | undefined;
|
|
1046
835
|
/**
|
|
1047
|
-
* <p>Version Id of the pipeline definition file. If not specified, Amazon SageMaker
|
|
1048
|
-
* will retrieve the latest version.</p>
|
|
836
|
+
* <p>Version Id of the pipeline definition file. If not specified, Amazon SageMaker will retrieve the latest version.</p>
|
|
1049
837
|
* @public
|
|
1050
838
|
*/
|
|
1051
839
|
VersionId?: string | undefined;
|
|
@@ -1065,14 +853,12 @@ export interface CreatePipelineRequest {
|
|
|
1065
853
|
*/
|
|
1066
854
|
PipelineDisplayName?: string | undefined;
|
|
1067
855
|
/**
|
|
1068
|
-
* <p>The <a href="https://aws-sagemaker-mlops.github.io/sagemaker-model-building-pipeline-definition-JSON-schema/">JSON
|
|
1069
|
-
* pipeline definition</a> of the pipeline.</p>
|
|
856
|
+
* <p>The <a href="https://aws-sagemaker-mlops.github.io/sagemaker-model-building-pipeline-definition-JSON-schema/">JSON pipeline definition</a> of the pipeline.</p>
|
|
1070
857
|
* @public
|
|
1071
858
|
*/
|
|
1072
859
|
PipelineDefinition?: string | undefined;
|
|
1073
860
|
/**
|
|
1074
|
-
* <p>The location of the pipeline definition stored in Amazon S3. If specified,
|
|
1075
|
-
* SageMaker will retrieve the pipeline definition from this location.</p>
|
|
861
|
+
* <p>The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.</p>
|
|
1076
862
|
* @public
|
|
1077
863
|
*/
|
|
1078
864
|
PipelineDefinitionS3Location?: PipelineDefinitionS3Location | undefined;
|
|
@@ -1082,8 +868,7 @@ export interface CreatePipelineRequest {
|
|
|
1082
868
|
*/
|
|
1083
869
|
PipelineDescription?: string | undefined;
|
|
1084
870
|
/**
|
|
1085
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
1086
|
-
* operation. An idempotent operation completes no more than one time.</p>
|
|
871
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.</p>
|
|
1087
872
|
* @public
|
|
1088
873
|
*/
|
|
1089
874
|
ClientRequestToken?: string | undefined;
|
|
@@ -1098,8 +883,7 @@ export interface CreatePipelineRequest {
|
|
|
1098
883
|
*/
|
|
1099
884
|
Tags?: Tag[] | undefined;
|
|
1100
885
|
/**
|
|
1101
|
-
* <p>This is the configuration that controls the parallelism of the pipeline.
|
|
1102
|
-
* If specified, it applies to all runs of this pipeline by default.</p>
|
|
886
|
+
* <p>This is the configuration that controls the parallelism of the pipeline. If specified, it applies to all runs of this pipeline by default.</p>
|
|
1103
887
|
* @public
|
|
1104
888
|
*/
|
|
1105
889
|
ParallelismConfiguration?: ParallelismConfiguration | undefined;
|
|
@@ -1144,41 +928,7 @@ export interface CreatePresignedDomainUrlRequest {
|
|
|
1144
928
|
*/
|
|
1145
929
|
SpaceName?: string | undefined;
|
|
1146
930
|
/**
|
|
1147
|
-
* <p>The landing page that the user is directed to when accessing the presigned URL. Using this
|
|
1148
|
-
* value, users can access Studio or Studio Classic, even if it is not the default experience for
|
|
1149
|
-
* the domain. The supported values are:</p>
|
|
1150
|
-
* <ul>
|
|
1151
|
-
* <li>
|
|
1152
|
-
* <p>
|
|
1153
|
-
* <code>studio::relative/path</code>: Directs users to the relative path in
|
|
1154
|
-
* Studio.</p>
|
|
1155
|
-
* </li>
|
|
1156
|
-
* <li>
|
|
1157
|
-
* <p>
|
|
1158
|
-
* <code>app:JupyterServer:relative/path</code>: Directs users to the relative path in
|
|
1159
|
-
* the Studio Classic application.</p>
|
|
1160
|
-
* </li>
|
|
1161
|
-
* <li>
|
|
1162
|
-
* <p>
|
|
1163
|
-
* <code>app:JupyterLab:relative/path</code>: Directs users to the relative path in the
|
|
1164
|
-
* JupyterLab application.</p>
|
|
1165
|
-
* </li>
|
|
1166
|
-
* <li>
|
|
1167
|
-
* <p>
|
|
1168
|
-
* <code>app:RStudioServerPro:relative/path</code>: Directs users to the relative path in
|
|
1169
|
-
* the RStudio application.</p>
|
|
1170
|
-
* </li>
|
|
1171
|
-
* <li>
|
|
1172
|
-
* <p>
|
|
1173
|
-
* <code>app:CodeEditor:relative/path</code>: Directs users to the relative path in the
|
|
1174
|
-
* Code Editor, based on Code-OSS, Visual Studio Code - Open Source application.</p>
|
|
1175
|
-
* </li>
|
|
1176
|
-
* <li>
|
|
1177
|
-
* <p>
|
|
1178
|
-
* <code>app:Canvas:relative/path</code>: Directs users to the relative path in the
|
|
1179
|
-
* Canvas application.</p>
|
|
1180
|
-
* </li>
|
|
1181
|
-
* </ul>
|
|
931
|
+
* <p>The landing page that the user is directed to when accessing the presigned URL. Using this value, users can access Studio or Studio Classic, even if it is not the default experience for the domain. The supported values are:</p> <ul> <li> <p> <code>studio::relative/path</code>: Directs users to the relative path in Studio.</p> </li> <li> <p> <code>app:JupyterServer:relative/path</code>: Directs users to the relative path in the Studio Classic application.</p> </li> <li> <p> <code>app:JupyterLab:relative/path</code>: Directs users to the relative path in the JupyterLab application.</p> </li> <li> <p> <code>app:RStudioServerPro:relative/path</code>: Directs users to the relative path in the RStudio application.</p> </li> <li> <p> <code>app:CodeEditor:relative/path</code>: Directs users to the relative path in the Code Editor, based on Code-OSS, Visual Studio Code - Open Source application.</p> </li> <li> <p> <code>app:Canvas:relative/path</code>: Directs users to the relative path in the Canvas application.</p> </li> </ul>
|
|
1182
932
|
* @public
|
|
1183
933
|
*/
|
|
1184
934
|
LandingUri?: string | undefined;
|
|
@@ -1203,8 +953,7 @@ export interface CreatePresignedMlflowTrackingServerUrlRequest {
|
|
|
1203
953
|
*/
|
|
1204
954
|
TrackingServerName: string | undefined;
|
|
1205
955
|
/**
|
|
1206
|
-
* <p>The duration in seconds that your presigned URL is valid. The presigned URL can be used
|
|
1207
|
-
* only once.</p>
|
|
956
|
+
* <p>The duration in seconds that your presigned URL is valid. The presigned URL can be used only once.</p>
|
|
1208
957
|
* @public
|
|
1209
958
|
*/
|
|
1210
959
|
ExpiresInSeconds?: number | undefined;
|
|
@@ -1250,25 +999,7 @@ export interface CreatePresignedNotebookInstanceUrlOutput {
|
|
|
1250
999
|
AuthorizedUrl?: string | undefined;
|
|
1251
1000
|
}
|
|
1252
1001
|
/**
|
|
1253
|
-
* <p>Associates a SageMaker job as a trial component with an experiment and trial. Specified when
|
|
1254
|
-
* you call the following APIs:</p>
|
|
1255
|
-
* <ul>
|
|
1256
|
-
* <li>
|
|
1257
|
-
* <p>
|
|
1258
|
-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html">CreateProcessingJob</a>
|
|
1259
|
-
* </p>
|
|
1260
|
-
* </li>
|
|
1261
|
-
* <li>
|
|
1262
|
-
* <p>
|
|
1263
|
-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html">CreateTrainingJob</a>
|
|
1264
|
-
* </p>
|
|
1265
|
-
* </li>
|
|
1266
|
-
* <li>
|
|
1267
|
-
* <p>
|
|
1268
|
-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html">CreateTransformJob</a>
|
|
1269
|
-
* </p>
|
|
1270
|
-
* </li>
|
|
1271
|
-
* </ul>
|
|
1002
|
+
* <p>Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html">CreateProcessingJob</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html">CreateTrainingJob</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html">CreateTransformJob</a> </p> </li> </ul>
|
|
1272
1003
|
* @public
|
|
1273
1004
|
*/
|
|
1274
1005
|
export interface ExperimentConfig {
|
|
@@ -1278,14 +1009,12 @@ export interface ExperimentConfig {
|
|
|
1278
1009
|
*/
|
|
1279
1010
|
ExperimentName?: string | undefined;
|
|
1280
1011
|
/**
|
|
1281
|
-
* <p>The name of an existing trial to associate the trial component with. If not specified, a
|
|
1282
|
-
* new trial is created.</p>
|
|
1012
|
+
* <p>The name of an existing trial to associate the trial component with. If not specified, a new trial is created.</p>
|
|
1283
1013
|
* @public
|
|
1284
1014
|
*/
|
|
1285
1015
|
TrialName?: string | undefined;
|
|
1286
1016
|
/**
|
|
1287
|
-
* <p>The display name for the trial component. If this key isn't specified, the display name is
|
|
1288
|
-
* the trial component name.</p>
|
|
1017
|
+
* <p>The display name for the trial component. If this key isn't specified, the display name is the trial component name.</p>
|
|
1289
1018
|
* @public
|
|
1290
1019
|
*/
|
|
1291
1020
|
TrialComponentDisplayName?: string | undefined;
|
|
@@ -1372,8 +1101,7 @@ export interface RedshiftDatasetDefinition {
|
|
|
1372
1101
|
*/
|
|
1373
1102
|
QueryString: string | undefined;
|
|
1374
1103
|
/**
|
|
1375
|
-
* <p>The IAM role attached to your Redshift cluster that Amazon SageMaker uses to generate
|
|
1376
|
-
* datasets.</p>
|
|
1104
|
+
* <p>The IAM role attached to your Redshift cluster that Amazon SageMaker uses to generate datasets.</p>
|
|
1377
1105
|
* @public
|
|
1378
1106
|
*/
|
|
1379
1107
|
ClusterRoleArn: string | undefined;
|
|
@@ -1383,8 +1111,7 @@ export interface RedshiftDatasetDefinition {
|
|
|
1383
1111
|
*/
|
|
1384
1112
|
OutputS3Uri: string | undefined;
|
|
1385
1113
|
/**
|
|
1386
|
-
* <p>The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker
|
|
1387
|
-
* uses to encrypt data from a Redshift execution.</p>
|
|
1114
|
+
* <p>The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data from a Redshift execution.</p>
|
|
1388
1115
|
* @public
|
|
1389
1116
|
*/
|
|
1390
1117
|
KmsKeyId?: string | undefined;
|
|
@@ -1400,9 +1127,7 @@ export interface RedshiftDatasetDefinition {
|
|
|
1400
1127
|
OutputCompression?: RedshiftResultCompressionType | undefined;
|
|
1401
1128
|
}
|
|
1402
1129
|
/**
|
|
1403
|
-
* <p>Configuration for Dataset Definition inputs. The Dataset Definition input must specify
|
|
1404
|
-
* exactly one of either <code>AthenaDatasetDefinition</code> or
|
|
1405
|
-
* <code>RedshiftDatasetDefinition</code> types.</p>
|
|
1130
|
+
* <p>Configuration for Dataset Definition inputs. The Dataset Definition input must specify exactly one of either <code>AthenaDatasetDefinition</code> or <code>RedshiftDatasetDefinition</code> types.</p>
|
|
1406
1131
|
* @public
|
|
1407
1132
|
*/
|
|
1408
1133
|
export interface DatasetDefinition {
|
|
@@ -1417,24 +1142,17 @@ export interface DatasetDefinition {
|
|
|
1417
1142
|
*/
|
|
1418
1143
|
RedshiftDatasetDefinition?: RedshiftDatasetDefinition | undefined;
|
|
1419
1144
|
/**
|
|
1420
|
-
* <p>The local path where you want Amazon SageMaker to download the Dataset Definition inputs to run a
|
|
1421
|
-
* processing job. <code>LocalPath</code> is an absolute path to the input data. This is a
|
|
1422
|
-
* required parameter when <code>AppManaged</code> is <code>False</code> (default).</p>
|
|
1145
|
+
* <p>The local path where you want Amazon SageMaker to download the Dataset Definition inputs to run a processing job. <code>LocalPath</code> is an absolute path to the input data. This is a required parameter when <code>AppManaged</code> is <code>False</code> (default).</p>
|
|
1423
1146
|
* @public
|
|
1424
1147
|
*/
|
|
1425
1148
|
LocalPath?: string | undefined;
|
|
1426
1149
|
/**
|
|
1427
|
-
* <p>Whether the generated dataset is <code>FullyReplicated</code> or
|
|
1428
|
-
* <code>ShardedByS3Key</code> (default).</p>
|
|
1150
|
+
* <p>Whether the generated dataset is <code>FullyReplicated</code> or <code>ShardedByS3Key</code> (default).</p>
|
|
1429
1151
|
* @public
|
|
1430
1152
|
*/
|
|
1431
1153
|
DataDistributionType?: DataDistributionType | undefined;
|
|
1432
1154
|
/**
|
|
1433
|
-
* <p>Whether to use <code>File</code> or <code>Pipe</code> input mode. In <code>File</code>
|
|
1434
|
-
* (default) mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic
|
|
1435
|
-
* Block Store (Amazon EBS) volumes before starting your training algorithm. This is the
|
|
1436
|
-
* most commonly used input mode. In <code>Pipe</code> mode, Amazon SageMaker streams input data from
|
|
1437
|
-
* the source directly to your algorithm without using the EBS volume.</p>
|
|
1155
|
+
* <p>Whether to use <code>File</code> or <code>Pipe</code> input mode. In <code>File</code> (default) mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode. In <code>Pipe</code> mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.</p>
|
|
1438
1156
|
* @public
|
|
1439
1157
|
*/
|
|
1440
1158
|
InputMode?: InputMode | undefined;
|
|
@@ -1464,63 +1182,43 @@ export declare const ProcessingS3DataType: {
|
|
|
1464
1182
|
*/
|
|
1465
1183
|
export type ProcessingS3DataType = (typeof ProcessingS3DataType)[keyof typeof ProcessingS3DataType];
|
|
1466
1184
|
/**
|
|
1467
|
-
* <p>Configuration for downloading input data from Amazon S3 into the processing
|
|
1468
|
-
* container.</p>
|
|
1185
|
+
* <p>Configuration for downloading input data from Amazon S3 into the processing container.</p>
|
|
1469
1186
|
* @public
|
|
1470
1187
|
*/
|
|
1471
1188
|
export interface ProcessingS3Input {
|
|
1472
1189
|
/**
|
|
1473
|
-
* <p>The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing
|
|
1474
|
-
* job.</p>
|
|
1190
|
+
* <p>The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.</p>
|
|
1475
1191
|
* @public
|
|
1476
1192
|
*/
|
|
1477
1193
|
S3Uri: string | undefined;
|
|
1478
1194
|
/**
|
|
1479
|
-
* <p>The local path in your container where you want Amazon SageMaker to write input data to.
|
|
1480
|
-
* <code>LocalPath</code> is an absolute path to the input data and must begin with
|
|
1481
|
-
* <code>/opt/ml/processing/</code>. <code>LocalPath</code> is a required parameter
|
|
1482
|
-
* when <code>AppManaged</code> is <code>False</code> (default).</p>
|
|
1195
|
+
* <p>The local path in your container where you want Amazon SageMaker to write input data to. <code>LocalPath</code> is an absolute path to the input data and must begin with <code>/opt/ml/processing/</code>. <code>LocalPath</code> is a required parameter when <code>AppManaged</code> is <code>False</code> (default).</p>
|
|
1483
1196
|
* @public
|
|
1484
1197
|
*/
|
|
1485
1198
|
LocalPath?: string | undefined;
|
|
1486
1199
|
/**
|
|
1487
|
-
* <p>Whether you use an <code>S3Prefix</code> or a <code>ManifestFile</code> for the data
|
|
1488
|
-
* type. If you choose <code>S3Prefix</code>, <code>S3Uri</code> identifies a key name
|
|
1489
|
-
* prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing job.
|
|
1490
|
-
* If you choose <code>ManifestFile</code>, <code>S3Uri</code> identifies an object that is
|
|
1491
|
-
* a manifest file containing a list of object keys that you want Amazon SageMaker to use for the
|
|
1492
|
-
* processing job.</p>
|
|
1200
|
+
* <p>Whether you use an <code>S3Prefix</code> or a <code>ManifestFile</code> for the data type. If you choose <code>S3Prefix</code>, <code>S3Uri</code> identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing job. If you choose <code>ManifestFile</code>, <code>S3Uri</code> identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for the processing job.</p>
|
|
1493
1201
|
* @public
|
|
1494
1202
|
*/
|
|
1495
1203
|
S3DataType: ProcessingS3DataType | undefined;
|
|
1496
1204
|
/**
|
|
1497
|
-
* <p>Whether to use <code>File</code> or <code>Pipe</code> input mode. In File mode, Amazon SageMaker
|
|
1498
|
-
* copies the data from the input source onto the local ML storage volume before starting
|
|
1499
|
-
* your processing container. This is the most commonly used input mode. In
|
|
1500
|
-
* <code>Pipe</code> mode, Amazon SageMaker streams input data from the source directly to your
|
|
1501
|
-
* processing container into named pipes without using the ML storage volume.</p>
|
|
1205
|
+
* <p>Whether to use <code>File</code> or <code>Pipe</code> input mode. In File mode, Amazon SageMaker copies the data from the input source onto the local ML storage volume before starting your processing container. This is the most commonly used input mode. In <code>Pipe</code> mode, Amazon SageMaker streams input data from the source directly to your processing container into named pipes without using the ML storage volume.</p>
|
|
1502
1206
|
* @public
|
|
1503
1207
|
*/
|
|
1504
1208
|
S3InputMode?: ProcessingS3InputMode | undefined;
|
|
1505
1209
|
/**
|
|
1506
|
-
* <p>Whether to distribute the data from Amazon S3 to all processing instances with
|
|
1507
|
-
* <code>FullyReplicated</code>, or whether the data from Amazon S3 is shared by Amazon S3 key,
|
|
1508
|
-
* downloading one shard of data to each processing instance.</p>
|
|
1210
|
+
* <p>Whether to distribute the data from Amazon S3 to all processing instances with <code>FullyReplicated</code>, or whether the data from Amazon S3 is shared by Amazon S3 key, downloading one shard of data to each processing instance.</p>
|
|
1509
1211
|
* @public
|
|
1510
1212
|
*/
|
|
1511
1213
|
S3DataDistributionType?: ProcessingS3DataDistributionType | undefined;
|
|
1512
1214
|
/**
|
|
1513
|
-
* <p>Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing
|
|
1514
|
-
* container. <code>Gzip</code> can only be used when <code>Pipe</code> mode is specified
|
|
1515
|
-
* as the <code>S3InputMode</code>. In <code>Pipe</code> mode, Amazon SageMaker streams input data from
|
|
1516
|
-
* the source directly to your container without using the EBS volume.</p>
|
|
1215
|
+
* <p>Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container. <code>Gzip</code> can only be used when <code>Pipe</code> mode is specified as the <code>S3InputMode</code>. In <code>Pipe</code> mode, Amazon SageMaker streams input data from the source directly to your container without using the EBS volume.</p>
|
|
1517
1216
|
* @public
|
|
1518
1217
|
*/
|
|
1519
1218
|
S3CompressionType?: ProcessingS3CompressionType | undefined;
|
|
1520
1219
|
}
|
|
1521
1220
|
/**
|
|
1522
|
-
* <p>The inputs for a processing job. The processing input must specify exactly one of
|
|
1523
|
-
* either <code>S3Input</code> or <code>DatasetDefinition</code> types.</p>
|
|
1221
|
+
* <p>The inputs for a processing job. The processing input must specify exactly one of either <code>S3Input</code> or <code>DatasetDefinition</code> types.</p>
|
|
1524
1222
|
* @public
|
|
1525
1223
|
*/
|
|
1526
1224
|
export interface ProcessingInput {
|
|
@@ -1530,15 +1228,12 @@ export interface ProcessingInput {
|
|
|
1530
1228
|
*/
|
|
1531
1229
|
InputName: string | undefined;
|
|
1532
1230
|
/**
|
|
1533
|
-
* <p>When <code>True</code>, input operations such as data download are managed natively by
|
|
1534
|
-
* the processing job application. When <code>False</code> (default), input operations are
|
|
1535
|
-
* managed by Amazon SageMaker.</p>
|
|
1231
|
+
* <p>When <code>True</code>, input operations such as data download are managed natively by the processing job application. When <code>False</code> (default), input operations are managed by Amazon SageMaker.</p>
|
|
1536
1232
|
* @public
|
|
1537
1233
|
*/
|
|
1538
1234
|
AppManaged?: boolean | undefined;
|
|
1539
1235
|
/**
|
|
1540
|
-
* <p>Configuration for downloading input data from Amazon S3 into the processing
|
|
1541
|
-
* container.</p>
|
|
1236
|
+
* <p>Configuration for downloading input data from Amazon S3 into the processing container.</p>
|
|
1542
1237
|
* @public
|
|
1543
1238
|
*/
|
|
1544
1239
|
S3Input?: ProcessingS3Input | undefined;
|
|
@@ -1554,9 +1249,7 @@ export interface ProcessingInput {
|
|
|
1554
1249
|
*/
|
|
1555
1250
|
export interface ProcessingFeatureStoreOutput {
|
|
1556
1251
|
/**
|
|
1557
|
-
* <p>The name of the Amazon SageMaker FeatureGroup to use as the destination for processing job output.
|
|
1558
|
-
* Note that your processing script is responsible for putting records into your Feature
|
|
1559
|
-
* Store.</p>
|
|
1252
|
+
* <p>The name of the Amazon SageMaker FeatureGroup to use as the destination for processing job output. Note that your processing script is responsible for putting records into your Feature Store.</p>
|
|
1560
1253
|
* @public
|
|
1561
1254
|
*/
|
|
1562
1255
|
FeatureGroupName: string | undefined;
|
|
@@ -1567,29 +1260,23 @@ export interface ProcessingFeatureStoreOutput {
|
|
|
1567
1260
|
*/
|
|
1568
1261
|
export interface ProcessingS3Output {
|
|
1569
1262
|
/**
|
|
1570
|
-
* <p>A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of
|
|
1571
|
-
* a processing job.</p>
|
|
1263
|
+
* <p>A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of a processing job.</p>
|
|
1572
1264
|
* @public
|
|
1573
1265
|
*/
|
|
1574
1266
|
S3Uri: string | undefined;
|
|
1575
1267
|
/**
|
|
1576
|
-
* <p>The local path of a directory where you want Amazon SageMaker to upload its contents to Amazon S3.
|
|
1577
|
-
* <code>LocalPath</code> is an absolute path to a directory containing output files.
|
|
1578
|
-
* This directory will be created by the platform and exist when your container's
|
|
1579
|
-
* entrypoint is invoked.</p>
|
|
1268
|
+
* <p>The local path of a directory where you want Amazon SageMaker to upload its contents to Amazon S3. <code>LocalPath</code> is an absolute path to a directory containing output files. This directory will be created by the platform and exist when your container's entrypoint is invoked.</p>
|
|
1580
1269
|
* @public
|
|
1581
1270
|
*/
|
|
1582
1271
|
LocalPath?: string | undefined;
|
|
1583
1272
|
/**
|
|
1584
|
-
* <p>Whether to upload the results of the processing job continuously or after the job
|
|
1585
|
-
* completes.</p>
|
|
1273
|
+
* <p>Whether to upload the results of the processing job continuously or after the job completes.</p>
|
|
1586
1274
|
* @public
|
|
1587
1275
|
*/
|
|
1588
1276
|
S3UploadMode: ProcessingS3UploadMode | undefined;
|
|
1589
1277
|
}
|
|
1590
1278
|
/**
|
|
1591
|
-
* <p>Describes the results of a processing job. The processing output must specify exactly
|
|
1592
|
-
* one of either <code>S3Output</code> or <code>FeatureStoreOutput</code> types.</p>
|
|
1279
|
+
* <p>Describes the results of a processing job. The processing output must specify exactly one of either <code>S3Output</code> or <code>FeatureStoreOutput</code> types.</p>
|
|
1593
1280
|
* @public
|
|
1594
1281
|
*/
|
|
1595
1282
|
export interface ProcessingOutput {
|
|
@@ -1604,15 +1291,12 @@ export interface ProcessingOutput {
|
|
|
1604
1291
|
*/
|
|
1605
1292
|
S3Output?: ProcessingS3Output | undefined;
|
|
1606
1293
|
/**
|
|
1607
|
-
* <p>Configuration for processing job outputs in Amazon SageMaker Feature Store. This processing output
|
|
1608
|
-
* type is only supported when <code>AppManaged</code> is specified. </p>
|
|
1294
|
+
* <p>Configuration for processing job outputs in Amazon SageMaker Feature Store. This processing output type is only supported when <code>AppManaged</code> is specified. </p>
|
|
1609
1295
|
* @public
|
|
1610
1296
|
*/
|
|
1611
1297
|
FeatureStoreOutput?: ProcessingFeatureStoreOutput | undefined;
|
|
1612
1298
|
/**
|
|
1613
|
-
* <p>When <code>True</code>, output operations such as data upload are managed natively by
|
|
1614
|
-
* the processing job application. When <code>False</code> (default), output operations are
|
|
1615
|
-
* managed by Amazon SageMaker.</p>
|
|
1299
|
+
* <p>When <code>True</code>, output operations such as data upload are managed natively by the processing job application. When <code>False</code> (default), output operations are managed by Amazon SageMaker.</p>
|
|
1616
1300
|
* @public
|
|
1617
1301
|
*/
|
|
1618
1302
|
AppManaged?: boolean | undefined;
|
|
@@ -1623,16 +1307,12 @@ export interface ProcessingOutput {
|
|
|
1623
1307
|
*/
|
|
1624
1308
|
export interface ProcessingOutputConfig {
|
|
1625
1309
|
/**
|
|
1626
|
-
* <p>An array of outputs configuring the data to upload from the processing
|
|
1627
|
-
* container.</p>
|
|
1310
|
+
* <p>An array of outputs configuring the data to upload from the processing container.</p>
|
|
1628
1311
|
* @public
|
|
1629
1312
|
*/
|
|
1630
1313
|
Outputs: ProcessingOutput[] | undefined;
|
|
1631
1314
|
/**
|
|
1632
|
-
* <p>The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker
|
|
1633
|
-
* uses to encrypt the processing job output. <code>KmsKeyId</code> can be an ID of a KMS
|
|
1634
|
-
* key, ARN of a KMS key, or alias of a KMS key. The <code>KmsKeyId</code> is applied to
|
|
1635
|
-
* all outputs.</p>
|
|
1315
|
+
* <p>The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the processing job output. <code>KmsKeyId</code> can be an ID of a KMS key, ARN of a KMS key, or alias of a KMS key. The <code>KmsKeyId</code> is applied to all outputs.</p>
|
|
1636
1316
|
* @public
|
|
1637
1317
|
*/
|
|
1638
1318
|
KmsKeyId?: string | undefined;
|
|
@@ -1643,8 +1323,7 @@ export interface ProcessingOutputConfig {
|
|
|
1643
1323
|
*/
|
|
1644
1324
|
export interface ProcessingClusterConfig {
|
|
1645
1325
|
/**
|
|
1646
|
-
* <p>The number of ML compute instances to use in the processing job. For distributed
|
|
1647
|
-
* processing jobs, specify a value greater than 1. The default value is 1.</p>
|
|
1326
|
+
* <p>The number of ML compute instances to use in the processing job. For distributed processing jobs, specify a value greater than 1. The default value is 1.</p>
|
|
1648
1327
|
* @public
|
|
1649
1328
|
*/
|
|
1650
1329
|
InstanceCount: number | undefined;
|
|
@@ -1654,54 +1333,29 @@ export interface ProcessingClusterConfig {
|
|
|
1654
1333
|
*/
|
|
1655
1334
|
InstanceType: ProcessingInstanceType | undefined;
|
|
1656
1335
|
/**
|
|
1657
|
-
* <p>The size of the ML storage volume in gigabytes that you want to provision. You must
|
|
1658
|
-
* specify sufficient ML storage for your scenario.</p>
|
|
1659
|
-
* <note>
|
|
1660
|
-
* <p>Certain Nitro-based instances include local storage with a fixed total size,
|
|
1661
|
-
* dependent on the instance type. When using these instances for processing, Amazon SageMaker
|
|
1662
|
-
* mounts the local instance storage instead of Amazon EBS gp2 storage. You can't request a
|
|
1663
|
-
* <code>VolumeSizeInGB</code> greater than the total size of the local instance
|
|
1664
|
-
* storage.</p>
|
|
1665
|
-
* <p>For a list of instance types that support local instance storage, including the
|
|
1666
|
-
* total size per instance type, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes">Instance Store Volumes</a>.</p>
|
|
1667
|
-
* </note>
|
|
1336
|
+
* <p>The size of the ML storage volume in gigabytes that you want to provision. You must specify sufficient ML storage for your scenario.</p> <note> <p>Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for processing, Amazon SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can't request a <code>VolumeSizeInGB</code> greater than the total size of the local instance storage.</p> <p>For a list of instance types that support local instance storage, including the total size per instance type, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes">Instance Store Volumes</a>.</p> </note>
|
|
1668
1337
|
* @public
|
|
1669
1338
|
*/
|
|
1670
1339
|
VolumeSizeInGB: number | undefined;
|
|
1671
1340
|
/**
|
|
1672
|
-
* <p>The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker
|
|
1673
|
-
* uses to encrypt data on the storage volume attached to the ML compute instance(s) that
|
|
1674
|
-
* run the processing job. </p>
|
|
1675
|
-
* <note>
|
|
1676
|
-
* <p>Certain Nitro-based instances include local storage, dependent on the instance
|
|
1677
|
-
* type. Local storage volumes are encrypted using a hardware module on the instance.
|
|
1678
|
-
* You can't request a <code>VolumeKmsKeyId</code> when using an instance type with
|
|
1679
|
-
* local storage.</p>
|
|
1680
|
-
* <p>For a list of instance types that support local instance storage, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes">Instance Store Volumes</a>.</p>
|
|
1681
|
-
* <p>For more information about local instance storage encryption, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html">SSD
|
|
1682
|
-
* Instance Store Volumes</a>.</p>
|
|
1683
|
-
* </note>
|
|
1341
|
+
* <p>The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the processing job. </p> <note> <p>Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a <code>VolumeKmsKeyId</code> when using an instance type with local storage.</p> <p>For a list of instance types that support local instance storage, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes">Instance Store Volumes</a>.</p> <p>For more information about local instance storage encryption, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html">SSD Instance Store Volumes</a>.</p> </note>
|
|
1684
1342
|
* @public
|
|
1685
1343
|
*/
|
|
1686
1344
|
VolumeKmsKeyId?: string | undefined;
|
|
1687
1345
|
}
|
|
1688
1346
|
/**
|
|
1689
|
-
* <p>Identifies the resources, ML compute instances, and ML storage volumes to deploy for a
|
|
1690
|
-
* processing job. In distributed training, you specify more than one instance.</p>
|
|
1347
|
+
* <p>Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.</p>
|
|
1691
1348
|
* @public
|
|
1692
1349
|
*/
|
|
1693
1350
|
export interface ProcessingResources {
|
|
1694
1351
|
/**
|
|
1695
|
-
* <p>The configuration for the resources in a cluster used to run the processing
|
|
1696
|
-
* job.</p>
|
|
1352
|
+
* <p>The configuration for the resources in a cluster used to run the processing job.</p>
|
|
1697
1353
|
* @public
|
|
1698
1354
|
*/
|
|
1699
1355
|
ClusterConfig: ProcessingClusterConfig | undefined;
|
|
1700
1356
|
}
|
|
1701
1357
|
/**
|
|
1702
|
-
* <p>Configures conditions under which the processing job should be stopped, such as how
|
|
1703
|
-
* long the processing job has been running. After the condition is met, the processing job
|
|
1704
|
-
* is stopped.</p>
|
|
1358
|
+
* <p>Configures conditions under which the processing job should be stopped, such as how long the processing job has been running. After the condition is met, the processing job is stopped.</p>
|
|
1705
1359
|
* @public
|
|
1706
1360
|
*/
|
|
1707
1361
|
export interface ProcessingStoppingCondition {
|
|
@@ -1716,8 +1370,7 @@ export interface ProcessingStoppingCondition {
|
|
|
1716
1370
|
*/
|
|
1717
1371
|
export interface CreateProcessingJobRequest {
|
|
1718
1372
|
/**
|
|
1719
|
-
* <p>An array of inputs configuring the data to download into the processing
|
|
1720
|
-
* container.</p>
|
|
1373
|
+
* <p>An array of inputs configuring the data to download into the processing container.</p>
|
|
1721
1374
|
* @public
|
|
1722
1375
|
*/
|
|
1723
1376
|
ProcessingInputs?: ProcessingInput[] | undefined;
|
|
@@ -1727,14 +1380,12 @@ export interface CreateProcessingJobRequest {
|
|
|
1727
1380
|
*/
|
|
1728
1381
|
ProcessingOutputConfig?: ProcessingOutputConfig | undefined;
|
|
1729
1382
|
/**
|
|
1730
|
-
* <p> The name of the processing job. The name must be unique within an Amazon Web Services
|
|
1731
|
-
* Region in the Amazon Web Services account.</p>
|
|
1383
|
+
* <p> The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.</p>
|
|
1732
1384
|
* @public
|
|
1733
1385
|
*/
|
|
1734
1386
|
ProcessingJobName: string | undefined;
|
|
1735
1387
|
/**
|
|
1736
|
-
* <p>Identifies the resources, ML compute instances, and ML storage volumes to deploy for a
|
|
1737
|
-
* processing job. In distributed training, you specify more than one instance.</p>
|
|
1388
|
+
* <p>Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.</p>
|
|
1738
1389
|
* @public
|
|
1739
1390
|
*/
|
|
1740
1391
|
ProcessingResources: ProcessingResources | undefined;
|
|
@@ -1749,64 +1400,27 @@ export interface CreateProcessingJobRequest {
|
|
|
1749
1400
|
*/
|
|
1750
1401
|
AppSpecification: AppSpecification | undefined;
|
|
1751
1402
|
/**
|
|
1752
|
-
* <p>The environment variables to set in the Docker container. Up to 100 key and values
|
|
1753
|
-
* entries in the map are supported.</p>
|
|
1754
|
-
* <important>
|
|
1755
|
-
* <p>Do not include any security-sensitive information including account access IDs, secrets,
|
|
1756
|
-
* or tokens in any environment fields. As part of the shared responsibility
|
|
1757
|
-
* model, you are responsible for any potential exposure, unauthorized access, or compromise of
|
|
1758
|
-
* your sensitive data if caused by security-sensitive information included in the
|
|
1759
|
-
* request environment variable or plain text fields.</p>
|
|
1760
|
-
* </important>
|
|
1403
|
+
* <p>The environment variables to set in the Docker container. Up to 100 key and values entries in the map are supported.</p> <important> <p>Do not include any security-sensitive information including account access IDs, secrets, or tokens in any environment fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request environment variable or plain text fields.</p> </important>
|
|
1761
1404
|
* @public
|
|
1762
1405
|
*/
|
|
1763
1406
|
Environment?: Record<string, string> | undefined;
|
|
1764
1407
|
/**
|
|
1765
|
-
* <p>Networking options for a processing job, such as whether to allow inbound and outbound
|
|
1766
|
-
* network calls to and from processing containers, and the VPC subnets and security groups
|
|
1767
|
-
* to use for VPC-enabled processing jobs.</p>
|
|
1408
|
+
* <p>Networking options for a processing job, such as whether to allow inbound and outbound network calls to and from processing containers, and the VPC subnets and security groups to use for VPC-enabled processing jobs.</p>
|
|
1768
1409
|
* @public
|
|
1769
1410
|
*/
|
|
1770
1411
|
NetworkConfig?: NetworkConfig | undefined;
|
|
1771
1412
|
/**
|
|
1772
|
-
* <p>The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on
|
|
1773
|
-
* your behalf.</p>
|
|
1413
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.</p>
|
|
1774
1414
|
* @public
|
|
1775
1415
|
*/
|
|
1776
1416
|
RoleArn: string | undefined;
|
|
1777
1417
|
/**
|
|
1778
|
-
* <p>(Optional) An array of key-value pairs. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL">Using Cost Allocation Tags</a> in the <i>Amazon Web Services Billing and
|
|
1779
|
-
* Cost Management User Guide</i>.</p>
|
|
1780
|
-
* <important>
|
|
1781
|
-
* <p>Do not include any security-sensitive information including account access IDs, secrets,
|
|
1782
|
-
* or tokens in any tags. As part of the shared responsibility
|
|
1783
|
-
* model, you are responsible for any potential exposure, unauthorized access, or compromise of
|
|
1784
|
-
* your sensitive data if caused by security-sensitive information included in the
|
|
1785
|
-
* request tag variable or plain text fields.</p>
|
|
1786
|
-
* </important>
|
|
1418
|
+
* <p>(Optional) An array of key-value pairs. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL">Using Cost Allocation Tags</a> in the <i>Amazon Web Services Billing and Cost Management User Guide</i>.</p> <important> <p>Do not include any security-sensitive information including account access IDs, secrets, or tokens in any tags. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request tag variable or plain text fields.</p> </important>
|
|
1787
1419
|
* @public
|
|
1788
1420
|
*/
|
|
1789
1421
|
Tags?: Tag[] | undefined;
|
|
1790
1422
|
/**
|
|
1791
|
-
* <p>Associates a SageMaker job as a trial component with an experiment and trial. Specified when
|
|
1792
|
-
* you call the following APIs:</p>
|
|
1793
|
-
* <ul>
|
|
1794
|
-
* <li>
|
|
1795
|
-
* <p>
|
|
1796
|
-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html">CreateProcessingJob</a>
|
|
1797
|
-
* </p>
|
|
1798
|
-
* </li>
|
|
1799
|
-
* <li>
|
|
1800
|
-
* <p>
|
|
1801
|
-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html">CreateTrainingJob</a>
|
|
1802
|
-
* </p>
|
|
1803
|
-
* </li>
|
|
1804
|
-
* <li>
|
|
1805
|
-
* <p>
|
|
1806
|
-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html">CreateTransformJob</a>
|
|
1807
|
-
* </p>
|
|
1808
|
-
* </li>
|
|
1809
|
-
* </ul>
|
|
1423
|
+
* <p>Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html">CreateProcessingJob</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html">CreateTrainingJob</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html">CreateTransformJob</a> </p> </li> </ul>
|
|
1810
1424
|
* @public
|
|
1811
1425
|
*/
|
|
1812
1426
|
ExperimentConfig?: ExperimentConfig | undefined;
|
|
@@ -1822,9 +1436,7 @@ export interface CreateProcessingJobResponse {
|
|
|
1822
1436
|
ProcessingJobArn: string | undefined;
|
|
1823
1437
|
}
|
|
1824
1438
|
/**
|
|
1825
|
-
* <p>A key value pair used when you provision a project as a service catalog product. For
|
|
1826
|
-
* information, see <a href="https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html">What is Amazon Web Services Service
|
|
1827
|
-
* Catalog</a>.</p>
|
|
1439
|
+
* <p>A key value pair used when you provision a project as a service catalog product. For information, see <a href="https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html">What is Amazon Web Services Service Catalog</a>.</p>
|
|
1828
1440
|
* @public
|
|
1829
1441
|
*/
|
|
1830
1442
|
export interface ProvisioningParameter {
|
|
@@ -1840,9 +1452,7 @@ export interface ProvisioningParameter {
|
|
|
1840
1452
|
Value?: string | undefined;
|
|
1841
1453
|
}
|
|
1842
1454
|
/**
|
|
1843
|
-
* <p>Details that you specify to provision a service catalog product. For information about
|
|
1844
|
-
* service catalog, see <a href="https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html">What is Amazon Web Services Service
|
|
1845
|
-
* Catalog</a>.</p>
|
|
1455
|
+
* <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>
|
|
1846
1456
|
* @public
|
|
1847
1457
|
*/
|
|
1848
1458
|
export interface ServiceCatalogProvisioningDetails {
|
|
@@ -1882,16 +1492,12 @@ export interface CreateProjectInput {
|
|
|
1882
1492
|
*/
|
|
1883
1493
|
ProjectDescription?: string | undefined;
|
|
1884
1494
|
/**
|
|
1885
|
-
* <p>The product ID and provisioning artifact ID to provision a service catalog. The provisioning
|
|
1886
|
-
* artifact ID will default to the latest provisioning artifact ID of the product, if you don't
|
|
1887
|
-
* 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
|
|
1888
|
-
* Catalog</a>.</p>
|
|
1495
|
+
* <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>
|
|
1889
1496
|
* @public
|
|
1890
1497
|
*/
|
|
1891
1498
|
ServiceCatalogProvisioningDetails?: ServiceCatalogProvisioningDetails | undefined;
|
|
1892
1499
|
/**
|
|
1893
|
-
* <p>An array of key-value pairs that you want to use to organize and track your Amazon Web Services
|
|
1894
|
-
* resource costs. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference Guide</i>.</p>
|
|
1500
|
+
* <p>An array of key-value pairs that you want to use to organize and track your Amazon Web Services resource costs. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference Guide</i>.</p>
|
|
1895
1501
|
* @public
|
|
1896
1502
|
*/
|
|
1897
1503
|
Tags?: Tag[] | undefined;
|
|
@@ -1928,15 +1534,13 @@ export interface OwnershipSettings {
|
|
|
1928
1534
|
*/
|
|
1929
1535
|
export interface SpaceIdleSettings {
|
|
1930
1536
|
/**
|
|
1931
|
-
* <p>The time that SageMaker waits after the application becomes idle before shutting it
|
|
1932
|
-
* down.</p>
|
|
1537
|
+
* <p>The time that SageMaker waits after the application becomes idle before shutting it down.</p>
|
|
1933
1538
|
* @public
|
|
1934
1539
|
*/
|
|
1935
1540
|
IdleTimeoutInMinutes?: number | undefined;
|
|
1936
1541
|
}
|
|
1937
1542
|
/**
|
|
1938
|
-
* <p>Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio
|
|
1939
|
-
* applications in a space.</p>
|
|
1543
|
+
* <p>Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio applications in a space.</p>
|
|
1940
1544
|
* @public
|
|
1941
1545
|
*/
|
|
1942
1546
|
export interface SpaceAppLifecycleManagement {
|
|
@@ -1952,25 +1556,18 @@ export interface SpaceAppLifecycleManagement {
|
|
|
1952
1556
|
*/
|
|
1953
1557
|
export interface SpaceCodeEditorAppSettings {
|
|
1954
1558
|
/**
|
|
1955
|
-
* <p>Specifies the ARN's of a SageMaker AI image and SageMaker AI image version, and the instance type that
|
|
1956
|
-
* the version runs on.</p>
|
|
1957
|
-
* <note>
|
|
1958
|
-
* <p>When both <code>SageMakerImageVersionArn</code> and <code>SageMakerImageArn</code> are passed, <code>SageMakerImageVersionArn</code> is used. Any updates to <code>SageMakerImageArn</code> will not take effect if <code>SageMakerImageVersionArn</code> already exists in the <code>ResourceSpec</code> because <code>SageMakerImageVersionArn</code> always takes precedence. To clear the value set for <code>SageMakerImageVersionArn</code>, pass <code>None</code> as the value.</p>
|
|
1959
|
-
* </note>
|
|
1559
|
+
* <p>Specifies the ARN's of a SageMaker AI image and SageMaker AI image version, and the instance type that the version runs on.</p> <note> <p>When both <code>SageMakerImageVersionArn</code> and <code>SageMakerImageArn</code> are passed, <code>SageMakerImageVersionArn</code> is used. Any updates to <code>SageMakerImageArn</code> will not take effect if <code>SageMakerImageVersionArn</code> already exists in the <code>ResourceSpec</code> because <code>SageMakerImageVersionArn</code> always takes precedence. To clear the value set for <code>SageMakerImageVersionArn</code>, pass <code>None</code> as the value.</p> </note>
|
|
1960
1560
|
* @public
|
|
1961
1561
|
*/
|
|
1962
1562
|
DefaultResourceSpec?: ResourceSpec | undefined;
|
|
1963
1563
|
/**
|
|
1964
|
-
* <p>Settings that are used to configure and manage the lifecycle of CodeEditor applications in
|
|
1965
|
-
* a space.</p>
|
|
1564
|
+
* <p>Settings that are used to configure and manage the lifecycle of CodeEditor applications in a space.</p>
|
|
1966
1565
|
* @public
|
|
1967
1566
|
*/
|
|
1968
1567
|
AppLifecycleManagement?: SpaceAppLifecycleManagement | undefined;
|
|
1969
1568
|
}
|
|
1970
1569
|
/**
|
|
1971
|
-
* <p>A file system, created by you in Amazon EFS, that you assign to a user profile or
|
|
1972
|
-
* space for an Amazon SageMaker AI Domain. Permitted users can access this file system in
|
|
1973
|
-
* Amazon SageMaker AI Studio.</p>
|
|
1570
|
+
* <p>A file system, created by you in Amazon EFS, that you assign to a user profile or space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI Studio.</p>
|
|
1974
1571
|
* @public
|
|
1975
1572
|
*/
|
|
1976
1573
|
export interface EFSFileSystem {
|
|
@@ -1992,8 +1589,7 @@ export interface FSxLustreFileSystem {
|
|
|
1992
1589
|
FileSystemId: string | undefined;
|
|
1993
1590
|
}
|
|
1994
1591
|
/**
|
|
1995
|
-
* <p>A file system, created by you, that you assign to a user profile or space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI
|
|
1996
|
-
* Studio.</p>
|
|
1592
|
+
* <p>A file system, created by you, that you assign to a user profile or space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI Studio.</p>
|
|
1997
1593
|
* @public
|
|
1998
1594
|
*/
|
|
1999
1595
|
export type CustomFileSystem = CustomFileSystem.EFSFileSystemMember | CustomFileSystem.FSxLustreFileSystemMember | CustomFileSystem.$UnknownMember;
|
|
@@ -2040,11 +1636,7 @@ export declare namespace CustomFileSystem {
|
|
|
2040
1636
|
*/
|
|
2041
1637
|
export interface SpaceJupyterLabAppSettings {
|
|
2042
1638
|
/**
|
|
2043
|
-
* <p>Specifies the ARN's of a SageMaker AI image and SageMaker AI image version, and the instance type that
|
|
2044
|
-
* the version runs on.</p>
|
|
2045
|
-
* <note>
|
|
2046
|
-
* <p>When both <code>SageMakerImageVersionArn</code> and <code>SageMakerImageArn</code> are passed, <code>SageMakerImageVersionArn</code> is used. Any updates to <code>SageMakerImageArn</code> will not take effect if <code>SageMakerImageVersionArn</code> already exists in the <code>ResourceSpec</code> because <code>SageMakerImageVersionArn</code> always takes precedence. To clear the value set for <code>SageMakerImageVersionArn</code>, pass <code>None</code> as the value.</p>
|
|
2047
|
-
* </note>
|
|
1639
|
+
* <p>Specifies the ARN's of a SageMaker AI image and SageMaker AI image version, and the instance type that the version runs on.</p> <note> <p>When both <code>SageMakerImageVersionArn</code> and <code>SageMakerImageArn</code> are passed, <code>SageMakerImageVersionArn</code> is used. Any updates to <code>SageMakerImageArn</code> will not take effect if <code>SageMakerImageVersionArn</code> already exists in the <code>ResourceSpec</code> because <code>SageMakerImageVersionArn</code> always takes precedence. To clear the value set for <code>SageMakerImageVersionArn</code>, pass <code>None</code> as the value.</p> </note>
|
|
2048
1640
|
* @public
|
|
2049
1641
|
*/
|
|
2050
1642
|
DefaultResourceSpec?: ResourceSpec | undefined;
|
|
@@ -2054,8 +1646,7 @@ export interface SpaceJupyterLabAppSettings {
|
|
|
2054
1646
|
*/
|
|
2055
1647
|
CodeRepositories?: CodeRepository[] | undefined;
|
|
2056
1648
|
/**
|
|
2057
|
-
* <p>Settings that are used to configure and manage the lifecycle of JupyterLab applications in
|
|
2058
|
-
* a space.</p>
|
|
1649
|
+
* <p>Settings that are used to configure and manage the lifecycle of JupyterLab applications in a space.</p>
|
|
2059
1650
|
* @public
|
|
2060
1651
|
*/
|
|
2061
1652
|
AppLifecycleManagement?: SpaceAppLifecycleManagement | undefined;
|
|
@@ -2108,10 +1699,7 @@ export interface SpaceSettings {
|
|
|
2108
1699
|
*/
|
|
2109
1700
|
JupyterLabAppSettings?: SpaceJupyterLabAppSettings | undefined;
|
|
2110
1701
|
/**
|
|
2111
|
-
* <p>The type of app created within the space.</p>
|
|
2112
|
-
* <p>If using the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateSpace.html">
|
|
2113
|
-
* UpdateSpace</a> API, you can't change the app type of your
|
|
2114
|
-
* space by specifying a different value for this field.</p>
|
|
1702
|
+
* <p>The type of app created within the space.</p> <p>If using the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateSpace.html"> UpdateSpace</a> API, you can't change the app type of your space by specifying a different value for this field.</p>
|
|
2115
1703
|
* @public
|
|
2116
1704
|
*/
|
|
2117
1705
|
AppType?: AppType | undefined;
|
|
@@ -2121,22 +1709,12 @@ export interface SpaceSettings {
|
|
|
2121
1709
|
*/
|
|
2122
1710
|
SpaceStorageSettings?: SpaceStorageSettings | undefined;
|
|
2123
1711
|
/**
|
|
2124
|
-
* <p>If you enable this option, SageMaker AI creates the following resources on your
|
|
2125
|
-
* behalf when you create the space:</p>
|
|
2126
|
-
* <ul>
|
|
2127
|
-
* <li>
|
|
2128
|
-
* <p>The user profile that possesses the space.</p>
|
|
2129
|
-
* </li>
|
|
2130
|
-
* <li>
|
|
2131
|
-
* <p>The app that the space contains.</p>
|
|
2132
|
-
* </li>
|
|
2133
|
-
* </ul>
|
|
1712
|
+
* <p>If you enable this option, SageMaker AI creates the following resources on your behalf when you create the space:</p> <ul> <li> <p>The user profile that possesses the space.</p> </li> <li> <p>The app that the space contains.</p> </li> </ul>
|
|
2134
1713
|
* @public
|
|
2135
1714
|
*/
|
|
2136
1715
|
SpaceManagedResources?: FeatureStatus | undefined;
|
|
2137
1716
|
/**
|
|
2138
|
-
* <p>A file system, created by you, that you assign to a space for an Amazon SageMaker AI
|
|
2139
|
-
* Domain. Permitted users can access this file system in Amazon SageMaker AI Studio.</p>
|
|
1717
|
+
* <p>A file system, created by you, that you assign to a space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI Studio.</p>
|
|
2140
1718
|
* @public
|
|
2141
1719
|
*/
|
|
2142
1720
|
CustomFileSystems?: CustomFileSystem[] | undefined;
|
|
@@ -2179,9 +1757,7 @@ export interface CreateSpaceRequest {
|
|
|
2179
1757
|
*/
|
|
2180
1758
|
SpaceName: string | undefined;
|
|
2181
1759
|
/**
|
|
2182
|
-
* <p>Tags to associated with the space. Each tag consists of a key and an optional value. Tag
|
|
2183
|
-
* keys must be unique for each resource. Tags are searchable using the <code>Search</code>
|
|
2184
|
-
* API.</p>
|
|
1760
|
+
* <p>Tags to associated with the space. Each tag consists of a key and an optional value. Tag keys must be unique for each resource. Tags are searchable using the <code>Search</code> API.</p>
|
|
2185
1761
|
* @public
|
|
2186
1762
|
*/
|
|
2187
1763
|
Tags?: Tag[] | undefined;
|
|
@@ -2240,8 +1816,7 @@ export interface CreateStudioLifecycleConfigRequest {
|
|
|
2240
1816
|
*/
|
|
2241
1817
|
StudioLifecycleConfigName: string | undefined;
|
|
2242
1818
|
/**
|
|
2243
|
-
* <p>The content of your Amazon SageMaker AI Studio Lifecycle Configuration script. This
|
|
2244
|
-
* content must be base64 encoded.</p>
|
|
1819
|
+
* <p>The content of your Amazon SageMaker AI Studio Lifecycle Configuration script. This content must be base64 encoded.</p>
|
|
2245
1820
|
* @public
|
|
2246
1821
|
*/
|
|
2247
1822
|
StudioLifecycleConfigContent: string | undefined;
|
|
@@ -2251,9 +1826,7 @@ export interface CreateStudioLifecycleConfigRequest {
|
|
|
2251
1826
|
*/
|
|
2252
1827
|
StudioLifecycleConfigAppType: StudioLifecycleConfigAppType | undefined;
|
|
2253
1828
|
/**
|
|
2254
|
-
* <p>Tags to be associated with the Lifecycle Configuration. Each tag consists of a key and an
|
|
2255
|
-
* optional value. Tag keys must be unique per resource. Tags are searchable using the Search
|
|
2256
|
-
* API. </p>
|
|
1829
|
+
* <p>Tags to be associated with the Lifecycle Configuration. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API. </p>
|
|
2257
1830
|
* @public
|
|
2258
1831
|
*/
|
|
2259
1832
|
Tags?: Tag[] | undefined;
|
|
@@ -2269,16 +1842,12 @@ export interface CreateStudioLifecycleConfigResponse {
|
|
|
2269
1842
|
StudioLifecycleConfigArn?: string | undefined;
|
|
2270
1843
|
}
|
|
2271
1844
|
/**
|
|
2272
|
-
* <p>Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and
|
|
2273
|
-
* storage paths. To learn more about
|
|
2274
|
-
* how to configure the <code>DebugHookConfig</code> parameter,
|
|
2275
|
-
* see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html">Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job</a>.</p>
|
|
1845
|
+
* <p>Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and storage paths. To learn more about how to configure the <code>DebugHookConfig</code> parameter, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html">Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job</a>.</p>
|
|
2276
1846
|
* @public
|
|
2277
1847
|
*/
|
|
2278
1848
|
export interface DebugHookConfig {
|
|
2279
1849
|
/**
|
|
2280
|
-
* <p>Path to local storage location for metrics and tensors. Defaults to
|
|
2281
|
-
* <code>/opt/ml/output/tensors/</code>.</p>
|
|
1850
|
+
* <p>Path to local storage location for metrics and tensors. Defaults to <code>/opt/ml/output/tensors/</code>.</p>
|
|
2282
1851
|
* @public
|
|
2283
1852
|
*/
|
|
2284
1853
|
LocalPath?: string | undefined;
|
|
@@ -2293,30 +1862,23 @@ export interface DebugHookConfig {
|
|
|
2293
1862
|
*/
|
|
2294
1863
|
HookParameters?: Record<string, string> | undefined;
|
|
2295
1864
|
/**
|
|
2296
|
-
* <p>Configuration information for Amazon SageMaker Debugger tensor collections. To learn more about
|
|
2297
|
-
* how to configure the <code>CollectionConfiguration</code> parameter,
|
|
2298
|
-
* see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html">Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job</a>.
|
|
2299
|
-
* </p>
|
|
1865
|
+
* <p>Configuration information for Amazon SageMaker Debugger tensor collections. To learn more about how to configure the <code>CollectionConfiguration</code> parameter, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html">Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job</a>. </p>
|
|
2300
1866
|
* @public
|
|
2301
1867
|
*/
|
|
2302
1868
|
CollectionConfigurations?: CollectionConfiguration[] | undefined;
|
|
2303
1869
|
}
|
|
2304
1870
|
/**
|
|
2305
|
-
* <p>Configuration information for SageMaker Debugger rules for debugging. To learn more about
|
|
2306
|
-
* how to configure the <code>DebugRuleConfiguration</code> parameter,
|
|
2307
|
-
* see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html">Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job</a>.</p>
|
|
1871
|
+
* <p>Configuration information for SageMaker Debugger rules for debugging. To learn more about how to configure the <code>DebugRuleConfiguration</code> parameter, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html">Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job</a>.</p>
|
|
2308
1872
|
* @public
|
|
2309
1873
|
*/
|
|
2310
1874
|
export interface DebugRuleConfiguration {
|
|
2311
1875
|
/**
|
|
2312
|
-
* <p>The name of the rule configuration. It must be unique relative to other rule
|
|
2313
|
-
* configuration names.</p>
|
|
1876
|
+
* <p>The name of the rule configuration. It must be unique relative to other rule configuration names.</p>
|
|
2314
1877
|
* @public
|
|
2315
1878
|
*/
|
|
2316
1879
|
RuleConfigurationName: string | undefined;
|
|
2317
1880
|
/**
|
|
2318
|
-
* <p>Path to local storage location for output of rules. Defaults to
|
|
2319
|
-
* <code>/opt/ml/processing/output/rule/</code>.</p>
|
|
1881
|
+
* <p>Path to local storage location for output of rules. Defaults to <code>/opt/ml/processing/output/rule/</code>.</p>
|
|
2320
1882
|
* @public
|
|
2321
1883
|
*/
|
|
2322
1884
|
LocalPath?: string | undefined;
|
|
@@ -2347,8 +1909,7 @@ export interface DebugRuleConfiguration {
|
|
|
2347
1909
|
RuleParameters?: Record<string, string> | undefined;
|
|
2348
1910
|
}
|
|
2349
1911
|
/**
|
|
2350
|
-
* <p>Configuration information for the infrastructure health check of a training job. A SageMaker-provided health check tests the health of instance hardware and cluster network
|
|
2351
|
-
* connectivity.</p>
|
|
1912
|
+
* <p>Configuration information for the infrastructure health check of a training job. A SageMaker-provided health check tests the health of instance hardware and cluster network connectivity.</p>
|
|
2352
1913
|
* @public
|
|
2353
1914
|
*/
|
|
2354
1915
|
export interface InfraCheckConfig {
|
|
@@ -2359,8 +1920,7 @@ export interface InfraCheckConfig {
|
|
|
2359
1920
|
EnableInfraCheck?: boolean | undefined;
|
|
2360
1921
|
}
|
|
2361
1922
|
/**
|
|
2362
|
-
* <p>Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and
|
|
2363
|
-
* storage paths.</p>
|
|
1923
|
+
* <p>Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and storage paths.</p>
|
|
2364
1924
|
* @public
|
|
2365
1925
|
*/
|
|
2366
1926
|
export interface ProfilerConfig {
|
|
@@ -2370,18 +1930,12 @@ export interface ProfilerConfig {
|
|
|
2370
1930
|
*/
|
|
2371
1931
|
S3OutputPath?: string | undefined;
|
|
2372
1932
|
/**
|
|
2373
|
-
* <p>A time interval for capturing system metrics in milliseconds. Available values are
|
|
2374
|
-
* 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.</p>
|
|
1933
|
+
* <p>A time interval for capturing system metrics in milliseconds. Available values are 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.</p>
|
|
2375
1934
|
* @public
|
|
2376
1935
|
*/
|
|
2377
1936
|
ProfilingIntervalInMilliseconds?: number | undefined;
|
|
2378
1937
|
/**
|
|
2379
|
-
* <p>Configuration information for capturing framework metrics. Available key strings for different profiling options are
|
|
2380
|
-
* <code>DetailedProfilingConfig</code>, <code>PythonProfilingConfig</code>, and <code>DataLoaderProfilingConfig</code>.
|
|
2381
|
-
* The following codes are configuration structures for the <code>ProfilingParameters</code> parameter. To learn more about
|
|
2382
|
-
* how to configure the <code>ProfilingParameters</code> parameter,
|
|
2383
|
-
* see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html">Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job</a>.
|
|
2384
|
-
* </p>
|
|
1938
|
+
* <p>Configuration information for capturing framework metrics. Available key strings for different profiling options are <code>DetailedProfilingConfig</code>, <code>PythonProfilingConfig</code>, and <code>DataLoaderProfilingConfig</code>. The following codes are configuration structures for the <code>ProfilingParameters</code> parameter. To learn more about how to configure the <code>ProfilingParameters</code> parameter, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html">Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job</a>. </p>
|
|
2385
1939
|
* @public
|
|
2386
1940
|
*/
|
|
2387
1941
|
ProfilingParameters?: Record<string, string> | undefined;
|
|
@@ -2433,10 +1987,7 @@ export interface ProfilerRuleConfiguration {
|
|
|
2433
1987
|
RuleParameters?: Record<string, string> | undefined;
|
|
2434
1988
|
}
|
|
2435
1989
|
/**
|
|
2436
|
-
* <p>Configuration for remote debugging for the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html">CreateTrainingJob</a> API. To learn more about the remote debugging
|
|
2437
|
-
* functionality of SageMaker, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/train-remote-debugging.html">Access a training container
|
|
2438
|
-
* through Amazon Web Services Systems Manager (SSM) for remote
|
|
2439
|
-
* debugging</a>.</p>
|
|
1990
|
+
* <p>Configuration for remote debugging for the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html">CreateTrainingJob</a> API. 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>
|
|
2440
1991
|
* @public
|
|
2441
1992
|
*/
|
|
2442
1993
|
export interface RemoteDebugConfig {
|
|
@@ -2447,16 +1998,12 @@ export interface RemoteDebugConfig {
|
|
|
2447
1998
|
EnableRemoteDebug?: boolean | undefined;
|
|
2448
1999
|
}
|
|
2449
2000
|
/**
|
|
2450
|
-
* <p>Contains information about attribute-based access control (ABAC) for a training job.
|
|
2451
|
-
* The session chaining configuration uses Amazon Security Token Service (STS) for your training job to
|
|
2452
|
-
* request temporary, limited-privilege credentials to tenants. For more information, see
|
|
2453
|
-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-access-training-data.html#model-access-training-data-abac">Attribute-based access control (ABAC) for multi-tenancy training</a>.</p>
|
|
2001
|
+
* <p>Contains information about attribute-based access control (ABAC) for a training job. The session chaining configuration uses Amazon Security Token Service (STS) for your training job to request temporary, limited-privilege credentials to tenants. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-access-training-data.html#model-access-training-data-abac">Attribute-based access control (ABAC) for multi-tenancy training</a>.</p>
|
|
2454
2002
|
* @public
|
|
2455
2003
|
*/
|
|
2456
2004
|
export interface SessionChainingConfig {
|
|
2457
2005
|
/**
|
|
2458
|
-
* <p>Set to <code>True</code> to allow SageMaker to extract session tags from a training job
|
|
2459
|
-
* creation role and reuse these tags when assuming the training job execution role.</p>
|
|
2006
|
+
* <p>Set to <code>True</code> to allow SageMaker to extract session tags from a training job creation role and reuse these tags when assuming the training job execution role.</p>
|
|
2460
2007
|
* @public
|
|
2461
2008
|
*/
|
|
2462
2009
|
EnableSessionTagChaining?: boolean | undefined;
|
|
@@ -2467,8 +2014,7 @@ export interface SessionChainingConfig {
|
|
|
2467
2014
|
*/
|
|
2468
2015
|
export interface TensorBoardOutputConfig {
|
|
2469
2016
|
/**
|
|
2470
|
-
* <p>Path to local storage location for tensorBoard output. Defaults to
|
|
2471
|
-
* <code>/opt/ml/output/tensorboard</code>.</p>
|
|
2017
|
+
* <p>Path to local storage location for tensorBoard output. Defaults to <code>/opt/ml/output/tensorboard</code>.</p>
|
|
2472
2018
|
* @public
|
|
2473
2019
|
*/
|
|
2474
2020
|
LocalPath?: string | undefined;
|
|
@@ -2483,161 +2029,77 @@ export interface TensorBoardOutputConfig {
|
|
|
2483
2029
|
*/
|
|
2484
2030
|
export interface CreateTrainingJobRequest {
|
|
2485
2031
|
/**
|
|
2486
|
-
* <p>The name of the training job. The name must be unique within an Amazon Web Services
|
|
2487
|
-
* Region in an Amazon Web Services account. </p>
|
|
2032
|
+
* <p>The name of the training job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account. </p>
|
|
2488
2033
|
* @public
|
|
2489
2034
|
*/
|
|
2490
2035
|
TrainingJobName: string | undefined;
|
|
2491
2036
|
/**
|
|
2492
|
-
* <p>Algorithm-specific parameters that influence the quality of the model. You set
|
|
2493
|
-
* hyperparameters before you start the learning process. For a list of hyperparameters for
|
|
2494
|
-
* each training algorithm provided by SageMaker, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html">Algorithms</a>. </p>
|
|
2495
|
-
* <p>You can specify a maximum of 100 hyperparameters. Each hyperparameter is a
|
|
2496
|
-
* key-value pair. Each key and value is limited to 256 characters, as specified by the
|
|
2497
|
-
* <code>Length Constraint</code>. </p>
|
|
2498
|
-
* <important>
|
|
2499
|
-
* <p>Do not include any security-sensitive information including account access IDs, secrets,
|
|
2500
|
-
* or tokens in any hyperparameter fields. As part of the shared responsibility
|
|
2501
|
-
* model, you are responsible for any potential exposure, unauthorized access, or compromise
|
|
2502
|
-
* of your sensitive data if caused by any security-sensitive information included in the
|
|
2503
|
-
* request hyperparameter variable or plain text fields.</p>
|
|
2504
|
-
* </important>
|
|
2037
|
+
* <p>Algorithm-specific parameters that influence the quality of the model. You set hyperparameters before you start the learning process. For a list of hyperparameters for each training algorithm provided by SageMaker, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html">Algorithms</a>. </p> <p>You can specify a maximum of 100 hyperparameters. Each hyperparameter is a key-value pair. Each key and value is limited to 256 characters, as specified by the <code>Length Constraint</code>. </p> <important> <p>Do not include any security-sensitive information including account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by any security-sensitive information included in the request hyperparameter variable or plain text fields.</p> </important>
|
|
2505
2038
|
* @public
|
|
2506
2039
|
*/
|
|
2507
2040
|
HyperParameters?: Record<string, string> | undefined;
|
|
2508
2041
|
/**
|
|
2509
|
-
* <p>The registry path of the Docker image that contains the training algorithm and
|
|
2510
|
-
* algorithm-specific metadata, including the input mode. For more information about
|
|
2511
|
-
* algorithms provided by SageMaker, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html">Algorithms</a>. For information about
|
|
2512
|
-
* providing your own algorithms, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html">Using Your Own Algorithms with
|
|
2513
|
-
* Amazon SageMaker</a>. </p>
|
|
2042
|
+
* <p>The registry path of the Docker image that contains the training algorithm and algorithm-specific metadata, including the input mode. For more information about algorithms provided by SageMaker, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html">Algorithms</a>. For information about providing your own algorithms, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html">Using Your Own Algorithms with Amazon SageMaker</a>. </p>
|
|
2514
2043
|
* @public
|
|
2515
2044
|
*/
|
|
2516
2045
|
AlgorithmSpecification: AlgorithmSpecification | undefined;
|
|
2517
2046
|
/**
|
|
2518
|
-
* <p>The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to perform
|
|
2519
|
-
* tasks on your behalf. </p>
|
|
2520
|
-
* <p>During model training, SageMaker needs your permission to read input data from an S3
|
|
2521
|
-
* bucket, download a Docker image that contains training code, write model artifacts to an
|
|
2522
|
-
* S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant
|
|
2523
|
-
* permissions for all of these tasks to an IAM role. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html">SageMaker
|
|
2524
|
-
* Roles</a>. </p>
|
|
2525
|
-
* <note>
|
|
2526
|
-
* <p>To be able to pass this role to SageMaker, the caller of this API must have the
|
|
2527
|
-
* <code>iam:PassRole</code> permission.</p>
|
|
2528
|
-
* </note>
|
|
2047
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to perform tasks on your behalf. </p> <p>During model training, SageMaker needs your permission to read input data from an S3 bucket, download a Docker image that contains training code, write model artifacts to an S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant permissions for all of these tasks to an IAM role. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html">SageMaker Roles</a>. </p> <note> <p>To be able to pass this role to SageMaker, the caller of this API must have the <code>iam:PassRole</code> permission.</p> </note>
|
|
2529
2048
|
* @public
|
|
2530
2049
|
*/
|
|
2531
2050
|
RoleArn: string | undefined;
|
|
2532
2051
|
/**
|
|
2533
|
-
* <p>An array of <code>Channel</code> objects. Each channel is a named input source.
|
|
2534
|
-
* <code>InputDataConfig</code> describes the input data and its location. </p>
|
|
2535
|
-
* <p>Algorithms can accept input data from one or more channels. For example, an
|
|
2536
|
-
* algorithm might have two channels of input data, <code>training_data</code> and
|
|
2537
|
-
* <code>validation_data</code>. The configuration for each channel provides the S3,
|
|
2538
|
-
* EFS, or FSx location where the input data is stored. It also provides information about
|
|
2539
|
-
* the stored data: the MIME type, compression method, and whether the data is wrapped in
|
|
2540
|
-
* RecordIO format. </p>
|
|
2541
|
-
* <p>Depending on the input mode that the algorithm supports, SageMaker either copies input
|
|
2542
|
-
* data files from an S3 bucket to a local directory in the Docker container, or makes it
|
|
2543
|
-
* available as input streams. For example, if you specify an EFS location, input data
|
|
2544
|
-
* files are available as input streams. They do not need to be downloaded.</p>
|
|
2545
|
-
* <p>Your input must be in the same Amazon Web Services region as your training
|
|
2546
|
-
* job.</p>
|
|
2052
|
+
* <p>An array of <code>Channel</code> objects. Each channel is a named input source. <code>InputDataConfig</code> describes the input data and its location. </p> <p>Algorithms can accept input data from one or more channels. For example, an algorithm might have two channels of input data, <code>training_data</code> and <code>validation_data</code>. The configuration for each channel provides the S3, EFS, or FSx location where the input data is stored. It also provides information about the stored data: the MIME type, compression method, and whether the data is wrapped in RecordIO format. </p> <p>Depending on the input mode that the algorithm supports, SageMaker either copies input data files from an S3 bucket to a local directory in the Docker container, or makes it available as input streams. For example, if you specify an EFS location, input data files are available as input streams. They do not need to be downloaded.</p> <p>Your input must be in the same Amazon Web Services region as your training job.</p>
|
|
2547
2053
|
* @public
|
|
2548
2054
|
*/
|
|
2549
2055
|
InputDataConfig?: Channel[] | undefined;
|
|
2550
2056
|
/**
|
|
2551
|
-
* <p>Specifies the path to the S3 location where you want to store model artifacts. SageMaker
|
|
2552
|
-
* creates subfolders for the artifacts. </p>
|
|
2057
|
+
* <p>Specifies the path to the S3 location where you want to store model artifacts. SageMaker creates subfolders for the artifacts. </p>
|
|
2553
2058
|
* @public
|
|
2554
2059
|
*/
|
|
2555
2060
|
OutputDataConfig: OutputDataConfig | undefined;
|
|
2556
2061
|
/**
|
|
2557
|
-
* <p>The resources, including the ML compute instances and ML storage volumes, to use
|
|
2558
|
-
* for model training. </p>
|
|
2559
|
-
* <p>ML storage volumes store model artifacts and incremental states. Training
|
|
2560
|
-
* algorithms might also use ML storage volumes for scratch space. If you want SageMaker to use
|
|
2561
|
-
* the ML storage volume to store the training data, choose <code>File</code> as the
|
|
2562
|
-
* <code>TrainingInputMode</code> in the algorithm specification. For distributed
|
|
2563
|
-
* training algorithms, specify an instance count greater than 1.</p>
|
|
2062
|
+
* <p>The resources, including the ML compute instances and ML storage volumes, to use for model training. </p> <p>ML storage volumes store model artifacts and incremental states. Training algorithms might also use ML storage volumes for scratch space. If you want SageMaker to use the ML storage volume to store the training data, choose <code>File</code> as the <code>TrainingInputMode</code> in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.</p>
|
|
2564
2063
|
* @public
|
|
2565
2064
|
*/
|
|
2566
2065
|
ResourceConfig: ResourceConfig | undefined;
|
|
2567
2066
|
/**
|
|
2568
|
-
* <p>A <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html">VpcConfig</a> object that specifies the VPC that you want your training job to
|
|
2569
|
-
* connect to. Control access to and from your training container by configuring the VPC.
|
|
2570
|
-
* For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html">Protect Training Jobs by Using an Amazon
|
|
2571
|
-
* Virtual Private Cloud</a>.</p>
|
|
2067
|
+
* <p>A <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html">VpcConfig</a> object that specifies the VPC that you want your training job to connect to. Control access to and from your training container by configuring the VPC. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html">Protect Training Jobs by Using an Amazon Virtual Private Cloud</a>.</p>
|
|
2572
2068
|
* @public
|
|
2573
2069
|
*/
|
|
2574
2070
|
VpcConfig?: VpcConfig | undefined;
|
|
2575
2071
|
/**
|
|
2576
|
-
* <p>Specifies a limit to how long a model training job can run. It also specifies how long
|
|
2577
|
-
* a managed Spot training job has to complete. When the job reaches the time limit, SageMaker
|
|
2578
|
-
* ends the training job. Use this API to cap model training costs.</p>
|
|
2579
|
-
* <p>To stop a job, SageMaker sends the algorithm the <code>SIGTERM</code> signal, which delays
|
|
2580
|
-
* job termination for 120 seconds. Algorithms can use this 120-second window to save the
|
|
2581
|
-
* model artifacts, so the results of training are not lost. </p>
|
|
2072
|
+
* <p>Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.</p> <p>To stop a job, SageMaker sends the algorithm the <code>SIGTERM</code> signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost. </p>
|
|
2582
2073
|
* @public
|
|
2583
2074
|
*/
|
|
2584
2075
|
StoppingCondition: StoppingCondition | undefined;
|
|
2585
2076
|
/**
|
|
2586
|
-
* <p>An array of key-value pairs. You can use tags to categorize your Amazon Web Services
|
|
2587
|
-
* resources in different ways, for example, by purpose, owner, or environment. For more
|
|
2588
|
-
* information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a>.</p>
|
|
2589
|
-
* <important>
|
|
2590
|
-
* <p>Do not include any security-sensitive information including account access IDs, secrets,
|
|
2591
|
-
* or tokens in any tags. As part of the shared responsibility model, you are
|
|
2592
|
-
* responsible for any potential exposure, unauthorized access, or compromise
|
|
2593
|
-
* of your sensitive data if caused by any security-sensitive information included in the
|
|
2594
|
-
* request tag variable or plain text fields.</p>
|
|
2595
|
-
* </important>
|
|
2077
|
+
* <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>.</p> <important> <p>Do not include any security-sensitive information including account access IDs, secrets, or tokens in any tags. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by any security-sensitive information included in the request tag variable or plain text fields.</p> </important>
|
|
2596
2078
|
* @public
|
|
2597
2079
|
*/
|
|
2598
2080
|
Tags?: Tag[] | undefined;
|
|
2599
2081
|
/**
|
|
2600
|
-
* <p>Isolates the training container. No inbound or outbound network calls can be made,
|
|
2601
|
-
* except for calls between peers within a training cluster for distributed training. If
|
|
2602
|
-
* you enable network isolation for training jobs that are configured to use a VPC, SageMaker
|
|
2603
|
-
* downloads and uploads customer data and model artifacts through the specified VPC, but
|
|
2604
|
-
* the training container does not have network access.</p>
|
|
2082
|
+
* <p>Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If you enable network isolation for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.</p>
|
|
2605
2083
|
* @public
|
|
2606
2084
|
*/
|
|
2607
2085
|
EnableNetworkIsolation?: boolean | undefined;
|
|
2608
2086
|
/**
|
|
2609
|
-
* <p>To encrypt all communications between ML compute instances in distributed training,
|
|
2610
|
-
* choose <code>True</code>. Encryption provides greater security for distributed training,
|
|
2611
|
-
* but training might take longer. How long it takes depends on the amount of communication
|
|
2612
|
-
* between compute instances, especially if you use a deep learning algorithm in
|
|
2613
|
-
* distributed training. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/train-encrypt.html">Protect Communications Between ML
|
|
2614
|
-
* Compute Instances in a Distributed Training Job</a>.</p>
|
|
2087
|
+
* <p>To encrypt all communications between ML compute instances in distributed training, choose <code>True</code>. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/train-encrypt.html">Protect Communications Between ML Compute Instances in a Distributed Training Job</a>.</p>
|
|
2615
2088
|
* @public
|
|
2616
2089
|
*/
|
|
2617
2090
|
EnableInterContainerTrafficEncryption?: boolean | undefined;
|
|
2618
2091
|
/**
|
|
2619
|
-
* <p>To train models using managed spot training, choose <code>True</code>. Managed spot
|
|
2620
|
-
* training provides a fully managed and scalable infrastructure for training machine
|
|
2621
|
-
* learning models. this option is useful when training jobs can be interrupted and when
|
|
2622
|
-
* there is flexibility when the training job is run. </p>
|
|
2623
|
-
* <p>The complete and intermediate results of jobs are stored in an Amazon S3 bucket, and can be
|
|
2624
|
-
* used as a starting point to train models incrementally. Amazon SageMaker provides metrics and
|
|
2625
|
-
* logs in CloudWatch. They can be used to see when managed spot training jobs are running,
|
|
2626
|
-
* interrupted, resumed, or completed. </p>
|
|
2092
|
+
* <p>To train models using managed spot training, choose <code>True</code>. Managed spot training provides a fully managed and scalable infrastructure for training machine learning models. this option is useful when training jobs can be interrupted and when there is flexibility when the training job is run. </p> <p>The complete and intermediate results of jobs are stored in an Amazon S3 bucket, and can be used as a starting point to train models incrementally. Amazon SageMaker provides metrics and logs in CloudWatch. They can be used to see when managed spot training jobs are running, interrupted, resumed, or completed. </p>
|
|
2627
2093
|
* @public
|
|
2628
2094
|
*/
|
|
2629
2095
|
EnableManagedSpotTraining?: boolean | undefined;
|
|
2630
2096
|
/**
|
|
2631
|
-
* <p>Contains information about the output location for managed spot training checkpoint
|
|
2632
|
-
* data.</p>
|
|
2097
|
+
* <p>Contains information about the output location for managed spot training checkpoint data.</p>
|
|
2633
2098
|
* @public
|
|
2634
2099
|
*/
|
|
2635
2100
|
CheckpointConfig?: CheckpointConfig | undefined;
|
|
2636
2101
|
/**
|
|
2637
|
-
* <p>Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and
|
|
2638
|
-
* storage paths. To learn more about
|
|
2639
|
-
* how to configure the <code>DebugHookConfig</code> parameter,
|
|
2640
|
-
* see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html">Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job</a>.</p>
|
|
2102
|
+
* <p>Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and storage paths. To learn more about how to configure the <code>DebugHookConfig</code> parameter, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html">Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job</a>.</p>
|
|
2641
2103
|
* @public
|
|
2642
2104
|
*/
|
|
2643
2105
|
DebugHookConfig?: DebugHookConfig | undefined;
|
|
@@ -2652,63 +2114,32 @@ export interface CreateTrainingJobRequest {
|
|
|
2652
2114
|
*/
|
|
2653
2115
|
TensorBoardOutputConfig?: TensorBoardOutputConfig | undefined;
|
|
2654
2116
|
/**
|
|
2655
|
-
* <p>Associates a SageMaker job as a trial component with an experiment and trial. Specified when
|
|
2656
|
-
* you call the following APIs:</p>
|
|
2657
|
-
* <ul>
|
|
2658
|
-
* <li>
|
|
2659
|
-
* <p>
|
|
2660
|
-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html">CreateProcessingJob</a>
|
|
2661
|
-
* </p>
|
|
2662
|
-
* </li>
|
|
2663
|
-
* <li>
|
|
2664
|
-
* <p>
|
|
2665
|
-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html">CreateTrainingJob</a>
|
|
2666
|
-
* </p>
|
|
2667
|
-
* </li>
|
|
2668
|
-
* <li>
|
|
2669
|
-
* <p>
|
|
2670
|
-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html">CreateTransformJob</a>
|
|
2671
|
-
* </p>
|
|
2672
|
-
* </li>
|
|
2673
|
-
* </ul>
|
|
2117
|
+
* <p>Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html">CreateProcessingJob</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html">CreateTrainingJob</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html">CreateTransformJob</a> </p> </li> </ul>
|
|
2674
2118
|
* @public
|
|
2675
2119
|
*/
|
|
2676
2120
|
ExperimentConfig?: ExperimentConfig | undefined;
|
|
2677
2121
|
/**
|
|
2678
|
-
* <p>Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and
|
|
2679
|
-
* storage paths.</p>
|
|
2122
|
+
* <p>Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and storage paths.</p>
|
|
2680
2123
|
* @public
|
|
2681
2124
|
*/
|
|
2682
2125
|
ProfilerConfig?: ProfilerConfig | undefined;
|
|
2683
2126
|
/**
|
|
2684
|
-
* <p>Configuration information for Amazon SageMaker Debugger rules for profiling system and framework
|
|
2685
|
-
* metrics.</p>
|
|
2127
|
+
* <p>Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.</p>
|
|
2686
2128
|
* @public
|
|
2687
2129
|
*/
|
|
2688
2130
|
ProfilerRuleConfigurations?: ProfilerRuleConfiguration[] | undefined;
|
|
2689
2131
|
/**
|
|
2690
|
-
* <p>The environment variables to set in the Docker container.</p>
|
|
2691
|
-
* <important>
|
|
2692
|
-
* <p>Do not include any security-sensitive information including account access IDs,
|
|
2693
|
-
* secrets, or tokens in any environment fields. As part of the shared responsibility model,
|
|
2694
|
-
* you are responsible for any potential exposure, unauthorized access, or compromise of your
|
|
2695
|
-
* sensitive data if caused by security-sensitive information included in the request environment variable
|
|
2696
|
-
* or plain text fields.</p>
|
|
2697
|
-
* </important>
|
|
2132
|
+
* <p>The environment variables to set in the Docker container.</p> <important> <p>Do not include any security-sensitive information including account access IDs, secrets, or tokens in any environment fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request environment variable or plain text fields.</p> </important>
|
|
2698
2133
|
* @public
|
|
2699
2134
|
*/
|
|
2700
2135
|
Environment?: Record<string, string> | undefined;
|
|
2701
2136
|
/**
|
|
2702
|
-
* <p>The number of times to retry the job when the job fails due to an
|
|
2703
|
-
* <code>InternalServerError</code>.</p>
|
|
2137
|
+
* <p>The number of times to retry the job when the job fails due to an <code>InternalServerError</code>.</p>
|
|
2704
2138
|
* @public
|
|
2705
2139
|
*/
|
|
2706
2140
|
RetryStrategy?: RetryStrategy | undefined;
|
|
2707
2141
|
/**
|
|
2708
|
-
* <p>Configuration for remote debugging. To learn more about the remote debugging
|
|
2709
|
-
* functionality of SageMaker, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/train-remote-debugging.html">Access a training container
|
|
2710
|
-
* through Amazon Web Services Systems Manager (SSM) for remote
|
|
2711
|
-
* debugging</a>.</p>
|
|
2142
|
+
* <p>Configuration for remote debugging. 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>
|
|
2712
2143
|
* @public
|
|
2713
2144
|
*/
|
|
2714
2145
|
RemoteDebugConfig?: RemoteDebugConfig | undefined;
|
|
@@ -2718,8 +2149,7 @@ export interface CreateTrainingJobRequest {
|
|
|
2718
2149
|
*/
|
|
2719
2150
|
InfraCheckConfig?: InfraCheckConfig | undefined;
|
|
2720
2151
|
/**
|
|
2721
|
-
* <p>Contains information about attribute-based access control (ABAC) for the training
|
|
2722
|
-
* job.</p>
|
|
2152
|
+
* <p>Contains information about attribute-based access control (ABAC) for the training job.</p>
|
|
2723
2153
|
* @public
|
|
2724
2154
|
*/
|
|
2725
2155
|
SessionChainingConfig?: SessionChainingConfig | undefined;
|
|
@@ -2744,8 +2174,7 @@ export interface CreateTrainingPlanRequest {
|
|
|
2744
2174
|
*/
|
|
2745
2175
|
TrainingPlanName: string | undefined;
|
|
2746
2176
|
/**
|
|
2747
|
-
* <p>The unique identifier of the training plan offering to use for creating this
|
|
2748
|
-
* plan.</p>
|
|
2177
|
+
* <p>The unique identifier of the training plan offering to use for creating this plan.</p>
|
|
2749
2178
|
* @public
|
|
2750
2179
|
*/
|
|
2751
2180
|
TrainingPlanOfferingId: string | undefined;
|
|
@@ -2778,76 +2207,38 @@ export declare const JoinSource: {
|
|
|
2778
2207
|
*/
|
|
2779
2208
|
export type JoinSource = (typeof JoinSource)[keyof typeof JoinSource];
|
|
2780
2209
|
/**
|
|
2781
|
-
* <p>The data structure used to specify the data to be used for inference in a batch
|
|
2782
|
-
* transform job and to associate the data that is relevant to the prediction results in
|
|
2783
|
-
* the output. The input filter provided allows you to exclude input data that is not
|
|
2784
|
-
* needed for inference in a batch transform job. The output filter provided allows you to
|
|
2785
|
-
* include input data relevant to interpreting the predictions in the output from the job.
|
|
2786
|
-
* For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html">Associate Prediction
|
|
2787
|
-
* Results with their Corresponding Input Records</a>.</p>
|
|
2210
|
+
* <p>The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output. The input filter provided allows you to exclude input data that is not needed for inference in a batch transform job. The output filter provided allows you to include input data relevant to interpreting the predictions in the output from the job. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html">Associate Prediction Results with their Corresponding Input Records</a>.</p>
|
|
2788
2211
|
* @public
|
|
2789
2212
|
*/
|
|
2790
2213
|
export interface DataProcessing {
|
|
2791
2214
|
/**
|
|
2792
|
-
* <p>A <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html#data-processing-operators">JSONPath</a> expression used to select a portion of the input data to pass to
|
|
2793
|
-
* the algorithm. Use the <code>InputFilter</code> parameter to exclude fields, such as an
|
|
2794
|
-
* ID column, from the input. If you want SageMaker to pass the entire input dataset to the
|
|
2795
|
-
* algorithm, accept the default value <code>$</code>.</p>
|
|
2796
|
-
* <p>Examples: <code>"$"</code>, <code>"$[1:]"</code>, <code>"$.features"</code>
|
|
2797
|
-
* </p>
|
|
2215
|
+
* <p>A <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html#data-processing-operators">JSONPath</a> expression used to select a portion of the input data to pass to the algorithm. Use the <code>InputFilter</code> parameter to exclude fields, such as an ID column, from the input. If you want SageMaker to pass the entire input dataset to the algorithm, accept the default value <code>$</code>.</p> <p>Examples: <code>"$"</code>, <code>"$[1:]"</code>, <code>"$.features"</code> </p>
|
|
2798
2216
|
* @public
|
|
2799
2217
|
*/
|
|
2800
2218
|
InputFilter?: string | undefined;
|
|
2801
2219
|
/**
|
|
2802
|
-
* <p>A <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html#data-processing-operators">JSONPath</a> expression used to select a portion of the joined dataset to save
|
|
2803
|
-
* in the output file for a batch transform job. If you want SageMaker to store the entire input
|
|
2804
|
-
* dataset in the output file, leave the default value, <code>$</code>. If you specify
|
|
2805
|
-
* indexes that aren't within the dimension size of the joined dataset, you get an
|
|
2806
|
-
* error.</p>
|
|
2807
|
-
* <p>Examples: <code>"$"</code>, <code>"$[0,5:]"</code>,
|
|
2808
|
-
* <code>"$['id','SageMakerOutput']"</code>
|
|
2809
|
-
* </p>
|
|
2220
|
+
* <p>A <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html#data-processing-operators">JSONPath</a> expression used to select a portion of the joined dataset to save in the output file for a batch transform job. If you want SageMaker to store the entire input dataset in the output file, leave the default value, <code>$</code>. If you specify indexes that aren't within the dimension size of the joined dataset, you get an error.</p> <p>Examples: <code>"$"</code>, <code>"$[0,5:]"</code>, <code>"$['id','SageMakerOutput']"</code> </p>
|
|
2810
2221
|
* @public
|
|
2811
2222
|
*/
|
|
2812
2223
|
OutputFilter?: string | undefined;
|
|
2813
2224
|
/**
|
|
2814
|
-
* <p>Specifies the source of the data to join with the transformed data. The valid values
|
|
2815
|
-
* are <code>None</code> and <code>Input</code>. The default value is <code>None</code>,
|
|
2816
|
-
* which specifies not to join the input with the transformed data. If you want the batch
|
|
2817
|
-
* transform job to join the original input data with the transformed data, set
|
|
2818
|
-
* <code>JoinSource</code> to <code>Input</code>. You can specify
|
|
2819
|
-
* <code>OutputFilter</code> as an additional filter to select a portion of the joined
|
|
2820
|
-
* dataset and store it in the output file.</p>
|
|
2821
|
-
* <p>For JSON or JSONLines objects, such as a JSON array, SageMaker adds the transformed data to
|
|
2822
|
-
* the input JSON object in an attribute called <code>SageMakerOutput</code>. The joined
|
|
2823
|
-
* result for JSON must be a key-value pair object. If the input is not a key-value pair
|
|
2824
|
-
* object, SageMaker creates a new JSON file. In the new JSON file, and the input data is stored
|
|
2825
|
-
* under the <code>SageMakerInput</code> key and the results are stored in
|
|
2826
|
-
* <code>SageMakerOutput</code>.</p>
|
|
2827
|
-
* <p>For CSV data, SageMaker takes each row as a JSON array and joins the transformed data with
|
|
2828
|
-
* the input by appending each transformed row to the end of the input. The joined data has
|
|
2829
|
-
* the original input data followed by the transformed data and the output is a CSV
|
|
2830
|
-
* file.</p>
|
|
2831
|
-
* <p>For information on how joining in applied, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html#batch-transform-data-processing-workflow">Workflow for Associating Inferences with Input Records</a>.</p>
|
|
2225
|
+
* <p>Specifies the source of the data to join with the transformed data. The valid values are <code>None</code> and <code>Input</code>. The default value is <code>None</code>, which specifies not to join the input with the transformed data. If you want the batch transform job to join the original input data with the transformed data, set <code>JoinSource</code> to <code>Input</code>. You can specify <code>OutputFilter</code> as an additional filter to select a portion of the joined dataset and store it in the output file.</p> <p>For JSON or JSONLines objects, such as a JSON array, SageMaker adds the transformed data to the input JSON object in an attribute called <code>SageMakerOutput</code>. The joined result for JSON must be a key-value pair object. If the input is not a key-value pair object, SageMaker creates a new JSON file. In the new JSON file, and the input data is stored under the <code>SageMakerInput</code> key and the results are stored in <code>SageMakerOutput</code>.</p> <p>For CSV data, SageMaker takes each row as a JSON array and joins the transformed data with the input by appending each transformed row to the end of the input. The joined data has the original input data followed by the transformed data and the output is a CSV file.</p> <p>For information on how joining in applied, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html#batch-transform-data-processing-workflow">Workflow for Associating Inferences with Input Records</a>.</p>
|
|
2832
2226
|
* @public
|
|
2833
2227
|
*/
|
|
2834
2228
|
JoinSource?: JoinSource | undefined;
|
|
2835
2229
|
}
|
|
2836
2230
|
/**
|
|
2837
|
-
* <p>Configures the timeout and maximum number of retries for processing a transform job
|
|
2838
|
-
* invocation.</p>
|
|
2231
|
+
* <p>Configures the timeout and maximum number of retries for processing a transform job invocation.</p>
|
|
2839
2232
|
* @public
|
|
2840
2233
|
*/
|
|
2841
2234
|
export interface ModelClientConfig {
|
|
2842
2235
|
/**
|
|
2843
|
-
* <p>The timeout value in seconds for an invocation request. The default value is
|
|
2844
|
-
* 600.</p>
|
|
2236
|
+
* <p>The timeout value in seconds for an invocation request. The default value is 600.</p>
|
|
2845
2237
|
* @public
|
|
2846
2238
|
*/
|
|
2847
2239
|
InvocationsTimeoutInSeconds?: number | undefined;
|
|
2848
2240
|
/**
|
|
2849
|
-
* <p>The maximum number of retries when invocation requests are failing. The default value
|
|
2850
|
-
* is 3.</p>
|
|
2241
|
+
* <p>The maximum number of retries when invocation requests are failing. The default value is 3.</p>
|
|
2851
2242
|
* @public
|
|
2852
2243
|
*/
|
|
2853
2244
|
InvocationsMaxRetries?: number | undefined;
|
|
@@ -2857,81 +2248,42 @@ export interface ModelClientConfig {
|
|
|
2857
2248
|
*/
|
|
2858
2249
|
export interface CreateTransformJobRequest {
|
|
2859
2250
|
/**
|
|
2860
|
-
* <p>The name of the transform job. The name must be unique within an Amazon Web Services Region in an
|
|
2861
|
-
* Amazon Web Services account. </p>
|
|
2251
|
+
* <p>The name of the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account. </p>
|
|
2862
2252
|
* @public
|
|
2863
2253
|
*/
|
|
2864
2254
|
TransformJobName: string | undefined;
|
|
2865
2255
|
/**
|
|
2866
|
-
* <p>The name of the model that you want to use for the transform job.
|
|
2867
|
-
* <code>ModelName</code> must be the name of an existing Amazon SageMaker model within an Amazon Web Services
|
|
2868
|
-
* Region in an Amazon Web Services account.</p>
|
|
2256
|
+
* <p>The name of the model that you want to use for the transform job. <code>ModelName</code> must be the name of an existing Amazon SageMaker model within an Amazon Web Services Region in an Amazon Web Services account.</p>
|
|
2869
2257
|
* @public
|
|
2870
2258
|
*/
|
|
2871
2259
|
ModelName: string | undefined;
|
|
2872
2260
|
/**
|
|
2873
|
-
* <p>The maximum number of parallel requests that can be sent to each instance in a
|
|
2874
|
-
* transform job. If <code>MaxConcurrentTransforms</code> is set to <code>0</code> or left
|
|
2875
|
-
* unset, Amazon SageMaker checks the optional execution-parameters to determine the settings for your
|
|
2876
|
-
* chosen algorithm. If the execution-parameters endpoint is not enabled, the default value
|
|
2877
|
-
* is <code>1</code>. For more information on execution-parameters, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-batch-code.html#your-algorithms-batch-code-how-containe-serves-requests">How Containers Serve Requests</a>. For built-in algorithms, you don't need to
|
|
2878
|
-
* set a value for <code>MaxConcurrentTransforms</code>.</p>
|
|
2261
|
+
* <p>The maximum number of parallel requests that can be sent to each instance in a transform job. If <code>MaxConcurrentTransforms</code> is set to <code>0</code> or left unset, Amazon SageMaker checks the optional execution-parameters to determine the settings for your chosen algorithm. If the execution-parameters endpoint is not enabled, the default value is <code>1</code>. For more information on execution-parameters, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-batch-code.html#your-algorithms-batch-code-how-containe-serves-requests">How Containers Serve Requests</a>. For built-in algorithms, you don't need to set a value for <code>MaxConcurrentTransforms</code>.</p>
|
|
2879
2262
|
* @public
|
|
2880
2263
|
*/
|
|
2881
2264
|
MaxConcurrentTransforms?: number | undefined;
|
|
2882
2265
|
/**
|
|
2883
|
-
* <p>Configures the timeout and maximum number of retries for processing a transform job
|
|
2884
|
-
* invocation.</p>
|
|
2266
|
+
* <p>Configures the timeout and maximum number of retries for processing a transform job invocation.</p>
|
|
2885
2267
|
* @public
|
|
2886
2268
|
*/
|
|
2887
2269
|
ModelClientConfig?: ModelClientConfig | undefined;
|
|
2888
2270
|
/**
|
|
2889
|
-
* <p>The maximum allowed size of the payload, in MB. A <i>payload</i> is the
|
|
2890
|
-
* data portion of a record (without metadata). The value in <code>MaxPayloadInMB</code>
|
|
2891
|
-
* must be greater than, or equal to, the size of a single record. To estimate the size of
|
|
2892
|
-
* a record in MB, divide the size of your dataset by the number of records. To ensure that
|
|
2893
|
-
* the records fit within the maximum payload size, we recommend using a slightly larger
|
|
2894
|
-
* value. The default value is <code>6</code> MB.
|
|
2895
|
-
* </p>
|
|
2896
|
-
* <p>The value of <code>MaxPayloadInMB</code> cannot be greater than 100 MB. If you specify
|
|
2897
|
-
* the <code>MaxConcurrentTransforms</code> parameter, the value of
|
|
2898
|
-
* <code>(MaxConcurrentTransforms * MaxPayloadInMB)</code> also cannot exceed 100
|
|
2899
|
-
* MB.</p>
|
|
2900
|
-
* <p>For cases where the payload might be arbitrarily large and is transmitted using HTTP
|
|
2901
|
-
* chunked encoding, set the value to <code>0</code>.
|
|
2902
|
-
* This
|
|
2903
|
-
* feature works only in supported algorithms. Currently, Amazon SageMaker built-in
|
|
2904
|
-
* algorithms do not support HTTP chunked encoding.</p>
|
|
2271
|
+
* <p>The maximum allowed size of the payload, in MB. A <i>payload</i> is the data portion of a record (without metadata). The value in <code>MaxPayloadInMB</code> must be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. The default value is <code>6</code> MB. </p> <p>The value of <code>MaxPayloadInMB</code> cannot be greater than 100 MB. If you specify the <code>MaxConcurrentTransforms</code> parameter, the value of <code>(MaxConcurrentTransforms * MaxPayloadInMB)</code> also cannot exceed 100 MB.</p> <p>For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to <code>0</code>. This feature works only in supported algorithms. Currently, Amazon SageMaker built-in algorithms do not support HTTP chunked encoding.</p>
|
|
2905
2272
|
* @public
|
|
2906
2273
|
*/
|
|
2907
2274
|
MaxPayloadInMB?: number | undefined;
|
|
2908
2275
|
/**
|
|
2909
|
-
* <p>Specifies the number of records to include in a mini-batch for an HTTP inference
|
|
2910
|
-
* request. A <i>record</i>
|
|
2911
|
-
* <i></i> is a single unit of input data that
|
|
2912
|
-
* inference can be made on. For example, a single line in a CSV file is a record. </p>
|
|
2913
|
-
* <p>To enable the batch strategy, you must set the <code>SplitType</code> property to
|
|
2914
|
-
* <code>Line</code>, <code>RecordIO</code>, or <code>TFRecord</code>.</p>
|
|
2915
|
-
* <p>To use only one record when making an HTTP invocation request to a container, set
|
|
2916
|
-
* <code>BatchStrategy</code> to <code>SingleRecord</code> and <code>SplitType</code>
|
|
2917
|
-
* to <code>Line</code>.</p>
|
|
2918
|
-
* <p>To fit as many records in a mini-batch as can fit within the
|
|
2919
|
-
* <code>MaxPayloadInMB</code> limit, set <code>BatchStrategy</code> to
|
|
2920
|
-
* <code>MultiRecord</code> and <code>SplitType</code> to <code>Line</code>.</p>
|
|
2276
|
+
* <p>Specifies the number of records to include in a mini-batch for an HTTP inference request. A <i>record</i> <i/> is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record. </p> <p>To enable the batch strategy, you must set the <code>SplitType</code> property to <code>Line</code>, <code>RecordIO</code>, or <code>TFRecord</code>.</p> <p>To use only one record when making an HTTP invocation request to a container, set <code>BatchStrategy</code> to <code>SingleRecord</code> and <code>SplitType</code> to <code>Line</code>.</p> <p>To fit as many records in a mini-batch as can fit within the <code>MaxPayloadInMB</code> limit, set <code>BatchStrategy</code> to <code>MultiRecord</code> and <code>SplitType</code> to <code>Line</code>.</p>
|
|
2921
2277
|
* @public
|
|
2922
2278
|
*/
|
|
2923
2279
|
BatchStrategy?: BatchStrategy | undefined;
|
|
2924
2280
|
/**
|
|
2925
|
-
* <p>The environment variables to set in the Docker container. Don't include any
|
|
2926
|
-
* sensitive data in your environment variables. We support up to 16 key and
|
|
2927
|
-
* values entries in the map.</p>
|
|
2281
|
+
* <p>The environment variables to set in the Docker container. Don't include any sensitive data in your environment variables. We support up to 16 key and values entries in the map.</p>
|
|
2928
2282
|
* @public
|
|
2929
2283
|
*/
|
|
2930
2284
|
Environment?: Record<string, string> | undefined;
|
|
2931
2285
|
/**
|
|
2932
|
-
* <p>Describes the input source and
|
|
2933
|
-
* the
|
|
2934
|
-
* way the transform job consumes it.</p>
|
|
2286
|
+
* <p>Describes the input source and the way the transform job consumes it.</p>
|
|
2935
2287
|
* @public
|
|
2936
2288
|
*/
|
|
2937
2289
|
TransformInput: TransformInput | undefined;
|
|
@@ -2946,53 +2298,22 @@ export interface CreateTransformJobRequest {
|
|
|
2946
2298
|
*/
|
|
2947
2299
|
DataCaptureConfig?: BatchDataCaptureConfig | undefined;
|
|
2948
2300
|
/**
|
|
2949
|
-
* <p>Describes the resources, including
|
|
2950
|
-
* ML
|
|
2951
|
-
* instance types and ML instance count, to use for the transform
|
|
2952
|
-
* job.</p>
|
|
2301
|
+
* <p>Describes the resources, including ML instance types and ML instance count, to use for the transform job.</p>
|
|
2953
2302
|
* @public
|
|
2954
2303
|
*/
|
|
2955
2304
|
TransformResources: TransformResources | undefined;
|
|
2956
2305
|
/**
|
|
2957
|
-
* <p>The data structure used to specify the data to be used for inference in a batch
|
|
2958
|
-
* transform job and to associate the data that is relevant to the prediction results in
|
|
2959
|
-
* the output. The input filter provided allows you to exclude input data that is not
|
|
2960
|
-
* needed for inference in a batch transform job. The output filter provided allows you to
|
|
2961
|
-
* include input data relevant to interpreting the predictions in the output from the job.
|
|
2962
|
-
* For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html">Associate Prediction
|
|
2963
|
-
* Results with their Corresponding Input Records</a>.</p>
|
|
2306
|
+
* <p>The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output. The input filter provided allows you to exclude input data that is not needed for inference in a batch transform job. The output filter provided allows you to include input data relevant to interpreting the predictions in the output from the job. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html">Associate Prediction Results with their Corresponding Input Records</a>.</p>
|
|
2964
2307
|
* @public
|
|
2965
2308
|
*/
|
|
2966
2309
|
DataProcessing?: DataProcessing | undefined;
|
|
2967
2310
|
/**
|
|
2968
|
-
* <p>(Optional)
|
|
2969
|
-
* An
|
|
2970
|
-
* array of key-value pairs. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what">Using
|
|
2971
|
-
* Cost Allocation Tags</a> in the <i>Amazon Web Services Billing and Cost Management User
|
|
2972
|
-
* Guide</i>.</p>
|
|
2311
|
+
* <p>(Optional) An array of key-value pairs. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what">Using Cost Allocation Tags</a> in the <i>Amazon Web Services Billing and Cost Management User Guide</i>.</p>
|
|
2973
2312
|
* @public
|
|
2974
2313
|
*/
|
|
2975
2314
|
Tags?: Tag[] | undefined;
|
|
2976
2315
|
/**
|
|
2977
|
-
* <p>Associates a SageMaker job as a trial component with an experiment and trial. Specified when
|
|
2978
|
-
* you call the following APIs:</p>
|
|
2979
|
-
* <ul>
|
|
2980
|
-
* <li>
|
|
2981
|
-
* <p>
|
|
2982
|
-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html">CreateProcessingJob</a>
|
|
2983
|
-
* </p>
|
|
2984
|
-
* </li>
|
|
2985
|
-
* <li>
|
|
2986
|
-
* <p>
|
|
2987
|
-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html">CreateTrainingJob</a>
|
|
2988
|
-
* </p>
|
|
2989
|
-
* </li>
|
|
2990
|
-
* <li>
|
|
2991
|
-
* <p>
|
|
2992
|
-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html">CreateTransformJob</a>
|
|
2993
|
-
* </p>
|
|
2994
|
-
* </li>
|
|
2995
|
-
* </ul>
|
|
2316
|
+
* <p>Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html">CreateProcessingJob</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html">CreateTrainingJob</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html">CreateTransformJob</a> </p> </li> </ul>
|
|
2996
2317
|
* @public
|
|
2997
2318
|
*/
|
|
2998
2319
|
ExperimentConfig?: ExperimentConfig | undefined;
|
|
@@ -3012,14 +2333,12 @@ export interface CreateTransformJobResponse {
|
|
|
3012
2333
|
*/
|
|
3013
2334
|
export interface CreateTrialRequest {
|
|
3014
2335
|
/**
|
|
3015
|
-
* <p>The name of the trial. The name must be unique in your Amazon Web Services account and is not
|
|
3016
|
-
* case-sensitive.</p>
|
|
2336
|
+
* <p>The name of the trial. The name must be unique in your Amazon Web Services account and is not case-sensitive.</p>
|
|
3017
2337
|
* @public
|
|
3018
2338
|
*/
|
|
3019
2339
|
TrialName: string | undefined;
|
|
3020
2340
|
/**
|
|
3021
|
-
* <p>The name of the trial as displayed. The name doesn't need to be unique. If
|
|
3022
|
-
* <code>DisplayName</code> isn't specified, <code>TrialName</code> is displayed.</p>
|
|
2341
|
+
* <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>
|
|
3023
2342
|
* @public
|
|
3024
2343
|
*/
|
|
3025
2344
|
DisplayName?: string | undefined;
|
|
@@ -3034,8 +2353,7 @@ export interface CreateTrialRequest {
|
|
|
3034
2353
|
*/
|
|
3035
2354
|
MetadataProperties?: MetadataProperties | undefined;
|
|
3036
2355
|
/**
|
|
3037
|
-
* <p>A list of tags to associate with the trial. You can use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a> API to
|
|
3038
|
-
* search on the tags.</p>
|
|
2356
|
+
* <p>A list of tags to associate with the trial. You can use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a> API to search on the tags.</p>
|
|
3039
2357
|
* @public
|
|
3040
2358
|
*/
|
|
3041
2359
|
Tags?: Tag[] | undefined;
|
|
@@ -3051,20 +2369,12 @@ export interface CreateTrialResponse {
|
|
|
3051
2369
|
TrialArn?: string | undefined;
|
|
3052
2370
|
}
|
|
3053
2371
|
/**
|
|
3054
|
-
* <p>Represents an input or output artifact of a trial component. You specify
|
|
3055
|
-
* <code>TrialComponentArtifact</code> as part of the <code>InputArtifacts</code> and
|
|
3056
|
-
* <code>OutputArtifacts</code> parameters in the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrialComponent.html">CreateTrialComponent</a>
|
|
3057
|
-
* request.</p>
|
|
3058
|
-
* <p>Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and
|
|
3059
|
-
* instance types. Examples of output artifacts are metrics, snapshots, logs, and images.</p>
|
|
2372
|
+
* <p>Represents an input or output artifact of a trial component. You specify <code>TrialComponentArtifact</code> as part of the <code>InputArtifacts</code> and <code>OutputArtifacts</code> parameters in the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrialComponent.html">CreateTrialComponent</a> request.</p> <p>Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types. Examples of output artifacts are metrics, snapshots, logs, and images.</p>
|
|
3060
2373
|
* @public
|
|
3061
2374
|
*/
|
|
3062
2375
|
export interface TrialComponentArtifact {
|
|
3063
2376
|
/**
|
|
3064
|
-
* <p>The media type of the artifact, which indicates the type of data in the artifact file. The
|
|
3065
|
-
* media type consists of a <i>type</i> and a <i>subtype</i>
|
|
3066
|
-
* concatenated with a slash (/) character, for example, text/csv, image/jpeg, and s3/uri. The
|
|
3067
|
-
* type specifies the category of the media. The subtype specifies the kind of data.</p>
|
|
2377
|
+
* <p>The media type of the artifact, which indicates the type of data in the artifact file. The media type consists of a <i>type</i> and a <i>subtype</i> concatenated with a slash (/) character, for example, text/csv, image/jpeg, and s3/uri. The type specifies the category of the media. The subtype specifies the kind of data.</p>
|
|
3068
2378
|
* @public
|
|
3069
2379
|
*/
|
|
3070
2380
|
MediaType?: string | undefined;
|
|
@@ -3075,9 +2385,7 @@ export interface TrialComponentArtifact {
|
|
|
3075
2385
|
Value: string | undefined;
|
|
3076
2386
|
}
|
|
3077
2387
|
/**
|
|
3078
|
-
* <p>The value of a hyperparameter. Only one of <code>NumberValue</code> or
|
|
3079
|
-
* <code>StringValue</code> can be specified.</p>
|
|
3080
|
-
* <p>This object is specified in the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrialComponent.html">CreateTrialComponent</a> request.</p>
|
|
2388
|
+
* <p>The value of a hyperparameter. Only one of <code>NumberValue</code> or <code>StringValue</code> can be specified.</p> <p>This object is specified in the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrialComponent.html">CreateTrialComponent</a> request.</p>
|
|
3081
2389
|
* @public
|
|
3082
2390
|
*/
|
|
3083
2391
|
export type TrialComponentParameterValue = TrialComponentParameterValue.NumberValueMember | TrialComponentParameterValue.StringValueMember | TrialComponentParameterValue.$UnknownMember;
|
|
@@ -3086,8 +2394,7 @@ export type TrialComponentParameterValue = TrialComponentParameterValue.NumberVa
|
|
|
3086
2394
|
*/
|
|
3087
2395
|
export declare namespace TrialComponentParameterValue {
|
|
3088
2396
|
/**
|
|
3089
|
-
* <p>The string value of a categorical hyperparameter. If you specify a value for this
|
|
3090
|
-
* parameter, you can't specify the <code>NumberValue</code> parameter.</p>
|
|
2397
|
+
* <p>The string value of a categorical hyperparameter. If you specify a value for this parameter, you can't specify the <code>NumberValue</code> parameter.</p>
|
|
3091
2398
|
* @public
|
|
3092
2399
|
*/
|
|
3093
2400
|
interface StringValueMember {
|
|
@@ -3096,8 +2403,7 @@ export declare namespace TrialComponentParameterValue {
|
|
|
3096
2403
|
$unknown?: never;
|
|
3097
2404
|
}
|
|
3098
2405
|
/**
|
|
3099
|
-
* <p>The numeric value of a numeric hyperparameter. If you specify a value for this parameter,
|
|
3100
|
-
* you can't specify the <code>StringValue</code> parameter.</p>
|
|
2406
|
+
* <p>The numeric value of a numeric hyperparameter. If you specify a value for this parameter, you can't specify the <code>StringValue</code> parameter.</p>
|
|
3101
2407
|
* @public
|
|
3102
2408
|
*/
|
|
3103
2409
|
interface NumberValueMember {
|
|
@@ -3156,31 +2462,17 @@ export interface TrialComponentStatus {
|
|
|
3156
2462
|
*/
|
|
3157
2463
|
export interface CreateTrialComponentRequest {
|
|
3158
2464
|
/**
|
|
3159
|
-
* <p>The name of the component. The name must be unique in your Amazon Web Services account and is not
|
|
3160
|
-
* case-sensitive.</p>
|
|
2465
|
+
* <p>The name of the component. The name must be unique in your Amazon Web Services account and is not case-sensitive.</p>
|
|
3161
2466
|
* @public
|
|
3162
2467
|
*/
|
|
3163
2468
|
TrialComponentName: string | undefined;
|
|
3164
2469
|
/**
|
|
3165
|
-
* <p>The name of the component as displayed. The name doesn't need to be unique. If
|
|
3166
|
-
* <code>DisplayName</code> isn't specified, <code>TrialComponentName</code> is
|
|
3167
|
-
* displayed.</p>
|
|
2470
|
+
* <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>
|
|
3168
2471
|
* @public
|
|
3169
2472
|
*/
|
|
3170
2473
|
DisplayName?: string | undefined;
|
|
3171
2474
|
/**
|
|
3172
|
-
* <p>The status of the component. States include:</p>
|
|
3173
|
-
* <ul>
|
|
3174
|
-
* <li>
|
|
3175
|
-
* <p>InProgress</p>
|
|
3176
|
-
* </li>
|
|
3177
|
-
* <li>
|
|
3178
|
-
* <p>Completed</p>
|
|
3179
|
-
* </li>
|
|
3180
|
-
* <li>
|
|
3181
|
-
* <p>Failed</p>
|
|
3182
|
-
* </li>
|
|
3183
|
-
* </ul>
|
|
2475
|
+
* <p>The status of the component. States include:</p> <ul> <li> <p>InProgress</p> </li> <li> <p>Completed</p> </li> <li> <p>Failed</p> </li> </ul>
|
|
3184
2476
|
* @public
|
|
3185
2477
|
*/
|
|
3186
2478
|
Status?: TrialComponentStatus | undefined;
|
|
@@ -3200,14 +2492,12 @@ export interface CreateTrialComponentRequest {
|
|
|
3200
2492
|
*/
|
|
3201
2493
|
Parameters?: Record<string, TrialComponentParameterValue> | undefined;
|
|
3202
2494
|
/**
|
|
3203
|
-
* <p>The input artifacts for the component. Examples of input artifacts are datasets,
|
|
3204
|
-
* algorithms, hyperparameters, source code, and instance types.</p>
|
|
2495
|
+
* <p>The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.</p>
|
|
3205
2496
|
* @public
|
|
3206
2497
|
*/
|
|
3207
2498
|
InputArtifacts?: Record<string, TrialComponentArtifact> | undefined;
|
|
3208
2499
|
/**
|
|
3209
|
-
* <p>The output artifacts for the component. Examples of output artifacts are metrics,
|
|
3210
|
-
* snapshots, logs, and images.</p>
|
|
2500
|
+
* <p>The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.</p>
|
|
3211
2501
|
* @public
|
|
3212
2502
|
*/
|
|
3213
2503
|
OutputArtifacts?: Record<string, TrialComponentArtifact> | undefined;
|
|
@@ -3217,8 +2507,7 @@ export interface CreateTrialComponentRequest {
|
|
|
3217
2507
|
*/
|
|
3218
2508
|
MetadataProperties?: MetadataProperties | undefined;
|
|
3219
2509
|
/**
|
|
3220
|
-
* <p>A list of tags to associate with the component. You can use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a> API
|
|
3221
|
-
* to search on the tags.</p>
|
|
2510
|
+
* <p>A list of tags to associate with the component. You can use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a> API to search on the tags.</p>
|
|
3222
2511
|
* @public
|
|
3223
2512
|
*/
|
|
3224
2513
|
Tags?: Tag[] | undefined;
|
|
@@ -3248,25 +2537,17 @@ export interface CreateUserProfileRequest {
|
|
|
3248
2537
|
*/
|
|
3249
2538
|
UserProfileName: string | undefined;
|
|
3250
2539
|
/**
|
|
3251
|
-
* <p>A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only
|
|
3252
|
-
* supported value is "UserName". If the Domain's AuthMode is IAM Identity Center, this field is
|
|
3253
|
-
* required. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.
|
|
3254
|
-
* </p>
|
|
2540
|
+
* <p>A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName". If the Domain's AuthMode is IAM Identity Center, this field is required. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified. </p>
|
|
3255
2541
|
* @public
|
|
3256
2542
|
*/
|
|
3257
2543
|
SingleSignOnUserIdentifier?: string | undefined;
|
|
3258
2544
|
/**
|
|
3259
|
-
* <p>The username of the associated Amazon Web Services Single Sign-On User for this
|
|
3260
|
-
* UserProfile. If the Domain's AuthMode is IAM Identity Center, this field is required, and must
|
|
3261
|
-
* match a valid username of a user in your directory. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified. </p>
|
|
2545
|
+
* <p>The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain's AuthMode is IAM Identity Center, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified. </p>
|
|
3262
2546
|
* @public
|
|
3263
2547
|
*/
|
|
3264
2548
|
SingleSignOnUserValue?: string | undefined;
|
|
3265
2549
|
/**
|
|
3266
|
-
* <p>Each tag consists of a key and an optional value. Tag keys must be unique per
|
|
3267
|
-
* resource.</p>
|
|
3268
|
-
* <p>Tags that you specify for the User Profile are also added to all Apps that the User
|
|
3269
|
-
* Profile launches.</p>
|
|
2550
|
+
* <p>Each tag consists of a key and an optional value. Tag keys must be unique per resource.</p> <p>Tags that you specify for the User Profile are also added to all Apps that the User Profile launches.</p>
|
|
3270
2551
|
* @public
|
|
3271
2552
|
*/
|
|
3272
2553
|
Tags?: Tag[] | undefined;
|
|
@@ -3343,19 +2624,12 @@ export interface OidcConfig {
|
|
|
3343
2624
|
AuthenticationRequestExtraParams?: Record<string, string> | undefined;
|
|
3344
2625
|
}
|
|
3345
2626
|
/**
|
|
3346
|
-
* <p>A list of IP address ranges (<a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">CIDRs</a>). Used to create an allow
|
|
3347
|
-
* list of IP addresses for a private workforce. Workers will only be able to log in to their worker portal from an
|
|
3348
|
-
* IP address within this range. By default, a workforce isn't restricted to specific IP addresses.</p>
|
|
2627
|
+
* <p>A list of IP address ranges (<a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">CIDRs</a>). Used to create an allow list of IP addresses for a private workforce. Workers will only be able to log in to their worker portal from an IP address within this range. By default, a workforce isn't restricted to specific IP addresses.</p>
|
|
3349
2628
|
* @public
|
|
3350
2629
|
*/
|
|
3351
2630
|
export interface SourceIpConfig {
|
|
3352
2631
|
/**
|
|
3353
|
-
* <p>A list of one to ten <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">Classless Inter-Domain Routing</a> (CIDR) values.</p>
|
|
3354
|
-
* <p>Maximum: Ten CIDR values</p>
|
|
3355
|
-
* <note>
|
|
3356
|
-
* <p>The following Length Constraints apply to individual CIDR values in
|
|
3357
|
-
* the CIDR value list.</p>
|
|
3358
|
-
* </note>
|
|
2632
|
+
* <p>A list of one to ten <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">Classless Inter-Domain Routing</a> (CIDR) values.</p> <p>Maximum: Ten CIDR values</p> <note> <p>The following Length Constraints apply to individual CIDR values in the CIDR value list.</p> </note>
|
|
3359
2633
|
* @public
|
|
3360
2634
|
*/
|
|
3361
2635
|
Cidrs: string[] | undefined;
|
|
@@ -3386,26 +2660,17 @@ export interface WorkforceVpcConfigRequest {
|
|
|
3386
2660
|
*/
|
|
3387
2661
|
export interface CreateWorkforceRequest {
|
|
3388
2662
|
/**
|
|
3389
|
-
* <p>Use this parameter to configure an Amazon Cognito private workforce.
|
|
3390
|
-
* A single Cognito workforce is created using and corresponds to a single
|
|
3391
|
-
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html">
|
|
3392
|
-
* Amazon Cognito user pool</a>.</p>
|
|
3393
|
-
* <p>Do not use <code>OidcConfig</code> if you specify values for
|
|
3394
|
-
* <code>CognitoConfig</code>.</p>
|
|
2663
|
+
* <p>Use this parameter to configure an Amazon Cognito private workforce. A single Cognito workforce is created using and corresponds to a single <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html"> Amazon Cognito user pool</a>.</p> <p>Do not use <code>OidcConfig</code> if you specify values for <code>CognitoConfig</code>.</p>
|
|
3395
2664
|
* @public
|
|
3396
2665
|
*/
|
|
3397
2666
|
CognitoConfig?: CognitoConfig | undefined;
|
|
3398
2667
|
/**
|
|
3399
|
-
* <p>Use this parameter to configure a private workforce using your own OIDC Identity Provider.</p>
|
|
3400
|
-
* <p>Do not use <code>CognitoConfig</code> if you specify values for
|
|
3401
|
-
* <code>OidcConfig</code>.</p>
|
|
2668
|
+
* <p>Use this parameter to configure a private workforce using your own OIDC Identity Provider.</p> <p>Do not use <code>CognitoConfig</code> if you specify values for <code>OidcConfig</code>.</p>
|
|
3402
2669
|
* @public
|
|
3403
2670
|
*/
|
|
3404
2671
|
OidcConfig?: OidcConfig | undefined;
|
|
3405
2672
|
/**
|
|
3406
|
-
* <p>A list of IP address ranges (<a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">CIDRs</a>). Used to create an allow
|
|
3407
|
-
* list of IP addresses for a private workforce. Workers will only be able to log in to their worker portal from an
|
|
3408
|
-
* IP address within this range. By default, a workforce isn't restricted to specific IP addresses.</p>
|
|
2673
|
+
* <p>A list of IP address ranges (<a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">CIDRs</a>). Used to create an allow list of IP addresses for a private workforce. Workers will only be able to log in to their worker portal from an IP address within this range. By default, a workforce isn't restricted to specific IP addresses.</p>
|
|
3409
2674
|
* @public
|
|
3410
2675
|
*/
|
|
3411
2676
|
SourceIpConfig?: SourceIpConfig | undefined;
|
|
@@ -3415,9 +2680,7 @@ export interface CreateWorkforceRequest {
|
|
|
3415
2680
|
*/
|
|
3416
2681
|
WorkforceName: string | undefined;
|
|
3417
2682
|
/**
|
|
3418
|
-
* <p>An array of key-value pairs that contain metadata to help you categorize and
|
|
3419
|
-
* organize our workforce. Each tag consists of a key and a value,
|
|
3420
|
-
* both of which you define.</p>
|
|
2683
|
+
* <p>An array of key-value pairs that contain metadata to help you categorize and organize our workforce. Each tag consists of a key and a value, both of which you define.</p>
|
|
3421
2684
|
* @public
|
|
3422
2685
|
*/
|
|
3423
2686
|
Tags?: Tag[] | undefined;
|
|
@@ -3438,18 +2701,12 @@ export interface CreateWorkforceResponse {
|
|
|
3438
2701
|
WorkforceArn: string | undefined;
|
|
3439
2702
|
}
|
|
3440
2703
|
/**
|
|
3441
|
-
* <p>A list of user groups that exist in your OIDC Identity Provider (IdP).
|
|
3442
|
-
* One to ten groups can be used to create a single private work team.
|
|
3443
|
-
* When you add a user group to the list of <code>Groups</code>, you can add that user group to one or more
|
|
3444
|
-
* private work teams. If you add a user group to a private work team, all workers in that user group
|
|
3445
|
-
* are added to the work team.</p>
|
|
2704
|
+
* <p>A list of user groups that exist in your OIDC Identity Provider (IdP). One to ten groups can be used to create a single private work team. When you add a user group to the list of <code>Groups</code>, you can add that user group to one or more private work teams. If you add a user group to a private work team, all workers in that user group are added to the work team.</p>
|
|
3446
2705
|
* @public
|
|
3447
2706
|
*/
|
|
3448
2707
|
export interface OidcMemberDefinition {
|
|
3449
2708
|
/**
|
|
3450
|
-
* <p>A list of comma seperated strings that identifies
|
|
3451
|
-
* user groups in your OIDC IdP. Each user group is
|
|
3452
|
-
* made up of a group of private workers.</p>
|
|
2709
|
+
* <p>A list of comma seperated strings that identifies user groups in your OIDC IdP. Each user group is made up of a group of private workers.</p>
|
|
3453
2710
|
* @public
|
|
3454
2711
|
*/
|
|
3455
2712
|
Groups?: string[] | undefined;
|
|
@@ -3465,18 +2722,13 @@ export interface MemberDefinition {
|
|
|
3465
2722
|
*/
|
|
3466
2723
|
CognitoMemberDefinition?: CognitoMemberDefinition | undefined;
|
|
3467
2724
|
/**
|
|
3468
|
-
* <p>A list user groups that exist in your OIDC Identity Provider (IdP).
|
|
3469
|
-
* One to ten groups can be used to create a single private work team.
|
|
3470
|
-
* When you add a user group to the list of <code>Groups</code>, you can add that user group to one or more
|
|
3471
|
-
* private work teams. If you add a user group to a private work team, all workers in that user group
|
|
3472
|
-
* are added to the work team.</p>
|
|
2725
|
+
* <p>A list user groups that exist in your OIDC Identity Provider (IdP). One to ten groups can be used to create a single private work team. When you add a user group to the list of <code>Groups</code>, you can add that user group to one or more private work teams. If you add a user group to a private work team, all workers in that user group are added to the work team.</p>
|
|
3473
2726
|
* @public
|
|
3474
2727
|
*/
|
|
3475
2728
|
OidcMemberDefinition?: OidcMemberDefinition | undefined;
|
|
3476
2729
|
}
|
|
3477
2730
|
/**
|
|
3478
|
-
* <p>Configures Amazon SNS notifications of available or expiring work items for work
|
|
3479
|
-
* teams.</p>
|
|
2731
|
+
* <p>Configures Amazon SNS notifications of available or expiring work items for work teams.</p>
|
|
3480
2732
|
* @public
|
|
3481
2733
|
*/
|
|
3482
2734
|
export interface NotificationConfiguration {
|
|
@@ -3515,8 +2767,7 @@ export interface IamPolicyConstraints {
|
|
|
3515
2767
|
VpcSourceIp?: EnabledOrDisabled | undefined;
|
|
3516
2768
|
}
|
|
3517
2769
|
/**
|
|
3518
|
-
* <p>This object defines the access restrictions to Amazon S3 resources that are included in custom worker task templates using the Liquid filter, <code>grant_read_access</code>.</p>
|
|
3519
|
-
* <p>To learn more about how custom templates are created, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-custom-templates.html">Create custom worker task templates</a>.</p>
|
|
2770
|
+
* <p>This object defines the access restrictions to Amazon S3 resources that are included in custom worker task templates using the Liquid filter, <code>grant_read_access</code>.</p> <p>To learn more about how custom templates are created, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-custom-templates.html">Create custom worker task templates</a>.</p>
|
|
3520
2771
|
* @public
|
|
3521
2772
|
*/
|
|
3522
2773
|
export interface S3Presign {
|
|
@@ -3552,23 +2803,7 @@ export interface CreateWorkteamRequest {
|
|
|
3552
2803
|
*/
|
|
3553
2804
|
WorkforceName?: string | undefined;
|
|
3554
2805
|
/**
|
|
3555
|
-
* <p>A list of <code>MemberDefinition</code> objects that contains objects that identify
|
|
3556
|
-
* the workers that make up the work team. </p>
|
|
3557
|
-
* <p>Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For
|
|
3558
|
-
* private workforces created using Amazon Cognito use <code>CognitoMemberDefinition</code>. For
|
|
3559
|
-
* workforces created using your own OIDC identity provider (IdP) use
|
|
3560
|
-
* <code>OidcMemberDefinition</code>. Do not provide input for both of these parameters
|
|
3561
|
-
* in a single request.</p>
|
|
3562
|
-
* <p>For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito
|
|
3563
|
-
* <i>user groups</i> within the user pool used to create a workforce. All of the
|
|
3564
|
-
* <code>CognitoMemberDefinition</code> objects that make up the member definition must
|
|
3565
|
-
* have the same <code>ClientId</code> and <code>UserPool</code> values. To add a Amazon
|
|
3566
|
-
* Cognito user group to an existing worker pool, see <a href="">Adding groups to a User
|
|
3567
|
-
* 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
|
|
3568
|
-
* Pools</a>.</p>
|
|
3569
|
-
* <p>For workforces created using your own OIDC IdP, specify the user groups that you want to
|
|
3570
|
-
* include in your private work team in <code>OidcMemberDefinition</code> by listing those groups
|
|
3571
|
-
* in <code>Groups</code>.</p>
|
|
2806
|
+
* <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>. Do 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>.</p>
|
|
3572
2807
|
* @public
|
|
3573
2808
|
*/
|
|
3574
2809
|
MemberDefinitions: MemberDefinition[] | undefined;
|
|
@@ -3588,11 +2823,7 @@ export interface CreateWorkteamRequest {
|
|
|
3588
2823
|
*/
|
|
3589
2824
|
WorkerAccessConfiguration?: WorkerAccessConfiguration | undefined;
|
|
3590
2825
|
/**
|
|
3591
|
-
* <p>An array of key-value pairs.</p>
|
|
3592
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html">Resource
|
|
3593
|
-
* Tag</a> and <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what">Using
|
|
3594
|
-
* Cost Allocation Tags</a> in the <i> Amazon Web Services Billing and Cost Management User
|
|
3595
|
-
* Guide</i>.</p>
|
|
2826
|
+
* <p>An array of key-value pairs.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html">Resource Tag</a> and <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what">Using Cost Allocation Tags</a> in the <i> Amazon Web Services Billing and Cost Management User Guide</i>.</p>
|
|
3596
2827
|
* @public
|
|
3597
2828
|
*/
|
|
3598
2829
|
Tags?: Tag[] | undefined;
|
|
@@ -3602,8 +2833,7 @@ export interface CreateWorkteamRequest {
|
|
|
3602
2833
|
*/
|
|
3603
2834
|
export interface CreateWorkteamResponse {
|
|
3604
2835
|
/**
|
|
3605
|
-
* <p>The Amazon Resource Name (ARN) of the work team. You can use this ARN to identify the
|
|
3606
|
-
* work team.</p>
|
|
2836
|
+
* <p>The Amazon Resource Name (ARN) of the work team. You can use this ARN to identify the work team.</p>
|
|
3607
2837
|
* @public
|
|
3608
2838
|
*/
|
|
3609
2839
|
WorkteamArn?: string | undefined;
|
|
@@ -3774,14 +3004,12 @@ export interface DeleteAppRequest {
|
|
|
3774
3004
|
*/
|
|
3775
3005
|
DomainId: string | undefined;
|
|
3776
3006
|
/**
|
|
3777
|
-
* <p>The user profile name. If this value is not set, then <code>SpaceName</code> must be
|
|
3778
|
-
* set.</p>
|
|
3007
|
+
* <p>The user profile name. If this value is not set, then <code>SpaceName</code> must be set.</p>
|
|
3779
3008
|
* @public
|
|
3780
3009
|
*/
|
|
3781
3010
|
UserProfileName?: string | undefined;
|
|
3782
3011
|
/**
|
|
3783
|
-
* <p>The name of the space. If this value is not set, then <code>UserProfileName</code> must be
|
|
3784
|
-
* set.</p>
|
|
3012
|
+
* <p>The name of the space. If this value is not set, then <code>UserProfileName</code> must be set.</p>
|
|
3785
3013
|
* @public
|
|
3786
3014
|
*/
|
|
3787
3015
|
SpaceName?: string | undefined;
|
|
@@ -3979,10 +3207,7 @@ export type RetentionType = (typeof RetentionType)[keyof typeof RetentionType];
|
|
|
3979
3207
|
*/
|
|
3980
3208
|
export interface RetentionPolicy {
|
|
3981
3209
|
/**
|
|
3982
|
-
* <p>The default is <code>Retain</code>, which specifies to keep the data stored on the
|
|
3983
|
-
* Amazon EFS volume.</p>
|
|
3984
|
-
* <p>Specify <code>Delete</code> to delete the data stored on the Amazon EFS
|
|
3985
|
-
* volume.</p>
|
|
3210
|
+
* <p>The default is <code>Retain</code>, which specifies to keep the data stored on the Amazon EFS volume.</p> <p>Specify <code>Delete</code> to delete the data stored on the Amazon EFS volume.</p>
|
|
3986
3211
|
* @public
|
|
3987
3212
|
*/
|
|
3988
3213
|
HomeEfsFileSystem?: RetentionType | undefined;
|
|
@@ -3997,9 +3222,7 @@ export interface DeleteDomainRequest {
|
|
|
3997
3222
|
*/
|
|
3998
3223
|
DomainId: string | undefined;
|
|
3999
3224
|
/**
|
|
4000
|
-
* <p>The retention policy for this domain, which specifies whether resources will be retained
|
|
4001
|
-
* after the Domain is deleted. By default, all resources are retained (not automatically
|
|
4002
|
-
* deleted). </p>
|
|
3225
|
+
* <p>The retention policy for this domain, which specifies whether resources will be retained after the Domain is deleted. By default, all resources are retained (not automatically deleted). </p>
|
|
4003
3226
|
* @public
|
|
4004
3227
|
*/
|
|
4005
3228
|
RetentionPolicy?: RetentionPolicy | undefined;
|
|
@@ -4074,8 +3297,7 @@ export interface DeleteExperimentResponse {
|
|
|
4074
3297
|
*/
|
|
4075
3298
|
export interface DeleteFeatureGroupRequest {
|
|
4076
3299
|
/**
|
|
4077
|
-
* <p>The name of the <code>FeatureGroup</code> you want to delete. The name must be unique
|
|
4078
|
-
* within an Amazon Web Services Region in an Amazon Web Services account. </p>
|
|
3300
|
+
* <p>The name of the <code>FeatureGroup</code> you want to delete. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account. </p>
|
|
4079
3301
|
* @public
|
|
4080
3302
|
*/
|
|
4081
3303
|
FeatureGroupName: string | undefined;
|
|
@@ -4273,8 +3495,7 @@ export interface DeleteMlflowTrackingServerRequest {
|
|
|
4273
3495
|
*/
|
|
4274
3496
|
export interface DeleteMlflowTrackingServerResponse {
|
|
4275
3497
|
/**
|
|
4276
|
-
* <p>A <code>TrackingServerArn</code> object, the ARN of the tracking server that is deleted if
|
|
4277
|
-
* successfully found.</p>
|
|
3498
|
+
* <p>A <code>TrackingServerArn</code> object, the ARN of the tracking server that is deleted if successfully found.</p>
|
|
4278
3499
|
* @public
|
|
4279
3500
|
*/
|
|
4280
3501
|
TrackingServerArn?: string | undefined;
|
|
@@ -4324,9 +3545,7 @@ export interface DeleteModelExplainabilityJobDefinitionRequest {
|
|
|
4324
3545
|
*/
|
|
4325
3546
|
export interface DeleteModelPackageInput {
|
|
4326
3547
|
/**
|
|
4327
|
-
* <p>The name or Amazon Resource Name (ARN) of the model package to delete.</p>
|
|
4328
|
-
* <p>When you specify a name, the name must have 1 to 63 characters. Valid characters are
|
|
4329
|
-
* a-z, A-Z, 0-9, and - (hyphen).</p>
|
|
3548
|
+
* <p>The name or Amazon Resource Name (ARN) of the model package to delete.</p> <p>When you specify a name, the name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).</p>
|
|
4330
3549
|
* @public
|
|
4331
3550
|
*/
|
|
4332
3551
|
ModelPackageName: string | undefined;
|
|
@@ -4436,8 +3655,7 @@ export interface DeletePipelineRequest {
|
|
|
4436
3655
|
*/
|
|
4437
3656
|
PipelineName: string | undefined;
|
|
4438
3657
|
/**
|
|
4439
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
4440
|
-
* operation. An idempotent operation completes no more than one time.</p>
|
|
3658
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.</p>
|
|
4441
3659
|
* @public
|
|
4442
3660
|
*/
|
|
4443
3661
|
ClientRequestToken?: string | undefined;
|
|
@@ -4492,8 +3710,7 @@ export interface DeleteStudioLifecycleConfigRequest {
|
|
|
4492
3710
|
*/
|
|
4493
3711
|
export interface DeleteTagsInput {
|
|
4494
3712
|
/**
|
|
4495
|
-
* <p>The Amazon Resource Name (ARN) of the resource whose tags you want to
|
|
4496
|
-
* delete.</p>
|
|
3713
|
+
* <p>The Amazon Resource Name (ARN) of the resource whose tags you want to delete.</p>
|
|
4497
3714
|
* @public
|
|
4498
3715
|
*/
|
|
4499
3716
|
ResourceArn: string | undefined;
|
|
@@ -4593,19 +3810,13 @@ export interface DeleteWorkteamRequest {
|
|
|
4593
3810
|
*/
|
|
4594
3811
|
export interface DeleteWorkteamResponse {
|
|
4595
3812
|
/**
|
|
4596
|
-
* <p>Returns <code>true</code> if the work team was successfully deleted; otherwise,
|
|
4597
|
-
* returns <code>false</code>.</p>
|
|
3813
|
+
* <p>Returns <code>true</code> if the work team was successfully deleted; otherwise, returns <code>false</code>.</p>
|
|
4598
3814
|
* @public
|
|
4599
3815
|
*/
|
|
4600
3816
|
Success: boolean | undefined;
|
|
4601
3817
|
}
|
|
4602
3818
|
/**
|
|
4603
|
-
* <p>Gets the Amazon EC2 Container Registry path of the docker image of the model that is hosted in this <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariant.html">ProductionVariant</a>.</p>
|
|
4604
|
-
* <p>If you used the <code>registry/repository[:tag]</code> form to specify the image path
|
|
4605
|
-
* of the primary container when you created the model hosted in this
|
|
4606
|
-
* <code>ProductionVariant</code>, the path resolves to a path of the form
|
|
4607
|
-
* <code>registry/repository[@digest]</code>. A digest is a hash value that identifies
|
|
4608
|
-
* a specific version of an image. For information about Amazon ECR paths, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/docker-pull-ecr-image.html">Pulling an Image</a> in the <i>Amazon ECR User Guide</i>.</p>
|
|
3819
|
+
* <p>Gets the Amazon EC2 Container Registry path of the docker image of the model that is hosted in this <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariant.html">ProductionVariant</a>.</p> <p>If you used the <code>registry/repository[:tag]</code> form to specify the image path of the primary container when you created the model hosted in this <code>ProductionVariant</code>, the path resolves to a path of the form <code>registry/repository[@digest]</code>. A digest is a hash value that identifies a specific version of an image. For information about Amazon ECR paths, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/docker-pull-ecr-image.html">Pulling an Image</a> in the <i>Amazon ECR User Guide</i>.</p>
|
|
4609
3820
|
* @public
|
|
4610
3821
|
*/
|
|
4611
3822
|
export interface DeployedImage {
|
|
@@ -4615,15 +3826,12 @@ export interface DeployedImage {
|
|
|
4615
3826
|
*/
|
|
4616
3827
|
SpecifiedImage?: string | undefined;
|
|
4617
3828
|
/**
|
|
4618
|
-
* <p>The specific digest path of the image hosted in this
|
|
4619
|
-
* <code>ProductionVariant</code>.</p>
|
|
3829
|
+
* <p>The specific digest path of the image hosted in this <code>ProductionVariant</code>.</p>
|
|
4620
3830
|
* @public
|
|
4621
3831
|
*/
|
|
4622
3832
|
ResolvedImage?: string | undefined;
|
|
4623
3833
|
/**
|
|
4624
|
-
* <p>The date and time when the image path for the model resolved to the
|
|
4625
|
-
* <code>ResolvedImage</code>
|
|
4626
|
-
* </p>
|
|
3834
|
+
* <p>The date and time when the image path for the model resolved to the <code>ResolvedImage</code> </p>
|
|
4627
3835
|
* @public
|
|
4628
3836
|
*/
|
|
4629
3837
|
ResolutionTime?: Date | undefined;
|
|
@@ -4664,16 +3872,12 @@ export declare const RecommendationStatus: {
|
|
|
4664
3872
|
*/
|
|
4665
3873
|
export type RecommendationStatus = (typeof RecommendationStatus)[keyof typeof RecommendationStatus];
|
|
4666
3874
|
/**
|
|
4667
|
-
* <p>A set of recommended deployment configurations for the model. To get more advanced recommendations, see
|
|
4668
|
-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateInferenceRecommendationsJob.html">CreateInferenceRecommendationsJob</a>
|
|
4669
|
-
* to create an inference recommendation job.</p>
|
|
3875
|
+
* <p>A set of recommended deployment configurations for the model. To get more advanced recommendations, see <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateInferenceRecommendationsJob.html">CreateInferenceRecommendationsJob</a> to create an inference recommendation job.</p>
|
|
4670
3876
|
* @public
|
|
4671
3877
|
*/
|
|
4672
3878
|
export interface DeploymentRecommendation {
|
|
4673
3879
|
/**
|
|
4674
|
-
* <p>Status of the deployment recommendation. The status <code>NOT_APPLICABLE</code> means that SageMaker
|
|
4675
|
-
* is unable to provide a default recommendation for the model using the information provided. If the deployment status is <code>IN_PROGRESS</code>,
|
|
4676
|
-
* retry your API call after a few seconds to get a <code>COMPLETED</code> deployment recommendation.</p>
|
|
3880
|
+
* <p>Status of the deployment recommendation. The status <code>NOT_APPLICABLE</code> means that SageMaker is unable to provide a default recommendation for the model using the information provided. If the deployment status is <code>IN_PROGRESS</code>, retry your API call after a few seconds to get a <code>COMPLETED</code> deployment recommendation.</p>
|
|
4677
3881
|
* @public
|
|
4678
3882
|
*/
|
|
4679
3883
|
RecommendationStatus: RecommendationStatus | undefined;
|
|
@@ -4717,8 +3921,7 @@ export interface EdgeDeploymentStatus {
|
|
|
4717
3921
|
*/
|
|
4718
3922
|
EdgeDeploymentSuccessInStage: number | undefined;
|
|
4719
3923
|
/**
|
|
4720
|
-
* <p>The number of edge devices yet to pick up the deployment in current stage, or in
|
|
4721
|
-
* progress.</p>
|
|
3924
|
+
* <p>The number of edge devices yet to pick up the deployment in current stage, or in progress.</p>
|
|
4722
3925
|
* @public
|
|
4723
3926
|
*/
|
|
4724
3927
|
EdgeDeploymentPendingInStage: number | undefined;
|
|
@@ -4785,9 +3988,7 @@ export interface DeregisterDevicesRequest {
|
|
|
4785
3988
|
*/
|
|
4786
3989
|
export interface DerivedInformation {
|
|
4787
3990
|
/**
|
|
4788
|
-
* <p>The data input configuration that SageMaker Neo automatically derived for the model.
|
|
4789
|
-
* When SageMaker Neo derives this information, you don't need to specify the data input
|
|
4790
|
-
* configuration when you create a compilation job.</p>
|
|
3991
|
+
* <p>The data input configuration that SageMaker Neo automatically derived for the model. When SageMaker Neo derives this information, you don't need to specify the data input configuration when you create a compilation job.</p>
|
|
4791
3992
|
* @public
|
|
4792
3993
|
*/
|
|
4793
3994
|
DerivedDataInputConfig?: string | undefined;
|
|
@@ -4847,8 +4048,7 @@ export interface DescribeActionResponse {
|
|
|
4847
4048
|
*/
|
|
4848
4049
|
CreationTime?: Date | undefined;
|
|
4849
4050
|
/**
|
|
4850
|
-
* <p>Information about the user who created or modified an experiment, trial, trial
|
|
4851
|
-
* component, lineage group, project, or model card.</p>
|
|
4051
|
+
* <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.</p>
|
|
4852
4052
|
* @public
|
|
4853
4053
|
*/
|
|
4854
4054
|
CreatedBy?: UserContext | undefined;
|
|
@@ -4858,8 +4058,7 @@ export interface DescribeActionResponse {
|
|
|
4858
4058
|
*/
|
|
4859
4059
|
LastModifiedTime?: Date | undefined;
|
|
4860
4060
|
/**
|
|
4861
|
-
* <p>Information about the user who created or modified an experiment, trial, trial
|
|
4862
|
-
* component, lineage group, project, or model card.</p>
|
|
4061
|
+
* <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.</p>
|
|
4863
4062
|
* @public
|
|
4864
4063
|
*/
|
|
4865
4064
|
LastModifiedBy?: UserContext | undefined;
|
|
@@ -4919,8 +4118,7 @@ export interface DescribeAlgorithmOutput {
|
|
|
4919
4118
|
*/
|
|
4920
4119
|
InferenceSpecification?: InferenceSpecification | undefined;
|
|
4921
4120
|
/**
|
|
4922
|
-
* <p>Details about configurations for one or more training jobs that SageMaker runs to test the
|
|
4923
|
-
* algorithm.</p>
|
|
4121
|
+
* <p>Details about configurations for one or more training jobs that SageMaker runs to test the algorithm.</p>
|
|
4924
4122
|
* @public
|
|
4925
4123
|
*/
|
|
4926
4124
|
ValidationSpecification?: AlgorithmValidationSpecification | undefined;
|
|
@@ -4940,8 +4138,7 @@ export interface DescribeAlgorithmOutput {
|
|
|
4940
4138
|
*/
|
|
4941
4139
|
ProductId?: string | undefined;
|
|
4942
4140
|
/**
|
|
4943
|
-
* <p>Whether the algorithm is certified to be listed in Amazon Web Services
|
|
4944
|
-
* Marketplace.</p>
|
|
4141
|
+
* <p>Whether the algorithm is certified to be listed in Amazon Web Services Marketplace.</p>
|
|
4945
4142
|
* @public
|
|
4946
4143
|
*/
|
|
4947
4144
|
CertifyForMarketplace?: boolean | undefined;
|
|
@@ -4956,8 +4153,7 @@ export interface DescribeAppRequest {
|
|
|
4956
4153
|
*/
|
|
4957
4154
|
DomainId: string | undefined;
|
|
4958
4155
|
/**
|
|
4959
|
-
* <p>The user profile name. If this value is not set, then <code>SpaceName</code> must be
|
|
4960
|
-
* set.</p>
|
|
4156
|
+
* <p>The user profile name. If this value is not set, then <code>SpaceName</code> must be set.</p>
|
|
4961
4157
|
* @public
|
|
4962
4158
|
*/
|
|
4963
4159
|
UserProfileName?: string | undefined;
|
|
@@ -5007,8 +4203,7 @@ export interface DescribeAppResponse {
|
|
|
5007
4203
|
*/
|
|
5008
4204
|
UserProfileName?: string | undefined;
|
|
5009
4205
|
/**
|
|
5010
|
-
* <p>The name of the space. If this value is not set, then <code>UserProfileName</code> must be
|
|
5011
|
-
* set.</p>
|
|
4206
|
+
* <p>The name of the space. If this value is not set, then <code>UserProfileName</code> must be set.</p>
|
|
5012
4207
|
* @public
|
|
5013
4208
|
*/
|
|
5014
4209
|
SpaceName?: string | undefined;
|
|
@@ -5028,21 +4223,12 @@ export interface DescribeAppResponse {
|
|
|
5028
4223
|
*/
|
|
5029
4224
|
LastHealthCheckTimestamp?: Date | undefined;
|
|
5030
4225
|
/**
|
|
5031
|
-
* <p>The timestamp of the last user's activity. <code>LastUserActivityTimestamp</code> is also
|
|
5032
|
-
* updated when SageMaker AI performs health checks without user activity. As a result, this
|
|
5033
|
-
* value is set to the same value as <code>LastHealthCheckTimestamp</code>.</p>
|
|
4226
|
+
* <p>The timestamp of the last user's activity. <code>LastUserActivityTimestamp</code> is also updated when SageMaker AI performs health checks without user activity. As a result, this value is set to the same value as <code>LastHealthCheckTimestamp</code>.</p>
|
|
5034
4227
|
* @public
|
|
5035
4228
|
*/
|
|
5036
4229
|
LastUserActivityTimestamp?: Date | undefined;
|
|
5037
4230
|
/**
|
|
5038
|
-
* <p>The creation time of the application.</p>
|
|
5039
|
-
* <note>
|
|
5040
|
-
* <p>After an application has been shut down for 24 hours, SageMaker AI deletes all
|
|
5041
|
-
* metadata for the application. To be considered an update and retain application metadata,
|
|
5042
|
-
* applications must be restarted within 24 hours after the previous application has been shut
|
|
5043
|
-
* down. After this time window, creation of an application is considered a new application
|
|
5044
|
-
* rather than an update of the previous application.</p>
|
|
5045
|
-
* </note>
|
|
4231
|
+
* <p>The creation time of the application.</p> <note> <p>After an application has been shut down for 24 hours, SageMaker AI deletes all metadata for the application. To be considered an update and retain application metadata, applications must be restarted within 24 hours after the previous application has been shut down. After this time window, creation of an application is considered a new application rather than an update of the previous application.</p> </note>
|
|
5046
4232
|
* @public
|
|
5047
4233
|
*/
|
|
5048
4234
|
CreationTime?: Date | undefined;
|
|
@@ -5052,8 +4238,7 @@ export interface DescribeAppResponse {
|
|
|
5052
4238
|
*/
|
|
5053
4239
|
FailureReason?: string | undefined;
|
|
5054
4240
|
/**
|
|
5055
|
-
* <p>The instance type and the Amazon Resource Name (ARN) of the SageMaker AI image
|
|
5056
|
-
* created on the instance.</p>
|
|
4241
|
+
* <p>The instance type and the Amazon Resource Name (ARN) of the SageMaker AI image created on the instance.</p>
|
|
5057
4242
|
* @public
|
|
5058
4243
|
*/
|
|
5059
4244
|
ResourceSpec?: ResourceSpec | undefined;
|
|
@@ -5158,8 +4343,7 @@ export interface DescribeArtifactResponse {
|
|
|
5158
4343
|
*/
|
|
5159
4344
|
CreationTime?: Date | undefined;
|
|
5160
4345
|
/**
|
|
5161
|
-
* <p>Information about the user who created or modified an experiment, trial, trial
|
|
5162
|
-
* component, lineage group, project, or model card.</p>
|
|
4346
|
+
* <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.</p>
|
|
5163
4347
|
* @public
|
|
5164
4348
|
*/
|
|
5165
4349
|
CreatedBy?: UserContext | undefined;
|
|
@@ -5169,8 +4353,7 @@ export interface DescribeArtifactResponse {
|
|
|
5169
4353
|
*/
|
|
5170
4354
|
LastModifiedTime?: Date | undefined;
|
|
5171
4355
|
/**
|
|
5172
|
-
* <p>Information about the user who created or modified an experiment, trial, trial
|
|
5173
|
-
* component, lineage group, project, or model card.</p>
|
|
4356
|
+
* <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.</p>
|
|
5174
4357
|
* @public
|
|
5175
4358
|
*/
|
|
5176
4359
|
LastModifiedBy?: UserContext | undefined;
|
|
@@ -5201,10 +4384,7 @@ export interface DescribeAutoMLJobRequest {
|
|
|
5201
4384
|
*/
|
|
5202
4385
|
export interface ModelDeployResult {
|
|
5203
4386
|
/**
|
|
5204
|
-
* <p>The name of the endpoint to which the model has been deployed.</p>
|
|
5205
|
-
* <note>
|
|
5206
|
-
* <p>If model deployment fails, this field is omitted from the response.</p>
|
|
5207
|
-
* </note>
|
|
4387
|
+
* <p>The name of the endpoint to which the model has been deployed.</p> <note> <p>If model deployment fails, this field is omitted from the response.</p> </note>
|
|
5208
4388
|
* @public
|
|
5209
4389
|
*/
|
|
5210
4390
|
EndpointName?: string | undefined;
|
|
@@ -5225,8 +4405,7 @@ export interface ResolvedAttributes {
|
|
|
5225
4405
|
*/
|
|
5226
4406
|
ProblemType?: ProblemType | undefined;
|
|
5227
4407
|
/**
|
|
5228
|
-
* <p>How long a job is allowed to run, or how many candidates a job is allowed to
|
|
5229
|
-
* generate.</p>
|
|
4408
|
+
* <p>How long a job is allowed to run, or how many candidates a job is allowed to generate.</p>
|
|
5230
4409
|
* @public
|
|
5231
4410
|
*/
|
|
5232
4411
|
CompletionCriteria?: AutoMLJobCompletionCriteria | undefined;
|
|
@@ -5256,8 +4435,7 @@ export interface DescribeAutoMLJobResponse {
|
|
|
5256
4435
|
*/
|
|
5257
4436
|
OutputDataConfig: AutoMLOutputDataConfig | undefined;
|
|
5258
4437
|
/**
|
|
5259
|
-
* <p>The ARN of the IAM role that has read permission to the input data
|
|
5260
|
-
* location and write permission to the output data location in Amazon S3.</p>
|
|
4438
|
+
* <p>The ARN of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.</p>
|
|
5261
4439
|
* @public
|
|
5262
4440
|
*/
|
|
5263
4441
|
RoleArn: string | undefined;
|
|
@@ -5302,9 +4480,7 @@ export interface DescribeAutoMLJobResponse {
|
|
|
5302
4480
|
*/
|
|
5303
4481
|
PartialFailureReasons?: AutoMLPartialFailureReason[] | undefined;
|
|
5304
4482
|
/**
|
|
5305
|
-
* <p>The best model candidate selected by SageMaker AI Autopilot using both the best
|
|
5306
|
-
* objective metric and lowest <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-metrics-validation.html">InferenceLatency</a> for
|
|
5307
|
-
* an experiment.</p>
|
|
4483
|
+
* <p>The best model candidate selected by SageMaker AI Autopilot using both the best objective metric and lowest <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-metrics-validation.html">InferenceLatency</a> for an experiment.</p>
|
|
5308
4484
|
* @public
|
|
5309
4485
|
*/
|
|
5310
4486
|
BestCandidate?: AutoMLCandidate | undefined;
|
|
@@ -5319,27 +4495,22 @@ export interface DescribeAutoMLJobResponse {
|
|
|
5319
4495
|
*/
|
|
5320
4496
|
AutoMLJobSecondaryStatus: AutoMLJobSecondaryStatus | undefined;
|
|
5321
4497
|
/**
|
|
5322
|
-
* <p>Indicates whether the output for an AutoML job generates candidate definitions
|
|
5323
|
-
* only.</p>
|
|
4498
|
+
* <p>Indicates whether the output for an AutoML job generates candidate definitions only.</p>
|
|
5324
4499
|
* @public
|
|
5325
4500
|
*/
|
|
5326
4501
|
GenerateCandidateDefinitionsOnly?: boolean | undefined;
|
|
5327
4502
|
/**
|
|
5328
|
-
* <p>Returns information on the job's artifacts found in
|
|
5329
|
-
* <code>AutoMLJobArtifacts</code>.</p>
|
|
4503
|
+
* <p>Returns information on the job's artifacts found in <code>AutoMLJobArtifacts</code>.</p>
|
|
5330
4504
|
* @public
|
|
5331
4505
|
*/
|
|
5332
4506
|
AutoMLJobArtifacts?: AutoMLJobArtifacts | undefined;
|
|
5333
4507
|
/**
|
|
5334
|
-
* <p>Contains <code>ProblemType</code>, <code>AutoMLJobObjective</code>, and
|
|
5335
|
-
* <code>CompletionCriteria</code>. If you do not provide these values, they are
|
|
5336
|
-
* inferred.</p>
|
|
4508
|
+
* <p>Contains <code>ProblemType</code>, <code>AutoMLJobObjective</code>, and <code>CompletionCriteria</code>. If you do not provide these values, they are inferred.</p>
|
|
5337
4509
|
* @public
|
|
5338
4510
|
*/
|
|
5339
4511
|
ResolvedAttributes?: ResolvedAttributes | undefined;
|
|
5340
4512
|
/**
|
|
5341
|
-
* <p>Indicates whether the model was deployed automatically to an endpoint and the name of
|
|
5342
|
-
* that endpoint if deployed automatically.</p>
|
|
4513
|
+
* <p>Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically.</p>
|
|
5343
4514
|
* @public
|
|
5344
4515
|
*/
|
|
5345
4516
|
ModelDeployConfig?: ModelDeployConfig | undefined;
|
|
@@ -5384,8 +4555,7 @@ export interface DescribeAutoMLJobV2Response {
|
|
|
5384
4555
|
*/
|
|
5385
4556
|
OutputDataConfig: AutoMLOutputDataConfig | undefined;
|
|
5386
4557
|
/**
|
|
5387
|
-
* <p>The ARN of the IAM role that has read permission to the input data
|
|
5388
|
-
* location and write permission to the output data location in Amazon S3.</p>
|
|
4558
|
+
* <p>The ARN of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.</p>
|
|
5389
4559
|
* @public
|
|
5390
4560
|
*/
|
|
5391
4561
|
RoleArn: string | undefined;
|
|
@@ -5430,8 +4600,7 @@ export interface DescribeAutoMLJobV2Response {
|
|
|
5430
4600
|
*/
|
|
5431
4601
|
PartialFailureReasons?: AutoMLPartialFailureReason[] | undefined;
|
|
5432
4602
|
/**
|
|
5433
|
-
* <p>Information about the candidate produced by an AutoML training job V2, including its
|
|
5434
|
-
* status, steps, and other properties.</p>
|
|
4603
|
+
* <p>Information about the candidate produced by an AutoML training job V2, including its status, steps, and other properties.</p>
|
|
5435
4604
|
* @public
|
|
5436
4605
|
*/
|
|
5437
4606
|
BestCandidate?: AutoMLCandidate | undefined;
|
|
@@ -5456,8 +4625,7 @@ export interface DescribeAutoMLJobV2Response {
|
|
|
5456
4625
|
*/
|
|
5457
4626
|
ResolvedAttributes?: AutoMLResolvedAttributes | undefined;
|
|
5458
4627
|
/**
|
|
5459
|
-
* <p>Indicates whether the model was deployed automatically to an endpoint and the name of
|
|
5460
|
-
* that endpoint if deployed automatically.</p>
|
|
4628
|
+
* <p>Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically.</p>
|
|
5461
4629
|
* @public
|
|
5462
4630
|
*/
|
|
5463
4631
|
ModelDeployConfig?: ModelDeployConfig | undefined;
|
|
@@ -5467,14 +4635,12 @@ export interface DescribeAutoMLJobV2Response {
|
|
|
5467
4635
|
*/
|
|
5468
4636
|
ModelDeployResult?: ModelDeployResult | undefined;
|
|
5469
4637
|
/**
|
|
5470
|
-
* <p>Returns the configuration settings of how the data are split into train and validation
|
|
5471
|
-
* datasets.</p>
|
|
4638
|
+
* <p>Returns the configuration settings of how the data are split into train and validation datasets.</p>
|
|
5472
4639
|
* @public
|
|
5473
4640
|
*/
|
|
5474
4641
|
DataSplitConfig?: AutoMLDataSplitConfig | undefined;
|
|
5475
4642
|
/**
|
|
5476
|
-
* <p>Returns the security configuration for traffic encryption or Amazon VPC
|
|
5477
|
-
* settings.</p>
|
|
4643
|
+
* <p>Returns the security configuration for traffic encryption or Amazon VPC settings.</p>
|
|
5478
4644
|
* @public
|
|
5479
4645
|
*/
|
|
5480
4646
|
SecurityConfig?: AutoMLSecurityConfig | undefined;
|
|
@@ -5529,10 +4695,7 @@ export interface DescribeClusterResponse {
|
|
|
5529
4695
|
*/
|
|
5530
4696
|
InstanceGroups: ClusterInstanceGroupDetails[] | undefined;
|
|
5531
4697
|
/**
|
|
5532
|
-
* <p>Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources
|
|
5533
|
-
* have access to. You can control access to and from your resources by configuring a VPC.
|
|
5534
|
-
* For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html">Give SageMaker Access to
|
|
5535
|
-
* Resources in your Amazon VPC</a>. </p>
|
|
4698
|
+
* <p>Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html">Give SageMaker Access to Resources in your Amazon VPC</a>. </p>
|
|
5536
4699
|
* @public
|
|
5537
4700
|
*/
|
|
5538
4701
|
VpcConfig?: VpcConfig | undefined;
|
|
@@ -5627,9 +4790,7 @@ export interface DescribeClusterSchedulerConfigResponse {
|
|
|
5627
4790
|
*/
|
|
5628
4791
|
ClusterArn?: string | undefined;
|
|
5629
4792
|
/**
|
|
5630
|
-
* <p>Cluster policy configuration. This policy is used for task prioritization and fair-share
|
|
5631
|
-
* allocation. This helps prioritize critical workloads and distributes idle compute
|
|
5632
|
-
* across entities.</p>
|
|
4793
|
+
* <p>Cluster policy configuration. This policy is used for task prioritization and fair-share allocation. This helps prioritize critical workloads and distributes idle compute across entities.</p>
|
|
5633
4794
|
* @public
|
|
5634
4795
|
*/
|
|
5635
4796
|
SchedulerConfig?: SchedulerConfig | undefined;
|
|
@@ -5644,8 +4805,7 @@ export interface DescribeClusterSchedulerConfigResponse {
|
|
|
5644
4805
|
*/
|
|
5645
4806
|
CreationTime: Date | undefined;
|
|
5646
4807
|
/**
|
|
5647
|
-
* <p>Information about the user who created or modified an experiment, trial, trial
|
|
5648
|
-
* component, lineage group, project, or model card.</p>
|
|
4808
|
+
* <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.</p>
|
|
5649
4809
|
* @public
|
|
5650
4810
|
*/
|
|
5651
4811
|
CreatedBy?: UserContext | undefined;
|
|
@@ -5655,8 +4815,7 @@ export interface DescribeClusterSchedulerConfigResponse {
|
|
|
5655
4815
|
*/
|
|
5656
4816
|
LastModifiedTime?: Date | undefined;
|
|
5657
4817
|
/**
|
|
5658
|
-
* <p>Information about the user who created or modified an experiment, trial, trial
|
|
5659
|
-
* component, lineage group, project, or model card.</p>
|
|
4818
|
+
* <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.</p>
|
|
5660
4819
|
* @public
|
|
5661
4820
|
*/
|
|
5662
4821
|
LastModifiedBy?: UserContext | undefined;
|
|
@@ -5696,9 +4855,7 @@ export interface DescribeCodeRepositoryOutput {
|
|
|
5696
4855
|
*/
|
|
5697
4856
|
LastModifiedTime: Date | undefined;
|
|
5698
4857
|
/**
|
|
5699
|
-
* <p>Configuration details about the repository, including the URL where the repository is
|
|
5700
|
-
* located, the default branch, and the Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the
|
|
5701
|
-
* repository.</p>
|
|
4858
|
+
* <p>Configuration details about the repository, including the URL where the repository is located, the default branch, and the Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the repository.</p>
|
|
5702
4859
|
* @public
|
|
5703
4860
|
*/
|
|
5704
4861
|
GitConfig?: GitConfig | undefined;
|
|
@@ -5714,19 +4871,12 @@ export interface DescribeCompilationJobRequest {
|
|
|
5714
4871
|
CompilationJobName: string | undefined;
|
|
5715
4872
|
}
|
|
5716
4873
|
/**
|
|
5717
|
-
* <p>Provides information about the location that is configured for storing model
|
|
5718
|
-
* artifacts. </p>
|
|
5719
|
-
* <p>Model artifacts are outputs that result from training a model. They typically consist
|
|
5720
|
-
* of trained parameters, a model definition that describes how to compute inferences, and
|
|
5721
|
-
* other metadata. A SageMaker container stores your trained model artifacts in the
|
|
5722
|
-
* <code>/opt/ml/model</code> directory. After training has completed, by default,
|
|
5723
|
-
* these artifacts are uploaded to your Amazon S3 bucket as compressed files.</p>
|
|
4874
|
+
* <p>Provides information about the location that is configured for storing model artifacts. </p> <p>Model artifacts are outputs that result from training a model. They typically consist of trained parameters, a model definition that describes how to compute inferences, and other metadata. A SageMaker container stores your trained model artifacts in the <code>/opt/ml/model</code> directory. After training has completed, by default, these artifacts are uploaded to your Amazon S3 bucket as compressed files.</p>
|
|
5724
4875
|
* @public
|
|
5725
4876
|
*/
|
|
5726
4877
|
export interface ModelArtifacts {
|
|
5727
4878
|
/**
|
|
5728
|
-
* <p>The path of the S3 object that contains the model artifacts. For example,
|
|
5729
|
-
* <code>s3://bucket-name/keynameprefix/model.tar.gz</code>.</p>
|
|
4879
|
+
* <p>The path of the S3 object that contains the model artifacts. For example, <code>s3://bucket-name/keynameprefix/model.tar.gz</code>.</p>
|
|
5730
4880
|
* @public
|
|
5731
4881
|
*/
|
|
5732
4882
|
S3ModelArtifacts: string | undefined;
|
|
@@ -5737,8 +4887,7 @@ export interface ModelArtifacts {
|
|
|
5737
4887
|
*/
|
|
5738
4888
|
export interface ModelDigests {
|
|
5739
4889
|
/**
|
|
5740
|
-
* <p>Provides a hash value that uniquely identifies the stored model
|
|
5741
|
-
* artifacts.</p>
|
|
4890
|
+
* <p>Provides a hash value that uniquely identifies the stored model artifacts.</p>
|
|
5742
4891
|
* @public
|
|
5743
4892
|
*/
|
|
5744
4893
|
ArtifactDigest?: string | undefined;
|
|
@@ -5763,38 +4912,27 @@ export interface DescribeCompilationJobResponse {
|
|
|
5763
4912
|
*/
|
|
5764
4913
|
CompilationJobStatus: CompilationJobStatus | undefined;
|
|
5765
4914
|
/**
|
|
5766
|
-
* <p>The time when the model compilation job started the <code>CompilationJob</code>
|
|
5767
|
-
* instances. </p>
|
|
5768
|
-
* <p>You are billed for the time between this timestamp and the timestamp in the
|
|
5769
|
-
* <code>CompilationEndTime</code> field. In Amazon CloudWatch Logs, the start time might be later
|
|
5770
|
-
* than this time. That's because it takes time to download the compilation job, which
|
|
5771
|
-
* depends on the size of the compilation job container. </p>
|
|
4915
|
+
* <p>The time when the model compilation job started the <code>CompilationJob</code> instances. </p> <p>You are billed for the time between this timestamp and the timestamp in the <code>CompilationEndTime</code> field. In Amazon CloudWatch Logs, the start time might be later than this time. That's because it takes time to download the compilation job, which depends on the size of the compilation job container. </p>
|
|
5772
4916
|
* @public
|
|
5773
4917
|
*/
|
|
5774
4918
|
CompilationStartTime?: Date | undefined;
|
|
5775
4919
|
/**
|
|
5776
|
-
* <p>The time when the model compilation job on a compilation job instance ended. For a
|
|
5777
|
-
* successful or stopped job, this is when the job's model artifacts have finished
|
|
5778
|
-
* uploading. For a failed job, this is when Amazon SageMaker AI detected that the job failed. </p>
|
|
4920
|
+
* <p>The time when the model compilation job on a compilation job instance ended. For a successful or stopped job, this is when the job's model artifacts have finished uploading. For a failed job, this is when Amazon SageMaker AI detected that the job failed. </p>
|
|
5779
4921
|
* @public
|
|
5780
4922
|
*/
|
|
5781
4923
|
CompilationEndTime?: Date | undefined;
|
|
5782
4924
|
/**
|
|
5783
|
-
* <p>Specifies a limit to how long a model compilation job can run. When the job reaches
|
|
5784
|
-
* the time limit, Amazon SageMaker AI ends the compilation job. Use this API to cap model training
|
|
5785
|
-
* costs.</p>
|
|
4925
|
+
* <p>Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker AI ends the compilation job. Use this API to cap model training costs.</p>
|
|
5786
4926
|
* @public
|
|
5787
4927
|
*/
|
|
5788
4928
|
StoppingCondition: StoppingCondition | undefined;
|
|
5789
4929
|
/**
|
|
5790
|
-
* <p>The inference image to use when compiling a model. Specify an image only if the target
|
|
5791
|
-
* device is a cloud instance.</p>
|
|
4930
|
+
* <p>The inference image to use when compiling a model. Specify an image only if the target device is a cloud instance.</p>
|
|
5792
4931
|
* @public
|
|
5793
4932
|
*/
|
|
5794
4933
|
InferenceImage?: string | undefined;
|
|
5795
4934
|
/**
|
|
5796
|
-
* <p>The Amazon Resource Name (ARN) of the versioned model package that was
|
|
5797
|
-
* provided to SageMaker Neo when you initiated a compilation job.</p>
|
|
4935
|
+
* <p>The Amazon Resource Name (ARN) of the versioned model package that was provided to SageMaker Neo when you initiated a compilation job.</p>
|
|
5798
4936
|
* @public
|
|
5799
4937
|
*/
|
|
5800
4938
|
ModelPackageVersionArn?: string | undefined;
|
|
@@ -5804,9 +4942,7 @@ export interface DescribeCompilationJobResponse {
|
|
|
5804
4942
|
*/
|
|
5805
4943
|
CreationTime: Date | undefined;
|
|
5806
4944
|
/**
|
|
5807
|
-
* <p>The time that the status
|
|
5808
|
-
* of
|
|
5809
|
-
* the model compilation job was last modified.</p>
|
|
4945
|
+
* <p>The time that the status of the model compilation job was last modified.</p>
|
|
5810
4946
|
* @public
|
|
5811
4947
|
*/
|
|
5812
4948
|
LastModifiedTime: Date | undefined;
|
|
@@ -5816,40 +4952,32 @@ export interface DescribeCompilationJobResponse {
|
|
|
5816
4952
|
*/
|
|
5817
4953
|
FailureReason: string | undefined;
|
|
5818
4954
|
/**
|
|
5819
|
-
* <p>Information about the location in Amazon S3 that has been configured for storing the model
|
|
5820
|
-
* artifacts used in the compilation job.</p>
|
|
4955
|
+
* <p>Information about the location in Amazon S3 that has been configured for storing the model artifacts used in the compilation job.</p>
|
|
5821
4956
|
* @public
|
|
5822
4957
|
*/
|
|
5823
4958
|
ModelArtifacts: ModelArtifacts | undefined;
|
|
5824
4959
|
/**
|
|
5825
|
-
* <p>Provides a BLAKE2 hash value that identifies the compiled model artifacts in
|
|
5826
|
-
* Amazon S3.</p>
|
|
4960
|
+
* <p>Provides a BLAKE2 hash value that identifies the compiled model artifacts in Amazon S3.</p>
|
|
5827
4961
|
* @public
|
|
5828
4962
|
*/
|
|
5829
4963
|
ModelDigests?: ModelDigests | undefined;
|
|
5830
4964
|
/**
|
|
5831
|
-
* <p>The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI assumes to perform the model
|
|
5832
|
-
* compilation job.</p>
|
|
4965
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI assumes to perform the model compilation job.</p>
|
|
5833
4966
|
* @public
|
|
5834
4967
|
*/
|
|
5835
4968
|
RoleArn: string | undefined;
|
|
5836
4969
|
/**
|
|
5837
|
-
* <p>Information about the location in Amazon S3 of the input model artifacts, the name and
|
|
5838
|
-
* shape of the expected data inputs, and the framework in which the model was
|
|
5839
|
-
* trained.</p>
|
|
4970
|
+
* <p>Information about the location in Amazon S3 of the input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.</p>
|
|
5840
4971
|
* @public
|
|
5841
4972
|
*/
|
|
5842
4973
|
InputConfig: InputConfig | undefined;
|
|
5843
4974
|
/**
|
|
5844
|
-
* <p>Information about the output location for the compiled model and the target device
|
|
5845
|
-
* that the model runs on.</p>
|
|
4975
|
+
* <p>Information about the output location for the compiled model and the target device that the model runs on.</p>
|
|
5846
4976
|
* @public
|
|
5847
4977
|
*/
|
|
5848
4978
|
OutputConfig: OutputConfig | undefined;
|
|
5849
4979
|
/**
|
|
5850
|
-
* <p>A <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html">VpcConfig</a> object that specifies the VPC that you want your compilation job
|
|
5851
|
-
* to connect to. Control access to your models by configuring the VPC. For more
|
|
5852
|
-
* information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/neo-vpc.html">Protect Compilation Jobs by Using an Amazon Virtual Private Cloud</a>.</p>
|
|
4980
|
+
* <p>A <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html">VpcConfig</a> object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/neo-vpc.html">Protect Compilation Jobs by Using an Amazon Virtual Private Cloud</a>.</p>
|
|
5853
4981
|
* @public
|
|
5854
4982
|
*/
|
|
5855
4983
|
VpcConfig?: NeoVpcConfig | undefined;
|
|
@@ -5919,8 +5047,7 @@ export interface DescribeComputeQuotaResponse {
|
|
|
5919
5047
|
*/
|
|
5920
5048
|
ClusterArn?: string | undefined;
|
|
5921
5049
|
/**
|
|
5922
|
-
* <p>Configuration of the compute allocation definition. This includes the resource sharing
|
|
5923
|
-
* option, and the setting to preempt low priority tasks.</p>
|
|
5050
|
+
* <p>Configuration of the compute allocation definition. This includes the resource sharing option, and the setting to preempt low priority tasks.</p>
|
|
5924
5051
|
* @public
|
|
5925
5052
|
*/
|
|
5926
5053
|
ComputeQuotaConfig?: ComputeQuotaConfig | undefined;
|
|
@@ -5930,9 +5057,7 @@ export interface DescribeComputeQuotaResponse {
|
|
|
5930
5057
|
*/
|
|
5931
5058
|
ComputeQuotaTarget: ComputeQuotaTarget | undefined;
|
|
5932
5059
|
/**
|
|
5933
|
-
* <p>The state of the compute allocation being described. Use to enable or disable compute
|
|
5934
|
-
* allocation.</p>
|
|
5935
|
-
* <p>Default is <code>Enabled</code>.</p>
|
|
5060
|
+
* <p>The state of the compute allocation being described. Use to enable or disable compute allocation.</p> <p>Default is <code>Enabled</code>.</p>
|
|
5936
5061
|
* @public
|
|
5937
5062
|
*/
|
|
5938
5063
|
ActivationState?: ActivationState | undefined;
|
|
@@ -5942,8 +5067,7 @@ export interface DescribeComputeQuotaResponse {
|
|
|
5942
5067
|
*/
|
|
5943
5068
|
CreationTime: Date | undefined;
|
|
5944
5069
|
/**
|
|
5945
|
-
* <p>Information about the user who created or modified an experiment, trial, trial
|
|
5946
|
-
* component, lineage group, project, or model card.</p>
|
|
5070
|
+
* <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.</p>
|
|
5947
5071
|
* @public
|
|
5948
5072
|
*/
|
|
5949
5073
|
CreatedBy?: UserContext | undefined;
|
|
@@ -5953,8 +5077,7 @@ export interface DescribeComputeQuotaResponse {
|
|
|
5953
5077
|
*/
|
|
5954
5078
|
LastModifiedTime?: Date | undefined;
|
|
5955
5079
|
/**
|
|
5956
|
-
* <p>Information about the user who created or modified an experiment, trial, trial
|
|
5957
|
-
* component, lineage group, project, or model card.</p>
|
|
5080
|
+
* <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.</p>
|
|
5958
5081
|
* @public
|
|
5959
5082
|
*/
|
|
5960
5083
|
LastModifiedBy?: UserContext | undefined;
|
|
@@ -6009,8 +5132,7 @@ export interface DescribeContextResponse {
|
|
|
6009
5132
|
*/
|
|
6010
5133
|
CreationTime?: Date | undefined;
|
|
6011
5134
|
/**
|
|
6012
|
-
* <p>Information about the user who created or modified an experiment, trial, trial
|
|
6013
|
-
* component, lineage group, project, or model card.</p>
|
|
5135
|
+
* <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.</p>
|
|
6014
5136
|
* @public
|
|
6015
5137
|
*/
|
|
6016
5138
|
CreatedBy?: UserContext | undefined;
|
|
@@ -6020,8 +5142,7 @@ export interface DescribeContextResponse {
|
|
|
6020
5142
|
*/
|
|
6021
5143
|
LastModifiedTime?: Date | undefined;
|
|
6022
5144
|
/**
|
|
6023
|
-
* <p>Information about the user who created or modified an experiment, trial, trial
|
|
6024
|
-
* component, lineage group, project, or model card.</p>
|
|
5145
|
+
* <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.</p>
|
|
6025
5146
|
* @public
|
|
6026
5147
|
*/
|
|
6027
5148
|
LastModifiedBy?: UserContext | undefined;
|
|
@@ -6071,8 +5192,7 @@ export interface DescribeDataQualityJobDefinitionResponse {
|
|
|
6071
5192
|
*/
|
|
6072
5193
|
DataQualityAppSpecification: DataQualityAppSpecification | undefined;
|
|
6073
5194
|
/**
|
|
6074
|
-
* <p>The list of inputs for the data quality monitoring job. Currently endpoints are
|
|
6075
|
-
* supported.</p>
|
|
5195
|
+
* <p>The list of inputs for the data quality monitoring job. Currently endpoints are supported.</p>
|
|
6076
5196
|
* @public
|
|
6077
5197
|
*/
|
|
6078
5198
|
DataQualityJobInput: DataQualityJobInput | undefined;
|
|
@@ -6092,8 +5212,7 @@ export interface DescribeDataQualityJobDefinitionResponse {
|
|
|
6092
5212
|
*/
|
|
6093
5213
|
NetworkConfig?: MonitoringNetworkConfig | undefined;
|
|
6094
5214
|
/**
|
|
6095
|
-
* <p>The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can
|
|
6096
|
-
* assume to perform tasks on your behalf.</p>
|
|
5215
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.</p>
|
|
6097
5216
|
* @public
|
|
6098
5217
|
*/
|
|
6099
5218
|
RoleArn: string | undefined;
|
|
@@ -6321,8 +5440,7 @@ export interface DescribeDomainResponse {
|
|
|
6321
5440
|
*/
|
|
6322
5441
|
SingleSignOnManagedApplicationInstanceId?: string | undefined;
|
|
6323
5442
|
/**
|
|
6324
|
-
* <p>The ARN of the application managed by SageMaker AI in IAM Identity Center. This value
|
|
6325
|
-
* is only returned for domains created after October 1, 2023.</p>
|
|
5443
|
+
* <p>The ARN of the application managed by SageMaker AI in IAM Identity Center. This value is only returned for domains created after October 1, 2023.</p>
|
|
6326
5444
|
* @public
|
|
6327
5445
|
*/
|
|
6328
5446
|
SingleSignOnApplicationArn?: string | undefined;
|
|
@@ -6347,8 +5465,7 @@ export interface DescribeDomainResponse {
|
|
|
6347
5465
|
*/
|
|
6348
5466
|
FailureReason?: string | undefined;
|
|
6349
5467
|
/**
|
|
6350
|
-
* <p>The ID of the security group that authorizes traffic between the
|
|
6351
|
-
* <code>RSessionGateway</code> apps and the <code>RStudioServerPro</code> app.</p>
|
|
5468
|
+
* <p>The ID of the security group that authorizes traffic between the <code>RSessionGateway</code> apps and the <code>RStudioServerPro</code> app.</p>
|
|
6352
5469
|
* @public
|
|
6353
5470
|
*/
|
|
6354
5471
|
SecurityGroupIdForDomainBoundary?: string | undefined;
|
|
@@ -6358,8 +5475,7 @@ export interface DescribeDomainResponse {
|
|
|
6358
5475
|
*/
|
|
6359
5476
|
AuthMode?: AuthMode | undefined;
|
|
6360
5477
|
/**
|
|
6361
|
-
* <p>Settings which are applied to UserProfiles in this domain if settings are not explicitly
|
|
6362
|
-
* specified in a given UserProfile. </p>
|
|
5478
|
+
* <p>Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a given UserProfile. </p>
|
|
6363
5479
|
* @public
|
|
6364
5480
|
*/
|
|
6365
5481
|
DefaultUserSettings?: UserSettings | undefined;
|
|
@@ -6369,18 +5485,7 @@ export interface DescribeDomainResponse {
|
|
|
6369
5485
|
*/
|
|
6370
5486
|
DomainSettings?: DomainSettings | undefined;
|
|
6371
5487
|
/**
|
|
6372
|
-
* <p>Specifies the VPC used for non-EFS traffic. The default value is
|
|
6373
|
-
* <code>PublicInternetOnly</code>.</p>
|
|
6374
|
-
* <ul>
|
|
6375
|
-
* <li>
|
|
6376
|
-
* <p>
|
|
6377
|
-
* <code>PublicInternetOnly</code> - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access</p>
|
|
6378
|
-
* </li>
|
|
6379
|
-
* <li>
|
|
6380
|
-
* <p>
|
|
6381
|
-
* <code>VpcOnly</code> - All traffic is through the specified VPC and subnets</p>
|
|
6382
|
-
* </li>
|
|
6383
|
-
* </ul>
|
|
5488
|
+
* <p>Specifies the VPC used for non-EFS traffic. The default value is <code>PublicInternetOnly</code>.</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 traffic is through the specified VPC and subnets</p> </li> </ul>
|
|
6384
5489
|
* @public
|
|
6385
5490
|
*/
|
|
6386
5491
|
AppNetworkAccessType?: AppNetworkAccessType | undefined;
|
|
@@ -6407,17 +5512,12 @@ export interface DescribeDomainResponse {
|
|
|
6407
5512
|
*/
|
|
6408
5513
|
VpcId?: string | undefined;
|
|
6409
5514
|
/**
|
|
6410
|
-
* <p>The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to
|
|
6411
|
-
* the domain.</p>
|
|
5515
|
+
* <p>The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to the domain.</p>
|
|
6412
5516
|
* @public
|
|
6413
5517
|
*/
|
|
6414
5518
|
KmsKeyId?: string | undefined;
|
|
6415
5519
|
/**
|
|
6416
|
-
* <p>The entity that creates and manages the required security groups for inter-app
|
|
6417
|
-
* communication in <code>VPCOnly</code> mode. Required when
|
|
6418
|
-
* <code>CreateDomain.AppNetworkAccessType</code> is <code>VPCOnly</code> and
|
|
6419
|
-
* <code>DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn</code> is
|
|
6420
|
-
* provided.</p>
|
|
5520
|
+
* <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.</p>
|
|
6421
5521
|
* @public
|
|
6422
5522
|
*/
|
|
6423
5523
|
AppSecurityGroupManagement?: AppSecurityGroupManagement | undefined;
|
|
@@ -6442,8 +5542,7 @@ export interface DescribeEdgeDeploymentPlanRequest {
|
|
|
6442
5542
|
*/
|
|
6443
5543
|
EdgeDeploymentPlanName: string | undefined;
|
|
6444
5544
|
/**
|
|
6445
|
-
* <p>If the edge deployment plan has enough stages to require tokening, then this is the
|
|
6446
|
-
* response from the last list of stages returned.</p>
|
|
5545
|
+
* <p>If the edge deployment plan has enough stages to require tokening, then this is the response from the last list of stages returned.</p>
|
|
6447
5546
|
* @public
|
|
6448
5547
|
*/
|
|
6449
5548
|
NextToken?: string | undefined;
|
|
@@ -6557,8 +5656,7 @@ export type EdgePresetDeploymentStatus = (typeof EdgePresetDeploymentStatus)[key
|
|
|
6557
5656
|
*/
|
|
6558
5657
|
export interface EdgePresetDeploymentOutput {
|
|
6559
5658
|
/**
|
|
6560
|
-
* <p>The deployment type created by SageMaker Edge Manager. Currently only
|
|
6561
|
-
* supports Amazon Web Services IoT Greengrass Version 2 components.</p>
|
|
5659
|
+
* <p>The deployment type created by SageMaker Edge Manager. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.</p>
|
|
6562
5660
|
* @public
|
|
6563
5661
|
*/
|
|
6564
5662
|
Type: EdgePresetDeploymentType | undefined;
|
|
@@ -6608,7 +5706,7 @@ export interface DescribeEdgePackagingJobResponse {
|
|
|
6608
5706
|
*/
|
|
6609
5707
|
ModelVersion?: string | undefined;
|
|
6610
5708
|
/**
|
|
6611
|
-
* <p>The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to
|
|
5709
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact Neo.</p>
|
|
6612
5710
|
* @public
|
|
6613
5711
|
*/
|
|
6614
5712
|
RoleArn?: string | undefined;
|
|
@@ -6708,34 +5806,7 @@ export type VariantStatus = (typeof VariantStatus)[keyof typeof VariantStatus];
|
|
|
6708
5806
|
*/
|
|
6709
5807
|
export interface ProductionVariantStatus {
|
|
6710
5808
|
/**
|
|
6711
|
-
* <p>The endpoint variant status which describes the current deployment stage status or
|
|
6712
|
-
* operational status.</p>
|
|
6713
|
-
* <ul>
|
|
6714
|
-
* <li>
|
|
6715
|
-
* <p>
|
|
6716
|
-
* <code>Creating</code>: Creating inference resources for the production
|
|
6717
|
-
* variant.</p>
|
|
6718
|
-
* </li>
|
|
6719
|
-
* <li>
|
|
6720
|
-
* <p>
|
|
6721
|
-
* <code>Deleting</code>: Terminating inference resources for the production
|
|
6722
|
-
* variant.</p>
|
|
6723
|
-
* </li>
|
|
6724
|
-
* <li>
|
|
6725
|
-
* <p>
|
|
6726
|
-
* <code>Updating</code>: Updating capacity for the production variant.</p>
|
|
6727
|
-
* </li>
|
|
6728
|
-
* <li>
|
|
6729
|
-
* <p>
|
|
6730
|
-
* <code>ActivatingTraffic</code>: Turning on traffic for the production
|
|
6731
|
-
* variant.</p>
|
|
6732
|
-
* </li>
|
|
6733
|
-
* <li>
|
|
6734
|
-
* <p>
|
|
6735
|
-
* <code>Baking</code>: Waiting period to monitor the CloudWatch alarms in the
|
|
6736
|
-
* automatic rollback configuration.</p>
|
|
6737
|
-
* </li>
|
|
6738
|
-
* </ul>
|
|
5809
|
+
* <p>The endpoint variant status which describes the current deployment stage status or operational status.</p> <ul> <li> <p> <code>Creating</code>: Creating inference resources for the production variant.</p> </li> <li> <p> <code>Deleting</code>: Terminating inference resources for the production variant.</p> </li> <li> <p> <code>Updating</code>: Updating capacity for the production variant.</p> </li> <li> <p> <code>ActivatingTraffic</code>: Turning on traffic for the production variant.</p> </li> <li> <p> <code>Baking</code>: Waiting period to monitor the CloudWatch alarms in the automatic rollback configuration.</p> </li> </ul>
|
|
6739
5810
|
* @public
|
|
6740
5811
|
*/
|
|
6741
5812
|
Status: VariantStatus | undefined;
|
|
@@ -6751,11 +5822,7 @@ export interface ProductionVariantStatus {
|
|
|
6751
5822
|
StartTime?: Date | undefined;
|
|
6752
5823
|
}
|
|
6753
5824
|
/**
|
|
6754
|
-
* <p>The production variant summary for a deployment when an endpoint is creating or
|
|
6755
|
-
* updating with the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html">CreateEndpoint</a>
|
|
6756
|
-
* or <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html">UpdateEndpoint</a>
|
|
6757
|
-
* operations. Describes the <code>VariantStatus </code>, weight and capacity for a
|
|
6758
|
-
* production variant associated with an endpoint. </p>
|
|
5825
|
+
* <p>The production variant summary for a deployment when an endpoint is creating or updating with the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html">CreateEndpoint</a> or <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html">UpdateEndpoint</a> operations. Describes the <code>VariantStatus </code>, weight and capacity for a production variant associated with an endpoint. </p>
|
|
6759
5826
|
* @public
|
|
6760
5827
|
*/
|
|
6761
5828
|
export interface PendingProductionVariantSummary {
|
|
@@ -6765,9 +5832,7 @@ export interface PendingProductionVariantSummary {
|
|
|
6765
5832
|
*/
|
|
6766
5833
|
VariantName: string | undefined;
|
|
6767
5834
|
/**
|
|
6768
|
-
* <p>An array of <code>DeployedImage</code> objects that specify the Amazon EC2 Container
|
|
6769
|
-
* Registry paths of the inference images deployed on instances of this
|
|
6770
|
-
* <code>ProductionVariant</code>.</p>
|
|
5835
|
+
* <p>An array of <code>DeployedImage</code> objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this <code>ProductionVariant</code>.</p>
|
|
6771
5836
|
* @public
|
|
6772
5837
|
*/
|
|
6773
5838
|
DeployedImages?: DeployedImage[] | undefined;
|
|
@@ -6777,8 +5842,7 @@ export interface PendingProductionVariantSummary {
|
|
|
6777
5842
|
*/
|
|
6778
5843
|
CurrentWeight?: number | undefined;
|
|
6779
5844
|
/**
|
|
6780
|
-
* <p>The requested weight for the variant in this deployment, as specified in the endpoint
|
|
6781
|
-
* configuration for the endpoint. The value is taken from the request to the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html">CreateEndpointConfig</a> operation.</p>
|
|
5845
|
+
* <p>The requested weight for the variant in this deployment, as specified in the endpoint configuration for the endpoint. The value is taken from the request to the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html">CreateEndpointConfig</a> operation.</p>
|
|
6782
5846
|
* @public
|
|
6783
5847
|
*/
|
|
6784
5848
|
DesiredWeight?: number | undefined;
|
|
@@ -6788,8 +5852,7 @@ export interface PendingProductionVariantSummary {
|
|
|
6788
5852
|
*/
|
|
6789
5853
|
CurrentInstanceCount?: number | undefined;
|
|
6790
5854
|
/**
|
|
6791
|
-
* <p>The number of instances requested in this deployment, as specified in the endpoint
|
|
6792
|
-
* configuration for the endpoint. The value is taken from the request to the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html">CreateEndpointConfig</a> operation.</p>
|
|
5855
|
+
* <p>The number of instances requested in this deployment, as specified in the endpoint configuration for the endpoint. The value is taken from the request to the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html">CreateEndpointConfig</a> operation.</p>
|
|
6793
5856
|
* @public
|
|
6794
5857
|
*/
|
|
6795
5858
|
DesiredInstanceCount?: number | undefined;
|
|
@@ -6799,16 +5862,12 @@ export interface PendingProductionVariantSummary {
|
|
|
6799
5862
|
*/
|
|
6800
5863
|
InstanceType?: ProductionVariantInstanceType | undefined;
|
|
6801
5864
|
/**
|
|
6802
|
-
* <p>This parameter is no longer supported. Elastic Inference (EI) is no longer
|
|
6803
|
-
* available.</p>
|
|
6804
|
-
* <p>This parameter was used to specify the size of the EI instance to use for the
|
|
6805
|
-
* production variant.</p>
|
|
5865
|
+
* <p>This parameter is no longer supported. Elastic Inference (EI) is no longer available.</p> <p>This parameter was used to specify the size of the EI instance to use for the production variant.</p>
|
|
6806
5866
|
* @public
|
|
6807
5867
|
*/
|
|
6808
5868
|
AcceleratorType?: ProductionVariantAcceleratorType | undefined;
|
|
6809
5869
|
/**
|
|
6810
|
-
* <p>The endpoint variant status which describes the current deployment stage status or
|
|
6811
|
-
* operational status.</p>
|
|
5870
|
+
* <p>The endpoint variant status which describes the current deployment stage status or operational status.</p>
|
|
6812
5871
|
* @public
|
|
6813
5872
|
*/
|
|
6814
5873
|
VariantStatus?: ProductionVariantStatus[] | undefined;
|
|
@@ -6823,21 +5882,18 @@ export interface PendingProductionVariantSummary {
|
|
|
6823
5882
|
*/
|
|
6824
5883
|
DesiredServerlessConfig?: ProductionVariantServerlessConfig | undefined;
|
|
6825
5884
|
/**
|
|
6826
|
-
* <p>Settings that control the range in the number of instances that the endpoint provisions
|
|
6827
|
-
* as it scales up or down to accommodate traffic. </p>
|
|
5885
|
+
* <p>Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic. </p>
|
|
6828
5886
|
* @public
|
|
6829
5887
|
*/
|
|
6830
5888
|
ManagedInstanceScaling?: ProductionVariantManagedInstanceScaling | undefined;
|
|
6831
5889
|
/**
|
|
6832
|
-
* <p>Settings that control how the endpoint routes incoming traffic to the instances that the
|
|
6833
|
-
* endpoint hosts.</p>
|
|
5890
|
+
* <p>Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.</p>
|
|
6834
5891
|
* @public
|
|
6835
5892
|
*/
|
|
6836
5893
|
RoutingConfig?: ProductionVariantRoutingConfig | undefined;
|
|
6837
5894
|
}
|
|
6838
5895
|
/**
|
|
6839
|
-
* <p>The summary of an in-progress deployment when an endpoint is creating or updating with
|
|
6840
|
-
* a new endpoint configuration.</p>
|
|
5896
|
+
* <p>The summary of an in-progress deployment when an endpoint is creating or updating with a new endpoint configuration.</p>
|
|
6841
5897
|
* @public
|
|
6842
5898
|
*/
|
|
6843
5899
|
export interface PendingDeploymentSummary {
|
|
@@ -6847,8 +5903,7 @@ export interface PendingDeploymentSummary {
|
|
|
6847
5903
|
*/
|
|
6848
5904
|
EndpointConfigName: string | undefined;
|
|
6849
5905
|
/**
|
|
6850
|
-
* <p>An array of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_PendingProductionVariantSummary.html">PendingProductionVariantSummary</a> objects, one for each model hosted behind
|
|
6851
|
-
* this endpoint for the in-progress deployment.</p>
|
|
5906
|
+
* <p>An array of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_PendingProductionVariantSummary.html">PendingProductionVariantSummary</a> objects, one for each model hosted behind this endpoint for the in-progress deployment.</p>
|
|
6852
5907
|
* @public
|
|
6853
5908
|
*/
|
|
6854
5909
|
ProductionVariants?: PendingProductionVariantSummary[] | undefined;
|
|
@@ -6858,18 +5913,13 @@ export interface PendingDeploymentSummary {
|
|
|
6858
5913
|
*/
|
|
6859
5914
|
StartTime?: Date | undefined;
|
|
6860
5915
|
/**
|
|
6861
|
-
* <p>An array of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_PendingProductionVariantSummary.html">PendingProductionVariantSummary</a> objects, one for each model hosted behind
|
|
6862
|
-
* this endpoint in shadow mode with production traffic replicated from the model specified
|
|
6863
|
-
* on <code>ProductionVariants</code> for the in-progress deployment.</p>
|
|
5916
|
+
* <p>An array of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_PendingProductionVariantSummary.html">PendingProductionVariantSummary</a> objects, one for each model hosted behind this endpoint in shadow mode with production traffic replicated from the model specified on <code>ProductionVariants</code> for the in-progress deployment.</p>
|
|
6864
5917
|
* @public
|
|
6865
5918
|
*/
|
|
6866
5919
|
ShadowProductionVariants?: PendingProductionVariantSummary[] | undefined;
|
|
6867
5920
|
}
|
|
6868
5921
|
/**
|
|
6869
|
-
* <p>Describes weight and capacities for a production variant associated with an
|
|
6870
|
-
* endpoint. If you sent a request to the <code>UpdateEndpointWeightsAndCapacities</code>
|
|
6871
|
-
* API and the endpoint status is <code>Updating</code>, you get different desired and
|
|
6872
|
-
* current values. </p>
|
|
5922
|
+
* <p>Describes weight and capacities for a production variant associated with an endpoint. If you sent a request to the <code>UpdateEndpointWeightsAndCapacities</code> API and the endpoint status is <code>Updating</code>, you get different desired and current values. </p>
|
|
6873
5923
|
* @public
|
|
6874
5924
|
*/
|
|
6875
5925
|
export interface ProductionVariantSummary {
|
|
@@ -6879,8 +5929,7 @@ export interface ProductionVariantSummary {
|
|
|
6879
5929
|
*/
|
|
6880
5930
|
VariantName: string | undefined;
|
|
6881
5931
|
/**
|
|
6882
|
-
* <p>An array of <code>DeployedImage</code> objects that specify the Amazon EC2 Container Registry paths of the
|
|
6883
|
-
* inference images deployed on instances of this <code>ProductionVariant</code>.</p>
|
|
5932
|
+
* <p>An array of <code>DeployedImage</code> objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this <code>ProductionVariant</code>.</p>
|
|
6884
5933
|
* @public
|
|
6885
5934
|
*/
|
|
6886
5935
|
DeployedImages?: DeployedImage[] | undefined;
|
|
@@ -6890,8 +5939,7 @@ export interface ProductionVariantSummary {
|
|
|
6890
5939
|
*/
|
|
6891
5940
|
CurrentWeight?: number | undefined;
|
|
6892
5941
|
/**
|
|
6893
|
-
* <p>The requested weight, as specified in the
|
|
6894
|
-
* <code>UpdateEndpointWeightsAndCapacities</code> request. </p>
|
|
5942
|
+
* <p>The requested weight, as specified in the <code>UpdateEndpointWeightsAndCapacities</code> request. </p>
|
|
6895
5943
|
* @public
|
|
6896
5944
|
*/
|
|
6897
5945
|
DesiredWeight?: number | undefined;
|
|
@@ -6901,14 +5949,12 @@ export interface ProductionVariantSummary {
|
|
|
6901
5949
|
*/
|
|
6902
5950
|
CurrentInstanceCount?: number | undefined;
|
|
6903
5951
|
/**
|
|
6904
|
-
* <p>The number of instances requested in the
|
|
6905
|
-
* <code>UpdateEndpointWeightsAndCapacities</code> request. </p>
|
|
5952
|
+
* <p>The number of instances requested in the <code>UpdateEndpointWeightsAndCapacities</code> request. </p>
|
|
6906
5953
|
* @public
|
|
6907
5954
|
*/
|
|
6908
5955
|
DesiredInstanceCount?: number | undefined;
|
|
6909
5956
|
/**
|
|
6910
|
-
* <p>The endpoint variant status which describes the current deployment stage status or
|
|
6911
|
-
* operational status.</p>
|
|
5957
|
+
* <p>The endpoint variant status which describes the current deployment stage status or operational status.</p>
|
|
6912
5958
|
* @public
|
|
6913
5959
|
*/
|
|
6914
5960
|
VariantStatus?: ProductionVariantStatus[] | undefined;
|
|
@@ -6923,14 +5969,12 @@ export interface ProductionVariantSummary {
|
|
|
6923
5969
|
*/
|
|
6924
5970
|
DesiredServerlessConfig?: ProductionVariantServerlessConfig | undefined;
|
|
6925
5971
|
/**
|
|
6926
|
-
* <p>Settings that control the range in the number of instances that the endpoint provisions
|
|
6927
|
-
* as it scales up or down to accommodate traffic. </p>
|
|
5972
|
+
* <p>Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic. </p>
|
|
6928
5973
|
* @public
|
|
6929
5974
|
*/
|
|
6930
5975
|
ManagedInstanceScaling?: ProductionVariantManagedInstanceScaling | undefined;
|
|
6931
5976
|
/**
|
|
6932
|
-
* <p>Settings that control how the endpoint routes incoming traffic to the instances that the
|
|
6933
|
-
* endpoint hosts.</p>
|
|
5977
|
+
* <p>Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.</p>
|
|
6934
5978
|
* @public
|
|
6935
5979
|
*/
|
|
6936
5980
|
RoutingConfig?: ProductionVariantRoutingConfig | undefined;
|
|
@@ -6955,8 +5999,7 @@ export interface DescribeEndpointOutput {
|
|
|
6955
5999
|
*/
|
|
6956
6000
|
EndpointConfigName?: string | undefined;
|
|
6957
6001
|
/**
|
|
6958
|
-
* <p>An array of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariantSummary.html">ProductionVariantSummary</a> objects, one for each model hosted behind this
|
|
6959
|
-
* endpoint.</p>
|
|
6002
|
+
* <p>An array of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariantSummary.html">ProductionVariantSummary</a> objects, one for each model hosted behind this endpoint.</p>
|
|
6960
6003
|
* @public
|
|
6961
6004
|
*/
|
|
6962
6005
|
ProductionVariants?: ProductionVariantSummary[] | undefined;
|
|
@@ -6966,68 +6009,12 @@ export interface DescribeEndpointOutput {
|
|
|
6966
6009
|
*/
|
|
6967
6010
|
DataCaptureConfig?: DataCaptureConfigSummary | undefined;
|
|
6968
6011
|
/**
|
|
6969
|
-
* <p>The status of the endpoint.</p>
|
|
6970
|
-
* <ul>
|
|
6971
|
-
* <li>
|
|
6972
|
-
* <p>
|
|
6973
|
-
* <code>OutOfService</code>: Endpoint is not available to take incoming
|
|
6974
|
-
* requests.</p>
|
|
6975
|
-
* </li>
|
|
6976
|
-
* <li>
|
|
6977
|
-
* <p>
|
|
6978
|
-
* <code>Creating</code>: <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html">CreateEndpoint</a> is executing.</p>
|
|
6979
|
-
* </li>
|
|
6980
|
-
* <li>
|
|
6981
|
-
* <p>
|
|
6982
|
-
* <code>Updating</code>: <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html">UpdateEndpoint</a> or <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html">UpdateEndpointWeightsAndCapacities</a> is executing.</p>
|
|
6983
|
-
* </li>
|
|
6984
|
-
* <li>
|
|
6985
|
-
* <p>
|
|
6986
|
-
* <code>SystemUpdating</code>: Endpoint is undergoing maintenance and cannot be
|
|
6987
|
-
* updated or deleted or re-scaled until it has completed. This maintenance
|
|
6988
|
-
* operation does not change any customer-specified values such as VPC config, KMS
|
|
6989
|
-
* encryption, model, instance type, or instance count.</p>
|
|
6990
|
-
* </li>
|
|
6991
|
-
* <li>
|
|
6992
|
-
* <p>
|
|
6993
|
-
* <code>RollingBack</code>: Endpoint fails to scale up or down or change its
|
|
6994
|
-
* variant weight and is in the process of rolling back to its previous
|
|
6995
|
-
* configuration. Once the rollback completes, endpoint returns to an
|
|
6996
|
-
* <code>InService</code> status. This transitional status only applies to an
|
|
6997
|
-
* endpoint that has autoscaling enabled and is undergoing variant weight or
|
|
6998
|
-
* capacity changes as part of an <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html">UpdateEndpointWeightsAndCapacities</a> call or when the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html">UpdateEndpointWeightsAndCapacities</a> operation is called
|
|
6999
|
-
* explicitly.</p>
|
|
7000
|
-
* </li>
|
|
7001
|
-
* <li>
|
|
7002
|
-
* <p>
|
|
7003
|
-
* <code>InService</code>: Endpoint is available to process incoming
|
|
7004
|
-
* requests.</p>
|
|
7005
|
-
* </li>
|
|
7006
|
-
* <li>
|
|
7007
|
-
* <p>
|
|
7008
|
-
* <code>Deleting</code>: <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html">DeleteEndpoint</a> is executing.</p>
|
|
7009
|
-
* </li>
|
|
7010
|
-
* <li>
|
|
7011
|
-
* <p>
|
|
7012
|
-
* <code>Failed</code>: Endpoint could not be created, updated, or re-scaled. Use
|
|
7013
|
-
* the <code>FailureReason</code> value returned by <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html">DescribeEndpoint</a> for information about the failure. <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html">DeleteEndpoint</a> is the only operation that can be performed on a
|
|
7014
|
-
* failed endpoint.</p>
|
|
7015
|
-
* </li>
|
|
7016
|
-
* <li>
|
|
7017
|
-
* <p>
|
|
7018
|
-
* <code>UpdateRollbackFailed</code>: Both the rolling deployment and
|
|
7019
|
-
* auto-rollback failed. Your endpoint is in service with a mix of the old and new
|
|
7020
|
-
* endpoint configurations. For information about how to remedy this issue and
|
|
7021
|
-
* restore the endpoint's status to <code>InService</code>, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/deployment-guardrails-rolling.html">Rolling
|
|
7022
|
-
* Deployments</a>.</p>
|
|
7023
|
-
* </li>
|
|
7024
|
-
* </ul>
|
|
6012
|
+
* <p>The status of the endpoint.</p> <ul> <li> <p> <code>OutOfService</code>: Endpoint is not available to take incoming requests.</p> </li> <li> <p> <code>Creating</code>: <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html">CreateEndpoint</a> is executing.</p> </li> <li> <p> <code>Updating</code>: <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html">UpdateEndpoint</a> or <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html">UpdateEndpointWeightsAndCapacities</a> is executing.</p> </li> <li> <p> <code>SystemUpdating</code>: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count.</p> </li> <li> <p> <code>RollingBack</code>: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an <code>InService</code> status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html">UpdateEndpointWeightsAndCapacities</a> call or when the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html">UpdateEndpointWeightsAndCapacities</a> operation is called explicitly.</p> </li> <li> <p> <code>InService</code>: Endpoint is available to process incoming requests.</p> </li> <li> <p> <code>Deleting</code>: <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html">DeleteEndpoint</a> is executing.</p> </li> <li> <p> <code>Failed</code>: Endpoint could not be created, updated, or re-scaled. Use the <code>FailureReason</code> value returned by <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html">DescribeEndpoint</a> for information about the failure. <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html">DeleteEndpoint</a> is the only operation that can be performed on a failed endpoint.</p> </li> <li> <p> <code>UpdateRollbackFailed</code>: Both the rolling deployment and auto-rollback failed. Your endpoint is in service with a mix of the old and new endpoint configurations. For information about how to remedy this issue and restore the endpoint's status to <code>InService</code>, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/deployment-guardrails-rolling.html">Rolling Deployments</a>.</p> </li> </ul>
|
|
7025
6013
|
* @public
|
|
7026
6014
|
*/
|
|
7027
6015
|
EndpointStatus: EndpointStatus | undefined;
|
|
7028
6016
|
/**
|
|
7029
|
-
* <p>If the status of the endpoint is <code>Failed</code>, the reason why it failed.
|
|
7030
|
-
* </p>
|
|
6017
|
+
* <p>If the status of the endpoint is <code>Failed</code>, the reason why it failed. </p>
|
|
7031
6018
|
* @public
|
|
7032
6019
|
*/
|
|
7033
6020
|
FailureReason?: string | undefined;
|
|
@@ -7047,15 +6034,12 @@ export interface DescribeEndpointOutput {
|
|
|
7047
6034
|
*/
|
|
7048
6035
|
LastDeploymentConfig?: DeploymentConfig | undefined;
|
|
7049
6036
|
/**
|
|
7050
|
-
* <p>Returns the description of an endpoint configuration created using the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html">
|
|
7051
|
-
* <code>CreateEndpointConfig</code>
|
|
7052
|
-
* </a> API.</p>
|
|
6037
|
+
* <p>Returns the description of an endpoint configuration created using the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html"> <code>CreateEndpointConfig</code> </a> API.</p>
|
|
7053
6038
|
* @public
|
|
7054
6039
|
*/
|
|
7055
6040
|
AsyncInferenceConfig?: AsyncInferenceConfig | undefined;
|
|
7056
6041
|
/**
|
|
7057
|
-
* <p>Returns the summary of an in-progress deployment. This field is only returned when the
|
|
7058
|
-
* endpoint is creating or updating with a new endpoint configuration.</p>
|
|
6042
|
+
* <p>Returns the summary of an in-progress deployment. This field is only returned when the endpoint is creating or updating with a new endpoint configuration.</p>
|
|
7059
6043
|
* @public
|
|
7060
6044
|
*/
|
|
7061
6045
|
PendingDeploymentSummary?: PendingDeploymentSummary | undefined;
|
|
@@ -7065,9 +6049,7 @@ export interface DescribeEndpointOutput {
|
|
|
7065
6049
|
*/
|
|
7066
6050
|
ExplainerConfig?: ExplainerConfig | undefined;
|
|
7067
6051
|
/**
|
|
7068
|
-
* <p>An array of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariantSummary.html">ProductionVariantSummary</a> objects, one for each model that you want to host
|
|
7069
|
-
* at this endpoint in shadow mode with production traffic replicated from the model
|
|
7070
|
-
* specified on <code>ProductionVariants</code>.</p>
|
|
6052
|
+
* <p>An array of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariantSummary.html">ProductionVariantSummary</a> objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on <code>ProductionVariants</code>.</p>
|
|
7071
6053
|
* @public
|
|
7072
6054
|
*/
|
|
7073
6055
|
ShadowProductionVariants?: ProductionVariantSummary[] | undefined;
|
|
@@ -7097,8 +6079,7 @@ export interface DescribeEndpointConfigOutput {
|
|
|
7097
6079
|
*/
|
|
7098
6080
|
EndpointConfigArn: string | undefined;
|
|
7099
6081
|
/**
|
|
7100
|
-
* <p>An array of <code>ProductionVariant</code> objects, one for each model that you
|
|
7101
|
-
* want to host at this endpoint.</p>
|
|
6082
|
+
* <p>An array of <code>ProductionVariant</code> objects, one for each model that you want to host at this endpoint.</p>
|
|
7102
6083
|
* @public
|
|
7103
6084
|
*/
|
|
7104
6085
|
ProductionVariants: ProductionVariant[] | undefined;
|
|
@@ -7108,8 +6089,7 @@ export interface DescribeEndpointConfigOutput {
|
|
|
7108
6089
|
*/
|
|
7109
6090
|
DataCaptureConfig?: DataCaptureConfig | undefined;
|
|
7110
6091
|
/**
|
|
7111
|
-
* <p>Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML
|
|
7112
|
-
* storage volume attached to the instance.</p>
|
|
6092
|
+
* <p>Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.</p>
|
|
7113
6093
|
* @public
|
|
7114
6094
|
*/
|
|
7115
6095
|
KmsKeyId?: string | undefined;
|
|
@@ -7119,9 +6099,7 @@ export interface DescribeEndpointConfigOutput {
|
|
|
7119
6099
|
*/
|
|
7120
6100
|
CreationTime: Date | undefined;
|
|
7121
6101
|
/**
|
|
7122
|
-
* <p>Returns the description of an endpoint configuration created using the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html">
|
|
7123
|
-
* <code>CreateEndpointConfig</code>
|
|
7124
|
-
* </a> API.</p>
|
|
6102
|
+
* <p>Returns the description of an endpoint configuration created using the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html"> <code>CreateEndpointConfig</code> </a> API.</p>
|
|
7125
6103
|
* @public
|
|
7126
6104
|
*/
|
|
7127
6105
|
AsyncInferenceConfig?: AsyncInferenceConfig | undefined;
|
|
@@ -7131,30 +6109,22 @@ export interface DescribeEndpointConfigOutput {
|
|
|
7131
6109
|
*/
|
|
7132
6110
|
ExplainerConfig?: ExplainerConfig | undefined;
|
|
7133
6111
|
/**
|
|
7134
|
-
* <p>An array of <code>ProductionVariant</code> objects, one for each model that you want
|
|
7135
|
-
* to host at this endpoint in shadow mode with production traffic replicated from the
|
|
7136
|
-
* model specified on <code>ProductionVariants</code>.</p>
|
|
6112
|
+
* <p>An array of <code>ProductionVariant</code> objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on <code>ProductionVariants</code>.</p>
|
|
7137
6113
|
* @public
|
|
7138
6114
|
*/
|
|
7139
6115
|
ShadowProductionVariants?: ProductionVariant[] | undefined;
|
|
7140
6116
|
/**
|
|
7141
|
-
* <p>The Amazon Resource Name (ARN) of the IAM role that you assigned to the
|
|
7142
|
-
* endpoint configuration.</p>
|
|
6117
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that you assigned to the endpoint configuration.</p>
|
|
7143
6118
|
* @public
|
|
7144
6119
|
*/
|
|
7145
6120
|
ExecutionRoleArn?: string | undefined;
|
|
7146
6121
|
/**
|
|
7147
|
-
* <p>Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources
|
|
7148
|
-
* have access to. You can control access to and from your resources by configuring a VPC.
|
|
7149
|
-
* For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html">Give SageMaker Access to
|
|
7150
|
-
* Resources in your Amazon VPC</a>. </p>
|
|
6122
|
+
* <p>Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html">Give SageMaker Access to Resources in your Amazon VPC</a>. </p>
|
|
7151
6123
|
* @public
|
|
7152
6124
|
*/
|
|
7153
6125
|
VpcConfig?: VpcConfig | undefined;
|
|
7154
6126
|
/**
|
|
7155
|
-
* <p>Indicates whether all model containers deployed to the endpoint are isolated. If they
|
|
7156
|
-
* are, no inbound or outbound network calls can be made to or from the model
|
|
7157
|
-
* containers.</p>
|
|
6127
|
+
* <p>Indicates whether all model containers deployed to the endpoint are isolated. If they are, no inbound or outbound network calls can be made to or from the model containers.</p>
|
|
7158
6128
|
* @public
|
|
7159
6129
|
*/
|
|
7160
6130
|
EnableNetworkIsolation?: boolean | undefined;
|
|
@@ -7200,8 +6170,7 @@ export interface DescribeExperimentResponse {
|
|
|
7200
6170
|
*/
|
|
7201
6171
|
ExperimentArn?: string | undefined;
|
|
7202
6172
|
/**
|
|
7203
|
-
* <p>The name of the experiment as displayed. If <code>DisplayName</code> isn't specified,
|
|
7204
|
-
* <code>ExperimentName</code> is displayed.</p>
|
|
6173
|
+
* <p>The name of the experiment as displayed. If <code>DisplayName</code> isn't specified, <code>ExperimentName</code> is displayed.</p>
|
|
7205
6174
|
* @public
|
|
7206
6175
|
*/
|
|
7207
6176
|
DisplayName?: string | undefined;
|
|
@@ -7241,15 +6210,12 @@ export interface DescribeExperimentResponse {
|
|
|
7241
6210
|
*/
|
|
7242
6211
|
export interface DescribeFeatureGroupRequest {
|
|
7243
6212
|
/**
|
|
7244
|
-
* <p>The name or Amazon Resource Name (ARN) of the <code>FeatureGroup</code> you want
|
|
7245
|
-
* described. </p>
|
|
6213
|
+
* <p>The name or Amazon Resource Name (ARN) of the <code>FeatureGroup</code> you want described. </p>
|
|
7246
6214
|
* @public
|
|
7247
6215
|
*/
|
|
7248
6216
|
FeatureGroupName: string | undefined;
|
|
7249
6217
|
/**
|
|
7250
|
-
* <p>A token to resume pagination of the list of <code>Features</code>
|
|
7251
|
-
* (<code>FeatureDefinitions</code>). 2,500 <code>Features</code> are returned by
|
|
7252
|
-
* default.</p>
|
|
6218
|
+
* <p>A token to resume pagination of the list of <code>Features</code> (<code>FeatureDefinitions</code>). 2,500 <code>Features</code> are returned by default.</p>
|
|
7253
6219
|
* @public
|
|
7254
6220
|
*/
|
|
7255
6221
|
NextToken?: string | undefined;
|
|
@@ -7328,39 +6294,22 @@ export interface OfflineStoreStatus {
|
|
|
7328
6294
|
BlockedReason?: string | undefined;
|
|
7329
6295
|
}
|
|
7330
6296
|
/**
|
|
7331
|
-
* <p>Active throughput configuration of the feature group. There are two modes:
|
|
7332
|
-
* <code>ON_DEMAND</code> and <code>PROVISIONED</code>. With on-demand mode, you are
|
|
7333
|
-
* charged for data reads and writes that your application performs on your feature group. You
|
|
7334
|
-
* do not need to specify read and write throughput because Feature Store accommodates your
|
|
7335
|
-
* workloads as they ramp up and down. You can switch a feature group to on-demand only once
|
|
7336
|
-
* in a 24 hour period. With provisioned throughput mode, you specify the read and write
|
|
7337
|
-
* capacity per second that you expect your application to require, and you are billed based
|
|
7338
|
-
* on those limits. Exceeding provisioned throughput will result in your requests being
|
|
7339
|
-
* throttled. </p>
|
|
7340
|
-
* <p>Note: <code>PROVISIONED</code> throughput mode is supported only for feature groups that
|
|
7341
|
-
* are offline-only, or use the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OnlineStoreConfig.html#sagemaker-Type-OnlineStoreConfig-StorageType">
|
|
7342
|
-
* <code>Standard</code>
|
|
7343
|
-
* </a> tier online store. </p>
|
|
6297
|
+
* <p>Active throughput configuration of the feature group. There are two modes: <code>ON_DEMAND</code> and <code>PROVISIONED</code>. With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled. </p> <p>Note: <code>PROVISIONED</code> throughput mode is supported only for feature groups that are offline-only, or use the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OnlineStoreConfig.html#sagemaker-Type-OnlineStoreConfig-StorageType"> <code>Standard</code> </a> tier online store. </p>
|
|
7344
6298
|
* @public
|
|
7345
6299
|
*/
|
|
7346
6300
|
export interface ThroughputConfigDescription {
|
|
7347
6301
|
/**
|
|
7348
|
-
* <p>The mode used for your feature group throughput: <code>ON_DEMAND</code> or
|
|
7349
|
-
* <code>PROVISIONED</code>. </p>
|
|
6302
|
+
* <p>The mode used for your feature group throughput: <code>ON_DEMAND</code> or <code>PROVISIONED</code>. </p>
|
|
7350
6303
|
* @public
|
|
7351
6304
|
*/
|
|
7352
6305
|
ThroughputMode: ThroughputMode | undefined;
|
|
7353
6306
|
/**
|
|
7354
|
-
* <p> For provisioned feature groups with online store enabled, this indicates the read
|
|
7355
|
-
* throughput you are billed for and can consume without throttling. </p>
|
|
7356
|
-
* <p>This field is not applicable for on-demand feature groups. </p>
|
|
6307
|
+
* <p> For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling. </p> <p>This field is not applicable for on-demand feature groups. </p>
|
|
7357
6308
|
* @public
|
|
7358
6309
|
*/
|
|
7359
6310
|
ProvisionedReadCapacityUnits?: number | undefined;
|
|
7360
6311
|
/**
|
|
7361
|
-
* <p> For provisioned feature groups, this indicates the write throughput you are billed for
|
|
7362
|
-
* and can consume without throttling. </p>
|
|
7363
|
-
* <p>This field is not applicable for on-demand feature groups. </p>
|
|
6312
|
+
* <p> For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling. </p> <p>This field is not applicable for on-demand feature groups. </p>
|
|
7364
6313
|
* @public
|
|
7365
6314
|
*/
|
|
7366
6315
|
ProvisionedWriteCapacityUnits?: number | undefined;
|
|
@@ -7380,24 +6329,17 @@ export interface DescribeFeatureGroupResponse {
|
|
|
7380
6329
|
*/
|
|
7381
6330
|
FeatureGroupName: string | undefined;
|
|
7382
6331
|
/**
|
|
7383
|
-
* <p>The name of the <code>Feature</code> used for <code>RecordIdentifier</code>, whose value
|
|
7384
|
-
* uniquely identifies a record stored in the feature store.</p>
|
|
6332
|
+
* <p>The name of the <code>Feature</code> used for <code>RecordIdentifier</code>, whose value uniquely identifies a record stored in the feature store.</p>
|
|
7385
6333
|
* @public
|
|
7386
6334
|
*/
|
|
7387
6335
|
RecordIdentifierFeatureName: string | undefined;
|
|
7388
6336
|
/**
|
|
7389
|
-
* <p>The name of the feature that stores the <code>EventTime</code> of a Record in a
|
|
7390
|
-
* <code>FeatureGroup</code>.</p>
|
|
7391
|
-
* <p> An <code>EventTime</code> is a point in time when a new event occurs that corresponds
|
|
7392
|
-
* to the creation or update of a <code>Record</code> in a <code>FeatureGroup</code>. All
|
|
7393
|
-
* <code>Records</code> in the <code>FeatureGroup</code> have a corresponding
|
|
7394
|
-
* <code>EventTime</code>.</p>
|
|
6337
|
+
* <p>The name of the feature that stores the <code>EventTime</code> of a Record in a <code>FeatureGroup</code>.</p> <p> An <code>EventTime</code> is a point in time when a new event occurs that corresponds to the creation or update of a <code>Record</code> in a <code>FeatureGroup</code>. All <code>Records</code> in the <code>FeatureGroup</code> have a corresponding <code>EventTime</code>.</p>
|
|
7395
6338
|
* @public
|
|
7396
6339
|
*/
|
|
7397
6340
|
EventTimeFeatureName: string | undefined;
|
|
7398
6341
|
/**
|
|
7399
|
-
* <p>A list of the <code>Features</code> in the <code>FeatureGroup</code>. Each feature is
|
|
7400
|
-
* defined by a <code>FeatureName</code> and <code>FeatureType</code>.</p>
|
|
6342
|
+
* <p>A list of the <code>Features</code> in the <code>FeatureGroup</code>. Each feature is defined by a <code>FeatureName</code> and <code>FeatureType</code>.</p>
|
|
7401
6343
|
* @public
|
|
7402
6344
|
*/
|
|
7403
6345
|
FeatureDefinitions: FeatureDefinition[] | undefined;
|
|
@@ -7417,48 +6359,17 @@ export interface DescribeFeatureGroupResponse {
|
|
|
7417
6359
|
*/
|
|
7418
6360
|
OnlineStoreConfig?: OnlineStoreConfig | undefined;
|
|
7419
6361
|
/**
|
|
7420
|
-
* <p>The configuration of the offline store. It includes the following configurations:</p>
|
|
7421
|
-
* <ul>
|
|
7422
|
-
* <li>
|
|
7423
|
-
* <p>Amazon S3 location of the offline store.</p>
|
|
7424
|
-
* </li>
|
|
7425
|
-
* <li>
|
|
7426
|
-
* <p>Configuration of the Glue data catalog.</p>
|
|
7427
|
-
* </li>
|
|
7428
|
-
* <li>
|
|
7429
|
-
* <p>Table format of the offline store.</p>
|
|
7430
|
-
* </li>
|
|
7431
|
-
* <li>
|
|
7432
|
-
* <p>Option to disable the automatic creation of a Glue table for the offline
|
|
7433
|
-
* store.</p>
|
|
7434
|
-
* </li>
|
|
7435
|
-
* <li>
|
|
7436
|
-
* <p>Encryption configuration.</p>
|
|
7437
|
-
* </li>
|
|
7438
|
-
* </ul>
|
|
6362
|
+
* <p>The configuration of the offline store. It includes the following configurations:</p> <ul> <li> <p>Amazon S3 location of the offline store.</p> </li> <li> <p>Configuration of the Glue data catalog.</p> </li> <li> <p>Table format of the offline store.</p> </li> <li> <p>Option to disable the automatic creation of a Glue table for the offline store.</p> </li> <li> <p>Encryption configuration.</p> </li> </ul>
|
|
7439
6363
|
* @public
|
|
7440
6364
|
*/
|
|
7441
6365
|
OfflineStoreConfig?: OfflineStoreConfig | undefined;
|
|
7442
6366
|
/**
|
|
7443
|
-
* <p>Active throughput configuration of the feature group. There are two modes:
|
|
7444
|
-
* <code>ON_DEMAND</code> and <code>PROVISIONED</code>. With on-demand mode, you are
|
|
7445
|
-
* charged for data reads and writes that your application performs on your feature group. You
|
|
7446
|
-
* do not need to specify read and write throughput because Feature Store accommodates your
|
|
7447
|
-
* workloads as they ramp up and down. You can switch a feature group to on-demand only once
|
|
7448
|
-
* in a 24 hour period. With provisioned throughput mode, you specify the read and write
|
|
7449
|
-
* capacity per second that you expect your application to require, and you are billed based
|
|
7450
|
-
* on those limits. Exceeding provisioned throughput will result in your requests being
|
|
7451
|
-
* throttled. </p>
|
|
7452
|
-
* <p>Note: <code>PROVISIONED</code> throughput mode is supported only for feature groups that
|
|
7453
|
-
* are offline-only, or use the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OnlineStoreConfig.html#sagemaker-Type-OnlineStoreConfig-StorageType">
|
|
7454
|
-
* <code>Standard</code>
|
|
7455
|
-
* </a> tier online store. </p>
|
|
6367
|
+
* <p>Active throughput configuration of the feature group. There are two modes: <code>ON_DEMAND</code> and <code>PROVISIONED</code>. With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled. </p> <p>Note: <code>PROVISIONED</code> throughput mode is supported only for feature groups that are offline-only, or use the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OnlineStoreConfig.html#sagemaker-Type-OnlineStoreConfig-StorageType"> <code>Standard</code> </a> tier online store. </p>
|
|
7456
6368
|
* @public
|
|
7457
6369
|
*/
|
|
7458
6370
|
ThroughputConfig?: ThroughputConfigDescription | undefined;
|
|
7459
6371
|
/**
|
|
7460
|
-
* <p>The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the
|
|
7461
|
-
* OfflineStore if an OfflineStoreConfig is provided.</p>
|
|
6372
|
+
* <p>The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.</p>
|
|
7462
6373
|
* @public
|
|
7463
6374
|
*/
|
|
7464
6375
|
RoleArn?: string | undefined;
|
|
@@ -7468,10 +6379,7 @@ export interface DescribeFeatureGroupResponse {
|
|
|
7468
6379
|
*/
|
|
7469
6380
|
FeatureGroupStatus?: FeatureGroupStatus | undefined;
|
|
7470
6381
|
/**
|
|
7471
|
-
* <p>The status of the <code>OfflineStore</code>. Notifies you if replicating data into the
|
|
7472
|
-
* <code>OfflineStore</code> has failed. Returns either: <code>Active</code> or
|
|
7473
|
-
* <code>Blocked</code>
|
|
7474
|
-
* </p>
|
|
6382
|
+
* <p>The status of the <code>OfflineStore</code>. Notifies you if replicating data into the <code>OfflineStore</code> has failed. Returns either: <code>Active</code> or <code>Blocked</code> </p>
|
|
7475
6383
|
* @public
|
|
7476
6384
|
*/
|
|
7477
6385
|
OfflineStoreStatus?: OfflineStoreStatus | undefined;
|
|
@@ -7481,18 +6389,7 @@ export interface DescribeFeatureGroupResponse {
|
|
|
7481
6389
|
*/
|
|
7482
6390
|
LastUpdateStatus?: LastUpdateStatus | undefined;
|
|
7483
6391
|
/**
|
|
7484
|
-
* <p>The reason that the <code>FeatureGroup</code> failed to be replicated in the
|
|
7485
|
-
* <code>OfflineStore</code>. This is failure can occur because:</p>
|
|
7486
|
-
* <ul>
|
|
7487
|
-
* <li>
|
|
7488
|
-
* <p>The <code>FeatureGroup</code> could not be created in the
|
|
7489
|
-
* <code>OfflineStore</code>.</p>
|
|
7490
|
-
* </li>
|
|
7491
|
-
* <li>
|
|
7492
|
-
* <p>The <code>FeatureGroup</code> could not be deleted from the
|
|
7493
|
-
* <code>OfflineStore</code>.</p>
|
|
7494
|
-
* </li>
|
|
7495
|
-
* </ul>
|
|
6392
|
+
* <p>The reason that the <code>FeatureGroup</code> failed to be replicated in the <code>OfflineStore</code>. This is failure can occur because:</p> <ul> <li> <p>The <code>FeatureGroup</code> could not be created in the <code>OfflineStore</code>.</p> </li> <li> <p>The <code>FeatureGroup</code> could not be deleted from the <code>OfflineStore</code>.</p> </li> </ul>
|
|
7496
6393
|
* @public
|
|
7497
6394
|
*/
|
|
7498
6395
|
FailureReason?: string | undefined;
|
|
@@ -7502,8 +6399,7 @@ export interface DescribeFeatureGroupResponse {
|
|
|
7502
6399
|
*/
|
|
7503
6400
|
Description?: string | undefined;
|
|
7504
6401
|
/**
|
|
7505
|
-
* <p>A token to resume pagination of the list of <code>Features</code>
|
|
7506
|
-
* (<code>FeatureDefinitions</code>).</p>
|
|
6402
|
+
* <p>A token to resume pagination of the list of <code>Features</code> (<code>FeatureDefinitions</code>).</p>
|
|
7507
6403
|
* @public
|
|
7508
6404
|
*/
|
|
7509
6405
|
NextToken: string | undefined;
|
|
@@ -7518,8 +6414,7 @@ export interface DescribeFeatureGroupResponse {
|
|
|
7518
6414
|
*/
|
|
7519
6415
|
export interface DescribeFeatureMetadataRequest {
|
|
7520
6416
|
/**
|
|
7521
|
-
* <p>The name or Amazon Resource Name (ARN) of the feature group containing the
|
|
7522
|
-
* feature.</p>
|
|
6417
|
+
* <p>The name or Amazon Resource Name (ARN) of the feature group containing the feature.</p>
|
|
7523
6418
|
* @public
|
|
7524
6419
|
*/
|
|
7525
6420
|
FeatureGroupName: string | undefined;
|
|
@@ -7575,9 +6470,7 @@ export interface DescribeFeatureMetadataResponse {
|
|
|
7575
6470
|
*/
|
|
7576
6471
|
CreationTime: Date | undefined;
|
|
7577
6472
|
/**
|
|
7578
|
-
* <p>A timestamp indicating when the metadata for the feature group was modified. For
|
|
7579
|
-
* example, if you add a parameter describing the feature, the timestamp changes to reflect
|
|
7580
|
-
* the last time you </p>
|
|
6473
|
+
* <p>A timestamp indicating when the metadata for the feature group was modified. For example, if you add a parameter describing the feature, the timestamp changes to reflect the last time you </p>
|
|
7581
6474
|
* @public
|
|
7582
6475
|
*/
|
|
7583
6476
|
LastModifiedTime: Date | undefined;
|
|
@@ -7641,8 +6534,7 @@ export interface DescribeFlowDefinitionResponse {
|
|
|
7641
6534
|
*/
|
|
7642
6535
|
CreationTime: Date | undefined;
|
|
7643
6536
|
/**
|
|
7644
|
-
* <p>Container for configuring the source of human task requests. Used to specify if
|
|
7645
|
-
* Amazon Rekognition or Amazon Textract is used as an integration source.</p>
|
|
6537
|
+
* <p>Container for configuring the source of human task requests. Used to specify if Amazon Rekognition or Amazon Textract is used as an integration source.</p>
|
|
7646
6538
|
* @public
|
|
7647
6539
|
*/
|
|
7648
6540
|
HumanLoopRequestSource?: HumanLoopRequestSource | undefined;
|