monitoring_schedules

Creates, updates, deletes or gets a monitoring_schedule resource or lists monitoring_schedules in a region

Overview

Name	monitoring_schedules
Type	Resource
Description	Resource Type definition for AWS::SageMaker::MonitoringSchedule
Id	aws.sagemaker.monitoring_schedules

Fields

Name	Datatype	Description
monitoring_schedule_arn	string	The Amazon Resource Name (ARN) of the monitoring schedule.
monitoring_schedule_name	string	The name of the monitoring schedule.
monitoring_schedule_config	object	The configuration object that specifies the monitoring schedule and defines the monitoring job.
tags	array	An array of key-value pairs to apply to this resource.
creation_time	string	The time at which the schedule was created.
endpoint_name	string	The name of the endpoint used to run the monitoring job.
failure_reason	string	Contains the reason a monitoring job failed, if it failed.
last_modified_time	string	A timestamp that indicates the last time the monitoring job was modified.
last_monitoring_execution_summary	object	Describes metadata on the last execution to run, if there was one.
monitoring_schedule_status	string	The status of a schedule job.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	MonitoringScheduleConfig, MonitoringScheduleName, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all monitoring_schedules in a region.

SELECT
region,
monitoring_schedule_arn,
monitoring_schedule_name,
monitoring_schedule_config,
tags,
creation_time,
endpoint_name,
failure_reason,
last_modified_time,
last_monitoring_execution_summary,
monitoring_schedule_status
FROM aws.sagemaker.monitoring_schedules
WHERE region = 'us-east-1';

Gets all properties from an individual monitoring_schedule.

SELECT
region,
monitoring_schedule_arn,
monitoring_schedule_name,
monitoring_schedule_config,
tags,
creation_time,
endpoint_name,
failure_reason,
last_modified_time,
last_monitoring_execution_summary,
monitoring_schedule_status
FROM aws.sagemaker.monitoring_schedules
WHERE region = 'us-east-1' AND data__Identifier = '<MonitoringScheduleArn>';

INSERT example

Use the following StackQL query and manifest file to create a new monitoring_schedule resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.sagemaker.monitoring_schedules (
 MonitoringScheduleName,
 MonitoringScheduleConfig,
 region
)
SELECT 
'{{ MonitoringScheduleName }}',
 '{{ MonitoringScheduleConfig }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.sagemaker.monitoring_schedules (
 MonitoringScheduleName,
 MonitoringScheduleConfig,
 Tags,
 EndpointName,
 FailureReason,
 LastMonitoringExecutionSummary,
 MonitoringScheduleStatus,
 region
)
SELECT 
 '{{ MonitoringScheduleName }}',
 '{{ MonitoringScheduleConfig }}',
 '{{ Tags }}',
 '{{ EndpointName }}',
 '{{ FailureReason }}',
 '{{ LastMonitoringExecutionSummary }}',
 '{{ MonitoringScheduleStatus }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: monitoring_schedule
    props:
      - name: MonitoringScheduleName
        value: '{{ MonitoringScheduleName }}'
      - name: MonitoringScheduleConfig
        value:
          MonitoringJobDefinition:
            BaselineConfig:
              ConstraintsResource:
                S3Uri: '{{ S3Uri }}'
              StatisticsResource:
                S3Uri: null
            Environment: {}
            MonitoringAppSpecification:
              ContainerArguments:
                - '{{ ContainerArguments[0] }}'
              ContainerEntrypoint:
                - '{{ ContainerEntrypoint[0] }}'
              ImageUri: '{{ ImageUri }}'
              PostAnalyticsProcessorSourceUri: null
              RecordPreprocessorSourceUri: null
            MonitoringInputs:
              - EndpointInput:
                  EndpointName: '{{ EndpointName }}'
                  LocalPath: '{{ LocalPath }}'
                  S3DataDistributionType: '{{ S3DataDistributionType }}'
                  S3InputMode: '{{ S3InputMode }}'
                  ExcludeFeaturesAttribute: '{{ ExcludeFeaturesAttribute }}'
                BatchTransformInput:
                  DataCapturedDestinationS3Uri: '{{ DataCapturedDestinationS3Uri }}'
                  DatasetFormat:
                    Csv:
                      Header: '{{ Header }}'
                    Json:
                      Line: '{{ Line }}'
                    Parquet: '{{ Parquet }}'
                  LocalPath: '{{ LocalPath }}'
                  S3DataDistributionType: '{{ S3DataDistributionType }}'
                  S3InputMode: '{{ S3InputMode }}'
                  ExcludeFeaturesAttribute: '{{ ExcludeFeaturesAttribute }}'
            MonitoringOutputConfig:
              KmsKeyId: '{{ KmsKeyId }}'
              MonitoringOutputs:
                - S3Output:
                    LocalPath: '{{ LocalPath }}'
                    S3UploadMode: '{{ S3UploadMode }}'
                    S3Uri: '{{ S3Uri }}'
            MonitoringResources:
              ClusterConfig:
                InstanceCount: '{{ InstanceCount }}'
                InstanceType: '{{ InstanceType }}'
                VolumeKmsKeyId: '{{ VolumeKmsKeyId }}'
                VolumeSizeInGB: '{{ VolumeSizeInGB }}'
            NetworkConfig:
              EnableInterContainerTrafficEncryption: '{{ EnableInterContainerTrafficEncryption }}'
              EnableNetworkIsolation: '{{ EnableNetworkIsolation }}'
              VpcConfig:
                SecurityGroupIds:
                  - '{{ SecurityGroupIds[0] }}'
                Subnets:
                  - '{{ Subnets[0] }}'
            RoleArn: '{{ RoleArn }}'
            StoppingCondition:
              MaxRuntimeInSeconds: '{{ MaxRuntimeInSeconds }}'
          MonitoringJobDefinitionName: '{{ MonitoringJobDefinitionName }}'
          MonitoringType: '{{ MonitoringType }}'
          ScheduleConfig:
            ScheduleExpression: '{{ ScheduleExpression }}'
            DataAnalysisStartTime: '{{ DataAnalysisStartTime }}'
            DataAnalysisEndTime: null
      - name: Tags
        value:
          - Value: '{{ Value }}'
            Key: '{{ Key }}'
      - name: EndpointName
        value: null
      - name: FailureReason
        value: '{{ FailureReason }}'
      - name: LastMonitoringExecutionSummary
        value:
          CreationTime: '{{ CreationTime }}'
          EndpointName: null
          FailureReason: '{{ FailureReason }}'
          LastModifiedTime: '{{ LastModifiedTime }}'
          MonitoringExecutionStatus: '{{ MonitoringExecutionStatus }}'
          MonitoringScheduleName: null
          ProcessingJobArn: '{{ ProcessingJobArn }}'
          ScheduledTime: '{{ ScheduledTime }}'
      - name: MonitoringScheduleStatus
        value: '{{ MonitoringScheduleStatus }}'

DELETE example

/*+ delete */
DELETE FROM aws.sagemaker.monitoring_schedules
WHERE data__Identifier = '<MonitoringScheduleArn>'
AND region = 'us-east-1';

Permissions

To operate on the monitoring_schedules resource, the following permissions are required:

Create

sagemaker:CreateMonitoringSchedule,
sagemaker:DescribeMonitoringSchedule,
iam:PassRole

Delete

sagemaker:DeleteMonitoringSchedule,
sagemaker:DescribeMonitoringSchedule

List

sagemaker:ListMonitoringSchedule

Read

sagemaker:DescribeMonitoringSchedule

Update

sagemaker:UpdateMonitoringSchedule,
sagemaker:DescribeMonitoringSchedule