ModelQualityJobDefinition

sagemaker.services.k8s.aws/v1alpha1

TypeLink
GoDocsagemaker-controller/apis/v1alpha1#ModelQualityJobDefinition

Metadata

PropertyValue
ScopeNamespaced
KindModelQualityJobDefinition
ListKindModelQualityJobDefinitionList
Pluralmodelqualityjobdefinitions
Singularmodelqualityjobdefinition

Spec

jobDefinitionName: string jobResources: clusterConfig: instanceCount: integer instanceType: string volumeKMSKeyID: string volumeSizeInGB: integer modelQualityAppSpecification: containerArguments: - string containerEntrypoint: - string environment: {} imageURI: string postAnalyticsProcessorSourceURI: string problemType: string recordPreprocessorSourceURI: string modelQualityBaselineConfig: baseliningJobName: string constraintsResource: s3URI: string modelQualityJobInput: endpointInput: endTimeOffset: string endpointName: string excludeFeaturesAttribute: string featuresAttribute: string inferenceAttribute: string localPath: string probabilityAttribute: string probabilityThresholdAttribute: number s3DataDistributionType: string s3InputMode: string startTimeOffset: string groundTruthS3Input: s3URI: string modelQualityJobOutputConfig: kmsKeyID: string monitoringOutputs: s3Output: localPath: string s3URI: string s3UploadMode: string networkConfig: enableInterContainerTrafficEncryption: boolean enableNetworkIsolation: boolean vpcConfig: securityGroupIDs: - string subnets: - string roleARN: string stoppingCondition: maxRuntimeInSeconds: integer tags: - key: string value: string
FieldDescription
jobDefinitionName
Required		string
The name of the monitoring job definition.

Regex Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$
jobResources
Required		object
Identifies the resources to deploy for a monitoring job.
jobResources.clusterConfig
Optional		object
Configuration for the cluster used to run model monitoring jobs.
jobResources.clusterConfig.instanceCount
Optional		integer
jobResources.clusterConfig.instanceType
Optional		string
jobResources.clusterConfig.volumeKMSKeyID
Optional		string
jobResources.clusterConfig.volumeSizeInGB
Optional		integer
modelQualityAppSpecification
Required		object
The container that runs the monitoring job.
modelQualityAppSpecification.containerArguments
Optional		array
modelQualityAppSpecification.containerArguments.[]
Required		string
modelQualityAppSpecification.containerEntrypoint.[]
Required		string
modelQualityAppSpecification.imageURI
Optional		string
modelQualityAppSpecification.postAnalyticsProcessorSourceURI
Optional		string
modelQualityAppSpecification.problemType
Optional		string
modelQualityAppSpecification.recordPreprocessorSourceURI
Optional		string
modelQualityBaselineConfig
Optional		object
Specifies the constraints and baselines for the monitoring job.
modelQualityBaselineConfig.baseliningJobName
Optional		string
modelQualityBaselineConfig.constraintsResource
Optional		object
The constraints resource for a monitoring job.
modelQualityBaselineConfig.constraintsResource.s3URI
Optional		string
modelQualityJobInput
Required		object
A list of the inputs that are monitored. Currently endpoints are supported.
modelQualityJobInput.endpointInput
Optional		object
Input object for the endpoint
modelQualityJobInput.endpointInput.endTimeOffset
Optional		string
modelQualityJobInput.endpointInput.endpointName
Optional		string
modelQualityJobInput.endpointInput.excludeFeaturesAttribute
Optional		string
modelQualityJobInput.endpointInput.featuresAttribute
Optional		string
modelQualityJobInput.endpointInput.inferenceAttribute
Optional		string
modelQualityJobInput.endpointInput.localPath
Optional		string
modelQualityJobInput.endpointInput.probabilityAttribute
Optional		string
modelQualityJobInput.endpointInput.probabilityThresholdAttribute
Optional		number
modelQualityJobInput.endpointInput.s3DataDistributionType
Optional		string
modelQualityJobInput.endpointInput.s3InputMode
Optional		string
modelQualityJobInput.endpointInput.startTimeOffset
Optional		string
modelQualityJobInput.groundTruthS3Input
Optional		object
The ground truth labels for the dataset used for the monitoring job.
modelQualityJobInput.groundTruthS3Input.s3URI
Optional		string
modelQualityJobOutputConfig
Required		object
The output configuration for monitoring jobs.
modelQualityJobOutputConfig.kmsKeyID
Optional		string
modelQualityJobOutputConfig.monitoringOutputs
Optional		array
modelQualityJobOutputConfig.monitoringOutputs.[]
Required		object
The output object for a monitoring job.
modelQualityJobOutputConfig.monitoringOutputs.[].s3Output.localPath
Optional		string
modelQualityJobOutputConfig.monitoringOutputs.[].s3Output.s3URI
Optional		string
modelQualityJobOutputConfig.monitoringOutputs.[].s3Output.s3UploadMode
Optional		string
networkConfig
Optional		object
Specifies the network configuration for the monitoring job.
networkConfig.enableInterContainerTrafficEncryption
Optional		boolean
networkConfig.enableNetworkIsolation
Optional		boolean
networkConfig.vpcConfig
Optional		object
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 (https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html).
networkConfig.vpcConfig.securityGroupIDs
Optional		array
networkConfig.vpcConfig.securityGroupIDs.[]
Required		string
networkConfig.vpcConfig.subnets.[]
Required		string
stoppingCondition
Optional		object
A time limit for how long the monitoring job is allowed to run before stopping.
stoppingCondition.maxRuntimeInSeconds
Optional		integer
tags
Optional		array
(Optional) An array of key-value pairs. For more information, see Using Cost
Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL)
in the Amazon Web Services Billing and Cost Management User Guide.
tags.[]
Required		object
A tag object that consists of a key and an optional value, used to manage
metadata for SageMaker Amazon Web Services resources.

You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).

For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || tags.[].key
Optional | string
| | tags.[].value
Optional | string
|

Status

ackResourceMetadata: arn: string ownerAccountID: string region: string conditions: - lastTransitionTime: string message: string reason: string status: string type: string
FieldDescription
ackResourceMetadata
Optional		object
All CRs managed by ACK have a common Status.ACKResourceMetadata member
that is used to contain resource sync state, account ownership,
constructed ARN for the resource
ackResourceMetadata.arn
Optional		string
ARN is the Amazon Resource Name for the resource. This is a
globally-unique identifier and is set only by the ACK service controller
once the controller has orchestrated the creation of the resource OR
when it has verified that an “adopted” resource (a resource where the
ARN annotation was set by the Kubernetes user on the CR) exists and
matches the supplied CR’s Spec field values.
https://github.com/aws/aws-controllers-k8s/issues/270
ackResourceMetadata.ownerAccountID
Required		string
OwnerAccountID is the AWS Account ID of the account that owns the
backend AWS service API resource.
ackResourceMetadata.region
Required		string
Region is the AWS region in which the resource exists or will exist.
conditions
Optional		array
All CRs managed by ACK have a common Status.Conditions member that
contains a collection of ackv1alpha1.Condition objects that describe
the various terminal states of the CR and its backend AWS service API
resource
conditions.[]
Required		object
Condition is the common struct used by all CRDs managed by ACK service
controllers to indicate terminal states of the CR and its backend AWS
service API resource
conditions.[].message
Optional		string
A human readable message indicating details about the transition.
conditions.[].reason
Optional		string
The reason for the condition’s last transition.
conditions.[].status
Optional		string
Status of the condition, one of True, False, Unknown.
conditions.[].type
Optional		string
Type is the type of the Condition