Input object for the endpoint
* @public */ export interface EndpointInput { /** *An endpoint in customer's account which has enabled DataCaptureConfig enabled.
Path to the filesystem where the endpoint data is available to the container.
* @public */ LocalPath: string | undefined; /** *Whether the Pipe or File is used as the input mode for transferring data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.
Whether input data distributed in Amazon S3 is fully replicated or sharded by an Amazon S3 key. Defaults to FullyReplicated
The attributes of the input data that are the input features.
* @public */ FeaturesAttribute?: string | undefined; /** *The attribute of the input data that represents the ground truth label.
* @public */ InferenceAttribute?: string | undefined; /** *In a classification problem, the attribute that represents the class probability.
* @public */ ProbabilityAttribute?: string | undefined; /** *The threshold for the class probability to be evaluated as a positive result.
* @public */ ProbabilityThresholdAttribute?: number | undefined; /** *If specified, monitoring jobs substract this time from the start time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.
* @public */ StartTimeOffset?: string | undefined; /** *If specified, monitoring jobs substract this time from the end time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.
* @public */ EndTimeOffset?: string | undefined; /** *The attributes of the input data to exclude from the analysis.
* @public */ ExcludeFeaturesAttribute?: string | undefined; } /** *The input for the data quality monitoring job. Currently endpoints are supported for input.
* @public */ export interface DataQualityJobInput { /** *Input object for the endpoint
* @public */ EndpointInput?: EndpointInput | undefined; /** *Input object for the batch transform job.
* @public */ BatchTransformInput?: BatchTransformInput | undefined; } /** *Information about where and how you want to store the results of a monitoring job.
* @public */ export interface MonitoringS3Output { /** *A URI that identifies the Amazon S3 storage location where Amazon SageMaker AI saves the results of a monitoring job.
* @public */ S3Uri: string | undefined; /** *The local path to the Amazon S3 storage location where Amazon SageMaker AI saves the results of a monitoring job. LocalPath is an absolute path for the output data.
* @public */ LocalPath: string | undefined; /** *Whether to upload the results of the monitoring job continuously or after the job completes.
* @public */ S3UploadMode?: ProcessingS3UploadMode | undefined; } /** *The output object for a monitoring job.
* @public */ export interface MonitoringOutput { /** *The Amazon S3 storage location where the results of a monitoring job are saved.
* @public */ S3Output: MonitoringS3Output | undefined; } /** *The output configuration for monitoring jobs.
* @public */ export interface MonitoringOutputConfig { /** *Monitoring outputs for monitoring jobs. This is where the output of the periodic monitoring jobs is uploaded.
* @public */ MonitoringOutputs: MonitoringOutput[] | undefined; /** *The Key Management Service (KMS) key that Amazon SageMaker AI uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.
* @public */ KmsKeyId?: string | undefined; } /** *Configuration for the cluster used to run model monitoring jobs.
* @public */ export interface MonitoringClusterConfig { /** *The number of ML compute instances to use in the model monitoring job. For distributed processing jobs, specify a value greater than 1. The default value is 1.
* @public */ InstanceCount: number | undefined; /** *The ML compute instance type for the processing job.
* @public */ InstanceType: ProcessingInstanceType | undefined; /** *The size of the ML storage volume, in gigabytes, that you want to provision. You must specify sufficient ML storage for your scenario.
* @public */ VolumeSizeInGB: number | undefined; /** *The Key Management Service (KMS) key that Amazon SageMaker AI uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the model monitoring job.
* @public */ VolumeKmsKeyId?: string | undefined; } /** *Identifies the resources to deploy for a monitoring job.
* @public */ export interface MonitoringResources { /** *The configuration for the cluster resources used to run the processing job.
* @public */ ClusterConfig: MonitoringClusterConfig | undefined; } /** *The networking configuration for the monitoring job.
* @public */ export interface MonitoringNetworkConfig { /** *Whether to encrypt all communications between the instances used for the monitoring jobs. Choose True to encrypt communications. Encryption provides greater security for distributed jobs, but the processing might take longer.
Whether to allow inbound and outbound network calls to and from the containers used for the monitoring job.
* @public */ EnableNetworkIsolation?: boolean | undefined; /** *Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC.
* @public */ VpcConfig?: VpcConfig | undefined; } /** *A time limit for how long the monitoring job is allowed to run before stopping.
* @public */ export interface MonitoringStoppingCondition { /** *The maximum runtime allowed in seconds.
The MaxRuntimeInSeconds cannot exceed the frequency of the job. For data quality and model explainability, this can be up to 3600 seconds for an hourly schedule. For model bias and model quality hourly schedules, this can be up to 1800 seconds.
The name for the monitoring job definition.
* @public */ JobDefinitionName: string | undefined; /** *Configures the constraints and baselines for the monitoring job.
* @public */ DataQualityBaselineConfig?: DataQualityBaselineConfig | undefined; /** *Specifies the container that runs the monitoring job.
* @public */ DataQualityAppSpecification: DataQualityAppSpecification | undefined; /** *A list of inputs for the monitoring job. Currently endpoints are supported as monitoring inputs.
* @public */ DataQualityJobInput: DataQualityJobInput | undefined; /** *The output configuration for monitoring jobs.
* @public */ DataQualityJobOutputConfig: MonitoringOutputConfig | undefined; /** *Identifies the resources to deploy for a monitoring job.
* @public */ JobResources: MonitoringResources | undefined; /** *Specifies networking configuration for the monitoring job.
* @public */ NetworkConfig?: MonitoringNetworkConfig | undefined; /** *The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.
* @public */ RoleArn: string | undefined; /** *A time limit for how long the monitoring job is allowed to run before stopping.
* @public */ StoppingCondition?: MonitoringStoppingCondition | undefined; /** *(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
* @public */ Tags?: Tag[] | undefined; } /** * @public */ export interface CreateDataQualityJobDefinitionResponse { /** *The Amazon Resource Name (ARN) of the job definition.
* @public */ JobDefinitionArn: string | undefined; } /** *The output configuration.
* @public */ export interface EdgeOutputConfig { /** *The Amazon Simple Storage (S3) bucker URI.
* @public */ S3OutputLocation: string | undefined; /** *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.
* @public */ KmsKeyId?: string | undefined; /** *The deployment type SageMaker Edge Manager will create. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.
* @public */ PresetDeploymentType?: EdgePresetDeploymentType | undefined; /** *The configuration used to create deployment artifacts. Specify configuration options with a JSON string. The available configuration options for each type are:
ComponentName (optional) - Name of the GreenGrass V2 component. If not specified, the default name generated consists of "SagemakerEdgeManager" and the name of your SageMaker Edge Manager packaging job.
ComponentDescription (optional) - Description of the component.
ComponentVersion (optional) - The version of the component.
Amazon Web Services IoT Greengrass uses semantic versions for components. Semantic versions follow a major.minor.patch number system. For example, version 1.0.0 represents the first major release for a component. For more information, see the semantic version specification.
PlatformOS (optional) - The name of the operating system for the platform. Supported platforms include Windows and Linux.
PlatformArchitecture (optional) - The processor architecture for the platform.
Supported architectures Windows include: Windows32_x86, Windows64_x64.
Supported architectures for Linux include: Linux x86_64, Linux ARMV8.
The name of the fleet that the device belongs to.
* @public */ DeviceFleetName: string | undefined; /** *The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).
* @public */ RoleArn?: string | undefined; /** *A description of the fleet.
* @public */ Description?: string | undefined; /** *The output configuration for storing sample data collected by the fleet.
* @public */ OutputConfig: EdgeOutputConfig | undefined; /** *Creates tags for the specified fleet.
* @public */ Tags?: Tag[] | undefined; /** *Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. The name of the role alias generated will match this pattern: "SageMakerEdge-\{DeviceFleetName\}".
For example, if your device fleet is called "demo-fleet", the name of the role alias will be "SageMakerEdge-demo-fleet".
* @public */ EnableIotRoleAlias?: boolean | undefined; } /** *The settings for assigning a custom Amazon EFS file system to a user profile or space for an Amazon SageMaker AI Domain.
* @public */ export interface EFSFileSystemConfig { /** *The ID of your Amazon EFS file system.
* @public */ FileSystemId: string | undefined; /** *The path to the file system directory that is accessible in Amazon SageMaker AI Studio. Permitted users can access only this directory and below.
* @public */ FileSystemPath?: string | undefined; } /** *The settings for assigning a custom Amazon FSx for Lustre file system to a user profile or space for an Amazon SageMaker Domain.
* @public */ export interface FSxLustreFileSystemConfig { /** *The globally unique, 17-digit, ID of the file system, assigned by Amazon FSx for Lustre.
* @public */ FileSystemId: string | undefined; /** *The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted users can access only this directory and below.
* @public */ FileSystemPath?: string | undefined; } /** *Configuration for the custom Amazon S3 file system.
* @public */ export interface S3FileSystemConfig { /** *The file system path where the Amazon S3 storage location will be mounted within the Amazon SageMaker Studio environment.
* @public */ MountPath?: string | undefined; /** *The Amazon S3 URI of the S3 file system configuration.
* @public */ S3Uri: string | undefined; } /** *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.
* @public */ export type CustomFileSystemConfig = CustomFileSystemConfig.EFSFileSystemConfigMember | CustomFileSystemConfig.FSxLustreFileSystemConfigMember | CustomFileSystemConfig.S3FileSystemConfigMember | CustomFileSystemConfig.$UnknownMember; /** * @public */ export declare namespace CustomFileSystemConfig { /** *The settings for a custom Amazon EFS file system.
* @public */ interface EFSFileSystemConfigMember { EFSFileSystemConfig: EFSFileSystemConfig; FSxLustreFileSystemConfig?: never; S3FileSystemConfig?: never; $unknown?: never; } /** *The settings for a custom Amazon FSx for Lustre file system.
* @public */ interface FSxLustreFileSystemConfigMember { EFSFileSystemConfig?: never; FSxLustreFileSystemConfig: FSxLustreFileSystemConfig; S3FileSystemConfig?: never; $unknown?: never; } /** *Configuration settings for a custom Amazon S3 file system.
* @public */ interface S3FileSystemConfigMember { EFSFileSystemConfig?: never; FSxLustreFileSystemConfig?: never; S3FileSystemConfig: S3FileSystemConfig; $unknown?: never; } /** * @public */ interface $UnknownMember { EFSFileSystemConfig?: never; FSxLustreFileSystemConfig?: never; S3FileSystemConfig?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorDetails about the POSIX identity that is used for file system operations.
* @public */ export interface CustomPosixUserConfig { /** *The POSIX user ID.
* @public */ Uid: number | undefined; /** *The POSIX group ID.
* @public */ Gid: number | undefined; } /** *The configuration parameters that specify the IAM roles assumed by the execution role of SageMaker (assumable roles) and the cluster instances or job execution environments (execution roles or runtime roles) to manage and access resources required for running Amazon EMR clusters or Amazon EMR Serverless applications.
* @public */ export interface EmrSettings { /** *An array of Amazon Resource Names (ARNs) of the IAM roles that the execution role of SageMaker can assume for performing operations or tasks related to Amazon EMR clusters or Amazon EMR Serverless applications. These roles define the permissions and access policies required when performing Amazon EMR-related operations, such as listing, connecting to, or terminating Amazon EMR clusters or Amazon EMR Serverless applications. They are typically used in cross-account access scenarios, where the Amazon EMR resources (clusters or serverless applications) are located in a different Amazon Web Services account than the SageMaker domain.
* @public */ AssumableRoleArns?: string[] | undefined; /** *An array of Amazon Resource Names (ARNs) of the IAM roles used by the Amazon EMR cluster instances or job execution environments to access other Amazon Web Services services and resources needed during the runtime of your Amazon EMR or Amazon EMR Serverless workloads, such as Amazon S3 for data access, Amazon CloudWatch for logging, or other Amazon Web Services services based on the particular workload requirements.
* @public */ ExecutionRoleArns?: string[] | undefined; } /** *The settings for the JupyterLab application.
* @public */ export interface JupyterLabAppSettings { /** *Specifies the ARN's of a SageMaker AI image and SageMaker AI image version, and the instance type that the version runs on.
When both SageMakerImageVersionArn and SageMakerImageArn are passed, SageMakerImageVersionArn is used. Any updates to SageMakerImageArn will not take effect if SageMakerImageVersionArn already exists in the ResourceSpec because SageMakerImageVersionArn always takes precedence. To clear the value set for SageMakerImageVersionArn, pass None as the value.
A list of custom SageMaker images that are configured to run as a JupyterLab app.
* @public */ CustomImages?: CustomImage[] | undefined; /** *The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. To remove a lifecycle config, you must set LifecycleConfigArns to an empty list.
A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.
* @public */ CodeRepositories?: CodeRepository[] | undefined; /** *Indicates whether idle shutdown is activated for JupyterLab applications.
* @public */ AppLifecycleManagement?: AppLifecycleManagement | undefined; /** *The configuration parameters that specify the IAM roles assumed by the execution role of SageMaker (assumable roles) and the cluster instances or job execution environments (execution roles or runtime roles) to manage and access resources required for running Amazon EMR clusters or Amazon EMR Serverless applications.
* @public */ EmrSettings?: EmrSettings | undefined; /** *The lifecycle configuration that runs before the default lifecycle configuration. It can override changes made in the default lifecycle configuration.
* @public */ BuiltInLifecycleConfigArn?: string | undefined; } /** *The JupyterServer app settings.
* @public */ export interface JupyterServerAppSettings { /** *The default instance type and the Amazon Resource Name (ARN) of the default SageMaker AI image used by the JupyterServer app. If you use the LifecycleConfigArns parameter, then this parameter is also required.
The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. If you use this parameter, the DefaultResourceSpec parameter is also required.
To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.
A list of Git repositories that SageMaker AI automatically displays to users for cloning in the JupyterServer application.
* @public */ CodeRepositories?: CodeRepository[] | undefined; } /** *The KernelGateway app settings.
* @public */ export interface KernelGatewayAppSettings { /** *The default instance type and the Amazon Resource Name (ARN) of the default SageMaker AI image used by the KernelGateway app.
The Amazon SageMaker AI Studio UI does not use the default instance type value set here. The default instance type set here is used when Apps are created using the CLI or CloudFormation and the instance type parameter value is not passed.
A list of custom SageMaker AI images that are configured to run as a KernelGateway app.
The maximum number of custom images are as follows.
On a domain level: 200
On a space level: 5
On a user profile level: 5
The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.
To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.
A collection of default EBS storage settings that apply to spaces created within a domain or user profile.
* @public */ export interface DefaultEbsStorageSettings { /** *The default size of the EBS storage volume for a space.
* @public */ DefaultEbsVolumeSizeInGb: number | undefined; /** *The maximum size of the EBS storage volume for a space.
* @public */ MaximumEbsVolumeSizeInGb: number | undefined; } /** *The default storage settings for a space.
* @public */ export interface DefaultSpaceStorageSettings { /** *The default EBS storage settings for a space.
* @public */ DefaultEbsStorageSettings?: DefaultEbsStorageSettings | undefined; } /** *The default settings for shared spaces that users create in the domain.
SageMaker applies these settings only to shared spaces. It doesn't apply them to private spaces.
* @public */ export interface DefaultSpaceSettings { /** *The ARN of the execution role for the space.
* @public */ ExecutionRole?: string | undefined; /** *The security group IDs for the Amazon VPC that the space uses for communication.
* @public */ SecurityGroups?: string[] | undefined; /** *The JupyterServer app settings.
* @public */ JupyterServerAppSettings?: JupyterServerAppSettings | undefined; /** *The KernelGateway app settings.
* @public */ KernelGatewayAppSettings?: KernelGatewayAppSettings | undefined; /** *The settings for the JupyterLab application.
* @public */ JupyterLabAppSettings?: JupyterLabAppSettings | undefined; /** *The default storage settings for a space.
* @public */ SpaceStorageSettings?: DefaultSpaceStorageSettings | undefined; /** *Details about the POSIX identity that is used for file system operations.
* @public */ CustomPosixUserConfig?: CustomPosixUserConfig | undefined; /** *The settings for assigning a custom file system to a domain. Permitted users can access this file system in Amazon SageMaker AI Studio.
* @public */ CustomFileSystemConfigs?: CustomFileSystemConfig[] | undefined; } /** *A collection of settings that apply to an RSessionGateway app.
Specifies the ARN's of a SageMaker AI image and SageMaker AI image version, and the instance type that the version runs on.
When both SageMakerImageVersionArn and SageMakerImageArn are passed, SageMakerImageVersionArn is used. Any updates to SageMakerImageArn will not take effect if SageMakerImageVersionArn already exists in the ResourceSpec because SageMakerImageVersionArn always takes precedence. To clear the value set for SageMakerImageVersionArn, pass None as the value.
A list of custom SageMaker AI images that are configured to run as a RSession app.
* @public */ CustomImages?: CustomImage[] | undefined; } /** *A collection of settings that configure user interaction with the RStudioServerPro app.
Indicates whether the current user has access to the RStudioServerPro app.
The level of permissions that the user has within the RStudioServerPro app. This value defaults to `User`. The `Admin` value allows the user access to the RStudio Administrative Dashboard.
Specifies options for sharing Amazon SageMaker AI Studio notebooks. These settings are specified as part of DefaultUserSettings when the CreateDomain API is called, and as part of UserSettings when the CreateUserProfile API is called. When SharingSettings is not specified, notebook sharing isn't allowed.
Whether to include the notebook cell output when sharing the notebook. The default is Disabled.
When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.
When NotebookOutputOption is Allowed, the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.
The SageMaker images that are hidden from the Studio user interface. You must specify the SageMaker image name and version aliases.
* @public */ export interface HiddenSageMakerImage { /** *The SageMaker image name that you are hiding from the Studio user interface.
* @public */ SageMakerImageName?: SageMakerImageName | undefined; /** *The version aliases you are hiding from the Studio user interface.
* @public */ VersionAliases?: string[] | undefined; } /** *Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.
* @public */ export interface StudioWebPortalSettings { /** *The machine learning tools that are hidden from the Studio left navigation pane.
* @public */ HiddenMlTools?: MlTools[] | undefined; /** *The Applications supported in Studio that are hidden from the Studio left navigation pane.
* @public */ HiddenAppTypes?: AppType[] | undefined; /** *The instance types you are hiding from the Studio user interface.
* @public */ HiddenInstanceTypes?: AppInstanceType[] | undefined; /** *The version aliases you are hiding from the Studio user interface.
* @public */ HiddenSageMakerImageVersionAliases?: HiddenSageMakerImage[] | undefined; } /** *The TensorBoard app settings.
* @public */ export interface TensorBoardAppSettings { /** *The default instance type and the Amazon Resource Name (ARN) of the SageMaker AI image created on the instance.
* @public */ DefaultResourceSpec?: ResourceSpec | undefined; } /** *A collection of settings that apply to users in a domain. These settings are specified when the CreateUserProfile API is called, and as DefaultUserSettings when the CreateDomain API is called.
SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings, the values specified in CreateUserProfile take precedence over those specified in CreateDomain.
The execution role for the user.
SageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.
* @public */ ExecutionRole?: string | undefined; /** *The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.
Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly, unless specified as part of the DefaultUserSettings for the domain.
Amazon SageMaker AI adds a security group to allow NFS traffic from Amazon SageMaker AI Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.
SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.
* @public */ SecurityGroups?: string[] | undefined; /** *Specifies options for sharing Amazon SageMaker AI Studio notebooks.
* @public */ SharingSettings?: SharingSettings | undefined; /** *The Jupyter server's app settings.
* @public */ JupyterServerAppSettings?: JupyterServerAppSettings | undefined; /** *The kernel gateway app settings.
* @public */ KernelGatewayAppSettings?: KernelGatewayAppSettings | undefined; /** *The TensorBoard app settings.
* @public */ TensorBoardAppSettings?: TensorBoardAppSettings | undefined; /** *A collection of settings that configure user interaction with the RStudioServerPro app.
A collection of settings that configure the RSessionGateway app.
The Canvas app settings.
SageMaker applies these settings only to private spaces that SageMaker creates for the Canvas app.
* @public */ CanvasAppSettings?: CanvasAppSettings | undefined; /** *The Code Editor application settings.
SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.
* @public */ CodeEditorAppSettings?: CodeEditorAppSettings | undefined; /** *The settings for the JupyterLab application.
SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.
* @public */ JupyterLabAppSettings?: JupyterLabAppSettings | undefined; /** *The storage settings for a space.
SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.
* @public */ SpaceStorageSettings?: DefaultSpaceStorageSettings | undefined; /** *The default experience that the user is directed to when accessing the domain. The supported values are:
studio::: Indicates that Studio is the default experience. This value can only be passed if StudioWebPortal is set to ENABLED.
app:JupyterServer:: Indicates that Studio Classic is the default experience.
Whether the user can access Studio. If this value is set to DISABLED, the user cannot access Studio, even if that is the default experience for the domain.
Details about the POSIX identity that is used for file system operations.
SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.
* @public */ CustomPosixUserConfig?: CustomPosixUserConfig | undefined; /** *The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker AI Studio.
SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.
* @public */ CustomFileSystemConfigs?: CustomFileSystemConfig[] | undefined; /** *Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.
* @public */ StudioWebPortalSettings?: StudioWebPortalSettings | undefined; /** *Indicates whether auto-mounting of an EFS volume is supported for the user profile. The DefaultAsDomain value is only supported for user profiles. Do not use the DefaultAsDomain value when setting this parameter for a domain.
SageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.
* @public */ AutoMountHomeEFS?: AutoMountHomeEFS | undefined; } /** *A collection of settings that configure the domain's Docker interaction.
* @public */ export interface DockerSettings { /** *Indicates whether the domain can access Docker.
* @public */ EnableDockerAccess?: FeatureStatus | undefined; /** *The list of Amazon Web Services accounts that are trusted when the domain is created in VPC-only mode.
* @public */ VpcOnlyTrustedAccounts?: string[] | undefined; /** *Indicates whether to use rootless Docker.
* @public */ RootlessDocker?: FeatureStatus | undefined; } /** *A collection of settings that configure the RStudioServerPro Domain-level app.
The ARN of the execution role for the RStudioServerPro Domain-level app.
A URL pointing to an RStudio Connect server.
* @public */ RStudioConnectUrl?: string | undefined; /** *A URL pointing to an RStudio Package Manager server.
* @public */ RStudioPackageManagerUrl?: string | undefined; /** *Specifies the ARN's of a SageMaker AI image and SageMaker AI image version, and the instance type that the version runs on.
When both SageMakerImageVersionArn and SageMakerImageArn are passed, SageMakerImageVersionArn is used. Any updates to SageMakerImageArn will not take effect if SageMakerImageVersionArn already exists in the ResourceSpec because SageMakerImageVersionArn always takes precedence. To clear the value set for SageMakerImageVersionArn, pass None as the value.
The Trusted Identity Propagation (TIP) settings for the SageMaker domain. These settings determine how user identities from IAM Identity Center are propagated through the domain to TIP enabled Amazon Web Services services.
* @public */ export interface TrustedIdentityPropagationSettings { /** *The status of Trusted Identity Propagation (TIP) at the SageMaker domain level.
When disabled, standard IAM role-based access is used.
When enabled:
User identities from IAM Identity Center are propagated through the application to TIP enabled Amazon Web Services services.
New applications or existing applications that are automatically patched, will use the domain level configuration.
The settings that apply to an Amazon SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.
* @public */ export interface UnifiedStudioSettings { /** *Sets whether you can access the domain in Amazon SageMaker Studio:
You can access the domain in Amazon SageMaker Studio. If you migrate the domain to Amazon SageMaker Unified Studio, you can access it in both studio interfaces.
You can't access the domain in Amazon SageMaker Studio. If you migrate the domain to Amazon SageMaker Unified Studio, you can access it only in that studio interface.
To migrate a domain to Amazon SageMaker Unified Studio, you specify the UnifiedStudioSettings data type when you use the UpdateDomain action.
* @public */ StudioWebPortalAccess?: FeatureStatus | undefined; /** *The ID of the Amazon Web Services account that has the Amazon SageMaker Unified Studio domain. The default value, if you don't specify an ID, is the ID of the account that has the Amazon SageMaker AI domain.
* @public */ DomainAccountId?: string | undefined; /** *The Amazon Web Services Region where the domain is located in Amazon SageMaker Unified Studio. The default value, if you don't specify a Region, is the Region where the Amazon SageMaker AI domain is located.
* @public */ DomainRegion?: string | undefined; /** *The ID of the Amazon SageMaker Unified Studio domain associated with this domain.
* @public */ DomainId?: string | undefined; /** *The ID of the Amazon SageMaker Unified Studio project that corresponds to the domain.
* @public */ ProjectId?: string | undefined; /** *The ID of the environment that Amazon SageMaker Unified Studio associates with the domain.
* @public */ EnvironmentId?: string | undefined; /** *The location where Amazon S3 stores temporary execution data and other artifacts for the project that corresponds to the domain.
* @public */ ProjectS3Path?: string | undefined; /** *The ARN of the Amazon DataZone application managed by Amazon SageMaker Unified Studio in the Amazon Web Services IAM Identity Center.
* @public */ SingleSignOnApplicationArn?: string | undefined; } /** *A collection of settings that apply to the SageMaker Domain. These settings are specified through the CreateDomain API call.
The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.
A collection of settings that configure the RStudioServerPro Domain-level app.
The configuration for attaching a SageMaker AI user profile name to the execution role as a sts:SourceIdentity key.
* @public */ ExecutionRoleIdentityConfig?: ExecutionRoleIdentityConfig | undefined; /** *The Trusted Identity Propagation (TIP) settings for the SageMaker domain. These settings determine how user identities from IAM Identity Center are propagated through the domain to TIP enabled Amazon Web Services services.
* @public */ TrustedIdentityPropagationSettings?: TrustedIdentityPropagationSettings | undefined; /** *A collection of settings that configure the domain's Docker interaction.
* @public */ DockerSettings?: DockerSettings | undefined; /** *A collection of settings that configure the Amazon Q experience within the domain. The AuthMode that you use to create the domain must be SSO.
The settings that apply to an SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.
* @public */ UnifiedStudioSettings?: UnifiedStudioSettings | undefined; /** *The IP address type for the domain. Specify ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity. When you specify dualstack, the subnet must support IPv6 CIDR blocks. If not specified, defaults to ipv4.
A name for the domain.
* @public */ DomainName: string | undefined; /** *The mode of authentication that members use to access the domain.
* @public */ AuthMode: AuthMode | undefined; /** *The default settings to use to create a user profile when UserSettings isn't specified in the call to the CreateUserProfile API.
SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings, the values specified in CreateUserProfile take precedence over those specified in CreateDomain.
A collection of Domain settings.
The VPC subnets that the domain uses for communication.
The field is optional when the AppNetworkAccessType parameter is set to PublicInternetOnly for domains created from Amazon SageMaker Unified Studio.
The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
The field is optional when the AppNetworkAccessType parameter is set to PublicInternetOnly for domains created from Amazon SageMaker Unified Studio.
Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.
Tags that you specify for the Domain are also added to all Apps that the Domain launches.
* @public */ Tags?: Tag[] | undefined; /** *Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.
PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access
VpcOnly - All traffic is through the specified VPC and subnets
Use KmsKeyId.
SageMaker AI uses Amazon Web Services KMS to encrypt EFS and EBS volumes attached to the domain with an Amazon Web Services managed key by default. For more control, specify a customer managed key.
* @public */ KmsKeyId?: string | undefined; /** *The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. If setting up the domain for use with RStudio, this value must be set to Service.
Indicates whether custom tag propagation is supported for the domain. Defaults to DISABLED.
The default settings for shared spaces that users create in the domain.
* @public */ DefaultSpaceSettings?: DefaultSpaceSettings | undefined; } /** * @public */ export interface CreateDomainResponse { /** *The Amazon Resource Name (ARN) of the created domain.
* @public */ DomainArn?: string | undefined; /** *The ID of the created domain.
* @public */ DomainId?: string | undefined; /** *The URL to the created domain.
* @public */ Url?: string | undefined; } /** *Contains information about the configuration of a model in a deployment.
* @public */ export interface EdgeDeploymentModelConfig { /** *The name the device application uses to reference this model.
* @public */ ModelHandle: string | undefined; /** *The edge packaging job associated with this deployment.
* @public */ EdgePackagingJobName: string | undefined; } /** *Contains information about the configuration of a deployment.
* @public */ export interface EdgeDeploymentConfig { /** *Toggle that determines whether to rollback to previous configuration if the current deployment fails. By default this is turned on. You may turn this off if you want to investigate the errors yourself.
* @public */ FailureHandlingPolicy: FailureHandlingPolicy | undefined; } /** *Contains information about the configurations of selected devices.
* @public */ export interface DeviceSelectionConfig { /** *Type of device subsets to deploy to the current stage.
* @public */ DeviceSubsetType: DeviceSubsetType | undefined; /** *Percentage of devices in the fleet to deploy to the current stage.
* @public */ Percentage?: number | undefined; /** *List of devices chosen to deploy.
* @public */ DeviceNames?: string[] | undefined; /** *A filter to select devices with names containing this name.
* @public */ DeviceNameContains?: string | undefined; } /** *Contains information about a stage in an edge deployment plan.
* @public */ export interface DeploymentStage { /** *The name of the stage.
* @public */ StageName: string | undefined; /** *Configuration of the devices in the stage.
* @public */ DeviceSelectionConfig: DeviceSelectionConfig | undefined; /** *Configuration of the deployment details.
* @public */ DeploymentConfig?: EdgeDeploymentConfig | undefined; } /** * @public */ export interface CreateEdgeDeploymentPlanRequest { /** *The name of the edge deployment plan.
* @public */ EdgeDeploymentPlanName: string | undefined; /** *List of models associated with the edge deployment plan.
* @public */ ModelConfigs: EdgeDeploymentModelConfig[] | undefined; /** *The device fleet used for this edge deployment plan.
* @public */ DeviceFleetName: string | undefined; /** *List of stages of the edge deployment plan. The number of stages is limited to 10 per deployment.
* @public */ Stages?: DeploymentStage[] | undefined; /** *List of tags with which to tag the edge deployment plan.
* @public */ Tags?: Tag[] | undefined; } /** * @public */ export interface CreateEdgeDeploymentPlanResponse { /** *The ARN of the edge deployment plan.
* @public */ EdgeDeploymentPlanArn: string | undefined; } /** * @public */ export interface CreateEdgeDeploymentStageRequest { /** *The name of the edge deployment plan.
* @public */ EdgeDeploymentPlanName: string | undefined; /** *List of stages to be added to the edge deployment plan.
* @public */ Stages: DeploymentStage[] | undefined; } /** * @public */ export interface CreateEdgePackagingJobRequest { /** *The name of the edge packaging job.
* @public */ EdgePackagingJobName: string | undefined; /** *The name of the SageMaker Neo compilation job that will be used to locate model artifacts for packaging.
* @public */ CompilationJobName: string | undefined; /** *The name of the model.
* @public */ ModelName: string | undefined; /** *The version of the model.
* @public */ ModelVersion: string | undefined; /** *The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact SageMaker Neo.
* @public */ RoleArn: string | undefined; /** *Provides information about the output location for the packaged model.
* @public */ OutputConfig: EdgeOutputConfig | undefined; /** *The Amazon Web Services KMS key to use when encrypting the EBS volume the edge packaging job runs on.
* @public */ ResourceKey?: string | undefined; /** *Creates tags for the packaging job.
* @public */ Tags?: Tag[] | undefined; } /** *Specifies a rolling deployment strategy for updating a SageMaker endpoint.
* @public */ export interface RollingUpdatePolicy { /** *Batch size for each rolling step to provision capacity and turn on traffic on the new endpoint fleet, and terminate capacity on the old endpoint fleet. Value must be between 5% to 50% of the variant's total instance count.
* @public */ MaximumBatchSize: CapacitySize | undefined; /** *The length of the baking period, during which SageMaker monitors alarms for each batch on the new fleet.
* @public */ WaitIntervalInSeconds: number | undefined; /** *The time limit for the total deployment. Exceeding this limit causes a timeout.
* @public */ MaximumExecutionTimeoutInSeconds?: number | undefined; /** *Batch size for rollback to the old endpoint fleet. Each rolling step to provision capacity and turn on traffic on the old endpoint fleet, and terminate capacity on the new endpoint fleet. If this field is absent, the default value will be set to 100% of total capacity which means to bring up the whole capacity of the old fleet at once during rollback.
* @public */ RollbackMaximumBatchSize?: CapacitySize | undefined; } /** *The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.
* @public */ export interface DeploymentConfig { /** *Update policy for a blue/green deployment. If this update policy is specified, SageMaker creates a new fleet during the deployment while maintaining the old fleet. SageMaker flips traffic to the new fleet according to the specified traffic routing configuration. Only one update policy should be used in the deployment configuration. If no update policy is specified, SageMaker uses a blue/green deployment strategy with all at once traffic shifting by default.
* @public */ BlueGreenUpdatePolicy?: BlueGreenUpdatePolicy | undefined; /** *Specifies a rolling deployment strategy for updating a SageMaker endpoint.
* @public */ RollingUpdatePolicy?: RollingUpdatePolicy | undefined; /** *Automatic rollback configuration for handling endpoint deployment failures and recovery.
* @public */ AutoRollbackConfiguration?: AutoRollbackConfig | undefined; } /** * @public */ export interface CreateEndpointInput { /** *The name of the endpoint.The name must be unique within an Amazon Web Services Region in your Amazon Web Services account. The name is case-insensitive in CreateEndpoint, but the case is preserved and must be matched in InvokeEndpoint.
The name of an endpoint configuration. For more information, see CreateEndpointConfig.
* @public */ EndpointConfigName: string | undefined; /** *The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.
* @public */ DeploymentConfig?: DeploymentConfig | undefined; /** *An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
* @public */ Tags?: Tag[] | undefined; } /** * @public */ export interface CreateEndpointOutput { /** *The Amazon Resource Name (ARN) of the endpoint.
* @public */ EndpointArn: string | undefined; } /** *Configuration to control how SageMaker AI captures inference data.
* @public */ export interface DataCaptureConfig { /** *Whether data capture should be enabled or disabled (defaults to enabled).
* @public */ EnableCapture?: boolean | undefined; /** *The percentage of requests SageMaker AI will capture. A lower value is recommended for Endpoints with high traffic.
* @public */ InitialSamplingPercentage: number | undefined; /** *The Amazon S3 location used to capture the data.
* @public */ DestinationS3Uri: string | undefined; /** *The Amazon Resource Name (ARN) of an Key Management Service key that SageMaker AI uses to encrypt the captured data at rest using Amazon S3 server-side encryption.
The KmsKeyId can be any of the following formats:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias
Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
Specifies data Model Monitor will capture. You can configure whether to collect only input, only output, or both
* @public */ CaptureOptions: CaptureOption[] | undefined; /** *Configuration specifying how to treat different headers. If no headers are specified SageMaker AI will by default base64 encode when capturing the data.
* @public */ CaptureContentTypeHeader?: CaptureContentTypeHeader | undefined; } /** *A parameter to activate explainers.
* @public */ export interface ExplainerConfig { /** *A member of ExplainerConfig that contains configuration parameters for the SageMaker Clarify explainer.
The configuration for Utilization metrics.
* @public */ export interface MetricsConfig { /** *Specifies whether to enable enhanced metrics for the endpoint. Enhanced metrics provide utilization data at instance and container granularity. Container granularity is supported for Inference Components. The default is False.
The frequency, in seconds, at which utilization metrics are published to Amazon CloudWatch. The default is 60 seconds.
Settings for the capacity reservation for the compute instances that SageMaker AI reserves for an endpoint.
* @public */ export interface ProductionVariantCapacityReservationConfig { /** *Options that you can choose for the capacity reservation. SageMaker AI supports the following options:
SageMaker AI launches instances only into an ML capacity reservation. If no capacity is available, the instances fail to launch.
The Amazon Resource Name (ARN) that uniquely identifies the ML capacity reservation that SageMaker AI applies when it deploys the endpoint.
* @public */ MlReservationArn?: string | undefined; } /** *Specifies configuration for a core dump from the model container when the process crashes.
* @public */ export interface ProductionVariantCoreDumpConfig { /** *The Amazon S3 bucket to send the core dump to.
* @public */ DestinationS3Uri: string | undefined; /** *The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the core dump data at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:
// KMS Key ID
"1234abcd-12ab-34cd-56ef-1234567890ab"
// Amazon Resource Name (ARN) of a KMS Key
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
// KMS Key Alias
"alias/ExampleAlias"
// Amazon Resource Name (ARN) of a KMS Key Alias
"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, SageMaker uses the default KMS key for Amazon S3 for your role's account. SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.
The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint and UpdateEndpoint requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.
Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.
* @public */ export interface ProductionVariantManagedInstanceScaling { /** *Indicates whether managed instance scaling is enabled.
* @public */ Status?: ManagedInstanceScalingStatus | undefined; /** *The minimum number of instances that the endpoint must retain when it scales down to accommodate a decrease in traffic.
* @public */ MinInstanceCount?: number | undefined; /** *The maximum number of instances that the endpoint can provision when it scales up to accommodate an increase in traffic.
* @public */ MaxInstanceCount?: number | undefined; } /** *Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.
* @public */ export interface ProductionVariantRoutingConfig { /** *Sets how the endpoint routes incoming traffic:
LEAST_OUTSTANDING_REQUESTS: The endpoint routes requests to the specific instances that have more capacity to process them.
RANDOM: The endpoint routes each request to a randomly chosen instance.
Specifies the serverless configuration for an endpoint variant.
* @public */ export interface ProductionVariantServerlessConfig { /** *The memory size of your serverless endpoint. Valid values are in 1 GB increments: 1024 MB, 2048 MB, 3072 MB, 4096 MB, 5120 MB, or 6144 MB.
* @public */ MemorySizeInMB: number | undefined; /** *The maximum number of concurrent invocations your serverless endpoint can process.
* @public */ MaxConcurrency: number | undefined; /** *The amount of provisioned concurrency to allocate for the serverless endpoint. Should be less than or equal to MaxConcurrency.
This field is not supported for serverless endpoint recommendations for Inference Recommender jobs. For more information about creating an Inference Recommender job, see CreateInferenceRecommendationsJobs.
Identifies a model that you want to host and the resources chosen to deploy for hosting it. If you are deploying multiple models, tell SageMaker how to distribute traffic among the models by specifying variant weights. For more information on production variants, check Production variants.
* @public */ export interface ProductionVariant { /** *The name of the production variant.
* @public */ VariantName: string | undefined; /** *The name of the model that you want to host. This is the name that you specified when creating the model.
* @public */ ModelName?: string | undefined; /** *Number of instances to launch initially.
* @public */ InitialInstanceCount?: number | undefined; /** *The ML compute instance type.
* @public */ InstanceType?: ProductionVariantInstanceType | undefined; /** *Determines initial traffic distribution among all of the models that you specify in the endpoint configuration. The traffic to a production variant is determined by the ratio of the VariantWeight to the sum of all VariantWeight values across all ProductionVariants. If unspecified, it defaults to 1.0.
This parameter is no longer supported. Elastic Inference (EI) is no longer available.
This parameter was used to specify the size of the EI instance to use for the production variant.
* @public */ AcceleratorType?: ProductionVariantAcceleratorType | undefined; /** *Specifies configuration for a core dump from the model container when the process crashes.
* @public */ CoreDumpConfig?: ProductionVariantCoreDumpConfig | undefined; /** *The serverless configuration for an endpoint. Specifies a serverless endpoint configuration instead of an instance-based endpoint configuration.
* @public */ ServerlessConfig?: ProductionVariantServerlessConfig | undefined; /** *The size, in GB, of the ML storage volume attached to individual inference instance associated with the production variant. Currently only Amazon EBS gp2 storage volumes are supported.
* @public */ VolumeSizeInGB?: number | undefined; /** *The timeout value, in seconds, to download and extract the model that you want to host from Amazon S3 to the individual inference instance associated with this production variant.
* @public */ ModelDataDownloadTimeoutInSeconds?: number | undefined; /** *The timeout value, in seconds, for your inference container to pass health check by SageMaker Hosting. For more information about health check, see How Your Container Should Respond to Health Check (Ping) Requests.
* @public */ ContainerStartupHealthCheckTimeoutInSeconds?: number | undefined; /** * You can use this parameter to turn on native Amazon Web Services Systems Manager (SSM) access for a production variant behind an endpoint. By default, SSM access is disabled for all production variants behind an endpoint. You can turn on or turn off SSM access for a production variant behind an existing endpoint by creating a new endpoint configuration and calling UpdateEndpoint.
Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.
* @public */ ManagedInstanceScaling?: ProductionVariantManagedInstanceScaling | undefined; /** *Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.
* @public */ RoutingConfig?: ProductionVariantRoutingConfig | undefined; /** *Specifies an option from a collection of preconfigured Amazon Machine Image (AMI) images. Each image is configured by Amazon Web Services with a set of software and driver versions. Amazon Web Services optimizes these configurations for different machine learning workloads.
By selecting an AMI version, you can ensure that your inference environment is compatible with specific software requirements, such as CUDA driver versions, Linux kernel versions, or Amazon Web Services Neuron driver versions.
The AMI version names, and their configurations, are the following:
Accelerator: GPU
NVIDIA driver version: 535
CUDA version: 12.2
Accelerator: GPU
NVIDIA driver version: 535
CUDA version: 12.2
NVIDIA Container Toolkit with disabled CUDA-compat mounting
Accelerator: GPU
NVIDIA driver version: 550
CUDA version: 12.4
NVIDIA Container Toolkit with disabled CUDA-compat mounting
Accelerator: Inferentia2 and Trainium
Neuron driver version: 2.19
Settings for the capacity reservation for the compute instances that SageMaker AI reserves for an endpoint.
* @public */ CapacityReservationConfig?: ProductionVariantCapacityReservationConfig | undefined; } /** * @public */ export interface CreateEndpointConfigInput { /** *The name of the endpoint configuration. You specify this name in a CreateEndpoint request.
* @public */ EndpointConfigName: string | undefined; /** *An array of ProductionVariant objects, one for each model that you want to host at this endpoint.
Configuration to control how SageMaker AI captures inference data.
* @public */ DataCaptureConfig?: DataCaptureConfig | undefined; /** *An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
* @public */ Tags?: Tag[] | undefined; /** *The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.
The KmsKeyId can be any of the following formats:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias
Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint, UpdateEndpoint requests. For more information, refer to the Amazon Web Services Key Management Service section Using Key Policies in Amazon Web Services KMS
Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a KmsKeyId when using an instance type with local storage. If any of the models that you specify in the ProductionVariants parameter use nitro-based instances with local storage, do not specify a value for the KmsKeyId parameter. If you specify a value for KmsKeyId when using any nitro-based instances with local storage, the call to CreateEndpointConfig fails.
For a list of instance types that support local instance storage, see Instance Store Volumes.
For more information about local instance storage encryption, see SSD Instance Store Volumes.
Specifies configuration for how an endpoint performs asynchronous inference. This is a required field in order for your Endpoint to be invoked using InvokeEndpointAsync.
* @public */ AsyncInferenceConfig?: AsyncInferenceConfig | undefined; /** *A member of CreateEndpointConfig that enables explainers.
An array of ProductionVariant objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants. If you use this field, you can only specify one variant for ProductionVariants and one variant for ShadowProductionVariants.
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform actions on your behalf. For more information, see SageMaker AI Roles.
To be able to pass this role to Amazon SageMaker AI, the caller of this action must have the iam:PassRole permission.
Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC.
* @public */ VpcConfig?: VpcConfig | undefined; /** *Sets whether all model containers deployed to the endpoint are isolated. If they are, no inbound or outbound network calls can be made to or from the model containers.
* @public */ EnableNetworkIsolation?: boolean | undefined; /** *The configuration parameters for utilization metrics.
* @public */ MetricsConfig?: MetricsConfig | undefined; } /** * @public */ export interface CreateEndpointConfigOutput { /** *The Amazon Resource Name (ARN) of the endpoint configuration.
* @public */ EndpointConfigArn: string | undefined; } /** * @public */ export interface CreateExperimentRequest { /** *The name of the experiment. The name must be unique in your Amazon Web Services account and is not case-sensitive.
* @public */ ExperimentName: string | undefined; /** *The name of the experiment as displayed. The name doesn't need to be unique. If you don't specify DisplayName, the value in ExperimentName is displayed.
The description of the experiment.
* @public */ Description?: string | undefined; /** *A list of tags to associate with the experiment. You can use Search API to search on the tags.
* @public */ Tags?: Tag[] | undefined; } /** * @public */ export interface CreateExperimentResponse { /** *The Amazon Resource Name (ARN) of the experiment.
* @public */ ExperimentArn?: string | undefined; } /** *A list of features. You must include FeatureName and FeatureType. Valid feature FeatureTypes are Integral, Fractional and String.
The name of a feature. The type must be a string. FeatureName cannot be any of the following: is_deleted, write_time, api_invocation_time.
The name:
Must start with an alphanumeric character.
Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.
The value type of a feature. Valid values are Integral, Fractional, or String.
* @public */ FeatureType: FeatureType | undefined; /** *A grouping of elements where each element within the collection must have the same feature type (String, Integral, or Fractional).
List: An ordered collection of elements.
Set: An unordered collection of unique elements.
Vector: A specialized list that represents a fixed-size array of elements. The vector dimension is determined by you. Must have elements with fractional feature types.
Configuration for your collection.
* @public */ CollectionConfig?: CollectionConfig | undefined; } /** *The meta data of the Glue table which serves as data catalog for the OfflineStore.
The name of the Glue table.
* @public */ TableName: string | undefined; /** *The name of the Glue table catalog.
* @public */ Catalog: string | undefined; /** *The name of the Glue table database.
* @public */ Database: string | undefined; } /** *The Amazon Simple Storage (Amazon S3) location and security configuration for OfflineStore.
The S3 URI, or location in Amazon S3, of OfflineStore.
S3 URIs have a format similar to the following: s3://example-bucket/prefix/.
The Amazon Web Services Key Management Service (KMS) key ARN of the key used to encrypt any objects written into the OfflineStore S3 location.
The IAM roleARN that is passed as a parameter to CreateFeatureGroup must have below permissions to the KmsKeyId:
"kms:GenerateDataKey"
The S3 path where offline records are written.
* @public */ ResolvedOutputS3Uri?: string | undefined; } /** *The configuration of an OfflineStore.
Provide an OfflineStoreConfig in a request to CreateFeatureGroup to create an OfflineStore.
To encrypt an OfflineStore using at rest data encryption, specify Amazon Web Services Key Management Service (KMS) key ID, or KMSKeyId, in S3StorageConfig.
The Amazon Simple Storage (Amazon S3) location of OfflineStore.
Set to True to disable the automatic creation of an Amazon Web Services Glue table when configuring an OfflineStore. If set to False, Feature Store will name the OfflineStore Glue table following Athena's naming recommendations.
The default value is False.
The meta data of the Glue table that is autogenerated when an OfflineStore is created.
Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.
* @public */ TableFormat?: TableFormat | undefined; } /** *The security configuration for OnlineStore.
The Amazon Web Services Key Management Service (KMS) key ARN that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption.
The caller (either user or IAM role) of CreateFeatureGroup must have below permissions to the OnlineStore KmsKeyId:
"kms:Encrypt"
"kms:Decrypt"
"kms:DescribeKey"
"kms:CreateGrant"
"kms:RetireGrant"
"kms:ReEncryptFrom"
"kms:ReEncryptTo"
"kms:GenerateDataKey"
"kms:ListAliases"
"kms:ListGrants"
"kms:RevokeGrant"
The caller (either user or IAM role) to all DataPlane operations (PutRecord, GetRecord, DeleteRecord) must have the following permissions to the KmsKeyId:
"kms:Decrypt"
Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
TtlDuration time unit.
TtlDuration time value.
Use this to specify the Amazon Web Services Key Management Service (KMS) Key ID, or KMSKeyId, for at rest data encryption. You can turn OnlineStore on or off by specifying the EnableOnlineStore flag at General Assembly.
The default value is False.
Use to specify KMS Key ID (KMSKeyId) for at-rest encryption of your OnlineStore.
Turn OnlineStore off by specifying False for the EnableOnlineStore flag. Turn OnlineStore on by specifying True for the EnableOnlineStore flag.
The default value is False.
Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
Option for different tiers of low latency storage for real-time data retrieval.
Standard: A managed low latency data store for feature groups.
InMemory: A managed data store for feature groups that supports very low latency retrieval.
Used to set feature group throughput configuration. There are two modes: ON_DEMAND and PROVISIONED. With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled.
Note: PROVISIONED throughput mode is supported only for feature groups that are offline-only, or use the Standard tier online store.
The mode used for your feature group throughput: ON_DEMAND or PROVISIONED.
For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.
This field is not applicable for on-demand feature groups.
* @public */ ProvisionedReadCapacityUnits?: number | undefined; /** *For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.
This field is not applicable for on-demand feature groups.
* @public */ ProvisionedWriteCapacityUnits?: number | undefined; } /** * @public */ export interface CreateFeatureGroupRequest { /** *The name of the FeatureGroup. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.
The name:
Must start with an alphanumeric character.
Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.
The name of the Feature whose value uniquely identifies a Record defined in the FeatureStore. Only the latest record per identifier value will be stored in the OnlineStore. RecordIdentifierFeatureName must be one of feature definitions' names.
You use the RecordIdentifierFeatureName to access data in a FeatureStore.
This name:
Must start with an alphanumeric character.
Can only contains alphanumeric characters, hyphens, underscores. Spaces are not allowed.
The name of the feature that stores the EventTime of a Record in a FeatureGroup.
An EventTime is a point in time when a new event occurs that corresponds to the creation or update of a Record in a FeatureGroup. All Records in the FeatureGroup must have a corresponding EventTime.
An EventTime can be a String or Fractional.
Fractional: EventTime feature values must be a Unix timestamp in seconds.
String: EventTime feature values must be an ISO-8601 string in the format. The following formats are supported yyyy-MM-dd'T'HH:mm:ssZ and yyyy-MM-dd'T'HH:mm:ss.SSSZ where yyyy, MM, and dd represent the year, month, and day respectively and HH, mm, ss, and if applicable, SSS represent the hour, month, second and milliseconds respsectively. 'T' and Z are constants.
A list of Feature names and types. Name and Type is compulsory per Feature.
Valid feature FeatureTypes are Integral, Fractional and String.
FeatureNames cannot be any of the following: is_deleted, write_time, api_invocation_time
You can create up to 2,500 FeatureDefinitions per FeatureGroup.
You can turn the OnlineStore on or off by specifying True for the EnableOnlineStore flag in OnlineStoreConfig.
You can also include an Amazon Web Services KMS key ID (KMSKeyId) for at-rest encryption of the OnlineStore.
The default value is False.
Use this to configure an OfflineFeatureStore. This parameter allows you to specify:
The Amazon Simple Storage Service (Amazon S3) location of an OfflineStore.
A configuration for an Amazon Web Services Glue or Amazon Web Services Hive data catalog.
An KMS encryption key to encrypt the Amazon S3 location used for OfflineStore. If KMS encryption key is not specified, by default we encrypt all data at rest using Amazon Web Services KMS key. By defining your bucket-level key for SSE, you can reduce Amazon Web Services KMS requests costs by up to 99 percent.
Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.
To learn more about this parameter, see OfflineStoreConfig.
* @public */ OfflineStoreConfig?: OfflineStoreConfig | undefined; /** *Used to set feature group throughput configuration. There are two modes: ON_DEMAND and PROVISIONED. With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled.
Note: PROVISIONED throughput mode is supported only for feature groups that are offline-only, or use the Standard tier online store.
The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.
A free-form description of a FeatureGroup.
Tags used to identify Features in each FeatureGroup.
The Amazon Resource Name (ARN) of the FeatureGroup. This is a unique identifier for the feature group.
Defines under what conditions SageMaker creates a human loop. Used within CreateFlowDefinition. See HumanLoopActivationConditionsConfig for the required format of activation conditions.
* @public */ export interface HumanLoopActivationConditionsConfig { /** *JSON expressing use-case specific conditions declaratively. If any condition is matched, atomic tasks are created against the configured work team. The set of conditions is different for Rekognition and Textract. For more information about how to structure the JSON, see JSON Schema for Human Loop Activation Conditions in Amazon Augmented AI in the Amazon SageMaker Developer Guide.
* @public */ HumanLoopActivationConditions: __AutomaticJsonStringConversion | string | undefined; } /** *Provides information about how and under what conditions SageMaker creates a human loop. If HumanLoopActivationConfig is not given, then all requests go to humans.
Container structure for defining under what conditions SageMaker creates a human loop.
* @public */ HumanLoopActivationConditionsConfig: HumanLoopActivationConditionsConfig | undefined; } /** *Represents an amount of money in United States dollars.
* @public */ export interface USD { /** *The whole number of dollars in the amount.
* @public */ Dollars?: number | undefined; /** *The fractional portion, in cents, of the amount.
* @public */ Cents?: number | undefined; /** *Fractions of a cent, in tenths.
* @public */ TenthFractionsOfACent?: number | undefined; } /** *Defines the amount of money paid to an Amazon Mechanical Turk worker for each task performed.
Use one of the following prices for bounding box tasks. Prices are in US dollars and should be based on the complexity of the task; the longer it takes in your initial testing, the more you should offer.
0.036
0.048
0.060
0.072
0.120
0.240
0.360
0.480
0.600
0.720
0.840
0.960
1.080
1.200
Use one of the following prices for image classification, text classification, and custom tasks. Prices are in US dollars.
0.012
0.024
0.036
0.048
0.060
0.072
0.120
0.240
0.360
0.480
0.600
0.720
0.840
0.960
1.080
1.200
Use one of the following prices for semantic segmentation tasks. Prices are in US dollars.
0.840
0.960
1.080
1.200
Use one of the following prices for Textract AnalyzeDocument Important Form Key Amazon Augmented AI review tasks. Prices are in US dollars.
2.400
2.280
2.160
2.040
1.920
1.800
1.680
1.560
1.440
1.320
1.200
1.080
0.960
0.840
0.720
0.600
0.480
0.360
0.240
0.120
0.072
0.060
0.048
0.036
0.024
0.012
Use one of the following prices for Rekognition DetectModerationLabels Amazon Augmented AI review tasks. Prices are in US dollars.
1.200
1.080
0.960
0.840
0.720
0.600
0.480
0.360
0.240
0.120
0.072
0.060
0.048
0.036
0.024
0.012
Use one of the following prices for Amazon Augmented AI custom human review tasks. Prices are in US dollars.
1.200
1.080
0.960
0.840
0.720
0.600
0.480
0.360
0.240
0.120
0.072
0.060
0.048
0.036
0.024
0.012
Defines the amount of money paid to an Amazon Mechanical Turk worker in United States dollars.
* @public */ AmountInUsd?: USD | undefined; } /** *Describes the work to be performed by human workers.
* @public */ export interface HumanLoopConfig { /** *Amazon Resource Name (ARN) of a team of workers. To learn more about the types of workforces and work teams you can create and use with Amazon A2I, see Create and Manage Workforces.
* @public */ WorkteamArn: string | undefined; /** *The Amazon Resource Name (ARN) of the human task user interface.
You can use standard HTML and Crowd HTML Elements to create a custom worker task template. You use this template to create a human task UI.
To learn how to create a custom HTML template, see Create Custom Worker Task Template.
To learn how to create a human task UI, which is a worker task template that can be used in a flow definition, see Create and Delete a Worker Task Templates.
* @public */ HumanTaskUiArn: string | undefined; /** *A title for the human worker task.
* @public */ TaskTitle: string | undefined; /** *A description for the human worker task.
* @public */ TaskDescription: string | undefined; /** *The number of distinct workers who will perform the same task on each object. For example, if TaskCount is set to 3 for an image classification labeling job, three workers will classify each input image. Increasing TaskCount can improve label accuracy.
The length of time that a task remains available for review by human workers.
* @public */ TaskAvailabilityLifetimeInSeconds?: number | undefined; /** *The amount of time that a worker has to complete a task. The default value is 3,600 seconds (1 hour).
* @public */ TaskTimeLimitInSeconds?: number | undefined; /** *Keywords used to describe the task so that workers can discover the task.
* @public */ TaskKeywords?: string[] | undefined; /** *Defines the amount of money paid to an Amazon Mechanical Turk worker for each task performed.
Use one of the following prices for bounding box tasks. Prices are in US dollars and should be based on the complexity of the task; the longer it takes in your initial testing, the more you should offer.
0.036
0.048
0.060
0.072
0.120
0.240
0.360
0.480
0.600
0.720
0.840
0.960
1.080
1.200
Use one of the following prices for image classification, text classification, and custom tasks. Prices are in US dollars.
0.012
0.024
0.036
0.048
0.060
0.072
0.120
0.240
0.360
0.480
0.600
0.720
0.840
0.960
1.080
1.200
Use one of the following prices for semantic segmentation tasks. Prices are in US dollars.
0.840
0.960
1.080
1.200
Use one of the following prices for Textract AnalyzeDocument Important Form Key Amazon Augmented AI review tasks. Prices are in US dollars.
2.400
2.280
2.160
2.040
1.920
1.800
1.680
1.560
1.440
1.320
1.200
1.080
0.960
0.840
0.720
0.600
0.480
0.360
0.240
0.120
0.072
0.060
0.048
0.036
0.024
0.012
Use one of the following prices for Rekognition DetectModerationLabels Amazon Augmented AI review tasks. Prices are in US dollars.
1.200
1.080
0.960
0.840
0.720
0.600
0.480
0.360
0.240
0.120
0.072
0.060
0.048
0.036
0.024
0.012
Use one of the following prices for Amazon Augmented AI custom human review tasks. Prices are in US dollars.
1.200
1.080
0.960
0.840
0.720
0.600
0.480
0.360
0.240
0.120
0.072
0.060
0.048
0.036
0.024
0.012
Container for configuring the source of human task requests.
* @public */ export interface HumanLoopRequestSource { /** *Specifies whether Amazon Rekognition or Amazon Textract are used as the integration source. The default field settings and JSON parsing rules are different based on the integration source. Valid values:
* @public */ AwsManagedHumanLoopRequestSource: AwsManagedHumanLoopRequestSource | undefined; } /** *Contains information about where human output will be stored.
* @public */ export interface FlowDefinitionOutputConfig { /** *The Amazon S3 path where the object containing human output will be made available.
To learn more about the format of Amazon A2I output data, see Amazon A2I Output Data.
* @public */ S3OutputPath: string | undefined; /** *The Amazon Key Management Service (KMS) key ID for server-side encryption.
* @public */ KmsKeyId?: string | undefined; } /** * @public */ export interface CreateFlowDefinitionRequest { /** *The name of your flow definition.
* @public */ FlowDefinitionName: string | undefined; /** *Container for configuring the source of human task requests. Use to specify if Amazon Rekognition or Amazon Textract is used as an integration source.
* @public */ HumanLoopRequestSource?: HumanLoopRequestSource | undefined; /** *An object containing information about the events that trigger a human workflow.
* @public */ HumanLoopActivationConfig?: HumanLoopActivationConfig | undefined; /** *An object containing information about the tasks the human reviewers will perform.
* @public */ HumanLoopConfig?: HumanLoopConfig | undefined; /** *An object containing information about where the human review results will be uploaded.
* @public */ OutputConfig: FlowDefinitionOutputConfig | undefined; /** *The Amazon Resource Name (ARN) of the role needed to call other services on your behalf. For example, arn:aws:iam::1234567890:role/service-role/AmazonSageMaker-ExecutionRole-20180111T151298.
An array of key-value pairs that contain metadata to help you categorize and organize a flow definition. Each tag consists of a key and a value, both of which you define.
* @public */ Tags?: Tag[] | undefined; } /** * @public */ export interface CreateFlowDefinitionResponse { /** *The Amazon Resource Name (ARN) of the flow definition you create.
* @public */ FlowDefinitionArn: string | undefined; } /** *The Amazon S3 storage configuration of a hub.
* @public */ export interface HubS3StorageConfig { /** *The Amazon S3 bucket prefix for hosting hub content.
* @public */ S3OutputPath?: string | undefined; } /** * @public */ export interface CreateHubRequest { /** *The name of the hub to create.
* @public */ HubName: string | undefined; /** *A description of the hub.
* @public */ HubDescription: string | undefined; /** *The display name of the hub.
* @public */ HubDisplayName?: string | undefined; /** *The searchable keywords for the hub.
* @public */ HubSearchKeywords?: string[] | undefined; /** *The Amazon S3 storage configuration for the hub.
* @public */ S3StorageConfig?: HubS3StorageConfig | undefined; /** *Any tags to associate with the hub.
* @public */ Tags?: Tag[] | undefined; } /** * @public */ export interface CreateHubResponse { /** *The Amazon Resource Name (ARN) of the hub.
* @public */ HubArn: string | undefined; } /** *Configuration for accessing hub content through presigned URLs, including license agreement acceptance and URL validation settings.
* @public */ export interface PresignedUrlAccessConfig { /** *Indicates acceptance of the End User License Agreement (EULA) for gated models. Set to true to acknowledge acceptance of the license terms required for accessing gated content.
* @public */ AcceptEula?: boolean | undefined; /** *The expected S3 URL prefix for validation purposes. This parameter helps ensure consistency between the resolved S3 URIs and the deployment configuration, reducing potential compatibility issues.
* @public */ ExpectedS3Url?: string | undefined; } /** * @public */ export interface CreateHubContentPresignedUrlsRequest { /** *The name or Amazon Resource Name (ARN) of the hub that contains the content. For public content, use SageMakerPublicHub.
The type of hub content to access. Valid values include Model, Notebook, and ModelReference.
The name of the hub content for which to generate presigned URLs. This identifies the specific model or content within the hub.
* @public */ HubContentName: string | undefined; /** *The version of the hub content. If not specified, the latest version is used.
* @public */ HubContentVersion?: string | undefined; /** *Configuration settings for accessing the hub content, including end-user license agreement acceptance for gated models and expected S3 URL validation.
* @public */ AccessConfig?: PresignedUrlAccessConfig | undefined; /** *The maximum number of presigned URLs to return in the response. Default value is 100. Large models may contain hundreds of files, requiring pagination to retrieve all URLs.
* @public */ MaxResults?: number | undefined; /** *A token for pagination. Use this token to retrieve the next set of presigned URLs when the response is truncated.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface CreateHubContentPresignedUrlsResponse { /** *An array of authorized URL configurations, each containing a presigned URL and its corresponding local file path for proper file organization during download.
* @public */ AuthorizedUrlConfigs: AuthorizedUrl[] | undefined; /** *A token for pagination. If present, indicates that more presigned URLs are available. Use this token in a subsequent request to retrieve additional URLs.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface CreateHubContentReferenceRequest { /** *The name of the hub to add the hub content reference to.
* @public */ HubName: string | undefined; /** *The ARN of the public hub content to reference.
* @public */ SageMakerPublicHubContentArn: string | undefined; /** *The name of the hub content to reference.
* @public */ HubContentName?: string | undefined; /** *The minimum version of the hub content to reference.
* @public */ MinVersion?: string | undefined; /** *Any tags associated with the hub content to reference.
* @public */ Tags?: Tag[] | undefined; } /** * @public */ export interface CreateHubContentReferenceResponse { /** *The ARN of the hub that the hub content reference was added to.
* @public */ HubArn: string | undefined; /** *The ARN of the hub content.
* @public */ HubContentArn: string | undefined; } /** *The Liquid template for the worker user interface.
* @public */ export interface UiTemplate { /** *The content of the Liquid template for the worker user interface.
* @public */ Content: string | undefined; } /** * @public */ export interface CreateHumanTaskUiRequest { /** *The name of the user interface you are creating.
* @public */ HumanTaskUiName: string | undefined; /** *The Liquid template for the worker user interface.
* @public */ UiTemplate: UiTemplate | undefined; /** *An array of key-value pairs that contain metadata to help you categorize and organize a human review workflow user interface. Each tag consists of a key and a value, both of which you define.
* @public */ Tags?: Tag[] | undefined; } /** * @public */ export interface CreateHumanTaskUiResponse { /** *The Amazon Resource Name (ARN) of the human review workflow user interface you create.
* @public */ HumanTaskUiArn: string | undefined; } /** *For a hyperparameter of the integer type, specifies the range that a hyperparameter tuning job searches.
* @public */ export interface IntegerParameterRange { /** *The name of the hyperparameter to search.
* @public */ Name: string | undefined; /** *The minimum value of the hyperparameter to search.
* @public */ MinValue: string | undefined; /** *The maximum value of the hyperparameter to search.
* @public */ MaxValue: string | undefined; /** *The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.
Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.
Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.
Logarithmic scaling works only for ranges that have only values greater than 0.
Specifies ranges of integer, continuous, and categorical hyperparameters that a hyperparameter tuning job searches. The hyperparameter tuning job launches training jobs with hyperparameter values within these ranges to find the combination of values that result in the training job with the best performance as measured by the objective metric of the hyperparameter tuning job.
The maximum number of items specified for Array Members refers to the maximum number of hyperparameters for each range and also the maximum for the hyperparameter tuning job itself. That is, the sum of the number of hyperparameters for all the ranges can't exceed the maximum number specified.
The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.
* @public */ IntegerParameterRanges?: IntegerParameterRange[] | undefined; /** *The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.
* @public */ ContinuousParameterRanges?: ContinuousParameterRange[] | undefined; /** *The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.
* @public */ CategoricalParameterRanges?: CategoricalParameterRange[] | undefined; /** *A list containing hyperparameter names and example values to be used by Autotune to determine optimal ranges for your tuning job.
* @public */ AutoParameters?: AutoParameter[] | undefined; } /** *Specifies the maximum number of training jobs and parallel training jobs that a hyperparameter tuning job can launch.
* @public */ export interface ResourceLimits { /** *The maximum number of training jobs that a hyperparameter tuning job can launch.
* @public */ MaxNumberOfTrainingJobs?: number | undefined; /** *The maximum number of concurrent training jobs that a hyperparameter tuning job can launch.
* @public */ MaxParallelTrainingJobs: number | undefined; /** *The maximum time in seconds that a hyperparameter tuning job can run.
* @public */ MaxRuntimeInSeconds?: number | undefined; } /** *The configuration for Hyperband, a multi-fidelity based hyperparameter tuning strategy. Hyperband uses the final and intermediate results of a training job to dynamically allocate resources to utilized hyperparameter configurations while automatically stopping under-performing configurations. This parameter should be provided only if Hyperband is selected as the StrategyConfig under the HyperParameterTuningJobConfig API.
The minimum number of resources (such as epochs) that can be used by a training job launched by a hyperparameter tuning job. If the value for MinResource has not been reached, the training job is not stopped by Hyperband.
The maximum number of resources (such as epochs) that can be used by a training job launched by a hyperparameter tuning job. Once a job reaches the MaxResource value, it is stopped. If a value for MaxResource is not provided, and Hyperband is selected as the hyperparameter tuning strategy, HyperbandTraining attempts to infer MaxResource from the following keys (if present) in StaticsHyperParameters:
epochs
numepochs
n-epochs
n_epochs
num_epochs
If HyperbandStrategyConfig is unable to infer a value for MaxResource, it generates a validation error. The maximum value is 20,000 epochs. All metrics that correspond to an objective metric are used to derive early stopping decisions. For distributed training jobs, ensure that duplicate metrics are not printed in the logs across the individual nodes in a training job. If multiple nodes are publishing duplicate or incorrect metrics, training jobs may make an incorrect stopping decision and stop the job prematurely.
The configuration for a training job launched by a hyperparameter tuning job. Choose Bayesian for Bayesian optimization, and Random for random search optimization. For more advanced use cases, use Hyperband, which evaluates objective metrics for training jobs after every epoch. For more information about strategies, see How Hyperparameter Tuning Works.
The configuration for the object that specifies the Hyperband strategy. This parameter is only supported for the Hyperband selection for Strategy within the HyperParameterTuningJobConfig API.
The job completion criteria.
* @public */ export interface TuningJobCompletionCriteria { /** *The value of the objective metric.
* @public */ TargetObjectiveMetricValue?: number | undefined; /** *A flag to stop your hyperparameter tuning job if model performance fails to improve as evaluated against an objective function.
* @public */ BestObjectiveNotImproving?: BestObjectiveNotImproving | undefined; /** *A flag to top your hyperparameter tuning job if automatic model tuning (AMT) has detected that your model has converged as evaluated against your objective function.
* @public */ ConvergenceDetected?: ConvergenceDetected | undefined; } /** *Configures a hyperparameter tuning job.
* @public */ export interface HyperParameterTuningJobConfig { /** *Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training job it launches. For information about search strategies, see How Hyperparameter Tuning Works.
* @public */ Strategy: HyperParameterTuningJobStrategyType | undefined; /** *The configuration for the Hyperband optimization strategy. This parameter should be provided only if Hyperband is selected as the strategy for HyperParameterTuningJobConfig.
The HyperParameterTuningJobObjective specifies the objective metric used to evaluate the performance of training jobs launched by this tuning job.
* @public */ HyperParameterTuningJobObjective?: HyperParameterTuningJobObjective | undefined; /** *The ResourceLimits object that specifies the maximum number of training and parallel training jobs that can be used for this hyperparameter tuning job.
* @public */ ResourceLimits: ResourceLimits | undefined; /** *The ParameterRanges object that specifies the ranges of hyperparameters that this tuning job searches over to find the optimal configuration for the highest model performance against your chosen objective metric.
* @public */ ParameterRanges?: ParameterRanges | undefined; /** *Specifies whether to use early stopping for training jobs launched by the hyperparameter tuning job. Because the Hyperband strategy has its own advanced internal early stopping mechanism, TrainingJobEarlyStoppingType must be OFF to use Hyperband. This parameter can take on one of the following values (the default value is OFF):
Training jobs launched by the hyperparameter tuning job do not use early stopping.
SageMaker stops training jobs launched by the hyperparameter tuning job when they are unlikely to perform better than previously completed training jobs. For more information, see Stop Training Jobs Early.
The tuning job's completion criteria.
* @public */ TuningJobCompletionCriteria?: TuningJobCompletionCriteria | undefined; /** *A value used to initialize a pseudo-random number generator. Setting a random seed and using the same seed later for the same tuning job will allow hyperparameter optimization to find more a consistent hyperparameter configuration between the two runs.
* @public */ RandomSeed?: number | undefined; } /** *Specifies which training algorithm to use for training jobs that a hyperparameter tuning job launches and the metrics to monitor.
* @public */ export interface HyperParameterAlgorithmSpecification { /** * The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.
The training input mode that the algorithm supports. For more information about input modes, see Algorithms.
Pipe mode
If an algorithm supports Pipe mode, Amazon SageMaker streams data directly from Amazon S3 to the container.
File mode
If an algorithm supports File mode, SageMaker downloads the training data from S3 to the provisioned ML storage volume, and mounts the directory to the Docker volume for the training container.
You must provision the ML storage volume with sufficient capacity to accommodate the data downloaded from S3. In addition to the training data, the ML storage volume also stores the output model. The algorithm container uses the ML storage volume to also store intermediate information, if any.
For distributed algorithms, training data is distributed uniformly. Your training duration is predictable if the input data objects sizes are approximately the same. SageMaker does not split the files any further for model training. If the object sizes are skewed, training won't be optimal as the data distribution is also skewed when one host in a training cluster is overloaded, thus becoming a bottleneck in training.
FastFile mode
If an algorithm supports FastFile mode, SageMaker streams data directly from S3 to the container with no code changes, and provides file system access to the data. Users can author their training script to interact with these files as if they were stored on disk.
FastFile mode works best when the data is read sequentially. Augmented manifest files aren't supported. The startup time is lower when there are fewer files in the S3 bucket provided.
The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for TrainingImage.
An array of MetricDefinition objects that specify the metrics that the algorithm emits.
* @public */ MetricDefinitions?: MetricDefinition[] | undefined; } /** *The configuration for hyperparameter tuning resources for use in training jobs launched by the tuning job. These resources include compute instances and storage volumes. Specify one or more compute instance configurations and allocation strategies to select resources (optional).
* @public */ export interface HyperParameterTuningInstanceConfig { /** *The instance type used for processing of hyperparameter optimization jobs. Choose from general purpose (no GPUs) instance types: ml.m5.xlarge, ml.m5.2xlarge, and ml.m5.4xlarge or compute optimized (no GPUs) instance types: ml.c5.xlarge and ml.c5.2xlarge. For more information about instance types, see instance type descriptions.
* @public */ InstanceType: TrainingInstanceType | undefined; /** *The number of instances of the type specified by InstanceType. Choose an instance count larger than 1 for distributed training algorithms. See Step 2: Launch a SageMaker Distributed Training Job Using the SageMaker Python SDK for more information.
The volume size in GB of the data to be processed for hyperparameter optimization (optional).
* @public */ VolumeSizeInGB: number | undefined; } /** *The configuration of resources, including compute instances and storage volumes for use in training jobs launched by hyperparameter tuning jobs. HyperParameterTuningResourceConfig is similar to ResourceConfig, but has the additional InstanceConfigs and AllocationStrategy fields to allow for flexible instance management. Specify one or more instance types, count, and the allocation strategy for instance selection.
HyperParameterTuningResourceConfig supports the capabilities of ResourceConfig with the exception of KeepAlivePeriodInSeconds. Hyperparameter tuning jobs use warm pools by default, which reuse clusters between training jobs.
The instance type used to run hyperparameter optimization tuning jobs. See descriptions of instance types for more information.
* @public */ InstanceType?: TrainingInstanceType | undefined; /** *The number of compute instances of type InstanceType to use. For distributed training, select a value greater than 1.
The volume size in GB for the storage volume to be used in processing hyperparameter optimization jobs (optional). These volumes store model artifacts, incremental states and optionally, scratch space for training algorithms. Do not provide a value for this parameter if a value for InstanceConfigs is also specified.
Some instance types have a fixed total local storage size. If you select one of these instances for training, VolumeSizeInGB cannot be greater than this total size. For a list of instance types with local instance storage and their sizes, see instance store volumes.
SageMaker supports only the General Purpose SSD (gp2) storage volume type.
A key used by Amazon Web Services Key Management Service to encrypt data on the storage volume attached to the compute instances used to run the training job. You can use either of the following formats to specify a key.
KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
Some instances use local storage, which use a hardware module to encrypt storage volumes. If you choose one of these instance types, you cannot request a VolumeKmsKeyId. For a list of instance types that use local storage, see instance store volumes. For more information about Amazon Web Services Key Management Service, see KMS encryption for more information.
The strategy that determines the order of preference for resources specified in InstanceConfigs used in hyperparameter optimization.
A list containing the configuration(s) for one or more resources for processing hyperparameter jobs. These resources include compute instances and storage volumes to use in model training jobs launched by hyperparameter tuning jobs. The AllocationStrategy controls the order in which multiple configurations provided in InstanceConfigs are used.
If you only want to use a single instance configuration inside the HyperParameterTuningResourceConfig API, do not provide a value for InstanceConfigs. Instead, use InstanceType, VolumeSizeInGB and InstanceCount. If you use InstanceConfigs, do not provide values for InstanceType, VolumeSizeInGB or InstanceCount.
The retry strategy to use when a training job fails due to an InternalServerError. RetryStrategy is specified as part of the CreateTrainingJob and CreateHyperParameterTuningJob requests. You can add the StoppingCondition parameter to the request to limit the training time for the complete job.
The number of times to retry the job. When the job is retried, it's SecondaryStatus is changed to STARTING.
Defines the training jobs launched by a hyperparameter tuning job.
* @public */ export interface HyperParameterTrainingJobDefinition { /** *The job definition name.
* @public */ DefinitionName?: string | undefined; /** *Defines the objective metric for a hyperparameter tuning job. Hyperparameter tuning uses the value of this metric to evaluate the training jobs it launches, and returns the training job that results in either the highest or lowest value for this metric, depending on the value you specify for the Type parameter. If you want to define a custom objective metric, see Define metrics and environment variables.
Specifies ranges of integer, continuous, and categorical hyperparameters that a hyperparameter tuning job searches. The hyperparameter tuning job launches training jobs with hyperparameter values within these ranges to find the combination of values that result in the training job with the best performance as measured by the objective metric of the hyperparameter tuning job.
The maximum number of items specified for Array Members refers to the maximum number of hyperparameters for each range and also the maximum for the hyperparameter tuning job itself. That is, the sum of the number of hyperparameters for all the ranges can't exceed the maximum number specified.
Specifies the values of hyperparameters that do not change for the tuning job.
* @public */ StaticHyperParameters?: RecordThe HyperParameterAlgorithmSpecification object that specifies the resource algorithm to use for the training jobs that the tuning job launches.
* @public */ AlgorithmSpecification: HyperParameterAlgorithmSpecification | undefined; /** *The Amazon Resource Name (ARN) of the IAM role associated with the training jobs that the tuning job launches.
* @public */ RoleArn: string | undefined; /** *An array of Channel objects that specify the input for the training jobs that the tuning job launches.
* @public */ InputDataConfig?: Channel[] | undefined; /** *The VpcConfig object that specifies the VPC that you want the training jobs that this hyperparameter tuning job launches to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.
* @public */ VpcConfig?: VpcConfig | undefined; /** *Specifies the path to the Amazon S3 bucket where you store model artifacts from the training jobs that the tuning job launches.
* @public */ OutputDataConfig: OutputDataConfig | undefined; /** *The resources, including the compute instances and storage volumes, to use for the training jobs that the tuning job launches.
Storage volumes store model artifacts and incremental states. Training algorithms might also use storage volumes for scratch space. If you want SageMaker to use the storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.
If you want to use hyperparameter optimization with instance type flexibility, use HyperParameterTuningResourceConfig instead.
The configuration for the hyperparameter tuning resources, including the compute instances and storage volumes, used for training jobs launched by the tuning job. By default, storage volumes hold model artifacts and incremental states. Choose File for TrainingInputMode in the AlgorithmSpecification parameter to additionally store training data in the storage volume (optional).
Specifies a limit to how long a model hyperparameter training job can run. It also specifies how long a managed spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.
* @public */ StoppingCondition: StoppingCondition | undefined; /** *Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If network isolation is used for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.
* @public */ EnableNetworkIsolation?: boolean | undefined; /** *To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.
A Boolean indicating whether managed spot training is enabled (True) or not (False).
Contains information about the output location for managed spot training checkpoint data.
* @public */ CheckpointConfig?: CheckpointConfig | undefined; /** *The number of times to retry the job when the job fails due to an InternalServerError.
An environment variable that you can pass into the SageMaker CreateTrainingJob API. You can use an existing environment variable from the training container or use your own. See Define metrics and variables for more information.
The maximum number of items specified for Map Entries refers to the maximum number of environment variables for each TrainingJobDefinition and also the maximum for the hyperparameter tuning job itself. That is, the sum of the number of environment variables for all the training job definitions can't exceed the maximum number specified.
A previously completed or stopped hyperparameter tuning job to be used as a starting point for a new hyperparameter tuning job.
* @public */ export interface ParentHyperParameterTuningJob { /** *The name of the hyperparameter tuning job to be used as a starting point for a new hyperparameter tuning job.
* @public */ HyperParameterTuningJobName?: string | undefined; } /** *Specifies the configuration for a hyperparameter tuning job that uses one or more previous hyperparameter tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.
All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric, and the training job that performs the best is compared to the best training jobs from the parent tuning jobs. From these, the training job that performs the best as measured by the objective metric is returned as the overall best training job.
All training jobs launched by parent hyperparameter tuning jobs and the new hyperparameter tuning jobs count against the limit of training jobs for the tuning job.
An array of hyperparameter tuning jobs that are used as the starting point for the new hyperparameter tuning job. For more information about warm starting a hyperparameter tuning job, see Using a Previous Hyperparameter Tuning Job as a Starting Point.
Hyperparameter tuning jobs created before October 1, 2018 cannot be used as parent jobs for warm start tuning jobs.
* @public */ ParentHyperParameterTuningJobs: ParentHyperParameterTuningJob[] | undefined; /** *Specifies one of the following:
The new hyperparameter tuning job uses the same input data and training image as the parent tuning jobs. You can change the hyperparameter ranges to search and the maximum number of training jobs that the hyperparameter tuning job launches. You cannot use a new version of the training algorithm, unless the changes in the new version do not affect the algorithm itself. For example, changes that improve logging or adding support for a different data format are allowed. You can also change hyperparameters from tunable to static, and from static to tunable, but the total number of static plus tunable hyperparameters must remain the same as it is in all parent jobs. The objective metric for the new tuning job must be the same as for all parent jobs.
The new hyperparameter tuning job can include input data, hyperparameter ranges, maximum number of concurrent training jobs, and maximum number of training jobs that are different than those of its parent hyperparameter tuning jobs. The training image can also be a different version from the version used in the parent hyperparameter tuning job. You can also change hyperparameters from tunable to static, and from static to tunable, but the total number of static plus tunable hyperparameters must remain the same as it is in all parent jobs. The objective metric for the new tuning job must be the same as for all parent jobs.
The name of the tuning job. This name is the prefix for the names of all training jobs that this tuning job launches. The name must be unique within the same Amazon Web Services account and Amazon Web Services Region. The name must have 1 to 32 characters. Valid characters are a-z, A-Z, 0-9, and : + = @ _ % - (hyphen). The name is not case sensitive.
* @public */ HyperParameterTuningJobName: string | undefined; /** *The HyperParameterTuningJobConfig object that describes the tuning job, including the search strategy, the objective metric used to evaluate training jobs, ranges of parameters to search, and resource limits for the tuning job. For more information, see How Hyperparameter Tuning Works.
* @public */ HyperParameterTuningJobConfig: HyperParameterTuningJobConfig | undefined; /** *The HyperParameterTrainingJobDefinition object that describes the training jobs that this tuning job launches, including static hyperparameters, input data configuration, output data configuration, resource configuration, and stopping condition.
* @public */ TrainingJobDefinition?: HyperParameterTrainingJobDefinition | undefined; /** *A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.
* @public */ TrainingJobDefinitions?: HyperParameterTrainingJobDefinition[] | undefined; /** *Specifies the configuration for starting the hyperparameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.
All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric. If you specify IDENTICAL_DATA_AND_ALGORITHM as the WarmStartType value for the warm start configuration, the training job that performs the best in the new tuning job is compared to the best training jobs from the parent tuning jobs. From these, the training job that performs the best as measured by the objective metric is returned as the overall best training job.
All training jobs launched by parent hyperparameter tuning jobs and the new hyperparameter tuning jobs count against the limit of training jobs for the tuning job.
An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
Tags that you specify for the tuning job are also added to all training jobs that the tuning job launches.
* @public */ Tags?: Tag[] | undefined; /** *Configures SageMaker Automatic model tuning (AMT) to automatically find optimal parameters for the following fields:
ParameterRanges: The names and ranges of parameters that a hyperparameter tuning job can optimize.
ResourceLimits: The maximum resources that can be used for a training job. These resources include the maximum number of training jobs, the maximum runtime of a tuning job, and the maximum number of training jobs to run at the same time.
TrainingJobEarlyStoppingType: A flag that specifies whether or not to use early stopping for training jobs launched by a hyperparameter tuning job.
RetryStrategy: The number of times to retry a training job.
Strategy: Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training jobs that it launches.
ConvergenceDetected: A flag to indicate that Automatic model tuning (AMT) has detected model convergence.
The Amazon Resource Name (ARN) of the tuning job. SageMaker assigns an ARN to a hyperparameter tuning job when you create it.
* @public */ HyperParameterTuningJobArn: string | undefined; } /** * @public */ export interface CreateImageRequest { /** *The description of the image.
* @public */ Description?: string | undefined; /** *The display name of the image. If not provided, ImageName is displayed.
The name of the image. Must be unique to your account.
* @public */ ImageName: string | undefined; /** *The ARN of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.
* @public */ RoleArn: string | undefined; /** *A list of tags to apply to the image.
* @public */ Tags?: Tag[] | undefined; } /** * @public */ export interface CreateImageResponse { /** *The ARN of the image.
* @public */ ImageArn?: string | undefined; } /** * @public */ export interface CreateImageVersionRequest { /** *The registry path of the container image to use as the starting point for this version. The path is an Amazon ECR URI in the following format:
<acct-id>.dkr.ecr.<region>.amazonaws.com/<repo-name[:tag] or [@digest]>
A unique ID. If not specified, the Amazon Web Services CLI and Amazon Web Services SDKs, such as the SDK for Python (Boto3), add a unique value to the call.
* @public */ ClientToken?: string | undefined; /** *The ImageName of the Image to create a version of.
A list of aliases created with the image version.
* @public */ Aliases?: string[] | undefined; /** *The stability of the image version, specified by the maintainer.
NOT_PROVIDED: The maintainers did not provide a status for image version stability.
STABLE: The image version is stable.
TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.
ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.
Indicates SageMaker AI job type compatibility.
TRAINING: The image version is compatible with SageMaker AI training jobs.
INFERENCE: The image version is compatible with SageMaker AI inference jobs.
NOTEBOOK_KERNEL: The image version is compatible with SageMaker AI notebook kernels.
The machine learning framework vended in the image version.
* @public */ MLFramework?: string | undefined; /** *The supported programming language and its version.
* @public */ ProgrammingLang?: string | undefined; /** *Indicates CPU or GPU compatibility.
CPU: The image version is compatible with CPU.
GPU: The image version is compatible with GPU.
Indicates Horovod compatibility.
* @public */ Horovod?: boolean | undefined; /** *The maintainer description of the image version.
* @public */ ReleaseNotes?: string | undefined; } /** * @public */ export interface CreateImageVersionResponse { /** *The ARN of the image version.
* @public */ ImageVersionArn?: string | undefined; } /** *Runtime settings for a model that is deployed with an inference component.
* @public */ export interface InferenceComponentRuntimeConfig { /** *The number of runtime copies of the model container to deploy with the inference component. Each copy can serve inference requests.
* @public */ CopyCount: number | undefined; } /** *Defines the compute resources to allocate to run a model, plus any adapter models, that you assign to an inference component. These resources include CPU cores, accelerators, and memory.
* @public */ export interface InferenceComponentComputeResourceRequirements { /** *The number of CPU cores to allocate to run a model that you assign to an inference component.
* @public */ NumberOfCpuCoresRequired?: number | undefined; /** *The number of accelerators to allocate to run a model that you assign to an inference component. Accelerators include GPUs and Amazon Web Services Inferentia.
* @public */ NumberOfAcceleratorDevicesRequired?: number | undefined; /** *The minimum MB of memory to allocate to run a model that you assign to an inference component.
* @public */ MinMemoryRequiredInMb: number | undefined; /** *The maximum MB of memory to allocate to run a model that you assign to an inference component.
* @public */ MaxMemoryRequiredInMb?: number | undefined; } /** *Defines a container that provides the runtime environment for a model that you deploy with an inference component.
* @public */ export interface InferenceComponentContainerSpecification { /** *The Amazon Elastic Container Registry (Amazon ECR) path where the Docker image for the model is stored.
* @public */ Image?: string | undefined; /** *The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).
* @public */ ArtifactUrl?: string | undefined; /** *The environment variables to set in the Docker container. Each key and value in the Environment string-to-string map can have length of up to 1024. We support up to 16 entries in the map.
* @public */ Environment?: RecordSettings that affect how the inference component caches data.
* @public */ export interface InferenceComponentDataCacheConfig { /** *Sets whether the endpoint that hosts the inference component caches the model artifacts and container image.
With caching enabled, the endpoint caches this data in each instance that it provisions for the inference component. That way, the inference component deploys faster during the auto scaling process. If caching isn't enabled, the inference component takes longer to deploy because of the time it spends downloading the data.
* @public */ EnableCaching: boolean | undefined; } /** *Settings that take effect while the model container starts up.
* @public */ export interface InferenceComponentStartupParameters { /** *The timeout value, in seconds, to download and extract the model that you want to host from Amazon S3 to the individual inference instance associated with this inference component.
* @public */ ModelDataDownloadTimeoutInSeconds?: number | undefined; /** *The timeout value, in seconds, for your inference container to pass health check by Amazon S3 Hosting. For more information about health check, see How Your Container Should Respond to Health Check (Ping) Requests.
* @public */ ContainerStartupHealthCheckTimeoutInSeconds?: number | undefined; } /** *Details about the resources to deploy with this inference component, including the model, container, and compute resources.
* @public */ export interface InferenceComponentSpecification { /** *The name of an existing SageMaker AI model object in your account that you want to deploy with the inference component.
* @public */ ModelName?: string | undefined; /** *Defines a container that provides the runtime environment for a model that you deploy with an inference component.
* @public */ Container?: InferenceComponentContainerSpecification | undefined; /** *Settings that take effect while the model container starts up.
* @public */ StartupParameters?: InferenceComponentStartupParameters | undefined; /** *The compute resources allocated to run the model, plus any adapter models, that you assign to the inference component.
Omit this parameter if your request is meant to create an adapter inference component. An adapter inference component is loaded by a base inference component, and it uses the compute resources of the base inference component.
* @public */ ComputeResourceRequirements?: InferenceComponentComputeResourceRequirements | undefined; /** *The name of an existing inference component that is to contain the inference component that you're creating with your request.
Specify this parameter only if your request is meant to create an adapter inference component. An adapter inference component contains the path to an adapter model. The purpose of the adapter model is to tailor the inference output of a base foundation model, which is hosted by the base inference component. The adapter inference component uses the compute resources that you assigned to the base inference component.
When you create an adapter inference component, use the Container parameter to specify the location of the adapter artifacts. In the parameter value, use the ArtifactUrl parameter of the InferenceComponentContainerSpecification data type.
Before you can create an adapter inference component, you must have an existing inference component that contains the foundation model that you want to adapt.
* @public */ BaseInferenceComponentName?: string | undefined; /** *Settings that affect how the inference component caches data.
* @public */ DataCacheConfig?: InferenceComponentDataCacheConfig | undefined; } /** * @public */ export interface CreateInferenceComponentInput { /** *A unique name to assign to the inference component.
* @public */ InferenceComponentName: string | undefined; /** *The name of an existing endpoint where you host the inference component.
* @public */ EndpointName: string | undefined; /** *The name of an existing production variant where you host the inference component.
* @public */ VariantName?: string | undefined; /** *Details about the resources to deploy with this inference component, including the model, container, and compute resources.
* @public */ Specification: InferenceComponentSpecification | undefined; /** *Runtime settings for a model that is deployed with an inference component.
* @public */ RuntimeConfig?: InferenceComponentRuntimeConfig | undefined; /** *A list of key-value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.
* @public */ Tags?: Tag[] | undefined; } /** * @public */ export interface CreateInferenceComponentOutput { /** *The Amazon Resource Name (ARN) of the inference component.
* @public */ InferenceComponentArn: string | undefined; } /** *The Amazon S3 location and configuration for storing inference request and response data.
* @public */ export interface InferenceExperimentDataStorageConfig { /** *The Amazon S3 bucket where the inference request and response data is stored.
* @public */ Destination: string | undefined; /** *The Amazon Web Services Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3 server-side encryption.
* @public */ KmsKey?: string | undefined; /** *Configuration specifying how to treat different headers. If no headers are specified Amazon SageMaker AI will by default base64 encode when capturing the data.
* @public */ ContentType?: CaptureContentTypeHeader | undefined; } /** *The infrastructure configuration for deploying the model to a real-time inference endpoint.
* @public */ export interface RealTimeInferenceConfig { /** *The instance type the model is deployed to.
* @public */ InstanceType: _InstanceType | undefined; /** *The number of instances of the type specified by InstanceType.
The configuration for the infrastructure that the model will be deployed to.
* @public */ export interface ModelInfrastructureConfig { /** *The inference option to which to deploy your model. Possible values are the following:
RealTime: Deploy to real-time inference.
The infrastructure configuration for deploying the model to real-time inference.
* @public */ RealTimeInferenceConfig: RealTimeInferenceConfig | undefined; } /** *Contains information about the deployment options of a model.
* @public */ export interface ModelVariantConfig { /** *The name of the Amazon SageMaker Model entity.
* @public */ ModelName: string | undefined; /** *The name of the variant.
* @public */ VariantName: string | undefined; /** *The configuration for the infrastructure that the model will be deployed to.
* @public */ InfrastructureConfig: ModelInfrastructureConfig | undefined; } /** *The start and end times of an inference experiment.
The maximum duration that you can set for an inference experiment is 30 days.
* @public */ export interface InferenceExperimentSchedule { /** *The timestamp at which the inference experiment started or will start.
* @public */ StartTime?: Date | undefined; /** *The timestamp at which the inference experiment ended or will end.
* @public */ EndTime?: Date | undefined; } /** *The name and sampling percentage of a shadow variant.
* @public */ export interface ShadowModelVariantConfig { /** *The name of the shadow variant.
* @public */ ShadowModelVariantName: string | undefined; /** *The percentage of inference requests that Amazon SageMaker replicates from the production variant to the shadow variant.
* @public */ SamplingPercentage: number | undefined; } /** * The configuration of ShadowMode inference experiment type, which specifies a production variant to take all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant it also specifies the percentage of requests that Amazon SageMaker replicates.
The name of the production variant, which takes all the inference requests.
* @public */ SourceModelVariantName: string | undefined; /** *List of shadow variant configurations.
* @public */ ShadowModelVariants: ShadowModelVariantConfig[] | undefined; } /** * @public */ export interface CreateInferenceExperimentRequest { /** *The name for the inference experiment.
* @public */ Name: string | undefined; /** *The type of the inference experiment that you want to run. The following types of experiments are possible:
ShadowMode: You can use this type to validate a shadow variant. For more information, see Shadow tests.
The duration for which you want the inference experiment to run. If you don't specify this field, the experiment automatically starts immediately upon creation and concludes after 7 days.
* @public */ Schedule?: InferenceExperimentSchedule | undefined; /** *A description for the inference experiment.
* @public */ Description?: string | undefined; /** *The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.
* @public */ RoleArn: string | undefined; /** *The name of the Amazon SageMaker endpoint on which you want to run the inference experiment.
* @public */ EndpointName: string | undefined; /** * An array of ModelVariantConfig objects. There is one for each variant in the inference experiment. Each ModelVariantConfig object in the array describes the infrastructure configuration for the corresponding variant.
The Amazon S3 location and configuration for storing inference request and response data.
This is an optional parameter that you can use for data capture. For more information, see Capture data.
* @public */ DataStorageConfig?: InferenceExperimentDataStorageConfig | undefined; /** * The configuration of ShadowMode inference experiment type. Use this field to specify a production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant also specify the percentage of requests that Amazon SageMaker replicates.
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. The KmsKey can be any of the following formats:
KMS key ID
"1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS key
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
KMS key Alias
"alias/ExampleAlias"
Amazon Resource Name (ARN) of a KMS key Alias
"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
If you use a KMS key ID or an alias of your KMS key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.
The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint and UpdateEndpoint requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.
Array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging your Amazon Web Services Resources.
* @public */ Tags?: Tag[] | undefined; } /** * @public */ export interface CreateInferenceExperimentResponse { /** *The ARN for your inference experiment.
* @public */ InferenceExperimentArn: string | undefined; } /** *The configuration for the payload for a recommendation job.
* @public */ export interface RecommendationJobPayloadConfig { /** *The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).
* @public */ SamplePayloadUrl?: string | undefined; /** *The supported MIME types for the input data.
* @public */ SupportedContentTypes?: string[] | undefined; } /** *Specifies mandatory fields for running an Inference Recommender job directly in the CreateInferenceRecommendationsJob API. The fields specified in ContainerConfig override the corresponding fields in the model package. Use ContainerConfig if you want to specify these fields for the recommendation job but don't want to edit them in your model package.
The machine learning domain of the model and its components.
Valid Values: COMPUTER_VISION | NATURAL_LANGUAGE_PROCESSING | MACHINE_LEARNING
The machine learning task that the model accomplishes.
Valid Values: IMAGE_CLASSIFICATION | OBJECT_DETECTION | TEXT_GENERATION | IMAGE_SEGMENTATION | FILL_MASK | CLASSIFICATION | REGRESSION | OTHER
The machine learning framework of the container image.
Valid Values: TENSORFLOW | PYTORCH | XGBOOST | SAGEMAKER-SCIKIT-LEARN
The framework version of the container image.
* @public */ FrameworkVersion?: string | undefined; /** *Specifies the SamplePayloadUrl and all other sample payload-related fields.
The name of a pre-trained machine learning model benchmarked by Amazon SageMaker Inference Recommender that matches your model.
Valid Values: efficientnetb7 | unet | xgboost | faster-rcnn-resnet101 | nasnetlarge | vgg16 | inception-v3 | mask-rcnn | sagemaker-scikit-learn | densenet201-gluon | resnet18v2-gluon | xception | densenet201 | yolov4 | resnet152 | bert-base-cased | xceptionV1-keras | resnet50 | retinanet
A list of the instance types that are used to generate inferences in real-time.
* @public */ SupportedInstanceTypes?: string[] | undefined; /** *The endpoint type to receive recommendations for. By default this is null, and the results of the inference recommendation job return a combined list of both real-time and serverless benchmarks. By specifying a value for this field, you can receive a longer list of benchmarks for the desired endpoint type.
* @public */ SupportedEndpointType?: RecommendationJobSupportedEndpointType | undefined; /** *Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. This field is used for optimizing your model using SageMaker Neo. For more information, see DataInputConfig.
* @public */ DataInputConfig?: string | undefined; /** *The supported MIME types for the output data.
* @public */ SupportedResponseMIMETypes?: string[] | undefined; } /** *Specifies the range of environment parameters
* @public */ export interface EnvironmentParameterRanges { /** *Specified a list of parameters for each category.
* @public */ CategoricalParameterRanges?: CategoricalParameter[] | undefined; } /** *The endpoint configuration for the load test.
* @public */ export interface EndpointInputConfiguration { /** *The instance types to use for the load test.
* @public */ InstanceType?: ProductionVariantInstanceType | undefined; /** *Specifies the serverless configuration for an endpoint variant.
* @public */ ServerlessConfig?: ProductionVariantServerlessConfig | undefined; /** *The inference specification name in the model package version.
* @public */ InferenceSpecificationName?: string | undefined; /** *The parameter you want to benchmark against.
* @public */ EnvironmentParameterRanges?: EnvironmentParameterRanges | undefined; } /** *Details about a customer endpoint that was compared in an Inference Recommender job.
* @public */ export interface EndpointInfo { /** *The name of a customer's endpoint.
* @public */ EndpointName?: string | undefined; } /** *Specifies the maximum number of jobs that can run in parallel and the maximum number of jobs that can run.
* @public */ export interface RecommendationJobResourceLimit { /** *Defines the maximum number of load tests.
* @public */ MaxNumberOfTests?: number | undefined; /** *Defines the maximum number of parallel load tests.
* @public */ MaxParallelOfTests?: number | undefined; } /** *Defines the traffic pattern.
* @public */ export interface Phase { /** *Specifies how many concurrent users to start with. The value should be between 1 and 3.
* @public */ InitialNumberOfUsers?: number | undefined; /** *Specified how many new users to spawn in a minute.
* @public */ SpawnRate?: number | undefined; /** *Specifies how long a traffic phase should be. For custom load tests, the value should be between 120 and 3600. This value should not exceed JobDurationInSeconds.
Defines the stairs traffic pattern for an Inference Recommender load test. This pattern type consists of multiple steps where the number of users increases at each step.
Specify either the stairs or phases traffic pattern.
* @public */ export interface Stairs { /** *Defines how long each traffic step should be.
* @public */ DurationInSeconds?: number | undefined; /** *Specifies how many steps to perform during traffic.
* @public */ NumberOfSteps?: number | undefined; /** *Specifies how many new users to spawn in each step.
* @public */ UsersPerStep?: number | undefined; } /** *Defines the traffic pattern of the load test.
* @public */ export interface TrafficPattern { /** *Defines the traffic patterns. Choose either PHASES or STAIRS.
Defines the phases traffic specification.
* @public */ Phases?: Phase[] | undefined; /** *Defines the stairs traffic pattern.
* @public */ Stairs?: Stairs | undefined; } /** *Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.
* @public */ export interface RecommendationJobVpcConfig { /** *The VPC security group IDs. IDs have the form of sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
The ID of the subnets in the VPC to which you want to connect your model.
* @public */ Subnets: string[] | undefined; } /** *The input configuration of the recommendation job.
* @public */ export interface RecommendationJobInputConfig { /** *The Amazon Resource Name (ARN) of a versioned model package.
* @public */ ModelPackageVersionArn?: string | undefined; /** *The name of the created model.
* @public */ ModelName?: string | undefined; /** *Specifies the maximum duration of the job, in seconds. The maximum value is 18,000 seconds.
* @public */ JobDurationInSeconds?: number | undefined; /** *Specifies the traffic pattern of the job.
* @public */ TrafficPattern?: TrafficPattern | undefined; /** *Defines the resource limit of the job.
* @public */ ResourceLimit?: RecommendationJobResourceLimit | undefined; /** *Specifies the endpoint configuration to use for a job.
* @public */ EndpointConfigurations?: EndpointInputConfiguration[] | undefined; /** *The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. This key will be passed to SageMaker Hosting for endpoint creation.
The SageMaker execution role must have kms:CreateGrant permission in order to encrypt data on the storage volume of the endpoints created for inference recommendation. The inference recommendation job will fail asynchronously during endpoint configuration creation if the role passed does not have kms:CreateGrant permission.
The KmsKeyId can be any of the following formats:
// KMS Key ID
"1234abcd-12ab-34cd-56ef-1234567890ab"
// Amazon Resource Name (ARN) of a KMS Key
"arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"
// KMS Key Alias
"alias/ExampleAlias"
// Amazon Resource Name (ARN) of a KMS Key Alias
"arn:aws:kms:<region>:<account>:alias/<ExampleAlias>"
For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.
* @public */ VolumeKmsKeyId?: string | undefined; /** *Specifies mandatory fields for running an Inference Recommender job. The fields specified in ContainerConfig override the corresponding fields in the model package.
Existing customer endpoints on which to run an Inference Recommender job.
* @public */ Endpoints?: EndpointInfo[] | undefined; /** *Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.
* @public */ VpcConfig?: RecommendationJobVpcConfig | undefined; } /** *Provides information about the output configuration for the compiled model.
* @public */ export interface RecommendationJobCompiledOutputConfig { /** *Identifies the Amazon S3 bucket where you want SageMaker to store the compiled model artifacts.
* @public */ S3OutputUri?: string | undefined; } /** *Provides information about the output configuration for the compiled model.
* @public */ export interface RecommendationJobOutputConfig { /** *The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt your output artifacts with Amazon S3 server-side encryption. The SageMaker execution role must have kms:GenerateDataKey permission.
The KmsKeyId can be any of the following formats:
// KMS Key ID
"1234abcd-12ab-34cd-56ef-1234567890ab"
// Amazon Resource Name (ARN) of a KMS Key
"arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"
// KMS Key Alias
"alias/ExampleAlias"
// Amazon Resource Name (ARN) of a KMS Key Alias
"arn:aws:kms:<region>:<account>:alias/<ExampleAlias>"
For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.
* @public */ KmsKeyId?: string | undefined; /** *Provides information about the output configuration for the compiled model.
* @public */ CompiledOutputConfig?: RecommendationJobCompiledOutputConfig | undefined; } /** *The model latency threshold.
* @public */ export interface ModelLatencyThreshold { /** *The model latency percentile threshold. Acceptable values are P95 and P99. For custom load tests, specify the value as P95.
The model latency percentile value in milliseconds.
* @public */ ValueInMilliseconds?: number | undefined; } /** *Specifies conditions for stopping a job. When a job reaches a stopping condition limit, SageMaker ends the job.
* @public */ export interface RecommendationJobStoppingConditions { /** *The maximum number of requests per minute expected for the endpoint.
* @public */ MaxInvocations?: number | undefined; /** *The interval of time taken by a model to respond as viewed from SageMaker. The interval includes the local communication time taken to send the request and to fetch the response from the container of a model and the time taken to complete the inference in the container.
* @public */ ModelLatencyThresholds?: ModelLatencyThreshold[] | undefined; /** *Stops a load test when the number of invocations (TPS) peaks and flattens, which means that the instance has reached capacity. The default value is Stop. If you want the load test to continue after invocations have flattened, set the value to Continue.
A name for the recommendation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account. The job name is passed down to the resources created by the recommendation job. The names of resources (such as the model, endpoint configuration, endpoint, and compilation) that are prefixed with the job name are truncated at 40 characters.
* @public */ JobName: string | undefined; /** *Defines the type of recommendation job. Specify Default to initiate an instance recommendation and Advanced to initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation (DEFAULT) job.
The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
* @public */ RoleArn: string | undefined; /** *Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.
* @public */ InputConfig: RecommendationJobInputConfig | undefined; /** *Description of the recommendation job.
* @public */ JobDescription?: string | undefined; /** *A set of conditions for stopping a recommendation job. If any of the conditions are met, the job is automatically stopped.
* @public */ StoppingConditions?: RecommendationJobStoppingConditions | undefined; /** *Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.
* @public */ OutputConfig?: RecommendationJobOutputConfig | undefined; /** *The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
* @public */ Tags?: Tag[] | undefined; } /** * @public */ export interface CreateInferenceRecommendationsJobResponse { /** *The Amazon Resource Name (ARN) of the recommendation job.
* @public */ JobArn: string | undefined; } /** *Provided configuration information for the worker UI for a labeling job. Provide either HumanTaskUiArn or UiTemplateS3Uri.
For named entity recognition, 3D point cloud and video frame labeling jobs, use HumanTaskUiArn.
For all other Ground Truth built-in task types and custom task types, use UiTemplateS3Uri to specify the location of a worker task template in Amazon S3.
The Amazon S3 bucket location of the UI template, or worker task template. This is the template used to render the worker UI and tools for labeling job tasks. For more information about the contents of a UI template, see Creating Your Custom Labeling Task Template.
* @public */ UiTemplateS3Uri?: string | undefined; /** *The ARN of the worker task template used to render the worker UI and tools for labeling job tasks.
Use this parameter when you are creating a labeling job for named entity recognition, 3D point cloud and video frame labeling jobs. Use your labeling job task type to select one of the following ARNs and use it with this parameter when you create a labeling job. Replace aws-region with the Amazon Web Services Region you are creating your labeling job in. For example, replace aws-region with us-west-1 if you create a labeling job in US West (N. California).
Named Entity Recognition
Use the following HumanTaskUiArn for named entity recognition labeling jobs:
arn:aws:sagemaker:aws-region:394669845002:human-task-ui/NamedEntityRecognition
3D Point Cloud HumanTaskUiArns
Use this HumanTaskUiArn for 3D point cloud object detection and 3D point cloud object detection adjustment labeling jobs.
arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectDetection
Use this HumanTaskUiArn for 3D point cloud object tracking and 3D point cloud object tracking adjustment labeling jobs.
arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectTracking
Use this HumanTaskUiArn for 3D point cloud semantic segmentation and 3D point cloud semantic segmentation adjustment labeling jobs.
arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudSemanticSegmentation
Video Frame HumanTaskUiArns
Use this HumanTaskUiArn for video frame object detection and video frame object detection adjustment labeling jobs.
arn:aws:sagemaker:region:394669845002:human-task-ui/VideoObjectDetection
Use this HumanTaskUiArn for video frame object tracking and video frame object tracking adjustment labeling jobs.
arn:aws:sagemaker:aws-region:394669845002:human-task-ui/VideoObjectTracking
Information required for human workers to complete a labeling task.
* @public */ export interface HumanTaskConfig { /** *The Amazon Resource Name (ARN) of the work team assigned to complete the tasks.
* @public */ WorkteamArn: string | undefined; /** *Information about the user interface that workers use to complete the labeling task.
* @public */ UiConfig: UiConfig | undefined; /** *The Amazon Resource Name (ARN) of a Lambda function that is run before a data object is sent to a human worker. Use this function to provide input to a custom labeling job.
For built-in task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for PreHumanTaskLambdaArn. For custom labeling workflows, see Pre-annotation Lambda.
Bounding box - Finds the most similar boxes from different workers based on the Jaccard index of the boxes.
arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox
arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox
arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox
arn:aws:lambda:ca-central-1:918755190332:function:PRE-BoundingBox
arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox
arn:aws:lambda:eu-west-2:487402164563:function:PRE-BoundingBox
arn:aws:lambda:eu-central-1:203001061592:function:PRE-BoundingBox
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-BoundingBox
arn:aws:lambda:ap-south-1:565803892007:function:PRE-BoundingBox
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-BoundingBox
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-BoundingBox
Image classification - Uses a variant of the Expectation Maximization approach to estimate the true class of an image based on annotations from individual workers.
arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass
arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass
arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass
arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClass
arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass
arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClass
arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClass
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass
arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClass
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClass
Multi-label image classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of an image based on annotations from individual workers.
arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClassMultiLabel
Semantic segmentation - Treats each pixel in an image as a multi-class classification and treats pixel annotations from workers as "votes" for the correct label.
arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation
arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation
arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation
arn:aws:lambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation
arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation
arn:aws:lambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation
arn:aws:lambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation
arn:aws:lambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-SemanticSegmentation
Text classification - Uses a variant of the Expectation Maximization approach to estimate the true class of text based on annotations from individual workers.
arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass
arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass
arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass
arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClass
arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass
arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClass
arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClass
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass
arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClass
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClass
Multi-label text classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of text based on annotations from individual workers.
arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClassMultiLabel
Named entity recognition - Groups similar selections and calculates aggregate boundaries, resolving to most-assigned label.
arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition
arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition
arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition
arn:aws:lambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition
arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition
arn:aws:lambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition
arn:aws:lambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition
arn:aws:lambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition
Video Classification - Use this task type when you need workers to classify videos using predefined labels that you specify. Workers are shown videos and are asked to choose one label for each video.
arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoMultiClass
arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoMultiClass
arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoMultiClass
arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoMultiClass
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoMultiClass
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoMultiClass
arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoMultiClass
arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoMultiClass
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoMultiClass
arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoMultiClass
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoMultiClass
arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoMultiClass
Video Frame Object Detection - Use this task type to have workers identify and locate objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to identify and localize various objects in a series of video frames, such as cars, bikes, and pedestrians.
arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectDetection
arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectDetection
arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectDetection
arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectDetection
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectDetection
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectDetection
arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectDetection
arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectDetection
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectDetection
arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectDetection
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectDetection
arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectDetection
Video Frame Object Tracking - Use this task type to have workers track the movement of objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to track the movement of objects, such as cars, bikes, and pedestrians.
arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectTracking
arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectTracking
arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectTracking
arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectTracking
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectTracking
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectTracking
arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectTracking
arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectTracking
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectTracking
arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectTracking
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectTracking
arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectTracking
3D Point Cloud Modalities
Use the following pre-annotation lambdas for 3D point cloud labeling modality tasks. See 3D Point Cloud Task types to learn more.
3D Point Cloud Object Detection - Use this task type when you want workers to classify objects in a 3D point cloud by drawing 3D cuboids around objects. For example, you can use this task type to ask workers to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.
arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectDetection
arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectDetection
arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectDetection
arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectDetection
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectDetection
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectDetection
arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectDetection
arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectDetection
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectDetection
arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectDetection
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectDetection
arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectDetection
3D Point Cloud Object Tracking - Use this task type when you want workers to draw 3D cuboids around objects that appear in a sequence of 3D point cloud frames. For example, you can use this task type to ask workers to track the movement of vehicles across multiple point cloud frames.
arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectTracking
arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectTracking
arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectTracking
arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectTracking
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectTracking
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectTracking
arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectTracking
arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectTracking
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectTracking
arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectTracking
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectTracking
arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectTracking
3D Point Cloud Semantic Segmentation - Use this task type when you want workers to create a point-level semantic segmentation masks by painting objects in a 3D point cloud using different colors where each color is assigned to one of the classes you specify.
arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudSemanticSegmentation
arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudSemanticSegmentation
arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudSemanticSegmentation
arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudSemanticSegmentation
arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudSemanticSegmentation
arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudSemanticSegmentation
arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudSemanticSegmentation
Use the following ARNs for Label Verification and Adjustment Jobs
Use label verification and adjustment jobs to review and adjust labels. To learn more, see Verify and Adjust Labels .
Bounding box verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgement for bounding box labels based on annotations from individual workers.
arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationBoundingBox
arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationBoundingBox
arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationBoundingBox
arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationBoundingBox
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationBoundingBox
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationBoundingBox
arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationBoundingBox
arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationBoundingBox
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationBoundingBox
arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationBoundingBox
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationBoundingBox
arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationBoundingBox
Bounding box adjustment - Finds the most similar boxes from different workers based on the Jaccard index of the adjusted annotations.
arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentBoundingBox
Semantic segmentation verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgment for semantic segmentation labels based on annotations from individual workers.
arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationSemanticSegmentation
Semantic segmentation adjustment - Treats each pixel in an image as a multi-class classification and treats pixel adjusted annotations from workers as "votes" for the correct label.
arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentSemanticSegmentation
arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentSemanticSegmentation
arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentSemanticSegmentation
arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentSemanticSegmentation
arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentSemanticSegmentation
arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentSemanticSegmentation
arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentSemanticSegmentation
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentSemanticSegmentation
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentSemanticSegmentation
arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentSemanticSegmentation
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentSemanticSegmentation
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentSemanticSegmentation
Video Frame Object Detection Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to classify and localize objects in a sequence of video frames.
arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectDetection
arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectDetection
arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectDetection
arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectDetection
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectDetection
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectDetection
arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectDetection
arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectDetection
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectDetection
arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectDetection
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectDetection
arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectDetection
Video Frame Object Tracking Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to track object movement across a sequence of video frames.
arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectTracking
arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectTracking
arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectTracking
arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectTracking
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectTracking
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectTracking
arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectTracking
arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectTracking
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectTracking
arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectTracking
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectTracking
arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectTracking
3D point cloud object detection adjustment - Adjust 3D cuboids in a point cloud frame.
arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectDetection
3D point cloud object tracking adjustment - Adjust 3D cuboids across a sequence of point cloud frames.
arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectTracking
3D point cloud semantic segmentation adjustment - Adjust semantic segmentation masks in a 3D point cloud.
arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudSemanticSegmentation
Generative AI/Custom - Direct passthrough of input data without any transformation.
arn:aws:lambda:us-east-1:432418664414:function:PRE-PassThrough
arn:aws:lambda:us-east-2:266458841044:function:PRE-PassThrough
arn:aws:lambda:us-west-2:081040173940:function:PRE-PassThrough
arn:aws:lambda:ca-central-1:918755190332:function:PRE-PassThrough
arn:aws:lambda:eu-west-1:568282634449:function:PRE-PassThrough
arn:aws:lambda:eu-west-2:487402164563:function:PRE-PassThrough
arn:aws:lambda:eu-central-1:203001061592:function:PRE-PassThrough
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-PassThrough
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-PassThrough
arn:aws:lambda:ap-south-1:565803892007:function:PRE-PassThrough
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-PassThrough
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-PassThrough
Keywords used to describe the task so that workers on Amazon Mechanical Turk can discover the task.
* @public */ TaskKeywords?: string[] | undefined; /** *A title for the task for your human workers.
* @public */ TaskTitle: string | undefined; /** *A description of the task for your human workers.
* @public */ TaskDescription: string | undefined; /** *The number of human workers that will label an object.
* @public */ NumberOfHumanWorkersPerDataObject: number | undefined; /** *The amount of time that a worker has to complete a task.
If you create a custom labeling job, the maximum value for this parameter is 8 hours (28,800 seconds).
If you create a labeling job using a built-in task type the maximum for this parameter depends on the task type you use:
For image and text labeling jobs, the maximum is 8 hours (28,800 seconds).
For 3D point cloud and video frame labeling jobs, the maximum is 30 days (2952,000 seconds) for non-AL mode. For most users, the maximum is also 30 days.
The length of time that a task remains available for labeling by human workers. The default and maximum values for this parameter depend on the type of workforce you use.
If you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours (43,200 seconds). The default is 6 hours (21,600 seconds).
If you choose a private or vendor workforce, the default value is 30 days (2592,000 seconds) for non-AL mode. For most users, the maximum is also 30 days.
Defines the maximum number of data objects that can be labeled by human workers at the same time. Also referred to as batch size. Each object may have more than one worker at one time. The default value is 1000 objects. To increase the maximum value to 5000 objects, contact Amazon Web Services Support.
* @public */ MaxConcurrentTaskCount?: number | undefined; /** *Configures how labels are consolidated across human workers.
* @public */ AnnotationConsolidationConfig?: AnnotationConsolidationConfig | undefined; /** *The price that you pay for each task performed by an Amazon Mechanical Turk worker.
* @public */ PublicWorkforceTaskPrice?: PublicWorkforceTaskPrice | undefined; } /** *Attributes of the data specified by the customer. Use these to describe the data to be labeled.
* @public */ export interface LabelingJobDataAttributes { /** *Declares that your content is free of personally identifiable information or adult content. SageMaker may restrict the Amazon Mechanical Turk workers that can view your task based on this information.
* @public */ ContentClassifiers?: ContentClassifier[] | undefined; } /** *The Amazon S3 location of the input data objects.
* @public */ export interface LabelingJobS3DataSource { /** *The Amazon S3 location of the manifest file that describes the input data objects.
The input manifest file referenced in ManifestS3Uri must contain one of the following keys: source-ref or source. The value of the keys are interpreted as follows:
source-ref: The source of the object is the Amazon S3 object specified in the value. Use this value when the object is a binary object, such as an image.
source: The source of the object is the value. Use this value when the object is a text value.
If you are a new user of Ground Truth, it is recommended you review Use an Input Manifest File in the Amazon SageMaker Developer Guide to learn how to create an input manifest file.
* @public */ ManifestS3Uri: string | undefined; } /** *An Amazon SNS data source used for streaming labeling jobs.
* @public */ export interface LabelingJobSnsDataSource { /** *The Amazon SNS input topic Amazon Resource Name (ARN). Specify the ARN of the input topic you will use to send new data objects to a streaming labeling job.
* @public */ SnsTopicArn: string | undefined; } /** *Provides information about the location of input data.
You must specify at least one of the following: S3DataSource or SnsDataSource.
Use SnsDataSource to specify an SNS input topic for a streaming labeling job. If you do not specify and SNS input topic ARN, Ground Truth will create a one-time labeling job.
Use S3DataSource to specify an input manifest file for both streaming and one-time labeling jobs. Adding an S3DataSource is optional if you use SnsDataSource to create a streaming labeling job.
The Amazon S3 location of the input data objects.
* @public */ S3DataSource?: LabelingJobS3DataSource | undefined; /** *An Amazon SNS data source used for streaming labeling jobs. To learn more, see Send Data to a Streaming Labeling Job.
* @public */ SnsDataSource?: LabelingJobSnsDataSource | undefined; } /** *Input configuration information for a labeling job.
* @public */ export interface LabelingJobInputConfig { /** *The location of the input data.
* @public */ DataSource: LabelingJobDataSource | undefined; /** *Attributes of the data specified by the customer.
* @public */ DataAttributes?: LabelingJobDataAttributes | undefined; } /** *Configure encryption on the storage volume attached to the ML compute instance used to run automated data labeling model training and inference.
* @public */ export interface LabelingJobResourceConfig { /** *The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training and inference jobs used for automated data labeling.
You can only specify a VolumeKmsKeyId when you create a labeling job with automated data labeling enabled using the API operation CreateLabelingJob. You cannot specify an Amazon Web Services KMS key to encrypt the storage volume used for automated data labeling model training and inference when you create a labeling job using the console. To learn more, see Output Data and Storage Volume Encryption.
The VolumeKmsKeyId can be any of the following formats:
KMS Key ID
"1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC.
* @public */ VpcConfig?: VpcConfig | undefined; } /** *Provides configuration information for auto-labeling of your data objects. A LabelingJobAlgorithmsConfig object must be supplied in order to use auto-labeling.
Specifies the Amazon Resource Name (ARN) of the algorithm used for auto-labeling. You must select one of the following ARNs:
Image classification
arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/image-classification
Text classification
arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/text-classification
Object detection
arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/object-detection
Semantic Segmentation
arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/semantic-segmentation
At the end of an auto-label job Ground Truth sends the Amazon Resource Name (ARN) of the final model used for auto-labeling. You can use this model as the starting point for subsequent similar jobs by providing the ARN of the model here.
* @public */ InitialActiveLearningModelArn?: string | undefined; /** *Provides configuration information for a labeling job.
* @public */ LabelingJobResourceConfig?: LabelingJobResourceConfig | undefined; } /** *Output configuration information for a labeling job.
* @public */ export interface LabelingJobOutputConfig { /** *The Amazon S3 location to write output data.
* @public */ S3OutputPath: string | undefined; /** *The Amazon Web Services Key Management Service ID of the key used to encrypt the output data, if any.
If you provide your own KMS key ID, you must add the required permissions to your KMS key described in Encrypt Output Data and Storage Volume with Amazon Web Services KMS.
If you don't provide a KMS key ID, Amazon SageMaker uses the default Amazon Web Services KMS key for Amazon S3 for your role's account to encrypt your output data.
If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.
An Amazon Simple Notification Service (Amazon SNS) output topic ARN. Provide a SnsTopicArn if you want to do real time chaining to another streaming job and receive an Amazon SNS notifications each time a data object is submitted by a worker.
If you provide an SnsTopicArn in OutputConfig, when workers complete labeling tasks, Ground Truth will send labeling task output data to the SNS output topic you specify here.
To learn more, see Receive Output Data from a Streaming Labeling Job.
* @public */ SnsTopicArn?: string | undefined; } /** *A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped. You can use these conditions to control the cost of data labeling.
Labeling jobs fail after 30 days with an appropriate client error message.
The maximum number of objects that can be labeled by human workers.
* @public */ MaxHumanLabeledObjectCount?: number | undefined; /** *The maximum number of input data objects that should be labeled.
* @public */ MaxPercentageOfInputDatasetLabeled?: number | undefined; } /** * @public */ export interface CreateLabelingJobRequest { /** *The name of the labeling job. This name is used to identify the job in a list of labeling jobs. Labeling job names must be unique within an Amazon Web Services account and region. LabelingJobName is not case sensitive. For example, Example-job and example-job are considered the same labeling job name by Ground Truth.
The attribute name to use for the label in the output manifest file. This is the key for the key/value pair formed with the label that a worker assigns to the object. The LabelAttributeName must meet the following requirements.
The name can't end with "-metadata".
If you are using one of the built-in task types or one of the following, the attribute name must end with "-ref".
Image semantic segmentation (SemanticSegmentation) and adjustment (AdjustmentSemanticSegmentation) labeling jobs for this task type. One exception is that verification (VerificationSemanticSegmentation) must not end with -"ref".
Video frame object detection (VideoObjectDetection), and adjustment and verification (AdjustmentVideoObjectDetection) labeling jobs for this task type.
Video frame object tracking (VideoObjectTracking), and adjustment and verification (AdjustmentVideoObjectTracking) labeling jobs for this task type.
3D point cloud semantic segmentation (3DPointCloudSemanticSegmentation), and adjustment and verification (Adjustment3DPointCloudSemanticSegmentation) labeling jobs for this task type.
3D point cloud object tracking (3DPointCloudObjectTracking), and adjustment and verification (Adjustment3DPointCloudObjectTracking) labeling jobs for this task type.
If you are creating an adjustment or verification labeling job, you must use a different LabelAttributeName than the one used in the original labeling job. The original labeling job is the Ground Truth labeling job that produced the labels that you want verified or adjusted. To learn more about adjustment and verification labeling jobs, see Verify and Adjust Labels.
Input data for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.
You must specify at least one of the following: S3DataSource or SnsDataSource.
Use SnsDataSource to specify an SNS input topic for a streaming labeling job. If you do not specify and SNS input topic ARN, Ground Truth will create a one-time labeling job that stops after all data objects in the input manifest file have been labeled.
Use S3DataSource to specify an input manifest file for both streaming and one-time labeling jobs. Adding an S3DataSource is optional if you use SnsDataSource to create a streaming labeling job.
If you use the Amazon Mechanical Turk workforce, your input data should not include confidential information, personal information or protected health information. Use ContentClassifiers to specify that your data is free of personally identifiable information and adult content.
The location of the output data and the Amazon Web Services Key Management Service key ID for the key used to encrypt the output data, if any.
* @public */ OutputConfig: LabelingJobOutputConfig | undefined; /** *The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete data labeling.
* @public */ RoleArn: string | undefined; /** *The S3 URI of the file, referred to as a label category configuration file, that defines the categories used to label the data objects.
For 3D point cloud and video frame task types, you can add label category attributes and frame attributes to your label category configuration file. To learn how, see Create a Labeling Category Configuration File for 3D Point Cloud Labeling Jobs.
For named entity recognition jobs, in addition to "labels", you must provide worker instructions in the label category configuration file using the "instructions" parameter: "instructions": \{"shortInstruction":"<h1>Add header</h1><p>Add Instructions</p>", "fullInstruction":"<p>Add additional instructions.</p>"\}. For details and an example, see Create a Named Entity Recognition Labeling Job (API) .
For all other built-in task types and custom tasks, your label category configuration file must be a JSON file in the following format. Identify the labels you want to use by replacing label_1, label_2,...,label_n with your label categories.
\{
"document-version": "2018-11-28",
"labels": [\{"label": "label_1"\},\{"label": "label_2"\},...\{"label": "label_n"\}]
\}
Note the following about the label category configuration file:
For image classification and text classification (single and multi-label) you must specify at least two label categories. For all other task types, the minimum number of label categories required is one.
Each label category must be unique, you cannot specify duplicate label categories.
If you create a 3D point cloud or video frame adjustment or verification labeling job, you must include auditLabelAttributeName in the label category configuration. Use this parameter to enter the LabelAttributeName of the labeling job you want to adjust or verify annotations of.
A set of conditions for stopping the labeling job. If any of the conditions are met, the job is automatically stopped. You can use these conditions to control the cost of data labeling.
* @public */ StoppingConditions?: LabelingJobStoppingConditions | undefined; /** *Configures the information required to perform automated data labeling.
* @public */ LabelingJobAlgorithmsConfig?: LabelingJobAlgorithmsConfig | undefined; /** *Configures the labeling task and how it is presented to workers; including, but not limited to price, keywords, and batch size (task count).
* @public */ HumanTaskConfig: HumanTaskConfig | undefined; /** *An array of key/value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
* @public */ Tags?: Tag[] | undefined; } /** * @public */ export interface CreateLabelingJobResponse { /** *The Amazon Resource Name (ARN) of the labeling job. You use this ARN to identify the labeling job.
* @public */ LabelingJobArn: string | undefined; } /** * @public */ export interface CreateMlflowTrackingServerRequest { /** *A unique string identifying the tracking server name. This string is part of the tracking server ARN.
* @public */ TrackingServerName: string | undefined; /** *The S3 URI for a general purpose bucket to use as the MLflow Tracking Server artifact store.
* @public */ ArtifactStoreUri: string | undefined; /** *The size of the tracking server you want to create. You can choose between "Small", "Medium", and "Large". The default MLflow Tracking Server configuration size is "Small". You can choose a size depending on the projected use of the tracking server such as the volume of data logged, number of users, and frequency of use.
We recommend using a small tracking server for teams of up to 25 users, a medium tracking server for teams of up to 50 users, and a large tracking server for teams of up to 100 users.
* @public */ TrackingServerSize?: TrackingServerSize | undefined; /** *The version of MLflow that the tracking server uses. To see which MLflow versions are available to use, see How it works.
* @public */ MlflowVersion?: string | undefined; /** *The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow Tracking Server uses to access the artifact store in Amazon S3. The role should have AmazonS3FullAccess permissions. For more information on IAM permissions for tracking server creation, see Set up IAM permissions for MLflow.
Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. To enable automatic model registration, set this value to True. To disable automatic model registration, set this value to False. If not specified, AutomaticModelRegistration defaults to False.
The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. For example: TUE:03:30.
* @public */ WeeklyMaintenanceWindowStart?: string | undefined; /** *Tags consisting of key-value pairs used to manage metadata for the tracking server.
* @public */ Tags?: Tag[] | undefined; } /** * @public */ export interface CreateMlflowTrackingServerResponse { /** *The ARN of the tracking server.
* @public */ TrackingServerArn?: string | undefined; } /** *Specifies details about how containers in a multi-container endpoint are run.
* @public */ export interface InferenceExecutionConfig { /** *How containers in a multi-container are run. The following values are valid.
SERIAL - Containers run as a serial pipeline.
DIRECT - Only the individual container that you specify is run.
The name of the new model.
* @public */ ModelName: string | undefined; /** *The location of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions.
* @public */ PrimaryContainer?: ContainerDefinition | undefined; /** *Specifies the containers in the inference pipeline.
* @public */ Containers?: ContainerDefinition[] | undefined; /** *Specifies details of how containers in a multi-container endpoint are called.
* @public */ InferenceExecutionConfig?: InferenceExecutionConfig | undefined; /** *The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute instances or for batch transform jobs. Deploying on ML compute instances is part of model hosting. For more information, see SageMaker Roles.
To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.
An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
* @public */ Tags?: Tag[] | undefined; /** *A VpcConfig object that specifies the VPC that you want your model to connect to. Control access to and from your model container by configuring the VPC. VpcConfig is used in hosting services and in batch transform. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private Cloud.
Isolates the model container. No inbound or outbound network calls can be made to or from the model container.
* @public */ EnableNetworkIsolation?: boolean | undefined; } /** * @public */ export interface CreateModelOutput { /** *The ARN of the model created in SageMaker.
* @public */ ModelArn: string | undefined; } /** *Docker container image configuration object for the model bias job.
* @public */ export interface ModelBiasAppSpecification { /** *The container image to be run by the model bias job.
* @public */ ImageUri: string | undefined; /** *JSON formatted S3 file that defines bias parameters. For more information on this JSON configuration file, see Configure bias parameters.
* @public */ ConfigUri: string | undefined; /** *Sets the environment variables in the Docker container.
* @public */ Environment?: RecordThe configuration for a baseline model bias job.
* @public */ export interface ModelBiasBaselineConfig { /** *The name of the baseline model bias job.
* @public */ BaseliningJobName?: string | undefined; /** *The constraints resource for a monitoring job.
* @public */ ConstraintsResource?: MonitoringConstraintsResource | undefined; } /** *The ground truth labels for the dataset used for the monitoring job.
* @public */ export interface MonitoringGroundTruthS3Input { /** *The address of the Amazon S3 location of the ground truth labels.
* @public */ S3Uri?: string | undefined; } /** *Inputs for the model bias job.
* @public */ export interface ModelBiasJobInput { /** *Input object for the endpoint
* @public */ EndpointInput?: EndpointInput | undefined; /** *Input object for the batch transform job.
* @public */ BatchTransformInput?: BatchTransformInput | undefined; /** *Location of ground truth labels to use in model bias job.
* @public */ GroundTruthS3Input: MonitoringGroundTruthS3Input | undefined; } /** * @public */ export interface CreateModelBiasJobDefinitionRequest { /** *The name of the bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
* @public */ JobDefinitionName: string | undefined; /** *The baseline configuration for a model bias job.
* @public */ ModelBiasBaselineConfig?: ModelBiasBaselineConfig | undefined; /** *Configures the model bias job to run a specified Docker container image.
* @public */ ModelBiasAppSpecification: ModelBiasAppSpecification | undefined; /** *Inputs for the model bias job.
* @public */ ModelBiasJobInput: ModelBiasJobInput | undefined; /** *The output configuration for monitoring jobs.
* @public */ ModelBiasJobOutputConfig: MonitoringOutputConfig | undefined; /** *Identifies the resources to deploy for a monitoring job.
* @public */ JobResources: MonitoringResources | undefined; /** *Networking options for a model bias job.
* @public */ NetworkConfig?: MonitoringNetworkConfig | undefined; /** *The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.
* @public */ RoleArn: string | undefined; /** *A time limit for how long the monitoring job is allowed to run before stopping.
* @public */ StoppingCondition?: MonitoringStoppingCondition | undefined; /** *(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
* @public */ Tags?: Tag[] | undefined; } /** * @public */ export interface CreateModelBiasJobDefinitionResponse { /** *The Amazon Resource Name (ARN) of the model bias job.
* @public */ JobDefinitionArn: string | undefined; } /** *Configure the security settings to protect model card data.
* @public */ export interface ModelCardSecurityConfig { /** *A Key Management Service key ID to use for encrypting a model card.
* @public */ KmsKeyId?: string | undefined; } /** * @public */ export interface CreateModelCardRequest { /** *The unique name of the model card.
* @public */ ModelCardName: string | undefined; /** *An optional Key Management Service key to encrypt, decrypt, and re-encrypt model card content for regulated workloads with highly sensitive data.
* @public */ SecurityConfig?: ModelCardSecurityConfig | undefined; /** *The content of the model card. Content must be in model card JSON schema and provided as a string.
* @public */ Content: string | undefined; /** *The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
Draft: The model card is a work in progress.
PendingReview: The model card is pending review.
Approved: The model card is approved.
Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.
Key-value pairs used to manage metadata for model cards.
* @public */ Tags?: Tag[] | undefined; } /** * @public */ export interface CreateModelCardResponse { /** *The Amazon Resource Name (ARN) of the successfully created model card.
* @public */ ModelCardArn: string | undefined; } /** *Configure the export output details for an Amazon SageMaker Model Card.
* @public */ export interface ModelCardExportOutputConfig { /** *The Amazon S3 output path to export your model card PDF.
* @public */ S3OutputPath: string | undefined; } /** * @public */ export interface CreateModelCardExportJobRequest { /** *The name or Amazon Resource Name (ARN) of the model card to export.
* @public */ ModelCardName: string | undefined; /** *The version of the model card to export. If a version is not provided, then the latest version of the model card is exported.
* @public */ ModelCardVersion?: number | undefined; /** *The name of the model card export job.
* @public */ ModelCardExportJobName: string | undefined; /** *The model card output configuration that specifies the Amazon S3 path for exporting.
* @public */ OutputConfig: ModelCardExportOutputConfig | undefined; } /** * @public */ export interface CreateModelCardExportJobResponse { /** *The Amazon Resource Name (ARN) of the model card export job.
* @public */ ModelCardExportJobArn: string | undefined; } /** *Docker container image configuration object for the model explainability job.
* @public */ export interface ModelExplainabilityAppSpecification { /** *The container image to be run by the model explainability job.
* @public */ ImageUri: string | undefined; /** *JSON formatted Amazon S3 file that defines explainability parameters. For more information on this JSON configuration file, see Configure model explainability parameters.
* @public */ ConfigUri: string | undefined; /** *Sets the environment variables in the Docker container.
* @public */ Environment?: RecordThe configuration for a baseline model explainability job.
* @public */ export interface ModelExplainabilityBaselineConfig { /** *The name of the baseline model explainability job.
* @public */ BaseliningJobName?: string | undefined; /** *The constraints resource for a monitoring job.
* @public */ ConstraintsResource?: MonitoringConstraintsResource | undefined; } /** *Inputs for the model explainability job.
* @public */ export interface ModelExplainabilityJobInput { /** *Input object for the endpoint
* @public */ EndpointInput?: EndpointInput | undefined; /** *Input object for the batch transform job.
* @public */ BatchTransformInput?: BatchTransformInput | undefined; } /** * @public */ export interface CreateModelExplainabilityJobDefinitionRequest { /** *The name of the model explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
* @public */ JobDefinitionName: string | undefined; /** *The baseline configuration for a model explainability job.
* @public */ ModelExplainabilityBaselineConfig?: ModelExplainabilityBaselineConfig | undefined; /** *Configures the model explainability job to run a specified Docker container image.
* @public */ ModelExplainabilityAppSpecification: ModelExplainabilityAppSpecification | undefined; /** *Inputs for the model explainability job.
* @public */ ModelExplainabilityJobInput: ModelExplainabilityJobInput | undefined; /** *The output configuration for monitoring jobs.
* @public */ ModelExplainabilityJobOutputConfig: MonitoringOutputConfig | undefined; /** *Identifies the resources to deploy for a monitoring job.
* @public */ JobResources: MonitoringResources | undefined; /** *Networking options for a model explainability job.
* @public */ NetworkConfig?: MonitoringNetworkConfig | undefined; /** *The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.
* @public */ RoleArn: string | undefined; /** *A time limit for how long the monitoring job is allowed to run before stopping.
* @public */ StoppingCondition?: MonitoringStoppingCondition | undefined; /** *(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
* @public */ Tags?: Tag[] | undefined; } /** * @public */ export interface CreateModelExplainabilityJobDefinitionResponse { /** *The Amazon Resource Name (ARN) of the model explainability job.
* @public */ JobDefinitionArn: string | undefined; } /** *Contains details regarding the file source.
* @public */ export interface FileSource { /** *The type of content stored in the file source.
* @public */ ContentType?: string | undefined; /** *The digest of the file source.
* @public */ ContentDigest?: string | undefined; /** *The Amazon S3 URI for the file source.
* @public */ S3Uri: string | undefined; } /** *Represents the drift check bias baselines that can be used when the model monitor is set using the model package.
* @public */ export interface DriftCheckBias { /** *The bias config file for a model.
* @public */ ConfigFile?: FileSource | undefined; /** *The pre-training constraints.
* @public */ PreTrainingConstraints?: MetricsSource | undefined; /** *The post-training constraints.
* @public */ PostTrainingConstraints?: MetricsSource | undefined; } /** *Represents the drift check explainability baselines that can be used when the model monitor is set using the model package.
* @public */ export interface DriftCheckExplainability { /** *The drift check explainability constraints.
* @public */ Constraints?: MetricsSource | undefined; /** *The explainability config file for the model.
* @public */ ConfigFile?: FileSource | undefined; } /** *Represents the drift check data quality baselines that can be used when the model monitor is set using the model package.
* @public */ export interface DriftCheckModelDataQuality { /** *The drift check model data quality statistics.
* @public */ Statistics?: MetricsSource | undefined; /** *The drift check model data quality constraints.
* @public */ Constraints?: MetricsSource | undefined; } /** *Represents the drift check model quality baselines that can be used when the model monitor is set using the model package.
* @public */ export interface DriftCheckModelQuality { /** *The drift check model quality statistics.
* @public */ Statistics?: MetricsSource | undefined; /** *The drift check model quality constraints.
* @public */ Constraints?: MetricsSource | undefined; } /** *Represents the drift check baselines that can be used when the model monitor is set using the model package.
* @public */ export interface DriftCheckBaselines { /** *Represents the drift check bias baselines that can be used when the model monitor is set using the model package.
* @public */ Bias?: DriftCheckBias | undefined; /** *Represents the drift check explainability baselines that can be used when the model monitor is set using the model package.
* @public */ Explainability?: DriftCheckExplainability | undefined; /** *Represents the drift check model quality baselines that can be used when the model monitor is set using the model package.
* @public */ ModelQuality?: DriftCheckModelQuality | undefined; /** *Represents the drift check model data quality baselines that can be used when the model monitor is set using the model package.
* @public */ ModelDataQuality?: DriftCheckModelDataQuality | undefined; } /** *The model card associated with the model package. Since ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.
The content of the model card. The content must follow the schema described in Model Package Model Card Schema.
* @public */ ModelCardContent?: string | undefined; /** *The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
Draft: The model card is a work in progress.
PendingReview: The model card is pending review.
Approved: The model card is approved.
Archived: The model card is archived. No more updates can be made to the model card content. If you try to update the model card content, you will receive the message Model Card is in Archived state.
A structure describing the current state of the model in its life cycle.
* @public */ export interface ModelLifeCycle { /** *The current stage in the model life cycle.
* @public */ Stage: string | undefined; /** *The current status of a stage in model life cycle.
* @public */ StageStatus: string | undefined; /** *Describes the stage related details.
* @public */ StageDescription?: string | undefined; } /** *Contains explainability metrics for a model.
* @public */ export interface Explainability { /** *The explainability report for a model.
* @public */ Report?: MetricsSource | undefined; } /** *Data quality constraints and statistics for a model.
* @public */ export interface ModelDataQuality { /** *Data quality statistics for a model.
* @public */ Statistics?: MetricsSource | undefined; /** *Data quality constraints for a model.
* @public */ Constraints?: MetricsSource | undefined; } /** *Model quality statistics and constraints.
* @public */ export interface ModelQuality { /** *Model quality statistics.
* @public */ Statistics?: MetricsSource | undefined; /** *Model quality constraints.
* @public */ Constraints?: MetricsSource | undefined; } /** *Contains metrics captured from a model.
* @public */ export interface ModelMetrics { /** *Metrics that measure the quality of a model.
* @public */ ModelQuality?: ModelQuality | undefined; /** *Metrics that measure the quality of the input data for a model.
* @public */ ModelDataQuality?: ModelDataQuality | undefined; /** *Metrics that measure bias in a model.
* @public */ Bias?: Bias | undefined; /** *Metrics that help explain a model.
* @public */ Explainability?: Explainability | undefined; } /** *An optional Key Management Service key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with highly sensitive data.
* @public */ export interface ModelPackageSecurityConfig { /** *The KMS Key ID (KMSKeyId) used for encryption of model package information.
Specifies an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.
* @public */ export interface SourceAlgorithm { /** *The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).
The model artifacts must be in an S3 bucket that is in the same Amazon Web Services region as the algorithm.
Specifies the location of ML model data to deploy during endpoint creation.
* @public */ ModelDataSource?: ModelDataSource | undefined; /** *The ETag associated with Model Data URL.
* @public */ ModelDataETag?: string | undefined; /** *The name of an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.
* @public */ AlgorithmName: string | undefined; } /** *A list of algorithms that were used to create a model package.
* @public */ export interface SourceAlgorithmSpecification { /** *A list of the algorithms that were used to create a model package.
* @public */ SourceAlgorithms: SourceAlgorithm[] | undefined; } /** *Contains data, such as the inputs and targeted instance types that are used in the process of validating the model package.
The data provided in the validation profile is made available to your buyers on Amazon Web Services Marketplace.
* @public */ export interface ModelPackageValidationProfile { /** *The name of the profile for the model package.
* @public */ ProfileName: string | undefined; /** *The TransformJobDefinition object that describes the transform job used for the validation of the model package.
Specifies batch transform jobs that SageMaker runs to validate your model package.
* @public */ export interface ModelPackageValidationSpecification { /** *The IAM roles to be used for the validation of the model package.
* @public */ ValidationRole: string | undefined; /** *An array of ModelPackageValidationProfile objects, each of which specifies a batch transform job that SageMaker runs to validate your model package.
The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).
This parameter is required for unversioned models. It is not applicable to versioned models.
* @public */ ModelPackageName?: string | undefined; /** *The name or Amazon Resource Name (ARN) of the model package group that this model version belongs to.
This parameter is required for versioned models, and does not apply to unversioned models.
* @public */ ModelPackageGroupName?: string | undefined; /** *A description of the model package.
* @public */ ModelPackageDescription?: string | undefined; /** *Specifies details about inference jobs that you can run with models based on this model package, including the following information:
The Amazon ECR paths of containers that contain the inference code and model artifacts.
The instance types that the model package supports for transform jobs and real-time endpoints used for inference.
The input and output content formats that the model package supports for inference.
Specifies configurations for one or more transform jobs that SageMaker runs to test the model package.
* @public */ ValidationSpecification?: ModelPackageValidationSpecification | undefined; /** *Details about the algorithm that was used to create the model package.
* @public */ SourceAlgorithmSpecification?: SourceAlgorithmSpecification | undefined; /** *Whether to certify the model package for listing on Amazon Web Services Marketplace.
This parameter is optional for unversioned models, and does not apply to versioned models.
* @public */ CertifyForMarketplace?: boolean | undefined; /** *A list of key value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
If you supply ModelPackageGroupName, your model package belongs to the model group you specify and uses the tags associated with the model group. In this case, you cannot supply a tag argument.
Whether the model is approved for deployment.
This parameter is optional for versioned models, and does not apply to unversioned models.
For versioned models, the value of this parameter must be set to Approved to deploy the model.
Metadata properties of the tracking entity, trial, or trial component.
* @public */ MetadataProperties?: MetadataProperties | undefined; /** *A structure that contains model metrics reports.
* @public */ ModelMetrics?: ModelMetrics | undefined; /** *A unique token that guarantees that the call to this API is idempotent.
* @public */ ClientToken?: string | undefined; /** *The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.
* @public */ Domain?: string | undefined; /** *The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification. The following tasks are supported by Inference Recommender: "IMAGE_CLASSIFICATION" | "OBJECT_DETECTION" | "TEXT_GENERATION" |"IMAGE_SEGMENTATION" | "FILL_MASK" | "CLASSIFICATION" | "REGRESSION" | "OTHER".
Specify "OTHER" if none of the tasks listed fit your use case.
* @public */ Task?: string | undefined; /** *The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). This archive can hold multiple files that are all equally used in the load test. Each file in the archive must satisfy the size constraints of the InvokeEndpoint call.
* @public */ SamplePayloadUrl?: string | undefined; /** *The metadata properties associated with the model package versions.
* @public */ CustomerMetadataProperties?: RecordRepresents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.
* @public */ DriftCheckBaselines?: DriftCheckBaselines | undefined; /** *An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.
* @public */ AdditionalInferenceSpecifications?: AdditionalInferenceSpecificationDefinition[] | undefined; /** *Indicates if you want to skip model validation.
* @public */ SkipModelValidation?: SkipModelValidation | undefined; /** *The URI of the source for the model package. If you want to clone a model package, set it to the model package Amazon Resource Name (ARN). If you want to register a model, set it to the model ARN.
* @public */ SourceUri?: string | undefined; /** *The KMS Key ID (KMSKeyId) used for encryption of model package information.
The model card associated with the model package. Since ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.
A structure describing the current state of the model in its life cycle.
* @public */ ModelLifeCycle?: ModelLifeCycle | undefined; } /** * @public */ export interface CreateModelPackageOutput { /** *The Amazon Resource Name (ARN) of the new model package.
* @public */ ModelPackageArn: string | undefined; } /** * @public */ export interface CreateModelPackageGroupInput { /** *The name of the model group.
* @public */ ModelPackageGroupName: string | undefined; /** *A description for the model group.
* @public */ ModelPackageGroupDescription?: string | undefined; /** *A list of key value pairs associated with the model group. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
* @public */ Tags?: Tag[] | undefined; } /** * @public */ export interface CreateModelPackageGroupOutput { /** *The Amazon Resource Name (ARN) of the model group.
* @public */ ModelPackageGroupArn: string | undefined; } /** *Container image configuration object for the monitoring job.
* @public */ export interface ModelQualityAppSpecification { /** *The address of the container image that the monitoring job runs.
* @public */ ImageUri: string | undefined; /** *Specifies the entrypoint for a container that the monitoring job runs.
* @public */ ContainerEntrypoint?: string[] | undefined; /** *An array of arguments for the container used to run the monitoring job.
* @public */ ContainerArguments?: string[] | undefined; /** *An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flattened JSON so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.
* @public */ RecordPreprocessorSourceUri?: string | undefined; /** *An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.
* @public */ PostAnalyticsProcessorSourceUri?: string | undefined; /** *The machine learning problem type of the model that the monitoring job monitors.
* @public */ ProblemType?: MonitoringProblemType | undefined; /** *Sets the environment variables in the container that the monitoring job runs.
* @public */ Environment?: RecordConfiguration for monitoring constraints and monitoring statistics. These baseline resources are compared against the results of the current job from the series of jobs scheduled to collect data periodically.
* @public */ export interface ModelQualityBaselineConfig { /** *The name of the job that performs baselining for the monitoring job.
* @public */ BaseliningJobName?: string | undefined; /** *The constraints resource for a monitoring job.
* @public */ ConstraintsResource?: MonitoringConstraintsResource | undefined; } /** *The input for the model quality monitoring job. Currently endpoints are supported for input for model quality monitoring jobs.
* @public */ export interface ModelQualityJobInput { /** *Input object for the endpoint
* @public */ EndpointInput?: EndpointInput | undefined; /** *Input object for the batch transform job.
* @public */ BatchTransformInput?: BatchTransformInput | undefined; /** *The ground truth label provided for the model.
* @public */ GroundTruthS3Input: MonitoringGroundTruthS3Input | undefined; } /** * @public */ export interface CreateModelQualityJobDefinitionRequest { /** *The name of the monitoring job definition.
* @public */ JobDefinitionName: string | undefined; /** *Specifies the constraints and baselines for the monitoring job.
* @public */ ModelQualityBaselineConfig?: ModelQualityBaselineConfig | undefined; /** *The container that runs the monitoring job.
* @public */ ModelQualityAppSpecification: ModelQualityAppSpecification | undefined; /** *A list of the inputs that are monitored. Currently endpoints are supported.
* @public */ ModelQualityJobInput: ModelQualityJobInput | undefined; /** *The output configuration for monitoring jobs.
* @public */ ModelQualityJobOutputConfig: MonitoringOutputConfig | undefined; /** *Identifies the resources to deploy for a monitoring job.
* @public */ JobResources: MonitoringResources | undefined; /** *Specifies the network configuration for the monitoring job.
* @public */ NetworkConfig?: MonitoringNetworkConfig | undefined; /** *The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.
* @public */ RoleArn: string | undefined; /** *A time limit for how long the monitoring job is allowed to run before stopping.
* @public */ StoppingCondition?: MonitoringStoppingCondition | undefined; /** *(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
* @public */ Tags?: Tag[] | undefined; } /** * @public */ export interface CreateModelQualityJobDefinitionResponse { /** *The Amazon Resource Name (ARN) of the model quality monitoring job.
* @public */ JobDefinitionArn: string | undefined; } /** *Configuration for monitoring constraints and monitoring statistics. These baseline resources are compared against the results of the current job from the series of jobs scheduled to collect data periodically.
* @public */ export interface MonitoringBaselineConfig { /** *The name of the job that performs baselining for the monitoring job.
* @public */ BaseliningJobName?: string | undefined; /** *The baseline constraint file in Amazon S3 that the current monitoring job should validated against.
* @public */ ConstraintsResource?: MonitoringConstraintsResource | undefined; /** *The baseline statistics file in Amazon S3 that the current monitoring job should be validated against.
* @public */ StatisticsResource?: MonitoringStatisticsResource | undefined; } /** *Container image configuration object for the monitoring job.
* @public */ export interface MonitoringAppSpecification { /** *The container image to be run by the monitoring job.
* @public */ ImageUri: string | undefined; /** *Specifies the entrypoint for a container used to run the monitoring job.
* @public */ ContainerEntrypoint?: string[] | undefined; /** *An array of arguments for the container used to run the monitoring job.
* @public */ ContainerArguments?: string[] | undefined; /** *An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flattened JSON so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.
* @public */ RecordPreprocessorSourceUri?: string | undefined; /** *An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.
* @public */ PostAnalyticsProcessorSourceUri?: string | undefined; } /** *The inputs for a monitoring job.
* @public */ export interface MonitoringInput { /** *The endpoint for a monitoring job.
* @public */ EndpointInput?: EndpointInput | undefined; /** *Input object for the batch transform job.
* @public */ BatchTransformInput?: BatchTransformInput | undefined; } /** *Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.
* @public */ export interface NetworkConfig { /** *Whether to encrypt all communications between distributed processing jobs. Choose True to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer.
Whether to allow inbound and outbound network calls to and from the containers used for the processing job.
* @public */ EnableNetworkIsolation?: boolean | undefined; /** *Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC.
* @public */ VpcConfig?: VpcConfig | undefined; } /** *Defines the monitoring job.
* @public */ export interface MonitoringJobDefinition { /** *Baseline configuration used to validate that the data conforms to the specified constraints and statistics
* @public */ BaselineConfig?: MonitoringBaselineConfig | undefined; /** *The array of inputs for the monitoring job. Currently we support monitoring an Amazon SageMaker AI Endpoint.
* @public */ MonitoringInputs: MonitoringInput[] | undefined; /** *The array of outputs from the monitoring job to be uploaded to Amazon S3.
* @public */ MonitoringOutputConfig: MonitoringOutputConfig | undefined; /** *Identifies the resources, ML compute instances, and ML storage volumes to deploy for a monitoring job. In distributed processing, you specify more than one instance.
* @public */ MonitoringResources: MonitoringResources | undefined; /** *Configures the monitoring job to run a specified Docker container image.
* @public */ MonitoringAppSpecification: MonitoringAppSpecification | undefined; /** *Specifies a time limit for how long the monitoring job is allowed to run.
* @public */ StoppingCondition?: MonitoringStoppingCondition | undefined; /** *Sets the environment variables in the Docker container.
* @public */ Environment?: RecordSpecifies networking options for an monitoring job.
* @public */ NetworkConfig?: NetworkConfig | undefined; /** *The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.
* @public */ RoleArn: string | undefined; } /** *Configuration details about the monitoring schedule.
* @public */ export interface ScheduleConfig { /** *A cron expression that describes details about the monitoring schedule.
The supported cron expressions are:
If you want to set the job to start every hour, use the following:
Hourly: cron(0 * ? * * *)
If you want to start the job daily:
cron(0 [00-23] ? * * *)
If you want to run the job one time, immediately, use the following keyword:
NOW
For example, the following are valid cron expressions:
Daily at noon UTC: cron(0 12 ? * * *)
Daily at midnight UTC: cron(0 0 ? * * *)
To support running every 6, 12 hours, the following are also supported:
cron(0 [00-23]/[01-24] ? * * *)
For example, the following are valid cron expressions:
Every 12 hours, starting at 5pm UTC: cron(0 17/12 ? * * *)
Every two hours starting at midnight: cron(0 0/2 ? * * *)
Even though the cron expression is set to start at 5PM UTC, note that there could be a delay of 0-20 minutes from the actual requested time to run the execution.
We recommend that if you would like a daily schedule, you do not provide this parameter. Amazon SageMaker AI will pick a time for running every day.
You can also specify the keyword NOW to run the monitoring job immediately, one time, without recurring.
Sets the start time for a monitoring job window. Express this time as an offset to the times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the ScheduleExpression parameter. Specify this offset in ISO 8601 duration format. For example, if you want to monitor the five hours of data in your dataset that precede the start of each monitoring job, you would specify: "-PT5H".
The start time that you specify must not precede the end time that you specify by more than 24 hours. You specify the end time with the DataAnalysisEndTime parameter.
If you set ScheduleExpression to NOW, this parameter is required.
Sets the end time for a monitoring job window. Express this time as an offset to the times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the ScheduleExpression parameter. Specify this offset in ISO 8601 duration format. For example, if you want to end the window one hour before the start of each monitoring job, you would specify: "-PT1H".
The end time that you specify must not follow the start time that you specify by more than 24 hours. You specify the start time with the DataAnalysisStartTime parameter.
If you set ScheduleExpression to NOW, this parameter is required.
Configures the monitoring schedule and defines the monitoring job.
* @public */ export interface MonitoringScheduleConfig { /** *Configures the monitoring schedule.
* @public */ ScheduleConfig?: ScheduleConfig | undefined; /** *Defines the monitoring job.
* @public */ MonitoringJobDefinition?: MonitoringJobDefinition | undefined; /** *The name of the monitoring job definition to schedule.
* @public */ MonitoringJobDefinitionName?: string | undefined; /** *The type of the monitoring job definition to schedule.
* @public */ MonitoringType?: MonitoringType | undefined; } /** * @public */ export interface CreateMonitoringScheduleRequest { /** *The name of the monitoring schedule. The name must be unique within an Amazon Web Services Region within an Amazon Web Services account.
* @public */ MonitoringScheduleName: string | undefined; /** *The configuration object that specifies the monitoring schedule and defines the monitoring job.
* @public */ MonitoringScheduleConfig: MonitoringScheduleConfig | undefined; /** *(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
* @public */ Tags?: Tag[] | undefined; } /** * @public */ export interface CreateMonitoringScheduleResponse { /** *The Amazon Resource Name (ARN) of the monitoring schedule.
* @public */ MonitoringScheduleArn: string | undefined; } /** *Information on the IMDS configuration of the notebook instance
* @public */ export interface InstanceMetadataServiceConfiguration { /** *Indicates the minimum IMDS version that the notebook instance supports. When passed as part of CreateNotebookInstance, if no value is selected, then it defaults to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part of UpdateNotebookInstance, there is no default.
The name of the new notebook instance.
* @public */ NotebookInstanceName: string | undefined; /** *The type of ML compute instance to launch for the notebook instance.
* @public */ InstanceType: _InstanceType | undefined; /** *The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.
* @public */ SubnetId?: string | undefined; /** *The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.
* @public */ SecurityGroupIds?: string[] | undefined; /** *The IP address type for the notebook instance. Specify ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity. When you specify dualstack, the subnet must support IPv6 CIDR blocks. If not specified, defaults to ipv4.
When you send any requests to Amazon Web Services resources from the notebook instance, SageMaker AI assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so SageMaker AI can perform these tasks. The policy must allow the SageMaker AI service principal (sagemaker.amazonaws.com) permissions to assume this role. For more information, see SageMaker AI Roles.
To be able to pass this role to SageMaker AI, the caller of this API must have the iam:PassRole permission.
The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker AI uses to encrypt data on the storage volume attached to your notebook instance. The KMS key you provide must be enabled. For information, see Enabling and Disabling Keys in the Amazon Web Services Key Management Service Developer Guide.
* @public */ KmsKeyId?: string | undefined; /** *An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
* @public */ Tags?: Tag[] | undefined; /** *The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.
* @public */ LifecycleConfigName?: string | undefined; /** *Sets whether SageMaker AI provides internet access to the notebook instance. If you set this to Disabled this notebook instance is able to access resources only in your VPC, and is not be able to connect to SageMaker AI training and endpoint services unless you configure a NAT Gateway in your VPC.
For more information, see Notebook Instances Are Internet-Enabled by Default. You can set the value of this parameter to Disabled only if you set a value for the SubnetId parameter.
The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.
* @public */ VolumeSizeInGB?: number | undefined; /** *This parameter is no longer supported. Elastic Inference (EI) is no longer available.
This parameter was used to specify a list of EI instance types to associate with this notebook instance.
* @public */ AcceleratorTypes?: NotebookInstanceAcceleratorType[] | undefined; /** *A Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker AI Notebook Instances.
* @public */ DefaultCodeRepository?: string | undefined; /** *An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker AI Notebook Instances.
* @public */ AdditionalCodeRepositories?: string[] | undefined; /** *Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled.
Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.
The platform identifier of the notebook instance runtime environment. The default value is notebook-al2-v2.
Information on the IMDS configuration of the notebook instance
* @public */ InstanceMetadataServiceConfiguration?: InstanceMetadataServiceConfiguration | undefined; } /** * @public */ export interface CreateNotebookInstanceOutput { /** *The Amazon Resource Name (ARN) of the notebook instance.
* @public */ NotebookInstanceArn?: string | undefined; } /** *Contains the notebook instance lifecycle configuration script.
Each lifecycle configuration script has a limit of 16384 characters.
The value of the $PATH environment variable that is available to both scripts is /sbin:bin:/usr/sbin:/usr/bin.
View Amazon CloudWatch Logs for notebook instance lifecycle configurations in log group /aws/sagemaker/NotebookInstances in log stream [notebook-instance-name]/[LifecycleConfigHook].
Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started.
For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.
* @public */ export interface NotebookInstanceLifecycleHook { /** *A base64-encoded string that contains a shell script for a notebook instance lifecycle configuration.
* @public */ Content?: string | undefined; } /** * @public */ export interface CreateNotebookInstanceLifecycleConfigInput { /** *The name of the lifecycle configuration.
* @public */ NotebookInstanceLifecycleConfigName: string | undefined; /** *A shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.
* @public */ OnCreate?: NotebookInstanceLifecycleHook[] | undefined; /** *A shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.
* @public */ OnStart?: NotebookInstanceLifecycleHook[] | undefined; /** *An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
* @public */ Tags?: Tag[] | undefined; } /** * @public */ export interface CreateNotebookInstanceLifecycleConfigOutput { /** *The Amazon Resource Name (ARN) of the lifecycle configuration.
* @public */ NotebookInstanceLifecycleConfigArn?: string | undefined; } /** *The access configuration settings for the source ML model for an optimization job, where you can accept the model end-user license agreement (EULA).
* @public */ export interface OptimizationModelAccessConfig { /** *Specifies agreement to the model end-user license agreement (EULA). The AcceptEula value must be explicitly defined as True in order to accept the EULA that this model requires. You are responsible for reviewing and complying with any applicable license terms and making sure they are acceptable for your use case before downloading or using a model.
The Amazon S3 location of a source model to optimize with an optimization job.
* @public */ export interface OptimizationJobModelSourceS3 { /** *An Amazon S3 URI that locates a source model to optimize with an optimization job.
* @public */ S3Uri?: string | undefined; /** *The access configuration settings for the source ML model for an optimization job, where you can accept the model end-user license agreement (EULA).
* @public */ ModelAccessConfig?: OptimizationModelAccessConfig | undefined; } /** *A SageMaker model to use as the source or destination for an optimization job.
* @public */ export interface OptimizationSageMakerModel { /** *The name of a SageMaker model.
* @public */ ModelName?: string | undefined; } /** *The location of the source model to optimize with an optimization job.
* @public */ export interface OptimizationJobModelSource { /** *The Amazon S3 location of a source model to optimize with an optimization job.
* @public */ S3?: OptimizationJobModelSourceS3 | undefined; /** *The name of an existing SageMaker model to optimize with an optimization job.
* @public */ SageMakerModel?: OptimizationSageMakerModel | undefined; } /** *Settings for the model compilation technique that's applied by a model optimization job.
* @public */ export interface ModelCompilationConfig { /** *The URI of an LMI DLC in Amazon ECR. SageMaker uses this image to run the optimization.
* @public */ Image?: string | undefined; /** *Environment variables that override the default ones in the model container.
* @public */ OverrideEnvironment?: RecordSettings for the model quantization technique that's applied by a model optimization job.
* @public */ export interface ModelQuantizationConfig { /** *The URI of an LMI DLC in Amazon ECR. SageMaker uses this image to run the optimization.
* @public */ Image?: string | undefined; /** *Environment variables that override the default ones in the model container.
* @public */ OverrideEnvironment?: RecordSettings for the model sharding technique that's applied by a model optimization job.
* @public */ export interface ModelShardingConfig { /** *The URI of an LMI DLC in Amazon ECR. SageMaker uses this image to run the optimization.
* @public */ Image?: string | undefined; /** *Environment variables that override the default ones in the model container.
* @public */ OverrideEnvironment?: RecordContains information about the training data source for speculative decoding.
* @public */ export interface ModelSpeculativeDecodingTrainingDataSource { /** *The Amazon S3 URI that points to the training data for speculative decoding.
* @public */ S3Uri: string | undefined; /** *The type of data stored in the Amazon S3 location. Valid values are S3Prefix or ManifestFile.
Settings for the model speculative decoding technique that's applied by a model optimization job.
* @public */ export interface ModelSpeculativeDecodingConfig { /** *The speculative decoding technique to apply during model optimization.
* @public */ Technique: ModelSpeculativeDecodingTechnique | undefined; /** *The location of the training data to use for speculative decoding. The data must be formatted as ShareGPT, OpenAI Completions or OpenAI Chat Completions. The input can also be unencrypted captured data from a SageMaker endpoint as long as the endpoint uses one of the above formats.
* @public */ TrainingDataSource?: ModelSpeculativeDecodingTrainingDataSource | undefined; } /** *Settings for an optimization technique that you apply with a model optimization job.
* @public */ export type OptimizationConfig = OptimizationConfig.ModelCompilationConfigMember | OptimizationConfig.ModelQuantizationConfigMember | OptimizationConfig.ModelShardingConfigMember | OptimizationConfig.ModelSpeculativeDecodingConfigMember | OptimizationConfig.$UnknownMember; /** * @public */ export declare namespace OptimizationConfig { /** *Settings for the model quantization technique that's applied by a model optimization job.
* @public */ interface ModelQuantizationConfigMember { ModelQuantizationConfig: ModelQuantizationConfig; ModelCompilationConfig?: never; ModelShardingConfig?: never; ModelSpeculativeDecodingConfig?: never; $unknown?: never; } /** *Settings for the model compilation technique that's applied by a model optimization job.
* @public */ interface ModelCompilationConfigMember { ModelQuantizationConfig?: never; ModelCompilationConfig: ModelCompilationConfig; ModelShardingConfig?: never; ModelSpeculativeDecodingConfig?: never; $unknown?: never; } /** *Settings for the model sharding technique that's applied by a model optimization job.
* @public */ interface ModelShardingConfigMember { ModelQuantizationConfig?: never; ModelCompilationConfig?: never; ModelShardingConfig: ModelShardingConfig; ModelSpeculativeDecodingConfig?: never; $unknown?: never; } /** *Settings for the model speculative decoding technique that's applied by a model optimization job.
* @public */ interface ModelSpeculativeDecodingConfigMember { ModelQuantizationConfig?: never; ModelCompilationConfig?: never; ModelShardingConfig?: never; ModelSpeculativeDecodingConfig: ModelSpeculativeDecodingConfig; $unknown?: never; } /** * @public */ interface $UnknownMember { ModelQuantizationConfig?: never; ModelCompilationConfig?: never; ModelShardingConfig?: never; ModelSpeculativeDecodingConfig?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorDetails for where to store the optimized model that you create with the optimization job.
* @public */ export interface OptimizationJobOutputConfig { /** *The Amazon Resource Name (ARN) of a key in Amazon Web Services KMS. SageMaker uses they key to encrypt the artifacts of the optimized model when SageMaker uploads the model to Amazon S3.
* @public */ KmsKeyId?: string | undefined; /** *The Amazon S3 URI for where to store the optimized model that you create with an optimization job.
* @public */ S3OutputLocation: string | undefined; /** *The name of a SageMaker model to use as the output destination for an optimization job.
* @public */ SageMakerModel?: OptimizationSageMakerModel | undefined; } /** *A VPC in Amazon VPC that's accessible to an optimized that you create with an optimization job. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC.
* @public */ export interface OptimizationVpcConfig { /** *The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
The ID of the subnets in the VPC to which you want to connect your optimized model.
* @public */ Subnets: string[] | undefined; } /** * @public */ export interface CreateOptimizationJobRequest { /** *A custom name for the new optimization job.
* @public */ OptimizationJobName: string | undefined; /** *The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.
During model optimization, Amazon SageMaker AI needs your permission to:
Read input data from an S3 bucket
Write model artifacts to an S3 bucket
Write logs to Amazon CloudWatch Logs
Publish metrics to Amazon CloudWatch
You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker AI, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker AI Roles.
The location of the source model to optimize with an optimization job.
* @public */ ModelSource: OptimizationJobModelSource | undefined; /** *The type of instance that hosts the optimized model that you create with the optimization job.
* @public */ DeploymentInstanceType: OptimizationJobDeploymentInstanceType | undefined; /** *The maximum number of instances to use for the optimization job.
* @public */ MaxInstanceCount?: number | undefined; /** *The environment variables to set in the model container.
* @public */ OptimizationEnvironment?: RecordSettings for each of the optimization techniques that the job applies.
* @public */ OptimizationConfigs: OptimizationConfig[] | undefined; /** *Details for where to store the optimized model that you create with the optimization job.
* @public */ OutputConfig: OptimizationJobOutputConfig | undefined; /** *Specifies a limit to how long a job can run. When the job reaches the time limit, SageMaker ends the job. Use this API to cap costs.
To stop a training job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.
The training algorithms provided by SageMaker automatically save the intermediate results of a model training job when possible. This attempt to save artifacts is only a best effort case as model might not be in a state from which it can be saved. For example, if training has just started, the model might not be ready to save. When saved, this intermediate data is a valid model artifact. You can use it to create a model with CreateModel.
The Neural Topic Model (NTM) currently does not support saving intermediate model artifacts. When training NTMs, make sure that the maximum runtime is sufficient for the training job to complete.
A list of key-value pairs associated with the optimization job. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
* @public */ Tags?: Tag[] | undefined; /** *A VPC in Amazon VPC that your optimized model has access to.
* @public */ VpcConfig?: OptimizationVpcConfig | undefined; } /** * @public */ export interface CreateOptimizationJobResponse { /** *The Amazon Resource Name (ARN) of the optimization job.
* @public */ OptimizationJobArn: string | undefined; } /** *Defines the mapping between an in-app role and the Amazon Web Services IAM Identity Center group patterns that should be assigned to that role within the SageMaker Partner AI App.
* @public */ export interface RoleGroupAssignment { /** *The name of the in-app role within the SageMaker Partner AI App. The specific roles available depend on the app type and version.
* @public */ RoleName: string | undefined; /** *A list of Amazon Web Services IAM Identity Center group patterns that should be assigned to the specified role. Group patterns support wildcard matching using *.
Configuration settings for the SageMaker Partner AI App.
* @public */ export interface PartnerAppConfig { /** *The list of users that are given admin access to the SageMaker Partner AI App.
* @public */ AdminUsers?: string[] | undefined; /** *This is a map of required inputs for a SageMaker Partner AI App. Based on the application type, the map is populated with a key and value pair that is specific to the user and application.
* @public */ Arguments?: RecordA list of Amazon Web Services IAM Identity Center group patterns that can access the SageMaker Partner AI App. Group names support wildcard matching using *. An empty list indicates the app will not use Identity Center group features. All groups specified in RoleGroupAssignments must match patterns in this list.
A map of in-app roles to Amazon Web Services IAM Identity Center group patterns. Groups assigned to specific roles receive those permissions, while groups in AssignedGroupPatterns but not in this map receive default in-app role depending on app type. Group patterns support wildcard matching using *. Currently supported by Fiddler version 1.3 and later with roles: ORG_MEMBER (default) and ORG_ADMIN.
Maintenance configuration settings for the SageMaker Partner AI App.
* @public */ export interface PartnerAppMaintenanceConfig { /** *The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. This value must take the following format: 3-letter-day:24-h-hour:minute. For example: TUE:03:30.
The name to give the SageMaker Partner AI App.
* @public */ Name: string | undefined; /** *The type of SageMaker Partner AI App to create. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler.
The ARN of the IAM role that the partner application uses.
* @public */ ExecutionRoleArn: string | undefined; /** *SageMaker Partner AI Apps uses Amazon Web Services KMS to encrypt data at rest using an Amazon Web Services managed key by default. For more control, specify a customer managed key.
* @public */ KmsKeyId?: string | undefined; /** *Maintenance configuration settings for the SageMaker Partner AI App.
* @public */ MaintenanceConfig?: PartnerAppMaintenanceConfig | undefined; /** *Indicates the instance type and size of the cluster attached to the SageMaker Partner AI App.
* @public */ Tier: string | undefined; /** *Configuration settings for the SageMaker Partner AI App.
* @public */ ApplicationConfig?: PartnerAppConfig | undefined; /** *The authorization type that users use to access the SageMaker Partner AI App.
* @public */ AuthType: PartnerAppAuthType | undefined; /** *When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.
When set to TRUE, the SageMaker Partner AI App is automatically upgraded to the latest minor version during the next scheduled maintenance window, if one is available. Default is FALSE.
A unique token that guarantees that the call to this API is idempotent.
* @public */ ClientToken?: string | undefined; /** *Each tag consists of a key and an optional value. Tag keys must be unique per resource.
* @public */ Tags?: Tag[] | undefined; } /** * @public */ export interface CreatePartnerAppResponse { /** *The ARN of the SageMaker Partner AI App.
* @public */ Arn?: string | undefined; } /** * @public */ export interface CreatePartnerAppPresignedUrlRequest { /** *The ARN of the SageMaker Partner AI App to create the presigned URL for.
* @public */ Arn: string | undefined; /** *The time that will pass before the presigned URL expires.
* @public */ ExpiresInSeconds?: number | undefined; /** *Indicates how long the Amazon SageMaker Partner AI App session can be accessed for after logging in.
* @public */ SessionExpirationDurationInSeconds?: number | undefined; } /** * @public */ export interface CreatePartnerAppPresignedUrlResponse { /** *The presigned URL that you can use to access the SageMaker Partner AI App.
* @public */ Url?: string | undefined; } /** *Configuration that controls the parallelism of the pipeline. By default, the parallelism configuration specified applies to all executions of the pipeline unless overridden.
* @public */ export interface ParallelismConfiguration { /** *The max number of steps that can be executed in parallel.
* @public */ MaxParallelExecutionSteps: number | undefined; } /** *The location of the pipeline definition stored in Amazon S3.
* @public */ export interface PipelineDefinitionS3Location { /** *Name of the S3 bucket.
* @public */ Bucket: string | undefined; /** *The object key (or key name) uniquely identifies the object in an S3 bucket.
* @public */ ObjectKey: string | undefined; /** *Version Id of the pipeline definition file. If not specified, Amazon SageMaker will retrieve the latest version.
* @public */ VersionId?: string | undefined; } /** * @public */ export interface CreatePipelineRequest { /** *The name of the pipeline.
* @public */ PipelineName: string | undefined; /** *The display name of the pipeline.
* @public */ PipelineDisplayName?: string | undefined; /** *The JSON pipeline definition of the pipeline.
* @public */ PipelineDefinition?: string | undefined; /** *The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.
* @public */ PipelineDefinitionS3Location?: PipelineDefinitionS3Location | undefined; /** *A description of the pipeline.
* @public */ PipelineDescription?: string | undefined; /** *A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.
* @public */ ClientRequestToken?: string | undefined; /** *The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources.
* @public */ RoleArn: string | undefined; /** *A list of tags to apply to the created pipeline.
* @public */ Tags?: Tag[] | undefined; /** *This is the configuration that controls the parallelism of the pipeline. If specified, it applies to all runs of this pipeline by default.
* @public */ ParallelismConfiguration?: ParallelismConfiguration | undefined; } /** * @public */ export interface CreatePipelineResponse { /** *The Amazon Resource Name (ARN) of the created pipeline.
* @public */ PipelineArn?: string | undefined; } /** * @public */ export interface CreatePresignedDomainUrlRequest { /** *The domain ID.
* @public */ DomainId: string | undefined; /** *The name of the UserProfile to sign-in as.
* @public */ UserProfileName: string | undefined; /** *The session expiration duration in seconds. This value defaults to 43200.
* @public */ SessionExpirationDurationInSeconds?: number | undefined; /** *The number of seconds until the pre-signed URL expires. This value defaults to 300.
* @public */ ExpiresInSeconds?: number | undefined; /** *The name of the space.
* @public */ SpaceName?: string | undefined; /** *The landing page that the user is directed to when accessing the presigned URL. Using this value, users can access Studio or Studio Classic, even if it is not the default experience for the domain. The supported values are:
studio::relative/path: Directs users to the relative path in Studio.
app:JupyterServer:relative/path: Directs users to the relative path in the Studio Classic application.
app:JupyterLab:relative/path: Directs users to the relative path in the JupyterLab application.
app:RStudioServerPro:relative/path: Directs users to the relative path in the RStudio application.
app:CodeEditor:relative/path: Directs users to the relative path in the Code Editor, based on Code-OSS, Visual Studio Code - Open Source application.
app:Canvas:relative/path: Directs users to the relative path in the Canvas application.
The presigned URL.
* @public */ AuthorizedUrl?: string | undefined; } /** * @public */ export interface CreatePresignedMlflowTrackingServerUrlRequest { /** *The name of the tracking server to connect to your MLflow UI.
* @public */ TrackingServerName: string | undefined; /** *The duration in seconds that your presigned URL is valid. The presigned URL can be used only once.
* @public */ ExpiresInSeconds?: number | undefined; /** *The duration in seconds that your MLflow UI session is valid.
* @public */ SessionExpirationDurationInSeconds?: number | undefined; } /** * @public */ export interface CreatePresignedMlflowTrackingServerUrlResponse { /** *A presigned URL with an authorization token.
* @public */ AuthorizedUrl?: string | undefined; } /** * @public */ export interface CreatePresignedNotebookInstanceUrlInput { /** *The name of the notebook instance.
* @public */ NotebookInstanceName: string | undefined; /** *The duration of the session, in seconds. The default is 12 hours.
* @public */ SessionExpirationDurationInSeconds?: number | undefined; } /** * @public */ export interface CreatePresignedNotebookInstanceUrlOutput { /** *A JSON object that contains the URL string.
* @public */ AuthorizedUrl?: string | undefined; } /** *Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:
* @public */ export interface ExperimentConfig { /** *The name of an existing experiment to associate with the trial component.
* @public */ ExperimentName?: string | undefined; /** *The name of an existing trial to associate the trial component with. If not specified, a new trial is created.
* @public */ TrialName?: string | undefined; /** *The display name for the trial component. If this key isn't specified, the display name is the trial component name.
* @public */ TrialComponentDisplayName?: string | undefined; /** *The name of the experiment run to associate with the trial component.
* @public */ RunName?: string | undefined; } /** *Configuration for Redshift Dataset Definition input.
* @public */ export interface RedshiftDatasetDefinition { /** *The Redshift cluster Identifier.
* @public */ ClusterId: string | undefined; /** *The name of the Redshift database used in Redshift query execution.
* @public */ Database: string | undefined; /** *The database user name used in Redshift query execution.
* @public */ DbUser: string | undefined; /** *The SQL query statements to be executed.
* @public */ QueryString: string | undefined; /** *The IAM role attached to your Redshift cluster that Amazon SageMaker uses to generate datasets.
* @public */ ClusterRoleArn: string | undefined; /** *The location in Amazon S3 where the Redshift query results are stored.
* @public */ OutputS3Uri: string | undefined; /** *The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data from a Redshift execution.
* @public */ KmsKeyId?: string | undefined; /** *The data storage format for Redshift query results.
* @public */ OutputFormat: RedshiftResultFormat | undefined; /** *The compression used for Redshift query results.
* @public */ OutputCompression?: RedshiftResultCompressionType | undefined; } /** *Configuration for Dataset Definition inputs. The Dataset Definition input must specify exactly one of either AthenaDatasetDefinition or RedshiftDatasetDefinition types.
Configuration for Athena Dataset Definition input.
* @public */ AthenaDatasetDefinition?: AthenaDatasetDefinition | undefined; /** *Configuration for Redshift Dataset Definition input.
* @public */ RedshiftDatasetDefinition?: RedshiftDatasetDefinition | undefined; /** *The local path where you want Amazon SageMaker to download the Dataset Definition inputs to run a processing job. LocalPath is an absolute path to the input data. This is a required parameter when AppManaged is False (default).
Whether the generated dataset is FullyReplicated or ShardedByS3Key (default).
Whether to use File or Pipe input mode. In File (default) mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.
Configuration for downloading input data from Amazon S3 into the processing container.
* @public */ export interface ProcessingS3Input { /** *The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.
* @public */ S3Uri: string | undefined; /** *The local path in your container where you want Amazon SageMaker to write input data to. LocalPath is an absolute path to the input data and must begin with /opt/ml/processing/. LocalPath is a required parameter when AppManaged is False (default).
Whether you use an S3Prefix or a ManifestFile for the data type. If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing job. If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for the processing job.
Whether to use File or Pipe input mode. In File mode, Amazon SageMaker copies the data from the input source onto the local ML storage volume before starting your processing container. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your processing container into named pipes without using the ML storage volume.
Whether to distribute the data from Amazon S3 to all processing instances with FullyReplicated, or whether the data from Amazon S3 is sharded by Amazon S3 key, downloading one shard of data to each processing instance.
Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container. Gzip can only be used when Pipe mode is specified as the S3InputMode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your container without using the EBS volume.
The inputs for a processing job. The processing input must specify exactly one of either S3Input or DatasetDefinition types.
The name for the processing job input.
* @public */ InputName: string | undefined; /** *When True, input operations such as data download are managed natively by the processing job application. When False (default), input operations are managed by Amazon SageMaker.
Configuration for downloading input data from Amazon S3 into the processing container.
* @public */ S3Input?: ProcessingS3Input | undefined; /** *Configuration for a Dataset Definition input.
* @public */ DatasetDefinition?: DatasetDefinition | undefined; } /** *Configuration for processing job outputs in Amazon SageMaker Feature Store.
* @public */ export interface ProcessingFeatureStoreOutput { /** *The name of the Amazon SageMaker FeatureGroup to use as the destination for processing job output. Note that your processing script is responsible for putting records into your Feature Store.
* @public */ FeatureGroupName: string | undefined; } /** *Configuration for uploading output data to Amazon S3 from the processing container.
* @public */ export interface ProcessingS3Output { /** *A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of a processing job.
* @public */ S3Uri: string | undefined; /** *The local path of a directory where you want Amazon SageMaker to upload its contents to Amazon S3. LocalPath is an absolute path to a directory containing output files. This directory will be created by the platform and exist when your container's entrypoint is invoked.
Whether to upload the results of the processing job continuously or after the job completes.
* @public */ S3UploadMode: ProcessingS3UploadMode | undefined; } /** *Describes the results of a processing job. The processing output must specify exactly one of either S3Output or FeatureStoreOutput types.
The name for the processing job output.
* @public */ OutputName: string | undefined; /** *Configuration for processing job outputs in Amazon S3.
* @public */ S3Output?: ProcessingS3Output | undefined; /** *Configuration for processing job outputs in Amazon SageMaker Feature Store. This processing output type is only supported when AppManaged is specified.
When True, output operations such as data upload are managed natively by the processing job application. When False (default), output operations are managed by Amazon SageMaker.
Configuration for uploading output from the processing container.
* @public */ export interface ProcessingOutputConfig { /** *An array of outputs configuring the data to upload from the processing container.
* @public */ Outputs: ProcessingOutput[] | undefined; /** *The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the processing job output. KmsKeyId can be an ID of a KMS key, ARN of a KMS key, or alias of a KMS key. The KmsKeyId is applied to all outputs.
Configuration for the cluster used to run a processing job.
* @public */ export interface ProcessingClusterConfig { /** *The number of ML compute instances to use in the processing job. For distributed processing jobs, specify a value greater than 1. The default value is 1.
* @public */ InstanceCount: number | undefined; /** *The ML compute instance type for the processing job.
* @public */ InstanceType: ProcessingInstanceType | undefined; /** *The size of the ML storage volume in gigabytes that you want to provision. You must specify sufficient ML storage for your scenario.
Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for processing, Amazon SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can't request a VolumeSizeInGB greater than the total size of the local instance storage.
For a list of instance types that support local instance storage, including the total size per instance type, see Instance Store Volumes.
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the processing job.
Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage.
For a list of instance types that support local instance storage, see Instance Store Volumes.
For more information about local instance storage encryption, see SSD Instance Store Volumes.
Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.
* @public */ export interface ProcessingResources { /** *The configuration for the resources in a cluster used to run the processing job.
* @public */ ClusterConfig: ProcessingClusterConfig | undefined; } /** *Configures conditions under which the processing job should be stopped, such as how long the processing job has been running. After the condition is met, the processing job is stopped.
* @public */ export interface ProcessingStoppingCondition { /** *Specifies the maximum runtime in seconds.
* @public */ MaxRuntimeInSeconds: number | undefined; } /** * @public */ export interface CreateProcessingJobRequest { /** *An array of inputs configuring the data to download into the processing container.
* @public */ ProcessingInputs?: ProcessingInput[] | undefined; /** *Output configuration for the processing job.
* @public */ ProcessingOutputConfig?: ProcessingOutputConfig | undefined; /** *The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
* @public */ ProcessingJobName: string | undefined; /** *Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.
* @public */ ProcessingResources: ProcessingResources | undefined; /** *The time limit for how long the processing job is allowed to run.
* @public */ StoppingCondition?: ProcessingStoppingCondition | undefined; /** *Configures the processing job to run a specified Docker container image.
* @public */ AppSpecification: AppSpecification | undefined; /** *The environment variables to set in the Docker container. Up to 100 key and values entries in the map are supported.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any environment fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request environment variable or plain text fields.
Networking options for a processing job, such as whether to allow inbound and outbound network calls to and from processing containers, and the VPC subnets and security groups to use for VPC-enabled processing jobs.
* @public */ NetworkConfig?: NetworkConfig | undefined; /** *The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
* @public */ RoleArn: string | undefined; /** *(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any tags. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request tag variable or plain text fields.
Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:
* @public */ ExperimentConfig?: ExperimentConfig | undefined; } /** * @public */ export interface CreateProcessingJobResponse { /** *The Amazon Resource Name (ARN) of the processing job.
* @public */ ProcessingJobArn: string | undefined; } /** *A key value pair used when you provision a project as a service catalog product. For information, see What is Amazon Web Services Service Catalog.
* @public */ export interface ProvisioningParameter { /** *The key that identifies a provisioning parameter.
* @public */ Key?: string | undefined; /** *The value of the provisioning parameter.
* @public */ Value?: string | undefined; } /** *Details that you specify to provision a service catalog product. For information about service catalog, see What is Amazon Web Services Service Catalog.
* @public */ export interface ServiceCatalogProvisioningDetails { /** *The ID of the product to provision.
* @public */ ProductId: string | undefined; /** *The ID of the provisioning artifact.
* @public */ ProvisioningArtifactId?: string | undefined; /** *The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path.
* @public */ PathId?: string | undefined; /** *A list of key value pairs that you specify when you provision a product.
* @public */ ProvisioningParameters?: ProvisioningParameter[] | undefined; } /** *Contains configuration details for a template provider. Only one type of template provider can be specified.
* @public */ export interface CreateTemplateProvider { /** *The CloudFormation template provider configuration for creating infrastructure resources.
* @public */ CfnTemplateProvider?: CfnCreateTemplateProvider | undefined; } /** * @public */ export interface CreateProjectInput { /** *The name of the project.
* @public */ ProjectName: string | undefined; /** *A description for the project.
* @public */ ProjectDescription?: string | undefined; /** *The product ID and provisioning artifact ID to provision a service catalog. The provisioning artifact ID will default to the latest provisioning artifact ID of the product, if you don't provide the provisioning artifact ID. For more information, see What is Amazon Web Services Service Catalog.
* @public */ ServiceCatalogProvisioningDetails?: ServiceCatalogProvisioningDetails | undefined; /** *An array of key-value pairs that you want to use to organize and track your Amazon Web Services resource costs. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
* @public */ Tags?: Tag[] | undefined; /** *An array of template provider configurations for creating infrastructure resources for the project.
* @public */ TemplateProviders?: CreateTemplateProvider[] | undefined; } /** * @public */ export interface CreateProjectOutput { /** *The Amazon Resource Name (ARN) of the project.
* @public */ ProjectArn: string | undefined; /** *The ID of the new project.
* @public */ ProjectId: string | undefined; } /** *The collection of ownership settings for a space.
* @public */ export interface OwnershipSettings { /** *The user profile who is the owner of the space.
* @public */ OwnerUserProfileName: string | undefined; } /** *Settings related to idle shutdown of Studio applications in a space.
* @public */ export interface SpaceIdleSettings { /** *The time that SageMaker waits after the application becomes idle before shutting it down.
* @public */ IdleTimeoutInMinutes?: number | undefined; } /** *Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio applications in a space.
* @public */ export interface SpaceAppLifecycleManagement { /** *Settings related to idle shutdown of Studio applications.
* @public */ IdleSettings?: SpaceIdleSettings | undefined; } /** *The application settings for a Code Editor space.
* @public */ export interface SpaceCodeEditorAppSettings { /** *Specifies the ARN's of a SageMaker AI image and SageMaker AI image version, and the instance type that the version runs on.
When both SageMakerImageVersionArn and SageMakerImageArn are passed, SageMakerImageVersionArn is used. Any updates to SageMakerImageArn will not take effect if SageMakerImageVersionArn already exists in the ResourceSpec because SageMakerImageVersionArn always takes precedence. To clear the value set for SageMakerImageVersionArn, pass None as the value.
Settings that are used to configure and manage the lifecycle of CodeEditor applications in a space.
* @public */ AppLifecycleManagement?: SpaceAppLifecycleManagement | undefined; } /** *A file system, created by you in Amazon EFS, that you assign to a user profile or space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI Studio.
* @public */ export interface EFSFileSystem { /** *The ID of your Amazon EFS file system.
* @public */ FileSystemId: string | undefined; } /** *A custom file system in Amazon FSx for Lustre.
* @public */ export interface FSxLustreFileSystem { /** *Amazon FSx for Lustre file system ID.
* @public */ FileSystemId: string | undefined; } /** *A custom file system in Amazon S3. This is only supported in Amazon SageMaker Unified Studio.
* @public */ export interface S3FileSystem { /** *The Amazon S3 URI that specifies the location in S3 where files are stored, which is mounted within the Studio environment. For example: s3://<bucket-name>/<prefix>/.
A file system, created by you, that you assign to a user profile or space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI Studio.
* @public */ export type CustomFileSystem = CustomFileSystem.EFSFileSystemMember | CustomFileSystem.FSxLustreFileSystemMember | CustomFileSystem.S3FileSystemMember | CustomFileSystem.$UnknownMember; /** * @public */ export declare namespace CustomFileSystem { /** *A custom file system in Amazon EFS.
* @public */ interface EFSFileSystemMember { EFSFileSystem: EFSFileSystem; FSxLustreFileSystem?: never; S3FileSystem?: never; $unknown?: never; } /** *A custom file system in Amazon FSx for Lustre.
* @public */ interface FSxLustreFileSystemMember { EFSFileSystem?: never; FSxLustreFileSystem: FSxLustreFileSystem; S3FileSystem?: never; $unknown?: never; } /** *A custom file system in Amazon S3. This is only supported in Amazon SageMaker Unified Studio.
* @public */ interface S3FileSystemMember { EFSFileSystem?: never; FSxLustreFileSystem?: never; S3FileSystem: S3FileSystem; $unknown?: never; } /** * @public */ interface $UnknownMember { EFSFileSystem?: never; FSxLustreFileSystem?: never; S3FileSystem?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorThe settings for the JupyterLab application within a space.
* @public */ export interface SpaceJupyterLabAppSettings { /** *Specifies the ARN's of a SageMaker AI image and SageMaker AI image version, and the instance type that the version runs on.
When both SageMakerImageVersionArn and SageMakerImageArn are passed, SageMakerImageVersionArn is used. Any updates to SageMakerImageArn will not take effect if SageMakerImageVersionArn already exists in the ResourceSpec because SageMakerImageVersionArn always takes precedence. To clear the value set for SageMakerImageVersionArn, pass None as the value.
A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.
* @public */ CodeRepositories?: CodeRepository[] | undefined; /** *Settings that are used to configure and manage the lifecycle of JupyterLab applications in a space.
* @public */ AppLifecycleManagement?: SpaceAppLifecycleManagement | undefined; } /** *A collection of EBS storage settings that apply to both private and shared spaces.
* @public */ export interface EbsStorageSettings { /** *The size of an EBS storage volume for a space.
* @public */ EbsVolumeSizeInGb: number | undefined; } /** *The storage settings for a space.
* @public */ export interface SpaceStorageSettings { /** *A collection of EBS storage settings for a space.
* @public */ EbsStorageSettings?: EbsStorageSettings | undefined; } /** *A collection of space settings.
* @public */ export interface SpaceSettings { /** *The JupyterServer app settings.
* @public */ JupyterServerAppSettings?: JupyterServerAppSettings | undefined; /** *The KernelGateway app settings.
* @public */ KernelGatewayAppSettings?: KernelGatewayAppSettings | undefined; /** *The Code Editor application settings.
* @public */ CodeEditorAppSettings?: SpaceCodeEditorAppSettings | undefined; /** *The settings for the JupyterLab application.
* @public */ JupyterLabAppSettings?: SpaceJupyterLabAppSettings | undefined; /** *The type of app created within the space.
If using the UpdateSpace API, you can't change the app type of your space by specifying a different value for this field.
* @public */ AppType?: AppType | undefined; /** *The storage settings for a space.
* @public */ SpaceStorageSettings?: SpaceStorageSettings | undefined; /** *If you enable this option, SageMaker AI creates the following resources on your behalf when you create the space:
The user profile that possesses the space.
The app that the space contains.
A file system, created by you, that you assign to a space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI Studio.
* @public */ CustomFileSystems?: CustomFileSystem[] | undefined; /** *A setting that enables or disables remote access for a SageMaker space. When enabled, this allows you to connect to the remote space from your local IDE.
* @public */ RemoteAccess?: FeatureStatus | undefined; } /** *A collection of space sharing settings.
* @public */ export interface SpaceSharingSettings { /** *Specifies the sharing type of the space.
* @public */ SharingType: SharingType | undefined; } /** * @public */ export interface CreateSpaceRequest { /** *The ID of the associated domain.
* @public */ DomainId: string | undefined; /** *The name of the space.
* @public */ SpaceName: string | undefined; /** *Tags to associated with the space. Each tag consists of a key and an optional value. Tag keys must be unique for each resource. Tags are searchable using the Search API.
A collection of space settings.
* @public */ SpaceSettings?: SpaceSettings | undefined; /** *A collection of ownership settings.
* @public */ OwnershipSettings?: OwnershipSettings | undefined; /** *A collection of space sharing settings.
* @public */ SpaceSharingSettings?: SpaceSharingSettings | undefined; /** *The name of the space that appears in the SageMaker Studio UI.
* @public */ SpaceDisplayName?: string | undefined; } /** * @public */ export interface CreateSpaceResponse { /** *The space's Amazon Resource Name (ARN).
* @public */ SpaceArn?: string | undefined; } /** * @public */ export interface CreateStudioLifecycleConfigRequest { /** *The name of the Amazon SageMaker AI Studio Lifecycle Configuration to create.
* @public */ StudioLifecycleConfigName: string | undefined; /** *The content of your Amazon SageMaker AI Studio Lifecycle Configuration script. This content must be base64 encoded.
* @public */ StudioLifecycleConfigContent: string | undefined; /** *The App type that the Lifecycle Configuration is attached to.
* @public */ StudioLifecycleConfigAppType: StudioLifecycleConfigAppType | undefined; /** *Tags to be associated with the Lifecycle Configuration. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.
* @public */ Tags?: Tag[] | undefined; } /** * @public */ export interface CreateStudioLifecycleConfigResponse { /** *The ARN of your created Lifecycle Configuration.
* @public */ StudioLifecycleConfigArn?: string | undefined; } /** *Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and storage paths. To learn more about how to configure the DebugHookConfig parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
Path to local storage location for metrics and tensors. Defaults to /opt/ml/output/tensors/.
Path to Amazon S3 storage location for metrics and tensors.
* @public */ S3OutputPath: string | undefined; /** *Configuration information for the Amazon SageMaker Debugger hook parameters.
* @public */ HookParameters?: RecordConfiguration information for Amazon SageMaker Debugger tensor collections. To learn more about how to configure the CollectionConfiguration parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
Configuration information for SageMaker Debugger rules for debugging. To learn more about how to configure the DebugRuleConfiguration parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
The name of the rule configuration. It must be unique relative to other rule configuration names.
* @public */ RuleConfigurationName: string | undefined; /** *Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.
Path to Amazon S3 storage location for rules.
* @public */ S3OutputPath?: string | undefined; /** *The Amazon Elastic Container (ECR) Image for the managed rule evaluation.
* @public */ RuleEvaluatorImage: string | undefined; /** *The instance type to deploy a custom rule for debugging a training job.
* @public */ InstanceType?: ProcessingInstanceType | undefined; /** *The size, in GB, of the ML storage volume attached to the processing instance.
* @public */ VolumeSizeInGB?: number | undefined; /** *Runtime configuration for rule container.
* @public */ RuleParameters?: RecordConfiguration information for the infrastructure health check of a training job. A SageMaker-provided health check tests the health of instance hardware and cluster network connectivity.
* @public */ export interface InfraCheckConfig { /** *Enables an infrastructure health check.
* @public */ EnableInfraCheck?: boolean | undefined; } /** *Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and storage paths.
* @public */ export interface ProfilerConfig { /** *Path to Amazon S3 storage location for system and framework metrics.
* @public */ S3OutputPath?: string | undefined; /** *A time interval for capturing system metrics in milliseconds. Available values are 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.
* @public */ ProfilingIntervalInMilliseconds?: number | undefined; /** *Configuration information for capturing framework metrics. Available key strings for different profiling options are DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig. The following codes are configuration structures for the ProfilingParameters parameter. To learn more about how to configure the ProfilingParameters parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
Configuration to turn off Amazon SageMaker Debugger's system monitoring and profiling functionality. To turn it off, set to True.
Configuration information for profiling rules.
* @public */ export interface ProfilerRuleConfiguration { /** *The name of the rule configuration. It must be unique relative to other rule configuration names.
* @public */ RuleConfigurationName: string | undefined; /** *Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.
Path to Amazon S3 storage location for rules.
* @public */ S3OutputPath?: string | undefined; /** *The Amazon Elastic Container Registry Image for the managed rule evaluation.
* @public */ RuleEvaluatorImage: string | undefined; /** *The instance type to deploy a custom rule for profiling a training job.
* @public */ InstanceType?: ProcessingInstanceType | undefined; /** *The size, in GB, of the ML storage volume attached to the processing instance.
* @public */ VolumeSizeInGB?: number | undefined; /** *Runtime configuration for rule container.
* @public */ RuleParameters?: RecordConfiguration for remote debugging for the CreateTrainingJob API. To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.
* @public */ export interface RemoteDebugConfig { /** *If set to True, enables remote debugging.
* @public */ EnableRemoteDebug?: boolean | undefined; } /** *Contains information about attribute-based access control (ABAC) for a training job. The session chaining configuration uses Amazon Security Token Service (STS) for your training job to request temporary, limited-privilege credentials to tenants. For more information, see Attribute-based access control (ABAC) for multi-tenancy training.
* @public */ export interface SessionChainingConfig { /** *Set to True to allow SageMaker to extract session tags from a training job creation role and reuse these tags when assuming the training job execution role.
Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data.
* @public */ export interface TensorBoardOutputConfig { /** *Path to local storage location for tensorBoard output. Defaults to /opt/ml/output/tensorboard.
Path to Amazon S3 storage location for TensorBoard output.
* @public */ S3OutputPath: string | undefined; } /** * @public */ export interface CreateTrainingJobRequest { /** *The name of the training job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.
* @public */ TrainingJobName: string | undefined; /** *Algorithm-specific parameters that influence the quality of the model. You set hyperparameters before you start the learning process. For a list of hyperparameters for each training algorithm provided by SageMaker, see Algorithms.
You can specify a maximum of 100 hyperparameters. Each hyperparameter is a key-value pair. Each key and value is limited to 256 characters, as specified by the Length Constraint.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by any security-sensitive information included in the request hyperparameter variable or plain text fields.
The registry path of the Docker image that contains the training algorithm and algorithm-specific metadata, including the input mode. For more information about algorithms provided by SageMaker, see Algorithms. For information about providing your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.
* @public */ AlgorithmSpecification?: AlgorithmSpecification | undefined; /** *The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to perform tasks on your behalf.
During model training, SageMaker needs your permission to read input data from an S3 bucket, download a Docker image that contains training code, write model artifacts to an S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant permissions for all of these tasks to an IAM role. For more information, see SageMaker Roles.
To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.
An array of Channel objects. Each channel is a named input source. InputDataConfig describes the input data and its location.
Algorithms can accept input data from one or more channels. For example, an algorithm might have two channels of input data, training_data and validation_data. The configuration for each channel provides the S3, EFS, or FSx location where the input data is stored. It also provides information about the stored data: the MIME type, compression method, and whether the data is wrapped in RecordIO format.
Depending on the input mode that the algorithm supports, SageMaker either copies input data files from an S3 bucket to a local directory in the Docker container, or makes it available as input streams. For example, if you specify an EFS location, input data files are available as input streams. They do not need to be downloaded.
Your input must be in the same Amazon Web Services region as your training job.
* @public */ InputDataConfig?: Channel[] | undefined; /** *Specifies the path to the S3 location where you want to store model artifacts. SageMaker creates subfolders for the artifacts.
* @public */ OutputDataConfig: OutputDataConfig | undefined; /** *The resources, including the ML compute instances and ML storage volumes, to use for model training.
ML storage volumes store model artifacts and incremental states. Training algorithms might also use ML storage volumes for scratch space. If you want SageMaker to use the ML storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.
A VpcConfig object that specifies the VPC that you want your training job to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.
* @public */ VpcConfig?: VpcConfig | undefined; /** *Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.
To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.
An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any tags. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by any security-sensitive information included in the request tag variable or plain text fields.
Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If you enable network isolation for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.
* @public */ EnableNetworkIsolation?: boolean | undefined; /** *To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training. For more information, see Protect Communications Between ML Compute Instances in a Distributed Training Job.
To train models using managed spot training, choose True. Managed spot training provides a fully managed and scalable infrastructure for training machine learning models. this option is useful when training jobs can be interrupted and when there is flexibility when the training job is run.
The complete and intermediate results of jobs are stored in an Amazon S3 bucket, and can be used as a starting point to train models incrementally. Amazon SageMaker provides metrics and logs in CloudWatch. They can be used to see when managed spot training jobs are running, interrupted, resumed, or completed.
* @public */ EnableManagedSpotTraining?: boolean | undefined; /** *Contains information about the output location for managed spot training checkpoint data.
* @public */ CheckpointConfig?: CheckpointConfig | undefined; /** *Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and storage paths. To learn more about how to configure the DebugHookConfig parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.
* @public */ DebugRuleConfigurations?: DebugRuleConfiguration[] | undefined; /** *Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data.
* @public */ TensorBoardOutputConfig?: TensorBoardOutputConfig | undefined; /** *Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:
* @public */ ExperimentConfig?: ExperimentConfig | undefined; /** *Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and storage paths.
* @public */ ProfilerConfig?: ProfilerConfig | undefined; /** *Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.
* @public */ ProfilerRuleConfigurations?: ProfilerRuleConfiguration[] | undefined; /** *The environment variables to set in the Docker container.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any environment fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request environment variable or plain text fields.
The number of times to retry the job when the job fails due to an InternalServerError.
Configuration for remote debugging. To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.
* @public */ RemoteDebugConfig?: RemoteDebugConfig | undefined; /** *Contains information about the infrastructure health check configuration for the training job.
* @public */ InfraCheckConfig?: InfraCheckConfig | undefined; /** *Contains information about attribute-based access control (ABAC) for the training job.
* @public */ SessionChainingConfig?: SessionChainingConfig | undefined; }