Package-level declarations

Types

Link copied to clipboard

The configuration for the kernels in a SageMaker image running as a CodeEditor app.

Link copied to clipboard
data class AppImageConfigContainerConfig(val containerArguments: List<String>? = null, val containerEntrypoint: List<String>? = null, val containerEnvironmentVariables: List<AppImageConfigCustomImageContainerEnvironmentVariable>? = null)

The container configuration for a SageMaker image.

Link copied to clipboard
data class AppImageConfigFileSystemConfig(val defaultGid: Int? = null, val defaultUid: Int? = null, val mountPath: String? = null)

The Amazon Elastic File System (EFS) storage configuration for a SageMaker image.

Link copied to clipboard

The configuration for the kernels in a SageMaker image running as a JupyterLab app.

Link copied to clipboard
data class AppImageConfigKernelGatewayImageConfig(val fileSystemConfig: AppImageConfigFileSystemConfig? = null, val kernelSpecs: List<AppImageConfigKernelSpec>)

The configuration for the file system and kernels in a SageMaker image running as a KernelGateway app.

Link copied to clipboard
data class AppImageConfigKernelSpec(val displayName: String? = null, val name: String)
Link copied to clipboard
data class AppResourceSpec(val instanceType: AppResourceSpecInstanceType? = null, val lifecycleConfigArn: String? = null, val sageMakerImageArn: String? = null, val sageMakerImageVersionArn: String? = null)
Link copied to clipboard
data class ClusterInstanceGroup(val currentCount: Int? = null, val executionRole: String, val instanceCount: Int, val instanceGroupName: String, val instanceStorageConfigs: List<ClusterInstanceStorageConfig>? = null, val instanceType: String, val lifeCycleConfig: ClusterLifeCycleConfig, val onStartDeepHealthChecks: List<ClusterDeepHealthCheckType>? = null, val threadsPerCore: Int? = null)

Details of an instance group in a SageMaker HyperPod cluster.

Link copied to clipboard

Defines the configuration for attaching additional storage to the instances in the SageMaker HyperPod cluster instance group.

Link copied to clipboard
data class ClusterLifeCycleConfig(val onCreate: String, val sourceS3Uri: String)

The lifecycle configuration for a SageMaker HyperPod cluster.

Link copied to clipboard

Specifies parameter(s) specific to the orchestrator, e.g. specify the EKS cluster.

Link copied to clipboard
data class ClusterOrchestratorEksConfig(val clusterArn: String)

Specifies parameter(s) related to EKS as orchestrator, e.g. the EKS cluster nodes will attach to,

Link copied to clipboard
data class ClusterVpcConfig(val securityGroupIds: List<String>, val subnets: List<String>)

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.

data class DataQualityJobDefinitionBatchTransformInput(val dataCapturedDestinationS3Uri: String, val datasetFormat: DataQualityJobDefinitionDatasetFormat, val excludeFeaturesAttribute: String? = null, val localPath: String, val s3DataDistributionType: DataQualityJobDefinitionBatchTransformInputS3DataDistributionType? = null, val s3InputMode: DataQualityJobDefinitionBatchTransformInputS3InputMode? = null)

The batch transform input for a monitoring job.

Link copied to clipboard
data class DataQualityJobDefinitionClusterConfig(val instanceCount: Int, val instanceType: String, val volumeKmsKeyId: String? = null, val volumeSizeInGb: Int)

Configuration for the cluster used to run model monitoring jobs.

The baseline constraints resource for a monitoring job.

Link copied to clipboard
data class DataQualityJobDefinitionCsv(val header: Boolean? = null)

The CSV format

data class DataQualityJobDefinitionDataQualityAppSpecification(val containerArguments: List<String>? = null, val containerEntrypoint: List<String>? = null, val environment: Any? = null, val imageUri: String, val postAnalyticsProcessorSourceUri: String? = null, val recordPreprocessorSourceUri: String? = null)

Container image configuration object for the monitoring job.

data class DataQualityJobDefinitionDataQualityBaselineConfig(val baseliningJobName: String? = null, val constraintsResource: DataQualityJobDefinitionConstraintsResource? = null, val statisticsResource: DataQualityJobDefinitionStatisticsResource? = null)

Baseline configuration used to validate that the data conforms to the specified constraints and statistics.

The inputs for a monitoring job.

Link copied to clipboard
data class DataQualityJobDefinitionDatasetFormat(val csv: DataQualityJobDefinitionCsv? = null, val json: DataQualityJobDefinitionJson? = null, val parquet: Boolean? = null)

The dataset format of the data to monitor

Link copied to clipboard
data class DataQualityJobDefinitionEndpointInput(val endpointName: String, val excludeFeaturesAttribute: String? = null, val localPath: String, val s3DataDistributionType: DataQualityJobDefinitionEndpointInputS3DataDistributionType? = null, val s3InputMode: DataQualityJobDefinitionEndpointInputS3InputMode? = null)

The endpoint for a monitoring job.

Link copied to clipboard
data class DataQualityJobDefinitionJson(val line: Boolean? = null)

The Json format

Link copied to clipboard

The output object for a monitoring job.

The output configuration for monitoring jobs.

Identifies the resources to deploy for a monitoring job.

Link copied to clipboard
data class DataQualityJobDefinitionNetworkConfig(val enableInterContainerTrafficEncryption: Boolean? = null, val enableNetworkIsolation: Boolean? = null, val vpcConfig: DataQualityJobDefinitionVpcConfig? = null)

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.

Link copied to clipboard
data class DataQualityJobDefinitionS3Output(val localPath: String, val s3UploadMode: DataQualityJobDefinitionS3OutputS3UploadMode? = null, val s3Uri: String)

Information about where and how to store the results of a monitoring job.

data class DataQualityJobDefinitionStatisticsResource(val s3Uri: String? = null)

The baseline statistics resource for a monitoring job.

data class DataQualityJobDefinitionStoppingCondition(val maxRuntimeInSeconds: Int)

Specifies a time limit for how long the monitoring job is allowed to run.

Link copied to clipboard
data class DataQualityJobDefinitionVpcConfig(val securityGroupIds: List<String>, val subnets: List<String>)

Specifies a VPC that your training jobs and hosted models have access to. Control access to and from your training and model containers by configuring the VPC.

Link copied to clipboard
data class Device(val description: String? = null, val deviceName: String, val iotThingName: String? = null)

Edge device you want to create

Link copied to clipboard
data class DeviceFleetEdgeOutputConfig(val kmsKeyId: String? = null, val s3OutputLocation: String)
Link copied to clipboard
data class DomainAppLifecycleManagement(val idleSettings: DomainIdleSettings? = null)
Link copied to clipboard
data class DomainCodeEditorAppSettings(val appLifecycleManagement: DomainAppLifecycleManagement? = null, val customImages: List<DomainCustomImage>? = null, val defaultResourceSpec: DomainResourceSpec? = null, val lifecycleConfigArns: List<String>? = null)

The CodeEditor app settings.

Link copied to clipboard
data class DomainCodeRepository(val repositoryUrl: String)
Link copied to clipboard
data class DomainCustomFileSystemConfig(val efsFileSystemConfig: DomainEfsFileSystemConfig? = null)
Link copied to clipboard
data class DomainCustomImage(val appImageConfigName: String, val imageName: String, val imageVersionNumber: Int? = null)

A custom SageMaker image.

Link copied to clipboard
data class DomainCustomPosixUserConfig(val gid: Int, val uid: Int)
Link copied to clipboard
data class DomainDefaultEbsStorageSettings(val defaultEbsVolumeSizeInGb: Int, val maximumEbsVolumeSizeInGb: Int)

Properties related to the Amazon Elastic Block Store volume. Must be provided if storage type is Amazon EBS and must not be provided if storage type is not Amazon EBS

Link copied to clipboard
data class DomainDefaultSpaceSettings(val customFileSystemConfigs: List<DomainCustomFileSystemConfig>? = null, val customPosixUserConfig: DomainCustomPosixUserConfig? = null, val executionRole: String, val jupyterLabAppSettings: DomainJupyterLabAppSettings? = null, val jupyterServerAppSettings: DomainJupyterServerAppSettings? = null, val kernelGatewayAppSettings: DomainKernelGatewayAppSettings? = null, val securityGroups: List<String>? = null, val spaceStorageSettings: DomainDefaultSpaceStorageSettings? = null)

A collection of settings that apply to spaces of Amazon SageMaker Studio. These settings are specified when the Create/Update Domain API is called.

Link copied to clipboard
data class DomainDefaultSpaceStorageSettings(val defaultEbsStorageSettings: DomainDefaultEbsStorageSettings? = null)

Default storage settings for a space.

Link copied to clipboard
data class DomainDockerSettings(val enableDockerAccess: DomainDockerSettingsEnableDockerAccess? = null, val vpcOnlyTrustedAccounts: List<String>? = null)

A collection of settings that are required to start docker-proxy server.

Link copied to clipboard
data class DomainEfsFileSystemConfig(val fileSystemId: String, val fileSystemPath: String? = null)
Link copied to clipboard
data class DomainIdleSettings(val idleTimeoutInMinutes: Int? = null, val lifecycleManagement: DomainLifecycleManagement? = null, val maxIdleTimeoutInMinutes: Int? = null, val minIdleTimeoutInMinutes: Int? = null)
Link copied to clipboard
data class DomainJupyterLabAppSettings(val appLifecycleManagement: DomainAppLifecycleManagement? = null, val codeRepositories: List<DomainCodeRepository>? = null, val customImages: List<DomainCustomImage>? = null, val defaultResourceSpec: DomainResourceSpec? = null, val lifecycleConfigArns: List<String>? = null)

The JupyterLab app settings.

Link copied to clipboard
data class DomainJupyterServerAppSettings(val defaultResourceSpec: DomainResourceSpec? = null, val lifecycleConfigArns: List<String>? = null)

The JupyterServer app settings.

Link copied to clipboard
data class DomainKernelGatewayAppSettings(val customImages: List<DomainCustomImage>? = null, val defaultResourceSpec: DomainResourceSpec? = null, val lifecycleConfigArns: List<String>? = null)

The kernel gateway app settings.

Link copied to clipboard
data class DomainResourceSpec(val instanceType: DomainResourceSpecInstanceType? = null, val lifecycleConfigArn: String? = null, val sageMakerImageArn: String? = null, val sageMakerImageVersionArn: String? = null)
Link copied to clipboard
data class DomainRSessionAppSettings(val customImages: List<DomainCustomImage>? = null, val defaultResourceSpec: DomainResourceSpec? = null)

A collection of settings that apply to an RSessionGateway app.

Link copied to clipboard

A collection of settings that configure user interaction with the RStudioServerPro app.

Link copied to clipboard
data class DomainRStudioServerProDomainSettings(val defaultResourceSpec: DomainResourceSpec? = null, val domainExecutionRoleArn: String, val rStudioConnectUrl: String? = null, val rStudioPackageManagerUrl: String? = null)

A collection of settings that update the current configuration for the RStudioServerPro Domain-level app.

Link copied to clipboard
data class DomainSettings(val dockerSettings: DomainDockerSettings? = null, val rStudioServerProDomainSettings: DomainRStudioServerProDomainSettings? = null, val securityGroupIds: List<String>? = null)

A collection of Domain settings.

Link copied to clipboard
data class DomainSharingSettings(val notebookOutputOption: DomainSharingSettingsNotebookOutputOption? = null, val s3KmsKeyId: String? = null, val s3OutputPath: String? = null)

Specifies options when sharing an Amazon SageMaker Studio notebook. 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.

Link copied to clipboard
data class DomainStudioWebPortalSettings(val hiddenAppTypes: List<DomainAppType>? = null, val hiddenMlTools: List<DomainMlTools>? = null)

Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.

Link copied to clipboard
data class DomainUserSettings(val codeEditorAppSettings: DomainCodeEditorAppSettings? = null, val customFileSystemConfigs: List<DomainCustomFileSystemConfig>? = null, val customPosixUserConfig: DomainCustomPosixUserConfig? = null, val defaultLandingUri: String? = null, val executionRole: String, val jupyterLabAppSettings: DomainJupyterLabAppSettings? = null, val jupyterServerAppSettings: DomainJupyterServerAppSettings? = null, val kernelGatewayAppSettings: DomainKernelGatewayAppSettings? = null, val rSessionAppSettings: DomainRSessionAppSettings? = null, val rStudioServerProAppSettings: DomainRStudioServerProAppSettings? = null, val securityGroups: List<String>? = null, val sharingSettings: DomainSharingSettings? = null, val spaceStorageSettings: DomainDefaultSpaceStorageSettings? = null, val studioWebPortal: DomainUserSettingsStudioWebPortal? = null, val studioWebPortalSettings: DomainStudioWebPortalSettings? = null)

A collection of settings that apply to users of Amazon SageMaker Studio. These settings are specified when the CreateUserProfile API is called, and as DefaultUserSettings when the CreateDomain API is called.

Link copied to clipboard
data class FeatureGroupDataCatalogConfig(val catalog: String, val database: String, val tableName: String)
Link copied to clipboard
Link copied to clipboard
data class FeatureGroupOnlineStoreSecurityConfig(val kmsKeyId: String? = null)
Link copied to clipboard
data class FeatureGroupS3StorageConfig(val kmsKeyId: String? = null, val s3Uri: String)
Link copied to clipboard
data class FeatureGroupThroughputConfig(val provisionedReadCapacityUnits: Int? = null, val provisionedWriteCapacityUnits: Int? = null, val throughputMode: FeatureGroupThroughputMode)
Link copied to clipboard
data class FeatureGroupTtlDuration(val unit: FeatureGroupUnit? = null, val value: Int? = null)

TTL configuration of the feature group

Link copied to clipboard
data class GetAppImageConfigResult(val appImageConfigArn: String? = null, val codeEditorAppImageConfig: AppImageConfigCodeEditorAppImageConfig? = null, val jupyterLabAppImageConfig: AppImageConfigJupyterLabAppImageConfig? = null, val kernelGatewayImageConfig: AppImageConfigKernelGatewayImageConfig? = null)
Link copied to clipboard
data class GetAppResult(val appArn: String? = null)
Link copied to clipboard
data class GetClusterResult(val clusterArn: String? = null, val clusterStatus: ClusterStatus? = null, val creationTime: String? = null, val failureMessage: String? = null, val instanceGroups: List<ClusterInstanceGroup>? = null, val nodeRecovery: ClusterNodeRecovery? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetDataQualityJobDefinitionResult(val creationTime: String? = null, val jobDefinitionArn: String? = null)
Link copied to clipboard
data class GetDeviceFleetResult(val description: String? = null, val outputConfig: DeviceFleetEdgeOutputConfig? = null, val roleArn: String? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetDomainResult(val appNetworkAccessType: DomainAppNetworkAccessType? = null, val appSecurityGroupManagement: DomainAppSecurityGroupManagement? = null, val defaultSpaceSettings: DomainDefaultSpaceSettings? = null, val defaultUserSettings: DomainUserSettings? = null, val domainArn: String? = null, val domainId: String? = null, val domainSettings: DomainSettings? = null, val homeEfsFileSystemId: String? = null, val securityGroupIdForDomainBoundary: String? = null, val singleSignOnApplicationArn: String? = null, val singleSignOnManagedApplicationInstanceId: String? = null, val subnetIds: List<String>? = null, val url: String? = null)
Link copied to clipboard
data class GetFeatureGroupResult(val creationTime: String? = null, val featureDefinitions: List<FeatureGroupFeatureDefinition>? = null, val featureGroupStatus: String? = null, val onlineStoreConfig: OnlineStoreConfigProperties? = null, val throughputConfig: FeatureGroupThroughputConfig? = null)
Link copied to clipboard
data class GetImageResult(val imageArn: String? = null, val imageDescription: String? = null, val imageDisplayName: String? = null, val imageRoleArn: String? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetImageVersionResult(val containerImage: String? = null, val horovod: Boolean? = null, val imageArn: String? = null, val imageVersionArn: String? = null, val jobType: ImageVersionJobType? = null, val mlFramework: String? = null, val processor: ImageVersionProcessor? = null, val programmingLang: String? = null, val releaseNotes: String? = null, val vendorGuidance: ImageVersionVendorGuidance? = null, val version: Int? = null)

/*

Link copied to clipboard
data class GetInferenceComponentResult(val creationTime: String? = null, val endpointArn: String? = null, val endpointName: String? = null, val failureReason: String? = null, val inferenceComponentArn: String? = null, val inferenceComponentName: String? = null, val inferenceComponentStatus: InferenceComponentStatus? = null, val lastModifiedTime: String? = null, val runtimeConfig: InferenceComponentRuntimeConfig? = null, val specification: InferenceComponentSpecification? = null, val tags: List<Tag>? = null, val variantName: String? = null)
Link copied to clipboard
data class GetInferenceExperimentResult(val arn: String? = null, val creationTime: String? = null, val dataStorageConfig: InferenceExperimentDataStorageConfig? = null, val description: String? = null, val desiredState: InferenceExperimentDesiredState? = null, val endpointMetadata: InferenceExperimentEndpointMetadata? = null, val lastModifiedTime: String? = null, val modelVariants: List<InferenceExperimentModelVariantConfig>? = null, val schedule: InferenceExperimentSchedule? = null, val shadowModeConfig: InferenceExperimentShadowModeConfig? = null, val status: InferenceExperimentStatus? = null, val statusReason: String? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetMlflowTrackingServerResult(val artifactStoreUri: String? = null, val automaticModelRegistration: Boolean? = null, val mlflowVersion: String? = null, val roleArn: String? = null, val tags: List<Tag>? = null, val trackingServerArn: String? = null, val trackingServerSize: MlflowTrackingServerTrackingServerSize? = null, val weeklyMaintenanceWindowStart: String? = null)
Link copied to clipboard
data class GetModelBiasJobDefinitionResult(val creationTime: String? = null, val jobDefinitionArn: String? = null)
Link copied to clipboard
data class GetModelCardResult(val content: ModelCardContent? = null, val createdBy: ModelCardUserContext? = null, val creationTime: String? = null, val lastModifiedBy: ModelCardUserContext? = null, val lastModifiedTime: String? = null, val modelCardArn: String? = null, val modelCardProcessingStatus: ModelCardProcessingStatus? = null, val modelCardStatus: ModelCardStatus? = null, val modelCardVersion: Int? = null, val tags: List<Tag>? = null)
data class GetModelExplainabilityJobDefinitionResult(val creationTime: String? = null, val jobDefinitionArn: String? = null)
Link copied to clipboard
data class GetModelPackageGroupResult(val creationTime: String? = null, val modelPackageGroupArn: String? = null, val modelPackageGroupPolicy: Any? = null, val modelPackageGroupStatus: ModelPackageGroupStatus? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetModelPackageResult(val additionalInferenceSpecifications: List<ModelPackageAdditionalInferenceSpecificationDefinition>? = null, val approvalDescription: String? = null, val certifyForMarketplace: Boolean? = null, val creationTime: String? = null, val customerMetadataProperties: ModelPackageCustomerMetadataProperties? = null, val lastModifiedTime: String? = null, val modelApprovalStatus: ModelPackageModelApprovalStatus? = null, val modelCard: ModelPackageModelCard? = null, val modelPackageArn: String? = null, val modelPackageName: String? = null, val modelPackageStatus: ModelPackageStatus? = null, val modelPackageStatusDetails: ModelPackageStatusDetails? = null, val modelPackageVersion: Int? = null, val skipModelValidation: ModelPackageSkipModelValidation? = null, val sourceUri: String? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetModelQualityJobDefinitionResult(val creationTime: String? = null, val jobDefinitionArn: String? = null)
Link copied to clipboard
data class GetMonitoringScheduleResult(val creationTime: String? = null, val endpointName: String? = null, val failureReason: String? = null, val lastModifiedTime: String? = null, val lastMonitoringExecutionSummary: MonitoringScheduleMonitoringExecutionSummary? = null, val monitoringScheduleArn: String? = null, val monitoringScheduleConfig: MonitoringScheduleConfig? = null, val monitoringScheduleStatus: MonitoringScheduleStatus? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetPipelineResult(val parallelismConfiguration: ParallelismConfigurationProperties? = null, val pipelineDefinition: Either<PipelineDefinition0Properties, PipelineDefinition1Properties>? = null, val pipelineDescription: String? = null, val pipelineDisplayName: String? = null, val roleArn: String? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetProjectResult(val creationTime: String? = null, val projectArn: String? = null, val projectId: String? = null, val projectStatus: ProjectStatus? = null, val serviceCatalogProvisionedProductDetails: ServiceCatalogProvisionedProductDetailsProperties? = null)
Link copied to clipboard
data class GetSpaceResult(val spaceArn: String? = null, val spaceDisplayName: String? = null, val url: String? = null)
Link copied to clipboard
data class GetStudioLifecycleConfigResult(val studioLifecycleConfigArn: String? = null)
Link copied to clipboard
data class GetUserProfileResult(val userProfileArn: String? = null, val userSettings: UserProfileUserSettings? = null)
data class InferenceComponentComputeResourceRequirements(val maxMemoryRequiredInMb: Int? = null, val minMemoryRequiredInMb: Int? = null, val numberOfAcceleratorDevicesRequired: Double? = null, val numberOfCpuCoresRequired: Double? = null)
Link copied to clipboard
data class InferenceComponentContainerSpecification(val artifactUrl: String? = null, val deployedImage: InferenceComponentDeployedImage? = null, val environment: Map<String, String>? = null, val image: String? = null)
Link copied to clipboard
data class InferenceComponentDeployedImage(val resolutionTime: String? = null, val resolvedImage: String? = null, val specifiedImage: String? = null)
Link copied to clipboard
data class InferenceComponentRuntimeConfig(val copyCount: Int? = null, val currentCopyCount: Int? = null, val desiredCopyCount: Int? = null)

The runtime config for the inference component

Link copied to clipboard
data class InferenceComponentSpecification(val computeResourceRequirements: InferenceComponentComputeResourceRequirements, val container: InferenceComponentContainerSpecification? = null, val modelName: String? = null, val startupParameters: InferenceComponentStartupParameters? = null)

The specification for the inference component

Link copied to clipboard
data class InferenceComponentStartupParameters(val containerStartupHealthCheckTimeoutInSeconds: Int? = null, val modelDataDownloadTimeoutInSeconds: Int? = null)
data class InferenceExperimentCaptureContentTypeHeader(val csvContentTypes: List<String>? = null, val jsonContentTypes: List<String>? = null)

Configuration specifying how to treat different headers. If no headers are specified SageMaker will by default base64 encode when capturing the data.

Link copied to clipboard
data class InferenceExperimentDataStorageConfig(val contentType: InferenceExperimentCaptureContentTypeHeader? = null, val destination: String, val kmsKey: String? = null)

The Amazon S3 location and configuration for storing inference request and response data.

Link copied to clipboard
data class InferenceExperimentEndpointMetadata(val endpointConfigName: String? = null, val endpointName: String, val endpointStatus: InferenceExperimentEndpointMetadataEndpointStatus? = null)

The metadata of the endpoint on which the inference experiment ran.

The configuration for the infrastructure that the model will be deployed to.

Link copied to clipboard
data class InferenceExperimentModelVariantConfig(val infrastructureConfig: InferenceExperimentModelInfrastructureConfig, val modelName: String, val variantName: String)

Contains information about the deployment options of a model.

data class InferenceExperimentRealTimeInferenceConfig(val instanceCount: Int, val instanceType: String)

The infrastructure configuration for deploying the model to a real-time inference endpoint.

Link copied to clipboard
data class InferenceExperimentSchedule(val endTime: String? = null, val startTime: String? = null)

The duration for which you want the inference experiment to run.

Link copied to clipboard
data class InferenceExperimentShadowModeConfig(val shadowModelVariants: List<InferenceExperimentShadowModelVariantConfig>, val sourceModelVariantName: String)

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.

data class InferenceExperimentShadowModelVariantConfig(val samplingPercentage: Int, val shadowModelVariantName: String)

The name and sampling percentage of a shadow variant.

data class ModelBiasJobDefinitionBatchTransformInput(val dataCapturedDestinationS3Uri: String, val datasetFormat: ModelBiasJobDefinitionDatasetFormat, val endTimeOffset: String? = null, val featuresAttribute: String? = null, val inferenceAttribute: String? = null, val localPath: String, val probabilityAttribute: String? = null, val probabilityThresholdAttribute: Double? = null, val s3DataDistributionType: ModelBiasJobDefinitionBatchTransformInputS3DataDistributionType? = null, val s3InputMode: ModelBiasJobDefinitionBatchTransformInputS3InputMode? = null, val startTimeOffset: String? = null)

The batch transform input for a monitoring job.

Link copied to clipboard
data class ModelBiasJobDefinitionClusterConfig(val instanceCount: Int, val instanceType: String, val volumeKmsKeyId: String? = null, val volumeSizeInGb: Int)

Configuration for the cluster used to run model monitoring jobs.

data class ModelBiasJobDefinitionConstraintsResource(val s3Uri: String? = null)

The baseline constraints resource for a monitoring job.

Link copied to clipboard
data class ModelBiasJobDefinitionCsv(val header: Boolean? = null)

The CSV format

Link copied to clipboard
data class ModelBiasJobDefinitionDatasetFormat(val csv: ModelBiasJobDefinitionCsv? = null, val json: ModelBiasJobDefinitionJson? = null, val parquet: Boolean? = null)

The dataset format of the data to monitor

Link copied to clipboard
data class ModelBiasJobDefinitionEndpointInput(val endTimeOffset: String? = null, val endpointName: String, val featuresAttribute: String? = null, val inferenceAttribute: String? = null, val localPath: String, val probabilityAttribute: String? = null, val probabilityThresholdAttribute: Double? = null, val s3DataDistributionType: ModelBiasJobDefinitionEndpointInputS3DataDistributionType? = null, val s3InputMode: ModelBiasJobDefinitionEndpointInputS3InputMode? = null, val startTimeOffset: String? = null)

The endpoint for a monitoring job.

Link copied to clipboard
data class ModelBiasJobDefinitionJson(val line: Boolean? = null)

The Json format

data class ModelBiasJobDefinitionModelBiasAppSpecification(val configUri: String, val environment: Any? = null, val imageUri: String)

Container image configuration object for the monitoring job.

data class ModelBiasJobDefinitionModelBiasBaselineConfig(val baseliningJobName: String? = null, val constraintsResource: ModelBiasJobDefinitionConstraintsResource? = null)

Baseline configuration used to validate that the data conforms to the specified constraints and statistics.

Link copied to clipboard

The inputs for a monitoring job.

Ground truth input provided in S3

Link copied to clipboard

The output object for a monitoring job.

data class ModelBiasJobDefinitionMonitoringOutputConfig(val kmsKeyId: String? = null, val monitoringOutputs: List<ModelBiasJobDefinitionMonitoringOutput>)

The output configuration for monitoring jobs.

Identifies the resources to deploy for a monitoring job.

Link copied to clipboard
data class ModelBiasJobDefinitionNetworkConfig(val enableInterContainerTrafficEncryption: Boolean? = null, val enableNetworkIsolation: Boolean? = null, val vpcConfig: ModelBiasJobDefinitionVpcConfig? = null)

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.

Link copied to clipboard
data class ModelBiasJobDefinitionS3Output(val localPath: String, val s3UploadMode: ModelBiasJobDefinitionS3OutputS3UploadMode? = null, val s3Uri: String)

Information about where and how to store the results of a monitoring job.

Link copied to clipboard
data class ModelBiasJobDefinitionStoppingCondition(val maxRuntimeInSeconds: Int)

Specifies a time limit for how long the monitoring job is allowed to run.

Link copied to clipboard
data class ModelBiasJobDefinitionVpcConfig(val securityGroupIds: List<String>, val subnets: List<String>)

Specifies a VPC that your training jobs and hosted models have access to. Control access to and from your training and model containers by configuring the VPC.

Link copied to clipboard
data class ModelCardAdditionalInformation(val caveatsAndRecommendations: String? = null, val customDetails: Map<String, String>? = null, val ethicalConsiderations: String? = null)
Link copied to clipboard
data class ModelCardBarChartMetric(val name: String, val notes: String? = null, val type: ModelCardBarChartMetricType, val value: List<Double>, val xAxisName: List<String>? = null, val yAxisName: String? = null)
Link copied to clipboard
data class ModelCardBusinessDetails(val businessProblem: String? = null, val businessStakeholders: String? = null, val lineOfBusiness: String? = null)

Business details.

Link copied to clipboard
data class ModelCardContainer(val image: String, val modelDataUrl: String? = null, val nearestModelName: String? = null)
Link copied to clipboard
data class ModelCardContent(val additionalInformation: ModelCardAdditionalInformation? = null, val businessDetails: ModelCardBusinessDetails? = null, val evaluationDetails: List<ModelCardEvaluationDetail>? = null, val intendedUses: ModelCardIntendedUses? = null, val modelOverview: ModelCardModelOverview? = null, val modelPackageDetails: ModelCardModelPackageDetails? = null, val trainingDetails: ModelCardTrainingDetails? = null)

The content of the model card.

Link copied to clipboard
data class ModelCardEvaluationDetail(val datasets: List<String>? = null, val evaluationJobArn: String? = null, val evaluationObservation: String? = null, val metadata: Map<String, String>? = null, val metricGroups: List<ModelCardMetricGroup>? = null, val name: String)

item of evaluation details

Link copied to clipboard
Link copied to clipboard
data class ModelCardIntendedUses(val explanationsForRiskRating: String? = null, val factorsAffectingModelEfficiency: String? = null, val intendedUses: String? = null, val purposeOfModel: String? = null, val riskRating: ModelCardRiskRating? = null)

Intended usage of model.

Link copied to clipboard
data class ModelCardLinearGraphMetric(val name: String, val notes: String? = null, val type: ModelCardLinearGraphMetricType, val value: List<List<Double>>, val xAxisName: String? = null, val yAxisName: String? = null)

Linear graph metric.

Link copied to clipboard
data class ModelCardMatrixMetric(val name: String, val notes: String? = null, val type: ModelCardMatrixMetricType, val value: List<List<Double>>, val xAxisName: List<String>? = null, val yAxisName: List<String>? = null)
Link copied to clipboard
data class ModelCardMetricGroup(val metricData: List<Any>, val name: String)

item in metric groups

Link copied to clipboard
data class ModelCardModelOverview(val algorithmType: String? = null, val inferenceEnvironment: ModelCardModelOverviewInferenceEnvironmentProperties? = null, val modelArtifact: List<String>? = null, val modelCreator: String? = null, val modelDescription: String? = null, val modelId: String? = null, val modelName: String? = null, val modelOwner: String? = null, val modelVersion: Double? = null, val problemType: String? = null)

Overview about the model.

data class ModelCardModelOverviewInferenceEnvironmentProperties(val containerImage: List<String>? = null)

Overview about the inference.

Link copied to clipboard
data class ModelCardModelPackageCreator(val userProfileName: String? = null)
Link copied to clipboard
data class ModelCardModelPackageDetails(val approvalDescription: String? = null, val createdBy: ModelCardModelPackageCreator? = null, val domain: String? = null, val inferenceSpecification: ModelCardInferenceSpecification? = null, val modelApprovalStatus: ModelCardModelPackageDetailsModelApprovalStatus? = null, val modelPackageArn: String? = null, val modelPackageDescription: String? = null, val modelPackageGroupName: String? = null, val modelPackageName: String? = null, val modelPackageStatus: ModelCardModelPackageDetailsModelPackageStatus? = null, val modelPackageVersion: Double? = null, val sourceAlgorithms: List<ModelCardSourceAlgorithm>? = null, val task: String? = null)

Metadata information related to model package version

Link copied to clipboard
data class ModelCardObjectiveFunction(val function: ModelCardObjectiveFunctionFunctionProperties? = null, val notes: String? = null)

the objective function the model will optimize for.

data class ModelCardObjectiveFunctionFunctionProperties(val condition: String? = null, val facet: String? = null, val function: ModelCardObjectiveFunctionFunctionPropertiesFunction? = null)

objective function that training job is optimized for.

Link copied to clipboard
data class ModelCardSecurityConfig(val kmsKeyId: String? = null)

An optional Key Management Service key to encrypt, decrypt, and re-encrypt model card content for regulated workloads with highly sensitive data.

Link copied to clipboard
data class ModelCardSimpleMetric(val name: String, val notes: String? = null, val type: ModelCardSimpleMetricType, val value: Any, val xAxisName: String? = null, val yAxisName: String? = null)

metric data

Link copied to clipboard
data class ModelCardSourceAlgorithm(val algorithmName: String, val modelDataUrl: String? = null)
Link copied to clipboard
data class ModelCardTrainingDetails(val objectiveFunction: ModelCardObjectiveFunction? = null, val trainingJobDetails: ModelCardTrainingDetailsTrainingJobDetailsProperties? = null, val trainingObservations: String? = null)

Overview about the training.

data class ModelCardTrainingDetailsTrainingJobDetailsProperties(val hyperParameters: List<ModelCardTrainingHyperParameter>? = null, val trainingArn: String? = null, val trainingDatasets: List<String>? = null, val trainingEnvironment: ModelCardTrainingDetailsTrainingJobDetailsPropertiesTrainingEnvironmentProperties? = null, val trainingMetrics: List<ModelCardTrainingMetric>? = null, val userProvidedHyperParameters: List<ModelCardTrainingHyperParameter>? = null, val userProvidedTrainingMetrics: List<ModelCardTrainingMetric>? = null)

Details about any associated training jobs.

Link copied to clipboard
data class ModelCardTrainingHyperParameter(val name: String, val value: String)

training hyper parameter

Link copied to clipboard
data class ModelCardTrainingMetric(val name: String, val notes: String? = null, val value: Double)

training metric data.

Link copied to clipboard
data class ModelCardUserContext(val domainId: String? = null, val userProfileArn: String? = null, val userProfileName: String? = null)

Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.

data class ModelExplainabilityJobDefinitionBatchTransformInput(val dataCapturedDestinationS3Uri: String, val datasetFormat: ModelExplainabilityJobDefinitionDatasetFormat, val featuresAttribute: String? = null, val inferenceAttribute: String? = null, val localPath: String, val probabilityAttribute: String? = null, val s3DataDistributionType: ModelExplainabilityJobDefinitionBatchTransformInputS3DataDistributionType? = null, val s3InputMode: ModelExplainabilityJobDefinitionBatchTransformInputS3InputMode? = null)

The batch transform input for a monitoring job.

data class ModelExplainabilityJobDefinitionClusterConfig(val instanceCount: Int, val instanceType: String, val volumeKmsKeyId: String? = null, val volumeSizeInGb: Int)

Configuration for the cluster used to run model monitoring jobs.

The baseline constraints resource for a monitoring job.

Link copied to clipboard
data class ModelExplainabilityJobDefinitionCsv(val header: Boolean? = null)

The CSV format

The dataset format of the data to monitor

data class ModelExplainabilityJobDefinitionEndpointInput(val endpointName: String, val featuresAttribute: String? = null, val inferenceAttribute: String? = null, val localPath: String, val probabilityAttribute: String? = null, val s3DataDistributionType: ModelExplainabilityJobDefinitionEndpointInputS3DataDistributionType? = null, val s3InputMode: ModelExplainabilityJobDefinitionEndpointInputS3InputMode? = null)

The endpoint for a monitoring job.

Link copied to clipboard
data class ModelExplainabilityJobDefinitionJson(val line: Boolean? = null)

The Json format

data class ModelExplainabilityJobDefinitionModelExplainabilityAppSpecification(val configUri: String, val environment: Any? = null, val imageUri: String)

Container image configuration object for the monitoring job.

Baseline configuration used to validate that the data conforms to the specified constraints and statistics.

The output object for a monitoring job.

The output configuration for monitoring jobs.

Identifies the resources to deploy for a monitoring job.

data class ModelExplainabilityJobDefinitionNetworkConfig(val enableInterContainerTrafficEncryption: Boolean? = null, val enableNetworkIsolation: Boolean? = null, val vpcConfig: ModelExplainabilityJobDefinitionVpcConfig? = null)

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.

Link copied to clipboard

Information about where and how to store the results of a monitoring job.

data class ModelExplainabilityJobDefinitionStoppingCondition(val maxRuntimeInSeconds: Int)

Specifies a time limit for how long the monitoring job is allowed to run.

data class ModelExplainabilityJobDefinitionVpcConfig(val securityGroupIds: List<String>, val subnets: List<String>)

Specifies a VPC that your training jobs and hosted models have access to. Control access to and from your training and model containers by configuring the VPC.

data class ModelPackageAdditionalInferenceSpecificationDefinition(val containers: List<ModelPackageContainerDefinition>, val description: String? = null, val name: String, val supportedContentTypes: List<String>? = null, val supportedRealtimeInferenceInstanceTypes: List<String>? = null, val supportedResponseMimeTypes: List<String>? = null, val supportedTransformInstanceTypes: List<String>? = null)

Additional Inference Specification specifies details about inference jobs that can be run with models based on this model package.AdditionalInferenceSpecifications can be added to existing model packages using AdditionalInferenceSpecificationsToAdd.

Link copied to clipboard
data class ModelPackageBias(val postTrainingReport: ModelPackageMetricsSource? = null, val preTrainingReport: ModelPackageMetricsSource? = null, val report: ModelPackageMetricsSource? = null)

Contains bias metrics for a model.

Link copied to clipboard
data class ModelPackageContainerDefinition(val containerHostname: String? = null, val environment: ModelPackageEnvironment? = null, val framework: String? = null, val frameworkVersion: String? = null, val image: String, val imageDigest: String? = null, val modelDataSource: ModelPackageModelDataSource? = null, val modelDataUrl: String? = null, val modelInput: ModelPackageContainerDefinitionModelInputProperties? = null, val nearestModelName: String? = null)

Describes the Docker container for the model package.

Link copied to clipboard

The metadata properties associated with the model package versions.

Link copied to clipboard
data class ModelPackageDataSource(val s3DataSource: ModelPackageS3DataSource)

Describes the input source of a transform job and the way the transform job consumes it.

Link copied to clipboard
data class ModelPackageDriftCheckBaselines(val bias: ModelPackageDriftCheckBias? = null, val explainability: ModelPackageDriftCheckExplainability? = null, val modelDataQuality: ModelPackageDriftCheckModelDataQuality? = null, val modelQuality: ModelPackageDriftCheckModelQuality? = null)

Represents the drift check baselines that can be used when the model monitor is set using the model package.

Link copied to clipboard
data class ModelPackageDriftCheckBias(val configFile: ModelPackageFileSource? = null, val postTrainingConstraints: ModelPackageMetricsSource? = null, val preTrainingConstraints: ModelPackageMetricsSource? = null)

Represents the drift check bias baselines that can be used when the model monitor is set using the model package.

Link copied to clipboard
data class ModelPackageDriftCheckExplainability(val configFile: ModelPackageFileSource? = null, val constraints: ModelPackageMetricsSource? = null)

Contains explainability metrics for a model.

Link copied to clipboard
data class ModelPackageDriftCheckModelDataQuality(val constraints: ModelPackageMetricsSource? = null, val statistics: ModelPackageMetricsSource? = null)

Represents the drift check data quality baselines that can be used when the model monitor is set using the model package.

Link copied to clipboard
data class ModelPackageDriftCheckModelQuality(val constraints: ModelPackageMetricsSource? = null, val statistics: ModelPackageMetricsSource? = null)

Represents the drift check model quality baselines that can be used when the model monitor is set using the model package.

Link copied to clipboard

Sets the environment variables in the Docker container

Link copied to clipboard

Contains explainability metrics for a model.

Link copied to clipboard
data class ModelPackageFileSource(val contentDigest: String? = null, val contentType: String? = null, val s3Uri: String)

Represents a File Source Object.

Link copied to clipboard
data class ModelPackageInferenceSpecification(val containers: List<ModelPackageContainerDefinition>, val supportedContentTypes: List<String>, val supportedRealtimeInferenceInstanceTypes: List<String>? = null, val supportedResponseMimeTypes: List<String>, val supportedTransformInstanceTypes: List<String>? = null)

Details about inference jobs that can be run with models based on this model package.

Link copied to clipboard
data class ModelPackageMetadataProperties(val commitId: String? = null, val generatedBy: String? = null, val projectId: String? = null, val repository: String? = null)

Metadata properties of the tracking entity, trial, or trial component.

Link copied to clipboard
data class ModelPackageMetricsSource(val contentDigest: String? = null, val contentType: String, val s3Uri: String)

Represents a Metric Source Object.

Link copied to clipboard
data class ModelPackageModelAccessConfig(val acceptEula: Boolean)

Specifies the access configuration file for the ML model.

Link copied to clipboard
data class ModelPackageModelCard(val modelCardContent: String, val modelCardStatus: ModelPackageModelCardModelCardStatus)

The model card associated with the model package.

Link copied to clipboard
data class ModelPackageModelDataQuality(val constraints: ModelPackageMetricsSource? = null, val statistics: ModelPackageMetricsSource? = null)

Metrics that measure the quality of the input data for a model.

Link copied to clipboard
data class ModelPackageModelDataSource(val s3DataSource: ModelPackageS3ModelDataSource? = null)

Specifies the location of ML model data to deploy during endpoint creation.

Link copied to clipboard
data class ModelPackageModelMetrics(val bias: ModelPackageBias? = null, val explainability: ModelPackageExplainability? = null, val modelDataQuality: ModelPackageModelDataQuality? = null, val modelQuality: ModelPackageModelQuality? = null)

A structure that contains model metrics reports.

Link copied to clipboard
data class ModelPackageModelQuality(val constraints: ModelPackageMetricsSource? = null, val statistics: ModelPackageMetricsSource? = null)

Metrics that measure the quality of a model.

Link copied to clipboard

Describes the S3 data source.

Link copied to clipboard
data class ModelPackageS3ModelDataSource(val compressionType: ModelPackageS3ModelDataSourceCompressionType, val modelAccessConfig: ModelPackageModelAccessConfig? = null, val s3DataType: ModelPackageS3ModelDataSourceS3DataType, val s3Uri: String)

Specifies the S3 location of ML model data to deploy.

Link copied to clipboard
data class ModelPackageSecurityConfig(val kmsKeyId: String)

An optional AWS Key Management Service key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with highly sensitive data.

Link copied to clipboard
data class ModelPackageSourceAlgorithm(val algorithmName: String, val modelDataUrl: String? = null)

Specifies an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your Amazon SageMaker account or an algorithm in AWS Marketplace that you are subscribed to.

Link copied to clipboard

Details about the algorithm that was used to create the model package.

Link copied to clipboard
data class ModelPackageStatusDetails(val validationStatuses: List<ModelPackageStatusItem>? = null)

Details about the current status of the model package.

Link copied to clipboard
data class ModelPackageStatusItem(val failureReason: String? = null, val name: String, val status: ModelPackageStatusItemStatus)

Represents the overall status of a model package.

Link copied to clipboard
data class ModelPackageTransformInput(val compressionType: ModelPackageTransformInputCompressionType? = null, val contentType: String? = null, val dataSource: ModelPackageDataSource, val splitType: ModelPackageTransformInputSplitType? = null)

Describes the input source of a transform job and the way the transform job consumes it.

Link copied to clipboard
data class ModelPackageTransformJobDefinition(val batchStrategy: ModelPackageTransformJobDefinitionBatchStrategy? = null, val environment: ModelPackageEnvironment? = null, val maxConcurrentTransforms: Int? = null, val maxPayloadInMb: Int? = null, val transformInput: ModelPackageTransformInput, val transformOutput: ModelPackageTransformOutput, val transformResources: ModelPackageTransformResources)

Defines the input needed to run a transform job using the inference specification specified in the algorithm.

Link copied to clipboard
data class ModelPackageTransformOutput(val accept: String? = null, val assembleWith: ModelPackageTransformOutputAssembleWith? = null, val kmsKeyId: String? = null, val s3OutputPath: String)

Describes the results of a transform job.

Link copied to clipboard
data class ModelPackageTransformResources(val instanceCount: Int, val instanceType: String, val volumeKmsKeyId: String? = null)

Describes the resources, including ML instance types and ML instance count, to use for transform job.

Link copied to clipboard
data class ModelPackageValidationProfile(val profileName: String, val transformJobDefinition: ModelPackageTransformJobDefinition)

Contains data, such as the inputs and targeted instance types that are used in the process of validating the model package.

Link copied to clipboard
data class ModelPackageValidationSpecification(val validationProfiles: List<ModelPackageValidationProfile>, val validationRole: String)

Specifies configurations for one or more transform jobs that Amazon SageMaker runs to test the model package.

data class ModelQualityJobDefinitionBatchTransformInput(val dataCapturedDestinationS3Uri: String, val datasetFormat: ModelQualityJobDefinitionDatasetFormat, val endTimeOffset: String? = null, val inferenceAttribute: String? = null, val localPath: String, val probabilityAttribute: String? = null, val probabilityThresholdAttribute: Double? = null, val s3DataDistributionType: ModelQualityJobDefinitionBatchTransformInputS3DataDistributionType? = null, val s3InputMode: ModelQualityJobDefinitionBatchTransformInputS3InputMode? = null, val startTimeOffset: String? = null)

The batch transform input for a monitoring job.

Link copied to clipboard
data class ModelQualityJobDefinitionClusterConfig(val instanceCount: Int, val instanceType: String, val volumeKmsKeyId: String? = null, val volumeSizeInGb: Int)

Configuration for the cluster used to run model monitoring jobs.

The baseline constraints resource for a monitoring job.

Link copied to clipboard
data class ModelQualityJobDefinitionCsv(val header: Boolean? = null)

The CSV format

Link copied to clipboard
data class ModelQualityJobDefinitionDatasetFormat(val csv: ModelQualityJobDefinitionCsv? = null, val json: ModelQualityJobDefinitionJson? = null, val parquet: Boolean? = null)

The dataset format of the data to monitor

Link copied to clipboard
data class ModelQualityJobDefinitionEndpointInput(val endTimeOffset: String? = null, val endpointName: String, val inferenceAttribute: String? = null, val localPath: String, val probabilityAttribute: String? = null, val probabilityThresholdAttribute: Double? = null, val s3DataDistributionType: ModelQualityJobDefinitionEndpointInputS3DataDistributionType? = null, val s3InputMode: ModelQualityJobDefinitionEndpointInputS3InputMode? = null, val startTimeOffset: String? = null)

The endpoint for a monitoring job.

Link copied to clipboard
data class ModelQualityJobDefinitionJson(val line: Boolean? = null)

The Json format

data class ModelQualityJobDefinitionModelQualityAppSpecification(val containerArguments: List<String>? = null, val containerEntrypoint: List<String>? = null, val environment: Any? = null, val imageUri: String, val postAnalyticsProcessorSourceUri: String? = null, val problemType: ModelQualityJobDefinitionProblemType, val recordPreprocessorSourceUri: String? = null)

Container image configuration object for the monitoring job.

data class ModelQualityJobDefinitionModelQualityBaselineConfig(val baseliningJobName: String? = null, val constraintsResource: ModelQualityJobDefinitionConstraintsResource? = null)

Baseline configuration used to validate that the data conforms to the specified constraints and statistics.

The inputs for a monitoring job.

Ground truth input provided in S3

The output object for a monitoring job.

The output configuration for monitoring jobs.

Identifies the resources to deploy for a monitoring job.

Link copied to clipboard
data class ModelQualityJobDefinitionNetworkConfig(val enableInterContainerTrafficEncryption: Boolean? = null, val enableNetworkIsolation: Boolean? = null, val vpcConfig: ModelQualityJobDefinitionVpcConfig? = null)

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.

Link copied to clipboard
data class ModelQualityJobDefinitionS3Output(val localPath: String, val s3UploadMode: ModelQualityJobDefinitionS3OutputS3UploadMode? = null, val s3Uri: String)

Information about where and how to store the results of a monitoring job.

data class ModelQualityJobDefinitionStoppingCondition(val maxRuntimeInSeconds: Int)

Specifies a time limit for how long the monitoring job is allowed to run.

Link copied to clipboard
data class ModelQualityJobDefinitionVpcConfig(val securityGroupIds: List<String>, val subnets: List<String>)

Specifies a VPC that your training jobs and hosted models have access to. Control access to and from your training and model containers by configuring the VPC.

Link copied to clipboard
data class MonitoringScheduleBaselineConfig(val constraintsResource: MonitoringScheduleConstraintsResource? = null, val statisticsResource: MonitoringScheduleStatisticsResource? = null)

Baseline configuration used to validate that the data conforms to the specified constraints and statistics.

Link copied to clipboard
data class MonitoringScheduleBatchTransformInput(val dataCapturedDestinationS3Uri: String, val datasetFormat: MonitoringScheduleDatasetFormat, val excludeFeaturesAttribute: String? = null, val localPath: String, val s3DataDistributionType: MonitoringScheduleBatchTransformInputS3DataDistributionType? = null, val s3InputMode: MonitoringScheduleBatchTransformInputS3InputMode? = null)

The batch transform input for a monitoring job.

Link copied to clipboard
data class MonitoringScheduleClusterConfig(val instanceCount: Int, val instanceType: String, val volumeKmsKeyId: String? = null, val volumeSizeInGb: Int)

Configuration for the cluster used to run model monitoring jobs.

Link copied to clipboard
data class MonitoringScheduleConfig(val monitoringJobDefinition: MonitoringScheduleMonitoringJobDefinition? = null, val monitoringJobDefinitionName: String? = null, val monitoringType: MonitoringScheduleMonitoringType? = null, val scheduleConfig: MonitoringScheduleScheduleConfig? = null)

The configuration object that specifies the monitoring schedule and defines the monitoring job.

Link copied to clipboard
data class MonitoringScheduleConstraintsResource(val s3Uri: String? = null)

The baseline constraints resource for a monitoring job.

Link copied to clipboard
data class MonitoringScheduleCsv(val header: Boolean? = null)

The CSV format

Link copied to clipboard
data class MonitoringScheduleDatasetFormat(val csv: MonitoringScheduleCsv? = null, val json: MonitoringScheduleJson? = null, val parquet: Boolean? = null)

The dataset format of the data to monitor

Link copied to clipboard
data class MonitoringScheduleEndpointInput(val endpointName: String, val excludeFeaturesAttribute: String? = null, val localPath: String, val s3DataDistributionType: MonitoringScheduleEndpointInputS3DataDistributionType? = null, val s3InputMode: MonitoringScheduleEndpointInputS3InputMode? = null)

The endpoint for a monitoring job.

Link copied to clipboard
data class MonitoringScheduleJson(val line: Boolean? = null)

The Json format

data class MonitoringScheduleMonitoringAppSpecification(val containerArguments: List<String>? = null, val containerEntrypoint: List<String>? = null, val imageUri: String, val postAnalyticsProcessorSourceUri: String? = null, val recordPreprocessorSourceUri: String? = null)

Container image configuration object for the monitoring job.

data class MonitoringScheduleMonitoringExecutionSummary(val creationTime: String, val endpointName: String? = null, val failureReason: String? = null, val lastModifiedTime: String, val monitoringExecutionStatus: MonitoringScheduleMonitoringExecutionSummaryMonitoringExecutionStatus, val monitoringScheduleName: String, val processingJobArn: String? = null, val scheduledTime: String)

Summary of information about monitoring job

Link copied to clipboard
data class MonitoringScheduleMonitoringInput(val batchTransformInput: MonitoringScheduleBatchTransformInput? = null, val endpointInput: MonitoringScheduleEndpointInput? = null)

The inputs for a monitoring job.

data class MonitoringScheduleMonitoringJobDefinition(val baselineConfig: MonitoringScheduleBaselineConfig? = null, val environment: Any? = null, val monitoringAppSpecification: MonitoringScheduleMonitoringAppSpecification, val monitoringInputs: List<MonitoringScheduleMonitoringInput>, val monitoringOutputConfig: MonitoringScheduleMonitoringOutputConfig, val monitoringResources: MonitoringScheduleMonitoringResources, val networkConfig: MonitoringScheduleNetworkConfig? = null, val roleArn: String, val stoppingCondition: MonitoringScheduleStoppingCondition? = null)

Defines the monitoring job.

Link copied to clipboard

The output object for a monitoring job.

Link copied to clipboard
data class MonitoringScheduleMonitoringOutputConfig(val kmsKeyId: String? = null, val monitoringOutputs: List<MonitoringScheduleMonitoringOutput>)

The output configuration for monitoring jobs.

Link copied to clipboard

Identifies the resources to deploy for a monitoring job.

Link copied to clipboard
data class MonitoringScheduleNetworkConfig(val enableInterContainerTrafficEncryption: Boolean? = null, val enableNetworkIsolation: Boolean? = null, val vpcConfig: MonitoringScheduleVpcConfig? = null)

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.

Link copied to clipboard
data class MonitoringScheduleS3Output(val localPath: String, val s3UploadMode: MonitoringScheduleS3OutputS3UploadMode? = null, val s3Uri: String)

Information about where and how to store the results of a monitoring job.

Link copied to clipboard
data class MonitoringScheduleScheduleConfig(val dataAnalysisEndTime: String? = null, val dataAnalysisStartTime: String? = null, val scheduleExpression: String)

Configuration details about the monitoring schedule.

Link copied to clipboard
data class MonitoringScheduleStatisticsResource(val s3Uri: String? = null)

The baseline statistics resource for a monitoring job.

Link copied to clipboard
data class MonitoringScheduleStoppingCondition(val maxRuntimeInSeconds: Int)

Specifies a time limit for how long the monitoring job is allowed to run.

Link copied to clipboard
data class MonitoringScheduleVpcConfig(val securityGroupIds: List<String>, val subnets: List<String>)

Specifies a VPC that your training jobs and hosted models have access to. Control access to and from your training and model containers by configuring the VPC.

Link copied to clipboard
data class OfflineStoreConfigProperties(val dataCatalogConfig: FeatureGroupDataCatalogConfig? = null, val disableGlueTableCreation: Boolean? = null, val s3StorageConfig: FeatureGroupS3StorageConfig, val tableFormat: FeatureGroupTableFormat? = null)

The configuration of an OfflineStore .

Link copied to clipboard
data class OnlineStoreConfigProperties(val enableOnlineStore: Boolean? = null, val securityConfig: FeatureGroupOnlineStoreSecurityConfig? = null, val storageType: FeatureGroupStorageType? = null, val ttlDuration: FeatureGroupTtlDuration? = null)

The configuration of an OnlineStore .

Link copied to clipboard
data class ParallelismConfigurationProperties(val maxParallelExecutionSteps: Int)

The parallelism configuration applied to the pipeline.

Link copied to clipboard
data class PipelineDefinition0Properties(val pipelineDefinitionBody: String)

The definition of the pipeline. This can be either a JSON string or an Amazon S3 location.

Link copied to clipboard
data class PipelineDefinition1Properties(val pipelineDefinitionS3Location: PipelineS3Location)

The definition of the pipeline. This can be either a JSON string or an Amazon S3 location.

Link copied to clipboard
data class PipelineS3Location(val bucket: String, val eTag: String? = null, val key: String, val version: String? = null)
Link copied to clipboard
data class ProjectProvisioningParameter(val key: String, val value: String)

Information about a parameter used to provision a product.

data class ServiceCatalogProvisionedProductDetailsProperties(val provisionedProductId: String? = null, val provisionedProductStatusMessage: String? = null)

Provisioned ServiceCatalog Details

data class ServiceCatalogProvisioningDetailsProperties(val pathId: String? = null, val productId: String, val provisioningArtifactId: String? = null, val provisioningParameters: List<ProjectProvisioningParameter>? = null)

Input ServiceCatalog Provisioning Details

Link copied to clipboard
data class SpaceAppLifecycleManagement(val idleSettings: SpaceIdleSettings? = null)
Link copied to clipboard
data class SpaceCodeEditorAppSettings(val appLifecycleManagement: SpaceAppLifecycleManagement? = null, val defaultResourceSpec: SpaceResourceSpec? = null)

The CodeEditor app settings.

Link copied to clipboard
data class SpaceCodeRepository(val repositoryUrl: String)
Link copied to clipboard
data class SpaceCustomFileSystem(val efsFileSystem: SpaceEfsFileSystem? = null)
Link copied to clipboard
data class SpaceCustomImage(val appImageConfigName: String, val imageName: String, val imageVersionNumber: Int? = null)

A custom SageMaker image.

Link copied to clipboard
data class SpaceEbsStorageSettings(val ebsVolumeSizeInGb: Int)

Properties related to the space's Amazon Elastic Block Store volume.

Link copied to clipboard
data class SpaceEfsFileSystem(val fileSystemId: String)
Link copied to clipboard
data class SpaceIdleSettings(val idleTimeoutInMinutes: Int? = null)
Link copied to clipboard
data class SpaceJupyterLabAppSettings(val appLifecycleManagement: SpaceAppLifecycleManagement? = null, val codeRepositories: List<SpaceCodeRepository>? = null, val defaultResourceSpec: SpaceResourceSpec? = null)

The JupyterServer app settings.

Link copied to clipboard
data class SpaceJupyterServerAppSettings(val defaultResourceSpec: SpaceResourceSpec? = null, val lifecycleConfigArns: List<String>? = null)

The JupyterServer app settings.

Link copied to clipboard
data class SpaceKernelGatewayAppSettings(val customImages: List<SpaceCustomImage>? = null, val defaultResourceSpec: SpaceResourceSpec? = null, val lifecycleConfigArns: List<String>? = null)

The kernel gateway app settings.

Link copied to clipboard
data class SpaceOwnershipSettings(val ownerUserProfileName: String)
Link copied to clipboard
data class SpaceResourceSpec(val instanceType: SpaceResourceSpecInstanceType? = null, val lifecycleConfigArn: String? = null, val sageMakerImageArn: String? = null, val sageMakerImageVersionArn: String? = null)
Link copied to clipboard
data class SpaceSettings(val appType: SpaceAppType? = null, val codeEditorAppSettings: SpaceCodeEditorAppSettings? = null, val customFileSystems: List<SpaceCustomFileSystem>? = null, val jupyterLabAppSettings: SpaceJupyterLabAppSettings? = null, val jupyterServerAppSettings: SpaceJupyterServerAppSettings? = null, val kernelGatewayAppSettings: SpaceKernelGatewayAppSettings? = null, val spaceStorageSettings: SpaceStorageSettings? = null)

A collection of settings that apply to spaces of Amazon SageMaker Studio. These settings are specified when the CreateSpace API is called.

Link copied to clipboard
Link copied to clipboard
data class SpaceStorageSettings(val ebsStorageSettings: SpaceEbsStorageSettings? = null)
Link copied to clipboard
data class UserProfileAppLifecycleManagement(val idleSettings: UserProfileIdleSettings? = null)
Link copied to clipboard
data class UserProfileCodeEditorAppSettings(val appLifecycleManagement: UserProfileAppLifecycleManagement? = null, val customImages: List<UserProfileCustomImage>? = null, val defaultResourceSpec: UserProfileResourceSpec? = null, val lifecycleConfigArns: List<String>? = null)

The CodeEditor app settings.

Link copied to clipboard
data class UserProfileCodeRepository(val repositoryUrl: String)
Link copied to clipboard
data class UserProfileCustomFileSystemConfig(val efsFileSystemConfig: UserProfileEfsFileSystemConfig? = null)
Link copied to clipboard
data class UserProfileCustomImage(val appImageConfigName: String, val imageName: String, val imageVersionNumber: Int? = null)

A custom SageMaker image.

Link copied to clipboard
data class UserProfileCustomPosixUserConfig(val gid: Int, val uid: Int)
Link copied to clipboard
data class UserProfileDefaultEbsStorageSettings(val defaultEbsVolumeSizeInGb: Int, val maximumEbsVolumeSizeInGb: Int)

Properties related to the Amazon Elastic Block Store volume.

Link copied to clipboard
data class UserProfileDefaultSpaceStorageSettings(val defaultEbsStorageSettings: UserProfileDefaultEbsStorageSettings? = null)

Default storage settings for a space.

Link copied to clipboard
data class UserProfileEfsFileSystemConfig(val fileSystemId: String, val fileSystemPath: String? = null)
Link copied to clipboard
data class UserProfileIdleSettings(val idleTimeoutInMinutes: Int? = null, val lifecycleManagement: UserProfileLifecycleManagement? = null, val maxIdleTimeoutInMinutes: Int? = null, val minIdleTimeoutInMinutes: Int? = null)
Link copied to clipboard
data class UserProfileJupyterLabAppSettings(val appLifecycleManagement: UserProfileAppLifecycleManagement? = null, val codeRepositories: List<UserProfileCodeRepository>? = null, val customImages: List<UserProfileCustomImage>? = null, val defaultResourceSpec: UserProfileResourceSpec? = null, val lifecycleConfigArns: List<String>? = null)

The JupyterLab app settings.

Link copied to clipboard
data class UserProfileJupyterServerAppSettings(val defaultResourceSpec: UserProfileResourceSpec? = null, val lifecycleConfigArns: List<String>? = null)

The JupyterServer app settings.

Link copied to clipboard
data class UserProfileKernelGatewayAppSettings(val customImages: List<UserProfileCustomImage>? = null, val defaultResourceSpec: UserProfileResourceSpec? = null, val lifecycleConfigArns: List<String>? = null)

The kernel gateway app settings.

Link copied to clipboard
data class UserProfileResourceSpec(val instanceType: UserProfileResourceSpecInstanceType? = null, val lifecycleConfigArn: String? = null, val sageMakerImageArn: String? = null, val sageMakerImageVersionArn: String? = null)
Link copied to clipboard

A collection of settings that configure user interaction with the RStudioServerPro app.

Link copied to clipboard
data class UserProfileSharingSettings(val notebookOutputOption: UserProfileSharingSettingsNotebookOutputOption? = null, val s3KmsKeyId: String? = null, val s3OutputPath: String? = null)

Specifies options when sharing an Amazon SageMaker Studio notebook. 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.

Link copied to clipboard
data class UserProfileStudioWebPortalSettings(val hiddenAppTypes: List<UserProfileAppType>? = null, val hiddenMlTools: List<UserProfileMlTools>? = null)

Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.

Link copied to clipboard
data class UserProfileUserSettings(val codeEditorAppSettings: UserProfileCodeEditorAppSettings? = null, val customFileSystemConfigs: List<UserProfileCustomFileSystemConfig>? = null, val customPosixUserConfig: UserProfileCustomPosixUserConfig? = null, val defaultLandingUri: String? = null, val executionRole: String? = null, val jupyterLabAppSettings: UserProfileJupyterLabAppSettings? = null, val jupyterServerAppSettings: UserProfileJupyterServerAppSettings? = null, val kernelGatewayAppSettings: UserProfileKernelGatewayAppSettings? = null, val rStudioServerProAppSettings: UserProfileRStudioServerProAppSettings? = null, val securityGroups: List<String>? = null, val sharingSettings: UserProfileSharingSettings? = null, val spaceStorageSettings: UserProfileDefaultSpaceStorageSettings? = null, val studioWebPortal: UserProfileUserSettingsStudioWebPortal? = null, val studioWebPortalSettings: UserProfileStudioWebPortalSettings? = null)

A collection of settings that apply to users of Amazon SageMaker Studio. These settings are specified when the CreateUserProfile API is called, and as DefaultUserSettings when the CreateDomain API is called.