DescribeMonitoringSchedule - Amazon SageMaker Service

DescribeMonitoringSchedule

Describes the schedule for a monitoring job.

Request Syntax

{ "MonitoringScheduleName": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

MonitoringScheduleName

Name of a previously created monitoring schedule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$

Required: Yes

Response Syntax

{ "CreationTime": number, "EndpointName": "string", "FailureReason": "string", "LastModifiedTime": number, "LastMonitoringExecutionSummary": { "CreationTime": number, "EndpointName": "string", "FailureReason": "string", "LastModifiedTime": number, "MonitoringExecutionStatus": "string", "MonitoringScheduleName": "string", "ProcessingJobArn": "string", "ScheduledTime": number }, "MonitoringScheduleArn": "string", "MonitoringScheduleConfig": { "MonitoringJobDefinition": { "BaselineConfig": { "ConstraintsResource": { "S3Uri": "string" }, "StatisticsResource": { "S3Uri": "string" } }, "Environment": { "string" : "string" }, "MonitoringAppSpecification": { "ContainerArguments": [ "string" ], "ContainerEntrypoint": [ "string" ], "ImageUri": "string", "PostAnalyticsProcessorSourceUri": "string", "RecordPreprocessorSourceUri": "string" }, "MonitoringInputs": [ { "EndpointInput": { "EndpointName": "string", "LocalPath": "string", "S3DataDistributionType": "string", "S3InputMode": "string" } } ], "MonitoringOutputConfig": { "KmsKeyId": "string", "MonitoringOutputs": [ { "S3Output": { "LocalPath": "string", "S3UploadMode": "string", "S3Uri": "string" } } ] }, "MonitoringResources": { "ClusterConfig": { "InstanceCount": number, "InstanceType": "string", "VolumeKmsKeyId": "string", "VolumeSizeInGB": number } }, "NetworkConfig": { "EnableInterContainerTrafficEncryption": boolean, "EnableNetworkIsolation": boolean, "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } }, "RoleArn": "string", "StoppingCondition": { "MaxRuntimeInSeconds": number } }, "ScheduleConfig": { "ScheduleExpression": "string" } }, "MonitoringScheduleName": "string", "MonitoringScheduleStatus": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CreationTime

The time at which the monitoring job was created.

Type: Timestamp

EndpointName

The name of the endpoint for the monitoring job.

Type: String

Length Constraints: Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*

FailureReason

A string, up to one KB in size, that contains the reason a monitoring job failed, if it failed.

Type: String

Length Constraints: Maximum length of 1024.

LastModifiedTime

The time at which the monitoring job was last modified.

Type: Timestamp

LastMonitoringExecutionSummary

Describes metadata on the last execution to run, if there was one.

Type: MonitoringExecutionSummary object

MonitoringScheduleArn

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

Type: String

Length Constraints: Maximum length of 256.

Pattern: .*

MonitoringScheduleConfig

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

Type: MonitoringScheduleConfig object

MonitoringScheduleName

Name of the monitoring schedule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$

MonitoringScheduleStatus

The status of an monitoring job.

Type: String

Valid Values: Pending | Failed | Scheduled | Stopped

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: