MonitoringJobDefinition - Amazon SageMaker
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Defines the monitoring job.



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

Type: MonitoringAppSpecification object

Required: Yes


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

Type: Array of MonitoringInput objects

Array Members: Fixed number of 1 item.

Required: Yes


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

Type: MonitoringOutputConfig object

Required: Yes


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.

Type: MonitoringResources object

Required: Yes


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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

Required: Yes


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

Type: MonitoringBaselineConfig object

Required: No


Sets the environment variables in the Docker container.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Maximum length of 256.

Key Pattern: [a-zA-Z_][a-zA-Z0-9_]*

Value Length Constraints: Maximum length of 256.

Value Pattern: [\S\s]*

Required: No


Specifies networking options for an monitoring job.

Type: NetworkConfig object

Required: No


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

Type: MonitoringStoppingCondition object

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: