awscc.sagemaker_monitoringschedule¶
Filters¶
event
reduce
value
Actions¶
delete¶
Parent base class for filters and actions.
properties:
type:
enum:
- delete
required:
- type
Permissions - sagemaker:DeleteMonitoringSchedule, sagemaker:DescribeMonitoringSchedule
update¶
Parent base class for filters and actions.
definitions:
BaselineConfig:
additionalProperties: false
description: Baseline configuration used to validate that the data conforms to
the specified constraints and statistics.
properties:
ConstraintsResource:
additionalProperties: false
description: The baseline constraints resource for a monitoring job.
properties:
S3Uri:
description: The Amazon S3 URI.
maxLength: 1024
pattern: ^(https|s3)://([^/]+)/?(.*)$
type: string
type: object
StatisticsResource:
additionalProperties: false
description: The baseline statistics resource for a monitoring job.
properties:
S3Uri:
description: The Amazon S3 URI.
maxLength: 1024
pattern: ^(https|s3)://([^/]+)/?(.*)$
type: string
type: object
type: object
ClusterConfig:
additionalProperties: false
description: Configuration for the cluster used to run model monitoring jobs.
properties:
InstanceCount:
description: 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.
maximum: 100
minimum: 1
type: integer
InstanceType:
description: The ML compute instance type for the processing job.
type: string
VolumeKmsKeyId:
description: The AWS Key Management Service (AWS 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.
maximum: 2048
minimum: 1
type: string
VolumeSizeInGB:
description: The size of the ML storage volume, in gigabytes, that you want
to provision. You must specify sufficient ML storage for your scenario.
maximum: 16384
minimum: 1
type: integer
required:
- InstanceCount
- InstanceType
- VolumeSizeInGB
type: object
ConstraintsResource:
additionalProperties: false
description: The baseline constraints resource for a monitoring job.
properties:
S3Uri:
description: The Amazon S3 URI.
maxLength: 1024
pattern: ^(https|s3)://([^/]+)/?(.*)$
type: string
type: object
ContainerArgument:
additionalProperties: false
description: Arguments for the container used to run the monitoring job.
maxLength: 256
minLength: 1
type: string
EndpointInput:
additionalProperties: false
description: The endpoint for a monitoring job.
properties:
EndpointName:
description: The name of the endpoint used to run the monitoring job.
maxLength: 63
pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*
type: string
LocalPath:
description: Path to the filesystem where the endpoint data is available to
the container.
maxLength: 256
pattern: .*
type: string
S3DataDistributionType:
description: Whether input data distributed in Amazon S3 is fully replicated
or sharded by an S3 key. Defauts to FullyReplicated
enum:
- FullyReplicated
- ShardedByS3Key
type: string
S3InputMode:
description: Whether the Pipe or File is used as the input mode for transfering
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.
enum:
- Pipe
- File
type: string
required:
- EndpointName
- LocalPath
type: object
EndpointName:
description: The name of the endpoint used to run the monitoring job.
maxLength: 63
pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*
type: string
MonitoringAppSpecification:
additionalProperties: false
description: Container image configuration object for the monitoring job.
properties:
ContainerArguments:
description: An array of arguments for the container used to run the monitoring
job.
items:
additionalProperties: false
description: Arguments for the container used to run the monitoring job.
maxLength: 256
minLength: 1
type: string
maxItems: 50
type: array
ContainerEntrypoint:
description: Specifies the entrypoint for a container used to run the monitoring
job.
items:
maxLength: 256
minLength: 1
type: string
maxItems: 100
type: array
ImageUri:
description: The container image to be run by the monitoring job.
maxLength: 255
pattern: .*
type: string
PostAnalyticsProcessorSourceUri:
description: The Amazon S3 URI.
maxLength: 1024
pattern: ^(https|s3)://([^/]+)/?(.*)$
type: string
RecordPreprocessorSourceUri:
description: The Amazon S3 URI.
maxLength: 1024
pattern: ^(https|s3)://([^/]+)/?(.*)$
type: string
required:
- ImageUri
type: object
MonitoringExecutionSummary:
description: Summary of information about monitoring job
properties:
CreationTime:
description: The time at which the monitoring job was created.
type: string
EndpointName:
description: The name of the endpoint used to run the monitoring job.
maxLength: 63
pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*
type: string
FailureReason:
description: Contains the reason a monitoring job failed, if it failed.
maxLength: 1024
type: string
LastModifiedTime:
description: A timestamp that indicates the last time the monitoring job was
modified.
type: string
MonitoringExecutionStatus:
description: The status of the monitoring job.
enum:
- Pending
- Completed
- CompletedWithViolations
- InProgress
- Failed
- Stopping
- Stopped
type: string
MonitoringScheduleName:
description: The name of the monitoring schedule.
maxLength: 63
pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$
type: string
ProcessingJobArn:
description: The Amazon Resource Name (ARN) of the monitoring job.
maxLength: 256
pattern: aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:processing-job/.*
type: string
ScheduledTime:
description: The time the monitoring job was scheduled.
type: string
required:
- CreationTime
- LastModifiedTime
- MonitoringExecutionStatus
- MonitoringScheduleName
- ScheduledTime
type: object
MonitoringInput:
additionalProperties: false
description: The inputs for a monitoring job.
properties:
EndpointInput:
additionalProperties: false
description: The endpoint for a monitoring job.
properties:
EndpointName:
description: The name of the endpoint used to run the monitoring job.
maxLength: 63
pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*
type: string
LocalPath:
description: Path to the filesystem where the endpoint data is available
to the container.
maxLength: 256
pattern: .*
type: string
S3DataDistributionType:
description: Whether input data distributed in Amazon S3 is fully replicated
or sharded by an S3 key. Defauts to FullyReplicated
enum:
- FullyReplicated
- ShardedByS3Key
type: string
S3InputMode:
description: Whether the Pipe or File is used as the input mode for transfering
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.
enum:
- Pipe
- File
type: string
required:
- EndpointName
- LocalPath
type: object
required:
- EndpointInput
type: object
MonitoringInputs:
additionalProperties: false
description: The array of inputs for the monitoring job.
items:
additionalProperties: false
description: The inputs for a monitoring job.
properties:
EndpointInput:
additionalProperties: false
description: The endpoint for a monitoring job.
properties:
EndpointName:
description: The name of the endpoint used to run the monitoring job.
maxLength: 63
pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*
type: string
LocalPath:
description: Path to the filesystem where the endpoint data is available
to the container.
maxLength: 256
pattern: .*
type: string
S3DataDistributionType:
description: Whether input data distributed in Amazon S3 is fully replicated
or sharded by an S3 key. Defauts to FullyReplicated
enum:
- FullyReplicated
- ShardedByS3Key
type: string
S3InputMode:
description: Whether the Pipe or File is used as the input mode for
transfering 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.
enum:
- Pipe
- File
type: string
required:
- EndpointName
- LocalPath
type: object
required:
- EndpointInput
type: object
maxItems: 1
minItems: 1
type: array
MonitoringJobDefinition:
additionalProperties: false
description: Defines the monitoring job.
properties:
BaselineConfig:
additionalProperties: false
description: Baseline configuration used to validate that the data conforms
to the specified constraints and statistics.
properties:
ConstraintsResource:
additionalProperties: false
description: The baseline constraints resource for a monitoring job.
properties:
S3Uri:
description: The Amazon S3 URI.
maxLength: 1024
pattern: ^(https|s3)://([^/]+)/?(.*)$
type: string
type: object
StatisticsResource:
additionalProperties: false
description: The baseline statistics resource for a monitoring job.
properties:
S3Uri:
description: The Amazon S3 URI.
maxLength: 1024
pattern: ^(https|s3)://([^/]+)/?(.*)$
type: string
type: object
type: object
Environment:
description: Sets the environment variables in the Docker container
patternProperties:
'[\S\s]*':
maxLength: 256
type: string
'[a-zA-Z_][a-zA-Z0-9_]*':
maxLength: 256
minLength: 1
type: string
type: object
MonitoringAppSpecification:
additionalProperties: false
description: Container image configuration object for the monitoring job.
properties:
ContainerArguments:
description: An array of arguments for the container used to run the monitoring
job.
items:
additionalProperties: false
description: Arguments for the container used to run the monitoring
job.
maxLength: 256
minLength: 1
type: string
maxItems: 50
type: array
ContainerEntrypoint:
description: Specifies the entrypoint for a container used to run the
monitoring job.
items:
maxLength: 256
minLength: 1
type: string
maxItems: 100
type: array
ImageUri:
description: The container image to be run by the monitoring job.
maxLength: 255
pattern: .*
type: string
PostAnalyticsProcessorSourceUri:
description: The Amazon S3 URI.
maxLength: 1024
pattern: ^(https|s3)://([^/]+)/?(.*)$
type: string
RecordPreprocessorSourceUri:
description: The Amazon S3 URI.
maxLength: 1024
pattern: ^(https|s3)://([^/]+)/?(.*)$
type: string
required:
- ImageUri
type: object
MonitoringInputs:
additionalProperties: false
description: The array of inputs for the monitoring job.
items:
additionalProperties: false
description: The inputs for a monitoring job.
properties:
EndpointInput:
additionalProperties: false
description: The endpoint for a monitoring job.
properties:
EndpointName:
description: The name of the endpoint used to run the monitoring
job.
maxLength: 63
pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*
type: string
LocalPath:
description: Path to the filesystem where the endpoint data is available
to the container.
maxLength: 256
pattern: .*
type: string
S3DataDistributionType:
description: Whether input data distributed in Amazon S3 is fully
replicated or sharded by an S3 key. Defauts to FullyReplicated
enum:
- FullyReplicated
- ShardedByS3Key
type: string
S3InputMode:
description: Whether the Pipe or File is used as the input mode
for transfering 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.
enum:
- Pipe
- File
type: string
required:
- EndpointName
- LocalPath
type: object
required:
- EndpointInput
type: object
maxItems: 1
minItems: 1
type: array
MonitoringOutputConfig:
additionalProperties: false
description: The output configuration for monitoring jobs.
properties:
KmsKeyId:
description: The AWS Key Management Service (AWS KMS) key that Amazon
SageMaker uses to encrypt the model artifacts at rest using Amazon S3
server-side encryption.
maxLength: 2048
pattern: .*
type: string
MonitoringOutputs:
description: Monitoring outputs for monitoring jobs. This is where the
output of the periodic monitoring jobs is uploaded.
items:
additionalProperties: false
description: The output object for a monitoring job.
properties:
S3Output:
additionalProperties: false
description: Information about where and how to store the results
of a monitoring job.
properties:
LocalPath:
description: 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.
maxLength: 256
pattern: .*
type: string
S3UploadMode:
description: Whether to upload the results of the monitoring
job continuously or after the job completes.
enum:
- Continuous
- EndOfJob
type: string
S3Uri:
description: A URI that identifies the Amazon S3 storage location
where Amazon SageMaker saves the results of a monitoring job.
maxLength: 512
pattern: ^(https|s3)://([^/]+)/?(.*)$
type: string
required:
- LocalPath
- S3Uri
type: object
required:
- S3Output
type: object
maxLength: 1
minLength: 1
type: array
required:
- MonitoringOutputs
type: object
MonitoringResources:
additionalProperties: false
description: Identifies the resources to deploy for a monitoring job.
properties:
ClusterConfig:
additionalProperties: false
description: Configuration for the cluster used to run model monitoring
jobs.
properties:
InstanceCount:
description: 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.
maximum: 100
minimum: 1
type: integer
InstanceType:
description: The ML compute instance type for the processing job.
type: string
VolumeKmsKeyId:
description: The AWS Key Management Service (AWS 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.
maximum: 2048
minimum: 1
type: string
VolumeSizeInGB:
description: The size of the ML storage volume, in gigabytes, that
you want to provision. You must specify sufficient ML storage for
your scenario.
maximum: 16384
minimum: 1
type: integer
required:
- InstanceCount
- InstanceType
- VolumeSizeInGB
type: object
required:
- ClusterConfig
type: object
NetworkConfig:
additionalProperties: false
description: 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.
properties:
EnableInterContainerTrafficEncryption:
description: Whether to encrypt all communications between distributed
processing jobs. Choose True to encrypt communications. Encryption provides
greater security for distributed processing jobs, but the processing
might take longer.
type: boolean
EnableNetworkIsolation:
description: Whether to allow inbound and outbound network calls to and
from the containers used for the processing job.
type: boolean
VpcConfig:
additionalProperties: false
description: Specifies a VPC that your training jobs and hosted models
have access to. Control access to and from your training and model containers
by configuring the VPC.
properties:
SecurityGroupIds:
description: The VPC security group IDs, in the form sg-xxxxxxxx.
Specify the security groups for the VPC that is specified in the
Subnets field.
items:
maxLength: 32
pattern: '[-0-9a-zA-Z]+'
type: string
maxItems: 5
minItems: 1
type: array
Subnets:
description: The ID of the subnets in the VPC to which you want to
connect to your monitoring jobs.
items:
maxLength: 32
pattern: '[-0-9a-zA-Z]+'
type: string
maxItems: 16
minItems: 1
type: array
required:
- SecurityGroupIds
- Subnets
type: object
type: object
RoleArn:
description: The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker
can assume to perform tasks on your behalf.
maxLength: 2048
minLength: 20
pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$
type: string
StoppingCondition:
additionalProperties: false
description: Specifies a time limit for how long the monitoring job is allowed
to run.
properties:
MaxRuntimeInSeconds:
description: The maximum runtime allowed in seconds.
maximum: 86400
minimum: 1
type: integer
required:
- MaxRuntimeInSeconds
type: object
required:
- MonitoringAppSpecification
- MonitoringInputs
- MonitoringOutputConfig
- MonitoringResources
- RoleArn
type: object
MonitoringOutput:
additionalProperties: false
description: The output object for a monitoring job.
properties:
S3Output:
additionalProperties: false
description: Information about where and how to store the results of a monitoring
job.
properties:
LocalPath:
description: 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.
maxLength: 256
pattern: .*
type: string
S3UploadMode:
description: Whether to upload the results of the monitoring job continuously
or after the job completes.
enum:
- Continuous
- EndOfJob
type: string
S3Uri:
description: A URI that identifies the Amazon S3 storage location where
Amazon SageMaker saves the results of a monitoring job.
maxLength: 512
pattern: ^(https|s3)://([^/]+)/?(.*)$
type: string
required:
- LocalPath
- S3Uri
type: object
required:
- S3Output
type: object
MonitoringOutputConfig:
additionalProperties: false
description: The output configuration for monitoring jobs.
properties:
KmsKeyId:
description: The AWS Key Management Service (AWS KMS) key that Amazon SageMaker
uses to encrypt the model artifacts at rest using Amazon S3 server-side
encryption.
maxLength: 2048
pattern: .*
type: string
MonitoringOutputs:
description: Monitoring outputs for monitoring jobs. This is where the output
of the periodic monitoring jobs is uploaded.
items:
additionalProperties: false
description: The output object for a monitoring job.
properties:
S3Output:
additionalProperties: false
description: Information about where and how to store the results of
a monitoring job.
properties:
LocalPath:
description: 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.
maxLength: 256
pattern: .*
type: string
S3UploadMode:
description: Whether to upload the results of the monitoring job
continuously or after the job completes.
enum:
- Continuous
- EndOfJob
type: string
S3Uri:
description: A URI that identifies the Amazon S3 storage location
where Amazon SageMaker saves the results of a monitoring job.
maxLength: 512
pattern: ^(https|s3)://([^/]+)/?(.*)$
type: string
required:
- LocalPath
- S3Uri
type: object
required:
- S3Output
type: object
maxLength: 1
minLength: 1
type: array
required:
- MonitoringOutputs
type: object
MonitoringResources:
additionalProperties: false
description: Identifies the resources to deploy for a monitoring job.
properties:
ClusterConfig:
additionalProperties: false
description: Configuration for the cluster used to run model monitoring jobs.
properties:
InstanceCount:
description: 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.
maximum: 100
minimum: 1
type: integer
InstanceType:
description: The ML compute instance type for the processing job.
type: string
VolumeKmsKeyId:
description: The AWS Key Management Service (AWS 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.
maximum: 2048
minimum: 1
type: string
VolumeSizeInGB:
description: The size of the ML storage volume, in gigabytes, that you
want to provision. You must specify sufficient ML storage for your scenario.
maximum: 16384
minimum: 1
type: integer
required:
- InstanceCount
- InstanceType
- VolumeSizeInGB
type: object
required:
- ClusterConfig
type: object
MonitoringScheduleConfig:
additionalProperties: false
description: The configuration object that specifies the monitoring schedule and
defines the monitoring job.
properties:
MonitoringJobDefinition:
additionalProperties: false
description: Defines the monitoring job.
properties:
BaselineConfig:
additionalProperties: false
description: Baseline configuration used to validate that the data conforms
to the specified constraints and statistics.
properties:
ConstraintsResource:
additionalProperties: false
description: The baseline constraints resource for a monitoring job.
properties:
S3Uri:
description: The Amazon S3 URI.
maxLength: 1024
pattern: ^(https|s3)://([^/]+)/?(.*)$
type: string
type: object
StatisticsResource:
additionalProperties: false
description: The baseline statistics resource for a monitoring job.
properties:
S3Uri:
description: The Amazon S3 URI.
maxLength: 1024
pattern: ^(https|s3)://([^/]+)/?(.*)$
type: string
type: object
type: object
Environment:
description: Sets the environment variables in the Docker container
patternProperties:
'[\S\s]*':
maxLength: 256
type: string
'[a-zA-Z_][a-zA-Z0-9_]*':
maxLength: 256
minLength: 1
type: string
type: object
MonitoringAppSpecification:
additionalProperties: false
description: Container image configuration object for the monitoring job.
properties:
ContainerArguments:
description: An array of arguments for the container used to run the
monitoring job.
items:
additionalProperties: false
description: Arguments for the container used to run the monitoring
job.
maxLength: 256
minLength: 1
type: string
maxItems: 50
type: array
ContainerEntrypoint:
description: Specifies the entrypoint for a container used to run
the monitoring job.
items:
maxLength: 256
minLength: 1
type: string
maxItems: 100
type: array
ImageUri:
description: The container image to be run by the monitoring job.
maxLength: 255
pattern: .*
type: string
PostAnalyticsProcessorSourceUri:
description: The Amazon S3 URI.
maxLength: 1024
pattern: ^(https|s3)://([^/]+)/?(.*)$
type: string
RecordPreprocessorSourceUri:
description: The Amazon S3 URI.
maxLength: 1024
pattern: ^(https|s3)://([^/]+)/?(.*)$
type: string
required:
- ImageUri
type: object
MonitoringInputs:
additionalProperties: false
description: The array of inputs for the monitoring job.
items:
additionalProperties: false
description: The inputs for a monitoring job.
properties:
EndpointInput:
additionalProperties: false
description: The endpoint for a monitoring job.
properties:
EndpointName:
description: The name of the endpoint used to run the monitoring
job.
maxLength: 63
pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*
type: string
LocalPath:
description: Path to the filesystem where the endpoint data
is available to the container.
maxLength: 256
pattern: .*
type: string
S3DataDistributionType:
description: Whether input data distributed in Amazon S3 is
fully replicated or sharded by an S3 key. Defauts to FullyReplicated
enum:
- FullyReplicated
- ShardedByS3Key
type: string
S3InputMode:
description: Whether the Pipe or File is used as the input mode
for transfering 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.
enum:
- Pipe
- File
type: string
required:
- EndpointName
- LocalPath
type: object
required:
- EndpointInput
type: object
maxItems: 1
minItems: 1
type: array
MonitoringOutputConfig:
additionalProperties: false
description: The output configuration for monitoring jobs.
properties:
KmsKeyId:
description: The AWS Key Management Service (AWS KMS) key that Amazon
SageMaker uses to encrypt the model artifacts at rest using Amazon
S3 server-side encryption.
maxLength: 2048
pattern: .*
type: string
MonitoringOutputs:
description: Monitoring outputs for monitoring jobs. This is where
the output of the periodic monitoring jobs is uploaded.
items:
additionalProperties: false
description: The output object for a monitoring job.
properties:
S3Output:
additionalProperties: false
description: Information about where and how to store the results
of a monitoring job.
properties:
LocalPath:
description: 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.
maxLength: 256
pattern: .*
type: string
S3UploadMode:
description: Whether to upload the results of the monitoring
job continuously or after the job completes.
enum:
- Continuous
- EndOfJob
type: string
S3Uri:
description: A URI that identifies the Amazon S3 storage
location where Amazon SageMaker saves the results of a
monitoring job.
maxLength: 512
pattern: ^(https|s3)://([^/]+)/?(.*)$
type: string
required:
- LocalPath
- S3Uri
type: object
required:
- S3Output
type: object
maxLength: 1
minLength: 1
type: array
required:
- MonitoringOutputs
type: object
MonitoringResources:
additionalProperties: false
description: Identifies the resources to deploy for a monitoring job.
properties:
ClusterConfig:
additionalProperties: false
description: Configuration for the cluster used to run model monitoring
jobs.
properties:
InstanceCount:
description: 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.
maximum: 100
minimum: 1
type: integer
InstanceType:
description: The ML compute instance type for the processing job.
type: string
VolumeKmsKeyId:
description: The AWS Key Management Service (AWS 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.
maximum: 2048
minimum: 1
type: string
VolumeSizeInGB:
description: The size of the ML storage volume, in gigabytes,
that you want to provision. You must specify sufficient ML storage
for your scenario.
maximum: 16384
minimum: 1
type: integer
required:
- InstanceCount
- InstanceType
- VolumeSizeInGB
type: object
required:
- ClusterConfig
type: object
NetworkConfig:
additionalProperties: false
description: 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.
properties:
EnableInterContainerTrafficEncryption:
description: Whether to encrypt all communications between distributed
processing jobs. Choose True to encrypt communications. Encryption
provides greater security for distributed processing jobs, but the
processing might take longer.
type: boolean
EnableNetworkIsolation:
description: Whether to allow inbound and outbound network calls to
and from the containers used for the processing job.
type: boolean
VpcConfig:
additionalProperties: false
description: Specifies a VPC that your training jobs and hosted models
have access to. Control access to and from your training and model
containers by configuring the VPC.
properties:
SecurityGroupIds:
description: The VPC security group IDs, in the form sg-xxxxxxxx.
Specify the security groups for the VPC that is specified in
the Subnets field.
items:
maxLength: 32
pattern: '[-0-9a-zA-Z]+'
type: string
maxItems: 5
minItems: 1
type: array
Subnets:
description: The ID of the subnets in the VPC to which you want
to connect to your monitoring jobs.
items:
maxLength: 32
pattern: '[-0-9a-zA-Z]+'
type: string
maxItems: 16
minItems: 1
type: array
required:
- SecurityGroupIds
- Subnets
type: object
type: object
RoleArn:
description: The Amazon Resource Name (ARN) of an IAM role that Amazon
SageMaker can assume to perform tasks on your behalf.
maxLength: 2048
minLength: 20
pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$
type: string
StoppingCondition:
additionalProperties: false
description: Specifies a time limit for how long the monitoring job is
allowed to run.
properties:
MaxRuntimeInSeconds:
description: The maximum runtime allowed in seconds.
maximum: 86400
minimum: 1
type: integer
required:
- MaxRuntimeInSeconds
type: object
required:
- MonitoringAppSpecification
- MonitoringInputs
- MonitoringOutputConfig
- MonitoringResources
- RoleArn
type: object
MonitoringJobDefinitionName:
description: Name of the job definition
maxLength: 63
minLength: 1
pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$
type: string
MonitoringType:
description: The type of monitoring job.
enum:
- DataQuality
- ModelQuality
- ModelBias
- ModelExplainability
type: string
ScheduleConfig:
additionalProperties: false
description: Configuration details about the monitoring schedule.
properties:
ScheduleExpression:
description: A cron expression that describes details about the monitoring
schedule.
maxLength: 256
minLength: 1
type: string
required:
- ScheduleExpression
type: object
type: object
MonitoringScheduleName:
description: The name of the monitoring schedule.
maxLength: 63
pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$
type: string
MonitoringType:
description: The type of monitoring job.
enum:
- DataQuality
- ModelQuality
- ModelBias
- ModelExplainability
type: string
NetworkConfig:
additionalProperties: false
description: 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.
properties:
EnableInterContainerTrafficEncryption:
description: Whether to encrypt all communications between distributed processing
jobs. Choose True to encrypt communications. Encryption provides greater
security for distributed processing jobs, but the processing might take
longer.
type: boolean
EnableNetworkIsolation:
description: Whether to allow inbound and outbound network calls to and from
the containers used for the processing job.
type: boolean
VpcConfig:
additionalProperties: false
description: Specifies a VPC that your training jobs and hosted models have
access to. Control access to and from your training and model containers
by configuring the VPC.
properties:
SecurityGroupIds:
description: The VPC security group IDs, in the form sg-xxxxxxxx. Specify
the security groups for the VPC that is specified in the Subnets field.
items:
maxLength: 32
pattern: '[-0-9a-zA-Z]+'
type: string
maxItems: 5
minItems: 1
type: array
Subnets:
description: The ID of the subnets in the VPC to which you want to connect
to your monitoring jobs.
items:
maxLength: 32
pattern: '[-0-9a-zA-Z]+'
type: string
maxItems: 16
minItems: 1
type: array
required:
- SecurityGroupIds
- Subnets
type: object
type: object
S3Output:
additionalProperties: false
description: Information about where and how to store the results of a monitoring
job.
properties:
LocalPath:
description: 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.
maxLength: 256
pattern: .*
type: string
S3UploadMode:
description: Whether to upload the results of the monitoring job continuously
or after the job completes.
enum:
- Continuous
- EndOfJob
type: string
S3Uri:
description: A URI that identifies the Amazon S3 storage location where Amazon
SageMaker saves the results of a monitoring job.
maxLength: 512
pattern: ^(https|s3)://([^/]+)/?(.*)$
type: string
required:
- LocalPath
- S3Uri
type: object
S3Uri:
description: The Amazon S3 URI.
maxLength: 1024
pattern: ^(https|s3)://([^/]+)/?(.*)$
type: string
ScheduleConfig:
additionalProperties: false
description: Configuration details about the monitoring schedule.
properties:
ScheduleExpression:
description: A cron expression that describes details about the monitoring
schedule.
maxLength: 256
minLength: 1
type: string
required:
- ScheduleExpression
type: object
StatisticsResource:
additionalProperties: false
description: The baseline statistics resource for a monitoring job.
properties:
S3Uri:
description: The Amazon S3 URI.
maxLength: 1024
pattern: ^(https|s3)://([^/]+)/?(.*)$
type: string
type: object
StoppingCondition:
additionalProperties: false
description: Specifies a time limit for how long the monitoring job is allowed
to run.
properties:
MaxRuntimeInSeconds:
description: The maximum runtime allowed in seconds.
maximum: 86400
minimum: 1
type: integer
required:
- MaxRuntimeInSeconds
type: object
Tag:
description: A key-value pair to associate with a resource.
properties:
Key:
description: 'The key name of the tag. You can specify a value that is 1 to
127 Unicode characters in length and cannot be prefixed with aws:. You can
use any of the following characters: the set of Unicode letters, digits,
whitespace, _, ., /, =, +, and -. '
maxLength: 128
minLength: 1
pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
type: string
Value:
description: 'The value for the tag. You can specify a value that is 1 to
255 Unicode characters in length and cannot be prefixed with aws:. You can
use any of the following characters: the set of Unicode letters, digits,
whitespace, _, ., /, =, +, and -. '
maxLength: 256
pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
type: string
required:
- Key
- Value
type: object
VpcConfig:
additionalProperties: false
description: Specifies a VPC that your training jobs and hosted models have access
to. Control access to and from your training and model containers by configuring
the VPC.
properties:
SecurityGroupIds:
description: The VPC security group IDs, in the form sg-xxxxxxxx. Specify
the security groups for the VPC that is specified in the Subnets field.
items:
maxLength: 32
pattern: '[-0-9a-zA-Z]+'
type: string
maxItems: 5
minItems: 1
type: array
Subnets:
description: The ID of the subnets in the VPC to which you want to connect
to your monitoring jobs.
items:
maxLength: 32
pattern: '[-0-9a-zA-Z]+'
type: string
maxItems: 16
minItems: 1
type: array
required:
- SecurityGroupIds
- Subnets
type: object
properties:
EndpointName:
description: The name of the endpoint used to run the monitoring job.
maxLength: 63
pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*
type: string
FailureReason:
description: Contains the reason a monitoring job failed, if it failed.
maxLength: 1024
minLength: 1
type: string
LastMonitoringExecutionSummary:
description: Summary of information about monitoring job
properties:
CreationTime:
description: The time at which the monitoring job was created.
type: string
EndpointName:
description: The name of the endpoint used to run the monitoring job.
maxLength: 63
pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*
type: string
FailureReason:
description: Contains the reason a monitoring job failed, if it failed.
maxLength: 1024
type: string
LastModifiedTime:
description: A timestamp that indicates the last time the monitoring job was
modified.
type: string
MonitoringExecutionStatus:
description: The status of the monitoring job.
enum:
- Pending
- Completed
- CompletedWithViolations
- InProgress
- Failed
- Stopping
- Stopped
type: string
MonitoringScheduleName:
description: The name of the monitoring schedule.
maxLength: 63
pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$
type: string
ProcessingJobArn:
description: The Amazon Resource Name (ARN) of the monitoring job.
maxLength: 256
pattern: aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:processing-job/.*
type: string
ScheduledTime:
description: The time the monitoring job was scheduled.
type: string
required:
- CreationTime
- LastModifiedTime
- MonitoringExecutionStatus
- MonitoringScheduleName
- ScheduledTime
type: object
MonitoringScheduleConfig:
additionalProperties: false
description: The configuration object that specifies the monitoring schedule and
defines the monitoring job.
properties:
MonitoringJobDefinition:
additionalProperties: false
description: Defines the monitoring job.
properties:
BaselineConfig:
additionalProperties: false
description: Baseline configuration used to validate that the data conforms
to the specified constraints and statistics.
properties:
ConstraintsResource:
additionalProperties: false
description: The baseline constraints resource for a monitoring job.
properties:
S3Uri:
description: The Amazon S3 URI.
maxLength: 1024
pattern: ^(https|s3)://([^/]+)/?(.*)$
type: string
type: object
StatisticsResource:
additionalProperties: false
description: The baseline statistics resource for a monitoring job.
properties:
S3Uri:
description: The Amazon S3 URI.
maxLength: 1024
pattern: ^(https|s3)://([^/]+)/?(.*)$
type: string
type: object
type: object
Environment:
description: Sets the environment variables in the Docker container
patternProperties:
'[\S\s]*':
maxLength: 256
type: string
'[a-zA-Z_][a-zA-Z0-9_]*':
maxLength: 256
minLength: 1
type: string
type: object
MonitoringAppSpecification:
additionalProperties: false
description: Container image configuration object for the monitoring job.
properties:
ContainerArguments:
description: An array of arguments for the container used to run the
monitoring job.
items:
additionalProperties: false
description: Arguments for the container used to run the monitoring
job.
maxLength: 256
minLength: 1
type: string
maxItems: 50
type: array
ContainerEntrypoint:
description: Specifies the entrypoint for a container used to run
the monitoring job.
items:
maxLength: 256
minLength: 1
type: string
maxItems: 100
type: array
ImageUri:
description: The container image to be run by the monitoring job.
maxLength: 255
pattern: .*
type: string
PostAnalyticsProcessorSourceUri:
description: The Amazon S3 URI.
maxLength: 1024
pattern: ^(https|s3)://([^/]+)/?(.*)$
type: string
RecordPreprocessorSourceUri:
description: The Amazon S3 URI.
maxLength: 1024
pattern: ^(https|s3)://([^/]+)/?(.*)$
type: string
required:
- ImageUri
type: object
MonitoringInputs:
additionalProperties: false
description: The array of inputs for the monitoring job.
items:
additionalProperties: false
description: The inputs for a monitoring job.
properties:
EndpointInput:
additionalProperties: false
description: The endpoint for a monitoring job.
properties:
EndpointName:
description: The name of the endpoint used to run the monitoring
job.
maxLength: 63
pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*
type: string
LocalPath:
description: Path to the filesystem where the endpoint data
is available to the container.
maxLength: 256
pattern: .*
type: string
S3DataDistributionType:
description: Whether input data distributed in Amazon S3 is
fully replicated or sharded by an S3 key. Defauts to FullyReplicated
enum:
- FullyReplicated
- ShardedByS3Key
type: string
S3InputMode:
description: Whether the Pipe or File is used as the input mode
for transfering 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.
enum:
- Pipe
- File
type: string
required:
- EndpointName
- LocalPath
type: object
required:
- EndpointInput
type: object
maxItems: 1
minItems: 1
type: array
MonitoringOutputConfig:
additionalProperties: false
description: The output configuration for monitoring jobs.
properties:
KmsKeyId:
description: The AWS Key Management Service (AWS KMS) key that Amazon
SageMaker uses to encrypt the model artifacts at rest using Amazon
S3 server-side encryption.
maxLength: 2048
pattern: .*
type: string
MonitoringOutputs:
description: Monitoring outputs for monitoring jobs. This is where
the output of the periodic monitoring jobs is uploaded.
items:
additionalProperties: false
description: The output object for a monitoring job.
properties:
S3Output:
additionalProperties: false
description: Information about where and how to store the results
of a monitoring job.
properties:
LocalPath:
description: 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.
maxLength: 256
pattern: .*
type: string
S3UploadMode:
description: Whether to upload the results of the monitoring
job continuously or after the job completes.
enum:
- Continuous
- EndOfJob
type: string
S3Uri:
description: A URI that identifies the Amazon S3 storage
location where Amazon SageMaker saves the results of a
monitoring job.
maxLength: 512
pattern: ^(https|s3)://([^/]+)/?(.*)$
type: string
required:
- LocalPath
- S3Uri
type: object
required:
- S3Output
type: object
maxLength: 1
minLength: 1
type: array
required:
- MonitoringOutputs
type: object
MonitoringResources:
additionalProperties: false
description: Identifies the resources to deploy for a monitoring job.
properties:
ClusterConfig:
additionalProperties: false
description: Configuration for the cluster used to run model monitoring
jobs.
properties:
InstanceCount:
description: 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.
maximum: 100
minimum: 1
type: integer
InstanceType:
description: The ML compute instance type for the processing job.
type: string
VolumeKmsKeyId:
description: The AWS Key Management Service (AWS 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.
maximum: 2048
minimum: 1
type: string
VolumeSizeInGB:
description: The size of the ML storage volume, in gigabytes,
that you want to provision. You must specify sufficient ML storage
for your scenario.
maximum: 16384
minimum: 1
type: integer
required:
- InstanceCount
- InstanceType
- VolumeSizeInGB
type: object
required:
- ClusterConfig
type: object
NetworkConfig:
additionalProperties: false
description: 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.
properties:
EnableInterContainerTrafficEncryption:
description: Whether to encrypt all communications between distributed
processing jobs. Choose True to encrypt communications. Encryption
provides greater security for distributed processing jobs, but the
processing might take longer.
type: boolean
EnableNetworkIsolation:
description: Whether to allow inbound and outbound network calls to
and from the containers used for the processing job.
type: boolean
VpcConfig:
additionalProperties: false
description: Specifies a VPC that your training jobs and hosted models
have access to. Control access to and from your training and model
containers by configuring the VPC.
properties:
SecurityGroupIds:
description: The VPC security group IDs, in the form sg-xxxxxxxx.
Specify the security groups for the VPC that is specified in
the Subnets field.
items:
maxLength: 32
pattern: '[-0-9a-zA-Z]+'
type: string
maxItems: 5
minItems: 1
type: array
Subnets:
description: The ID of the subnets in the VPC to which you want
to connect to your monitoring jobs.
items:
maxLength: 32
pattern: '[-0-9a-zA-Z]+'
type: string
maxItems: 16
minItems: 1
type: array
required:
- SecurityGroupIds
- Subnets
type: object
type: object
RoleArn:
description: The Amazon Resource Name (ARN) of an IAM role that Amazon
SageMaker can assume to perform tasks on your behalf.
maxLength: 2048
minLength: 20
pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$
type: string
StoppingCondition:
additionalProperties: false
description: Specifies a time limit for how long the monitoring job is
allowed to run.
properties:
MaxRuntimeInSeconds:
description: The maximum runtime allowed in seconds.
maximum: 86400
minimum: 1
type: integer
required:
- MaxRuntimeInSeconds
type: object
required:
- MonitoringAppSpecification
- MonitoringInputs
- MonitoringOutputConfig
- MonitoringResources
- RoleArn
type: object
MonitoringJobDefinitionName:
description: Name of the job definition
maxLength: 63
minLength: 1
pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$
type: string
MonitoringType:
description: The type of monitoring job.
enum:
- DataQuality
- ModelQuality
- ModelBias
- ModelExplainability
type: string
ScheduleConfig:
additionalProperties: false
description: Configuration details about the monitoring schedule.
properties:
ScheduleExpression:
description: A cron expression that describes details about the monitoring
schedule.
maxLength: 256
minLength: 1
type: string
required:
- ScheduleExpression
type: object
type: object
MonitoringScheduleStatus:
description: The status of a schedule job.
enum:
- Pending
- Failed
- Scheduled
- Stopped
type: string
Tags:
description: An array of key-value pairs to apply to this resource.
items:
description: A key-value pair to associate with a resource.
properties:
Key:
description: 'The key name of the tag. You can specify a value that is 1
to 127 Unicode characters in length and cannot be prefixed with aws:.
You can use any of the following characters: the set of Unicode letters,
digits, whitespace, _, ., /, =, +, and -. '
maxLength: 128
minLength: 1
pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
type: string
Value:
description: 'The value for the tag. You can specify a value that is 1 to
255 Unicode characters in length and cannot be prefixed with aws:. You
can use any of the following characters: the set of Unicode letters, digits,
whitespace, _, ., /, =, +, and -. '
maxLength: 256
pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
type: string
required:
- Key
- Value
type: object
maxItems: 50
type: array
type:
enum:
- update
Permissions - sagemaker:UpdateMonitoringSchedule, sagemaker:DescribeMonitoringSchedule