Skip to content

CreateMlflowAppRequest

Source code in docs_src/capo_sagemaker/types/create_mlflow_app_request.py
class CreateMlflowAppRequest(TypedDict, closed=True):
    name: NotRequired["capo_sagemaker.types.mlflow_app_name.MlflowAppName"]
    """<p>A string identifying the MLflow app name. This string is not part of the tracking server ARN.</p>"""
    artifact_store_uri: NotRequired["capo_sagemaker.types.s3_uri.S3Uri"]
    """<p>The S3 URI for a general purpose bucket to use as the MLflow App artifact store.</p>"""
    role_arn: NotRequired["capo_sagemaker.types.role_arn.RoleArn"]
    """<p>The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow App uses to access the artifact store in Amazon S3. The role should have the <code>AmazonS3FullAccess</code> permission.</p>"""
    kms_key_id: NotRequired["capo_sagemaker.types.kms_key_id.KmsKeyId"]
    """<p>The ID of the Amazon Web Services KMS key used to encrypt the data at rest associated with the MLflow App. If you don't specify a value, the MLflow App is not encrypted with a customer-managed key.</p>"""
    model_registration_mode: NotRequired[
        "capo_sagemaker.types.model_registration_mode.ModelRegistrationMode"
    ]
    """<p>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 <code>AutoModelRegistrationEnabled</code>. To disable automatic model registration, set this value to <code>AutoModelRegistrationDisabled</code>. If not specified, <code>AutomaticModelRegistration</code> defaults to <code>AutoModelRegistrationDisabled</code>.</p>"""
    weekly_maintenance_window_start: NotRequired[
        "capo_sagemaker.types.weekly_maintenance_window_start.WeeklyMaintenanceWindowStart"
    ]
    """<p>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.</p>"""
    account_default_status: NotRequired[
        "capo_sagemaker.types.account_default_status.AccountDefaultStatus"
    ]
    """<p>Indicates whether this MLflow app is the default for the entire account.</p>"""
    default_domain_id_list: NotRequired[
        "capo_sagemaker.types.default_domain_id_list.DefaultDomainIdList"
    ]
    """<p>List of SageMaker domain IDs for which this MLflow App is used as the default.</p>"""
    tags: NotRequired["capo_sagemaker.types.tag_list.TagList"]
    """<p>Tags consisting of key-value pairs used to manage metadata for the MLflow App.</p>"""

account_default_status instance-attribute

account_default_status: NotRequired[AccountDefaultStatus]

Indicates whether this MLflow app is the default for the entire account.

artifact_store_uri instance-attribute

artifact_store_uri: NotRequired[S3Uri]

The S3 URI for a general purpose bucket to use as the MLflow App artifact store.

default_domain_id_list instance-attribute

default_domain_id_list: NotRequired[DefaultDomainIdList]

List of SageMaker domain IDs for which this MLflow App is used as the default.

kms_key_id instance-attribute

kms_key_id: NotRequired[KmsKeyId]

The ID of the Amazon Web Services KMS key used to encrypt the data at rest associated with the MLflow App. If you don't specify a value, the MLflow App is not encrypted with a customer-managed key.

model_registration_mode instance-attribute

model_registration_mode: NotRequired[ModelRegistrationMode]

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 AutoModelRegistrationEnabled. To disable automatic model registration, set this value to AutoModelRegistrationDisabled. If not specified, AutomaticModelRegistration defaults to AutoModelRegistrationDisabled.

name instance-attribute

name: NotRequired[MlflowAppName]

A string identifying the MLflow app name. This string is not part of the tracking server ARN.

role_arn instance-attribute

role_arn: NotRequired[RoleArn]

The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow App uses to access the artifact store in Amazon S3. The role should have the AmazonS3FullAccess permission.

tags instance-attribute

tags: NotRequired[TagList]

Tags consisting of key-value pairs used to manage metadata for the MLflow App.

weekly_maintenance_window_start instance-attribute

weekly_maintenance_window_start: NotRequired[WeeklyMaintenanceWindowStart]

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.