model_quality_job_definitions

Creates, updates, deletes, gets or lists a model_quality_job_definitions resource.

Overview

Name	model_quality_job_definitions
Type	Resource
Id	aws.sagemaker.model_quality_job_definitions

Fields

The following fields are returned by SELECT queries:

describe_model_quality_job_definition

Name	Datatype	Description
creation_time	string (date-time)	The time at which the model quality job was created.
job_definition_arn	string	The Amazon Resource Name (ARN) of the model quality job. (pattern: <code>.*</code>)
job_definition_name	string	The name of the quality job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)
job_resources	object	Identifies the resources to deploy for a monitoring job.
model_quality_app_specification	object	Configures the model quality job to run a specified Docker container image.
model_quality_baseline_config	object	The baseline configuration for a model quality job.
model_quality_job_input	object	Inputs for the model quality job.
model_quality_job_output_config	object	The output configuration for monitoring jobs.
network_config	object	Networking options for a model quality job.
role_arn	string	The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf. (pattern: <code>arn:aws[a-z-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@-_/]+</code>)
stopping_condition	object	A time limit for how long the monitoring job is allowed to run before stopping.

list_model_quality_job_definitions

Name	Datatype	Description
creation_time	string (date-time)	The time that the monitoring job was created.
endpoint_name	string	The name of the endpoint that the job monitors. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)
monitoring_job_definition_arn	string	The Amazon Resource Name (ARN) of the monitoring job. (pattern: <code>.*</code>)
monitoring_job_definition_name	string	The name of the monitoring job. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_model_quality_job_definition	select	region		Returns a description of a model quality job definition.
list_model_quality_job_definitions	select	region		Gets a list of model quality monitoring job definitions in your account.
create_model_quality_job_definition	insert	region, JobDefinitionName, ModelQualityAppSpecification, ModelQualityJobInput, ModelQualityJobOutputConfig, JobResources, RoleArn		Creates a definition for a job that monitors model quality and drift. For information about model monitor, see Amazon SageMaker AI Model Monitor.
delete_model_quality_job_definition	delete	region		Deletes the secified model quality monitoring job definition.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_model_quality_job_definition

Returns a description of a model quality job definition.

SELECT
creation_time,
job_definition_arn,
job_definition_name,
job_resources,
model_quality_app_specification,
model_quality_baseline_config,
model_quality_job_input,
model_quality_job_output_config,
network_config,
role_arn,
stopping_condition
FROM aws.sagemaker.model_quality_job_definitions
WHERE region = '{{ region }}' -- required
;

list_model_quality_job_definitions

Gets a list of model quality monitoring job definitions in your account.

SELECT
creation_time,
endpoint_name,
monitoring_job_definition_arn,
monitoring_job_definition_name
FROM aws.sagemaker.model_quality_job_definitions
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_model_quality_job_definition

Creates a definition for a job that monitors model quality and drift. For information about model monitor, see Amazon SageMaker AI Model Monitor.

INSERT INTO aws.sagemaker.model_quality_job_definitions (
JobDefinitionName,
ModelQualityBaselineConfig,
ModelQualityAppSpecification,
ModelQualityJobInput,
ModelQualityJobOutputConfig,
JobResources,
NetworkConfig,
RoleArn,
StoppingCondition,
Tags,
region
)
SELECT 
'{{ JobDefinitionName }}' /* required */,
'{{ ModelQualityBaselineConfig }}',
'{{ ModelQualityAppSpecification }}' /* required */,
'{{ ModelQualityJobInput }}' /* required */,
'{{ ModelQualityJobOutputConfig }}' /* required */,
'{{ JobResources }}' /* required */,
'{{ NetworkConfig }}',
'{{ RoleArn }}' /* required */,
'{{ StoppingCondition }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
job_definition_arn
;

Manifest

# Description fields are for documentation purposes
- name: model_quality_job_definitions
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the model_quality_job_definitions resource.
  - name: JobDefinitionName
    value: "{{ JobDefinitionName }}"
    description: |
      The name of the monitoring job definition.
  - name: ModelQualityBaselineConfig
    description: |
      Specifies the constraints and baselines for the monitoring job.
    value:
      BaseliningJobName: "{{ BaseliningJobName }}"
      ConstraintsResource:
        S3Uri: "{{ S3Uri }}"
  - name: ModelQualityAppSpecification
    description: |
      The container that runs the monitoring job.
    value:
      ImageUri: "{{ ImageUri }}"
      ContainerEntrypoint:
        - "{{ ContainerEntrypoint }}"
      ContainerArguments:
        - "{{ ContainerArguments }}"
      RecordPreprocessorSourceUri: "{{ RecordPreprocessorSourceUri }}"
      PostAnalyticsProcessorSourceUri: "{{ PostAnalyticsProcessorSourceUri }}"
      ProblemType: "{{ ProblemType }}"
      Environment: "{{ Environment }}"
  - name: ModelQualityJobInput
    description: |
      A list of the inputs that are monitored. Currently endpoints are supported.
    value:
      EndpointInput:
        EndpointName: "{{ EndpointName }}"
        LocalPath: "{{ LocalPath }}"
        S3InputMode: "{{ S3InputMode }}"
        S3DataDistributionType: "{{ S3DataDistributionType }}"
        FeaturesAttribute: "{{ FeaturesAttribute }}"
        InferenceAttribute: "{{ InferenceAttribute }}"
        ProbabilityAttribute: "{{ ProbabilityAttribute }}"
        ProbabilityThresholdAttribute: {{ ProbabilityThresholdAttribute }}
        StartTimeOffset: "{{ StartTimeOffset }}"
        EndTimeOffset: "{{ EndTimeOffset }}"
        ExcludeFeaturesAttribute: "{{ ExcludeFeaturesAttribute }}"
      BatchTransformInput:
        DataCapturedDestinationS3Uri: "{{ DataCapturedDestinationS3Uri }}"
        DatasetFormat:
          Csv:
            Header: {{ Header }}
          Json:
            Line: {{ Line }}
          Parquet: "{{ Parquet }}"
        LocalPath: "{{ LocalPath }}"
        S3InputMode: "{{ S3InputMode }}"
        S3DataDistributionType: "{{ S3DataDistributionType }}"
        FeaturesAttribute: "{{ FeaturesAttribute }}"
        InferenceAttribute: "{{ InferenceAttribute }}"
        ProbabilityAttribute: "{{ ProbabilityAttribute }}"
        ProbabilityThresholdAttribute: {{ ProbabilityThresholdAttribute }}
        StartTimeOffset: "{{ StartTimeOffset }}"
        EndTimeOffset: "{{ EndTimeOffset }}"
        ExcludeFeaturesAttribute: "{{ ExcludeFeaturesAttribute }}"
      GroundTruthS3Input:
        S3Uri: "{{ S3Uri }}"
  - name: ModelQualityJobOutputConfig
    description: |
      The output configuration for monitoring jobs.
    value:
      MonitoringOutputs:
        - S3Output:
            S3Uri: "{{ S3Uri }}"
            LocalPath: "{{ LocalPath }}"
            S3UploadMode: "{{ S3UploadMode }}"
      KmsKeyId: "{{ KmsKeyId }}"
  - name: JobResources
    description: |
      Identifies the resources to deploy for a monitoring job.
    value:
      ClusterConfig:
        InstanceCount: {{ InstanceCount }}
        InstanceType: "{{ InstanceType }}"
        VolumeSizeInGB: {{ VolumeSizeInGB }}
        VolumeKmsKeyId: "{{ VolumeKmsKeyId }}"
  - name: NetworkConfig
    description: |
      Specifies the network configuration for the monitoring job.
    value:
      EnableInterContainerTrafficEncryption: {{ EnableInterContainerTrafficEncryption }}
      EnableNetworkIsolation: {{ EnableNetworkIsolation }}
      VpcConfig:
        SecurityGroupIds:
          - "{{ SecurityGroupIds }}"
        Subnets:
          - "{{ Subnets }}"
  - name: RoleArn
    value: "{{ RoleArn }}"
    description: |
      The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.
  - name: StoppingCondition
    description: |
      A time limit for how long the monitoring job is allowed to run before stopping.
    value:
      MaxRuntimeInSeconds: {{ MaxRuntimeInSeconds }}
  - name: Tags
    description: |
      (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.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

DELETE examples

delete_model_quality_job_definition

Deletes the secified model quality monitoring job definition.

DELETE FROM aws.sagemaker.model_quality_job_definitions
WHERE region = '{{ region }}' --required
;