@aws-sdk/client-sagemaker 3.462.0 → 3.464.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/dist-cjs/models/models_0.js +15 -13
- package/dist-cjs/models/models_1.js +23 -22
- package/dist-cjs/models/models_2.js +22 -45
- package/dist-cjs/models/models_3.js +46 -22
- package/dist-cjs/models/models_4.js +21 -1
- package/dist-cjs/protocols/Aws_json1_1.js +180 -2
- package/dist-es/models/models_0.js +14 -12
- package/dist-es/models/models_1.js +22 -21
- package/dist-es/models/models_2.js +21 -44
- package/dist-es/models/models_3.js +44 -20
- package/dist-es/models/models_4.js +20 -0
- package/dist-es/protocols/Aws_json1_1.js +179 -1
- package/dist-types/commands/CreateAppCommand.d.ts +1 -1
- package/dist-types/commands/CreateAppImageConfigCommand.d.ts +13 -0
- package/dist-types/commands/CreateCompilationJobCommand.d.ts +2 -1
- package/dist-types/commands/CreateContextCommand.d.ts +1 -1
- package/dist-types/commands/CreateDomainCommand.d.ts +50 -10
- package/dist-types/commands/CreateSpaceCommand.d.ts +43 -0
- package/dist-types/commands/CreateStudioLifecycleConfigCommand.d.ts +1 -1
- package/dist-types/commands/CreateTrainingJobCommand.d.ts +1 -1
- package/dist-types/commands/CreateTransformJobCommand.d.ts +1 -1
- package/dist-types/commands/CreateTrialCommand.d.ts +1 -1
- package/dist-types/commands/CreateTrialComponentCommand.d.ts +1 -1
- package/dist-types/commands/CreateUserProfileCommand.d.ts +49 -2
- package/dist-types/commands/DeleteAppCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAppCommand.d.ts +2 -2
- package/dist-types/commands/DescribeAppImageConfigCommand.d.ts +13 -0
- package/dist-types/commands/DescribeDomainCommand.d.ts +50 -10
- package/dist-types/commands/DescribeSpaceCommand.d.ts +43 -0
- package/dist-types/commands/DescribeStudioLifecycleConfigCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTrainingJobCommand.d.ts +2 -1
- package/dist-types/commands/DescribeTransformJobCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTrialCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTrialComponentCommand.d.ts +1 -1
- package/dist-types/commands/DescribeUserProfileCommand.d.ts +49 -2
- package/dist-types/commands/ListAppImageConfigsCommand.d.ts +13 -0
- package/dist-types/commands/ListAppsCommand.d.ts +8 -1
- package/dist-types/commands/ListPipelineExecutionStepsCommand.d.ts +2 -1
- package/dist-types/commands/ListPipelineParametersForExecutionCommand.d.ts +1 -1
- package/dist-types/commands/ListPipelinesCommand.d.ts +1 -1
- package/dist-types/commands/ListProcessingJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListProjectsCommand.d.ts +1 -1
- package/dist-types/commands/ListSpacesCommand.d.ts +15 -0
- package/dist-types/commands/ListStudioLifecycleConfigsCommand.d.ts +2 -2
- package/dist-types/commands/UpdateAppImageConfigCommand.d.ts +13 -0
- package/dist-types/commands/UpdateDomainCommand.d.ts +49 -9
- package/dist-types/commands/UpdateSpaceCommand.d.ts +37 -0
- package/dist-types/commands/UpdateUserProfileCommand.d.ts +48 -0
- package/dist-types/models/models_0.d.ts +184 -176
- package/dist-types/models/models_1.d.ts +383 -796
- package/dist-types/models/models_2.d.ts +4794 -5178
- package/dist-types/models/models_3.d.ts +5376 -4691
- package/dist-types/models/models_4.d.ts +598 -13
- package/dist-types/ts3.4/commands/CreateCompilationJobCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/CreateContextCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateTrainingJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateTransformJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateTrialCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateTrialComponentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateUserProfileCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/DescribeTrainingJobCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/DescribeTransformJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeTrialCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeTrialComponentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeUserProfileCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/ListPipelineExecutionStepsCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/ListPipelineParametersForExecutionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPipelinesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListProcessingJobsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListProjectsCommand.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +68 -65
- package/dist-types/ts3.4/models/models_1.d.ts +116 -160
- package/dist-types/ts3.4/models/models_2.d.ts +162 -203
- package/dist-types/ts3.4/models/models_3.d.ts +227 -130
- package/dist-types/ts3.4/models/models_4.d.ts +165 -17
- package/package.json +1 -1
|
@@ -1,5 +1,68 @@
|
|
|
1
1
|
import { LazyJsonString as __LazyJsonString } from "@smithy/smithy-client";
|
|
2
|
-
import { AdditionalInferenceSpecificationDefinition,
|
|
2
|
+
import { AdditionalInferenceSpecificationDefinition, AnnotationConsolidationConfig, AppNetworkAccessType, AppSecurityGroupManagement, AppSpecification, AppType, AsyncInferenceConfig, AthenaDatasetDefinition, AuthMode, AutoParameter, AutoRollbackConfig, Autotune, AwsManagedHumanLoopRequestSource, BatchTransformInput, BestObjectiveNotImproving, Bias, BlueGreenUpdatePolicy, CanvasAppSettings, CapacitySize, CaptureContentTypeHeader, CaptureOption, CategoricalParameter, CategoricalParameterRange, Channel, CheckpointConfig, ClarifyExplainerConfig, CodeEditorAppSettings, CodeRepository, CollectionConfig, CollectionConfiguration, CollectionType, ContainerDefinition, ContentClassifier, ContextSource, ContinuousParameterRange, ConvergenceDetected, HyperParameterScalingType, HyperParameterTuningJobObjective, InferenceSpecification, MetadataProperties, MetricDefinition, MetricsSource, ModelApprovalStatus, OutputDataConfig, ProcessingS3DataDistributionType, ProcessingS3InputMode, ProductionVariantInstanceType, ResourceConfig, ResourceSpec, StoppingCondition, Tag, TrainingInputMode, TrainingInstanceType, TransformJobDefinition, VpcConfig } from "./models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export interface CreateCompilationJobResponse {
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
* <p>If the action is successful, the service sends back an HTTP 200 response. Amazon SageMaker returns
|
|
10
|
+
* the following data in JSON format:</p>
|
|
11
|
+
* <ul>
|
|
12
|
+
* <li>
|
|
13
|
+
* <p>
|
|
14
|
+
* <code>CompilationJobArn</code>: The Amazon Resource Name (ARN) of the compiled
|
|
15
|
+
* job.</p>
|
|
16
|
+
* </li>
|
|
17
|
+
* </ul>
|
|
18
|
+
*/
|
|
19
|
+
CompilationJobArn: string | undefined;
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* @public
|
|
23
|
+
*/
|
|
24
|
+
export interface CreateContextRequest {
|
|
25
|
+
/**
|
|
26
|
+
* @public
|
|
27
|
+
* <p>The name of the context. Must be unique to your account in an Amazon Web Services Region.</p>
|
|
28
|
+
*/
|
|
29
|
+
ContextName: string | undefined;
|
|
30
|
+
/**
|
|
31
|
+
* @public
|
|
32
|
+
* <p>The source type, ID, and URI.</p>
|
|
33
|
+
*/
|
|
34
|
+
Source: ContextSource | undefined;
|
|
35
|
+
/**
|
|
36
|
+
* @public
|
|
37
|
+
* <p>The context type.</p>
|
|
38
|
+
*/
|
|
39
|
+
ContextType: string | undefined;
|
|
40
|
+
/**
|
|
41
|
+
* @public
|
|
42
|
+
* <p>The description of the context.</p>
|
|
43
|
+
*/
|
|
44
|
+
Description?: string;
|
|
45
|
+
/**
|
|
46
|
+
* @public
|
|
47
|
+
* <p>A list of properties to add to the context.</p>
|
|
48
|
+
*/
|
|
49
|
+
Properties?: Record<string, string>;
|
|
50
|
+
/**
|
|
51
|
+
* @public
|
|
52
|
+
* <p>A list of tags to apply to the context.</p>
|
|
53
|
+
*/
|
|
54
|
+
Tags?: Tag[];
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* @public
|
|
58
|
+
*/
|
|
59
|
+
export interface CreateContextResponse {
|
|
60
|
+
/**
|
|
61
|
+
* @public
|
|
62
|
+
* <p>The Amazon Resource Name (ARN) of the context.</p>
|
|
63
|
+
*/
|
|
64
|
+
ContextArn?: string;
|
|
65
|
+
}
|
|
3
66
|
/**
|
|
4
67
|
* @public
|
|
5
68
|
* <p>Information about the container that a data quality monitoring job runs.</p>
|
|
@@ -659,6 +722,98 @@ export interface DefaultSpaceSettings {
|
|
|
659
722
|
*/
|
|
660
723
|
KernelGatewayAppSettings?: KernelGatewayAppSettings;
|
|
661
724
|
}
|
|
725
|
+
/**
|
|
726
|
+
* @public
|
|
727
|
+
* <p>The settings for assigning a custom Amazon EFS file system to a user profile
|
|
728
|
+
* or space for an Amazon SageMaker Domain.</p>
|
|
729
|
+
*/
|
|
730
|
+
export interface EFSFileSystemConfig {
|
|
731
|
+
/**
|
|
732
|
+
* @public
|
|
733
|
+
* <p>The ID of your Amazon EFS file system.</p>
|
|
734
|
+
*/
|
|
735
|
+
FileSystemId: string | undefined;
|
|
736
|
+
/**
|
|
737
|
+
* @public
|
|
738
|
+
* <p>The path to the file system directory that is accessible in Amazon SageMaker
|
|
739
|
+
* Studio. Permitted users can access only this directory and below.</p>
|
|
740
|
+
*/
|
|
741
|
+
FileSystemPath?: string;
|
|
742
|
+
}
|
|
743
|
+
/**
|
|
744
|
+
* @public
|
|
745
|
+
* <p>The settings for assigning a custom file system to a user profile or space for an
|
|
746
|
+
* Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker Studio.</p>
|
|
747
|
+
*/
|
|
748
|
+
export type CustomFileSystemConfig = CustomFileSystemConfig.EFSFileSystemConfigMember | CustomFileSystemConfig.$UnknownMember;
|
|
749
|
+
/**
|
|
750
|
+
* @public
|
|
751
|
+
*/
|
|
752
|
+
export declare namespace CustomFileSystemConfig {
|
|
753
|
+
/**
|
|
754
|
+
* @public
|
|
755
|
+
* <p>The settings for a custom Amazon EFS file system.</p>
|
|
756
|
+
*/
|
|
757
|
+
interface EFSFileSystemConfigMember {
|
|
758
|
+
EFSFileSystemConfig: EFSFileSystemConfig;
|
|
759
|
+
$unknown?: never;
|
|
760
|
+
}
|
|
761
|
+
/**
|
|
762
|
+
* @public
|
|
763
|
+
*/
|
|
764
|
+
interface $UnknownMember {
|
|
765
|
+
EFSFileSystemConfig?: never;
|
|
766
|
+
$unknown: [string, any];
|
|
767
|
+
}
|
|
768
|
+
interface Visitor<T> {
|
|
769
|
+
EFSFileSystemConfig: (value: EFSFileSystemConfig) => T;
|
|
770
|
+
_: (name: string, value: any) => T;
|
|
771
|
+
}
|
|
772
|
+
const visit: <T>(value: CustomFileSystemConfig, visitor: Visitor<T>) => T;
|
|
773
|
+
}
|
|
774
|
+
/**
|
|
775
|
+
* @public
|
|
776
|
+
* <p>Details about the POSIX identity that is used for file system operations.</p>
|
|
777
|
+
*/
|
|
778
|
+
export interface CustomPosixUserConfig {
|
|
779
|
+
/**
|
|
780
|
+
* @public
|
|
781
|
+
* <p>The POSIX user ID.</p>
|
|
782
|
+
*/
|
|
783
|
+
Uid: number | undefined;
|
|
784
|
+
/**
|
|
785
|
+
* @public
|
|
786
|
+
* <p>The POSIX group ID.</p>
|
|
787
|
+
*/
|
|
788
|
+
Gid: number | undefined;
|
|
789
|
+
}
|
|
790
|
+
/**
|
|
791
|
+
* @public
|
|
792
|
+
* <p>The settings for the JupyterLab application.</p>
|
|
793
|
+
*/
|
|
794
|
+
export interface JupyterLabAppSettings {
|
|
795
|
+
/**
|
|
796
|
+
* @public
|
|
797
|
+
* <p>Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that
|
|
798
|
+
* the version runs on.</p>
|
|
799
|
+
*/
|
|
800
|
+
DefaultResourceSpec?: ResourceSpec;
|
|
801
|
+
/**
|
|
802
|
+
* @public
|
|
803
|
+
* <p>A list of custom SageMaker images that are configured to run as a JupyterLab app.</p>
|
|
804
|
+
*/
|
|
805
|
+
CustomImages?: CustomImage[];
|
|
806
|
+
/**
|
|
807
|
+
* @public
|
|
808
|
+
* <p>The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. To remove a lifecycle config, you must set <code>LifecycleConfigArns</code> to an empty list.</p>
|
|
809
|
+
*/
|
|
810
|
+
LifecycleConfigArns?: string[];
|
|
811
|
+
/**
|
|
812
|
+
* @public
|
|
813
|
+
* <p>A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.</p>
|
|
814
|
+
*/
|
|
815
|
+
CodeRepositories?: CodeRepository[];
|
|
816
|
+
}
|
|
662
817
|
/**
|
|
663
818
|
* @public
|
|
664
819
|
* <p>A collection of settings that apply to an <code>RSessionGateway</code> app.</p>
|
|
@@ -760,6 +915,33 @@ export interface SharingSettings {
|
|
|
760
915
|
*/
|
|
761
916
|
S3KmsKeyId?: string;
|
|
762
917
|
}
|
|
918
|
+
/**
|
|
919
|
+
* @public
|
|
920
|
+
* <p>A collection of default EBS storage settings that applies to private spaces created within a domain or user profile.</p>
|
|
921
|
+
*/
|
|
922
|
+
export interface DefaultEbsStorageSettings {
|
|
923
|
+
/**
|
|
924
|
+
* @public
|
|
925
|
+
* <p>The default size of the EBS storage volume for a private space.</p>
|
|
926
|
+
*/
|
|
927
|
+
DefaultEbsVolumeSizeInGb: number | undefined;
|
|
928
|
+
/**
|
|
929
|
+
* @public
|
|
930
|
+
* <p>The maximum size of the EBS storage volume for a private space.</p>
|
|
931
|
+
*/
|
|
932
|
+
MaximumEbsVolumeSizeInGb: number | undefined;
|
|
933
|
+
}
|
|
934
|
+
/**
|
|
935
|
+
* @public
|
|
936
|
+
* <p>The default storage settings for a private space.</p>
|
|
937
|
+
*/
|
|
938
|
+
export interface DefaultSpaceStorageSettings {
|
|
939
|
+
/**
|
|
940
|
+
* @public
|
|
941
|
+
* <p>The default EBS storage settings for a private space.</p>
|
|
942
|
+
*/
|
|
943
|
+
DefaultEbsStorageSettings?: DefaultEbsStorageSettings;
|
|
944
|
+
}
|
|
763
945
|
/**
|
|
764
946
|
* @public
|
|
765
947
|
* @enum
|
|
@@ -846,6 +1028,21 @@ export interface UserSettings {
|
|
|
846
1028
|
* <p>The Canvas app settings.</p>
|
|
847
1029
|
*/
|
|
848
1030
|
CanvasAppSettings?: CanvasAppSettings;
|
|
1031
|
+
/**
|
|
1032
|
+
* @public
|
|
1033
|
+
* <p>The settings for the JupyterLab application.</p>
|
|
1034
|
+
*/
|
|
1035
|
+
JupyterLabAppSettings?: JupyterLabAppSettings;
|
|
1036
|
+
/**
|
|
1037
|
+
* @public
|
|
1038
|
+
* <p>The Code Editor application settings.</p>
|
|
1039
|
+
*/
|
|
1040
|
+
CodeEditorAppSettings?: CodeEditorAppSettings;
|
|
1041
|
+
/**
|
|
1042
|
+
* @public
|
|
1043
|
+
* <p>The storage settings for a private space.</p>
|
|
1044
|
+
*/
|
|
1045
|
+
SpaceStorageSettings?: DefaultSpaceStorageSettings;
|
|
849
1046
|
/**
|
|
850
1047
|
* @public
|
|
851
1048
|
* <p>The default experience that the user is directed to when accessing the domain. The supported values are:</p>
|
|
@@ -866,6 +1063,17 @@ export interface UserSettings {
|
|
|
866
1063
|
* <p>Whether the user can access Studio. If this value is set to <code>DISABLED</code>, the user cannot access Studio, even if that is the default experience for the domain.</p>
|
|
867
1064
|
*/
|
|
868
1065
|
StudioWebPortal?: StudioWebPortal;
|
|
1066
|
+
/**
|
|
1067
|
+
* @public
|
|
1068
|
+
* <p>Details about the POSIX identity that is used for file system operations.</p>
|
|
1069
|
+
*/
|
|
1070
|
+
CustomPosixUserConfig?: CustomPosixUserConfig;
|
|
1071
|
+
/**
|
|
1072
|
+
* @public
|
|
1073
|
+
* <p>The settings for assigning a custom file system to a user profile. Permitted users can
|
|
1074
|
+
* access this file system in Amazon SageMaker Studio.</p>
|
|
1075
|
+
*/
|
|
1076
|
+
CustomFileSystemConfigs?: CustomFileSystemConfig[];
|
|
869
1077
|
}
|
|
870
1078
|
/**
|
|
871
1079
|
* @public
|
|
@@ -10135,6 +10343,112 @@ export interface CreateProjectOutput {
|
|
|
10135
10343
|
*/
|
|
10136
10344
|
ProjectId: string | undefined;
|
|
10137
10345
|
}
|
|
10346
|
+
/**
|
|
10347
|
+
* @public
|
|
10348
|
+
* <p>The collection of ownership settings for a space.</p>
|
|
10349
|
+
*/
|
|
10350
|
+
export interface OwnershipSettings {
|
|
10351
|
+
/**
|
|
10352
|
+
* @public
|
|
10353
|
+
* <p>The user profile who is the owner of the private space.</p>
|
|
10354
|
+
*/
|
|
10355
|
+
OwnerUserProfileName: string | undefined;
|
|
10356
|
+
}
|
|
10357
|
+
/**
|
|
10358
|
+
* @public
|
|
10359
|
+
* <p>The application settings for a Code Editor space.</p>
|
|
10360
|
+
*/
|
|
10361
|
+
export interface SpaceCodeEditorAppSettings {
|
|
10362
|
+
/**
|
|
10363
|
+
* @public
|
|
10364
|
+
* <p>Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that
|
|
10365
|
+
* the version runs on.</p>
|
|
10366
|
+
*/
|
|
10367
|
+
DefaultResourceSpec?: ResourceSpec;
|
|
10368
|
+
}
|
|
10369
|
+
/**
|
|
10370
|
+
* @public
|
|
10371
|
+
* <p>A file system, created by you in Amazon EFS, that you assign to a user profile
|
|
10372
|
+
* or space for an Amazon SageMaker Domain. Permitted users can access this file
|
|
10373
|
+
* system in Amazon SageMaker Studio.</p>
|
|
10374
|
+
*/
|
|
10375
|
+
export interface EFSFileSystem {
|
|
10376
|
+
/**
|
|
10377
|
+
* @public
|
|
10378
|
+
* <p>The ID of your Amazon EFS file system.</p>
|
|
10379
|
+
*/
|
|
10380
|
+
FileSystemId: string | undefined;
|
|
10381
|
+
}
|
|
10382
|
+
/**
|
|
10383
|
+
* @public
|
|
10384
|
+
* <p>A file system, created by you, that you assign to a user profile or space for an
|
|
10385
|
+
* Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker Studio.</p>
|
|
10386
|
+
*/
|
|
10387
|
+
export type CustomFileSystem = CustomFileSystem.EFSFileSystemMember | CustomFileSystem.$UnknownMember;
|
|
10388
|
+
/**
|
|
10389
|
+
* @public
|
|
10390
|
+
*/
|
|
10391
|
+
export declare namespace CustomFileSystem {
|
|
10392
|
+
/**
|
|
10393
|
+
* @public
|
|
10394
|
+
* <p>A custom file system in Amazon EFS.</p>
|
|
10395
|
+
*/
|
|
10396
|
+
interface EFSFileSystemMember {
|
|
10397
|
+
EFSFileSystem: EFSFileSystem;
|
|
10398
|
+
$unknown?: never;
|
|
10399
|
+
}
|
|
10400
|
+
/**
|
|
10401
|
+
* @public
|
|
10402
|
+
*/
|
|
10403
|
+
interface $UnknownMember {
|
|
10404
|
+
EFSFileSystem?: never;
|
|
10405
|
+
$unknown: [string, any];
|
|
10406
|
+
}
|
|
10407
|
+
interface Visitor<T> {
|
|
10408
|
+
EFSFileSystem: (value: EFSFileSystem) => T;
|
|
10409
|
+
_: (name: string, value: any) => T;
|
|
10410
|
+
}
|
|
10411
|
+
const visit: <T>(value: CustomFileSystem, visitor: Visitor<T>) => T;
|
|
10412
|
+
}
|
|
10413
|
+
/**
|
|
10414
|
+
* @public
|
|
10415
|
+
* <p>The settings for the JupyterLab application within a space.</p>
|
|
10416
|
+
*/
|
|
10417
|
+
export interface SpaceJupyterLabAppSettings {
|
|
10418
|
+
/**
|
|
10419
|
+
* @public
|
|
10420
|
+
* <p>Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that
|
|
10421
|
+
* the version runs on.</p>
|
|
10422
|
+
*/
|
|
10423
|
+
DefaultResourceSpec?: ResourceSpec;
|
|
10424
|
+
/**
|
|
10425
|
+
* @public
|
|
10426
|
+
* <p>A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.</p>
|
|
10427
|
+
*/
|
|
10428
|
+
CodeRepositories?: CodeRepository[];
|
|
10429
|
+
}
|
|
10430
|
+
/**
|
|
10431
|
+
* @public
|
|
10432
|
+
* <p>A collection of EBS storage settings that applies to private spaces.</p>
|
|
10433
|
+
*/
|
|
10434
|
+
export interface EbsStorageSettings {
|
|
10435
|
+
/**
|
|
10436
|
+
* @public
|
|
10437
|
+
* <p>The size of an EBS storage volume for a private space.</p>
|
|
10438
|
+
*/
|
|
10439
|
+
EbsVolumeSizeInGb: number | undefined;
|
|
10440
|
+
}
|
|
10441
|
+
/**
|
|
10442
|
+
* @public
|
|
10443
|
+
* <p>The storage settings for a private space.</p>
|
|
10444
|
+
*/
|
|
10445
|
+
export interface SpaceStorageSettings {
|
|
10446
|
+
/**
|
|
10447
|
+
* @public
|
|
10448
|
+
* <p>A collection of EBS storage settings for a private space.</p>
|
|
10449
|
+
*/
|
|
10450
|
+
EbsStorageSettings?: EbsStorageSettings;
|
|
10451
|
+
}
|
|
10138
10452
|
/**
|
|
10139
10453
|
* @public
|
|
10140
10454
|
* <p>A collection of space settings.</p>
|
|
@@ -10150,6 +10464,56 @@ export interface SpaceSettings {
|
|
|
10150
10464
|
* <p>The KernelGateway app settings.</p>
|
|
10151
10465
|
*/
|
|
10152
10466
|
KernelGatewayAppSettings?: KernelGatewayAppSettings;
|
|
10467
|
+
/**
|
|
10468
|
+
* @public
|
|
10469
|
+
* <p>The settings for the JupyterLab application.</p>
|
|
10470
|
+
*/
|
|
10471
|
+
JupyterLabAppSettings?: SpaceJupyterLabAppSettings;
|
|
10472
|
+
/**
|
|
10473
|
+
* @public
|
|
10474
|
+
* <p>The Code Editor application settings.</p>
|
|
10475
|
+
*/
|
|
10476
|
+
CodeEditorAppSettings?: SpaceCodeEditorAppSettings;
|
|
10477
|
+
/**
|
|
10478
|
+
* @public
|
|
10479
|
+
* <p>The storage settings for a private space.</p>
|
|
10480
|
+
*/
|
|
10481
|
+
SpaceStorageSettings?: SpaceStorageSettings;
|
|
10482
|
+
/**
|
|
10483
|
+
* @public
|
|
10484
|
+
* <p>The type of app created within the space.</p>
|
|
10485
|
+
*/
|
|
10486
|
+
AppType?: AppType;
|
|
10487
|
+
/**
|
|
10488
|
+
* @public
|
|
10489
|
+
* <p>A file system, created by you, that you assign to a space for an Amazon SageMaker
|
|
10490
|
+
* Domain. Permitted users can access this file system in Amazon SageMaker
|
|
10491
|
+
* Studio.</p>
|
|
10492
|
+
*/
|
|
10493
|
+
CustomFileSystems?: CustomFileSystem[];
|
|
10494
|
+
}
|
|
10495
|
+
/**
|
|
10496
|
+
* @public
|
|
10497
|
+
* @enum
|
|
10498
|
+
*/
|
|
10499
|
+
export declare const SharingType: {
|
|
10500
|
+
readonly Private: "Private";
|
|
10501
|
+
readonly Shared: "Shared";
|
|
10502
|
+
};
|
|
10503
|
+
/**
|
|
10504
|
+
* @public
|
|
10505
|
+
*/
|
|
10506
|
+
export type SharingType = (typeof SharingType)[keyof typeof SharingType];
|
|
10507
|
+
/**
|
|
10508
|
+
* @public
|
|
10509
|
+
* <p>A collection of space sharing settings.</p>
|
|
10510
|
+
*/
|
|
10511
|
+
export interface SpaceSharingSettings {
|
|
10512
|
+
/**
|
|
10513
|
+
* @public
|
|
10514
|
+
* <p>Specifies the sharing type of the space.</p>
|
|
10515
|
+
*/
|
|
10516
|
+
SharingType: SharingType | undefined;
|
|
10153
10517
|
}
|
|
10154
10518
|
/**
|
|
10155
10519
|
* @public
|
|
@@ -10169,7 +10533,7 @@ export interface CreateSpaceRequest {
|
|
|
10169
10533
|
* @public
|
|
10170
10534
|
* <p>Tags to associated with the space. Each tag consists of a key and an optional value.
|
|
10171
10535
|
* Tag keys must be unique for each resource. Tags are searchable using the
|
|
10172
|
-
*
|
|
10536
|
+
* <code>Search</code> API.</p>
|
|
10173
10537
|
*/
|
|
10174
10538
|
Tags?: Tag[];
|
|
10175
10539
|
/**
|
|
@@ -10177,6 +10541,21 @@ export interface CreateSpaceRequest {
|
|
|
10177
10541
|
* <p>A collection of space settings.</p>
|
|
10178
10542
|
*/
|
|
10179
10543
|
SpaceSettings?: SpaceSettings;
|
|
10544
|
+
/**
|
|
10545
|
+
* @public
|
|
10546
|
+
* <p>The name of the space that appears in the SageMaker Studio UI.</p>
|
|
10547
|
+
*/
|
|
10548
|
+
SpaceDisplayName?: string;
|
|
10549
|
+
/**
|
|
10550
|
+
* @public
|
|
10551
|
+
* <p>A collection of ownership settings.</p>
|
|
10552
|
+
*/
|
|
10553
|
+
OwnershipSettings?: OwnershipSettings;
|
|
10554
|
+
/**
|
|
10555
|
+
* @public
|
|
10556
|
+
* <p>A collection of space sharing settings.</p>
|
|
10557
|
+
*/
|
|
10558
|
+
SpaceSharingSettings?: SpaceSharingSettings;
|
|
10180
10559
|
}
|
|
10181
10560
|
/**
|
|
10182
10561
|
* @public
|
|
@@ -10193,6 +10572,8 @@ export interface CreateSpaceResponse {
|
|
|
10193
10572
|
* @enum
|
|
10194
10573
|
*/
|
|
10195
10574
|
export declare const StudioLifecycleConfigAppType: {
|
|
10575
|
+
readonly CodeEditor: "CodeEditor";
|
|
10576
|
+
readonly JupyterLab: "JupyterLab";
|
|
10196
10577
|
readonly JupyterServer: "JupyterServer";
|
|
10197
10578
|
readonly KernelGateway: "KernelGateway";
|
|
10198
10579
|
};
|
|
@@ -10358,800 +10739,6 @@ export interface ProfilerConfig {
|
|
|
10358
10739
|
*/
|
|
10359
10740
|
DisableProfiler?: boolean;
|
|
10360
10741
|
}
|
|
10361
|
-
/**
|
|
10362
|
-
* @public
|
|
10363
|
-
* <p>Configuration information for profiling rules.</p>
|
|
10364
|
-
*/
|
|
10365
|
-
export interface ProfilerRuleConfiguration {
|
|
10366
|
-
/**
|
|
10367
|
-
* @public
|
|
10368
|
-
* <p>The name of the rule configuration. It must be unique relative to other rule configuration names.</p>
|
|
10369
|
-
*/
|
|
10370
|
-
RuleConfigurationName: string | undefined;
|
|
10371
|
-
/**
|
|
10372
|
-
* @public
|
|
10373
|
-
* <p>Path to local storage location for output of rules. Defaults to <code>/opt/ml/processing/output/rule/</code>. </p>
|
|
10374
|
-
*/
|
|
10375
|
-
LocalPath?: string;
|
|
10376
|
-
/**
|
|
10377
|
-
* @public
|
|
10378
|
-
* <p>Path to Amazon S3 storage location for rules.</p>
|
|
10379
|
-
*/
|
|
10380
|
-
S3OutputPath?: string;
|
|
10381
|
-
/**
|
|
10382
|
-
* @public
|
|
10383
|
-
* <p>The Amazon Elastic Container Registry Image for the managed rule evaluation.</p>
|
|
10384
|
-
*/
|
|
10385
|
-
RuleEvaluatorImage: string | undefined;
|
|
10386
|
-
/**
|
|
10387
|
-
* @public
|
|
10388
|
-
* <p>The instance type to deploy a custom rule for profiling a training job.</p>
|
|
10389
|
-
*/
|
|
10390
|
-
InstanceType?: ProcessingInstanceType;
|
|
10391
|
-
/**
|
|
10392
|
-
* @public
|
|
10393
|
-
* <p>The size, in GB, of the ML storage volume attached to the processing instance.</p>
|
|
10394
|
-
*/
|
|
10395
|
-
VolumeSizeInGB?: number;
|
|
10396
|
-
/**
|
|
10397
|
-
* @public
|
|
10398
|
-
* <p>Runtime configuration for rule container.</p>
|
|
10399
|
-
*/
|
|
10400
|
-
RuleParameters?: Record<string, string>;
|
|
10401
|
-
}
|
|
10402
|
-
/**
|
|
10403
|
-
* @public
|
|
10404
|
-
* <p>Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data.</p>
|
|
10405
|
-
*/
|
|
10406
|
-
export interface TensorBoardOutputConfig {
|
|
10407
|
-
/**
|
|
10408
|
-
* @public
|
|
10409
|
-
* <p>Path to local storage location for tensorBoard output. Defaults to
|
|
10410
|
-
* <code>/opt/ml/output/tensorboard</code>.</p>
|
|
10411
|
-
*/
|
|
10412
|
-
LocalPath?: string;
|
|
10413
|
-
/**
|
|
10414
|
-
* @public
|
|
10415
|
-
* <p>Path to Amazon S3 storage location for TensorBoard output.</p>
|
|
10416
|
-
*/
|
|
10417
|
-
S3OutputPath: string | undefined;
|
|
10418
|
-
}
|
|
10419
|
-
/**
|
|
10420
|
-
* @public
|
|
10421
|
-
*/
|
|
10422
|
-
export interface CreateTrainingJobRequest {
|
|
10423
|
-
/**
|
|
10424
|
-
* @public
|
|
10425
|
-
* <p>The name of the training job. The name must be unique within an Amazon Web Services
|
|
10426
|
-
* Region in an Amazon Web Services account. </p>
|
|
10427
|
-
*/
|
|
10428
|
-
TrainingJobName: string | undefined;
|
|
10429
|
-
/**
|
|
10430
|
-
* @public
|
|
10431
|
-
* <p>Algorithm-specific parameters that influence the quality of the model. You set
|
|
10432
|
-
* hyperparameters before you start the learning process. For a list of hyperparameters for
|
|
10433
|
-
* each training algorithm provided by SageMaker, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html">Algorithms</a>. </p>
|
|
10434
|
-
* <p>You can specify a maximum of 100 hyperparameters. Each hyperparameter is a
|
|
10435
|
-
* key-value pair. Each key and value is limited to 256 characters, as specified by the
|
|
10436
|
-
* <code>Length Constraint</code>. </p>
|
|
10437
|
-
* <important>
|
|
10438
|
-
* <p>Do not include any security-sensitive information including account access IDs,
|
|
10439
|
-
* secrets or tokens in any hyperparameter field. If the use of security-sensitive
|
|
10440
|
-
* credentials are detected, SageMaker will reject your training job request and return an
|
|
10441
|
-
* exception error.</p>
|
|
10442
|
-
* </important>
|
|
10443
|
-
*/
|
|
10444
|
-
HyperParameters?: Record<string, string>;
|
|
10445
|
-
/**
|
|
10446
|
-
* @public
|
|
10447
|
-
* <p>The registry path of the Docker image that contains the training algorithm and
|
|
10448
|
-
* algorithm-specific metadata, including the input mode. For more information about
|
|
10449
|
-
* algorithms provided by SageMaker, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html">Algorithms</a>. For information about
|
|
10450
|
-
* providing your own algorithms, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html">Using Your Own Algorithms with
|
|
10451
|
-
* Amazon SageMaker</a>. </p>
|
|
10452
|
-
*/
|
|
10453
|
-
AlgorithmSpecification: AlgorithmSpecification | undefined;
|
|
10454
|
-
/**
|
|
10455
|
-
* @public
|
|
10456
|
-
* <p>The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to perform
|
|
10457
|
-
* tasks on your behalf. </p>
|
|
10458
|
-
* <p>During model training, SageMaker needs your permission to read input data from an S3
|
|
10459
|
-
* bucket, download a Docker image that contains training code, write model artifacts to an
|
|
10460
|
-
* S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant
|
|
10461
|
-
* 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
|
|
10462
|
-
* Roles</a>. </p>
|
|
10463
|
-
* <note>
|
|
10464
|
-
* <p>To be able to pass this role to SageMaker, the caller of this API must have the
|
|
10465
|
-
* <code>iam:PassRole</code> permission.</p>
|
|
10466
|
-
* </note>
|
|
10467
|
-
*/
|
|
10468
|
-
RoleArn: string | undefined;
|
|
10469
|
-
/**
|
|
10470
|
-
* @public
|
|
10471
|
-
* <p>An array of <code>Channel</code> objects. Each channel is a named input source.
|
|
10472
|
-
* <code>InputDataConfig</code> describes the input data and its location. </p>
|
|
10473
|
-
* <p>Algorithms can accept input data from one or more channels. For example, an
|
|
10474
|
-
* algorithm might have two channels of input data, <code>training_data</code> and
|
|
10475
|
-
* <code>validation_data</code>. The configuration for each channel provides the S3,
|
|
10476
|
-
* EFS, or FSx location where the input data is stored. It also provides information about
|
|
10477
|
-
* the stored data: the MIME type, compression method, and whether the data is wrapped in
|
|
10478
|
-
* RecordIO format. </p>
|
|
10479
|
-
* <p>Depending on the input mode that the algorithm supports, SageMaker either copies input
|
|
10480
|
-
* data files from an S3 bucket to a local directory in the Docker container, or makes it
|
|
10481
|
-
* available as input streams. For example, if you specify an EFS location, input data
|
|
10482
|
-
* files are available as input streams. They do not need to be downloaded.</p>
|
|
10483
|
-
* <p>Your input must be in the same Amazon Web Services region as your training
|
|
10484
|
-
* job.</p>
|
|
10485
|
-
*/
|
|
10486
|
-
InputDataConfig?: Channel[];
|
|
10487
|
-
/**
|
|
10488
|
-
* @public
|
|
10489
|
-
* <p>Specifies the path to the S3 location where you want to store model artifacts. SageMaker
|
|
10490
|
-
* creates subfolders for the artifacts. </p>
|
|
10491
|
-
*/
|
|
10492
|
-
OutputDataConfig: OutputDataConfig | undefined;
|
|
10493
|
-
/**
|
|
10494
|
-
* @public
|
|
10495
|
-
* <p>The resources, including the ML compute instances and ML storage volumes, to use
|
|
10496
|
-
* for model training. </p>
|
|
10497
|
-
* <p>ML storage volumes store model artifacts and incremental states. Training
|
|
10498
|
-
* algorithms might also use ML storage volumes for scratch space. If you want SageMaker to use
|
|
10499
|
-
* the ML storage volume to store the training data, choose <code>File</code> as the
|
|
10500
|
-
* <code>TrainingInputMode</code> in the algorithm specification. For distributed
|
|
10501
|
-
* training algorithms, specify an instance count greater than 1.</p>
|
|
10502
|
-
*/
|
|
10503
|
-
ResourceConfig: ResourceConfig | undefined;
|
|
10504
|
-
/**
|
|
10505
|
-
* @public
|
|
10506
|
-
* <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
|
|
10507
|
-
* connect to. Control access to and from your training container by configuring the VPC.
|
|
10508
|
-
* For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html">Protect Training Jobs by Using an Amazon
|
|
10509
|
-
* Virtual Private Cloud</a>.</p>
|
|
10510
|
-
*/
|
|
10511
|
-
VpcConfig?: VpcConfig;
|
|
10512
|
-
/**
|
|
10513
|
-
* @public
|
|
10514
|
-
* <p>Specifies a limit to how long a model training job can run. It also specifies how long
|
|
10515
|
-
* a managed Spot training job has to complete. When the job reaches the time limit, SageMaker
|
|
10516
|
-
* ends the training job. Use this API to cap model training costs.</p>
|
|
10517
|
-
* <p>To stop a job, SageMaker sends the algorithm the <code>SIGTERM</code> signal, which delays
|
|
10518
|
-
* job termination for 120 seconds. Algorithms can use this 120-second window to save the
|
|
10519
|
-
* model artifacts, so the results of training are not lost. </p>
|
|
10520
|
-
*/
|
|
10521
|
-
StoppingCondition: StoppingCondition | undefined;
|
|
10522
|
-
/**
|
|
10523
|
-
* @public
|
|
10524
|
-
* <p>An array of key-value pairs. You can use tags to categorize your Amazon Web Services
|
|
10525
|
-
* resources in different ways, for example, by purpose, owner, or environment. For more
|
|
10526
|
-
* information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a>.</p>
|
|
10527
|
-
*/
|
|
10528
|
-
Tags?: Tag[];
|
|
10529
|
-
/**
|
|
10530
|
-
* @public
|
|
10531
|
-
* <p>Isolates the training container. No inbound or outbound network calls can be made,
|
|
10532
|
-
* except for calls between peers within a training cluster for distributed training. If
|
|
10533
|
-
* you enable network isolation for training jobs that are configured to use a VPC, SageMaker
|
|
10534
|
-
* downloads and uploads customer data and model artifacts through the specified VPC, but
|
|
10535
|
-
* the training container does not have network access.</p>
|
|
10536
|
-
*/
|
|
10537
|
-
EnableNetworkIsolation?: boolean;
|
|
10538
|
-
/**
|
|
10539
|
-
* @public
|
|
10540
|
-
* <p>To encrypt all communications between ML compute instances in distributed training,
|
|
10541
|
-
* choose <code>True</code>. Encryption provides greater security for distributed training,
|
|
10542
|
-
* but training might take longer. How long it takes depends on the amount of communication
|
|
10543
|
-
* between compute instances, especially if you use a deep learning algorithm in
|
|
10544
|
-
* distributed training. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/train-encrypt.html">Protect Communications Between ML
|
|
10545
|
-
* Compute Instances in a Distributed Training Job</a>.</p>
|
|
10546
|
-
*/
|
|
10547
|
-
EnableInterContainerTrafficEncryption?: boolean;
|
|
10548
|
-
/**
|
|
10549
|
-
* @public
|
|
10550
|
-
* <p>To train models using managed spot training, choose <code>True</code>. Managed spot
|
|
10551
|
-
* training provides a fully managed and scalable infrastructure for training machine
|
|
10552
|
-
* learning models. this option is useful when training jobs can be interrupted and when
|
|
10553
|
-
* there is flexibility when the training job is run. </p>
|
|
10554
|
-
* <p>The complete and intermediate results of jobs are stored in an Amazon S3 bucket, and can be
|
|
10555
|
-
* used as a starting point to train models incrementally. Amazon SageMaker provides metrics and
|
|
10556
|
-
* logs in CloudWatch. They can be used to see when managed spot training jobs are running,
|
|
10557
|
-
* interrupted, resumed, or completed. </p>
|
|
10558
|
-
*/
|
|
10559
|
-
EnableManagedSpotTraining?: boolean;
|
|
10560
|
-
/**
|
|
10561
|
-
* @public
|
|
10562
|
-
* <p>Contains information about the output location for managed spot training checkpoint
|
|
10563
|
-
* data.</p>
|
|
10564
|
-
*/
|
|
10565
|
-
CheckpointConfig?: CheckpointConfig;
|
|
10566
|
-
/**
|
|
10567
|
-
* @public
|
|
10568
|
-
* <p>Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and
|
|
10569
|
-
* storage paths. To learn more about
|
|
10570
|
-
* how to configure the <code>DebugHookConfig</code> parameter,
|
|
10571
|
-
* 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>
|
|
10572
|
-
*/
|
|
10573
|
-
DebugHookConfig?: DebugHookConfig;
|
|
10574
|
-
/**
|
|
10575
|
-
* @public
|
|
10576
|
-
* <p>Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.</p>
|
|
10577
|
-
*/
|
|
10578
|
-
DebugRuleConfigurations?: DebugRuleConfiguration[];
|
|
10579
|
-
/**
|
|
10580
|
-
* @public
|
|
10581
|
-
* <p>Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data.</p>
|
|
10582
|
-
*/
|
|
10583
|
-
TensorBoardOutputConfig?: TensorBoardOutputConfig;
|
|
10584
|
-
/**
|
|
10585
|
-
* @public
|
|
10586
|
-
* <p>Associates a SageMaker job as a trial component with an experiment and trial. Specified when
|
|
10587
|
-
* you call the following APIs:</p>
|
|
10588
|
-
* <ul>
|
|
10589
|
-
* <li>
|
|
10590
|
-
* <p>
|
|
10591
|
-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html">CreateProcessingJob</a>
|
|
10592
|
-
* </p>
|
|
10593
|
-
* </li>
|
|
10594
|
-
* <li>
|
|
10595
|
-
* <p>
|
|
10596
|
-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html">CreateTrainingJob</a>
|
|
10597
|
-
* </p>
|
|
10598
|
-
* </li>
|
|
10599
|
-
* <li>
|
|
10600
|
-
* <p>
|
|
10601
|
-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html">CreateTransformJob</a>
|
|
10602
|
-
* </p>
|
|
10603
|
-
* </li>
|
|
10604
|
-
* </ul>
|
|
10605
|
-
*/
|
|
10606
|
-
ExperimentConfig?: ExperimentConfig;
|
|
10607
|
-
/**
|
|
10608
|
-
* @public
|
|
10609
|
-
* <p>Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and
|
|
10610
|
-
* storage paths.</p>
|
|
10611
|
-
*/
|
|
10612
|
-
ProfilerConfig?: ProfilerConfig;
|
|
10613
|
-
/**
|
|
10614
|
-
* @public
|
|
10615
|
-
* <p>Configuration information for Amazon SageMaker Debugger rules for profiling system and framework
|
|
10616
|
-
* metrics.</p>
|
|
10617
|
-
*/
|
|
10618
|
-
ProfilerRuleConfigurations?: ProfilerRuleConfiguration[];
|
|
10619
|
-
/**
|
|
10620
|
-
* @public
|
|
10621
|
-
* <p>The environment variables to set in the Docker container.</p>
|
|
10622
|
-
*/
|
|
10623
|
-
Environment?: Record<string, string>;
|
|
10624
|
-
/**
|
|
10625
|
-
* @public
|
|
10626
|
-
* <p>The number of times to retry the job when the job fails due to an
|
|
10627
|
-
* <code>InternalServerError</code>.</p>
|
|
10628
|
-
*/
|
|
10629
|
-
RetryStrategy?: RetryStrategy;
|
|
10630
|
-
/**
|
|
10631
|
-
* @public
|
|
10632
|
-
* <p>Contains information about the infrastructure health check configuration for the training job.</p>
|
|
10633
|
-
*/
|
|
10634
|
-
InfraCheckConfig?: InfraCheckConfig;
|
|
10635
|
-
}
|
|
10636
|
-
/**
|
|
10637
|
-
* @public
|
|
10638
|
-
*/
|
|
10639
|
-
export interface CreateTrainingJobResponse {
|
|
10640
|
-
/**
|
|
10641
|
-
* @public
|
|
10642
|
-
* <p>The Amazon Resource Name (ARN) of the training job.</p>
|
|
10643
|
-
*/
|
|
10644
|
-
TrainingJobArn: string | undefined;
|
|
10645
|
-
}
|
|
10646
|
-
/**
|
|
10647
|
-
* @public
|
|
10648
|
-
* @enum
|
|
10649
|
-
*/
|
|
10650
|
-
export declare const JoinSource: {
|
|
10651
|
-
readonly INPUT: "Input";
|
|
10652
|
-
readonly NONE: "None";
|
|
10653
|
-
};
|
|
10654
|
-
/**
|
|
10655
|
-
* @public
|
|
10656
|
-
*/
|
|
10657
|
-
export type JoinSource = (typeof JoinSource)[keyof typeof JoinSource];
|
|
10658
|
-
/**
|
|
10659
|
-
* @public
|
|
10660
|
-
* <p>The data structure used to specify the data to be used for inference in a batch
|
|
10661
|
-
* transform job and to associate the data that is relevant to the prediction results in
|
|
10662
|
-
* the output. The input filter provided allows you to exclude input data that is not
|
|
10663
|
-
* needed for inference in a batch transform job. The output filter provided allows you to
|
|
10664
|
-
* include input data relevant to interpreting the predictions in the output from the job.
|
|
10665
|
-
* For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html">Associate Prediction
|
|
10666
|
-
* Results with their Corresponding Input Records</a>.</p>
|
|
10667
|
-
*/
|
|
10668
|
-
export interface DataProcessing {
|
|
10669
|
-
/**
|
|
10670
|
-
* @public
|
|
10671
|
-
* <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
|
|
10672
|
-
* the algorithm. Use the <code>InputFilter</code> parameter to exclude fields, such as an
|
|
10673
|
-
* ID column, from the input. If you want SageMaker to pass the entire input dataset to the
|
|
10674
|
-
* algorithm, accept the default value <code>$</code>.</p>
|
|
10675
|
-
* <p>Examples: <code>"$"</code>, <code>"$[1:]"</code>, <code>"$.features"</code>
|
|
10676
|
-
* </p>
|
|
10677
|
-
*/
|
|
10678
|
-
InputFilter?: string;
|
|
10679
|
-
/**
|
|
10680
|
-
* @public
|
|
10681
|
-
* <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
|
|
10682
|
-
* in the output file for a batch transform job. If you want SageMaker to store the entire input
|
|
10683
|
-
* dataset in the output file, leave the default value, <code>$</code>. If you specify
|
|
10684
|
-
* indexes that aren't within the dimension size of the joined dataset, you get an
|
|
10685
|
-
* error.</p>
|
|
10686
|
-
* <p>Examples: <code>"$"</code>, <code>"$[0,5:]"</code>,
|
|
10687
|
-
* <code>"$['id','SageMakerOutput']"</code>
|
|
10688
|
-
* </p>
|
|
10689
|
-
*/
|
|
10690
|
-
OutputFilter?: string;
|
|
10691
|
-
/**
|
|
10692
|
-
* @public
|
|
10693
|
-
* <p>Specifies the source of the data to join with the transformed data. The valid values
|
|
10694
|
-
* are <code>None</code> and <code>Input</code>. The default value is <code>None</code>,
|
|
10695
|
-
* which specifies not to join the input with the transformed data. If you want the batch
|
|
10696
|
-
* transform job to join the original input data with the transformed data, set
|
|
10697
|
-
* <code>JoinSource</code> to <code>Input</code>. You can specify
|
|
10698
|
-
* <code>OutputFilter</code> as an additional filter to select a portion of the joined
|
|
10699
|
-
* dataset and store it in the output file.</p>
|
|
10700
|
-
* <p>For JSON or JSONLines objects, such as a JSON array, SageMaker adds the transformed data to
|
|
10701
|
-
* the input JSON object in an attribute called <code>SageMakerOutput</code>. The joined
|
|
10702
|
-
* result for JSON must be a key-value pair object. If the input is not a key-value pair
|
|
10703
|
-
* object, SageMaker creates a new JSON file. In the new JSON file, and the input data is stored
|
|
10704
|
-
* under the <code>SageMakerInput</code> key and the results are stored in
|
|
10705
|
-
* <code>SageMakerOutput</code>.</p>
|
|
10706
|
-
* <p>For CSV data, SageMaker takes each row as a JSON array and joins the transformed data with
|
|
10707
|
-
* the input by appending each transformed row to the end of the input. The joined data has
|
|
10708
|
-
* the original input data followed by the transformed data and the output is a CSV
|
|
10709
|
-
* file.</p>
|
|
10710
|
-
* <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>
|
|
10711
|
-
*/
|
|
10712
|
-
JoinSource?: JoinSource;
|
|
10713
|
-
}
|
|
10714
|
-
/**
|
|
10715
|
-
* @public
|
|
10716
|
-
* <p>Configures the timeout and maximum number of retries for processing a transform job
|
|
10717
|
-
* invocation.</p>
|
|
10718
|
-
*/
|
|
10719
|
-
export interface ModelClientConfig {
|
|
10720
|
-
/**
|
|
10721
|
-
* @public
|
|
10722
|
-
* <p>The timeout value in seconds for an invocation request. The default value is
|
|
10723
|
-
* 600.</p>
|
|
10724
|
-
*/
|
|
10725
|
-
InvocationsTimeoutInSeconds?: number;
|
|
10726
|
-
/**
|
|
10727
|
-
* @public
|
|
10728
|
-
* <p>The maximum number of retries when invocation requests are failing. The default value
|
|
10729
|
-
* is 3.</p>
|
|
10730
|
-
*/
|
|
10731
|
-
InvocationsMaxRetries?: number;
|
|
10732
|
-
}
|
|
10733
|
-
/**
|
|
10734
|
-
* @public
|
|
10735
|
-
*/
|
|
10736
|
-
export interface CreateTransformJobRequest {
|
|
10737
|
-
/**
|
|
10738
|
-
* @public
|
|
10739
|
-
* <p>The name of the transform job. The name must be unique within an Amazon Web Services Region in an
|
|
10740
|
-
* Amazon Web Services account. </p>
|
|
10741
|
-
*/
|
|
10742
|
-
TransformJobName: string | undefined;
|
|
10743
|
-
/**
|
|
10744
|
-
* @public
|
|
10745
|
-
* <p>The name of the model that you want to use for the transform job.
|
|
10746
|
-
* <code>ModelName</code> must be the name of an existing Amazon SageMaker model within an Amazon Web Services
|
|
10747
|
-
* Region in an Amazon Web Services account.</p>
|
|
10748
|
-
*/
|
|
10749
|
-
ModelName: string | undefined;
|
|
10750
|
-
/**
|
|
10751
|
-
* @public
|
|
10752
|
-
* <p>The maximum number of parallel requests that can be sent to each instance in a
|
|
10753
|
-
* transform job. If <code>MaxConcurrentTransforms</code> is set to <code>0</code> or left
|
|
10754
|
-
* unset, Amazon SageMaker checks the optional execution-parameters to determine the settings for your
|
|
10755
|
-
* chosen algorithm. If the execution-parameters endpoint is not enabled, the default value
|
|
10756
|
-
* 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
|
|
10757
|
-
* set a value for <code>MaxConcurrentTransforms</code>.</p>
|
|
10758
|
-
*/
|
|
10759
|
-
MaxConcurrentTransforms?: number;
|
|
10760
|
-
/**
|
|
10761
|
-
* @public
|
|
10762
|
-
* <p>Configures the timeout and maximum number of retries for processing a transform job
|
|
10763
|
-
* invocation.</p>
|
|
10764
|
-
*/
|
|
10765
|
-
ModelClientConfig?: ModelClientConfig;
|
|
10766
|
-
/**
|
|
10767
|
-
* @public
|
|
10768
|
-
* <p>The maximum allowed size of the payload, in MB. A <i>payload</i> is the
|
|
10769
|
-
* data portion of a record (without metadata). The value in <code>MaxPayloadInMB</code>
|
|
10770
|
-
* must be greater than, or equal to, the size of a single record. To estimate the size of
|
|
10771
|
-
* a record in MB, divide the size of your dataset by the number of records. To ensure that
|
|
10772
|
-
* the records fit within the maximum payload size, we recommend using a slightly larger
|
|
10773
|
-
* value. The default value is <code>6</code> MB.
|
|
10774
|
-
* </p>
|
|
10775
|
-
* <p>The value of <code>MaxPayloadInMB</code> cannot be greater than 100 MB. If you specify
|
|
10776
|
-
* the <code>MaxConcurrentTransforms</code> parameter, the value of
|
|
10777
|
-
* <code>(MaxConcurrentTransforms * MaxPayloadInMB)</code> also cannot exceed 100
|
|
10778
|
-
* MB.</p>
|
|
10779
|
-
* <p>For cases where the payload might be arbitrarily large and is transmitted using HTTP
|
|
10780
|
-
* chunked encoding, set the value to <code>0</code>.
|
|
10781
|
-
* This
|
|
10782
|
-
* feature works only in supported algorithms. Currently, Amazon SageMaker built-in
|
|
10783
|
-
* algorithms do not support HTTP chunked encoding.</p>
|
|
10784
|
-
*/
|
|
10785
|
-
MaxPayloadInMB?: number;
|
|
10786
|
-
/**
|
|
10787
|
-
* @public
|
|
10788
|
-
* <p>Specifies the number of records to include in a mini-batch for an HTTP inference
|
|
10789
|
-
* request. A <i>record</i>
|
|
10790
|
-
* <i></i> is a single unit of input data that
|
|
10791
|
-
* inference can be made on. For example, a single line in a CSV file is a record. </p>
|
|
10792
|
-
* <p>To enable the batch strategy, you must set the <code>SplitType</code> property to
|
|
10793
|
-
* <code>Line</code>, <code>RecordIO</code>, or <code>TFRecord</code>.</p>
|
|
10794
|
-
* <p>To use only one record when making an HTTP invocation request to a container, set
|
|
10795
|
-
* <code>BatchStrategy</code> to <code>SingleRecord</code> and <code>SplitType</code>
|
|
10796
|
-
* to <code>Line</code>.</p>
|
|
10797
|
-
* <p>To fit as many records in a mini-batch as can fit within the
|
|
10798
|
-
* <code>MaxPayloadInMB</code> limit, set <code>BatchStrategy</code> to
|
|
10799
|
-
* <code>MultiRecord</code> and <code>SplitType</code> to <code>Line</code>.</p>
|
|
10800
|
-
*/
|
|
10801
|
-
BatchStrategy?: BatchStrategy;
|
|
10802
|
-
/**
|
|
10803
|
-
* @public
|
|
10804
|
-
* <p>The environment variables to set in the Docker container. We support up to 16 key and
|
|
10805
|
-
* values entries in the map.</p>
|
|
10806
|
-
*/
|
|
10807
|
-
Environment?: Record<string, string>;
|
|
10808
|
-
/**
|
|
10809
|
-
* @public
|
|
10810
|
-
* <p>Describes the input source and
|
|
10811
|
-
* the
|
|
10812
|
-
* way the transform job consumes it.</p>
|
|
10813
|
-
*/
|
|
10814
|
-
TransformInput: TransformInput | undefined;
|
|
10815
|
-
/**
|
|
10816
|
-
* @public
|
|
10817
|
-
* <p>Describes the results of the transform job.</p>
|
|
10818
|
-
*/
|
|
10819
|
-
TransformOutput: TransformOutput | undefined;
|
|
10820
|
-
/**
|
|
10821
|
-
* @public
|
|
10822
|
-
* <p>Configuration to control how SageMaker captures inference data.</p>
|
|
10823
|
-
*/
|
|
10824
|
-
DataCaptureConfig?: BatchDataCaptureConfig;
|
|
10825
|
-
/**
|
|
10826
|
-
* @public
|
|
10827
|
-
* <p>Describes the resources, including
|
|
10828
|
-
* ML
|
|
10829
|
-
* instance types and ML instance count, to use for the transform
|
|
10830
|
-
* job.</p>
|
|
10831
|
-
*/
|
|
10832
|
-
TransformResources: TransformResources | undefined;
|
|
10833
|
-
/**
|
|
10834
|
-
* @public
|
|
10835
|
-
* <p>The data structure used to specify the data to be used for inference in a batch
|
|
10836
|
-
* transform job and to associate the data that is relevant to the prediction results in
|
|
10837
|
-
* the output. The input filter provided allows you to exclude input data that is not
|
|
10838
|
-
* needed for inference in a batch transform job. The output filter provided allows you to
|
|
10839
|
-
* include input data relevant to interpreting the predictions in the output from the job.
|
|
10840
|
-
* For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html">Associate Prediction
|
|
10841
|
-
* Results with their Corresponding Input Records</a>.</p>
|
|
10842
|
-
*/
|
|
10843
|
-
DataProcessing?: DataProcessing;
|
|
10844
|
-
/**
|
|
10845
|
-
* @public
|
|
10846
|
-
* <p>(Optional)
|
|
10847
|
-
* An
|
|
10848
|
-
* 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
|
|
10849
|
-
* Cost Allocation Tags</a> in the <i>Amazon Web Services Billing and Cost Management User
|
|
10850
|
-
* Guide</i>.</p>
|
|
10851
|
-
*/
|
|
10852
|
-
Tags?: Tag[];
|
|
10853
|
-
/**
|
|
10854
|
-
* @public
|
|
10855
|
-
* <p>Associates a SageMaker job as a trial component with an experiment and trial. Specified when
|
|
10856
|
-
* you call the following APIs:</p>
|
|
10857
|
-
* <ul>
|
|
10858
|
-
* <li>
|
|
10859
|
-
* <p>
|
|
10860
|
-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html">CreateProcessingJob</a>
|
|
10861
|
-
* </p>
|
|
10862
|
-
* </li>
|
|
10863
|
-
* <li>
|
|
10864
|
-
* <p>
|
|
10865
|
-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html">CreateTrainingJob</a>
|
|
10866
|
-
* </p>
|
|
10867
|
-
* </li>
|
|
10868
|
-
* <li>
|
|
10869
|
-
* <p>
|
|
10870
|
-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html">CreateTransformJob</a>
|
|
10871
|
-
* </p>
|
|
10872
|
-
* </li>
|
|
10873
|
-
* </ul>
|
|
10874
|
-
*/
|
|
10875
|
-
ExperimentConfig?: ExperimentConfig;
|
|
10876
|
-
}
|
|
10877
|
-
/**
|
|
10878
|
-
* @public
|
|
10879
|
-
*/
|
|
10880
|
-
export interface CreateTransformJobResponse {
|
|
10881
|
-
/**
|
|
10882
|
-
* @public
|
|
10883
|
-
* <p>The Amazon Resource Name (ARN) of the transform job.</p>
|
|
10884
|
-
*/
|
|
10885
|
-
TransformJobArn: string | undefined;
|
|
10886
|
-
}
|
|
10887
|
-
/**
|
|
10888
|
-
* @public
|
|
10889
|
-
*/
|
|
10890
|
-
export interface CreateTrialRequest {
|
|
10891
|
-
/**
|
|
10892
|
-
* @public
|
|
10893
|
-
* <p>The name of the trial. The name must be unique in your Amazon Web Services account and is not
|
|
10894
|
-
* case-sensitive.</p>
|
|
10895
|
-
*/
|
|
10896
|
-
TrialName: string | undefined;
|
|
10897
|
-
/**
|
|
10898
|
-
* @public
|
|
10899
|
-
* <p>The name of the trial as displayed. The name doesn't need to be unique. If
|
|
10900
|
-
* <code>DisplayName</code> isn't specified, <code>TrialName</code> is displayed.</p>
|
|
10901
|
-
*/
|
|
10902
|
-
DisplayName?: string;
|
|
10903
|
-
/**
|
|
10904
|
-
* @public
|
|
10905
|
-
* <p>The name of the experiment to associate the trial with.</p>
|
|
10906
|
-
*/
|
|
10907
|
-
ExperimentName: string | undefined;
|
|
10908
|
-
/**
|
|
10909
|
-
* @public
|
|
10910
|
-
* <p>Metadata properties of the tracking entity, trial, or trial component.</p>
|
|
10911
|
-
*/
|
|
10912
|
-
MetadataProperties?: MetadataProperties;
|
|
10913
|
-
/**
|
|
10914
|
-
* @public
|
|
10915
|
-
* <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
|
|
10916
|
-
* search on the tags.</p>
|
|
10917
|
-
*/
|
|
10918
|
-
Tags?: Tag[];
|
|
10919
|
-
}
|
|
10920
|
-
/**
|
|
10921
|
-
* @public
|
|
10922
|
-
*/
|
|
10923
|
-
export interface CreateTrialResponse {
|
|
10924
|
-
/**
|
|
10925
|
-
* @public
|
|
10926
|
-
* <p>The Amazon Resource Name (ARN) of the trial.</p>
|
|
10927
|
-
*/
|
|
10928
|
-
TrialArn?: string;
|
|
10929
|
-
}
|
|
10930
|
-
/**
|
|
10931
|
-
* @public
|
|
10932
|
-
* <p>Represents an input or output artifact of a trial component. You specify
|
|
10933
|
-
* <code>TrialComponentArtifact</code> as part of the <code>InputArtifacts</code> and
|
|
10934
|
-
* <code>OutputArtifacts</code> parameters in the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrialComponent.html">CreateTrialComponent</a>
|
|
10935
|
-
* request.</p>
|
|
10936
|
-
* <p>Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and
|
|
10937
|
-
* instance types. Examples of output artifacts are metrics, snapshots, logs, and images.</p>
|
|
10938
|
-
*/
|
|
10939
|
-
export interface TrialComponentArtifact {
|
|
10940
|
-
/**
|
|
10941
|
-
* @public
|
|
10942
|
-
* <p>The media type of the artifact, which indicates the type of data in the artifact file. The
|
|
10943
|
-
* media type consists of a <i>type</i> and a <i>subtype</i>
|
|
10944
|
-
* concatenated with a slash (/) character, for example, text/csv, image/jpeg, and s3/uri. The
|
|
10945
|
-
* type specifies the category of the media. The subtype specifies the kind of data.</p>
|
|
10946
|
-
*/
|
|
10947
|
-
MediaType?: string;
|
|
10948
|
-
/**
|
|
10949
|
-
* @public
|
|
10950
|
-
* <p>The location of the artifact.</p>
|
|
10951
|
-
*/
|
|
10952
|
-
Value: string | undefined;
|
|
10953
|
-
}
|
|
10954
|
-
/**
|
|
10955
|
-
* @public
|
|
10956
|
-
* <p>The value of a hyperparameter. Only one of <code>NumberValue</code> or
|
|
10957
|
-
* <code>StringValue</code> can be specified.</p>
|
|
10958
|
-
* <p>This object is specified in the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrialComponent.html">CreateTrialComponent</a> request.</p>
|
|
10959
|
-
*/
|
|
10960
|
-
export type TrialComponentParameterValue = TrialComponentParameterValue.NumberValueMember | TrialComponentParameterValue.StringValueMember | TrialComponentParameterValue.$UnknownMember;
|
|
10961
|
-
/**
|
|
10962
|
-
* @public
|
|
10963
|
-
*/
|
|
10964
|
-
export declare namespace TrialComponentParameterValue {
|
|
10965
|
-
/**
|
|
10966
|
-
* @public
|
|
10967
|
-
* <p>The string value of a categorical hyperparameter. If you specify a value for this
|
|
10968
|
-
* parameter, you can't specify the <code>NumberValue</code> parameter.</p>
|
|
10969
|
-
*/
|
|
10970
|
-
interface StringValueMember {
|
|
10971
|
-
StringValue: string;
|
|
10972
|
-
NumberValue?: never;
|
|
10973
|
-
$unknown?: never;
|
|
10974
|
-
}
|
|
10975
|
-
/**
|
|
10976
|
-
* @public
|
|
10977
|
-
* <p>The numeric value of a numeric hyperparameter. If you specify a value for this parameter,
|
|
10978
|
-
* you can't specify the <code>StringValue</code> parameter.</p>
|
|
10979
|
-
*/
|
|
10980
|
-
interface NumberValueMember {
|
|
10981
|
-
StringValue?: never;
|
|
10982
|
-
NumberValue: number;
|
|
10983
|
-
$unknown?: never;
|
|
10984
|
-
}
|
|
10985
|
-
/**
|
|
10986
|
-
* @public
|
|
10987
|
-
*/
|
|
10988
|
-
interface $UnknownMember {
|
|
10989
|
-
StringValue?: never;
|
|
10990
|
-
NumberValue?: never;
|
|
10991
|
-
$unknown: [string, any];
|
|
10992
|
-
}
|
|
10993
|
-
interface Visitor<T> {
|
|
10994
|
-
StringValue: (value: string) => T;
|
|
10995
|
-
NumberValue: (value: number) => T;
|
|
10996
|
-
_: (name: string, value: any) => T;
|
|
10997
|
-
}
|
|
10998
|
-
const visit: <T>(value: TrialComponentParameterValue, visitor: Visitor<T>) => T;
|
|
10999
|
-
}
|
|
11000
|
-
/**
|
|
11001
|
-
* @public
|
|
11002
|
-
* @enum
|
|
11003
|
-
*/
|
|
11004
|
-
export declare const TrialComponentPrimaryStatus: {
|
|
11005
|
-
readonly COMPLETED: "Completed";
|
|
11006
|
-
readonly FAILED: "Failed";
|
|
11007
|
-
readonly IN_PROGRESS: "InProgress";
|
|
11008
|
-
readonly STOPPED: "Stopped";
|
|
11009
|
-
readonly STOPPING: "Stopping";
|
|
11010
|
-
};
|
|
11011
|
-
/**
|
|
11012
|
-
* @public
|
|
11013
|
-
*/
|
|
11014
|
-
export type TrialComponentPrimaryStatus = (typeof TrialComponentPrimaryStatus)[keyof typeof TrialComponentPrimaryStatus];
|
|
11015
|
-
/**
|
|
11016
|
-
* @public
|
|
11017
|
-
* <p>The status of the trial component.</p>
|
|
11018
|
-
*/
|
|
11019
|
-
export interface TrialComponentStatus {
|
|
11020
|
-
/**
|
|
11021
|
-
* @public
|
|
11022
|
-
* <p>The status of the trial component.</p>
|
|
11023
|
-
*/
|
|
11024
|
-
PrimaryStatus?: TrialComponentPrimaryStatus;
|
|
11025
|
-
/**
|
|
11026
|
-
* @public
|
|
11027
|
-
* <p>If the component failed, a message describing why.</p>
|
|
11028
|
-
*/
|
|
11029
|
-
Message?: string;
|
|
11030
|
-
}
|
|
11031
|
-
/**
|
|
11032
|
-
* @public
|
|
11033
|
-
*/
|
|
11034
|
-
export interface CreateTrialComponentRequest {
|
|
11035
|
-
/**
|
|
11036
|
-
* @public
|
|
11037
|
-
* <p>The name of the component. The name must be unique in your Amazon Web Services account and is not
|
|
11038
|
-
* case-sensitive.</p>
|
|
11039
|
-
*/
|
|
11040
|
-
TrialComponentName: string | undefined;
|
|
11041
|
-
/**
|
|
11042
|
-
* @public
|
|
11043
|
-
* <p>The name of the component as displayed. The name doesn't need to be unique. If
|
|
11044
|
-
* <code>DisplayName</code> isn't specified, <code>TrialComponentName</code> is
|
|
11045
|
-
* displayed.</p>
|
|
11046
|
-
*/
|
|
11047
|
-
DisplayName?: string;
|
|
11048
|
-
/**
|
|
11049
|
-
* @public
|
|
11050
|
-
* <p>The status of the component. States include:</p>
|
|
11051
|
-
* <ul>
|
|
11052
|
-
* <li>
|
|
11053
|
-
* <p>InProgress</p>
|
|
11054
|
-
* </li>
|
|
11055
|
-
* <li>
|
|
11056
|
-
* <p>Completed</p>
|
|
11057
|
-
* </li>
|
|
11058
|
-
* <li>
|
|
11059
|
-
* <p>Failed</p>
|
|
11060
|
-
* </li>
|
|
11061
|
-
* </ul>
|
|
11062
|
-
*/
|
|
11063
|
-
Status?: TrialComponentStatus;
|
|
11064
|
-
/**
|
|
11065
|
-
* @public
|
|
11066
|
-
* <p>When the component started.</p>
|
|
11067
|
-
*/
|
|
11068
|
-
StartTime?: Date;
|
|
11069
|
-
/**
|
|
11070
|
-
* @public
|
|
11071
|
-
* <p>When the component ended.</p>
|
|
11072
|
-
*/
|
|
11073
|
-
EndTime?: Date;
|
|
11074
|
-
/**
|
|
11075
|
-
* @public
|
|
11076
|
-
* <p>The hyperparameters for the component.</p>
|
|
11077
|
-
*/
|
|
11078
|
-
Parameters?: Record<string, TrialComponentParameterValue>;
|
|
11079
|
-
/**
|
|
11080
|
-
* @public
|
|
11081
|
-
* <p>The input artifacts for the component. Examples of input artifacts are datasets,
|
|
11082
|
-
* algorithms, hyperparameters, source code, and instance types.</p>
|
|
11083
|
-
*/
|
|
11084
|
-
InputArtifacts?: Record<string, TrialComponentArtifact>;
|
|
11085
|
-
/**
|
|
11086
|
-
* @public
|
|
11087
|
-
* <p>The output artifacts for the component. Examples of output artifacts are metrics,
|
|
11088
|
-
* snapshots, logs, and images.</p>
|
|
11089
|
-
*/
|
|
11090
|
-
OutputArtifacts?: Record<string, TrialComponentArtifact>;
|
|
11091
|
-
/**
|
|
11092
|
-
* @public
|
|
11093
|
-
* <p>Metadata properties of the tracking entity, trial, or trial component.</p>
|
|
11094
|
-
*/
|
|
11095
|
-
MetadataProperties?: MetadataProperties;
|
|
11096
|
-
/**
|
|
11097
|
-
* @public
|
|
11098
|
-
* <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
|
|
11099
|
-
* to search on the tags.</p>
|
|
11100
|
-
*/
|
|
11101
|
-
Tags?: Tag[];
|
|
11102
|
-
}
|
|
11103
|
-
/**
|
|
11104
|
-
* @public
|
|
11105
|
-
*/
|
|
11106
|
-
export interface CreateTrialComponentResponse {
|
|
11107
|
-
/**
|
|
11108
|
-
* @public
|
|
11109
|
-
* <p>The Amazon Resource Name (ARN) of the trial component.</p>
|
|
11110
|
-
*/
|
|
11111
|
-
TrialComponentArn?: string;
|
|
11112
|
-
}
|
|
11113
|
-
/**
|
|
11114
|
-
* @public
|
|
11115
|
-
*/
|
|
11116
|
-
export interface CreateUserProfileRequest {
|
|
11117
|
-
/**
|
|
11118
|
-
* @public
|
|
11119
|
-
* <p>The ID of the associated Domain.</p>
|
|
11120
|
-
*/
|
|
11121
|
-
DomainId: string | undefined;
|
|
11122
|
-
/**
|
|
11123
|
-
* @public
|
|
11124
|
-
* <p>A name for the UserProfile. This value is not case sensitive.</p>
|
|
11125
|
-
*/
|
|
11126
|
-
UserProfileName: string | undefined;
|
|
11127
|
-
/**
|
|
11128
|
-
* @public
|
|
11129
|
-
* <p>A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName".
|
|
11130
|
-
* 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.
|
|
11131
|
-
* </p>
|
|
11132
|
-
*/
|
|
11133
|
-
SingleSignOnUserIdentifier?: string;
|
|
11134
|
-
/**
|
|
11135
|
-
* @public
|
|
11136
|
-
* <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
|
|
11137
|
-
* 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.
|
|
11138
|
-
* </p>
|
|
11139
|
-
*/
|
|
11140
|
-
SingleSignOnUserValue?: string;
|
|
11141
|
-
/**
|
|
11142
|
-
* @public
|
|
11143
|
-
* <p>Each tag consists of a key and an optional value.
|
|
11144
|
-
* Tag keys must be unique per resource.</p>
|
|
11145
|
-
* <p>Tags that you specify for the User Profile are also added to all Apps that the
|
|
11146
|
-
* User Profile launches.</p>
|
|
11147
|
-
*/
|
|
11148
|
-
Tags?: Tag[];
|
|
11149
|
-
/**
|
|
11150
|
-
* @public
|
|
11151
|
-
* <p>A collection of settings.</p>
|
|
11152
|
-
*/
|
|
11153
|
-
UserSettings?: UserSettings;
|
|
11154
|
-
}
|
|
11155
10742
|
/**
|
|
11156
10743
|
* @internal
|
|
11157
10744
|
*/
|