MonitoringSchedule

sagemaker.services.k8s.aws/v1alpha1

TypeLink
GoDocsagemaker-controller/apis/v1alpha1#MonitoringSchedule

Metadata

PropertyValue
ScopeNamespaced
KindMonitoringSchedule
ListKindMonitoringScheduleList
Pluralmonitoringschedules
Singularmonitoringschedule

A schedule for a model monitoring job. For information about model monitor, see Amazon SageMaker Model Monitor (https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor.html).

Spec

monitoringScheduleConfig: 
  monitoringJobDefinition: 
    baselineConfig: 
      baseliningJobName: string
      constraintsResource: 
        s3URI: string
      statisticsResource: 
        s3URI: string
    environment: {}
    monitoringAppSpecification: 
      containerArguments:
      - string
      containerEntrypoint:
      - string
      imageURI: string
      postAnalyticsProcessorSourceURI: string
      recordPreprocessorSourceURI: string
    monitoringInputs:
      endpointInput: 
        endTimeOffset: string
        endpointName: string
        excludeFeaturesAttribute: string
        featuresAttribute: string
        inferenceAttribute: string
        localPath: string
        probabilityAttribute: string
        probabilityThresholdAttribute: number
        s3DataDistributionType: string
        s3InputMode: string
        startTimeOffset: string
    monitoringOutputConfig: 
      kmsKeyID: string
      monitoringOutputs:
        s3Output: 
          localPath: string
          s3URI: string
          s3UploadMode: string
    monitoringResources: 
      clusterConfig: 
        instanceCount: integer
        instanceType: string
        volumeKMSKeyID: string
        volumeSizeInGB: integer
    networkConfig: 
      enableInterContainerTrafficEncryption: boolean
      enableNetworkIsolation: boolean
      vpcConfig: 
        securityGroupIDs:
        - string
        subnets:
        - string
    roleARN: string
    stoppingCondition: 
      maxRuntimeInSeconds: integer
  monitoringJobDefinitionName: string
  monitoringType: string
  scheduleConfig: 
    dataAnalysisEndTime: string
    dataAnalysisStartTime: string
    scheduleExpression: string
monitoringScheduleName: string
tags:
- key: string
  value: string
FieldDescription
monitoringScheduleConfig
Required
object
The configuration object that specifies the monitoring schedule and defines
the monitoring job.
monitoringScheduleConfig.monitoringJobDefinition
Optional
object
Defines the monitoring job.
monitoringScheduleConfig.monitoringJobDefinition.baselineConfig
Optional
object
Configuration for monitoring constraints and monitoring statistics. These
baseline resources are compared against the results of the current job from
the series of jobs scheduled to collect data periodically.
monitoringScheduleConfig.monitoringJobDefinition.baselineConfig.baseliningJobName
Optional
string
monitoringScheduleConfig.monitoringJobDefinition.baselineConfig.constraintsResource
Optional
object
The constraints resource for a monitoring job.
monitoringScheduleConfig.monitoringJobDefinition.baselineConfig.constraintsResource.s3URI
Optional
string
monitoringScheduleConfig.monitoringJobDefinition.baselineConfig.statisticsResource
Optional
object
The statistics resource for a monitoring job.
monitoringScheduleConfig.monitoringJobDefinition.baselineConfig.statisticsResource.s3URI
Optional
string
monitoringScheduleConfig.monitoringJobDefinition.environment
Optional
object
monitoringScheduleConfig.monitoringJobDefinition.monitoringAppSpecification
Optional
object
Container image configuration object for the monitoring job.
monitoringScheduleConfig.monitoringJobDefinition.monitoringAppSpecification.containerArguments
Optional
array
monitoringScheduleConfig.monitoringJobDefinition.monitoringAppSpecification.containerArguments.[]
Required
string
monitoringScheduleConfig.monitoringJobDefinition.monitoringAppSpecification.containerEntrypoint.[]
Required
string
monitoringScheduleConfig.monitoringJobDefinition.monitoringAppSpecification.postAnalyticsProcessorSourceURI
Optional
string
monitoringScheduleConfig.monitoringJobDefinition.monitoringAppSpecification.recordPreprocessorSourceURI
Optional
string
monitoringScheduleConfig.monitoringJobDefinition.monitoringInputs
Optional
array
monitoringScheduleConfig.monitoringJobDefinition.monitoringInputs.[]
Required
object
The inputs for a monitoring job.
monitoringScheduleConfig.monitoringJobDefinition.monitoringInputs.[].endpointInput.endTimeOffset
Optional
string
monitoringScheduleConfig.monitoringJobDefinition.monitoringInputs.[].endpointInput.endpointName
Optional
string
monitoringScheduleConfig.monitoringJobDefinition.monitoringInputs.[].endpointInput.excludeFeaturesAttribute
Optional
string
monitoringScheduleConfig.monitoringJobDefinition.monitoringInputs.[].endpointInput.featuresAttribute
Optional
string
monitoringScheduleConfig.monitoringJobDefinition.monitoringInputs.[].endpointInput.inferenceAttribute
Optional
string
monitoringScheduleConfig.monitoringJobDefinition.monitoringInputs.[].endpointInput.localPath
Optional
string
monitoringScheduleConfig.monitoringJobDefinition.monitoringInputs.[].endpointInput.probabilityAttribute
Optional
string
monitoringScheduleConfig.monitoringJobDefinition.monitoringInputs.[].endpointInput.probabilityThresholdAttribute
Optional
number
monitoringScheduleConfig.monitoringJobDefinition.monitoringInputs.[].endpointInput.s3DataDistributionType
Optional
string
monitoringScheduleConfig.monitoringJobDefinition.monitoringInputs.[].endpointInput.s3InputMode
Optional
string
monitoringScheduleConfig.monitoringJobDefinition.monitoringInputs.[].endpointInput.startTimeOffset
Optional
string
monitoringScheduleConfig.monitoringJobDefinition.monitoringOutputConfig
Optional
object
The output configuration for monitoring jobs.
monitoringScheduleConfig.monitoringJobDefinition.monitoringOutputConfig.kmsKeyID
Optional
string
monitoringScheduleConfig.monitoringJobDefinition.monitoringOutputConfig.monitoringOutputs
Optional
array
monitoringScheduleConfig.monitoringJobDefinition.monitoringOutputConfig.monitoringOutputs.[]
Required
object
The output object for a monitoring job.
monitoringScheduleConfig.monitoringJobDefinition.monitoringOutputConfig.monitoringOutputs.[].s3Output.localPath
Optional
string
monitoringScheduleConfig.monitoringJobDefinition.monitoringOutputConfig.monitoringOutputs.[].s3Output.s3URI
Optional
string
monitoringScheduleConfig.monitoringJobDefinition.monitoringOutputConfig.monitoringOutputs.[].s3Output.s3UploadMode
Optional
string
monitoringScheduleConfig.monitoringJobDefinition.monitoringResources
Optional
object
Identifies the resources to deploy for a monitoring job.
monitoringScheduleConfig.monitoringJobDefinition.monitoringResources.clusterConfig
Optional
object
Configuration for the cluster used to run model monitoring jobs.
monitoringScheduleConfig.monitoringJobDefinition.monitoringResources.clusterConfig.instanceCount
Optional
integer
monitoringScheduleConfig.monitoringJobDefinition.monitoringResources.clusterConfig.instanceType
Optional
string
monitoringScheduleConfig.monitoringJobDefinition.monitoringResources.clusterConfig.volumeKMSKeyID
Optional
string
monitoringScheduleConfig.monitoringJobDefinition.monitoringResources.clusterConfig.volumeSizeInGB
Optional
integer
monitoringScheduleConfig.monitoringJobDefinition.networkConfig
Optional
object
Networking options for a job, such as network traffic encryption between
containers, whether to allow inbound and outbound network calls to and from
containers, and the VPC subnets and security groups to use for VPC-enabled
jobs.
monitoringScheduleConfig.monitoringJobDefinition.networkConfig.enableInterContainerTrafficEncryption
Optional
boolean
monitoringScheduleConfig.monitoringJobDefinition.networkConfig.enableNetworkIsolation
Optional
boolean
monitoringScheduleConfig.monitoringJobDefinition.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).
monitoringScheduleConfig.monitoringJobDefinition.networkConfig.vpcConfig.securityGroupIDs
Optional
array
monitoringScheduleConfig.monitoringJobDefinition.networkConfig.vpcConfig.securityGroupIDs.[]
Required
string
monitoringScheduleConfig.monitoringJobDefinition.networkConfig.vpcConfig.subnets.[]
Required
string
monitoringScheduleConfig.monitoringJobDefinition.stoppingCondition
Optional
object
A time limit for how long the monitoring job is allowed to run before stopping.
monitoringScheduleConfig.monitoringJobDefinition.stoppingCondition.maxRuntimeInSeconds
Optional
integer
monitoringScheduleConfig.monitoringJobDefinitionName
Optional
string
monitoringScheduleConfig.monitoringType
Optional
string
monitoringScheduleConfig.scheduleConfig
Optional
object
Configuration details about the monitoring schedule.
monitoringScheduleConfig.scheduleConfig.dataAnalysisEndTime
Optional
string
monitoringScheduleConfig.scheduleConfig.dataAnalysisStartTime
Optional
string
monitoringScheduleConfig.scheduleConfig.scheduleExpression
Optional
string
monitoringScheduleName
Required
string
The name of the monitoring schedule. The name must be unique within an Amazon
Web Services Region within an Amazon Web Services account.
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
creationTime: string
failureReason: string
lastModifiedTime: string
lastMonitoringExecutionSummary: 
  creationTime: string
  endpointName: string
  failureReason: string
  lastModifiedTime: string
  monitoringExecutionStatus: string
  monitoringJobDefinitionName: string
  monitoringScheduleName: string
  monitoringType: string
  processingJobARN: string
  scheduledTime: string
monitoringScheduleStatus: 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.
TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse
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
creationTime
Optional
string
The time at which the monitoring job was created.
failureReason
Optional
string
A string, up to one KB in size, that contains the reason a monitoring job
failed, if it failed.
lastModifiedTime
Optional
string
The time at which the monitoring job was last modified.
lastMonitoringExecutionSummary
Optional
object
Describes metadata on the last execution to run, if there was one.
lastMonitoringExecutionSummary.creationTime
Optional
string
lastMonitoringExecutionSummary.endpointName
Optional
string
lastMonitoringExecutionSummary.failureReason
Optional
string
lastMonitoringExecutionSummary.lastModifiedTime
Optional
string
lastMonitoringExecutionSummary.monitoringExecutionStatus
Optional
string
lastMonitoringExecutionSummary.monitoringJobDefinitionName
Optional
string
lastMonitoringExecutionSummary.monitoringScheduleName
Optional
string
lastMonitoringExecutionSummary.monitoringType
Optional
string
lastMonitoringExecutionSummary.processingJobARN
Optional
string
lastMonitoringExecutionSummary.scheduledTime
Optional
string
monitoringScheduleStatus
Optional
string
The status of an monitoring job.