Skip to content

aws.sagemaker.describe_model_bias_job_definition

Example SQL Queries

SELECT * FROM
aws.sagemaker.describe_model_bias_job_definition
WHERE
"job_definition_name" = 'VALUE';

Description

Returns a description of a model bias job definition.

Table Definition

Column NameColumn Data Type
job_definition_name Required Input Column

The name of the bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

creation_time

The time at which the model bias job was created.

TIMESTAMP_S
job_definition_arn

The Amazon Resource Name (ARN) of the model bias job.

VARCHAR
job_resources

Identifies the resources to deploy for a monitoring job.

STRUCT(
"cluster_config" STRUCT(
"instance_count" BIGINT,
"instance_type" VARCHAR,
"volume_size_in_gb" BIGINT,
"volume_kms_key_id" VARCHAR
)
)
Show child fields
job_resources.cluster_config

The configuration for the cluster resources used to run the processing job.

Show child fields
job_resources.cluster_config.instance_count

The number of ML compute instances to use in the model monitoring job. For distributed processing jobs, specify a value greater than 1. The default value is 1.

job_resources.cluster_config.instance_type

The ML compute instance type for the processing job.

job_resources.cluster_config.volume_kms_key_id

The Key Management Service (KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the model monitoring job.

job_resources.cluster_config.volume_size_in_gb

The size of the ML storage volume, in gigabytes, that you want to provision. You must specify sufficient ML storage for your scenario.

model_bias_app_specification

Configures the model bias job to run a specified Docker container image.

STRUCT(
"image_uri" VARCHAR,
"config_uri" VARCHAR,
"environment" MAP(VARCHAR, VARCHAR)
)
Show child fields
model_bias_app_specification.config_uri

JSON formatted S3 file that defines bias parameters. For more information on this JSON configuration file, see Configure bias parameters.

model_bias_app_specification.environment

Sets the environment variables in the Docker container.

model_bias_app_specification.image_uri

The container image to be run by the model bias job.

model_bias_baseline_config

The baseline configuration for a model bias job.

STRUCT(
"baselining_job_name" VARCHAR,
"constraints_resource" STRUCT(
"s3_uri" VARCHAR
)
)
Show child fields
model_bias_baseline_config.baselining_job_name

The name of the baseline model bias job.

model_bias_baseline_config.constraints_resource

The constraints resource for a monitoring job.

Show child fields
model_bias_baseline_config.constraints_resource.s3_uri

The Amazon S3 URI for the constraints resource.

model_bias_job_input

Inputs for the model bias job.

STRUCT(
"endpoint_input" STRUCT(
"endpoint_name" VARCHAR,
"local_path" VARCHAR,
"s3_input_mode" VARCHAR,
"s3_data_distribution_type" VARCHAR,
"features_attribute" VARCHAR,
"inference_attribute" VARCHAR,
"probability_attribute" VARCHAR,
"probability_threshold_attribute" DOUBLE,
"start_time_offset" VARCHAR,
"end_time_offset" VARCHAR,
"exclude_features_attribute" VARCHAR
),
"batch_transform_input" STRUCT(
"data_captured_destination_s3_uri" VARCHAR,
"dataset_format" STRUCT(
"csv" STRUCT(
"header" BOOLEAN
),
"json" STRUCT(
"line" BOOLEAN
),
"parquet" BOOLEAN
),
"local_path" VARCHAR,
"s3_input_mode" VARCHAR,
"s3_data_distribution_type" VARCHAR,
"features_attribute" VARCHAR,
"inference_attribute" VARCHAR,
"probability_attribute" VARCHAR,
"probability_threshold_attribute" DOUBLE,
"start_time_offset" VARCHAR,
"end_time_offset" VARCHAR,
"exclude_features_attribute" VARCHAR
),
"ground_truth_s3_input" STRUCT(
"s3_uri" VARCHAR
)
)
Show child fields
model_bias_job_input.batch_transform_input

Input object for the batch transform job.

Show child fields
model_bias_job_input.batch_transform_input.data_captured_destination_s3_uri

The Amazon S3 location being used to capture the data.

model_bias_job_input.batch_transform_input.dataset_format

The dataset format for your batch transform job.

Show child fields
model_bias_job_input.batch_transform_input.dataset_format.csv

The CSV dataset used in the monitoring job.

Show child fields
model_bias_job_input.batch_transform_input.dataset_format.csv.header

Indicates if the CSV data has a header.

model_bias_job_input.batch_transform_input.dataset_format.json

The JSON dataset used in the monitoring job

Show child fields
model_bias_job_input.batch_transform_input.dataset_format.json.line

Indicates if the file should be read as a JSON object per line.

model_bias_job_input.batch_transform_input.dataset_format.parquet

The Parquet dataset used in the monitoring job

model_bias_job_input.batch_transform_input.end_time_offset

If specified, monitoring jobs subtract this time from the end time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.

model_bias_job_input.batch_transform_input.exclude_features_attribute

The attributes of the input data to exclude from the analysis.

model_bias_job_input.batch_transform_input.features_attribute

The attributes of the input data that are the input features.

model_bias_job_input.batch_transform_input.inference_attribute

The attribute of the input data that represents the ground truth label.

model_bias_job_input.batch_transform_input.local_path

Path to the filesystem where the batch transform data is available to the container.

model_bias_job_input.batch_transform_input.probability_attribute

In a classification problem, the attribute that represents the class probability.

model_bias_job_input.batch_transform_input.probability_threshold_attribute

The threshold for the class probability to be evaluated as a positive result.

model_bias_job_input.batch_transform_input.s3_data_distribution_type

Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defaults to FullyReplicated

model_bias_job_input.batch_transform_input.s3_input_mode

Whether the Pipe or File is used as the input mode for transferring data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.

model_bias_job_input.batch_transform_input.start_time_offset

If specified, monitoring jobs substract this time from the start time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.

model_bias_job_input.endpoint_input

Input object for the endpoint

Show child fields
model_bias_job_input.endpoint_input.end_time_offset

If specified, monitoring jobs substract this time from the end time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.

model_bias_job_input.endpoint_input.endpoint_name

An endpoint in customer's account which has enabled DataCaptureConfig enabled.

model_bias_job_input.endpoint_input.exclude_features_attribute

The attributes of the input data to exclude from the analysis.

model_bias_job_input.endpoint_input.features_attribute

The attributes of the input data that are the input features.

model_bias_job_input.endpoint_input.inference_attribute

The attribute of the input data that represents the ground truth label.

model_bias_job_input.endpoint_input.local_path

Path to the filesystem where the endpoint data is available to the container.

model_bias_job_input.endpoint_input.probability_attribute

In a classification problem, the attribute that represents the class probability.

model_bias_job_input.endpoint_input.probability_threshold_attribute

The threshold for the class probability to be evaluated as a positive result.

model_bias_job_input.endpoint_input.s3_data_distribution_type

Whether input data distributed in Amazon S3 is fully replicated or sharded by an Amazon S3 key. Defaults to FullyReplicated

model_bias_job_input.endpoint_input.s3_input_mode

Whether the Pipe or File is used as the input mode for transferring data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.

model_bias_job_input.endpoint_input.start_time_offset

If specified, monitoring jobs substract this time from the start time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.

model_bias_job_input.ground_truth_s3_input

Location of ground truth labels to use in model bias job.

Show child fields
model_bias_job_input.ground_truth_s3_input.s3_uri

The address of the Amazon S3 location of the ground truth labels.

model_bias_job_output_config

The output configuration for monitoring jobs.

STRUCT(
"monitoring_outputs" STRUCT(
"s3_output" STRUCT(
"s3_uri" VARCHAR,
"local_path" VARCHAR,
"s3_upload_mode" VARCHAR
)
)[],
"kms_key_id" VARCHAR
)
Show child fields
model_bias_job_output_config.kms_key_id

The Key Management Service (KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.

model_bias_job_output_config.monitoring_outputs[]
Show child fields
model_bias_job_output_config.monitoring_outputs[].s3_output

The Amazon S3 storage location where the results of a monitoring job are saved.

Show child fields
model_bias_job_output_config.monitoring_outputs[].s3_output.local_path

The local path to the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job. LocalPath is an absolute path for the output data.

model_bias_job_output_config.monitoring_outputs[].s3_output.s3_upload_mode

Whether to upload the results of the monitoring job continuously or after the job completes.

model_bias_job_output_config.monitoring_outputs[].s3_output.s3_uri

A URI that identifies the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job.

network_config

Networking options for a model bias job.

STRUCT(
"enable_inter_container_traffic_encryption" BOOLEAN,
"enable_network_isolation" BOOLEAN,
"vpc_config" STRUCT(
"security_group_ids" VARCHAR[],
"subnets" VARCHAR[]
)
)
Show child fields
network_config.enable_inter_container_traffic_encryption

Whether to encrypt all communications between the instances used for the monitoring jobs. Choose True to encrypt communications. Encryption provides greater security for distributed jobs, but the processing might take longer.

network_config.enable_network_isolation

Whether to allow inbound and outbound network calls to and from the containers used for the monitoring job.

network_config.vpc_config

Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC.

Show child fields
network_config.vpc_config.security_group_ids[]
network_config.vpc_config.subnets[]
role_arn

The Amazon Resource Name (ARN) of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.

VARCHAR
stopping_condition

A time limit for how long the monitoring job is allowed to run before stopping.

STRUCT(
"max_runtime_in_seconds" BIGINT
)
Show child fields
stopping_condition.max_runtime_in_seconds

The maximum runtime allowed in seconds.

The MaxRuntimeInSeconds cannot exceed the frequency of the job. For data quality and model explainability, this can be up to 3600 seconds for an hourly schedule. For model bias and model quality hourly schedules, this can be up to 1800 seconds.