AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::SageMaker::Types::MonitoringScheduleConfig

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb

Overview

Note:

When making an API call, you may pass MonitoringScheduleConfig data as a hash:

{
  schedule_config: {
    schedule_expression: "ScheduleExpression", # required
  },
  monitoring_job_definition: {
    baseline_config: {
      baselining_job_name: "ProcessingJobName",
      constraints_resource: {
        s3_uri: "S3Uri",
      },
      statistics_resource: {
        s3_uri: "S3Uri",
      },
    },
    monitoring_inputs: [ # required
      {
        endpoint_input: { # required
          endpoint_name: "EndpointName", # required
          local_path: "ProcessingLocalPath", # required
          s3_input_mode: "Pipe", # accepts Pipe, File
          s3_data_distribution_type: "FullyReplicated", # accepts FullyReplicated, ShardedByS3Key
          features_attribute: "String",
          inference_attribute: "String",
          probability_attribute: "String",
          probability_threshold_attribute: 1.0,
          start_time_offset: "MonitoringTimeOffsetString",
          end_time_offset: "MonitoringTimeOffsetString",
        },
      },
    ],
    monitoring_output_config: { # required
      monitoring_outputs: [ # required
        {
          s3_output: { # required
            s3_uri: "MonitoringS3Uri", # required
            local_path: "ProcessingLocalPath", # required
            s3_upload_mode: "Continuous", # accepts Continuous, EndOfJob
          },
        },
      ],
      kms_key_id: "KmsKeyId",
    },
    monitoring_resources: { # required
      cluster_config: { # required
        instance_count: 1, # required
        instance_type: "ml.t3.medium", # required, accepts ml.t3.medium, ml.t3.large, ml.t3.xlarge, ml.t3.2xlarge, ml.m4.xlarge, ml.m4.2xlarge, ml.m4.4xlarge, ml.m4.10xlarge, ml.m4.16xlarge, ml.c4.xlarge, ml.c4.2xlarge, ml.c4.4xlarge, ml.c4.8xlarge, ml.p2.xlarge, ml.p2.8xlarge, ml.p2.16xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge, ml.c5.xlarge, ml.c5.2xlarge, ml.c5.4xlarge, ml.c5.9xlarge, ml.c5.18xlarge, ml.m5.large, ml.m5.xlarge, ml.m5.2xlarge, ml.m5.4xlarge, ml.m5.12xlarge, ml.m5.24xlarge, ml.r5.large, ml.r5.xlarge, ml.r5.2xlarge, ml.r5.4xlarge, ml.r5.8xlarge, ml.r5.12xlarge, ml.r5.16xlarge, ml.r5.24xlarge, ml.g4dn.xlarge, ml.g4dn.2xlarge, ml.g4dn.4xlarge, ml.g4dn.8xlarge, ml.g4dn.12xlarge, ml.g4dn.16xlarge
        volume_size_in_gb: 1, # required
        volume_kms_key_id: "KmsKeyId",
      },
    },
    monitoring_app_specification: { # required
      image_uri: "ImageUri", # required
      container_entrypoint: ["ContainerEntrypointString"],
      container_arguments: ["ContainerArgument"],
      record_preprocessor_source_uri: "S3Uri",
      post_analytics_processor_source_uri: "S3Uri",
    },
    stopping_condition: {
      max_runtime_in_seconds: 1, # required
    },
    environment: {
      "ProcessingEnvironmentKey" => "ProcessingEnvironmentValue",
    },
    network_config: {
      enable_inter_container_traffic_encryption: false,
      enable_network_isolation: false,
      vpc_config: {
        security_group_ids: ["SecurityGroupId"], # required
        subnets: ["SubnetId"], # required
      },
    },
    role_arn: "RoleArn", # required
  },
  monitoring_job_definition_name: "MonitoringJobDefinitionName",
  monitoring_type: "DataQuality", # accepts DataQuality, ModelQuality, ModelBias, ModelExplainability
}

Configures the monitoring schedule and defines the monitoring job.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#monitoring_job_definitionTypes::MonitoringJobDefinition

Defines the monitoring job.



27725
27726
27727
27728
27729
27730
27731
27732
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 27725

class MonitoringScheduleConfig < Struct.new(
  :schedule_config,
  :monitoring_job_definition,
  :monitoring_job_definition_name,
  :monitoring_type)
  SENSITIVE = []
  include Aws::Structure
end

#monitoring_job_definition_nameString

The name of the monitoring job definition to schedule.

Returns:

  • (String)


27725
27726
27727
27728
27729
27730
27731
27732
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 27725

class MonitoringScheduleConfig < Struct.new(
  :schedule_config,
  :monitoring_job_definition,
  :monitoring_job_definition_name,
  :monitoring_type)
  SENSITIVE = []
  include Aws::Structure
end

#monitoring_typeString

The type of the monitoring job definition to schedule.

Returns:

  • (String)


27725
27726
27727
27728
27729
27730
27731
27732
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 27725

class MonitoringScheduleConfig < Struct.new(
  :schedule_config,
  :monitoring_job_definition,
  :monitoring_job_definition_name,
  :monitoring_type)
  SENSITIVE = []
  include Aws::Structure
end

#schedule_configTypes::ScheduleConfig

Configures the monitoring schedule.



27725
27726
27727
27728
27729
27730
27731
27732
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 27725

class MonitoringScheduleConfig < Struct.new(
  :schedule_config,
  :monitoring_job_definition,
  :monitoring_job_definition_name,
  :monitoring_type)
  SENSITIVE = []
  include Aws::Structure
end