{ "description": "ModelExplainabilityJobDefinition is the Schema for the ModelExplainabilityJobDefinitions API", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", "type": "string" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", "type": "string" }, "metadata": { "type": "object" }, "spec": { "description": "ModelExplainabilityJobDefinitionSpec defines the desired state of ModelExplainabilityJobDefinition.", "properties": { "jobDefinitionName": { "description": "The name of the model explainability job definition. The name must be unique\nwithin an Amazon Web Services Region in the Amazon Web Services account.\n\nRegex Pattern: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$`", "type": "string" }, "jobResources": { "description": "Identifies the resources to deploy for a monitoring job.", "properties": { "clusterConfig": { "description": "Configuration for the cluster used to run model monitoring jobs.", "properties": { "instanceCount": { "format": "int64", "type": "integer" }, "instanceType": { "type": "string" }, "volumeKMSKeyID": { "type": "string" }, "volumeSizeInGB": { "format": "int64", "type": "integer" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "modelExplainabilityAppSpecification": { "description": "Configures the model explainability job to run a specified Docker container\nimage.", "properties": { "configURI": { "type": "string" }, "environment": { "additionalProperties": { "type": "string" }, "type": "object" }, "imageURI": { "type": "string" } }, "type": "object", "additionalProperties": false }, "modelExplainabilityBaselineConfig": { "description": "The baseline configuration for a model explainability job.", "properties": { "baseliningJobName": { "type": "string" }, "constraintsResource": { "description": "The constraints resource for a monitoring job.", "properties": { "s3URI": { "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "modelExplainabilityJobInput": { "description": "Inputs for the model explainability job.", "properties": { "endpointInput": { "description": "Input object for the endpoint", "properties": { "endTimeOffset": { "type": "string" }, "endpointName": { "type": "string" }, "excludeFeaturesAttribute": { "type": "string" }, "featuresAttribute": { "type": "string" }, "inferenceAttribute": { "type": "string" }, "localPath": { "type": "string" }, "probabilityAttribute": { "type": "string" }, "probabilityThresholdAttribute": { "type": "number" }, "s3DataDistributionType": { "type": "string" }, "s3InputMode": { "type": "string" }, "startTimeOffset": { "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "modelExplainabilityJobOutputConfig": { "description": "The output configuration for monitoring jobs.", "properties": { "kmsKeyID": { "type": "string" }, "monitoringOutputs": { "items": { "description": "The output object for a monitoring job.", "properties": { "s3Output": { "description": "Information about where and how you want to store the results of a monitoring\njob.", "properties": { "localPath": { "type": "string" }, "s3URI": { "type": "string" }, "s3UploadMode": { "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false }, "networkConfig": { "description": "Networking options for a model explainability job.", "properties": { "enableInterContainerTrafficEncryption": { "type": "boolean" }, "enableNetworkIsolation": { "type": "boolean" }, "vpcConfig": { "description": "Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs,\nhosted models, and compute resources have access to. You can control access\nto and from your resources by configuring a VPC. For more information, see\nGive SageMaker Access to Resources in your Amazon VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html).", "properties": { "securityGroupIDs": { "items": { "type": "string" }, "type": "array" }, "subnets": { "items": { "type": "string" }, "type": "array" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "roleARN": { "description": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can\nassume to perform tasks on your behalf.\n\nRegex Pattern: `^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$`", "type": "string" }, "stoppingCondition": { "description": "A time limit for how long the monitoring job is allowed to run before stopping.", "properties": { "maxRuntimeInSeconds": { "format": "int64", "type": "integer" } }, "type": "object", "additionalProperties": false }, "tags": { "description": "(Optional) An array of key-value pairs. For more information, see Using Cost\nAllocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL)\nin the Amazon Web Services Billing and Cost Management User Guide.", "items": { "description": "A tag object that consists of a key and an optional value, used to manage\nmetadata for SageMaker Amazon Web Services resources.\n\nYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\n\nFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf).", "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" } }, "required": [ "jobDefinitionName", "jobResources", "modelExplainabilityAppSpecification", "modelExplainabilityJobInput", "modelExplainabilityJobOutputConfig", "roleARN" ], "type": "object", "additionalProperties": false }, "status": { "description": "ModelExplainabilityJobDefinitionStatus defines the observed state of ModelExplainabilityJobDefinition", "properties": { "ackResourceMetadata": { "description": "All CRs managed by ACK have a common `Status.ACKResourceMetadata` member\nthat is used to contain resource sync state, account ownership,\nconstructed ARN for the resource", "properties": { "arn": { "description": "ARN is the Amazon Resource Name for the resource. This is a\nglobally-unique identifier and is set only by the ACK service controller\nonce the controller has orchestrated the creation of the resource OR\nwhen it has verified that an \"adopted\" resource (a resource where the\nARN annotation was set by the Kubernetes user on the CR) exists and\nmatches the supplied CR's Spec field values.\nhttps://github.com/aws/aws-controllers-k8s/issues/270", "type": "string" }, "ownerAccountID": { "description": "OwnerAccountID is the AWS Account ID of the account that owns the\nbackend AWS service API resource.", "type": "string" }, "region": { "description": "Region is the AWS region in which the resource exists or will exist.", "type": "string" } }, "required": [ "ownerAccountID", "region" ], "type": "object", "additionalProperties": false }, "conditions": { "description": "All CRs managed by ACK have a common `Status.Conditions` member that\ncontains a collection of `ackv1alpha1.Condition` objects that describe\nthe various terminal states of the CR and its backend AWS service API\nresource", "items": { "description": "Condition is the common struct used by all CRDs managed by ACK service\ncontrollers to indicate terminal states of the CR and its backend AWS\nservice API resource", "properties": { "lastTransitionTime": { "description": "Last time the condition transitioned from one status to another.", "format": "date-time", "type": "string" }, "message": { "description": "A human readable message indicating details about the transition.", "type": "string" }, "reason": { "description": "The reason for the condition's last transition.", "type": "string" }, "status": { "description": "Status of the condition, one of True, False, Unknown.", "type": "string" }, "type": { "description": "Type is the type of the Condition", "type": "string" } }, "required": [ "status", "type" ], "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false } }, "type": "object" }