Skip to content

MonitoringJobDefinition

Source code in docs_src/capo_sagemaker/types/monitoring_job_definition.py
class MonitoringJobDefinition(TypedDict, closed=True):
    baseline_config: NotRequired[
        "capo_sagemaker.types.monitoring_baseline_config.MonitoringBaselineConfig"
    ]
    """<p>Baseline configuration used to validate that the data conforms to the specified constraints and statistics</p>"""
    monitoring_inputs: NotRequired[
        "capo_sagemaker.types.monitoring_inputs.MonitoringInputs"
    ]
    """<p>The array of inputs for the monitoring job. Currently we support monitoring an Amazon SageMaker AI Endpoint.</p>"""
    monitoring_output_config: NotRequired[
        "capo_sagemaker.types.monitoring_output_config.MonitoringOutputConfig"
    ]
    """<p>The array of outputs from the monitoring job to be uploaded to Amazon S3.</p>"""
    monitoring_resources: NotRequired[
        "capo_sagemaker.types.monitoring_resources.MonitoringResources"
    ]
    """<p>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.</p>"""
    monitoring_app_specification: NotRequired[
        "capo_sagemaker.types.monitoring_app_specification.MonitoringAppSpecification"
    ]
    """<p>Configures the monitoring job to run a specified Docker container image.</p>"""
    stopping_condition: NotRequired[
        "capo_sagemaker.types.monitoring_stopping_condition.MonitoringStoppingCondition"
    ]
    """<p>Specifies a time limit for how long the monitoring job is allowed to run.</p>"""
    environment: NotRequired[
        "capo_sagemaker.types.monitoring_environment_map.MonitoringEnvironmentMap"
    ]
    """<p>Sets the environment variables in the Docker container.</p>"""
    network_config: NotRequired["capo_sagemaker.types.network_config.NetworkConfig"]
    """<p>Specifies networking options for an monitoring job.</p>"""
    role_arn: NotRequired["capo_sagemaker.types.role_arn.RoleArn"]
    """<p>The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.</p>"""

baseline_config instance-attribute

baseline_config: NotRequired[MonitoringBaselineConfig]

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

environment instance-attribute

environment: NotRequired[MonitoringEnvironmentMap]

Sets the environment variables in the Docker container.

monitoring_app_specification instance-attribute

monitoring_app_specification: NotRequired[MonitoringAppSpecification]

Configures the monitoring job to run a specified Docker container image.

monitoring_inputs instance-attribute

monitoring_inputs: NotRequired[MonitoringInputs]

The array of inputs for the monitoring job. Currently we support monitoring an Amazon SageMaker AI Endpoint.

monitoring_output_config instance-attribute

monitoring_output_config: NotRequired[MonitoringOutputConfig]

The array of outputs from the monitoring job to be uploaded to Amazon S3.

monitoring_resources instance-attribute

monitoring_resources: NotRequired[MonitoringResources]

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.

network_config instance-attribute

network_config: NotRequired[NetworkConfig]

Specifies networking options for an monitoring job.

role_arn instance-attribute

role_arn: NotRequired[RoleArn]

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.

stopping_condition instance-attribute

stopping_condition: NotRequired[MonitoringStoppingCondition]

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