Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . sagemaker ]

create-monitoring-schedule

Description

Creates a schedule that regularly starts Amazon SageMaker Processing Jobs to monitor the data captured for an Amazon SageMaker Endoint.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-monitoring-schedule
--monitoring-schedule-name <value>
--monitoring-schedule-config <value>
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--monitoring-schedule-name (string)

The name of the monitoring schedule. The name must be unique within an AWS Region within an AWS account.

--monitoring-schedule-config (structure)

The configuration object that specifies the monitoring schedule and defines the monitoring job.

JSON Syntax:

{
  "ScheduleConfig": {
    "ScheduleExpression": "string"
  },
  "MonitoringJobDefinition": {
    "BaselineConfig": {
      "ConstraintsResource": {
        "S3Uri": "string"
      },
      "StatisticsResource": {
        "S3Uri": "string"
      }
    },
    "MonitoringInputs": [
      {
        "EndpointInput": {
          "EndpointName": "string",
          "LocalPath": "string",
          "S3InputMode": "Pipe"|"File",
          "S3DataDistributionType": "FullyReplicated"|"ShardedByS3Key"
        }
      }
      ...
    ],
    "MonitoringOutputConfig": {
      "MonitoringOutputs": [
        {
          "S3Output": {
            "S3Uri": "string",
            "LocalPath": "string",
            "S3UploadMode": "Continuous"|"EndOfJob"
          }
        }
        ...
      ],
      "KmsKeyId": "string"
    },
    "MonitoringResources": {
      "ClusterConfig": {
        "InstanceCount": integer,
        "InstanceType": "ml.t3.medium"|"ml.t3.large"|"ml.t3.xlarge"|"ml.t3.2xlarge"|"ml.m4.xlarge"|"ml.m4.2xlarge"|"ml.m4.4xlarge"|"ml.m4.10xlarge"|"ml.m4.16xlarge"|"ml.c4.xlarge"|"ml.c4.2xlarge"|"ml.c4.4xlarge"|"ml.c4.8xlarge"|"ml.p2.xlarge"|"ml.p2.8xlarge"|"ml.p2.16xlarge"|"ml.p3.2xlarge"|"ml.p3.8xlarge"|"ml.p3.16xlarge"|"ml.c5.xlarge"|"ml.c5.2xlarge"|"ml.c5.4xlarge"|"ml.c5.9xlarge"|"ml.c5.18xlarge"|"ml.m5.large"|"ml.m5.xlarge"|"ml.m5.2xlarge"|"ml.m5.4xlarge"|"ml.m5.12xlarge"|"ml.m5.24xlarge"|"ml.r5.large"|"ml.r5.xlarge"|"ml.r5.2xlarge"|"ml.r5.4xlarge"|"ml.r5.8xlarge"|"ml.r5.12xlarge"|"ml.r5.16xlarge"|"ml.r5.24xlarge",
        "VolumeSizeInGB": integer,
        "VolumeKmsKeyId": "string"
      }
    },
    "MonitoringAppSpecification": {
      "ImageUri": "string",
      "ContainerEntrypoint": ["string", ...],
      "ContainerArguments": ["string", ...],
      "RecordPreprocessorSourceUri": "string",
      "PostAnalyticsProcessorSourceUri": "string"
    },
    "StoppingCondition": {
      "MaxRuntimeInSeconds": integer
    },
    "Environment": {"string": "string"
      ...},
    "NetworkConfig": {
      "EnableNetworkIsolation": true|false,
      "VpcConfig": {
        "SecurityGroupIds": ["string", ...],
        "Subnets": ["string", ...]
      }
    },
    "RoleArn": "string"
  }
}

--tags (list)

(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 AWS Billing and Cost Management User Guide .

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

MonitoringScheduleArn -> (string)

The Amazon Resource Name (ARN) of the monitoring schedule.