@aws-sdk/client-sagemaker 3.935.0 → 3.937.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.
Files changed (63) hide show
  1. package/README.md +16 -0
  2. package/dist-cjs/index.js +333 -125
  3. package/dist-es/SageMaker.js +4 -0
  4. package/dist-es/commands/BatchRebootClusterNodesCommand.js +16 -0
  5. package/dist-es/commands/BatchReplaceClusterNodesCommand.js +16 -0
  6. package/dist-es/commands/index.js +2 -0
  7. package/dist-es/models/enums.js +43 -0
  8. package/dist-es/schemas/schemas_0.js +259 -125
  9. package/dist-types/SageMaker.d.ts +14 -0
  10. package/dist-types/SageMakerClient.d.ts +4 -2
  11. package/dist-types/commands/BatchRebootClusterNodesCommand.d.ts +102 -0
  12. package/dist-types/commands/BatchReplaceClusterNodesCommand.d.ts +102 -0
  13. package/dist-types/commands/CreateComputeQuotaCommand.d.ts +4 -0
  14. package/dist-types/commands/CreateDataQualityJobDefinitionCommand.d.ts +1 -1
  15. package/dist-types/commands/CreateDeviceFleetCommand.d.ts +1 -1
  16. package/dist-types/commands/CreateTrialComponentCommand.d.ts +1 -1
  17. package/dist-types/commands/CreateUserProfileCommand.d.ts +1 -1
  18. package/dist-types/commands/DescribeComputeQuotaCommand.d.ts +4 -0
  19. package/dist-types/commands/DescribeTrainingPlanCommand.d.ts +1 -1
  20. package/dist-types/commands/DescribeTrialComponentCommand.d.ts +2 -1
  21. package/dist-types/commands/DescribeUserProfileCommand.d.ts +1 -1
  22. package/dist-types/commands/DescribeWorkforceCommand.d.ts +1 -1
  23. package/dist-types/commands/ListClusterNodesCommand.d.ts +1 -0
  24. package/dist-types/commands/ListComputeQuotasCommand.d.ts +4 -0
  25. package/dist-types/commands/ListTrainingPlansCommand.d.ts +1 -1
  26. package/dist-types/commands/ListUltraServersByReservedCapacityCommand.d.ts +1 -1
  27. package/dist-types/commands/ListUserProfilesCommand.d.ts +1 -1
  28. package/dist-types/commands/ListWorkforcesCommand.d.ts +1 -1
  29. package/dist-types/commands/ListWorkteamsCommand.d.ts +1 -2
  30. package/dist-types/commands/SearchTrainingPlanOfferingsCommand.d.ts +2 -2
  31. package/dist-types/commands/UpdateComputeQuotaCommand.d.ts +4 -0
  32. package/dist-types/commands/index.d.ts +2 -0
  33. package/dist-types/models/enums.d.ts +67 -0
  34. package/dist-types/models/models_0.d.ts +201 -207
  35. package/dist-types/models/models_1.d.ts +208 -261
  36. package/dist-types/models/models_2.d.ts +263 -353
  37. package/dist-types/models/models_3.d.ts +354 -257
  38. package/dist-types/models/models_4.d.ts +259 -7
  39. package/dist-types/schemas/schemas_0.d.ts +15 -0
  40. package/dist-types/ts3.4/SageMaker.d.ts +34 -0
  41. package/dist-types/ts3.4/SageMakerClient.d.ts +12 -0
  42. package/dist-types/ts3.4/commands/BatchRebootClusterNodesCommand.d.ts +51 -0
  43. package/dist-types/ts3.4/commands/BatchReplaceClusterNodesCommand.d.ts +51 -0
  44. package/dist-types/ts3.4/commands/CreateDataQualityJobDefinitionCommand.d.ts +1 -1
  45. package/dist-types/ts3.4/commands/CreateDeviceFleetCommand.d.ts +1 -1
  46. package/dist-types/ts3.4/commands/CreateTrialComponentCommand.d.ts +1 -1
  47. package/dist-types/ts3.4/commands/CreateUserProfileCommand.d.ts +1 -1
  48. package/dist-types/ts3.4/commands/DescribeTrialComponentCommand.d.ts +2 -4
  49. package/dist-types/ts3.4/commands/DescribeUserProfileCommand.d.ts +1 -1
  50. package/dist-types/ts3.4/commands/DescribeWorkforceCommand.d.ts +1 -1
  51. package/dist-types/ts3.4/commands/ListUltraServersByReservedCapacityCommand.d.ts +1 -1
  52. package/dist-types/ts3.4/commands/ListUserProfilesCommand.d.ts +1 -1
  53. package/dist-types/ts3.4/commands/ListWorkforcesCommand.d.ts +1 -1
  54. package/dist-types/ts3.4/commands/ListWorkteamsCommand.d.ts +4 -2
  55. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  56. package/dist-types/ts3.4/models/enums.d.ts +49 -0
  57. package/dist-types/ts3.4/models/models_0.d.ts +51 -50
  58. package/dist-types/ts3.4/models/models_1.d.ts +53 -83
  59. package/dist-types/ts3.4/models/models_2.d.ts +80 -88
  60. package/dist-types/ts3.4/models/models_3.d.ts +89 -68
  61. package/dist-types/ts3.4/models/models_4.d.ts +73 -8
  62. package/dist-types/ts3.4/schemas/schemas_0.d.ts +15 -0
  63. package/package.json +12 -12
@@ -1,6 +1,212 @@
1
1
  import { AutomaticJsonStringConversion as __AutomaticJsonStringConversion } from "@smithy/smithy-client";
2
- import { _InstanceType, AppInstanceType, AppNetworkAccessType, AppSecurityGroupManagement, AppType, AuthMode, AutoMountHomeEFS, AwsManagedHumanLoopRequestSource, BatchStrategy, CapacityReservationPreference, CollectionType, ContentClassifier, DataDistributionType, DeviceSubsetType, DirectInternetAccess, ExecutionRoleIdentityConfig, FailureHandlingPolicy, FeatureStatus, FeatureType, FlatInvocations, HubContentType, HyperParameterScalingType, HyperParameterTuningAllocationStrategy, HyperParameterTuningJobStrategyType, HyperParameterTuningJobWarmStartType, InferenceExecutionMode, InferenceExperimentType, InputMode, IPAddressType, JobType, JoinSource, ManagedInstanceScalingStatus, MetricPublishFrequencyInSeconds, MlTools, ModelApprovalStatus, ModelCardStatus, ModelInfrastructureType, MonitoringProblemType, MonitoringType, NotebookInstanceAcceleratorType, NotebookOutputOption, OptimizationJobDeploymentInstanceType, PartnerAppAuthType, PartnerAppType, ProcessingInstanceType, ProcessingS3CompressionType, ProcessingS3DataDistributionType, ProcessingS3DataType, ProcessingS3InputMode, ProcessingS3UploadMode, Processor, ProductionVariantAcceleratorType, ProductionVariantInferenceAmiVersion, ProductionVariantInstanceType, RecommendationJobSupportedEndpointType, RecommendationJobType, RedshiftResultCompressionType, RedshiftResultFormat, RootAccess, RoutingStrategy, RStudioServerProAccessStatus, RStudioServerProUserGroup, SageMakerImageName, SharingType, SkipModelValidation, StorageType, StudioLifecycleConfigAppType, StudioWebPortal, TableFormat, TagPropagation, ThroughputMode, TrackingServerSize, TrafficType, TrainingInputMode, TrainingInstanceType, TrainingJobEarlyStoppingType, TrialComponentPrimaryStatus, TtlDurationUnit, VendorGuidance } from "./enums";
3
- import { AdditionalInferenceSpecificationDefinition, AlgorithmSpecification, AmazonQSettings, AnnotationConsolidationConfig, AppLifecycleManagement, AppSpecification, AsyncInferenceConfig, AthenaDatasetDefinition, AuthorizedUrl, AutoParameter, AutoRollbackConfig, Autotune, BatchDataCaptureConfig, BatchTransformInput, BestObjectiveNotImproving, Bias, BlueGreenUpdatePolicy, CanvasAppSettings, CapacitySize, CaptureContentTypeHeader, CaptureOption, CategoricalParameter, CategoricalParameterRange, CfnCreateTemplateProvider, Channel, CheckpointConfig, ClarifyExplainerConfig, CodeEditorAppSettings, CodeRepository, CollectionConfig, CollectionConfiguration, ContainerDefinition, ContinuousParameterRange, ConvergenceDetected, CustomImage, EdgeOutputConfig, EFSFileSystemConfig, EndpointInput, FSxLustreFileSystemConfig, HyperParameterTuningJobObjective, InferenceSpecification, MetadataProperties, MetricDefinition, MetricsSource, ModelDataSource, MonitoringConstraintsResource, MonitoringNetworkConfig, MonitoringOutputConfig, MonitoringResources, MonitoringStatisticsResource, MonitoringStoppingCondition, OutputDataConfig, ResourceConfig, ResourceSpec, S3FileSystemConfig, StoppingCondition, Tag, TransformInput, TransformJobDefinition, TransformOutput, TransformResources, VpcConfig } from "./models_0";
2
+ import { _InstanceType, AppInstanceType, AppNetworkAccessType, AppSecurityGroupManagement, AppType, AuthMode, AutoMountHomeEFS, AwsManagedHumanLoopRequestSource, BatchStrategy, CapacityReservationPreference, CollectionType, ContentClassifier, DataDistributionType, DeviceSubsetType, DirectInternetAccess, EdgePresetDeploymentType, ExecutionRoleIdentityConfig, FailureHandlingPolicy, FeatureStatus, FeatureType, FlatInvocations, HubContentType, HyperParameterScalingType, HyperParameterTuningAllocationStrategy, HyperParameterTuningJobStrategyType, HyperParameterTuningJobWarmStartType, InferenceExecutionMode, InferenceExperimentType, InputMode, IPAddressType, JobType, JoinSource, ManagedInstanceScalingStatus, MetricPublishFrequencyInSeconds, MlTools, ModelApprovalStatus, ModelCardStatus, ModelInfrastructureType, MonitoringProblemType, MonitoringType, NotebookInstanceAcceleratorType, NotebookOutputOption, OptimizationJobDeploymentInstanceType, PartnerAppAuthType, PartnerAppType, ProcessingInstanceType, ProcessingS3CompressionType, ProcessingS3DataDistributionType, ProcessingS3DataType, ProcessingS3InputMode, ProcessingS3UploadMode, Processor, ProductionVariantAcceleratorType, ProductionVariantInferenceAmiVersion, ProductionVariantInstanceType, RecommendationJobSupportedEndpointType, RecommendationJobType, RedshiftResultCompressionType, RedshiftResultFormat, RootAccess, RoutingStrategy, RStudioServerProAccessStatus, RStudioServerProUserGroup, SageMakerImageName, SharingType, SkipModelValidation, StorageType, StudioLifecycleConfigAppType, StudioWebPortal, TableFormat, TagPropagation, ThroughputMode, TrackingServerSize, TrafficType, TrainingInputMode, TrainingInstanceType, TrainingJobEarlyStoppingType, TtlDurationUnit, VendorGuidance } from "./enums";
3
+ import { AdditionalInferenceSpecificationDefinition, AlgorithmSpecification, AmazonQSettings, AnnotationConsolidationConfig, AppLifecycleManagement, AppSpecification, AsyncInferenceConfig, AthenaDatasetDefinition, AuthorizedUrl, AutoParameter, AutoRollbackConfig, Autotune, BatchDataCaptureConfig, BatchTransformInput, BestObjectiveNotImproving, Bias, BlueGreenUpdatePolicy, CanvasAppSettings, CapacitySize, CaptureContentTypeHeader, CaptureOption, CategoricalParameter, CategoricalParameterRange, CfnCreateTemplateProvider, Channel, CheckpointConfig, ClarifyExplainerConfig, CodeEditorAppSettings, CodeRepository, CollectionConfig, CollectionConfiguration, ContainerDefinition, ContinuousParameterRange, ConvergenceDetected, CustomImage, DataQualityAppSpecification, DataQualityBaselineConfig, DataQualityJobInput, EndpointInput, HyperParameterTuningJobObjective, InferenceSpecification, MetadataProperties, MetricDefinition, MetricsSource, ModelDataSource, MonitoringConstraintsResource, MonitoringOutputConfig, MonitoringResources, MonitoringStatisticsResource, OutputDataConfig, ResourceConfig, ResourceSpec, StoppingCondition, Tag, TransformInput, TransformJobDefinition, TransformOutput, TransformResources, VpcConfig } from "./models_0";
4
+ /**
5
+ * <p>The networking configuration for the monitoring job.</p>
6
+ * @public
7
+ */
8
+ export interface MonitoringNetworkConfig {
9
+ /**
10
+ * <p>Whether to encrypt all communications between the instances used for the monitoring jobs. Choose <code>True</code> to encrypt communications. Encryption provides greater security for distributed jobs, but the processing might take longer.</p>
11
+ * @public
12
+ */
13
+ EnableInterContainerTrafficEncryption?: boolean | undefined;
14
+ /**
15
+ * <p>Whether to allow inbound and outbound network calls to and from the containers used for the monitoring job.</p>
16
+ * @public
17
+ */
18
+ EnableNetworkIsolation?: boolean | undefined;
19
+ /**
20
+ * <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>
21
+ * @public
22
+ */
23
+ VpcConfig?: VpcConfig | undefined;
24
+ }
25
+ /**
26
+ * <p>A time limit for how long the monitoring job is allowed to run before stopping.</p>
27
+ * @public
28
+ */
29
+ export interface MonitoringStoppingCondition {
30
+ /**
31
+ * <p>The maximum runtime allowed in seconds.</p> <note> <p>The <code>MaxRuntimeInSeconds</code> cannot exceed the frequency of the job. For data quality and model explainability, this can be up to 3600 seconds for an hourly schedule. For model bias and model quality hourly schedules, this can be up to 1800 seconds.</p> </note>
32
+ * @public
33
+ */
34
+ MaxRuntimeInSeconds: number | undefined;
35
+ }
36
+ /**
37
+ * @public
38
+ */
39
+ export interface CreateDataQualityJobDefinitionRequest {
40
+ /**
41
+ * <p>The name for the monitoring job definition.</p>
42
+ * @public
43
+ */
44
+ JobDefinitionName: string | undefined;
45
+ /**
46
+ * <p>Configures the constraints and baselines for the monitoring job.</p>
47
+ * @public
48
+ */
49
+ DataQualityBaselineConfig?: DataQualityBaselineConfig | undefined;
50
+ /**
51
+ * <p>Specifies the container that runs the monitoring job.</p>
52
+ * @public
53
+ */
54
+ DataQualityAppSpecification: DataQualityAppSpecification | undefined;
55
+ /**
56
+ * <p>A list of inputs for the monitoring job. Currently endpoints are supported as monitoring inputs.</p>
57
+ * @public
58
+ */
59
+ DataQualityJobInput: DataQualityJobInput | undefined;
60
+ /**
61
+ * <p>The output configuration for monitoring jobs.</p>
62
+ * @public
63
+ */
64
+ DataQualityJobOutputConfig: MonitoringOutputConfig | undefined;
65
+ /**
66
+ * <p>Identifies the resources to deploy for a monitoring job.</p>
67
+ * @public
68
+ */
69
+ JobResources: MonitoringResources | undefined;
70
+ /**
71
+ * <p>Specifies networking configuration for the monitoring job.</p>
72
+ * @public
73
+ */
74
+ NetworkConfig?: MonitoringNetworkConfig | undefined;
75
+ /**
76
+ * <p>The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.</p>
77
+ * @public
78
+ */
79
+ RoleArn: string | undefined;
80
+ /**
81
+ * <p>A time limit for how long the monitoring job is allowed to run before stopping.</p>
82
+ * @public
83
+ */
84
+ StoppingCondition?: MonitoringStoppingCondition | undefined;
85
+ /**
86
+ * <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>
87
+ * @public
88
+ */
89
+ Tags?: Tag[] | undefined;
90
+ }
91
+ /**
92
+ * @public
93
+ */
94
+ export interface CreateDataQualityJobDefinitionResponse {
95
+ /**
96
+ * <p>The Amazon Resource Name (ARN) of the job definition.</p>
97
+ * @public
98
+ */
99
+ JobDefinitionArn: string | undefined;
100
+ }
101
+ /**
102
+ * <p>The output configuration.</p>
103
+ * @public
104
+ */
105
+ export interface EdgeOutputConfig {
106
+ /**
107
+ * <p>The Amazon Simple Storage (S3) bucker URI.</p>
108
+ * @public
109
+ */
110
+ S3OutputLocation: string | undefined;
111
+ /**
112
+ * <p>The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account.</p>
113
+ * @public
114
+ */
115
+ KmsKeyId?: string | undefined;
116
+ /**
117
+ * <p>The deployment type SageMaker Edge Manager will create. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.</p>
118
+ * @public
119
+ */
120
+ PresetDeploymentType?: EdgePresetDeploymentType | undefined;
121
+ /**
122
+ * <p>The configuration used to create deployment artifacts. Specify configuration options with a JSON string. The available configuration options for each type are:</p> <ul> <li> <p> <code>ComponentName</code> (optional) - Name of the GreenGrass V2 component. If not specified, the default name generated consists of "SagemakerEdgeManager" and the name of your SageMaker Edge Manager packaging job.</p> </li> <li> <p> <code>ComponentDescription</code> (optional) - Description of the component.</p> </li> <li> <p> <code>ComponentVersion</code> (optional) - The version of the component.</p> <note> <p>Amazon Web Services IoT Greengrass uses semantic versions for components. Semantic versions follow a<i> major.minor.patch</i> number system. For example, version 1.0.0 represents the first major release for a component. For more information, see the <a href="https://semver.org/">semantic version specification</a>.</p> </note> </li> <li> <p> <code>PlatformOS</code> (optional) - The name of the operating system for the platform. Supported platforms include Windows and Linux.</p> </li> <li> <p> <code>PlatformArchitecture</code> (optional) - The processor architecture for the platform. </p> <p>Supported architectures Windows include: Windows32_x86, Windows64_x64.</p> <p>Supported architectures for Linux include: Linux x86_64, Linux ARMV8.</p> </li> </ul>
123
+ * @public
124
+ */
125
+ PresetDeploymentConfig?: string | undefined;
126
+ }
127
+ /**
128
+ * @public
129
+ */
130
+ export interface CreateDeviceFleetRequest {
131
+ /**
132
+ * <p>The name of the fleet that the device belongs to.</p>
133
+ * @public
134
+ */
135
+ DeviceFleetName: string | undefined;
136
+ /**
137
+ * <p>The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).</p>
138
+ * @public
139
+ */
140
+ RoleArn?: string | undefined;
141
+ /**
142
+ * <p>A description of the fleet.</p>
143
+ * @public
144
+ */
145
+ Description?: string | undefined;
146
+ /**
147
+ * <p>The output configuration for storing sample data collected by the fleet.</p>
148
+ * @public
149
+ */
150
+ OutputConfig: EdgeOutputConfig | undefined;
151
+ /**
152
+ * <p>Creates tags for the specified fleet.</p>
153
+ * @public
154
+ */
155
+ Tags?: Tag[] | undefined;
156
+ /**
157
+ * <p>Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. The name of the role alias generated will match this pattern: "SageMakerEdge-\{DeviceFleetName\}".</p> <p>For example, if your device fleet is called "demo-fleet", the name of the role alias will be "SageMakerEdge-demo-fleet".</p>
158
+ * @public
159
+ */
160
+ EnableIotRoleAlias?: boolean | undefined;
161
+ }
162
+ /**
163
+ * <p>The settings for assigning a custom Amazon EFS file system to a user profile or space for an Amazon SageMaker AI Domain.</p>
164
+ * @public
165
+ */
166
+ export interface EFSFileSystemConfig {
167
+ /**
168
+ * <p>The ID of your Amazon EFS file system.</p>
169
+ * @public
170
+ */
171
+ FileSystemId: string | undefined;
172
+ /**
173
+ * <p>The path to the file system directory that is accessible in Amazon SageMaker AI Studio. Permitted users can access only this directory and below.</p>
174
+ * @public
175
+ */
176
+ FileSystemPath?: string | undefined;
177
+ }
178
+ /**
179
+ * <p>The settings for assigning a custom Amazon FSx for Lustre file system to a user profile or space for an Amazon SageMaker Domain.</p>
180
+ * @public
181
+ */
182
+ export interface FSxLustreFileSystemConfig {
183
+ /**
184
+ * <p>The globally unique, 17-digit, ID of the file system, assigned by Amazon FSx for Lustre.</p>
185
+ * @public
186
+ */
187
+ FileSystemId: string | undefined;
188
+ /**
189
+ * <p>The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted users can access only this directory and below.</p>
190
+ * @public
191
+ */
192
+ FileSystemPath?: string | undefined;
193
+ }
194
+ /**
195
+ * <p>Configuration for the custom Amazon S3 file system.</p>
196
+ * @public
197
+ */
198
+ export interface S3FileSystemConfig {
199
+ /**
200
+ * <p>The file system path where the Amazon S3 storage location will be mounted within the Amazon SageMaker Studio environment.</p>
201
+ * @public
202
+ */
203
+ MountPath?: string | undefined;
204
+ /**
205
+ * <p>The Amazon S3 URI of the S3 file system configuration.</p>
206
+ * @public
207
+ */
208
+ S3Uri: string | undefined;
209
+ }
4
210
  /**
5
211
  * <p>The settings for assigning a custom file system 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>
6
212
  * @public
@@ -6866,262 +7072,3 @@ export interface TrialComponentArtifact {
6866
7072
  */
6867
7073
  Value: string | undefined;
6868
7074
  }
6869
- /**
6870
- * <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>
6871
- * @public
6872
- */
6873
- export type TrialComponentParameterValue = TrialComponentParameterValue.NumberValueMember | TrialComponentParameterValue.StringValueMember | TrialComponentParameterValue.$UnknownMember;
6874
- /**
6875
- * @public
6876
- */
6877
- export declare namespace TrialComponentParameterValue {
6878
- /**
6879
- * <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>
6880
- * @public
6881
- */
6882
- interface StringValueMember {
6883
- StringValue: string;
6884
- NumberValue?: never;
6885
- $unknown?: never;
6886
- }
6887
- /**
6888
- * <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>
6889
- * @public
6890
- */
6891
- interface NumberValueMember {
6892
- StringValue?: never;
6893
- NumberValue: number;
6894
- $unknown?: never;
6895
- }
6896
- /**
6897
- * @public
6898
- */
6899
- interface $UnknownMember {
6900
- StringValue?: never;
6901
- NumberValue?: never;
6902
- $unknown: [string, any];
6903
- }
6904
- /**
6905
- * @deprecated unused in schema-serde mode.
6906
- *
6907
- */
6908
- interface Visitor<T> {
6909
- StringValue: (value: string) => T;
6910
- NumberValue: (value: number) => T;
6911
- _: (name: string, value: any) => T;
6912
- }
6913
- }
6914
- /**
6915
- * <p>The status of the trial component.</p>
6916
- * @public
6917
- */
6918
- export interface TrialComponentStatus {
6919
- /**
6920
- * <p>The status of the trial component.</p>
6921
- * @public
6922
- */
6923
- PrimaryStatus?: TrialComponentPrimaryStatus | undefined;
6924
- /**
6925
- * <p>If the component failed, a message describing why.</p>
6926
- * @public
6927
- */
6928
- Message?: string | undefined;
6929
- }
6930
- /**
6931
- * @public
6932
- */
6933
- export interface CreateTrialComponentRequest {
6934
- /**
6935
- * <p>The name of the component. The name must be unique in your Amazon Web Services account and is not case-sensitive.</p>
6936
- * @public
6937
- */
6938
- TrialComponentName: string | undefined;
6939
- /**
6940
- * <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>
6941
- * @public
6942
- */
6943
- DisplayName?: string | undefined;
6944
- /**
6945
- * <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>
6946
- * @public
6947
- */
6948
- Status?: TrialComponentStatus | undefined;
6949
- /**
6950
- * <p>When the component started.</p>
6951
- * @public
6952
- */
6953
- StartTime?: Date | undefined;
6954
- /**
6955
- * <p>When the component ended.</p>
6956
- * @public
6957
- */
6958
- EndTime?: Date | undefined;
6959
- /**
6960
- * <p>The hyperparameters for the component.</p>
6961
- * @public
6962
- */
6963
- Parameters?: Record<string, TrialComponentParameterValue> | undefined;
6964
- /**
6965
- * <p>The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.</p>
6966
- * @public
6967
- */
6968
- InputArtifacts?: Record<string, TrialComponentArtifact> | undefined;
6969
- /**
6970
- * <p>The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.</p>
6971
- * @public
6972
- */
6973
- OutputArtifacts?: Record<string, TrialComponentArtifact> | undefined;
6974
- /**
6975
- * <p>Metadata properties of the tracking entity, trial, or trial component.</p>
6976
- * @public
6977
- */
6978
- MetadataProperties?: MetadataProperties | undefined;
6979
- /**
6980
- * <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>
6981
- * @public
6982
- */
6983
- Tags?: Tag[] | undefined;
6984
- }
6985
- /**
6986
- * @public
6987
- */
6988
- export interface CreateTrialComponentResponse {
6989
- /**
6990
- * <p>The Amazon Resource Name (ARN) of the trial component.</p>
6991
- * @public
6992
- */
6993
- TrialComponentArn?: string | undefined;
6994
- }
6995
- /**
6996
- * @public
6997
- */
6998
- export interface CreateUserProfileRequest {
6999
- /**
7000
- * <p>The ID of the associated Domain.</p>
7001
- * @public
7002
- */
7003
- DomainId: string | undefined;
7004
- /**
7005
- * <p>A name for the UserProfile. This value is not case sensitive.</p>
7006
- * @public
7007
- */
7008
- UserProfileName: string | undefined;
7009
- /**
7010
- * <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>
7011
- * @public
7012
- */
7013
- SingleSignOnUserIdentifier?: string | undefined;
7014
- /**
7015
- * <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>
7016
- * @public
7017
- */
7018
- SingleSignOnUserValue?: string | undefined;
7019
- /**
7020
- * <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>
7021
- * @public
7022
- */
7023
- Tags?: Tag[] | undefined;
7024
- /**
7025
- * <p>A collection of settings.</p>
7026
- * @public
7027
- */
7028
- UserSettings?: UserSettings | undefined;
7029
- }
7030
- /**
7031
- * @public
7032
- */
7033
- export interface CreateUserProfileResponse {
7034
- /**
7035
- * <p>The user profile Amazon Resource Name (ARN).</p>
7036
- * @public
7037
- */
7038
- UserProfileArn?: string | undefined;
7039
- }
7040
- /**
7041
- * <p>Use this parameter to configure your OIDC Identity Provider (IdP).</p>
7042
- * @public
7043
- */
7044
- export interface OidcConfig {
7045
- /**
7046
- * <p>The OIDC IdP client ID used to configure your private workforce.</p>
7047
- * @public
7048
- */
7049
- ClientId: string | undefined;
7050
- /**
7051
- * <p>The OIDC IdP client secret used to configure your private workforce.</p>
7052
- * @public
7053
- */
7054
- ClientSecret: string | undefined;
7055
- /**
7056
- * <p>The OIDC IdP issuer used to configure your private workforce.</p>
7057
- * @public
7058
- */
7059
- Issuer: string | undefined;
7060
- /**
7061
- * <p>The OIDC IdP authorization endpoint used to configure your private workforce.</p>
7062
- * @public
7063
- */
7064
- AuthorizationEndpoint: string | undefined;
7065
- /**
7066
- * <p>The OIDC IdP token endpoint used to configure your private workforce.</p>
7067
- * @public
7068
- */
7069
- TokenEndpoint: string | undefined;
7070
- /**
7071
- * <p>The OIDC IdP user information endpoint used to configure your private workforce.</p>
7072
- * @public
7073
- */
7074
- UserInfoEndpoint: string | undefined;
7075
- /**
7076
- * <p>The OIDC IdP logout endpoint used to configure your private workforce.</p>
7077
- * @public
7078
- */
7079
- LogoutEndpoint: string | undefined;
7080
- /**
7081
- * <p>The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.</p>
7082
- * @public
7083
- */
7084
- JwksUri: string | undefined;
7085
- /**
7086
- * <p>An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.</p>
7087
- * @public
7088
- */
7089
- Scope?: string | undefined;
7090
- /**
7091
- * <p>A string to string map of identifiers specific to the custom identity provider (IdP) being used.</p>
7092
- * @public
7093
- */
7094
- AuthenticationRequestExtraParams?: Record<string, string> | undefined;
7095
- }
7096
- /**
7097
- * <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>
7098
- * @public
7099
- */
7100
- export interface SourceIpConfig {
7101
- /**
7102
- * <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>
7103
- * @public
7104
- */
7105
- Cidrs: string[] | undefined;
7106
- }
7107
- /**
7108
- * <p>The VPC object you use to create or update a workforce.</p>
7109
- * @public
7110
- */
7111
- export interface WorkforceVpcConfigRequest {
7112
- /**
7113
- * <p>The ID of the VPC that the workforce uses for communication.</p>
7114
- * @public
7115
- */
7116
- VpcId?: string | undefined;
7117
- /**
7118
- * <p>The VPC security group IDs, in the form <code>sg-xxxxxxxx</code>. The security groups must be for the same VPC as specified in the subnet.</p>
7119
- * @public
7120
- */
7121
- SecurityGroupIds?: string[] | undefined;
7122
- /**
7123
- * <p>The ID of the subnets in the VPC that you want to connect.</p>
7124
- * @public
7125
- */
7126
- Subnets?: string[] | undefined;
7127
- }