@propulsionworks/cloudformation 0.0.2 → 0.1.1

package/out/exports/resources.generated/aws-sagemaker-monitoringschedule.d.ts

@@ -0,0 +1,637 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * The `AWS::SageMaker::MonitoringSchedule` resource is an Amazon SageMaker resource type that regularly starts SageMaker processing Jobs to monitor the data captured for a SageMaker endpoint.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html}
+ */
+export type SageMakerMonitoringSchedule = ResourceDefinitionWithAttributes<"AWS::SageMaker::MonitoringSchedule", SageMakerMonitoringScheduleProps, SageMakerMonitoringScheduleAttribs>;
+/**
+ * The `AWS::SageMaker::MonitoringSchedule` resource is an Amazon SageMaker resource type that regularly starts SageMaker processing Jobs to monitor the data captured for a SageMaker endpoint.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html}
+ */
+export type SageMakerMonitoringScheduleProps = {
+    /**
+     * The name of the endpoint using the monitoring schedule.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html#cfn-sagemaker-monitoringschedule-endpointname}
+     */
+    EndpointName?: string | undefined;
+    /**
+     * Contains the reason a monitoring job failed, if it failed.
+     * @minLength 1
+     * @maxLength 1024
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html#cfn-sagemaker-monitoringschedule-failurereason}
+     */
+    FailureReason?: string | undefined;
+    /**
+     * Describes metadata on the last execution to run, if there was one.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html#cfn-sagemaker-monitoringschedule-lastmonitoringexecutionsummary}
+     */
+    LastMonitoringExecutionSummary?: MonitoringExecutionSummary | undefined;
+    /**
+     * The configuration object that specifies the monitoring schedule and defines the monitoring job.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html#cfn-sagemaker-monitoringschedule-monitoringscheduleconfig}
+     */
+    MonitoringScheduleConfig: MonitoringScheduleConfig;
+    /**
+     * The name of the monitoring schedule.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html#cfn-sagemaker-monitoringschedule-monitoringschedulename}
+     */
+    MonitoringScheduleName: string;
+    /**
+     * The status of the monitoring schedule.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html#cfn-sagemaker-monitoringschedule-monitoringschedulestatus}
+     */
+    MonitoringScheduleStatus?: "Pending" | "Failed" | "Scheduled" | "Stopped" | undefined;
+    /**
+     * An array of key-value pairs to apply to this resource.
+     *
+     * For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html#cfn-sagemaker-monitoringschedule-tags}
+     */
+    Tags?: Tag[] | undefined;
+};
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html#aws-resource-sagemaker-monitoringschedule-return-values}
+ */
+export type SageMakerMonitoringScheduleAttribs = {
+    /**
+     * The time when the monitoring schedule was created.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html#cfn-sagemaker-monitoringschedule-creationtime}
+     */
+    CreationTime: string;
+    /**
+     * The last time that the monitoring schedule was modified.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html#cfn-sagemaker-monitoringschedule-lastmodifiedtime}
+     */
+    LastModifiedTime: string;
+    /**
+     * The Amazon Resource Name (ARN) of the monitoring schedule.
+     * @minLength 1
+     * @maxLength 256
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html#cfn-sagemaker-monitoringschedule-monitoringschedulearn}
+     */
+    MonitoringScheduleArn: string;
+};
+/**
+ * Baseline configuration used to validate that the data conforms to the specified constraints and statistics.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-baselineconfig.html}
+ */
+export type BaselineConfig = {
+    /**
+     * The Amazon S3 URI for the constraints resource.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-baselineconfig.html#cfn-sagemaker-monitoringschedule-baselineconfig-constraintsresource}
+     */
+    ConstraintsResource?: ConstraintsResource | undefined;
+    /**
+     * The baseline statistics file in Amazon S3 that the current monitoring job should be validated against.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-baselineconfig.html#cfn-sagemaker-monitoringschedule-baselineconfig-statisticsresource}
+     */
+    StatisticsResource?: StatisticsResource | undefined;
+};
+/**
+ * Input object for the batch transform job.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-batchtransforminput.html}
+ */
+export type BatchTransformInput = {
+    /**
+     * The Amazon S3 location being used to capture the data.
+     * @maxLength 512
+     * @pattern ^(https|s3)://([^/]+)/?(.*)$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-batchtransforminput.html#cfn-sagemaker-monitoringschedule-batchtransforminput-datacaptureddestinations3uri}
+     */
+    DataCapturedDestinationS3Uri: string;
+    /**
+     * The dataset format for your batch transform job.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-batchtransforminput.html#cfn-sagemaker-monitoringschedule-batchtransforminput-datasetformat}
+     */
+    DatasetFormat: DatasetFormat;
+    /**
+     * The attributes of the input data to exclude from the analysis.
+     * @maxLength 100
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-batchtransforminput.html#cfn-sagemaker-monitoringschedule-batchtransforminput-excludefeaturesattribute}
+     */
+    ExcludeFeaturesAttribute?: string | undefined;
+    /**
+     * Path to the filesystem where the batch transform data is available to the container.
+     * @maxLength 256
+     * @pattern .*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-batchtransforminput.html#cfn-sagemaker-monitoringschedule-batchtransforminput-localpath}
+     */
+    LocalPath: string;
+    /**
+     * Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defaults to `FullyReplicated`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-batchtransforminput.html#cfn-sagemaker-monitoringschedule-batchtransforminput-s3datadistributiontype}
+     */
+    S3DataDistributionType?: "FullyReplicated" | "ShardedByS3Key" | undefined;
+    /**
+     * Whether the `Pipe` or `File` is used as the input mode for transferring 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` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-batchtransforminput.html#cfn-sagemaker-monitoringschedule-batchtransforminput-s3inputmode}
+     */
+    S3InputMode?: "Pipe" | "File" | undefined;
+};
+/**
+ * Configuration for the cluster used to run model monitoring jobs.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-clusterconfig.html}
+ */
+export type ClusterConfig = {
+    /**
+     * 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.
+     * @min 1
+     * @max 100
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-clusterconfig.html#cfn-sagemaker-monitoringschedule-clusterconfig-instancecount}
+     */
+    InstanceCount: number;
+    /**
+     * The ML compute instance type for the processing job.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-clusterconfig.html#cfn-sagemaker-monitoringschedule-clusterconfig-instancetype}
+     */
+    InstanceType: string;
+    /**
+     * 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.
+     * @min 1
+     * @max 2048
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-clusterconfig.html#cfn-sagemaker-monitoringschedule-clusterconfig-volumekmskeyid}
+     */
+    VolumeKmsKeyId?: string | undefined;
+    /**
+     * The size of the ML storage volume, in gigabytes, that you want to provision. You must specify sufficient ML storage for your scenario.
+     * @min 1
+     * @max 16384
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-clusterconfig.html#cfn-sagemaker-monitoringschedule-clusterconfig-volumesizeingb}
+     */
+    VolumeSizeInGB: number;
+};
+/**
+ * The Amazon S3 URI for the constraints resource.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-constraintsresource.html}
+ */
+export type ConstraintsResource = {
+    /**
+     * The Amazon S3 URI for the constraints resource.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-constraintsresource.html#cfn-sagemaker-monitoringschedule-constraintsresource-s3uri}
+     */
+    S3Uri?: string | undefined;
+};
+/**
+ * The CSV format
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-csv.html}
+ */
+export type Csv = {
+    /**
+     * A boolean flag indicating if given CSV has header
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-csv.html#cfn-sagemaker-monitoringschedule-csv-header}
+     */
+    Header?: boolean | undefined;
+};
+/**
+ * The dataset format of the data to monitor
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-datasetformat.html}
+ */
+export type DatasetFormat = {
+    /**
+     * The CSV format
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-datasetformat.html#cfn-sagemaker-monitoringschedule-datasetformat-csv}
+     */
+    Csv?: Csv | undefined;
+    /**
+     * The Json format
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-datasetformat.html#cfn-sagemaker-monitoringschedule-datasetformat-json}
+     */
+    Json?: Json | undefined;
+    /**
+     * A flag indicating if the dataset format is Parquet
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-datasetformat.html#cfn-sagemaker-monitoringschedule-datasetformat-parquet}
+     */
+    Parquet?: boolean | undefined;
+};
+/**
+ * Input object for the endpoint
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-endpointinput.html}
+ */
+export type EndpointInput = {
+    /**
+     * An endpoint in customer's account which has enabled `DataCaptureConfig` enabled.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-endpointinput.html#cfn-sagemaker-monitoringschedule-endpointinput-endpointname}
+     */
+    EndpointName: string;
+    /**
+     * The attributes of the input data to exclude from the analysis.
+     * @maxLength 100
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-endpointinput.html#cfn-sagemaker-monitoringschedule-endpointinput-excludefeaturesattribute}
+     */
+    ExcludeFeaturesAttribute?: string | undefined;
+    /**
+     * Path to the filesystem where the endpoint data is available to the container.
+     * @maxLength 256
+     * @pattern .*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-endpointinput.html#cfn-sagemaker-monitoringschedule-endpointinput-localpath}
+     */
+    LocalPath: string;
+    /**
+     * Whether input data distributed in Amazon S3 is fully replicated or sharded by an Amazon S3 key. Defaults to `FullyReplicated`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-endpointinput.html#cfn-sagemaker-monitoringschedule-endpointinput-s3datadistributiontype}
+     */
+    S3DataDistributionType?: "FullyReplicated" | "ShardedByS3Key" | undefined;
+    /**
+     * Whether the `Pipe` or `File` is used as the input mode for transferring 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` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-endpointinput.html#cfn-sagemaker-monitoringschedule-endpointinput-s3inputmode}
+     */
+    S3InputMode?: "Pipe" | "File" | undefined;
+};
+/**
+ * The Json format
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-json.html}
+ */
+export type Json = {
+    /**
+     * A boolean flag indicating if it is JSON line format
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-json.html#cfn-sagemaker-monitoringschedule-json-line}
+     */
+    Line?: boolean | undefined;
+};
+/**
+ * Container image configuration object for the monitoring job.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringappspecification.html}
+ */
+export type MonitoringAppSpecification = {
+    /**
+     * An array of arguments for the container used to run the monitoring job.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringappspecification.html#cfn-sagemaker-monitoringschedule-monitoringappspecification-containerarguments}
+     */
+    ContainerArguments?: string[] | undefined;
+    /**
+     * Specifies the entrypoint for a container used to run the monitoring job.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringappspecification.html#cfn-sagemaker-monitoringschedule-monitoringappspecification-containerentrypoint}
+     */
+    ContainerEntrypoint?: string[] | undefined;
+    /**
+     * The container image to be run by the monitoring job.
+     * @maxLength 255
+     * @pattern .*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringappspecification.html#cfn-sagemaker-monitoringschedule-monitoringappspecification-imageuri}
+     */
+    ImageUri: string;
+    /**
+     * An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringappspecification.html#cfn-sagemaker-monitoringschedule-monitoringappspecification-postanalyticsprocessorsourceuri}
+     */
+    PostAnalyticsProcessorSourceUri?: string | undefined;
+    /**
+     * An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flattened JSON so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringappspecification.html#cfn-sagemaker-monitoringschedule-monitoringappspecification-recordpreprocessorsourceuri}
+     */
+    RecordPreprocessorSourceUri?: string | undefined;
+};
+/**
+ * Summary of information about the last monitoring job to run.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringexecutionsummary.html}
+ */
+export type MonitoringExecutionSummary = {
+    /**
+     * The time at which the monitoring job was created.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringexecutionsummary.html#cfn-sagemaker-monitoringschedule-monitoringexecutionsummary-creationtime}
+     */
+    CreationTime: string;
+    /**
+     * The name of the endpoint used to run the monitoring job.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringexecutionsummary.html#cfn-sagemaker-monitoringschedule-monitoringexecutionsummary-endpointname}
+     */
+    EndpointName?: string | undefined;
+    /**
+     * Contains the reason a monitoring job failed, if it failed.
+     * @maxLength 1024
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringexecutionsummary.html#cfn-sagemaker-monitoringschedule-monitoringexecutionsummary-failurereason}
+     */
+    FailureReason?: string | undefined;
+    /**
+     * A timestamp that indicates the last time the monitoring job was modified.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringexecutionsummary.html#cfn-sagemaker-monitoringschedule-monitoringexecutionsummary-lastmodifiedtime}
+     */
+    LastModifiedTime: string;
+    /**
+     * The status of the monitoring job.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringexecutionsummary.html#cfn-sagemaker-monitoringschedule-monitoringexecutionsummary-monitoringexecutionstatus}
+     */
+    MonitoringExecutionStatus: "Pending" | "Completed" | "CompletedWithViolations" | "InProgress" | "Failed" | "Stopping" | "Stopped";
+    /**
+     * The name of the monitoring schedule.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringexecutionsummary.html#cfn-sagemaker-monitoringschedule-monitoringexecutionsummary-monitoringschedulename}
+     */
+    MonitoringScheduleName: string;
+    /**
+     * The Amazon Resource Name (ARN) of the monitoring job.
+     * @maxLength 256
+     * @pattern aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:processing-job/.*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringexecutionsummary.html#cfn-sagemaker-monitoringschedule-monitoringexecutionsummary-processingjobarn}
+     */
+    ProcessingJobArn?: string | undefined;
+    /**
+     * The time the monitoring job was scheduled.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringexecutionsummary.html#cfn-sagemaker-monitoringschedule-monitoringexecutionsummary-scheduledtime}
+     */
+    ScheduledTime: string;
+};
+/**
+ * The inputs for a monitoring job.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringinput.html}
+ */
+export type MonitoringInput = {
+    /**
+     * Input object for the batch transform job.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringinput.html#cfn-sagemaker-monitoringschedule-monitoringinput-batchtransforminput}
+     */
+    BatchTransformInput?: BatchTransformInput | undefined;
+    /**
+     * The endpoint for a monitoring job.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringinput.html#cfn-sagemaker-monitoringschedule-monitoringinput-endpointinput}
+     */
+    EndpointInput?: EndpointInput | undefined;
+};
+/**
+ * Defines the monitoring job.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringjobdefinition.html}
+ */
+export type MonitoringJobDefinition = {
+    /**
+     * Baseline configuration used to validate that the data conforms to the specified constraints and statistics
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringjobdefinition.html#cfn-sagemaker-monitoringschedule-monitoringjobdefinition-baselineconfig}
+     */
+    BaselineConfig?: BaselineConfig | undefined;
+    /**
+     * Sets the environment variables in the Docker container.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringjobdefinition.html#cfn-sagemaker-monitoringschedule-monitoringjobdefinition-environment}
+     */
+    Environment?: Record<string, string> | undefined;
+    /**
+     * Configures the monitoring job to run a specified Docker container image.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringjobdefinition.html#cfn-sagemaker-monitoringschedule-monitoringjobdefinition-monitoringappspecification}
+     */
+    MonitoringAppSpecification: MonitoringAppSpecification;
+    /**
+     * The array of inputs for the monitoring job. Currently we support monitoring an Amazon SageMaker AI Endpoint.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringjobdefinition.html#cfn-sagemaker-monitoringschedule-monitoringjobdefinition-monitoringinputs}
+     */
+    MonitoringInputs: MonitoringInput[];
+    /**
+     * The array of outputs from the monitoring job to be uploaded to Amazon S3.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringjobdefinition.html#cfn-sagemaker-monitoringschedule-monitoringjobdefinition-monitoringoutputconfig}
+     */
+    MonitoringOutputConfig: MonitoringOutputConfig;
+    /**
+     * Identifies the resources, ML compute instances, and ML storage volumes to deploy for a monitoring job. In distributed processing, you specify more than one instance.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringjobdefinition.html#cfn-sagemaker-monitoringschedule-monitoringjobdefinition-monitoringresources}
+     */
+    MonitoringResources: MonitoringResources;
+    /**
+     * Specifies networking options for an monitoring job.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringjobdefinition.html#cfn-sagemaker-monitoringschedule-monitoringjobdefinition-networkconfig}
+     */
+    NetworkConfig?: NetworkConfig | undefined;
+    /**
+     * The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.
+     * @minLength 20
+     * @maxLength 2048
+     * @pattern ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringjobdefinition.html#cfn-sagemaker-monitoringschedule-monitoringjobdefinition-rolearn}
+     */
+    RoleArn: string;
+    /**
+     * Specifies a time limit for how long the monitoring job is allowed to run.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringjobdefinition.html#cfn-sagemaker-monitoringschedule-monitoringjobdefinition-stoppingcondition}
+     */
+    StoppingCondition?: StoppingCondition | undefined;
+};
+/**
+ * The output object for a monitoring job.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringoutput.html}
+ */
+export type MonitoringOutput = {
+    /**
+     * The Amazon S3 storage location where the results of a monitoring job are saved.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringoutput.html#cfn-sagemaker-monitoringschedule-monitoringoutput-s3output}
+     */
+    S3Output: S3Output;
+};
+/**
+ * The output configuration for monitoring jobs.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringoutputconfig.html}
+ */
+export type MonitoringOutputConfig = {
+    /**
+     * The AWS Key Management Service ( AWS KMS ) key that Amazon SageMaker AI uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.
+     * @maxLength 2048
+     * @pattern .*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringoutputconfig.html#cfn-sagemaker-monitoringschedule-monitoringoutputconfig-kmskeyid}
+     */
+    KmsKeyId?: string | undefined;
+    /**
+     * Monitoring outputs for monitoring jobs. This is where the output of the periodic monitoring jobs is uploaded.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringoutputconfig.html#cfn-sagemaker-monitoringschedule-monitoringoutputconfig-monitoringoutputs}
+     */
+    MonitoringOutputs: MonitoringOutput[];
+};
+/**
+ * Identifies the resources to deploy for a monitoring job.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringresources.html}
+ */
+export type MonitoringResources = {
+    /**
+     * The configuration for the cluster resources used to run the processing job.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringresources.html#cfn-sagemaker-monitoringschedule-monitoringresources-clusterconfig}
+     */
+    ClusterConfig: ClusterConfig;
+};
+/**
+ * Configures the monitoring schedule and defines the monitoring job.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringscheduleconfig.html}
+ */
+export type MonitoringScheduleConfig = {
+    /**
+     * Defines the monitoring job.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringscheduleconfig.html#cfn-sagemaker-monitoringschedule-monitoringscheduleconfig-monitoringjobdefinition}
+     */
+    MonitoringJobDefinition?: MonitoringJobDefinition | undefined;
+    /**
+     * The name of the monitoring job definition to schedule.
+     * @minLength 1
+     * @maxLength 63
+     * @pattern ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringscheduleconfig.html#cfn-sagemaker-monitoringschedule-monitoringscheduleconfig-monitoringjobdefinitionname}
+     */
+    MonitoringJobDefinitionName?: string | undefined;
+    /**
+     * The type of the monitoring job definition to schedule.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringscheduleconfig.html#cfn-sagemaker-monitoringschedule-monitoringscheduleconfig-monitoringtype}
+     */
+    MonitoringType?: MonitoringType | undefined;
+    /**
+     * Configures the monitoring schedule.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringscheduleconfig.html#cfn-sagemaker-monitoringschedule-monitoringscheduleconfig-scheduleconfig}
+     */
+    ScheduleConfig?: ScheduleConfig | undefined;
+};
+/**
+ * The type of monitoring job.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringtype.html}
+ */
+export type MonitoringType = "DataQuality" | "ModelQuality" | "ModelBias" | "ModelExplainability";
+/**
+ * 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-networkconfig.html}
+ */
+export type NetworkConfig = {
+    /**
+     * 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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-networkconfig.html#cfn-sagemaker-monitoringschedule-networkconfig-enableintercontainertrafficencryption}
+     */
+    EnableInterContainerTrafficEncryption?: boolean | undefined;
+    /**
+     * Whether to allow inbound and outbound network calls to and from the containers used for the processing job.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-networkconfig.html#cfn-sagemaker-monitoringschedule-networkconfig-enablenetworkisolation}
+     */
+    EnableNetworkIsolation?: boolean | undefined;
+    /**
+     * 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. For more information, see [Protect Endpoints by Using an Amazon Virtual Private Cloud](https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html) and [Protect Training Jobs by Using an Amazon Virtual Private Cloud](https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-networkconfig.html#cfn-sagemaker-monitoringschedule-networkconfig-vpcconfig}
+     */
+    VpcConfig?: VpcConfig | undefined;
+};
+/**
+ * Information about where and how you want to store the results of a monitoring job.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-s3output.html}
+ */
+export type S3Output = {
+    /**
+     * The local path to the S3 storage location where SageMaker saves the results of a monitoring job. LocalPath is an absolute path for the output data.
+     * @maxLength 256
+     * @pattern .*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-s3output.html#cfn-sagemaker-monitoringschedule-s3output-localpath}
+     */
+    LocalPath: string;
+    /**
+     * Whether to upload the results of the monitoring job continuously or after the job completes.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-s3output.html#cfn-sagemaker-monitoringschedule-s3output-s3uploadmode}
+     */
+    S3UploadMode?: "Continuous" | "EndOfJob" | undefined;
+    /**
+     * A URI that identifies the S3 storage location where SageMaker saves the results of a monitoring job.
+     * @maxLength 512
+     * @pattern ^(https|s3)://([^/]+)/?(.*)$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-s3output.html#cfn-sagemaker-monitoringschedule-s3output-s3uri}
+     */
+    S3Uri: string;
+};
+/**
+ * Configuration details about the monitoring schedule.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-scheduleconfig.html}
+ */
+export type ScheduleConfig = {
+    /**
+     * Sets the end time for a monitoring job window. Express this time as an offset to the times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the `ScheduleExpression` parameter. Specify this offset in ISO 8601 duration format. For example, if you want to end the window one hour before the start of each monitoring job, you would specify: `"-PT1H"` .
+     *
+     * The end time that you specify must not follow the start time that you specify by more than 24 hours. You specify the start time with the `DataAnalysisStartTime` parameter.
+     *
+     * If you set `ScheduleExpression` to `NOW` , this parameter is required.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-scheduleconfig.html#cfn-sagemaker-monitoringschedule-scheduleconfig-dataanalysisendtime}
+     */
+    DataAnalysisEndTime?: string | undefined;
+    /**
+     * Sets the start time for a monitoring job window. Express this time as an offset to the times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the `ScheduleExpression` parameter. Specify this offset in ISO 8601 duration format. For example, if you want to monitor the five hours of data in your dataset that precede the start of each monitoring job, you would specify: `"-PT5H"` .
+     *
+     * The start time that you specify must not precede the end time that you specify by more than 24 hours. You specify the end time with the `DataAnalysisEndTime` parameter.
+     *
+     * If you set `ScheduleExpression` to `NOW` , this parameter is required.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-scheduleconfig.html#cfn-sagemaker-monitoringschedule-scheduleconfig-dataanalysisstarttime}
+     */
+    DataAnalysisStartTime?: string | undefined;
+    /**
+     * A cron expression that describes details about the monitoring schedule.
+     *
+     * The supported cron expressions are:
+     *
+     * - If you want to set the job to start every hour, use the following:
+     *
+     * `Hourly: cron(0 * ? * * *)`
+     * - If you want to start the job daily:
+     *
+     * `cron(0 [00-23] ? * * *)`
+     * - If you want to run the job one time, immediately, use the following keyword:
+     *
+     * `NOW`
+     *
+     * For example, the following are valid cron expressions:
+     *
+     * - Daily at noon UTC: `cron(0 12 ? * * *)`
+     * - Daily at midnight UTC: `cron(0 0 ? * * *)`
+     *
+     * To support running every 6, 12 hours, the following are also supported:
+     *
+     * `cron(0 [00-23]/[01-24] ? * * *)`
+     *
+     * For example, the following are valid cron expressions:
+     *
+     * - Every 12 hours, starting at 5pm UTC: `cron(0 17/12 ? * * *)`
+     * - Every two hours starting at midnight: `cron(0 0/2 ? * * *)`
+     *
+     * > - Even though the cron expression is set to start at 5PM UTC, note that there could be a delay of 0-20 minutes from the actual requested time to run the execution.
+     * > - We recommend that if you would like a daily schedule, you do not provide this parameter. Amazon SageMaker AI will pick a time for running every day.
+     *
+     * You can also specify the keyword `NOW` to run the monitoring job immediately, one time, without recurring.
+     * @minLength 1
+     * @maxLength 256
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-scheduleconfig.html#cfn-sagemaker-monitoringschedule-scheduleconfig-scheduleexpression}
+     */
+    ScheduleExpression: string;
+};
+/**
+ * The baseline statistics file in Amazon S3 that the current monitoring job should be validated against.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-statisticsresource.html}
+ */
+export type StatisticsResource = {
+    /**
+     * The S3 URI for the statistics resource.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-statisticsresource.html#cfn-sagemaker-monitoringschedule-statisticsresource-s3uri}
+     */
+    S3Uri?: string | undefined;
+};
+/**
+ * Specifies a limit to how long a job can run. When the job reaches the time limit, SageMaker ends the job. Use this API to cap costs.
+ *
+ * To stop a training job, SageMaker sends the algorithm the `SIGTERM` signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.
+ *
+ * The training algorithms provided by SageMaker automatically save the intermediate results of a model training job when possible. This attempt to save artifacts is only a best effort case as model might not be in a state from which it can be saved. For example, if training has just started, the model might not be ready to save. When saved, this intermediate data is a valid model artifact. You can use it to create a model with `CreateModel` .
+ *
+ * > The Neural Topic Model (NTM) currently does not support saving intermediate model artifacts. When training NTMs, make sure that the maximum runtime is sufficient for the training job to complete.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-stoppingcondition.html}
+ */
+export type StoppingCondition = {
+    /**
+     * The maximum length of time, in seconds, that a training or compilation job can run before it is stopped.
+     *
+     * For compilation jobs, if the job does not complete during this time, a `TimeOut` error is generated. We recommend starting with 900 seconds and increasing as necessary based on your model.
+     *
+     * For all other jobs, if the job does not complete during this time, SageMaker ends the job. When `RetryStrategy` is specified in the job request, `MaxRuntimeInSeconds` specifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.
+     *
+     * The maximum time that a `TrainingJob` can run in total, including any time spent publishing metrics or archiving and uploading models after it has been stopped, is 30 days.
+     * @min 1
+     * @max 86400
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-stoppingcondition.html#cfn-sagemaker-monitoringschedule-stoppingcondition-maxruntimeinseconds}
+     */
+    MaxRuntimeInSeconds: number;
+};
+/**
+ * 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) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-vpcconfig.html}
+ */
+export type VpcConfig = {
+    /**
+     * The VPC security group IDs, in the form `sg-xxxxxxxx` . Specify the security groups for the VPC that is specified in the `Subnets` field.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-vpcconfig.html#cfn-sagemaker-monitoringschedule-vpcconfig-securitygroupids}
+     */
+    SecurityGroupIds: string[];
+    /**
+     * The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see [Supported Instance Types and Availability Zones](https://docs.aws.amazon.com/sagemaker/latest/dg/instance-types-az.html) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-vpcconfig.html#cfn-sagemaker-monitoringschedule-vpcconfig-subnets}
+     */
+    Subnets: string[];
+};
+//# sourceMappingURL=aws-sagemaker-monitoringschedule.d.ts.map